Description of the Sub-Menu Customizing
From Metis Documentation
(→Field Types and Options) |
|||
| Line 1: | Line 1: | ||
| - | + | The customizing sub-menu enables administrators to customize both Metis Smart Quotes and Metis Smart Modeling by creating new fields for default windows. The purpose of these fields are subjective to the user which may choose from a variety of different functionalities. For example, the user could add a field in Metis Smart Quotes titled "Offer Deadline" which would appear in the position specified by the user. The end user would click on an icon in the field opening a calendar where the "Offer Deadline" date could be set. | |
| - | |||
| - | |||
| - | |||
| - | + | [[File:MSM_Data_Management_Customizing.png|center|600x400px]] | |
| - | + | ||
| - | Selecting a category from the left-hand table changes what is shown in the table to the right. This table displays existing customizations organized by sections. | + | Selecting a category from the left-hand table changes what is shown in the table to the right. This table displays existing customizations organized by sections. These sections listed in this table are all the possible section choices the user has when deciding where to place a customized field. These sections represent default windows within Metis applications. For example, the "Project" section under "Smart Quotes" represents the project definition window in Metis Smart Quotes. It allows the end-users to specify all project related information. Or under "Smart Modeling", the "Office" section relates to the [[Description_of_the_Menu_Users#Offices|Office]] definition window. Here the administrator/user can define additional fields do describe an office. |
| - | These sections listed in this table are all the possible section choices the user has when deciding where to place a | + | |
| - | |||
===Field Types and Options=== | ===Field Types and Options=== | ||
| - | The different types of customizations are listed | + | The different types of customizations are listed below. Most types have several different input options, such as the Boolean type customization having inputs of being either "0 or 1", "Yes or No" or "True or False" for example. Types with no options visible have only one type of input permitted for the customization which is most often unique to that customization. The option input may differ between customization types from being a choice from a drop-down list to the selection of a certain file or folder from the windows explorer. |
| Line 27: | Line 22: | ||
'''Boolean''' | '''Boolean''' | ||
| width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | | width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| - | Creates a basic type of customization having only two possible outcomes, such as '''True''' or '''False'''. The following are all the available | + | Creates a basic type of customization having only two possible outcomes, such as '''True''' or '''False'''. The following are all the available Boolean type options available for displaying the value of the customized field: |
*0 / 1 | *0 / 1 | ||
*Yes / No | *Yes / No | ||
| Line 40: | Line 35: | ||
| width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | | width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
Creates a field where the input can only be numerical. The user has the option to pick between integers or real numbers. | Creates a field where the input can only be numerical. The user has the option to pick between integers or real numbers. | ||
| - | *Integer: | + | *Integer: number without a fractional component. |
| - | *Real: | + | *Real: number with a fractional component. |
|- | |- | ||
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | | width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
| Line 47: | Line 42: | ||
| width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | | width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
Creates a field where only numbers and letters can be entered. The following alphanumeric options are available. | Creates a field where only numbers and letters can be entered. The following alphanumeric options are available. | ||
| - | *String: | + | *String: normal sequence of letters and numbers. |
| - | *Multi Language String (not available): | + | *Multi Language String (not available): normal sequence of letters and numbers that can be saved for different languages. |
| - | *Password: | + | *Password: sequence of letters and numbers that is masked by asterisks. |
|- | |- | ||
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | | width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
'''Date''' | '''Date''' | ||
| width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | | width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| - | Creates a field where a calendar graphic will pop up and the user may select the date by either entering it in | + | Creates a field where a calendar graphic will pop up and the user may select the date by either entering it in the field or using the calendar view to select the desired date. |
|- | |- | ||
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | | width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
'''List''' | '''List''' | ||
| width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | | width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| - | Creates a field with a | + | Creates a field with a drop-down list where the user may select an entry from the list selected in the options. |
| - | *List Type: All the existing lists found in Smart Modeling are found in this | + | *List Type: All the existing lists found in Smart Modeling are found in this drop-down list and can be selected so that its content is displayed in the custom field. |
|- | |- | ||
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | | width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
| Line 80: | Line 75: | ||
'''User''' | '''User''' | ||
| width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | | width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| - | Creates a field where the user may select a user from the list of existing users. | + | Creates a field where the user may select a user from the list of existing [[Description_of_the_Menu_Users#Employees|users]]. |
*User Role: Selecting a user role narrows the list of users down to only the users found in the selected user role. For example, selecting the user role '''Sales''' would have the list of users linked to the '''Sales''' user role. | *User Role: Selecting a user role narrows the list of users down to only the users found in the selected user role. For example, selecting the user role '''Sales''' would have the list of users linked to the '''Sales''' user role. | ||
|- | |- | ||
| Line 86: | Line 81: | ||
'''User Role''' | '''User Role''' | ||
| width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | | width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| - | Creates a field where the user may select a user role from the list of existing user roles. | + | Creates a field where the user may select a user role from the list of existing [[Description_of_the_Menu_Users#User_Roles|user roles]]. |
|- | |- | ||
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | | width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
'''Address''' | '''Address''' | ||
| width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | | width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| - | Creates a field where the user can then open a new window and find the appropriate | + | Creates a field where the user can then open a new window and find the appropriate [[Description_of_the_Sub-Menu_Addresses|Addresses]] using the address search criteria. |
*All: Lists all of the existing addresses. | *All: Lists all of the existing addresses. | ||
*Addresses linked to the project: Lists only the addresses that have been already associated to the project being customized. | *Addresses linked to the project: Lists only the addresses that have been already associated to the project being customized. | ||
| Line 99: | Line 94: | ||
'''Address Role''' | '''Address Role''' | ||
| width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | | width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| - | Creates a field with a | + | Creates a field with a drop-down list where the user selects the desired [[Description_of_the_Sub-Menu_Address_Roles|Address role]]. |
|- | |- | ||
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | | width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
'''Language''' | '''Language''' | ||
| width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | | width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| - | Creates a field with a | + | Creates a field with a drop-down list where the user selects the desired [[Description_of_the_Menu_Versions_Languages|language]]. |
|- | |- | ||
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | | width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
'''Variant''' | '''Variant''' | ||
| width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | | width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| - | Creates a field with a | + | Creates a field with a drop-down list where the user selects the desired [[Description_of_the_Sub-Menu_Variants|Variant]]. |
|- | |- | ||
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | | width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
'''System''' | '''System''' | ||
| width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | | width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| - | Creates a field with a | + | Creates a field with a drop-down list where the user selects the desired system, sub-system or system group. |
| - | *All: Lists all the existing | + | *All: Lists all the existing [[Metis_Smart_Modeling_-_Systems#Systems|System]], sub-systems and system groups. |
*Systems Only: Lists all of the existing systems. | *Systems Only: Lists all of the existing systems. | ||
*System Groups: Lists all of the existing system groups. | *System Groups: Lists all of the existing system groups. | ||
| Line 123: | Line 118: | ||
'''Price Category''' | '''Price Category''' | ||
| width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | | width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| - | Creates a field with a | + | Creates a field with a drop-down list where the user selects the desired [[Description_of_the_Menu_Prices#Price_Categories|price category]]. |
|- | |- | ||
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | | width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
'''Country''' | '''Country''' | ||
| width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | | width="85%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| - | Creates a field with a | + | Creates a field with a drop-down list where the user selects the desired [[Description_of_the_Sub-Menu_Countries|country]]. |
|- | |- | ||
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" | | | width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" | | ||
| Line 137: | Line 132: | ||
|} | |} | ||
| - | |||
| - | |||
| - | + | == Adding a Customized Field == | |
| - | + | ||
| - | + | ||
| - | The | + | To begin creating a new customization, the user must select where in Smart Quotes or Smart Modeling they would like to create a new field. The table on the left-hand side lists the different parts that can be customized with a new field. Once a category has been selected and is currently highlighted, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main table allows the user/administrator to create a new Field. When it is clicked, the Standard Custom Item''' or '''Searchable Custom Item''' creation window opens, it allows to define all related information. The difference between the two is that a searchable custom is just like a standard custom item except for the fact that once created, in addition to creating a field for the customization, a search criteria field is also added to the search section found on the left of the main window in Metis Smart Quotes. |
| - | + | After choosing the desired item and confirming, the window '''Custom Item - (designation)''' window will open where designation is replaced with whichever designation (application part) was previously chosen. | |
| - | |||
| - | |||
| + | [[File:MSM_Data_Management_Customizing_Add.png|center]] | ||
| - | |||
| - | + | The window contains the following fields, check-boxes and radio buttons to define the new field: | |
| - | *Statistics: | + | * '''Item Name''' : name given to the new field. |
| + | * '''Code''' : additional reference to the field. | ||
| + | * '''Section''' : certain windows have multiple sections each with different fields. This drop-down list presents the available sections which the user may select. If nothing is listed, the window has only one section. | ||
| + | * '''Public''' : allows child versions to see the new field. | ||
| + | * '''Statistics''' : the data from this customization is saved and can be later used and viewed statically in excel for example. | ||
| + | * '''Keep the value if duplicated''' : only applicable when duplicating items. For example, the user has added several customizations to an offer. He wants that when duplicating the offer, the values associated with these customizations are also duplicated. | ||
| + | * '''Mandatory field''' : field is set as mandatory, and will be represented in bold text and/or with a red arrow before it. | ||
| + | * '''Description''' : simple description of the field that the user may choose to add. This is the text which will be displayed in the application if entered, otherwise the Item Name will be used. | ||
| + | * '''Type''' : field type can be selected. Please refer to the list above for reference. | ||
| + | * '''Option''' : option linked to the selected type for the field. Please refer to the list above for reference. | ||
| - | |||
| - | |||
| - | + | [[File:MSM_Data_Management_Customizing_Add_Standar_cust_item.png|center|600x400px]] | |
| - | |||
| - | + | {{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 field can be saved by validating the '''Custom Item - (designation)''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. | |
| + | {{Note | ||
| + | | When adding new customizations to both Smart Quotes and Smart Modeling, the user will have to restart the application for the changes to take effect. | ||
| + | }} | ||
| + | {{Video | ||
| + | | <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/7/7c/VID_AddingFieldOfferLevel.PNG'>File:Adding_a_Field_at_the_Project_Level_OK.mp4</mediaplayer> | ||
| + | | Setting up a new field in the Project level. | ||
| + | }} | ||
| + | {{Video | ||
| + | | <mediaplayer width='400' height='300' image='http://http://www.xpert-technologies.ch/mediawikidev/images/4/4b/VID_AddingFieldProjectLevel.PNG'>File:Adding_a_Field_at_the_Offer_Level_OK.mp4</mediaplayer> | ||
| + | | Setting up a new field in the Offer level. | ||
| + | }} | ||
| - | |||
| + | Once all necessary information provided, the new field will be saved when the window is validated. It will then be placed in the appropriate part of the selected designation. | ||
| + | == Modifying a Customized Field == | ||
| - | + | In the '''Customizing''' 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 Customized Field. Selecting a Customized Field and clicking on it opens the '''Custom Item - (designation)''' edition window where all related properties and information can be edited. | |
| + | [[File:MSM_Data_Management_Customizing_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 Customized Field. Modifications applied to the selected Customized Field will only be saved once the '''Custom Item - (designation)''' 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. |
| + | {{Note | ||
| + | | When modifying a Customized Field for either Smart Quotes or Smart Modeling, the user will have to restart the application for the changes to take effect. | ||
| + | }} | ||
| + | ==Sorting Customized Field== | ||
| - | + | The "Sort" button [[File:MetisSmartModelingSortButton.PNG|link=]] allows the user to change the order of how the different customizations are shown in the table below. This order is important because it reflects exactly the order of how the customizations are later presented in either Smart Quotes or Smart Modeling. | |
| - | + | When clicking the button, the sorting window opens. It allows the administrator to define the order in which the custom Field are displayed both in the table and in the applications they are intended. Sorting is by selecting an item and moving it up and down with the green arrows on the right of the table. | |
| - | |||
| - | |||
| + | [[File:MSM-Data-Management-Customizing-Sort.png|center]] | ||
| - | + | Once the order is set, it can be saved by validating the window. | |
| - | |||
| - | + | {{Note | |
| + | | When modifying the order of Customized Fields for either Smart Quotes or Smart Modeling, the user will have to restart the application for the changes to take effect. | ||
| + | }} | ||
| - | |||
| - | + | == Deleting a Customized Field == | |
| - | + | In the '''Customizing''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Customized Field. Selecting a Customized Field and clicking on it displays the following confirmation window. | |
| - | + | [[File:MSM_Data_Management_Customizing_Delete.png|center]] | |
| - | + | ||
| - | + | ||
| - | |||
| - | + | Once the warning is confirmed, the selected Customized Field is removed from Metis Smart Suite and deleted from the Metis Database. | |
| - | |||
| - | + | == Previewing a Customized Field == | |
| + | In the '''Customizing''' 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 Customized Field. Selecting a Customized Field from the table and clicking on it opens the '''Custom Item - (designation)''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Customized Field. | ||
| - | |||
| - | + | [[File:MSM_Data_Management_Customizing_Preview.png|center|600x400px]] | |
| - | |||
{{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. |
}} | }} | ||