Using Keywords

Keywords

Keywords are used to resolve data dynamically in your app. To use dynamic data, you need to use the following Keywords as is. These keywords are available under the different tasks under Use Keywords > Keywords.

Following is the list of Keywords used in Action flows:

  • USERNAME: Username or user id of the user logged in.

  • USEREMAIL: Email address of the user logged in.

    • Note: It is important to remember that if the App is open in public access, i.e. the user has not logged in, the two keywords USERNAME and USEREMAIL defaults to the app creator’s name and email.
  • TRUE: This is a boolean data type value that is TRUE. Usually used when the result of a logical statement is True

  • FALSE: This is a boolean data type value that is false. Usually used when the result of a logical statement is false

  • DATAENV: This is the environment name where the data is coming. The environments are Prod, beta, dev. For Apps published in Live/Prod, the environment will always be Prod or production. For the apps published in Beta only state, it will return Beta. When you are taking a preview of your app when designing them the DATAENV would return it as Dev.

  • WORKFLOWENV: This is the environment where the workflow is functioning. When you are designing or developing your apps and take a preview of the same, the workflow that you added would function in the Dev environment. While for the published The keyword is primarily useful in scenarios where we want to schedule the action flow task execution depending upon the environment

  • NULL: Used to assign NULL value.

  • DEVICESIZE: Specifies the size of the device in terms of the Mobile Portrait, Mobile Landscape, Desktop, and Tablet. Say, for example, an app used on the tablet will return Tablet while one used on a Desktop or Laptop computer would return “Desktop”.

  • DEVICETYPE: This is the type of device where the app is used. If it is used on a desktop it will return Web while say if it is a mobile app it will return Android on the standard Android smartphones.

  • MODE: This s the mode of the app usage as online or offline. For example, you may use the offline mode for the data submission of the feedback forms or documenting inspection reports, construction, and so on.

  • WIDTH: Specifies the width of the app based on the device size. For example, if you are using a mobile portrait the width would be 413, if the device is a desktop the width would be 1980.

  • APPENV: This is the environment of the app being used as dev, prod, or beta. E. g. whenever you are creating your apps in the dev environment and you take a preview of the same, APPENV returns the value “Dev”.

  • LANGUAGE: This is the language in use e.g. eng-US, eng-UK and so that is set when

  • VERSION: This gives you the current published version of the App. It is typically useful when you want to display the version number on the home screen of your app that provides users specific information about the installed app.

Workflow Keywords

The Workflow Keywords are used to resolve data dynamically in your workflow. These are limited to be used within the workflows as against the above keywords that can be used in any task.

To use dynamic data, you need to use the following Keywords as is. However, to use dynamic data in Workflow description, Notification Title & Notification Message or Task Name, you need to use keywords within double curly braces {{}}, e.g. {{INITIATED.INPUTBYEMAIL}}

Following is the list of Keywords used in Workflow

  • INPUTAT: The time at which user submitted the data in UTC timestamp in Unix format

  • INPUTBYEMAIL: Email address of the user who has submitted the data

  • INPUTBYNAME: Initiator’s Full Name or full name of the user who has triggered the workflow

  • SUBMITID: Is the ID which uniquely identifies a group of Rows submitted/Added together. For a detailed explanation refer to this article here.

  • ROWID: This is used to uniquely identify a Row in Sheet. For a detailed explanation refer to this article here.

The above mentioned keywords can be used in Workflow tasks with prefix INITIATED or taskname followed by a dot (.), for example, INITIATED .INPUTAT or taskname .INPUTBYEMAIL

INITIATED

This keyword is used to refer to the data submitted by the user from the screen through which the workflow has been triggered. For instance, in a Leave Application app, when an employee applies for a leave, the leaves balance should be updated accordingly on approval by its manager. Therefore, while creating Update Task for updating leave balance in the Workflow, you can access employee’s leave application data using keyword INITIATED. leavestartdate , where leavestartdate stores the leave application’s start date.

CURRENT_VALUE

This keyword can only be used in Workflow’s Update Tasks. It is used to perform an operation on the existing value of the field to be updated/modified.
For example, let’s say there is a column called as “Product_Stock” in sheet Inventory_Details and your Update Task need to subtract the Ordered Quantity (control unique name - ordered_quantity ) from the Product_Stock which results into available stock, then you can use keyword in the following way -
Product_Stock=CURRENT_VALUE- INITIATED .ordered_quantity ,
where Ordered Quantity is subtracted from the current value of Product Stock and the result is updated in column Product_Stock.