Attributes
- template_id: Identifier of the template to use, e.g. "PG1C"
Required: Yes
- duration_ms: The amount of time this screen should be shown in milliseconds. If not set or 0, the screen will be shown indefinitely.
Required: No
- separator: The separator used for communicating with the ProGlove device - this should not be used in any headers or content.
Required: No
- Default value: |
- refresh_type: Defines the request of this screen:
FULL_REFRESH = Black screen before the change
PARTIAL_REFRESH = immediate change (may leave old traces of old content on screen)
DEFAULT = ProGlove will decide
Required: No
- Default value: DEFAULT
Parameters
- headers: List of the headers to show - the number of entries depending on the template.
Required: No
- right_headers: List of the headers on the right side to show. These might not be shown on all devices.
Required: No
- content: The content to show - the number of entries depending on the template
Required: Yes
Output
- PROGLOVE_SET_SCREEN_SUCCESS: If the screen was set successfully
- PROGLOVE_SET_SCREEN_ERROR: If the screen could not be set successfully
- payload.error: Error description
Template IDs
ProGlove uses a template approach specific to itself to present information.
Templates are pre-defined screen layouts that support integration efforts and ensure the best possible user experience. They have IDs which are unique identifiers for each template layout. These need to be set during the integration process.
For more information, please see ProGlove - Screen Templates.
Here are the templates and their IDs to administrate Frontline:
PG1
This template is ideal for single items or short text messages.
<proglove_insight_template id="set_template" template_id="PG1" refresh_type="FULL_REFRESH">
<list name="headers" listType="NAMED">
<param name="1" type="string">Storage Unit</param>
</list>
<list name="content" listType="NAMED">
<param name="1" type="string">R15</param>
</list>
</proglove_insight_template>
PG1A
This template is ideal for short text messages.
<proglove_insight_template id="set_template" template_id="PG1A" refresh_type="FULL_REFRESH">
<param name="content" type="string">Check the package for any signs</param>
</proglove_insight_template>
PG2
This template is ideal for sorting.
<proglove_insight_template id="set_template" template_id="PG2" refresh_type="FULL_REFRESH">
<list name="headers" listType="NAMED">
<param name="1" type="string">Storage Unit</param>
<param name="2" type="string">Destination</param>
</list>
<list name="content" listType="NAMED">
<param name="1" type="string">R15</param>
<param name="2" type="string">A7</param>
</list>
</proglove_insight_template>
PG3
This template is ideal for picking use cases.
<proglove_insight_template id="set_template" template_id="PG3" separator=":" refresh_type="FULL_REFRESH">
<list name="headers" listType="NAMED">
<param name="1" type="string">left</param>
<param name="2" type="string">left</param>
<param name="3" type="string">left</param>
</list>
<list name="content" listType="NAMED">
<param name="1" type="string">Text 1</param>
<param name="2" type="string">Text 2</param>
<param name="3" type="string">Text 3</param>
</list>
<list name="right_headers" listType="NAMED">
<param name="1" type="string">right</param>
<param name="2" type="string">right</param>
<param name="3" type="string">right</param>
</list>
</proglove_insight_template>
PG1C
This template is ideal for positive and short notifications.
<proglove_insight_template id="set_template" template_id="PG1C" refresh_type="FULL_REFRESH">
<param name="content" type="string">Order complete</param>
</proglove_insight_template>
PG2C
This template is ideal for positive notifications which need more detail.
<proglove_insight_template id="set_template" template_id="PG2C" refresh_type="FULL_REFRESH">
<list name="content" listType="NAMED">
<param name="1" type="string">Correct Part</param>
<param name="2" type="string">Double click to proceed</param>
</list>
</proglove_insight_template>
PG1E
This template is ideal for negative and short notifications.
<proglove_insight_template id="set_template" template_id="PG1E">
<param name="content" type="string">Part Number Incorrect</param>
</proglove_insight_template>
PG2E
This template is ideal for negative notifications which need more detail.
<proglove_insight_template id="set_template" template_id="PG2E" duration_ms="3000">
<list name="content" listType="NAMED">
<param name="1" type="string">Error</param>
<param name="2" type="string">Netzwerkfehler</param>
</list>
</proglove_insight_template>
PG1I
This template is ideal for neutral short notifications.
<proglove_insight_template id="set_template" template_id="PG1I" refresh_type="FULL_REFRESH">
<param name="content" type="string">Confirm Quantity</param>
</proglove_insight_template>
PG2I
This template is ideal for neutral and short notifications which need more detail.
<proglove_insight_template id="set_template" template_id="PG2I">
<list name="content" listType="NAMED">
<param name="1" type="string">Confirm ...</param>
<param name="2" type="string">25</param>
</list>
</proglove_insight_template>
PG2A
This template is ideal for sorting (echoes to the scanned content and reverts back to the original screen).
<proglove_insight_template id="set_template" template_id="PG2A">
<list name="content" listType="NAMED">
<param name="1" type="string">1</param>
<param name="2" type="string">2 3 4 5</param>
</list>
</proglove_insight_template>