Viewing Experiences
Once your app is built and integrated into Cinchy, you can set it up as an Applet to be viewed within the Cinchy platform.
Applets will show up as a tile on the Cinchy home screen and can be searched for in the Marketplace.
Applet Setup
To set up an applet:
- Navigate to the [Cinchy].[Applets] table.
- Insert a new row with the following information:
Column Name | Value | Example |
---|---|---|
Domain | Mandatory. Select a domain for the applet to belong to. | Cinchy |
Name | Mandatory. A name for your applet. | Network Map |
Full Name | This is a calculated field made up of "Domain" + "Name" | Cinchy.Network Map |
Icon | Mandatory. Select a system icon for the applet tile. | fa fa-spinner |
Icon Color | Mandatory. Select a system color for the icon. | Purple |
Description | A description of your app that will be visible on the applet tile. | The network map is used to visualize the data within the Cinchy platform. |
Target Window | Mandatory. This field defines whether the applet url will open in a: - New Window: Opens the URL in a new browser tab. - Existing Window (Redirect): Opens the URL in your existing browser tab. - Existing Window (Embedded): - Open the URL in your existing browser tab, with the Cinchy platform UI at the top of the screen, or opens within an iframe | |
Existing Window (Embedded) | ||
Application URL | Mandatory. The URL of your application. | ./apps/datanetworkvisualizer |
Users | A list of users who can search for the applet on the Cinchy homepage. | |
Groups | A list of Groups who can search for the applet on the Cinchy homepage. | /Cinchy/ |
Integrated Client | The "Name" of the Integrated Client associated with the app, if applicable. | |
GUID | This is a calculated field that's automatically generated for the applet. |
You can confirm the set up of your applet by searching for it in the Cinchy homepage as a user, or Group member, who has the correct entitlements.