Setting up the Creation or Opening of Records with QR Code

Users can Create new records, or Open existing records by scanning a QR, starting on the Search page.

Prerequisites

PREREQUISITE FOR OPENING RECORDS

To use a field in the QR code for opening a record, this field must be included in the Default Component Lookup of the Component.

The only exception for this requirement is the Unique ID.

note_awesome

NOTE

  • QR Code only works with components/forms that exist in Roam

Connectivity status when using Roam

  • To CREATE a new record, user can be on-line or off-line
  • To OPEN (include find or search) an existing record, user MUST be on-line.

Construction of the URL for QR Code

The full URL for creating or opening a record consists of three elements: Base URL/Form Identifier?Field Parameters

Base URL

  • To create a record: com.saiglobal.cintellate.roam5://New/
  • To open a record: com.saiglobal.cintellate.roam5://Open/

Form Identifier

  • The PublishID of the form can be retrieved from the Form Designer Menu path separator Form and Views Menu path separator find the component you want to create the QR code for.
    • QGGGxM5PNjI0NDIzOTA1NTg4 = [Alert] Publish ID

QRCode_PublishId

Field Parameters

Field Parameters are used as follows.

  • Creating a record: the fields will be pre-filled/selected to the value(s) provided.
  • Opening a record: the value(s) will be used as a filter.

Examples of URLs

  • Create a new Action record with no field parameter specified

    com.saiglobal.cintellate.roam5://New/ABNylGGXMjQ2ODk2MDI0Mjg4

    • where ABNylGGXMjQ2ODk2MDI0Mjg4 is the PublishID of the Action form.

  • Create a new Alert record defaulting [Alert Type] to "Risk".

    com.saiglobal.cintellate.roam5://New/QGGGxM5PNjI0NDIzOTA1NTg4?bms_9999999_10091=9999999_2089

    • where QGGGxM5PNjI0NDIzOTA1NTg4 is the PublishID of the Alert Form
    • bms_9999999_10091 is the bms id of field [Alert Type]
    • 9999999_2089 is the lookup Item ID 'Risk'

  • Create an Inspection record populating the Inspection Type, Asset/Equipment and Location

    com.saiglobal.cintellate.roam5://New/ABNylGGXMjQ2ODk2MDI0Mzk1?bms_9999999_9015=9999999_1583&bms_FK_9999999_988_ID=9999999_27&bms_FK_9999999_11033_ID=9999999_49

    • where ABNylGGXMjQ2ODk2MDI0Mzk1 is the PublishID of the Inspection Form
    • bms_9999999_9015 is the bms_id of field [Inspection Type]
    • 9999999_1583 is the lookup Item ID 'Equipment'
    • bms_FK_9999999_988_ID is the Location Inspection relationship Id
    • 9999999_27 is the internal id of Location "Australia"
    • bms_FK_9999999_11033_ID is the Asset/Equipment Inspection relationship Id
    • 9999999_49 is the internal id of Asset/Equipment "Air Handler"

See Also

Configuration of Mobile Forms

Component Filters in Roam

Lookup Filters in Roam

Setting up "My Tasks" in Roam

Setting up "New Tasks" - and the use of Icons

Setting up Searching of Records in Roam

Find closest Location in Roam