Platform

The Platform Widget category consists of the following widgets:

• Object Card
• Resource Selector
• Time Series
• Action

---

Object Card

The object card widget takes ObjectRID as its input. It will render the mini object-views (cards) as they have been defined in the Ontology app. The object cards will be linked to their Object Explorer object view.

Table Format

It is possible to populate a table of object views using this widget in conjunction with repeatable containers.

For example, assume that you have a Slate function that returns an array of RIDs. You can insert the object card widget into the repeating container to create a "table view". You need to index the Object Widget with the repeatable container’s index so in the “Object RID” you will specify: {{lookup f_function1 w_repeating_container.index}}.

This sets up a list of cards based on the RID from your function and the index of the repeatable container using the lookup built-in function.

Get Object RID

To obtain the ObjectRID input, you have a few options:

Option 1: Slate provides a point-and-click UI, the Object Set panel, where you can make object queries without having to construct the queries manually.

Option 2: You can obtain the ObjectRid of a specific object by navigating to its Object View and selecting the Actions dropdown. In the clipboard, it will allow you to copy a URL link. Copy the last section of the URL link, that is, the portion after ?objectId={ObjectRID} (for example if the URL is ...?objectId=ri.phonograph2-objects.main.object.09d2e0e9-dd3c-49b2-8b96-0cb1bf005c1d your ObjectRID = ri.phonograph2-objects.main.object.09d2e0e9-dd3c-49b2-8b96-0cb1bf005c1d).

Option 3: To obtain the ObjectRID from the ObjectTypeId and ObjectPrimaryKey, you will need to use the Get Object by Locator endpoint. While ObjectTypeId and ObjectPrimaryKey can be use in other places to parameterize Object Explorer URL links, they need to be resolved into ObjectRIDs in Slate. You can make dynamic combinations of ObjectTypeId and ObjectPrimaryKey and pass this into a Slate query to retrieve the ObjectRID (provided the endpoints are exposed on your instance and you have set it up as a data source).

---

Resource Selector

The Resource Selector widget allows you to select a file in Compass.

This widget does not create a visual element on your page. Instead, it exposes an Action to open the resource selector, and some events to handle the selected resource.

Events

• w_resource_selector_1.didClose: This event is triggered when the resource selector is closed.
• w_resource_selector_1.selectedRid.changed: This event is triggered when a resource is selected in the resource selector. {{sl_event_value}} is set to the RID of the selected resource.

Actions

• w_resource_selector_1.open: This action opens the resource selector dialog.

---

Time Series

Slate’s Time Series widget provides a convenient way to visualize time series graphs. You can add multiple series into the same chart using the Series ID, or make a Codex query of data served from Epoch2. You can also configure the visualization by:

• Specifying the Title, Unit and Color, or by disabling the Crosshairs or Legends.
• Dynamically defining the Time Range to specify the view window.
• Turning on “streaming mode” for the data.

---

Action

Slate's Action Widget allows Slate to execute business logic pre-configured in an Action. After adding the widget onto your page, you can:

• Select a Foundry Action you have access to,
• Pass in Default Parameters into your Action form directly or via Slate's handlebars, and
• Submit the Action form directly with the Submit button, or indirectly with the Slate event-action pair w_widget.submit.

Additionally, Slate provides the following Slate events in relation to the Action Forms:

• Submission (w_widget.success/w_widget.failure)
• Validation state (w_widget.ValidationSuccess/w_widget.ValidationFailure), and
• Rendered changes (w_widget.transitioned and w_widget.cssClassesUpdated).

Finally, you can also prevent the Action Form from displaying via a toggle control if you need abstract away the UI from the user and trigger submission via Slate events. Refer to the Slate events for more information.

The Foundry Action will need to be created before being used in Slate. Refer to the Actions documentation for more information.

Default Parameters

The parameters for a Foundry Action can be provided directly by the user or programmatically by using default parameters, which can be set in the configuration of the widget.

Object Locator Prefill

To provide an object reference, you can use the code snippet below. The values of typeId and primaryKey can be found in the Ontology Manager: typeID is the ID of the object and primaryKey is the Property ID of the object's primary key.

Copied!
1
2
3
4
5
6
{
  "typeId": "<object typeId here>",
  "primaryKey": {
    "<optional primary keys here>": "<values>"
  }
}

If the Object parameter for the relevant Action supports multiple inputs, provide a list of object locators as the default value.

Copied!
1
2
3
4
5
6
7
8
9
10
11
[{
  "typeId": "<object typeId here>",
  "primaryKey": {
    "<optional primary keys here>": "<values>"
  }
},{
  "typeId": "<object typeId here>",
  "primaryKey": {
    "<optional primary keys here>": "<values>"
  }
}]

Date Prefill

Dates are expected to be in ISO 8601 format; for example, YYYY-MM-DD (e.g. 1990-01-12) is a valid date format.

Timestamp Prefill

Timestamps are expected to follow ISO 8601 format: YYYY-MM-DD[T]HH:mm:ss.SSS[Z] (1990-01-12T23:00:00.000Z, for example).