On this page

The SubApps tab

Integrating existing apps as subordinate apps can be a smart way to reduce development time while forming relationships and structuring data between your app and others. In this guide, we will go through the steps required to add Instant, Remote, and Standard Apps as subordinate apps to your app.

Add an existing App as SubApp

When you want to add an existing app as a SubApp, you must ensure you have the correct name for that app first. Apps are often displayed by their labels which may or may not the same as the app name. The app name can be seen in the URL of the app's main page, it is the last part of the URL i.e: if the URL is https://w1.sitegui.app/siteadmin/100/app/feature_request, the app name is Feature_Request.

When you have the correct name of the app, just enter the name into the App field and optionally set an Alias for that app to replace the app name (in your app only). You can choose whether your App's record accepts multiple or just single subapp entry from each Client. For instance, if Comment is a SubApp, for each app record, we expect to receive multiple comments from a Client but for Like SubApp, we expect just one Like from that Client. If entries for the SubApp should not be created through the main App, choose Client ReadOnly or (Staff) ReadOnly for the Entry/User to just display SubApp entries and hide the button and input fields for creating a new entry.

Finally, choose how all SubApp's entries are displayed with our app record:

  • Table: display each SubApp's entry as a row in a table
  • Grid: display each SubApp's entry as a card in a grid
  • Kanban: group entries by a property (e.g: status) and display them in kanban columns
  • Flat Discussion: display entries as a flat discussion thread (e.g: comment thread)
  • Single Entry: display as a single entry
  • Client Hidden: hidden for Client, default SubApp's display for Staff. Note that Client can be under-privileged employees in the case of company internal app.

Your app may have as many SubApps as it needs, however please note that SubApps must be activated or bought by Site Managers before they can be used with your app. Site Managers having Developer license are also able to add more SubApps to your app or override the settings for existing SubApps when they configure your app.

Hidden App is visible when it is added as a Subapp

Hidden App are hidden from view for both Client and Staff, this is because they are often designed to be SubApps, complementing other apps. When they are added as SubApps, they become visible within the app to which they are added. For example, Like app is not really useful when it is used alone (so it is hidden by default) but when it is added as a SubApp, it helps provide Like for other apps' records (and thus its entries are visible when other apps' records are displayed)

App Visibility does apply in other cases, except when your app set the SubApp to be Client Hidden which will hide the SubApp for the Client group.

Relationship between Main App's record and SubApp's record

When a SubApp's record is created through the Main App, a relationship is established automatically from the Main App's record to the SubApp's record but this relationship is not visible to the Automated Action. App Developers should consider using a lookup field to create a direct relationship from the SubApp's record to the Main App's record and utilize the Automated Action to update the Main App's record when needed. App Developers may use a lookup field name exactly as the Main App's name to silently assign the Main App's record ID as the field value when creating a SubApp's record through the Main App.