Skip to main content

Exporting a Production

Exporting a Production

To export the XML for a production using the Management Portal, open the production, click Production Settings and the Actions tab and then click the Export button. Ensemble selects all business services, business processes, business operations, and some related classes, and then displays the following form to allow you to add export notes and additional components.

generated description: production export

You can also export a business service, process, or operation by selecting the component in the production configuration and then clicking the Export button on the Actions tab. In both cases, you can add additional components to the package by clicking on one of the buttons and selecting a component. You can remove components from the package by clearing the check box.

You can use the export notes to describe what is in the deployment package. For example, you can describe whether a complete production is in the package or set of components that are an update to a production. The export notes are displayed when you are deploying the package to a target system using the Management Portal.

When you are exporting a deployment package, the first decision you should make is whether the target system has an older version of the production.

If you are deploying the production as a new installation, you should:

  • Include the definition of the production class.

  • Include the production settings.

  • Include the definitions of all components used in the production.

  • Exclude the production settings (ptd file) for each component. This would duplicate the definition in the production class.

If you are deploying the production to update a live version of the production, you should:

  • Exclude the definition of the production class.

  • Exclude the production settings unless there are changes and you want to override any local settings.

  • Include the definition of all components that have been updated.

  • Include the production settings (ptd) file for any component whose setting have been changed or that should be disabled before the XML is imported and compiled.

Although many components are included by default in the package, you have to add others manually by selecting one of the buttons in the Add to package section. For example, if any of the following are used in your production, you need to add them manually:

  • Record maps—the defined and generated classes are included.

  • Complex record maps—the defined and generated classes are included.

  • Lookup tables

  • User classes referenced in code

  • System default settings or schedule specifications that are set as deployable

If you have a set of classes defined in a studio project file, you can include those classes in the deployment by clicking the Studio Project Files button and selecting the file.

The Production Settings button allows you to add the production ptd file. This XML defines the following:

  • Production comments

  • General pool size

  • Whether testing is enabled and whether trace events should be logged.

You can deselect any component in the list by clearing its check box. You can select a component by checking its box. The Select All button checks all the boxes and the Unselect All button clears all check boxes.

Once you have selected the components for the deployment package, create it by clicking Export.

The deployment package contains the following information about how it was created:

  • Name of the system running Ensemble

  • Namespace containing the production

  • Name of the source production

  • User who exported the production

  • UTC timestamp when the production was exported

You should keep a copy of the deployment file on your development system. You can use it to create a new deployment package with the latest changes to the components. Keeping a copy of the deployment file saves you from having to manually select the components to be included in the deployment file.

To create a new deployment package using an existing deployment package to select the components, do the following:

  1. On the development system with the updated production, click Production Settings and the Actions tab and then the Re-Export button.

  2. Select the file containing the older deployment package.

  3. Ensemble selects the same components from the current production that were included in the older deployment package.

  4. If there were any components missing from the older deployment package or if you have added new components to the production, add the missing components manually.

  5. Click the Export button to save a new deployment package with the updated components.


If a production uses XSD schemas for XML documents or uses an old format schema for X12 documents, the schemas are not included in the XML deployment file and have to be deployed through another mechanism. Ensemble can store X12 schemas in the current format, in an old format, or in both formats. When you create a deployment file, it can contain X12 schemas in the current format, but it does not contain any X12 schemas in the old format or any XSD schemas for XML documents. If your production uses an old format X12 schema or uses any XSD XML schema, you must deploy the schemas independently of deploying the production. For the schemas that are not included in the deployment file, they can be deployed to a target system by either of the following means:

  • If the XML or X12 schema was originally imported from an XSD or SEF file and that file is still available, import the schema on the target system by importing that file. XSD files can be used to import XML schemas and SEF files can be used to import X12 schemas.

  • Export the underlying Caché global that contains the schema and then import this on the target system. To export a global, select System Explorer > Globals, select the desired globals and then select Export. The X12 schemas are stored in the EnsEDI.Description, EnsEDI.Schema, EnsEDI.X12.Description, and EnsEDI.X12.Schema globals. The XML schemas are stored in the EnsEDI.XML.Schema global. See “Exporting Globals” in the Using Caché Globals guide for details on exporting globals.

FeedbackOpens in a new tab