Updating Instances

Read first

Make sure you have read the following sections before proceeding:


Following are the two ways of updating solution instances:

Instance Update mode Who creates? Scalable? Ideal For?
From the Dashboard You No, as you are manually updating each instance Integration Managers who lack development resources for a marketplace app

Embedded Native users can use this for end to end testing by taking the role of an end user
From the marketplace app (powered by Embedded APIs) End users Yes, as your end users update their own instances Embedded native users who want to provide end users the flexibility to update their instances

As shown in the table above, you or the end user can update instances.

The instance updates are also triggered when the parent master solution is updated by you. Read this page here on managing updates to master solutions:

Using Tray dashboard

Once you have published a Solution, you will be able to update instances from the dashboard.

Navigate to the project you want to update 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 update as shown above and it will open a modal with options to run config wizard either by yourself or through a shareable link with the end user.

Note that the shareable link is valid for 5 minutes.

The config wizard needs to be closed manually after clicking on 'finish' if the wizard runs through the 'Shareable Link' option.

As shown above the window doesn't close by itself after clicking finish. It's because the wizard is designed to run as a pop up.

Using Marketplace App

The marketplace app is your customized offering to your end users built using Embedded APIs.

You will design your application to call the updateSolutionInstance mutation when the user clicks update button for an Instance.

Here's an Integration Marketplace app that can be set up in minutes to get you started. You can either customize this application to follow your branding schema and embed this in your portal or build your own Marketplace app.

Depending on which experience, you chose while creating the instance, the steps (including API calls) that are needed to update instances can differ:

Check the section on updating instances in the corresponding page for your end user experience:

Next page in this section discusses how you can delete instances in Tray UI as well as the API that can be used to do the same in your marketplace app.