Promote assets from API Gateway user interface

About this task

Define a stage to represent the asset's lifecycle such as development, test, and production. For details about how to add a stage, see Adding a stage.

Promoting assets from one stage (source) to another stage (target) includes the following high-level steps:

Procedure

Authorization server promotion - Promote Authorization server in one of the following ways.
- Export the authorization server from one environment and import it into another, if you want to use the same authorization server across multiple environments.
- Create the authorization server with the same name as in the current environment, if you want to use a different authorization server instance.
  
  Proceed to the next step after the authorization server is ready.
Select assets for promotion: During this step, you search for assets by using a keyword and by performing a type search that sorts and filters the results.
- Search by using a keyword. You can search for all assets whose string attributes (asset name, description) contain a certain keyword (character string).
- Search by using a Type. You can search for assets based on type. Use the Search by type filter to restrict the types on which the search is conducted. In the Search by type window, webMethods API Gateway shows you a list of supported asset types.
- Search by team. You can search for assets that are assigned to the teams. Click the teams to view the assets that are assigned to the selected teams.
- Search by using two keywords. You can provide more than one keyword by separating the keywords that use a pipe symbol (|). For example, to search for assets whose names contain pet and test, you can provide pet|test in the search field.
- Search by using wildcard characters. You can use wildcard characters in your search keyword. For example, to list all assets that start with graph, you can provide a graph.
You can also select assets' dependencies for promotion. You can specify whether to include dependencies, such as registered applications for an API or package subscriptions, during selected asset promotion.
Note: Groups and users are part of the team. If you want to promote the Groups and Users (optional dependencies) of the team that owns the selected asset, set the enableTeamWork extended setting to true. Only then the Groups and Users sections appear.
Select the stages to promote. During this step, you specify one or more target stages to which you want to promote the selected assets and their dependencies.
Configure the promotion details. During this step, you provide the promotion-specific information.
Ensure that you are promoting the assets from a smaller version of webMethods API Gateway to a higher version of webMethods API Gateway. You cannot promote assets from a higher version to a smaller version of API Gateway. For example, if you are using webMethods API Gateway v10.11, you can promote the assets from this version to v10,15 and other higher versions. You cannot promote assets back to the v10.7, v10.5.
Note: If you plan to perform bulk assets promotion from a source stage to a target stage, increase the value of maxRegexLengthInSearchQuery. Setting on the Extended Settings page under Administration > General in both the source and target stages. This process is done considering that the generated RegEx search query length might become longer during bulk promotion of assets. The default value of this property is 37000. When you increase the value, it can lead to higher memory and CPU utilization, particularly when you are working with complex regular expressions. Therefore, it is recommended to closely monitor any spike in memory and CPU usage during asset promotion. For example, if your RegEx search query's length is more than 37000, asset promotion fails to indicate that the length of RegEx used in RegEx Query request exceeded the allowed maximum. In such case, you must increase the value of maxRegexLengthInSearchQuery setting to more than the value specified in the error message.