Adding tags to your location comes with great advantages for managing your location data. This functionality enables you to efficiently categorize and utilize your location information.
Location tags can be useful for:
- Tax and Regulatory Compliance: Tagging locations by state and county for easier reporting.
- Location-Specific Pricing: Grouping locations for consistent pricing in line items.
- Metadata Enrichment: Adding details like well type (sour or sweet) or product type (oil, gas, water) for better analysis.
This guide is designed to help you effectively utilize location tags. Below, you will find the topics covered in this guide:
Tag Types
Permissions Required
Creating and tagging a new location in the dispatch hub.
Editing tags on existing location directly within the dispatch hub.
Adding/updating tags on new/existent locations from the admin portal.
Tag Types
Tags can be created as two different types:
- Composite Tags: are the combination of a CATEGORY and a VALUE separated by a COLON, i.e.
Well Type: SourorCounty: Midland. Composite tags can be created by entering both a category and a value. You have the flexibility to establish new categories while tagging; once a category is created, it will be available for future use. To select from available categories, simply click the downward-facing arrow in the category field. - Simple Tags: are a text string, i.e.
Yard 2. To create a simple tag, you can leave the category field empty and simply fill in the value field.
Note: Location tags are linked to an ORGANIZATION, allowing any created tag CATEGORIES or VALUES to be reused across locations. Tags are case insensitive, so duplicates differing only in capitalization (e.g., "Tag" and "tag") cannot be created. While tags can contain spaces and special characters, avoid using a COLON, as it separates CATEGORY from VALUE in composite tags, making it inappropriate for SIMPLE tags.
Permissions
Users who have access to a location are permitted to add their own tags. However, you can only delete tags that are associated with your organization. Tags that cannot be removed will not display an "X" icon when you are in editing mode. To delete a tag from a location, simply click the "X" icon next to the tag you wish to remove.
Location tags can be applied to locations through the following methods:
- Creating a New Location: You can create a new location based on an existing job within the dispatch hub and add relevant tags during this process.
- Editing an Existing Location: Navigate to an existing location in the dispatch hub to modify or update its tags as needed.
- Admin Portal Management: In the admin portal, you have the option to either create a new location or select an existing one to add or update tags accordingly.
1. Dispatch Hub: Creating and tagging a new location from an existing job
Step 1: Access the job where you wish to add the new location. Navigate to either the pickup or destination location section, and enter the name of the new location in the designated field.
Step 2: A list of available locations will be displayed, and you will see an option that says "Show all locations." Please click on this option to proceed.
Step 3: A new option labeled "Add new location" will appear. Click on this.
Step 4: A location creation modal will appear where you can specify the new location's properties. Click "Add Tags" in the bottom right corner.
Step 5: A tags creation modal will appear. For a category tag, specify both the category and value fields. For a simple tag, fill in only the value field. Available tags that match your entry, will appear as suggestions; if none are available, you can create a new tag by selecting the "New Tag" option. After filling in the fields, click the "+" sign to add your tag to the location.
Step 6: To add multiple tags, repeat the previous steps by entering a new category and value for each tag, then click the "+" sign to include it. Once you have added all desired tags, click the "Save" button to confirm and save your changes.
Your new location will be created along with the tags associated to it.
2. Dispatch Hub: Adding and updating tags in an existing location
Step 1: Navigate to the location for which you want to modify the tags, and then click on the "Edit Tags" option.
Step 2: To create a new tag, simply enter the relevant information in the category and value fields. If you wish to remove an existing tag, just click the "x" icon located next to that tag.
Step 3: If there are available tags that match your input, they will appear as suggestions. If no suggestions are found, you will have the option to create a new tag by clicking on the "New Tag" option.
Step 4: Click on the "+" sign to add the tag to the location.
Step 5: Click on save to save your changes.
3. Admin Portal: Adding/updating tags on a new/existing location
Step 1: In the admin portal's locations section, you can either click the "New" button to create a new location or search for and select an existing location. Once you access the location creation or editing screen, simply scroll down to locate the tags section.
Step 2: You can use the "Add Tag" option to create new tags. This will open fields for both the category and value; simply fill in the required information based on your required tag type (either simple tags or composite tags). Once you have entered the details, click the "+" sign to add the tag. If you wish to delete an existing tag, simply click the "X" icon next to it to remove it.
