Promoting assets from API Gateway user interface

Edit online

About this task

You must have the Manage promotions functional privilege to perform this task.

Procedure

  1. Open the menu options and select Manage > Promotion management.
  2. Select Promotions.
  3. Click Promote.
  4. In the Search by keyword text box, type the keyword to search for assets. You can use one or more wildcards to specify the keywords. webMethods API Gateway returns the assets that match the specified keyword.
    Note: You can perform multiple searches for the same type without losing previous results.
  5. In the Search by type list, select the required types.
    Select the All checkbox to search across all asset types. API Gateway returns the assets that match the selected types. The number of search results is displayed in the results area, for example, Showing 10 results. If no results are found, the results area displays a blank page.
  6. Optional. Select Include admin configurations checkbox if you want to include administrative configurations in the promotion.
    webMethods API Gateway displays the administrative configurations that are supported for promotion. For the list of assets and configuration settings that can be promoted, see Promoting assets.
    Note: Before you configure webMethods API Gateway to promote an administrative configuration, make sure that the corresponding administrative settings are already configured in webMethods API Gateway. For example, to include the Load balancer configuration in the asset promotion set, the required Load balancer URLs must be configured.
  7. Select the assets and the administrative configurations that you want to promote.
  8. Click Next. The Assets and dependencies page appears.
  9. Select the referenced assets that you want to promote.
  10. Click Next. The Stages page appears.
  11. Select the target stages to that you want to promote the assets, dependencies, and administrative configurations.
  12. Click Next. The Promote page appears.
  13. Provide the following information:
    Field Description
    Name Mandatory. Name of the promotion.
    Description Description of the promotion.
    Overwrite 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 KeysAPI Keys without overwriting the Applications. Similarly, you can overwrite Strategies without overwriting the Strategy Credentials, but not vice versa.
    Fix missing version Select the checkbox to fix the API version history. The discrepancy between the asset versions in the source and target stages, if any, is fixed.

    For example, consider that you created an API and have five versions of the API from 1 to 5, in the source.

    If you select versions 1, 2, 4, and 5 for promotion to the target, the linking depends on the checkbox selection. If the checkbox is not selected, versions 1 and 2 are linked together, and versions 4 and 5 are linked separately.

    . However, if you select this checkbox, version 2 is linked to version 4 and hence all versions 1, 2, 4, and 5 are now linked in the target.
    Include application registrations Select the checkbox to include the application registrations when you promote an API.
    Note: The Overwrite assets if exists on selected stages option allows the user to overwrite assets that exist on the target stages. If you do not want to overwrite assets in the target stages, clear this checkbox.
  14. Click Promote.
    The selected assets, dependencies, and administrative configurations are promoted to the selected stages. The Stage-specific promotion status page displays the status of the asset promotion in each of the selected stages. The available values are Success and Failure. The page also displays the reason if the promotion fails.