Export and import integrations and microapps

You can export and import your integrations and microapps by completing the following procedures. Each import and export supports only a single integration (without microapps) and a single microapp one at a time.

To update an entire integration with microapps on a new environment, follow these steps:

  1. Export the source integration configuration (only necessary if changes were made to the target integration).
  2. Export source microapps.
  3. Import source integration configuration to the target environment as a new integration.
  4. Import source microapps into the new integration.
  5. Add missing credentials to the new integration.
  6. Add subscribers to the new microapps.
  7. Delete original integration on the target environment.

Known impact of updating integration configuration or a microapp

Consider the following issues before completing your export/import workflow:

  • Already generated feed cards are deleted when the original microapp is deleted.
  • New feed cards and push notifications are generated starting with the full sync of the new integration.
  • User’s favorite actions are lost as newly imported microapps behave as new ones.

Import a new microapp version with an unchanged integration

  1. Export the source microapps.
  2. Import the source microapps into the new integration.
  3. Add subscribers to the new microapps.
  4. Delete the original microapp on the target environment.

Export an integration

  1. Export an integration configuration using the context menu option Export integration configuration on an integration, in the microapps list in the Microapps admin.

    The integration configuration file for the integration is exported in the .mapp file format to your local machine.

    Configuration files contain the following entities:

    • Configuration (without passwords and client secrets)
    • Synchronization setup
    • Virtual Assistant Resolvers
    • For an HTTP integration:
      • Data endpoints (including chained child endpoints)
      • Relationships
      • Service Actions
    • No microapps are exported.

Import an integration

  1. Import an integration configuration using the Import integration configuration option.
  2. What are the limitations for import.
    1. The integration is still exported without client secrets. Therefore they must be filled in after import. Before that, the integration will not work properly (no caching, no actions possible).
  3. What is the state of integration after importing.
    1. Status “Passwords needed”:
      1. No synchronization happens until credentials are filled in manually.
      2. OAuth reauthentication is necessary if OAuth is set as the authentication method. Reauthentication is required to obtain updated tokens from the system of record.
      3. To fill in the credentials go to Manage > Integration context menu > Edit > Properties and fill in the missing passwords, secrets, and reauthenticate OAuth.
    2. No microapps are present (only the integration is imported).

Export a microapp

  1. Export a microapp using the context menu option Export microapp on microapp, in the microapps list in Microapps admin.
  2. A .mapp file with the microapp definition is downloaded.
  3. What gets exported:
    • A .mapp file defining a microapp with the following:
      • properties (microapp name, description, icon, action, action page).
      • notifications (trigger, conditions, notification content, expiration conditions).
      • pages (name, properties, all components with their properties including actions called).
      • Identification of the microapp integration (a mapping structure of microapp components to the integration data cache layer must properly map to the new integration).
    • No subscribers settings are exported.

Import a microapp

  1. Prerequisite: an integration has been imported to target environment or the integration exists on the target environment.
  2. Import a microapp using the context menu option Import microapp on an integration, in the microapps list in Microapps admin.
    1. Drag the file into the blade or choose the file from your file system and upload.
  3. Import limitations:
    1. A microapp must be imported to the same integration.
      1. Same integration type (either one of the template integrations (ServiceNow, Concur, and so on) or a custom HTTP integration).
        1. Even if the underlying data structure is equal for source and target integration, microapp import is unable to match the microapp data structure to a different type of integration.
      2. Matching database structure - if there are some cached tables missing in the target integration (the schema is different), the microapp is imported as misconfigured.
        1. To prevent misconfiguration make sure the schema of the source and target integrations are equal navigate through the integration context menu to Edit > Tables > Edit schema.
    2. The microapp must be built on top of a single integration.
      1. The microapp cannot call an action (on a button actions stack) from a different integration than the one it’s based on.
      2. The microapp cannot navigate to a page from a different integration as the “Go To Page” action in the button action stack (from both notification and page button).
      3. The microapp cannot have a page or notification built on top of a table from a different integration (when creating a page, a table from the same integration must be used to be able to import).

What is the state of microapp after importing?

  • The microapp has no subscribers. Subscribers must be recreated manually.
  • No generated notifications: notifications are generated automatically based on the notification trigger preferences (typically after the next synchronization).

Import a new microapp version

You can update a microapp to a newer version from the microapp option (ellipsis) menu.

  1. Select Import new version on your desired microapp in the Microapp Integration screen.
  2. Drag your new microapp and select Import.

    (Optional) Select Delete existing feed cards if you want to completely remove the old version of your microapp from the system. If you do not select this option, your old microapp remains on the system marked with and end-of-life (EOL) flag. Your newer version is set as the active microapp. It is recommended you do not delete your old microapps in order to keep your created feed cards working correctly.

  3. Click Import Your new microapp is imported.