Promotion Manager
ViVE’s ‘Promotion Manager’ is a user-friendly feature designed to facilitate seamless export and import of objects created under a Process Map from one environment to another. This feature significantly simplifies the replication process across different environments, such as exporting or importing Dashboards and Reports (created under a Process Map) from one environment to another.
Key Capabilities of ‘Promotion Manager’ include:
Efficient Object Transfer: Enables users to effortlessly transfer objects, eliminating the need for time-consuming and error-prone manual replication.
Environment Agnostic: Objects can be moved between environments (e.g., Dev to QA) with minimal effort, ensuring consistency across stages, without the need to make any changes in the environments.
User-Friendly Interface: The feature provides an intuitive interface that guides users through the transfer process effortlessly.
Minimal Input Required: Users only need to provide a few essential details, making the process quick and straightforward.
Error Reduction: Unlike manual replication, automated object transfer reduces the likelihood of errors and increases operational efficiency.
This feature provides significant value in scenarios involving frequent and consistent replication of objects(created under a Process Map) across different environments.
The process of replication from one environment to an other environment consists of two main stages: ‘Export’ and ‘Import’.
The objects which need to be replicated will have to be initially ‘Exported’ from the source environment and then ‘Imported’ into the target environment.
The different steps involved in both the stages are detailed in the following sections.
Export
Click the ‘Promotion Manager’ option in the ‘Settings’ menu of ViVE’s main interface, to display the following screen:
Select the ‘export’ option, and all available Workspaces will be listed in the ‘Workspaces’ dropdown list.
Select the Workspace from the list to display the following screen:
All the available Process Maps under the selected Workspace will be listed here.
Select any Process Map by clicking the box against the chosen Process Map and click the ‘Next’ button to display the following screen:
The list displays all the objects (Dashboards and Reports) created using the selected Process Map.
Select one or more of the objects, which need to be exported, and click the ‘Submit’ button.
The chosen objects will be exported in a XML format to the ‘Downloads’ folder and a confirmation will be displayed in the form of a message.
This completed the ‘Export’ process.
Note: ‘Promotion Manager’ supports Process Maps created from SQL Server sources only and allows export of one Process Map at a time.
Import
The ‘Import’ stage is second and final in the replication process and involves the following three steps:
Upload the downloaded XML file to the target environment
Update the connections associated with the imported Process Map
Schedule Data Refresh
The second and third steps are mandatory for the first time replication only.
Upload the XML file
Select the ‘import’ option in the ‘Promotion Manager' main interface to display the following screen:
The tabular view in the lower half of the screen displays the data pertaining to the earlier ‘import’ jobs that have been executed in the environment.
The first step in the import process is to upload the XML file.
Click the ‘Choose File’ button and select the XML file (earlier exported) to be imported into the current environment.
Click the Upload button after selecting the XML file and the ‘Workspace’ drop down list will be populated with all the available Workspaces in the environment.
The Imported Workspace will be earmarked as ‘new’, if this is being imported for the first time and does not exist in the current environment.
The Tabular view at the lower half of the screen displays all the Process Maps in the selected Workspace.
The second column in the tabular view displays two options against each of the listed Process Maps.
For Process Maps which are imported for the first time the options will be:
Create New
Ignore
If the selected Process Map already exists, then the options will be:
Overwrite Existing
Ignore
The ‘Create New’ option will create the Process Map afresh, while the ‘Overwrite Existing’ option will overwrite the existing Process Map with the imported Process Map.
Once, the options are made, click the ‘Next’ button to display the following screen.
All the Dashboards and Reports under the selected Process Map will be displayed in the form of a tabular view at the lower half of the screen.
Select one of the two options ‘Create New’ or ‘Ignore’ for each of the objects and click the ‘Submit’ button to complete the upload process.
A status message will be displayed as shown below
Click the ‘Refresh’ button to view the status of the ‘upload’ process in the tabular view.
The status will be either ‘In Progress' or ‘Completed’. The duration of completion and the Created Date Time are displayed in separate columns against each of the uploads.
Note:
If the source database already exists on the import server with the updated connection details, there's no need to update the connections for any process maps created using that source.
For Process Map and Dashboard links to work correctly, the selected Process Map and Dashboards must be created or overwritten together during the import process.
Workspace selection is not mandatory during import. When a user uploads an XML file, the import server automatically validates and selects the appropriate Workspace based on the XML. If the exported Workspace does not exist, a new Workspace will be created using the naming convention specified in the XML file.
If you want to import new process maps into an existing workspace, first upload the XML file and click 'Upload'. Once the process maps are loaded, switch to the workspace where you want to import them.
If a process map already exists in another workspace, the system will validate and display an alert, allowing you to overwrite it only in the existing workspace.
Renaming existing Dashboards, or Reports will be treated as a new creation during import.
Overwrite functionality applies only within the same Workspace. Overwriting is based on object names and occurs automatically if matching names are found.
When duplicating or renaming existing process maps and related objects, there's no need to update any connections or run the scheduler, as they use the existing data model. After import, the new changes will automatically appear upon refresh.
The duplicate functionality is not supported for Comply Dashboards when renaming the existing configurations is involved.
The following feature configurations are not included in the import:
'Process configuration', ‘Swim Lanes’ and ‘Drill Through’
User-level preferences
Dashboard user - level preferences.
Update the connections
The second step in the ‘Import’ stage is updating the connections associated with the imported Process Map.
From the ‘ViVE Admin’ option in ViVE’s main menu, click on the ‘Data and Connections’ option.
From the options under ‘Data and Connections’, click on ‘Connections' to display the following screen:
Select the Workspace from the ‘Workspace’ dropdown list and click the ‘search’ button to display the following screen.
Click the ‘Edit’ icon against the displayed connection name and the connection details will be displayed at the bottom.
Enter the Name of the Server, User Id and Password in the columns provided and click the ‘Update’ button to complete updating the connections for the Process Map.
Schedule Data Refresh
The third step in the ‘Import’ stage is scheduling Data Refresh.
From the ‘ViVE Admin’ option in ViVE’s main menu, click on the ‘Data and Connections’ option.
From the options under ‘Data and Connections’, click on ‘Schedule Data Refresh' to display the following screen:
Select the ‘Workspace’ and the ‘Source Connection’ and click the create button to navigate to the following screen:
Enter all the required parameters and click the ‘Schedule’ button to complete scheduling the Data Refresh.
For overwrite, there's no need to schedule a data refresh — this only applies to newly created Process Maps.
This completes the third step in the ‘Import’ stage and the Replication process in total.