Description of the Menu Versions
From Metis Documentation
(→Update) |
(→Add) |
||
| Line 1: | Line 1: | ||
| - | + | 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 | + | == 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 == | == 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 == | == 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 == | == Licensing == | ||
(TBD) | (TBD) | ||