Skip to main content
Feedback

Embedding a Space

important

This section applies only to OEM partners who have opted for embedded Spaces within their applications.

Using the Embeddable Settings, you can configure and edit relevant settings for your embedded Spaces.

Configuring embeddable settings

To configure user settings for your embedded Space:

  1. Log in to Boomi Enterprise Platform.

  2. In the Services menu, go to Labs > Marketplace Publisher.

  3. Click Embeddable Settings.

    note

    You must give access to all child accounts you want to configure with embedded Spaces in the Access & Permissions tab.

    Embeddable Settings

  4. Click Give Access and enter the following details:

    1. Email Id of the child account.
    important

    Each child account must have a unique email id that is not shared with other child accounts.

    1. The Child Account ID in the required format.
    2. The API Token for the child account to access the embedded Space. For more information on generating an API token for a child account, refer to Generating API tokens.

  5. Click Give Access.

You have granted the user access to Embedded Spaces.

Editing Embeddable Settings

To edit Embeddable Settings for your Space:

  1. Log in to Boomi Enterprise Platform.
  2. In the Services menu, go to Labs > Marketplace Publisher.
  3. Click Embeddable Settings. The Access & Permissions tab lists all child accounts configured with embeddable Spaces.
  4. In the Actions column, click the Edit icon for the user you want to update.
  5. Update any of the following information:
    1. API Token for this child account. For more information on generating an API token for a child account, refer to Generating API tokens.
    2. Default Space (the Space that opens by default for the user).
  6. Click Give Access.

You have updated the user's embeddable settings.

Customizing branding for your Spaces

If you are an organization using embedded Spaces within your application, you can use custom branding to personalize the visual appearance of Spaces to match your brand identity. As your organization's administrator, you can customize elements such as headers, landing pages, typography, buttons, links, tables, and forms, to create a seamless, cohesive experience for your users.

To customize your embedded Spaces experience:

  1. Log in to Boomi Enterprise Platform.

  2. In the Services menu, go to Labs > Marketplace Publisher.

  3. Click Embeddable Settings.

  4. Go to the Custom Branding tab.

  5. You have options to customize the following settings:

    1. BRAND ASSETS

      1. Logo - Your company's logo in PNG, JPG, or GIF formats. If no logo is uploaded, the Boomi Spaces logo is used in your user Space. Recommended dimensions are 128 × 128 px.
      2. Banner Image - The image that forms the header banner for the user Space in PNG or JPG formats. File size must be lesser that 1 MB. Recommended dimensions are 1440px x 150px.
      3. Banner Title.
      4. Banner Subtitle.
      5. Banner Text Color.

    2. THEME & APPEARANCE for the user Space.

      1. Color themes.
      2. Font family.

  6. Based on your customization inputs on the left pane, a live preview is generated on the right pane.

  7. Tweak your inputs to suit your company's branding requirements. You can either save your settings as draft or Publish to your Space. All users of this Space will see these custom branding updates within their embedded application.

Generating Platform API tokens

To generate an API token for your child account:

  1. Log in to your Boomi Platform account.

  2. Use the account switcher to switch to the child account for which you want to generate the API token.

  3. Go to the Settings page for this account.

  4. On the left pane, click Platform API Tokens under My User Settings.

  5. Click Add New Token.

  6. Enter a name for the API token and click Generate Token.

  7. Click Copy To Clipboard & Close.

    important

    Once created, API tokens cannot be accessed from the Platform API Tokens page. Make sure to copy the token after generation and store it securely for future use.

Repeat these steps to generate API tokens for any other child accounts you want to add as partners.

On this Page