In this article we will look at how to manage attributes in Loc8. This article uses the JOBS workspace as the configuration point, but the process is ubiquitous across all workspaces that support custom attributes. If you are looking for how to add field groups to specific entity types, please CLICK HERE.
------------------------------------------------------------------------------------
Attributes settings
Click on Settings, then use the drop down selection in the left hand side menu to select the Workspace you want to manage. In this guide, we will be configuring "Job settings", but the same process can be followed with any other workspace that supports Attributes (Assets, Customers, Quotes etc). Once you have selected the Workspace you want to manage, click on "Attributes". The first screen you will see will be the fields that are available for that Workspace. Any Field with the "TYPE" of System is a default Loc8 field. You can add a new field simply by clicking the "+ Add Field" option.
View, manage and create attributes
------------------------------------------------------------------------------------
Creating new fields
Click Add field, you will be able to type in a NAME for the new field, define it's type (Text, number, drop down etc), as well as add a description. Once you have configured this to your liking, click the green tick to save it.
Scroll down the page to locate the newly created field, "More information required for a job". The field list here is alphabetical so you can easily find the fields that you have created.
Editing existing fields
Click "Actions" next to the field to display the "Edit" and "Archive" options. Edit will allow you to edit the field details (NOTE: Any changes to the field will be immediately reflected on all entities that field is associated to via a group. You also cannot change the FIELD TYPE once it's been created). "Archive" will archive the field. It will still be visible on any entities that it is currently on, but will be displayed in the "Archived" area on the entity.
Managing and configuring "Global Groups"
Click on the "GLOBAL GROUPS" tab to switch to the global groups management section.
Managing Global Groups
Global groups are field groups that will appear on all "Types" for that Entity. In this example, these fields will apply to all Job Types. You can use the 3 dashes on the left hand side of the group card to re-order the group. This will define the order of display when you are inspecting the entity itself. You can remove the field groups from Global by clicking "remove". (NOTE: any changes here will affect all existing entities. Removing the group does not delete the group, merely stops it from being shown).
Create a New Field Group
Click "Add field group" to create a new group named "New Group" at the bottom of the list. You can then edit the group and assign fields to that group.
Configure new field group
Give your new field group a name, an icon, or change it's display order if required.
Select an Icon for the Group
Click the icon next to the group name to open the icon selection menu, then scroll through the available icons.
Add Field to Group
Click on the expand arrow to expand the field group. Click "Add field" within the group, then start typing the field that you created earlier in step 2 to this new field group.
Optional configuration
You can optionally here configure the field as "REQUIRED". This means that it will have to be filled out when an entity it's associated to is created. This is useful for mandatory information that you wish to record. You can also change the visibility here. Always show will always display this field regardless of whether or not it's populated. Hidden will hide it by default on associated entities. Show if populated will only display this field if it contains data.
Adjust Field Permissions
You can also set who has edit permissions for this field group. Usually this would be left as is, however if you have a more advanced use case, you can restrict the edit for this field group to specific user types.
Save Global Group Configuration
Click the "SAVE" button. In the confirmation dialog, click "CONFIRM" to save the global group configuration. A confirmation message will appear.
Archive fields
To archive a field, return to the "Fields" tab. Under the "Actions" menu, there will be an option to "Archive" Please read the warning CAREFULLY prior to archiving.
View and manage "Archived fields"
You will see an "Archived fields" sub-tab. This will display any and all archived fields relating to this workspace configuration.
Restore Archived Fields
Click "Archived fields" to view archived fields. Click "Actions" next to the field, then select "Restore". In the confirmation dialog, click "CONFIRM" to restore the field. A confirmation message will appear.
Deleting fields
When deleting an attribute field, you will be required to type in "DELETE". This is an intentional check to make sure that you absolutely wish to do this. (NOTE: This is not reversible. If you delete the field, it will be removed from all associated groups and entities. Any data already input into this field on any entity will be deleted and is NOT RECOVERABLE. Please make sure you understand this prior to deleting).
------------------------------------------------------------------------------------