Description of the Menu Versions
From Metis Documentation
(→Languages) |
(→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. | 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. | ||
| Line 15: | Line 13: | ||
| - | [[File: | + | [[File:IMG_Version_Concept.png|center|600x400px]] |
| Line 26: | Line 24: | ||
Versions in the main table may be represented by several different types of icons. | 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. | 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. | ||
| Line 32: | Line 59: | ||
[[File:MSM_Versions_Versions.png|center|600x400px]] | [[File:MSM_Versions_Versions.png|center|600x400px]] | ||
| - | |||
| - | |||
| - | |||
| Line 42: | Line 66: | ||
[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] | [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 === | === Managing versions === | ||
| Line 74: | Line 133: | ||
* Default currency : set the default currency to used for all offers created within this 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]]'''. | * 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. | ||
| Line 109: | Line 181: | ||
'''[[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. | '''[[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 ''' | + | 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. | 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. | ||
| Line 115: | Line 187: | ||
[[File:MSM_Versions_Versions_add_profiles.png|center|600x400px]] | [[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. | ||
| + | }} | ||
| Line 196: | Line 273: | ||
}} | }} | ||
| + | |||
| + | 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 ==== | ==== Version without Administrator ==== | ||
| Line 208: | Line 287: | ||
| Setting up a version without an administrator. | | Setting up a version without an administrator. | ||
}} | }} | ||
| - | |||
== Access == | == Access == | ||
| Line 458: | Line 536: | ||
== 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) | ||