Importing asset and configuration archives

About this task

Importing an exported archive enables import of selected assets to a different instance of API Gateway or redeploy them on the same instance.

Procedure

  1. Open the menu options and select Manage > Import.
  2. Provide the following information:
    1. Select the archive file.
    2. Click Browser to select a file or compressed format file.
    3. Overwrite. Use this field to select an overwrite option:
      • None. If you do not want to overwrite matching objects that exist on the server. Import fails for the object in the archive if a matching object or asset exists on the server.
      • All. If you want to overwrite any matching asset that exists on the server. If a match is not found, then a new asset is created.
      • Custom. If you want to select the specific types of assets that are overwritten on the server if a match is found. If a matching asset exists on the server for an asset type that is not selected in the Custom overwrite list, the import operation fails.

        If a duplicate asset is found for any asset type that is not selected in the Custom over write list, the import fails.

        Some types of assets have dependencies on other asset types. For example, APIs have a dependency on policies, aliases, and applications. Some of the dependencies are needed, while others are optional. The required dependencies are always included in the archive when you export the asset. Consider your requirements and select the assets that need to be overwritten in the Custom list. Some asset types can have multiple overwrite options that are organized in the form of a tree. When you select such an asset, all its components are displayed and selected by default. You can select a parent component without selecting any of its child components. However, you cannot select a child component without selecting its parent component. For example, when you select Applications, it expands and displays its components, Strategies, and API Keys. Strategies, in turn, has a component Credentials. You can overwrite Applications without overwriting the API Keys. However, you cannot overwrite the API Keys without overwriting the Applications. Similarly, you can overwrite Strategies without overwriting the Strategy Credentials, but not vice versa.

      • API version history. Select this option Fix missing versions to fix the API version history. On selecting this option, the API versions are newly linked according to the system version of the APIs.
    Note: webMethods API Gateway supports compatibility with the earlier versions for webMethods API Gateway 10.1 version or higher when you import the archives of APIs. In addition, the compatibility of archives across API Gateway fix levels is also maintained. For example, you can import the archives that are created from smaller fix levels of webMethods API Gateway into higher fix levels. If the smaller fix level does not support the higher fix level's configurations, webMethods API Gateway can reject the archive import that is created from a higher fix level into a smaller fix level.
  3. Click Import. The Import report displays the following information:
    • Type. This field displaces the asset type.
    • Successful. This field displays the number of successful imports for each artifact type.
    • Unsuccessful. This field displays the number of unsuccessful imports for each artifact type.
    • Replaced. This field displays the number of instances that are replaced for each artifact type.
    • Warning. This field displays the number of warnings that are displayed during the import of each artifact type. webMethods API Gateway displays warning messages when the import is successful but some additional information is needed.
  4. Click Download the detail report here to download the detail report. The detail report displays the following information about the imported artifact:
    • Name. This field displays the name of the artifact imported.
    • Type. This field displays the artifact type.
    • Status. This field displays the status of the imported artifact. The available values are Success, Replaced, Warning.
    • Explanation. This field displays the number of instances that are replaced for each artifact type.

What to do next

If you want to take a backup of an API that you want to overwrite during import, you can set the parameter enableImportBackup as true under the Administration> General> Extended Settings section.

If an API import fails, one of the reasons might be that a configuration that the API requires is not set up correctly on webMethods API Gateway. If something happens unexpectedly while the import is in progress, webMethods API Gateway discontinues the import and restores the existing API. This function is necessary as parts of the existing API such as policies might be overwritten.