AR application objects and variables
The integration endpoint is an example of how you can load a configuration payload into the AR experience without having to make changes in the AR tools. This allows for use of OIC’s declarative design tools to be used for configuration instead of coding the AR toolkit. Implementation of this configuration approach is not a requirement, but is used in this accelerator as an example for this approach.
Note: This endpoint exposes an HTTP endpoint
that returns a JSON payload back to the application. The JSON payload
can contain any applicable information that you want to configure.
The following table describes the application objects and their associated variables that can be delivered to the AR accelerator.
Objects / variables | Description |
---|---|
service |
This object tells the AR experience if the demo should use Engagement Cloud or Service Cloud. |
application |
This variable must be ec (engagement) or osvc (service) based on the application
being used in the demo. |
applicationHostName |
This variable is the fully-qualified domain name at the root of the Engagement Cloud or Service Cloud environment. |
contactId |
This variable is the contact that is associated to the service request that is created in the AR experience. You must collect a valid PartyId from Engagement Cloud or a valid Contact ID from Service Cloud depending on the application being used in the demo. |
iot |
This object controls the sensors (vibration , temperature , rpm , sound ) to display in the AR experience.
If any of the values are changed from 1 to 0, the selected sensor
will not display in the experience. Note: String values are used here because of the way OIC parses boolean
and integer JSON payloads. |
The following JSON example shows the applications objects and their associated variables.
{
"service": {
"application": "ec",
"applicationHostName": "www.apps.oracle.com",
"contactId": 100000000395782
},
"iot": {
"deviceId": "7894CDEB-7F21-4E9C-BEB2-BA5C25DE207D"
}
}