Enabling Instances

Read first

Copy

• Tray Embedded Overview

• Main components diagram

• Solution building basics

• User Management

• Displaying Solutions

• The Config Wizard

• Solution Instances Introduction

• Creating Instances

Introduction

Copy

Once the instance has been created, you will can update instances:

• through dashboard

• through marketplace

  • call the enable instance API right after configuration is finished by the end user.

  • allow end users to do it themselves in the marketplace app on click of a button.

This is to allow you to make any checks or changes before an Instance is activated.

Using Tray dashboard

Copy

You can enable instances through the dashboard as well. Navigate to the project you want to enable instances for. Open the project and click on the Solution Instances tab. You will find all Solution Instances linked to this project.

You can click on enable as shown above and the instance would be enabled.

You can also disable instances if required. You will find a 'disable' option for a Solution Instance that's 'enabled':

Using Marketplace App

Copy

You can provide an option to end users to enable the instance as shown as shown above. You will use the updateSolutionInstance - Enable (User token) mutation with to enable the instance in your Integration marketplace app.

Note that it is best practice to set errorOnEnablingWithMissingValues to true when passing the arguments with this mutation:

1
 updateSolutionInstance(input: {
2
   solutionInstanceId: $solutionInstanceId,
3
   instanceName: $instanceName,
4
   errorOnEnablingWithMissingValues: true,
5
   enabled: true
6
 }) 

This will prevent you from enabling misconfigured Instances.

When using config wizard experience, You can also enable the instance for them by immediately calling the above API right after the wizard is completed.

For this, You can listen for the tray.configPopup.finish event to know when was the wizard finished successfully. Check other config wizard events to handle any errors.

If you are using a custom form experience, you will have to use your own workaround.

Read next

Copy

• Updating Instances