Introduction to Moving Assets
Move assets from one instance to another in two ways:
- By using a zip file containing the assets you want to move. You can move assets from two types of instances:
- webMethods.io B2B assets you created in one webMethods.io B2B instance to another. See Importing Assets from Another webMethods.io B2B Instance
- On-premise Trading Networks instance to your webMethods.io B2B instance. Importing Assets from an On-Premise Trading Networks Instance
- By applying assets from an available deployment in your environment. See Importing from an Available Deployment
After you select the source as zip file:
- Step 1 of 3: Select the assets you want to import under each asset type. In this step, the assets you are trying to move from an on-premise Trading Networks instance, which are not supported in the webMethods.io B2B instance yet, are listed under Skipped assets.
- Step 2 of 3: Review the issues by examining the asset list. webMethods.io B2B analyses the selected assets, if dependent assets are missing in your selection, then the missing assets are listed under Missing dependencies. If the target instance already has the assets you are trying to import, these duplicate assets are listed as Conflicts. You can optionally resolve these issues before you import the assets.
You can optionally download the analysis report to analyze and resolve the issues.
- Step 3 of 3: Confirm the import activity. You can optionally download the Asset import summary to examine all the assets that were moved.
Points to remember:
- webMethods.io B2B moves assets in both active and inactive statuses. The status of the assets on the source instance is maintained on the target instance after the movement.
- You cannot import or export secondary certificates.
- You cannot import system-generated assets of document types, processing rules, and attributes. For a complete list see, System-Generated Assets.
For details on exporting assets, see Exporting Assets. In the target environment, exported assets reside in the Available deployment list after you publish them to an instance.
Registering an Environment
Depending on your business use case, you can register to any number of existing Software AG Cloud environments for the purpose of asset movement.
To register an environment:
In webMethods.io B2B, go to Settings > Environments.
Click Register environment. On the Register environment dialog box, specify the following information:
Fields Description Name Specify a name for the environment. Description Provide a description stating the scope of environment that you are about to create.
Export assets from one webMethods.io B2B product environment, or from a on-premise Trading Networks instance, and import them in another webMethods.io B2B product environment. For example, from a test environment to a production environment.
And search for an asset across asset types such as partner profiles, business documents, processing rules, document attributes, trading partner agreements, and field groups.
Note: The size of each webMethods.io B2B export file cannot exceed 4 MB. If the export file exceeds the 4 MB limit, then create another export file to export the remaining assets.
To export webMethods.io B2B assets
In webMethods.io B2B, go to Asset movement > Export.
On the Export assets page, select the assets to export from all the asset type tabs.
Each asset specifies the number of dependent assets it has.
After you select the assets, click Add to export list.
The Include dependencies option is selected by default. Clear this option if you do not want the dependent assets to be included in the export file. To view all the dependent assets, click on the count in the Dependencies column.
Note: The Include dependencies option is disabled for Field groups. You can view the selected assets in the export cart .
Click Next. On the Export assets page, verify the final export set.
On the Export Assets page, select the export action:
Action Description Export as a zip file Specify a name for the export file. webMethods.io B2B either downloads the exported assets in the form of a
ZIPfile or displays the file browser. The location of the downloaded file depends on your browser configuration.
Create deployment Specify a name and optionally provide a description. The deployment you create appears on the Deployments page. See Viewing the Details of a Deployment for details. Publish deployment to an environment Select the environment to which you want to quickly publish the deployment. If you notice environments other than the ones you created, it could be because there are more than one administrators creating and managing environments for your product instance. If you wish to publish the assets later, do not select this option. Important: You are required to provide your credentials before publishing the deployments. Note: If there are multiple environments mapping to the same Software AG cloud environment, webMethods.io B2B publishes the deployments to the last created target environment.
webMethods.io B2B either downloads the exported assets in the form of a
ZIPfile, or displays the file browser, or allows you to create a deployment. The location of the downloaded file depends on your browser’s configuration. However, if there are errors during the asset deployment, you can track them in the Deployment logs page.
You must perform the following actions after you export the assets:
The document changes you make on a webMethods.io B2B product instance also reside on the webMethods.io Integration product instance. Therefore, after you export a certain set of documents from a webMethods.io B2B product instance, if you edit the same set of documents on webMethods.io Integration product instance by using the EDI application, any subsequent movement of those set of documents to another fresh instance of webMethods.io B2B and webMethods.io Integration results in an error, due to the discrepancies in the two sets of documents. To avoid such a situation, ensure that while exporting documents from webMethods.io B2B and webMethods.io Integration, you retain the same copies of the documents until you import them in a new instance set.
For XML documents, make sure that they are exported as part of the corresponding project from webMethods.io Integration instance.
For the orchestrations on webMethods.io Integration product instance to work seamlessly in a new instance after the asset movement, make sure the documents that are referred in the orchestrations on webMethods.io Integration are also exported.
You can move assets from one instance to another in one of the following ways:
- On-premise Trading Networks instance to your webMethods.io B2B instance. See here
- webMethods.io B2B assets you created in one webMethods.io B2B instance to another. See here
Before you Begin
Note the following points before you import assets into your product instance:
- You must use a .zip file to import assets both from a cloud instance, and from an on-premise Trading Networks instance.
- From on-premise, only assets exported from Trading Networks 10.5 having Trading Networks Server 10.5 Fix 6 or higher versions and Trading Networks 10.7 having Trading Networks Server 10.7 Fix1 or higher versions can be imported. Software AG recommends that you export assets in ‘binary’ format so the asset file size smaller compared to the XML format.
- If the asset file contains only skipped assets, then you will not be able to import the asset file.
- The size of each asset file exported from cloud instance must not exceed 4 MB and from on-premise must not exceed 1.5 MB.
- If the
ZIPfile contains business documents from the 1.1 version of webMethods.io B2B, those documents do not get imported.
Points to Note:
If your asset file is larger than the allowed limit, export them again in smaller file sizes in a dependency order, and try to import them again.
If you do not follow the dependency order, it will result in Missing dependencies. For example, you cannot import processing rule without importing partner profile.
The dependency order is as follows:
- Partner profile
- Field groups
- Document attributes
- Business documents
- Processing rules
If the export file is within the maximum size limit, and has too many assets, import them in the dependency order.
Note: You can search for an asset across all asset types.
- In webMethods.io B2B, go to Asset movement > Import.
- In the Step 1 of 3, select Import from a .zip file.
Select the assets to import from all the asset type tabs.
The assets types that are not supported in webMethods.io B2B are skipped when you import them from an on-premise Trading Networks instance.
Referred by shows the list of assets where the current asset is being used.
Refers to shows the list of dependent assets.
Refer to the following table for the asset categories:
Asset Category Description Skipped If you export assets from an on-premise Trading Networks instance, the assets that are not supported in webMethods.io B2B as yet, are listed as Skipped assets. For example, data-level permissions cannot be moved to the cloud instance because it is not supported. Added If you import assets that are not present in the target instance, it gets added to the instance with the status as Added. Updated If you import assets which are existing in the target instance and when you perform a force import, then the status will be Updated. Ignored System assets or any of the asset properties of on-premise Trading Networks instance that are not supported in webMethods.io B2B as yet, are categorized as Ignored. Missing dependencies Some assets require other assets. For example, the processing rule depends on partner profiles and document types, and document type depends on document attributes. For moved assets to work properly, the dependent assets must also move to the target instance, if they are not already present.
When you select an asset to import it, the system scans the target instance for the presence of the dependent assets. If the dependent assets are not present in both the target instance or in the assets you selected, then those are listed as Missing dependencies.
For example, if a processing rule refer to a partner profile that does not exist in both the target instance or the import file, it is a Missing dependency.
Click Include dependencies to include all the dependent assets. This option is enabled only when the dependent asset is present in the import file, but you did not select it during the Step1 of 3.
Conflicts When an asset already exists in the target instance, and is imported again with force as false, it causes conflicts without overwriting the asset. Conflicts can occur with warnings if assets are present on the target instance with different ID.
For example, if a partner profile already exists in the target system and is also available in the import file, it is a conflict.
To avoid such conflicts, ensure you import the assets, using the Force import option.
Click Clear conflicts to remove the conflicted assets from import.
Critical Assets not imported for any other miscellaneous reasons are termed as Critical. For example, importing a different enterprise when the enterprise is already present in the target instance.
To download the analysis report, click Download analysis report.
The analysis report contains information on the statuses with their respective severity. The three categories of severities are Error, Warning, and Info.
Resolve the errors in the analysis report to import assets successfully.
Select the following options before importing the assets:
Option Description Force import To overwrite assets that might already exist in the target instance. For details, see here Attach import summary with activity log To view the import activity in the activity logs.
On the Import assets page, review the asset list that you have imported.
Click Download import summary to view the list of success, warning, and error messages. Use the relevant message detail to rectify each error or warning depending on the severity in the downloaded file.
If you have more assets to import, click Start new import.
- In webMethods.io B2B, go to Asset movement > Import.
- On the Import assets page, there are two ways in which you can import assets:
- Import from a .zip file. You can import assets from a .zip file.
- Import from available deployments. You can import assets from available deployment if some other environment has Published deployments to the current environment.
- Follow steps 3-7 in Importing Assets from an On-Premise Trading Networks Instance
Important: Assets that are native to the environment such as channels, partner users, purge or archive schedules, and runtime transaction data (tasks, and the entries recorded in the Course of transaction).
The following table lists the actions you must take after you complete the import activity:
|Asset Type||Action to take|
|Archival and purge schedules||Update the default archival schedule and create the relevant purge schedules. See How Can I Update the Archival Schedule?.|
|Functional permissions||Create the relevant users and permissions for each user. See Managing User Roles and Permissions.|
|Partner profiles||As the Delivery Settings are ignored while importing partner profiles from an on-premises Trading Networks instance, create outbound channels and associate them with the partner profiles. See Associating an Outbound Channel with a Partner.|
|Processing rule||Execute a Service action while importing processing rule from an on-premises Trading Networks instance is ignored. You must create an integration on webMethods.io Integration and associate it in the Call an integration action. See Adding a Processing Rule|
|Partner users for each partner profile||Recreate the partner users in the partner profiles. See Adding a Partner User and Associating a User with a Partner.|
To see the complete list of skipped assets, ignored asset properties, and system-generated assets, see Reference Information For Asset Movement
You must perform the following actions after you import the assets into your target instance:
- On importing an XML document, ensure that you manually associate it with the webMethods.io Integration project and the document type to populate the required schema.
- Ensure the integration endpoint you configured in all the processing rules are valid when the endpoint is accessed from the target instance.
- For the integrations on the webMethods.io Integration product instance to work seamlessly in a new instance after the asset movement, make sure the documents that are referred in the integrations on webMethods.io Integration are also imported.
Note: If any EDI document is dependent on other assets, and during import if the dependent assets not present in the target instance or import file, then the document import fails in webMethods.io B2B, but the document schema gets created on webMethods.io Integration.
Subsequently, if you try to import the same document again, the instance would have the document already.
How to Create Deployments
Deployment is a group of webMethods.io B2B assets that you can export and import from one environment to another. Unlike
ZIP files, deployments reside inside the database of the source or target environment.
To create a deployment
In webMethods.io B2B, go to Asset movement > Deployments.
Click New deployment to navigate to the Export assets page. For further steps, see Exporting Assets.
Applying a Deployment from Available Deployments Page
When assets from a different environment are pushed to your current environment, you can either apply or reject the assets that are pushed to your environment.
To apply a deployment and apply assets from Available Deployments page
In webMethods.io B2B, go to Asset movement > Deployments and click Available deployments.
Select the assets to apply from the Partner profiles, Business documents, Processing rules, Document attributes, and Field groups tabs.
Note: To reject a deployment, click Reject. Rejecting a deployment permanently removes the deployment from the target environment and from the Available deployments page.
Click Add to list. If you want to apply assets with dependencies, select the Include dependencies check box. You can view the selected assets in the cart .
Click Next. Verify the final list of assets to apply.
Tip: To remove assets that you no longer wish to apply, click .
Click Apply. On the Apply selected assets dialog box, select the Force apply option to overwrite assets that may already exist in your environment, and click Proceed.
If you wish to apply more deployments, click Apply another deployment.
A list of success, warning, and error messages appear on the Summary of applied assets page. Use the relevant message detail to rectify each error or warning depending on the severity.
Note: If the apply action fails, then webMethods.io B2B does not delete the deployment. It is available in the Available deployments page. However, after the apply action is completed successfully, webMethods.io B2B deletes the deployment from the Available deployments page.
Viewing the Details of a Deployment
View the details of all the deployments you create on the Deployments and Export page.
To view the details of a deployment
In webMethods.io B2B, go to Asset movement > Deployments.
Select the deployment to view details such as number and type of assets in the deployment. You can edit the name and description of the environment. On this page, you can also perform the following activities:
Action Description Remove deleted assets Removes references to assets that were deleted from webMethods.io B2B. Using this action, webMethods.io B2B allows you to clean up the deployment before publishing. Important: This option appears only if the selected deployment contains assets that no longer exist. Additionally, until you remove the deleted assets from the deployment, webMethods.io B2B does not allow you to publish the deployment. Publish deployment Publishes assets to an environment you select. Important: You are required to provide your credentials before publishing the deployment. Delete deployment Deletes the deployment. Only the deployment is deleted. The assets applied to other environments remain intact.
How Do I Monitor the Deployment Logs?
The deployments you create in one environment can either be accepted or rejected in another environment. Monitor the status of these deployments across all the users and roles that create them, on the Logs > Deployment logs page.
You can search for specific deployment logs by deployment set name, associated environment name, user, action, or status.
Tip: To view all the error logs, type error in the search bar. Similarly, type success in the search bar to view all the successful events.
The Deployment logs page displays the following details:
|Date received||Timestamp when the action was performed on the deployment.|
|Deployment name||Name of the deployments.|
|Event||Action performed on the deployments. Some of the possible events are:
|Performed by||Name of the user who performed the action.|
|Source environment||Name of the environment from where the deployment set was published.
Note: If you see (current) in the Source environment column, it indicates that the source environment is the environment to which you have currently logged-in to.
|Target environment||Name of the environment to which the deployment was published.
Note: If you see (current) in the Target environment column, it indicates that the target environment is the environment to which you have currently logged-in to.
Prerequisite: You must have at least two environments so you can switch between them.
Every instance displays the environment it represents at the top-right corner of the welcome screen.
As an Administrator, perform the following steps to switch between environments.
In webMethods.io B2B, click next to the current environment name.
Select the environment to which you wish to switch. You are in your chosen environment.
How Does webMethods.io B2B Overwrite Existing Assets?
When you import an asset, webMethods.io B2B checks whether another asset with the same name already exists in the target instance. Only for partner profiles, webMethods.io B2B checks for the same combination of partner profile name and organization unit name. For all the other assets, webMethods.io B2B checks only if the same name exists in the target instance.
If you select Force Import option while importing assets, webMethods.io B2B overwrites the assets that may exist in the target instance during the import operation.
When you import processing rules, webMethods.io B2B does the following: