Managing Deployment Bundles

Topics:

The Deployment section enables you to manage the installed deployment bundle, as well as retrieve information on the associated Subjects. You can replace the current deployment, as required, or simply update the deployment from a new bundle.

In the left pane of the Omni Console, click Deployment, as shown in the following image.

The following table lists and describes the available buttons on the Deployment toolbar.

Toolbar Button

Description

Deploy Bundle

Enables you to select a number of different deployment actions related to managing the model plans.

Install/Replace Bundle. Opens a dialog box, to browse your file system and select a bundle to deploy as a replacement.

The option is labeled Install Bundle or Replace Bundle if an existing bundle is available.

Note: If a database exists, then it will be cleaned and all data will be lost.

Update Bundle. Opens a dialog box, to browse your file system and select a bundle to deploy as an update.

It is expected to be a derivative of the current bundle. For example, a new column/attribute.

Note: The database is not cleaned.

Update Data Model. Opens a dialog box, to browse your file system and select a data model to deploy as an update.

Reset Environment

Resets the environment to its original state, when it was first deployed.

Model Tables. Truncates all model-related tables, and leaves system tables intact.

Model AND System Tables. Truncates all application tables, allowing you to start fresh in a Development or Test environment, as if you had just deployed your bundle for the first time.

Note:

  • This action opens a dialog box to confirm this operation.
  • This is a destructive operation and should be used with caution.

Deployment History

Enables you to see your prior Deployment History at a glance, with the following available for each Deployment.

Current Deployment. Enables you to download the currently Deployed Data Model and as a Deployment Bundle, for ease of propagation to other environments.

Deployment Bundle. Enables you to download the Bundle that was used to affect a specific Update Bundle or Update Data Model operation.

Measures. Enables you to download a file that contains the raw output of the status for each deployment step.

Viewing Information for the Installed Bundle

The Installed Bundle Information area in the Deployment pane provides a summary of the current bundle, as shown in the following image.

Viewing Subjects

Topics:

The Subjects area in the Deployment pane lists all of the Subjects that are defined within this deployment, as shown in the following image.

Specific operations can be performed on a selected subject, as shown in the following image.

These operations range from simply reviewing the structure of the subject through its schema or a physical example (Omni Input Document), to the ability to run a single instance or multiple instances through the system for testing purposes utilizing auto generated sample data. This can be used for simple tests of the environment or performance testing.

To view this context menu, click the menu icon that corresponds to a subject in the first column of the Subjects table.

The following table lists and describes the available operations that can be performed for a selected subject.

Operation

Description

View Example

Views an example for the selected subject. For more information, see Example Viewer.

View IDS

Views the Interface Document Specification (IDS) for the selected subject. For more information, see IDS Viewer.

View XSD

Views the XML Schema Document (XSD) for the selected subject. For more information, see XSD Viewer.

Download Documentation

Downloads the documentation for the selected subject. For more information, see Downloading Documentation.

Reprocess Subject

Reprocesses the selected subject. When complete, a message displays in a green banner at the top of the window indicating that the reprocessing of the item was successful.

Process Test Subjects

Displays the processing menu for the selected subject. For more information, see Process Test Subjects.

Example Viewer

Selecting the View Example operation for a subject opens the Example Viewer, which displays an example of the selected subject, as shown in the following image.

IDS Viewer

Selecting the View IDS operation for a subject opens the IDS Viewer, which displays the corresponding Interface Document Specification (IDS), as shown in the following image.

XSD Viewer

Selecting the View XSD operation for a subject opens the XSD Viewer, which displays the corresponding XML Schema Document (XSD), as shown in the following image.

Downloading Documentation

Selecting the Download Documentation operation for a subject prompts you to open or save the document, as shown in the following image.

Process Test Subjects

Selecting the Process Test Subjects operation for a subject opens the Process dialog box for the selected subject (for example, Customer), as shown in the following image.

Specify the number of test subjects to generate, and then click the green Play icon.

Managing Workflow Items During Subject Processing

When processing a subject in the Deployment section, you can manage specific steps in the subject workflow (for example, enabling or disabling an operation). Click the check box in the Workflow column to display the work order items for a particular subject, as shown in the following image.