Creating Instances
Read firstCopy
Make sure you have read the following sections before proceeding:
IntroductionCopy
Following are the two ways of configuring solution instances:
Solution Instance Creation | Who creates? | Scalable? | Ideal For? |
---|---|---|---|
From the Dashboard | You | No, as you are manually creating 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 configure their own instances | Embedded native users who want to provide end users the flexibility to create their instances |
Using Tray dashboardCopy
Once you have published a Solution, you will be able to create instances from the dashboard. Follow the steps below to achieve this:
Using Marketplace AppCopy
The marketplace app is your customized offering to your end users built using Embedded APIs.
You will design your application to call the createInstance mutation when the user clicks configure button for a Solution.
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.
Embedded Native provides you with three options to choose from when building end-user experience:
Config wizard experience: This is the standard way of building an experience where users can provide auths and configs.
Auth-only dialog experience: Ideal when you only want the end user to provide auth and data mappings and configs are static.
Custom Form experience: Your custom wizard where you can leverage Tray's auth dialog for capturing auths and Call Connector API to build config dropdowns.
You can decide which experience to present to your End Users as per your Integration use case you can also have a combination of these experiences by choosing a suitable type for each Integration/solution that you build. Check the decision table on this page here.
Read nextCopy
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: