App‑to‑App Group Inbox Support

Note:Available on the TrueContext Mobile App versions 22.1 and later

You can use the list and open actions with records that were dispatched to a group or FormSpace. With both actions, you must specify type=groupinbox. This topic describes the list and open actions for records in the Group InboxClosed The Group Inbox on your mobile device is a list of records that were sent to a group or FormSpace. If you're available, you can claim a record to work on from the Group Inbox. and provides example App‑to‑App calls.

Available on the Enterprise tier only:

Essentials
Advanced
Enterprise

Contents

list actions

The list action displays a list of matching records in the Group Inbox. You must specify type=groupinbox in your App‑to‑App call.

Supported filters

  • name: Filters by the record name, matches partial strings.
  • tag and tag.list: Filters by one or more tags. You can use the tagOperator to specify whether the filter matches all tags (AND) or any tags (OR).

list examples

Action Example
List all records dispatched to a group or FormSpaceClosed FormSpaces are where forms are stored and organized in the TrueContext Web Portal. A TrueContext Team may have multiple FormSpaces, depending on their needs. Admins can set FormSpace permissions to control which users have access to the forms in that FormSpace.. 
truecontext://x-callback-url/list?type=groupinbox
List specific records dispatched to a group or FormSpace using the name parameter. 
truecontext://x-callback-url/list?type=groupinbox&name=asset%20list
List specific records dispatched to a group or FormSpace using the tag or tag.list parameter.

This example lists records that have the “install” tag.

truecontext://x-callback-url/list?type=groupinbox&tag=install

In the following example, the app lists records that have both the “install” and “checklist” tags.

truecontext://x-callback-url/list?type=groupinbox&tag.list=[install,checklist]

In the next example, the AND tag operator is optional, because the app defaults to and logic.

truecontext://x-callback-url/list?type=groupinbox&tagOperator=AND&tag.list=[install,checklist]

In this last example, the OR tag operator overrides the default behavior. The results include records that have either the install or the checklist tags, or both.

truecontext://x-callback-url/list?type=groupinbox&tagOperator=OR&tag.list=[install,checklist]

open actions

When you use the open action:

  • The Mobile App user must claim and open the record.

  • If only one record is a match, the Details view opens so that the user can claim the record.

  • If more than one record is a match, a list of matching records is displayed in the Group Inbox. Users can claim a record from the list.

  • You can dispatch answers in your App‑to‑App call, for example:

    truecontext://x-callback-url/open?type=groupinbox&name=asset%20list&Job%20-%20Type=Warranty

    where Job%20-%20Type is the question unique ID “Job - Type” and Warranty is the answer.

    Tip:The value is dispatched once the user claims and opens the record from the Group Inbox.

Supported filters

  • name: Filters by the record name, matches partial strings.
  • tag and tag.list: Filters by one or more tags. You can use the tagOperator to specify whether the filter matches all tags (AND) or any tags (OR).
  • dataRecordID: Filters on the identifier assigned when the record is dispatched to a group or FormSpace.

open examples

Action Example
Open the details of a specific record dispatched to a group or FormSpace using the dataRecordID parameter. 
truecontext://x-callback-url/open?type=groupinbox&dataRecordID=1234567891
Open a record or list of records dispatched to a group or FormSpace using the name parameter. 
truecontext://x-callback-url/open?type=groupinbox&name=asset%20list
Open a record or list of records dispatched to a group or FormSpace using the tag or tag.list parameter.

This example opens or lists records that have the “install” tag.

truecontext://x-callback-url/open?type=groupinbox&tag=install

In the following example, the app opens or lists records that have both the “install” and “checklist” tags.

truecontext://x-callback-url/open?type=groupinbox&tag.list=[install,checklist]

In the next example, the AND tag operator is optional, because the app defaults to and logic.

truecontext://x-callback-url/open?type=groupinbox&tagOperator=AND&tag.list=[install,checklist]

In this last example, the OR tag operator overrides the default behavior to apply or logic. The results include records that have either the install or the checklist tags, or both.

truecontext://x-callback-url/open?type=groupinbox&tagOperator=OR&tag.list=[install,checklist]
Open a record or list of records dispatched to a group or FormSpace using the name parameter, and prepopulate a value.

In this example, “Job - Type” is the question unique ID and “Warranty” is the value.

truecontext://x-callback-url/open?type=groupinbox&name=asset%20list&Job%20-%20Type=Warranty

Tip:The value is dispatched after the user claims and opens a record.

Callbacks

You can use the x-callback parametersClosed As part of an App‑to‑App call to the TrueContext app, x-callback parameters provide a way to launch and send data to the calling app. These include x-success, x-cancel, and x-error parameters. described in the following table to send information from the TrueContext Mobile App to another app or URL.

Info:The topic App‑to‑App x-callback parameters describes how these work in more detail.

Action Callbacks supported
list None
open

x-success

x-cancel

x-error