Description of the Sub-Menu Customizing
From Metis Documentation
| Line 1: | Line 1: | ||
| - | Description of the different functionalities and | + | Description of the Customizing sub-menu |
| + | |||
| + | The customizing sub-menu enables users to customize both Smart Quotes and Smart Modeling by creating new fields. 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 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 chosen. | ||
| + | [screenshot of the customizing sub-menu] | ||
| + | |||
| + | 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 categories that can be customized with a new field. | ||
| + | Once a category has been selected and is currently highlighted, the user may then click on the '''Add''' button to start the process. | ||
| + | |||
| + | 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 new customization. | ||
| + | |||
| + | 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. | ||
| + | |||
| + | |||
| + | ===Field Types and Options=== | ||
| + | |||
| + | The different types of customizations are listed table 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 dropdown list to the selection of a certain file or folder from the windows explorer. | ||
| + | |||
| + | |||
| + | {| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; | ||
| + | |||
| + | border-style: solid; border-color: grey;" | ||
| + | |- | ||
| + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Type of rule | ||
| + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Icons | ||
| + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Description | ||
| + | |- | ||
| + | | width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
| + | '''Single selection''' | ||
| + | | width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
| + | [[File:MetisSmartModelingRuleSIngle.PNG|link=]] | ||
| + | | width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| + | The [[#Single_Selection|Single Selection]] rule tests an input and calculates the defined output based on a simple | ||
| + | |||
| + | logical relation. | ||
| + | |- | ||
| + | | width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" | | ||
| + | '''External selection''' | ||
| + | | width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 0 0" | | ||
| + | [[File:MetisSmartModelingRuleExternal.PNG|link=]] | ||
| + | | width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" | | ||
| + | The goal of an [[#External_Selection|external rule]] is to use a third party application (software) to calculate | ||
| + | |||
| + | the output of a rule. | ||
| + | |- | ||
| + | |} | ||
| + | |||
| + | |||
| + | *Boolean: 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: | ||
| + | **0 / 1 | ||
| + | **Yes / No | ||
| + | **True / False | ||
| + | **Enable / Disable | ||
| + | **Optional / Mandatory | ||
| + | **Editable / Read Only | ||
| + | **Checkbox: The checkbox option equates to being true when ticked and false when left unticked. | ||
| + | |||
| + | |||
| + | *Numerical: Creates a field where the input can only be numerical. The user has the option to pick between integers or real numbers. | ||
| + | **Integer: Any number without a fractional component. | ||
| + | |||
| + | **Real: Any number with a fractional component. | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | *Alphanumerical: Creates a field where only numbers and letters can be entered. The following alphanumeric options are available. | ||
| + | **String: A normal sequence of letters and numbers. | ||
| + | **Multi Language String: A normal sequence of letters and numbers that can be saved for different languages. | ||
| + | **Password: A sequence of letters and numbers that is masked by asterisks. | ||
| + | |||
| + | |||
| + | *Date: Creates a field where a calendar graphic will pop up and the user may select the date by either entering it in themselves or using the arrows to scroll to the desired date. | ||
| + | |||
| + | |||
| + | *List: Creates a field with a dropdown list where the user may select an entry from the list that was chosen when creating the customization. | ||
| + | **List Type: All the existing lists found in Smart Modeling are found in this dropdown list. | ||
| + | |||
| + | |||
| + | *Directory: Creates a field where the user opens the windows explorer and selects the desired directory. | ||
| + | |||
| + | |||
| + | *File: Creates a field where the user opens the windows explorer and selects the desired file. | ||
| + | |||
| + | |||
| + | Image: Creates a field where the user can open the windows explorer and choose the desired image file to import. | ||
| + | |||
| + | |||
| + | *User: Creates a field where the user may select a user from the list of existing users. | ||
| + | **User Role: Selecting a user role narrows the list of users down to only the users found in the user role selected. For example, selecting the user role '''Sales''' would have the list of users be only users found in the '''Sales''' user role. | ||
| + | |||
| + | |||
| + | *User Role: Creates a field where the user may select a user role from the list of existing user roles. | ||
| + | |||
| + | |||
| + | *Address: Creates a field where the user can then open a new window and find the appropriate address using the address search criteria. | ||
| + | **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. | ||
| + | **Address filtered by role: Lists the address but with an address role filter allowing only certain addresses to show up in the list. | ||
| + | |||
| + | |||
| + | *Address Role: Creates a field with a dropdown list where the user selects the desired address role. | ||
| + | |||
| + | |||
| + | *Language: Creates a field with a dropdown list where the user selects the desired language. | ||
| + | |||
| + | |||
| + | *Variant: Creates a field with a dropdown list where the user selects the desired variant. | ||
| + | |||
| + | |||
| + | *System: Creates a field with a dropdown list where the user selects the desired system, sub-system or system group. | ||
| + | |||
| + | |||
| + | **All: Lists all the existing systems, sub-systems and system groups. | ||
| + | **Systems Only: Lists all of the existing systems. | ||
| + | **System Groups: Lists all of the existing system groups. | ||
| + | **Sub-systems: | ||
| + | Lists all of the existing sub-systems. | ||
| + | |||
| + | |||
| + | |||
| + | *Price Category: Creates a field with a dropdown list where the user selects the desired price category. | ||
| + | |||
| + | |||
| + | *Country: Creates a field with a dropdown list where the user selects the desired country. | ||
| + | |||
| + | |||
| + | *Label: | ||
| + | Creates a blank field where the user may then enter in a label of their choosing. | ||
| + | |||
| + | |||
| + | |||
| + | ==Add== | ||
| + | |||
| + | [screenshot of the add customization window] | ||
| + | |||
| + | The '''Add''' button allows the user to add a new customization. When the '''Add''' button is clicked, a window opens where the user must choose the type of customization between either '''Standard Custom Item''' and '''Searchable Custom Item'''. | ||
| + | The difference between the two is that a searchable custom is just like a standward 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 window in Smart Quotes. | ||
| + | After choosing the desired item and confirming, the window '''Custom Item - (designation)''' window will open with the word designation being replaced with whichever designation was previously chosen. | ||
| + | |||
| + | The window contains the following fields, checkboxes and radio buttons: | ||
| + | |||
| + | *Item Name: A name given to the new customization set by the user. | ||
| + | |||
| + | *Code: | ||
| + | An additional reference to the customization that the user can add. | ||
| + | |||
| + | |||
| + | *Section: Certain windows have multiple sections each with different fields. This dropdown list presents the available sections which the user may select. If nothing is listed, the window has only one section. | ||
| + | |||
| + | *Public: Ticking this checkbox allows the child versions the ability to see the new customization. | ||
| + | |||
| + | *Statistics: Ticking this checkbox means that the data from this customization is saved and can be later used and viewed statiscally in perhaps excel for example. | ||
| + | |||
| + | *Keep the value if duplicated: Ticking this checkbox is only applicable when duplicating items. For example, the user has added several customizations to an offer. | ||
| + | The user wants that when duplicating the offer, the values associated with these customizations are also duplicated, therefore they tick the checkbox. | ||
| + | |||
| + | *Mandatory field: Ticking this checkbox adds on something to signify that the field is mandatory, such as bold text or a red arrow before it. | ||
| + | |||
| + | *Description: A simple description of the customization that the user may choose to add. | ||
| + | |||
| + | * Type | ||
| + | |||
| + | * Option | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Delete== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Edit== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Preview== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Sort== | ||
| + | |||
| + | [screenshot of how the sort button works with customizations and sections] | ||
| + | |||
| + | The '''Sort''' button allows the user to change the order of how the different customizations are shown in the table below. | ||
| + | This order presented in the table below is important because it reflects absolutely the order of how the customizations are later presented in either Smart Quotes or Smart Modeling. | ||
| + | |||
| + | |||
== Which fields can be customized? == | == Which fields can be customized? == | ||
| Line 6: | Line 202: | ||
== Modifying a Customized Field == | == Modifying a Customized Field == | ||
| + | |||
| + | [screenshot of the edit customization window] | ||
| + | |||
| + | The '''Edit''' button allows the user to modify the properties of a customization. | ||
| + | |||
| + | Selecting a customization and clicking on the '''Edit''' button opens the '''Customization''' window. Every field that was available when creating a new customization can now be edited in this window, such as the item name, type, and option. | ||
| + | |||
== Deleting a Customized Field == | == Deleting a Customized Field == | ||
| + | |||
| + | The '''Delete''' button allows the user to delete an existing customization. | ||
| + | |||
| + | Multiple customizations may be selected and deleted together. | ||
| + | |||
| + | When deleting a customization, the following pop-up window appears: | ||
| + | |||
| + | [Screen shot of the delete customization window] | ||
| + | |||
| + | The user must confirm the message before the customization can be deleted. | ||
| + | |||
| + | |||
| + | == Previewing a Customized Field === | ||
| + | |||
| + | The '''Preview''' button allows the user to see the properties of the selected customization. | ||
| + | |||
| + | Selecting a customization and clicking on the '''Preview''' button opens the '''Custom Item - (Designation)''' window. All the properties of the customization are shown here in this window. | ||
| + | |||
| + | {{Note | ||
| + | | It is not possible to edit the properties of the customization in the '''Preview''' customization window. This must be done with the '''Edit''' button. | ||
| + | }} | ||