Publishing an application makes it available to your end users. You can specify which modules, data views, and pages you would like to make available.
First, you publish the application in a Test environment for internal testing, then, in the Live environment to reach your target audience. You can also make it available to multiple clients, each in a separate client environment.
To learn how to manage end user access rights to your published application, please refer to this article.
Contents
- Publish an application for testing
- Publish an application to your target audience
- Unpublish an application from Test or Live
- Known limitations
Publish an application for testing
Before you make your application available to your target audience, you need to publish it to the Test environment.
Step 1: Publish modules to Test
- In your application, ensure that all modules you want to display in the application are published to Test. If any modules are unpublished, open the editor for those modules and publish them there. Data views and Pages are published automatically.
Step 2: Configure your application sidebar
You can customize which components appear in the sidebar and how they are labeled for end users.
- Select Publish in the side navigation.
- There, click Manage sidebar items to select the components you want to display in the sidebar. Confirm your selection by clicking Update.
- The selected components will now appear in a list where you can drag and drop to reorder them.
- For each component, the internal component name (used when building) is shown as static text on the left. Next to it is an input field where you can enter the external component name, the label displayed to end users in the sidebar of the published application.
- Click Save changes to confirm your sidebar configuration.
Step 3: Customize the application's external display name
- In the Sidebar section on the Publish page, you can also change the external application title by typing a new name in the input field next to the Sidebar heading.
- This name appears in the top-left corner of the sidebar in the published application.
Step 4: Publish to test
- Click Publish to Test to publish the application for testing purposes.
Step 5: Open and share your application
- Click Open to load the published application in a new browser tab. You can now share this link with colleagues or testers in your organization.
Optional: Customize portal display
To customize how your application appears in a portal, configure its portal card settings accordingly.
Publish an application to your target audience
Once your application has been tested and you're ready to release it, you can publish it to the Live environment.
Step 1: Publish to Live
- On the Publish page, click Publish to Live to make the application available to your end users.
Make sure that all modules includes in the application are also published to Live. Data views and pages are automatically published to Live.
Optional: Make the application available to multiple clients
- If you want to make this application available to multiple clients, follow the instructions provided here.
Unpublish an application from Test or Live
You can unpublish your application from the Test or Live environment any time.
Steps to unpublish
- In an application, go to the Publish page via the side navigation.
- Click the three-dot icon next to either the Test or Live environment.
- Select Unpublish from the menu.
- In the popup, confirm by clicking Unpublish again.
You can only unpublish from Live if the application is already unpublished from all client environments. If the Unpublish option is disabled, first make the application unavailable to clients.
Known limitations
- Modules secured via Only accessible via an API key will not appear on the Publish page.
- When switching between components of a published application, the session data will not be stored.
- Responsive design for smaller devices.
Related topics
- Publish an application to multiple clients, each with a separate design, data organization, user and authentication management.
- To decide who can access which module or data view, manage end user access.
- Add an external webpage to your published application.