Saturday, November 24, 2018

Using placeholders

Placeholder in Rethink Workflow is one of our unique features which allow the workflow designer creating a temporary variable whose value will be assigned at run-time.

Placeholders work great for many use-cases, for example, you could generate a letter of recommendation based on the values entered to the form by the end-user.

How to design

In Rethink Workflow, {{nameOfThePlaceholder}} format represents a placeholder. For example:
To add a placeholder to supporting configuration, simply type {{ and the list of available placeholders will appear. You can then select one from the list to add as in the demonstration below:
In the above demonstration, we are adding {{currentDate}} to the name of the document. When a new document created, the system will replace it with the current date in MM/DD/YYYY format.

Placeholder-supported configuration

While designing a workflow, you can add placeholders to the following places:









There are two types of placeholders: system placeholders and field-provided placeholders.

System placeholders 

System placeholders are placeholders that predetermined by the system.
  • action.description - string: The description of the last action (e.g. transition) which moved the document to the current state
  • action.id - id: The unique ID of the last action (e.g. transition) which moved the document to the current state
  • action.name - string: The name of the last action (e.g. transition) which moved the document to the current state
  • actor.avatarUrl - string: The Avatar URL of the last actor
  • actor.emailAddress - string: The last actor's email address
  • actor.id - id: the last actor's unique ID
  • actor.name - string: The last actor name
  • actor.profileUrl - string: The Profile URL of the last actor
  • actor.unit.id - id: The unique ID of the last actor's organizational unit
  • actor.unit.name - string: The name of the last actor's organizational unit
  • actor.unit.path - string: The full path of the last actor's organizational unit
  • company.id - id: The company's unique ID of the document
  • company.name - string: The name of the current company
  • currentDate - string: The current date in MM/DD/YYYY format
  • currentDateTime - string: The current date time in MM/DD/YYYY hh:mm AM/PM format
  • currentTime - string: The current time in hh:mm AM/PM format
  • document.createdDate - string: The created date of the document in MM/DD/YYYY format
  • document.createdDateTime - string: The created date and time of the document in MM/DD/YYYY hh:mm AM/PM format
  • document.createdTime - string: The created time of the document in hh:mm AM/PM format
  • document.createdTimestamp - timestamp: The created timestamp the document
  • document.id - id: The unique ID of the document
  • document.isCompleted - boolean: The boolean value "true" if the document has reached the exit state
  • document.isCreated - boolean: The boolean value "true" if the document is created and has not been routed yet
  • document.isInProgress - boolean: The boolean value "true" if the document is not in created nor reaches the exit state
  • document.key - string: The unique key of the document generated automatically by the system
  • document.lastActivity.date - string: The date of the document's last activity in MM/DD/YYYY format
  • document.lastActivity.dateTime - string: The date and time of the document's last activity in MM/DD/YYYY hh:mm AM/PM format
  • document.lastActivity.description - string: The description of the document's last activity
  • document.lastActivity.time - string: The date of the document's last activity in hh:mm AM/PM format
  • document.lastActivity.title - string: The title of the document's last activity
  • document.lastUpdatedDate - string: The last updated date of the document in MM/DD/YYYY format
  • document.lastUpdatedDateTime - string: The last updated date and time of the document in MM/DD/YYYY hh:mm AM/PM format
  • document.lastUpdatedTime - string: The last updated time of the document in hh:mm AM/PM format
  • document.lastUpdatedTimestamp - timestamp: The last updated timestamp
  • document.name - string: The name of the document
  • document.url - string: The absolute URL to the document
  • documentIsTrashed - boolean: The boolean value "true" if the document was trashed
  • owner.avatarUrl - string: The avatar URL of the document owner
  • owner.emailAddress - string: The document owner's email address
  • owner.id - id: The document owner unique ID
  • owner.name - string: The full name of the document owner
  • owner.profileUrl - string: The profile URL of the document owner
  • owner.unit.id - id: The document owner's unit unique ID
  • owner.unit.name - string: The unit name of the document owner
  • owner.unit.path - string: The full path to the document owner's organizational unit
  • pendingSignOffPeople - string: The list of users who have NOT signed off the document
  • recipient.avatarUrl - string: The avatar URL of the recipient (if available)
  • recipient.emailAddress - string: The email address of the recipient (if available)
  • recipient.id - string: The id of the recipient (if available)
  • recipient.name - string: The name of the recipient (if available)
  • recipient.profileUrl - string: The profile URL of the recipient (if available)
  • signedOffPeople - string: The list of users who have already signed off the document
  • state.description - string: The description of the current document's state
  • state.id - id: The unique ID of the current document's state
  • state.isEntry - boolean: The boolean value "true" if the document's state is the entry state
  • state.isExit - boolean: The boolean value "true" if the document's state is an exit state
  • state.name - string: The name of the current document's state
  • variant.description - string: The workflow variant description
  • variant.id - id: The workflow variant unique ID
  • variant.name - string: The workflow variant name
  • workflow.description - string: The workflow description
  • workflow.id - id: The unique ID of the workflow
  • workflow.key - string: The unique key of the workflow
  • workflow.name - string: The workflow name

Field-provided placeholders

This type of placeholders provided by each field / control. Check out the guide on each control to get what being offered. 

No comments:

Post a Comment