Description of the Menu Versions Upadte - Revision history

Patrick: Replaced content with "link=Description_of_the_Menu_Versions_Versionslink=Description_of_the_Menu_Versions_Access[[File:..."

2013-11-05T07:46:50Z

Replaced content with "link=Description_of_the_Menu_Versions_Versions link=Description_of_the_Menu_Versions_Access[[File:..."

← Older revision		Revision as of 07:46, 5 November 2013
Line 1:		Line 1:
	[[File:MSM-Versions-Version-BTN1.png\|link=Description_of_the_Menu_Versions_Versions]][[File:MSM-Versions-Access-BTN1.png\|link=Description_of_the_Menu_Versions_Access]][[File:MSM-Versions-Languages-BTN1.png\|link=Description_of_the_Menu_Versions_Languages]][[File:MSM-Versions-Update-BTN2.png\|link=]][[File:MSM-Versions-Licenses-BTN1.png\|link=Description_of_the_Menu_Versions_Licenses]]		[[File:MSM-Versions-Version-BTN1.png\|link=Description_of_the_Menu_Versions_Versions]][[File:MSM-Versions-Access-BTN1.png\|link=Description_of_the_Menu_Versions_Access]][[File:MSM-Versions-Languages-BTN1.png\|link=Description_of_the_Menu_Versions_Languages]][[File:MSM-Versions-Update-BTN2.png\|link=]][[File:MSM-Versions-Licenses-BTN1.png\|link=Description_of_the_Menu_Versions_Licenses]]
-
-	~~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.~~
-	}}

Patrick at 09:27, 30 September 2013

2013-09-30T09:27:02Z

← Older revision		Revision as of 09:27, 30 September 2013
Line 1:		Line 1:
	[[File:MSM-Versions-Version-BTN1.png\|link=Description_of_the_Menu_Versions_Versions]][[File:MSM-Versions-Access-BTN1.png\|link=Description_of_the_Menu_Versions_Access]][[File:MSM-Versions-Languages-BTN1.png\|link=Description_of_the_Menu_Versions_Languages]][[File:MSM-Versions-Update-BTN2.png\|link=]][[File:MSM-Versions-Licenses-BTN1.png\|link=Description_of_the_Menu_Versions_Licenses]]		[[File:MSM-Versions-Version-BTN1.png\|link=Description_of_the_Menu_Versions_Versions]][[File:MSM-Versions-Access-BTN1.png\|link=Description_of_the_Menu_Versions_Access]][[File:MSM-Versions-Languages-BTN1.png\|link=Description_of_the_Menu_Versions_Languages]][[File:MSM-Versions-Update-BTN2.png\|link=]][[File:MSM-Versions-Licenses-BTN1.png\|link=Description_of_the_Menu_Versions_Licenses]]

-	The Metis update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.	+	The Metis Smart Suite update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.


Line 17:		Line 17:
	=== Preparing Metis Smart Quotes Updates ===		=== Preparing Metis Smart Quotes Updates ===

-	The update sub-menu is used to prepare ~~an update~~ for offline versions of the Metis Smart ~~Suite~~. By default an update which will be created ~~from~~ 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 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.	+	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.


Line 23:		Line 23:


-	In the update sub-menu the main working area is ~~occupied by~~ a table with the following columns:	+	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.		*'''Source File Name''': The name of the original file found under either the "Common Files" or "Specific Files" folder depending on the choice made.
Line 51:		Line 51:
	[[File:IMG_Version_Concept.png\|center\|600x400px]]		[[File:IMG_Version_Concept.png\|center\|600x400px]]

-
-	~~[add the diagram from the preparing an update video]~~


Line 63:		Line 61:


-	After selecting a file type and confirming, a ~~select a file~~ 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.	+	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====		====Delete Files====

-	~~Selecting a file and clicking on~~ the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG\|link=]] ~~deletes the file from~~ the main table of the ~~update sub-menu~~.	+	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.
-		+

-	~~{{Note~~
-	~~\| The user is not given a warning pop-up when clicking on the delete button, the file will instantly be deleted from the table once the button has been clicked.~~
-	}}


-	~~Multiple files may be~~ selected ~~and deleted together~~.	+	Once the warning is confirmed, the selected files are removed from the Metis Smart Suite Update.

	====Prepare Update====		====Prepare Update====

Patrick at 12:39, 7 August 2013

2013-08-07T12:39:09Z

← Older revision		Revision as of 12:39, 7 August 2013
Line 1:		Line 1:
-	[[File:MSM-Versions-Version-BTN1.png\|link=Description_of_the_Menu_Versions_Versions]][[File:MSM-Versions-Access-BTN1.png\|link=Description_of_the_Menu_Versions_Access]][[File:MSM-Versions-Languages-BTN1.png\|link=Description_of_the_Menu_Versions_Languages]][[File:MSM-Versions-Update-~~BTN1~~.png\|link=~~Description_of_the_Menu_Versions_Upadte~~]][[File:MSM-Versions-Licenses-BTN1.png\|link=Description_of_the_Menu_Versions_Licenses]]	+	[[File:MSM-Versions-Version-BTN1.png\|link=Description_of_the_Menu_Versions_Versions]][[File:MSM-Versions-Access-BTN1.png\|link=Description_of_the_Menu_Versions_Access]][[File:MSM-Versions-Languages-BTN1.png\|link=Description_of_the_Menu_Versions_Languages]][[File:MSM-Versions-Update-BTN2.png\|link=]][[File:MSM-Versions-Licenses-BTN1.png\|link=Description_of_the_Menu_Versions_Licenses]]

	The Metis update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.		The Metis update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.

Patrick at 12:34, 7 August 2013

2013-08-07T12:34:09Z

← Older revision		Revision as of 12:34, 7 August 2013
Line 1:		Line 1:
		+	[[File:MSM-Versions-Version-BTN1.png\|link=Description_of_the_Menu_Versions_Versions]][[File:MSM-Versions-Access-BTN1.png\|link=Description_of_the_Menu_Versions_Access]][[File:MSM-Versions-Languages-BTN1.png\|link=Description_of_the_Menu_Versions_Languages]][[File:MSM-Versions-Update-BTN1.png\|link=Description_of_the_Menu_Versions_Upadte]][[File:MSM-Versions-Licenses-BTN1.png\|link=Description_of_the_Menu_Versions_Licenses]]
		+
	The Metis update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.		The Metis update process allows to distribute all defined information and settings to the end-users of the Metis Smart Quote Software.

Patrick at 12:28, 7 August 2013

2013-08-07T12:28:57Z

← Older revision		Revision as of 12:28, 7 August 2013
Line 63:		Line 63:
	After selecting a file type and confirming, a select a file 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.		After selecting a file type and confirming, a select a file 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====	+	====Delete Files====

	Selecting a file and clicking on the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG\|link=]] deletes the file from the main table of the update sub-menu.		Selecting a file and clicking on the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG\|link=]] deletes the file from the main table of the update sub-menu.

Patrick: Created page with "The Metis 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..."

2013-08-07T12:28:20Z

Created page with "The Metis 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..."

New page

The Metis 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 an update for offline versions of the Metis Smart Suite. By default an update which will be created from 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 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 occupied by 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 the diagram from the preparing an update video]

====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 select a file 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====

Selecting a file and clicking on the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] deletes the file from the main table of the update sub-menu.

{{Note
| The user is not given a warning pop-up when clicking on the delete button, the file will instantly be deleted from the table once the button has been clicked.
}}

Multiple files may be selected and deleted together.

====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.
}}