Embedded Apps

In addition to running independently, because they are XML, Apps can be embedded in other web content. For example, you could design a Returns capability, and embed it in a third party site. On the Apps tab of the Product Admin screen, depending on your user Role, each App has authorization settings that control if and how it can be embedded:

  • Embeddable. When enabled, the App can be embedded. If not enabled, and the App is identified as embedded, user access is denied. By default, Embeddable is disabled.
  • Only Embeddable. When embedding is allowed, this setting restricts that embedding to iframe only, meaning the embedded App cannot appear as a top level window or tab.
  • Only Allow These Hosts. When embedding is allowed, use this to restrict the embedding to named domains. This is a semi-colon (;) separated list of permissible domains. Note that an empty list means allow all domains.
  • Note: Transtream Apps can only be embedded on HTTPS connections.
  • Allow Anonymous Access. This can be set to:
    • None. The user must provide a valid username and password. This is the default.
    • Preset User Context. A number of Apps and Snippet features are not supported if exercised using a Preset User Context. These include:
      • EDI App
      • Data Mapper App
      • Desktop App
      • Data Management App
      • Administration App
      • The ability to import Users from a CSV file into the Address Book Snippet
    • HubCapp Page to Page. The App runs with the user context supplied in the initialization of Page to Page communications using HubCapp. This allows loading user details or other information in the embedded widget.
      Note: the implementation of Page to Page communications protocol via HubCapp is considered a Developer-level feature and requires scripting be configured on the host webpage. These steps are not documented on this site. Please review with your Transtream account manager if you would like further information.
Article last edited 16 February 2023