Web applications should be added and published in App Manager for users to start using them. Details of the process of adding a web application to App Manager is described below.
Step 1 : Adding web application to the publisher
Follow the steps below to add the web application to App Manager.
Adding a web application to App Manager doesn’t mean that it is hosted in App Manager. It can be hosted in any server, and the URL will be exposed through App Manager.
- Log in to the publisher.
- Click Add Web App.
- Enter details of the web app as follows and click Add.
The fields on which you need to enter the values accordingly when adding a web application are described below.
Name of the field | Description |
Name | Name of the application. This is the field, which will be used as the SAML2 issuer at the time of logging in. |
Context | Sub context of the web application. Gateway URL of the web application contains the context that should be provided in this field. |
Version | Version of the web application. Users can have multiple versions of the same web application. Version will appear in the gateway URL. |
| Transport | The transport protocol used (For example: http/ https). |
| Web App URL | URL of the web application. This URL will be considered as the landing page for the web application. |
| URL Pattern | URL patterns, throttling tiers and whether to skip throttling for the URL pattern or not. For example, if Javascript requests should not be throttled, user can simply add a URL pattern with 'Skip Throttling' being set to true. |
Step 2 : Promoting web application to published state
After adding the web application to the publisher, you need to promote its lifecycle state to published state, to publish it as follows.
Once a web application is added to App Manager, it is added to the registry as an asset, and a lifecycle is attached to the web application. The lifecycle state for a newly created web application is 'Created'. Users can change the state to 'In-Review', which will automatically initialize a work flow event. Work flows will be explained in another section. Once an admin user approves the work flow event, then lifecycle state moves to the 'Published' state and will appear in the store for users to consume. This behavior can be extended according to the user requirement with the provided extension points.
Once a web application reaches the 'Published' state, an API resource will be created under <PRODUCT_HOME>/repository/deployment/server/synapse-configs/default/api/ directory. Name of the file will be {web app created user}–{web app name}_v{version}.xml. This is the REST endpoint, which will be invoked once the gateway URL is accessed.
After promoting the lifecycle state of the added web application, you need to configure security for it. For information on configuring security for web applications, see Securing with SAML2 SSO.