Metis Documentation - User contributions [en]

Metis Smart Modeling - Rules

2014-02-26T07:39:36Z

PatrickG: /* Formulas */

In the Metis Smart Suite, a Rule is a determinate method for performing a logical or mathematical operation and obtaining a certain result which is the building block of the modeling concept(configurator). It is based on a simple structure and logic which can be used in an endless number of cases and will suit most of the requirements for material and service configuration.

== What is a rule? ==

[[Image:Model_Exec_3.png|thumb|upright=0.5|alt=Metis Smart Quote Rule Execution Description|Metis Smart Quote Rule Execution Description]]
Based on the [[Metis_Smart_Modeling_-_Models|model]] execution scheme, rules fit inside of [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] in Metis. They are the logical part of the execution process. As described in the [[Metis_Smart_Modeling_-_Models|model]] section, once a [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] is executed, all [[Metis_Smart_Modeling_-_Variables|variables]] are instantiated and only after this the rules are executed. In opposition to groups of rules inside a [[Metis_Smart_Modeling_-_Models|model]], rules don't have a specific order in which they are executed. The execution of Rules is done in parallel. As pictured on the right, the execution of a rule first tests if the rule should be run by testing if the defined filter can be validated. If the test is OK then the process moves to the rule or formula itself. If and only if that steps produces an output the process then moves to the addition of add-ons. Those can be seen as dependencies of the result of the rule or formula. Throughout the execution, the values used in fields input are taken from the Group of rules in which the Rule is currently being executed.

[[File:MetisSmartModelingSCRulesDef2.PNG|center|706x860px]]

A rule is typically made out of three different parts which can work together :

1. '''Description''' : Main information regarding the rule.

{| class="wikitable centre" width="100%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: transparent; background-color : transparent;"
| width="20%" style="vertical-align: top; background-color : transparent; border-style: solid; border-color: transparent; border-width: 0 1px 1px 0" |
''Type''
| width="80%" style="vertical-align: top; background-color : transparent; border-style: solid; border-color: transparent; border-width: 0 0 1px 0" |
Allows to define the type rule will take and modify the 'Formula' part of the rule. (mandatory)
|-
| width="20%" style="vertical-align: top; background-color : transparent; border-style: solid; border-color: transparent; border-width: 0 1px 1px 0" |
''ID''
| width="80%" style="vertical-align: top; background-color : transparent; border-style: solid; border-color: transparent; border-width: 0 0 1px 0" |
Once the rule has been saved, the ID field will automatically completed by Metis Smart Modeling. The generated identification code is unique worldwide and can be useful for searching for a rule or debugging it, if necessary. (mandatory, but generated automatically upon validation)
|-
| width="20%" style="vertical-align: top; background-color : transparent; border-style: solid; border-color: transparent; border-width: 0 1px 1px 0" |
''Comment''
| width="80%" style="vertical-align: top; background-color : transparent; border-style: solid; border-color: transparent; border-width: 0 0 1px 0" |
When creating a new rule, the user must enter a comment, or short description, that will be displayed on reports and lists. (mandatory)
|-
| width="20%" style="vertical-align: top; background-color : transparent; border-style: solid; border-color: transparent; border-width: 0 1px 1px 0" |
''Description''
| width="80%" style="vertical-align: top; background-color : transparent; border-style: solid; border-color: transparent; border-width: 0 0 1px 0" |
A long description ca be given to all rules defined within Metis Smart Modeling. This helps explain what the Rule does.
|-
| width="20%" style="vertical-align: top; background-color : transparent; border-style: solid; border-color: transparent; border-width: 0 1px 1px 0" |
''Round output down''
| width="80%" style="vertical-align: top; background-color : transparent; border-style: solid; border-color: transparent; border-width: 0 0 1px 0" |
If this check-box is ticked, any fractions of output resulting from a rule will not be taken into account. This means that the result will only be composed of whole units. This applies in particular when using a formula based rule.
|-
| width="20%" style="vertical-align: top; background-color : transparent; border-style: solid; border-color: transparent; border-width: 0 1px 1px 0" |
''Mandatory External Control (Offer)''
| width="80%" style="vertical-align: top; background-color : transparent; border-style: solid; border-color: transparent; border-width: 0 0 1px 0" |
Mandatory Controls, implied by the presence of a system name, are considered to be applied on the offer level. The influence in Metis Smart Quotes is that it will still be possible to view and print offer documents for the Metis Smart Quotes end user until an external configurator control can be performed. There is no icon to represent the Mandatory Control applied on the offer level.
|-
| width="20%" style="vertical-align: top; background-color : transparent; border-style: solid; border-color: transparent; border-width: 0 1px 1px 0" |
''Mandatory External Control (Order)''
| width="80%" style="vertical-align: top; background-color : transparent; border-style: solid; border-color: transparent; border-width: 0 0 1px 0" |
Mandatory Controls, implied by the presence of a system name, are considered to be applied on the order level. The influence in Metis Smart Quotes is that the ordering process will be blocked for the Metis Smart Quotes end user until an external configurator control can be performed, but it will still be possible to view and print offer documents. There is no icon to represent the Mandatory Control applied on the order level.
|-
| width="20%" style="vertical-align: top; background-color : transparent; border-style: solid; border-color: transparent; border-width: 0 1px 0 0" |
''Mandatory Internal Control (Offer)''
| width="80%" style="vertical-align: top; background-color : transparent; border-style: solid; border-color: transparent; border-width: 0 0 0 0" |
Mandatory Control intended for [[Metis_Smart_Modeling_-_Systems|systems]] which do not have system names. They require Metis Smart Quotes end users to perform a mandatory control of [[Metis_Smart_Modeling_-_Systems|system]] configuration. The mandatory controls of [[Metis_Smart_Modeling_-_Systems|systems]] will have to be performed manually by a specifically authorized user as opposed to being handled by an external configurator like Mandatory External Control. It will be applied on the offer level. It is basically the same as the Mandatory Internal Control (Order) with the added restriction that it will not be possible for the end user to view and print offer documents.
|-
| width="20%" style="vertical-align: top; background-color : transparent; border-style: solid; border-color: transparent; border-width: 0 1px 1px 0" |
''Mandatory Internal Control (Order)''
| width="80%" style="vertical-align: top; background-color : transparent; border-style: solid; border-color: transparent; border-width: 0 0 1px 0" |
Mandatory Controls intended for [[Metis_Smart_Modeling_-_Systems|systems]] which do not have system names. Similar to the above Mandatory Control, they also require Metis Smart Quotes end users to perform a mandatory control of the [[Metis_Smart_Modeling_-_Systems|system]] configuration. The mandatory controls of [[Metis_Smart_Modeling_-_Systems|systems]] will have to be performed manually by an specifically authorized user as opposed to being handled by an external configurator like Mandatory External Control. Will be applied on the order level, meaning that the ordering process will be blocked for the Metis Smart Quotes end user until a manual control can be performed. It will still be possible for the end user to view and print offer documents, however.
|-
| colspan="2" width="80%" style="vertical-align: top; background-color : white; border-style: solid; border-color: transparent; border-width: 0 0 0 0" |
{| class="wikitable centre" width="100%" 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" |
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''External Controls''' (ProductName)
! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | '''Internal Controls''' (no ProductName)
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Applied on the '''Order Level'''
| width="40%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Ordering process blocked until external configurator control has been completed.
| width="40%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Ordering process blocked until manual control has been completed.
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
Applied on the '''Offer Level'''
| width="40%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
Ordering process and Document Generation blocked until external configurator control has been completed.
| width="40%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Ordering process and Document Generation blocked until manual control has been competed.
|-
|}
|-
|}

{{Note
| Whether the Mandatory Internal Control has been set on the order level or offer level, there will be no difference in the display in QSBW. The same small yellow icon will be displayed for either one.
}}

{{Note
| Only one type of Mandatory Internal Control can be active on a rule at a time.
}}

{{Note
| The Mandatory External Control (Offer) and a Mandatory Internal Control can be active on the same rule at the same time. However, Mandatory Internal Controls will not have any influence on a [[Metis_Smart_Modeling_-_Systems|system]] which has a system name. [[Metis_Smart_Modeling_-_Systems|Systems]] which have a [[Metis_Smart_Modeling_-_Systems|system]] name will only take into account whether or not the White Flag (Offer) has been applied. Conversely, the White Flag (Offer) setting will have no influence on [[Metis_Smart_Modeling_-_Systems|systems]] which do not have a system name.
}}

2. '''Filter''' : Part of the rule which allow to configure the circumstances in which the rule is valid and should be executed by the application. Enabling the rule only under specific conditions
The Variable Filter validates the rule according to [[Metis_Smart_Modeling_-_Variables|variables]], products, or [[Metis_Smart_Modeling_-_Variables|groups of variables]].

To select a new variable, select a line and click to enter. Give the name, or part of the name of your parameter or a space to select all and click “ENTER.”

3. '''Formula''' : It is the logical or mathematical part of a rule. Setting up the rule, please refer to the various formula types for detailed description of how to setup each of them.

{{Note
| When specifying output, users only have the choice between “Product” and “Variable”, as it is not possible to set the value of a [[Metis_Smart_Modeling_-_Variables|group of variables]] or an [[Metis_Smart_Modeling_-_Attributes|attribute]].
}}

4. '''Add-On's'''' : Based on the result provided by the Formula part, a rule can be set-up to add implied positions or define new values in [[Metis_Smart_Modeling_-_Variables|variables]]. Additional results from the rule based on the result of the "formula"

{{Note
| When specifying output, you will only have the choice between “Product” and “Variable”, as it is not possible to set the value of a [[Metis_Smart_Modeling_-_Variables|group of variables]] or an [[Metis_Smart_Modeling_-_Attributes|attribute]].
}}

A rule may use the following items in its different parts :

{| 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" | Object
! 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" |
'''Positions'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingPositionIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
material and service '''Positions''' (input and output) can be used as a parameter (taking into account the quantity) or as output (setting the quantity through the execution of the formula)
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''[[Metis_Smart_Modeling_-_Attributes|Attributes]]'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
()
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
(input only) [[Metis_Smart_Modeling_-_Attributes|attributes]] values added-up over the complete offer can be used as input for rules
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''[[Metis_Smart_Modeling_-_Variables|Variables]]'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVariableIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
(input and output) can be used as a parameter in the filter and formula part of a rule (taking into account its value) or as an output in the formula or add-on part of a rule (the obtained value will be set to the variable)
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''[[Metis_Smart_Modeling_-_Variables|Group of variables]]'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
[[File:MetisSmartModelingVariableGroupIcon.png‎|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
(input only) can be used as a parameter in the filter and formula part of a rule (taking into account the sum of all the positions and [[Metis_Smart_Modeling_-_Variables|variables]] it includes)
|-
|}

Because rules are essentially based on value given to [[Metis_Smart_Modeling_-_Variables|variables]] and /or positions, most of the numerical information which needs to be given when defining a rule is placed quantity fields:

{| 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" | Value
! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Description
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Q from'''
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
The value set in this field will define the lower limit for which the rule is valid and should be executed. For example, if the '''Q in''' value is 6 and that the "Q from" value is 5, then the rule will provide an output. The "Q from" value can also be considered as a base value for the [[Metis_Smart_Modeling_-_Systems|system]] in which the [[Metis_Smart_Modeling_-_Models|model]] is used.
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Q to'''
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
The value set in this field will define the upper limit for which the rule is valid and should be executed. For example, if the '''Q in''' value is 6 and that the "Q to" value is 4, then the rule will not provide an output.
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Q in'''
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
The value set in this field will define
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Q out'''
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
The value set in this field will define
|-
|}

{{Warning
| [[Metis_Smart_Modeling_-_Attributes|Attributes]] do not hold any values in material [[Metis_Smart_Modeling_-_Models|models]], as in Rules their value is calculated based on a list of material and that this list is only available when the execution of the model is completed.
}}

== Rule types ==

Rules which can be configured in Metis are divided into 7 categories:

{| 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 1px 0" |
'''Table selection'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingRuleTable.PNG‎|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
The goal of a [[#Table_Selection|Table Selection]] is to determine an output quantity within several ranges of input values
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Optimal selection'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingRuleOptimal.PNG‎|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
The goal of an [[#Optimal_Selection|optimal rule]] is to automatically select of the best alternative depending on the input quantity required and the related price.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Maximal selection'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingRuleMaximal.PNG‎|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
In [[#Maximal_Selection|this type]] of rule each line will be used as a single criterion and Metis will return the lowest result possible.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Minimal selection'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingRuleMinimal.PNG‎|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
In [[#Minimal_Selection|this type]] of rule each line will be used as a single criterion and Metis will return the lowest result possible.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Formula selection'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingRuleFormula.PNG‎|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
The goal of a [[#Formulas|formula based rule]] is to use arithmetic and logic function to calculate an output for a rule.
|-
| 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.
|-
|}

{{Warning
| Changing the type of an existing rule will not reset its content (filter, inputs, outputs and add-ons). Be careful when doing such changes and review all parts of the rule before saving it. Metis Smart Modeling will discard all changes which do not apply to the new type when validating then in the rule edition window. The change cannot be reverted.
}}

=== Single Selection ===

The single selection rule tests an input and calculates the defined output based on a simple logical relation. The Input "object" can be of any type available, but the output one can only be a position or a variable. If the input is set to be a variable, its value may come directly from a field placed in a [[Metis_Smart_Modeling_-_Masks|mask]] or a default value. The output quantity ('''Q out''') is determined by the input quantity ('''Q in'''). If they are both set to "1", then for every number of input there will be an output. On the other hand, if the '''Q out''' fields is set to 2, it means that for every input there will be 2 output.

[[File:MetisSmartModelingSCRuleSingle.PNG‎|center|700x600px]]

{{Warning
| Beware that if the '''Q in''' field is left empty, the output will be equal to the input. The output value will always be equal to the input value, for any '''Q in''' value.
}}

In certain case their could be a 'start' value for the output provided by the rule. For example a motherboard is generally already equipped with multiple USB ports, in this case lets say 4. Based on the result of the execution, the required number of ports could be 6. s the base of the 'system' being modeled already '''includes''' 4, the result of the rule should be 1. This value could then be used in another Group of rules to define an expansion card for the system. The '''Q included''' field allows to define the value that is already available in the model.

{{Note
| If the '''Q from''' field is left empty, this means ‘from 0'. If the '''Q to''' field is left empty, this means “up to ∞” (or > 999'999'999).
}}

{{Note
| Only the input value will be considered by the range filter.
}}

In the “Modeling” menu, make sure that the “Rules” sub-menu has been selected.
On the left, in the “Groups of rules” dropdown list, select “D-Basic Hardware.”
Click on add [[File:MetisSmartModelingPLUSButton.PNG|link=]]. A window opens where the new rule will be created.
In the “Type” field, select “Single” from the dropdown list. In the “comment” field, enter a name for the rule, for example, “Configure Memory.”
The goal of this example rule is to generate the number of memory modules required based on the desired quantity of memory provided in a [[Metis_Smart_Modeling_-_Masks|mask]].
Click on the add button near the “input” field. A window opens where it is possible to select positions, [[Metis_Smart_Modeling_-_Variables|variables]], and [[Metis_Smart_Modeling_-_Attributes|attributes]]. Select “[[Metis_Smart_Modeling_-_Variables|variables]]”.
Select “$Memory” from the list and confirm.
Click on the add button near the “Output” field. The same window from before opens, but it is only possible to select positions or [[Metis_Smart_Modeling_-_Variables|variables]]. In this example a position is added.
In the description field, enter “ddr” and click on filter.
Select “DDR2 1GB” from the list and confirm.
In the field '''Q in''' enter the value “1.”
To test this new rule, click on the “test” button.
The test window opens.
In the “test value” field for “$Memory” enter “4.”
Click on the test button. The results appear below.
In this example the result value is also “4” because '''Q in''' and '''Q out''' were both set to “1.”
Close the test window.
Now click on confirm to save the rule. It now appears in the list of rules.

{| 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" | '''Q in'''
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q out'''
! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
1
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
1
| width="70%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Output will have the same quantity as Input.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
5
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
1
| width="70%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
1 output will be added to each group of 5 units of input.
If Q in = 3, Q out = 1

If Q in = 8, Q out = 2

If Q in = 15, Q out = 3

If the parameter ‘No Treatment of the rest' is activated, the result would be:
If Q in = 3, Q out = 0

If Q in = 8, Q out = 1

If Q in = 15, Q out = 3
|-
|}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/c/c8/VID_Creating_a_single_rule.PNG'>File:Creating_a_single_rule_OK.mp4</mediaplayer>
| Definition of a single rule within Metis Smart Modeling.
}}

=== Table Selection===

The goal is to determine an output quantity within several ranges of input values. The rule allows to enter several '''Q from''' and '''Q to''' to determine those ranges. They each then induce a specific '''Q out''' which will be used as a quantity for the output.

[[File:MetisSmartModelingSCRuleTable.PNG‎|center|700x600px]]

In the “Modeling” menu, make sure to select the “rules” sub-menu.
To create a new rule, first select an existing [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] from the drop down list. For example, “s-basic enhancements.”
Then click on the “Add” button [[File:MetisSmartModelingPLUSButton.PNG|link=]]. A window opens where the rule will be created.
In the “Type” field, select “table.”
In this particular example, a condition is first set to execute the rule only if a variable has a value greater than 0.
Then, an output quantity will depend upon an input value entered in a [[Metis_Smart_Modeling_-_Masks|mask]].
In the “comment” field, enter “Define RAID Type.”
Additional comments can be entered in the box below the “comment” field if desired.
Click on the “add” button [[File:MetisSmartModelingPLUSButton.PNG|link=]] for the “filter” section.
A new window opens. It is possible to add positions, [[Metis_Smart_Modeling_-_Variables|variables]] or [[Metis_Smart_Modeling_-_Attributes|attributes]]. Select “[[Metis_Smart_Modeling_-_Variables|variables]]”.
In the [[Metis_Smart_Modeling_-_Variables|variables]] list, select “$HasRAID.” Then click on confirm.
The variable is now added to the filter variable table.
In the “filter [[Metis_Smart_Modeling_-_Variables|variables]]” section, change the “Condition” to “greater than.”
The main part of the rule is shown by the blue and red colored sections in the middle of the window, where the inputs and outputs can be entered.
The purpose of this rule is to determine which RAID configuration will be setup in the [[Metis_Smart_Modeling_-_Systems|system]] based on the selection done in a [[Metis_Smart_Modeling_-_Masks|mask]].

To do so, click on the “add” button [[File:MetisSmartModelingPLUSButton.PNG|link=]] for the “Input” section.
The same window from before opens. Select “[[Metis_Smart_Modeling_-_Variables|variables]]” and select “$RAID_Type” from the list.
Click on confirm. The variable is added to the input field.
Click on the “add” button [[File:MetisSmartModelingPLUSButton.PNG|link=]] for the “output” section.
The same window from before opens. Select “[[Metis_Smart_Modeling_-_Variables|variables]].”
Select “$NB_HDD” from the list and confirm to continue. The variable is added to the output field.
The requirement for this rule is that for a RAID configuration with a value of 0 or 1, the number of disks must be 2, hence why '''Q out''' is set to 2. With a value anywhere from 2 to 10, the number of disks must be 3, hence '''Q out''' is set to "3".
Therefore, under the Q fields, in the first field, Set '''Q from''' to “0,” '''Q to''' to “1” and '''Q out''' to “2.”
In the second field, set '''Q from''' to “2,” '''Q to''' to “10,” and '''Q out''' to “3.”
Please note, that although it is not displayed the value “0” for '''Q from''' has indeed been saved.
The rule can now be tested.
Click on the “Test” button found at the top. A test window opens.
Enter “1” in the “Test value” column for both the “$HasRAID” and “$RAID_Type” fields.
Click on the “Test” button.
In the table below the “test” button, the results appear.
The result for the “$NB_HDD” variable is 2.
Now change the test value for “$Raid_Type” to “5” and click on test again.
Notice the result is now “3” for the “$NB_HDD” variable.
Close the test window and then confirm to save the new rule.

{| 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" | '''Q from'''
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q to'''
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q out'''
! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark
|-
| width="10%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
2
| width="10%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
1
| width="10%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
3
| width="70%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
If the input in defined between 1 and 3, the output will be 2.
|-
| width="10%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
4
| width="10%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
12
| width="10%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
4
| width="70%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
If the input is defined between 4 and 12, then the output will be 4.
|-
|}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/6/66/VID_Creating_a_table_rule.PNG'>File:Creating_a_Table_Rule_OK.mp4</mediaplayer>
| Definition of a table rule within Metis Smart Modeling.
}}

=== Optimal Selection ===

This very performing rule enables the automatic selection of the best alternative depending on the output quantity required and the related price. This rule is particularly appreciated in selecting products when one input corresponds to several possible output results.

Basically, the application will calculate all output as if they were "Single selection" rules and then compare all results based on the resulting price. With this result it will then chose the least expensive one as the output of the rule.

[[File:MetisSmartModelingSCRuleOptimal.PNG‎|center|700x600px]]

In the “Modeling” menu, make sure that the “Rules” sub-menu has been selected.
On the left, in the “Groups of rules” dropdown list, select “Server Software 2.”
Click on the "Add" button [[File:MetisSmartModelingPLUSButton.PNG|link=]]. A window opens where the new rule will be created.
In the “Type” field, select “Optimal” from the dropdown list. In the “comment” field, enter a name for the rule, for example “determine best license package.”
Click on the add button near the “input” field. A window opens where it is possible to select positions, [[Metis_Smart_Modeling_-_Variables|variables]], and [[Metis_Smart_Modeling_-_Attributes|attributes]]. Select “[[Metis_Smart_Modeling_-_Variables|variables]]”.
In the list below, select “$NB_Licences.” Click on confirm.
Click on the add button near the '''Q in''' field. The same window from before opens, but it is only possible to select positions or [[Metis_Smart_Modeling_-_Variables|variables]]. In this example a position is added.
In the description field, enter “cal” and then click on filter.
From the results, select the position “Windows Server 2008 CAL 1x” and then click on confirm.
Repeat the previous steps, but this time select “Windows Server 2008 CAL 5x” and click on confirm.
In '''Q in''' field for “Windows Server 2008 CAL 5x” set the value to “5.”
Click on the add button near '''Q in''' once again.
Repeat the previous steps and select the “Windows Server 2008 CAL 25x” position and click on confirm.
Enter “25” in the '''Q in''' field for “Windows Server 2008 CAL 25x”
The rule now states that based on the number of licenses, various solutions are possible. When executed, the rule looks up the prices of the various outputs to determine the cheapest and most suitable option.
To test this new rule, click on the “test” button.
The test window opens. Enter “10” in the “test value” cell and click on the “Test” button.
The results are shown below. Now enter “23” and click on “test.”
Close the test window. Click on confirm to save the rule. It now appears in the list of rules.

{| 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" | '''Q in'''
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q out'''
! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
24 and 8
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
1 and 1
| width="70%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
If the number of analogue ports needed is 30, the best configuration for the customer is to have 1 module with 24 ports and 1 with 8 ports.
If the number of analogue ports needed is 35, Metis will control which configuration would be the best for the customer between 1 x 24 + 2 x 8 and 2 x 24. The least expensive solution will be preferred and set as output.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
1, 100 and 1000
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
1 for each
| width="70%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
If the number of licenses needed is 850, Metis will test the different possibilities and select the cheapest one:
* 8 x 100 + 50 x 1
* 9 x 100
* 1 x 1000
|-
|}

{{Note
| As the optimal rule is a 'sequence' of single rules, the '''Q included''' field works as described above.
}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/0/0a/VID_Creating_an_optimal_rule.PNG'>File:Creating_an_optimal_rule_OK.mp4‎</mediaplayer>
| Definition of an optimal rule within Metis Smart Modeling.
}}

=== Maximal Selection ===

This type of rule can be used when several input values influence a specific output. Each line will be used as a single criterion and Metis will return the highest result possible. It is particularly useful when the goal is to define a minimal number of one position in order to satisfy several criteria. When the input quantity is not within the indicated range ('''Q from''' – '''Q to'''), the line will not be valid, thus not considered by the rule.

[[File:MetisSmartModelingSCRuleMaximal.PNG‎|center|700x600px]]

In the “Modeling” menu, make sure that the “Rules” sub-menu has been selected.
On the left, in the “Groups of rules” dropdown list, select “Server Software 1.”
Click on the "Add" button [[File:MetisSmartModelingPLUSButton.PNG|link=]]. A window opens where the new rule will be created.
In the “Type” field, select “Maximal” from the dropdown list. In the “comment” field, enter a name for the rule, for example “Determine number of MS licenses.”
Click on the "Add" button [[File:MetisSmartModelingPLUSButton.PNG|link=]] near the “input” field. A window opens where it is possible to select positions, [[Metis_Smart_Modeling_-_Variables|variables]], and [[Metis_Smart_Modeling_-_Attributes|attributes]].
Select “[[Metis_Smart_Modeling_-_Variables|variables]]”.
Select “$NB_Users” from the list and confirm.
Repeat the previous steps, but this time select the variable “$NB_Mailboxes” from the list and click on confirm.
Click on the "Add" button [[File:MetisSmartModelingPLUSButton.PNG|link=]] near the “Output” field.
The same window from before opens, but it is only possible to select positions or [[Metis_Smart_Modeling_-_Variables|variables]].
Select “[[Metis_Smart_Modeling_-_Variables|variables]]”.
Select “$NB_Licences” from the list and confirm.
To test this new rule, click on the “test” button.
The test window opens.
In the “test value” field for “$NB_Users” enter “25.” For “$NB_Mailboxes” enter “50.”
Click on the test button. The results appear below.
The purpose of the maximal rule is to output the maximum value found amongst several input values. This explains why the output value is “50” in this specific example.
Close the test window.
Click on confirm to save the rule. It now appears in the list of rules.

{{Note
| If the '''Q from''' field is left empty, this means ‘from 0'. If the '''Q to''' field is left empty, this means “up to ∞” (or > 999'999'999).
}}

{| 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" | '''Q in'''
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q out'''
! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
25 and 50
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
50
| width="70%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
In this case the result is equal to the highest test value given.
|-
|}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/3/3d/VID_Creating_a_maximal_rule.PNG'>File:Creating_a_maximal_rule_OK.mp4</mediaplayer>
| Definition of a maximal rule within Metis Smart Modeling.
}}

=== Minimal Selection ===

This type of rule uses the same logic as the Maximal Rule, but the lowest value will be returned as an output result.

{{Note
| If the '''Q from''' field is left empty, this means ‘from 0'. If the '''Q to''' field is left empty, this means “up to ∞” (or > 999'999'999).
}}

In the “Modeling” menu, make sure that the “Rules” sub-menu has been selected.
On the left, in the “Groups of rules” drop-down list, select “Server Software 1.”
Click on the "Add" button [[File:MetisSmartModelingPLUSButton.PNG|link=]]. A window opens where the new rule will be created.
In the “Type” field, select “Maximal” from the drop-down list. In the “comment” field, enter a name for the rule, for example “Determine number of MS licenses.”
Click on the "Add" button [[File:MetisSmartModelingPLUSButton.PNG|link=]] near the “input” field. A window opens where it is possible to select positions, [[Metis_Smart_Modeling_-_Variables|variables]], and [[Metis_Smart_Modeling_-_Attributes|attributes]].
Select “[[Metis_Smart_Modeling_-_Variables|variables]]”.
Select “$NB_Users” from the list and confirm.
Repeat the previous steps, but this time select the [[Metis_Smart_Modeling_-_Variables|variable]] “$NB_Mailboxes” from the list and click on confirm.
Click on the "Add" button [[File:MetisSmartModelingPLUSButton.PNG|link=]] near the “Output” field.
The same window from before opens, but it is only possible to select positions or [[Metis_Smart_Modeling_-_Variables|variables]].
Select “[[Metis_Smart_Modeling_-_Variables|variables]]”.
Select “$NB_Licences” from the list and confirm.
To test this new rule, click on the “test” button.
The test window opens.
In the “test value” field for “$NB_Users” enter “25.” For “$NB_Mailboxes” enter “50.”
Click on the test button. The results appear below.
The purpose of the maximal rule is to output the maximum value found amongst several input values. This explains why the output value is “50” in this specific example.
Close the test window.
Click on confirm to save the rule. It now appears in the list of rules.

{| 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" | '''Q in'''
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q out'''
! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
25 and 50
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
25
| width="70%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
In this case the result is equal to the lowest test value given.
|-
|}

See Maximal Rule for example of how to use this type of rule.

=== Formulas ===

In some cases, the previous rules categories are not sufficient for a suitable result. The mathematical formula rules may be very helpful in calculating services associated to certain equipment.

[[File:MetisSmartModelingSCRuleFormula.PNG‎|center|700x600px]]

In the “Modeling” menu, make sure that the “Rules” sub-menu has been selected.
On the left, in the “Groups of rules” dropdown list, select “Shipping.”
Click on the "Add" button [[File:MetisSmartModelingPLUSButton.PNG|link=]]. A window opens where the new rule will be created.
In the “Type” field, select “Formula” from the dropdown list. In the “comment” field, enter “Shipping.”
Click on the "Add" button [[File:MetisSmartModelingPLUSButton.PNG|link=]] near the “input” field. A window opens where it is possible to select positions, [[Metis_Smart_Modeling_-_Variables|variables]], and [[Metis_Smart_Modeling_-_Attributes|attributes]]. Select “[[Metis_Smart_Modeling_-_Attributes|Attributes]].”
Select “weight” and click on confirm.
Click on the "Add" button [[File:MetisSmartModelingPLUSButton.PNG|link=]] again. Select “[[Metis_Smart_Modeling_-_Variables|variables]]”. Search for the [[Metis_Smart_Modeling_-_Variables|variable]] “$Shipping_Type.” Select it and click on confirm.
Click on the add button near the “Output” field. Search for the “shipping and handling” position. Select it and click on confirm.
In the “Quantity =” field, enter the following formula “(Var1*Var2)/2"
To test this new rule, click on the “test” button.
The test window opens.
In the “test value” field for “weight” enter “12.” For “$Shipping_type” enter “3.”
Click on the test button. The results appear below. The formula is applied.
Note: The result of the formula is rounded if the result is not a whole number.
Close the test window.
Click on confirm to save the rule. It now appears in the list of rules.

{| 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" | '''Q in'''
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q out'''
! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
13 and 2
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
18
| width="70%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Based on the formula used in the example below :

''(Var1*Var2)/2''

The result with those input values is 18.
|-
|}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/1/14/VID_Creating_a_formula_based_rule.PNG'>File:Creating_a_formula_based_rule_OK.mp4</mediaplayer>
| Definition of a formula based rule within Metis Smart Modeling.
}}

The main mathematical functions that may be used in rules are described in the table below:

{| 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" | Function
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Description
! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Syntax
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Abs'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Calculates the absolute value of a numeric expression (integer or real).
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = Abs(<Numeric>)

'''Parameter Details'''

<Result>: Integer or real absolute value sought

<Numeric>: Numeric expression, integer or real numeric expression or numeric value to use.
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Round'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Calculates the rounded value of a numeric value according to the specified number of decimal.
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = Round(<Numeric Value> [,<Number of Decimals>])

'''Parameter Details'''

<Result>: Integer or real rounded value of the specified numeric value.
<Numeric Value>: Real or currency numeric value to round. We recommend that you use the currency type in order to get reliable results.

'''Numeric Value'''
If <Numeric Value> is included between:

0 et 0.49: the number is rounded to 0. For example, 3.2 is rounded to 3 (no decimal).

0.5 and 0.99: the number is rounded to 1. For example, 3.7 is rounded to 4 (no decimal).
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''RoundUp'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Calculates the upward rounded value of a numeric value according to the specified number of decimal.
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = Roundup(<Numeric Value> [,<Number of Decimals>])

'''Parameter Details'''

<Result>: Integer or real rounded value of the specified numeric value.
<Numeric Value>: Real or currency numeric value to round. We recommend that you use the currency type in order to get reliable results.

'''Numeric Value'''
If <Numeric Value> is included between:

0 and 0.99: the number is rounded up to 1. For example, 3.7 is rounded to 4 (no decimal).
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''RoundDown'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Calculates the downward rounded value of a numeric value according to the specified number of decimal.
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = Rounddown(<Numeric Value> [,<Number of Decimals>])

'''Parameter Details'''

<Result>: Integer or real rounded value of the specified numeric value.
<Numeric Value>: Real or currency numeric value to round. We recommend that you use the currency type in order to get reliable results.

'''Numeric Value'''
If <Numeric Value> is included between:

0 et 0.49: the number is rounded to 0. For example, 3.2 is rounded to 3 (no decimal).
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''IsOdd'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Identifies an odd number
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = IsOdd(<Number>)

'''Parameter Details'''

<Result>: Boolean true if the specified number is odd, False otherwise.

<Number>: Integer numeric expression or integer number integer numeric expression or integer number to identify.
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''IsEven'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Identifies an even number
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = IsEven(<Number>)

'''Parameter Details'''

<Result>: Boolean true if the specified number is even, False otherwise.
<Number>: Integer numeric expression or integer number Integer numeric expression or integer number to identify.
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Max'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Returns the greatest of the value passed in parameter
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = Max(<Value 1> [,<Value 2> [,<Value N>]])

'''Parameter Details'''

<Result>: Character string, integer or real the greatest of the values passed in parameter.

<Value 1>: Character string, integer or real value to compare.

<Value 2>: Optional character string, integer or real value to compare.

<Value N>: Optional character string, integer or real value to compare.
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Min'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Returns the smallest of the value passed in parameter
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = Min(<Value 1> [,<Value 2> [,<Value N>]])

'''Parameter Details'''

<Result>: Character string, integer or real the smallest of the values passed in parameter.

<Value 1>: Character string, integer or real value to compare.

<Value 2>: Optional character string, integer or real value to compare.

<Value N>: Optional character string, integer or real value to compare.
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''DecimalPart'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Returns the decimal part of a number
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = DecimalPart(<Number>)

'''Parameter Details'''

<Result>: Real decimal part sought.

<Number>: Real number to use.
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''IntegerPart'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Returns the integer part of a number
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = IntegerPart(<Number>)

'''Parameter Details'''

<Result>: Real decimal part sought. Corresponds to the largest integer smaller than or equal to <Number>.

<Number>: Real number to use.
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Power'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Raises a number to a power
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = Power(<Number to Raise>, <Exponent>)

'''Parameter Details'''

<Result>: Real result of the <Number to Raise> to the power of <Exponent>.

<Number to Raise>: Integer or real number to raise to the power.

<Exponent>: Integer or real exponent.
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Root'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Calculates the root of a number
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = Root(<Number> [,<Root Factor>])

'''Parameter Details'''

<Result>: Real root of the number.

<Number>: Integer or real number to use.

<Root Factor>: Integer or real factor of the root (2 for a square root, 3 for a cubic root, ...). If this parameter is not specified, the square root of <Number> is returned.
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Log'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Calculates the logarithm of a numeric value (integer or real)
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = Log(<Numeric Value>)

'''Parameter Details'''

<Result>: Real decimal logarithm sought.

<Numeric Value>: Integer or real numeric value to use. An error occurs if this parameter is a negative number or a null number.
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Ln'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Calculates the Napierian logarithm (reverse of exponential) of a numeric value (integer or real)
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = Ln(<Numeric Value>)

'''Parameter Details'''

<Result>: Real decimal logarithm sought.

<Numeric Value>: Integer or real numeric value to use. An error occurs if this parameter is a negative number or a null number??
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''ArcSin'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Calculates the arc sine of a numeric value (integer or real)
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = ArcSin(<Numeric Value>)

'''Parameter Details'''

<Result>: Real arc sine (angle in degrees of the sine) of the specified numeric value, found in the [-90, 90] interval.

<Numeric Value>: Integer or real numeric value (sine) to use. This value must be found in the [-1,1] interval. Otherwise, an error occurs.
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''ArcTan'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Calculates the arc tangent of a numeric value (integer or real)
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = ArcTan(<Numeric Value>)

'''Parameter Details'''

<Result>: Real arc tangent (angle in degrees of the tangent) of the specified numeric value, included in the [-90,90] interval (excluding bounds).

<Numeric Value>: Integer or real numeric value (tangent) to use.
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''ArcCos'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Calculate the arc cosine of a numeric value
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = ArCos(<Numeric Value>)

'''Parameter Details'''

<Result>:

<Numeric Value>:
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Cos'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Calculate the angle cosine
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = Cos(<Angle>)

'''Parameter Details'''

<Result>: Real cosine of the specified angle.

<Angle>: Integer or real angle (in degrees) to use. This parameter can have any value: the cosine calculation is performed "modulo 360".
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''CoTan'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Calculate the angle cotangent
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = CoTan(<Angle>)

'''Parameter Details'''

<Result>: Real cotangent of the specified angle.

<Angle>: Integer or real angle (in degrees) to use. An error occurs if this parameter is set to 0°, 180° or -180°.
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Exp'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Calculates the exponential of a numeric value
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = Exp(<Numeric Value>)

'''Parameter Details'''

<Result>: Real exponential sought.

<Numeric Value>: Integer or real numeric value to use.
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Sin'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
Calculate the angle sine
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
<Result> = Sin(<Angle>)

'''Parameter Details'''

<Result>: Real sine of the specified angle.

<Angle>: Integer or real angle (in degrees) to use.
|-
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Tangent'''
| width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
Calculates the angle tangent
| width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
<Result> = Tangent(<Angle>)

'''Parameter Details'''

<Result>: Real tangent of the specified angle.

<Angle>: Integer or real angle (in degrees) to use. An error occurs if this parameter is set to 90°, -90°, 270° or -270°.
|-
|}

=== External Selection===

For very complex rules, an external file might be used to implement them in Metis Smart Modeling. The purpose of this rule type is to allow the development of algorithms which may not be handled in Metis. The file linked to such rule should a compiled program which can be started by providing at least one parameter and which returns '''only one''' value. This file can be searched through the External File Name button on the right. In order for a new file to be displayed in that list it has to be "imported" through the ... .

In the “Modeling” menu, make sure that the “Rules” sub-menu has been selected.
On the left, in the “Groups of rules” dropdown list, select “D-Basic Hardware.”
Click on the "Add" button [[File:MetisSmartModelingPLUSButton.PNG|link=]]. A window opens where the new rule will be created.
In the “Type” field, select “External” from the dropdown list. In the “comment” field, enter a name for the rule. For example, “Total Service Time.”
The goal of this example rule is to provide two inputs to an external program. The program will then sum up the value of the inputs and provide the output to a [[Metis_Smart_Modeling_-_Variables|variable]].
Click on the "Add" button [[File:MetisSmartModelingPLUSButton.PNG|link=]] near the “input” field. A window opens where it is possible to select positions, [[Metis_Smart_Modeling_-_Variables|variables]], and [[Metis_Smart_Modeling_-_Attributes|attributes]]. Select “[[Metis_Smart_Modeling_-_Attributes|Attributes]]”.
Select “Installation time” from the list and confirm.
Repeat the same steps, but this time select “Project management” from the list.
Note: It is very important that the order in which the parameters are listed in the table is the same as within the external program.
Click on the "Add" button [[File:MetisSmartModelingPLUSButton.PNG|link=]] near the “Output” field. The same window from before opens, but it is only possible to select positions or [[Metis_Smart_Modeling_-_Variables|variables]]. In this example a position is added. Select “[[Metis_Smart_Modeling_-_Variables|variables]]”.
Search for the [[Metis_Smart_Modeling_-_Variables|variable]] “$Service.” Select it and then confirm.
In the “Input” section, click on the icon next to the “External File Name” field.
A window opens. Click on the "Add" button [[File:MetisSmartModelingPLUSButton.PNG|link=]]. The “select a file…” window opens.
For this example the file “ADD.exe” is added. Make sure that the “Add.exe” file is selected and then click on confirm to continue.
To test this new rule, click on the “test” button.The test window opens.
In the “test value” field for “Installation Time” enter “12.” For “Project Management,” enter “4.”
Click on the test button. The results appear below. The external program has summed up both input values.
Close the test window. Click on confirm to save the rule. It now appears in the list of rules.

{| 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" | '''Q in'''
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q out'''
! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
12 and 4
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
16
| width="70%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Based on the external program used in the example below, which simply adds up to numbers :

''Var1+Var2''

The result with those input values is 16.
|-
|}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/e/ec/VID_CreatingExternalRule.PNG'>File:Creating_an_External_Rule_OK.mp4‎</mediaplayer>
| Definition of an external rule within Metis Smart Modeling.
}}

{{Note
| The external application which is executed when running an external rule can be written in any programming language as long as it is configured to accept one or more input [[Metis_Smart_Modeling_-_Variables|variables]] and only one output. Common consideration for executing the application are not supported by Xpert Technologies SA.
}}

== Testing rules ==

All rules which have been created in Metis Smart Modeling can be tested in various ways, either on their own or as part of the group they belong. This section of the manual will focus on testing a rule by itself, for more information about other tests please refer to [[Description_of_the_Sub-Menu_Check_Rules|Checking Rules]].

INPUT VALUES (Filter and input)
In the above table, value can be given to specific inputs for testing the current rule. The listed inputs include both the ones used as input for the rule and the ones used in the filter part of the rule. It goes without saying that in order to get a result from the test that all filters need to be valid.

OUTPUT VALUES (Output and Add-on)
In the lower table, results will be displayed based on the inputs given and the rule itself. The listed result include both the output defined in the rule and the "Add-on" specified.

{{Note
| The "program" which is used for an external rule should be executable on its own, meaning that the related execution environment or libraries should be accessible on the machine where Metis Smart Suite in installed.
}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/8/84/VID_Testing_rules_and_Group_of_rules.PNG'>File:Testing rules and groups of rules OK.mp4‎</mediaplayer>
| Testing rules and [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]].
}}

{{Note
| Because optimal rule take into account the prices of the various possible results, the testing window allows to set which "Price category" should be used for the current test. Thus the result will take into account the selection.
}}

{{Note
| Because some products may not be available for specific variants, the testing window allows to set a preferred "Variant" for the current test. Thus the result will take into account the selection.
}}

== Structuring rules together ==

One simple example to described the importance of planning in advance the structure of the rules within a group or the groups themselves is in the scope of the configuration of a computer is the calculation of the memory modules required. One way to accommodate this situation is to let the user input the requested amount of memory he would like to have configured in his machine.

The first rule will determine the number of 1 GB modules required to suit his needs. For example the input is 4 GB and the result is 4 modules of 1 GB each. The situation would be more complicated if the user had chosen 8 GB and that the machine could only hold 4 modules in total. This means that the [[Metis_Smart_Modeling_-_Models|model]] requires a second rule to check the number of 1 GB module against the number of slots available. In the example of a input equal to 8, the resulting number of modules is 8. The second rule could then take this value and modify the result to 2 GB modules thus making it possible to be installed on the machine.

Because in this situation the second needs to have the result of the first one available in order to use it has an input it is necessary that second be placed in another [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] which should be executed after the one containing the first rule.

{{Note
| On the main rule screen, listing all rules within a single group, they can be sorted. This functionality is only a visual help for the user. Based on the execution scheme of [[Metis_Smart_Modeling_-_Models|models]], sorting rule within a group doesn't have any effect on the result of the group. If rule need to be executed a sequential order, then they should be placed in sequential groups.
}}

== Advanced rules search ==

From the main rules screen in Metis Smart Modeling, the Advanced Search button brings up a window allowing to refine the search for rules.

[[File:MetisSmartModelingSCRuleAdvSearch.PNG|center|850x860px]]

* '''ID''' : Search for a rule directly by entering its identification number.

* '''Comment''' : Search for a rule by entering the "Comment" (name) of a rule.

* '''Mandatory Control''' : Refine to search to rule which enforce mandatory controls.

* '''Contain Item''' : By using the ADD button [[File:MetisSmartModelingAddButton.PNG|link=]] search for rules which contain a specific position, variable or [[Metis_Smart_Modeling_-_Attributes|attribute]]. Using the '''Used as''' options it is possible to refine how this object is used in the rule looked for. Either as a filter, an add-on value or as input or output values. In the case of objects being used in the rule itself, the application allows to specify exactly where it is used in the rule.
** ''Rule Input or Output'' : Object used either as an input or an output of a rule.
** ''Rule Input only'' : Object used only as an input of a rule.
** ''Rule Output only'' : Object used only as an output of a rule.
** ''Not used as Input or Output'' : Object used neither as an input nor an output of a rule.

By clicking on the "search" button, the search is executed and the results (if any) is displayed in the table on the right of the window. Double-clicking on a listed rule will open it and allow for modifications and testing.

{{Note
| The comment field doesn't enforce capitalization.
}}

== Modifying a rule ==

In the “Modeling” menu, make sure that the “Rules” sub-menu has been selected. On the left, in the “Groups of rules” drop-down list, select the appropriate group where the rule to be edited is stored. Select the rule and click on the EDIT button [[File:MetisSmartModelingEditButton.PNG|link=]], the rule definition window opens up and modifications can be applied. Validation is required in order to save all changes made to the rule. Please refer to the individual rule type description for additional information on configuring a valid rule.

{{Note
| If modifications are applied to a rule which is used in several groups, keep in mind that changes will be have an influence on all groups or [[Metis_Smart_Modeling_-_Models|models]] in which this rule is used. It may be relevant to make a copy of the rule in order to test the modifications.
}}

=== Duplicating a rule ===

In the “Modeling” menu, make sure that the “Rules” sub-menu has been selected. On the left, in the “Groups of rules” drop-down list, select the appropriate group where the rule to be duplicated is stored. Select the rule and click on the DUPLICATE button [[File:MetisSmartModelingDuplicateButton.PNG|link=]], the rule is immediately copied and placed in the selected [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]]. It is an exact copy, or duplicate, of the original one. It can then be edited to fit all requirements or moved to another group.

{{Note
| A duplicated rule is an entirely new rule. All modifications applied to the original or the duplicate will not be reciprocated to the other one.
}}

=== Moving a rule to another group of rules===

In the “Modeling” menu, make sure that the “Rules” sub-menu has been selected. On the left, in the “Groups of rules” drop-down list, select the appropriate group where the rule to be moved is stored. Select the rule and click on the MOVE button [[File:MetisSmartModelingMoveButton.PNG|link=]], a new window opens where the target [[Metis_Smart_Modeling_-_Group_of_Rules|group of rule]] can be selected from the complete list of groups available in Metis Smart Modeling. Once the [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] selected, validation is required in order to save all changes made to the rule.

[[File:MetisSmartModelingSCRulesMove.PNG‎|center|300x500px|link=]]

{{Note
| Moving a rule doesn't create a copy of it, neither an additional link. It really moves it from one [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] to another.
}}

=== Linking a rule with another group of rules===

In the “Modeling” menu, make sure that the “Rules” sub-menu has been selected. On the left, in the “Groups of rules” drop-down list, select the appropriate group where the rule to be linked to other group(s) of rule is located. Select the rule and click on the LINK button [[File:MetisSmartModelingLinkButton.PNG|link=]], a window opens up where a target [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] can be selected from a drop-down list to set the [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] where the selected rule should be applied. Once selected, validation is required in order to save all changes made to the rule.

{{Note
| Linking a rule to more than one [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]], doesn't copy the rule inside that group. It is still identified through one ID.
}}

{{Note
| Changes applied to one occurrence of a rule linked in several groups will have an impact on all those groups.
}}

To check in which groups of rules a rule is used (linked), select the rule for which a verification should be done and click on the "Currently used by" button [[File:MetisSmartModelingCurrentlyUsedByButton.PNG|link=]]. A window will open displaying all groups of rules, [[Metis_Smart_Modeling_-_Models|models]] and [[Metis_Smart_Modeling_-_Systems|systems]] to which the selected rule is linked. Please refer here for more information.

== Deleting a rule ==

In the “Modeling” menu, make sure that the “Rules” sub-menu has been selected. On the left, in the “Groups of rules” drop-down list, select the appropriate group where the rule to be edited is stored. Select the rule and click on the DELETE button [[File:MetisSmartModelingDeleteButton.PNG|link=]]. This opens a small window requesting to confirm the deletion of the selected rule. Once confirmed it will be definitively deleted from the selected [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]].

{{Note
| When the same rule is used in more then one [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]], Metis Smart Modeling will open a window showing a list of all groups in which the rule is linked. It is then possible to either delete the rule form all groups or select the group form which it should be deleted.

[[File:MetisSmartModelingSCRulesDel.PNG‎|center|300x500px|link=]]

}}

{{Warning
| Extra care should be taken when deleting a rule which produces an output which will afterwards be used as an input for another rule in a [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] following the current one. This will result in wrong results at the end of the execution scheme.
}}

File:Creating a system OK.mp4

2014-01-30T14:50:27Z

PatrickG:

File:Creating a model OK.mp4

2014-01-30T14:49:45Z

PatrickG: uploaded a new version of "File:Creating a model OK.mp4"

File:Creating a language OK.mp4

2014-01-30T14:49:28Z

PatrickG: uploaded a new version of "File:Creating a language OK.mp4"

File:Creating a group of masks OK.mp4

2014-01-30T14:49:04Z

PatrickG: uploaded a new version of "File:Creating a group of masks OK.mp4"

File:Additional Profiles OK.mp4

2014-01-30T14:48:44Z

PatrickG: uploaded a new version of "File:Additional Profiles OK.mp4"

File:Xpert Technologies SA - Metis Smart Modeling Rights Structure - 05.11.2013.pdf

2014-01-30T14:45:55Z

PatrickG: uploaded a new version of "File:Xpert Technologies SA - Metis Smart Modeling Rights Structure - 05.11.2013.pdf"

Description of the Menu Hierarchies

2014-01-27T09:14:06Z

PatrickG: /* Segments */

Metis Smart Suite uses different catalog building blocks to sort and classify Positions. From the top to the later, the structure is the following :

* '''Hierarchy Groups''' : groups hierarchies together
* '''Hierarchies''' : defines the starting point of a Section structure and the first element to hold positions
* '''Sections''' : sorts positions
* '''Sub-Sections''' (optional) : sort positions in detail
* ''' Positions''' : system building block

This scheme and the listed positions will be used to structure offers, to sort positions when browsing the catalogs in Metis Smart Quotes and also to set portfolios to users in Metis Smart Modeling.

== Hierarchy Groups ==

Hierarchy groups act as a tool to organize the different hierarchies found in Metis. Hierarchy groups are the uppermost level in the classification of hierarchies, sections and positions. They can, for example, be used to set the main segments of the product catalog, like hardware and software.

When creating a new hierarchy group or editing an existing hierarchy group, the user can arrange which hierarchies are part of that hierarchy group, as well as arrange the order in which they appear in Metis Smart Modelling and Metis Smart Quotes.

Hierarchy groups are found in Smart Modeling under the Hierarchies menu. Here the user can either add or edit an existing hierarchy group. In order to define access right to the created hierarchy groups, the Profile menu include a hierarchy sub-menu. See the corresponding [[Description_of_the_Sub-Menu_Hierarchies|section]] of this manual for additional information.

[[File:MSM_Hierarchies_Hierarchy_Groups.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Hierarchies Groups 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/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

* '''Version''': Define which version the search should be done.

* '''Hierarchy Group''': Enter search criteria of the hierarchy to be found.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/d/d7/VID_Creating_a_section_a_hierarchy_and_a_group_of_hierarchies.png'>File:Creating_a_section_a_hierarchy_and_a_group_of_hierarchies.mp4</mediaplayer>
| Creating a Hierarchy Group, Hierarchies and Sections.
}}

=== Creating a Hierarchy Group ===

In the '''Hierarchy Group''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Hierarchy Group. When it is clicked, the '''Hierarchy Group''' creation window opens, it allows to define all related information.

[[File:MSM_Hierarchies_Hierarchy_Groups_Add.png|center|600x400px]]

Here the user can enter a name for the new hierarchy group in the '''Description''' field for at least one of the available languages. The two tables below allow the user to select which hierarchies they would like to include in this new hierarchy group. Using the left and right arrows, the user can move hierarchies from one side to the other. Hierarchies can also be added from the right side to the left side by double clicking on a hierarchy.

{{Note
| Multiple hierarchies can be selected and added from one side to another by selecting them all and using the appropriate arrow.
}}

{{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 Hierarchy Group can be saved by validating the '''Hierarchy Group''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Modifying a Hierarchy Group ===

In the '''Hierarchy Groups''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Hierarchy Group. Selecting a Hierarchy Group and clicking on it opens the '''Hierarchy Group''' edition window where all related properties and information can be edited.

[[File:MSM_Hierarchies_Hierarchy_Groups_Edit.png|center|600x400px]]

The name of the hierarchy group can be modified in the '''Description''' field for any of the available languages. The user can also remove or add hierarchies in this group by using the two table in the lower part of the window and moving them between them by using the left and right arrows just like when adding a new hierarchy group.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Hierarchy Group. Modifications applied to the selected Hierarchy Group will only be saved once the Hierarchy Group edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the table/list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

{{Note
| For hierarchy groups with a lock icon before them, it is only possible to edit the name of the hierarchy group.
}}

=== Deleting a Hierarchy Group ===

In the '''Hierarchy Groups''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Hierarchy Group. Selecting one or more Hierarchy Groups and clicking on it displays the following confirmation window.

[[File:MSM_Hierarchies_Hierarchy_Groups_Delete.png|center]]

Once the warning is confirmed, the selected Hierarchy Group is removed from Metis Smart Suite and deleted from the Metis Database.

=== Previewing a Hierarchy Group ===

In the '''Hierarchy Groups''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Hierarchy Group. Selecting a Hierarchy Group from the list and clicking on it opens the '''Hierarchy Group''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Hierarchy Group.

[[File:MSM_Hierarchies_Hierarchy_Groups_Peview.png|center|600x400px]]

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

== Hierarchies ==

In Metis Smart Suite hierarchies are created to make managing data much easier for the user; they act as a tool to organize the different sections, sub-sections and positions found in Metis. When creating a new hierarchy or editing an existing one, the user can define how the sections, sub-sections and positions are arranged in that particular hierarchy. They are used in a variety of different instances throughout Metis, both in Smart Modeling and in Smart Quotes.

Since hierarchies are used to organize data, they can also be manipulated to restrict which data certain users have access to. This is done through the use of [[Description_of_the_Sub-Menu_Hierarchies|Hierarchy Profiles]]. In Metis Smart Modeling in the Profiles menu, then in the Hierarchies sub-menu the user can create hierarchy profiles. After naming the hierarchy profile, the user can then select which hierarchies are to be included in the profile as well as the option to select entire hierarchy groups for the profile. For additional information about defining which hierarchies are accessible to which group of users, please refer to the corresponding section.

[[File:MSM_Hierarchies_Hierarchies.png|center|600x400px]]

{{Note
| Hierarchies are also linked with [[Metis_Smart_Modeling_-_Systems#Systems|Systems]]. Once in the Systems menu, then in Systems sub-menu, a system can either be added or edited and the hierarchy used for that system can be selected from the Hierarchy drop-down list found near the bottom of the window.
}}

{{Note
| Hierarchies are linked to [[Description_of_the_Menu_Positions|positions]] as well. In the positions menu, then in the positions sub-menu, add or edit an existing position then move to the Hierarchies tab. A list of all the hierarchies in which the position in linked to is shown.
}}

{{Note
| In the column titled ''Visible'', a check box will either be ticked or not ticked indicating whether the hierarchy is visible or not in Smart Quotes.
}}

In Metis Smart Quotes, hierarchies can be found under the Price menu when selecting a system and clicking on the Edit Material List button. The Edit Material list window will open with a list of hierarchies and hierarchy groups found at the top left of the window. Here the user can edit the material list by searching through the hierarchies and adding positions to the system being edited.

{{Note
| In the '''Hierarchies''' sub-menu window, the hierarchies listed in the table have both their description and remark shown.
}}

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Hierarchies 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.

=== Creating a Hierarchy ===

In the '''Hierarchies''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main table allows the user/administrator to create a new Hierarchy. When it is clicked, the '''Hierarchy''' creation window opens, it allows to define all related information.

[[File:MSM_Hierarchies_Hierarchies_Add.png|center|600x400px]]

* '''Description''': name for the new hierarchy for at least one of the available languages with a limit of 80 characters.

* '''Remark''': remark concerning the hierarchy with a limit of 80 characters.

* '''Visible''': Make the hierarchy visible or not in the hierarchies sub-menu by ticking the visible check-box. Ticking this check-box means that in Metis Smart Quotes in the Price menu when editing the material list of an offer, the hierarchy will not be visible from the list found on the top right corner of the Edit Material List window. Positions linked to this hierarchy will still be displayed however.

In the lower part of the window the sections, sub-sections and positions are defined within the hierarchy. A designation column displays their names while an order number column displays the order numbers.

'''Add section'''

Sections and sub-sections can be added to the hierarchy using the "add Section" button. Clicking on the button opens a new window with a list of all the available sections which can be added. Once the first section has been added, the user can then select that section and add either sub-sections or positions to it or continue adding other sections by selecting the hierarchy icon found at the top of the list. The destination of the added section or sub-section is dependent on which section or sub-section is currently selected.

[[File:MSM_Hierarchies_Sections_Add_Section.png|center|600x400px]]

{{Note
| While the hierarchy icon is selected, the user may only add sections. All the other buttons have been disabled until a section or sub-section has been selected.
}}

{{Note
| A sub-section is the lowest level the user can add. Positions may be added to sub-sections, however, no sections can be added to a sub-section. Nothing may be added to a position.
}}

'''Add Position'''

Positions can be added to any section or sub-section configured within the hierarchy. Clicking on the "Add Position" button will bring up a window allowing to select one or more positions form the complete list. In order to find the appropriate positions a complete "search" functionality is available to the user. The search results will then be displayed in the list on the right-hand side. The destination of the added position is dependent on which section or sub-section is currently selected.

[[File:MSM_Hierarchies_Sections_Add_Positions.png|center|600x400px]]

'''Delete'''

Selecting any section, sub-section or position and clicking the "Delete" button will delete the selected item. Multiple items may be selected at the same time and deleted together.

'''Arrows'''

Using the left and right arrows, the user can move sections to become sub-sections, positions from sections to sub-sections and vice-verse. The up and down arrows let the user change the order of the sections, sub-sections and positions within the hierarchy

{{Warning
| Unlike other delete buttons, there is no warning message to confirm the deletion of the sections, sub-sections and positions.
}}

The second tab is the '''Variants''' tab. Here the user is presented with a list of variants which are not authorized. No edition is allowed under this tab. The information displayed is defined within the '''[[Description_of_the_Sub-Menu_Variants|Variants]]''' menu of Metis Smart Modelling.

{{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 Hierarchy can be saved by validating the '''Hierarchy''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Modifying a Hierarchy ===

In the '''Hierarchies''' 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 Hierarchy . Selecting a Hierarchy and clicking on it opens the '''Hierarchy ''' edition window where all related properties and information can be edited. The name of the hierarchy can be edited here as well as any other properties that were available when adding a new hierarchy, e.g., Adding sections, sub-sections and positions or creating a remark for the hierarchy. Refer to the above section for details.

[[File:MSM_Hierarchies_Hierarchies_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 Hierarchy . Modifications applied to the selected Hierarchy will only be saved once the Hierarchy edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the table/list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

=== Deleting a Hierarchy ===

In the '''Hierarchies''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Hierarchy. Selecting one or more Hierarchy and clicking on it displays the following confirmation window.

[[File:MSM_Hierarchies_Hierarchies_Delete.png|center]]

Once the warning is confirmed, the selected Hierarchy is removed from Metis Smart Suite and deleted from the Metis Database.

=== Previewing a Hierarchy ===

In the '''Hierarchies''' 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 Hierarchy.

[[File:MSM_Hierarchies_Hierarchies_Preview.png|center|600x400px]]

Selecting a Hierarchy from the table and clicking on it opens the '''Hierarchy''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Hierarchy.

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

== Sections ==

Sections are the building parts of hierarchies. Sections are used as an organizational tool in Metis; they can contain both positions and sub-sections. Sub-sections are an optional organizational level found below sections and can also contain positions. Therefore, a section can have both free potions and positions found under a sub-section. While it is optional to include sub-sections in a section, a position must be part of a section for it to be classified. Sections, together with sub-sections and positions serve to make up hierarchies.

Sections are found throughout both Metis Smart Modeling and Metis Smart Quotes. In Metis Smart Modeling we find sections by going to the Hierarchies menu, then in the Hierarchies sub-menu. Once in the sub-menu, adding or editing an existing hierarchy opens a window where the contents of the hierarchy can be changed. Sections can be added using the '''Add Section''' button, as well as adding sub-sections to sections and positions to both sections and sub-sections. In the window that opens when clicking on '''Add Section''', all the available sections will be listed, some having a lock icon in front of them meaning that they were created in the parent version.

[[File:MSM_Hierarchies_Sections.png|center|600x400px]]

In Smart Quotes, sections can be found through the '''[[Description_of_the_Menu_Prices|Price]]''' menu by selecting a system and clicking on the Edit Material List button. A window opens where the system is listed at the top with all the sections and positions belonging to it found below.
Here the user may alter the material list by adding sections, sub-sections and positions to the system. The sections and positions shown in the bottom right corner are directly related to which hierarchy group and hierarchy is selected.

Adding a section or position is done simply by double clicking on it. Once added, sections and positions can then be moved using the up and down arrows found in the middle of the window.

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Sections 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 list.

=== Creating a Section ===

In the '''Sections''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Section. When it is clicked, the '''Section''' creation window opens, it allows to define all related information.

[[File:MSM_Hierarchies_Sections_Add.png|center|600x400px]]

Here the user must enter a name for the new section in the '''Description''' field for at least one of the available languages with a character limit of 80.

{{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 Section can be saved by validating the '''Section''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Modifying a Section ===

In the '''Section''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Section. Selecting a Section and clicking on it opens the '''Section''' edition window where all related properties and information can be edited. The name of the section can be edited here in the '''Description''' field for each of the available languages.

[[File:MSM_Hierarchies_Sections_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 Section. Modifications applied to the selected Section will only be saved once the Section edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the table/list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

{{Warning
| All modification applied to a section will be show everywhere this section is used (i.e. all hierarchies where the section appears either as a section or as a sub-section).
}}

=== Deleting a Section ===

In the '''Sections''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Section. Selecting one or more Section and clicking on it displays the following confirmation window.

[[File:MSM_Hierarchies_Sections_Delete.png|center]]

Once the warning is confirmed, the selected Section is removed from Metis Smart Suite and deleted from the Metis Database.

{{Warning
| A deleted section will be removed everywhere this section is used (i.e. all hierarchies where the section appears either as a section or as a sub-section). This may induce issues when removing a section containing positions and/or sub-sections.
}}

=== Previewing a Section ===

In the '''Section''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Section.

Selecting a Section from the list and clicking on it opens the '''Section''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Section.

[[File:MSM_Hierarchies_Sections_Preview.png|center|600x400px]]

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

== Segments ==

In Metis Smart Suite, Segments can be used to sort and classify positions in an alternate form from the catalogs represented by the Hierarchies. In addition, special functionalities are implemented in Metis Smart Quotes to use and view those segments. For example, an administrator could determine that pricing functions are only available on segments instead of the whole ensemble.

[[File:MSM_Hierarchies_SegmentView.png|center|600x400px]]

The list shown in the main window displays all the Segments available in Metis Smart Modeling. It can be sorted alphabetically using the small arrows in the table headers.

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Segments based on its name. The search is triggered by selecting the appropriate version and typing a keyword or only a letter in the field 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 list.

=== Creating a new Segment ===

In the '''Segment View''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Segment. When it is clicked, the '''Segment''' creation window opens, it allows to define all related information.

[[File:MSM_Hierarchies_SegmentView_Add.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 Segment can be saved by validating the '''Segment''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Editing a Segment ===

In the '''Segment View''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Segment . Selecting a Segment and clicking on it opens the '''Segment ''' edition window where all related properties and information can be edited.

[[File:MSM_Hierarchies_SegmentView_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 Segment. Modifications applied to the selected Segment will only be saved once the Segment edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

=== Deleting a Segment ===

In the '''Segment View''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Segment. Selecting one or more Segments and clicking on it displays the following confirmation window.

[[File:MSM_Attributes_Attributes_Delete.png|center]]

Once the warning is confirmed, the selected Segment is removed from Metis Smart Suite and deleted from the Metis Database.

=== Previewing a Segment ===

In the '''Segment View''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Segment. Selecting a Segment from the list and clicking on it opens the '''Segment''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Segment.

[[File:MSM_Hierarchies_SegmentView_Preview.png|center|600x400px]]

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

Description of the Menu Hierarchies

2014-01-27T09:10:30Z

PatrickG: /* Segments */

Metis Smart Suite uses different catalog building blocks to sort and classify Positions. From the top to the later, the structure is the following :

* '''Hierarchy Groups''' : groups hierarchies together
* '''Hierarchies''' : defines the starting point of a Section structure and the first element to hold positions
* '''Sections''' : sorts positions
* '''Sub-Sections''' (optional) : sort positions in detail
* ''' Positions''' : system building block

This scheme and the listed positions will be used to structure offers, to sort positions when browsing the catalogs in Metis Smart Quotes and also to set portfolios to users in Metis Smart Modeling.

== Hierarchy Groups ==

Hierarchy groups act as a tool to organize the different hierarchies found in Metis. Hierarchy groups are the uppermost level in the classification of hierarchies, sections and positions. They can, for example, be used to set the main segments of the product catalog, like hardware and software.

When creating a new hierarchy group or editing an existing hierarchy group, the user can arrange which hierarchies are part of that hierarchy group, as well as arrange the order in which they appear in Metis Smart Modelling and Metis Smart Quotes.

Hierarchy groups are found in Smart Modeling under the Hierarchies menu. Here the user can either add or edit an existing hierarchy group. In order to define access right to the created hierarchy groups, the Profile menu include a hierarchy sub-menu. See the corresponding [[Description_of_the_Sub-Menu_Hierarchies|section]] of this manual for additional information.

[[File:MSM_Hierarchies_Hierarchy_Groups.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Hierarchies Groups 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/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

* '''Version''': Define which version the search should be done.

* '''Hierarchy Group''': Enter search criteria of the hierarchy to be found.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/d/d7/VID_Creating_a_section_a_hierarchy_and_a_group_of_hierarchies.png'>File:Creating_a_section_a_hierarchy_and_a_group_of_hierarchies.mp4</mediaplayer>
| Creating a Hierarchy Group, Hierarchies and Sections.
}}

=== Creating a Hierarchy Group ===

In the '''Hierarchy Group''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Hierarchy Group. When it is clicked, the '''Hierarchy Group''' creation window opens, it allows to define all related information.

[[File:MSM_Hierarchies_Hierarchy_Groups_Add.png|center|600x400px]]

Here the user can enter a name for the new hierarchy group in the '''Description''' field for at least one of the available languages. The two tables below allow the user to select which hierarchies they would like to include in this new hierarchy group. Using the left and right arrows, the user can move hierarchies from one side to the other. Hierarchies can also be added from the right side to the left side by double clicking on a hierarchy.

{{Note
| Multiple hierarchies can be selected and added from one side to another by selecting them all and using the appropriate arrow.
}}

{{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 Hierarchy Group can be saved by validating the '''Hierarchy Group''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Modifying a Hierarchy Group ===

In the '''Hierarchy Groups''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Hierarchy Group. Selecting a Hierarchy Group and clicking on it opens the '''Hierarchy Group''' edition window where all related properties and information can be edited.

[[File:MSM_Hierarchies_Hierarchy_Groups_Edit.png|center|600x400px]]

The name of the hierarchy group can be modified in the '''Description''' field for any of the available languages. The user can also remove or add hierarchies in this group by using the two table in the lower part of the window and moving them between them by using the left and right arrows just like when adding a new hierarchy group.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Hierarchy Group. Modifications applied to the selected Hierarchy Group will only be saved once the Hierarchy Group edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the table/list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

{{Note
| For hierarchy groups with a lock icon before them, it is only possible to edit the name of the hierarchy group.
}}

=== Deleting a Hierarchy Group ===

In the '''Hierarchy Groups''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Hierarchy Group. Selecting one or more Hierarchy Groups and clicking on it displays the following confirmation window.

[[File:MSM_Hierarchies_Hierarchy_Groups_Delete.png|center]]

Once the warning is confirmed, the selected Hierarchy Group is removed from Metis Smart Suite and deleted from the Metis Database.

=== Previewing a Hierarchy Group ===

In the '''Hierarchy Groups''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Hierarchy Group. Selecting a Hierarchy Group from the list and clicking on it opens the '''Hierarchy Group''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Hierarchy Group.

[[File:MSM_Hierarchies_Hierarchy_Groups_Peview.png|center|600x400px]]

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

== Hierarchies ==

In Metis Smart Suite hierarchies are created to make managing data much easier for the user; they act as a tool to organize the different sections, sub-sections and positions found in Metis. When creating a new hierarchy or editing an existing one, the user can define how the sections, sub-sections and positions are arranged in that particular hierarchy. They are used in a variety of different instances throughout Metis, both in Smart Modeling and in Smart Quotes.

Since hierarchies are used to organize data, they can also be manipulated to restrict which data certain users have access to. This is done through the use of [[Description_of_the_Sub-Menu_Hierarchies|Hierarchy Profiles]]. In Metis Smart Modeling in the Profiles menu, then in the Hierarchies sub-menu the user can create hierarchy profiles. After naming the hierarchy profile, the user can then select which hierarchies are to be included in the profile as well as the option to select entire hierarchy groups for the profile. For additional information about defining which hierarchies are accessible to which group of users, please refer to the corresponding section.

[[File:MSM_Hierarchies_Hierarchies.png|center|600x400px]]

{{Note
| Hierarchies are also linked with [[Metis_Smart_Modeling_-_Systems#Systems|Systems]]. Once in the Systems menu, then in Systems sub-menu, a system can either be added or edited and the hierarchy used for that system can be selected from the Hierarchy drop-down list found near the bottom of the window.
}}

{{Note
| Hierarchies are linked to [[Description_of_the_Menu_Positions|positions]] as well. In the positions menu, then in the positions sub-menu, add or edit an existing position then move to the Hierarchies tab. A list of all the hierarchies in which the position in linked to is shown.
}}

{{Note
| In the column titled ''Visible'', a check box will either be ticked or not ticked indicating whether the hierarchy is visible or not in Smart Quotes.
}}

In Metis Smart Quotes, hierarchies can be found under the Price menu when selecting a system and clicking on the Edit Material List button. The Edit Material list window will open with a list of hierarchies and hierarchy groups found at the top left of the window. Here the user can edit the material list by searching through the hierarchies and adding positions to the system being edited.

{{Note
| In the '''Hierarchies''' sub-menu window, the hierarchies listed in the table have both their description and remark shown.
}}

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Hierarchies 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.

=== Creating a Hierarchy ===

In the '''Hierarchies''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main table allows the user/administrator to create a new Hierarchy. When it is clicked, the '''Hierarchy''' creation window opens, it allows to define all related information.

[[File:MSM_Hierarchies_Hierarchies_Add.png|center|600x400px]]

* '''Description''': name for the new hierarchy for at least one of the available languages with a limit of 80 characters.

* '''Remark''': remark concerning the hierarchy with a limit of 80 characters.

* '''Visible''': Make the hierarchy visible or not in the hierarchies sub-menu by ticking the visible check-box. Ticking this check-box means that in Metis Smart Quotes in the Price menu when editing the material list of an offer, the hierarchy will not be visible from the list found on the top right corner of the Edit Material List window. Positions linked to this hierarchy will still be displayed however.

In the lower part of the window the sections, sub-sections and positions are defined within the hierarchy. A designation column displays their names while an order number column displays the order numbers.

'''Add section'''

Sections and sub-sections can be added to the hierarchy using the "add Section" button. Clicking on the button opens a new window with a list of all the available sections which can be added. Once the first section has been added, the user can then select that section and add either sub-sections or positions to it or continue adding other sections by selecting the hierarchy icon found at the top of the list. The destination of the added section or sub-section is dependent on which section or sub-section is currently selected.

[[File:MSM_Hierarchies_Sections_Add_Section.png|center|600x400px]]

{{Note
| While the hierarchy icon is selected, the user may only add sections. All the other buttons have been disabled until a section or sub-section has been selected.
}}

{{Note
| A sub-section is the lowest level the user can add. Positions may be added to sub-sections, however, no sections can be added to a sub-section. Nothing may be added to a position.
}}

'''Add Position'''

Positions can be added to any section or sub-section configured within the hierarchy. Clicking on the "Add Position" button will bring up a window allowing to select one or more positions form the complete list. In order to find the appropriate positions a complete "search" functionality is available to the user. The search results will then be displayed in the list on the right-hand side. The destination of the added position is dependent on which section or sub-section is currently selected.

[[File:MSM_Hierarchies_Sections_Add_Positions.png|center|600x400px]]

'''Delete'''

Selecting any section, sub-section or position and clicking the "Delete" button will delete the selected item. Multiple items may be selected at the same time and deleted together.

'''Arrows'''

Using the left and right arrows, the user can move sections to become sub-sections, positions from sections to sub-sections and vice-verse. The up and down arrows let the user change the order of the sections, sub-sections and positions within the hierarchy

{{Warning
| Unlike other delete buttons, there is no warning message to confirm the deletion of the sections, sub-sections and positions.
}}

The second tab is the '''Variants''' tab. Here the user is presented with a list of variants which are not authorized. No edition is allowed under this tab. The information displayed is defined within the '''[[Description_of_the_Sub-Menu_Variants|Variants]]''' menu of Metis Smart Modelling.

{{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 Hierarchy can be saved by validating the '''Hierarchy''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Modifying a Hierarchy ===

In the '''Hierarchies''' 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 Hierarchy . Selecting a Hierarchy and clicking on it opens the '''Hierarchy ''' edition window where all related properties and information can be edited. The name of the hierarchy can be edited here as well as any other properties that were available when adding a new hierarchy, e.g., Adding sections, sub-sections and positions or creating a remark for the hierarchy. Refer to the above section for details.

[[File:MSM_Hierarchies_Hierarchies_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 Hierarchy . Modifications applied to the selected Hierarchy will only be saved once the Hierarchy edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the table/list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

=== Deleting a Hierarchy ===

In the '''Hierarchies''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Hierarchy. Selecting one or more Hierarchy and clicking on it displays the following confirmation window.

[[File:MSM_Hierarchies_Hierarchies_Delete.png|center]]

Once the warning is confirmed, the selected Hierarchy is removed from Metis Smart Suite and deleted from the Metis Database.

=== Previewing a Hierarchy ===

In the '''Hierarchies''' 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 Hierarchy.

[[File:MSM_Hierarchies_Hierarchies_Preview.png|center|600x400px]]

Selecting a Hierarchy from the table and clicking on it opens the '''Hierarchy''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Hierarchy.

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

== Sections ==

Sections are the building parts of hierarchies. Sections are used as an organizational tool in Metis; they can contain both positions and sub-sections. Sub-sections are an optional organizational level found below sections and can also contain positions. Therefore, a section can have both free potions and positions found under a sub-section. While it is optional to include sub-sections in a section, a position must be part of a section for it to be classified. Sections, together with sub-sections and positions serve to make up hierarchies.

Sections are found throughout both Metis Smart Modeling and Metis Smart Quotes. In Metis Smart Modeling we find sections by going to the Hierarchies menu, then in the Hierarchies sub-menu. Once in the sub-menu, adding or editing an existing hierarchy opens a window where the contents of the hierarchy can be changed. Sections can be added using the '''Add Section''' button, as well as adding sub-sections to sections and positions to both sections and sub-sections. In the window that opens when clicking on '''Add Section''', all the available sections will be listed, some having a lock icon in front of them meaning that they were created in the parent version.

[[File:MSM_Hierarchies_Sections.png|center|600x400px]]

In Smart Quotes, sections can be found through the '''[[Description_of_the_Menu_Prices|Price]]''' menu by selecting a system and clicking on the Edit Material List button. A window opens where the system is listed at the top with all the sections and positions belonging to it found below.
Here the user may alter the material list by adding sections, sub-sections and positions to the system. The sections and positions shown in the bottom right corner are directly related to which hierarchy group and hierarchy is selected.

Adding a section or position is done simply by double clicking on it. Once added, sections and positions can then be moved using the up and down arrows found in the middle of the window.

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Sections 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 list.

=== Creating a Section ===

In the '''Sections''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Section. When it is clicked, the '''Section''' creation window opens, it allows to define all related information.

[[File:MSM_Hierarchies_Sections_Add.png|center|600x400px]]

Here the user must enter a name for the new section in the '''Description''' field for at least one of the available languages with a character limit of 80.

{{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 Section can be saved by validating the '''Section''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Modifying a Section ===

In the '''Section''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Section. Selecting a Section and clicking on it opens the '''Section''' edition window where all related properties and information can be edited. The name of the section can be edited here in the '''Description''' field for each of the available languages.

[[File:MSM_Hierarchies_Sections_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 Section. Modifications applied to the selected Section will only be saved once the Section edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the table/list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

{{Warning
| All modification applied to a section will be show everywhere this section is used (i.e. all hierarchies where the section appears either as a section or as a sub-section).
}}

=== Deleting a Section ===

In the '''Sections''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Section. Selecting one or more Section and clicking on it displays the following confirmation window.

[[File:MSM_Hierarchies_Sections_Delete.png|center]]

Once the warning is confirmed, the selected Section is removed from Metis Smart Suite and deleted from the Metis Database.

{{Warning
| A deleted section will be removed everywhere this section is used (i.e. all hierarchies where the section appears either as a section or as a sub-section). This may induce issues when removing a section containing positions and/or sub-sections.
}}

=== Previewing a Section ===

In the '''Section''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Section.

Selecting a Section from the list and clicking on it opens the '''Section''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Section.

[[File:MSM_Hierarchies_Sections_Preview.png|center|600x400px]]

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

== Segments ==

[[File:MSM_Hierarchies_SegmentView.png|center|600x400px]]

The list shown in the main window displays all the Segmenst available in Metis Smart Modeling. It can be sorted alphabetically using the small arrows in the table headers.

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Segments based on its name. The search is triggered by selecting the appropriate version and typing a keyword or only a letter in the field 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 list.

=== Creating a new Segment ===

In the '''Segment''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Segment. When it is clicked, the '''Segment''' creation window opens, it allows to define all related information.

[[File:MSM_Hierarchies_SegmentView_Add.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 Segment can be saved by validating the '''Segment''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Editing a Segment ===

In the '''Segment ''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Segment . Selecting a Segment and clicking on it opens the '''Segment ''' edition window where all related properties and information can be edited.

[[File:MSM_Hierarchies_SegmentView_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 Segment. Modifications applied to the selected Segment will only be saved once the Segment edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

=== Deleting a Segment ===

In the '''Segment''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Segment. Selecting one or more Segments and clicking on it displays the following confirmation window.

[[File:MSM_Attributes_Attributes_Delete.png|center]]

Once the warning is confirmed, the selected Segment is removed from Metis Smart Suite and deleted from the Metis Database.

=== Previewing a Segment ===

In the '''Segment''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Segment. Selecting a Segment from the list and clicking on it opens the '''Segment''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Segment.

[[File:MSM_Hierarchies_SegmentView_Preview.png|center|600x400px]]

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

Description of the Menu Hierarchies

2014-01-27T09:07:52Z

PatrickG: /* Segments */

Metis Smart Suite uses different catalog building blocks to sort and classify Positions. From the top to the later, the structure is the following :

* '''Hierarchy Groups''' : groups hierarchies together
* '''Hierarchies''' : defines the starting point of a Section structure and the first element to hold positions
* '''Sections''' : sorts positions
* '''Sub-Sections''' (optional) : sort positions in detail
* ''' Positions''' : system building block

This scheme and the listed positions will be used to structure offers, to sort positions when browsing the catalogs in Metis Smart Quotes and also to set portfolios to users in Metis Smart Modeling.

== Hierarchy Groups ==

Hierarchy groups act as a tool to organize the different hierarchies found in Metis. Hierarchy groups are the uppermost level in the classification of hierarchies, sections and positions. They can, for example, be used to set the main segments of the product catalog, like hardware and software.

When creating a new hierarchy group or editing an existing hierarchy group, the user can arrange which hierarchies are part of that hierarchy group, as well as arrange the order in which they appear in Metis Smart Modelling and Metis Smart Quotes.

Hierarchy groups are found in Smart Modeling under the Hierarchies menu. Here the user can either add or edit an existing hierarchy group. In order to define access right to the created hierarchy groups, the Profile menu include a hierarchy sub-menu. See the corresponding [[Description_of_the_Sub-Menu_Hierarchies|section]] of this manual for additional information.

[[File:MSM_Hierarchies_Hierarchy_Groups.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Hierarchies Groups 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/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

* '''Version''': Define which version the search should be done.

* '''Hierarchy Group''': Enter search criteria of the hierarchy to be found.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/d/d7/VID_Creating_a_section_a_hierarchy_and_a_group_of_hierarchies.png'>File:Creating_a_section_a_hierarchy_and_a_group_of_hierarchies.mp4</mediaplayer>
| Creating a Hierarchy Group, Hierarchies and Sections.
}}

=== Creating a Hierarchy Group ===

In the '''Hierarchy Group''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Hierarchy Group. When it is clicked, the '''Hierarchy Group''' creation window opens, it allows to define all related information.

[[File:MSM_Hierarchies_Hierarchy_Groups_Add.png|center|600x400px]]

Here the user can enter a name for the new hierarchy group in the '''Description''' field for at least one of the available languages. The two tables below allow the user to select which hierarchies they would like to include in this new hierarchy group. Using the left and right arrows, the user can move hierarchies from one side to the other. Hierarchies can also be added from the right side to the left side by double clicking on a hierarchy.

{{Note
| Multiple hierarchies can be selected and added from one side to another by selecting them all and using the appropriate arrow.
}}

{{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 Hierarchy Group can be saved by validating the '''Hierarchy Group''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Modifying a Hierarchy Group ===

In the '''Hierarchy Groups''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Hierarchy Group. Selecting a Hierarchy Group and clicking on it opens the '''Hierarchy Group''' edition window where all related properties and information can be edited.

[[File:MSM_Hierarchies_Hierarchy_Groups_Edit.png|center|600x400px]]

The name of the hierarchy group can be modified in the '''Description''' field for any of the available languages. The user can also remove or add hierarchies in this group by using the two table in the lower part of the window and moving them between them by using the left and right arrows just like when adding a new hierarchy group.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Hierarchy Group. Modifications applied to the selected Hierarchy Group will only be saved once the Hierarchy Group edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the table/list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

{{Note
| For hierarchy groups with a lock icon before them, it is only possible to edit the name of the hierarchy group.
}}

=== Deleting a Hierarchy Group ===

In the '''Hierarchy Groups''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Hierarchy Group. Selecting one or more Hierarchy Groups and clicking on it displays the following confirmation window.

[[File:MSM_Hierarchies_Hierarchy_Groups_Delete.png|center]]

Once the warning is confirmed, the selected Hierarchy Group is removed from Metis Smart Suite and deleted from the Metis Database.

=== Previewing a Hierarchy Group ===

In the '''Hierarchy Groups''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Hierarchy Group. Selecting a Hierarchy Group from the list and clicking on it opens the '''Hierarchy Group''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Hierarchy Group.

[[File:MSM_Hierarchies_Hierarchy_Groups_Peview.png|center|600x400px]]

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

== Hierarchies ==

In Metis Smart Suite hierarchies are created to make managing data much easier for the user; they act as a tool to organize the different sections, sub-sections and positions found in Metis. When creating a new hierarchy or editing an existing one, the user can define how the sections, sub-sections and positions are arranged in that particular hierarchy. They are used in a variety of different instances throughout Metis, both in Smart Modeling and in Smart Quotes.

Since hierarchies are used to organize data, they can also be manipulated to restrict which data certain users have access to. This is done through the use of [[Description_of_the_Sub-Menu_Hierarchies|Hierarchy Profiles]]. In Metis Smart Modeling in the Profiles menu, then in the Hierarchies sub-menu the user can create hierarchy profiles. After naming the hierarchy profile, the user can then select which hierarchies are to be included in the profile as well as the option to select entire hierarchy groups for the profile. For additional information about defining which hierarchies are accessible to which group of users, please refer to the corresponding section.

[[File:MSM_Hierarchies_Hierarchies.png|center|600x400px]]

{{Note
| Hierarchies are also linked with [[Metis_Smart_Modeling_-_Systems#Systems|Systems]]. Once in the Systems menu, then in Systems sub-menu, a system can either be added or edited and the hierarchy used for that system can be selected from the Hierarchy drop-down list found near the bottom of the window.
}}

{{Note
| Hierarchies are linked to [[Description_of_the_Menu_Positions|positions]] as well. In the positions menu, then in the positions sub-menu, add or edit an existing position then move to the Hierarchies tab. A list of all the hierarchies in which the position in linked to is shown.
}}

{{Note
| In the column titled ''Visible'', a check box will either be ticked or not ticked indicating whether the hierarchy is visible or not in Smart Quotes.
}}

In Metis Smart Quotes, hierarchies can be found under the Price menu when selecting a system and clicking on the Edit Material List button. The Edit Material list window will open with a list of hierarchies and hierarchy groups found at the top left of the window. Here the user can edit the material list by searching through the hierarchies and adding positions to the system being edited.

{{Note
| In the '''Hierarchies''' sub-menu window, the hierarchies listed in the table have both their description and remark shown.
}}

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Hierarchies 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.

=== Creating a Hierarchy ===

In the '''Hierarchies''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main table allows the user/administrator to create a new Hierarchy. When it is clicked, the '''Hierarchy''' creation window opens, it allows to define all related information.

[[File:MSM_Hierarchies_Hierarchies_Add.png|center|600x400px]]

* '''Description''': name for the new hierarchy for at least one of the available languages with a limit of 80 characters.

* '''Remark''': remark concerning the hierarchy with a limit of 80 characters.

* '''Visible''': Make the hierarchy visible or not in the hierarchies sub-menu by ticking the visible check-box. Ticking this check-box means that in Metis Smart Quotes in the Price menu when editing the material list of an offer, the hierarchy will not be visible from the list found on the top right corner of the Edit Material List window. Positions linked to this hierarchy will still be displayed however.

In the lower part of the window the sections, sub-sections and positions are defined within the hierarchy. A designation column displays their names while an order number column displays the order numbers.

'''Add section'''

Sections and sub-sections can be added to the hierarchy using the "add Section" button. Clicking on the button opens a new window with a list of all the available sections which can be added. Once the first section has been added, the user can then select that section and add either sub-sections or positions to it or continue adding other sections by selecting the hierarchy icon found at the top of the list. The destination of the added section or sub-section is dependent on which section or sub-section is currently selected.

[[File:MSM_Hierarchies_Sections_Add_Section.png|center|600x400px]]

{{Note
| While the hierarchy icon is selected, the user may only add sections. All the other buttons have been disabled until a section or sub-section has been selected.
}}

{{Note
| A sub-section is the lowest level the user can add. Positions may be added to sub-sections, however, no sections can be added to a sub-section. Nothing may be added to a position.
}}

'''Add Position'''

Positions can be added to any section or sub-section configured within the hierarchy. Clicking on the "Add Position" button will bring up a window allowing to select one or more positions form the complete list. In order to find the appropriate positions a complete "search" functionality is available to the user. The search results will then be displayed in the list on the right-hand side. The destination of the added position is dependent on which section or sub-section is currently selected.

[[File:MSM_Hierarchies_Sections_Add_Positions.png|center|600x400px]]

'''Delete'''

Selecting any section, sub-section or position and clicking the "Delete" button will delete the selected item. Multiple items may be selected at the same time and deleted together.

'''Arrows'''

Using the left and right arrows, the user can move sections to become sub-sections, positions from sections to sub-sections and vice-verse. The up and down arrows let the user change the order of the sections, sub-sections and positions within the hierarchy

{{Warning
| Unlike other delete buttons, there is no warning message to confirm the deletion of the sections, sub-sections and positions.
}}

The second tab is the '''Variants''' tab. Here the user is presented with a list of variants which are not authorized. No edition is allowed under this tab. The information displayed is defined within the '''[[Description_of_the_Sub-Menu_Variants|Variants]]''' menu of Metis Smart Modelling.

{{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 Hierarchy can be saved by validating the '''Hierarchy''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Modifying a Hierarchy ===

In the '''Hierarchies''' 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 Hierarchy . Selecting a Hierarchy and clicking on it opens the '''Hierarchy ''' edition window where all related properties and information can be edited. The name of the hierarchy can be edited here as well as any other properties that were available when adding a new hierarchy, e.g., Adding sections, sub-sections and positions or creating a remark for the hierarchy. Refer to the above section for details.

[[File:MSM_Hierarchies_Hierarchies_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 Hierarchy . Modifications applied to the selected Hierarchy will only be saved once the Hierarchy edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the table/list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

=== Deleting a Hierarchy ===

In the '''Hierarchies''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Hierarchy. Selecting one or more Hierarchy and clicking on it displays the following confirmation window.

[[File:MSM_Hierarchies_Hierarchies_Delete.png|center]]

Once the warning is confirmed, the selected Hierarchy is removed from Metis Smart Suite and deleted from the Metis Database.

=== Previewing a Hierarchy ===

In the '''Hierarchies''' 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 Hierarchy.

[[File:MSM_Hierarchies_Hierarchies_Preview.png|center|600x400px]]

Selecting a Hierarchy from the table and clicking on it opens the '''Hierarchy''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Hierarchy.

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

== Sections ==

Sections are the building parts of hierarchies. Sections are used as an organizational tool in Metis; they can contain both positions and sub-sections. Sub-sections are an optional organizational level found below sections and can also contain positions. Therefore, a section can have both free potions and positions found under a sub-section. While it is optional to include sub-sections in a section, a position must be part of a section for it to be classified. Sections, together with sub-sections and positions serve to make up hierarchies.

Sections are found throughout both Metis Smart Modeling and Metis Smart Quotes. In Metis Smart Modeling we find sections by going to the Hierarchies menu, then in the Hierarchies sub-menu. Once in the sub-menu, adding or editing an existing hierarchy opens a window where the contents of the hierarchy can be changed. Sections can be added using the '''Add Section''' button, as well as adding sub-sections to sections and positions to both sections and sub-sections. In the window that opens when clicking on '''Add Section''', all the available sections will be listed, some having a lock icon in front of them meaning that they were created in the parent version.

[[File:MSM_Hierarchies_Sections.png|center|600x400px]]

In Smart Quotes, sections can be found through the '''[[Description_of_the_Menu_Prices|Price]]''' menu by selecting a system and clicking on the Edit Material List button. A window opens where the system is listed at the top with all the sections and positions belonging to it found below.
Here the user may alter the material list by adding sections, sub-sections and positions to the system. The sections and positions shown in the bottom right corner are directly related to which hierarchy group and hierarchy is selected.

Adding a section or position is done simply by double clicking on it. Once added, sections and positions can then be moved using the up and down arrows found in the middle of the window.

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Sections 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 list.

=== Creating a Section ===

In the '''Sections''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Section. When it is clicked, the '''Section''' creation window opens, it allows to define all related information.

[[File:MSM_Hierarchies_Sections_Add.png|center|600x400px]]

Here the user must enter a name for the new section in the '''Description''' field for at least one of the available languages with a character limit of 80.

{{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 Section can be saved by validating the '''Section''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Modifying a Section ===

In the '''Section''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Section. Selecting a Section and clicking on it opens the '''Section''' edition window where all related properties and information can be edited. The name of the section can be edited here in the '''Description''' field for each of the available languages.

[[File:MSM_Hierarchies_Sections_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 Section. Modifications applied to the selected Section will only be saved once the Section edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the table/list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

{{Warning
| All modification applied to a section will be show everywhere this section is used (i.e. all hierarchies where the section appears either as a section or as a sub-section).
}}

=== Deleting a Section ===

In the '''Sections''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Section. Selecting one or more Section and clicking on it displays the following confirmation window.

[[File:MSM_Hierarchies_Sections_Delete.png|center]]

Once the warning is confirmed, the selected Section is removed from Metis Smart Suite and deleted from the Metis Database.

{{Warning
| A deleted section will be removed everywhere this section is used (i.e. all hierarchies where the section appears either as a section or as a sub-section). This may induce issues when removing a section containing positions and/or sub-sections.
}}

=== Previewing a Section ===

In the '''Section''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Section.

Selecting a Section from the list and clicking on it opens the '''Section''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Section.

[[File:MSM_Hierarchies_Sections_Preview.png|center|600x400px]]

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

== Segments ==

[[File:MSM_Hierarchies_SegmentView.png|center|600x400px]]

=== Creating a new Segment ===

In the '''Segment''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Segment. When it is clicked, the '''Segment''' creation window opens, it allows to define all related information.

[[File:MSM_Hierarchies_SegmentView_Add.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 Segment can be saved by validating the '''Segment''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Editing a Segment ===

In the '''Segment ''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Segment . Selecting a Segment and clicking on it opens the '''Segment ''' edition window where all related properties and information can be edited.

[[File:MSM_Hierarchies_SegmentView_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 Segment. Modifications applied to the selected Segment will only be saved once the Segment edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

=== Deleting a Segment ===

In the '''Segment''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Segment. Selecting one or more Segments and clicking on it displays the following confirmation window.

[[File:MSM_Attributes_Attributes_Delete.png|center]]

Once the warning is confirmed, the selected Segment is removed from Metis Smart Suite and deleted from the Metis Database.

=== Previewing a Segment ===

In the '''Segment''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Segment. Selecting a Segment from the list and clicking on it opens the '''Segment''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Segment.

[[File:MSM_Hierarchies_SegmentView_Preview.png|center|600x400px]]

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

File:MSM Hierarchies SegmentView Preview.png

2014-01-27T09:07:36Z

PatrickG:

File:MSM Hierarchies SegmentView Edit.png

2014-01-27T09:07:03Z

PatrickG:

File:MSM Hierarchies SegmentView Add.png

2014-01-27T09:06:33Z

PatrickG:

File:MSM Hierarchies SegmentView.png

2014-01-27T09:05:11Z

PatrickG:

Description of the Menu Prices

2014-01-24T12:26:39Z

PatrickG: /* Currencies */

The Prices menu consists of the following sub-menus:
* Price Groups
* Price Categories
* Price Factors
* Customer Prices
* Price Types
* Currencies

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/e/ea/VID_OverviewPriceConcept.png'>File:Price_Concept_OK.mp4</mediaplayer>
| Overview of the pricing concept in Metis Smart Modeling.
}}

== Price Groups ==

Price Groups are used to organize position prices into groups which will later be associated with a price type. Positions can vary in their price depending on the customer or other market variables. For example, the product associated with a position might be sold under different price specifications from one business to another, based on the size of it.

This is why price groups are created. When associating a price group with a price type, a price group might be named '''Sale''' which would later be used to link with the '''Sales Price''' price type. By default, all currently existing and newly created price groups are linked to all existing positions each having a starting value of zero, which can later be modified. The same is true for positions. That is, all currently existing and newly created positions are linked to every existing price group each with a starting value of zero.

In the main window of the Price Groups function, a list of all existing price groups is shown and the user can create new ones, edit existing ones and preview the for review.

[[File:MSM-Prices-Price-Groups.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Price Group 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 list.

{{Note
| Price Groups listed with a lock icon are inherited from parent versions and cannot be edited.
}}

=== Creating a Price Group ===

Before creating a new Price Group, the user/administrator should first check the version selected in the filter area. The new Price Group will be created in the select version.

In the '''Price Groups''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Price Group. When it is clicked, the '''Price Group''' creation window opens, it allows to define all related information. The user must first enter a name for the new price group into the '''Price Group Name''' field. Listed in the table below are all the positions found in Metis Smart Modeling that have a Price Model of '''Single'''. The user may choose to display only positions with a price value or all the positions by selecting the corresponding radio button at the top. The user may select any of the positions and enter a price, a currency and choose the price model for that particular position. The price model column contains the following options:

*'''Single''': price is determined to be the default price since only one single unit is being purchased.

*'''Quantity''': price is determined when a specific quantity is reached according to the position
For example, if the quantity is < 5, the price per unit is 200 EUR. If the quantity is < 10, the price per unit is 195 EUR, and so on.

*'''Amount''': price is determined when a certain monetary amount is reached according to the position
For example, if a customer's order reaches a total price of 2'000 EUR, a 1% discount applies. If the customer's order reaches 20'000 EUR, a 5% discount applies.

{{Note
| Prices for the new Price group can be edited directly when creating the Group or later on by editing the same group or by defining it for each position in the '''[[Description_of_the_Menu_Positions|Positions]]''' menu.
}}

[[File:MSM_Prices_Price_Groups_Add.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 Price Group can be saved by validating the '''Price Group''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Modifying a Price Group ===

In the '''Price Groups''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Price Group. Selecting a Price Group and clicking on it opens the '''Price Group''' edition window where all related properties and information can be edited. The user may then edit the prices, currencies and price model columns for any of the positions listed in the table below, and also modify the name of the selected Price Group.

[[File:MSM_Prices_Price_Groups_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 Price Group . Modifications applied to the selected Price Group will only be saved once the Price Group edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the table/list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

=== Deleting a Price Group ===

Selecting a Price Group from the list and using the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] allows the user to delete an existing price group. Multiple price groups may be selected and deleted together. When deleting a price group, the following pop-up window appears:

[[File:MSM-Prices-Price-Groups-Delete.png|center]]

The user must confirm the message before the price group can be deleted.

=== Previewing a Price group ===

The "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] allows the user to see the properties of the selected price group. Selecting a price group and clicking on the '''Preview''' button opens the '''Price Group''' window where the positions associated with the selected price group are displayed along with their properties.

[[File:MSM-Prices-Price-Groups-Preview.png|center|600x400px]]

{{Note
| It is not possible to edit the properties of a price group in the '''Preview''' section window. This must be done with the '''Edit''' button.
}}$

== Price Categories ==

Prices for certain products or services may vary depending on the customer. Price categories make sure that this is carried out in Metis Smart Quotes by letting the user define specific price groups for each price category they would like to create. This means that price categories can be used to define a different price for each type of business such as subcontractors for example, who can be offered different prices than direct salespeople.

Moreover, price categories are used when importing price conditions from SAP systems or other third party data sources) to allow multiple prices for each product. In the Price Categories sub-menu are all the existing price categories listed and organized in the table below by their description and category type. Price categories can be used in several different places in both Metis Smart Modeling and Smart Quotes.

In Smart Quotes, in the Project menu, when either adding or editing an existing offer, a price category field is found on the right side of the window under the General section. This field allows the user to set the price category that will be used for that specific offer. To do so, the user must click on the drop-down list icon for the Price Category field. The drop-down list will open with all the existing price categories made visible to the user.

Also in Smart Quotes, the user may define a default Price Category for themselves. To do so, the user must click on the Setup top button, then User Data, and go to the Parameters tab. Then, clicking on the icon in the Price Category field opens a drop down with all the existing price categories.

In Smart Modeling the administrator may set the Price Category in several different cases. In the Profiles menu, then in the '''[[Description_of_the_Sub-Menu_Price_categories|Price Categories]]''' sub-menu, when adding a new or editing an existing profile the administrator may choose from the list of all existing price categories which to authorize for that particular profile. Price categories with a lock icon before them indicate that they were created in the parent version.

Also in the Profiles menu, then in the Functionalities sub-menu, the administrator may set the default price category for a certain profile. To do so, either create a new or edit an existing profile. On the rights tab go to the section titled Setup and expand it. The last field named Default Price Category allows the administrator to set the default price category for that profile. By double clicking in the value cell a list of price categories will appear. In the cell to the right of the value, the user has the option to make the right invisible or read only as well.

In the Versions menu, then in the Versions sub-menu, when adding or editing a new version the version window will be open. On the Profiles tab the user can select the price category to be associated with that particular version.

{{Note
| If a user sets a default price category in Metis Smart Quotes themselves, it will take priority over the default price category set by the administrator in Metis Smart Modeling.
}}

[[File:MSM_Prices_Price_Categories.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Price Categories 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.

=== Creating a Price Category ===

Before creating a new Price Categories, the user/administrator should first check the version selected in the filter area. The new Price Category will be created in the select version.

In the '''Price Category''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main table/list allows the user/administrator to create a new Price Category. When it is clicked, the '''Price Category''' creation window opens, it allows to define all related information. The user must first enter a name into the '''Price Category Name''' field and then pick a '''Price Category Type''' from the drop-down list. From the '''Price Category Type''' drop-down list, the following two types can be selected:

*'''Normal''': Nothing has been changed for this price category.
*'''Global Sales Price''': The Cost price is calculated by the GSP Discount value. This means that the Sales price is multiplied by the percentage GSP discount to give the new cost price.

[[File:MSM-Profiles-Prices-Categories-Add.png|center|600x400px]]

{{Note
| Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field.
}}

{{Note
| The GSP Discount value is set by the administrator is Smart Modeling. To set the GSP Discount value, the administrator must go to the Versions menu, then the Versions sub-menu and edit the version to be modified.
Under the conditions section, the administrator enters a value in the GSP Discount field by clicking on the edit icon.
}}

In the first table, where languages are listed to the left. The user must enter a description for at least one of the languages listed, describing the newly created Price Category.

The second table contains price types on one side and price groups on the other. The price types listed on the left represent all of the existing price types and can be modified in the price types sub-menu. The '''Sales Price''' and '''Cost Price''' price types are the two default price types and will always appear. For each of the price types listed on the left, a corresponding price group needs to be defined for the new Price Category. When no price group has been defined yet, the price groups listed on the right are all defaulted to '''<None>'''. To choose a price group, the user must select a row and choose the price group they would like to associate with the corresponding price type listed on the left by searching through drop-down list by clicking on the button located in each price group row.

Once all related mandatory and optional information have been set, the new Price Category can be saved by validating the '''Price Category''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Modifying a Price Category ===

In the '''Price Categories''' 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 Price Category. Selecting a Price Category and clicking on it opens the '''Price Category''' edition window where all related properties and information can be edited. The user may then edit the price category name, type, description as well as the price groups associated with each price type.

[[File:MSM_Attributes_Attributes_Sum_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 Price Category. Modifications applied to the selected Price Category will only be saved once the Price Category edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the table/list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

=== Deleting a Price Category ===

In the '''Price Categories''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table/list allows the user/administrator to delete the selected Price Category. Selecting one or more Price Categories and clicking on it displays the following confirmation window.

[[File:MSM-Profiles-Prices-Categories-Delete.png|center]]

Once the warning is confirmed, the selected Price Category is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| The message below appears when trying to delete a Price Category listed with a lock icon.

[[File:MSM-Prices-Price-Categories-Delete2.png|center]]

}}

=== Previewing a Price Category ===

In the '''Price Categories''' 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 Price Category.

Selecting a Price Category from the table and clicking on it opens the '''Price Category''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Price Category.

[[File:MSM_Prices_Price_Categories_Preview.png|center|600x400px]]

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

== Price Factors==

Price factors are used when either the Sales or Cost price needs to be augmented by a certain factor. Meaning that if the Sales price needs to be increased by a certain percentage, the user can define the appropriate price factor by creating a new price factor using the add button.

Price Factors can be seen as default discounts (- or +) to be applied on an offer. Ideally, this function would be used without any additional discounting possibilities.

[[File:MSM-Prices-Price-Factors.png|center|600x400px]]

{{Note
| Price Factors are not identical to Difficulty Factors. Please refer to the corresponding section for more information on Difficulty Factors.
}}

=== Creating a Price Factor ===

In the '''Price Factors''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main table allows the user/administrator to create a new Price Factor. When it is clicked, the '''Price Factor''' creation window opens, it allows to define all related information.

*'''Sales Price Factor (%)''': a percentage multiplier used on the sales price
*'''Cost Price Factor (%)''': a percentage multiplier used on the cost price
*'''Code''': used as an additional reference
*'''Description''': the name of the Price Factor in all available languages

[[File:MSM-Prices-Price-Factors-Add.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 Price Factor can be saved by validating the '''Price Factor''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

{{Warning
| Sales Price Factor and Cost Price Factor are linked to the corresponding Price Types. Only those two Price types can be used by Price Factors.
}}

=== Modifying a Price Factor ===

In the '''Price Factor''' 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 Price Factor. Selecting a Price Factor and clicking on it opens the '''Price Factor''' edition window where all related properties and information can be edited. The sales price factor (%), the cost price factor (%), the code and the description are all editable.

[[File:MSM_Attributes_Attributes_Sum_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 Price Factor. Modifications applied to the selected Price Factor will only be saved once the Price Factor 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.

=== Deleting a Price Factor ===

In the '''Price Factor''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Price Factor. Selecting one or more Price Factor and clicking on it displays the following confirmation window.

[[File:MSM-Prices-Price-Factors-Del.png|center]]

Once the warning is confirmed, the selected Price Factor is removed from Metis Smart Suite and deleted from the Metis Database.

== Customer Prices ==

In some cases the prices listed in an offer need to be automatically adapted based on the customer the offer is intended for. For example, based on an agreement with it, he gets an overall 3% discount on every purchase he makes, or he could be eligible for a 5% discount on a specific list of positions or services.

To support such cases, Metis Smart Suite allows to define Customer Prices. The corresponding menu in Metis Smart Modeling allows the administrator to defines those special conditions. When defining a Customer price, the user has the possibility to specify both cases described above.

[[File:MSM_Prices_Customer_Prices.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Customer Price 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/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

=== Creating a Customer Price ===

In the '''Customer Prices''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main table allows the user/administrator to create a new Customer Price. When it is clicked, the '''Customer Price''' creation window opens, it allows to define all related information.

{{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 Customer Price can be saved by validating the '''Customer Price''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Modifying a Customer Price ===

In the '''Customer Prices''' 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 Customer Price. Selecting a Customer Price and clicking on it opens the '''Customer Price''' edition window where all related properties and information can be edited.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Customer Price. Modifications applied to the selected Customer Price will only be saved once the Customer Price 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.

=== Deleting a Customer Price ===

In the '''Customer Prices''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Customer Price. Selecting one or more Customer Price and clicking on it displays the following confirmation window.

Once the warning is confirmed, the selected Customer Price is removed from Metis Smart Suite and deleted from the Metis Database.

=== Previewing a Customer Price ===

In the '''Customer Price''' 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 Customer Price. Selecting a Customer Price from the table and clicking on it opens the '''Customer Price''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Customer Price.

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

== Price Types ==

Price Types are defined as the different possible variations of prices that can be encountered when creating an offer or placing an order; for example: the '''Sales Price''' and '''Cost Price'''. The three main price types '''Sales Price''', '''Cost Price''' and '''Transfer Price''' found in the Price Types sub-menu are all default price types and cannot be modified or deleted. But from this sub-menu, the User has the possibility to define additional ones based on the business' needs and requirements.

[[File:MSM-Prices--Price-Types.png|center|600x400px]]

In the Price Categories sub-menu, Price Types are used when defining which Price Groups are to be linked to the different Price Types. Please refer to this section for additional information.

'''Cost Price''' : Default Price Type representing costs for Price Groups in Metis Smart Suite.

'''Sales Price''' : Default Price Type representing selling prices for Price Groups in Metis Smart Suite.

'''Transfer Price''' : Default Price Type representing transfer prices between parts of an organization for Price Groups in Metis Smart Suite.

{{Note
| Price types that are created in a child version are not visible in the parent version.
}}

=== Creating a Price Type ===

In the '''Price Types''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Price Type. When it is clicked, the '''Price Type''' creation window opens, it allows to define all related information. The user must enter a name for the price type in the '''Price Type Name''' field having 50 or less characters.

[[File:MSM-Prices--Price-Types-Add.png|center]]

{{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 Price Type can be saved by validating the '''Price Type''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Modifying a Price Type ===

In the '''Price Types''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Price Type. Selecting a Price Type and clicking on it opens the '''Price Type''' edition window where all related properties and information can be edited.

[[File:MSM-Prices--Price-Types-Edit2.png|center]]

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Price Type. Modifications applied to the selected Price Type will only be saved once the Price Type edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

{{Note
| When a Price Type with a lock is selected and the user tries to edit it, the warning below will be displayed.

[[File:MSM-Prices--Price-Types-Edit.png|center]]
}}

=== Deleting a Price Type ===

In the '''Price Types''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Price Type. Selecting one or more Price Type and clicking on it displays the following confirmation window.

[[File:MSM-Prices--Price-Types-Del.png|center]]

Once the warning is confirmed, the selected Price Type is removed from Metis Smart Suite and deleted from the Metis Database.

== Currencies ==

The Currencies sub-menu allows the user to create any currency required for the organization in which Metis Smart Suite is being deployed. The user can either create new currencies or select already existing currencies from the drop-down list to define a new exchange rate. The exchange rate between the two currencies however, must be defined by the user. Once an exchange rate is defined, the currency is defined. The defined exchange rates allow Metis Smart Modeling to always calculate the right price in various currencies. The end user can still select which type of currency should appear in the proposal.

When an exchange rate is defined for in one direction, the second is automatically calculated by Metis Smart Modeling. For example, if users specify the EUR/USD exchange rate, Metis Smart Modeling will automatically calculate the reverse exchange rate (USD/EUR). Therefore, it will not be necessary to also specify the USD/EUR rate separately.

{{Warning
| Defining cascading exchange rates will not enable Metis to calculate the exchange rate between the first and the last currency. For example, if users specify the CHF/EUR and the EUR/RUB exchange rates, Metis Smart Modeling will not automatically calculate the CHF/RUB rate based on the first two rates alone. Therefore, if users wish to have the CHF/RUB, it has to be entered separately in the list of exchange rates.
}}

Existing currencies are listed in the table along with their exchange rates. Currencies can be used for defining prices (and all related objects), positions and offers in Metis Smart Quotes.

[[File:MSM-Prices-Currencies.png|center|600x400px]]

{{Note
| Currencies and the exchange rates defined within a Version are specific to that version.
}}

{{Note
| Exchange rate displayed in grey indicate automatic conversion of a defined exchange rate (the opposite rate). They can be modified!
}}

{{Note
| It is to have at least one currency is defined in Metis Smart Modeling. In cases where there is only one existing currency, it should be entered in the following format 1 EUR is 1 EUR.
}}

=== Creating a Currency ===

Before creating a new Currency, the user/administrator should first check the version selected in the filter area. The new Currency will be created in the select version.

In the '''Currency''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main table allows the user/administrator to create a new Currency. When it is clicked, the '''Currency''' creation window opens, it allows to define all related information.

[[File:MSM-Prices-Currencies-Add.png|center|600x400px]]

*'''Currency From''' : A new currency must be created or an existing currency must be selected with a character limit of 5.
*'''Exchange Rate''' : The exchange rate between the two currencies must be defined with a limit of 6 decimal digits. Metis does not generate the exchange rates, the user must use external resources to find the exchange rate.
*'''Currency To''' : A new currency must be created or an existing currency must be selected with a character limit of 5.

{{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 Currency can be saved by validating the '''Currency''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Modifying a Currency ===

In the '''Currencies''' 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 Currency. Selecting an exchange rate and clicking on the '''Edit''' button opens the '''Price Currency''' window, which is an editable version of the main currency window. The only information which can be changed are the exchange rates previously defined .

[[File:MSM-Prices-Currencies-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 Currency. Modifications applied to the selected Currency will only be saved once the Currency edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the table/list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

{{Note
| Because of the dependencies with currencies, the name of one cannot be edited. If it is required to change one, it is simpler to redefine a new one and have the option to delete the old one.
}}

=== Deleting a Currency ===

In the '''Currencies''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Currency. Selecting a Currency and clicking on it displays the following confirmation window.

[[File:MSM-Prices-Currencies-Delete.png|center]]

Once the warning is confirmed, the selected Currency is removed from Metis Smart Suite and deleted from the Metis Database along with all the exchange rates defined for it.

Description of the Menu Prices

2014-01-24T12:09:32Z

PatrickG: /* Price Factors */

The Prices menu consists of the following sub-menus:
* Price Groups
* Price Categories
* Price Factors
* Customer Prices
* Price Types
* Currencies

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/e/ea/VID_OverviewPriceConcept.png'>File:Price_Concept_OK.mp4</mediaplayer>
| Overview of the pricing concept in Metis Smart Modeling.
}}

== Price Groups ==

Price Groups are used to organize position prices into groups which will later be associated with a price type. Positions can vary in their price depending on the customer or other market variables. For example, the product associated with a position might be sold under different price specifications from one business to another, based on the size of it.

This is why price groups are created. When associating a price group with a price type, a price group might be named '''Sale''' which would later be used to link with the '''Sales Price''' price type. By default, all currently existing and newly created price groups are linked to all existing positions each having a starting value of zero, which can later be modified. The same is true for positions. That is, all currently existing and newly created positions are linked to every existing price group each with a starting value of zero.

In the main window of the Price Groups function, a list of all existing price groups is shown and the user can create new ones, edit existing ones and preview the for review.

[[File:MSM-Prices-Price-Groups.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Price Group 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 list.

{{Note
| Price Groups listed with a lock icon are inherited from parent versions and cannot be edited.
}}

=== Creating a Price Group ===

Before creating a new Price Group, the user/administrator should first check the version selected in the filter area. The new Price Group will be created in the select version.

In the '''Price Groups''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Price Group. When it is clicked, the '''Price Group''' creation window opens, it allows to define all related information. The user must first enter a name for the new price group into the '''Price Group Name''' field. Listed in the table below are all the positions found in Metis Smart Modeling that have a Price Model of '''Single'''. The user may choose to display only positions with a price value or all the positions by selecting the corresponding radio button at the top. The user may select any of the positions and enter a price, a currency and choose the price model for that particular position. The price model column contains the following options:

*'''Single''': price is determined to be the default price since only one single unit is being purchased.

*'''Quantity''': price is determined when a specific quantity is reached according to the position
For example, if the quantity is < 5, the price per unit is 200 EUR. If the quantity is < 10, the price per unit is 195 EUR, and so on.

*'''Amount''': price is determined when a certain monetary amount is reached according to the position
For example, if a customer's order reaches a total price of 2'000 EUR, a 1% discount applies. If the customer's order reaches 20'000 EUR, a 5% discount applies.

{{Note
| Prices for the new Price group can be edited directly when creating the Group or later on by editing the same group or by defining it for each position in the '''[[Description_of_the_Menu_Positions|Positions]]''' menu.
}}

[[File:MSM_Prices_Price_Groups_Add.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 Price Group can be saved by validating the '''Price Group''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Modifying a Price Group ===

In the '''Price Groups''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Price Group. Selecting a Price Group and clicking on it opens the '''Price Group''' edition window where all related properties and information can be edited. The user may then edit the prices, currencies and price model columns for any of the positions listed in the table below, and also modify the name of the selected Price Group.

[[File:MSM_Prices_Price_Groups_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 Price Group . Modifications applied to the selected Price Group will only be saved once the Price Group edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the table/list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

=== Deleting a Price Group ===

Selecting a Price Group from the list and using the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] allows the user to delete an existing price group. Multiple price groups may be selected and deleted together. When deleting a price group, the following pop-up window appears:

[[File:MSM-Prices-Price-Groups-Delete.png|center]]

The user must confirm the message before the price group can be deleted.

=== Previewing a Price group ===

The "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] allows the user to see the properties of the selected price group. Selecting a price group and clicking on the '''Preview''' button opens the '''Price Group''' window where the positions associated with the selected price group are displayed along with their properties.

[[File:MSM-Prices-Price-Groups-Preview.png|center|600x400px]]

{{Note
| It is not possible to edit the properties of a price group in the '''Preview''' section window. This must be done with the '''Edit''' button.
}}$

== Price Categories ==

Prices for certain products or services may vary depending on the customer. Price categories make sure that this is carried out in Metis Smart Quotes by letting the user define specific price groups for each price category they would like to create. This means that price categories can be used to define a different price for each type of business such as subcontractors for example, who can be offered different prices than direct salespeople.

Moreover, price categories are used when importing price conditions from SAP systems or other third party data sources) to allow multiple prices for each product. In the Price Categories sub-menu are all the existing price categories listed and organized in the table below by their description and category type. Price categories can be used in several different places in both Metis Smart Modeling and Smart Quotes.

In Smart Quotes, in the Project menu, when either adding or editing an existing offer, a price category field is found on the right side of the window under the General section. This field allows the user to set the price category that will be used for that specific offer. To do so, the user must click on the drop-down list icon for the Price Category field. The drop-down list will open with all the existing price categories made visible to the user.

Also in Smart Quotes, the user may define a default Price Category for themselves. To do so, the user must click on the Setup top button, then User Data, and go to the Parameters tab. Then, clicking on the icon in the Price Category field opens a drop down with all the existing price categories.

In Smart Modeling the administrator may set the Price Category in several different cases. In the Profiles menu, then in the '''[[Description_of_the_Sub-Menu_Price_categories|Price Categories]]''' sub-menu, when adding a new or editing an existing profile the administrator may choose from the list of all existing price categories which to authorize for that particular profile. Price categories with a lock icon before them indicate that they were created in the parent version.

Also in the Profiles menu, then in the Functionalities sub-menu, the administrator may set the default price category for a certain profile. To do so, either create a new or edit an existing profile. On the rights tab go to the section titled Setup and expand it. The last field named Default Price Category allows the administrator to set the default price category for that profile. By double clicking in the value cell a list of price categories will appear. In the cell to the right of the value, the user has the option to make the right invisible or read only as well.

In the Versions menu, then in the Versions sub-menu, when adding or editing a new version the version window will be open. On the Profiles tab the user can select the price category to be associated with that particular version.

{{Note
| If a user sets a default price category in Metis Smart Quotes themselves, it will take priority over the default price category set by the administrator in Metis Smart Modeling.
}}

[[File:MSM_Prices_Price_Categories.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Price Categories 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.

=== Creating a Price Category ===

Before creating a new Price Categories, the user/administrator should first check the version selected in the filter area. The new Price Category will be created in the select version.

In the '''Price Category''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main table/list allows the user/administrator to create a new Price Category. When it is clicked, the '''Price Category''' creation window opens, it allows to define all related information. The user must first enter a name into the '''Price Category Name''' field and then pick a '''Price Category Type''' from the drop-down list. From the '''Price Category Type''' drop-down list, the following two types can be selected:

*'''Normal''': Nothing has been changed for this price category.
*'''Global Sales Price''': The Cost price is calculated by the GSP Discount value. This means that the Sales price is multiplied by the percentage GSP discount to give the new cost price.

[[File:MSM-Profiles-Prices-Categories-Add.png|center|600x400px]]

{{Note
| Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field.
}}

{{Note
| The GSP Discount value is set by the administrator is Smart Modeling. To set the GSP Discount value, the administrator must go to the Versions menu, then the Versions sub-menu and edit the version to be modified.
Under the conditions section, the administrator enters a value in the GSP Discount field by clicking on the edit icon.
}}

In the first table, where languages are listed to the left. The user must enter a description for at least one of the languages listed, describing the newly created Price Category.

The second table contains price types on one side and price groups on the other. The price types listed on the left represent all of the existing price types and can be modified in the price types sub-menu. The '''Sales Price''' and '''Cost Price''' price types are the two default price types and will always appear. For each of the price types listed on the left, a corresponding price group needs to be defined for the new Price Category. When no price group has been defined yet, the price groups listed on the right are all defaulted to '''<None>'''. To choose a price group, the user must select a row and choose the price group they would like to associate with the corresponding price type listed on the left by searching through drop-down list by clicking on the button located in each price group row.

Once all related mandatory and optional information have been set, the new Price Category can be saved by validating the '''Price Category''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Modifying a Price Category ===

In the '''Price Categories''' 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 Price Category. Selecting a Price Category and clicking on it opens the '''Price Category''' edition window where all related properties and information can be edited. The user may then edit the price category name, type, description as well as the price groups associated with each price type.

[[File:MSM_Attributes_Attributes_Sum_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 Price Category. Modifications applied to the selected Price Category will only be saved once the Price Category edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the table/list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

=== Deleting a Price Category ===

In the '''Price Categories''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table/list allows the user/administrator to delete the selected Price Category. Selecting one or more Price Categories and clicking on it displays the following confirmation window.

[[File:MSM-Profiles-Prices-Categories-Delete.png|center]]

Once the warning is confirmed, the selected Price Category is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| The message below appears when trying to delete a Price Category listed with a lock icon.

[[File:MSM-Prices-Price-Categories-Delete2.png|center]]

}}

=== Previewing a Price Category ===

In the '''Price Categories''' 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 Price Category.

Selecting a Price Category from the table and clicking on it opens the '''Price Category''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Price Category.

[[File:MSM_Prices_Price_Categories_Preview.png|center|600x400px]]

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

== Price Factors==

Price factors are used when either the Sales or Cost price needs to be augmented by a certain factor. Meaning that if the Sales price needs to be increased by a certain percentage, the user can define the appropriate price factor by creating a new price factor using the add button.

Price Factors can be seen as default discounts (- or +) to be applied on an offer. Ideally, this function would be used without any additional discounting possibilities.

[[File:MSM-Prices-Price-Factors.png|center|600x400px]]

{{Note
| Price Factors are not identical to Difficulty Factors. Please refer to the corresponding section for more information on Difficulty Factors.
}}

=== Creating a Price Factor ===

In the '''Price Factors''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main table allows the user/administrator to create a new Price Factor. When it is clicked, the '''Price Factor''' creation window opens, it allows to define all related information.

*'''Sales Price Factor (%)''': a percentage multiplier used on the sales price
*'''Cost Price Factor (%)''': a percentage multiplier used on the cost price
*'''Code''': used as an additional reference
*'''Description''': the name of the Price Factor in all available languages

[[File:MSM-Prices-Price-Factors-Add.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 Price Factor can be saved by validating the '''Price Factor''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

{{Warning
| Sales Price Factor and Cost Price Factor are linked to the corresponding Price Types. Only those two Price types can be used by Price Factors.
}}

=== Modifying a Price Factor ===

In the '''Price Factor''' 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 Price Factor. Selecting a Price Factor and clicking on it opens the '''Price Factor''' edition window where all related properties and information can be edited. The sales price factor (%), the cost price factor (%), the code and the description are all editable.

[[File:MSM_Attributes_Attributes_Sum_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 Price Factor. Modifications applied to the selected Price Factor will only be saved once the Price Factor 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.

=== Deleting a Price Factor ===

In the '''Price Factor''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Price Factor. Selecting one or more Price Factor and clicking on it displays the following confirmation window.

[[File:MSM-Prices-Price-Factors-Del.png|center]]

Once the warning is confirmed, the selected Price Factor is removed from Metis Smart Suite and deleted from the Metis Database.

== Customer Prices ==

In some cases the prices listed in an offer need to be automatically adapted based on the customer the offer is intended for. For example, based on an agreement with it, he gets an overall 3% discount on every purchase he makes, or he could be eligible for a 5% discount on a specific list of positions or services.

To support such cases, Metis Smart Suite allows to define Customer Prices. The corresponding menu in Metis Smart Modeling allows the administrator to defines those special conditions. When defining a Customer price, the user has the possibility to specify both cases described above.

[[File:MSM_Prices_Customer_Prices.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Customer Price 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/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

=== Creating a Customer Price ===

In the '''Customer Prices''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main table allows the user/administrator to create a new Customer Price. When it is clicked, the '''Customer Price''' creation window opens, it allows to define all related information.

{{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 Customer Price can be saved by validating the '''Customer Price''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Modifying a Customer Price ===

In the '''Customer Prices''' 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 Customer Price. Selecting a Customer Price and clicking on it opens the '''Customer Price''' edition window where all related properties and information can be edited.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Customer Price. Modifications applied to the selected Customer Price will only be saved once the Customer Price 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.

=== Deleting a Customer Price ===

In the '''Customer Prices''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Customer Price. Selecting one or more Customer Price and clicking on it displays the following confirmation window.

Once the warning is confirmed, the selected Customer Price is removed from Metis Smart Suite and deleted from the Metis Database.

=== Previewing a Customer Price ===

In the '''Customer Price''' 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 Customer Price. Selecting a Customer Price from the table and clicking on it opens the '''Customer Price''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Customer Price.

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

== Price Types ==

Price Types are defined as the different possible variations of prices that can be encountered when creating an offer or placing an order; for example: the '''Sales Price''' and '''Cost Price'''. The three main price types '''Sales Price''', '''Cost Price''' and '''Transfer Price''' found in the Price Types sub-menu are all default price types and cannot be modified or deleted. But from this sub-menu, the User has the possibility to define additional ones based on the business' needs and requirements.

[[File:MSM-Prices--Price-Types.png|center|600x400px]]

In the Price Categories sub-menu, Price Types are used when defining which Price Groups are to be linked to the different Price Types. Please refer to this section for additional information.

'''Cost Price''' : Default Price Type representing costs for Price Groups in Metis Smart Suite.

'''Sales Price''' : Default Price Type representing selling prices for Price Groups in Metis Smart Suite.

'''Transfer Price''' : Default Price Type representing transfer prices between parts of an organization for Price Groups in Metis Smart Suite.

{{Note
| Price types that are created in a child version are not visible in the parent version.
}}

=== Creating a Price Type ===

In the '''Price Types''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Price Type. When it is clicked, the '''Price Type''' creation window opens, it allows to define all related information. The user must enter a name for the price type in the '''Price Type Name''' field having 50 or less characters.

[[File:MSM-Prices--Price-Types-Add.png|center]]

{{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 Price Type can be saved by validating the '''Price Type''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Modifying a Price Type ===

In the '''Price Types''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Price Type. Selecting a Price Type and clicking on it opens the '''Price Type''' edition window where all related properties and information can be edited.

[[File:MSM-Prices--Price-Types-Edit2.png|center]]

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Price Type. Modifications applied to the selected Price Type will only be saved once the Price Type edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

{{Note
| When a Price Type with a lock is selected and the user tries to edit it, the warning below will be displayed.

[[File:MSM-Prices--Price-Types-Edit.png|center]]
}}

=== Deleting a Price Type ===

In the '''Price Types''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Price Type. Selecting one or more Price Type and clicking on it displays the following confirmation window.

[[File:MSM-Prices--Price-Types-Del.png|center]]

Once the warning is confirmed, the selected Price Type is removed from Metis Smart Suite and deleted from the Metis Database.

== Currencies ==

The Currencies sub-menu allows the user to create any currency required for the organization in which Metis Smart Suite is being deployed. The user can either create new currencies or select already existing currencies from the drop-down list to define a new exchange rate. The exchange rate between the two currencies however, must be defined by the user. Once an exchange rate is defined, the currency is defined. The defined exchange rates allow Metis Smart Modeling to always calculate the right price in various currencies. The end user can still select which type of currency should appear in the proposal.

When an exchange rate is defined for in one direction, the second is automatically calculated by Metis Smart Modeling. For example, if users specify the EUR/USD exchange rate, Metis Smart Modeling will automatically calculate the reverse exchange rate (USD/EUR). Therefore, it will not be necessary to also specify the USD/EUR rate separately.

{{Warning
| Defining cascading exchange rates will not enable Metis to calculate the exchange rate between the first and the last currency. For example, if users specify the CHF/EUR and the EUR/RUB exchange rates, Metis Smart Modeling will not automatically calculate the CHF/RUB rate based on the first two rates alone. Therefore, if users wish to have the CHF/RUB, it has to be entered separately in the list of exchange rates.
}}

Existing currencies are listed in the table along with their exchange rates. Currencies can be used for defining prices (and all related objects), positions and offers in Metis Smart Quotes.

[[File:MSM-Prices-Currencies.png|center|600x400px]]

{{Note
| Currencies and the exchange rates defined within a Version are specific to that version.
}}

{{Note
| It is to have at least one currency is defined in Metis Smart Modeling. In cases where there is only one existing currency, it should be entered in the following format 1 EUR is 1 EUR.
}}

=== Creating a Currency ===

Before creating a new Currency, the user/administrator should first check the version selected in the filter area. The new Currency will be created in the select version.

In the '''Currency''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main table allows the user/administrator to create a new Currency. When it is clicked, the '''Currency''' creation window opens, it allows to define all related information.

[[File:MSM-Prices-Currencies-Add.png|center|600x400px]]

*'''Currency From''' : A new currency must be created or an existing currency must be selected with a character limit of 5.
*'''Exchange Rate''' : The exchange rate between the two currencies must be defined with a limit of 6 decimal digits. Metis does not generate the exchange rates, the user must use external resources to find the exchange rate.
*'''Currency To''' : A new currency must be created or an existing currency must be selected with a character limit of 5.

{{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 Currency can be saved by validating the '''Currency''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Modifying a Currency ===

In the '''Currencies''' 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 Currency. Selecting an exchange rate and clicking on the '''Edit''' button opens the '''Price Currency''' window, which is an editable version of the main currency window. The only information which can be changed are the exchange rates previously defined .

[[File:MSM-Prices-Currencies-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 Currency. Modifications applied to the selected Currency will only be saved once the Currency edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the table/list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

{{Note
| Because of the dependencies with currencies, the name of one cannot be edited. If it is required to change one, it is simpler to redefine a new one and have the option to delete the old one.
}}

=== Deleting a Currency ===

In the '''Currencies''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Currency. Selecting a Currency and clicking on it displays the following confirmation window.

[[File:MSM-Prices-Currencies-Delete.png|center]]

Once the warning is confirmed, the selected Currency is removed from Metis Smart Suite and deleted from the Metis Database along with all the exchange rates defined for it.

Description of the Sub-Menu Attributes

2014-01-22T15:50:19Z

PatrickG: /* Previewing a Functionality Profile */

In Metis Smart Modeling, [[Metis_Smart_Modeling_-_Attributes#Attributes|Attributes]] are additional position related information which can be defined as being basically anything which should describe this position. In Metis Smart Quotes not all attributes are relevant for the End-user either because they should not be used or because they should not be modified. In the Attributes profile menu, the administrator can define and manage the attributes defined in the [[Metis_Smart_Modeling_-_Attributes | Attributes section]], as shown in the following example:

[[File:MSM_Profiles_Attributes.png|center|600x400px]]

The attribute profiles defined in this menu can then be associated at a version level to Metis Smart Quotes users.

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Attributes profiles 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 list.

The attributes profiles table consist of two columns:
* the first column may contain a padlock icon. If a padlock icon appears, this means that the profile cannot be deleted nor its properties edited. Only an administrator of the parent version can delete the profile or edit its properties.
* the second column contains the designation of the profile.

{{Note
| The contents of the Profiles table is sorted in alphabetical order, thus it cannot be sorted.
}}

=== Adding an Attribute Profile ===

In the '''Attribute Profiles''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Attribute Profile. When it is clicked, the '''Attribute Profile''' creation window opens, it allows to define all related information.

[[File:MSM_Profiles_Attributes_Add_Attributes.png|center|600x400px]]

The administrator must provide a valid name for the profile to be able to save it. A pop up appears if the administrator tries to save the profile with the '''Profile Name''' field left blank or if the name already exists.

The attribute profile window consists of two tabs:

* Attribute tab:
In this tab, at least one attribute must be selected for the Metis Smart Quotes user to have attributes. Selecting attributes for positions and not mandatory; a position can have zero attributes associated to it. The table contains the attributes available in the [[Description of the Menu Attributes | Attributes menu]]. If no attribute is selected, no attribute will be available to the Smart Quotes user.

A padlock icon might appear to indicate that the attribute has been inherited from a parent profile or version. By clicking on the header of the '''Authorized''' column, it is possible to sort the contents of the table to display the authorized attributes first, then the unauthorized ones. The reverse order is also possible. By clicking on the header of the '''Attribute''' column, it is possible to sort the contents of the table by alphabetical order. It is also possible to search for an attribute by clicking on the magnifying glass icon.

Below the attribute table, the '''All''' and '''None''' buttons allows to select or unselect all the entries of the table.

* Attributes Sum tab:

In this tab, all Attribute Sets defined in Metis Smart Modeling are listed and can be authorized for the Attribute Profile. The principle is the same as for basic attributes. Disabling attributes will result in them not being available in Metis Smart Quotes for model calculation and manual edition by the End-users.

{{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 Attribute Profile can be saved by validating the '''Attribute Profile''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

{{Note
| As described in the [[Metis_Smart_Modeling_-_Attributes#Attributes|Attributes]] section, Attributes can also be disabled for End-user edition by setting it as "not editable" or "invisible". This still allows them to be used by the model calculation. be careful disabling Attributes in Attributes Profiles. It is preferable to use this functionality to enable or disable Attributes which only describe positions and are not used in models. For example, a specific group of users may require to have access to specific [[Metis_Smart_Modeling_-_Attributes#Attributes_Sum|Attribute Sums]], which are unuseful to another group.
}}

=== Duplicating an Attribute Profile ===

To create a new profile, the administrator can also create a duplicate of an existing profile and then edit it accordingly. To do so, the administrator must select a profile and then click on the "Duplicate" button [[File:MetisSmartModelingDuplicateButton.PNG|link=]]. The Attribute Profile window appears as shown in the following example:

[[File:MSM_Profiles_Attributes_Add_Attributes_Sum.png|center|600x400px]]

By default, the profile name field displays the name of the profile which has been duplicated. The administrator must provide another name for the profile as it is not possible to provide a profile name that already exists. If the administrator tries to do so, a pop-up window appears when trying to save the profile.

The administrator can then define the properties of the new profile (i.e. the authorized attributes an attribute sums).

Once all related mandatory and optional information have been set, the new Attribute Profile can be saved by validating the '''Attribute Profile''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Editing an Attribute Profile ===

In the '''Attribute Profiles''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Attribute Profile. Selecting a Attribute Profile and clicking on it opens the '''Attribute Profile''' edition window where all related properties and information can be edited.

[[File:MSM_Profiles_Attributes_Edit_Attributes.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 Attribute Profile. Modifications applied to the selected Attribute Profile will only be saved once the Attribute Profile edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

{{Note
| If the administrator does not have the right to edit the properties of a profile (i.e. presence of a padlock icon), a pop-up window appears.
}}

=== Deleting an Attribute Profile ===

In the '''Attribute Profiles''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Attribute Profile. Selecting a Attribute Profile and clicking on it displays the following confirmation window.

[[File:MSM_Profiles_Attributes_Delete.png|center]]

If the profile has been assigned to versions and profile groups, the confirmation window indicates the number of versions and profile groups using this profile.

Once the warning is confirmed, the selected Attribute Profile is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| Profiles with a padlock icon cannot be deleted. If the administrator tries to do so, a pop-up window appears.
}}

=== Previewing an Attribute Profile ===

In the '''Functionality Profiles''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Functionality Profile. Selecting a Functionality Profile from the list and clicking on it opens the '''Functionality Profile''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Functionality Profile.

[[File:MSM_Profiles_Attributes_Preview_Attributes.png|center|600x400px]]

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

Description of the Sub-Menu Hierarchies

2014-01-22T15:43:57Z

PatrickG: /* Duplicating a Hierarchy Profile */

In Metis Smart Modeling, [[Description_of_the_Menu_Hierarchies#Hierarchies|hierarchies]], [[Description_of_the_Menu_Hierarchies#Hierarchy_Groups|hierarchy groups]] and [[Description_of_the_Menu_Hierarchies#Sections|sections]] can be defined in order to sort all the different material and service positions created or imported into the application. The Hierarchy profile menu allows the administrator to define and manage the hierarchies and hierarchy groups in order to make them available to user in version or individually.

[[File:MSM_Profiles_Hierarchies.png|center|600x400px]]

{{Note
| Remember that the positions available in the version and to the Metis Smart Quotes user depends on the authorized hierarchies and hierarchy groups.
}}

The hierarchy profiles defined in this menu can then be attributed to a version level to Metis Smart Quotes users.

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Hierarchy Profiles 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 list.

The hierarchy profiles list consist of two columns:
* the first column may contain a padlock icon. If a padlock icon appears, this means that the profile cannot be deleted nor its properties edited. Only an administrator of the parent version can delete the profile or edit its properties.
* the second column contains the designation of the profile.

The contents of the Profiles table is sorted and displayed in alphabetical order and can thus not be modified.

=== Adding a Hierarchy Profile ===

In the '''Hierarchy Profiles''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Hierarchy Profile. When it is clicked, the '''Hierarchy Profile''' creation window opens, it allows to define all related information.

[[File:MSM_Profiles_Hierarchies_Add_Hierarchies.png|center|600x400px]]

The administrator must provide a valid name for the profile to be able to save it. A pop up appears if the administrator tries to save the profile with the '''Profile Name''' field left blank or if the name already exists. The hierarchy profile window consists of two tabs:
* Hierarchy Groups
* Hierarchies

Both tables contain the hierarchies and the hierarchy groups defined in the [[Description of the Menu Hierarchies | Hierarchies menu]]. A hierarchy profile is defined by its name and the hierarchy groups and hierarchies which are selected within the two available tabs. Based on how the objects where created in Metis Smart Modeling, they may be linked together. This means that in order for provide access to a specific set of positions, the administrator should authorize hierarchies which are linked to the group which was also given access to. In both tabs, a padlock icon might appear to indicate that the hierarchy or the hierarchy group has been inherited. In both tabs, by clicking on the header of the '''Authorized''' column, it is possible to sort the contents of the table to display the authorized hierarchies or hierarchies groups first, then the unauthorized ones. The reverse order is also possible. In both tabs, by clicking on the header of the '''Hierarchy Groups''' or '''Hierarchies''' column, it is possible to sort the contents of the table alphabetically. It is also possible to search for Hierarchy Groups or Hierarchies by clicking on the magnifying glass icon.

Below the Hierarchy groups and Hierarchies tables, the '''All''' and '''None''' buttons allows the user to select or unselect all the entries in the table.

[[File:MSM_Profiles_Hierarchies_Add_Hierarchy_Goups.png|center|600x400px]]

{{Note
| In these tabs, at least one hierarchy group and a hierarchy contained within that hierarchy group should be selected for the Metis Smart Quotes user to have positions available to create offers. If no hierarchy group is selected, no positions are available to the Smart Quotes user. If at least one hierarchy group has been selected but no hierarchies, the hierarchy group is displayed in the hierarchy groups drop-down menu of Metis Smart Quotes but neither hierarchies nor positions are available.
}}

{{Note
| Hierarchies and hierarchy Groups displayed with a padlock (inherited from another version) can be authorized or not for the profile beeing edited or created.
}}

Once all related mandatory and optional information have been set, the new Hierarchy Profile can be saved by validating the '''Hierarchy Profile''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Duplicating a Hierarchy Profile ===

In order to create a new hierarchy profile, the administrator can also duplicate an existing profile by selecting it and then clicking on the "Duplicate" button [[File:MetisSmartModelingDuplicateButton.PNG|link=]]. The hierarchy profile window appears as shown in the following example:

[[File:MSM_Profiles_Hierarchies_Edit_Hierarchy_Goups.png|center|600x400px]]

All the settings from the original profile are displayed in the window and the only thing the user has to do is provide a unique name for his newly created hierarchy profile. After doing so, the user can modify the authorized hierarchy groups or hierarchies required and save the new hierarchy. It will immediately be displayed within the main list.

{{Tip
| This allows to create new hierarchy profile quicker.
}}

=== Editing a Hierarchy Profile ===

In the '''Hierarchy Profiles''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Hierarchy Profile. Selecting a Hierarchy Profile and clicking on it opens the '''Hierarchy Profile''' edition window where all related properties and information can be edited.

[[File:MSM_Profiles_Hierarchies_Edit_Hierarchies.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 Hierarchy Profile. Modifications applied to the selected Hierarchy Profile will only be saved once the Hierarchy Profile edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

{{Note
| The application verifies if the name has changed and if it is already used within Metis Smart Suite.
}}

=== Deleting a Hierarchy Profile ===

In the '''Hierarchy Profiles''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Hierarchy Profile. Selecting a Hierarchy Profile and clicking on it, if the profile has been attributed to versions and profile groups, the confirmation window indicates the number of versions and profile groups using this profile.

[[File:MSM_Profiles_Hierarchies_Delete.png|center]]

Once the warning is confirmed, the selected Hierarchy Profile is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| Remember that profiles with a padlock icon cannot be deleted. If the administrator tries to do so, a pop-up window appears.
}}

{{Note
| The administrator cannot select several profiles at the same time.
}}

=== Previewing a Hierarchy Profile ===

In the '''Hierarchy Profiles''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Hierarchy Profile. Selecting a Hierarchy Profile from the list and clicking on it opens the '''Hierarchy Profile''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Hierarchy Profile.

[[File:MSM_Profiles_Hierarchies_Preview_Hierarchy_Goups.png|center|600x400px]]

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

Description of the Sub-Menu Hierarchies

2014-01-22T15:42:50Z

PatrickG: /* Adding a Hierarchy Profile */

In Metis Smart Modeling, [[Description_of_the_Menu_Hierarchies#Hierarchies|hierarchies]], [[Description_of_the_Menu_Hierarchies#Hierarchy_Groups|hierarchy groups]] and [[Description_of_the_Menu_Hierarchies#Sections|sections]] can be defined in order to sort all the different material and service positions created or imported into the application. The Hierarchy profile menu allows the administrator to define and manage the hierarchies and hierarchy groups in order to make them available to user in version or individually.

[[File:MSM_Profiles_Hierarchies.png|center|600x400px]]

{{Note
| Remember that the positions available in the version and to the Metis Smart Quotes user depends on the authorized hierarchies and hierarchy groups.
}}

The hierarchy profiles defined in this menu can then be attributed to a version level to Metis Smart Quotes users.

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Hierarchy Profiles 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 list.

The hierarchy profiles list consist of two columns:
* the first column may contain a padlock icon. If a padlock icon appears, this means that the profile cannot be deleted nor its properties edited. Only an administrator of the parent version can delete the profile or edit its properties.
* the second column contains the designation of the profile.

The contents of the Profiles table is sorted and displayed in alphabetical order and can thus not be modified.

=== Adding a Hierarchy Profile ===

In the '''Hierarchy Profiles''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Hierarchy Profile. When it is clicked, the '''Hierarchy Profile''' creation window opens, it allows to define all related information.

[[File:MSM_Profiles_Hierarchies_Add_Hierarchies.png|center|600x400px]]

The administrator must provide a valid name for the profile to be able to save it. A pop up appears if the administrator tries to save the profile with the '''Profile Name''' field left blank or if the name already exists. The hierarchy profile window consists of two tabs:
* Hierarchy Groups
* Hierarchies

Both tables contain the hierarchies and the hierarchy groups defined in the [[Description of the Menu Hierarchies | Hierarchies menu]]. A hierarchy profile is defined by its name and the hierarchy groups and hierarchies which are selected within the two available tabs. Based on how the objects where created in Metis Smart Modeling, they may be linked together. This means that in order for provide access to a specific set of positions, the administrator should authorize hierarchies which are linked to the group which was also given access to. In both tabs, a padlock icon might appear to indicate that the hierarchy or the hierarchy group has been inherited. In both tabs, by clicking on the header of the '''Authorized''' column, it is possible to sort the contents of the table to display the authorized hierarchies or hierarchies groups first, then the unauthorized ones. The reverse order is also possible. In both tabs, by clicking on the header of the '''Hierarchy Groups''' or '''Hierarchies''' column, it is possible to sort the contents of the table alphabetically. It is also possible to search for Hierarchy Groups or Hierarchies by clicking on the magnifying glass icon.

Below the Hierarchy groups and Hierarchies tables, the '''All''' and '''None''' buttons allows the user to select or unselect all the entries in the table.

[[File:MSM_Profiles_Hierarchies_Add_Hierarchy_Goups.png|center|600x400px]]

{{Note
| In these tabs, at least one hierarchy group and a hierarchy contained within that hierarchy group should be selected for the Metis Smart Quotes user to have positions available to create offers. If no hierarchy group is selected, no positions are available to the Smart Quotes user. If at least one hierarchy group has been selected but no hierarchies, the hierarchy group is displayed in the hierarchy groups drop-down menu of Metis Smart Quotes but neither hierarchies nor positions are available.
}}

{{Note
| Hierarchies and hierarchy Groups displayed with a padlock (inherited from another version) can be authorized or not for the profile beeing edited or created.
}}

Once all related mandatory and optional information have been set, the new Hierarchy Profile can be saved by validating the '''Hierarchy Profile''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window.

=== Duplicating a Hierarchy Profile ===

In order to create a new hierarchy profile,the administrator can also duplicate an existing profile by selecting it and then clicking on the "Duplicate" button [[File:MetisSmartModelingDuplicateButton.PNG|link=]]. The hierarchy profile window appears as shown in the following example:

[[File:MSM_Profiles_Hierarchies_Edit_Hierarchy_Goups.png|center|600x400px]]

All the settings from the original profile are displayed in the window and the only thing the user has to do is provide a unique name for his newly created hierarchy profile. After doing so, the user can modify the authorized hierarchy groups or hierarchies required and save the new hierarchy. It will immediately be displayed within the main list.

{{Tip
| This allows to create new hierarchy profile quicker.
}}

=== Editing a Hierarchy Profile ===

In the '''Hierarchy Profiles''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Hierarchy Profile. Selecting a Hierarchy Profile and clicking on it opens the '''Hierarchy Profile''' edition window where all related properties and information can be edited.

[[File:MSM_Profiles_Hierarchies_Edit_Hierarchies.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 Hierarchy Profile. Modifications applied to the selected Hierarchy Profile will only be saved once the Hierarchy Profile edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

{{Note
| The application verifies if the name has changed and if it is already used within Metis Smart Suite.
}}

=== Deleting a Hierarchy Profile ===

In the '''Hierarchy Profiles''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Hierarchy Profile. Selecting a Hierarchy Profile and clicking on it, if the profile has been attributed to versions and profile groups, the confirmation window indicates the number of versions and profile groups using this profile.

[[File:MSM_Profiles_Hierarchies_Delete.png|center]]

Once the warning is confirmed, the selected Hierarchy Profile is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| Remember that profiles with a padlock icon cannot be deleted. If the administrator tries to do so, a pop-up window appears.
}}

{{Note
| The administrator cannot select several profiles at the same time.
}}

=== Previewing a Hierarchy Profile ===

In the '''Hierarchy Profiles''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Hierarchy Profile. Selecting a Hierarchy Profile from the list and clicking on it opens the '''Hierarchy Profile''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Hierarchy Profile.

[[File:MSM_Profiles_Hierarchies_Preview_Hierarchy_Goups.png|center|600x400px]]

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

Description of the Menu Profiles

2014-01-22T15:18:28Z

PatrickG:

In Metis Smart Modeling all functionnalities and data can be "filtered" based on the user, the version and the variant used. The Metis Smart Modelling user/administrator will have to set all the data (see previous sections) first and then he will be able to determine what data will be available to which group of users. In the Profiles menu, the administrator can define and manage the settings and the rights which are then attributed at the version level and to each Metis users.

The different types of profiles and functionnalities related are divided as listed below. Each sub-menus are described in their respective sections.

* [[Description of the Sub-Menu Functionalities | Functionalities]]
* [[Description of the Sub-Menu Hierarchies | Hierarchies]]
* [[Description of the Sub-Menu Attributes | Attributes]]
* [[Description of the Sub-Menu Price categories | Price Categories]]
* [[Description of the Sub-Menu Systems | Systems]]
* [[Description of the Sub-Menu Service Models| Service Models]]
* [[Description of the Sub-Menu Tax Models| Tax Models]]
* [[Description of the Sub-Menu Variants | Variants]]
* [[Description of the Sub-Menu Profile Groups | Profile Groups]]

{{Warning
| Great care should be given when setting profiles for users and/or versions. It has a direct influence on what the end-users will be able to do and work with.
}}

Description of the Menu Versions

2014-01-22T15:00:38Z

PatrickG: /* Add */

As Metis Smart Suite can be rolled out in small to large organizations the software supports a versioning concepts. These feature allows it to be structured in a tree like schema. As the root of this tree there will always be the main delivered version of the application.

The branches from that tree will represent created version within the organization. As described in the figure below the headquarters of an organization is placed at the root of the tree, and all the country specific subsidiaries, for example, are shown as first child version (i.e. first level nodes). The leafs of the tree from a specific branch are for example partners within that country.

Within Metis Smart Suite a version is mainly described by its name and basic information, conditions, customer designation and directories which have to be used by it. Additionally '''[[Description of the Menu Profiles | Profiles]]''' of all types can be linked to a version in order to enforce default rights and privileges to all users which will be created in that version.

Versions are a key element of the Metis Smart Suite. This functionality allows the administrator to re-create the sales or legal structure of the company in which the software suite is being deployed. Additional examples of how this structure can support any organization can be found within the various screenshots of that section.

== Versions ==

Both Metis Smart Modeling users and administrators can create as many versions as required. As a reminder, versions that descend from a main version are classified as child versions. The main versions which create these child versions are classified as parent versions. This means that any single version may be a parent or child version, depending on the point of view.

[[File:IMG_Version_Concept.png|center|600x400px]]

=== Overview of versions ===

Users may add, delete, edit, and preview versions in this sub-menu. A search feature can be found on the left side and a main table containing general information is found in the working area.

In this table, the parent version (the currently logged-in version) is featured at the top with all its child versions listed below.
Versions in the main table may be represented by several different types of icons.

{| 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 Version
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Icon
! 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" |
'''Normal Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Standard Metis Smart Suite Version.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Version without Admin'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionNoAdminIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
There are no Users defined as administrator for this version. It depends entirely on the parent version's Administrator.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Inactive Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
[[File:MetisSmartModelingVersionInactiveIcon.png‎|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Version exists in the Metis Smart Suite Database, but has been disabled.
|-
|}

A lock icon may be found preceding any of these types of versions. The lock icon signifies that the version was not created in the version currently logged-in, but in another version or by an automated system.

[[File:MSM_Versions_Versions.png|center|600x400px]]

{{Note
| Imported versions which are denied access to certain items through profile groups, can never have access to these items even if they are given access through the use of additional profiles.

[take a screenshot of for example a system profile[title it "main profile"] with several check-boxes unticked and one["additional profile"] with the same check-boxes ticked, and then screenshot of additional profiles for profile groups for the user]
}}

{| 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 0 1px 0" | Description
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Version Specific Objects'''
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Available only in the version where created and in the child versions if access was granted.
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
*Employees
*Offices
*Positions
*Attributes
*Hierarchies
*Segments
*Price Groups
*Price Categories
*Documents
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Objects implicitly linked'''
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Allowed modifications which are done to part of an object (i.e. description) are then valid also for all child versions,
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
*Translations (descriptions all positions, attributes, hierarchies, prices, systems and languages)
*Data Management type objects
|-
|}

=== Managing versions ===

====Search====

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Versions based on various criterions. 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 disaplyed below/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

====Add====

In the '''Versions''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Version. When it is clicked, the '''Version''' creation window opens, it contains two different type of information. The first tab '''Version''' shows a table separated into several expandable sections with two columns, '''Designation''' which represents the type of field and '''Value''' which represents the data entered into that field. All those fields provides the detailed description of a version. Only the ones with the edit icon on the right-hand side of the table can be defined by the user. The other ones are either inheritance from the parent version or imported through a third-party system.

[[File:MSM_Versions_Versions_add_Versions.png|center|600x400px]]

{{Note
| Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field.
}}

When creating a new version, the fields in the versions tab can be edited in order to define the version.

'''''Main'''''

* Version: Name of the version.
* Administrator Free: Choose to make a version administrator free. By setting the version to be administration free, the fields under the Customer section become available.
* Nomad Gateway User: A nomad gateway user can be defined in this field.
* Use Parent documents: Choose to use parent documents for the current version.
* Second ID to display : Secondary ID for he version.
* Default currency : set the default currency to used for all offers created within this version.
* Role for client condition : Role which specifies which Address is taken to apply '''[[Description_of_the_Menu_Prices#Customer_Prices|Customer Prices]]'''.

'''''Login'''''

* Default Password: Default password for any new user or when resetting a user's password.
* Mandatory Password Change: Selection for password change requirement.
* At least 1 Upper Case Letter: Any password provided by the user should at least hold 1 upper case letter.
* At least 1 Lower Case Letter: Any password provided by the user should at least hold 1 lower case letter.
* At least 1 Mandatory Number: Any password provided by the user should at least hold 1 number.
* At least 1 Mandatory Special Character: Any password provided by the user should at least hold 1 special character.
* Minimum Length: Any password provided by the user should have a minimum length of the defined number of characters.
* Warning Period [days]: Number of days before the end of the validity of a password when a warning message will be displayed to the user to change his password.
* Validity Period [days]: Validity period for a given password.

'''''Conditions'''''

* GSP Discount: The global sales price discount. Entering a figure here for example 50.0, means that a discount of 50% will be factored into the global sales price for this version. The GSP Discount can only be defined for a version by the parent version.

'''''Customer'''''

* OrgID: Organization ID
* Name 1: Name of the customer contact.
* Name 2: Additional name field for a contact.
* Name 3: Additional name field for a contact.
* Address 1: Address of where the customer is located (i.e. street name)
* Address 2: Additional address field for the customer (i.e. building name).
* City Name: City of where the customer is located. A drop-down list of available cities can provided for selection (see Data Management)
* ZipCode: Zipcode for where the customer is located.
* Country: Country where the customer is located. A drop-down list of available countries can provided for selection (see Data Management).
* State: State in the country where the customer is located. A drop-down list of states can be provided for selection (see Data Management).

'''''Directories'''''

Directories may only be specified within the version currently logged-in to. Parent versions cannot choose the directory for child versions. When a directory has been specified, the folder path will be shown in the corresponding field.

* Exchange: link to a folder used for saving FQS files.
* Document: link to a folder used for saving documents that are related to offers.
* Order: link to a folder used for saving XML and SES files.
* Libraries: link to a folder used for software libraries.

'''Profiles'''

'''[[Description of the Menu Profiles | Profiles]]''' are set to a version by the parent of that version in the section '''From Creator'''. Versions that have been automatically created by importation have their profiles also automatically set and cannot have their profiles edited.

However, additional profiles can be given to these versions in the section '''From parent'''. The '''From parent''' section is only visible for these automatically created versions. To the right of the edit icon column is another column that has an eye for an icon.

Clicking on this eye lets the user see what items are defined by the current profile. Meaning that if the system profile "Default systems" was selected, doing so will display which systems are available in this profile.

[[File:MSM_Versions_Versions_add_profiles.png|center|600x400px]]

{{Note
| Differentiation must be made between the two different classes of Profiles: the ones defining privileges for content and for functionnalities. In the case of a Version, both classes can be set. For content related profiles, the content available in a child version is the 'union' of the profiles provided by the version creator and the parent version. When creating manually a version, it only can only hold preset profiles defined as 'From Creator', there are no additional profiles coming from a distant parent. Those profiles are automatically based on the content available and defined in the version from which it is created. As for the Functionality Profiles, they will be used in the child Version as a basis for future grandchild version or duplicated Profiles.
}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/d/d2/VID_AdditionalProfilesConcept.PNG'>File:Additional_Profiles_OK.mp4‎</mediaplayer>
| Managing additional Profiles in versions.
}}

'''''From Creator'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

'''''From Parent'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

====Edit====

In the '''Versions''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version. Selecting a version and clicking on it opens the '''Version''' edition window where all related properties and information can be edited.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Version. Modifications applied to the selected version will only be saved once the version edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

[[File:MSM_Versions_Versions_Edit_Version.png|center|600x400px]]

====Delete====

In the '''Version''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Version. Selecting a version and clicking on it displays the following confirmation window.

[[File:MSM_Versions_Versions_delete_2.png|center]]

Once the warning is confirmed, the selected version is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| It is not possible to delete a version unless logged-in to the version that created it.

[[File:MSM_Versions_Versions_delete.png|center]]

}}

====Preview====

In the '''Versions''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected version. Selecting a version from the list and clicking on it opens the '''Version''' preview window.

[[File:MSM_Versions_Versions_Preview_profile.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 ... .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In the rightmost column of the table displayed in the '''Version''' preview window, the icon representing an eye can be used to display the list Systems, Hierarchies, Price Categories, Attributes, Variants, Service Models and Tax Models which have been set for the various profiles. No edition is possible.

==== Version without Administrator ====

As stated in the name, version without administrator is a Metis Smart Suite Version which doesn't include an administrator. This type of version is mainly used when no direct maintenance is required on the version level or when it is simply not wished to let the version be maintained individually.

A version without administrator is always created and maintained by its parent version.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/f/fe/VID_VersionNoAdmin.png'>File:Setting_a_version_without_an_administrator_OK.mp4‎</mediaplayer>
| Setting up a version without an administrator.
}}

== Access ==

From this sub-menu, the administrator can define and manage the access between the various children versions, as shown in the following example:

[[File:MSM_Versions_Access.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find versions based on various criterion. The search is triggered by typing a keyword or only a letter in the field 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 list.

=== Editing a Version's Rights ===

In the '''Version Rights''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version Right. Selecting a version right and clicking on it opens the '''Version Rights''' edition window where all related properties and information can be edited.

[[File:MSM_Versions_Access_Edit.png|center|600x400px]]

{{Note
| The title on the window displays the name of selected version (e.g. Version Rights Headquarters where Headquarters is the name of the selected version).
}}

The Versions (Smart Quotes) table displays all the available versions. The displayed versions consist of all of the children versions of the administrator's version. The authorized column allows the administrator to select / deselect the versions that the Smart Quotes users is authorized to access to. The following example describes the cases where a version can have access to the projects and offers made in other versions:

[[File:MetisSmartModelingVersionsProfileDiagram.PNG]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/a/a3/VID_Manage_the_version_access.png'>File:Managing_the_access_of_versions_OK.mp4‎</mediaplayer>
| Managing version access.
}}

An administrator of Version A can define that the Version A users can have access to the direct children versions' projects and offers (i.e. Version B, Version C and Version D). However, Version A users cannot access Version E's projects and offers because Version E is not a direct child of Version A.

The administrator of Version A can also define that Version B users can have access to Version C's projects and offers but not to Version D's projects and offer. The same administrator could also define that Version C users can only have access to Version B's projects and offers.

The authorization is not bi-directional: if Version B users have access to Version C's projects and offers, Version C users do not automatically receive access to Version B's projects and offers. The administrator must set the authorizations for each version.

=== Previewing a Version's Rights ===

In the '''Version Access''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Version Rights. Selecting a Version Right from the table/list and clicking on it opens the '''Version Rights''' preview window.

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

For detailed descriptions of all information available in this window please refer to the section dedicated to the edition of a version right .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In this window, only the authorized versions are displayed. This means that if a version is not authorized to see the projects or the offers or at least one other version, the table is empty as shown in the following example:

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

== Languages ==

Metis Smart Suite supports the use of multiple languages for single roll-outs of the application. Different languages can then be used to translate the [[Metis_Smart_Modeling_-_Setup|User Interface]] and/or the objects created in Metis Smart Modeling, the documents generated by Metis Smart Quotes or the Notes provided by the End-Users In this menu, the administrator defines the languages that the Metis Smart Modeling and Metis Smart Quote users are authorized to use.

{{Warning
| The administrator can define a maximum of four languages per version.
}}

Languages defined in this menu are then made available in the following parts of Metis:

* when a designation is required for an item (e.g. a language, a [[Description_of_the_Menu_Positions|position]], an [[Metis_Smart_Modeling_-_Attributes|attribute]] etc.), the designation may be entered for all the languages that have been made available.

* In the [[Description_of_the_Menu_Users|Users]] menu when defining a user's main language

* In the [[Description of the Sub-Menu Functionalities#Languages tab | Profiles]] menu when setting a default language for a functionality profile.

* In the [[Metis_Smart_Modeling_-_Setup|Setup]] menu when selecting the User Interface language for the application.

* In various part of Metis Smart Quotes as when creating a contact.

{{Note
| The designations in the other languages are used in the case where a designation is missing for the language in which the user is currently working with (see the [[#Priority| Priority]] section below).
}}

=== Adding a New Language ===

Before adding or creating a language, the administrator has to make sure that the maximum number of languages per version is not reached. A click on the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] displays the following window:

[[File:MetisSmartModelingAddLangageSelection.PNG|center|300x350px]]

The administrator can either add an existing language or create a new language.

==== Adding an Existing Language ====

If the administrator chooses to add an existing language, the following window appears after selecting the "Add available language" option:

[[File:MetisSmartModelingLanguageAddExistingLanguage.PNG|center|600x400px]]

The contents of this window is non editable.

The window contains the list of all the available languages. These languages can come from one of the following sources:
* an ascendant version
* the current version
* a descendant version

The first three columns of the window (Flag, Code and Designation) show the country flag, the language code and the language designation. The last column (Version) indicates the version in which the language has been created.

To add a language to the current version, select a language then click on the OK icon. The Languages menu is displayed again with the added language(s). In the language selection menu, it is possible to select several languages at the same time. If the administrator tries to select too many languages and exceeds the 4 authorized languages per version, a pop up window appears. If the user tries to select a language that has already been made available for the current version, a pop up window appears.

==== Creating a New Language ====

If the administrator chooses to create a new language, the following window appears after selecting the "Create a new language" option:

[[File:MetisSmartModelingLanguageAddNewLanguage.PNG|center|600x400px]]

The properties of the language must be provided, that is to say:
* a picture representing the country flag
* a language code (preferably the ISO code)
* a designation
* a translation for each language that has already been made available by the administrator

The language code field is mandatory in order to save the language. This field is limited to four characters and cannot be changed afterwards.

{{Note
| It is highly recommended to use the [http://www.iso.org/iso/english_country_names_and_code_elements official ISO country code].
}}

To define a picture representing the country flag for the language, click on the frame located on the top right side. A window opens as shown in the following example:

[[File:MetisSmartModelingLanguageAddFlagIcon.PNG|center|300x350px]]

The window contains the pictures that have been previously uploaded in the '''[[Description_of_the_Sub-Menu_Cliparts | Cliparts]]''' menu.

The language designation is limited to 30 characters and is mandatory.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/0/0b/VID_Creating_a_language.png'>File:Creating_a_language_OK.mp4‎</mediaplayer>
| Creating a language.
}}

For each language that has already been made available by the administrator, a designation should be provided. This designation should be the name of the created language translated into the other language (e.g. "Russian" in English, "Russe" in French, "Russisch" in German etc.).

=== Editing a Language ===

In the '''Languages''' 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 Language. Selecting a Language and clicking on it opens the '''Languages''' edition window where all related properties and information can be edited.

[[File:MetisSmartModelingLanguageEdit.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the country flag
* an ISO language code
* designation
* the designation of the language (for each language that has been made available by the administrator)

If the administrator is not the owner of the language (i.e. the language has been created in another version), it is only possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator). The language code and the picture cannot be edited.

If the administrator is the owner of the language, it is possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator) and the picture representing the country flag. The language code cannot be edited.

=== Preview ===

In the '''Languages''' 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 Language. Selecting a language from the table and clicking on it opens the '''Languages''' preview window.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Language.

[[File:MetisSmartModelingLanguagePreview.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the flag
* an ISO language code
* a designation
* the designation of the language (for each language that has been made available by the administrator)

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

=== Priority ===

The order in which the languages are displayed correspond to the language priority order. This order is considered when a description is missing for an item. When a description is missing, Metis looks for the item description in the other available languages and displays this description. This means that if the description of an item is missing in the first language, Metis displays the description in the second language if it exists. If not, the description in the third language is displayed and so on.

The priority can be modified by clicking on the ''Priority'' button. The following window appears:

[[File:MetisSmartModelingLanguagePriority.PNG|center|300x350px]]

The table is populated with the languages that have been defined for the current version. The contents of the table cannot be edited. The priority order of the language can be defined using the up and down arrows on the right of the table. The language at the top of the table has the highest priority. The language at the bottom of the table has the lowest priority.

=== Deleting a Language ===

In the '''Languages''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Language. Selecting a Language and clicking on it displays the following confirmation window, if the version has been manually created (i.e. no lock) or is owned by the current version, a confirmation window appears.

Once the warning is confirmed, the selected Language is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| If all the languages are deleted, Metis proposes by default English as the language of the version.
}}

{{Note
| If the language is owned by another version (i.e. presence of a lock), the language cannot be deleted.

[[File:MSM_Versions_Languages_Languages_Delete.png|center]]

}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/e/eb/VID_managing_the_languages_of_a_version.png'>File:Managing_languages_OK.mp4‎</mediaplayer>
| Managing languages of a version.
}}

== Update ==

The Metis Smart Suite update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.

=== Update process Overview ===

In order for this process to efficiently distribute all that information, the functionality works based on the diagram below.

[[File:IMG_Update_Process.png|center|600x400px]]

All update related settings, information and files are bundled together within Metis Smart Suite and sent to a web-service hosted on a web-server. The local instances of Metis Smart Quotes then inquires this service for available updates and notifies the user. If validated, the update takes places and the application will be restarted.

=== Preparing Metis Smart Quotes Updates ===

The update sub-menu is used to prepare updates for offline versions of the Metis Smart Quotes. By default an update which will be created here will include the various databases required by the applications. The update preparation tool in Metis Smart Modeling can be used to fine tune this update. The first type of additional information which can be included in an update are files. The concept is that throughout the settings, external files could be required by Metis Smart Quotes in order to provide to the end-user different information. For example, in the [[Description_of_the_Sub-Menu_Notes|Notes]] menu of the software, the various note types allow the user to import default texts in the note. Those default texts need to be distributed and linked to the application. In the definition of the note setting the administrator sets up a link to a folder where those templates will be stored. When creating the update the idea is to list those templates and define where they will be placed within the local instance of the application. Therefore, the link defined within the profile will also be set in the "destination folder" column of the update preparation.

[[File:MSM_Versions_Uptdate.png|center|600x400px]]

In the update sub-menu the main working area is dedicated to a table with the following columns:

*'''Source File Name''': The name of the original file found under either the "Common Files" or "Specific Files" folder depending on the choice made.
*'''Dest. Folder''': An editable field where the user can enter the destination folder for the file after being updated.
*'''Dest. Filename''': An editable field where the user can enter a new name for the file after being distributed.
*'''File Date''': The date the original file was created.
*'''Behavior''': Describes what will happen once the update has been executed. A drop-down menu with three different options is found in this column.
**Overwite if more recent: The file will be replaced with a more recent version if one is available.
**Ignore if already existing: The file will remain untouched if it is found to already exist.
**Force overwrite: The file will be replaced no matter what the case.

Updates must be prepared in online mode. The purpose of the update process is that when updating a version, the update will automatically be available to the offline users of the version as well as the offline users of the child versions.

Updates may be available for online and offline versions of MSQ. Only the information owned by a version may be used for updates. Data which is owned by a version means data which has been created by the administrator of that version.

For example, on the diagram, the HQ version is the parent of the versions ENG, FRA, GER, JPN, and USA. USA is the parent of the versions NY and WA. This means that NY and WA are the grandchildren of the HQ version.

If an administrator of the HQ version prepares an update, the offline users of the HQ, ENG, FRA, GER, JPN, USA, NY and WA versions also receive the update.

If an administrator of the USA version prepares an update, the versions HQ, ENG, FRA, GER and JPN do not receive the update. Only the USA version and the child versions of USA receive it.

[[File:IMG_Version_Concept.png|center|600x400px]]

====Add Files====

Clicking on the "Add Files" button [[File:MetisSmartModelingCurrentlyAddFilesButton.PNG|link=]] opens a window that asks the user which type of files they wish to add, either '''Common Files''' or '''Specific Files'''. Common files are files which will be distributed to the selected version and its child versions after the update process. Specific files are files which will only be distributed to the selected version when preparing an update. The child versions will not receive the file after the update process.

[[File:MSM_Versions_Update_Add_Files.png|center]]

After selecting a file type and confirming, a MS Windows Explorer window opens where the user may add one or more files at the same time and then clicking on open to complete the process. The files are then added to the main table of the update sub-menu. Depending on the file type chosen, the files will appear under the appropriate folder.

====Delete Files====

In the '''Update''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Files. Selecting one or more files and clicking on it displays the following confirmation window.

Once the warning is confirmed, the selected files are removed from the Metis Smart Suite Update.

====Prepare Update====

After the desired file or files have been added to the update, the user can then begin to generate the update with the "Prepare Update" button [[File:MetisSmartModelingPrepareUpdateButton.PNG|link=]] button.

When selecting a file and clicking on this button, the user is presented with a pop-up window asking if they are sure that they want to run the update process.

The '''Preparing Update...''' window opens after confirming the pop-up. In this window the user is presented with a table with three columns including the '''Date''', '''Message''', and '''Status'''.

The '''Date''' columns list the date and time of the message given in the table, the '''Message''' column provides information to the user in the form of short messages indicating the current status of the update process, and the '''Status''' column is filled with either a green check-mark indicating successful step in the update process or a red x indicating an error in the update process. In the case of an error, a short notice will be displayed in the message column describing the error.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/5/5e/VID_preparing_update.png'>File:PreparingAnUpdateForOfflineInstallations_OK.mp4‎</mediaplayer>
| Preparing an update for offline installations.
}}

{{Warning
| In order for the update preparation and distribution to go through normally, it is required to define the update settings in the functionality profiles in the version in which the administrator works; and in the versions which are targeted by the update.

For the Metis Smart Quotes instances targeted by the update to receive the update it is of course necessary that the profiles define the correct update settings.
}}

== Licensing ==

(TBD)

Description of the Menu Versions

2014-01-22T14:52:30Z

PatrickG: /* Add */

As Metis Smart Suite can be rolled out in small to large organizations the software supports a versioning concepts. These feature allows it to be structured in a tree like schema. As the root of this tree there will always be the main delivered version of the application.

The branches from that tree will represent created version within the organization. As described in the figure below the headquarters of an organization is placed at the root of the tree, and all the country specific subsidiaries, for example, are shown as first child version (i.e. first level nodes). The leafs of the tree from a specific branch are for example partners within that country.

Within Metis Smart Suite a version is mainly described by its name and basic information, conditions, customer designation and directories which have to be used by it. Additionally '''[[Description of the Menu Profiles | Profiles]]''' of all types can be linked to a version in order to enforce default rights and privileges to all users which will be created in that version.

Versions are a key element of the Metis Smart Suite. This functionality allows the administrator to re-create the sales or legal structure of the company in which the software suite is being deployed. Additional examples of how this structure can support any organization can be found within the various screenshots of that section.

== Versions ==

Both Metis Smart Modeling users and administrators can create as many versions as required. As a reminder, versions that descend from a main version are classified as child versions. The main versions which create these child versions are classified as parent versions. This means that any single version may be a parent or child version, depending on the point of view.

[[File:IMG_Version_Concept.png|center|600x400px]]

=== Overview of versions ===

Users may add, delete, edit, and preview versions in this sub-menu. A search feature can be found on the left side and a main table containing general information is found in the working area.

In this table, the parent version (the currently logged-in version) is featured at the top with all its child versions listed below.
Versions in the main table may be represented by several different types of icons.

{| 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 Version
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Icon
! 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" |
'''Normal Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Standard Metis Smart Suite Version.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Version without Admin'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionNoAdminIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
There are no Users defined as administrator for this version. It depends entirely on the parent version's Administrator.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Inactive Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
[[File:MetisSmartModelingVersionInactiveIcon.png‎|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Version exists in the Metis Smart Suite Database, but has been disabled.
|-
|}

A lock icon may be found preceding any of these types of versions. The lock icon signifies that the version was not created in the version currently logged-in, but in another version or by an automated system.

[[File:MSM_Versions_Versions.png|center|600x400px]]

{{Note
| Imported versions which are denied access to certain items through profile groups, can never have access to these items even if they are given access through the use of additional profiles.

[take a screenshot of for example a system profile[title it "main profile"] with several check-boxes unticked and one["additional profile"] with the same check-boxes ticked, and then screenshot of additional profiles for profile groups for the user]
}}

{| 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 0 1px 0" | Description
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Version Specific Objects'''
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Available only in the version where created and in the child versions if access was granted.
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
*Employees
*Offices
*Positions
*Attributes
*Hierarchies
*Segments
*Price Groups
*Price Categories
*Documents
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Objects implicitly linked'''
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Allowed modifications which are done to part of an object (i.e. description) are then valid also for all child versions,
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
*Translations (descriptions all positions, attributes, hierarchies, prices, systems and languages)
*Data Management type objects
|-
|}

=== Managing versions ===

====Search====

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Versions based on various criterions. 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 disaplyed below/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

====Add====

In the '''Versions''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Version. When it is clicked, the '''Version''' creation window opens, it contains two different type of information. The first tab '''Version''' shows a table separated into several expandable sections with two columns, '''Designation''' which represents the type of field and '''Value''' which represents the data entered into that field. All those fields provides the detailed description of a version. Only the ones with the edit icon on the right-hand side of the table can be defined by the user. The other ones are either inheritance from the parent version or imported through a third-party system.

[[File:MSM_Versions_Versions_add_Versions.png|center|600x400px]]

{{Note
| Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field.
}}

When creating a new version, the fields in the versions tab can be edited in order to define the version.

'''''Main'''''

* Version: Name of the version.
* Administrator Free: Choose to make a version administrator free. By setting the version to be administration free, the fields under the Customer section become available.
* Nomad Gateway User: A nomad gateway user can be defined in this field.
* Use Parent documents: Choose to use parent documents for the current version.
* Second ID to display : Secondary ID for he version.
* Default currency : set the default currency to used for all offers created within this version.
* Role for client condition : Role which specifies which Address is taken to apply '''[[Description_of_the_Menu_Prices#Customer_Prices|Customer Prices]]'''.

'''''Login'''''

* Default Password: Default password for any new user or when resetting a user's password.
* Mandatory Password Change: Selection for password change requirement.
* At least 1 Upper Case Letter: Any password provided by the user should at least hold 1 upper case letter.
* At least 1 Lower Case Letter: Any password provided by the user should at least hold 1 lower case letter.
* At least 1 Mandatory Number: Any password provided by the user should at least hold 1 number.
* At least 1 Mandatory Special Character: Any password provided by the user should at least hold 1 special character.
* Minimum Length: Any password provided by the user should have a minimum length of the defined number of characters.
* Warning Period [days]: Number of days before the end of the validity of a password when a warning message will be displayed to the user to change his password.
* Validity Period [days]: Validity period for a given password.

'''''Conditions'''''

* GSP Discount: The global sales price discount. Entering a figure here for example 50.0, means that a discount of 50% will be factored into the global sales price for this version. The GSP Discount can only be defined for a version by the parent version.

'''''Customer'''''

* OrgID: Organization ID
* Name 1: Name of the customer contact.
* Name 2: Additional name field for a contact.
* Name 3: Additional name field for a contact.
* Address 1: Address of where the customer is located (i.e. street name)
* Address 2: Additional address field for the customer (i.e. building name).
* City Name: City of where the customer is located. A drop-down list of available cities can provided for selection (see Data Management)
* ZipCode: Zipcode for where the customer is located.
* Country: Country where the customer is located. A drop-down list of available countries can provided for selection (see Data Management).
* State: State in the country where the customer is located. A drop-down list of states can be provided for selection (see Data Management).

'''''Directories'''''

Directories may only be specified within the version currently logged-in to. Parent versions cannot choose the directory for child versions. When a directory has been specified, the folder path will be shown in the corresponding field.

* Exchange: link to a folder used for saving FQS files.
* Document: link to a folder used for saving documents that are related to offers.
* Order: link to a folder used for saving XML and SES files.
* Libraries: link to a folder used for software libraries.

'''Profiles'''

'''[[Description of the Menu Profiles | Profiles]]''' are set to a version by the parent of that version in the section '''From Creator'''. Versions that have been automatically created by importation have their profiles also automatically set and cannot have their profiles edited.

However, additional profiles can be given to these versions in the section '''From parent'''. The '''Form parent''' section is only visible for these automatically created versions. To the right of the edit icon column is another column that has an eye for an icon.

Clicking on this eye lets the user see what items are defined by the current profile. Meaning that if the system profile "Default systems" was selected, doing so will display which systems are available in this profile.

[[File:MSM_Versions_Versions_add_profiles.png|center|600x400px]]

{{Note
| Differentiation must be made between the two different classes of Profiles: the ones defining privileges for content and for functionnalities. In the case of a Version, both classes can be set. For content related profiles, the content available in a child version is the 'union' of the profiles provided by the version creator and the parent version. When creating manually a version, it only can only hold preset profiles defined as 'From Creator', there are no additional profiles coming from a distant parent. Those profiles are automatically based on the content available and defined in the version from which it is created. As for the Functionality Profiles, they will be used in the child Version as a basis for future grandchild version or duplicated Profiles.
}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/d/d2/VID_AdditionalProfilesConcept.PNG'>File:Additional_Profiles_OK.mp4‎</mediaplayer>
| Managing additional Profiles in versions.
}}

'''''From Creator'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

'''''From Parent'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

====Edit====

In the '''Versions''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version. Selecting a version and clicking on it opens the '''Version''' edition window where all related properties and information can be edited.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Version. Modifications applied to the selected version will only be saved once the version edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

[[File:MSM_Versions_Versions_Edit_Version.png|center|600x400px]]

====Delete====

In the '''Version''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Version. Selecting a version and clicking on it displays the following confirmation window.

[[File:MSM_Versions_Versions_delete_2.png|center]]

Once the warning is confirmed, the selected version is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| It is not possible to delete a version unless logged-in to the version that created it.

[[File:MSM_Versions_Versions_delete.png|center]]

}}

====Preview====

In the '''Versions''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected version. Selecting a version from the list and clicking on it opens the '''Version''' preview window.

[[File:MSM_Versions_Versions_Preview_profile.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 ... .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In the rightmost column of the table displayed in the '''Version''' preview window, the icon representing an eye can be used to display the list Systems, Hierarchies, Price Categories, Attributes, Variants, Service Models and Tax Models which have been set for the various profiles. No edition is possible.

==== Version without Administrator ====

As stated in the name, version without administrator is a Metis Smart Suite Version which doesn't include an administrator. This type of version is mainly used when no direct maintenance is required on the version level or when it is simply not wished to let the version be maintained individually.

A version without administrator is always created and maintained by its parent version.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/f/fe/VID_VersionNoAdmin.png'>File:Setting_a_version_without_an_administrator_OK.mp4‎</mediaplayer>
| Setting up a version without an administrator.
}}

== Access ==

From this sub-menu, the administrator can define and manage the access between the various children versions, as shown in the following example:

[[File:MSM_Versions_Access.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find versions based on various criterion. The search is triggered by typing a keyword or only a letter in the field 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 list.

=== Editing a Version's Rights ===

In the '''Version Rights''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version Right. Selecting a version right and clicking on it opens the '''Version Rights''' edition window where all related properties and information can be edited.

[[File:MSM_Versions_Access_Edit.png|center|600x400px]]

{{Note
| The title on the window displays the name of selected version (e.g. Version Rights Headquarters where Headquarters is the name of the selected version).
}}

The Versions (Smart Quotes) table displays all the available versions. The displayed versions consist of all of the children versions of the administrator's version. The authorized column allows the administrator to select / deselect the versions that the Smart Quotes users is authorized to access to. The following example describes the cases where a version can have access to the projects and offers made in other versions:

[[File:MetisSmartModelingVersionsProfileDiagram.PNG]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/a/a3/VID_Manage_the_version_access.png'>File:Managing_the_access_of_versions_OK.mp4‎</mediaplayer>
| Managing version access.
}}

An administrator of Version A can define that the Version A users can have access to the direct children versions' projects and offers (i.e. Version B, Version C and Version D). However, Version A users cannot access Version E's projects and offers because Version E is not a direct child of Version A.

The administrator of Version A can also define that Version B users can have access to Version C's projects and offers but not to Version D's projects and offer. The same administrator could also define that Version C users can only have access to Version B's projects and offers.

The authorization is not bi-directional: if Version B users have access to Version C's projects and offers, Version C users do not automatically receive access to Version B's projects and offers. The administrator must set the authorizations for each version.

=== Previewing a Version's Rights ===

In the '''Version Access''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Version Rights. Selecting a Version Right from the table/list and clicking on it opens the '''Version Rights''' preview window.

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

For detailed descriptions of all information available in this window please refer to the section dedicated to the edition of a version right .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In this window, only the authorized versions are displayed. This means that if a version is not authorized to see the projects or the offers or at least one other version, the table is empty as shown in the following example:

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

== Languages ==

Metis Smart Suite supports the use of multiple languages for single roll-outs of the application. Different languages can then be used to translate the [[Metis_Smart_Modeling_-_Setup|User Interface]] and/or the objects created in Metis Smart Modeling, the documents generated by Metis Smart Quotes or the Notes provided by the End-Users In this menu, the administrator defines the languages that the Metis Smart Modeling and Metis Smart Quote users are authorized to use.

{{Warning
| The administrator can define a maximum of four languages per version.
}}

Languages defined in this menu are then made available in the following parts of Metis:

* when a designation is required for an item (e.g. a language, a [[Description_of_the_Menu_Positions|position]], an [[Metis_Smart_Modeling_-_Attributes|attribute]] etc.), the designation may be entered for all the languages that have been made available.

* In the [[Description_of_the_Menu_Users|Users]] menu when defining a user's main language

* In the [[Description of the Sub-Menu Functionalities#Languages tab | Profiles]] menu when setting a default language for a functionality profile.

* In the [[Metis_Smart_Modeling_-_Setup|Setup]] menu when selecting the User Interface language for the application.

* In various part of Metis Smart Quotes as when creating a contact.

{{Note
| The designations in the other languages are used in the case where a designation is missing for the language in which the user is currently working with (see the [[#Priority| Priority]] section below).
}}

=== Adding a New Language ===

Before adding or creating a language, the administrator has to make sure that the maximum number of languages per version is not reached. A click on the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] displays the following window:

[[File:MetisSmartModelingAddLangageSelection.PNG|center|300x350px]]

The administrator can either add an existing language or create a new language.

==== Adding an Existing Language ====

If the administrator chooses to add an existing language, the following window appears after selecting the "Add available language" option:

[[File:MetisSmartModelingLanguageAddExistingLanguage.PNG|center|600x400px]]

The contents of this window is non editable.

The window contains the list of all the available languages. These languages can come from one of the following sources:
* an ascendant version
* the current version
* a descendant version

The first three columns of the window (Flag, Code and Designation) show the country flag, the language code and the language designation. The last column (Version) indicates the version in which the language has been created.

To add a language to the current version, select a language then click on the OK icon. The Languages menu is displayed again with the added language(s). In the language selection menu, it is possible to select several languages at the same time. If the administrator tries to select too many languages and exceeds the 4 authorized languages per version, a pop up window appears. If the user tries to select a language that has already been made available for the current version, a pop up window appears.

==== Creating a New Language ====

If the administrator chooses to create a new language, the following window appears after selecting the "Create a new language" option:

[[File:MetisSmartModelingLanguageAddNewLanguage.PNG|center|600x400px]]

The properties of the language must be provided, that is to say:
* a picture representing the country flag
* a language code (preferably the ISO code)
* a designation
* a translation for each language that has already been made available by the administrator

The language code field is mandatory in order to save the language. This field is limited to four characters and cannot be changed afterwards.

{{Note
| It is highly recommended to use the [http://www.iso.org/iso/english_country_names_and_code_elements official ISO country code].
}}

To define a picture representing the country flag for the language, click on the frame located on the top right side. A window opens as shown in the following example:

[[File:MetisSmartModelingLanguageAddFlagIcon.PNG|center|300x350px]]

The window contains the pictures that have been previously uploaded in the '''[[Description_of_the_Sub-Menu_Cliparts | Cliparts]]''' menu.

The language designation is limited to 30 characters and is mandatory.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/0/0b/VID_Creating_a_language.png'>File:Creating_a_language_OK.mp4‎</mediaplayer>
| Creating a language.
}}

For each language that has already been made available by the administrator, a designation should be provided. This designation should be the name of the created language translated into the other language (e.g. "Russian" in English, "Russe" in French, "Russisch" in German etc.).

=== Editing a Language ===

In the '''Languages''' 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 Language. Selecting a Language and clicking on it opens the '''Languages''' edition window where all related properties and information can be edited.

[[File:MetisSmartModelingLanguageEdit.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the country flag
* an ISO language code
* designation
* the designation of the language (for each language that has been made available by the administrator)

If the administrator is not the owner of the language (i.e. the language has been created in another version), it is only possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator). The language code and the picture cannot be edited.

If the administrator is the owner of the language, it is possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator) and the picture representing the country flag. The language code cannot be edited.

=== Preview ===

In the '''Languages''' 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 Language. Selecting a language from the table and clicking on it opens the '''Languages''' preview window.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Language.

[[File:MetisSmartModelingLanguagePreview.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the flag
* an ISO language code
* a designation
* the designation of the language (for each language that has been made available by the administrator)

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

=== Priority ===

The order in which the languages are displayed correspond to the language priority order. This order is considered when a description is missing for an item. When a description is missing, Metis looks for the item description in the other available languages and displays this description. This means that if the description of an item is missing in the first language, Metis displays the description in the second language if it exists. If not, the description in the third language is displayed and so on.

The priority can be modified by clicking on the ''Priority'' button. The following window appears:

[[File:MetisSmartModelingLanguagePriority.PNG|center|300x350px]]

The table is populated with the languages that have been defined for the current version. The contents of the table cannot be edited. The priority order of the language can be defined using the up and down arrows on the right of the table. The language at the top of the table has the highest priority. The language at the bottom of the table has the lowest priority.

=== Deleting a Language ===

In the '''Languages''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Language. Selecting a Language and clicking on it displays the following confirmation window, if the version has been manually created (i.e. no lock) or is owned by the current version, a confirmation window appears.

Once the warning is confirmed, the selected Language is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| If all the languages are deleted, Metis proposes by default English as the language of the version.
}}

{{Note
| If the language is owned by another version (i.e. presence of a lock), the language cannot be deleted.

[[File:MSM_Versions_Languages_Languages_Delete.png|center]]

}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/e/eb/VID_managing_the_languages_of_a_version.png'>File:Managing_languages_OK.mp4‎</mediaplayer>
| Managing languages of a version.
}}

== Update ==

The Metis Smart Suite update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.

=== Update process Overview ===

In order for this process to efficiently distribute all that information, the functionality works based on the diagram below.

[[File:IMG_Update_Process.png|center|600x400px]]

All update related settings, information and files are bundled together within Metis Smart Suite and sent to a web-service hosted on a web-server. The local instances of Metis Smart Quotes then inquires this service for available updates and notifies the user. If validated, the update takes places and the application will be restarted.

=== Preparing Metis Smart Quotes Updates ===

The update sub-menu is used to prepare updates for offline versions of the Metis Smart Quotes. By default an update which will be created here will include the various databases required by the applications. The update preparation tool in Metis Smart Modeling can be used to fine tune this update. The first type of additional information which can be included in an update are files. The concept is that throughout the settings, external files could be required by Metis Smart Quotes in order to provide to the end-user different information. For example, in the [[Description_of_the_Sub-Menu_Notes|Notes]] menu of the software, the various note types allow the user to import default texts in the note. Those default texts need to be distributed and linked to the application. In the definition of the note setting the administrator sets up a link to a folder where those templates will be stored. When creating the update the idea is to list those templates and define where they will be placed within the local instance of the application. Therefore, the link defined within the profile will also be set in the "destination folder" column of the update preparation.

[[File:MSM_Versions_Uptdate.png|center|600x400px]]

In the update sub-menu the main working area is dedicated to a table with the following columns:

*'''Source File Name''': The name of the original file found under either the "Common Files" or "Specific Files" folder depending on the choice made.
*'''Dest. Folder''': An editable field where the user can enter the destination folder for the file after being updated.
*'''Dest. Filename''': An editable field where the user can enter a new name for the file after being distributed.
*'''File Date''': The date the original file was created.
*'''Behavior''': Describes what will happen once the update has been executed. A drop-down menu with three different options is found in this column.
**Overwite if more recent: The file will be replaced with a more recent version if one is available.
**Ignore if already existing: The file will remain untouched if it is found to already exist.
**Force overwrite: The file will be replaced no matter what the case.

Updates must be prepared in online mode. The purpose of the update process is that when updating a version, the update will automatically be available to the offline users of the version as well as the offline users of the child versions.

Updates may be available for online and offline versions of MSQ. Only the information owned by a version may be used for updates. Data which is owned by a version means data which has been created by the administrator of that version.

For example, on the diagram, the HQ version is the parent of the versions ENG, FRA, GER, JPN, and USA. USA is the parent of the versions NY and WA. This means that NY and WA are the grandchildren of the HQ version.

If an administrator of the HQ version prepares an update, the offline users of the HQ, ENG, FRA, GER, JPN, USA, NY and WA versions also receive the update.

If an administrator of the USA version prepares an update, the versions HQ, ENG, FRA, GER and JPN do not receive the update. Only the USA version and the child versions of USA receive it.

[[File:IMG_Version_Concept.png|center|600x400px]]

====Add Files====

Clicking on the "Add Files" button [[File:MetisSmartModelingCurrentlyAddFilesButton.PNG|link=]] opens a window that asks the user which type of files they wish to add, either '''Common Files''' or '''Specific Files'''. Common files are files which will be distributed to the selected version and its child versions after the update process. Specific files are files which will only be distributed to the selected version when preparing an update. The child versions will not receive the file after the update process.

[[File:MSM_Versions_Update_Add_Files.png|center]]

After selecting a file type and confirming, a MS Windows Explorer window opens where the user may add one or more files at the same time and then clicking on open to complete the process. The files are then added to the main table of the update sub-menu. Depending on the file type chosen, the files will appear under the appropriate folder.

====Delete Files====

In the '''Update''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Files. Selecting one or more files and clicking on it displays the following confirmation window.

Once the warning is confirmed, the selected files are removed from the Metis Smart Suite Update.

====Prepare Update====

After the desired file or files have been added to the update, the user can then begin to generate the update with the "Prepare Update" button [[File:MetisSmartModelingPrepareUpdateButton.PNG|link=]] button.

When selecting a file and clicking on this button, the user is presented with a pop-up window asking if they are sure that they want to run the update process.

The '''Preparing Update...''' window opens after confirming the pop-up. In this window the user is presented with a table with three columns including the '''Date''', '''Message''', and '''Status'''.

The '''Date''' columns list the date and time of the message given in the table, the '''Message''' column provides information to the user in the form of short messages indicating the current status of the update process, and the '''Status''' column is filled with either a green check-mark indicating successful step in the update process or a red x indicating an error in the update process. In the case of an error, a short notice will be displayed in the message column describing the error.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/5/5e/VID_preparing_update.png'>File:PreparingAnUpdateForOfflineInstallations_OK.mp4‎</mediaplayer>
| Preparing an update for offline installations.
}}

{{Warning
| In order for the update preparation and distribution to go through normally, it is required to define the update settings in the functionality profiles in the version in which the administrator works; and in the versions which are targeted by the update.

For the Metis Smart Quotes instances targeted by the update to receive the update it is of course necessary that the profiles define the correct update settings.
}}

== Licensing ==

(TBD)

Description of the Menu Versions

2014-01-15T14:21:26Z

PatrickG: /* Add */

As Metis Smart Suite can be rolled out in small to large organizations the software supports a versioning concepts. These feature allows it to be structured in a tree like schema. As the root of this tree there will always be the main delivered version of the application.

The branches from that tree will represent created version within the organization. As described in the figure below the headquarters of an organization is placed at the root of the tree, and all the country specific subsidiaries, for example, are shown as first child version (i.e. first level nodes). The leafs of the tree from a specific branch are for example partners within that country.

Within Metis Smart Suite a version is mainly described by its name and basic information, conditions, customer designation and directories which have to be used by it. Additionally '''[[Description of the Menu Profiles | Profiles]]''' of all types can be linked to a version in order to enforce default rights and privileges to all users which will be created in that version.

Versions are a key element of the Metis Smart Suite. This functionality allows the administrator to re-create the sales or legal structure of the company in which the software suite is being deployed. Additional examples of how this structure can support any organization can be found within the various screenshots of that section.

== Versions ==

Both Metis Smart Modeling users and administrators can create as many versions as required. As a reminder, versions that descend from a main version are classified as child versions. The main versions which create these child versions are classified as parent versions. This means that any single version may be a parent or child version, depending on the point of view.

[[File:IMG_Version_Concept.png|center|600x400px]]

=== Overview of versions ===

Users may add, delete, edit, and preview versions in this sub-menu. A search feature can be found on the left side and a main table containing general information is found in the working area.

In this table, the parent version (the currently logged-in version) is featured at the top with all its child versions listed below.
Versions in the main table may be represented by several different types of icons.

{| 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 Version
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Icon
! 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" |
'''Normal Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Standard Metis Smart Suite Version.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Version without Admin'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionNoAdminIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
There are no Users defined as administrator for this version. It depends entirely on the parent version's Administrator.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Inactive Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
[[File:MetisSmartModelingVersionInactiveIcon.png‎|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Version exists in the Metis Smart Suite Database, but has been disabled.
|-
|}

A lock icon may be found preceding any of these types of versions. The lock icon signifies that the version was not created in the version currently logged-in, but in another version or by an automated system.

[[File:MSM_Versions_Versions.png|center|600x400px]]

{{Note
| Imported versions which are denied access to certain items through profile groups, can never have access to these items even if they are given access through the use of additional profiles.

[take a screenshot of for example a system profile[title it "main profile"] with several check-boxes unticked and one["additional profile"] with the same check-boxes ticked, and then screenshot of additional profiles for profile groups for the user]
}}

{| 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 0 1px 0" | Description
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Version Specific Objects'''
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Available only in the version where created and in the child versions if access was granted.
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
*Employees
*Offices
*Positions
*Attributes
*Hierarchies
*Segments
*Price Groups
*Price Categories
*Documents
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Objects implicitly linked'''
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Allowed modifications which are done to part of an object (i.e. description) are then valid also for all child versions,
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
*Translations (descriptions all positions, attributes, hierarchies, prices, systems and languages)
*Data Management type objects
|-
|}

=== Managing versions ===

====Search====

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Versions based on various criterions. 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 disaplyed below/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

====Add====

In the '''Versions''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Version. When it is clicked, the '''Version''' creation window opens, it contains two different type of information. The first tab '''Version''' shows a table separated into several expandable sections with two columns, '''Designation''' which represents the type of field and '''Value''' which represents the data entered into that field. All those fields provides the detailed description of a version. Only the ones with the edit icon on the right-hand side of the table can be defined by the user. The other ones are either inheritance from the parent version or imported through a third-party system.

[[File:MSM_Versions_Versions_add_Versions.png|center|600x400px]]

{{Note
| Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field.
}}

When creating a new version, the fields in the versions tab can be edited in order to define the version.

'''''Main'''''

* Version: Name of the version.
* Administrator Free: Choose to make a version administrator free. By setting the version to be administration free, the fields under the Customer section become available.
* Nomad Gateway User: A nomad gateway user can be defined in this field.
* Use Parent documents: Choose to use parent documents for the current version.
* Second ID to display : Secondary ID for he version.
* Default currency : set the default currency to used for all offers created within this version.
* Role for client condition : Role which specifies which Address is taken to apply '''[[Description_of_the_Menu_Prices#Customer_Prices|Customer Prices]]'''.

'''''Conditions'''''

* GSP Discount: The global sales price discount. Entering a figure here for example 50.0, means that a discount of 50% will be factored into the global sales price for this version. The GSP Discount can only be defined for a version by the parent version.

'''''Customer'''''

* OrgID: Organization ID
* Name 1: Name of the customer contact.
* Name 2: Additional name field for a contact.
* Name 3: Additional name field for a contact.
* Address 1: Address of where the customer is located (i.e. street name)
* Address 2: Additional address field for the customer (i.e. building name).
* City Name: City of where the customer is located. A drop-down list of available cities can provided for selection (see Data Management)
* ZipCode: Zipcode for where the customer is located.
* Country: Country where the customer is located. A drop-down list of available countries can provided for selection (see Data Management).
* State: State in the country where the customer is located. A drop-down list of states can be provided for selection (see Data Management).

'''''Directories'''''

Directories may only be specified within the version currently logged-in to. Parent versions cannot choose the directory for child versions. When a directory has been specified, the folder path will be shown in the corresponding field.

* Exchange: link to a folder used for saving FQS files.
* Document: link to a folder used for saving documents that are related to offers.
* Order: link to a folder used for saving XML and SES files.
* Libraries: link to a folder used for software libraries.

'''Profiles'''

'''[[Description of the Menu Profiles | Profiles]]''' are set to a version by the parent of that version in the section '''From Creator'''. Versions that have been automatically created by importation have their profiles also automatically set and cannot have their profiles edited.

However, additional profiles can be given to these versions in the section '''From parent'''. The '''Form parent''' section is only visible for these automatically created versions. To the right of the edit icon column is another column that has an eye for an icon.

Clicking on this eye lets the user see what items are defined by the current profile. Meaning that if the system profile "Default systems" was selected, doing so will display which systems are available in this profile.

[[File:MSM_Versions_Versions_add_profiles.png|center|600x400px]]

{{Note
| Differentiation must be made between the two different classes of Profiles: the ones defining privileges for content and for functionnalities. In the case of a Version, both classes can be set. For content related profiles, the content available in a child version is the 'union' of the profiles provided by the version creator and the parent version. When creating manually a version, it only can only hold preset profiles defined as 'From Creator', there are no additional profiles coming from a distant parent. Those profiles are automatically based on the content available and defined in the version from which it is created. As for the Functionality Profiles, they will be used in the child Version as a basis for future grandchild version or duplicated Profiles.
}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/d/d2/VID_AdditionalProfilesConcept.PNG'>File:Additional_Profiles_OK.mp4‎</mediaplayer>
| Managing additional Profiles in versions.
}}

'''''From Creator'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

'''''From Parent'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

====Edit====

In the '''Versions''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version. Selecting a version and clicking on it opens the '''Version''' edition window where all related properties and information can be edited.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Version. Modifications applied to the selected version will only be saved once the version edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

[[File:MSM_Versions_Versions_Edit_Version.png|center|600x400px]]

====Delete====

In the '''Version''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Version. Selecting a version and clicking on it displays the following confirmation window.

[[File:MSM_Versions_Versions_delete_2.png|center]]

Once the warning is confirmed, the selected version is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| It is not possible to delete a version unless logged-in to the version that created it.

[[File:MSM_Versions_Versions_delete.png|center]]

}}

====Preview====

In the '''Versions''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected version. Selecting a version from the list and clicking on it opens the '''Version''' preview window.

[[File:MSM_Versions_Versions_Preview_profile.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 ... .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In the rightmost column of the table displayed in the '''Version''' preview window, the icon representing an eye can be used to display the list Systems, Hierarchies, Price Categories, Attributes, Variants, Service Models and Tax Models which have been set for the various profiles. No edition is possible.

==== Version without Administrator ====

As stated in the name, version without administrator is a Metis Smart Suite Version which doesn't include an administrator. This type of version is mainly used when no direct maintenance is required on the version level or when it is simply not wished to let the version be maintained individually.

A version without administrator is always created and maintained by its parent version.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/f/fe/VID_VersionNoAdmin.png'>File:Setting_a_version_without_an_administrator_OK.mp4‎</mediaplayer>
| Setting up a version without an administrator.
}}

== Access ==

From this sub-menu, the administrator can define and manage the access between the various children versions, as shown in the following example:

[[File:MSM_Versions_Access.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find versions based on various criterion. The search is triggered by typing a keyword or only a letter in the field 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 list.

=== Editing a Version's Rights ===

In the '''Version Rights''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version Right. Selecting a version right and clicking on it opens the '''Version Rights''' edition window where all related properties and information can be edited.

[[File:MSM_Versions_Access_Edit.png|center|600x400px]]

{{Note
| The title on the window displays the name of selected version (e.g. Version Rights Headquarters where Headquarters is the name of the selected version).
}}

The Versions (Smart Quotes) table displays all the available versions. The displayed versions consist of all of the children versions of the administrator's version. The authorized column allows the administrator to select / deselect the versions that the Smart Quotes users is authorized to access to. The following example describes the cases where a version can have access to the projects and offers made in other versions:

[[File:MetisSmartModelingVersionsProfileDiagram.PNG]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/a/a3/VID_Manage_the_version_access.png'>File:Managing_the_access_of_versions_OK.mp4‎</mediaplayer>
| Managing version access.
}}

An administrator of Version A can define that the Version A users can have access to the direct children versions' projects and offers (i.e. Version B, Version C and Version D). However, Version A users cannot access Version E's projects and offers because Version E is not a direct child of Version A.

The administrator of Version A can also define that Version B users can have access to Version C's projects and offers but not to Version D's projects and offer. The same administrator could also define that Version C users can only have access to Version B's projects and offers.

The authorization is not bi-directional: if Version B users have access to Version C's projects and offers, Version C users do not automatically receive access to Version B's projects and offers. The administrator must set the authorizations for each version.

=== Previewing a Version's Rights ===

In the '''Version Access''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Version Rights. Selecting a Version Right from the table/list and clicking on it opens the '''Version Rights''' preview window.

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

For detailed descriptions of all information available in this window please refer to the section dedicated to the edition of a version right .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In this window, only the authorized versions are displayed. This means that if a version is not authorized to see the projects or the offers or at least one other version, the table is empty as shown in the following example:

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

== Languages ==

Metis Smart Suite supports the use of multiple languages for single roll-outs of the application. Different languages can then be used to translate the [[Metis_Smart_Modeling_-_Setup|User Interface]] and/or the objects created in Metis Smart Modeling, the documents generated by Metis Smart Quotes or the Notes provided by the End-Users In this menu, the administrator defines the languages that the Metis Smart Modeling and Metis Smart Quote users are authorized to use.

{{Warning
| The administrator can define a maximum of four languages per version.
}}

Languages defined in this menu are then made available in the following parts of Metis:

* when a designation is required for an item (e.g. a language, a [[Description_of_the_Menu_Positions|position]], an [[Metis_Smart_Modeling_-_Attributes|attribute]] etc.), the designation may be entered for all the languages that have been made available.

* In the [[Description_of_the_Menu_Users|Users]] menu when defining a user's main language

* In the [[Description of the Sub-Menu Functionalities#Languages tab | Profiles]] menu when setting a default language for a functionality profile.

* In the [[Metis_Smart_Modeling_-_Setup|Setup]] menu when selecting the User Interface language for the application.

* In various part of Metis Smart Quotes as when creating a contact.

{{Note
| The designations in the other languages are used in the case where a designation is missing for the language in which the user is currently working with (see the [[#Priority| Priority]] section below).
}}

=== Adding a New Language ===

Before adding or creating a language, the administrator has to make sure that the maximum number of languages per version is not reached. A click on the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] displays the following window:

[[File:MetisSmartModelingAddLangageSelection.PNG|center|300x350px]]

The administrator can either add an existing language or create a new language.

==== Adding an Existing Language ====

If the administrator chooses to add an existing language, the following window appears after selecting the "Add available language" option:

[[File:MetisSmartModelingLanguageAddExistingLanguage.PNG|center|600x400px]]

The contents of this window is non editable.

The window contains the list of all the available languages. These languages can come from one of the following sources:
* an ascendant version
* the current version
* a descendant version

The first three columns of the window (Flag, Code and Designation) show the country flag, the language code and the language designation. The last column (Version) indicates the version in which the language has been created.

To add a language to the current version, select a language then click on the OK icon. The Languages menu is displayed again with the added language(s). In the language selection menu, it is possible to select several languages at the same time. If the administrator tries to select too many languages and exceeds the 4 authorized languages per version, a pop up window appears. If the user tries to select a language that has already been made available for the current version, a pop up window appears.

==== Creating a New Language ====

If the administrator chooses to create a new language, the following window appears after selecting the "Create a new language" option:

[[File:MetisSmartModelingLanguageAddNewLanguage.PNG|center|600x400px]]

The properties of the language must be provided, that is to say:
* a picture representing the country flag
* a language code (preferably the ISO code)
* a designation
* a translation for each language that has already been made available by the administrator

The language code field is mandatory in order to save the language. This field is limited to four characters and cannot be changed afterwards.

{{Note
| It is highly recommended to use the [http://www.iso.org/iso/english_country_names_and_code_elements official ISO country code].
}}

To define a picture representing the country flag for the language, click on the frame located on the top right side. A window opens as shown in the following example:

[[File:MetisSmartModelingLanguageAddFlagIcon.PNG|center|300x350px]]

The window contains the pictures that have been previously uploaded in the '''[[Description_of_the_Sub-Menu_Cliparts | Cliparts]]''' menu.

The language designation is limited to 30 characters and is mandatory.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/0/0b/VID_Creating_a_language.png'>File:Creating_a_language_OK.mp4‎</mediaplayer>
| Creating a language.
}}

For each language that has already been made available by the administrator, a designation should be provided. This designation should be the name of the created language translated into the other language (e.g. "Russian" in English, "Russe" in French, "Russisch" in German etc.).

=== Editing a Language ===

In the '''Languages''' 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 Language. Selecting a Language and clicking on it opens the '''Languages''' edition window where all related properties and information can be edited.

[[File:MetisSmartModelingLanguageEdit.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the country flag
* an ISO language code
* designation
* the designation of the language (for each language that has been made available by the administrator)

If the administrator is not the owner of the language (i.e. the language has been created in another version), it is only possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator). The language code and the picture cannot be edited.

If the administrator is the owner of the language, it is possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator) and the picture representing the country flag. The language code cannot be edited.

=== Preview ===

In the '''Languages''' 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 Language. Selecting a language from the table and clicking on it opens the '''Languages''' preview window.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Language.

[[File:MetisSmartModelingLanguagePreview.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the flag
* an ISO language code
* a designation
* the designation of the language (for each language that has been made available by the administrator)

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

=== Priority ===

The order in which the languages are displayed correspond to the language priority order. This order is considered when a description is missing for an item. When a description is missing, Metis looks for the item description in the other available languages and displays this description. This means that if the description of an item is missing in the first language, Metis displays the description in the second language if it exists. If not, the description in the third language is displayed and so on.

The priority can be modified by clicking on the ''Priority'' button. The following window appears:

[[File:MetisSmartModelingLanguagePriority.PNG|center|300x350px]]

The table is populated with the languages that have been defined for the current version. The contents of the table cannot be edited. The priority order of the language can be defined using the up and down arrows on the right of the table. The language at the top of the table has the highest priority. The language at the bottom of the table has the lowest priority.

=== Deleting a Language ===

In the '''Languages''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Language. Selecting a Language and clicking on it displays the following confirmation window, if the version has been manually created (i.e. no lock) or is owned by the current version, a confirmation window appears.

Once the warning is confirmed, the selected Language is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| If all the languages are deleted, Metis proposes by default English as the language of the version.
}}

{{Note
| If the language is owned by another version (i.e. presence of a lock), the language cannot be deleted.

[[File:MSM_Versions_Languages_Languages_Delete.png|center]]

}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/e/eb/VID_managing_the_languages_of_a_version.png'>File:Managing_languages_OK.mp4‎</mediaplayer>
| Managing languages of a version.
}}

== Update ==

The Metis Smart Suite update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.

=== Update process Overview ===

In order for this process to efficiently distribute all that information, the functionality works based on the diagram below.

[[File:IMG_Update_Process.png|center|600x400px]]

All update related settings, information and files are bundled together within Metis Smart Suite and sent to a web-service hosted on a web-server. The local instances of Metis Smart Quotes then inquires this service for available updates and notifies the user. If validated, the update takes places and the application will be restarted.

=== Preparing Metis Smart Quotes Updates ===

The update sub-menu is used to prepare updates for offline versions of the Metis Smart Quotes. By default an update which will be created here will include the various databases required by the applications. The update preparation tool in Metis Smart Modeling can be used to fine tune this update. The first type of additional information which can be included in an update are files. The concept is that throughout the settings, external files could be required by Metis Smart Quotes in order to provide to the end-user different information. For example, in the [[Description_of_the_Sub-Menu_Notes|Notes]] menu of the software, the various note types allow the user to import default texts in the note. Those default texts need to be distributed and linked to the application. In the definition of the note setting the administrator sets up a link to a folder where those templates will be stored. When creating the update the idea is to list those templates and define where they will be placed within the local instance of the application. Therefore, the link defined within the profile will also be set in the "destination folder" column of the update preparation.

[[File:MSM_Versions_Uptdate.png|center|600x400px]]

In the update sub-menu the main working area is dedicated to a table with the following columns:

*'''Source File Name''': The name of the original file found under either the "Common Files" or "Specific Files" folder depending on the choice made.
*'''Dest. Folder''': An editable field where the user can enter the destination folder for the file after being updated.
*'''Dest. Filename''': An editable field where the user can enter a new name for the file after being distributed.
*'''File Date''': The date the original file was created.
*'''Behavior''': Describes what will happen once the update has been executed. A drop-down menu with three different options is found in this column.
**Overwite if more recent: The file will be replaced with a more recent version if one is available.
**Ignore if already existing: The file will remain untouched if it is found to already exist.
**Force overwrite: The file will be replaced no matter what the case.

Updates must be prepared in online mode. The purpose of the update process is that when updating a version, the update will automatically be available to the offline users of the version as well as the offline users of the child versions.

Updates may be available for online and offline versions of MSQ. Only the information owned by a version may be used for updates. Data which is owned by a version means data which has been created by the administrator of that version.

For example, on the diagram, the HQ version is the parent of the versions ENG, FRA, GER, JPN, and USA. USA is the parent of the versions NY and WA. This means that NY and WA are the grandchildren of the HQ version.

If an administrator of the HQ version prepares an update, the offline users of the HQ, ENG, FRA, GER, JPN, USA, NY and WA versions also receive the update.

If an administrator of the USA version prepares an update, the versions HQ, ENG, FRA, GER and JPN do not receive the update. Only the USA version and the child versions of USA receive it.

[[File:IMG_Version_Concept.png|center|600x400px]]

====Add Files====

Clicking on the "Add Files" button [[File:MetisSmartModelingCurrentlyAddFilesButton.PNG|link=]] opens a window that asks the user which type of files they wish to add, either '''Common Files''' or '''Specific Files'''. Common files are files which will be distributed to the selected version and its child versions after the update process. Specific files are files which will only be distributed to the selected version when preparing an update. The child versions will not receive the file after the update process.

[[File:MSM_Versions_Update_Add_Files.png|center]]

After selecting a file type and confirming, a MS Windows Explorer window opens where the user may add one or more files at the same time and then clicking on open to complete the process. The files are then added to the main table of the update sub-menu. Depending on the file type chosen, the files will appear under the appropriate folder.

====Delete Files====

In the '''Update''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Files. Selecting one or more files and clicking on it displays the following confirmation window.

Once the warning is confirmed, the selected files are removed from the Metis Smart Suite Update.

====Prepare Update====

After the desired file or files have been added to the update, the user can then begin to generate the update with the "Prepare Update" button [[File:MetisSmartModelingPrepareUpdateButton.PNG|link=]] button.

When selecting a file and clicking on this button, the user is presented with a pop-up window asking if they are sure that they want to run the update process.

The '''Preparing Update...''' window opens after confirming the pop-up. In this window the user is presented with a table with three columns including the '''Date''', '''Message''', and '''Status'''.

The '''Date''' columns list the date and time of the message given in the table, the '''Message''' column provides information to the user in the form of short messages indicating the current status of the update process, and the '''Status''' column is filled with either a green check-mark indicating successful step in the update process or a red x indicating an error in the update process. In the case of an error, a short notice will be displayed in the message column describing the error.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/5/5e/VID_preparing_update.png'>File:PreparingAnUpdateForOfflineInstallations_OK.mp4‎</mediaplayer>
| Preparing an update for offline installations.
}}

{{Warning
| In order for the update preparation and distribution to go through normally, it is required to define the update settings in the functionality profiles in the version in which the administrator works; and in the versions which are targeted by the update.

For the Metis Smart Quotes instances targeted by the update to receive the update it is of course necessary that the profiles define the correct update settings.
}}

== Licensing ==

(TBD)

Description of the Menu Versions

2014-01-15T14:20:53Z

PatrickG: /* Add */

As Metis Smart Suite can be rolled out in small to large organizations the software supports a versioning concepts. These feature allows it to be structured in a tree like schema. As the root of this tree there will always be the main delivered version of the application.

The branches from that tree will represent created version within the organization. As described in the figure below the headquarters of an organization is placed at the root of the tree, and all the country specific subsidiaries, for example, are shown as first child version (i.e. first level nodes). The leafs of the tree from a specific branch are for example partners within that country.

Within Metis Smart Suite a version is mainly described by its name and basic information, conditions, customer designation and directories which have to be used by it. Additionally '''[[Description of the Menu Profiles | Profiles]]''' of all types can be linked to a version in order to enforce default rights and privileges to all users which will be created in that version.

Versions are a key element of the Metis Smart Suite. This functionality allows the administrator to re-create the sales or legal structure of the company in which the software suite is being deployed. Additional examples of how this structure can support any organization can be found within the various screenshots of that section.

== Versions ==

Both Metis Smart Modeling users and administrators can create as many versions as required. As a reminder, versions that descend from a main version are classified as child versions. The main versions which create these child versions are classified as parent versions. This means that any single version may be a parent or child version, depending on the point of view.

[[File:IMG_Version_Concept.png|center|600x400px]]

=== Overview of versions ===

Users may add, delete, edit, and preview versions in this sub-menu. A search feature can be found on the left side and a main table containing general information is found in the working area.

In this table, the parent version (the currently logged-in version) is featured at the top with all its child versions listed below.
Versions in the main table may be represented by several different types of icons.

{| 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 Version
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Icon
! 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" |
'''Normal Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Standard Metis Smart Suite Version.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Version without Admin'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionNoAdminIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
There are no Users defined as administrator for this version. It depends entirely on the parent version's Administrator.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Inactive Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
[[File:MetisSmartModelingVersionInactiveIcon.png‎|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Version exists in the Metis Smart Suite Database, but has been disabled.
|-
|}

A lock icon may be found preceding any of these types of versions. The lock icon signifies that the version was not created in the version currently logged-in, but in another version or by an automated system.

[[File:MSM_Versions_Versions.png|center|600x400px]]

{{Note
| Imported versions which are denied access to certain items through profile groups, can never have access to these items even if they are given access through the use of additional profiles.

[take a screenshot of for example a system profile[title it "main profile"] with several check-boxes unticked and one["additional profile"] with the same check-boxes ticked, and then screenshot of additional profiles for profile groups for the user]
}}

{| 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 0 1px 0" | Description
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Version Specific Objects'''
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Available only in the version where created and in the child versions if access was granted.
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
*Employees
*Offices
*Positions
*Attributes
*Hierarchies
*Segments
*Price Groups
*Price Categories
*Documents
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Objects implicitly linked'''
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Allowed modifications which are done to part of an object (i.e. description) are then valid also for all child versions,
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
*Translations (descriptions all positions, attributes, hierarchies, prices, systems and languages)
*Data Management type objects
|-
|}

=== Managing versions ===

====Search====

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Versions based on various criterions. 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 disaplyed below/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

====Add====

In the '''Versions''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Version. When it is clicked, the '''Version''' creation window opens, it contains two different type of information. The first tab '''Version''' shows a table separated into several expandable sections with two columns, '''Designation''' which represents the type of field and '''Value''' which represents the data entered into that field. All those fields provides the detailed description of a version. Only the ones with the edit icon on the right-hand side of the table can be defined by the user. The other ones are either inheritance from the parent version or imported through a third-party system.

[[File:MSM_Versions_Versions_add_Versions.png|center|600x400px]]

{{Note
| Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field.
}}

When creating a new version, the fields in the versions tab can be edited in order to define the version.

'''''Main'''''

* Version: Name of the version.
* Administrator Free: Choose to make a version administrator free. By setting the version to be administration free, the fields under the Customer section become available.
* Nomad Gateway User: A nomad gateway user can be defined in this field.
* Use Parent documents: Choose to use parent documents for the current version.
* Second ID to display : Secondary ID for he version.
* Default currency : set the default currency to used for all offers created within this version.
* Role for client condition : Role which specifies which Address is taken to apply '''[[Description_of_the_Menu_Prices#Customer_Prices|Customer Prices]]'''.

'''''Conditions'''''

* GSP Discount: The global sales price discount. Entering a figure here for example 50.0, means that a discount of 50% will be factored into the global sales price for this version. The GSP Discount can only be defined for a version by the parent version.

'''''Customer'''''

* OrgID: Organization ID
* Name 1: Name of the customer contact.
* Name 2: Additional name field for a contact.
* Name 3: Additional name field for a contact.
* Address 1: Address of where the customer is located (i.e. street name)
* Address 2: Additional address field for the customer (i.e. building name).
* City Name: City of where the customer is located. A drop-down list of available cities can provided for selection (see Data Management)
* ZipCode: Zipcode for where the customer is located.
* Country: Country where the customer is located. A drop-down list of available countries can provided for selection (see Data Management).
* State: State in the country where the customer is located. A drop-down list of states can be provided for selection (see Data Management).

'''''Directories'''''

Directories may only be specified within the version currently logged-in to. Parent versions cannot choose the directory for child versions. When a directory has been specified, the folder path will be shown in the corresponding field.

* Exchange: link to a folder used for saving FQS files.
* Document: link to a folder used for saving documents that are related to offers.
* Order: link to a folder used for saving XML and SES files.
* Libraries: link to a folder used for software libraries.

'''Profiles'''

'''[[Description of the Menu Profiles | Profiles]]''' are set to a version by the parent of that version in the section '''From Creator'''. Versions that have been automatically created by importation have their profiles also automatically set and cannot have their profiles edited.

However, additional profiles can be given to these versions in the section '''From parent'''. The '''Form parent''' section is only visible for these automatically created versions. To the right of the edit icon column is another column that has an eye for an icon.

Clicking on this eye lets the user see what items are defined by the current profile. Meaning that if the system profile "Default systems" was selected, doing so will display which systems are available in this profile.

[[File:MSM_Versions_Versions_add_profiles.png|center|600x400px]]

{{Note
| Differentiation must be done between the two different classes of Profiles: the ones defining privileges for content and for functionnalities. In the case of a Version, both classes can be set. For content related profiles, the content available in a child version is the 'union' of the profiles provided by the version creator and the parent version. When creating manually a version, it only can only hold preset profiles defined as 'From Creator', there are no additional profiles coming from a distant parent. Those profiles are automatically based on the content available and defined in the version from which it is created. As for the Functionality Profiles, they will be used in the child Version as a basis for future grandchild version or duplicated Profiles.
}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/d/d2/VID_AdditionalProfilesConcept.PNG'>File:Additional_Profiles_OK.mp4‎</mediaplayer>
| Managing additional Profiles in versions.
}}

'''''From Creator'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

'''''From Parent'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

====Edit====

In the '''Versions''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version. Selecting a version and clicking on it opens the '''Version''' edition window where all related properties and information can be edited.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Version. Modifications applied to the selected version will only be saved once the version edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

[[File:MSM_Versions_Versions_Edit_Version.png|center|600x400px]]

====Delete====

In the '''Version''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Version. Selecting a version and clicking on it displays the following confirmation window.

[[File:MSM_Versions_Versions_delete_2.png|center]]

Once the warning is confirmed, the selected version is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| It is not possible to delete a version unless logged-in to the version that created it.

[[File:MSM_Versions_Versions_delete.png|center]]

}}

====Preview====

In the '''Versions''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected version. Selecting a version from the list and clicking on it opens the '''Version''' preview window.

[[File:MSM_Versions_Versions_Preview_profile.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 ... .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In the rightmost column of the table displayed in the '''Version''' preview window, the icon representing an eye can be used to display the list Systems, Hierarchies, Price Categories, Attributes, Variants, Service Models and Tax Models which have been set for the various profiles. No edition is possible.

==== Version without Administrator ====

As stated in the name, version without administrator is a Metis Smart Suite Version which doesn't include an administrator. This type of version is mainly used when no direct maintenance is required on the version level or when it is simply not wished to let the version be maintained individually.

A version without administrator is always created and maintained by its parent version.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/f/fe/VID_VersionNoAdmin.png'>File:Setting_a_version_without_an_administrator_OK.mp4‎</mediaplayer>
| Setting up a version without an administrator.
}}

== Access ==

From this sub-menu, the administrator can define and manage the access between the various children versions, as shown in the following example:

[[File:MSM_Versions_Access.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find versions based on various criterion. The search is triggered by typing a keyword or only a letter in the field 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 list.

=== Editing a Version's Rights ===

In the '''Version Rights''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version Right. Selecting a version right and clicking on it opens the '''Version Rights''' edition window where all related properties and information can be edited.

[[File:MSM_Versions_Access_Edit.png|center|600x400px]]

{{Note
| The title on the window displays the name of selected version (e.g. Version Rights Headquarters where Headquarters is the name of the selected version).
}}

The Versions (Smart Quotes) table displays all the available versions. The displayed versions consist of all of the children versions of the administrator's version. The authorized column allows the administrator to select / deselect the versions that the Smart Quotes users is authorized to access to. The following example describes the cases where a version can have access to the projects and offers made in other versions:

[[File:MetisSmartModelingVersionsProfileDiagram.PNG]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/a/a3/VID_Manage_the_version_access.png'>File:Managing_the_access_of_versions_OK.mp4‎</mediaplayer>
| Managing version access.
}}

An administrator of Version A can define that the Version A users can have access to the direct children versions' projects and offers (i.e. Version B, Version C and Version D). However, Version A users cannot access Version E's projects and offers because Version E is not a direct child of Version A.

The administrator of Version A can also define that Version B users can have access to Version C's projects and offers but not to Version D's projects and offer. The same administrator could also define that Version C users can only have access to Version B's projects and offers.

The authorization is not bi-directional: if Version B users have access to Version C's projects and offers, Version C users do not automatically receive access to Version B's projects and offers. The administrator must set the authorizations for each version.

=== Previewing a Version's Rights ===

In the '''Version Access''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Version Rights. Selecting a Version Right from the table/list and clicking on it opens the '''Version Rights''' preview window.

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

For detailed descriptions of all information available in this window please refer to the section dedicated to the edition of a version right .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In this window, only the authorized versions are displayed. This means that if a version is not authorized to see the projects or the offers or at least one other version, the table is empty as shown in the following example:

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

== Languages ==

Metis Smart Suite supports the use of multiple languages for single roll-outs of the application. Different languages can then be used to translate the [[Metis_Smart_Modeling_-_Setup|User Interface]] and/or the objects created in Metis Smart Modeling, the documents generated by Metis Smart Quotes or the Notes provided by the End-Users In this menu, the administrator defines the languages that the Metis Smart Modeling and Metis Smart Quote users are authorized to use.

{{Warning
| The administrator can define a maximum of four languages per version.
}}

Languages defined in this menu are then made available in the following parts of Metis:

* when a designation is required for an item (e.g. a language, a [[Description_of_the_Menu_Positions|position]], an [[Metis_Smart_Modeling_-_Attributes|attribute]] etc.), the designation may be entered for all the languages that have been made available.

* In the [[Description_of_the_Menu_Users|Users]] menu when defining a user's main language

* In the [[Description of the Sub-Menu Functionalities#Languages tab | Profiles]] menu when setting a default language for a functionality profile.

* In the [[Metis_Smart_Modeling_-_Setup|Setup]] menu when selecting the User Interface language for the application.

* In various part of Metis Smart Quotes as when creating a contact.

{{Note
| The designations in the other languages are used in the case where a designation is missing for the language in which the user is currently working with (see the [[#Priority| Priority]] section below).
}}

=== Adding a New Language ===

Before adding or creating a language, the administrator has to make sure that the maximum number of languages per version is not reached. A click on the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] displays the following window:

[[File:MetisSmartModelingAddLangageSelection.PNG|center|300x350px]]

The administrator can either add an existing language or create a new language.

==== Adding an Existing Language ====

If the administrator chooses to add an existing language, the following window appears after selecting the "Add available language" option:

[[File:MetisSmartModelingLanguageAddExistingLanguage.PNG|center|600x400px]]

The contents of this window is non editable.

The window contains the list of all the available languages. These languages can come from one of the following sources:
* an ascendant version
* the current version
* a descendant version

The first three columns of the window (Flag, Code and Designation) show the country flag, the language code and the language designation. The last column (Version) indicates the version in which the language has been created.

To add a language to the current version, select a language then click on the OK icon. The Languages menu is displayed again with the added language(s). In the language selection menu, it is possible to select several languages at the same time. If the administrator tries to select too many languages and exceeds the 4 authorized languages per version, a pop up window appears. If the user tries to select a language that has already been made available for the current version, a pop up window appears.

==== Creating a New Language ====

If the administrator chooses to create a new language, the following window appears after selecting the "Create a new language" option:

[[File:MetisSmartModelingLanguageAddNewLanguage.PNG|center|600x400px]]

The properties of the language must be provided, that is to say:
* a picture representing the country flag
* a language code (preferably the ISO code)
* a designation
* a translation for each language that has already been made available by the administrator

The language code field is mandatory in order to save the language. This field is limited to four characters and cannot be changed afterwards.

{{Note
| It is highly recommended to use the [http://www.iso.org/iso/english_country_names_and_code_elements official ISO country code].
}}

To define a picture representing the country flag for the language, click on the frame located on the top right side. A window opens as shown in the following example:

[[File:MetisSmartModelingLanguageAddFlagIcon.PNG|center|300x350px]]

The window contains the pictures that have been previously uploaded in the '''[[Description_of_the_Sub-Menu_Cliparts | Cliparts]]''' menu.

The language designation is limited to 30 characters and is mandatory.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/0/0b/VID_Creating_a_language.png'>File:Creating_a_language_OK.mp4‎</mediaplayer>
| Creating a language.
}}

For each language that has already been made available by the administrator, a designation should be provided. This designation should be the name of the created language translated into the other language (e.g. "Russian" in English, "Russe" in French, "Russisch" in German etc.).

=== Editing a Language ===

In the '''Languages''' 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 Language. Selecting a Language and clicking on it opens the '''Languages''' edition window where all related properties and information can be edited.

[[File:MetisSmartModelingLanguageEdit.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the country flag
* an ISO language code
* designation
* the designation of the language (for each language that has been made available by the administrator)

If the administrator is not the owner of the language (i.e. the language has been created in another version), it is only possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator). The language code and the picture cannot be edited.

If the administrator is the owner of the language, it is possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator) and the picture representing the country flag. The language code cannot be edited.

=== Preview ===

In the '''Languages''' 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 Language. Selecting a language from the table and clicking on it opens the '''Languages''' preview window.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Language.

[[File:MetisSmartModelingLanguagePreview.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the flag
* an ISO language code
* a designation
* the designation of the language (for each language that has been made available by the administrator)

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

=== Priority ===

The order in which the languages are displayed correspond to the language priority order. This order is considered when a description is missing for an item. When a description is missing, Metis looks for the item description in the other available languages and displays this description. This means that if the description of an item is missing in the first language, Metis displays the description in the second language if it exists. If not, the description in the third language is displayed and so on.

The priority can be modified by clicking on the ''Priority'' button. The following window appears:

[[File:MetisSmartModelingLanguagePriority.PNG|center|300x350px]]

The table is populated with the languages that have been defined for the current version. The contents of the table cannot be edited. The priority order of the language can be defined using the up and down arrows on the right of the table. The language at the top of the table has the highest priority. The language at the bottom of the table has the lowest priority.

=== Deleting a Language ===

In the '''Languages''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Language. Selecting a Language and clicking on it displays the following confirmation window, if the version has been manually created (i.e. no lock) or is owned by the current version, a confirmation window appears.

Once the warning is confirmed, the selected Language is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| If all the languages are deleted, Metis proposes by default English as the language of the version.
}}

{{Note
| If the language is owned by another version (i.e. presence of a lock), the language cannot be deleted.

[[File:MSM_Versions_Languages_Languages_Delete.png|center]]

}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/e/eb/VID_managing_the_languages_of_a_version.png'>File:Managing_languages_OK.mp4‎</mediaplayer>
| Managing languages of a version.
}}

== Update ==

The Metis Smart Suite update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.

=== Update process Overview ===

In order for this process to efficiently distribute all that information, the functionality works based on the diagram below.

[[File:IMG_Update_Process.png|center|600x400px]]

All update related settings, information and files are bundled together within Metis Smart Suite and sent to a web-service hosted on a web-server. The local instances of Metis Smart Quotes then inquires this service for available updates and notifies the user. If validated, the update takes places and the application will be restarted.

=== Preparing Metis Smart Quotes Updates ===

The update sub-menu is used to prepare updates for offline versions of the Metis Smart Quotes. By default an update which will be created here will include the various databases required by the applications. The update preparation tool in Metis Smart Modeling can be used to fine tune this update. The first type of additional information which can be included in an update are files. The concept is that throughout the settings, external files could be required by Metis Smart Quotes in order to provide to the end-user different information. For example, in the [[Description_of_the_Sub-Menu_Notes|Notes]] menu of the software, the various note types allow the user to import default texts in the note. Those default texts need to be distributed and linked to the application. In the definition of the note setting the administrator sets up a link to a folder where those templates will be stored. When creating the update the idea is to list those templates and define where they will be placed within the local instance of the application. Therefore, the link defined within the profile will also be set in the "destination folder" column of the update preparation.

[[File:MSM_Versions_Uptdate.png|center|600x400px]]

In the update sub-menu the main working area is dedicated to a table with the following columns:

*'''Source File Name''': The name of the original file found under either the "Common Files" or "Specific Files" folder depending on the choice made.
*'''Dest. Folder''': An editable field where the user can enter the destination folder for the file after being updated.
*'''Dest. Filename''': An editable field where the user can enter a new name for the file after being distributed.
*'''File Date''': The date the original file was created.
*'''Behavior''': Describes what will happen once the update has been executed. A drop-down menu with three different options is found in this column.
**Overwite if more recent: The file will be replaced with a more recent version if one is available.
**Ignore if already existing: The file will remain untouched if it is found to already exist.
**Force overwrite: The file will be replaced no matter what the case.

Updates must be prepared in online mode. The purpose of the update process is that when updating a version, the update will automatically be available to the offline users of the version as well as the offline users of the child versions.

Updates may be available for online and offline versions of MSQ. Only the information owned by a version may be used for updates. Data which is owned by a version means data which has been created by the administrator of that version.

For example, on the diagram, the HQ version is the parent of the versions ENG, FRA, GER, JPN, and USA. USA is the parent of the versions NY and WA. This means that NY and WA are the grandchildren of the HQ version.

If an administrator of the HQ version prepares an update, the offline users of the HQ, ENG, FRA, GER, JPN, USA, NY and WA versions also receive the update.

If an administrator of the USA version prepares an update, the versions HQ, ENG, FRA, GER and JPN do not receive the update. Only the USA version and the child versions of USA receive it.

[[File:IMG_Version_Concept.png|center|600x400px]]

====Add Files====

Clicking on the "Add Files" button [[File:MetisSmartModelingCurrentlyAddFilesButton.PNG|link=]] opens a window that asks the user which type of files they wish to add, either '''Common Files''' or '''Specific Files'''. Common files are files which will be distributed to the selected version and its child versions after the update process. Specific files are files which will only be distributed to the selected version when preparing an update. The child versions will not receive the file after the update process.

[[File:MSM_Versions_Update_Add_Files.png|center]]

After selecting a file type and confirming, a MS Windows Explorer window opens where the user may add one or more files at the same time and then clicking on open to complete the process. The files are then added to the main table of the update sub-menu. Depending on the file type chosen, the files will appear under the appropriate folder.

====Delete Files====

In the '''Update''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Files. Selecting one or more files and clicking on it displays the following confirmation window.

Once the warning is confirmed, the selected files are removed from the Metis Smart Suite Update.

====Prepare Update====

After the desired file or files have been added to the update, the user can then begin to generate the update with the "Prepare Update" button [[File:MetisSmartModelingPrepareUpdateButton.PNG|link=]] button.

When selecting a file and clicking on this button, the user is presented with a pop-up window asking if they are sure that they want to run the update process.

The '''Preparing Update...''' window opens after confirming the pop-up. In this window the user is presented with a table with three columns including the '''Date''', '''Message''', and '''Status'''.

The '''Date''' columns list the date and time of the message given in the table, the '''Message''' column provides information to the user in the form of short messages indicating the current status of the update process, and the '''Status''' column is filled with either a green check-mark indicating successful step in the update process or a red x indicating an error in the update process. In the case of an error, a short notice will be displayed in the message column describing the error.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/5/5e/VID_preparing_update.png'>File:PreparingAnUpdateForOfflineInstallations_OK.mp4‎</mediaplayer>
| Preparing an update for offline installations.
}}

{{Warning
| In order for the update preparation and distribution to go through normally, it is required to define the update settings in the functionality profiles in the version in which the administrator works; and in the versions which are targeted by the update.

For the Metis Smart Quotes instances targeted by the update to receive the update it is of course necessary that the profiles define the correct update settings.
}}

== Licensing ==

(TBD)

Description of the Menu Versions

2014-01-15T13:14:01Z

PatrickG: /* Overview of versions */

As Metis Smart Suite can be rolled out in small to large organizations the software supports a versioning concepts. These feature allows it to be structured in a tree like schema. As the root of this tree there will always be the main delivered version of the application.

The branches from that tree will represent created version within the organization. As described in the figure below the headquarters of an organization is placed at the root of the tree, and all the country specific subsidiaries, for example, are shown as first child version (i.e. first level nodes). The leafs of the tree from a specific branch are for example partners within that country.

Within Metis Smart Suite a version is mainly described by its name and basic information, conditions, customer designation and directories which have to be used by it. Additionally '''[[Description of the Menu Profiles | Profiles]]''' of all types can be linked to a version in order to enforce default rights and privileges to all users which will be created in that version.

Versions are a key element of the Metis Smart Suite. This functionality allows the administrator to re-create the sales or legal structure of the company in which the software suite is being deployed. Additional examples of how this structure can support any organization can be found within the various screenshots of that section.

== Versions ==

Both Metis Smart Modeling users and administrators can create as many versions as required. As a reminder, versions that descend from a main version are classified as child versions. The main versions which create these child versions are classified as parent versions. This means that any single version may be a parent or child version, depending on the point of view.

[[File:IMG_Version_Concept.png|center|600x400px]]

=== Overview of versions ===

Users may add, delete, edit, and preview versions in this sub-menu. A search feature can be found on the left side and a main table containing general information is found in the working area.

In this table, the parent version (the currently logged-in version) is featured at the top with all its child versions listed below.
Versions in the main table may be represented by several different types of icons.

{| 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 Version
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Icon
! 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" |
'''Normal Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Standard Metis Smart Suite Version.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Version without Admin'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionNoAdminIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
There are no Users defined as administrator for this version. It depends entirely on the parent version's Administrator.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Inactive Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
[[File:MetisSmartModelingVersionInactiveIcon.png‎|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Version exists in the Metis Smart Suite Database, but has been disabled.
|-
|}

A lock icon may be found preceding any of these types of versions. The lock icon signifies that the version was not created in the version currently logged-in, but in another version or by an automated system.

[[File:MSM_Versions_Versions.png|center|600x400px]]

{{Note
| Imported versions which are denied access to certain items through profile groups, can never have access to these items even if they are given access through the use of additional profiles.

[take a screenshot of for example a system profile[title it "main profile"] with several check-boxes unticked and one["additional profile"] with the same check-boxes ticked, and then screenshot of additional profiles for profile groups for the user]
}}

{| 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 0 1px 0" | Description
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Version Specific Objects'''
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Available only in the version where created and in the child versions if access was granted.
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
*Employees
*Offices
*Positions
*Attributes
*Hierarchies
*Segments
*Price Groups
*Price Categories
*Documents
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Objects implicitly linked'''
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Allowed modifications which are done to part of an object (i.e. description) are then valid also for all child versions,
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
*Translations (descriptions all positions, attributes, hierarchies, prices, systems and languages)
*Data Management type objects
|-
|}

=== Managing versions ===

====Search====

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Versions based on various criterions. 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 disaplyed below/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

====Add====

In the '''Versions''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Version. When it is clicked, the '''Version''' creation window opens, it contains two different type of information. The first tab '''Version''' shows a table separated into several expandable sections with two columns, '''Designation''' which represents the type of field and '''Value''' which represents the data entered into that field. All those fields provides the detailed description of a version. Only the ones with the edit icon on the right-hand side of the table can be defined by the user. The other ones are either inheritance from the parent version or imported through a third-party system.

[[File:MSM_Versions_Versions_add_Versions.png|center|600x400px]]

{{Note
| Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field.
}}

When creating a new version, the fields in the versions tab can be edited in order to define the version.

'''''Main'''''

* Version: Name of the version.
* Administrator Free: Choose to make a version administrator free. By setting the version to be administration free, the fields under the Customer section become available.
* Nomad Gateway User: A nomad gateway user can be defined in this field.
* Use Parent documents: Choose to use parent documents for the current version.
* Second ID to display : Secondary ID for he version.
* Default currency : set the default currency to used for all offers created within this version.
* Role for client condition : Role which specifies which Address is taken to apply '''[[Description_of_the_Menu_Prices#Customer_Prices|Customer Prices]]'''.

'''''Conditions'''''

* GSP Discount: The global sales price discount. Entering a figure here for example 50.0, means that a discount of 50% will be factored into the global sales price for this version. The GSP Discount can only be defined for a version by the parent version.

'''''Customer'''''

* OrgID: Organization ID
* Name 1: Name of the customer contact.
* Name 2: Additional name field for a contact.
* Name 3: Additional name field for a contact.
* Address 1: Address of where the customer is located (i.e. street name)
* Address 2: Additional address field for the customer (i.e. building name).
* City Name: City of where the customer is located. A drop-down list of available cities can provided for selection (see Data Management)
* ZipCode: Zipcode for where the customer is located.
* Country: Country where the customer is located. A drop-down list of available countries can provided for selection (see Data Management).
* State: State in the country where the customer is located. A drop-down list of states can be provided for selection (see Data Management).

'''''Directories'''''

Directories may only be specified within the version currently logged-in to. Parent versions cannot choose the directory for child versions. When a directory has been specified, the folder path will be shown in the corresponding field.

* Exchange: link to a folder used for saving FQS files.
* Document: link to a folder used for saving documents that are related to offers.
* Order: link to a folder used for saving XML and SES files.
* Libraries: link to a folder used for software libraries.

'''Profiles'''

'''[[Description of the Menu Profiles | Profiles]]''' are set to a version by the parent of that version in the section '''From Creator'''. Versions that have been automatically created by importation have their profiles also automatically set and cannot have their profiles edited.

However, additional profiles can be given to these versions in the section '''From parent'''. The '''Form parent''' section is only visible for these automatically created versions. To the right of the edit icon column is another column that has an eye for an icon.

Clicking on this eye lets the user see what items are defined by the current profile. Meaning that if the system profile "Default systems" was selected, doing so will display which systems are available in this profile.

[[File:MSM_Versions_Versions_add_profiles.png|center|600x400px]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/d/d2/VID_AdditionalProfilesConcept.PNG'>File:Additional_Profiles_OK.mp4‎</mediaplayer>
| Managing additional Profiles in versions.
}}

'''''From Creator'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

'''''From Parent'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

====Edit====

In the '''Versions''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version. Selecting a version and clicking on it opens the '''Version''' edition window where all related properties and information can be edited.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Version. Modifications applied to the selected version will only be saved once the version edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

[[File:MSM_Versions_Versions_Edit_Version.png|center|600x400px]]

====Delete====

In the '''Version''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Version. Selecting a version and clicking on it displays the following confirmation window.

[[File:MSM_Versions_Versions_delete_2.png|center]]

Once the warning is confirmed, the selected version is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| It is not possible to delete a version unless logged-in to the version that created it.

[[File:MSM_Versions_Versions_delete.png|center]]

}}

====Preview====

In the '''Versions''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected version. Selecting a version from the list and clicking on it opens the '''Version''' preview window.

[[File:MSM_Versions_Versions_Preview_profile.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 ... .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In the rightmost column of the table displayed in the '''Version''' preview window, the icon representing an eye can be used to display the list Systems, Hierarchies, Price Categories, Attributes, Variants, Service Models and Tax Models which have been set for the various profiles. No edition is possible.

==== Version without Administrator ====

As stated in the name, version without administrator is a Metis Smart Suite Version which doesn't include an administrator. This type of version is mainly used when no direct maintenance is required on the version level or when it is simply not wished to let the version be maintained individually.

A version without administrator is always created and maintained by its parent version.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/f/fe/VID_VersionNoAdmin.png'>File:Setting_a_version_without_an_administrator_OK.mp4‎</mediaplayer>
| Setting up a version without an administrator.
}}

== Access ==

From this sub-menu, the administrator can define and manage the access between the various children versions, as shown in the following example:

[[File:MSM_Versions_Access.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find versions based on various criterion. The search is triggered by typing a keyword or only a letter in the field 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 list.

=== Editing a Version's Rights ===

In the '''Version Rights''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version Right. Selecting a version right and clicking on it opens the '''Version Rights''' edition window where all related properties and information can be edited.

[[File:MSM_Versions_Access_Edit.png|center|600x400px]]

{{Note
| The title on the window displays the name of selected version (e.g. Version Rights Headquarters where Headquarters is the name of the selected version).
}}

The Versions (Smart Quotes) table displays all the available versions. The displayed versions consist of all of the children versions of the administrator's version. The authorized column allows the administrator to select / deselect the versions that the Smart Quotes users is authorized to access to. The following example describes the cases where a version can have access to the projects and offers made in other versions:

[[File:MetisSmartModelingVersionsProfileDiagram.PNG]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/a/a3/VID_Manage_the_version_access.png'>File:Managing_the_access_of_versions_OK.mp4‎</mediaplayer>
| Managing version access.
}}

An administrator of Version A can define that the Version A users can have access to the direct children versions' projects and offers (i.e. Version B, Version C and Version D). However, Version A users cannot access Version E's projects and offers because Version E is not a direct child of Version A.

The administrator of Version A can also define that Version B users can have access to Version C's projects and offers but not to Version D's projects and offer. The same administrator could also define that Version C users can only have access to Version B's projects and offers.

The authorization is not bi-directional: if Version B users have access to Version C's projects and offers, Version C users do not automatically receive access to Version B's projects and offers. The administrator must set the authorizations for each version.

=== Previewing a Version's Rights ===

In the '''Version Access''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Version Rights. Selecting a Version Right from the table/list and clicking on it opens the '''Version Rights''' preview window.

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

For detailed descriptions of all information available in this window please refer to the section dedicated to the edition of a version right .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In this window, only the authorized versions are displayed. This means that if a version is not authorized to see the projects or the offers or at least one other version, the table is empty as shown in the following example:

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

== Languages ==

Metis Smart Suite supports the use of multiple languages for single roll-outs of the application. Different languages can then be used to translate the [[Metis_Smart_Modeling_-_Setup|User Interface]] and/or the objects created in Metis Smart Modeling, the documents generated by Metis Smart Quotes or the Notes provided by the End-Users In this menu, the administrator defines the languages that the Metis Smart Modeling and Metis Smart Quote users are authorized to use.

{{Warning
| The administrator can define a maximum of four languages per version.
}}

Languages defined in this menu are then made available in the following parts of Metis:

* when a designation is required for an item (e.g. a language, a [[Description_of_the_Menu_Positions|position]], an [[Metis_Smart_Modeling_-_Attributes|attribute]] etc.), the designation may be entered for all the languages that have been made available.

* In the [[Description_of_the_Menu_Users|Users]] menu when defining a user's main language

* In the [[Description of the Sub-Menu Functionalities#Languages tab | Profiles]] menu when setting a default language for a functionality profile.

* In the [[Metis_Smart_Modeling_-_Setup|Setup]] menu when selecting the User Interface language for the application.

* In various part of Metis Smart Quotes as when creating a contact.

{{Note
| The designations in the other languages are used in the case where a designation is missing for the language in which the user is currently working with (see the [[#Priority| Priority]] section below).
}}

=== Adding a New Language ===

Before adding or creating a language, the administrator has to make sure that the maximum number of languages per version is not reached. A click on the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] displays the following window:

[[File:MetisSmartModelingAddLangageSelection.PNG|center|300x350px]]

The administrator can either add an existing language or create a new language.

==== Adding an Existing Language ====

If the administrator chooses to add an existing language, the following window appears after selecting the "Add available language" option:

[[File:MetisSmartModelingLanguageAddExistingLanguage.PNG|center|600x400px]]

The contents of this window is non editable.

The window contains the list of all the available languages. These languages can come from one of the following sources:
* an ascendant version
* the current version
* a descendant version

The first three columns of the window (Flag, Code and Designation) show the country flag, the language code and the language designation. The last column (Version) indicates the version in which the language has been created.

To add a language to the current version, select a language then click on the OK icon. The Languages menu is displayed again with the added language(s). In the language selection menu, it is possible to select several languages at the same time. If the administrator tries to select too many languages and exceeds the 4 authorized languages per version, a pop up window appears. If the user tries to select a language that has already been made available for the current version, a pop up window appears.

==== Creating a New Language ====

If the administrator chooses to create a new language, the following window appears after selecting the "Create a new language" option:

[[File:MetisSmartModelingLanguageAddNewLanguage.PNG|center|600x400px]]

The properties of the language must be provided, that is to say:
* a picture representing the country flag
* a language code (preferably the ISO code)
* a designation
* a translation for each language that has already been made available by the administrator

The language code field is mandatory in order to save the language. This field is limited to four characters and cannot be changed afterwards.

{{Note
| It is highly recommended to use the [http://www.iso.org/iso/english_country_names_and_code_elements official ISO country code].
}}

To define a picture representing the country flag for the language, click on the frame located on the top right side. A window opens as shown in the following example:

[[File:MetisSmartModelingLanguageAddFlagIcon.PNG|center|300x350px]]

The window contains the pictures that have been previously uploaded in the '''[[Description_of_the_Sub-Menu_Cliparts | Cliparts]]''' menu.

The language designation is limited to 30 characters and is mandatory.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/0/0b/VID_Creating_a_language.png'>File:Creating_a_language_OK.mp4‎</mediaplayer>
| Creating a language.
}}

For each language that has already been made available by the administrator, a designation should be provided. This designation should be the name of the created language translated into the other language (e.g. "Russian" in English, "Russe" in French, "Russisch" in German etc.).

=== Editing a Language ===

In the '''Languages''' 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 Language. Selecting a Language and clicking on it opens the '''Languages''' edition window where all related properties and information can be edited.

[[File:MetisSmartModelingLanguageEdit.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the country flag
* an ISO language code
* designation
* the designation of the language (for each language that has been made available by the administrator)

If the administrator is not the owner of the language (i.e. the language has been created in another version), it is only possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator). The language code and the picture cannot be edited.

If the administrator is the owner of the language, it is possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator) and the picture representing the country flag. The language code cannot be edited.

=== Preview ===

In the '''Languages''' 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 Language. Selecting a language from the table and clicking on it opens the '''Languages''' preview window.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Language.

[[File:MetisSmartModelingLanguagePreview.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the flag
* an ISO language code
* a designation
* the designation of the language (for each language that has been made available by the administrator)

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

=== Priority ===

The order in which the languages are displayed correspond to the language priority order. This order is considered when a description is missing for an item. When a description is missing, Metis looks for the item description in the other available languages and displays this description. This means that if the description of an item is missing in the first language, Metis displays the description in the second language if it exists. If not, the description in the third language is displayed and so on.

The priority can be modified by clicking on the ''Priority'' button. The following window appears:

[[File:MetisSmartModelingLanguagePriority.PNG|center|300x350px]]

The table is populated with the languages that have been defined for the current version. The contents of the table cannot be edited. The priority order of the language can be defined using the up and down arrows on the right of the table. The language at the top of the table has the highest priority. The language at the bottom of the table has the lowest priority.

=== Deleting a Language ===

In the '''Languages''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Language. Selecting a Language and clicking on it displays the following confirmation window, if the version has been manually created (i.e. no lock) or is owned by the current version, a confirmation window appears.

Once the warning is confirmed, the selected Language is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| If all the languages are deleted, Metis proposes by default English as the language of the version.
}}

{{Note
| If the language is owned by another version (i.e. presence of a lock), the language cannot be deleted.

[[File:MSM_Versions_Languages_Languages_Delete.png|center]]

}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/e/eb/VID_managing_the_languages_of_a_version.png'>File:Managing_languages_OK.mp4‎</mediaplayer>
| Managing languages of a version.
}}

== Update ==

The Metis Smart Suite update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.

=== Update process Overview ===

In order for this process to efficiently distribute all that information, the functionality works based on the diagram below.

[[File:IMG_Update_Process.png|center|600x400px]]

All update related settings, information and files are bundled together within Metis Smart Suite and sent to a web-service hosted on a web-server. The local instances of Metis Smart Quotes then inquires this service for available updates and notifies the user. If validated, the update takes places and the application will be restarted.

=== Preparing Metis Smart Quotes Updates ===

The update sub-menu is used to prepare updates for offline versions of the Metis Smart Quotes. By default an update which will be created here will include the various databases required by the applications. The update preparation tool in Metis Smart Modeling can be used to fine tune this update. The first type of additional information which can be included in an update are files. The concept is that throughout the settings, external files could be required by Metis Smart Quotes in order to provide to the end-user different information. For example, in the [[Description_of_the_Sub-Menu_Notes|Notes]] menu of the software, the various note types allow the user to import default texts in the note. Those default texts need to be distributed and linked to the application. In the definition of the note setting the administrator sets up a link to a folder where those templates will be stored. When creating the update the idea is to list those templates and define where they will be placed within the local instance of the application. Therefore, the link defined within the profile will also be set in the "destination folder" column of the update preparation.

[[File:MSM_Versions_Uptdate.png|center|600x400px]]

In the update sub-menu the main working area is dedicated to a table with the following columns:

*'''Source File Name''': The name of the original file found under either the "Common Files" or "Specific Files" folder depending on the choice made.
*'''Dest. Folder''': An editable field where the user can enter the destination folder for the file after being updated.
*'''Dest. Filename''': An editable field where the user can enter a new name for the file after being distributed.
*'''File Date''': The date the original file was created.
*'''Behavior''': Describes what will happen once the update has been executed. A drop-down menu with three different options is found in this column.
**Overwite if more recent: The file will be replaced with a more recent version if one is available.
**Ignore if already existing: The file will remain untouched if it is found to already exist.
**Force overwrite: The file will be replaced no matter what the case.

Updates must be prepared in online mode. The purpose of the update process is that when updating a version, the update will automatically be available to the offline users of the version as well as the offline users of the child versions.

Updates may be available for online and offline versions of MSQ. Only the information owned by a version may be used for updates. Data which is owned by a version means data which has been created by the administrator of that version.

For example, on the diagram, the HQ version is the parent of the versions ENG, FRA, GER, JPN, and USA. USA is the parent of the versions NY and WA. This means that NY and WA are the grandchildren of the HQ version.

If an administrator of the HQ version prepares an update, the offline users of the HQ, ENG, FRA, GER, JPN, USA, NY and WA versions also receive the update.

If an administrator of the USA version prepares an update, the versions HQ, ENG, FRA, GER and JPN do not receive the update. Only the USA version and the child versions of USA receive it.

[[File:IMG_Version_Concept.png|center|600x400px]]

====Add Files====

Clicking on the "Add Files" button [[File:MetisSmartModelingCurrentlyAddFilesButton.PNG|link=]] opens a window that asks the user which type of files they wish to add, either '''Common Files''' or '''Specific Files'''. Common files are files which will be distributed to the selected version and its child versions after the update process. Specific files are files which will only be distributed to the selected version when preparing an update. The child versions will not receive the file after the update process.

[[File:MSM_Versions_Update_Add_Files.png|center]]

After selecting a file type and confirming, a MS Windows Explorer window opens where the user may add one or more files at the same time and then clicking on open to complete the process. The files are then added to the main table of the update sub-menu. Depending on the file type chosen, the files will appear under the appropriate folder.

====Delete Files====

In the '''Update''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Files. Selecting one or more files and clicking on it displays the following confirmation window.

Once the warning is confirmed, the selected files are removed from the Metis Smart Suite Update.

====Prepare Update====

After the desired file or files have been added to the update, the user can then begin to generate the update with the "Prepare Update" button [[File:MetisSmartModelingPrepareUpdateButton.PNG|link=]] button.

When selecting a file and clicking on this button, the user is presented with a pop-up window asking if they are sure that they want to run the update process.

The '''Preparing Update...''' window opens after confirming the pop-up. In this window the user is presented with a table with three columns including the '''Date''', '''Message''', and '''Status'''.

The '''Date''' columns list the date and time of the message given in the table, the '''Message''' column provides information to the user in the form of short messages indicating the current status of the update process, and the '''Status''' column is filled with either a green check-mark indicating successful step in the update process or a red x indicating an error in the update process. In the case of an error, a short notice will be displayed in the message column describing the error.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/5/5e/VID_preparing_update.png'>File:PreparingAnUpdateForOfflineInstallations_OK.mp4‎</mediaplayer>
| Preparing an update for offline installations.
}}

{{Warning
| In order for the update preparation and distribution to go through normally, it is required to define the update settings in the functionality profiles in the version in which the administrator works; and in the versions which are targeted by the update.

For the Metis Smart Quotes instances targeted by the update to receive the update it is of course necessary that the profiles define the correct update settings.
}}

== Licensing ==

(TBD)

Description of the Menu Versions

2014-01-15T13:13:16Z

PatrickG: /* Overview of versions */

As Metis Smart Suite can be rolled out in small to large organizations the software supports a versioning concepts. These feature allows it to be structured in a tree like schema. As the root of this tree there will always be the main delivered version of the application.

The branches from that tree will represent created version within the organization. As described in the figure below the headquarters of an organization is placed at the root of the tree, and all the country specific subsidiaries, for example, are shown as first child version (i.e. first level nodes). The leafs of the tree from a specific branch are for example partners within that country.

Within Metis Smart Suite a version is mainly described by its name and basic information, conditions, customer designation and directories which have to be used by it. Additionally '''[[Description of the Menu Profiles | Profiles]]''' of all types can be linked to a version in order to enforce default rights and privileges to all users which will be created in that version.

Versions are a key element of the Metis Smart Suite. This functionality allows the administrator to re-create the sales or legal structure of the company in which the software suite is being deployed. Additional examples of how this structure can support any organization can be found within the various screenshots of that section.

== Versions ==

Both Metis Smart Modeling users and administrators can create as many versions as required. As a reminder, versions that descend from a main version are classified as child versions. The main versions which create these child versions are classified as parent versions. This means that any single version may be a parent or child version, depending on the point of view.

[[File:IMG_Version_Concept.png|center|600x400px]]

=== Overview of versions ===

Users may add, delete, edit, and preview versions in this sub-menu. A search feature can be found on the left side and a main table containing general information is found in the working area.

In this table, the parent version (the currently logged-in version) is featured at the top with all its child versions listed below.
Versions in the main table may be represented by several different types of icons.

{| 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 Version
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Icon
! 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" |
'''Normal Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Standard Metis Smart Suite Version.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Version without Admin'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionNoAdminIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
There are no Users defined as administrator for this version. It depends entirely on the parent version's Administrator.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Inactive Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
[[File:MetisSmartModelingVersionInactiveIcon.png‎|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Version exists in the Metis Smart Suite Database, but has been disabled.
|-
|}

A lock icon may be found preceding any of these types of versions. The lock icon signifies that the version was not created in the version currently logged-in, but in another version or by an automated system.

[[File:MSM_Versions_Versions.png|center|600x400px]]

{{Note
| Imported versions which are denied access to certain items through profile groups, can never have access to these items even if they are given access through the use of additional profiles.

[take a screenshot of for example a system profile[title it "main profile"] with several check-boxes unticked and one["additional profile"] with the same check-boxes ticked, and then screenshot of additional profiles for profile groups for the user]
}}

{| 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 0 1px 0" | Description
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Version Specific Objects'''
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Available only in the version where created and in the child versions if access was granted.
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
*Employees
*Offices
*Positions
*Attributes
*Hierarchies
*Segments
*Price Groups
*Price Categories
*Documents
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Objects implicitly linked'''
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Allowed modifications which are done to part of an object (i.e. description) are then valid also for all child versions,
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
*Translations (descriptions all positions, attributes, hierarchies, prices, systems and languages)
*Data Management type objects
|-
|}

=== Managing versions ===

====Search====

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Versions based on various criterions. 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 disaplyed below/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

====Add====

In the '''Versions''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Version. When it is clicked, the '''Version''' creation window opens, it contains two different type of information. The first tab '''Version''' shows a table separated into several expandable sections with two columns, '''Designation''' which represents the type of field and '''Value''' which represents the data entered into that field. All those fields provides the detailed description of a version. Only the ones with the edit icon on the right-hand side of the table can be defined by the user. The other ones are either inheritance from the parent version or imported through a third-party system.

[[File:MSM_Versions_Versions_add_Versions.png|center|600x400px]]

{{Note
| Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field.
}}

When creating a new version, the fields in the versions tab can be edited in order to define the version.

'''''Main'''''

* Version: Name of the version.
* Administrator Free: Choose to make a version administrator free. By setting the version to be administration free, the fields under the Customer section become available.
* Nomad Gateway User: A nomad gateway user can be defined in this field.
* Use Parent documents: Choose to use parent documents for the current version.
* Second ID to display : Secondary ID for he version.
* Default currency : set the default currency to used for all offers created within this version.
* Role for client condition : Role which specifies which Address is taken to apply '''[[Description_of_the_Menu_Prices#Customer_Prices|Customer Prices]]'''.

'''''Conditions'''''

* GSP Discount: The global sales price discount. Entering a figure here for example 50.0, means that a discount of 50% will be factored into the global sales price for this version. The GSP Discount can only be defined for a version by the parent version.

'''''Customer'''''

* OrgID: Organization ID
* Name 1: Name of the customer contact.
* Name 2: Additional name field for a contact.
* Name 3: Additional name field for a contact.
* Address 1: Address of where the customer is located (i.e. street name)
* Address 2: Additional address field for the customer (i.e. building name).
* City Name: City of where the customer is located. A drop-down list of available cities can provided for selection (see Data Management)
* ZipCode: Zipcode for where the customer is located.
* Country: Country where the customer is located. A drop-down list of available countries can provided for selection (see Data Management).
* State: State in the country where the customer is located. A drop-down list of states can be provided for selection (see Data Management).

'''''Directories'''''

Directories may only be specified within the version currently logged-in to. Parent versions cannot choose the directory for child versions. When a directory has been specified, the folder path will be shown in the corresponding field.

* Exchange: link to a folder used for saving FQS files.
* Document: link to a folder used for saving documents that are related to offers.
* Order: link to a folder used for saving XML and SES files.
* Libraries: link to a folder used for software libraries.

'''Profiles'''

'''[[Description of the Menu Profiles | Profiles]]''' are set to a version by the parent of that version in the section '''From Creator'''. Versions that have been automatically created by importation have their profiles also automatically set and cannot have their profiles edited.

However, additional profiles can be given to these versions in the section '''From parent'''. The '''Form parent''' section is only visible for these automatically created versions. To the right of the edit icon column is another column that has an eye for an icon.

Clicking on this eye lets the user see what items are defined by the current profile. Meaning that if the system profile "Default systems" was selected, doing so will display which systems are available in this profile.

[[File:MSM_Versions_Versions_add_profiles.png|center|600x400px]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/d/d2/VID_AdditionalProfilesConcept.PNG'>File:Additional_Profiles_OK.mp4‎</mediaplayer>
| Managing additional Profiles in versions.
}}

'''''From Creator'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

'''''From Parent'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

====Edit====

In the '''Versions''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version. Selecting a version and clicking on it opens the '''Version''' edition window where all related properties and information can be edited.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Version. Modifications applied to the selected version will only be saved once the version edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

[[File:MSM_Versions_Versions_Edit_Version.png|center|600x400px]]

====Delete====

In the '''Version''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Version. Selecting a version and clicking on it displays the following confirmation window.

[[File:MSM_Versions_Versions_delete_2.png|center]]

Once the warning is confirmed, the selected version is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| It is not possible to delete a version unless logged-in to the version that created it.

[[File:MSM_Versions_Versions_delete.png|center]]

}}

====Preview====

In the '''Versions''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected version. Selecting a version from the list and clicking on it opens the '''Version''' preview window.

[[File:MSM_Versions_Versions_Preview_profile.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 ... .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In the rightmost column of the table displayed in the '''Version''' preview window, the icon representing an eye can be used to display the list Systems, Hierarchies, Price Categories, Attributes, Variants, Service Models and Tax Models which have been set for the various profiles. No edition is possible.

==== Version without Administrator ====

As stated in the name, version without administrator is a Metis Smart Suite Version which doesn't include an administrator. This type of version is mainly used when no direct maintenance is required on the version level or when it is simply not wished to let the version be maintained individually.

A version without administrator is always created and maintained by its parent version.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/f/fe/VID_VersionNoAdmin.png'>File:Setting_a_version_without_an_administrator_OK.mp4‎</mediaplayer>
| Setting up a version without an administrator.
}}

== Access ==

From this sub-menu, the administrator can define and manage the access between the various children versions, as shown in the following example:

[[File:MSM_Versions_Access.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find versions based on various criterion. The search is triggered by typing a keyword or only a letter in the field 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 list.

=== Editing a Version's Rights ===

In the '''Version Rights''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version Right. Selecting a version right and clicking on it opens the '''Version Rights''' edition window where all related properties and information can be edited.

[[File:MSM_Versions_Access_Edit.png|center|600x400px]]

{{Note
| The title on the window displays the name of selected version (e.g. Version Rights Headquarters where Headquarters is the name of the selected version).
}}

The Versions (Smart Quotes) table displays all the available versions. The displayed versions consist of all of the children versions of the administrator's version. The authorized column allows the administrator to select / deselect the versions that the Smart Quotes users is authorized to access to. The following example describes the cases where a version can have access to the projects and offers made in other versions:

[[File:MetisSmartModelingVersionsProfileDiagram.PNG]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/a/a3/VID_Manage_the_version_access.png'>File:Managing_the_access_of_versions_OK.mp4‎</mediaplayer>
| Managing version access.
}}

An administrator of Version A can define that the Version A users can have access to the direct children versions' projects and offers (i.e. Version B, Version C and Version D). However, Version A users cannot access Version E's projects and offers because Version E is not a direct child of Version A.

The administrator of Version A can also define that Version B users can have access to Version C's projects and offers but not to Version D's projects and offer. The same administrator could also define that Version C users can only have access to Version B's projects and offers.

The authorization is not bi-directional: if Version B users have access to Version C's projects and offers, Version C users do not automatically receive access to Version B's projects and offers. The administrator must set the authorizations for each version.

=== Previewing a Version's Rights ===

In the '''Version Access''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Version Rights. Selecting a Version Right from the table/list and clicking on it opens the '''Version Rights''' preview window.

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

For detailed descriptions of all information available in this window please refer to the section dedicated to the edition of a version right .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In this window, only the authorized versions are displayed. This means that if a version is not authorized to see the projects or the offers or at least one other version, the table is empty as shown in the following example:

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

== Languages ==

Metis Smart Suite supports the use of multiple languages for single roll-outs of the application. Different languages can then be used to translate the [[Metis_Smart_Modeling_-_Setup|User Interface]] and/or the objects created in Metis Smart Modeling, the documents generated by Metis Smart Quotes or the Notes provided by the End-Users In this menu, the administrator defines the languages that the Metis Smart Modeling and Metis Smart Quote users are authorized to use.

{{Warning
| The administrator can define a maximum of four languages per version.
}}

Languages defined in this menu are then made available in the following parts of Metis:

* when a designation is required for an item (e.g. a language, a [[Description_of_the_Menu_Positions|position]], an [[Metis_Smart_Modeling_-_Attributes|attribute]] etc.), the designation may be entered for all the languages that have been made available.

* In the [[Description_of_the_Menu_Users|Users]] menu when defining a user's main language

* In the [[Description of the Sub-Menu Functionalities#Languages tab | Profiles]] menu when setting a default language for a functionality profile.

* In the [[Metis_Smart_Modeling_-_Setup|Setup]] menu when selecting the User Interface language for the application.

* In various part of Metis Smart Quotes as when creating a contact.

{{Note
| The designations in the other languages are used in the case where a designation is missing for the language in which the user is currently working with (see the [[#Priority| Priority]] section below).
}}

=== Adding a New Language ===

Before adding or creating a language, the administrator has to make sure that the maximum number of languages per version is not reached. A click on the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] displays the following window:

[[File:MetisSmartModelingAddLangageSelection.PNG|center|300x350px]]

The administrator can either add an existing language or create a new language.

==== Adding an Existing Language ====

If the administrator chooses to add an existing language, the following window appears after selecting the "Add available language" option:

[[File:MetisSmartModelingLanguageAddExistingLanguage.PNG|center|600x400px]]

The contents of this window is non editable.

The window contains the list of all the available languages. These languages can come from one of the following sources:
* an ascendant version
* the current version
* a descendant version

The first three columns of the window (Flag, Code and Designation) show the country flag, the language code and the language designation. The last column (Version) indicates the version in which the language has been created.

To add a language to the current version, select a language then click on the OK icon. The Languages menu is displayed again with the added language(s). In the language selection menu, it is possible to select several languages at the same time. If the administrator tries to select too many languages and exceeds the 4 authorized languages per version, a pop up window appears. If the user tries to select a language that has already been made available for the current version, a pop up window appears.

==== Creating a New Language ====

If the administrator chooses to create a new language, the following window appears after selecting the "Create a new language" option:

[[File:MetisSmartModelingLanguageAddNewLanguage.PNG|center|600x400px]]

The properties of the language must be provided, that is to say:
* a picture representing the country flag
* a language code (preferably the ISO code)
* a designation
* a translation for each language that has already been made available by the administrator

The language code field is mandatory in order to save the language. This field is limited to four characters and cannot be changed afterwards.

{{Note
| It is highly recommended to use the [http://www.iso.org/iso/english_country_names_and_code_elements official ISO country code].
}}

To define a picture representing the country flag for the language, click on the frame located on the top right side. A window opens as shown in the following example:

[[File:MetisSmartModelingLanguageAddFlagIcon.PNG|center|300x350px]]

The window contains the pictures that have been previously uploaded in the '''[[Description_of_the_Sub-Menu_Cliparts | Cliparts]]''' menu.

The language designation is limited to 30 characters and is mandatory.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/0/0b/VID_Creating_a_language.png'>File:Creating_a_language_OK.mp4‎</mediaplayer>
| Creating a language.
}}

For each language that has already been made available by the administrator, a designation should be provided. This designation should be the name of the created language translated into the other language (e.g. "Russian" in English, "Russe" in French, "Russisch" in German etc.).

=== Editing a Language ===

In the '''Languages''' 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 Language. Selecting a Language and clicking on it opens the '''Languages''' edition window where all related properties and information can be edited.

[[File:MetisSmartModelingLanguageEdit.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the country flag
* an ISO language code
* designation
* the designation of the language (for each language that has been made available by the administrator)

If the administrator is not the owner of the language (i.e. the language has been created in another version), it is only possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator). The language code and the picture cannot be edited.

If the administrator is the owner of the language, it is possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator) and the picture representing the country flag. The language code cannot be edited.

=== Preview ===

In the '''Languages''' 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 Language. Selecting a language from the table and clicking on it opens the '''Languages''' preview window.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Language.

[[File:MetisSmartModelingLanguagePreview.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the flag
* an ISO language code
* a designation
* the designation of the language (for each language that has been made available by the administrator)

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

=== Priority ===

The order in which the languages are displayed correspond to the language priority order. This order is considered when a description is missing for an item. When a description is missing, Metis looks for the item description in the other available languages and displays this description. This means that if the description of an item is missing in the first language, Metis displays the description in the second language if it exists. If not, the description in the third language is displayed and so on.

The priority can be modified by clicking on the ''Priority'' button. The following window appears:

[[File:MetisSmartModelingLanguagePriority.PNG|center|300x350px]]

The table is populated with the languages that have been defined for the current version. The contents of the table cannot be edited. The priority order of the language can be defined using the up and down arrows on the right of the table. The language at the top of the table has the highest priority. The language at the bottom of the table has the lowest priority.

=== Deleting a Language ===

In the '''Languages''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Language. Selecting a Language and clicking on it displays the following confirmation window, if the version has been manually created (i.e. no lock) or is owned by the current version, a confirmation window appears.

Once the warning is confirmed, the selected Language is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| If all the languages are deleted, Metis proposes by default English as the language of the version.
}}

{{Note
| If the language is owned by another version (i.e. presence of a lock), the language cannot be deleted.

[[File:MSM_Versions_Languages_Languages_Delete.png|center]]

}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/e/eb/VID_managing_the_languages_of_a_version.png'>File:Managing_languages_OK.mp4‎</mediaplayer>
| Managing languages of a version.
}}

== Update ==

The Metis Smart Suite update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.

=== Update process Overview ===

In order for this process to efficiently distribute all that information, the functionality works based on the diagram below.

[[File:IMG_Update_Process.png|center|600x400px]]

All update related settings, information and files are bundled together within Metis Smart Suite and sent to a web-service hosted on a web-server. The local instances of Metis Smart Quotes then inquires this service for available updates and notifies the user. If validated, the update takes places and the application will be restarted.

=== Preparing Metis Smart Quotes Updates ===

The update sub-menu is used to prepare updates for offline versions of the Metis Smart Quotes. By default an update which will be created here will include the various databases required by the applications. The update preparation tool in Metis Smart Modeling can be used to fine tune this update. The first type of additional information which can be included in an update are files. The concept is that throughout the settings, external files could be required by Metis Smart Quotes in order to provide to the end-user different information. For example, in the [[Description_of_the_Sub-Menu_Notes|Notes]] menu of the software, the various note types allow the user to import default texts in the note. Those default texts need to be distributed and linked to the application. In the definition of the note setting the administrator sets up a link to a folder where those templates will be stored. When creating the update the idea is to list those templates and define where they will be placed within the local instance of the application. Therefore, the link defined within the profile will also be set in the "destination folder" column of the update preparation.

[[File:MSM_Versions_Uptdate.png|center|600x400px]]

In the update sub-menu the main working area is dedicated to a table with the following columns:

*'''Source File Name''': The name of the original file found under either the "Common Files" or "Specific Files" folder depending on the choice made.
*'''Dest. Folder''': An editable field where the user can enter the destination folder for the file after being updated.
*'''Dest. Filename''': An editable field where the user can enter a new name for the file after being distributed.
*'''File Date''': The date the original file was created.
*'''Behavior''': Describes what will happen once the update has been executed. A drop-down menu with three different options is found in this column.
**Overwite if more recent: The file will be replaced with a more recent version if one is available.
**Ignore if already existing: The file will remain untouched if it is found to already exist.
**Force overwrite: The file will be replaced no matter what the case.

Updates must be prepared in online mode. The purpose of the update process is that when updating a version, the update will automatically be available to the offline users of the version as well as the offline users of the child versions.

Updates may be available for online and offline versions of MSQ. Only the information owned by a version may be used for updates. Data which is owned by a version means data which has been created by the administrator of that version.

For example, on the diagram, the HQ version is the parent of the versions ENG, FRA, GER, JPN, and USA. USA is the parent of the versions NY and WA. This means that NY and WA are the grandchildren of the HQ version.

If an administrator of the HQ version prepares an update, the offline users of the HQ, ENG, FRA, GER, JPN, USA, NY and WA versions also receive the update.

If an administrator of the USA version prepares an update, the versions HQ, ENG, FRA, GER and JPN do not receive the update. Only the USA version and the child versions of USA receive it.

[[File:IMG_Version_Concept.png|center|600x400px]]

====Add Files====

Clicking on the "Add Files" button [[File:MetisSmartModelingCurrentlyAddFilesButton.PNG|link=]] opens a window that asks the user which type of files they wish to add, either '''Common Files''' or '''Specific Files'''. Common files are files which will be distributed to the selected version and its child versions after the update process. Specific files are files which will only be distributed to the selected version when preparing an update. The child versions will not receive the file after the update process.

[[File:MSM_Versions_Update_Add_Files.png|center]]

After selecting a file type and confirming, a MS Windows Explorer window opens where the user may add one or more files at the same time and then clicking on open to complete the process. The files are then added to the main table of the update sub-menu. Depending on the file type chosen, the files will appear under the appropriate folder.

====Delete Files====

In the '''Update''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Files. Selecting one or more files and clicking on it displays the following confirmation window.

Once the warning is confirmed, the selected files are removed from the Metis Smart Suite Update.

====Prepare Update====

After the desired file or files have been added to the update, the user can then begin to generate the update with the "Prepare Update" button [[File:MetisSmartModelingPrepareUpdateButton.PNG|link=]] button.

When selecting a file and clicking on this button, the user is presented with a pop-up window asking if they are sure that they want to run the update process.

The '''Preparing Update...''' window opens after confirming the pop-up. In this window the user is presented with a table with three columns including the '''Date''', '''Message''', and '''Status'''.

The '''Date''' columns list the date and time of the message given in the table, the '''Message''' column provides information to the user in the form of short messages indicating the current status of the update process, and the '''Status''' column is filled with either a green check-mark indicating successful step in the update process or a red x indicating an error in the update process. In the case of an error, a short notice will be displayed in the message column describing the error.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/5/5e/VID_preparing_update.png'>File:PreparingAnUpdateForOfflineInstallations_OK.mp4‎</mediaplayer>
| Preparing an update for offline installations.
}}

{{Warning
| In order for the update preparation and distribution to go through normally, it is required to define the update settings in the functionality profiles in the version in which the administrator works; and in the versions which are targeted by the update.

For the Metis Smart Quotes instances targeted by the update to receive the update it is of course necessary that the profiles define the correct update settings.
}}

== Licensing ==

(TBD)

Description of the Menu Versions

2014-01-15T13:11:55Z

PatrickG: /* Overview of versions */

As Metis Smart Suite can be rolled out in small to large organizations the software supports a versioning concepts. These feature allows it to be structured in a tree like schema. As the root of this tree there will always be the main delivered version of the application.

The branches from that tree will represent created version within the organization. As described in the figure below the headquarters of an organization is placed at the root of the tree, and all the country specific subsidiaries, for example, are shown as first child version (i.e. first level nodes). The leafs of the tree from a specific branch are for example partners within that country.

Within Metis Smart Suite a version is mainly described by its name and basic information, conditions, customer designation and directories which have to be used by it. Additionally '''[[Description of the Menu Profiles | Profiles]]''' of all types can be linked to a version in order to enforce default rights and privileges to all users which will be created in that version.

Versions are a key element of the Metis Smart Suite. This functionality allows the administrator to re-create the sales or legal structure of the company in which the software suite is being deployed. Additional examples of how this structure can support any organization can be found within the various screenshots of that section.

== Versions ==

Both Metis Smart Modeling users and administrators can create as many versions as required. As a reminder, versions that descend from a main version are classified as child versions. The main versions which create these child versions are classified as parent versions. This means that any single version may be a parent or child version, depending on the point of view.

[[File:IMG_Version_Concept.png|center|600x400px]]

=== Overview of versions ===

Users may add, delete, edit, and preview versions in this sub-menu. A search feature can be found on the left side and a main table containing general information is found in the working area.

In this table, the parent version (the currently logged-in version) is featured at the top with all its child versions listed below.
Versions in the main table may be represented by several different types of icons.

{| 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 Version
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Icon
! 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" |
'''Normal Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Standard Metis Smart Suite Version.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Version without Admin'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionNoAdminIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
There are no Users defined as administrator for this version. It depends entirely on the parent version's Administrator.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Inactive Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
[[File:MetisSmartModelingVersionInactiveIcon.png‎|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Version exists in the Metis Smart Suite Database, but has been disabled.
|-
|}

A lock icon may be found preceding any of these types of versions. The lock icon signifies that the version was not created in the version currently logged-in, but in another version or by an automated system.

[[File:MSM_Versions_Versions.png|center|600x400px]]

{{Note
| Imported versions which are denied access to certain items through profile groups, can never have access to these items even if they are given access through the use of additional profiles.

[take a screenshot of for example a system profile[title it "main profile"] with several check-boxes unticked and one["additional profile"] with the same check-boxes ticked, and then screenshot of additional profiles for profile groups for the user]
}}

{| 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 0 1px 0" | Description
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Version Specific Objects'''
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Available only in the version where created and in the child versions if access was granted.
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
*Employees
*Offices
*Positions
*Attributes
*Hierarchies
*Segments
*Price Groups
*Price Categories
*Documents
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Objects implicitly linked'''
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Allowed modifications which are done to part of an object (i.e. description) are then valid also for all child versions,
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
*Translations (descriptions all positions, attributes, hierarchies, prices, systems and languages)
*Data Management type objects
|-
|}

=== Managing versions ===

====Search====

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Versions based on various criterions. 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 disaplyed below/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

====Add====

In the '''Versions''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Version. When it is clicked, the '''Version''' creation window opens, it contains two different type of information. The first tab '''Version''' shows a table separated into several expandable sections with two columns, '''Designation''' which represents the type of field and '''Value''' which represents the data entered into that field. All those fields provides the detailed description of a version. Only the ones with the edit icon on the right-hand side of the table can be defined by the user. The other ones are either inheritance from the parent version or imported through a third-party system.

[[File:MSM_Versions_Versions_add_Versions.png|center|600x400px]]

{{Note
| Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field.
}}

When creating a new version, the fields in the versions tab can be edited in order to define the version.

'''''Main'''''

* Version: Name of the version.
* Administrator Free: Choose to make a version administrator free. By setting the version to be administration free, the fields under the Customer section become available.
* Nomad Gateway User: A nomad gateway user can be defined in this field.
* Use Parent documents: Choose to use parent documents for the current version.
* Second ID to display : Secondary ID for he version.
* Default currency : set the default currency to used for all offers created within this version.
* Role for client condition : Role which specifies which Address is taken to apply '''[[Description_of_the_Menu_Prices#Customer_Prices|Customer Prices]]'''.

'''''Conditions'''''

* GSP Discount: The global sales price discount. Entering a figure here for example 50.0, means that a discount of 50% will be factored into the global sales price for this version. The GSP Discount can only be defined for a version by the parent version.

'''''Customer'''''

* OrgID: Organization ID
* Name 1: Name of the customer contact.
* Name 2: Additional name field for a contact.
* Name 3: Additional name field for a contact.
* Address 1: Address of where the customer is located (i.e. street name)
* Address 2: Additional address field for the customer (i.e. building name).
* City Name: City of where the customer is located. A drop-down list of available cities can provided for selection (see Data Management)
* ZipCode: Zipcode for where the customer is located.
* Country: Country where the customer is located. A drop-down list of available countries can provided for selection (see Data Management).
* State: State in the country where the customer is located. A drop-down list of states can be provided for selection (see Data Management).

'''''Directories'''''

Directories may only be specified within the version currently logged-in to. Parent versions cannot choose the directory for child versions. When a directory has been specified, the folder path will be shown in the corresponding field.

* Exchange: link to a folder used for saving FQS files.
* Document: link to a folder used for saving documents that are related to offers.
* Order: link to a folder used for saving XML and SES files.
* Libraries: link to a folder used for software libraries.

'''Profiles'''

'''[[Description of the Menu Profiles | Profiles]]''' are set to a version by the parent of that version in the section '''From Creator'''. Versions that have been automatically created by importation have their profiles also automatically set and cannot have their profiles edited.

However, additional profiles can be given to these versions in the section '''From parent'''. The '''Form parent''' section is only visible for these automatically created versions. To the right of the edit icon column is another column that has an eye for an icon.

Clicking on this eye lets the user see what items are defined by the current profile. Meaning that if the system profile "Default systems" was selected, doing so will display which systems are available in this profile.

[[File:MSM_Versions_Versions_add_profiles.png|center|600x400px]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/d/d2/VID_AdditionalProfilesConcept.PNG'>File:Additional_Profiles_OK.mp4‎</mediaplayer>
| Managing additional Profiles in versions.
}}

'''''From Creator'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

'''''From Parent'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

====Edit====

In the '''Versions''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version. Selecting a version and clicking on it opens the '''Version''' edition window where all related properties and information can be edited.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Version. Modifications applied to the selected version will only be saved once the version edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

[[File:MSM_Versions_Versions_Edit_Version.png|center|600x400px]]

====Delete====

In the '''Version''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Version. Selecting a version and clicking on it displays the following confirmation window.

[[File:MSM_Versions_Versions_delete_2.png|center]]

Once the warning is confirmed, the selected version is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| It is not possible to delete a version unless logged-in to the version that created it.

[[File:MSM_Versions_Versions_delete.png|center]]

}}

====Preview====

In the '''Versions''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected version. Selecting a version from the list and clicking on it opens the '''Version''' preview window.

[[File:MSM_Versions_Versions_Preview_profile.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 ... .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In the rightmost column of the table displayed in the '''Version''' preview window, the icon representing an eye can be used to display the list Systems, Hierarchies, Price Categories, Attributes, Variants, Service Models and Tax Models which have been set for the various profiles. No edition is possible.

==== Version without Administrator ====

As stated in the name, version without administrator is a Metis Smart Suite Version which doesn't include an administrator. This type of version is mainly used when no direct maintenance is required on the version level or when it is simply not wished to let the version be maintained individually.

A version without administrator is always created and maintained by its parent version.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/f/fe/VID_VersionNoAdmin.png'>File:Setting_a_version_without_an_administrator_OK.mp4‎</mediaplayer>
| Setting up a version without an administrator.
}}

== Access ==

From this sub-menu, the administrator can define and manage the access between the various children versions, as shown in the following example:

[[File:MSM_Versions_Access.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find versions based on various criterion. The search is triggered by typing a keyword or only a letter in the field 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 list.

=== Editing a Version's Rights ===

In the '''Version Rights''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version Right. Selecting a version right and clicking on it opens the '''Version Rights''' edition window where all related properties and information can be edited.

[[File:MSM_Versions_Access_Edit.png|center|600x400px]]

{{Note
| The title on the window displays the name of selected version (e.g. Version Rights Headquarters where Headquarters is the name of the selected version).
}}

The Versions (Smart Quotes) table displays all the available versions. The displayed versions consist of all of the children versions of the administrator's version. The authorized column allows the administrator to select / deselect the versions that the Smart Quotes users is authorized to access to. The following example describes the cases where a version can have access to the projects and offers made in other versions:

[[File:MetisSmartModelingVersionsProfileDiagram.PNG]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/a/a3/VID_Manage_the_version_access.png'>File:Managing_the_access_of_versions_OK.mp4‎</mediaplayer>
| Managing version access.
}}

An administrator of Version A can define that the Version A users can have access to the direct children versions' projects and offers (i.e. Version B, Version C and Version D). However, Version A users cannot access Version E's projects and offers because Version E is not a direct child of Version A.

The administrator of Version A can also define that Version B users can have access to Version C's projects and offers but not to Version D's projects and offer. The same administrator could also define that Version C users can only have access to Version B's projects and offers.

The authorization is not bi-directional: if Version B users have access to Version C's projects and offers, Version C users do not automatically receive access to Version B's projects and offers. The administrator must set the authorizations for each version.

=== Previewing a Version's Rights ===

In the '''Version Access''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Version Rights. Selecting a Version Right from the table/list and clicking on it opens the '''Version Rights''' preview window.

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

For detailed descriptions of all information available in this window please refer to the section dedicated to the edition of a version right .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In this window, only the authorized versions are displayed. This means that if a version is not authorized to see the projects or the offers or at least one other version, the table is empty as shown in the following example:

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

== Languages ==

Metis Smart Suite supports the use of multiple languages for single roll-outs of the application. Different languages can then be used to translate the [[Metis_Smart_Modeling_-_Setup|User Interface]] and/or the objects created in Metis Smart Modeling, the documents generated by Metis Smart Quotes or the Notes provided by the End-Users In this menu, the administrator defines the languages that the Metis Smart Modeling and Metis Smart Quote users are authorized to use.

{{Warning
| The administrator can define a maximum of four languages per version.
}}

Languages defined in this menu are then made available in the following parts of Metis:

* when a designation is required for an item (e.g. a language, a [[Description_of_the_Menu_Positions|position]], an [[Metis_Smart_Modeling_-_Attributes|attribute]] etc.), the designation may be entered for all the languages that have been made available.

* In the [[Description_of_the_Menu_Users|Users]] menu when defining a user's main language

* In the [[Description of the Sub-Menu Functionalities#Languages tab | Profiles]] menu when setting a default language for a functionality profile.

* In the [[Metis_Smart_Modeling_-_Setup|Setup]] menu when selecting the User Interface language for the application.

* In various part of Metis Smart Quotes as when creating a contact.

{{Note
| The designations in the other languages are used in the case where a designation is missing for the language in which the user is currently working with (see the [[#Priority| Priority]] section below).
}}

=== Adding a New Language ===

Before adding or creating a language, the administrator has to make sure that the maximum number of languages per version is not reached. A click on the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] displays the following window:

[[File:MetisSmartModelingAddLangageSelection.PNG|center|300x350px]]

The administrator can either add an existing language or create a new language.

==== Adding an Existing Language ====

If the administrator chooses to add an existing language, the following window appears after selecting the "Add available language" option:

[[File:MetisSmartModelingLanguageAddExistingLanguage.PNG|center|600x400px]]

The contents of this window is non editable.

The window contains the list of all the available languages. These languages can come from one of the following sources:
* an ascendant version
* the current version
* a descendant version

The first three columns of the window (Flag, Code and Designation) show the country flag, the language code and the language designation. The last column (Version) indicates the version in which the language has been created.

To add a language to the current version, select a language then click on the OK icon. The Languages menu is displayed again with the added language(s). In the language selection menu, it is possible to select several languages at the same time. If the administrator tries to select too many languages and exceeds the 4 authorized languages per version, a pop up window appears. If the user tries to select a language that has already been made available for the current version, a pop up window appears.

==== Creating a New Language ====

If the administrator chooses to create a new language, the following window appears after selecting the "Create a new language" option:

[[File:MetisSmartModelingLanguageAddNewLanguage.PNG|center|600x400px]]

The properties of the language must be provided, that is to say:
* a picture representing the country flag
* a language code (preferably the ISO code)
* a designation
* a translation for each language that has already been made available by the administrator

The language code field is mandatory in order to save the language. This field is limited to four characters and cannot be changed afterwards.

{{Note
| It is highly recommended to use the [http://www.iso.org/iso/english_country_names_and_code_elements official ISO country code].
}}

To define a picture representing the country flag for the language, click on the frame located on the top right side. A window opens as shown in the following example:

[[File:MetisSmartModelingLanguageAddFlagIcon.PNG|center|300x350px]]

The window contains the pictures that have been previously uploaded in the '''[[Description_of_the_Sub-Menu_Cliparts | Cliparts]]''' menu.

The language designation is limited to 30 characters and is mandatory.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/0/0b/VID_Creating_a_language.png'>File:Creating_a_language_OK.mp4‎</mediaplayer>
| Creating a language.
}}

For each language that has already been made available by the administrator, a designation should be provided. This designation should be the name of the created language translated into the other language (e.g. "Russian" in English, "Russe" in French, "Russisch" in German etc.).

=== Editing a Language ===

In the '''Languages''' 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 Language. Selecting a Language and clicking on it opens the '''Languages''' edition window where all related properties and information can be edited.

[[File:MetisSmartModelingLanguageEdit.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the country flag
* an ISO language code
* designation
* the designation of the language (for each language that has been made available by the administrator)

If the administrator is not the owner of the language (i.e. the language has been created in another version), it is only possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator). The language code and the picture cannot be edited.

If the administrator is the owner of the language, it is possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator) and the picture representing the country flag. The language code cannot be edited.

=== Preview ===

In the '''Languages''' 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 Language. Selecting a language from the table and clicking on it opens the '''Languages''' preview window.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Language.

[[File:MetisSmartModelingLanguagePreview.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the flag
* an ISO language code
* a designation
* the designation of the language (for each language that has been made available by the administrator)

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

=== Priority ===

The order in which the languages are displayed correspond to the language priority order. This order is considered when a description is missing for an item. When a description is missing, Metis looks for the item description in the other available languages and displays this description. This means that if the description of an item is missing in the first language, Metis displays the description in the second language if it exists. If not, the description in the third language is displayed and so on.

The priority can be modified by clicking on the ''Priority'' button. The following window appears:

[[File:MetisSmartModelingLanguagePriority.PNG|center|300x350px]]

The table is populated with the languages that have been defined for the current version. The contents of the table cannot be edited. The priority order of the language can be defined using the up and down arrows on the right of the table. The language at the top of the table has the highest priority. The language at the bottom of the table has the lowest priority.

=== Deleting a Language ===

In the '''Languages''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Language. Selecting a Language and clicking on it displays the following confirmation window, if the version has been manually created (i.e. no lock) or is owned by the current version, a confirmation window appears.

Once the warning is confirmed, the selected Language is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| If all the languages are deleted, Metis proposes by default English as the language of the version.
}}

{{Note
| If the language is owned by another version (i.e. presence of a lock), the language cannot be deleted.

[[File:MSM_Versions_Languages_Languages_Delete.png|center]]

}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/e/eb/VID_managing_the_languages_of_a_version.png'>File:Managing_languages_OK.mp4‎</mediaplayer>
| Managing languages of a version.
}}

== Update ==

The Metis Smart Suite update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.

=== Update process Overview ===

In order for this process to efficiently distribute all that information, the functionality works based on the diagram below.

[[File:IMG_Update_Process.png|center|600x400px]]

All update related settings, information and files are bundled together within Metis Smart Suite and sent to a web-service hosted on a web-server. The local instances of Metis Smart Quotes then inquires this service for available updates and notifies the user. If validated, the update takes places and the application will be restarted.

=== Preparing Metis Smart Quotes Updates ===

The update sub-menu is used to prepare updates for offline versions of the Metis Smart Quotes. By default an update which will be created here will include the various databases required by the applications. The update preparation tool in Metis Smart Modeling can be used to fine tune this update. The first type of additional information which can be included in an update are files. The concept is that throughout the settings, external files could be required by Metis Smart Quotes in order to provide to the end-user different information. For example, in the [[Description_of_the_Sub-Menu_Notes|Notes]] menu of the software, the various note types allow the user to import default texts in the note. Those default texts need to be distributed and linked to the application. In the definition of the note setting the administrator sets up a link to a folder where those templates will be stored. When creating the update the idea is to list those templates and define where they will be placed within the local instance of the application. Therefore, the link defined within the profile will also be set in the "destination folder" column of the update preparation.

[[File:MSM_Versions_Uptdate.png|center|600x400px]]

In the update sub-menu the main working area is dedicated to a table with the following columns:

*'''Source File Name''': The name of the original file found under either the "Common Files" or "Specific Files" folder depending on the choice made.
*'''Dest. Folder''': An editable field where the user can enter the destination folder for the file after being updated.
*'''Dest. Filename''': An editable field where the user can enter a new name for the file after being distributed.
*'''File Date''': The date the original file was created.
*'''Behavior''': Describes what will happen once the update has been executed. A drop-down menu with three different options is found in this column.
**Overwite if more recent: The file will be replaced with a more recent version if one is available.
**Ignore if already existing: The file will remain untouched if it is found to already exist.
**Force overwrite: The file will be replaced no matter what the case.

Updates must be prepared in online mode. The purpose of the update process is that when updating a version, the update will automatically be available to the offline users of the version as well as the offline users of the child versions.

Updates may be available for online and offline versions of MSQ. Only the information owned by a version may be used for updates. Data which is owned by a version means data which has been created by the administrator of that version.

For example, on the diagram, the HQ version is the parent of the versions ENG, FRA, GER, JPN, and USA. USA is the parent of the versions NY and WA. This means that NY and WA are the grandchildren of the HQ version.

If an administrator of the HQ version prepares an update, the offline users of the HQ, ENG, FRA, GER, JPN, USA, NY and WA versions also receive the update.

If an administrator of the USA version prepares an update, the versions HQ, ENG, FRA, GER and JPN do not receive the update. Only the USA version and the child versions of USA receive it.

[[File:IMG_Version_Concept.png|center|600x400px]]

====Add Files====

Clicking on the "Add Files" button [[File:MetisSmartModelingCurrentlyAddFilesButton.PNG|link=]] opens a window that asks the user which type of files they wish to add, either '''Common Files''' or '''Specific Files'''. Common files are files which will be distributed to the selected version and its child versions after the update process. Specific files are files which will only be distributed to the selected version when preparing an update. The child versions will not receive the file after the update process.

[[File:MSM_Versions_Update_Add_Files.png|center]]

After selecting a file type and confirming, a MS Windows Explorer window opens where the user may add one or more files at the same time and then clicking on open to complete the process. The files are then added to the main table of the update sub-menu. Depending on the file type chosen, the files will appear under the appropriate folder.

====Delete Files====

In the '''Update''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Files. Selecting one or more files and clicking on it displays the following confirmation window.

Once the warning is confirmed, the selected files are removed from the Metis Smart Suite Update.

====Prepare Update====

After the desired file or files have been added to the update, the user can then begin to generate the update with the "Prepare Update" button [[File:MetisSmartModelingPrepareUpdateButton.PNG|link=]] button.

When selecting a file and clicking on this button, the user is presented with a pop-up window asking if they are sure that they want to run the update process.

The '''Preparing Update...''' window opens after confirming the pop-up. In this window the user is presented with a table with three columns including the '''Date''', '''Message''', and '''Status'''.

The '''Date''' columns list the date and time of the message given in the table, the '''Message''' column provides information to the user in the form of short messages indicating the current status of the update process, and the '''Status''' column is filled with either a green check-mark indicating successful step in the update process or a red x indicating an error in the update process. In the case of an error, a short notice will be displayed in the message column describing the error.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/5/5e/VID_preparing_update.png'>File:PreparingAnUpdateForOfflineInstallations_OK.mp4‎</mediaplayer>
| Preparing an update for offline installations.
}}

{{Warning
| In order for the update preparation and distribution to go through normally, it is required to define the update settings in the functionality profiles in the version in which the administrator works; and in the versions which are targeted by the update.

For the Metis Smart Quotes instances targeted by the update to receive the update it is of course necessary that the profiles define the correct update settings.
}}

== Licensing ==

(TBD)

Description of the Menu Versions

2014-01-15T13:11:05Z

PatrickG: /* Overview of versions */

As Metis Smart Suite can be rolled out in small to large organizations the software supports a versioning concepts. These feature allows it to be structured in a tree like schema. As the root of this tree there will always be the main delivered version of the application.

The branches from that tree will represent created version within the organization. As described in the figure below the headquarters of an organization is placed at the root of the tree, and all the country specific subsidiaries, for example, are shown as first child version (i.e. first level nodes). The leafs of the tree from a specific branch are for example partners within that country.

Within Metis Smart Suite a version is mainly described by its name and basic information, conditions, customer designation and directories which have to be used by it. Additionally '''[[Description of the Menu Profiles | Profiles]]''' of all types can be linked to a version in order to enforce default rights and privileges to all users which will be created in that version.

Versions are a key element of the Metis Smart Suite. This functionality allows the administrator to re-create the sales or legal structure of the company in which the software suite is being deployed. Additional examples of how this structure can support any organization can be found within the various screenshots of that section.

== Versions ==

Both Metis Smart Modeling users and administrators can create as many versions as required. As a reminder, versions that descend from a main version are classified as child versions. The main versions which create these child versions are classified as parent versions. This means that any single version may be a parent or child version, depending on the point of view.

[[File:IMG_Version_Concept.png|center|600x400px]]

=== Overview of versions ===

Users may add, delete, edit, and preview versions in this sub-menu. A search feature can be found on the left side and a main table containing general information is found in the working area.

In this table, the parent version (the currently logged-in version) is featured at the top with all its child versions listed below.
Versions in the main table may be represented by several different types of icons.

{| 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 Version
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Icon
! 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" |
'''Normal Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Standard Metis Smart Suite Version.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Version without Admin'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionNoAdminIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
There are no Users defined as administrator for this version. It depends entirely on the parent version's Administrator.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Inactive Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
[[File:MetisSmartModelingVersionInactiveIcon.png‎|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Version exists in the Metis Smart Suite Database, but has been disabled.
|-
|}

A lock icon may be found preceding any of these types of versions. The lock icon signifies that the version was not created in the version currently logged-in, but in another version or by an automated system.

[[File:MSM_Versions_Versions.png|center|600x400px]]

{{Note
| Imported versions which are denied access to certain items through profile groups, can never have access to these items even if they are given access through the use of additional profiles.

[take a screenshot of for example a system profile[title it "main profile"] with several check-boxes unticked and one["additional profile"] with the same check-boxes ticked, and then screenshot of additional profiles for profile groups for the user]
}}

{| 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 0 1px 0" | Description
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Version Specific Objects'''
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Available only in the version where created and in the child versions if access was granted.
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Employees
Offices
Positions
Attributes
Hierarchies
Segments
Price Groups
Price Categories
Documents
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Objects implicitly linked'''
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Allowed modifications which are done to part of an object (i.e. description) are then valid also for all child versions,
|-
| width="25%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
| width="75%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Translations (descriptions all positions, attributes, hierarchies, prices, systems and languages)
Data Management type objects
|-
|}

=== Managing versions ===

====Search====

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Versions based on various criterions. 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 disaplyed below/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

====Add====

In the '''Versions''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Version. When it is clicked, the '''Version''' creation window opens, it contains two different type of information. The first tab '''Version''' shows a table separated into several expandable sections with two columns, '''Designation''' which represents the type of field and '''Value''' which represents the data entered into that field. All those fields provides the detailed description of a version. Only the ones with the edit icon on the right-hand side of the table can be defined by the user. The other ones are either inheritance from the parent version or imported through a third-party system.

[[File:MSM_Versions_Versions_add_Versions.png|center|600x400px]]

{{Note
| Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field.
}}

When creating a new version, the fields in the versions tab can be edited in order to define the version.

'''''Main'''''

* Version: Name of the version.
* Administrator Free: Choose to make a version administrator free. By setting the version to be administration free, the fields under the Customer section become available.
* Nomad Gateway User: A nomad gateway user can be defined in this field.
* Use Parent documents: Choose to use parent documents for the current version.
* Second ID to display : Secondary ID for he version.
* Default currency : set the default currency to used for all offers created within this version.
* Role for client condition : Role which specifies which Address is taken to apply '''[[Description_of_the_Menu_Prices#Customer_Prices|Customer Prices]]'''.

'''''Conditions'''''

* GSP Discount: The global sales price discount. Entering a figure here for example 50.0, means that a discount of 50% will be factored into the global sales price for this version. The GSP Discount can only be defined for a version by the parent version.

'''''Customer'''''

* OrgID: Organization ID
* Name 1: Name of the customer contact.
* Name 2: Additional name field for a contact.
* Name 3: Additional name field for a contact.
* Address 1: Address of where the customer is located (i.e. street name)
* Address 2: Additional address field for the customer (i.e. building name).
* City Name: City of where the customer is located. A drop-down list of available cities can provided for selection (see Data Management)
* ZipCode: Zipcode for where the customer is located.
* Country: Country where the customer is located. A drop-down list of available countries can provided for selection (see Data Management).
* State: State in the country where the customer is located. A drop-down list of states can be provided for selection (see Data Management).

'''''Directories'''''

Directories may only be specified within the version currently logged-in to. Parent versions cannot choose the directory for child versions. When a directory has been specified, the folder path will be shown in the corresponding field.

* Exchange: link to a folder used for saving FQS files.
* Document: link to a folder used for saving documents that are related to offers.
* Order: link to a folder used for saving XML and SES files.
* Libraries: link to a folder used for software libraries.

'''Profiles'''

'''[[Description of the Menu Profiles | Profiles]]''' are set to a version by the parent of that version in the section '''From Creator'''. Versions that have been automatically created by importation have their profiles also automatically set and cannot have their profiles edited.

However, additional profiles can be given to these versions in the section '''From parent'''. The '''Form parent''' section is only visible for these automatically created versions. To the right of the edit icon column is another column that has an eye for an icon.

Clicking on this eye lets the user see what items are defined by the current profile. Meaning that if the system profile "Default systems" was selected, doing so will display which systems are available in this profile.

[[File:MSM_Versions_Versions_add_profiles.png|center|600x400px]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/d/d2/VID_AdditionalProfilesConcept.PNG'>File:Additional_Profiles_OK.mp4‎</mediaplayer>
| Managing additional Profiles in versions.
}}

'''''From Creator'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

'''''From Parent'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

====Edit====

In the '''Versions''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version. Selecting a version and clicking on it opens the '''Version''' edition window where all related properties and information can be edited.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Version. Modifications applied to the selected version will only be saved once the version edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

[[File:MSM_Versions_Versions_Edit_Version.png|center|600x400px]]

====Delete====

In the '''Version''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Version. Selecting a version and clicking on it displays the following confirmation window.

[[File:MSM_Versions_Versions_delete_2.png|center]]

Once the warning is confirmed, the selected version is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| It is not possible to delete a version unless logged-in to the version that created it.

[[File:MSM_Versions_Versions_delete.png|center]]

}}

====Preview====

In the '''Versions''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected version. Selecting a version from the list and clicking on it opens the '''Version''' preview window.

[[File:MSM_Versions_Versions_Preview_profile.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 ... .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In the rightmost column of the table displayed in the '''Version''' preview window, the icon representing an eye can be used to display the list Systems, Hierarchies, Price Categories, Attributes, Variants, Service Models and Tax Models which have been set for the various profiles. No edition is possible.

==== Version without Administrator ====

As stated in the name, version without administrator is a Metis Smart Suite Version which doesn't include an administrator. This type of version is mainly used when no direct maintenance is required on the version level or when it is simply not wished to let the version be maintained individually.

A version without administrator is always created and maintained by its parent version.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/f/fe/VID_VersionNoAdmin.png'>File:Setting_a_version_without_an_administrator_OK.mp4‎</mediaplayer>
| Setting up a version without an administrator.
}}

== Access ==

From this sub-menu, the administrator can define and manage the access between the various children versions, as shown in the following example:

[[File:MSM_Versions_Access.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find versions based on various criterion. The search is triggered by typing a keyword or only a letter in the field 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 list.

=== Editing a Version's Rights ===

In the '''Version Rights''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version Right. Selecting a version right and clicking on it opens the '''Version Rights''' edition window where all related properties and information can be edited.

[[File:MSM_Versions_Access_Edit.png|center|600x400px]]

{{Note
| The title on the window displays the name of selected version (e.g. Version Rights Headquarters where Headquarters is the name of the selected version).
}}

The Versions (Smart Quotes) table displays all the available versions. The displayed versions consist of all of the children versions of the administrator's version. The authorized column allows the administrator to select / deselect the versions that the Smart Quotes users is authorized to access to. The following example describes the cases where a version can have access to the projects and offers made in other versions:

[[File:MetisSmartModelingVersionsProfileDiagram.PNG]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/a/a3/VID_Manage_the_version_access.png'>File:Managing_the_access_of_versions_OK.mp4‎</mediaplayer>
| Managing version access.
}}

An administrator of Version A can define that the Version A users can have access to the direct children versions' projects and offers (i.e. Version B, Version C and Version D). However, Version A users cannot access Version E's projects and offers because Version E is not a direct child of Version A.

The administrator of Version A can also define that Version B users can have access to Version C's projects and offers but not to Version D's projects and offer. The same administrator could also define that Version C users can only have access to Version B's projects and offers.

The authorization is not bi-directional: if Version B users have access to Version C's projects and offers, Version C users do not automatically receive access to Version B's projects and offers. The administrator must set the authorizations for each version.

=== Previewing a Version's Rights ===

In the '''Version Access''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Version Rights. Selecting a Version Right from the table/list and clicking on it opens the '''Version Rights''' preview window.

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

For detailed descriptions of all information available in this window please refer to the section dedicated to the edition of a version right .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In this window, only the authorized versions are displayed. This means that if a version is not authorized to see the projects or the offers or at least one other version, the table is empty as shown in the following example:

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

== Languages ==

Metis Smart Suite supports the use of multiple languages for single roll-outs of the application. Different languages can then be used to translate the [[Metis_Smart_Modeling_-_Setup|User Interface]] and/or the objects created in Metis Smart Modeling, the documents generated by Metis Smart Quotes or the Notes provided by the End-Users In this menu, the administrator defines the languages that the Metis Smart Modeling and Metis Smart Quote users are authorized to use.

{{Warning
| The administrator can define a maximum of four languages per version.
}}

Languages defined in this menu are then made available in the following parts of Metis:

* when a designation is required for an item (e.g. a language, a [[Description_of_the_Menu_Positions|position]], an [[Metis_Smart_Modeling_-_Attributes|attribute]] etc.), the designation may be entered for all the languages that have been made available.

* In the [[Description_of_the_Menu_Users|Users]] menu when defining a user's main language

* In the [[Description of the Sub-Menu Functionalities#Languages tab | Profiles]] menu when setting a default language for a functionality profile.

* In the [[Metis_Smart_Modeling_-_Setup|Setup]] menu when selecting the User Interface language for the application.

* In various part of Metis Smart Quotes as when creating a contact.

{{Note
| The designations in the other languages are used in the case where a designation is missing for the language in which the user is currently working with (see the [[#Priority| Priority]] section below).
}}

=== Adding a New Language ===

Before adding or creating a language, the administrator has to make sure that the maximum number of languages per version is not reached. A click on the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] displays the following window:

[[File:MetisSmartModelingAddLangageSelection.PNG|center|300x350px]]

The administrator can either add an existing language or create a new language.

==== Adding an Existing Language ====

If the administrator chooses to add an existing language, the following window appears after selecting the "Add available language" option:

[[File:MetisSmartModelingLanguageAddExistingLanguage.PNG|center|600x400px]]

The contents of this window is non editable.

The window contains the list of all the available languages. These languages can come from one of the following sources:
* an ascendant version
* the current version
* a descendant version

The first three columns of the window (Flag, Code and Designation) show the country flag, the language code and the language designation. The last column (Version) indicates the version in which the language has been created.

To add a language to the current version, select a language then click on the OK icon. The Languages menu is displayed again with the added language(s). In the language selection menu, it is possible to select several languages at the same time. If the administrator tries to select too many languages and exceeds the 4 authorized languages per version, a pop up window appears. If the user tries to select a language that has already been made available for the current version, a pop up window appears.

==== Creating a New Language ====

If the administrator chooses to create a new language, the following window appears after selecting the "Create a new language" option:

[[File:MetisSmartModelingLanguageAddNewLanguage.PNG|center|600x400px]]

The properties of the language must be provided, that is to say:
* a picture representing the country flag
* a language code (preferably the ISO code)
* a designation
* a translation for each language that has already been made available by the administrator

The language code field is mandatory in order to save the language. This field is limited to four characters and cannot be changed afterwards.

{{Note
| It is highly recommended to use the [http://www.iso.org/iso/english_country_names_and_code_elements official ISO country code].
}}

To define a picture representing the country flag for the language, click on the frame located on the top right side. A window opens as shown in the following example:

[[File:MetisSmartModelingLanguageAddFlagIcon.PNG|center|300x350px]]

The window contains the pictures that have been previously uploaded in the '''[[Description_of_the_Sub-Menu_Cliparts | Cliparts]]''' menu.

The language designation is limited to 30 characters and is mandatory.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/0/0b/VID_Creating_a_language.png'>File:Creating_a_language_OK.mp4‎</mediaplayer>
| Creating a language.
}}

For each language that has already been made available by the administrator, a designation should be provided. This designation should be the name of the created language translated into the other language (e.g. "Russian" in English, "Russe" in French, "Russisch" in German etc.).

=== Editing a Language ===

In the '''Languages''' 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 Language. Selecting a Language and clicking on it opens the '''Languages''' edition window where all related properties and information can be edited.

[[File:MetisSmartModelingLanguageEdit.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the country flag
* an ISO language code
* designation
* the designation of the language (for each language that has been made available by the administrator)

If the administrator is not the owner of the language (i.e. the language has been created in another version), it is only possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator). The language code and the picture cannot be edited.

If the administrator is the owner of the language, it is possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator) and the picture representing the country flag. The language code cannot be edited.

=== Preview ===

In the '''Languages''' 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 Language. Selecting a language from the table and clicking on it opens the '''Languages''' preview window.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Language.

[[File:MetisSmartModelingLanguagePreview.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the flag
* an ISO language code
* a designation
* the designation of the language (for each language that has been made available by the administrator)

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

=== Priority ===

The order in which the languages are displayed correspond to the language priority order. This order is considered when a description is missing for an item. When a description is missing, Metis looks for the item description in the other available languages and displays this description. This means that if the description of an item is missing in the first language, Metis displays the description in the second language if it exists. If not, the description in the third language is displayed and so on.

The priority can be modified by clicking on the ''Priority'' button. The following window appears:

[[File:MetisSmartModelingLanguagePriority.PNG|center|300x350px]]

The table is populated with the languages that have been defined for the current version. The contents of the table cannot be edited. The priority order of the language can be defined using the up and down arrows on the right of the table. The language at the top of the table has the highest priority. The language at the bottom of the table has the lowest priority.

=== Deleting a Language ===

In the '''Languages''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Language. Selecting a Language and clicking on it displays the following confirmation window, if the version has been manually created (i.e. no lock) or is owned by the current version, a confirmation window appears.

Once the warning is confirmed, the selected Language is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| If all the languages are deleted, Metis proposes by default English as the language of the version.
}}

{{Note
| If the language is owned by another version (i.e. presence of a lock), the language cannot be deleted.

[[File:MSM_Versions_Languages_Languages_Delete.png|center]]

}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/e/eb/VID_managing_the_languages_of_a_version.png'>File:Managing_languages_OK.mp4‎</mediaplayer>
| Managing languages of a version.
}}

== Update ==

The Metis Smart Suite update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.

=== Update process Overview ===

In order for this process to efficiently distribute all that information, the functionality works based on the diagram below.

[[File:IMG_Update_Process.png|center|600x400px]]

All update related settings, information and files are bundled together within Metis Smart Suite and sent to a web-service hosted on a web-server. The local instances of Metis Smart Quotes then inquires this service for available updates and notifies the user. If validated, the update takes places and the application will be restarted.

=== Preparing Metis Smart Quotes Updates ===

The update sub-menu is used to prepare updates for offline versions of the Metis Smart Quotes. By default an update which will be created here will include the various databases required by the applications. The update preparation tool in Metis Smart Modeling can be used to fine tune this update. The first type of additional information which can be included in an update are files. The concept is that throughout the settings, external files could be required by Metis Smart Quotes in order to provide to the end-user different information. For example, in the [[Description_of_the_Sub-Menu_Notes|Notes]] menu of the software, the various note types allow the user to import default texts in the note. Those default texts need to be distributed and linked to the application. In the definition of the note setting the administrator sets up a link to a folder where those templates will be stored. When creating the update the idea is to list those templates and define where they will be placed within the local instance of the application. Therefore, the link defined within the profile will also be set in the "destination folder" column of the update preparation.

[[File:MSM_Versions_Uptdate.png|center|600x400px]]

In the update sub-menu the main working area is dedicated to a table with the following columns:

*'''Source File Name''': The name of the original file found under either the "Common Files" or "Specific Files" folder depending on the choice made.
*'''Dest. Folder''': An editable field where the user can enter the destination folder for the file after being updated.
*'''Dest. Filename''': An editable field where the user can enter a new name for the file after being distributed.
*'''File Date''': The date the original file was created.
*'''Behavior''': Describes what will happen once the update has been executed. A drop-down menu with three different options is found in this column.
**Overwite if more recent: The file will be replaced with a more recent version if one is available.
**Ignore if already existing: The file will remain untouched if it is found to already exist.
**Force overwrite: The file will be replaced no matter what the case.

Updates must be prepared in online mode. The purpose of the update process is that when updating a version, the update will automatically be available to the offline users of the version as well as the offline users of the child versions.

Updates may be available for online and offline versions of MSQ. Only the information owned by a version may be used for updates. Data which is owned by a version means data which has been created by the administrator of that version.

For example, on the diagram, the HQ version is the parent of the versions ENG, FRA, GER, JPN, and USA. USA is the parent of the versions NY and WA. This means that NY and WA are the grandchildren of the HQ version.

If an administrator of the HQ version prepares an update, the offline users of the HQ, ENG, FRA, GER, JPN, USA, NY and WA versions also receive the update.

If an administrator of the USA version prepares an update, the versions HQ, ENG, FRA, GER and JPN do not receive the update. Only the USA version and the child versions of USA receive it.

[[File:IMG_Version_Concept.png|center|600x400px]]

====Add Files====

Clicking on the "Add Files" button [[File:MetisSmartModelingCurrentlyAddFilesButton.PNG|link=]] opens a window that asks the user which type of files they wish to add, either '''Common Files''' or '''Specific Files'''. Common files are files which will be distributed to the selected version and its child versions after the update process. Specific files are files which will only be distributed to the selected version when preparing an update. The child versions will not receive the file after the update process.

[[File:MSM_Versions_Update_Add_Files.png|center]]

After selecting a file type and confirming, a MS Windows Explorer window opens where the user may add one or more files at the same time and then clicking on open to complete the process. The files are then added to the main table of the update sub-menu. Depending on the file type chosen, the files will appear under the appropriate folder.

====Delete Files====

In the '''Update''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Files. Selecting one or more files and clicking on it displays the following confirmation window.

Once the warning is confirmed, the selected files are removed from the Metis Smart Suite Update.

====Prepare Update====

After the desired file or files have been added to the update, the user can then begin to generate the update with the "Prepare Update" button [[File:MetisSmartModelingPrepareUpdateButton.PNG|link=]] button.

When selecting a file and clicking on this button, the user is presented with a pop-up window asking if they are sure that they want to run the update process.

The '''Preparing Update...''' window opens after confirming the pop-up. In this window the user is presented with a table with three columns including the '''Date''', '''Message''', and '''Status'''.

The '''Date''' columns list the date and time of the message given in the table, the '''Message''' column provides information to the user in the form of short messages indicating the current status of the update process, and the '''Status''' column is filled with either a green check-mark indicating successful step in the update process or a red x indicating an error in the update process. In the case of an error, a short notice will be displayed in the message column describing the error.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/5/5e/VID_preparing_update.png'>File:PreparingAnUpdateForOfflineInstallations_OK.mp4‎</mediaplayer>
| Preparing an update for offline installations.
}}

{{Warning
| In order for the update preparation and distribution to go through normally, it is required to define the update settings in the functionality profiles in the version in which the administrator works; and in the versions which are targeted by the update.

For the Metis Smart Quotes instances targeted by the update to receive the update it is of course necessary that the profiles define the correct update settings.
}}

== Licensing ==

(TBD)

Description of the Menu Versions

2014-01-15T13:04:01Z

PatrickG: /* Versions */

As Metis Smart Suite can be rolled out in small to large organizations the software supports a versioning concepts. These feature allows it to be structured in a tree like schema. As the root of this tree there will always be the main delivered version of the application.

The branches from that tree will represent created version within the organization. As described in the figure below the headquarters of an organization is placed at the root of the tree, and all the country specific subsidiaries, for example, are shown as first child version (i.e. first level nodes). The leafs of the tree from a specific branch are for example partners within that country.

Within Metis Smart Suite a version is mainly described by its name and basic information, conditions, customer designation and directories which have to be used by it. Additionally '''[[Description of the Menu Profiles | Profiles]]''' of all types can be linked to a version in order to enforce default rights and privileges to all users which will be created in that version.

Versions are a key element of the Metis Smart Suite. This functionality allows the administrator to re-create the sales or legal structure of the company in which the software suite is being deployed. Additional examples of how this structure can support any organization can be found within the various screenshots of that section.

== Versions ==

Both Metis Smart Modeling users and administrators can create as many versions as required. As a reminder, versions that descend from a main version are classified as child versions. The main versions which create these child versions are classified as parent versions. This means that any single version may be a parent or child version, depending on the point of view.

[[File:IMG_Version_Concept.png|center|600x400px]]

=== Overview of versions ===

Users may add, delete, edit, and preview versions in this sub-menu. A search feature can be found on the left side and a main table containing general information is found in the working area.

In this table, the parent version (the currently logged-in version) is featured at the top with all its child versions listed below.
Versions in the main table may be represented by several different types of icons.

{| 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 Version
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Icon
! 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" |
'''Normal Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Standard Metis Smart Suite Version.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Version without Admin'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionNoAdminIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
There are no Users defined as administrator for this version. It depends entirely on the parent version's Administrator.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Inactive Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
[[File:MetisSmartModelingVersionInactiveIcon.png‎|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Version exists in the Metis Smart Suite Database, but has been disabled.
|-
|}

A lock icon may be found preceding any of these types of versions. The lock icon signifies that the version was not created in the version currently logged-in, but in another version or by an automated system.

[[File:MSM_Versions_Versions.png|center|600x400px]]

{{Note
| Imported versions which are denied access to certain items through profile groups, can never have access to these items even if they are given access through the use of additional profiles.

[take a screenshot of for example a system profile[title it "main profile"] with several check-boxes unticked and one["additional profile"] with the same check-boxes ticked, and then screenshot of additional profiles for profile groups for the user]
}}

Which Metis Objects are Version specific?

=== Managing versions ===

====Search====

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Versions based on various criterions. 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 disaplyed below/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

====Add====

In the '''Versions''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Version. When it is clicked, the '''Version''' creation window opens, it contains two different type of information. The first tab '''Version''' shows a table separated into several expandable sections with two columns, '''Designation''' which represents the type of field and '''Value''' which represents the data entered into that field. All those fields provides the detailed description of a version. Only the ones with the edit icon on the right-hand side of the table can be defined by the user. The other ones are either inheritance from the parent version or imported through a third-party system.

[[File:MSM_Versions_Versions_add_Versions.png|center|600x400px]]

{{Note
| Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field.
}}

When creating a new version, the fields in the versions tab can be edited in order to define the version.

'''''Main'''''

* Version: Name of the version.
* Administrator Free: Choose to make a version administrator free. By setting the version to be administration free, the fields under the Customer section become available.
* Nomad Gateway User: A nomad gateway user can be defined in this field.
* Use Parent documents: Choose to use parent documents for the current version.
* Second ID to display : Secondary ID for he version.
* Default currency : set the default currency to used for all offers created within this version.
* Role for client condition : Role which specifies which Address is taken to apply '''[[Description_of_the_Menu_Prices#Customer_Prices|Customer Prices]]'''.

'''''Conditions'''''

* GSP Discount: The global sales price discount. Entering a figure here for example 50.0, means that a discount of 50% will be factored into the global sales price for this version. The GSP Discount can only be defined for a version by the parent version.

'''''Customer'''''

* OrgID: Organization ID
* Name 1: Name of the customer contact.
* Name 2: Additional name field for a contact.
* Name 3: Additional name field for a contact.
* Address 1: Address of where the customer is located (i.e. street name)
* Address 2: Additional address field for the customer (i.e. building name).
* City Name: City of where the customer is located. A drop-down list of available cities can provided for selection (see Data Management)
* ZipCode: Zipcode for where the customer is located.
* Country: Country where the customer is located. A drop-down list of available countries can provided for selection (see Data Management).
* State: State in the country where the customer is located. A drop-down list of states can be provided for selection (see Data Management).

'''''Directories'''''

Directories may only be specified within the version currently logged-in to. Parent versions cannot choose the directory for child versions. When a directory has been specified, the folder path will be shown in the corresponding field.

* Exchange: link to a folder used for saving FQS files.
* Document: link to a folder used for saving documents that are related to offers.
* Order: link to a folder used for saving XML and SES files.
* Libraries: link to a folder used for software libraries.

'''Profiles'''

'''[[Description of the Menu Profiles | Profiles]]''' are set to a version by the parent of that version in the section '''From Creator'''. Versions that have been automatically created by importation have their profiles also automatically set and cannot have their profiles edited.

However, additional profiles can be given to these versions in the section '''From parent'''. The '''Form parent''' section is only visible for these automatically created versions. To the right of the edit icon column is another column that has an eye for an icon.

Clicking on this eye lets the user see what items are defined by the current profile. Meaning that if the system profile "Default systems" was selected, doing so will display which systems are available in this profile.

[[File:MSM_Versions_Versions_add_profiles.png|center|600x400px]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/d/d2/VID_AdditionalProfilesConcept.PNG'>File:Additional_Profiles_OK.mp4‎</mediaplayer>
| Managing additional Profiles in versions.
}}

'''''From Creator'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

'''''From Parent'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

====Edit====

In the '''Versions''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version. Selecting a version and clicking on it opens the '''Version''' edition window where all related properties and information can be edited.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Version. Modifications applied to the selected version will only be saved once the version edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

[[File:MSM_Versions_Versions_Edit_Version.png|center|600x400px]]

====Delete====

In the '''Version''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Version. Selecting a version and clicking on it displays the following confirmation window.

[[File:MSM_Versions_Versions_delete_2.png|center]]

Once the warning is confirmed, the selected version is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| It is not possible to delete a version unless logged-in to the version that created it.

[[File:MSM_Versions_Versions_delete.png|center]]

}}

====Preview====

In the '''Versions''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected version. Selecting a version from the list and clicking on it opens the '''Version''' preview window.

[[File:MSM_Versions_Versions_Preview_profile.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 ... .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In the rightmost column of the table displayed in the '''Version''' preview window, the icon representing an eye can be used to display the list Systems, Hierarchies, Price Categories, Attributes, Variants, Service Models and Tax Models which have been set for the various profiles. No edition is possible.

==== Version without Administrator ====

As stated in the name, version without administrator is a Metis Smart Suite Version which doesn't include an administrator. This type of version is mainly used when no direct maintenance is required on the version level or when it is simply not wished to let the version be maintained individually.

A version without administrator is always created and maintained by its parent version.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/f/fe/VID_VersionNoAdmin.png'>File:Setting_a_version_without_an_administrator_OK.mp4‎</mediaplayer>
| Setting up a version without an administrator.
}}

== Access ==

From this sub-menu, the administrator can define and manage the access between the various children versions, as shown in the following example:

[[File:MSM_Versions_Access.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find versions based on various criterion. The search is triggered by typing a keyword or only a letter in the field 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 list.

=== Editing a Version's Rights ===

In the '''Version Rights''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version Right. Selecting a version right and clicking on it opens the '''Version Rights''' edition window where all related properties and information can be edited.

[[File:MSM_Versions_Access_Edit.png|center|600x400px]]

{{Note
| The title on the window displays the name of selected version (e.g. Version Rights Headquarters where Headquarters is the name of the selected version).
}}

The Versions (Smart Quotes) table displays all the available versions. The displayed versions consist of all of the children versions of the administrator's version. The authorized column allows the administrator to select / deselect the versions that the Smart Quotes users is authorized to access to. The following example describes the cases where a version can have access to the projects and offers made in other versions:

[[File:MetisSmartModelingVersionsProfileDiagram.PNG]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/a/a3/VID_Manage_the_version_access.png'>File:Managing_the_access_of_versions_OK.mp4‎</mediaplayer>
| Managing version access.
}}

An administrator of Version A can define that the Version A users can have access to the direct children versions' projects and offers (i.e. Version B, Version C and Version D). However, Version A users cannot access Version E's projects and offers because Version E is not a direct child of Version A.

The administrator of Version A can also define that Version B users can have access to Version C's projects and offers but not to Version D's projects and offer. The same administrator could also define that Version C users can only have access to Version B's projects and offers.

The authorization is not bi-directional: if Version B users have access to Version C's projects and offers, Version C users do not automatically receive access to Version B's projects and offers. The administrator must set the authorizations for each version.

=== Previewing a Version's Rights ===

In the '''Version Access''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Version Rights. Selecting a Version Right from the table/list and clicking on it opens the '''Version Rights''' preview window.

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

For detailed descriptions of all information available in this window please refer to the section dedicated to the edition of a version right .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In this window, only the authorized versions are displayed. This means that if a version is not authorized to see the projects or the offers or at least one other version, the table is empty as shown in the following example:

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

== Languages ==

Metis Smart Suite supports the use of multiple languages for single roll-outs of the application. Different languages can then be used to translate the [[Metis_Smart_Modeling_-_Setup|User Interface]] and/or the objects created in Metis Smart Modeling, the documents generated by Metis Smart Quotes or the Notes provided by the End-Users In this menu, the administrator defines the languages that the Metis Smart Modeling and Metis Smart Quote users are authorized to use.

{{Warning
| The administrator can define a maximum of four languages per version.
}}

Languages defined in this menu are then made available in the following parts of Metis:

* when a designation is required for an item (e.g. a language, a [[Description_of_the_Menu_Positions|position]], an [[Metis_Smart_Modeling_-_Attributes|attribute]] etc.), the designation may be entered for all the languages that have been made available.

* In the [[Description_of_the_Menu_Users|Users]] menu when defining a user's main language

* In the [[Description of the Sub-Menu Functionalities#Languages tab | Profiles]] menu when setting a default language for a functionality profile.

* In the [[Metis_Smart_Modeling_-_Setup|Setup]] menu when selecting the User Interface language for the application.

* In various part of Metis Smart Quotes as when creating a contact.

{{Note
| The designations in the other languages are used in the case where a designation is missing for the language in which the user is currently working with (see the [[#Priority| Priority]] section below).
}}

=== Adding a New Language ===

Before adding or creating a language, the administrator has to make sure that the maximum number of languages per version is not reached. A click on the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] displays the following window:

[[File:MetisSmartModelingAddLangageSelection.PNG|center|300x350px]]

The administrator can either add an existing language or create a new language.

==== Adding an Existing Language ====

If the administrator chooses to add an existing language, the following window appears after selecting the "Add available language" option:

[[File:MetisSmartModelingLanguageAddExistingLanguage.PNG|center|600x400px]]

The contents of this window is non editable.

The window contains the list of all the available languages. These languages can come from one of the following sources:
* an ascendant version
* the current version
* a descendant version

The first three columns of the window (Flag, Code and Designation) show the country flag, the language code and the language designation. The last column (Version) indicates the version in which the language has been created.

To add a language to the current version, select a language then click on the OK icon. The Languages menu is displayed again with the added language(s). In the language selection menu, it is possible to select several languages at the same time. If the administrator tries to select too many languages and exceeds the 4 authorized languages per version, a pop up window appears. If the user tries to select a language that has already been made available for the current version, a pop up window appears.

==== Creating a New Language ====

If the administrator chooses to create a new language, the following window appears after selecting the "Create a new language" option:

[[File:MetisSmartModelingLanguageAddNewLanguage.PNG|center|600x400px]]

The properties of the language must be provided, that is to say:
* a picture representing the country flag
* a language code (preferably the ISO code)
* a designation
* a translation for each language that has already been made available by the administrator

The language code field is mandatory in order to save the language. This field is limited to four characters and cannot be changed afterwards.

{{Note
| It is highly recommended to use the [http://www.iso.org/iso/english_country_names_and_code_elements official ISO country code].
}}

To define a picture representing the country flag for the language, click on the frame located on the top right side. A window opens as shown in the following example:

[[File:MetisSmartModelingLanguageAddFlagIcon.PNG|center|300x350px]]

The window contains the pictures that have been previously uploaded in the '''[[Description_of_the_Sub-Menu_Cliparts | Cliparts]]''' menu.

The language designation is limited to 30 characters and is mandatory.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/0/0b/VID_Creating_a_language.png'>File:Creating_a_language_OK.mp4‎</mediaplayer>
| Creating a language.
}}

For each language that has already been made available by the administrator, a designation should be provided. This designation should be the name of the created language translated into the other language (e.g. "Russian" in English, "Russe" in French, "Russisch" in German etc.).

=== Editing a Language ===

In the '''Languages''' 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 Language. Selecting a Language and clicking on it opens the '''Languages''' edition window where all related properties and information can be edited.

[[File:MetisSmartModelingLanguageEdit.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the country flag
* an ISO language code
* designation
* the designation of the language (for each language that has been made available by the administrator)

If the administrator is not the owner of the language (i.e. the language has been created in another version), it is only possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator). The language code and the picture cannot be edited.

If the administrator is the owner of the language, it is possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator) and the picture representing the country flag. The language code cannot be edited.

=== Preview ===

In the '''Languages''' 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 Language. Selecting a language from the table and clicking on it opens the '''Languages''' preview window.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Language.

[[File:MetisSmartModelingLanguagePreview.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the flag
* an ISO language code
* a designation
* the designation of the language (for each language that has been made available by the administrator)

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

=== Priority ===

The order in which the languages are displayed correspond to the language priority order. This order is considered when a description is missing for an item. When a description is missing, Metis looks for the item description in the other available languages and displays this description. This means that if the description of an item is missing in the first language, Metis displays the description in the second language if it exists. If not, the description in the third language is displayed and so on.

The priority can be modified by clicking on the ''Priority'' button. The following window appears:

[[File:MetisSmartModelingLanguagePriority.PNG|center|300x350px]]

The table is populated with the languages that have been defined for the current version. The contents of the table cannot be edited. The priority order of the language can be defined using the up and down arrows on the right of the table. The language at the top of the table has the highest priority. The language at the bottom of the table has the lowest priority.

=== Deleting a Language ===

In the '''Languages''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Language. Selecting a Language and clicking on it displays the following confirmation window, if the version has been manually created (i.e. no lock) or is owned by the current version, a confirmation window appears.

Once the warning is confirmed, the selected Language is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| If all the languages are deleted, Metis proposes by default English as the language of the version.
}}

{{Note
| If the language is owned by another version (i.e. presence of a lock), the language cannot be deleted.

[[File:MSM_Versions_Languages_Languages_Delete.png|center]]

}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/e/eb/VID_managing_the_languages_of_a_version.png'>File:Managing_languages_OK.mp4‎</mediaplayer>
| Managing languages of a version.
}}

== Update ==

The Metis Smart Suite update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.

=== Update process Overview ===

In order for this process to efficiently distribute all that information, the functionality works based on the diagram below.

[[File:IMG_Update_Process.png|center|600x400px]]

All update related settings, information and files are bundled together within Metis Smart Suite and sent to a web-service hosted on a web-server. The local instances of Metis Smart Quotes then inquires this service for available updates and notifies the user. If validated, the update takes places and the application will be restarted.

=== Preparing Metis Smart Quotes Updates ===

The update sub-menu is used to prepare updates for offline versions of the Metis Smart Quotes. By default an update which will be created here will include the various databases required by the applications. The update preparation tool in Metis Smart Modeling can be used to fine tune this update. The first type of additional information which can be included in an update are files. The concept is that throughout the settings, external files could be required by Metis Smart Quotes in order to provide to the end-user different information. For example, in the [[Description_of_the_Sub-Menu_Notes|Notes]] menu of the software, the various note types allow the user to import default texts in the note. Those default texts need to be distributed and linked to the application. In the definition of the note setting the administrator sets up a link to a folder where those templates will be stored. When creating the update the idea is to list those templates and define where they will be placed within the local instance of the application. Therefore, the link defined within the profile will also be set in the "destination folder" column of the update preparation.

[[File:MSM_Versions_Uptdate.png|center|600x400px]]

In the update sub-menu the main working area is dedicated to a table with the following columns:

*'''Source File Name''': The name of the original file found under either the "Common Files" or "Specific Files" folder depending on the choice made.
*'''Dest. Folder''': An editable field where the user can enter the destination folder for the file after being updated.
*'''Dest. Filename''': An editable field where the user can enter a new name for the file after being distributed.
*'''File Date''': The date the original file was created.
*'''Behavior''': Describes what will happen once the update has been executed. A drop-down menu with three different options is found in this column.
**Overwite if more recent: The file will be replaced with a more recent version if one is available.
**Ignore if already existing: The file will remain untouched if it is found to already exist.
**Force overwrite: The file will be replaced no matter what the case.

Updates must be prepared in online mode. The purpose of the update process is that when updating a version, the update will automatically be available to the offline users of the version as well as the offline users of the child versions.

Updates may be available for online and offline versions of MSQ. Only the information owned by a version may be used for updates. Data which is owned by a version means data which has been created by the administrator of that version.

For example, on the diagram, the HQ version is the parent of the versions ENG, FRA, GER, JPN, and USA. USA is the parent of the versions NY and WA. This means that NY and WA are the grandchildren of the HQ version.

If an administrator of the HQ version prepares an update, the offline users of the HQ, ENG, FRA, GER, JPN, USA, NY and WA versions also receive the update.

If an administrator of the USA version prepares an update, the versions HQ, ENG, FRA, GER and JPN do not receive the update. Only the USA version and the child versions of USA receive it.

[[File:IMG_Version_Concept.png|center|600x400px]]

====Add Files====

Clicking on the "Add Files" button [[File:MetisSmartModelingCurrentlyAddFilesButton.PNG|link=]] opens a window that asks the user which type of files they wish to add, either '''Common Files''' or '''Specific Files'''. Common files are files which will be distributed to the selected version and its child versions after the update process. Specific files are files which will only be distributed to the selected version when preparing an update. The child versions will not receive the file after the update process.

[[File:MSM_Versions_Update_Add_Files.png|center]]

After selecting a file type and confirming, a MS Windows Explorer window opens where the user may add one or more files at the same time and then clicking on open to complete the process. The files are then added to the main table of the update sub-menu. Depending on the file type chosen, the files will appear under the appropriate folder.

====Delete Files====

In the '''Update''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Files. Selecting one or more files and clicking on it displays the following confirmation window.

Once the warning is confirmed, the selected files are removed from the Metis Smart Suite Update.

====Prepare Update====

After the desired file or files have been added to the update, the user can then begin to generate the update with the "Prepare Update" button [[File:MetisSmartModelingPrepareUpdateButton.PNG|link=]] button.

When selecting a file and clicking on this button, the user is presented with a pop-up window asking if they are sure that they want to run the update process.

The '''Preparing Update...''' window opens after confirming the pop-up. In this window the user is presented with a table with three columns including the '''Date''', '''Message''', and '''Status'''.

The '''Date''' columns list the date and time of the message given in the table, the '''Message''' column provides information to the user in the form of short messages indicating the current status of the update process, and the '''Status''' column is filled with either a green check-mark indicating successful step in the update process or a red x indicating an error in the update process. In the case of an error, a short notice will be displayed in the message column describing the error.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/5/5e/VID_preparing_update.png'>File:PreparingAnUpdateForOfflineInstallations_OK.mp4‎</mediaplayer>
| Preparing an update for offline installations.
}}

{{Warning
| In order for the update preparation and distribution to go through normally, it is required to define the update settings in the functionality profiles in the version in which the administrator works; and in the versions which are targeted by the update.

For the Metis Smart Quotes instances targeted by the update to receive the update it is of course necessary that the profiles define the correct update settings.
}}

== Licensing ==

(TBD)

Description of the Menu Versions

2014-01-15T13:02:14Z

PatrickG: /* Overview of versions */

As Metis Smart Suite can be rolled out in small to large organizations the software supports a versioning concepts. These feature allows it to be structured in a tree like schema. As the root of this tree there will always be the main delivered version of the application.

The branches from that tree will represent created version within the organization. As described in the figure below the headquarters of an organization is placed at the root of the tree, and all the country specific subsidiaries, for example, are shown as first child version (i.e. first level nodes). The leafs of the tree from a specific branch are for example partners within that country.

Within Metis Smart Suite a version is mainly described by its name and basic information, conditions, customer designation and directories which have to be used by it. Additionally '''[[Description of the Menu Profiles | Profiles]]''' of all types can be linked to a version in order to enforce default rights and privileges to all users which will be created in that version.

Versions are a key element of the Metis Smart Suite. This functionality allows the administrator to re-create the sales or legal structure of the company in which the software suite is being deployed. Additional examples of how this structure can support any organization can be found within the various screenshots of that section.

== Versions ==

Both Metis Smart Modeling users and administrators can create as many versions as required. As a reminder, versions that descend from a main version are classified as child versions. The main versions which create these child versions are classified as parent versions. This means that any single version may be a parent or child version, depending on the point of view.

[[File:MSM_Versions_Versions.png|center|600x400px]]

=== Overview of versions ===

Users may add, delete, edit, and preview versions in this sub-menu. A search feature can be found on the left side and a main table containing general information is found in the working area.

In this table, the parent version (the currently logged-in version) is featured at the top with all its child versions listed below.
Versions in the main table may be represented by several different types of icons.

{| 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 Version
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Icon
! 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" |
'''Normal Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Standard Metis Smart Suite Version.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Version without Admin'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionNoAdminIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
There are no Users defined as administrator for this version. It depends entirely on the parent version's Administrator.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Inactive Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
[[File:MetisSmartModelingVersionInactiveIcon.png‎|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Version exists in the Metis Smart Suite Database, but has been disabled.
|-
|}

A lock icon may be found preceding any of these types of versions. The lock icon signifies that the version was not created in the version currently logged-in, but in another version or by an automated system.

[[File:MSM_Versions_Versions.png|center|600x400px]]

[[File:IMG_Version_Concept.png|center|600x400px]]

{{Note
| Imported versions which are denied access to certain items through profile groups, can never have access to these items even if they are given access through the use of additional profiles.

[take a screenshot of for example a system profile[title it "main profile"] with several check-boxes unticked and one["additional profile"] with the same check-boxes ticked, and then screenshot of additional profiles for profile groups for the user]
}}

Which Metis Objects are Version specific?

=== Managing versions ===

====Search====

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Versions based on various criterions. 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 disaplyed below/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

====Add====

In the '''Versions''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Version. When it is clicked, the '''Version''' creation window opens, it contains two different type of information. The first tab '''Version''' shows a table separated into several expandable sections with two columns, '''Designation''' which represents the type of field and '''Value''' which represents the data entered into that field. All those fields provides the detailed description of a version. Only the ones with the edit icon on the right-hand side of the table can be defined by the user. The other ones are either inheritance from the parent version or imported through a third-party system.

[[File:MSM_Versions_Versions_add_Versions.png|center|600x400px]]

{{Note
| Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field.
}}

When creating a new version, the fields in the versions tab can be edited in order to define the version.

'''''Main'''''

* Version: Name of the version.
* Administrator Free: Choose to make a version administrator free. By setting the version to be administration free, the fields under the Customer section become available.
* Nomad Gateway User: A nomad gateway user can be defined in this field.
* Use Parent documents: Choose to use parent documents for the current version.
* Second ID to display : Secondary ID for he version.
* Default currency : set the default currency to used for all offers created within this version.
* Role for client condition : Role which specifies which Address is taken to apply '''[[Description_of_the_Menu_Prices#Customer_Prices|Customer Prices]]'''.

'''''Conditions'''''

* GSP Discount: The global sales price discount. Entering a figure here for example 50.0, means that a discount of 50% will be factored into the global sales price for this version. The GSP Discount can only be defined for a version by the parent version.

'''''Customer'''''

* OrgID: Organization ID
* Name 1: Name of the customer contact.
* Name 2: Additional name field for a contact.
* Name 3: Additional name field for a contact.
* Address 1: Address of where the customer is located (i.e. street name)
* Address 2: Additional address field for the customer (i.e. building name).
* City Name: City of where the customer is located. A drop-down list of available cities can provided for selection (see Data Management)
* ZipCode: Zipcode for where the customer is located.
* Country: Country where the customer is located. A drop-down list of available countries can provided for selection (see Data Management).
* State: State in the country where the customer is located. A drop-down list of states can be provided for selection (see Data Management).

'''''Directories'''''

Directories may only be specified within the version currently logged-in to. Parent versions cannot choose the directory for child versions. When a directory has been specified, the folder path will be shown in the corresponding field.

* Exchange: link to a folder used for saving FQS files.
* Document: link to a folder used for saving documents that are related to offers.
* Order: link to a folder used for saving XML and SES files.
* Libraries: link to a folder used for software libraries.

'''Profiles'''

'''[[Description of the Menu Profiles | Profiles]]''' are set to a version by the parent of that version in the section '''From Creator'''. Versions that have been automatically created by importation have their profiles also automatically set and cannot have their profiles edited.

However, additional profiles can be given to these versions in the section '''From parent'''. The '''Form parent''' section is only visible for these automatically created versions. To the right of the edit icon column is another column that has an eye for an icon.

Clicking on this eye lets the user see what items are defined by the current profile. Meaning that if the system profile "Default systems" was selected, doing so will display which systems are available in this profile.

[[File:MSM_Versions_Versions_add_profiles.png|center|600x400px]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/d/d2/VID_AdditionalProfilesConcept.PNG'>File:Additional_Profiles_OK.mp4‎</mediaplayer>
| Managing additional Profiles in versions.
}}

'''''From Creator'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

'''''From Parent'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

====Edit====

In the '''Versions''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version. Selecting a version and clicking on it opens the '''Version''' edition window where all related properties and information can be edited.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Version. Modifications applied to the selected version will only be saved once the version edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

[[File:MSM_Versions_Versions_Edit_Version.png|center|600x400px]]

====Delete====

In the '''Version''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Version. Selecting a version and clicking on it displays the following confirmation window.

[[File:MSM_Versions_Versions_delete_2.png|center]]

Once the warning is confirmed, the selected version is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| It is not possible to delete a version unless logged-in to the version that created it.

[[File:MSM_Versions_Versions_delete.png|center]]

}}

====Preview====

In the '''Versions''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected version. Selecting a version from the list and clicking on it opens the '''Version''' preview window.

[[File:MSM_Versions_Versions_Preview_profile.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 ... .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In the rightmost column of the table displayed in the '''Version''' preview window, the icon representing an eye can be used to display the list Systems, Hierarchies, Price Categories, Attributes, Variants, Service Models and Tax Models which have been set for the various profiles. No edition is possible.

==== Version without Administrator ====

As stated in the name, version without administrator is a Metis Smart Suite Version which doesn't include an administrator. This type of version is mainly used when no direct maintenance is required on the version level or when it is simply not wished to let the version be maintained individually.

A version without administrator is always created and maintained by its parent version.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/f/fe/VID_VersionNoAdmin.png'>File:Setting_a_version_without_an_administrator_OK.mp4‎</mediaplayer>
| Setting up a version without an administrator.
}}

== Access ==

From this sub-menu, the administrator can define and manage the access between the various children versions, as shown in the following example:

[[File:MSM_Versions_Access.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find versions based on various criterion. The search is triggered by typing a keyword or only a letter in the field 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 list.

=== Editing a Version's Rights ===

In the '''Version Rights''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version Right. Selecting a version right and clicking on it opens the '''Version Rights''' edition window where all related properties and information can be edited.

[[File:MSM_Versions_Access_Edit.png|center|600x400px]]

{{Note
| The title on the window displays the name of selected version (e.g. Version Rights Headquarters where Headquarters is the name of the selected version).
}}

The Versions (Smart Quotes) table displays all the available versions. The displayed versions consist of all of the children versions of the administrator's version. The authorized column allows the administrator to select / deselect the versions that the Smart Quotes users is authorized to access to. The following example describes the cases where a version can have access to the projects and offers made in other versions:

[[File:MetisSmartModelingVersionsProfileDiagram.PNG]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/a/a3/VID_Manage_the_version_access.png'>File:Managing_the_access_of_versions_OK.mp4‎</mediaplayer>
| Managing version access.
}}

An administrator of Version A can define that the Version A users can have access to the direct children versions' projects and offers (i.e. Version B, Version C and Version D). However, Version A users cannot access Version E's projects and offers because Version E is not a direct child of Version A.

The administrator of Version A can also define that Version B users can have access to Version C's projects and offers but not to Version D's projects and offer. The same administrator could also define that Version C users can only have access to Version B's projects and offers.

The authorization is not bi-directional: if Version B users have access to Version C's projects and offers, Version C users do not automatically receive access to Version B's projects and offers. The administrator must set the authorizations for each version.

=== Previewing a Version's Rights ===

In the '''Version Access''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Version Rights. Selecting a Version Right from the table/list and clicking on it opens the '''Version Rights''' preview window.

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

For detailed descriptions of all information available in this window please refer to the section dedicated to the edition of a version right .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In this window, only the authorized versions are displayed. This means that if a version is not authorized to see the projects or the offers or at least one other version, the table is empty as shown in the following example:

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

== Languages ==

Metis Smart Suite supports the use of multiple languages for single roll-outs of the application. Different languages can then be used to translate the [[Metis_Smart_Modeling_-_Setup|User Interface]] and/or the objects created in Metis Smart Modeling, the documents generated by Metis Smart Quotes or the Notes provided by the End-Users In this menu, the administrator defines the languages that the Metis Smart Modeling and Metis Smart Quote users are authorized to use.

{{Warning
| The administrator can define a maximum of four languages per version.
}}

Languages defined in this menu are then made available in the following parts of Metis:

* when a designation is required for an item (e.g. a language, a [[Description_of_the_Menu_Positions|position]], an [[Metis_Smart_Modeling_-_Attributes|attribute]] etc.), the designation may be entered for all the languages that have been made available.

* In the [[Description_of_the_Menu_Users|Users]] menu when defining a user's main language

* In the [[Description of the Sub-Menu Functionalities#Languages tab | Profiles]] menu when setting a default language for a functionality profile.

* In the [[Metis_Smart_Modeling_-_Setup|Setup]] menu when selecting the User Interface language for the application.

* In various part of Metis Smart Quotes as when creating a contact.

{{Note
| The designations in the other languages are used in the case where a designation is missing for the language in which the user is currently working with (see the [[#Priority| Priority]] section below).
}}

=== Adding a New Language ===

Before adding or creating a language, the administrator has to make sure that the maximum number of languages per version is not reached. A click on the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] displays the following window:

[[File:MetisSmartModelingAddLangageSelection.PNG|center|300x350px]]

The administrator can either add an existing language or create a new language.

==== Adding an Existing Language ====

If the administrator chooses to add an existing language, the following window appears after selecting the "Add available language" option:

[[File:MetisSmartModelingLanguageAddExistingLanguage.PNG|center|600x400px]]

The contents of this window is non editable.

The window contains the list of all the available languages. These languages can come from one of the following sources:
* an ascendant version
* the current version
* a descendant version

The first three columns of the window (Flag, Code and Designation) show the country flag, the language code and the language designation. The last column (Version) indicates the version in which the language has been created.

To add a language to the current version, select a language then click on the OK icon. The Languages menu is displayed again with the added language(s). In the language selection menu, it is possible to select several languages at the same time. If the administrator tries to select too many languages and exceeds the 4 authorized languages per version, a pop up window appears. If the user tries to select a language that has already been made available for the current version, a pop up window appears.

==== Creating a New Language ====

If the administrator chooses to create a new language, the following window appears after selecting the "Create a new language" option:

[[File:MetisSmartModelingLanguageAddNewLanguage.PNG|center|600x400px]]

The properties of the language must be provided, that is to say:
* a picture representing the country flag
* a language code (preferably the ISO code)
* a designation
* a translation for each language that has already been made available by the administrator

The language code field is mandatory in order to save the language. This field is limited to four characters and cannot be changed afterwards.

{{Note
| It is highly recommended to use the [http://www.iso.org/iso/english_country_names_and_code_elements official ISO country code].
}}

To define a picture representing the country flag for the language, click on the frame located on the top right side. A window opens as shown in the following example:

[[File:MetisSmartModelingLanguageAddFlagIcon.PNG|center|300x350px]]

The window contains the pictures that have been previously uploaded in the '''[[Description_of_the_Sub-Menu_Cliparts | Cliparts]]''' menu.

The language designation is limited to 30 characters and is mandatory.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/0/0b/VID_Creating_a_language.png'>File:Creating_a_language_OK.mp4‎</mediaplayer>
| Creating a language.
}}

For each language that has already been made available by the administrator, a designation should be provided. This designation should be the name of the created language translated into the other language (e.g. "Russian" in English, "Russe" in French, "Russisch" in German etc.).

=== Editing a Language ===

In the '''Languages''' 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 Language. Selecting a Language and clicking on it opens the '''Languages''' edition window where all related properties and information can be edited.

[[File:MetisSmartModelingLanguageEdit.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the country flag
* an ISO language code
* designation
* the designation of the language (for each language that has been made available by the administrator)

If the administrator is not the owner of the language (i.e. the language has been created in another version), it is only possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator). The language code and the picture cannot be edited.

If the administrator is the owner of the language, it is possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator) and the picture representing the country flag. The language code cannot be edited.

=== Preview ===

In the '''Languages''' 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 Language. Selecting a language from the table and clicking on it opens the '''Languages''' preview window.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Language.

[[File:MetisSmartModelingLanguagePreview.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the flag
* an ISO language code
* a designation
* the designation of the language (for each language that has been made available by the administrator)

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

=== Priority ===

The order in which the languages are displayed correspond to the language priority order. This order is considered when a description is missing for an item. When a description is missing, Metis looks for the item description in the other available languages and displays this description. This means that if the description of an item is missing in the first language, Metis displays the description in the second language if it exists. If not, the description in the third language is displayed and so on.

The priority can be modified by clicking on the ''Priority'' button. The following window appears:

[[File:MetisSmartModelingLanguagePriority.PNG|center|300x350px]]

The table is populated with the languages that have been defined for the current version. The contents of the table cannot be edited. The priority order of the language can be defined using the up and down arrows on the right of the table. The language at the top of the table has the highest priority. The language at the bottom of the table has the lowest priority.

=== Deleting a Language ===

In the '''Languages''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Language. Selecting a Language and clicking on it displays the following confirmation window, if the version has been manually created (i.e. no lock) or is owned by the current version, a confirmation window appears.

Once the warning is confirmed, the selected Language is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| If all the languages are deleted, Metis proposes by default English as the language of the version.
}}

{{Note
| If the language is owned by another version (i.e. presence of a lock), the language cannot be deleted.

[[File:MSM_Versions_Languages_Languages_Delete.png|center]]

}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/e/eb/VID_managing_the_languages_of_a_version.png'>File:Managing_languages_OK.mp4‎</mediaplayer>
| Managing languages of a version.
}}

== Update ==

The Metis Smart Suite update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.

=== Update process Overview ===

In order for this process to efficiently distribute all that information, the functionality works based on the diagram below.

[[File:IMG_Update_Process.png|center|600x400px]]

All update related settings, information and files are bundled together within Metis Smart Suite and sent to a web-service hosted on a web-server. The local instances of Metis Smart Quotes then inquires this service for available updates and notifies the user. If validated, the update takes places and the application will be restarted.

=== Preparing Metis Smart Quotes Updates ===

The update sub-menu is used to prepare updates for offline versions of the Metis Smart Quotes. By default an update which will be created here will include the various databases required by the applications. The update preparation tool in Metis Smart Modeling can be used to fine tune this update. The first type of additional information which can be included in an update are files. The concept is that throughout the settings, external files could be required by Metis Smart Quotes in order to provide to the end-user different information. For example, in the [[Description_of_the_Sub-Menu_Notes|Notes]] menu of the software, the various note types allow the user to import default texts in the note. Those default texts need to be distributed and linked to the application. In the definition of the note setting the administrator sets up a link to a folder where those templates will be stored. When creating the update the idea is to list those templates and define where they will be placed within the local instance of the application. Therefore, the link defined within the profile will also be set in the "destination folder" column of the update preparation.

[[File:MSM_Versions_Uptdate.png|center|600x400px]]

In the update sub-menu the main working area is dedicated to a table with the following columns:

*'''Source File Name''': The name of the original file found under either the "Common Files" or "Specific Files" folder depending on the choice made.
*'''Dest. Folder''': An editable field where the user can enter the destination folder for the file after being updated.
*'''Dest. Filename''': An editable field where the user can enter a new name for the file after being distributed.
*'''File Date''': The date the original file was created.
*'''Behavior''': Describes what will happen once the update has been executed. A drop-down menu with three different options is found in this column.
**Overwite if more recent: The file will be replaced with a more recent version if one is available.
**Ignore if already existing: The file will remain untouched if it is found to already exist.
**Force overwrite: The file will be replaced no matter what the case.

Updates must be prepared in online mode. The purpose of the update process is that when updating a version, the update will automatically be available to the offline users of the version as well as the offline users of the child versions.

Updates may be available for online and offline versions of MSQ. Only the information owned by a version may be used for updates. Data which is owned by a version means data which has been created by the administrator of that version.

For example, on the diagram, the HQ version is the parent of the versions ENG, FRA, GER, JPN, and USA. USA is the parent of the versions NY and WA. This means that NY and WA are the grandchildren of the HQ version.

If an administrator of the HQ version prepares an update, the offline users of the HQ, ENG, FRA, GER, JPN, USA, NY and WA versions also receive the update.

If an administrator of the USA version prepares an update, the versions HQ, ENG, FRA, GER and JPN do not receive the update. Only the USA version and the child versions of USA receive it.

[[File:IMG_Version_Concept.png|center|600x400px]]

====Add Files====

Clicking on the "Add Files" button [[File:MetisSmartModelingCurrentlyAddFilesButton.PNG|link=]] opens a window that asks the user which type of files they wish to add, either '''Common Files''' or '''Specific Files'''. Common files are files which will be distributed to the selected version and its child versions after the update process. Specific files are files which will only be distributed to the selected version when preparing an update. The child versions will not receive the file after the update process.

[[File:MSM_Versions_Update_Add_Files.png|center]]

After selecting a file type and confirming, a MS Windows Explorer window opens where the user may add one or more files at the same time and then clicking on open to complete the process. The files are then added to the main table of the update sub-menu. Depending on the file type chosen, the files will appear under the appropriate folder.

====Delete Files====

In the '''Update''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Files. Selecting one or more files and clicking on it displays the following confirmation window.

Once the warning is confirmed, the selected files are removed from the Metis Smart Suite Update.

====Prepare Update====

After the desired file or files have been added to the update, the user can then begin to generate the update with the "Prepare Update" button [[File:MetisSmartModelingPrepareUpdateButton.PNG|link=]] button.

When selecting a file and clicking on this button, the user is presented with a pop-up window asking if they are sure that they want to run the update process.

The '''Preparing Update...''' window opens after confirming the pop-up. In this window the user is presented with a table with three columns including the '''Date''', '''Message''', and '''Status'''.

The '''Date''' columns list the date and time of the message given in the table, the '''Message''' column provides information to the user in the form of short messages indicating the current status of the update process, and the '''Status''' column is filled with either a green check-mark indicating successful step in the update process or a red x indicating an error in the update process. In the case of an error, a short notice will be displayed in the message column describing the error.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/5/5e/VID_preparing_update.png'>File:PreparingAnUpdateForOfflineInstallations_OK.mp4‎</mediaplayer>
| Preparing an update for offline installations.
}}

{{Warning
| In order for the update preparation and distribution to go through normally, it is required to define the update settings in the functionality profiles in the version in which the administrator works; and in the versions which are targeted by the update.

For the Metis Smart Quotes instances targeted by the update to receive the update it is of course necessary that the profiles define the correct update settings.
}}

== Licensing ==

(TBD)

Description of the Menu Versions

2014-01-15T13:01:51Z

PatrickG: /* Overview of versions */

As Metis Smart Suite can be rolled out in small to large organizations the software supports a versioning concepts. These feature allows it to be structured in a tree like schema. As the root of this tree there will always be the main delivered version of the application.

The branches from that tree will represent created version within the organization. As described in the figure below the headquarters of an organization is placed at the root of the tree, and all the country specific subsidiaries, for example, are shown as first child version (i.e. first level nodes). The leafs of the tree from a specific branch are for example partners within that country.

Within Metis Smart Suite a version is mainly described by its name and basic information, conditions, customer designation and directories which have to be used by it. Additionally '''[[Description of the Menu Profiles | Profiles]]''' of all types can be linked to a version in order to enforce default rights and privileges to all users which will be created in that version.

Versions are a key element of the Metis Smart Suite. This functionality allows the administrator to re-create the sales or legal structure of the company in which the software suite is being deployed. Additional examples of how this structure can support any organization can be found within the various screenshots of that section.

== Versions ==

Both Metis Smart Modeling users and administrators can create as many versions as required. As a reminder, versions that descend from a main version are classified as child versions. The main versions which create these child versions are classified as parent versions. This means that any single version may be a parent or child version, depending on the point of view.

[[File:MSM_Versions_Versions.png|center|600x400px]]

=== Overview of versions ===

Users may add, delete, edit, and preview versions in this sub-menu. A search feature can be found on the left side and a main table containing general information is found in the working area.

In this table, the parent version (the currently logged-in version) is featured at the top with all its child versions listed below.
Versions in the main table may be represented by several different types of icons.

{| 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 version
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Icon
! 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" |
'''Normal Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Standard Metis Smart Suite Version.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Version without Admin'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionNoAdminIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
There are no Users defined as administrator for this version. It depends entirely on the parent version's Administrator.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Inactive Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
[[File:MetisSmartModelingVersionInactiveIcon.png‎|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Version exists in the Metis Smart Suite Database, but has been disabled.
|-
|}

A lock icon may be found preceding any of these types of versions. The lock icon signifies that the version was not created in the version currently logged-in, but in another version or by an automated system.

[[File:MSM_Versions_Versions.png|center|600x400px]]

[[File:IMG_Version_Concept.png|center|600x400px]]

{{Note
| Imported versions which are denied access to certain items through profile groups, can never have access to these items even if they are given access through the use of additional profiles.

[take a screenshot of for example a system profile[title it "main profile"] with several check-boxes unticked and one["additional profile"] with the same check-boxes ticked, and then screenshot of additional profiles for profile groups for the user]
}}

Which Metis Objects are Version specific?

=== Managing versions ===

====Search====

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Versions based on various criterions. 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 disaplyed below/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

====Add====

In the '''Versions''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Version. When it is clicked, the '''Version''' creation window opens, it contains two different type of information. The first tab '''Version''' shows a table separated into several expandable sections with two columns, '''Designation''' which represents the type of field and '''Value''' which represents the data entered into that field. All those fields provides the detailed description of a version. Only the ones with the edit icon on the right-hand side of the table can be defined by the user. The other ones are either inheritance from the parent version or imported through a third-party system.

[[File:MSM_Versions_Versions_add_Versions.png|center|600x400px]]

{{Note
| Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field.
}}

When creating a new version, the fields in the versions tab can be edited in order to define the version.

'''''Main'''''

* Version: Name of the version.
* Administrator Free: Choose to make a version administrator free. By setting the version to be administration free, the fields under the Customer section become available.
* Nomad Gateway User: A nomad gateway user can be defined in this field.
* Use Parent documents: Choose to use parent documents for the current version.
* Second ID to display : Secondary ID for he version.
* Default currency : set the default currency to used for all offers created within this version.
* Role for client condition : Role which specifies which Address is taken to apply '''[[Description_of_the_Menu_Prices#Customer_Prices|Customer Prices]]'''.

'''''Conditions'''''

* GSP Discount: The global sales price discount. Entering a figure here for example 50.0, means that a discount of 50% will be factored into the global sales price for this version. The GSP Discount can only be defined for a version by the parent version.

'''''Customer'''''

* OrgID: Organization ID
* Name 1: Name of the customer contact.
* Name 2: Additional name field for a contact.
* Name 3: Additional name field for a contact.
* Address 1: Address of where the customer is located (i.e. street name)
* Address 2: Additional address field for the customer (i.e. building name).
* City Name: City of where the customer is located. A drop-down list of available cities can provided for selection (see Data Management)
* ZipCode: Zipcode for where the customer is located.
* Country: Country where the customer is located. A drop-down list of available countries can provided for selection (see Data Management).
* State: State in the country where the customer is located. A drop-down list of states can be provided for selection (see Data Management).

'''''Directories'''''

Directories may only be specified within the version currently logged-in to. Parent versions cannot choose the directory for child versions. When a directory has been specified, the folder path will be shown in the corresponding field.

* Exchange: link to a folder used for saving FQS files.
* Document: link to a folder used for saving documents that are related to offers.
* Order: link to a folder used for saving XML and SES files.
* Libraries: link to a folder used for software libraries.

'''Profiles'''

'''[[Description of the Menu Profiles | Profiles]]''' are set to a version by the parent of that version in the section '''From Creator'''. Versions that have been automatically created by importation have their profiles also automatically set and cannot have their profiles edited.

However, additional profiles can be given to these versions in the section '''From parent'''. The '''Form parent''' section is only visible for these automatically created versions. To the right of the edit icon column is another column that has an eye for an icon.

Clicking on this eye lets the user see what items are defined by the current profile. Meaning that if the system profile "Default systems" was selected, doing so will display which systems are available in this profile.

[[File:MSM_Versions_Versions_add_profiles.png|center|600x400px]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/d/d2/VID_AdditionalProfilesConcept.PNG'>File:Additional_Profiles_OK.mp4‎</mediaplayer>
| Managing additional Profiles in versions.
}}

'''''From Creator'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

'''''From Parent'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

====Edit====

In the '''Versions''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version. Selecting a version and clicking on it opens the '''Version''' edition window where all related properties and information can be edited.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Version. Modifications applied to the selected version will only be saved once the version edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

[[File:MSM_Versions_Versions_Edit_Version.png|center|600x400px]]

====Delete====

In the '''Version''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Version. Selecting a version and clicking on it displays the following confirmation window.

[[File:MSM_Versions_Versions_delete_2.png|center]]

Once the warning is confirmed, the selected version is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| It is not possible to delete a version unless logged-in to the version that created it.

[[File:MSM_Versions_Versions_delete.png|center]]

}}

====Preview====

In the '''Versions''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected version. Selecting a version from the list and clicking on it opens the '''Version''' preview window.

[[File:MSM_Versions_Versions_Preview_profile.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 ... .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In the rightmost column of the table displayed in the '''Version''' preview window, the icon representing an eye can be used to display the list Systems, Hierarchies, Price Categories, Attributes, Variants, Service Models and Tax Models which have been set for the various profiles. No edition is possible.

==== Version without Administrator ====

As stated in the name, version without administrator is a Metis Smart Suite Version which doesn't include an administrator. This type of version is mainly used when no direct maintenance is required on the version level or when it is simply not wished to let the version be maintained individually.

A version without administrator is always created and maintained by its parent version.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/f/fe/VID_VersionNoAdmin.png'>File:Setting_a_version_without_an_administrator_OK.mp4‎</mediaplayer>
| Setting up a version without an administrator.
}}

== Access ==

From this sub-menu, the administrator can define and manage the access between the various children versions, as shown in the following example:

[[File:MSM_Versions_Access.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find versions based on various criterion. The search is triggered by typing a keyword or only a letter in the field 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 list.

=== Editing a Version's Rights ===

In the '''Version Rights''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version Right. Selecting a version right and clicking on it opens the '''Version Rights''' edition window where all related properties and information can be edited.

[[File:MSM_Versions_Access_Edit.png|center|600x400px]]

{{Note
| The title on the window displays the name of selected version (e.g. Version Rights Headquarters where Headquarters is the name of the selected version).
}}

The Versions (Smart Quotes) table displays all the available versions. The displayed versions consist of all of the children versions of the administrator's version. The authorized column allows the administrator to select / deselect the versions that the Smart Quotes users is authorized to access to. The following example describes the cases where a version can have access to the projects and offers made in other versions:

[[File:MetisSmartModelingVersionsProfileDiagram.PNG]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/a/a3/VID_Manage_the_version_access.png'>File:Managing_the_access_of_versions_OK.mp4‎</mediaplayer>
| Managing version access.
}}

An administrator of Version A can define that the Version A users can have access to the direct children versions' projects and offers (i.e. Version B, Version C and Version D). However, Version A users cannot access Version E's projects and offers because Version E is not a direct child of Version A.

The administrator of Version A can also define that Version B users can have access to Version C's projects and offers but not to Version D's projects and offer. The same administrator could also define that Version C users can only have access to Version B's projects and offers.

The authorization is not bi-directional: if Version B users have access to Version C's projects and offers, Version C users do not automatically receive access to Version B's projects and offers. The administrator must set the authorizations for each version.

=== Previewing a Version's Rights ===

In the '''Version Access''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Version Rights. Selecting a Version Right from the table/list and clicking on it opens the '''Version Rights''' preview window.

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

For detailed descriptions of all information available in this window please refer to the section dedicated to the edition of a version right .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In this window, only the authorized versions are displayed. This means that if a version is not authorized to see the projects or the offers or at least one other version, the table is empty as shown in the following example:

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

== Languages ==

Metis Smart Suite supports the use of multiple languages for single roll-outs of the application. Different languages can then be used to translate the [[Metis_Smart_Modeling_-_Setup|User Interface]] and/or the objects created in Metis Smart Modeling, the documents generated by Metis Smart Quotes or the Notes provided by the End-Users In this menu, the administrator defines the languages that the Metis Smart Modeling and Metis Smart Quote users are authorized to use.

{{Warning
| The administrator can define a maximum of four languages per version.
}}

Languages defined in this menu are then made available in the following parts of Metis:

* when a designation is required for an item (e.g. a language, a [[Description_of_the_Menu_Positions|position]], an [[Metis_Smart_Modeling_-_Attributes|attribute]] etc.), the designation may be entered for all the languages that have been made available.

* In the [[Description_of_the_Menu_Users|Users]] menu when defining a user's main language

* In the [[Description of the Sub-Menu Functionalities#Languages tab | Profiles]] menu when setting a default language for a functionality profile.

* In the [[Metis_Smart_Modeling_-_Setup|Setup]] menu when selecting the User Interface language for the application.

* In various part of Metis Smart Quotes as when creating a contact.

{{Note
| The designations in the other languages are used in the case where a designation is missing for the language in which the user is currently working with (see the [[#Priority| Priority]] section below).
}}

=== Adding a New Language ===

Before adding or creating a language, the administrator has to make sure that the maximum number of languages per version is not reached. A click on the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] displays the following window:

[[File:MetisSmartModelingAddLangageSelection.PNG|center|300x350px]]

The administrator can either add an existing language or create a new language.

==== Adding an Existing Language ====

If the administrator chooses to add an existing language, the following window appears after selecting the "Add available language" option:

[[File:MetisSmartModelingLanguageAddExistingLanguage.PNG|center|600x400px]]

The contents of this window is non editable.

The window contains the list of all the available languages. These languages can come from one of the following sources:
* an ascendant version
* the current version
* a descendant version

The first three columns of the window (Flag, Code and Designation) show the country flag, the language code and the language designation. The last column (Version) indicates the version in which the language has been created.

To add a language to the current version, select a language then click on the OK icon. The Languages menu is displayed again with the added language(s). In the language selection menu, it is possible to select several languages at the same time. If the administrator tries to select too many languages and exceeds the 4 authorized languages per version, a pop up window appears. If the user tries to select a language that has already been made available for the current version, a pop up window appears.

==== Creating a New Language ====

If the administrator chooses to create a new language, the following window appears after selecting the "Create a new language" option:

[[File:MetisSmartModelingLanguageAddNewLanguage.PNG|center|600x400px]]

The properties of the language must be provided, that is to say:
* a picture representing the country flag
* a language code (preferably the ISO code)
* a designation
* a translation for each language that has already been made available by the administrator

The language code field is mandatory in order to save the language. This field is limited to four characters and cannot be changed afterwards.

{{Note
| It is highly recommended to use the [http://www.iso.org/iso/english_country_names_and_code_elements official ISO country code].
}}

To define a picture representing the country flag for the language, click on the frame located on the top right side. A window opens as shown in the following example:

[[File:MetisSmartModelingLanguageAddFlagIcon.PNG|center|300x350px]]

The window contains the pictures that have been previously uploaded in the '''[[Description_of_the_Sub-Menu_Cliparts | Cliparts]]''' menu.

The language designation is limited to 30 characters and is mandatory.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/0/0b/VID_Creating_a_language.png'>File:Creating_a_language_OK.mp4‎</mediaplayer>
| Creating a language.
}}

For each language that has already been made available by the administrator, a designation should be provided. This designation should be the name of the created language translated into the other language (e.g. "Russian" in English, "Russe" in French, "Russisch" in German etc.).

=== Editing a Language ===

In the '''Languages''' 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 Language. Selecting a Language and clicking on it opens the '''Languages''' edition window where all related properties and information can be edited.

[[File:MetisSmartModelingLanguageEdit.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the country flag
* an ISO language code
* designation
* the designation of the language (for each language that has been made available by the administrator)

If the administrator is not the owner of the language (i.e. the language has been created in another version), it is only possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator). The language code and the picture cannot be edited.

If the administrator is the owner of the language, it is possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator) and the picture representing the country flag. The language code cannot be edited.

=== Preview ===

In the '''Languages''' 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 Language. Selecting a language from the table and clicking on it opens the '''Languages''' preview window.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Language.

[[File:MetisSmartModelingLanguagePreview.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the flag
* an ISO language code
* a designation
* the designation of the language (for each language that has been made available by the administrator)

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

=== Priority ===

The order in which the languages are displayed correspond to the language priority order. This order is considered when a description is missing for an item. When a description is missing, Metis looks for the item description in the other available languages and displays this description. This means that if the description of an item is missing in the first language, Metis displays the description in the second language if it exists. If not, the description in the third language is displayed and so on.

The priority can be modified by clicking on the ''Priority'' button. The following window appears:

[[File:MetisSmartModelingLanguagePriority.PNG|center|300x350px]]

The table is populated with the languages that have been defined for the current version. The contents of the table cannot be edited. The priority order of the language can be defined using the up and down arrows on the right of the table. The language at the top of the table has the highest priority. The language at the bottom of the table has the lowest priority.

=== Deleting a Language ===

In the '''Languages''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Language. Selecting a Language and clicking on it displays the following confirmation window, if the version has been manually created (i.e. no lock) or is owned by the current version, a confirmation window appears.

Once the warning is confirmed, the selected Language is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| If all the languages are deleted, Metis proposes by default English as the language of the version.
}}

{{Note
| If the language is owned by another version (i.e. presence of a lock), the language cannot be deleted.

[[File:MSM_Versions_Languages_Languages_Delete.png|center]]

}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/e/eb/VID_managing_the_languages_of_a_version.png'>File:Managing_languages_OK.mp4‎</mediaplayer>
| Managing languages of a version.
}}

== Update ==

The Metis Smart Suite update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.

=== Update process Overview ===

In order for this process to efficiently distribute all that information, the functionality works based on the diagram below.

[[File:IMG_Update_Process.png|center|600x400px]]

All update related settings, information and files are bundled together within Metis Smart Suite and sent to a web-service hosted on a web-server. The local instances of Metis Smart Quotes then inquires this service for available updates and notifies the user. If validated, the update takes places and the application will be restarted.

=== Preparing Metis Smart Quotes Updates ===

The update sub-menu is used to prepare updates for offline versions of the Metis Smart Quotes. By default an update which will be created here will include the various databases required by the applications. The update preparation tool in Metis Smart Modeling can be used to fine tune this update. The first type of additional information which can be included in an update are files. The concept is that throughout the settings, external files could be required by Metis Smart Quotes in order to provide to the end-user different information. For example, in the [[Description_of_the_Sub-Menu_Notes|Notes]] menu of the software, the various note types allow the user to import default texts in the note. Those default texts need to be distributed and linked to the application. In the definition of the note setting the administrator sets up a link to a folder where those templates will be stored. When creating the update the idea is to list those templates and define where they will be placed within the local instance of the application. Therefore, the link defined within the profile will also be set in the "destination folder" column of the update preparation.

[[File:MSM_Versions_Uptdate.png|center|600x400px]]

In the update sub-menu the main working area is dedicated to a table with the following columns:

*'''Source File Name''': The name of the original file found under either the "Common Files" or "Specific Files" folder depending on the choice made.
*'''Dest. Folder''': An editable field where the user can enter the destination folder for the file after being updated.
*'''Dest. Filename''': An editable field where the user can enter a new name for the file after being distributed.
*'''File Date''': The date the original file was created.
*'''Behavior''': Describes what will happen once the update has been executed. A drop-down menu with three different options is found in this column.
**Overwite if more recent: The file will be replaced with a more recent version if one is available.
**Ignore if already existing: The file will remain untouched if it is found to already exist.
**Force overwrite: The file will be replaced no matter what the case.

Updates must be prepared in online mode. The purpose of the update process is that when updating a version, the update will automatically be available to the offline users of the version as well as the offline users of the child versions.

Updates may be available for online and offline versions of MSQ. Only the information owned by a version may be used for updates. Data which is owned by a version means data which has been created by the administrator of that version.

For example, on the diagram, the HQ version is the parent of the versions ENG, FRA, GER, JPN, and USA. USA is the parent of the versions NY and WA. This means that NY and WA are the grandchildren of the HQ version.

If an administrator of the HQ version prepares an update, the offline users of the HQ, ENG, FRA, GER, JPN, USA, NY and WA versions also receive the update.

If an administrator of the USA version prepares an update, the versions HQ, ENG, FRA, GER and JPN do not receive the update. Only the USA version and the child versions of USA receive it.

[[File:IMG_Version_Concept.png|center|600x400px]]

====Add Files====

Clicking on the "Add Files" button [[File:MetisSmartModelingCurrentlyAddFilesButton.PNG|link=]] opens a window that asks the user which type of files they wish to add, either '''Common Files''' or '''Specific Files'''. Common files are files which will be distributed to the selected version and its child versions after the update process. Specific files are files which will only be distributed to the selected version when preparing an update. The child versions will not receive the file after the update process.

[[File:MSM_Versions_Update_Add_Files.png|center]]

After selecting a file type and confirming, a MS Windows Explorer window opens where the user may add one or more files at the same time and then clicking on open to complete the process. The files are then added to the main table of the update sub-menu. Depending on the file type chosen, the files will appear under the appropriate folder.

====Delete Files====

In the '''Update''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Files. Selecting one or more files and clicking on it displays the following confirmation window.

Once the warning is confirmed, the selected files are removed from the Metis Smart Suite Update.

====Prepare Update====

After the desired file or files have been added to the update, the user can then begin to generate the update with the "Prepare Update" button [[File:MetisSmartModelingPrepareUpdateButton.PNG|link=]] button.

When selecting a file and clicking on this button, the user is presented with a pop-up window asking if they are sure that they want to run the update process.

The '''Preparing Update...''' window opens after confirming the pop-up. In this window the user is presented with a table with three columns including the '''Date''', '''Message''', and '''Status'''.

The '''Date''' columns list the date and time of the message given in the table, the '''Message''' column provides information to the user in the form of short messages indicating the current status of the update process, and the '''Status''' column is filled with either a green check-mark indicating successful step in the update process or a red x indicating an error in the update process. In the case of an error, a short notice will be displayed in the message column describing the error.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/5/5e/VID_preparing_update.png'>File:PreparingAnUpdateForOfflineInstallations_OK.mp4‎</mediaplayer>
| Preparing an update for offline installations.
}}

{{Warning
| In order for the update preparation and distribution to go through normally, it is required to define the update settings in the functionality profiles in the version in which the administrator works; and in the versions which are targeted by the update.

For the Metis Smart Quotes instances targeted by the update to receive the update it is of course necessary that the profiles define the correct update settings.
}}

== Licensing ==

(TBD)

Description of the Menu Versions

2014-01-15T13:01:28Z

PatrickG: /* Overview of versions */

As Metis Smart Suite can be rolled out in small to large organizations the software supports a versioning concepts. These feature allows it to be structured in a tree like schema. As the root of this tree there will always be the main delivered version of the application.

The branches from that tree will represent created version within the organization. As described in the figure below the headquarters of an organization is placed at the root of the tree, and all the country specific subsidiaries, for example, are shown as first child version (i.e. first level nodes). The leafs of the tree from a specific branch are for example partners within that country.

Within Metis Smart Suite a version is mainly described by its name and basic information, conditions, customer designation and directories which have to be used by it. Additionally '''[[Description of the Menu Profiles | Profiles]]''' of all types can be linked to a version in order to enforce default rights and privileges to all users which will be created in that version.

Versions are a key element of the Metis Smart Suite. This functionality allows the administrator to re-create the sales or legal structure of the company in which the software suite is being deployed. Additional examples of how this structure can support any organization can be found within the various screenshots of that section.

== Versions ==

Both Metis Smart Modeling users and administrators can create as many versions as required. As a reminder, versions that descend from a main version are classified as child versions. The main versions which create these child versions are classified as parent versions. This means that any single version may be a parent or child version, depending on the point of view.

[[File:MSM_Versions_Versions.png|center|600x400px]]

=== Overview of versions ===

Users may add, delete, edit, and preview versions in this sub-menu. A search feature can be found on the left side and a main table containing general information is found in the working area.

In this table, the parent version (the currently logged-in version) is featured at the top with all its child versions listed below.
Versions in the main table may be represented by several different types of icons.

{| 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 version
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Icon
! 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" |
'''Normal Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
Standard Metis Smart Suite Version.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Version without Admin'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
[[File:MetisSmartModelingVersionNoAdminIcon.png|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" |
There are no Users defined as administrator for this version. It depends entirely on the parent version's Administrator.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Inactive Version'''
| width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
[[File:MetisSmartModelingVersionInactiveIcon.png‎|link=]]
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" |
Version Exists in the Metis Smart Suite Database, but has been set to disabled.
|-
|}

A lock icon may be found preceding any of these types of versions. The lock icon signifies that the version was not created in the version currently logged-in, but in another version or by an automated system.

[[File:MSM_Versions_Versions.png|center|600x400px]]

[[File:IMG_Version_Concept.png|center|600x400px]]

{{Note
| Imported versions which are denied access to certain items through profile groups, can never have access to these items even if they are given access through the use of additional profiles.

[take a screenshot of for example a system profile[title it "main profile"] with several check-boxes unticked and one["additional profile"] with the same check-boxes ticked, and then screenshot of additional profiles for profile groups for the user]
}}

Which Metis Objects are Version specific?

=== Managing versions ===

====Search====

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Versions based on various criterions. 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 disaplyed below/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

====Add====

In the '''Versions''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Version. When it is clicked, the '''Version''' creation window opens, it contains two different type of information. The first tab '''Version''' shows a table separated into several expandable sections with two columns, '''Designation''' which represents the type of field and '''Value''' which represents the data entered into that field. All those fields provides the detailed description of a version. Only the ones with the edit icon on the right-hand side of the table can be defined by the user. The other ones are either inheritance from the parent version or imported through a third-party system.

[[File:MSM_Versions_Versions_add_Versions.png|center|600x400px]]

{{Note
| Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field.
}}

When creating a new version, the fields in the versions tab can be edited in order to define the version.

'''''Main'''''

* Version: Name of the version.
* Administrator Free: Choose to make a version administrator free. By setting the version to be administration free, the fields under the Customer section become available.
* Nomad Gateway User: A nomad gateway user can be defined in this field.
* Use Parent documents: Choose to use parent documents for the current version.
* Second ID to display : Secondary ID for he version.
* Default currency : set the default currency to used for all offers created within this version.
* Role for client condition : Role which specifies which Address is taken to apply '''[[Description_of_the_Menu_Prices#Customer_Prices|Customer Prices]]'''.

'''''Conditions'''''

* GSP Discount: The global sales price discount. Entering a figure here for example 50.0, means that a discount of 50% will be factored into the global sales price for this version. The GSP Discount can only be defined for a version by the parent version.

'''''Customer'''''

* OrgID: Organization ID
* Name 1: Name of the customer contact.
* Name 2: Additional name field for a contact.
* Name 3: Additional name field for a contact.
* Address 1: Address of where the customer is located (i.e. street name)
* Address 2: Additional address field for the customer (i.e. building name).
* City Name: City of where the customer is located. A drop-down list of available cities can provided for selection (see Data Management)
* ZipCode: Zipcode for where the customer is located.
* Country: Country where the customer is located. A drop-down list of available countries can provided for selection (see Data Management).
* State: State in the country where the customer is located. A drop-down list of states can be provided for selection (see Data Management).

'''''Directories'''''

Directories may only be specified within the version currently logged-in to. Parent versions cannot choose the directory for child versions. When a directory has been specified, the folder path will be shown in the corresponding field.

* Exchange: link to a folder used for saving FQS files.
* Document: link to a folder used for saving documents that are related to offers.
* Order: link to a folder used for saving XML and SES files.
* Libraries: link to a folder used for software libraries.

'''Profiles'''

'''[[Description of the Menu Profiles | Profiles]]''' are set to a version by the parent of that version in the section '''From Creator'''. Versions that have been automatically created by importation have their profiles also automatically set and cannot have their profiles edited.

However, additional profiles can be given to these versions in the section '''From parent'''. The '''Form parent''' section is only visible for these automatically created versions. To the right of the edit icon column is another column that has an eye for an icon.

Clicking on this eye lets the user see what items are defined by the current profile. Meaning that if the system profile "Default systems" was selected, doing so will display which systems are available in this profile.

[[File:MSM_Versions_Versions_add_profiles.png|center|600x400px]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/d/d2/VID_AdditionalProfilesConcept.PNG'>File:Additional_Profiles_OK.mp4‎</mediaplayer>
| Managing additional Profiles in versions.
}}

'''''From Creator'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

'''''From Parent'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

====Edit====

In the '''Versions''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version. Selecting a version and clicking on it opens the '''Version''' edition window where all related properties and information can be edited.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Version. Modifications applied to the selected version will only be saved once the version edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

[[File:MSM_Versions_Versions_Edit_Version.png|center|600x400px]]

====Delete====

In the '''Version''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Version. Selecting a version and clicking on it displays the following confirmation window.

[[File:MSM_Versions_Versions_delete_2.png|center]]

Once the warning is confirmed, the selected version is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| It is not possible to delete a version unless logged-in to the version that created it.

[[File:MSM_Versions_Versions_delete.png|center]]

}}

====Preview====

In the '''Versions''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected version. Selecting a version from the list and clicking on it opens the '''Version''' preview window.

[[File:MSM_Versions_Versions_Preview_profile.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 ... .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In the rightmost column of the table displayed in the '''Version''' preview window, the icon representing an eye can be used to display the list Systems, Hierarchies, Price Categories, Attributes, Variants, Service Models and Tax Models which have been set for the various profiles. No edition is possible.

==== Version without Administrator ====

As stated in the name, version without administrator is a Metis Smart Suite Version which doesn't include an administrator. This type of version is mainly used when no direct maintenance is required on the version level or when it is simply not wished to let the version be maintained individually.

A version without administrator is always created and maintained by its parent version.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/f/fe/VID_VersionNoAdmin.png'>File:Setting_a_version_without_an_administrator_OK.mp4‎</mediaplayer>
| Setting up a version without an administrator.
}}

== Access ==

From this sub-menu, the administrator can define and manage the access between the various children versions, as shown in the following example:

[[File:MSM_Versions_Access.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find versions based on various criterion. The search is triggered by typing a keyword or only a letter in the field 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 list.

=== Editing a Version's Rights ===

In the '''Version Rights''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version Right. Selecting a version right and clicking on it opens the '''Version Rights''' edition window where all related properties and information can be edited.

[[File:MSM_Versions_Access_Edit.png|center|600x400px]]

{{Note
| The title on the window displays the name of selected version (e.g. Version Rights Headquarters where Headquarters is the name of the selected version).
}}

The Versions (Smart Quotes) table displays all the available versions. The displayed versions consist of all of the children versions of the administrator's version. The authorized column allows the administrator to select / deselect the versions that the Smart Quotes users is authorized to access to. The following example describes the cases where a version can have access to the projects and offers made in other versions:

[[File:MetisSmartModelingVersionsProfileDiagram.PNG]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/a/a3/VID_Manage_the_version_access.png'>File:Managing_the_access_of_versions_OK.mp4‎</mediaplayer>
| Managing version access.
}}

An administrator of Version A can define that the Version A users can have access to the direct children versions' projects and offers (i.e. Version B, Version C and Version D). However, Version A users cannot access Version E's projects and offers because Version E is not a direct child of Version A.

The administrator of Version A can also define that Version B users can have access to Version C's projects and offers but not to Version D's projects and offer. The same administrator could also define that Version C users can only have access to Version B's projects and offers.

The authorization is not bi-directional: if Version B users have access to Version C's projects and offers, Version C users do not automatically receive access to Version B's projects and offers. The administrator must set the authorizations for each version.

=== Previewing a Version's Rights ===

In the '''Version Access''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Version Rights. Selecting a Version Right from the table/list and clicking on it opens the '''Version Rights''' preview window.

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

For detailed descriptions of all information available in this window please refer to the section dedicated to the edition of a version right .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In this window, only the authorized versions are displayed. This means that if a version is not authorized to see the projects or the offers or at least one other version, the table is empty as shown in the following example:

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

== Languages ==

Metis Smart Suite supports the use of multiple languages for single roll-outs of the application. Different languages can then be used to translate the [[Metis_Smart_Modeling_-_Setup|User Interface]] and/or the objects created in Metis Smart Modeling, the documents generated by Metis Smart Quotes or the Notes provided by the End-Users In this menu, the administrator defines the languages that the Metis Smart Modeling and Metis Smart Quote users are authorized to use.

{{Warning
| The administrator can define a maximum of four languages per version.
}}

Languages defined in this menu are then made available in the following parts of Metis:

* when a designation is required for an item (e.g. a language, a [[Description_of_the_Menu_Positions|position]], an [[Metis_Smart_Modeling_-_Attributes|attribute]] etc.), the designation may be entered for all the languages that have been made available.

* In the [[Description_of_the_Menu_Users|Users]] menu when defining a user's main language

* In the [[Description of the Sub-Menu Functionalities#Languages tab | Profiles]] menu when setting a default language for a functionality profile.

* In the [[Metis_Smart_Modeling_-_Setup|Setup]] menu when selecting the User Interface language for the application.

* In various part of Metis Smart Quotes as when creating a contact.

{{Note
| The designations in the other languages are used in the case where a designation is missing for the language in which the user is currently working with (see the [[#Priority| Priority]] section below).
}}

=== Adding a New Language ===

Before adding or creating a language, the administrator has to make sure that the maximum number of languages per version is not reached. A click on the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] displays the following window:

[[File:MetisSmartModelingAddLangageSelection.PNG|center|300x350px]]

The administrator can either add an existing language or create a new language.

==== Adding an Existing Language ====

If the administrator chooses to add an existing language, the following window appears after selecting the "Add available language" option:

[[File:MetisSmartModelingLanguageAddExistingLanguage.PNG|center|600x400px]]

The contents of this window is non editable.

The window contains the list of all the available languages. These languages can come from one of the following sources:
* an ascendant version
* the current version
* a descendant version

The first three columns of the window (Flag, Code and Designation) show the country flag, the language code and the language designation. The last column (Version) indicates the version in which the language has been created.

To add a language to the current version, select a language then click on the OK icon. The Languages menu is displayed again with the added language(s). In the language selection menu, it is possible to select several languages at the same time. If the administrator tries to select too many languages and exceeds the 4 authorized languages per version, a pop up window appears. If the user tries to select a language that has already been made available for the current version, a pop up window appears.

==== Creating a New Language ====

If the administrator chooses to create a new language, the following window appears after selecting the "Create a new language" option:

[[File:MetisSmartModelingLanguageAddNewLanguage.PNG|center|600x400px]]

The properties of the language must be provided, that is to say:
* a picture representing the country flag
* a language code (preferably the ISO code)
* a designation
* a translation for each language that has already been made available by the administrator

The language code field is mandatory in order to save the language. This field is limited to four characters and cannot be changed afterwards.

{{Note
| It is highly recommended to use the [http://www.iso.org/iso/english_country_names_and_code_elements official ISO country code].
}}

To define a picture representing the country flag for the language, click on the frame located on the top right side. A window opens as shown in the following example:

[[File:MetisSmartModelingLanguageAddFlagIcon.PNG|center|300x350px]]

The window contains the pictures that have been previously uploaded in the '''[[Description_of_the_Sub-Menu_Cliparts | Cliparts]]''' menu.

The language designation is limited to 30 characters and is mandatory.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/0/0b/VID_Creating_a_language.png'>File:Creating_a_language_OK.mp4‎</mediaplayer>
| Creating a language.
}}

For each language that has already been made available by the administrator, a designation should be provided. This designation should be the name of the created language translated into the other language (e.g. "Russian" in English, "Russe" in French, "Russisch" in German etc.).

=== Editing a Language ===

In the '''Languages''' 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 Language. Selecting a Language and clicking on it opens the '''Languages''' edition window where all related properties and information can be edited.

[[File:MetisSmartModelingLanguageEdit.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the country flag
* an ISO language code
* designation
* the designation of the language (for each language that has been made available by the administrator)

If the administrator is not the owner of the language (i.e. the language has been created in another version), it is only possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator). The language code and the picture cannot be edited.

If the administrator is the owner of the language, it is possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator) and the picture representing the country flag. The language code cannot be edited.

=== Preview ===

In the '''Languages''' 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 Language. Selecting a language from the table and clicking on it opens the '''Languages''' preview window.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Language.

[[File:MetisSmartModelingLanguagePreview.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the flag
* an ISO language code
* a designation
* the designation of the language (for each language that has been made available by the administrator)

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

=== Priority ===

The order in which the languages are displayed correspond to the language priority order. This order is considered when a description is missing for an item. When a description is missing, Metis looks for the item description in the other available languages and displays this description. This means that if the description of an item is missing in the first language, Metis displays the description in the second language if it exists. If not, the description in the third language is displayed and so on.

The priority can be modified by clicking on the ''Priority'' button. The following window appears:

[[File:MetisSmartModelingLanguagePriority.PNG|center|300x350px]]

The table is populated with the languages that have been defined for the current version. The contents of the table cannot be edited. The priority order of the language can be defined using the up and down arrows on the right of the table. The language at the top of the table has the highest priority. The language at the bottom of the table has the lowest priority.

=== Deleting a Language ===

In the '''Languages''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Language. Selecting a Language and clicking on it displays the following confirmation window, if the version has been manually created (i.e. no lock) or is owned by the current version, a confirmation window appears.

Once the warning is confirmed, the selected Language is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| If all the languages are deleted, Metis proposes by default English as the language of the version.
}}

{{Note
| If the language is owned by another version (i.e. presence of a lock), the language cannot be deleted.

[[File:MSM_Versions_Languages_Languages_Delete.png|center]]

}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/e/eb/VID_managing_the_languages_of_a_version.png'>File:Managing_languages_OK.mp4‎</mediaplayer>
| Managing languages of a version.
}}

== Update ==

The Metis Smart Suite update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.

=== Update process Overview ===

In order for this process to efficiently distribute all that information, the functionality works based on the diagram below.

[[File:IMG_Update_Process.png|center|600x400px]]

All update related settings, information and files are bundled together within Metis Smart Suite and sent to a web-service hosted on a web-server. The local instances of Metis Smart Quotes then inquires this service for available updates and notifies the user. If validated, the update takes places and the application will be restarted.

=== Preparing Metis Smart Quotes Updates ===

The update sub-menu is used to prepare updates for offline versions of the Metis Smart Quotes. By default an update which will be created here will include the various databases required by the applications. The update preparation tool in Metis Smart Modeling can be used to fine tune this update. The first type of additional information which can be included in an update are files. The concept is that throughout the settings, external files could be required by Metis Smart Quotes in order to provide to the end-user different information. For example, in the [[Description_of_the_Sub-Menu_Notes|Notes]] menu of the software, the various note types allow the user to import default texts in the note. Those default texts need to be distributed and linked to the application. In the definition of the note setting the administrator sets up a link to a folder where those templates will be stored. When creating the update the idea is to list those templates and define where they will be placed within the local instance of the application. Therefore, the link defined within the profile will also be set in the "destination folder" column of the update preparation.

[[File:MSM_Versions_Uptdate.png|center|600x400px]]

In the update sub-menu the main working area is dedicated to a table with the following columns:

*'''Source File Name''': The name of the original file found under either the "Common Files" or "Specific Files" folder depending on the choice made.
*'''Dest. Folder''': An editable field where the user can enter the destination folder for the file after being updated.
*'''Dest. Filename''': An editable field where the user can enter a new name for the file after being distributed.
*'''File Date''': The date the original file was created.
*'''Behavior''': Describes what will happen once the update has been executed. A drop-down menu with three different options is found in this column.
**Overwite if more recent: The file will be replaced with a more recent version if one is available.
**Ignore if already existing: The file will remain untouched if it is found to already exist.
**Force overwrite: The file will be replaced no matter what the case.

Updates must be prepared in online mode. The purpose of the update process is that when updating a version, the update will automatically be available to the offline users of the version as well as the offline users of the child versions.

Updates may be available for online and offline versions of MSQ. Only the information owned by a version may be used for updates. Data which is owned by a version means data which has been created by the administrator of that version.

For example, on the diagram, the HQ version is the parent of the versions ENG, FRA, GER, JPN, and USA. USA is the parent of the versions NY and WA. This means that NY and WA are the grandchildren of the HQ version.

If an administrator of the HQ version prepares an update, the offline users of the HQ, ENG, FRA, GER, JPN, USA, NY and WA versions also receive the update.

If an administrator of the USA version prepares an update, the versions HQ, ENG, FRA, GER and JPN do not receive the update. Only the USA version and the child versions of USA receive it.

[[File:IMG_Version_Concept.png|center|600x400px]]

====Add Files====

Clicking on the "Add Files" button [[File:MetisSmartModelingCurrentlyAddFilesButton.PNG|link=]] opens a window that asks the user which type of files they wish to add, either '''Common Files''' or '''Specific Files'''. Common files are files which will be distributed to the selected version and its child versions after the update process. Specific files are files which will only be distributed to the selected version when preparing an update. The child versions will not receive the file after the update process.

[[File:MSM_Versions_Update_Add_Files.png|center]]

After selecting a file type and confirming, a MS Windows Explorer window opens where the user may add one or more files at the same time and then clicking on open to complete the process. The files are then added to the main table of the update sub-menu. Depending on the file type chosen, the files will appear under the appropriate folder.

====Delete Files====

In the '''Update''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Files. Selecting one or more files and clicking on it displays the following confirmation window.

Once the warning is confirmed, the selected files are removed from the Metis Smart Suite Update.

====Prepare Update====

After the desired file or files have been added to the update, the user can then begin to generate the update with the "Prepare Update" button [[File:MetisSmartModelingPrepareUpdateButton.PNG|link=]] button.

When selecting a file and clicking on this button, the user is presented with a pop-up window asking if they are sure that they want to run the update process.

The '''Preparing Update...''' window opens after confirming the pop-up. In this window the user is presented with a table with three columns including the '''Date''', '''Message''', and '''Status'''.

The '''Date''' columns list the date and time of the message given in the table, the '''Message''' column provides information to the user in the form of short messages indicating the current status of the update process, and the '''Status''' column is filled with either a green check-mark indicating successful step in the update process or a red x indicating an error in the update process. In the case of an error, a short notice will be displayed in the message column describing the error.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/5/5e/VID_preparing_update.png'>File:PreparingAnUpdateForOfflineInstallations_OK.mp4‎</mediaplayer>
| Preparing an update for offline installations.
}}

{{Warning
| In order for the update preparation and distribution to go through normally, it is required to define the update settings in the functionality profiles in the version in which the administrator works; and in the versions which are targeted by the update.

For the Metis Smart Quotes instances targeted by the update to receive the update it is of course necessary that the profiles define the correct update settings.
}}

== Licensing ==

(TBD)

File:MetisSmartModelingVersionNoAdminIcon.png

2014-01-15T13:01:10Z

PatrickG:

File:MetisSmartModelingVersionInactiveIcon.png

2014-01-15T13:00:49Z

PatrickG:

File:MetisSmartModelingVersionIcon.png

2014-01-15T13:00:08Z

PatrickG:

Description of the Menu Versions

2014-01-15T12:58:07Z

PatrickG: /* Overview of versions */

As Metis Smart Suite can be rolled out in small to large organizations the software supports a versioning concepts. These feature allows it to be structured in a tree like schema. As the root of this tree there will always be the main delivered version of the application.

The branches from that tree will represent created version within the organization. As described in the figure below the headquarters of an organization is placed at the root of the tree, and all the country specific subsidiaries, for example, are shown as first child version (i.e. first level nodes). The leafs of the tree from a specific branch are for example partners within that country.

Within Metis Smart Suite a version is mainly described by its name and basic information, conditions, customer designation and directories which have to be used by it. Additionally '''[[Description of the Menu Profiles | Profiles]]''' of all types can be linked to a version in order to enforce default rights and privileges to all users which will be created in that version.

Versions are a key element of the Metis Smart Suite. This functionality allows the administrator to re-create the sales or legal structure of the company in which the software suite is being deployed. Additional examples of how this structure can support any organization can be found within the various screenshots of that section.

== Versions ==

Both Metis Smart Modeling users and administrators can create as many versions as required. As a reminder, versions that descend from a main version are classified as child versions. The main versions which create these child versions are classified as parent versions. This means that any single version may be a parent or child version, depending on the point of view.

[[File:MSM_Versions_Versions.png|center|600x400px]]

=== Overview of versions ===

Users may add, delete, edit, and preview versions in this sub-menu. A search feature can be found on the left side and a main table containing general information is found in the working area.

In this table, the parent version (the currently logged-in version) is featured at the top with all its child versions listed below.
Versions in the main table may be represented by several different types of icons.

{| 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 version
! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Icon
! 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" |
'''Normal Version'''
| 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" |
Standard Metis Smart Suite Version.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" |
'''Version without Admin'''
| 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" |
There are no Users defined as administrator for this version. It depends entirely on the parent version's Administrator.
|-
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" |
'''Inactive Version'''
| 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" |
Version Exists in the Metis Smart Suite Database, but has been set to disabled.
|-
|}

A lock icon may be found preceding any of these types of versions. The lock icon signifies that the version was not created in the version currently logged-in, but in another version or by an automated system.

[[File:MSM_Versions_Versions.png|center|600x400px]]

[[File:IMG_Version_Concept.png|center|600x400px]]

{{Note
| Imported versions which are denied access to certain items through profile groups, can never have access to these items even if they are given access through the use of additional profiles.

[take a screenshot of for example a system profile[title it "main profile"] with several check-boxes unticked and one["additional profile"] with the same check-boxes ticked, and then screenshot of additional profiles for profile groups for the user]
}}

Which Metis Objects are Version specific?

=== Managing versions ===

====Search====

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Versions based on various criterions. 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 disaplyed below/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

====Add====

In the '''Versions''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Version. When it is clicked, the '''Version''' creation window opens, it contains two different type of information. The first tab '''Version''' shows a table separated into several expandable sections with two columns, '''Designation''' which represents the type of field and '''Value''' which represents the data entered into that field. All those fields provides the detailed description of a version. Only the ones with the edit icon on the right-hand side of the table can be defined by the user. The other ones are either inheritance from the parent version or imported through a third-party system.

[[File:MSM_Versions_Versions_add_Versions.png|center|600x400px]]

{{Note
| Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field.
}}

When creating a new version, the fields in the versions tab can be edited in order to define the version.

'''''Main'''''

* Version: Name of the version.
* Administrator Free: Choose to make a version administrator free. By setting the version to be administration free, the fields under the Customer section become available.
* Nomad Gateway User: A nomad gateway user can be defined in this field.
* Use Parent documents: Choose to use parent documents for the current version.
* Second ID to display : Secondary ID for he version.
* Default currency : set the default currency to used for all offers created within this version.
* Role for client condition : Role which specifies which Address is taken to apply '''[[Description_of_the_Menu_Prices#Customer_Prices|Customer Prices]]'''.

'''''Conditions'''''

* GSP Discount: The global sales price discount. Entering a figure here for example 50.0, means that a discount of 50% will be factored into the global sales price for this version. The GSP Discount can only be defined for a version by the parent version.

'''''Customer'''''

* OrgID: Organization ID
* Name 1: Name of the customer contact.
* Name 2: Additional name field for a contact.
* Name 3: Additional name field for a contact.
* Address 1: Address of where the customer is located (i.e. street name)
* Address 2: Additional address field for the customer (i.e. building name).
* City Name: City of where the customer is located. A drop-down list of available cities can provided for selection (see Data Management)
* ZipCode: Zipcode for where the customer is located.
* Country: Country where the customer is located. A drop-down list of available countries can provided for selection (see Data Management).
* State: State in the country where the customer is located. A drop-down list of states can be provided for selection (see Data Management).

'''''Directories'''''

Directories may only be specified within the version currently logged-in to. Parent versions cannot choose the directory for child versions. When a directory has been specified, the folder path will be shown in the corresponding field.

* Exchange: link to a folder used for saving FQS files.
* Document: link to a folder used for saving documents that are related to offers.
* Order: link to a folder used for saving XML and SES files.
* Libraries: link to a folder used for software libraries.

'''Profiles'''

'''[[Description of the Menu Profiles | Profiles]]''' are set to a version by the parent of that version in the section '''From Creator'''. Versions that have been automatically created by importation have their profiles also automatically set and cannot have their profiles edited.

However, additional profiles can be given to these versions in the section '''From parent'''. The '''Form parent''' section is only visible for these automatically created versions. To the right of the edit icon column is another column that has an eye for an icon.

Clicking on this eye lets the user see what items are defined by the current profile. Meaning that if the system profile "Default systems" was selected, doing so will display which systems are available in this profile.

[[File:MSM_Versions_Versions_add_profiles.png|center|600x400px]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/d/d2/VID_AdditionalProfilesConcept.PNG'>File:Additional_Profiles_OK.mp4‎</mediaplayer>
| Managing additional Profiles in versions.
}}

'''''From Creator'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

'''''From Parent'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

====Edit====

In the '''Versions''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version. Selecting a version and clicking on it opens the '''Version''' edition window where all related properties and information can be edited.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Version. Modifications applied to the selected version will only be saved once the version edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

[[File:MSM_Versions_Versions_Edit_Version.png|center|600x400px]]

====Delete====

In the '''Version''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Version. Selecting a version and clicking on it displays the following confirmation window.

[[File:MSM_Versions_Versions_delete_2.png|center]]

Once the warning is confirmed, the selected version is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| It is not possible to delete a version unless logged-in to the version that created it.

[[File:MSM_Versions_Versions_delete.png|center]]

}}

====Preview====

In the '''Versions''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected version. Selecting a version from the list and clicking on it opens the '''Version''' preview window.

[[File:MSM_Versions_Versions_Preview_profile.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 ... .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In the rightmost column of the table displayed in the '''Version''' preview window, the icon representing an eye can be used to display the list Systems, Hierarchies, Price Categories, Attributes, Variants, Service Models and Tax Models which have been set for the various profiles. No edition is possible.

==== Version without Administrator ====

As stated in the name, version without administrator is a Metis Smart Suite Version which doesn't include an administrator. This type of version is mainly used when no direct maintenance is required on the version level or when it is simply not wished to let the version be maintained individually.

A version without administrator is always created and maintained by its parent version.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/f/fe/VID_VersionNoAdmin.png'>File:Setting_a_version_without_an_administrator_OK.mp4‎</mediaplayer>
| Setting up a version without an administrator.
}}

== Access ==

From this sub-menu, the administrator can define and manage the access between the various children versions, as shown in the following example:

[[File:MSM_Versions_Access.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find versions based on various criterion. The search is triggered by typing a keyword or only a letter in the field 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 list.

=== Editing a Version's Rights ===

In the '''Version Rights''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version Right. Selecting a version right and clicking on it opens the '''Version Rights''' edition window where all related properties and information can be edited.

[[File:MSM_Versions_Access_Edit.png|center|600x400px]]

{{Note
| The title on the window displays the name of selected version (e.g. Version Rights Headquarters where Headquarters is the name of the selected version).
}}

The Versions (Smart Quotes) table displays all the available versions. The displayed versions consist of all of the children versions of the administrator's version. The authorized column allows the administrator to select / deselect the versions that the Smart Quotes users is authorized to access to. The following example describes the cases where a version can have access to the projects and offers made in other versions:

[[File:MetisSmartModelingVersionsProfileDiagram.PNG]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/a/a3/VID_Manage_the_version_access.png'>File:Managing_the_access_of_versions_OK.mp4‎</mediaplayer>
| Managing version access.
}}

An administrator of Version A can define that the Version A users can have access to the direct children versions' projects and offers (i.e. Version B, Version C and Version D). However, Version A users cannot access Version E's projects and offers because Version E is not a direct child of Version A.

The administrator of Version A can also define that Version B users can have access to Version C's projects and offers but not to Version D's projects and offer. The same administrator could also define that Version C users can only have access to Version B's projects and offers.

The authorization is not bi-directional: if Version B users have access to Version C's projects and offers, Version C users do not automatically receive access to Version B's projects and offers. The administrator must set the authorizations for each version.

=== Previewing a Version's Rights ===

In the '''Version Access''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Version Rights. Selecting a Version Right from the table/list and clicking on it opens the '''Version Rights''' preview window.

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

For detailed descriptions of all information available in this window please refer to the section dedicated to the edition of a version right .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In this window, only the authorized versions are displayed. This means that if a version is not authorized to see the projects or the offers or at least one other version, the table is empty as shown in the following example:

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

== Languages ==

Metis Smart Suite supports the use of multiple languages for single roll-outs of the application. Different languages can then be used to translate the [[Metis_Smart_Modeling_-_Setup|User Interface]] and/or the objects created in Metis Smart Modeling, the documents generated by Metis Smart Quotes or the Notes provided by the End-Users In this menu, the administrator defines the languages that the Metis Smart Modeling and Metis Smart Quote users are authorized to use.

{{Warning
| The administrator can define a maximum of four languages per version.
}}

Languages defined in this menu are then made available in the following parts of Metis:

* when a designation is required for an item (e.g. a language, a [[Description_of_the_Menu_Positions|position]], an [[Metis_Smart_Modeling_-_Attributes|attribute]] etc.), the designation may be entered for all the languages that have been made available.

* In the [[Description_of_the_Menu_Users|Users]] menu when defining a user's main language

* In the [[Description of the Sub-Menu Functionalities#Languages tab | Profiles]] menu when setting a default language for a functionality profile.

* In the [[Metis_Smart_Modeling_-_Setup|Setup]] menu when selecting the User Interface language for the application.

* In various part of Metis Smart Quotes as when creating a contact.

{{Note
| The designations in the other languages are used in the case where a designation is missing for the language in which the user is currently working with (see the [[#Priority| Priority]] section below).
}}

=== Adding a New Language ===

Before adding or creating a language, the administrator has to make sure that the maximum number of languages per version is not reached. A click on the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] displays the following window:

[[File:MetisSmartModelingAddLangageSelection.PNG|center|300x350px]]

The administrator can either add an existing language or create a new language.

==== Adding an Existing Language ====

If the administrator chooses to add an existing language, the following window appears after selecting the "Add available language" option:

[[File:MetisSmartModelingLanguageAddExistingLanguage.PNG|center|600x400px]]

The contents of this window is non editable.

The window contains the list of all the available languages. These languages can come from one of the following sources:
* an ascendant version
* the current version
* a descendant version

The first three columns of the window (Flag, Code and Designation) show the country flag, the language code and the language designation. The last column (Version) indicates the version in which the language has been created.

To add a language to the current version, select a language then click on the OK icon. The Languages menu is displayed again with the added language(s). In the language selection menu, it is possible to select several languages at the same time. If the administrator tries to select too many languages and exceeds the 4 authorized languages per version, a pop up window appears. If the user tries to select a language that has already been made available for the current version, a pop up window appears.

==== Creating a New Language ====

If the administrator chooses to create a new language, the following window appears after selecting the "Create a new language" option:

[[File:MetisSmartModelingLanguageAddNewLanguage.PNG|center|600x400px]]

The properties of the language must be provided, that is to say:
* a picture representing the country flag
* a language code (preferably the ISO code)
* a designation
* a translation for each language that has already been made available by the administrator

The language code field is mandatory in order to save the language. This field is limited to four characters and cannot be changed afterwards.

{{Note
| It is highly recommended to use the [http://www.iso.org/iso/english_country_names_and_code_elements official ISO country code].
}}

To define a picture representing the country flag for the language, click on the frame located on the top right side. A window opens as shown in the following example:

[[File:MetisSmartModelingLanguageAddFlagIcon.PNG|center|300x350px]]

The window contains the pictures that have been previously uploaded in the '''[[Description_of_the_Sub-Menu_Cliparts | Cliparts]]''' menu.

The language designation is limited to 30 characters and is mandatory.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/0/0b/VID_Creating_a_language.png'>File:Creating_a_language_OK.mp4‎</mediaplayer>
| Creating a language.
}}

For each language that has already been made available by the administrator, a designation should be provided. This designation should be the name of the created language translated into the other language (e.g. "Russian" in English, "Russe" in French, "Russisch" in German etc.).

=== Editing a Language ===

In the '''Languages''' 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 Language. Selecting a Language and clicking on it opens the '''Languages''' edition window where all related properties and information can be edited.

[[File:MetisSmartModelingLanguageEdit.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the country flag
* an ISO language code
* designation
* the designation of the language (for each language that has been made available by the administrator)

If the administrator is not the owner of the language (i.e. the language has been created in another version), it is only possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator). The language code and the picture cannot be edited.

If the administrator is the owner of the language, it is possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator) and the picture representing the country flag. The language code cannot be edited.

=== Preview ===

In the '''Languages''' 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 Language. Selecting a language from the table and clicking on it opens the '''Languages''' preview window.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Language.

[[File:MetisSmartModelingLanguagePreview.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the flag
* an ISO language code
* a designation
* the designation of the language (for each language that has been made available by the administrator)

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

=== Priority ===

The order in which the languages are displayed correspond to the language priority order. This order is considered when a description is missing for an item. When a description is missing, Metis looks for the item description in the other available languages and displays this description. This means that if the description of an item is missing in the first language, Metis displays the description in the second language if it exists. If not, the description in the third language is displayed and so on.

The priority can be modified by clicking on the ''Priority'' button. The following window appears:

[[File:MetisSmartModelingLanguagePriority.PNG|center|300x350px]]

The table is populated with the languages that have been defined for the current version. The contents of the table cannot be edited. The priority order of the language can be defined using the up and down arrows on the right of the table. The language at the top of the table has the highest priority. The language at the bottom of the table has the lowest priority.

=== Deleting a Language ===

In the '''Languages''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Language. Selecting a Language and clicking on it displays the following confirmation window, if the version has been manually created (i.e. no lock) or is owned by the current version, a confirmation window appears.

Once the warning is confirmed, the selected Language is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| If all the languages are deleted, Metis proposes by default English as the language of the version.
}}

{{Note
| If the language is owned by another version (i.e. presence of a lock), the language cannot be deleted.

[[File:MSM_Versions_Languages_Languages_Delete.png|center]]

}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/e/eb/VID_managing_the_languages_of_a_version.png'>File:Managing_languages_OK.mp4‎</mediaplayer>
| Managing languages of a version.
}}

== Update ==

The Metis Smart Suite update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.

=== Update process Overview ===

In order for this process to efficiently distribute all that information, the functionality works based on the diagram below.

[[File:IMG_Update_Process.png|center|600x400px]]

All update related settings, information and files are bundled together within Metis Smart Suite and sent to a web-service hosted on a web-server. The local instances of Metis Smart Quotes then inquires this service for available updates and notifies the user. If validated, the update takes places and the application will be restarted.

=== Preparing Metis Smart Quotes Updates ===

The update sub-menu is used to prepare updates for offline versions of the Metis Smart Quotes. By default an update which will be created here will include the various databases required by the applications. The update preparation tool in Metis Smart Modeling can be used to fine tune this update. The first type of additional information which can be included in an update are files. The concept is that throughout the settings, external files could be required by Metis Smart Quotes in order to provide to the end-user different information. For example, in the [[Description_of_the_Sub-Menu_Notes|Notes]] menu of the software, the various note types allow the user to import default texts in the note. Those default texts need to be distributed and linked to the application. In the definition of the note setting the administrator sets up a link to a folder where those templates will be stored. When creating the update the idea is to list those templates and define where they will be placed within the local instance of the application. Therefore, the link defined within the profile will also be set in the "destination folder" column of the update preparation.

[[File:MSM_Versions_Uptdate.png|center|600x400px]]

In the update sub-menu the main working area is dedicated to a table with the following columns:

*'''Source File Name''': The name of the original file found under either the "Common Files" or "Specific Files" folder depending on the choice made.
*'''Dest. Folder''': An editable field where the user can enter the destination folder for the file after being updated.
*'''Dest. Filename''': An editable field where the user can enter a new name for the file after being distributed.
*'''File Date''': The date the original file was created.
*'''Behavior''': Describes what will happen once the update has been executed. A drop-down menu with three different options is found in this column.
**Overwite if more recent: The file will be replaced with a more recent version if one is available.
**Ignore if already existing: The file will remain untouched if it is found to already exist.
**Force overwrite: The file will be replaced no matter what the case.

Updates must be prepared in online mode. The purpose of the update process is that when updating a version, the update will automatically be available to the offline users of the version as well as the offline users of the child versions.

Updates may be available for online and offline versions of MSQ. Only the information owned by a version may be used for updates. Data which is owned by a version means data which has been created by the administrator of that version.

For example, on the diagram, the HQ version is the parent of the versions ENG, FRA, GER, JPN, and USA. USA is the parent of the versions NY and WA. This means that NY and WA are the grandchildren of the HQ version.

If an administrator of the HQ version prepares an update, the offline users of the HQ, ENG, FRA, GER, JPN, USA, NY and WA versions also receive the update.

If an administrator of the USA version prepares an update, the versions HQ, ENG, FRA, GER and JPN do not receive the update. Only the USA version and the child versions of USA receive it.

[[File:IMG_Version_Concept.png|center|600x400px]]

====Add Files====

Clicking on the "Add Files" button [[File:MetisSmartModelingCurrentlyAddFilesButton.PNG|link=]] opens a window that asks the user which type of files they wish to add, either '''Common Files''' or '''Specific Files'''. Common files are files which will be distributed to the selected version and its child versions after the update process. Specific files are files which will only be distributed to the selected version when preparing an update. The child versions will not receive the file after the update process.

[[File:MSM_Versions_Update_Add_Files.png|center]]

After selecting a file type and confirming, a MS Windows Explorer window opens where the user may add one or more files at the same time and then clicking on open to complete the process. The files are then added to the main table of the update sub-menu. Depending on the file type chosen, the files will appear under the appropriate folder.

====Delete Files====

In the '''Update''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Files. Selecting one or more files and clicking on it displays the following confirmation window.

Once the warning is confirmed, the selected files are removed from the Metis Smart Suite Update.

====Prepare Update====

After the desired file or files have been added to the update, the user can then begin to generate the update with the "Prepare Update" button [[File:MetisSmartModelingPrepareUpdateButton.PNG|link=]] button.

When selecting a file and clicking on this button, the user is presented with a pop-up window asking if they are sure that they want to run the update process.

The '''Preparing Update...''' window opens after confirming the pop-up. In this window the user is presented with a table with three columns including the '''Date''', '''Message''', and '''Status'''.

The '''Date''' columns list the date and time of the message given in the table, the '''Message''' column provides information to the user in the form of short messages indicating the current status of the update process, and the '''Status''' column is filled with either a green check-mark indicating successful step in the update process or a red x indicating an error in the update process. In the case of an error, a short notice will be displayed in the message column describing the error.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/5/5e/VID_preparing_update.png'>File:PreparingAnUpdateForOfflineInstallations_OK.mp4‎</mediaplayer>
| Preparing an update for offline installations.
}}

{{Warning
| In order for the update preparation and distribution to go through normally, it is required to define the update settings in the functionality profiles in the version in which the administrator works; and in the versions which are targeted by the update.

For the Metis Smart Quotes instances targeted by the update to receive the update it is of course necessary that the profiles define the correct update settings.
}}

== Licensing ==

(TBD)

Description of the Menu Versions

2014-01-15T07:43:49Z

PatrickG: /* Overview of versions */

As Metis Smart Suite can be rolled out in small to large organizations the software supports a versioning concepts. These feature allows it to be structured in a tree like schema. As the root of this tree there will always be the main delivered version of the application.

The branches from that tree will represent created version within the organization. As described in the figure below the headquarters of an organization is placed at the root of the tree, and all the country specific subsidiaries, for example, are shown as first child version (i.e. first level nodes). The leafs of the tree from a specific branch are for example partners within that country.

Within Metis Smart Suite a version is mainly described by its name and basic information, conditions, customer designation and directories which have to be used by it. Additionally '''[[Description of the Menu Profiles | Profiles]]''' of all types can be linked to a version in order to enforce default rights and privileges to all users which will be created in that version.

Versions are a key element of the Metis Smart Suite. This functionality allows the administrator to re-create the sales or legal structure of the company in which the software suite is being deployed. Additional examples of how this structure can support any organization can be found within the various screenshots of that section.

== Versions ==

Both Metis Smart Modeling users and administrators can create as many versions as required. As a reminder, versions that descend from a main version are classified as child versions. The main versions which create these child versions are classified as parent versions. This means that any single version may be a parent or child version, depending on the point of view.

[[File:MSM_Versions_Versions.png|center|600x400px]]

=== Overview of versions ===

Users may add, delete, edit, and preview versions in this sub-menu. A search feature can be found on the left side and a main table containing general information is found in the working area.

In this table, the parent version (the currently logged-in version) is featured at the top with all its child versions listed below.
Versions in the main table may be represented by several different types of icons.

Versions with a globe icon represent a version without an administrator, versions with a globe and small person icon represent a version with an administrator, and versions with a greyed out globe icon represent inactive versions.

A lock icon may be found preceding any of these types of versions. The lock icon signifies that the version was not created in the version currently logged-in, but in another version or by an automated system.

[[File:MSM_Versions_Versions.png|center|600x400px]]

[[File:IMG_Version_Concept.png|center|600x400px]]

{{Note
| Imported versions which are denied access to certain items through profile groups, can never have access to these items even if they are given access through the use of additional profiles.

[take a screenshot of for example a system profile[title it "main profile"] with several check-boxes unticked and one["additional profile"] with the same check-boxes ticked, and then screenshot of additional profiles for profile groups for the user]
}}

Which Metis Objects are Version specific?

=== Managing versions ===

====Search====

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Versions based on various criterions. 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 disaplyed below/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

====Add====

In the '''Versions''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Version. When it is clicked, the '''Version''' creation window opens, it contains two different type of information. The first tab '''Version''' shows a table separated into several expandable sections with two columns, '''Designation''' which represents the type of field and '''Value''' which represents the data entered into that field. All those fields provides the detailed description of a version. Only the ones with the edit icon on the right-hand side of the table can be defined by the user. The other ones are either inheritance from the parent version or imported through a third-party system.

[[File:MSM_Versions_Versions_add_Versions.png|center|600x400px]]

{{Note
| Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field.
}}

When creating a new version, the fields in the versions tab can be edited in order to define the version.

'''''Main'''''

* Version: Name of the version.
* Administrator Free: Choose to make a version administrator free. By setting the version to be administration free, the fields under the Customer section become available.
* Nomad Gateway User: A nomad gateway user can be defined in this field.
* Use Parent documents: Choose to use parent documents for the current version.
* Second ID to display : Secondary ID for he version.
* Default currency : set the default currency to used for all offers created within this version.
* Role for client condition : Role which specifies which Address is taken to apply '''[[Description_of_the_Menu_Prices#Customer_Prices|Customer Prices]]'''.

'''''Conditions'''''

* GSP Discount: The global sales price discount. Entering a figure here for example 50.0, means that a discount of 50% will be factored into the global sales price for this version. The GSP Discount can only be defined for a version by the parent version.

'''''Customer'''''

* OrgID: Organization ID
* Name 1: Name of the customer contact.
* Name 2: Additional name field for a contact.
* Name 3: Additional name field for a contact.
* Address 1: Address of where the customer is located (i.e. street name)
* Address 2: Additional address field for the customer (i.e. building name).
* City Name: City of where the customer is located. A drop-down list of available cities can provided for selection (see Data Management)
* ZipCode: Zipcode for where the customer is located.
* Country: Country where the customer is located. A drop-down list of available countries can provided for selection (see Data Management).
* State: State in the country where the customer is located. A drop-down list of states can be provided for selection (see Data Management).

'''''Directories'''''

Directories may only be specified within the version currently logged-in to. Parent versions cannot choose the directory for child versions. When a directory has been specified, the folder path will be shown in the corresponding field.

* Exchange: link to a folder used for saving FQS files.
* Document: link to a folder used for saving documents that are related to offers.
* Order: link to a folder used for saving XML and SES files.
* Libraries: link to a folder used for software libraries.

'''Profiles'''

'''[[Description of the Menu Profiles | Profiles]]''' are set to a version by the parent of that version in the section '''From Creator'''. Versions that have been automatically created by importation have their profiles also automatically set and cannot have their profiles edited.

However, additional profiles can be given to these versions in the section '''From parent'''. The '''Form parent''' section is only visible for these automatically created versions. To the right of the edit icon column is another column that has an eye for an icon.

Clicking on this eye lets the user see what items are defined by the current profile. Meaning that if the system profile "Default systems" was selected, doing so will display which systems are available in this profile.

[[File:MSM_Versions_Versions_add_profiles.png|center|600x400px]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/d/d2/VID_AdditionalProfilesConcept.PNG'>File:Additional_Profiles_OK.mp4‎</mediaplayer>
| Managing additional Profiles in versions.
}}

'''''From Creator'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

'''''From Parent'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

====Edit====

In the '''Versions''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version. Selecting a version and clicking on it opens the '''Version''' edition window where all related properties and information can be edited.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Version. Modifications applied to the selected version will only be saved once the version edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

[[File:MSM_Versions_Versions_Edit_Version.png|center|600x400px]]

====Delete====

In the '''Version''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Version. Selecting a version and clicking on it displays the following confirmation window.

[[File:MSM_Versions_Versions_delete_2.png|center]]

Once the warning is confirmed, the selected version is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| It is not possible to delete a version unless logged-in to the version that created it.

[[File:MSM_Versions_Versions_delete.png|center]]

}}

====Preview====

In the '''Versions''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected version. Selecting a version from the list and clicking on it opens the '''Version''' preview window.

[[File:MSM_Versions_Versions_Preview_profile.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 ... .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In the rightmost column of the table displayed in the '''Version''' preview window, the icon representing an eye can be used to display the list Systems, Hierarchies, Price Categories, Attributes, Variants, Service Models and Tax Models which have been set for the various profiles. No edition is possible.

==== Version without Administrator ====

As stated in the name, version without administrator is a Metis Smart Suite Version which doesn't include an administrator. This type of version is mainly used when no direct maintenance is required on the version level or when it is simply not wished to let the version be maintained individually.

A version without administrator is always created and maintained by its parent version.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/f/fe/VID_VersionNoAdmin.png'>File:Setting_a_version_without_an_administrator_OK.mp4‎</mediaplayer>
| Setting up a version without an administrator.
}}

== Access ==

From this sub-menu, the administrator can define and manage the access between the various children versions, as shown in the following example:

[[File:MSM_Versions_Access.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find versions based on various criterion. The search is triggered by typing a keyword or only a letter in the field 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 list.

=== Editing a Version's Rights ===

In the '''Version Rights''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version Right. Selecting a version right and clicking on it opens the '''Version Rights''' edition window where all related properties and information can be edited.

[[File:MSM_Versions_Access_Edit.png|center|600x400px]]

{{Note
| The title on the window displays the name of selected version (e.g. Version Rights Headquarters where Headquarters is the name of the selected version).
}}

The Versions (Smart Quotes) table displays all the available versions. The displayed versions consist of all of the children versions of the administrator's version. The authorized column allows the administrator to select / deselect the versions that the Smart Quotes users is authorized to access to. The following example describes the cases where a version can have access to the projects and offers made in other versions:

[[File:MetisSmartModelingVersionsProfileDiagram.PNG]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/a/a3/VID_Manage_the_version_access.png'>File:Managing_the_access_of_versions_OK.mp4‎</mediaplayer>
| Managing version access.
}}

An administrator of Version A can define that the Version A users can have access to the direct children versions' projects and offers (i.e. Version B, Version C and Version D). However, Version A users cannot access Version E's projects and offers because Version E is not a direct child of Version A.

The administrator of Version A can also define that Version B users can have access to Version C's projects and offers but not to Version D's projects and offer. The same administrator could also define that Version C users can only have access to Version B's projects and offers.

The authorization is not bi-directional: if Version B users have access to Version C's projects and offers, Version C users do not automatically receive access to Version B's projects and offers. The administrator must set the authorizations for each version.

=== Previewing a Version's Rights ===

In the '''Version Access''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Version Rights. Selecting a Version Right from the table/list and clicking on it opens the '''Version Rights''' preview window.

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

For detailed descriptions of all information available in this window please refer to the section dedicated to the edition of a version right .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In this window, only the authorized versions are displayed. This means that if a version is not authorized to see the projects or the offers or at least one other version, the table is empty as shown in the following example:

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

== Languages ==

Metis Smart Suite supports the use of multiple languages for single roll-outs of the application. Different languages can then be used to translate the [[Metis_Smart_Modeling_-_Setup|User Interface]] and/or the objects created in Metis Smart Modeling, the documents generated by Metis Smart Quotes or the Notes provided by the End-Users In this menu, the administrator defines the languages that the Metis Smart Modeling and Metis Smart Quote users are authorized to use.

{{Warning
| The administrator can define a maximum of four languages per version.
}}

Languages defined in this menu are then made available in the following parts of Metis:

* when a designation is required for an item (e.g. a language, a [[Description_of_the_Menu_Positions|position]], an [[Metis_Smart_Modeling_-_Attributes|attribute]] etc.), the designation may be entered for all the languages that have been made available.

* In the [[Description_of_the_Menu_Users|Users]] menu when defining a user's main language

* In the [[Description of the Sub-Menu Functionalities#Languages tab | Profiles]] menu when setting a default language for a functionality profile.

* In the [[Metis_Smart_Modeling_-_Setup|Setup]] menu when selecting the User Interface language for the application.

* In various part of Metis Smart Quotes as when creating a contact.

{{Note
| The designations in the other languages are used in the case where a designation is missing for the language in which the user is currently working with (see the [[#Priority| Priority]] section below).
}}

=== Adding a New Language ===

Before adding or creating a language, the administrator has to make sure that the maximum number of languages per version is not reached. A click on the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] displays the following window:

[[File:MetisSmartModelingAddLangageSelection.PNG|center|300x350px]]

The administrator can either add an existing language or create a new language.

==== Adding an Existing Language ====

If the administrator chooses to add an existing language, the following window appears after selecting the "Add available language" option:

[[File:MetisSmartModelingLanguageAddExistingLanguage.PNG|center|600x400px]]

The contents of this window is non editable.

The window contains the list of all the available languages. These languages can come from one of the following sources:
* an ascendant version
* the current version
* a descendant version

The first three columns of the window (Flag, Code and Designation) show the country flag, the language code and the language designation. The last column (Version) indicates the version in which the language has been created.

To add a language to the current version, select a language then click on the OK icon. The Languages menu is displayed again with the added language(s). In the language selection menu, it is possible to select several languages at the same time. If the administrator tries to select too many languages and exceeds the 4 authorized languages per version, a pop up window appears. If the user tries to select a language that has already been made available for the current version, a pop up window appears.

==== Creating a New Language ====

If the administrator chooses to create a new language, the following window appears after selecting the "Create a new language" option:

[[File:MetisSmartModelingLanguageAddNewLanguage.PNG|center|600x400px]]

The properties of the language must be provided, that is to say:
* a picture representing the country flag
* a language code (preferably the ISO code)
* a designation
* a translation for each language that has already been made available by the administrator

The language code field is mandatory in order to save the language. This field is limited to four characters and cannot be changed afterwards.

{{Note
| It is highly recommended to use the [http://www.iso.org/iso/english_country_names_and_code_elements official ISO country code].
}}

To define a picture representing the country flag for the language, click on the frame located on the top right side. A window opens as shown in the following example:

[[File:MetisSmartModelingLanguageAddFlagIcon.PNG|center|300x350px]]

The window contains the pictures that have been previously uploaded in the '''[[Description_of_the_Sub-Menu_Cliparts | Cliparts]]''' menu.

The language designation is limited to 30 characters and is mandatory.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/0/0b/VID_Creating_a_language.png'>File:Creating_a_language_OK.mp4‎</mediaplayer>
| Creating a language.
}}

For each language that has already been made available by the administrator, a designation should be provided. This designation should be the name of the created language translated into the other language (e.g. "Russian" in English, "Russe" in French, "Russisch" in German etc.).

=== Editing a Language ===

In the '''Languages''' 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 Language. Selecting a Language and clicking on it opens the '''Languages''' edition window where all related properties and information can be edited.

[[File:MetisSmartModelingLanguageEdit.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the country flag
* an ISO language code
* designation
* the designation of the language (for each language that has been made available by the administrator)

If the administrator is not the owner of the language (i.e. the language has been created in another version), it is only possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator). The language code and the picture cannot be edited.

If the administrator is the owner of the language, it is possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator) and the picture representing the country flag. The language code cannot be edited.

=== Preview ===

In the '''Languages''' 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 Language. Selecting a language from the table and clicking on it opens the '''Languages''' preview window.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Language.

[[File:MetisSmartModelingLanguagePreview.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the flag
* an ISO language code
* a designation
* the designation of the language (for each language that has been made available by the administrator)

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

=== Priority ===

The order in which the languages are displayed correspond to the language priority order. This order is considered when a description is missing for an item. When a description is missing, Metis looks for the item description in the other available languages and displays this description. This means that if the description of an item is missing in the first language, Metis displays the description in the second language if it exists. If not, the description in the third language is displayed and so on.

The priority can be modified by clicking on the ''Priority'' button. The following window appears:

[[File:MetisSmartModelingLanguagePriority.PNG|center|300x350px]]

The table is populated with the languages that have been defined for the current version. The contents of the table cannot be edited. The priority order of the language can be defined using the up and down arrows on the right of the table. The language at the top of the table has the highest priority. The language at the bottom of the table has the lowest priority.

=== Deleting a Language ===

In the '''Languages''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Language. Selecting a Language and clicking on it displays the following confirmation window, if the version has been manually created (i.e. no lock) or is owned by the current version, a confirmation window appears.

Once the warning is confirmed, the selected Language is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| If all the languages are deleted, Metis proposes by default English as the language of the version.
}}

{{Note
| If the language is owned by another version (i.e. presence of a lock), the language cannot be deleted.

[[File:MSM_Versions_Languages_Languages_Delete.png|center]]

}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/e/eb/VID_managing_the_languages_of_a_version.png'>File:Managing_languages_OK.mp4‎</mediaplayer>
| Managing languages of a version.
}}

== Update ==

The Metis Smart Suite update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.

=== Update process Overview ===

In order for this process to efficiently distribute all that information, the functionality works based on the diagram below.

[[File:IMG_Update_Process.png|center|600x400px]]

All update related settings, information and files are bundled together within Metis Smart Suite and sent to a web-service hosted on a web-server. The local instances of Metis Smart Quotes then inquires this service for available updates and notifies the user. If validated, the update takes places and the application will be restarted.

=== Preparing Metis Smart Quotes Updates ===

The update sub-menu is used to prepare updates for offline versions of the Metis Smart Quotes. By default an update which will be created here will include the various databases required by the applications. The update preparation tool in Metis Smart Modeling can be used to fine tune this update. The first type of additional information which can be included in an update are files. The concept is that throughout the settings, external files could be required by Metis Smart Quotes in order to provide to the end-user different information. For example, in the [[Description_of_the_Sub-Menu_Notes|Notes]] menu of the software, the various note types allow the user to import default texts in the note. Those default texts need to be distributed and linked to the application. In the definition of the note setting the administrator sets up a link to a folder where those templates will be stored. When creating the update the idea is to list those templates and define where they will be placed within the local instance of the application. Therefore, the link defined within the profile will also be set in the "destination folder" column of the update preparation.

[[File:MSM_Versions_Uptdate.png|center|600x400px]]

In the update sub-menu the main working area is dedicated to a table with the following columns:

*'''Source File Name''': The name of the original file found under either the "Common Files" or "Specific Files" folder depending on the choice made.
*'''Dest. Folder''': An editable field where the user can enter the destination folder for the file after being updated.
*'''Dest. Filename''': An editable field where the user can enter a new name for the file after being distributed.
*'''File Date''': The date the original file was created.
*'''Behavior''': Describes what will happen once the update has been executed. A drop-down menu with three different options is found in this column.
**Overwite if more recent: The file will be replaced with a more recent version if one is available.
**Ignore if already existing: The file will remain untouched if it is found to already exist.
**Force overwrite: The file will be replaced no matter what the case.

Updates must be prepared in online mode. The purpose of the update process is that when updating a version, the update will automatically be available to the offline users of the version as well as the offline users of the child versions.

Updates may be available for online and offline versions of MSQ. Only the information owned by a version may be used for updates. Data which is owned by a version means data which has been created by the administrator of that version.

For example, on the diagram, the HQ version is the parent of the versions ENG, FRA, GER, JPN, and USA. USA is the parent of the versions NY and WA. This means that NY and WA are the grandchildren of the HQ version.

If an administrator of the HQ version prepares an update, the offline users of the HQ, ENG, FRA, GER, JPN, USA, NY and WA versions also receive the update.

If an administrator of the USA version prepares an update, the versions HQ, ENG, FRA, GER and JPN do not receive the update. Only the USA version and the child versions of USA receive it.

[[File:IMG_Version_Concept.png|center|600x400px]]

====Add Files====

Clicking on the "Add Files" button [[File:MetisSmartModelingCurrentlyAddFilesButton.PNG|link=]] opens a window that asks the user which type of files they wish to add, either '''Common Files''' or '''Specific Files'''. Common files are files which will be distributed to the selected version and its child versions after the update process. Specific files are files which will only be distributed to the selected version when preparing an update. The child versions will not receive the file after the update process.

[[File:MSM_Versions_Update_Add_Files.png|center]]

After selecting a file type and confirming, a MS Windows Explorer window opens where the user may add one or more files at the same time and then clicking on open to complete the process. The files are then added to the main table of the update sub-menu. Depending on the file type chosen, the files will appear under the appropriate folder.

====Delete Files====

In the '''Update''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Files. Selecting one or more files and clicking on it displays the following confirmation window.

Once the warning is confirmed, the selected files are removed from the Metis Smart Suite Update.

====Prepare Update====

After the desired file or files have been added to the update, the user can then begin to generate the update with the "Prepare Update" button [[File:MetisSmartModelingPrepareUpdateButton.PNG|link=]] button.

When selecting a file and clicking on this button, the user is presented with a pop-up window asking if they are sure that they want to run the update process.

The '''Preparing Update...''' window opens after confirming the pop-up. In this window the user is presented with a table with three columns including the '''Date''', '''Message''', and '''Status'''.

The '''Date''' columns list the date and time of the message given in the table, the '''Message''' column provides information to the user in the form of short messages indicating the current status of the update process, and the '''Status''' column is filled with either a green check-mark indicating successful step in the update process or a red x indicating an error in the update process. In the case of an error, a short notice will be displayed in the message column describing the error.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/5/5e/VID_preparing_update.png'>File:PreparingAnUpdateForOfflineInstallations_OK.mp4‎</mediaplayer>
| Preparing an update for offline installations.
}}

{{Warning
| In order for the update preparation and distribution to go through normally, it is required to define the update settings in the functionality profiles in the version in which the administrator works; and in the versions which are targeted by the update.

For the Metis Smart Quotes instances targeted by the update to receive the update it is of course necessary that the profiles define the correct update settings.
}}

== Licensing ==

(TBD)

Description of the Menu Versions

2014-01-15T07:36:14Z

PatrickG: /* Preview */

As Metis Smart Suite can be rolled out in small to large organizations the software supports a versioning concepts. These feature allows it to be structured in a tree like schema. As the root of this tree there will always be the main delivered version of the application.

The branches from that tree will represent created version within the organization. As described in the figure below the headquarters of an organization is placed at the root of the tree, and all the country specific subsidiaries, for example, are shown as first child version (i.e. first level nodes). The leafs of the tree from a specific branch are for example partners within that country.

Within Metis Smart Suite a version is mainly described by its name and basic information, conditions, customer designation and directories which have to be used by it. Additionally '''[[Description of the Menu Profiles | Profiles]]''' of all types can be linked to a version in order to enforce default rights and privileges to all users which will be created in that version.

Versions are a key element of the Metis Smart Suite. This functionality allows the administrator to re-create the sales or legal structure of the company in which the software suite is being deployed. Additional examples of how this structure can support any organization can be found within the various screenshots of that section.

== Versions ==

Both Metis Smart Modeling users and administrators can create as many versions as required. As a reminder, versions that descend from a main version are classified as child versions. The main versions which create these child versions are classified as parent versions. This means that any single version may be a parent or child version, depending on the point of view.

[[File:MSM_Versions_Versions.png|center|600x400px]]

=== Overview of versions ===

Users may add, delete, edit, and preview versions in this sub-menu. A search feature can be found on the left side and a main table containing general information is found in the working area.

In this table, the parent version (the currently logged-in version) is featured at the top with all its child versions listed below.
Versions in the main table may be represented by several different types of icons.

Versions with a globe icon represent a version without an administrator, versions with a globe and small person icon represent a version with an administrator, and versions with a greyed out globe icon represent inactive versions.

A lock icon may be found preceding any of these types of versions. The lock icon signifies that the version was not created in the version currently logged-in, but in another version or by an automated system.

[[File:MSM_Versions_Versions.png|center|600x400px]]

[[File:IMG_Version_Concept.png|center|600x400px]]

{{Note
| Imported versions which are denied access to certain items through profile groups, can never have access to these items even if they are given access through the use of additional profiles.

[take a screenshot of for example a system profile[title it "main profile"] with several check-boxes unticked and one["additional profile"] with the same check-boxes ticked, and then screenshot of additional profiles for profile groups for the user]
}}

=== Managing versions ===

====Search====

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Versions based on various criterions. 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 disaplyed below/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

====Add====

In the '''Versions''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Version. When it is clicked, the '''Version''' creation window opens, it contains two different type of information. The first tab '''Version''' shows a table separated into several expandable sections with two columns, '''Designation''' which represents the type of field and '''Value''' which represents the data entered into that field. All those fields provides the detailed description of a version. Only the ones with the edit icon on the right-hand side of the table can be defined by the user. The other ones are either inheritance from the parent version or imported through a third-party system.

[[File:MSM_Versions_Versions_add_Versions.png|center|600x400px]]

{{Note
| Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field.
}}

When creating a new version, the fields in the versions tab can be edited in order to define the version.

'''''Main'''''

* Version: Name of the version.
* Administrator Free: Choose to make a version administrator free. By setting the version to be administration free, the fields under the Customer section become available.
* Nomad Gateway User: A nomad gateway user can be defined in this field.
* Use Parent documents: Choose to use parent documents for the current version.
* Second ID to display : Secondary ID for he version.
* Default currency : set the default currency to used for all offers created within this version.
* Role for client condition : Role which specifies which Address is taken to apply '''[[Description_of_the_Menu_Prices#Customer_Prices|Customer Prices]]'''.

'''''Conditions'''''

* GSP Discount: The global sales price discount. Entering a figure here for example 50.0, means that a discount of 50% will be factored into the global sales price for this version. The GSP Discount can only be defined for a version by the parent version.

'''''Customer'''''

* OrgID: Organization ID
* Name 1: Name of the customer contact.
* Name 2: Additional name field for a contact.
* Name 3: Additional name field for a contact.
* Address 1: Address of where the customer is located (i.e. street name)
* Address 2: Additional address field for the customer (i.e. building name).
* City Name: City of where the customer is located. A drop-down list of available cities can provided for selection (see Data Management)
* ZipCode: Zipcode for where the customer is located.
* Country: Country where the customer is located. A drop-down list of available countries can provided for selection (see Data Management).
* State: State in the country where the customer is located. A drop-down list of states can be provided for selection (see Data Management).

'''''Directories'''''

Directories may only be specified within the version currently logged-in to. Parent versions cannot choose the directory for child versions. When a directory has been specified, the folder path will be shown in the corresponding field.

* Exchange: link to a folder used for saving FQS files.
* Document: link to a folder used for saving documents that are related to offers.
* Order: link to a folder used for saving XML and SES files.
* Libraries: link to a folder used for software libraries.

'''Profiles'''

'''[[Description of the Menu Profiles | Profiles]]''' are set to a version by the parent of that version in the section '''From Creator'''. Versions that have been automatically created by importation have their profiles also automatically set and cannot have their profiles edited.

However, additional profiles can be given to these versions in the section '''From parent'''. The '''Form parent''' section is only visible for these automatically created versions. To the right of the edit icon column is another column that has an eye for an icon.

Clicking on this eye lets the user see what items are defined by the current profile. Meaning that if the system profile "Default systems" was selected, doing so will display which systems are available in this profile.

[[File:MSM_Versions_Versions_add_profiles.png|center|600x400px]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/d/d2/VID_AdditionalProfilesConcept.PNG'>File:Additional_Profiles_OK.mp4‎</mediaplayer>
| Managing additional Profiles in versions.
}}

'''''From Creator'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

'''''From Parent'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

====Edit====

In the '''Versions''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version. Selecting a version and clicking on it opens the '''Version''' edition window where all related properties and information can be edited.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Version. Modifications applied to the selected version will only be saved once the version edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

[[File:MSM_Versions_Versions_Edit_Version.png|center|600x400px]]

====Delete====

In the '''Version''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Version. Selecting a version and clicking on it displays the following confirmation window.

[[File:MSM_Versions_Versions_delete_2.png|center]]

Once the warning is confirmed, the selected version is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| It is not possible to delete a version unless logged-in to the version that created it.

[[File:MSM_Versions_Versions_delete.png|center]]

}}

====Preview====

In the '''Versions''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected version. Selecting a version from the list and clicking on it opens the '''Version''' preview window.

[[File:MSM_Versions_Versions_Preview_profile.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 ... .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In the rightmost column of the table displayed in the '''Version''' preview window, the icon representing an eye can be used to display the list Systems, Hierarchies, Price Categories, Attributes, Variants, Service Models and Tax Models which have been set for the various profiles. No edition is possible.

==== Version without Administrator ====

As stated in the name, version without administrator is a Metis Smart Suite Version which doesn't include an administrator. This type of version is mainly used when no direct maintenance is required on the version level or when it is simply not wished to let the version be maintained individually.

A version without administrator is always created and maintained by its parent version.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/f/fe/VID_VersionNoAdmin.png'>File:Setting_a_version_without_an_administrator_OK.mp4‎</mediaplayer>
| Setting up a version without an administrator.
}}

== Access ==

From this sub-menu, the administrator can define and manage the access between the various children versions, as shown in the following example:

[[File:MSM_Versions_Access.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find versions based on various criterion. The search is triggered by typing a keyword or only a letter in the field 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 list.

=== Editing a Version's Rights ===

In the '''Version Rights''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version Right. Selecting a version right and clicking on it opens the '''Version Rights''' edition window where all related properties and information can be edited.

[[File:MSM_Versions_Access_Edit.png|center|600x400px]]

{{Note
| The title on the window displays the name of selected version (e.g. Version Rights Headquarters where Headquarters is the name of the selected version).
}}

The Versions (Smart Quotes) table displays all the available versions. The displayed versions consist of all of the children versions of the administrator's version. The authorized column allows the administrator to select / deselect the versions that the Smart Quotes users is authorized to access to. The following example describes the cases where a version can have access to the projects and offers made in other versions:

[[File:MetisSmartModelingVersionsProfileDiagram.PNG]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/a/a3/VID_Manage_the_version_access.png'>File:Managing_the_access_of_versions_OK.mp4‎</mediaplayer>
| Managing version access.
}}

An administrator of Version A can define that the Version A users can have access to the direct children versions' projects and offers (i.e. Version B, Version C and Version D). However, Version A users cannot access Version E's projects and offers because Version E is not a direct child of Version A.

The administrator of Version A can also define that Version B users can have access to Version C's projects and offers but not to Version D's projects and offer. The same administrator could also define that Version C users can only have access to Version B's projects and offers.

The authorization is not bi-directional: if Version B users have access to Version C's projects and offers, Version C users do not automatically receive access to Version B's projects and offers. The administrator must set the authorizations for each version.

=== Previewing a Version's Rights ===

In the '''Version Access''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Version Rights. Selecting a Version Right from the table/list and clicking on it opens the '''Version Rights''' preview window.

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

For detailed descriptions of all information available in this window please refer to the section dedicated to the edition of a version right .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In this window, only the authorized versions are displayed. This means that if a version is not authorized to see the projects or the offers or at least one other version, the table is empty as shown in the following example:

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

== Languages ==

Metis Smart Suite supports the use of multiple languages for single roll-outs of the application. Different languages can then be used to translate the [[Metis_Smart_Modeling_-_Setup|User Interface]] and/or the objects created in Metis Smart Modeling, the documents generated by Metis Smart Quotes or the Notes provided by the End-Users In this menu, the administrator defines the languages that the Metis Smart Modeling and Metis Smart Quote users are authorized to use.

{{Warning
| The administrator can define a maximum of four languages per version.
}}

Languages defined in this menu are then made available in the following parts of Metis:

* when a designation is required for an item (e.g. a language, a [[Description_of_the_Menu_Positions|position]], an [[Metis_Smart_Modeling_-_Attributes|attribute]] etc.), the designation may be entered for all the languages that have been made available.

* In the [[Description_of_the_Menu_Users|Users]] menu when defining a user's main language

* In the [[Description of the Sub-Menu Functionalities#Languages tab | Profiles]] menu when setting a default language for a functionality profile.

* In the [[Metis_Smart_Modeling_-_Setup|Setup]] menu when selecting the User Interface language for the application.

* In various part of Metis Smart Quotes as when creating a contact.

{{Note
| The designations in the other languages are used in the case where a designation is missing for the language in which the user is currently working with (see the [[#Priority| Priority]] section below).
}}

=== Adding a New Language ===

Before adding or creating a language, the administrator has to make sure that the maximum number of languages per version is not reached. A click on the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] displays the following window:

[[File:MetisSmartModelingAddLangageSelection.PNG|center|300x350px]]

The administrator can either add an existing language or create a new language.

==== Adding an Existing Language ====

If the administrator chooses to add an existing language, the following window appears after selecting the "Add available language" option:

[[File:MetisSmartModelingLanguageAddExistingLanguage.PNG|center|600x400px]]

The contents of this window is non editable.

The window contains the list of all the available languages. These languages can come from one of the following sources:
* an ascendant version
* the current version
* a descendant version

The first three columns of the window (Flag, Code and Designation) show the country flag, the language code and the language designation. The last column (Version) indicates the version in which the language has been created.

To add a language to the current version, select a language then click on the OK icon. The Languages menu is displayed again with the added language(s). In the language selection menu, it is possible to select several languages at the same time. If the administrator tries to select too many languages and exceeds the 4 authorized languages per version, a pop up window appears. If the user tries to select a language that has already been made available for the current version, a pop up window appears.

==== Creating a New Language ====

If the administrator chooses to create a new language, the following window appears after selecting the "Create a new language" option:

[[File:MetisSmartModelingLanguageAddNewLanguage.PNG|center|600x400px]]

The properties of the language must be provided, that is to say:
* a picture representing the country flag
* a language code (preferably the ISO code)
* a designation
* a translation for each language that has already been made available by the administrator

The language code field is mandatory in order to save the language. This field is limited to four characters and cannot be changed afterwards.

{{Note
| It is highly recommended to use the [http://www.iso.org/iso/english_country_names_and_code_elements official ISO country code].
}}

To define a picture representing the country flag for the language, click on the frame located on the top right side. A window opens as shown in the following example:

[[File:MetisSmartModelingLanguageAddFlagIcon.PNG|center|300x350px]]

The window contains the pictures that have been previously uploaded in the '''[[Description_of_the_Sub-Menu_Cliparts | Cliparts]]''' menu.

The language designation is limited to 30 characters and is mandatory.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/0/0b/VID_Creating_a_language.png'>File:Creating_a_language_OK.mp4‎</mediaplayer>
| Creating a language.
}}

For each language that has already been made available by the administrator, a designation should be provided. This designation should be the name of the created language translated into the other language (e.g. "Russian" in English, "Russe" in French, "Russisch" in German etc.).

=== Editing a Language ===

In the '''Languages''' 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 Language. Selecting a Language and clicking on it opens the '''Languages''' edition window where all related properties and information can be edited.

[[File:MetisSmartModelingLanguageEdit.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the country flag
* an ISO language code
* designation
* the designation of the language (for each language that has been made available by the administrator)

If the administrator is not the owner of the language (i.e. the language has been created in another version), it is only possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator). The language code and the picture cannot be edited.

If the administrator is the owner of the language, it is possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator) and the picture representing the country flag. The language code cannot be edited.

=== Preview ===

In the '''Languages''' 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 Language. Selecting a language from the table and clicking on it opens the '''Languages''' preview window.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Language.

[[File:MetisSmartModelingLanguagePreview.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the flag
* an ISO language code
* a designation
* the designation of the language (for each language that has been made available by the administrator)

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

=== Priority ===

The order in which the languages are displayed correspond to the language priority order. This order is considered when a description is missing for an item. When a description is missing, Metis looks for the item description in the other available languages and displays this description. This means that if the description of an item is missing in the first language, Metis displays the description in the second language if it exists. If not, the description in the third language is displayed and so on.

The priority can be modified by clicking on the ''Priority'' button. The following window appears:

[[File:MetisSmartModelingLanguagePriority.PNG|center|300x350px]]

The table is populated with the languages that have been defined for the current version. The contents of the table cannot be edited. The priority order of the language can be defined using the up and down arrows on the right of the table. The language at the top of the table has the highest priority. The language at the bottom of the table has the lowest priority.

=== Deleting a Language ===

In the '''Languages''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Language. Selecting a Language and clicking on it displays the following confirmation window, if the version has been manually created (i.e. no lock) or is owned by the current version, a confirmation window appears.

Once the warning is confirmed, the selected Language is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| If all the languages are deleted, Metis proposes by default English as the language of the version.
}}

{{Note
| If the language is owned by another version (i.e. presence of a lock), the language cannot be deleted.

[[File:MSM_Versions_Languages_Languages_Delete.png|center]]

}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/e/eb/VID_managing_the_languages_of_a_version.png'>File:Managing_languages_OK.mp4‎</mediaplayer>
| Managing languages of a version.
}}

== Update ==

The Metis Smart Suite update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.

=== Update process Overview ===

In order for this process to efficiently distribute all that information, the functionality works based on the diagram below.

[[File:IMG_Update_Process.png|center|600x400px]]

All update related settings, information and files are bundled together within Metis Smart Suite and sent to a web-service hosted on a web-server. The local instances of Metis Smart Quotes then inquires this service for available updates and notifies the user. If validated, the update takes places and the application will be restarted.

=== Preparing Metis Smart Quotes Updates ===

The update sub-menu is used to prepare updates for offline versions of the Metis Smart Quotes. By default an update which will be created here will include the various databases required by the applications. The update preparation tool in Metis Smart Modeling can be used to fine tune this update. The first type of additional information which can be included in an update are files. The concept is that throughout the settings, external files could be required by Metis Smart Quotes in order to provide to the end-user different information. For example, in the [[Description_of_the_Sub-Menu_Notes|Notes]] menu of the software, the various note types allow the user to import default texts in the note. Those default texts need to be distributed and linked to the application. In the definition of the note setting the administrator sets up a link to a folder where those templates will be stored. When creating the update the idea is to list those templates and define where they will be placed within the local instance of the application. Therefore, the link defined within the profile will also be set in the "destination folder" column of the update preparation.

[[File:MSM_Versions_Uptdate.png|center|600x400px]]

In the update sub-menu the main working area is dedicated to a table with the following columns:

*'''Source File Name''': The name of the original file found under either the "Common Files" or "Specific Files" folder depending on the choice made.
*'''Dest. Folder''': An editable field where the user can enter the destination folder for the file after being updated.
*'''Dest. Filename''': An editable field where the user can enter a new name for the file after being distributed.
*'''File Date''': The date the original file was created.
*'''Behavior''': Describes what will happen once the update has been executed. A drop-down menu with three different options is found in this column.
**Overwite if more recent: The file will be replaced with a more recent version if one is available.
**Ignore if already existing: The file will remain untouched if it is found to already exist.
**Force overwrite: The file will be replaced no matter what the case.

Updates must be prepared in online mode. The purpose of the update process is that when updating a version, the update will automatically be available to the offline users of the version as well as the offline users of the child versions.

Updates may be available for online and offline versions of MSQ. Only the information owned by a version may be used for updates. Data which is owned by a version means data which has been created by the administrator of that version.

For example, on the diagram, the HQ version is the parent of the versions ENG, FRA, GER, JPN, and USA. USA is the parent of the versions NY and WA. This means that NY and WA are the grandchildren of the HQ version.

If an administrator of the HQ version prepares an update, the offline users of the HQ, ENG, FRA, GER, JPN, USA, NY and WA versions also receive the update.

If an administrator of the USA version prepares an update, the versions HQ, ENG, FRA, GER and JPN do not receive the update. Only the USA version and the child versions of USA receive it.

[[File:IMG_Version_Concept.png|center|600x400px]]

====Add Files====

Clicking on the "Add Files" button [[File:MetisSmartModelingCurrentlyAddFilesButton.PNG|link=]] opens a window that asks the user which type of files they wish to add, either '''Common Files''' or '''Specific Files'''. Common files are files which will be distributed to the selected version and its child versions after the update process. Specific files are files which will only be distributed to the selected version when preparing an update. The child versions will not receive the file after the update process.

[[File:MSM_Versions_Update_Add_Files.png|center]]

After selecting a file type and confirming, a MS Windows Explorer window opens where the user may add one or more files at the same time and then clicking on open to complete the process. The files are then added to the main table of the update sub-menu. Depending on the file type chosen, the files will appear under the appropriate folder.

====Delete Files====

In the '''Update''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Files. Selecting one or more files and clicking on it displays the following confirmation window.

Once the warning is confirmed, the selected files are removed from the Metis Smart Suite Update.

====Prepare Update====

After the desired file or files have been added to the update, the user can then begin to generate the update with the "Prepare Update" button [[File:MetisSmartModelingPrepareUpdateButton.PNG|link=]] button.

When selecting a file and clicking on this button, the user is presented with a pop-up window asking if they are sure that they want to run the update process.

The '''Preparing Update...''' window opens after confirming the pop-up. In this window the user is presented with a table with three columns including the '''Date''', '''Message''', and '''Status'''.

The '''Date''' columns list the date and time of the message given in the table, the '''Message''' column provides information to the user in the form of short messages indicating the current status of the update process, and the '''Status''' column is filled with either a green check-mark indicating successful step in the update process or a red x indicating an error in the update process. In the case of an error, a short notice will be displayed in the message column describing the error.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/5/5e/VID_preparing_update.png'>File:PreparingAnUpdateForOfflineInstallations_OK.mp4‎</mediaplayer>
| Preparing an update for offline installations.
}}

{{Warning
| In order for the update preparation and distribution to go through normally, it is required to define the update settings in the functionality profiles in the version in which the administrator works; and in the versions which are targeted by the update.

For the Metis Smart Quotes instances targeted by the update to receive the update it is of course necessary that the profiles define the correct update settings.
}}

== Licensing ==

(TBD)

Description of the Menu Versions

2014-01-15T07:35:18Z

PatrickG: /* Preview */

As Metis Smart Suite can be rolled out in small to large organizations the software supports a versioning concepts. These feature allows it to be structured in a tree like schema. As the root of this tree there will always be the main delivered version of the application.

The branches from that tree will represent created version within the organization. As described in the figure below the headquarters of an organization is placed at the root of the tree, and all the country specific subsidiaries, for example, are shown as first child version (i.e. first level nodes). The leafs of the tree from a specific branch are for example partners within that country.

Within Metis Smart Suite a version is mainly described by its name and basic information, conditions, customer designation and directories which have to be used by it. Additionally '''[[Description of the Menu Profiles | Profiles]]''' of all types can be linked to a version in order to enforce default rights and privileges to all users which will be created in that version.

Versions are a key element of the Metis Smart Suite. This functionality allows the administrator to re-create the sales or legal structure of the company in which the software suite is being deployed. Additional examples of how this structure can support any organization can be found within the various screenshots of that section.

== Versions ==

Both Metis Smart Modeling users and administrators can create as many versions as required. As a reminder, versions that descend from a main version are classified as child versions. The main versions which create these child versions are classified as parent versions. This means that any single version may be a parent or child version, depending on the point of view.

[[File:MSM_Versions_Versions.png|center|600x400px]]

=== Overview of versions ===

Users may add, delete, edit, and preview versions in this sub-menu. A search feature can be found on the left side and a main table containing general information is found in the working area.

In this table, the parent version (the currently logged-in version) is featured at the top with all its child versions listed below.
Versions in the main table may be represented by several different types of icons.

Versions with a globe icon represent a version without an administrator, versions with a globe and small person icon represent a version with an administrator, and versions with a greyed out globe icon represent inactive versions.

A lock icon may be found preceding any of these types of versions. The lock icon signifies that the version was not created in the version currently logged-in, but in another version or by an automated system.

[[File:MSM_Versions_Versions.png|center|600x400px]]

[[File:IMG_Version_Concept.png|center|600x400px]]

{{Note
| Imported versions which are denied access to certain items through profile groups, can never have access to these items even if they are given access through the use of additional profiles.

[take a screenshot of for example a system profile[title it "main profile"] with several check-boxes unticked and one["additional profile"] with the same check-boxes ticked, and then screenshot of additional profiles for profile groups for the user]
}}

=== Managing versions ===

====Search====

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Versions based on various criterions. 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 disaplyed below/in the main table/list. Selecting a line from the result list will automatically select the corresponding entry in the main table/list.

====Add====

In the '''Versions''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main list allows the user/administrator to create a new Version. When it is clicked, the '''Version''' creation window opens, it contains two different type of information. The first tab '''Version''' shows a table separated into several expandable sections with two columns, '''Designation''' which represents the type of field and '''Value''' which represents the data entered into that field. All those fields provides the detailed description of a version. Only the ones with the edit icon on the right-hand side of the table can be defined by the user. The other ones are either inheritance from the parent version or imported through a third-party system.

[[File:MSM_Versions_Versions_add_Versions.png|center|600x400px]]

{{Note
| Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field.
}}

When creating a new version, the fields in the versions tab can be edited in order to define the version.

'''''Main'''''

* Version: Name of the version.
* Administrator Free: Choose to make a version administrator free. By setting the version to be administration free, the fields under the Customer section become available.
* Nomad Gateway User: A nomad gateway user can be defined in this field.
* Use Parent documents: Choose to use parent documents for the current version.
* Second ID to display : Secondary ID for he version.
* Default currency : set the default currency to used for all offers created within this version.
* Role for client condition : Role which specifies which Address is taken to apply '''[[Description_of_the_Menu_Prices#Customer_Prices|Customer Prices]]'''.

'''''Conditions'''''

* GSP Discount: The global sales price discount. Entering a figure here for example 50.0, means that a discount of 50% will be factored into the global sales price for this version. The GSP Discount can only be defined for a version by the parent version.

'''''Customer'''''

* OrgID: Organization ID
* Name 1: Name of the customer contact.
* Name 2: Additional name field for a contact.
* Name 3: Additional name field for a contact.
* Address 1: Address of where the customer is located (i.e. street name)
* Address 2: Additional address field for the customer (i.e. building name).
* City Name: City of where the customer is located. A drop-down list of available cities can provided for selection (see Data Management)
* ZipCode: Zipcode for where the customer is located.
* Country: Country where the customer is located. A drop-down list of available countries can provided for selection (see Data Management).
* State: State in the country where the customer is located. A drop-down list of states can be provided for selection (see Data Management).

'''''Directories'''''

Directories may only be specified within the version currently logged-in to. Parent versions cannot choose the directory for child versions. When a directory has been specified, the folder path will be shown in the corresponding field.

* Exchange: link to a folder used for saving FQS files.
* Document: link to a folder used for saving documents that are related to offers.
* Order: link to a folder used for saving XML and SES files.
* Libraries: link to a folder used for software libraries.

'''Profiles'''

'''[[Description of the Menu Profiles | Profiles]]''' are set to a version by the parent of that version in the section '''From Creator'''. Versions that have been automatically created by importation have their profiles also automatically set and cannot have their profiles edited.

However, additional profiles can be given to these versions in the section '''From parent'''. The '''Form parent''' section is only visible for these automatically created versions. To the right of the edit icon column is another column that has an eye for an icon.

Clicking on this eye lets the user see what items are defined by the current profile. Meaning that if the system profile "Default systems" was selected, doing so will display which systems are available in this profile.

[[File:MSM_Versions_Versions_add_profiles.png|center|600x400px]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/d/d2/VID_AdditionalProfilesConcept.PNG'>File:Additional_Profiles_OK.mp4‎</mediaplayer>
| Managing additional Profiles in versions.
}}

'''''From Creator'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

'''''From Parent'''''

*Smart Quotes: The functionality profile to be used for Smart Quotes.
*Smart Modeling: The functionality profile to be used for Smart Modeling.
*Smart Monitoring: The functionality profile to be used for Smart Monitoring.
*System: The default system profile to be used in this version.
*Hierarchy: The default hierarchy profile to be used for hierarchies.
*Price category: The default price category profile to be used for price categories
*Attribute: The default attribute profile to be used for attributes.
*Variant: The default variant profile to be used for variants.
*Model of service: The default profile to be used for service models.
*Model of taxes: The default profile to be used for tax models.

====Edit====

In the '''Versions''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version. Selecting a version and clicking on it opens the '''Version''' edition window where all related properties and information can be edited.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Version. Modifications applied to the selected version will only be saved once the version edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

[[File:MSM_Versions_Versions_Edit_Version.png|center|600x400px]]

====Delete====

In the '''Version''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main list allows the user/administrator to delete the selected Version. Selecting a version and clicking on it displays the following confirmation window.

[[File:MSM_Versions_Versions_delete_2.png|center]]

Once the warning is confirmed, the selected version is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| It is not possible to delete a version unless logged-in to the version that created it.

[[File:MSM_Versions_Versions_delete.png|center]]

}}

====Preview====

In the '''Versions''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected version. Selecting a version from the list and clicking on it opens the '''Version''' preview window.

[[File:MSM_Versions_Versions_Preview_profile.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 ... .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In the rightmost column, the icon representing an eye can be used to display the list Systems, Hierarchies, Price Categories, Attributes, Variants, Service Models and Tax Models which have been set for the various profiles. No edition is possible.

==== Version without Administrator ====

As stated in the name, version without administrator is a Metis Smart Suite Version which doesn't include an administrator. This type of version is mainly used when no direct maintenance is required on the version level or when it is simply not wished to let the version be maintained individually.

A version without administrator is always created and maintained by its parent version.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/f/fe/VID_VersionNoAdmin.png'>File:Setting_a_version_without_an_administrator_OK.mp4‎</mediaplayer>
| Setting up a version without an administrator.
}}

== Access ==

From this sub-menu, the administrator can define and manage the access between the various children versions, as shown in the following example:

[[File:MSM_Versions_Access.png|center|600x400px]]

On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find versions based on various criterion. The search is triggered by typing a keyword or only a letter in the field 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 list.

=== Editing a Version's Rights ===

In the '''Version Rights''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main list allows the user/administrator to apply modifications to all properties related to the selected Version Right. Selecting a version right and clicking on it opens the '''Version Rights''' edition window where all related properties and information can be edited.

[[File:MSM_Versions_Access_Edit.png|center|600x400px]]

{{Note
| The title on the window displays the name of selected version (e.g. Version Rights Headquarters where Headquarters is the name of the selected version).
}}

The Versions (Smart Quotes) table displays all the available versions. The displayed versions consist of all of the children versions of the administrator's version. The authorized column allows the administrator to select / deselect the versions that the Smart Quotes users is authorized to access to. The following example describes the cases where a version can have access to the projects and offers made in other versions:

[[File:MetisSmartModelingVersionsProfileDiagram.PNG]]

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/a/a3/VID_Manage_the_version_access.png'>File:Managing_the_access_of_versions_OK.mp4‎</mediaplayer>
| Managing version access.
}}

An administrator of Version A can define that the Version A users can have access to the direct children versions' projects and offers (i.e. Version B, Version C and Version D). However, Version A users cannot access Version E's projects and offers because Version E is not a direct child of Version A.

The administrator of Version A can also define that Version B users can have access to Version C's projects and offers but not to Version D's projects and offer. The same administrator could also define that Version C users can only have access to Version B's projects and offers.

The authorization is not bi-directional: if Version B users have access to Version C's projects and offers, Version C users do not automatically receive access to Version B's projects and offers. The administrator must set the authorizations for each version.

=== Previewing a Version's Rights ===

In the '''Version Access''' sub-menu, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main list allows the user/administrator to see all properties and information related to the selected Version Rights. Selecting a Version Right from the table/list and clicking on it opens the '''Version Rights''' preview window.

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

For detailed descriptions of all information available in this window please refer to the section dedicated to the edition of a version right .

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

In this window, only the authorized versions are displayed. This means that if a version is not authorized to see the projects or the offers or at least one other version, the table is empty as shown in the following example:

[[File:MSM_Versions_Access_Preview.png|center|600x400px]]

== Languages ==

Metis Smart Suite supports the use of multiple languages for single roll-outs of the application. Different languages can then be used to translate the [[Metis_Smart_Modeling_-_Setup|User Interface]] and/or the objects created in Metis Smart Modeling, the documents generated by Metis Smart Quotes or the Notes provided by the End-Users In this menu, the administrator defines the languages that the Metis Smart Modeling and Metis Smart Quote users are authorized to use.

{{Warning
| The administrator can define a maximum of four languages per version.
}}

Languages defined in this menu are then made available in the following parts of Metis:

* when a designation is required for an item (e.g. a language, a [[Description_of_the_Menu_Positions|position]], an [[Metis_Smart_Modeling_-_Attributes|attribute]] etc.), the designation may be entered for all the languages that have been made available.

* In the [[Description_of_the_Menu_Users|Users]] menu when defining a user's main language

* In the [[Description of the Sub-Menu Functionalities#Languages tab | Profiles]] menu when setting a default language for a functionality profile.

* In the [[Metis_Smart_Modeling_-_Setup|Setup]] menu when selecting the User Interface language for the application.

* In various part of Metis Smart Quotes as when creating a contact.

{{Note
| The designations in the other languages are used in the case where a designation is missing for the language in which the user is currently working with (see the [[#Priority| Priority]] section below).
}}

=== Adding a New Language ===

Before adding or creating a language, the administrator has to make sure that the maximum number of languages per version is not reached. A click on the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] displays the following window:

[[File:MetisSmartModelingAddLangageSelection.PNG|center|300x350px]]

The administrator can either add an existing language or create a new language.

==== Adding an Existing Language ====

If the administrator chooses to add an existing language, the following window appears after selecting the "Add available language" option:

[[File:MetisSmartModelingLanguageAddExistingLanguage.PNG|center|600x400px]]

The contents of this window is non editable.

The window contains the list of all the available languages. These languages can come from one of the following sources:
* an ascendant version
* the current version
* a descendant version

The first three columns of the window (Flag, Code and Designation) show the country flag, the language code and the language designation. The last column (Version) indicates the version in which the language has been created.

To add a language to the current version, select a language then click on the OK icon. The Languages menu is displayed again with the added language(s). In the language selection menu, it is possible to select several languages at the same time. If the administrator tries to select too many languages and exceeds the 4 authorized languages per version, a pop up window appears. If the user tries to select a language that has already been made available for the current version, a pop up window appears.

==== Creating a New Language ====

If the administrator chooses to create a new language, the following window appears after selecting the "Create a new language" option:

[[File:MetisSmartModelingLanguageAddNewLanguage.PNG|center|600x400px]]

The properties of the language must be provided, that is to say:
* a picture representing the country flag
* a language code (preferably the ISO code)
* a designation
* a translation for each language that has already been made available by the administrator

The language code field is mandatory in order to save the language. This field is limited to four characters and cannot be changed afterwards.

{{Note
| It is highly recommended to use the [http://www.iso.org/iso/english_country_names_and_code_elements official ISO country code].
}}

To define a picture representing the country flag for the language, click on the frame located on the top right side. A window opens as shown in the following example:

[[File:MetisSmartModelingLanguageAddFlagIcon.PNG|center|300x350px]]

The window contains the pictures that have been previously uploaded in the '''[[Description_of_the_Sub-Menu_Cliparts | Cliparts]]''' menu.

The language designation is limited to 30 characters and is mandatory.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/0/0b/VID_Creating_a_language.png'>File:Creating_a_language_OK.mp4‎</mediaplayer>
| Creating a language.
}}

For each language that has already been made available by the administrator, a designation should be provided. This designation should be the name of the created language translated into the other language (e.g. "Russian" in English, "Russe" in French, "Russisch" in German etc.).

=== Editing a Language ===

In the '''Languages''' 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 Language. Selecting a Language and clicking on it opens the '''Languages''' edition window where all related properties and information can be edited.

[[File:MetisSmartModelingLanguageEdit.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the country flag
* an ISO language code
* designation
* the designation of the language (for each language that has been made available by the administrator)

If the administrator is not the owner of the language (i.e. the language has been created in another version), it is only possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator). The language code and the picture cannot be edited.

If the administrator is the owner of the language, it is possible for the administrator to edit the descriptions of the language (for each language that has been made available by the version administrator) and the picture representing the country flag. The language code cannot be edited.

=== Preview ===

In the '''Languages''' 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 Language. Selecting a language from the table and clicking on it opens the '''Languages''' preview window.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Language.

[[File:MetisSmartModelingLanguagePreview.PNG|center|600x400px]]

The properties of a language includes:
* a picture representing the flag
* an ISO language code
* a designation
* the designation of the language (for each language that has been made available by the administrator)

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

=== Priority ===

The order in which the languages are displayed correspond to the language priority order. This order is considered when a description is missing for an item. When a description is missing, Metis looks for the item description in the other available languages and displays this description. This means that if the description of an item is missing in the first language, Metis displays the description in the second language if it exists. If not, the description in the third language is displayed and so on.

The priority can be modified by clicking on the ''Priority'' button. The following window appears:

[[File:MetisSmartModelingLanguagePriority.PNG|center|300x350px]]

The table is populated with the languages that have been defined for the current version. The contents of the table cannot be edited. The priority order of the language can be defined using the up and down arrows on the right of the table. The language at the top of the table has the highest priority. The language at the bottom of the table has the lowest priority.

=== Deleting a Language ===

In the '''Languages''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Language. Selecting a Language and clicking on it displays the following confirmation window, if the version has been manually created (i.e. no lock) or is owned by the current version, a confirmation window appears.

Once the warning is confirmed, the selected Language is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| If all the languages are deleted, Metis proposes by default English as the language of the version.
}}

{{Note
| If the language is owned by another version (i.e. presence of a lock), the language cannot be deleted.

[[File:MSM_Versions_Languages_Languages_Delete.png|center]]

}}

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/e/eb/VID_managing_the_languages_of_a_version.png'>File:Managing_languages_OK.mp4‎</mediaplayer>
| Managing languages of a version.
}}

== Update ==

The Metis Smart Suite update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.

=== Update process Overview ===

In order for this process to efficiently distribute all that information, the functionality works based on the diagram below.

[[File:IMG_Update_Process.png|center|600x400px]]

All update related settings, information and files are bundled together within Metis Smart Suite and sent to a web-service hosted on a web-server. The local instances of Metis Smart Quotes then inquires this service for available updates and notifies the user. If validated, the update takes places and the application will be restarted.

=== Preparing Metis Smart Quotes Updates ===

The update sub-menu is used to prepare updates for offline versions of the Metis Smart Quotes. By default an update which will be created here will include the various databases required by the applications. The update preparation tool in Metis Smart Modeling can be used to fine tune this update. The first type of additional information which can be included in an update are files. The concept is that throughout the settings, external files could be required by Metis Smart Quotes in order to provide to the end-user different information. For example, in the [[Description_of_the_Sub-Menu_Notes|Notes]] menu of the software, the various note types allow the user to import default texts in the note. Those default texts need to be distributed and linked to the application. In the definition of the note setting the administrator sets up a link to a folder where those templates will be stored. When creating the update the idea is to list those templates and define where they will be placed within the local instance of the application. Therefore, the link defined within the profile will also be set in the "destination folder" column of the update preparation.

[[File:MSM_Versions_Uptdate.png|center|600x400px]]

In the update sub-menu the main working area is dedicated to a table with the following columns:

*'''Source File Name''': The name of the original file found under either the "Common Files" or "Specific Files" folder depending on the choice made.
*'''Dest. Folder''': An editable field where the user can enter the destination folder for the file after being updated.
*'''Dest. Filename''': An editable field where the user can enter a new name for the file after being distributed.
*'''File Date''': The date the original file was created.
*'''Behavior''': Describes what will happen once the update has been executed. A drop-down menu with three different options is found in this column.
**Overwite if more recent: The file will be replaced with a more recent version if one is available.
**Ignore if already existing: The file will remain untouched if it is found to already exist.
**Force overwrite: The file will be replaced no matter what the case.

Updates must be prepared in online mode. The purpose of the update process is that when updating a version, the update will automatically be available to the offline users of the version as well as the offline users of the child versions.

Updates may be available for online and offline versions of MSQ. Only the information owned by a version may be used for updates. Data which is owned by a version means data which has been created by the administrator of that version.

For example, on the diagram, the HQ version is the parent of the versions ENG, FRA, GER, JPN, and USA. USA is the parent of the versions NY and WA. This means that NY and WA are the grandchildren of the HQ version.

If an administrator of the HQ version prepares an update, the offline users of the HQ, ENG, FRA, GER, JPN, USA, NY and WA versions also receive the update.

If an administrator of the USA version prepares an update, the versions HQ, ENG, FRA, GER and JPN do not receive the update. Only the USA version and the child versions of USA receive it.

[[File:IMG_Version_Concept.png|center|600x400px]]

====Add Files====

Clicking on the "Add Files" button [[File:MetisSmartModelingCurrentlyAddFilesButton.PNG|link=]] opens a window that asks the user which type of files they wish to add, either '''Common Files''' or '''Specific Files'''. Common files are files which will be distributed to the selected version and its child versions after the update process. Specific files are files which will only be distributed to the selected version when preparing an update. The child versions will not receive the file after the update process.

[[File:MSM_Versions_Update_Add_Files.png|center]]

After selecting a file type and confirming, a MS Windows Explorer window opens where the user may add one or more files at the same time and then clicking on open to complete the process. The files are then added to the main table of the update sub-menu. Depending on the file type chosen, the files will appear under the appropriate folder.

====Delete Files====

In the '''Update''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Files. Selecting one or more files and clicking on it displays the following confirmation window.

Once the warning is confirmed, the selected files are removed from the Metis Smart Suite Update.

====Prepare Update====

After the desired file or files have been added to the update, the user can then begin to generate the update with the "Prepare Update" button [[File:MetisSmartModelingPrepareUpdateButton.PNG|link=]] button.

When selecting a file and clicking on this button, the user is presented with a pop-up window asking if they are sure that they want to run the update process.

The '''Preparing Update...''' window opens after confirming the pop-up. In this window the user is presented with a table with three columns including the '''Date''', '''Message''', and '''Status'''.

The '''Date''' columns list the date and time of the message given in the table, the '''Message''' column provides information to the user in the form of short messages indicating the current status of the update process, and the '''Status''' column is filled with either a green check-mark indicating successful step in the update process or a red x indicating an error in the update process. In the case of an error, a short notice will be displayed in the message column describing the error.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/5/5e/VID_preparing_update.png'>File:PreparingAnUpdateForOfflineInstallations_OK.mp4‎</mediaplayer>
| Preparing an update for offline installations.
}}

{{Warning
| In order for the update preparation and distribution to go through normally, it is required to define the update settings in the functionality profiles in the version in which the administrator works; and in the versions which are targeted by the update.

For the Metis Smart Quotes instances targeted by the update to receive the update it is of course necessary that the profiles define the correct update settings.
}}

== Licensing ==

(TBD)

Metis Smart Modeling - Models

2014-01-14T15:51:48Z

PatrickG:

A model is the building block of Metis Smart Suite . It allows the application to generate a list of material, service items and configure maintenance based on logic rules defined by the business and created by the Metis Smart Modeling user/administrator.

[[Image:Model Pres 1.png|thumb|upright=0.5|alt=Metis Smart Quote Model Description|Metis Smart Quote Model Description]]

This section explains all parameters and techniques to build and maintain models, giving a full understanding of the possibilities behind this functionality. The following sections of this manual will present all aspects related to this task. They are structured based on the different elements required to create full featured models.

The current section describes how a model works and how one can create and maintain it. Based on that information, the following sections describe model building blocks like [[Metis_Smart_Modeling_-_Rules|rules]], [[Metis_Smart_Modeling_-_Group_of_Rules|groups of rules]], [[Metis_Smart_Modeling_-_Variables|variables]] and [[Metis_Smart_Modeling_-_Masks|masks]]. For consistency purposes, all aspects of the creation of models are based on a full featured example.

== How does a model work? ==

Before explaining how to create and use models, it is necessary to explain how Metis Smart Quote works in order to provide the user with a fully featured offer. Establishing such an offer can be summarized through the scheme on the right.
[[Image:Model_Metis_SQ_Exec.png|thumb|upright=0.5|alt=Metis Smart Quote Execution Description|Metis Smart Quote Execution Description]]
When an offer is initiated in Metis Smart Quote, '''modeled positions''' are “calculated” based in the information provided in modeling [[Metis_Smart_Modeling_-_Masks|masks]] and Default Configurations linked to [[Metis_Smart_Modeling_-_Systems#Systems|Systems]]. These values represent the customer’s needs and technical basis. Through the execution of the [[#Material|material]] model, the application creates a list of positions which basically represents the customer’s desired items and all of these products are listed in a structured way.

For example, in the case of a company selling computer [[Metis_Smart_Modeling_-_Systems|systems]], requirements will be provided in the modeling [[Metis_Smart_Modeling_-_Masks|masks]] and after the calculation will result in a list of components like computers, servers and network appliances.

All positions listed through the use of models will be in read only mode. Metis Smart Quote allows, however, editing the list by adding '''manual positions'''. All parameters related to them can be manually set, like quantity and [[Metis_Smart_Modeling_-_Attributes|attributes]].

Based on the previous example, a secondary screen can be added for one or more calculated computers. Or, additional, not modeled network features can be added.

After the two previous steps, Metis Smart Quote will not only list all items required for the offer, but also calculate '''prices'''. This calculation will not only be based on all positions listed in the offer, but also on the pricing settings defined on the positions. For example, a specific computer component, like software licenses may be subject to discounts based on the quantity.

Additionally to defining the list of positions required in an offer, the modeling functionality of Metis Smart Suite, '''services specific models''' can be implemented in the application. Once the pricing of materials and based on the availability of a [[#Service|service]] models, Metis Smart Quote is able to calculated related services through service models and list relevant service position in the offer.

For example, the installation of the complete set of computers and network appliances.

Once the customer required material and service positions defined through the models or manually entered, the '''global pricing''' of an offer can be calculated by Metis Smart Quote.

On top of that, based on the overall offer, Metis allows to trigger so called Tax models which are executed at the very end of the process. These models can typically be used to '''add sales taxes to an offer''' (VAT or recycling).

In Metis Smart Quote, models appear in different forms, based on their type. For [[#Material|material]] models, the linked [[Metis_Smart_Modeling_-_Masks|masks]] will be displayed the application in the offer window when selecting the [[Metis_Smart_Modeling_-_Systems|system]].

{{Note
| For a full description of the use of models in Metis Smart Quote, refer to the “System configuration” section of the applications menu.
}}

Now that the ground work of the model concept is laid down, it is necessary to understand a bit how such a model works in the Metis Smart Suite. As described in figure [[:File:Model_Exec_1.png|Model execution overview]], outside of the [[Metis_Smart_Modeling_-_Masks|masks]], a [[Metis_Smart_Modeling_-_Models|model]] is built on specific objects. Each model includes at least one “[[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]]”, which is a container for individual [[Metis_Smart_Modeling_-_Rules|rules]]. Those [[Metis_Smart_Modeling_-_Rules|rules]] are the logic part of the models. Each [[Metis_Smart_Modeling_-_Rules|rule]] uses input values ([[Metis_Smart_Modeling_-_Variables|variables]], [[Metis_Smart_Modeling_-_Attributes|attributes]], positions) coming from the [[Metis_Smart_Modeling_-_Masks|masks]], default or calculated information to process a logic “formula”. A [[Metis_Smart_Modeling_-_Group_of_Rules|Group of rules]] can include as many [[Metis_Smart_Modeling_-_Rules|rules]] as necessary, with the only constrain that the result of a given [[Metis_Smart_Modeling_-_Rules|rule]] will only be available in the next [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] in the process. As described in figure [[:File:Model_Exec_2.png|Group of rules execution overview]], a [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] feeds on input values which are instantiated before its execution. Once inside, all [[Metis_Smart_Modeling_-_Rules|rules]] will use those values to process the formulas. When all [[Metis_Smart_Modeling_-_Rules|rules]] are processed, the resulting [[Metis_Smart_Modeling_-_Variables|variables]] and/or material positions are prepared for the next [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]].Before starting the execution of the next [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]], the engine instantiates the new input values and lets the various [[Metis_Smart_Modeling_-_Rules|rules]] included in the group feed on them.

[[Image:IMG_BLANK.png|500x226px|link=]][[Image:Model_Exec_1.png|500x226px|link=]] [[Image:Model_Exec_2.png|500x226px|link=]]

For example, when configuring a computer, the selection of a specific CPU will influence the list of compatible motherboards. Only when the appropriate one is determined, will the number of specific ports (like USB) be available and used for further configuration.

{{Note
| Additional information on the use of model can be found in [[Metis_Smart_Quote_User_Manual_Home_Page|Metis Smart Quote Manual]], and the examples listed here.
}}

== Model types ==

The Metis environment supports and enables the use of three different types of [[Metis_Smart_Modeling_-_Rules|rules]]. Overall, the type of the model will determine the "moment" the model will be executed and information it can base itself on. When creating a new model, the user has to select the appropriate type before defining the model.

[[File:MetisSmartModelingSCModels1.PNG|center|354x240px]]

=== Material ===

A model defined as being of type "material" is defined in Metis Smart Modeling to generate a list of material in Metis Smart Quote based on input [[Metis_Smart_Modeling_-_Masks|masks]], [[Metis_Smart_Modeling_-_Rules|rules]] and logic. The result will be displayed in the latest.

The main concept behind this type of model is for the Metis Smart Quote end-user to be able to enter in a simple and graphic way his customer's requirements and then let the application generate the list of necessary positions. This type can be used in many different ways. For example, in the case of a business selling computer [[Metis_Smart_Modeling_-_Systems|systems]], a model can be created which will ask for basic configuration properties and then let the application calculate the various possibilities which may fulfill the customer’s need. The [[Metis_Smart_Modeling_-_Systems|system]] may then even pre-select the less expensive solution. The other possibility is to define a model which could basically be compared to a component catalog and let the user select the required items manually, but in a graphical environment.

=== Service ===

A model defined as being of type "service" will feed on the generated or manually input list of material in Metis Smart Quote to generate service items for the current offer. The result will be displayed in the latest.

Usually those models will use the [[Metis_Smart_Modeling_-_Attributes|attributes]] and position quantities to calculate the required service items. In the displayed list, each of the positions may have [[Metis_Smart_Modeling_-_Attributes|attribute]] values linked to it. For example, a printer defines a time which is required to install its drivers on the host computer(s). These times will then be processed by the model and generate an additional position which will add up all those times and insert the installation service in the offer.

This functionality can also be used to generate additional material item based on the main material list. For example it can be used to calculate the appropriate backup battery (UPS) for the servers included in the offer.

{{Warning
| [[Metis_Smart_Modeling_-_Masks|Masks]] cannot be used in conjunction with service models, as they are calculated based on a list of positions.
}}

=== Tax ===
A model defined as being of type "tax" will feed on the generated or manually input list of material in Metis Smart Quote to generate various taxes. The result will be displayed in the latest.

Usually those models will use total or positions specific amounts, the [[Metis_Smart_Modeling_-_Attributes|attributes]] and position quantities to calculate the taxes. With these type of models, the Metis Smart Modeling user can define any number of taxes like VAT (Value Added Tax) or recycling. The result of the model will be displayed on the offer level, as part of the total price.

A tax model is always linked to the overall offer when used in Metis Smart Quotes. The activation of the model thus has to be done based on a specific group of users belonging to a version. This is done via the Tax Models sub-section of the Profiles menu in Metis Smart Modeling.

The definition of a TAX model varies from the definition of the two other types of models, as it basically consist of a formula which should be applied on prices, quantities, [[Metis_Smart_Modeling_-_Variables|variables]] or [[Metis_Smart_Modeling_-_Attributes|attributes]]. Thus the full definition of it is done in the main model setup window.

[[File:MetisSmartModelingSCModelsTAXDef.PNG|center|706x860px]]

After defining all basic information for the model, like name, descriptions and versioning, the lower part of the window allows to setup the [[Metis_Smart_Modeling_-_Variables|variables]] to be used and formula which will be calculated. As for formula based [[Metis_Smart_Modeling_-_Rules|rules]], the first step is to define which input [[Metis_Smart_Modeling_-_Variables|variables]] should be used in the formula. by clicking on the add button on the left of the table, the application will show a new window where the user can the type and the item to be used as input variable for the formula. In addition to the standard input items, a tax model can also use prices. The list of price types which can be used is available when selecting the "Items" radio button.

When all required input variable are defined, the formula can be typed in the dedicated field below the table. In the above example, the "Net Sales Price" is multiplied by "1.08" in order to calculated the swiss VAT (8%).

[[File:MetisSmartModelingSCModelsTAXDef2.PNG|center|706x860px]]

'''List of "items" :'''
* (Is Material Position) : Will return a Boolean value defining of the position being treated is a material position.
* (Is Service Position) : Will return a Boolean value defining of the position being treated is a service position.
* Cost Price : Will return the cost price of the position being treated.
* Gross Price : Will return the gross price (sales price before all discounts) of the position being treated.
* Net Sales Price : Will return the net sales price (sales price after all discounts) of the position being treated.
* Original Sales Price : Will return the original sales price (sales price as by default in the database) of the position being treated.

{{Note
| Whenever one of these "items" is used in a tax formula, the formula will be executed individually on all items and add up the results to display it as a total.
}}

{{Note
| Several TAX models can be applied on an offer.
}}

== Searching and sorting through models ==

The main screen of the "Modeling" tab in Metis Smart Modeling displays the list of all the model available in the version. That list shows the name of the model, its version, type and creation date. On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Models 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.

[[File:MetisSmartModelingSCModels.PNG‎|center|850x860px]]

== Creating a new Model ==

In the '''Models''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main table allows the user/administrator to create a new Model. When it is clicked, the '''Model''' creation window opens, it allows to define all related information. Select a model type, for example “MAT”. Provide a name for the model, for example “Entry-Level Desktop”, enter a version, for example “1.0”. Enter a description for each available language. The tables below allow the user to define the two main parts of the model, those being the “[[Metis_Smart_Modeling_-_Masks|masks]]” and the “[[Metis_Smart_Modeling_-_Group_of_Rules|groups of rules]]”
For the [[Metis_Smart_Modeling_-_Masks|masks]] table, click on the add button. A window opens where [[Metis_Smart_Modeling_-_Masks|masks]] and groups of [[Metis_Smart_Modeling_-_Masks|masks]] can be selected and linked to the model. Select the desired [[Metis_Smart_Modeling_-_Masks|masks]], for example, “D-Basic Hardware” and “D-Peripherals” and then confirm to continue. For the [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] table, click on the add button. A window similar to the [[Metis_Smart_Modeling_-_Masks|masks]] window opens, but for [[Metis_Smart_Modeling_-_Group_of_Rules|groups of rules]]. Select the desired groups of [[Metis_Smart_Modeling_-_Rules|rules]] and confirm. The green up and down arrows found above each table allow the user to modify the display order of the [[Metis_Smart_Modeling_-_Masks|masks]] as well as the execution order of the groups of [[Metis_Smart_Modeling_-_Rules|rules]].

{{Note
| A proper execution of the model depends entirely on the order of the groups of [[Metis_Smart_Modeling_-_Rules|rules]].
}}

[[File:MetisSmartModelingSCModelsDef.PNG‎|center|764x860px]]

A model is basically constructed of 3 main information. Basic properties will define such information as description, type and versioning. The logical part is made of "[[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]]" which will be used to run the calculation and [[Metis_Smart_Modeling_-_Masks|masks]] which will be displayed in Metis Smart Quotes to allow for input in the model.

* '''Description''' (mandatory) : A description for the model, usually a name.
* '''Type''' ( mandatory) : Each model requires to be typed. On this information will depend the moment the model is executed when used in Metis Smart Quotes.
* '''Versioning''' : When updating a model based on an old one, this information is very useful to keep track of the different versions.
* '''[[Metis_Smart_Modeling_-_Masks|masks]]''' : List of [[Metis_Smart_Modeling_-_Masks|masks]] used in this model. Once the model is linked to a [[Metis_Smart_Modeling_-_Systems|system]], the listed [[Metis_Smart_Modeling_-_Masks|mask]] will appear in Metis Smart Quotes when configuring the [[Metis_Smart_Modeling_-_Systems|system]] in the "Design" section.
* '''[[Metis_Smart_Modeling_-_Group_of_Rules|Group of rules]]''' : List of [[Description_of_the_Sub-Menu_Group_of_Rules|groups of rules]] to be used when executing the model in Metis Smart Quotes. The order of the groups of [[Metis_Smart_Modeling_-_Rules|rules]] is very important for the model to generate concrete and valid results.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/7/71/VID_CreatingAModel.PNG'>File:Creating a model OK.mp4</mediaplayer>
| Creation of a new model, selection of linked groups of [[Metis_Smart_Modeling_-_Rules|rules]] and [[Metis_Smart_Modeling_-_Masks|masks]].
}}

{{Note
| A service or material model doesn't have influence on a configuration without fully configured groups of [[Metis_Smart_Modeling_-_Rules|rules]] and in the case on material models [[Metis_Smart_Modeling_-_Masks|masks]].
}}

{{Note
| The example used above applies on material models as well as service models. Only tax model are defined in a different way.
}}

The model definition window also allows to setup which [[Metis_Smart_Modeling_-_Systems|systems]] will use the model when inserted in an offer in Metis Smart Quotes. By moving to the second tab in the window a list of all [[Metis_Smart_Modeling_-_Systems|system]] defined in Metis Smart Modeling is displayed and lets the user validate the [[Metis_Smart_Modeling_-_Systems|system(s)]] which should use this models with the appropriate offer type.

[[File:MetisSmartModelingSCModelsDef2.PNG‎|center|764x860px]]

{{Tip
| The System tab is very useful to have an overview of which [[Metis_Smart_Modeling_-_Systems|systems]] use the selected model.
}}

== Duplicating a Model ==

In the '''Models''' sub-menu, the "Duplicate" button [[File:MetisSmartModelingDuplicateButton.PNG|link=]] located above the main table allows the user/administrator to create a copy of the selected Model. Selecting a Model and clicking on it create an exact duplicate of the model with all the information the original holds.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Model. Modifications can be applied to the newly create Model by selecting it and clicking the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main table. Please refer to the following section for more information.

{{Note
| In an online environment of Metis, all modifications are applied immediately.
}}

{{Tip
| Test and debug all newly created or modified models before distributing it to the Metis Smart Quotes users through privileged settings.
}}

== Deleting a Model ==

In the '''Models''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Model. Selecting a Model and clicking on it displays the following confirmation window.

[[File:MSM_Modeling_Models_Delete.png|center]]

{{Note
| Deleting a model only removes the "container" form the Metis Database, all [[Metis_Smart_Modeling_-_Masks|masks]] and groups of [[Metis_Smart_Modeling_-_Rules|rules]] which were linked to it will not be deleted! The reason for this is that those parts could be used in other models or re-used in a new one. This way only the binding object is removed from the application.
}}

Once the warning is confirmed, the selected Model is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| As in order section of Metis Smart Modeling, deletion of objects cannot be undone.
}}

== Modifying a Model ==

In the '''Models''' 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 Model. Selecting a Model and clicking on it opens the '''Model''' edition window where all related properties and information can be edited. Apply all necessary modifications based on the explanations available in the previous section about creating and defining a new model. Once done validate the windows to apply the changes.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Model. Modifications applied to the selected Model will only be saved once the Model 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
| In an online environment of Metis, all modifications are applied immediately.
}}

{{Tip
| Test and debug all newly created or modified models before distributing it to the Metis Smart Quotes users through privileged settings.
}}

== Previewing a Model ==

In the '''Model''' 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 Model . Selecting a Model from the table and clicking on it opens the '''Model''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Model.

[[File:MSM_Modeling_Models_Preview_General.png|center|600x400px]]

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

Metis Smart Modeling - Models

2014-01-14T15:45:24Z

PatrickG: /* Previewing a Model */

A model is the building block of Metis Smart Suite . It allows the application to generate a list of material, service items and configure maintenance based on logic rules defined by the business and created by the Metis Smart Modeling user/administrator.

[[Image:Model Pres 1.png|thumb|upright=0.5|alt=Metis Smart Quote Model Description|Metis Smart Quote Model Description]]

This section explains all parameters and techniques to build and maintain models, giving a full understanding of the possibilities behind this functionality. The following sections of this manual will present all aspects related to this task. They are structured based on the different elements required to create full featured models.

The current section describes how a model works and how one can create and maintain it. Based on that information, the following sections describe model building blocks like [[Metis_Smart_Modeling_-_Rules|rules]], [[Metis_Smart_Modeling_-_Group_of_Rules|groups of rules]], [[Metis_Smart_Modeling_-_Variables|variables]] and [[Metis_Smart_Modeling_-_Masks|masks]]. For consistency purposes, all aspects of the creation of models are based on a full featured example.

== How does a model work? ==

Before explaining how to create and use models, it is necessary to explain how Metis Smart Quote works in order to provide the user with a fully featured offer. Establishing such an offer can be summarized through the scheme on the right.
[[Image:Model_Metis_SQ_Exec.png|thumb|upright=0.5|alt=Metis Smart Quote Execution Description|Metis Smart Quote Execution Description]]
When an offer is initiated in Metis Smart Quote, '''modeled positions''' are “calculated” based in the information provided in modeling [[Metis_Smart_Modeling_-_Masks|masks]] and Default Configurations linked to [[Metis_Smart_Modeling_-_Systems#Systems|Systems]]. These values represent the customer’s needs and technical basis. Through the execution of the [[#Material|material]] model, the application creates a list of positions which basically represents the customer’s desired items and all of these products are listed in a structured way.

For example, in the case of a company selling computer [[Metis_Smart_Modeling_-_Systems|systems]], requirements will be provided in the modeling [[Metis_Smart_Modeling_-_Masks|masks]] and after the calculation will result in a list of components like computers, servers and network appliances.

All positions listed through the use of models will be in read only mode. Metis Smart Quote allows, however, editing the list by adding '''manual positions'''. All parameters related to them can be manually set, like quantity and [[Metis_Smart_Modeling_-_Attributes|attributes]].

Based on the previous example, a secondary screen can be added for one or more calculated computers. Or, additional, not modeled network features can be added.

After the two previous steps, Metis Smart Quote will not only list all items required for the offer, but also calculate '''prices'''. This calculation will not only be based on all positions listed in the offer, but also on the pricing settings defined on the positions. For example, a specific computer component, like software licenses may be subject to discounts based on the quantity.

Additionally to defining the list of positions required in an offer, the modeling functionality of Metis Smart Suite, '''services specific models''' can be implemented in the application. Once the pricing of materials and based on the availability of a [[#Service|service]] models, Metis Smart Quote is able to calculated related services through service models and list relevant service position in the offer.

For example, the installation of the complete set of computers and network appliances.

Once the customer required material and service positions defined through the models or manually entered, the '''global pricing''' of an offer can be calculated by Metis Smart Quote.

On top of that, based on the overall offer, Metis allows to trigger so called Tax models which are executed at the very end of the process. These models can typically be used to '''add sales taxes to an offer''' (VAT or recycling).

In Metis Smart Quote, models appear in different forms, based on their type. For [[#Material|material]] models, the linked [[Metis_Smart_Modeling_-_Masks|masks]] will be displayed the application in the offer window when selecting the [[Metis_Smart_Modeling_-_Systems|system]].

{{Note
| For a full description of the use of models in Metis Smart Quote, refer to the “System configuration” section of the applications menu.
}}

Now that the ground work of the model concept is laid down, it is necessary to understand a bit how such a model works in the Metis Smart Suite. As described in figure [[:File:Model_Exec_1.png|Model execution overview]], outside of the [[Metis_Smart_Modeling_-_Masks|masks]], a [[Metis_Smart_Modeling_-_Models|model]] is built on specific objects. Each model includes at least one “[[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]]”, which is a container for individual [[Metis_Smart_Modeling_-_Rules|rules]]. Those [[Metis_Smart_Modeling_-_Rules|rules]] are the logic part of the models. Each [[Metis_Smart_Modeling_-_Rules|rule]] uses input values ([[Metis_Smart_Modeling_-_Variables|variables]], [[Metis_Smart_Modeling_-_Attributes|attributes]], positions) coming from the [[Metis_Smart_Modeling_-_Masks|masks]], default or calculated information to process a logic “formula”. A [[Metis_Smart_Modeling_-_Group_of_Rules|Group of rules]] can include as many [[Metis_Smart_Modeling_-_Rules|rules]] as necessary, with the only constrain that the result of a given [[Metis_Smart_Modeling_-_Rules|rule]] will only be available in the next [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] in the process. As described in figure [[:File:Model_Exec_2.png|Group of rules execution overview]], a [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] feeds on input values which are instantiated before its execution. Once inside, all [[Metis_Smart_Modeling_-_Rules|rules]] will use those values to process the formulas. When all [[Metis_Smart_Modeling_-_Rules|rules]] are processed, the resulting [[Metis_Smart_Modeling_-_Variables|variables]] and/or material positions are prepared for the next [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]].Before starting the execution of the next [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]], the engine instantiates the new input values and lets the various [[Metis_Smart_Modeling_-_Rules|rules]] included in the group feed on them.

[[Image:IMG_BLANK.png|500x226px|link=]][[Image:Model_Exec_1.png|500x226px|link=]] [[Image:Model_Exec_2.png|500x226px|link=]]

For example, when configuring a computer, the selection of a specific CPU will influence the list of compatible motherboards. Only when the appropriate one is determined, will the number of specific ports (like USB) be available and used for further configuration.

{{Note
| Additional information on the use of model can be found in [[Metis_Smart_Quote_User_Manual_Home_Page|Metis Smart Quote Manual]], and the examples listed here.
}}

== Model types ==

The Metis environment supports and enables the use of three different types of [[Metis_Smart_Modeling_-_Rules|rules]]. Overall, the type of the model will determine the "moment" the model will be executed and information it can base itself on. When creating a new model, the user has to select the appropriate type before defining the model.

[[File:MetisSmartModelingSCModels1.PNG|center|354x240px]]

=== Material ===

A model defined as being of type "material" is defined in Metis Smart Modeling to generate a list of material in Metis Smart Quote based on input [[Metis_Smart_Modeling_-_Masks|masks]], [[Metis_Smart_Modeling_-_Rules|rules]] and logic. The result will be displayed in the latest.

The main concept behind this type of model is for the Metis Smart Quote end-user to be able to enter in a simple and graphic way his customer's requirements and then let the application generate the list of necessary positions. This type can be used in many different ways. For example, in the case of a business selling computer [[Metis_Smart_Modeling_-_Systems|systems]], a model can be created which will ask for basic configuration properties and then let the application calculate the various possibilities which may fulfill the customer’s need. The [[Metis_Smart_Modeling_-_Systems|system]] may then even pre-select the less expensive solution. The other possibility is to define a model which could basically be compared to a component catalog and let the user select the required items manually, but in a graphical environment.

=== Service ===

A model defined as being of type "service" will feed on the generated or manually input list of material in Metis Smart Quote to generate service items for the current offer. The result will be displayed in the latest.

Usually those models will use the [[Metis_Smart_Modeling_-_Attributes|attributes]] and position quantities to calculate the required service items. In the displayed list, each of the positions may have [[Metis_Smart_Modeling_-_Attributes|attribute]] values linked to it. For example, a printer defines a time which is required to install its drivers on the host computer(s). These times will then be processed by the model and generate an additional position which will add up all those times and insert the installation service in the offer.

This functionality can also be used to generate additional material item based on the main material list. For example it can be used to calculate the appropriate backup battery (UPS) for the servers included in the offer.

{{Warning
| [[Metis_Smart_Modeling_-_Masks|Masks]] cannot be used in conjunction with service models, as they are calculated based on a list of positions.
}}

=== Tax ===
A model defined as being of type "tax" will feed on the generated or manually input list of material in Metis Smart Quote to generate various taxes. The result will be displayed in the latest.

Usually those models will use total or positions specific amounts, the [[Metis_Smart_Modeling_-_Attributes|attributes]] and position quantities to calculate the taxes. With these type of models, the Metis Smart Modeling user can define any number of taxes like VAT (Value Added Tax) or recycling. The result of the model will be displayed on the offer level, as part of the total price.

A tax model is always linked to the overall offer when used in Metis Smart Quotes. The activation of the model thus has to be done based on a specific group of users belonging to a version. This is done via the Tax Models sub-section of the Profiles menu in Metis Smart Modeling.

The definition of a TAX model varies from the definition of the two other types of models, as it basically consist of a formula which should be applied on prices, quantities, [[Metis_Smart_Modeling_-_Variables|variables]] or [[Metis_Smart_Modeling_-_Attributes|attributes]]. Thus the full definition of it is done in the main model setup window.

[[File:MetisSmartModelingSCModelsTAXDef.PNG|center|706x860px]]

After defining all basic information for the model, like name, descriptions and versioning, the lower part of the window allows to setup the [[Metis_Smart_Modeling_-_Variables|variables]] to be used and formula which will be calculated. As for formula based [[Metis_Smart_Modeling_-_Rules|rules]], the first step is to define which input [[Metis_Smart_Modeling_-_Variables|variables]] should be used in the formula. by clicking on the add button on the left of the table, the application will show a new window where the user can the type and the item to be used as input variable for the formula. In addition to the standard input items, a tax model can also use prices. The list of price types which can be used is available when selecting the "Items" radio button.

When all required input variable are defined, the formula can be typed in the dedicated field below the table. In the above example, the "Net Sales Price" is multiplied by "1.08" in order to calculated the swiss VAT (8%).

[[File:MetisSmartModelingSCModelsTAXDef2.PNG|center|706x860px]]

'''List of "items" :'''
* (Is Material Position) : Will return a Boolean value defining of the position being treated is a material position.
* (Is Service Position) : Will return a Boolean value defining of the position being treated is a service position.
* Cost Price : Will return the cost price of the position being treated.
* Gross Price : Will return the gross price (sales price before all discounts) of the position being treated.
* Net Sales Price : Will return the net sales price (sales price after all discounts) of the position being treated.
* Original Sales Price : Will return the original sales price (sales price as by default in the database) of the position being treated.

{{Note
| Whenever one of these "items" is used in a tax formula, the formula will be executed individually on all items and add up the results to display it as a total.
}}

{{Note
| Several TAX models can be applied on an offer.
}}

== Searching and sorting through models ==

The main screen of the "Modeling" tab in Metis Smart Modeling displays the list of all the model available in the version. That list shows the name of the model, its version, type and creation date. On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Models 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.

[[File:MetisSmartModelingSCModels.PNG‎|center|850x860px]]

== Creating a new Model ==

In the '''Models''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main table allows the user/administrator to create a new Model. When it is clicked, the '''Model''' creation window opens, it allows to define all related information. Select a model type, for example “MAT”. Provide a name for the model, for example “Entry-Level Desktop”, enter a version, for example “1.0”. Enter a description for each available language. The tables below allow the user to define the two main parts of the model, those being the “[[Metis_Smart_Modeling_-_Masks|masks]]” and the “[[Metis_Smart_Modeling_-_Group_of_Rules|groups of rules]]”
For the [[Metis_Smart_Modeling_-_Masks|masks]] table, click on the add button. A window opens where [[Metis_Smart_Modeling_-_Masks|masks]] and groups of [[Metis_Smart_Modeling_-_Masks|masks]] can be selected and linked to the model. Select the desired [[Metis_Smart_Modeling_-_Masks|masks]], for example, “D-Basic Hardware” and “D-Peripherals” and then confirm to continue. For the [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] table, click on the add button. A window similar to the [[Metis_Smart_Modeling_-_Masks|masks]] window opens, but for [[Metis_Smart_Modeling_-_Group_of_Rules|groups of rules]]. Select the desired groups of [[Metis_Smart_Modeling_-_Rules|rules]] and confirm. The green up and down arrows found above each table allow the user to modify the display order of the [[Metis_Smart_Modeling_-_Masks|masks]] as well as the execution order of the groups of [[Metis_Smart_Modeling_-_Rules|rules]].

{{Note
| A proper execution of the model depends entirely on the order of the groups of [[Metis_Smart_Modeling_-_Rules|rules]].
}}

[[File:MetisSmartModelingSCModelsDef.PNG‎|center|764x860px]]

A model is basically constructed of 3 main information. Basic properties will define such information as description, type and versioning. The logical part is made of "[[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]]" which will be used to run the calculation and [[Metis_Smart_Modeling_-_Masks|masks]] which will be displayed in Metis Smart Quotes to allow for input in the model.

* '''Description''' (mandatory) : A description for the model, usually a name.
* '''Type''' ( mandatory) : Each model requires to be typed. On this information will depend the moment the model is executed when used in Metis Smart Quotes.
* '''Versioning''' : When updating a model based on an old one, this information is very useful to keep track of the different versions.
* '''[[Metis_Smart_Modeling_-_Masks|masks]]''' : List of [[Metis_Smart_Modeling_-_Masks|masks]] used in this model. Once the model is linked to a [[Metis_Smart_Modeling_-_Systems|system]], the listed [[Metis_Smart_Modeling_-_Masks|mask]] will appear in Metis Smart Quotes when configuring the [[Metis_Smart_Modeling_-_Systems|system]] in the "Design" section.
* '''[[Metis_Smart_Modeling_-_Group_of_Rules|Group of rules]]''' : List of [[Description_of_the_Sub-Menu_Group_of_Rules|groups of rules]] to be used when executing the model in Metis Smart Quotes. The order of the groups of [[Metis_Smart_Modeling_-_Rules|rules]] is very important for the model to generate concrete and valid results.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/7/71/VID_CreatingAModel.PNG'>File:Creating a model OK.mp4</mediaplayer>
| Creation of a new model, selection of linked groups of [[Metis_Smart_Modeling_-_Rules|rules]] and [[Metis_Smart_Modeling_-_Masks|masks]].
}}

{{Note
| A service or material model doesn't have influence on a configuration without fully configured groups of [[Metis_Smart_Modeling_-_Rules|rules]] and in the case on material models [[Metis_Smart_Modeling_-_Masks|masks]].
}}

{{Note
| The example used above applies on material models as well as service models. Only tax model are defined in a different way.
}}

The model definition window also allows to setup which [[Metis_Smart_Modeling_-_Systems|systems]] will use the model when inserted in an offer in Metis Smart Quotes. By moving to the second tab in the window a list of all [[Metis_Smart_Modeling_-_Systems|system]] defined in Metis Smart Modeling is displayed and lets the user validate the [[Metis_Smart_Modeling_-_Systems|system(s)]] which should use this models with the appropriate offer type.

[[File:MetisSmartModelingSCModelsDef2.PNG‎|center|764x860px]]

{{Tip
| The System tab is very useful to have an overview of which [[Metis_Smart_Modeling_-_Systems|systems]] use the selected model.
}}

== Deleting a Model ==

In the '''Models''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Model. Selecting a Model and clicking on it displays the following confirmation window.

[[File:MSM_Modeling_Models_Delete.png|center]]

{{Note
| Deleting a model only removes the "container" form the Metis Database, all [[Metis_Smart_Modeling_-_Masks|masks]] and groups of [[Metis_Smart_Modeling_-_Rules|rules]] which were linked to it will not be deleted! The reason for this is that those parts could be used in other models or re-used in a new one. This way only the binding object is removed from the application.
}}

Once the warning is confirmed, the selected Model is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| As in order section of Metis Smart Modeling, deletion of objects cannot be undone.
}}

== Modifying a Model ==

In the '''Models''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main table/list allows the user/administrator to apply modifications to all properties related to the selected Model. Selecting a Model and clicking on it opens the '''Model''' edition window where all related properties and information can be edited. Apply all necessary modifications based on the explanations available in the previous section about creating and defining a new model. Once done validate the windows to apply the changes.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Model. Modifications applied to the selected Model will only be saved once the Model edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the table/list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

{{Note
| In an online environment of Metis, all modifications are applied immediately.
}}

{{Tip
| Test and debug all newly created or modified models before distributing it to the Metis Smart Quotes users through privileged settings.
}}

== Previewing a Model ==

In the '''Model''' 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 Model . Selecting a Model from the table and clicking on it opens the '''Model''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Model.

[[File:MSM_Modeling_Models_Preview_General.png|center|600x400px]]

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

Metis Smart Modeling - Models

2014-01-14T15:44:57Z

PatrickG:

A model is the building block of Metis Smart Suite . It allows the application to generate a list of material, service items and configure maintenance based on logic rules defined by the business and created by the Metis Smart Modeling user/administrator.

[[Image:Model Pres 1.png|thumb|upright=0.5|alt=Metis Smart Quote Model Description|Metis Smart Quote Model Description]]

This section explains all parameters and techniques to build and maintain models, giving a full understanding of the possibilities behind this functionality. The following sections of this manual will present all aspects related to this task. They are structured based on the different elements required to create full featured models.

The current section describes how a model works and how one can create and maintain it. Based on that information, the following sections describe model building blocks like [[Metis_Smart_Modeling_-_Rules|rules]], [[Metis_Smart_Modeling_-_Group_of_Rules|groups of rules]], [[Metis_Smart_Modeling_-_Variables|variables]] and [[Metis_Smart_Modeling_-_Masks|masks]]. For consistency purposes, all aspects of the creation of models are based on a full featured example.

== How does a model work? ==

Before explaining how to create and use models, it is necessary to explain how Metis Smart Quote works in order to provide the user with a fully featured offer. Establishing such an offer can be summarized through the scheme on the right.
[[Image:Model_Metis_SQ_Exec.png|thumb|upright=0.5|alt=Metis Smart Quote Execution Description|Metis Smart Quote Execution Description]]
When an offer is initiated in Metis Smart Quote, '''modeled positions''' are “calculated” based in the information provided in modeling [[Metis_Smart_Modeling_-_Masks|masks]] and Default Configurations linked to [[Metis_Smart_Modeling_-_Systems#Systems|Systems]]. These values represent the customer’s needs and technical basis. Through the execution of the [[#Material|material]] model, the application creates a list of positions which basically represents the customer’s desired items and all of these products are listed in a structured way.

For example, in the case of a company selling computer [[Metis_Smart_Modeling_-_Systems|systems]], requirements will be provided in the modeling [[Metis_Smart_Modeling_-_Masks|masks]] and after the calculation will result in a list of components like computers, servers and network appliances.

All positions listed through the use of models will be in read only mode. Metis Smart Quote allows, however, editing the list by adding '''manual positions'''. All parameters related to them can be manually set, like quantity and [[Metis_Smart_Modeling_-_Attributes|attributes]].

Based on the previous example, a secondary screen can be added for one or more calculated computers. Or, additional, not modeled network features can be added.

After the two previous steps, Metis Smart Quote will not only list all items required for the offer, but also calculate '''prices'''. This calculation will not only be based on all positions listed in the offer, but also on the pricing settings defined on the positions. For example, a specific computer component, like software licenses may be subject to discounts based on the quantity.

Additionally to defining the list of positions required in an offer, the modeling functionality of Metis Smart Suite, '''services specific models''' can be implemented in the application. Once the pricing of materials and based on the availability of a [[#Service|service]] models, Metis Smart Quote is able to calculated related services through service models and list relevant service position in the offer.

For example, the installation of the complete set of computers and network appliances.

Once the customer required material and service positions defined through the models or manually entered, the '''global pricing''' of an offer can be calculated by Metis Smart Quote.

On top of that, based on the overall offer, Metis allows to trigger so called Tax models which are executed at the very end of the process. These models can typically be used to '''add sales taxes to an offer''' (VAT or recycling).

In Metis Smart Quote, models appear in different forms, based on their type. For [[#Material|material]] models, the linked [[Metis_Smart_Modeling_-_Masks|masks]] will be displayed the application in the offer window when selecting the [[Metis_Smart_Modeling_-_Systems|system]].

{{Note
| For a full description of the use of models in Metis Smart Quote, refer to the “System configuration” section of the applications menu.
}}

Now that the ground work of the model concept is laid down, it is necessary to understand a bit how such a model works in the Metis Smart Suite. As described in figure [[:File:Model_Exec_1.png|Model execution overview]], outside of the [[Metis_Smart_Modeling_-_Masks|masks]], a [[Metis_Smart_Modeling_-_Models|model]] is built on specific objects. Each model includes at least one “[[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]]”, which is a container for individual [[Metis_Smart_Modeling_-_Rules|rules]]. Those [[Metis_Smart_Modeling_-_Rules|rules]] are the logic part of the models. Each [[Metis_Smart_Modeling_-_Rules|rule]] uses input values ([[Metis_Smart_Modeling_-_Variables|variables]], [[Metis_Smart_Modeling_-_Attributes|attributes]], positions) coming from the [[Metis_Smart_Modeling_-_Masks|masks]], default or calculated information to process a logic “formula”. A [[Metis_Smart_Modeling_-_Group_of_Rules|Group of rules]] can include as many [[Metis_Smart_Modeling_-_Rules|rules]] as necessary, with the only constrain that the result of a given [[Metis_Smart_Modeling_-_Rules|rule]] will only be available in the next [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] in the process. As described in figure [[:File:Model_Exec_2.png|Group of rules execution overview]], a [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] feeds on input values which are instantiated before its execution. Once inside, all [[Metis_Smart_Modeling_-_Rules|rules]] will use those values to process the formulas. When all [[Metis_Smart_Modeling_-_Rules|rules]] are processed, the resulting [[Metis_Smart_Modeling_-_Variables|variables]] and/or material positions are prepared for the next [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]].Before starting the execution of the next [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]], the engine instantiates the new input values and lets the various [[Metis_Smart_Modeling_-_Rules|rules]] included in the group feed on them.

[[Image:IMG_BLANK.png|500x226px|link=]][[Image:Model_Exec_1.png|500x226px|link=]] [[Image:Model_Exec_2.png|500x226px|link=]]

For example, when configuring a computer, the selection of a specific CPU will influence the list of compatible motherboards. Only when the appropriate one is determined, will the number of specific ports (like USB) be available and used for further configuration.

{{Note
| Additional information on the use of model can be found in [[Metis_Smart_Quote_User_Manual_Home_Page|Metis Smart Quote Manual]], and the examples listed here.
}}

== Model types ==

The Metis environment supports and enables the use of three different types of [[Metis_Smart_Modeling_-_Rules|rules]]. Overall, the type of the model will determine the "moment" the model will be executed and information it can base itself on. When creating a new model, the user has to select the appropriate type before defining the model.

[[File:MetisSmartModelingSCModels1.PNG|center|354x240px]]

=== Material ===

A model defined as being of type "material" is defined in Metis Smart Modeling to generate a list of material in Metis Smart Quote based on input [[Metis_Smart_Modeling_-_Masks|masks]], [[Metis_Smart_Modeling_-_Rules|rules]] and logic. The result will be displayed in the latest.

The main concept behind this type of model is for the Metis Smart Quote end-user to be able to enter in a simple and graphic way his customer's requirements and then let the application generate the list of necessary positions. This type can be used in many different ways. For example, in the case of a business selling computer [[Metis_Smart_Modeling_-_Systems|systems]], a model can be created which will ask for basic configuration properties and then let the application calculate the various possibilities which may fulfill the customer’s need. The [[Metis_Smart_Modeling_-_Systems|system]] may then even pre-select the less expensive solution. The other possibility is to define a model which could basically be compared to a component catalog and let the user select the required items manually, but in a graphical environment.

=== Service ===

A model defined as being of type "service" will feed on the generated or manually input list of material in Metis Smart Quote to generate service items for the current offer. The result will be displayed in the latest.

Usually those models will use the [[Metis_Smart_Modeling_-_Attributes|attributes]] and position quantities to calculate the required service items. In the displayed list, each of the positions may have [[Metis_Smart_Modeling_-_Attributes|attribute]] values linked to it. For example, a printer defines a time which is required to install its drivers on the host computer(s). These times will then be processed by the model and generate an additional position which will add up all those times and insert the installation service in the offer.

This functionality can also be used to generate additional material item based on the main material list. For example it can be used to calculate the appropriate backup battery (UPS) for the servers included in the offer.

{{Warning
| [[Metis_Smart_Modeling_-_Masks|Masks]] cannot be used in conjunction with service models, as they are calculated based on a list of positions.
}}

=== Tax ===
A model defined as being of type "tax" will feed on the generated or manually input list of material in Metis Smart Quote to generate various taxes. The result will be displayed in the latest.

Usually those models will use total or positions specific amounts, the [[Metis_Smart_Modeling_-_Attributes|attributes]] and position quantities to calculate the taxes. With these type of models, the Metis Smart Modeling user can define any number of taxes like VAT (Value Added Tax) or recycling. The result of the model will be displayed on the offer level, as part of the total price.

A tax model is always linked to the overall offer when used in Metis Smart Quotes. The activation of the model thus has to be done based on a specific group of users belonging to a version. This is done via the Tax Models sub-section of the Profiles menu in Metis Smart Modeling.

The definition of a TAX model varies from the definition of the two other types of models, as it basically consist of a formula which should be applied on prices, quantities, [[Metis_Smart_Modeling_-_Variables|variables]] or [[Metis_Smart_Modeling_-_Attributes|attributes]]. Thus the full definition of it is done in the main model setup window.

[[File:MetisSmartModelingSCModelsTAXDef.PNG|center|706x860px]]

After defining all basic information for the model, like name, descriptions and versioning, the lower part of the window allows to setup the [[Metis_Smart_Modeling_-_Variables|variables]] to be used and formula which will be calculated. As for formula based [[Metis_Smart_Modeling_-_Rules|rules]], the first step is to define which input [[Metis_Smart_Modeling_-_Variables|variables]] should be used in the formula. by clicking on the add button on the left of the table, the application will show a new window where the user can the type and the item to be used as input variable for the formula. In addition to the standard input items, a tax model can also use prices. The list of price types which can be used is available when selecting the "Items" radio button.

When all required input variable are defined, the formula can be typed in the dedicated field below the table. In the above example, the "Net Sales Price" is multiplied by "1.08" in order to calculated the swiss VAT (8%).

[[File:MetisSmartModelingSCModelsTAXDef2.PNG|center|706x860px]]

'''List of "items" :'''
* (Is Material Position) : Will return a Boolean value defining of the position being treated is a material position.
* (Is Service Position) : Will return a Boolean value defining of the position being treated is a service position.
* Cost Price : Will return the cost price of the position being treated.
* Gross Price : Will return the gross price (sales price before all discounts) of the position being treated.
* Net Sales Price : Will return the net sales price (sales price after all discounts) of the position being treated.
* Original Sales Price : Will return the original sales price (sales price as by default in the database) of the position being treated.

{{Note
| Whenever one of these "items" is used in a tax formula, the formula will be executed individually on all items and add up the results to display it as a total.
}}

{{Note
| Several TAX models can be applied on an offer.
}}

== Searching and sorting through models ==

The main screen of the "Modeling" tab in Metis Smart Modeling displays the list of all the model available in the version. That list shows the name of the model, its version, type and creation date. On the left-hand side of the main window, a '''Search''' feature is found. It allows the user/administrator to find Models 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.

[[File:MetisSmartModelingSCModels.PNG‎|center|850x860px]]

== Creating a new Model ==

In the '''Models''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main table allows the user/administrator to create a new Model. When it is clicked, the '''Model''' creation window opens, it allows to define all related information. Select a model type, for example “MAT”. Provide a name for the model, for example “Entry-Level Desktop”, enter a version, for example “1.0”. Enter a description for each available language. The tables below allow the user to define the two main parts of the model, those being the “[[Metis_Smart_Modeling_-_Masks|masks]]” and the “[[Metis_Smart_Modeling_-_Group_of_Rules|groups of rules]]”
For the [[Metis_Smart_Modeling_-_Masks|masks]] table, click on the add button. A window opens where [[Metis_Smart_Modeling_-_Masks|masks]] and groups of [[Metis_Smart_Modeling_-_Masks|masks]] can be selected and linked to the model. Select the desired [[Metis_Smart_Modeling_-_Masks|masks]], for example, “D-Basic Hardware” and “D-Peripherals” and then confirm to continue. For the [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] table, click on the add button. A window similar to the [[Metis_Smart_Modeling_-_Masks|masks]] window opens, but for [[Metis_Smart_Modeling_-_Group_of_Rules|groups of rules]]. Select the desired groups of [[Metis_Smart_Modeling_-_Rules|rules]] and confirm. The green up and down arrows found above each table allow the user to modify the display order of the [[Metis_Smart_Modeling_-_Masks|masks]] as well as the execution order of the groups of [[Metis_Smart_Modeling_-_Rules|rules]].

{{Note
| A proper execution of the model depends entirely on the order of the groups of [[Metis_Smart_Modeling_-_Rules|rules]].
}}

[[File:MetisSmartModelingSCModelsDef.PNG‎|center|764x860px]]

A model is basically constructed of 3 main information. Basic properties will define such information as description, type and versioning. The logical part is made of "[[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]]" which will be used to run the calculation and [[Metis_Smart_Modeling_-_Masks|masks]] which will be displayed in Metis Smart Quotes to allow for input in the model.

* '''Description''' (mandatory) : A description for the model, usually a name.
* '''Type''' ( mandatory) : Each model requires to be typed. On this information will depend the moment the model is executed when used in Metis Smart Quotes.
* '''Versioning''' : When updating a model based on an old one, this information is very useful to keep track of the different versions.
* '''[[Metis_Smart_Modeling_-_Masks|masks]]''' : List of [[Metis_Smart_Modeling_-_Masks|masks]] used in this model. Once the model is linked to a [[Metis_Smart_Modeling_-_Systems|system]], the listed [[Metis_Smart_Modeling_-_Masks|mask]] will appear in Metis Smart Quotes when configuring the [[Metis_Smart_Modeling_-_Systems|system]] in the "Design" section.
* '''[[Metis_Smart_Modeling_-_Group_of_Rules|Group of rules]]''' : List of [[Description_of_the_Sub-Menu_Group_of_Rules|groups of rules]] to be used when executing the model in Metis Smart Quotes. The order of the groups of [[Metis_Smart_Modeling_-_Rules|rules]] is very important for the model to generate concrete and valid results.

{{Video
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/7/71/VID_CreatingAModel.PNG'>File:Creating a model OK.mp4</mediaplayer>
| Creation of a new model, selection of linked groups of [[Metis_Smart_Modeling_-_Rules|rules]] and [[Metis_Smart_Modeling_-_Masks|masks]].
}}

{{Note
| A service or material model doesn't have influence on a configuration without fully configured groups of [[Metis_Smart_Modeling_-_Rules|rules]] and in the case on material models [[Metis_Smart_Modeling_-_Masks|masks]].
}}

{{Note
| The example used above applies on material models as well as service models. Only tax model are defined in a different way.
}}

The model definition window also allows to setup which [[Metis_Smart_Modeling_-_Systems|systems]] will use the model when inserted in an offer in Metis Smart Quotes. By moving to the second tab in the window a list of all [[Metis_Smart_Modeling_-_Systems|system]] defined in Metis Smart Modeling is displayed and lets the user validate the [[Metis_Smart_Modeling_-_Systems|system(s)]] which should use this models with the appropriate offer type.

[[File:MetisSmartModelingSCModelsDef2.PNG‎|center|764x860px]]

{{Tip
| The System tab is very useful to have an overview of which [[Metis_Smart_Modeling_-_Systems|systems]] use the selected model.
}}

== Deleting a Model ==

In the '''Models''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected Model. Selecting a Model and clicking on it displays the following confirmation window.

[[File:MSM_Modeling_Models_Delete.png|center]]

{{Note
| Deleting a model only removes the "container" form the Metis Database, all [[Metis_Smart_Modeling_-_Masks|masks]] and groups of [[Metis_Smart_Modeling_-_Rules|rules]] which were linked to it will not be deleted! The reason for this is that those parts could be used in other models or re-used in a new one. This way only the binding object is removed from the application.
}}

Once the warning is confirmed, the selected Model is removed from Metis Smart Suite and deleted from the Metis Database.

{{Note
| As in order section of Metis Smart Modeling, deletion of objects cannot be undone.
}}

== Modifying a Model ==

In the '''Models''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main table/list allows the user/administrator to apply modifications to all properties related to the selected Model. Selecting a Model and clicking on it opens the '''Model''' edition window where all related properties and information can be edited. Apply all necessary modifications based on the explanations available in the previous section about creating and defining a new model. Once done validate the windows to apply the changes.

For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Model. Modifications applied to the selected Model will only be saved once the Model edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the table/list displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window.

{{Note
| In an online environment of Metis, all modifications are applied immediately.
}}

{{Tip
| Test and debug all newly created or modified models before distributing it to the Metis Smart Quotes users through privileged settings.
}}

== Previewing a Model ==

In the '''Model''' 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 Model . Selecting a Model from the table and clicking on it opens the '''Model''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new Model.

[[File:MSM_Modeling_Models_Preview_General.png|center]]

{{Note
| Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used.
}}

File:MSM Modeling Models Preview General.png

2014-01-14T15:44:29Z

PatrickG:

File:MetisSmartModelingSCVariables2.PNG

2014-01-14T12:38:37Z

PatrickG: uploaded a new version of "File:MetisSmartModelingSCVariables2.PNG"

Modeling - Variables - Group of items

File:MetisSmartModelingSCVariables1.PNG

2014-01-14T12:38:19Z

PatrickG: uploaded a new version of "File:MetisSmartModelingSCVariables1.PNG"

Modeling - Variables definition

File:MetisSmartModelingSCSystemsSubSys.PNG

2014-01-14T12:37:58Z

PatrickG: uploaded a new version of "File:MetisSmartModelingSCSystemsSubSys.PNG"

File:MetisSmartModelingSCSystemsPictures.PNG

2014-01-14T12:37:41Z

PatrickG: uploaded a new version of "File:MetisSmartModelingSCSystemsPictures.PNG"

File:MetisSmartModelingSCSystemsLInkedWith.PNG

2014-01-14T12:37:29Z

PatrickG: uploaded a new version of "File:MetisSmartModelingSCSystemsLInkedWith.PNG"

File:MetisSmartModelingSCSystemsLimits.PNG

2014-01-14T12:36:54Z

PatrickG: uploaded a new version of "File:MetisSmartModelingSCSystemsLimits.PNG"

File:MetisSmartModelingSCSystemsGrpofSys.PNG

2014-01-14T12:36:41Z

PatrickG: uploaded a new version of "File:MetisSmartModelingSCSystemsGrpofSys.PNG"

File:MetisSmartModelingSCSystemsGeneral.PNG

2014-01-14T12:36:28Z

PatrickG: uploaded a new version of "File:MetisSmartModelingSCSystemsGeneral.PNG"