Description of the Sub-Menu Address Roles
From Metis Documentation
(→Adding an Address Role) |
|||
| Line 1: | Line 1: | ||
| - | In order to use the defined Addresses and contacts created in the previous in Metis Smart | + | In order to use the defined Addresses and contacts created in the [[Description_of_the_Sub-Menu_Addresses|previous sub-menu]] in Metis Smart Modeling, the administrator can define address roles to be used in conjunction with projects, offers, and systems. The '''Address Roles''' sub-menu consists of a search function on the left side and a table containing all address roles along with their codes and check-boxes to define the links with project, offer, and system which are currently ticked or not ticked. |
| - | Address roles with a lock icon in front of them are from a parent version and can only have their description modified. | + | Address roles with a lock icon in front of them are from a parent version and can only have their description modified,specifically the translations. |
The address roles themselves are a means of identifying the different activity a company or contact may have in a project, offer or system; such as a shipping address, a billing address, or an installation address. | The address roles themselves are a means of identifying the different activity a company or contact may have in a project, offer or system; such as a shipping address, a billing address, or an installation address. | ||
| Line 8: | Line 8: | ||
| - | On the left-hand side of the window, a '''Search''' feature is found. | + | On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Address Roles based on various criterion. The search is triggered by typing a keyword or only a letter in the fields above the "Search" button and then click on it. The results are then displayed below. Selecting a line from the result list will automatically select the corresponding entry in the main table. |
| - | 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, | + | 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, check-boxes become available for each of the address roles. When a check-box 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 == | ||
| - | + | In the '''Address Roles''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main table allows the user/administrator to create a new Address Role. When it is clicked, the '''Address Role''' creation window opens, it allows to define all related information. | |
| + | |||
| + | |||
| + | [[File:MSM_Data_Management_Address_Roles_Add.png|center|600x400px]] | ||
| - | |||
* '''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. | * '''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. | ||
| Line 25: | Line 27: | ||
| - | + | {{Note | |
| + | | Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field. | ||
| + | }} | ||
| - | + | Once all related mandatory and optional information have been set, the new Address Role can be saved by validating the '''Address Role''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. | |
| - | Once all | + | |
| Line 36: | Line 39: | ||
}} | }} | ||
| - | |||
| - | + | == Modifying an Address Role == | |
| + | |||
| + | In the '''Address Roles''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main table allows the user/administrator to apply modifications to all properties related to the selected Address Role. Selecting a Address Role and clicking on it opens the '''Address Role''' edition window where all related properties and information can be edited. | ||
[[File:MSM_Data_Management_Address_Roles_Edit.png|center|600x400px]] | [[File:MSM_Data_Management_Address_Roles_Edit.png|center|600x400px]] | ||
| + | |||
| + | |||
| + | For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Address Role. Modifications applied to the selected Address Role will only be saved once the Address Role edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the table displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window. | ||
| Line 53: | Line 60: | ||
== Deleting an Address Role == | == Deleting an Address Role == | ||
| - | + | In the '''Address Roles''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Address Role. Selecting one or more Address Role and clicking on it displays the following confirmation window. | |
| Line 59: | Line 66: | ||
| - | + | Once the warning is confirmed, the selected Address Role is removed from Metis Smart Suite and deleted from the Metis Database. | |
| Line 70: | Line 77: | ||
== Sorting through Address Roles == | == Sorting through Address Roles == | ||
| - | The "Sort" button [[File: | + | The "Sort" button [[File:MetisSmartModelingSortButton.PNG|link=]] allows the user to define the order in which the defined Address Roles are shown within the list in Metis Smart Modeling and in Metis Smart Quotes. Clicking on the button displays a new windows where the administrator can set that order using the UP and DOWN arrow located on top of the list. By selecting an Address Role and using those buttons, the list can be sorted. |
| Line 87: | Line 94: | ||
== Previewing an Address Role == | == Previewing an Address Role == | ||
| - | + | In the '''Address Roles''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main table allows the user/administrator to see all properties and information related to the selected Address Role. | |
[[File:MSM_Data_Management_Address_Roles_Preview.png|center|600x400px]] | [[File:MSM_Data_Management_Address_Roles_Preview.png|center|600x400px]] | ||
| + | |||
| + | |||
| + | Selecting a Address Role from the table and clicking on it opens the '''Address Role''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Address Role. | ||
{{Note | {{Note | ||
| - | | | + | | Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used. |
}} | }} | ||