Web application needs to be added to the app manager and should be published in order for users to consume the web application. Below sections describe the process in detail on how to add a web application to the app manager.
Step 1 : Add Web Application to the Publisher
This is the first step that needs to be done in the process of web application publishing. Adding a web application to the app manager doesn’t mean that the web application should be hosted in the app manager. Web application can be hosted anywhere and only the URL will be exposed through app manager. Prior adding a web application, user needs to login to the publisher. Below is a screen capture of the add web application page.
Descriptions of important fields 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 login. This will be explained in detail later in this document. |
Context | Sub context of the web application. Gateway URL for web application contains the context provided in this field |
Version | Version of the web application. Users can have multiple versions for the same web application. Version will appear in the gateway URL |
| Transport | 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 | Here users can add 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 Throtteling' is set to true. |
Step 2 : Promote lifecycle state
Promote Web Application to Published State
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 newly created web application is 'Created'. Users can change the state to 'In-Review' which will automatically initializes a work flow event. Work flows will be explained in another section. Once an 'admin' user approves the work flow event, then lifecycle goes 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 correctly goes to the Published state, user can find an API resource created under <APPM_HOME>/repository/deployment/server/synapse-configs/default/api folder. 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.
As the next step we need to configure security for web application as describes here.