Placeholders & Conditions for Notification, Printout, Message and Descriptive Memo

In Xeelo platform, you can reach the issue that you want to get data from request into Notification, Printout, Message or Descriptive Memo (into HTML editor). For this purpose platform contains placeholders that provide such a functionality. There is nothing to set except just type the placeholder into the editor.

Format placeholder

Placeholder Description
{idXXX} current value of provided object line will be returned.
{idXXXp} this placeholder will return previous value of provided object line. More precisely value of previous version of request (before update was made).
{idXXXv} returns value of a reference (Value - Name). Usage only in Combo-box
{NextUserName} currently assigned users
{PrevUserName} user performing current workflow action
{RequestLink} HTTPS link to request
{Today} current date
{TodayTime} current time
{TodaySerial} current date in serial format YYYYMMDD
{RequestorID} requestor user ID
{RequestorName} requestor user name
{RequestorLogin} requestor login
{RequestorAssigned} value 1 in case request is assigned to requestor, otherwise value 0
{RequestorEmail} return requestor e-mail
{RequestorLanguage} return requestor language
{NotAssigned} value 1 in case request is assigned to requestor, otherwise value 0
{ObjectName} name of current request object
{CompanyName} name of current request company
{ObjectTypeName} name of current request object type
{RequestID} current request ID
{RoleName} current request role name
{RequestStatus} current request status name
{RequestState} current request state according to Workflow step (status property): Completed, Cancelled or InProgress
{RequestType} current request type name (create, update or update empty)
{RequestPriority} current request priority name
{ObjectDefaultName} current request template name
LastActionDate} date and time of last workflow action for current request
{CreatedDate} creation date of current request
{ModifiedDate} modification date of current request
{RequestTag} new / overdue tag of current reuqest
{ActionDuration} duration in minutes between current and previous workflow action
{ModifiedByID} user ID of last modifier
{ModifiedByName} user name of last modifier
{CreatedByID} user ID of request creator
{CreatedByName} user name of request creator
{LastWorkflowUserID} last workflow action user ID of current request
{LastWorkflowUserName} last workflow action user name of current request
{LastActionName} last workflow action name
{LastActionID} last workflow action ID
{LastRoleName} previous role name of current request
{LastRequestStatus} previous status name of current request
{AssignedUserName} list of user names currently assigned to request
{AssignedUserID} list of user IDs currently assigned to request
{RequestorLogin}
{RequestorEmail}
{RequestorLanguage}
{RequestorAssigned}
{NotAssigned}
{RequestState}
{LastRoleName}
{LastRequestStatus}
{LastComment}
{SubLineNext}
{id%[0-9]}
{OwnerUserID}
{OwnerUserName}
{WatcherUserID}
{WatcherUserName}
{Variable,%}
{LastComment} last comment of current request
{ObjectDefaultID} template ID of current request
{OwnerUserID} owner ID of user assigned in current request
{OwnerUserName} owner name of user assigned in current request
{WatcherUserID} watcher ID of user assigned in current request
{WatcherUserName} watcher name of user assigned in current request
{Variable,[Variable code]} general variable
{TempCalc,[Temporary calculation ID]} temporary calculation value

Format HTML placeholder

Placeholder Description

{BarCode,[Object line ID],[type of code]}

{BarCode,[Object line ID],[type of code],[width],[height]}

Default width is set to "2" and default height is set to "60".
Width in this case defines a width of a Barcode line (stripe).

type of code - MUST BE set with lower case characters!!!

inserts a barcode regarding provided object line (numerc, alphanumeric) and defined type of code:

  • STD25 (Only Numeric) - Standard 2 of 5 Symbology (digits are encoded with 5 bars, 2 of which are always wide (and the remaining three are narrow)

  • INT25 (Only Numeric) - Interleaved 2 of 5 Symbology (encodes data in the width of both the bars and spaces. This allows to achieve a somewhat higher density.)

  • EAN8 (Only Numeric) - provides a "short" bar code for small packages.

  • EAN13 (Only Numeric) - number system code consists of two digits ranging from 00 through 99, which is essentially a country code

  • UPC (Only Numeric) - encodes 11 digits of numeric (0 through 9) message data along with a trailing check digit, for a total of 12 digits of bar code data.

  • Code11 (Only Numeric) - The symbology is discrete and is able to encode the numbers 0 through 9, the dash symbol (-), and start/stop characters

  • Code39 (Alphanumeric) - The first alpha-numeric symbology to be developed

  • Code93 (Alphanumeric) - can represent the full ASCII character set by using combinations of 2 characters. It differs in that Code 93 is a continuous symbology and produces denser code

  • Code128 (Alphanumeric) - Code 128 is a very effective, high-density symbology which permits the encoding of alphanumeric data.

  • Codabar (Only Numeric) - encodes 16 different characters, plus an additional 4 start/stop characters

  • MSI (Only Numeric) - is a continuous, non-self-checking symbology. While the length of an MSI bar code can be of any length, a given application usually implements a fixed-length code

  • Datamatrix (Alphanumeric) - very efficient, two-dimensional (2D) barcode symbology that uses a small area of square modules with a unique perimeter pattern, which helps the barcode scanner determine cell locations and decode the symbol. Characters, numbers, text and actual bytes of data may be encoded, including Unicode characters and photos.

    Sources: http://www.barcodeisland.com, https://www.idautomation.com

  • {RequestSubGridNoHeader,[Width],[Object line ID],[idXXX],…,[idZZZ]} inserts the table with sub-grid details for specific object line with selected object sub-grid lines. Sub-grid table without header

    You can set height (2/3) or width (60/100) of barcode. Both values are constants.

    {RequestSubGrid,[Width],[Object line ID],[Sub-Grid idXXX],…,[Sub-Grid idZZZ]} inserts the table with sub-grid details for specific object line with selected object sub-grid lines. Sub-grid table with header
    {RequestSubGridTotal,[Width],[Object line ID],[Sub-Grid idXXX],…,[Sub-Grid idZZZ]} sub-grid with header and total. This placeholder will display subgrid details with one extra row (in bold) with totals.
    {ReportResult,100, XXX} Placeholder inserts the report result according to its definition. XXX is ID of report result
    {RelationGrid,[Width],[Object ID],[idXXX],…,[idZZZ]} table with the list of related object requests. Inserts the table with requests that are in relation with current request for specific object and selected object lines.
    {RequestDetail,[Width],[idXXX],…,[idZZZ]} table with details of the request. This table is shown regardless the visibility set-up in Workflow or Object. idXXX,…,idZZZ - list of object lines where XXX,…,ZZZ is the list of IDs. In case no ID is provided then all lines will be shown.
    {RequestDetailFilter,[Width],[idXXX],…,[idZZZ]} similar function as above with exception that it provides only non-empty data or data that are changed (in case of update request). idXXX,…,idZZZ - list of object lines where XXX,…,ZZZ is the list of IDs. In case no ID is provided then all lines will be shown.
    {RequestCommentsNew,[Width]} table with comments added since last workflow action. Inserts table with request comments added since last comment notification was sent. This notification have to be set-up in Scheduler for each object separately.
    {RequestCommentsPrev,[Width]} table with comments added before last workflow action. Inserts table with request comments for which comment notification was already sent.
    {RequestComment.[Width]} table with all comments. Inserts table with all request comments ordered chronologically
    {RequestWorkflow,[Width]} table with request workflow history
    {ProgressBar,[Height],[Label],[Value or Object line ID],[Color or Object line ID]} progress bar
    {Condition,[Condition],[True statement],[False statement]} inline condition (online for Printout). The first parameter in brackets must be always the word Condition!
    Syntax is almost the same for string and number, except the quotation marks:
    • For string the condition must be with parentheses. The simple example: {Condition,'{id1364}'='Xeelo color',Green,Blue}
    • For number the condition must be without parentheses. The simple example: {Condition,{id1325}<{id57},24,124}
    • HTML in result branches is still available therefore it is possible to insert HTML tags and format the result.
    {Condition2,[Condition ID],[Condition]}{Condition2Else,[Condition ID]}{Condition2End,[Condition ID]} statement condition (online for Printout). Condition ID is the identifier of the condition. It is highly recommended to change the identifier for different conditions!
    • It is possible to set condition without else branch. The condition will look like {Condition2, ABC, Condition phrase} if branch {Codition2End, ABC}
    • It is also possible to insert one {Condition2, First, 1=1} into another condition {Condition2, Second, 1<2} ....
    • Syntax:
        For string the condition must be with parentheses. The simple example: {Condition2, CAB,'{id1364}'='Xeelo color'}TRUE{Condition2Else, CAB}FALSE{Condition2End, CAB}
        For number the condition must be without parentheses. The simple example: {Condition2, BBB,{id1325}<{id57}}It is really true!{Condition2End, BBB}
     
    **Only for notification additionally**
    {RequestOfflineActions,[Width]} list of workflow offline actions. This function inserts the block with workflow offline action that can be used in the email approval. Please ensure that offline actions are allowed in the Workflow and proper authorisation level is setup in System settings. This function can be used on for single request notifications.
    It must be set on WF step.
    {RequestOfflineActionsWithRequestLink,[Width]} list of workflow offline actions with link to request. Enhancement to workflow offline actions allows to add additional “action” called Request detail to be used in the email approvals, which opens the particular request.
    It must be set on WF step.

    Tip: Attachment preview can be now displayed in various placeholders that display Request/SubGrid details, detailed info here

    Format Summary placeholder

    Placeholder Description
    {Variable,[Variable code]} general variable
    {RequestGrid,[Width],[idXXX],…,[idZZZ]} table with list of requests. This function can insert the grid with multiple requests with link to each individual request. It can be used only for request summary notification type.
    1 Like
    1. Can you please explain what is the difference between {idXXX}, {idXXXp} and {idXXXv}, while the description is for all three of them the same: “id of object line with slot with extra info of object / tab / section / object line name. In case of printout should be restricted to particular object.”
      Note: one can find that idXXX and idXXXp means somewhere else, but it would be better to see it here as well.

    2. For BarCode what are please the possible values of Type of code?

    Thanks a lot.

    Hey @petr.skruzny,

    i have updated the description of mentioned fields. I hope it is now clearly explained.

    {idxxx} - current value of provided object line will be returned in the output.
    {idxxxp} - previous value of provided object line will be returned in the output - more precisely value of previous version of request (before update)
    {idxxxv} - this one can be used only for combo-boxes and returns a value of a reference (Value - Name).

    About the BarCode i do not know but i will try to find out and update this topic.

    2 Likes

    @petr.skruzny Topic updated with types of barcode.

    1 Like

    Hi,
    there are also following new placeholders:

    {OwnerUserID}
    {OwnerUserName}
    {WatcherUserID}
    {WatcherUserName}

    It would be nice to have them with others in the table with explanation.

    Added. Thank you @hana.zakostelska

    1 Like

    It is now possible to include line type “Attachment preview” into following placeholders, which will be displayed as a link of the attachment:

    • {RequestSubGridNoHeader,[Width],[Object line ID],[idXXX],…,[idZZZ]}
    • {RequestSubGrid,[Width],[Object line ID],[Sub-Grid idXXX],…,[Sub-Grid idZZZ]}
    • {RequestSubGridTotal,[Width],[Object line ID],[Sub-Grid idXXX],…,[Sub-Grid idZZZ]}
    • {RequestDetail,[Width],[idXXX],…,[idZZZ]}
    • {RequestDetailFilter,[Width],[idXXX],…,[idZZZ]}

    These placeholders with line type “Attachment preview” can only be used in line type “Description memo”!!!

    It is possible to display attachment preview by clicking on the provided link in the description memo from Xeelo web and also from Xeelo mobile application.

    4 Likes