Description of the Sub-Menu Address Roles
From Metis Documentation
| Line 5: | Line 5: | ||
| - | [[File:MSM-Data-Management-Address-Roles.png|center|600x400px]] | + | [[File:MSM-Data-Management-Address-Roles.png|center|600x400px]] |
| - | + | On the left-hand side of the window, a '''Search''' feature is found. Upon entering only a few characters, the '''Search''' can be launched with the results appearing just below. When an Address Role is selected from the result list it will also be highlighted in the main list on the right. | |
| - | + | In Smart Quotes, address roles may be found on the '''Addresses''' tab when adding addresses and contacts to projects, offers and systems. Once the '''Add''' button has been clicked, the '''Addresses and Contacts Role selections''' window opens. Once an address or contact has been found using the search function, checkboxes become available for each of the address roles. When a checkbox is ticked for a certain address role, the address role is then associated with the address or contact. Multiple address roles may be selected if desired. Once finished selecting address roles, the user clicks on the confirm button to save the changes. | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
== Adding an Address Role == | == Adding an Address Role == | ||
| - | The | + | The "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] allows the user to create a new address role. When the it is clicked, the '''Address Role''' window opens. |
The window contains the following fields: | The window contains the following fields: | ||
| - | *Code: an additional reference to the address role that the user can provide. The | + | * '''Code''' : an additional reference to the address role that the user can provide. The field is limited to 10 characters. It can mainly be used in the background to create links with the Address Role in interfaces and the GUI. |
| - | *Description: The address role can be named for each of the available languages. The | + | * '''Description''' : The address role can be named for each of the available languages. The field is limited to 50 characters. |
| + | * Three '''checkboxes''' : Project, Offer and System which allow the administrator to define where that role will be available. | ||
| - | |||
| + | [[File:MSM_Data_Management_Address_Roles_Add.png|center|600x400px]] | ||
| - | |||
| - | |||
| - | |||
| - | + | Once all the required information provided, the window needs to be validated in order for the new Address Role to be saved in the database. | |
| Line 40: | Line 34: | ||
| - | The | + | The "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] allows the user to see and modify the properties of an Address Role. Selecting an address role and clicking on it opens the '''Address Role''' window. All of the fields that were available when creating a new address role are still available and can be modified in this '''Edit''' window. |
| + | |||
| + | |||
| + | [[File:MSM_Data_Management_Address_Roles_Edit.png|center|600x400px]] | ||
| - | |||
{{Note | {{Note | ||
| Address roles with a lock icon before them can only have their description edited. | | Address roles with a lock icon before them can only have their description edited. | ||
}} | }} | ||
| + | |||
| + | |||
== Deleting an Address Role == | == Deleting an Address Role == | ||
| - | The | + | The "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] allows the user to delete an existing address role. When deleting an address role, the following confirmation window appears: |
| - | |||
| - | [ | + | [[File:MSM_Data_Management_Address_Roles_Delete.png|center]] |
| + | |||
| + | |||
| + | The user must validate it before the address role is deleted. | ||
| - | |||
{{Note | {{Note | ||
| Address roles with a lock icon before them can only be deleted by the administrator of the version they were created in. | | Address roles with a lock icon before them can only be deleted by the administrator of the version they were created in. | ||
}} | }} | ||
| + | |||
| + | |||
== Sorting through Address Roles == | == Sorting through Address Roles == | ||
| + | |||
| + | |||
| + | |||
| + | [[File:MSM-Data-Management-Address-Roles-Sort.png|center|600x400px]] | ||
| + | |||
== Previewing an Address Role == | == Previewing an Address Role == | ||
| - | The | + | The "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] allows the user to see the properties of the selected address role. Selecting an address role and clicking on the '''Preview''' button opens the '''Address Role''' window. The name of the address role is presented in the description field for each of the available languages as well as the external code and checkboxes. |
| - | |||
{{Note | {{Note | ||
| - | | It is not possible to edit the properties of the address role in the '''Preview''' address role window. This must be done with the '''Edit''' | + | | It is not possible to edit the properties of the address role in the '''Preview''' address role window. This must be done with the '''Edit''' function. |
}} | }} | ||