Import / restore selected objects

If you have created backup files of selected Activator objects, users with appropriate rights can import these objects into a Activator environment of the same version as the export environment.

To view the backup (export) procedure, see Back up selected objects.

The following objects can be imported either individually or a as a collection of similar objects:

Required permissions

The user must have a role that includes the permission to manage the object type that he or she wants to import.

General procedure

The behavior of Activator when importing selected objects, varies depending on the object that is being handled. The following is a generic procedure that describes basic steps for importing all selected objects backups. For details of importing specific object types, see Special conditions and exceptions.

To import objects:

  1. Go to the management page for the object type you want to import.
  2. From the Related tasks list at the bottom of the page, select Add a [object_type] to open the add wizard.
  3. In the "Choose the source" page of the wizard, select the option Import one or more [object type], and click Next.
  4. In the Enter import file path page:
  5. Click Next.
  6. Review the import summary and click Close.

Example procedure: Import selected services

The following example illustrates how to import a previously-exported collection of two service objects:

  1. Go to Processing configuration > Manage Services to open the "Mange Services" page.
  2. From the "Related tasks" list at the bottom of the page, select Add a service to open the "Add a service" wizard.
  3. In the "Choose the source" page of the wizard, select the option Import one or more services, and click Next.
  4. In the "Enter import file path" page:
  5. Click Next.
  6. Review the import summary and click Close.
  7. Activator executes the import and updates the list of services with the newly imported services.
  8. Activator writes the results to the log4j file, located in [trading_engine_install_directory]\logs.

Special conditions and exceptions

Each Activator object has its own data structure and parent/child dependencies. This section provides special considerations for each object type.

Components

About Components

The role of a Activator Component object is to provide specific processing for a Activator Service. There are many types of Components in Activator. For a detailed description, see Components .

A Component has two types of dependent child objects:

Special considerations

Child dependencies:

When you execute a selective import of a Component, the child dependency of the Connection and of the Resource must be re-established in the new environment, otherwise the import will result in an “incomplete” component definition. This means if the Connection and the Resource do not already exist in the target import system, the Component will be displayed in the UI as incomplete, and will not be valid for use in a Service.

You must check that all child connections and resources that existed in the originating configuration (from which you exported) also exist in the target system (to which you import).

Impact of Component import on Services:

Components are used in Services and Services can be used in multiple Agreements. When you replace or update an existing Component by importing and overwriting an existing Component definition, there can be an impact on the flow logic. For example, if the original component produced 1 output and the new component produces 2 outputs, the Service is modified, resulting in a non-reversible impact on the definition of the Service that uses the component, and on any objects that use the Service.

During the import process, you select a import mode that controls the impact of these potential object changes:

Attempts to import Components with errors:

If any Component in the export/import file is modified so that it contains invalid data, the import fails and the failure is displayed in the import result summary page of the import wizard.

Services

About Services

The role of a Activator Service object is to specify the processing sequence for a message exchanged between two or more exchange participants. For a detailed description, see Services.

A Service has the following dependent child objects and parameters:

Special considerations

Service dependencies:

When you execute a selective import of a Service, the Service Attributes and Component parameters (defined in the Service object) are maintained. However the child dependency of the Application Delivery and the Component (with Resource and Connection) must be re-established in the new environment, otherwise the import will result in an “incomplete”Service definition. This means if the Application Delivery and Component (with Connection and the Resource) do not already exist in the target import system, the Service will be displayed in the UI as incomplete, and will not be valid for use in message handling.

You must check that all child Application Deliveries and Components that existed in the originating configuration (from which you exported) also exist in the target system (to which you import).

Impact of importing modified Services:

Services can be used in multiple Agreements and in Metadata Profiles. When you replace or update an existing Service by importing, there can be an impact on the flow logic.

Example 1:

The Service output in the target environment (before import) has a different delivery option than the updated Service (e.g. deliver to partner vs. deliver to application). This modification will have a non-reversible impact on the objects using this Service (Agreement / Metadata Profile).

Example 2:

The Service output in the target environment (before import) uses a Component that produces 1 output and the updated Service uses a Component with the same name producing 2 outputs. This will have a non-reversible impact on flow logic.

Example 3:

The Service in the imported file introduces a required attribute value to an exiting Attribures Template. This will generate an updated Attribute Template in the target environment. Any existing Services that use that Template will be incomplete because they lack the required value.

During the import process, you select a import mode that controls the impact of these potential object changes:

Attempts to import Services with errors:

The following are conditions in which Service import may fail:

Warnings on Service import:

If any Service in the export/import file contains an attribute that does not exist on the target system, the attribute is created and a warning is displayed on the summary page of the import wizard.

Inbound Agreements

About Inbound Agreements

The role of a B2Bi inbound Agreement object is to specify how B2Bi processes the information that it consumes from a remote trading partner. For a detailed description, see Agreements.

An inbound Agreement has the following dependent objects and parameters:

Special considerations

Agreement import order:

Inbound Agreements, outbound Agreements and Document Agreements work together in B2Bi message flows to provide such services as acknowledgements and receipts. To correctly maintain relationships, export/import these objects in the following order:

  1. Outbound Agreements
  2. Inbound Agreements
  3. Document Agreements

Inbound Agreement dependencies:

When you execute a selective import of an inbound Agreement, the Agreement Attribute and Functional Group Agreement relationships are maintained. However the links to Outbound Agreements (for acknowledgements), Services (for acknowledgements) and Document Agreements must be re-established in the new environment, otherwise the import will result in an “incomplete” Agreement definition. This means that if the linked outbound Agreement, Service or Document Agreement do not already exist in the target import system, the Agreement will be displayed in the UI as incomplete, and will not be valid for use in message processing.

You must check that all linked outbound Agreements, Services and Document Agreements that existed in the originating configuration (from which you exported) also exist in the target system (to which you import).

Impact of ignore/replace selection:

During the import process, you select a import mode that controls the impact of these potential object changes:

Attempts to import inbound Agreements with errors:

The following are conditions in which inbound Agreement import may fail:

Warnings on Agreement import:

If any Agreement in the export/import file contains an attribute that does not exist on the target system, the attribute is created and a warning is displayed on the summary page of the import wizard.

Document Agreements

About Document Agreements

The role of a B2Bi Document Agreement object is to specify how a document type (within a messaging standard and standard version) is to be handled in an inbound agreement between exchange partners. For a detailed description, see Document agreements.

A Document Agreement has the following dependent objects and parameters:

Special considerations

Agreement import order:

Document Agreements work together with inbound Agreements and outbound Agreements to provide such services as acknowledgements and receipts. To correctly maintain relationships, export/import these objects in the following order:

  1. Outbound Agreements
  2. Inbound Agreements
  3. Document Agreements

Document Agreement dependencies:

When you execute a selective import of a Document Agreement, the Document Agreement Attribute relationships are maintained. However the links to inbound Agreements, outbound Agreements (for acknowledgements), and Services must be re-established in the new environment. If the linked inbound Agreement, outbound Agreement or Service do not already exist in the target import system, the Document Agreement will be displayed in the UI as "incomplete", and will not be valid for use in message processing.

You must check that all linked inbound Agreements, outbound Agreements and Services that existed in the originating configuration (from which you exported) also exist in the target system (to which you import).

Impact of ignore/replace selection:

During the import process, you select a import mode that controls the impact of these potential object changes:

Attempts to import Document Agreements with errors:

The following are conditions in which inbound Agreement import may fail:

Warnings on Document Agreement import:

If any Document Agreement in the export/import file contains an attribute that does not exist on the target system, the attribute is created and a warning is displayed on the summary page of the import wizard.

Outbound Agreements

About outbound Agreements

The role of a B2Bi outbound Agreement object is to specify how B2Bi processes the information in order to send it to a remote trading partner. For a detailed description, see Agreements.

An outbound Agreement has the following dependent objects and parameters:

Special considerations

Agreement import order:

Outbound Agreements, inbound Agreements and Document Agreements may work together in B2Bi message flows to provide such services as acknowledgements and receipts. To correctly maintain relationships, export/import these objects in the following order:

  1. Outbound Agreements
  2. Inbound Agreements
  3. Document Agreements

Outbound Agreement dependencies:

When you execute a selective import of an outbound Agreement, the Agreement Attribute and Functional Group Agreement relationships are maintained and included in the import.

Impact of ignore/replace selection:

During the import process, you select a import mode that controls the impact of these potential object changes:

Attempts to import outbound Agreements with errors:

The following are conditions in which outbound Agreement import may fail:

Warnings on Agreement import:

If any outbound Agreement in the export/import file contains an attribute that does not exist on the target system, the attribute is created and a warning is displayed on the summary page of the import wizard.