input
stringlengths 14
1.47k
| output
stringlengths 286
299k
| instruction
stringclasses 1
value |
|---|---|---|
Add Validations to an Inline Editable Grid
Allows the user to change data directly in a grid, and validate a various entries.
This design pattern is not recommended for offline interfaces because reflecting immediate changes in an interface based on user interaction requires a connection to the server.
In this case, the recipe validates for a relevant phone number standard as well as non-sensical dates for existing employees.
Change an employee's phoneNumber to a value greater than 12 digits. Notice that the validation message shows up when you move away from the field.
Change an existing employee's startDate to a date in the future. Notice that the validation message shows up when you move away from the field. Change the date back to a past date
Add a new employee. Change that new employee's startDate to a date in the future. Notice that the validation message does not show up when you move away from the field.
This scenario demonstrates:
How to configure validation messages that show up as soon as a condition is satisfied
How to configure validation messages to appear outside the component where the validation occurred
| a!localVariables(
/*
* local!employees is provided in this recipe as a way to start with hard-coded
* data. However, this data is identical to the data created from the entity-backed
* tutorial. Replace the hard-coded data with a query to the employee data store
* entity and all of the employee records from the tutorial will appear.
*
* To replace this data with your own, replace (ctrl+H or cmd+H) all references to
* local!employees with your data source, either via rule input or local variable.
*/
local!employees: {
a!map( id: 1, firstName: "John" , lastName: "Smith" , department: "Engineering" , title: "Director" , phoneNumber: "555-123-4567" , startDate: today()-360 ),
a!map( id: 2, firstName: "Michael" , lastName: "Johnson" , department: "Finance" , title: "Analyst" , phoneNumber: "555-987-6543" , startDate: today()-360 ),
a!map( id: 3, firstName: "Mary", lastName: "Reed" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-456-0123" , startDate: today()-240 ),
},
a!formLayout(
label: "Add or Update Employee Data",
instructions: "Add, edit, or remove Employee data in an inline editable grid",
contents: {
a!gridLayout(
totalCount: count(local!employees),
headerCells: {
a!gridLayoutHeaderCell(label: "First Name" ),
a!gridLayoutHeaderCell(label: "Last Name" ),
a!gridLayoutHeaderCell(label: "Department" ),
a!gridLayoutHeaderCell(label: "Title" ),
a!gridLayoutHeaderCell(label: "Phone Number" ),
a!gridLayoutHeaderCell(label: "Start Date", align: "RIGHT" ),
/* For the "Remove" column */
a!gridLayoutHeaderCell(label: "" )
},
/* Only needed when some columns need to be narrow */
columnConfigs: {
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight:3 ),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight:3 ),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight:3 ),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight:3 ),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight:3 ),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight:2 ),
a!gridLayoutColumnConfig(width: "ICON")
},
/*
* a!forEach() will take local!employee data and used that data to loop through an
* expression that creates each row.
*
* When modifying the recipe to work with your data, you only need to change:
* 1.) the number of fields in each row
* 2.) the types of fields for each column (i.e. a!textField() for text data elements)
* 3.) the fv!item elements. For example fv!item.firstName would change to fv!item.yourdata
*/
rows: a!forEach(
items: local!employees,
expression: a!gridRowLayout(
contents: {
/* For the First Name Column*/
a!textField(
/* Labels are not visible in grid cells but are necessary to meet accessibility requirements */
label: "first name " & fv!index,
value: fv!item.firstName,
saveInto: fv!item.firstName,
required: true
),
/* For the Last Name Column*/
a!textField(
label: "last name " & fv!index,
value: fv!item.lastName,
saveInto: fv!item.lastName,
required:true
),
/* For the Department Column*/
a!dropdownField(
label: "department " & fv!index,
placeholder: "-- Select -- ",
choiceLabels: { "Corporate", "Engineering", "Finance", "Human Resources", "Professional Services", "Sales" },
choiceValues: { "Corporate", "Engineering", "Finance", "Human Resources", "Professional Services", "Sales" },
value: fv!item.department,
saveInto: fv!item.department,
required:true
),
/* For the Title Column*/
a!textField(
label: "title " & fv!index,
value: fv!item.title,
saveInto: fv!item.title,
required:true
),
/* For the Phone Number Column*/
a!textField(
label: "phone number " & fv!index,
placeholder:"555-456-7890",
value: fv!item.phoneNumber,
saveInto: fv!item.phoneNumber,
validations: if( len(fv!item.phoneNumber) > 12, "Contains more than 12 characters. Please reenter phone number, and include only numbers and dashes", null )
),
/* For the Start Date Column*/
a!dateField(
label: "start date " & fv!index,
value: fv!item.startDate,
saveInto: fv!item.startDate,
required:true,
validations: if( and( isnull(fv!item.id) , todate(fv!item.startDate) < today() ), "This Employee cannot have a start date before today.", null),
align: "RIGHT"
),
/* For the Removal Column*/
a!richTextDisplayField(
value: a!richTextIcon(
icon: "close",
altText: "delete " & fv!index,
caption: "Remove " & fv!item.firstName & " " & fv!item.lastName,
link: a!dynamicLink(
value: fv!index,
saveInto: {
a!save(local!employees, remove(local!employees, save!value))
}
),
linkStyle: "STANDALONE",
color: "NEGATIVE"
)
)
},
id: fv!index
)
),
addRowlink: a!dynamicLink(
label: "Add Employee",
/*
* For your use case, set the value to a blank instance of your CDT using
* the type constructor, e.g. type!Employee(). Only specify the field
* if you want to give it a default value e.g. startDate: today()+1.
*/
value: {startDate: today() + 1},
saveInto: {
a!save(local!employees, append(local!employees, save!value))
}
),
/* This validation prevents existing employee start date from changing to a date in the future*/
validations: if(
a!forEach(
items: local!employees,
expression: and( not( isnull( fv!item.id)), todate(fv!item.startDate) > today() )
),
"Existing Employees cannot have an effective start date beyond today",
null
),
rowHeader: 1
)
},
buttons: a!buttonLayout(
primaryButtons: a!buttonWidget(
label: "Submit",
submit: true
)
)
)
)
Notable implementation details.
The array of validations can contain either text or a validation message created with a!validationMessage(). Use the latter when you want the validation message to show up when the user clicks a submit button, or a validating button.
| Solve the following leet code problem |
Problem
Enforce that the user enters at least a certain number of characters in their text field, and also enforce that it contains the "@" character.
This scenario demonstrates:
How to configure multiple validations for a single component
Type fewer than 5 characters and click "Submit".
When testing offline, the form queues for submission but returns the validation messages when you go back online and the form attempts to submit.
Type more than 5 characters but no "@" and click "Submit".
When testing offline, the form queues for submission but returns the validation messages when you go back online and the form attempts to submit.
Type more than 5 characters and include "@" and click "Submit".
|
a!localVariables(
local!varA,
a!formLayout(
label: "Example: Multiple Validation Rules on One Component",
contents:{
a!textField(
label: "Text",
instructions: "Enter at least 5 characters, and include the @ character",
value: local!varA,
saveInto: local!varA,
validations: {
if(len(local!varA)>=5, null, "Enter at least 5 characters"),
if(isnull(local!varA), null, if(find("@", local!varA)<>0, null, "You need an @ character!"))
}
)
},
buttons: a!buttonLayout(
primaryButtons: a!buttonWidget(
label: "Submit",
submit: true
)
)
)
)
| Solve the following leet code problem |
Add and Populate Sections Dynamically
Add and populate a dynamic number of sections, one for each item in a CDT array.
Each section contains an input for each field of the CDT. A new entry is added to the CDT array as the user is editing the last section to allow the user to quickly add new entries without extra clicks. Sections can be independently removed by clicking on a "Remove" button. In the example below, attempting to remove the last section simply blanks out the inputs. Your own use case may involve removing the last section altogether.
| a)
Fill in the first field and notice that a new section is added as you're typing.
Add a few sections and click on the Remove button to remove items from the array
Notable Implementation Details
fv!isLast is being used to populate the instructions of the last text field as well as prevent the remove button from appearing in the last section.
a!localVariables(
/* A section will be created for every label value array present */
local!records: {'type!{http://www.appian.com/ae/types/2009}LabelValue'()},
{
a!forEach(
items: local!records,
expression: a!sectionLayout(
label: "Section " & fv!index,
contents: {
a!textField(
label: "Label",
instructions: if(
fv!isLast,
"Value of local!records: "&local!records,
{}
),
value: fv!item.label,
saveInto: {
fv!item.label,
if(
fv!isLast,
/* This value appends a new section array to section*/
a!save(local!records, append(local!records, cast(typeof(local!records), null))),
{}
)
},
refreshAfter: "KEYPRESS"
),
a!textField(
label: "Value",
value: fv!item.value,
saveInto: fv!item.value,
refreshAfter: "KEYPRESS"
),
a!buttonArrayLayout(
a!buttonWidget(
label: "Remove",
value: fv!index,
saveInto: {
a!save(local!records, remove(local!records, fv!index))
},
showWhen:not( fv!isLast )
)
)
}
)
)
}
)
b)
Offline
Since sections cannot be added dynamically when offline, you should include multiple sections initially in case they are needed. To support this use case for offline, we will create a different expression with a different supporting rule.
There are now 3 sections available to the user immediately.
Fill out some of the sections but leave others blank and submit the form.
Notice that null values are removed from the array and only non-null values are saved.
a!localVariables(
/* A section will be created for every label value array present */
local!records: { repeat(3, 'type!{http://www.appian.com/ae/types/2009}LabelValue'()) },
{
a!forEach(
items: local!records,
expression: a!sectionLayout(
label: "Section " & fv!index,
contents: {
a!textField(
label: "Label",
instructions: if(
fv!isLast,
"Value of local!records: "&local!records,
{}
),
value: fv!item.label,
saveInto: {
fv!item.label,
},
refreshAfter: "KEYPRESS"
),
a!textField(
label: "Value",
value: fv!item.value,
saveInto: fv!item.value,
refreshAfter: "KEYPRESS"
)
}
)
)
}
)
| Solve the following leet code problem |
Add, Edit, and Remove Data in an Inline Editable Grid
Allow the user to change data directly in an inline editable grid
This scenario demonstrates:
How to use the grid layout component to build an inline editable grid
How to allow users to add and remove rows in the grid
How to pass in a default value initially and while adding a new row
Edit values in an existing row.
Click the Add Employee link to insert a new row into the editable grid. Add values to that row.
Delete a row by clicking on the red X at the end of a row. Notice the remaining rows will adjust automatically.
Notable implementation detailsCopy link to clipboard
The component in each cell has a label, but the label isn't displayed. Labels and instructions aren't rendered within a grid cell. It is useful to enter a label for expression readability, and to help identify which cell has an expression error since the label is displayed in the error message. Labels are also necessary to meet accessibility requirements, so that a screen reader can properly parse the grid.
To keep track of which items are removed so that you can execute the Delete from Data Store Entity smart service for the removed items, see the Track Adds and Deletes in an Inline Editable Grid recipe.
| a!localVariables(
/*
* local!employess is provided in this recipe as a way to start with hard-coded
* data. However, this data is identical to the data created from the entity-backed
* tutorial. Replace the hard-coded data with a query to the employee data store
* entity and all of the employee records from the tutorial will appear.
*
* To replace this data with your own, replace (ctrl+H or cmd+H) all references to
* local!employees with your data source, either via rule input or local variable.
*/
local!employees: {
a!map( id: 1, firstName: "John" , lastName: "Smith" , department: "Engineering" , title: "Director" , phoneNumber: "555-123-4567" , startDate: today()-360 ),
a!map( id: 2, firstName: "Michael" , lastName: "Johnson" , department: "Finance" , title: "Analyst" , phoneNumber: "555-987-6543" , startDate: today()-360 ),
a!map( id: 3, firstName: "Mary", lastName: "Reed" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-456-0123" , startDate: today()-240 ),
},
a!formLayout(
label: "Example: Add,Update, or Remove Employee Data",
contents: {
a!gridLayout(
totalCount: count(local!employees),
headerCells: {
a!gridLayoutHeaderCell(label: "First Name" ),
a!gridLayoutHeaderCell(label: "Last Name" ),
a!gridLayoutHeaderCell(label: "Department" ),
a!gridLayoutHeaderCell(label: "Title" ),
a!gridLayoutHeaderCell(label: "Phone Number" ),
a!gridLayoutHeaderCell(label: "Start Date", align: "RIGHT" ),
/* For the "Remove" column */
a!gridLayoutHeaderCell(label: "" )
},
/* Only needed when some columns need to be narrow */
columnConfigs: {
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight:3 ),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight:3 ),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight:3 ),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight:3 ),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight:3 ),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight:2 ),
a!gridLayoutColumnConfig(width: "ICON")
},
/*
* a!forEach() will take local!employee data and used that data to loop through an
* expression that creates each row.
*
* When modifying the recipe to work with your data, you only need to change:
* 1.) the number of fields in each row
* 2.) the types of fields for each column (i.e. a!textField() for text data elements)
* 3.) the fv!item elements. For example fv!item.firstName would change to fv!item.yourdata
*/
rows: a!forEach(
items: local!employees,
expression: a!gridRowLayout(
contents: {
/* For the First Name Column*/
a!textField(
/* Labels are not visible in grid cells but are necessary to meet accessibility requirements */
label: "first name " & fv!index,
value: fv!item.firstName,
saveInto: fv!item.firstName,
required: true
),
/* For the Last Name Column*/
a!textField(
label: "last name " & fv!index,
value: fv!item.lastName,
saveInto: fv!item.lastName,
required:true
),
/* For the Department Column*/
a!dropdownField(
label: "department " & fv!index,
placeholder: "-- Select -- ",
choiceLabels: { "Corporate", "Engineering", "Finance", "Human Resources", "Professional Services", "Sales" },
choiceValues: { "Corporate", "Engineering", "Finance", "Human Resources", "Professional Services", "Sales" },
value: fv!item.department,
saveInto: fv!item.department,
required:true
),
/* For the Title Column*/
a!textField(
label: "title " & fv!index,
value: fv!item.title,
saveInto: fv!item.title,
required:true
),
/* For the Phone Number Column*/
a!textField(
label: "phone number " & fv!index,
placeholder:"555-456-7890",
value: fv!item.phoneNumber,
saveInto: fv!item.phoneNumber
),
/* For the Start Date Column*/
a!dateField(
label: "start date " & fv!index,
value: fv!item.startDate,
saveInto: fv!item.startDate,
required:true,
align: "RIGHT"
),
/* For the Removal Column*/
a!richTextDisplayField(
value: a!richTextIcon(
icon: "close",
altText: "delete " & fv!index,
caption: "Remove " & fv!item.firstName & " " & fv!item.lastName,
link: a!dynamicLink(
value: fv!index,
saveInto: {
a!save(local!employees, remove(local!employees, save!value))
}
),
linkStyle: "STANDALONE",
color: "NEGATIVE"
)
)
},
id: fv!index
)
),
addRowlink: a!dynamicLink(
label: "Add Employee",
/*
* For your use case, set the value to a blank instance of your CDT using
* the type constructor, e.g. type!Employee(). Only specify the field
* if you want to give it a default value e.g. startDate: today()+1.
*/
value: {
startDate: today() + 1
},
saveInto: {
a!save(local!employees, append(local!employees, save!value))
}
),
rowHeader: 1
)
},
buttons: a!buttonLayout(
primaryButtons: a!buttonWidget(
label: "Submit",
submit: true
)
)
)
)
| Solve the following leet code problem |
Add, Remove, and Move Group Members Browser
Problem
Display the membership tree for a given group and provide users with the ability to add, remove, and move user members from a single interface.
|
Expression
Once you have created your groups and users, you will be ready to begin constructing the interface and process by following the steps below:
From the application, create a new interface called EX_addMoveRemoveUsers with the following inputs:
ri!initialGroup (Group) - the group whose direct members display in the first column of the browser, necessary to re-initialize the component after submittal.
ri!navigationPath (User or Group array) - the navigation path that the user was seeing when the form was submitted, necessary to re-initialize the component after submittal.
ri!usersToAdd (User Array) - the users to add as members to the ri!addedToGroup.
ri!addedToGroup (Group) - the chosen group to add users to.
ri!userToRemove (User) - the chosen user for the remove action.
ri!removeFromGroup (Group) - the group from which the ri!userToRemove is being removed.
ri!userToMove (User) - the chosen user for the move action.
ri!moveFromGroup (Group) - the chosen group to move the ri!userToMove from.
ri!moveToGroup (Group) - the chosen group to move the ri!userToMove to.
ri!btnAction (Text) - determines flow of the process. Can be "ADD", "REMOVE", or "MOVE".
Copy the following text into the expression view of EX_addMoveRemoveUsers :
a!localVariables(
local!selectionValue,
local!isUserSelected: runtimetypeof(local!selectionValue) = 'type! {http://www.appian.com/ae/types/2009}User',
local!actionTaken: if(
isnull(ri!btnAction),
false,
or(ri!btnAction = "ADD", ri!btnAction = "MOVE")
),
local!navigationLength: if(
isnull(ri!navigationPath),
0,
length(ri!navigationPath)
),
a!formLayout(
label: "Manage Group Membership",
contents: {
/*
If you use this as a related action, rather than using this picker
to choose the inital group, you would pass it in as context for
the action.
*/
a!pickerFieldGroups(
label: "Select a group to view its members",
maxSelections: 1,
value: ri!initialGroup,
saveInto: {
ri!initialGroup,
a!save(
{
ri!btnAction,
ri!userToRemove,
ri!userToMove,
ri!addedToGroup,
ri!removeFromGroup,
ri!navigationPath,
ri!moveFromGroup,
ri!moveToGroup,
ri!usersToAdd,
local!selectionValue
},
null
)
}
),
a!sectionLayout(
showWhen: not(isnull(ri!initialGroup)),
label: group(ri!initialGroup, "groupName") & " Group Members",
contents: {
a!buttonArrayLayout(
buttons: {
a!buttonWidget(
label: "Add Members",
disabled: or(
local!actionTaken,
local!navigationLength = 0
),
value: "ADD",
saveInto: {
ri!btnAction,
a!save(
ri!addedToGroup,
if(
/*
If the user has not navigated anywhere, or
the user has clicked on a user in the first column,
save the intial group
*/
or(
local!navigationLength = 0,
and(local!navigationLength = 1, local!isUserSelected)
),
ri!initialGroup,
if(
/* If a user is selected save the last group in the path */
local!isUserSelected,
togroup(ri!navigationPath[local!navigationLength - 1])
/* Otherwise save the end of the path */
togroup(ri!navigationPath[local!navigationLength])
)
)
)
}
),
a!buttonWidget(
label: "Remove Member",
value: "REMOVE",
saveInto: {
ri!btnAction,
a!save(ri!userToRemove, local!selectionValue),
/*
Since a user needs to be removed from a group, the button
needs to determine what group the user should be removed from.
*/
a!save(
ri!removeFromGroup,
if(
/* If the user is on the first column, save the initial group */
local!navigationLength = 1,
ri!initialGroup,
/* Otherwise save the group containing the selected user */
ri!navigationPath[local!navigationLength - 1]
)
),
/*
This navigation path will be used to pre-populate the group browser
when the user returns to this interface after the selected user has
been removed. Therefore, we must remove the selected user from the
navigation path to prevent an error.
*/
a!save(ri!navigationPath, rdrop(ri!navigationPath, 1))
},
disabled: or(local!actionTaken, not(local!isUserSelected)),
submit: true
),
a!buttonWidget(
label: "Move Member",
style: "OUTLINE",
disabled: or(local!actionTaken, not(local!isUserSelected)),
value: "MOVE",
saveInto: {
ri!btnAction,
a!save(ri!userToMove, local!selectionValue),
/*
Since a user needs to be removed from a group, the button
needs to determine what group the user should be removed from.
*/
a!save(
ri!moveFromGroup,
if(
/* If the user is in the first column save the initial group. */
local!navigationLength = 1,
ri!initialGroup,
/* Otherwise save the last group in the navigation path */
ri!navigationPath[local!navigationLength - 1]
)
),
a!save(ri!navigationPath, rdrop(ri!navigationPath, 1)),
a!save(ri!moveToGroup, ri!moveFromGroup)
}
)
}
),
/*
After selecting a member to move, the interface needs to allow the
user to select a group to move the member to. To limit what can
be selected to a group and not a user, we switch the component
to a group browser
*/
a!groupBrowserFieldColumns(
labelPosition: "COLLAPSED",
showWhen: ri!btnAction = "MOVE",
rootGroup: ri!initialGroup,
pathValue: ri!navigationPath,
pathSaveInto: ri!navigationPath,
selectionValue: ri!moveToGroup,
selectionSaveInto: ri!moveToGroup
),
/*
Unless the user is in the process of moving members,
the user has the option to select a user to move or remove
or a group to add members to.
*/
a!userAndGroupBrowserFieldColumns(
labelPosition: "COLLAPSED",
showWhen: not(ri!btnAction = "MOVE"),
rootGroup: ri!initialGroup,
pathValue: ri!navigationPath,
pathSaveInto: ri!navigationPath,
selectionValue: local!selectionValue,
selectionSaveInto: local!selectionValue,
readOnly: or(
ri!btnAction = "ADD",
ri!btnAction = "REMOVE"
)
),
/*
Navigation cannot be cleared without configuration, so
this link lets the user add members to the initial group.
*/
a!linkField(
labelPosition: "COLLAPSED",
showWhen: not( local!actionTaken),
links: {
a!dynamicLink(
label: "+ Add Users to " & group(ri!initialGroup, "groupName"),
value: "ADD",
saveInto: {
ri!btnAction,
a!save(ri!addedToGroup, ri!initialGroup)
}
)
}
)
}
),
a!sectionLayout(
label: "Add Users to " & group(ri!addedToGroup, "groupName"),
showWhen: ri!btnAction = "ADD",
contents: {
a!pickerFieldUsers(
label: "Users to Add",
value: ri!usersToAdd,
saveInto: a!save(ri!usersToAdd, getdistinctusers(save!value)),
required: true
)
}
),
a!sectionLayout(
label: "Move User",
showWhen: ri!btnAction = "MOVE",
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
"Move ",
a!richTextItem(
text: user(ri!userToMove, "firstName") & " " & user(ri!userToMove, "lastName"),
style: "STRONG"
),
" from ",
a!richTextItem(
text: group(ri!moveFromGroup, "groupName"),
style: "STRONG"
),
" to"
},
readOnly: true
),
a!pickerFieldGroups(
labelPosition: "COLLAPSED",
groupFilter: ri!initialGroup,
value: ri!moveToGroup,
saveInto: ri!moveToGroup,
required: true
)
}
),
a!buttonLayout(
showWhen: local!actionTaken,
primaryButtons: {
a!buttonWidget(
label: if(ri!btnAction = "ADD", "Add Users", "Move User"),
style: "SOLID",
disabled: if(
ri!btnAction = "MOVE",
or(ri!moveFromGroup = ri!moveToGroup, isnull(ri!moveToGroup)),
if(isnull(ri!usersToAdd), true, length(ri!usersToAdd) = 0)
),
submit: true
)
},
secondaryButtons: {
/*
Allows the user to cancel the selected action. If the user
cancels out of the action, we need to clear all the
selection variables
*/
a!buttonWidget(
label: "Cancel",
style: "OUTLINE",
showWhen: local!actionTaken,
value: null,
saveInto: {
ri!btnAction,
ri!userToMove,
ri!userToRemove,
ri!addedToGroup,
ri!removeFromGroup,
ri!moveFromGroup,
ri!moveToGroup,
ri!usersToAdd,
local!selectionValue
}
)
}
)
},
buttons: a!buttonLayout(
primaryButtons: {
a!buttonWidget(
label: "Close",
value: "CLOSE",
saveInto: ri!btnAction,
submit: true,
validate: false
)
}
)
)
)
Notable expression detailsCopy link to clipboard
The comments in the expression above point out many difficult concepts in this recipe. Some of the most important to note are listed below:
When managing group membership in process, keep track of the navigation path. This allows you to reinitialize the browser where the user left off, creating the feeling that the user never leaves the form. At the same time, you must be sure that the navigation path does not become invalidated due to altered group membership. In the example above, if a user is removed from a groups membership, it is also removed from the navigation path.
To extract the parent of the selected value from the path, use the following expression :
if(
length(ri!navigationPath) = 1,
ri!initialGroup,
togroup(ri!navigationPath[length(ri!navigationPath) - 1])
)
If using a user & group browser, use the runtimetypeof() combined with 'type!User' and 'type!Group' to determine what type of value is selected.
If using the recipe for a related action, pass the initial group in the related action context and remove the group picker from the interface
Getting the interface into a process model :
To be able move group members, we need to use a process. We will continue this recipe by:
Create a new process model named Manage Group Members.
Add a new user input task, labeled Manage Group Members, connecting it to the start node. Make the connection an activity chain.
Set this as a user input task rather than a start form so that you can loop back to it.
On the Forms tab, enter the name of your EX_addMoveRemoveUsers interface in the search box and select it.
Click Yes when the Process Modeler asks, "Do you want to import the rule inputs?". This will create node inputs.
On the Data Tab, for each activity class variable, add a duplicate process variable to save the activity class variable.
For initialGroup, set the corresponding process variable as the input value.
For navigationPath, set the corresponding process variable as the input value.
Assign the task to the process initiator.
To create a decision:
Create a new XOR node below the input task and name it Do What? Connect the two with an activity chain.
Move the end node to the left of the XOR, and connect the two.
Now you can start to actually build the nodes that handle the actions.
To build the nodes connected to the gateway:
Create three new sets of nodes, stemming from the gateway. Activity chain all connections going forward.
Add Add Group Members and do not change the name.
Add Remove Group Members and change the name to Remove Group Member.
Add Add Group Members and Remove Group Members and connect them.
Change the names to Add Group Member for Move and Remove Group Member for Move, respectively.
Connect Add Group Members, Remove Group Member, and Remove Group Member for Move back to Manage Group Membership, and activity chain the connections.
At this point, your process should look something like this:
Configure the Do What? logic:
If pv!btnAction = "ADD" is True, then go to Add Group Member.
Else If pv!btnAction = "REMOVE" is True, then go to Remove Group Member.
Else If pv!btnAction = "MOVE" is True, then go to Add Group Member for Move.
Else if none are true, go to End Node.
To configure the remaining nodes in the process model and publish as an action:
In Add Group Member:
Set Choose New Members to pv!usersToAdd.
Set Choose Group to pv!addToGroup.
In Remove Group Member:
Set Choose Members to pv!userToRemove.
Set Group to pv!removeFromGroup.
In Move to Group:
Set Choose New Members to pv!userToMove.
Set Choose Group to pv!moveToGroup.
In Move from Group:
Set Choose Members to pv!userToMove.
Set Group to pv!moveFromGroup.
Save & Publish the process model.
From the application, click Settings, then Application Actions.
Add the process model Manage Group Members as an action called Manage Group Members.
Publish your application.
Test it outCopy link to clipboard
At this point, you are ready to manage your groups membership.
To try it out:
Go to the actions tab, click on your new Manage Group Members action.
Click on a group and click Add Members.
In the picker, type in names of users, and click Add Users to submit the form. You should be brought back to the interface, and the users should now appear as members of the group.
Click on one of the new users.
Click Remove Member. The user should no longer be a member of the group.
Click on another user
Click Move Member.
Click on another group or type a group name in the picker. Click Move User to confirm. The user should now be moved.
| Solve the following leet code problem |
Aggregate data and conditionally display it in a pie chart or grid.
In this pattern, we will calculate the total number of employees in each department and display it in a pie chart and a read-only grid. Then, we'll use a link field to conditionally display each component.
This design pattern is not recommended for offline interfaces because reflecting immediate changes in an interface based on user interaction requires a connection to the server.
This scenario demonstrates:
How to use a link to switch between two different interface components.
How to aggregate on two dimensions
| a!localVariables(
/* This variable is set to true initially and is referenced in the showWhen parameters for
the pie chart and inversely in the grid. The dynamic link at the end reverses this value
on click. */
local!displayAsChart: true,
/* Since we want to pass the data to the pie chart and the grid, we query for the data in
a local variable. Otherwise, we would just query directly from the data parameter of
the gridField(). */
local!datasubset: a!queryRecordType(
recordType: recordType!Employee,
fields: a!aggregationFields(
groupings: a!grouping(
field: recordType!Employee.fields.department,
alias: "department"
),
measures: a!measure(
field: recordType!Employee.fields.id,
function: "COUNT",
alias: "id_count"
)
),
pagingInfo: a!pagingInfo(startIndex: 1, batchSize: 5000)
),
{
a!pieChartField(
series: {
a!forEach(
items: local!datasubset.data,
expression: a!chartSeries(
label: fv!item.department,
data: fv!item.id_count
)
)
},
colorScheme: "BERRY",
style: "DONUT",
seriesLabelStyle: "LEGEND",
/* Since the initial value is true, the pie chart displays on load. We could change
the initial value of local!displayAsChart to swap that behavior without having to
otherwise change the logic of this interface. */
showWhen: local!displayAsChart
),
a!gridField(
data: local!datasubset.data,
columns: {
a!gridColumn(
label: "Department",
sortField: "department",
value: fv!row.department
),
a!gridColumn(
label: "Total",
sortField: "id_count",
value: fv!row.id_count
)
},
/* Here the grid only shows when local!displayAsChart is not true. */
showWhen: not(local!displayAsChart),
rowHeader: 1
),
a!linkField(
labelPosition: "COLLAPSED",
links: a!dynamicLink(
label: "Show as " & if(local!displayAsChart, "Grid", "Chart"),
/* The not() function simply converts a true to false, or false to true, which
simplifies the toggle behavior. */
value: not(local!displayAsChart),
saveInto: local!displayAsChart
),
align: "CENTER"
)
}
)
| Solve the following leet code problem |
Aggregate Data and Display in a Chart
This expression uses direct references to the Employee record type, created in the Records Tutorial. If you've completed that tutorial in your environment, you can change the existing record-type references in this pattern to point to your Employee record type instead.
https://docs.appian.com/suite/help/24.1/Records_Tutorial.html
This scenario demonstrates:
How to aggregate data and display in a pie chart
|
Create this pattern
You can easily create this pattern in design mode when you use a record type as the source of your chart.
To create this pattern in design mode:
Open a new or empty interface object.
From the PALETTE, drag a Pie Chart component into the interface.
From Data Source, select RECORD TYPE and search for the Employee record type.
Under Primary Grouping, select the department field.
Under Measure, use the dropdown to select Count of, then select the id field.
Under Style, use the dropdown to select Pie.
{
a!pieChartField(
data: recordType!Employee,
config: a!pieChartConfig(
primaryGrouping: a!grouping(
field: recordType!Employee.fields.department,
alias: "department_primaryGrouping"
),
measures: {
a!measure(
function: "COUNT",
field: recordType!Employee.fields.id,
alias: "id_count_measure1"
)
},
dataLimit: 100
),
label: "Pie Chart",
labelPosition: "ABOVE",
colorScheme: "CLASSIC",
style: "PIE",
seriesLabelStyle: "ON_CHART",
height: "MEDIUM",
refreshAfter: "RECORD_ACTION"
)
}
| Solve the following leet code problem |
Aggregate data by multiple fields and display it in a stacked column chart. In this pattern, we will calculate the total number of employees for each title in each department and display it in a stacked column chart.
How to aggregate data by multiple fields and display in a column chart
| a)
To create this pattern in design mode:
https://docs.appian.com/suite/help/24.1/Chart_Configuration_Using_Records.html
Open a new or empty interface object.
From the PALETTE, drag a Column Chart component into the interface.
From Data Source, select RECORD TYPE and search for the Employee record type.
Under Primary Grouping, select the department field.
Click ADD GROUPING.
Under Secondary Grouping, select the title field.
Under Measure, use the dropdown to select Count of, then select the id field.
From Stacking, select Normal.
For the X-Axis Title, enter Department.
For the Y-Axis Title, enter Number of Employees.
b)
a!columnChartField(
data: recordType!Employee,
config: a!columnChartConfig(
primaryGrouping: a!grouping(
field: recordType!Employee.fields.department,
alias: "department_primaryGrouping"
),
secondaryGrouping: a!grouping(
field: recordType!Employee.fields.title,
alias: "title_secondaryGrouping"
),
measures: {
a!measure(
function: "COUNT",
field: recordType!Employee.fields.id,
alias: "id_count_measure1"
)
},
dataLimit: 100
),
label: "Column Chart",
xAxisTitle: "Department",
yAxisTitle: "Number of Employees",
stacking: "NORMAL",
showLegend: true,
showTooltips: true,
labelPosition: "ABOVE",
colorScheme: "CLASSIC",
height: "MEDIUM",
xAxisStyle: "STANDARD",
yAxisStyle: "STANDARD"
)
| Solve the following leet code problem |
Aggregate Data on a Date or Date and Time Field
Aggregate data, specifically the total number of employees by date.
|
a)
To create this pattern in design mode:
Open a new or empty interface object.
From the PALETTE, drag a Bar Chart component into the interface.
From Data Source, select RECORD TYPE and search for the Employee record type.
Under Primary Grouping, select the startDate field.
Click the edit icon next to the selected field and set Time Interval to Month of Year.
Under Format Value, use the dropdown to choose a pre-defined format. Select the short text date.
Click Bar Chart to return to the bar chart configuration.
Click ADD GROUPING.
Under Secondary Grouping, select the department field.
Under Measure, use the dropdown to select Count of, then select the id field.
From Stacking, select Normal.
From Color Scheme, select Ocean.
b)
a!barChartField(
data: recordType!Employee,
config: a!barChartConfig(
primaryGrouping: a!grouping(
field: recordType!Employee.fields.startDate,
alias: "startDate_month_of_year_primaryGrouping",
interval: "MONTH_OF_YEAR_SHORT_TEXT"
),
secondaryGrouping: a!grouping(
field: recordType!Employee.fields.department,
alias: "department_secondaryGrouping"
),
measures: {
a!measure(
function: "COUNT",
field: recordType!Employee.fields.id,
alias: "id_count_measure1"
)
},
dataLimit: 100
),
label: "Bar Chart",
labelPosition: "ABOVE",
stacking: "NORMAL",
showLegend: true,
showTooltips: true,
colorScheme: "OCEAN",
height: "MEDIUM",
xAxisStyle: "STANDARD",
yAxisStyle: "STANDARD"
)
| Solve the following leet code problem |
Aggregate Data using a Filter and Display in a Chart
Aggregate data, specifically the total number of employees for each title in the Engineering department, to display in a bar chart.
This scenario demonstrates:
How to aggregated data and display it in a bar chart
How to filter the bar chart
| a)
To create this pattern in design mode:
Open a new or empty interface object.
From the PALETTE, drag a Bar Chart component into the interface.
From Data Source, select RECORD TYPE and search for the Employee record type.
Under Primary Grouping, select the title field.
Under Measure, use the dropdown to select Count of, then select the id field.
Click the edit icon next to the measure.
Under Label, enter Total.
Return to the Bar Chart configuration and click FILTER RECORDS.
Under Field, use the dropdown to select the department field.
Under Condition, use the dropdown to select equal to.
Under Value, enter Engineering.
Click OK.
b)
{
a!barChartField(
data: a!recordData(
recordType: recordType!Employee,
filters: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: recordType!Employee.fields.department,
operator: "=",
value: "Engineering"
)
},
ignoreFiltersWithEmptyValues: true
)
),
config: a!barChartConfig(
primaryGrouping: a!grouping(
field: recordType!Employee.fields.title,
alias: "title_primaryGrouping"
),
measures: {
a!measure(
label: "Total",
function: "COUNT",
field: recordType!Employee.fields.id,
alias: "id_count_measure1"
)
},
dataLimit: 100
),
label: "Bar Chart",
labelPosition: "ABOVE",
stacking: "NONE",
showLegend: true,
showTooltips: true,
colorScheme: "OCEAN",
height: "MEDIUM",
xAxisStyle: "STANDARD",
yAxisStyle: "STANDARD",
refreshAfter: "RECORD_ACTION"
)
}
Notable implementation details:
The expression for the filter is being passed into the filters parameter of a!recordData(). Learn more about this function.
In the final expression, the chart color scheme "OCEAN" has been added. You can change the color scheme or create your own custom color scheme.
| Solve the following leet code problem |
Display a hierarchical data browser.
This design pattern is not recommended for offline interfaces because reflecting immediate changes in an interface based on user interaction requires a connection to the server.
This columns browser shows regions, account executives located in each region, and the customers associated with each account executive. Regions, account executives, and customers each have a different display configuration.
This scenario demonstrates:
How to display data in a columns browser
How to dynamically retrieve data for each column depending on the level of the hierarchy
How to dynamically configure the display of each node depending on the type of data displayed in the hierarchy
|
Setup
For this recipe, you'll need a hierarchical data set. Create the following three custom data types with corresponding fields.
EXAMPLE_Region
id (Number (Integer))
name (Text)
EXAMPLE_AccountExec
id (Number (Integer))
firstName (Text)
lastName (Text)
regionId (Number (Integer))
EXAMPLE_Customer
id (Number (Integer))
name (Text)
accountExecId (Number (Integer))
These data types have a hierarchical relationship. Note how EXAMPLE_AccountExec has a field for region and EXAMPLE_Customer has a field for account executive.
Sail code :
a!localVariables(
/*
This is sample data for the recipe. In your columns browser component,
you'll use data from other sources, like records or entities.
*/
local!regions:{
'type!{urn:com:appian:types}EXAMPLE_Region'( id: 1, name: "North America" ),
'type!{urn:com:appian:types}EXAMPLE_Region'( id: 2, name: "South America" ),
'type!{urn:com:appian:types}EXAMPLE_Region'( id: 3, name: "EMEA" ),
'type!{urn:com:appian:types}EXAMPLE_Region'( id: 4, name: "APAC" )
},
local!accountExecs:{
'type!{urn:com:appian:types}EXAMPLE_AccountExec'( id: 1, firstName: "Susan", lastName: "Taylor", regionId: 1 ),
'type!{urn:com:appian:types}EXAMPLE_AccountExec'( id: 2, firstName: "Sharon", lastName: "Hill", regionId: 3 ),
'type!{urn:com:appian:types}EXAMPLE_AccountExec'( id: 3, firstName: "Kevin", lastName: "Singh", regionId: 2 ),
'type!{urn:com:appian:types}EXAMPLE_AccountExec'( id: 4, firstName: "Daniel", lastName: "Lewis", regionId: 3 )
},
local!customers:{
'type!{urn:com:appian:types}EXAMPLE_Customer'( id: 1, name: "Lebedev", accountExecId: 2 ),
'type!{urn:com:appian:types}EXAMPLE_Customer'( id: 2, name: "Parsec Express", accountExecId: 3 ),
'type!{urn:com:appian:types}EXAMPLE_Customer'( id: 3, name: "Dengar Dynamics", accountExecId: 2 ),
'type!{urn:com:appian:types}EXAMPLE_Customer'( id: 4, name: "Almach", accountExecId: 1 )
},
local!path,
local!selection,
a!sectionLayout(
contents:{
a!hierarchyBrowserFieldColumns(
label: "Interface Recipe: Columns Browser",
/*
This data comes from a local variable for the recipe. Substitute your
rule here when you make your own columns browser component.
*/
firstColumnValues: local!regions,
/*
This is where you specify how a node appears in the browser given
its type. If the node is a region, show the name field. If the node
is an account executive, show the first name and last name fields.
*/
nodeConfigs: if(
typeof(fv!nodeValue) = 'type!{urn:com:appian:types}EXAMPLE_Region',
a!hierarchyBrowserFieldColumnsNode(
id: fv!nodeValue.id,
label: fv!nodeValue.name,
image: a!documentImage(document: a!iconIndicator("HARVEY_0"))
),
if(
typeof(fv!nodeValue) = 'type!{urn:com:appian:types}EXAMPLE_AccountExec',
a!hierarchyBrowserFieldColumnsNode(
id: fv!nodeValue.id,
label: fv!nodeValue.firstName & " " & fv!nodeValue.lastName,
image: a!documentImage(document: a!iconIndicator("HARVEY_50"))
),
if(
typeof(fv!nodeValue)='type!{urn:com:appian:types}EXAMPLE_Customer',
a!hierarchyBrowserFieldColumnsNode(
id: fv!nodeValue.id,
label: fv!nodeValue.name,
image: a!documentImage(document: a!iconIndicator("HARVEY_100")),
isDrillable: false
),
{}
)
)
),
pathValue: local!path,
pathSaveInto: local!path,
nextColumnValues: if(
/*
Check to see if the node is a region. If so, look up account
executives for that region. Substitute your type and rule here.
*/
typeof(fv!nodeValue)='type!{urn:com:appian:types}EXAMPLE_Region',
index(local!accountExecs, wherecontains(fv!nodeValue.id, local!accountExecs.regionId), {}),
if(
/*
Check to see if the node is an account executive. If so, look up customers
for that account executive. Substitute your type and rule here.
*/
typeof(fv!nodeValue)='type!{urn:com:appian:types}EXAMPLE_AccountExec',
index(local!customers, wherecontains(fv!nodeValue.id, local!customers.accountExecId), {}),
{}
)
),
selectionValue: local!selection,
selectionSaveInto: local!selection,
height: "SHORT"
),
a!textField(
label: "path",
instructions: typename(typeof(local!path)),
value: local!path,
readOnly: true
),
a!textField(
label: "selection",
instructions: typename(typeof(local!selection)),
value: local!selection,
readOnly: true
)
}
)
)
The data provided here is loaded into local variables. Refer to the comments in the example interface to substitute your own data and queries. For heterogenous data sets like this example, remember to specify how each type should retrieve its next column values and how each type should be displayed.
The images shown in this example are simple icons configured with a!iconIndicator. You can use this function or provide different document or web images. Choose icons that makes sense for your data to create a compelling visual experience in your interfaces.
nodeConfigs is configured using a!hierarchyBrowserFieldColumnsNode(). This determines how items in the hierarchy are displayed. In this snippet, it determines how regions are displayed.
nextColumnValues determines what appears in the next column based on the type of the current node, fv!nodeValue.
The customer nodes are configured not to be drillable because we know that this column is the end of the hierarchy.
| Solve the following leet code problem |
Build a Wizard with Milestone Navigation
Use the milestone component to show steps in a wizard.
Configure links for each step in the milestone so that the user can move forward or return to any step.
This scenario demonstrates:
How to create a wizard using the showWhen parameter of an interface component
How to use a milestone field to show the current step of the wizard
How to show and change the style of buttons
| a!localVariables(
local!employee:a!map( firstName:null, lastName:null, department:null, title:null, phoneNumber:null, startDate:null ),
local!currentStep: 1,
local!steps: {"Step 1", "Step 2", "Review"},
a!formLayout(
label: "Example: Onboarding Wizard",
contents:{
a!sectionLayout(
contents:{
a!milestoneField(
steps: local!steps,
active: local!currentStep
)
}
),
a!sectionLayout(
contents:{
a!columnsLayout(
columns:{
a!columnLayout(
contents:{
a!textField(
label: "First Name",
labelPosition: if( local!currentStep = 3, "ADJACENT","ABOVE"),
value: local!employee.firstName,
saveInto: local!employee.firstName,
readOnly: local!currentStep = 3,
required: not(local!currentStep = 3),
showWhen: or( local!currentStep = {1,3} )
),
a!textField(
label: "Last Name",
labelPosition: if( local!currentStep = 3, "ADJACENT","ABOVE"),
value: local!employee.lastName,
saveInto: local!employee.lastName,
readOnly: local!currentStep = 3,
required: not(local!currentStep = 3),
showWhen: or( local!currentStep = {1,3} )
),
a!textField(
label: "Phone Number",
labelPosition: if( local!currentStep = 3, "ADJACENT","ABOVE"),
value: local!employee.phoneNumber,
saveInto: local!employee.phoneNumber,
readOnly: local!currentStep = 3,
required: not(local!currentStep = 3),
showWhen: or( local!currentStep = {2,3} )
)
}
),
a!columnLayout(
contents:{
a!textField(
label: "Department",
labelPosition: if( local!currentStep = 3, "ADJACENT","ABOVE"),
value: local!employee.department,
saveInto: local!employee.department,
readOnly: local!currentStep = 3,
required: not(local!currentStep = 3),
showWhen: or( local!currentStep = {1,3} )
),
a!textField(
label: "Title",
labelPosition: if( local!currentStep = 3, "ADJACENT","ABOVE"),
value: local!employee.title,
saveInto: local!employee.title,
readOnly: local!currentStep = 3,
required: not(local!currentStep = 3),
showWhen: or( local!currentStep = {1,3} )
),
a!dateField(
label: "Start Date",
labelPosition: if( local!currentStep = 3, "ADJACENT","ABOVE"),
value: local!employee.startDate,
saveInto: local!employee.startDate,
readOnly: local!currentStep = 3,
required: not(local!currentStep = 3),
showWhen: or( local!currentStep = {2,3} )
)
}
)
}
)
}
)
},
buttons: a!buttonLayout(
primaryButtons: {
a!buttonWidget(
label: "Go Back",
value: local!currentStep - 1,
saveInto: local!currentStep,
showWhen: or( local!currentStep = {2,3} )
),
a!buttonWidget(
label: if( local!currentStep = 1, "Next", "Go to Review"),
value: local!currentStep + 1,
saveInto: local!currentStep,
validate: true,
showWhen: or( local!currentStep = {1,2} )
),
a!buttonWidget(
label: "Onboard Employee",
style: "SOLID",
submit: true,
showWhen: local!currentStep = 3
)
}
)
)
)
Notable Implementation Details
The showWhen parameter is used extensively to conditionally show particular fields as well as set requiredness & read only setting.
Each "Next" button is configured to increment local!currentStep. Validate is set to true, which ensures all fields are required before continuing on to the next step.
Each "Go Back" button is not configured to enforce validation. This allows the user to go to a previous step even if the current step has null required fields and other invalid fields. This button also decrements local!currentStep by one.
The milestone field is configured without links, however links could be added that navigate a user back to a particular step.
| Solve the following leet code problem |
Build an Interface Wizard
Divide a big form into sections presented one step at a time with validation.
Wizards should be used to break up a large form into smaller steps rather than activity-chaining. Users can step back and forth within a wizard without losing data in between steps.
All the fields must be valid before the user is allowed to move to the next steps. However, the user is allowed to move to a previous step even if the fields in the current step aren't valid. The last step in the wizard is a confirmation screen.
This scenario demonstrates:
How to create a wizard using the showWhen parameter of an interface component
How to conditionally set readOnly and required on an interface component
How to show and change the style of buttons
| SAIL code:
a!localVariables(
local!employee:a!map( firstName:null, lastName:null, department:null, title:null, phoneNumber:null, startDate:null ),
local!currentStep: 1,
a!formLayout(
label: "Example: Onboarding Wizard",
contents:{
a!columnsLayout(
columns:{
a!columnLayout(
contents:{
a!textField(
label: "First Name",
labelPosition: if( local!currentStep = 3, "ADJACENT","ABOVE"),
value: local!employee.firstName,
saveInto: local!employee.firstName,
readOnly: local!currentStep = 3,
required: not( local!currentStep = 3),
showWhen: or( local!currentStep = {1,3} )
),
a!textField(
label: "Last Name",
labelPosition: if( local!currentStep = 3, "ADJACENT","ABOVE"),
value: local!employee.lastName,
saveInto: local!employee.lastName,
readOnly: local!currentStep = 3,
required: not( local!currentStep = 3),
showWhen: or( local!currentStep = {1,3} )
),
a!textField(
label: "Phone Number",
labelPosition: if( local!currentStep = 3, "ADJACENT","ABOVE"),
value: local!employee.phoneNumber,
saveInto: local!employee.phoneNumber,
readOnly: local!currentStep = 3,
required: not( local!currentStep = 3),
showWhen: or( local!currentStep = {2,3} )
)
}
),
a!columnLayout(
contents:{
a!textField(
label: "Department",
labelPosition: if( local!currentStep = 3, "ADJACENT","ABOVE"),
value: local!employee.department,
saveInto: local!employee.department,
readOnly: local!currentStep = 3,
required: not( local!currentStep = 3),
showWhen: or( local!currentStep = {1,3} )
),
a!textField(
label: "Title",
labelPosition: if( local!currentStep = 3, "ADJACENT","ABOVE"),
value: local!employee.title,
saveInto: local!employee.title,
readOnly: local!currentStep = 3,
required: not( local!currentStep = 3),
showWhen: or( local!currentStep = {1,3} )
),
a!dateField(
label: "Start Date",
labelPosition: if( local!currentStep = 3, "ADJACENT","ABOVE"),
value: local!employee.startDate,
saveInto: local!employee.startDate,
readOnly: local!currentStep = 3,
required: not( local!currentStep = 3),
showWhen: or( local!currentStep = {2,3} )
)
}
)
}
)
},
buttons: a!buttonLayout(
primaryButtons: {
a!buttonWidget(
label: "Go Back",
value: local!currentStep - 1,
saveInto: local!currentStep,
showWhen: or( local!currentStep = {2,3} )
),
a!buttonWidget(
label: if( local!currentStep = 1, "Next", "Go to Review"),
value: local!currentStep + 1,
saveInto: local!currentStep,
validate: true,
showWhen: or( local!currentStep = {1,2} )
),
a!buttonWidget(
label: "Onboard Employee",
style: "SOLID",
submit: true,
showWhen: local!currentStep = 3
)
}
)
)
)
Notable implementation details
The showWhen parameter is used extensively to conditionally show particular fields as well as set requiredness & read only setting.
Each "Next" button is configured to increment local!currentStep. Validate is set to true, which ensures all fields are required before continuing on to the next step.
Each "Go Back" button is not configured to enforce validation. This allows the user to go to a previous step even if the current step has null required fields and other invalid fields. This button also decrements local!currentStep by one.
| Solve the following leet code problem |
Conditionally hide a column in a read-only grid when all data for that column is a specific value.
Use Case
You can configure a read-only grid to conditionally hide a grid column, show a grid column, or both when the user selects a filter. This interface expression pattern demonstrates how to use a!gridField() to configure a read-only grid that conditionally hides the Department column and makes the Phone Number column visible when the user selects a Department filter. It also shows you how to use a record type as the grid's data source and bring in additional features configured in the record type.
Use the pattern in this example as a template when you want to:
Conditionally hide or show certain record data based on a user's interaction with the grid.
Configure a user filter for a specific grid only.
|
The expression pattern below shows you how to:
Conditionally hide a column in a read-only grid based on the user's interaction.
Use a!queryFilter() to query the record type to return a datasubset that matches the filter value selected.
Use record type field references, recordType!<record type name>.fields.<field name>, to reference record fields in the grid and fv!row with bracket notation to call the field values in a grid.
Use a!localVariables to store the filter value a user selects.
Use a!dropdownField() to configure a filter dropdown for the grid.
SAIL code:
a!localVariables(
/* In your application, replace the values defined by local!departments
* with a constant that stores the filter values you want to use in your
* grid. Then use cons!<constant name> to reference the constant in
* local!departments. */
local!departments: { "Corporate", "Engineering", "Finance", "HR", "Professional Services", "Sales" },
/* Use a local variable to hold the name of the department filter the
* user selects in the filter dropdown. This example, uses
* local!selectedDepartment */
local!selectedDepartment,
{
a!sectionLayout(
label: "",
contents: {
a!richTextDisplayField(
value: {
a!richTextItem(
/* The department name is appended to Employees and displayed
* only when the user selects a department filter in the
* dropdown list. */
text: {"Employees"&if(isnull(local!selectedDepartment),null," in "&upper(local!selectedDepartment))},
size: "MEDIUM",
style: {
"STRONG"
}
)
}
),
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
/* We used the dropdownField() component to create an
* adhoc user filter for the grid. It pulls in the
* department names stored in local!departments as
* choiceLabels and choiceValues and saves the filter
* value selected by the user in local!selectedDepartment. */
a!dropdownField(
label: "Department ",
placeholder: "-- Filter By Department -- ",
choiceLabels: local!departments,
choiceValues: local!departments,
value: local!selectedDepartment,
saveInto: local!selectedDepartment
)
},
width: "NARROW_PLUS"
)
}
),
a!gridField(
data: a!recordData(
recordType: recordType!Employee,
filters: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: recordType!Employee.fields.department,
operator: "=",
value: local!selectedDepartment
)
},
ignoreFiltersWithEmptyValues: true
)
),
columns: {
a!gridColumn(
label: "First Name",
sortField:recordType!Employee.fields.firstName,
value: fv!row[recordType!Employee.fields.firstName]
),
a!gridColumn(
label: "Last Name",
sortField: recordType!mployee.fields.lastName,
value: fv!row[recordType!Employee.fields.lastName]
),
a!gridColumn(
label: "Department",
sortField: recordType!Employee.fields.department,
value: fv!row[recordType!Employee.fields.department],
/* The Department column is shown only when the user has not
* selected a department filter in the dropdown list. */
showWhen: isnull(local!selectedDepartment)
),
a!gridColumn(
label: "Title",
sortField: recordType!Employee.fields.title,
value: fv!row[recordType!Employee.fields.title]
),
/* The Phone Number column is shown when the user selects
* a Department filter. */
a!gridColumn(
label: "Phone Number",
sortField: recordType!Employee.fields.phoneNumber,
value: fv!row[recordType!Employee.fields.phoneNumber],
showwhen: not(isnull(local!selectedDepartment))
)
}
)
}
)
}
)
| Solve the following leet code problem |
Configure Buttons with Conditional Requiredness
Present two buttons to the end user and only make certain fields required if the user clicks a particular button
This scenario demonstrates:
How to use validation groups to evaluate particular fields on a form
How to use the requiredMessage parameter to set custom required messages
| a!localVariables(
/*
* All of these local variables could be combined into the employee CDT and passed into
* a process model via a rule input
*/
local!firstName,
local!lastName,
local!department,
local!title,
local!phoneNumber,
local!startDate,
/*
* local!isFutureHire is a placeholder variable used to set the validation group trigger.
* When isFutureHire is set to true, a user can skip phone number and start date.
*/
local!isFutureHire,
a!formLayout(
label: "Example: Add Employee with Conditional Requiredness",
contents: {
a!textField(
label: "First Name",
value: local!firstName,
saveInto: local!firstName,
required: true
),
a!textField(
label: "Last Name",
value: local!lastName,
saveInto: local!lastName,
required: true
),
a!dropdownField(
label: "Department",
placeholder: "-- Select a Department -- ",
choiceLabels: { "Corporate", "Engineering", "Finance", "Human Resources", "Professional Services", "Sales" },
choiceValues: { "Corporate", "Engineering", "Finance", "Human Resources", "Professional Services", "Sales" },
value: local!department,
saveInto: local!department,
required: true
),
a!textField(
label: "Title",
value: local!title,
saveInto: local!title,
required: true
),
/*
* When a field has a validation group set, the required parameter and any validations
* are deferred until the validation group is triggered by a button or link.
*/
a!textField(
label: "Phone Number",
placeholder: "555-456-7890",
value: local!phoneNumber,
saveInto: local!phoneNumber,
required:true,
requiredMessage:"A phone number is needed if you're going to onboard this employee",
validationGroup:"Future_Hire"
),
a!dateField(
label: "Start Date",
value: local!startDate,
saveInto: local!startDate,
required:true,
requiredMessage:"A start date is needed if you're going to onboard this employee",
validationGroup:"Future_Hire"
)
},
buttons: a!buttonLayout(
primaryButtons: {
a!buttonWidget(
label: "Submit Future Onboarding",
style: "OUTLINE",
color: "SECONDARY",
value: true,
saveInto: local!isFutureHire,
submit: true
),
a!buttonWidget(
label: "Onboard Employee Now",
value: false,
saveInto: local!isFutureHire,
submit: true,
validationGroup: "Future_Hire"
)
}
)
)
)
| Solve the following leet code problem |
Configure Cascading Dropdowns
Show different dropdown options depending on the user selection.
This scenario demonstrates:
How to setup a dropdown field's choice labels and values based of another dropdown's selection.
How to clear a child dropdown selection when the parent dropdown value changes.
| a!localVariables(
local!selectedDepartment,
local!selectedTitle,
/*
* Hardcoded values are stored here through the choose function. Typically
* this data would live with the department in a lookup value. In that case
* local!selectedDepartment would act as a filter on that query to bring
* back titles by department.
*/
local!availableTitles:choose(
if(isnull(local!selectedDepartment), 1, local!selectedDepartment),
{"CEO","CFO","COO","Executive Assistant"},
{"Director","Quality Engineer","Manager","Software Engineer"},
{"Accountant","Manager","Director"},
{"Coordinator","Director","Manager"},
{"Consultant","Principal Consultant","Senior Consultant"},
{"Account Executive","Director","Manager"}
),
a!sectionLayout(
label: "Example: Cascading Dropdowns",
contents: {
a!dropdownField(
label: "Department",
choiceLabels: { "Corporate", "Engineering", "Finance", "Human Resources", "Professional Services", "Sales" },
choiceValues: { 1, 2, 3, 4, 5, 6 },
placeholder: "-- Select a Department -- ",
value: local!selectedDepartment,
saveInto: {
local!selectedDepartment,
a!save(local!selectedTitle, null)
}
),
a!dropdownField(
label: "Title",
choiceLabels: local!availableTitles,
choiceValues: local!availableTitles,
placeholder: "--- Select a Title ---",
value: local!selectedTitle,
saveInto: local!selectedTitle,
disabled: isnull(local!selectedDepartment)
)
}
)
)
| Solve the following leet code problem |
Configure a Boolean Checkbox
Configure a checkbox that saves a boolean (true/false) value, and validate that the user selects the checkbox before submitting a form.
This scenario demonstrates:
How to configure a checkbox field so that a single user interaction records a true or false value
| a!localVariables(
local!userAgreed,
a!formLayout(
label:"Example: Configure a Boolean Checkbox",
contents:{
a!checkboxField(
label: "Acknowledge",
choiceLabels: {"I agree to the terms and conditions."},
choiceValues: {true},
/* If local!userAgreed is false, set the value */
/* to null so that the checkbox is unchecked */
value: if(local!userAgreed, true, null),
/* We want to save a false value when the checkbox */
/* is unchecked, so we need to check whether */
/* save!value is null and update the variable if so */
saveInto: a!save(
local!userAgreed,
if(isnull(save!value), false, true)
),
required: true,
requiredMessage: "You must check this box!"
)
},
buttons:a!buttonLayout(
primaryButtons:{
a!buttonWidget(
label:"Submit",
submit: true
)
}
)
)
)
| Solve the following leet code problem |
Configure a Chart Drilldown to a Grid
Displays a column chart with aggregate data from a record type and conditionally shows a grid with filtered records when a user selects a column on the chart.
This design pattern is not recommended for offline interfaces because reflecting immediate changes in an interface based on user interaction requires a connection to the server.
This scenario demonstrates:
How to create a grid and chart using a record type as the source.
How to save a selection from the chart and filter the grid.
| a!localVariables(
local!selection,
a!sectionLayout(
contents: {
a!columnChartField(
label: "All Cases",
data: a!recordData(
recordType: recordType!Case,
filters: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: recordType!Case.fields.type,
operator: "not in",
value: {"Other"}
)
},
ignoreFiltersWithEmptyValues: true
)
),
config: a!columnChartConfig(
primaryGrouping: a!grouping(
field: recordType!Case.fields.status,
alias: "status"
),
secondaryGrouping: a!grouping(
field: recordType!Case.fields.type,
alias: "type"
),
measures: {
a!measure(
function: "COUNT",
field: recordType!Case.fields.id,
alias: "id_count"
)
},
dataLimit: 100,
link: a!dynamicLink(
value: fv!selection,
saveInto: local!selection
)
),
stacking: "NONE",
colorScheme: "PARACHUTE",
showWhen: isnull(local!selection)
),
a!linkField(
labelPosition: "COLLAPSED",
links: a!dynamicLink(
label: "Back",
saveInto: a!save(
target: local!selection,
value: null
)
),
showWhen: not(isnull(local!selection))
),
a!gridField(
label: local!selection.status & " " &local!selection.type & " Cases",
labelPosition: "ABOVE",
data: a!recordData(
recordType:recordType!Case,
filters: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: recordType!Case.fields.type,
operator: "=",
value: local!selection.type
),
a!queryFilter(
field: recordType!Case.fields.status,
operator: "=",
value: local!selection.status
)
},
ignorefilterswithemptyvalues: true
)
),
columns: {
a!gridColumn(
label: "Id",
sortField: recordType!Case.fields.id,
value: fv!row[recordType!Case.fields.id],
align: "END"
),
a!gridColumn(
label: "Assignee",
sortField: recordType!Case.fields.assignee,
value: a!linkField(
links: {
a!recordLink(
label: fv!row[recordType!Case.fields.assignee],
recordType: recordType!Case,
identifier: fv!identifier
)
}
)
),
a!gridColumn(
label: "Title",
sortField: recordType!Case.fields.title,
value: fv!row[recordType!Case.fields.title]
),
a!gridColumn(
label: "Priority",
sortField: recordType!Case.fields.priority,
value: fv!row[recordType!Case.fields.priority]
),
a!gridColumn(
label: "Status",
sortField: recordType!Case.fields.status,
value: fv!row[recordType!Case.fields.status]
),
a!gridColumn(
label: "Type",
sortField: recordType!Case.fields.type,
value: fv!row[recordType!Case.fields.type]
),
a!gridColumn(
label: "Date Created",
sortField: recordType!Case.fields.dateCreated,
value: fv!row[recordType!Case.fields.dateCreated],
align: "END"
),
},
showWhen: not(isnull(local!selection))
)
}
)
)
| Solve the following leet code problem |
Configure a Chart to Grid Toggle
Display a column chart with a toggle to display an alternate grid view of the data.
Display a chart with the number of tickets reported each month internally and from customers. Then add a grid to display the same data. Finally, add a link so that a user may toggle between the chart and grid views of the data. This pattern is recommended to provide a visual data display while still making the data accessible to users who employ assistive technology.
This scenario demonstrates:
How to configure alternate displays of the same data.
How to modify the expression to display a grid when the user clicks on a link toggle
This example uses a hard-coded data set. To use data from a record type, use a!queryRecordType() to populate local!ticketData and update the columns to use record type field references. See Aggregate Data and Conditionally Display in a Chart or Grid for a similar pattern using records.
| a!localVariables(
local!ticketData:{
a!map( month:"January", internalTickets:32, customerTickets:41 ),
a!map( month:"February", internalTickets:16, customerTickets:38 ),
a!map( month:"March", internalTickets:21, customerTickets:37 ),
a!map( month:"April", internalTickets:31, customerTickets:20 ),
a!map( month:"May", internalTickets:33, customerTickets:47 ),
a!map( month:"June", internalTickets:9, customerTickets:22 ),
a!map( month:"July", internalTickets:2, customerTickets:16 ),
a!map( month:"August", internalTickets:11, customerTickets:29 ),
a!map( month:"September", internalTickets:5, customerTickets:0 ),
a!map( month:"October", internalTickets:71, customerTickets:10 ),
a!map( month:"November", internalTickets:4, customerTickets:13 ),
a!map( month:"December", internalTickets:5, customerTickets:21 )
},
/* This variable is referenced in the showWhen parameters of both the grid and
the chart. */
local!showAsGrid: false,
{
a!linkField(
links:{
/* The not() function simply inverts a true or false value, making for a
simple toggle. */
a!dynamicLink(
label: "View data as a " & if(local!showAsGrid, "chart", "grid"),
value: not(local!showAsGrid),
saveInto: local!showAsGrid
)
}
),
if(local!showAsGrid,
a!gridField(
label: "Logged Defect Tickets",
data: local!ticketData,
columns: {
a!gridColumn(
label: "Month",
value: fv!row.month
),
a!gridColumn(
label: "Internal Tickets",
value: fv!row.internalTickets,
align: "END",
width: "NARROW_PLUS"
),
a!gridColumn(
label: "Customer Tickets",
value: fv!row.customerTickets,
align: "END",
width: "NARROW_PLUS"
),
a!gridColumn(
label: "Total Tickets",
value: fv!row.internalTickets + fv!row.customerTickets,
align:"END",
width: "NARROW_PLUS"
)
},
pageSize: 12
),
a!columnChartField(
label: "Logged Defect Tickets",
categories: left(local!ticketData.month, 3),
series: {
a!chartSeries(label: "Internal", data: local!ticketData.internalTickets),
a!chartSeries(label: "Customer", data: local!ticketData.customerTickets)
},
colorScheme: "PARACHUTE",
yAxisTitle: "Number of Tickets",
stacking: "NORMAL",
showLegend: true
)
)
}
)
| Solve the following leet code problem |
Configure a Dropdown Field to Save a CDT
When using a dropdown to select values from the database, or generally from an array of CDT values, configure it to save the entire CDT value rather than just a single field.
This scenario demonstrates:
How to configure a dropdown component to save a CDT value.
Notable implementation details:
Saving the entire CDT saves you from having to store the id and query the entire object separately when you need to display attributes of the selected CDT elsewhere on the form.
When you configure your dropdown, replace the value of local!foodTypes with a CDT array that is the result of a!queryEntity() or a!queryRecordType(). These functions allow you to retrieve only the fields that you need to configure your dropdown.
This technique is well suited for selecting lookup values for nested CDTs. Let's say you have a project CDT and each project can have zero, one, or many team members. Team members reference the employee CDT. Use this technique when displaying a form to the end user for selecting team members.
| a!localVariables(
local!foodTypes: {
a!map( id: 1, name: "Fruits" ),
a!map( id: 2, name: "Vegetables" )
},
local!selectedFoodType,
a!formLayout(
label: "Example: Dropdown with CDT",
contents: {
a!dropdownField(
label: "Food Type",
instructions: "Value saved: " & local!selectedFoodType,
choiceLabels: index(local!foodTypes, "name", null),
placeholder: "--- Select Food Type ---",
/* choiceValues gets the CDT/dictionary rather than the ids */
choiceValues: local!foodTypes,
value: local!selectedFoodType,
saveInto: local!selectedFoodType
)
},
buttons: a!buttonLayout(
primaryButtons: a!buttonWidget(
label: "Submit",
submit: true
)
)
)
)
| Solve the following leet code problem |
Configure a Dropdown with an Extra Option for Other
Show a dropdown that has an "Other" option at the end of the list of choices. If the user selects "Other", show a required text field.
This scenario demonstrates:
How to configure a dropdown with an appended value
How to conditionally show a field based the selection of an 'Other' option
How to save one of two values when evaluating a form through a submit button
| a)
a!localVariables(
local!departments:{"Corporate","Engineering","Finance","HR","Professional Services"},
/*
* You need separate variables to temporarily store the dropdown selection
* (local!selectedDepartment) and the value entered for "Other" (local!otherChoice).
*/
local!selectedDepartment,
local!otherChoice,
local!savedValue,
a!formLayout(
label: "Example: Dropdown with Extra Option for Other",
contents: {
a!dropdownField(
label: "Department",
instructions:"Value saved: "& local!savedValue,
/*
* Adding the "Other" option here allows you to store a separate value.
* For example, if your choiceValues are integers, you could store -1.
*/
choiceLabels: a!flatten({local!departments, "Other"}),
choiceValues: a!flatten({local!departments, "Other"}),
placeholder: "--- Select a Department ---",
value: local!selectedDepartment,
saveInto: local!selectedDepartment
),
a!textField(
label: "Other",
value: local!otherChoice,
saveInto: local!otherChoice,
required: true,
showWhen: local!selectedDepartment = "Other"
)
},
buttons: a!buttonLayout(
/*
* The Submit button saves the appropriate value to its final location
*/
primaryButtons: a!buttonWidget(
label: "Submit",
value: if(
local!selectedDepartment = "Other",
local!otherChoice,
local!selectedDepartment
),
saveInto: local!savedValue,
submit: true
)
)
)
)
b) offline mode
a!localVariables(
local!departments:{"Corporate","Engineering","Finance","HR","Professional Services"},
/*
* You need separate variables to temporarily store the dropdown selection
* (local!selectedDepartment) and the value entered for "Other" (local!otherChoice).
*/
local!selectedDepartment,
local!otherChoice,
local!savedValue,
a!formLayout(
label: "Example: Dropdown with Extra Option for Other",
contents: {
a!dropdownField(
label: "Department",
instructions:"Value saved: "& local!savedValue,
/*
* Adding the "Other" option here allows you to store a separate value.
* For example, if your choiceValues are integers, you could store -1.
*/
choiceLabels: a!flatten({local!departments, "Other"}),
choiceValues: a!flatten({local!departments, "Other"}),
placeholder: "--- Select a Department ---",
value: local!selectedDepartment,
saveInto: local!selectedDepartment
),
a!textField(
label: "Other",
value: local!otherChoice,
saveInto: local!otherChoice,
required: local!selectedDepartment = "Other"
)
},
buttons: a!buttonLayout(
/*
* The Submit button saves the appropriate value to its final location
*/
primaryButtons: a!buttonWidget(
label: "Submit",
value: if(
local!selectedDepartment = "Other",
local!otherChoice,
local!selectedDepartment
),
saveInto: local!savedValue,
submit: true
)
)
)
)
| Solve the following leet code problem |
Configure an Array Picker
Allow users to choose from a long text array using an auto-completing picker.
Also, allow users to work with user-friendly long labels but submit machine-friendly abbreviations.
|
The main expression uses a supporting rule, so let's create that first.
ucArrayPickerFilter: Scans labels that match the text entered by the user and returns a DataSubset for use in the picker component.
Create expression rule ucArrayPickerFilter with the following rule inputs:
filter (Text)
labels (Text Array)
identifiers (Text Array)
Enter the following definition for the rule:
a!localVariables(
local!matches: where(
a!forEach(
items: ri!labels,
expression: search( ri!filter, fv!item)
)
),
a!dataSubset(
data: index( ri!labels, local!matches),
identifiers: index( ri!identifiers, local!matches)
)
)
Now that we've created the supporting rule, let's move on to the main expression.
a!localVariables(
local!pickedState,
local!stateLabels: { "Alabama", "Alaska", "Arizona", "Arkansas", "California", "Colorado", "Connecticut", "Delaware", "Florida", "Georgia", "Hawaii", "Idaho", "Illinois", "Indiana", "Iowa", "Kansas", "Kentucky", "Louisiana", "Maine", "Maryland", "Massachusetts", "Michigan", "Minnesota", "Mississippi", "Missouri", "Montana", "Nebraska", "Nevada", "New Hampshire", "New Jersey", "New Mexico", "New York", "North Carolina", "North Dakota", "Ohio", "Oklahoma", "Oregon", "Pennsylvania", "Rhode Island", "South Carolina", "South Dakota", "Tennessee", "Texas", "Utah", "Vermont", "Virginia", "Washington", "West Virginia", "Wisconsin", "Wyoming" },
local!stateAbbreviations: { "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" },
a!pickerFieldCustom(
label: "State of Residence",
instructions: "Value saved: " & local!pickedState,
placeholder: "Type to select the employee's state of residence",
maxSelections: 1,
suggestFunction: rule!ucArrayPickerFilter(
filter:_ ,
labels: local!stateLabels,
identifiers: local!stateAbbreviations
),
selectedLabels: a!forEach(
items: local!pickedState,
expression: index(local!stateLabels, wherecontains(fv!item, local!stateAbbreviations))
),
value: local!pickedState,
saveInto: local!pickedState
)
)
| Solve the following leet code problem |
Configure an Array Picker with a Show All Option
Allow users to choose from a long text array using an autocompleting picker, but also allow them to see the entire choice set using a dropdown.
Dropdowns with many choices can be a little unwieldy, but when there is doubt about even the first letters of an option they can be very useful.
This scenario demonstrates:
How to create a link that replace one component with another
How to save a value in one component and be able to see those results in another component
| Setup:
The main expression uses a supporting rule, so let's create that first.
ucArrayPickerFilter: Scans labels that match the text entered by the user and returns a DataSubset for use in the picker component.
Create expression rule ucArrayPickerFilter with the following rule inputs:
filter (Text)
labels (Text Array)
identifiers (Text Array)
Enter the following definition for the rule:
a!localVariables(
local!matches: where(
a!forEach(
items: ri!labels,
expression: search( ri!filter, fv!item)
)
),
a!dataSubset(
data: index( ri!labels, local!matches),
identifiers: index( ri!identifiers, local!matches)
)
)
Expression :
a!localVariables(
local!pickedState,
/*
* local!showPicker is used as a field toggle. When set to true, a picker and link
* will be visible. The link field with set this to false when clicked, showing a dropdown.
*/
local!showPicker: true,
local!stateLabels: { "Alabama", "Alaska", "Arizona", "Arkansas", "California", "Colorado", "Connecticut", "Delaware", "Florida", "Georgia", "Hawaii", "Idaho", "Illinois", "Indiana", "Iowa", "Kansas", "Kentucky", "Louisiana", "Maine", "Maryland", "Massachusetts", "Michigan", "Minnesota", "Mississippi", "Missouri", "Montana", "Nebraska", "Nevada", "New Hampshire", "New Jersey", "New Mexico", "New York", "North Carolina", "North Dakota", "Ohio", "Oklahoma", "Oregon", "Pennsylvania", "Rhode Island", "South Carolina", "South Dakota", "Tennessee", "Texas", "Utah", "Vermont", "Virginia", "Washington", "West Virginia", "Wisconsin", "Wyoming" },
local!stateAbbreviations: { "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" },
a!sectionLayout(
contents:{
a!linkField(
links: a!dynamicLink(
label: "Show All",
value: false,
saveInto: local!showPicker,
showWhen: local!showPicker
)
),
a!pickerFieldCustom(
label: "States",
instructions: "Enter the employee's state of residence.",
maxSelections: 1,
/*
* To use with your data, replace local!stateLabels with the datapoint you wish to be displayed and
* local!stateAbbreviations with the datapoint you eventually want to save.
*/
suggestFunction: rule!ucArrayPickerFilter(filter: _, labels: local!stateLabels, identifiers: local!stateAbbreviations),
selectedLabels: a!forEach(
items: local!pickedState,
expression: index(local!stateLabels, wherecontains(fv!item, local!stateAbbreviations))
),
value: local!pickedState,
saveInto: local!pickedState,
showWhen: local!showPicker
),
a!dropdownField(
label: "States",
instructions: "Enter the employee's state of residence.",
choiceLabels: local!stateLabels,
placeholder: "Select a US state",
choiceValues: local!stateAbbreviations,
value: local!pickedState,
saveInto: local!pickedState,
showWhen: not( local!showPicker )
)
}
)
)
| Solve the following leet code problem |
Define a Simple Currency Component
Show a text field that allows the user to enter dollar amounts including the dollar symbol and thousand separators, but save the value as a decimal rather than text. Additionally, always show the dollar amount with the dollar symbol.
This scenario demonstrates:
How to configure an interface component to format a user's input
| a!localVariables(
local!amount,
a!textField(
label:"Amount in Text",
/* Instructions show the saved datatype*/
instructions: "Type of local!amount: " & typename(typeof(local!amount)),
value: a!currency(
isoCode: "USD",
value: local!amount,
format: "SYMBOL"
),
/* Instead of saving the value as text, a!save() is used to store to the desired datatype*/
saveInto: a!save(local!amount, todecimal(save!value))
)
)
| Solve the following leet code problem |
Delete Rows in a Grid
Delete one or more rows of data in a read-only grid.
This scenario demonstrates how to remove rows from a grid.
This design pattern is not recommended for offline interfaces because reflecting immediate changes in an interface based on user interaction requires a connection to the server.
| When the user clicks the REMOVE button, the selected row IDs are added to a local variable. Any ID in that variable is filtered out of the grid using a!queryFilter() within the a!recordData() function. Note that the source rows are not actually removed; the rows are just visibly removed from the grid. To actually remove the records from the source, you would want to pass those removed IDs to another function, process, or service.
SAIL code :
a!localVariables(
/* This variable stores the grid's selection. */
local!selection,
/* This variable stores the row information for the grid's selection. */
local!selectedRows,
/* This variable stores the IDs of the rows that were removed via the REMOVE button
to filter out those rows from the grid. It can also be used to pass these
IDs to a process to remove them from the source entity. */
local!removedIds,
{
a!buttonArrayLayout(
buttons: {
a!buttonWidget(
label: "REMOVE",
saveinto: {
/* Append the selected rows IDs to the local!removedIds variable. */
a!save(local!removedIds, append(local!removedIds, local!selectedRows[recordType!Employee.fields.id])),
/* Reset local!selectedRows so other rows can be removed. */
a!save(local!selectedRows, null),
/* Reset the grid selection as well. */
a!save(local!selection, null)
},
style: "OUTLINE",
/* Disable the button if local!selectedRows is empty. */
disabled: if(or(isnull(local!selectedRows),length(local!selectedRows)<1),true,false)
)
},
align: "START"
),
a!gridField(
label: "Grid with Removable Rows",
/* The recordData function allows us to filter the record data. */
data: a!recordData(
recordType: recordType!Employee,
/* This query filter applies to all rows where the row ID is found in local!removedRows. */
filters: a!queryFilter(
field: recordType!Employee.fields.id,
operator: if(isnull(local!removedIds),"not null","not in"),
value: local!removedIds
)
),
columns: {
a!gridColumn(
label: "ID",
sortField: recordType!Employee.fields.id,
value: fv!row[recordType!Employee.fields.id],
align: "END",
width: "ICON"
),
a!gridColumn(
label: "First Name",
sortField: recordType!Employee.fields.firstName,
value: fv!row[recordType!Employee.fields.firstName]
),
a!gridColumn(
label: "lastName",
sortField: recordType!Employee.fields.lastName,
value: fv!row[recordType!Employee.fields.lastName]
),
a!gridColumn(
label: "Department",
sortField: recordType!Employee.fields.department,
value: fv!row[recordType!Employee.fields.department]
),
a!gridColumn(
label: "Title",
sortField: recordType!Employee.fields.title,
value: fv!row[recordType!Employee.fields.title]
)
},
selectable: true,
selectionStyle: "ROW_HIGHLIGHT",
selectionValue: local!selection,
selectionSaveInto: {
local!selection,
/* Add row data to local!selectedRows list when that row is selected by the user. */
a!save(local!selectedRows, append(local!selectedRows,fv!selectedRows)),
/* Remove row data from local!selectedRows when that row is deselected by the user. */
a!save(local!selectedRows, difference(local!selectedRows,fv!deselectedRows))
},
showSearchBox: false,
showRefreshButton: false
)
}
)
| Solve the following leet code problem |
Disable Automatic Refresh After User Saves Into a Variable
This scenario demonstrates:
How to disable the automatic recalculation of a variable's default value once a user has edited that variable directly
|
a!localVariables(
local!startDate: today(),
local!endDateEdited: false,
local!endDate: a!refreshVariable(
value: local!startDate + 7,
refreshOnReferencedVarChange: not(local!endDateEdited)
),
{
a!dateField(
label: "Start Date",
value: local!startDate,
saveInto: local!startDate
),
a!dateField(
label: "End Date",
value: local!endDate,
saveInto: {
local!endDate,
a!save(local!endDateEdited, true)
}
)
}
)
| Solve the following leet code problem |
Display Last Refresh Time
This scenario demonstrates how to enable, track, and display the last updated time when the data in the grid refreshed on an interval, and due to a user interaction. Use this pattern when you want to let users know how fresh the data is and when it was last refreshed.
|
Solution explanation :
This pattern works by putting the recordData() function into a local variable, instead of directly into the grid, allowing the refresh variable in local!lastUpdatedAt to watch it. We use recordData() in order to take advantage of using record data in a grid which enables a refresh button. The fundamental pattern of watching another variable works just as well using a!queryEntity().
SAIL code :
=a!localVariables(
/* This refresh variable refreshes every 30 seconds to return the data from
the Employee record type. */
local!employees: a!refreshVariable(
value: a!recordData(recordType!Employee),
refreshInterval: 0.5
),
/* This refresh variable returns the current time using the now() function.
It is set to refresh whenever local!employees changes. It's also set to
refresh every 30 seconds, because if local!employees refreshes, but the
data hasn't changed, then this refresh variable wouldn't know to
refresh. */
local!lastUpdatedAt: a!refreshVariable(
value: now(),
refreshOnVarChange: local!employees,
refreshInterval: 0.5
),
a!sectionLayout(
contents:{
a!richTextDisplayField(
labelposition: "COLLAPSED",
value: {
a!richTextItem(
text: {
"Last updated at ",
text(local!lastUpdatedAt, "h:mm a")
},
color: "SECONDARY",
style: "EMPHASIS"
)
},
align: "RIGHT"
),
a!gridField(
label: "Employees",
/* The recordData() function is external to the grid so it can be
referenced by the refresh variable in local!lastUpdatedAt. */
data: local!employees,
columns: {
a!gridColumn(
label: "First Name",
sortField: recordType!Employee.fields.firstName,
value: fv!row[recordType!Employee.fields.firstName]
),
a!gridColumn(
label: "Last Name",
sortField: recordType!Employee.fields.lastName,
value: fv!row[recordType!Employee.fields.lastName]
),
a!gridColumn(
label: "Department",
sortField: "department",
value: fv!row[recordType!Employee.fields.department]
),
a!gridColumn(
label: "Title",
sortField: recordType!Employee.fields.title,
value: fv!row[recordType!Employee.fields.title]
),
a!gridColumn(
label: "Phone Number",
value: fv!row[recordType!Employee.fields.phoneNumber]
),
a!gridColumn(
label: "Start Date",
sortField: recordType!Employee.fields.startDate,
value: fv!row[recordType!Employee.fields.startDate]
)
},
rowHeader: 1
)
}
)
)
| Solve the following leet code problem |
Display Multiple Files in a Grid.
Show a dynamic number of files in a grid and edit certain file attributes.
For this recipe, were are giving our users the ability to update the file name, description, and an associative field for the file "Category". However, designers can modify this recipe to modify various types of document metadata.
This scenario demonstrates:
How to handle an array of documents in an editable grid for file verification and attribute editing
How to use a!forEach() in an interface component
|
Solution explanation :
Before we can see this recipe in the live view, we will need to create a Constant that holds an array of documents.
To do this:
Upload a few files into Appian
Create a constant of type Document named UC_DOCUMENTS and select the multiple checkbox. Select the files you just uploaded as the value.
Notes: While this recipe uses local variable for their stand-alone capability, you will typically be interaction with a CDT or datasubset data structure when working with file attributes. In these cases, the data would typically be passed in via a rule input or query.
SAIL Code :
a!localVariables(
/*
* local!files are stored in a constant here. However, this source would typically come from
* process data or queried from a relational database. local!fileMap simulates a data
* structure that would typically hold file metadata.
*/
local!files: cons!DOCUMENT_GIF_IMAGE,
local!fileMap: a!forEach(
items: local!files,
expression: a!map(
file: fv!item,
fileCategory: "",
newFileName: document(fv!item, "name"),
newFileDescription: document(fv!item, "description")
)
),
a!sectionLayout(
contents: {
a!gridLayout(
label: "Example: Display Multiple Files in a Grid",
totalCount: count(local!files),
headerCells: {
a!gridLayoutHeaderCell(label: "File"),
a!gridLayoutHeaderCell(label: "Name"),
a!gridLayoutHeaderCell(label: "Description"),
a!gridLayoutHeaderCell(label: "Category"),
a!gridLayoutHeaderCell(label: "Size (KB)", align: "RIGHT")
},
columnConfigs: {
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight: 3),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight: 3),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight: 3),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight: 2),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight: 2),
},
rows: a!forEach(
items: local!fileMap,
expression: a!gridRowLayout(
contents: {
a!linkField(
/* Labels are not visible in grid cells but are necessary to meet accessibility requirements */
label: "File" & fv!index,
links: a!documentDownloadLink(
label: document(fv!item.file,"name") & "." & document(fv!item.file,"extension"),
document: fv!item.file
),
value: fv!item.newFileName,
readOnly: true
),
a!textField(
label: "File Name " & fv!index,
value: fv!item.newFileName,
saveInto: fv!item.newFileName
),
a!textField(
label: "Description " & fv!index,
value: fv!item.newFileDescription,
saveInto: fv!item.newFileDescription,
readOnly: false
),
a!dropdownField(
label: "category " & fv!index,
placeholder: "-- Please Select--",
choiceLabels: { "Resume", "Cover Letter", "Other" },
choiceValues: { "Resume", "Cover Letter", "Other" },
value: fv!item.fileCategory,
saveInto: fv!item.fileCategory
),
a!textField(
label: "title " & fv!index,
value: round(document(fv!item.file, "size") / 1000),
align: "RIGHT",
readOnly: true
)
},
id: fv!index
)
),
rowHeader: 2
),
a!textField(
label: "Value of Document Dictionary",
readOnly: true,
value: local!fileMap
)
}
)
)
| Solve the following leet code problem |
Display Processes by Process Model with Status Icons.
Use an interface to display information about instances of a specific process model.
This design pattern is not recommended for offline interfaces because reflecting immediate changes in an interface based on user interaction requires a connection to the server.
This scenario demonstrates:
How to use a!queryProcessAnalytics() to query process data
How to display process report data in a grid
How to use the process report's configured formatting to customize display
How to us a!forEach() to dynamically create a grid's columns
| Setup
For this recipe, you'll need a constant pointing to a process report and a process model that has been at least started a few times. If you don't have a process model, you can follow the Process Modeling Tutorial. Once you have some processes, you can follow these steps to create a process report with the default columns and associate it with a constant:
In the Build view of your application, click NEW > Process Report.
Select Create from scratch.
Name the report Processes for Process Model A.
Under Report Type, select Process.
Under Context Type, select Processes by process model.
Specify a folder to contain the report, and then click Create.
Open the process report in a new tab. You will see the Choose Process Models dialog open.
In the Choose Process Models dialog, select the desired process model, and then click OK.
The main expression uses two supporting constants, so let's create them first.
UC_PROCESSES_FOR_PM_REPORT: Constant of type Document whose value is Processes for Process Model A.
UC_PROCESS_MODEL: Constant of type Process Model whose value is the process you created
SAIL Code :
a!localVariables(
local!pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: -1
),
local!report: a!queryProcessAnalytics(
report: cons!UC_PROCESSES_FOR_PM_REPORT,
contextProcessModels: {
cons!UC_PROCESS_MODEL
},
query: a!query(
pagingInfo: local!pagingInfo
)
),
a!gridField(
label: local!report.name,
instructions: local!report.description,
data: local!report.data,
columns: a!forEach(
items: local!report.columnConfigs,
expression: a!gridColumn(
label: fv!item.label,
sortField: fv!item.field,
value: if(
fv!item.configuredFormatting = "PROCESS_STATUS_ICON",
a!imageField(
images: choose(
/*Process status go from 0-4, so add 1 to index into the choose list */
1 + tointeger(index(fv!row, fv!item.field, {})),
a!documentImage(
document: a!iconIndicator( icon: "PROGRESS_RUNNING" ),
altText: "Active",
caption: "Active"
),
a!documentImage(
document: a!iconIndicator( icon: "STATUS_OK" ),
altText: "Completed",
caption: "Completed"
),
a!documentImage(
document: a!iconIndicator( icon: "PROGRESS_PAUSED" ),
altText: "Paused",
caption: "Paused"
),
a!documentImage(
document: a!iconIndicator( icon: "STATUS_NOTDONE" ),
altText: "Cancelled",
caption: "Cancelled"
),
a!documentImage(
document: a!iconIndicator( icon: "STATUS_ERROR" ),
altText: "Paused By Exception",
caption: "Paused By Exception"
)
) ),
index(fv!row, fv!item.field)
)
)
),
rowHeader: 1,
pageSize: 20
)
)
| Solve the following leet code problem |
Display a User's Tasks in a Grid With Task Links.
Display the tasks for a user in a Read-Only Grid and allow them to click on a task to navigate to the task itself.
This design pattern is not recommended for offline interfaces because reflecting immediate changes in an interface based on user interaction requires a connection to the server.
This scenario demonstrates:
How to use a!queryProcessAnalytics() to query task data
How to display a grid based on a process report's configuration
How to use the process report's configured formatting in SAIL
How to convert the process report's configured drilldown to interface links
|
Setup
For this recipe, you'll need a constant pointing to a task report. Follow these steps to create a task report with the default columns and associate it with a constant:
In the Build view of your application, click NEW > Process Report.
Select Create from scratch.
Name the report Tasks for User A, and provide a description that will be displayed as the label and instructions of the grid.
Under Report Type, select Task.
Under Context Type, select Tasks by owner.
Specify a folder to contain the report, and then click Create & Edit.
The process report opens in a new tab.
In the toolbar, click Edit.
In the Report Options dialog, click the Data tab.
Click the Name link.
Check the Link to more information checkbox and from the Link to dropdown list, select Task Details.
Click Save.
Save the report by clicking Save in the toolbar.
The main expression uses a supporting constant constant, so let's create them first.
UC_TASKS_FOR_USER_REPORT: Constant of type Document whose value is Tasks for User A
Now that we've created the supporting rules, let's move on to the main expression.
Sail Code:
a!localVariables(
local!pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: -1
),
local!report: a!queryProcessAnalytics(
report: cons!UC_TASKS_FOR_USER_REPORT,
query: a!query(pagingInfo: local!pagingInfo)
),
a!gridField(
label: local!report.name,
instructions: local!report.description,
data: local!report.data,
columns:
a!forEach(
items: local!report.columnConfigs,
expression: a!gridColumn(
label: fv!item.label,
sortField: fv!item.field,
align: if(fv!item.configuredFormatting = "DATE_TIME", "END", "START"),
value: if(
fv!item.configuredFormatting = "TASK_STATUS",
index(
{
"Assigned",
"Accepted",
"Completed",
"Not Started",
"Cancelled",
"Paused",
"Unattended",
"Aborted",
"Cancelled By Exception",
"Submitted",
"Running",
"Error"
},
/* Task status ids start with 0, so add one to reach the first index */
tointeger(index(fv!row, tointeger(fv!item.field) + 1, -1 )),
"Other"
),
if(
fv!item.configuredDrilldown = "TASK_DETAILS",
a!linkField(
links: a!processTaskLink(
label: index(fv!row, fv!item.field, {}),
task: index(fv!row, fv!item.drilldownField, {})
)
),
index(fv!row, fv!item.field, {})
)
)
)
),
rowHeader: 1,
pageSize: 20
)
)
| Solve the following leet code problem |
Dynamically Show Sales by Product Category Compared to Total Sales.
This pattern illustrates how to create an area chart that dynamically displays sales generated by product category compared to total sales. This pattern also provides a sample scenario to show how you can take common business requirements and quickly turn them into a report.
You'll notice that this pattern provides more than just an expression, it shows you the fastest way to build reports in Design Mode. To get the most out of this pattern, follow the steps in Create this pattern to learn how to build advanced reports using the latest low-code features.
Scenario
Inventory managers at the Appian Retail company want to know how monthly sales were divided among the different product categories to see how their line of products impact overall sales. Since each inventory manager is responsible for a certain product category, they want this report to help them determine if they need to change their inventory strategy to follow sales trends.
To allow different inventory managers to view their own product category sales, you'll use the pattern on this page to create an area chart that can be filtered by product category. This way, users can see their monthly sales for the selected category compared to the total sales generated each month.
| Setup
This pattern uses data from the Appian Retail application, available for free in Appian Community Edition. To follow along with this pattern, log in to Appian Community to request the latest Appian Community Edition site.
If you do not see the Appian Retail application available in your existing Appian Community Edition, you can request a new Appian Community Edition to get the latest application contents available.
This pattern will use data from the following record types in the Appian Retail application:
1) Order record type: Contains order information like the order number, date, status, and whether it was purchased online or in stores. For example, order number SO43659 was purchased in stores on 5/31/2019 and the order is closed.
2) Order Detail record type: Contains specific order details like the number of order items, order totals, promo codes applied, and products. For example, the order above contained one product that cost $2,024.99.
3) Product Category record type: Contains product categories. For example, Bikes.
Step 1: Create an area chart with total sales per monthCopy link to clipboard
First, we'll create an area chart that shows the total sales generated each month in 2021.
To create the area chart:
In the Appian Retail application, go to the Build view.
Click NEW > Interface.
Configure the interface properties and click CREATE.
From the PALETTE, drag an AREA CHART component into the interface.
From Data Source, select RECORD TYPE and search for the Order record type.
For Primary Grouping, keep the default field selection orderDate.
Click the pencil icon next to the Primary Grouping to change the format of the date values. This will allow you to read the dates in an easier format:
For Time Interval, select Month.
For Format Value, use a pre-defined format to display the abbreviated month and year. For example, Nov 2021.
Return to the Area Chart component configuration.
Click the pencil icon next to the Measure to configure the chart's aggregation:
For Label, enter Total Sales.
For Aggregation Function, select Sum of.
For Field, remove the existing field. Then, use the dropdown to hover over the orderDetail relationship and select the lineTotal field. The field will display as orderDetail.lineTotal.
Return to the Area Chart component configuration.
Click FILTER RECORDS.
Click Add Filter and configure the following conditions:
For Field, select orderDate.
For Condition, select Date Range.
For Value, use the context menu () to select Expression.
Click null to edit the expression.
Replace the existing value with the following expression:
{
todatetime("01/01/2021"),
todatetime("12/31/2021")
}
Click OK.
Click OK to close the dialog.
Step 2: Add a second measure with a filterCopy link to clipboard
Now, we're going to add a second measure to the area chart. This measure will include a filter so it only displays the sum of sales from orders that have at least one item from the Bikes category.
To add the second measure:
On the area chart, click ADD MEASURE.
Click the pencil icon next to the new Measure to configure the second aggregation:
For Label, enter Product Category: Bikes.
For Aggregation Function, select Sum of.
For Field, use the dropdown to hover over the orderDetail relationship and select the lineTotal field. The field will display as orderDetail.lineTotal.
Click + ADD FILTERS.
Click Add Filter and configure following:
For Field, use the dropdown to hover over product > productSubcategory > productCategory and select the name field. The field will display as product.productSubcategory.productCategory.name.
For Condition, leave the default selection of equal to.
For Value, enter Bikes.
Click OK.
Return to the Area Chart component configuration.
For Label, enter Monthly Sales in 2021.
For Stacking, select None.
Step 3: Add a dropdown componentCopy link to clipboard
Since inventory managers want to see sales trends for each product category, not just bikes, you'll add a filter that lets users change which product category is displayed in the chart.
To dynamically filter the chart, you'll add a dropdown component and configure a local variable so the selected dropdown option will filter the chart. Let's start by adding the dropdown component.
To add the dropdown component:
From the PALETTE, drag the COLUMNS component onto your interface above the area chart.
From the PALETTE, drag the DROPDOWN component into the left column.
For the dropdown's Label, enter Product Categories.
Hover over Choice Labels and click Edit as Expression . The Choice Labels dialog appears.
Delete the default values in the dialog.
Click Create Constant create constant icon and configure the following values:
For Name, enter AR_CATEGORIES.
For Type, select Text.
Select the Array (multiple values) checkbox.
For Values, enter the category options. Separate each category by a line break, but do not include spaces, commas, or quotations:
Bikes
Accessories
Clothing
Components
Leave the other fields as default.
Click CREATE. The constant cons!AR_CATEGORIES appears in the Choice Labels dialog.
Click OK.
Note: After you change the Choice Label to use the constant, an error will appear. This is expected since the Choice Label and Choice Values fields currently have different values. The error will resolve itself when you change the Choice Values field to use the same constant.
Hover over Choice Values and click Edit as Expression . The Choice Values dialog appears.
Delete the default values in the Choice Values dialog and enter cons!AR_CATEGORIES.
Click OK.
Step 4: Add a local variable to filter the chart based on the dropdown selectionCopy link to clipboard
Now that you have a dropdown component, you need to configure a local variable to save the selected dropdown value. After, you'll configure a filter on the chart to only display sales by the selected value.
Since you want a category selection to appear on the chart when it first loads, you’ll also add a default value to your local variable.
To add the local variable:
In your interface, click EXPRESSION in the title bar.
Modify the Interface Definition by making the highlighted changes to the expression:
+ a!localVariables(
+ local!category: "Bikes",
{
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!dropdownField(
label: "Product Categories",
labelPosition: "ABOVE",
placeholder: "--- Select a Value ---",
choiceLabels: cons!AR_CATEGORIES,
choiceValues: cons!AR_CATEGORIES,
saveInto: {},
searchDisplay: "AUTO",
validations: {}
)
}
),
a!columnLayout(contents: {}),
a!columnLayout(contents: {})
}
),
a!lineChartField(
data: a!recordData(
recordType: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order',
filters: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.fields.{fbcc99f6-1ddf-4923-903b-18122a1737c6}orderDate',
operator: "between",
value: /* Trailing 12 Months */toDatetime(
{
eomonth(today(), - 13) + 1,
eomonth(today(), - 1) + 1
}
)
)
},
ignoreFiltersWithEmptyValues: true
)
),
config: a!lineChartConfig(
primaryGrouping: a!grouping(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.fields.{fbcc99f6-1ddf-4923-903b-18122a1737c6}orderDate',
alias: "orderDate_month_primaryGrouping",
interval: "MONTH_SHORT_TEXT"
),
measures: {
a!measure(
label: "Total Sales",
function: "SUM",
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.relationships.{0bde4028-fd7a-411f-97ad-7ad5b84e0d18}orderDetail.fields.{db456082-5f77-4765-bc3e-f662651e0d52}lineTotal',
alias: "lineTotal_sum_measure1"
),
a!measure(
label: "Product Category: Bikes",
function: "SUM",
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.relationships.{0bde4028-fd7a-411f-97ad-7ad5b84e0d18}orderDetail.fields.{db456082-5f77-4765-bc3e-f662651e0d52}lineTotal',
filters: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: 'recordType!{bec4a875-9980-4bbf-a38c-c492ebed065a}Order Detail.relationships.{eee8c0a6-46b0-4cb7-9faf-be492400cc41}product.relationships.{d3a62d4a-3268-48dc-9563-3b99c33715d1}productSubcategory.relationships.{61e25c34-c4ba-4315-8da4-b2ed06d9b5ae}productCategory.fields.{963f051f-baea-4a23-8481-e365bf972a74}name',
operator: "=",
value: "Bikes"
)
},
ignoreFiltersWithEmptyValues: true
),
alias: "lineTotal_sum_measure2"
)
},
dataLimit: 100
),
label: "Monthly Sales ",
labelPosition: "ABOVE",
showLegend: true,
showTooltips: true,
colorScheme: "CLASSIC",
height: "MEDIUM",
xAxisStyle: "STANDARD",
yAxisStyle: "STANDARD",
refreshAfter: "RECORD_ACTION"
)
}
+ )
Now that you have a local variable to store the selected category, we can update the dropdown component to use local!category as the saveInto value, and add a filter using local!category to filter the chart by category.
To use the local variable to filter the chart:
In the a!dropdownField() configuration (line 8), add the following parameter and values highlighted below:
a!dropdownField(
label: "Product Categories",
labelPosition: "ABOVE",
placeholder: "--- Select a category ---",
choiceLabels: cons!AR_CATEGORIES,
choiceValues: cons!AR_CATEGORIES,
+ value: local!category,
saveInto: local!category,
searchDisplay: "AUTO",
validations: {}
)
In the a!areaChartConfig() configuration (line 47), update the following values highlighted below:
...
config: a!areaChartConfig(
primaryGrouping: a!grouping(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.fields.{fbcc99f6-1ddf-4923-903b-18122a1737c6}orderDate',
alias: "orderDate_month_primaryGrouping",
interval: "MONTH_TEXT"
),
measures: {
a!measure(
label: "Total Sales",
function: "SUM",
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.relationships.{0bde4028-fd7a-411f-97ad-7ad5b84e0d18}orderDetail.fields.{db456082-5f77-4765-bc3e-f662651e0d52}lineTotal',
alias: "lineTotal_sum_measure1"
),
a!measure(
label: "Product Category: " & local!category,
function: "SUM",
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.relationships.{0bde4028-fd7a-411f-97ad-7ad5b84e0d18}orderDetail.fields.{db456082-5f77-4765-bc3e-f662651e0d52}lineTotal',
filters: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: 'recordType!{bec4a875-9980-4bbf-a38c-c492ebed065a}Order Detail.relationships.{eee8c0a6-46b0-4cb7-9faf-be492400cc41}product.relationships.{d3a62d4a-3268-48dc-9563-3b99c33715d1}productSubcategory.relationships.{61e25c34-c4ba-4315-8da4-b2ed06d9b5ae}productCategory.fields.{963f051f-baea-4a23-8481-e365bf972a74}name',
operator: "=",
value: local!category
)
},
ignoreFiltersWithEmptyValues: true
),
alias: "lineTotal_sum_measure2"
)
...
Click SAVE CHANGES.
Full SAIL Code :
a!localVariables(
local!category: "Bikes",
{
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!dropdownField(
label: "Product Categories",
labelPosition: "ABOVE",
placeholder: "--- Select a Value ---",
choiceLabels: cons!AR_CATEGORIES,
choiceValues: cons!AR_CATEGORIES,
value: local!category,
saveInto: local!category,
searchDisplay: "AUTO",
validations: {}
)
}
),
a!columnLayout(contents: {}),
a!columnLayout(contents: {})
}
),
a!areaChartField(
data: a!recordData(
recordType: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order',
filters: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.fields.{fbcc99f6-1ddf-4923-903b-18122a1737c6}orderDate',
operator: "between",
value: {
todatetime("01/01/2021"),
todatetime("12/31/2021")
}
)
},
ignoreFiltersWithEmptyValues: true
)
),
config: a!areaChartConfig(
primaryGrouping: a!grouping(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.fields.{fbcc99f6-1ddf-4923-903b-18122a1737c6}orderDate',
alias: "orderDate_month_primaryGrouping",
interval: "MONTH_SHORT_TEXT"
),
measures: {
a!measure(
label: "Total Sales",
function: "SUM",
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.relationships.{0bde4028-fd7a-411f-97ad-7ad5b84e0d18}orderDetail.fields.{db456082-5f77-4765-bc3e-f662651e0d52}lineTotal',
alias: "lineTotal_sum_measure1"
),
a!measure(
label: "Product Category: " & local!category,
function: "SUM",
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.relationships.{0bde4028-fd7a-411f-97ad-7ad5b84e0d18}orderDetail.fields.{db456082-5f77-4765-bc3e-f662651e0d52}lineTotal',
filters: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: 'recordType!{bec4a875-9980-4bbf-a38c-c492ebed065a}Order Detail.relationships.{eee8c0a6-46b0-4cb7-9faf-be492400cc41}product.relationships.{d3a62d4a-3268-48dc-9563-3b99c33715d1}productSubcategory.relationships.{61e25c34-c4ba-4315-8da4-b2ed06d9b5ae}productCategory.fields.{963f051f-baea-4a23-8481-e365bf972a74}name',
operator: "=",
value: local!category
)
},
ignoreFiltersWithEmptyValues: true
),
alias: "lineTotal_sum_measure2"
)
},
dataLimit: 100,
showIntervalsWithNoData: true
),
label: "Monthly Sales in 2021",
labelPosition: "ABOVE",
stacking: "NONE",
showLegend: true,
showTooltips: true,
colorScheme: "CLASSIC",
height: "MEDIUM",
xAxisStyle: "STANDARD",
yAxisStyle: "STANDARD",
refreshAfter: "RECORD_ACTION"
)
}
)
| Solve the following leet code problem |
Expand/Collapse Rows in a Tree Grid
Create a grid that shows hierarchical data and allows users to dynamically expand and collapse rows within the grid.
This scenario demonstrates:
How to use the rich text display component inside an editable grid to create a tree grid.
How to use a rich text display component to create a dynamic link used to expand and collapse the rows in an editable grid.
How to create a rich text bulleted list within a rich text display component inside each collapsible row in the tree grid.
| SetupCopy link to clipboard
For this recipe, you'll need two Data Store Entities that are populated with data:
Create a custom data type called PurchaseRequest with the following fields:
id (Number (Integer))
summary (Text)
Designate the id field as the primary key and set to generate value.
See also: Primary Keys
Save and publish the CDT.
Create a custom data type called PurchaseRequestItem with the following fields:
id (Number (Integer))
summary (Text)
qty (Number (Integer))
unitPrice (Number (Decimal))
purchaseRequest (PurchaseRequest)
Designate the id field as the primary key and set to generate value.
Save and publish the CDT.
Create a Data Store called "Purchase Request" with two entities, one of each data type that was just created:
PurchaseRequests (PurchaseRequest)
PurchaseRequestItems (PurchaseRequestItem)
Insert the following values into PurchaseRequest:
id summary
1 PR 1
2 PR 2
Insert the following values into PurchaseRequestItem:
id summary qty unitPrice purchaseRequest.id
1 Item 1 2 10 1
2 Item 2 3 50 1
3 Item 3 1 100 1
4 Item 4 3 75 2
5 Item 5 10 25 2
Now that we have the data, let's create a couple of supporting constants:
PR_ENTITY: A constant of type Data Store Entity with value PurchaseRequests.
PR_ITEM_ENTITY: A constant of type Data Store Entity with value PurchaseRequestItems.
Now that we have created all of the supporting objects, let's move on to the main expression.
SAIL Code:
a!localVariables(
local!prs: a!queryEntity(
entity: cons!PR_ENTITY,
query: a!query(
/* To return all fields, leave the selection parameter blank. `*/
/*`If you are not displaying all fields, use the selection `*/
/*` parameter to only return the necessary fields */
pagingInfo: a!pagingInfo(startIndex: 1, batchSize: -1)
)
).data,
local!items: a!queryEntity(
entity: cons!PR_ITEM_ENTITY,
query: a!query(
pagingInfo: a!pagingInfo(startIndex: 1, batchSize: -1)
)
).data,
a!gridLayout(
headerCells: {
a!gridLayoutHeaderCell(label: "Summary"),
a!gridLayoutHeaderCell(label: "Qty", align: "RIGHT"),
a!gridLayoutHeaderCell(label: "Unit Price", align: "RIGHT"),
a!gridLayoutHeaderCell(label: "Total Price", align: "RIGHT")
},
columnConfigs: {
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight: 4),
a!gridLayoutColumnConfig(width: "DISTRIBUTE"),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight: 2),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight: 2)
},
rowHeader: 1,
rows: a!forEach(
items: local!prs,
expression: a!localVariables(
local!expanded: false,
local!itemsForPr: index(
local!items,
/* Must cast to integer because a!queryEntity() returns a dictionary */
wherecontains(tointeger(fv!item.id), local!items.purchaseRequest.id),
{}
),
local!totalPrice: sum(
a!forEach(
items: local!itemsForPr,
expression:
tointeger(fv!item.qty) * todecimal(fv!item.unitPrice)
)
),
{
a!gridRowLayout(
contents: {
a!richTextDisplayField(
label: "Summary " & fv!index,
value: {
if(
length(local!itemsForPr)=0,
fv!item.summary,
a!richTextItem(
text: if(local!expanded, "-", "+") &" "& fv!item.summary,
link: a!dynamicLink(
value: not(local!expanded),
saveInto: local!expanded
)
)
)
}
),
a!textField(
label: "Qty " & fv!index,
readOnly: true
),
a!textField(
label: "Unit Price " & fv!index,
readOnly: true
),
a!textField(
label: "Total Price " & fv!index,
value: a!currency(
isoCode: "USD",
value: local!totalPrice
),
readOnly: true,
align: "RIGHT"
)
}
),
if(
local!expanded,
a!forEach(
items: local!itemsForPr,
expression: a!gridRowLayout(contents: {
a!richTextDisplayField(
label: "Item Summary " & fv!index,
value: a!richTextBulletedList(
items: fv!item.summary
)
),
a!integerField(
label: "Item Qty " & fv!index,
value: fv!item.qty,
readOnly: true,
align: "RIGHT"
),
a!textField(
label: "Item Unit Price " & fv!index,
value: a!currency(
isoCode: "USD",
value: fv!item.unitPrice)
,
readOnly: true,
align: "RIGHT"
),
a!textField(
label: "Item Total Price " & fv!index,
value: a!currency(
isoCode: "USD",
value: tointeger(fv!item.qty) * todecimal(fv!item.unitPrice)
),
readOnly: true,
align: "RIGHT"
)
})
),
{}
)
}
)
)
)
)
Notice that we used a rich text display component to create a dynamic link used to expand and collapse the item rows for each purchase request. Alternatively, we could have used a link component containing the same dynamic link. The rich text display component would be useful here if a rich text style (e.g. underline) needed to be applied to the purchase request summary or if the summary needed to be a combination of links and normal text.
The bullet appearing in front of each item summary is made possible by using a rich text bulleted list within a rich text display component. See also: Rich Text
We left the selection parameter blank in our a!query()function because we wanted to return all fields of the entities that we were querying.
| Solve the following leet code problem |
Filter the Data in a Grid
Configure a user filter for your read-only grid that uses a record type as the data source. When the user selects a value to filter by, update the grid to show the result.
This design pattern is not recommended for offline interfaces because reflecting immediate changes in an interface based on user interaction requires a connection to the server.
| Filter the rows in a grid
User filters on your read-only grid allow users to select a filter and return only the records that match the filter value. When you use a record type as the data source for your read-only grid, there are two ways to configure user filters on the grid.
In design mode, you can quickly and easily bring any user filters configured in the record type into your grid. In expression mode, you can use the filter parameter in the a!recordData() function to manually configure a user filter for a specific grid. This type of user filter is considered single-use because it is not configured in the record type.
The patterns on this page demonstrate both methods for configuring user filters on your grid.
Applying a filter from the record type
Walk through the steps below to bring a user filter configured on a record type into your read-only grid.
Replace the Employee record type used in this example with a record type in your environment. Be sure there is at least one user filter configured on your record type.
To add a user filter from your record type to the grid:
Note: This example will not evaluate in your test interface and should only be used as a reference.
In the Build view of your application, click NEW > Interface.
From the COMPONENTS PALETTE, drag and drop the READ-ONLY GRID component onto your interface.
From the DATA section in the COMPONENT CONFIGURATION pane, select Record Type as your Data Source.
In the Search record types field, enter the Employee record type. Note: Replace Employee with the name of your record type.
From the RECORD LIST section in the COMPONENT CONFIGURATION pane, select the Department user filter in the User Filter dropdown. Note: Replace Department with the name of the user filter configured on your record type.
The Department user filter is applied to the grid. When the user selects a specific department, the grid will only display the records that match the filter value.
/SAIL Recipe Filter Data in a Grid
You can test the grid by selecting a title from the filter dropdown. Notice that only the employee records that match the selected title are visible in the grid. The result displays on page 1 even if the user was previously on a different page number.
See Create a Record Type for more information about configuring user filters on a record type and Configuring the Read-Only Grid for more information about configuring a read-only grid.
Manually creating a filter on the grid
This pattern demonstrates how to use a!gridField() to configure a read-only grid and manually configure a user filter dropdown for the grid.
Use the pattern in this example as a template to configure a user filter for a specific grid only. If you plan to reuse the user filter across multiple read-only grids, it is best practice to configure the user filter in the record type. This allows you to quickly and easily bring the filter into any grid that uses the record type as the data source.
ExpressionCopy link to clipboard
The expression pattern below shows you how to:
Manually configure a user filter for a specific grid only.
Use a!localVariables to store the filter value a user selects.
Use a!dropdownField() to configure a filter dropdown for the grid.
SAIL Code :
a!localVariables(
/* In your application, replace the values used in local!titles with a
* constant that stores the filter values you want to use in your grid.
* Then use cons!<constant name> to reference the constant in
* local!titles. */
local!titles: {"Analyst", "Consultant", "Director", "Manager", "Sales Associate", "Software Engineer"},
/* Use a local variable to hold the name of the title filter the user
* selects in the filter dropdown. This example, uses
* local!selectedTitle */
local!selectedTitle,
a!sectionLayout(
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!richTextDisplayField(
label: "",
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
/* We used ampersand (&) to concatenate the title
* text we want to display at the top of the grid.
* When the user selects a title filter in the
* dropdown list, the grid will display "ALL
* <local!selectedTitle> EMPLOYEES". If no filter
* is selected, the grid * will display "ALL
* EMPLOYEES". */
text: {
"All"& " "&if(isnull(local!selectedTitle),"EMPLOYEE", upper(local!selectedTitle))&"S"
},
size: "MEDIUM_PLUS",
style: {
"STRONG"
}
)
}
),
a!dropdownField(
label: "Title",
labelPosition: "ABOVE",
placeholder: "-- Filter By Title --",
choiceLabels: local!titles,
choiceValues: local!titles,
value: local!selectedTitle,
saveInto: local!selectedTitle
)
},
width: "MEDIUM"
)
}
),
a!gridField(
labelPosition: "ABOVE",
data: a!recordData(
recordType: recordType!Employee,
filters: a!queryFilter(
field: recordType!Employee.fields.title,
operator: if(isnull(local!selectedTitle), "not null", "="),
value: local!selectedTitle
)
),
columns: {
a!gridColumn(
label: "Name",
sortField: recordType!Employee.fields.lastName,
value: a!linkField(
links: a!recordLink(
label: fv!row[recordType!Employee.fields.firstName] & " " & fv!row[recordType!Employee.fields.lastName],
recordType: {
recordType!Employee
},
identifier: fv!row[recordType!Employee.fields.lastName]
)
),
width: "1X"
),
a!gridColumn(
label: "Title",
sortField: recordType!Employee.fields.title,
value: fv!row[recordType!Employee.fields.title],
width: "1X"
),
a!gridColumn(
label: "Department",
sortField: recordType!Employee.fields.department,
value: fv!row[recordType!Employee.fields.department],
width: "1X"
)
},
pageSize: 10,
showSearchBox: false,
showRefreshButton: false,
)
}
)
)
| Solve the following leet code problem |
Filter the Data in a Grid Using a Chart.
Display an interactive pie chart with selectable sections so that a user may filter the results in a grid.
This design pattern is not recommended for offline interfaces because reflecting immediate changes in an interface based on user interaction requires a connection to the server.
This interface has two main components: (1) a grid listing all of a company’s employees, and (2) a pie chart with dynamic link sections capable of filtering the grid by department.
This scenario demonstrates:
How to use an expression to add links to each slice of the pie chart and use those links to filter grid data.
How to use multiple datasubsets.
| Create this patternCopy link to clipboard
This recipe uses references to record types and record fields. To use this recipe, you will need to update the references to record types and record fields in your application.
SAIL Code:
a!localVariables(
local!chartDataSubset: a!queryRecordType(
recordType: recordType!Employee,
/* Grouping on department then counting the total ids in that group
for the pie chart to size. This returns an array of departments
with the total number of employees in that department. It looks
like this: { {department:Engineering, id: 6}...} */
fields: a!aggregationFields(
groupings: a!grouping(
field: recordType!Employee.fields.department,
alias: "department"
),
measures: a!measure(
field: recordType!Employee.fields.id,
function: "COUNT",
alias: "id_measure"
)
),
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: 5000,
sort: a!sortInfo(
field: "department",
ascending: true
)
)
),
/* local!selectedDepartment holds the name of the selected pie chart section. */
local!selectedDepartment,
a!sectionLayout(
contents: {
a!pieChartField(
series: a!forEach(
items: local!chartDataSubset.data,
expression: a!chartSeries(
label: fv!item.department,
data: fv!item.id,
links: a!dynamicLink(
/* The dynamic link stores the department value into local!selectedDepartment. */
value: fv!item.department,
saveInto: local!selectedDepartment
)
)
),
colorScheme: "MIDNIGHT"
),
a!linkField(
labelPosition: "COLLAPSED",
links: a!dynamicLink(
label: "Show all employees",
value: null,
saveInto: { local!selectedDepartment }
),
showWhen: not(isnull(local!selectedDepartment))
),
a!gridField(
label: if(
isnull(local!selectedDepartment),
"All Employees",
"Employees in " & local!selectedDepartment
),
emptyGridMessage: "No employees meet this criteria",
data: a!recordData(
recordType: recordType!Employee,
/* Filter the department column based on the value of local!selectedDepartment. */
filters: a!queryLogicalExpression(
operator: "AND",
filters: a!queryFilter(
field: recordType!Employee.fields.department,
operator: "=",
value: local!selectedDepartment
),
ignorefilterswithemptyvalues: true
)
),
columns: {
a!gridColumn(
label: "First Name",
sortField: recordType!Employee.fields.firstName,
value: fv!row[recordType!Employee.fields.firstName]
),
a!gridColumn(
label: "Last Name",
sortField: recordType!Employee.fields.lastName,
value: fv!row[recordType!Employee.fields.lastName]
),
a!gridColumn(
label: "Title",
sortField: recordType!Employee.fields.title,
value: fv!row[recordType!Employee.fields.title]
)
}
)
}
)
)
Notice that when the grid is filtered, we are not querying the department field. This allows us to only query the data that we plan on displaying in the grid.
| Solve the following leet code problem |
Format the User's Input
Format the user's input as a telephone number in the US and save the formatted value, not the user's input.
This expression uses the text() function to format the telephone number. You may choose to format using your own rule, so you would create the supporting rule first, and then create an interface with the main expression.
This scenario demonstrates:
How to configure a field to format a user's input
|
SAIL Code:
a!localVariables(
local!telephone,
a!textField(
label: "Employee Telephone Number",
instructions: "Value saved: " & local!telephone,
value: local!telephone,
saveInto: a!save(
local!telephone,
text(save!value, "###-###-####;###-###-####")
)
)
)
| Solve the following leet code problem |
Limit the Number of Rows in a Grid That Can Be Selected
Limit the number of rows that can be selected to an arbitrary number.
This scenario demonstrates:
How to configure grid selection in a Read-Only Grid.
How to limit selection to an arbitrary number.
How to remove selections without clicking through pages.
| a!localVariables(
local!selection,
/* This is the maximum number of rows you can select from the grid. */
local!selectionLimit: 2,
/*This variable would be used to pass the full rows of data on the selected items out of this interface, such as to a process model. */
local!selectedEmployees,
{
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!gridField(
label: "Employees",
labelPosition: "ABOVE",
instructions: "Select up to " & local!selectionLimit & " employees.",
data: recordType!Employee,
columns: {
a!gridColumn(
label: "ID",
sortField: "id",
value: fv!row[recordType!Employee.fields.id],
width: "ICON"
),
a!gridColumn(
label: "First Name",
sortField: "firstName",
value: fv!row[recordType!Employee.fields.firstName]
),
a!gridColumn(
label: "Last Name",
sortField: "lastName",
value: fv!row[recordType!Employee.fields.lastName]
),
a!gridColumn(
label: "Phone Number",
sortField: "phoneNumber",
value: fv!row[recordType!Employee.fields.phoneNumber]
)
},
pagesize: 10,
selectable: true,
selectionstyle: "ROW_HIGHLIGHT",
/* This is where we pass the maximum number of rows you can select into the grid. */
maxSelections: local!selectionLimit,
selectionvalue: local!selection,
showSelectionCount: "ON",
selectionSaveInto: {
local!selection,
/*This save adds the full rows of data for items selected in the most recent user interaction to local!selectedEmployees. */
a!save(
local!selectedEmployees,
append(
local!selectedEmployees,
fv!selectedRows
)
),
/*This save removes the full rows of data for items deselected in the most recent user interaction to local!selectedEmployees. */
a!save(
local!selectedEmployees,
difference(
local!selectedEmployees,
fv!deselectedRows
)
)
}
),
},
width: "WIDE"
),
a!columnLayout(
contents: {
a!sectionLayout(
label: "Selected Employees",
contents: {
a!richTextDisplayField(
value: if(
or(
isnull(local!selectedEmployees),
length(local!selectedEmployees) = 0
),
a!richTextItem(text: "None", style: "EMPHASIS"),
{}
),
marginBelow: "NONE"
),
a!forEach(
local!selectedEmployees,
a!cardLayout(
contents: {
a!sideBySideLayout(
items: {
a!sideBySideItem(
item: a!richTextDisplayField(
value: {
if(
or(
isnull(local!selectedEmployees),
length(local!selectedEmployees) = 0
),
a!richTextItem(text: "None", style: "EMPHASIS"),
{
a!richTextIcon(icon: "USER-CIRCLE", color: "ACCENT")
}
)
},
marginBelow: "LESS"
),
width: "MINIMIZE"
),
a!sideBySideItem(
item: a!richTextDisplayField(
value: {
if(
or(
isnull(local!selectedEmployees),
length(local!selectedEmployees) = 0
),
a!richTextItem(text: "None", style: "EMPHASIS"),
{ a!richTextItem(text: fv!item.[recordType!Employee.fields.firstName] & " " & fv!item.[recordType!Employee.fields.lastName] ) }
)
},
marginBelow: "LESS"
)
),
a!sideBySideItem(
item: a!richTextDisplayField(
value: {
if(
or(
isnull(local!selectedEmployees),
length(local!selectedEmployees) = 0
),
a!richTextItem(text: "None", style: "EMPHASIS"),
{
a!richTextIcon(
icon: "times",
link: a!dynamicLink(
value: fv!index,
saveInto: {
a!save(
local!selection,
remove(local!selection, fv!index)
),
a!save(
local!selectedEmployees,
remove(local!selectedEmployees, fv!index)
)
}
),
linkStyle: "STANDALONE",
color: "SECONDARY"
),
char(10)
}
)
},
marginBelow: "LESS"
),
width: "MINIMIZE"
)
}
)
},
marginBelow: "EVEN_LESS"
)
)
}
),
}
)
}
)
}
)
| Solve the following leet code problem |
Make a Component Required Based on a User Selection
Make a paragraph component conditionally required based on the user selection.
This scenario demonstrates:
How to configure a required parameter of one component based off the interaction of another
| a!localVariables(
local!isCritical,
local!phoneNumber,
a!formLayout(
label: "Example: Conditionally Required Field",
contents:{
a!columnsLayout(
columns:{
a!columnLayout(
contents:{
a!checkboxField(
label: "Is Mission Critical",
choiceLabels: "Check the box if the employee will be on a mission critical team",
choiceValues: {true},
value: local!isCritical,
saveInto: local!isCritical
)
}
),
a!columnLayout(
contents:{
a!textField(
label: "Cell Number",
placeholder:"555-456-7890",
required: local!isCritical,
value: local!phoneNumber,
saveInto: local!phoneNumber,
validations: if( len(local!phoneNumber) > 12, "Contains more than 12 characters. Please reenter phone number, and include only numbers and dashes", null )
)
}
)
}
)
},
buttons:a!buttonLayout(
primaryButtons:{
a!buttonWidget(
label:"Submit",
submit: true
)
}
)
)
)
| Solve the following leet code problem |
Offline Mobile Task Report
Display a task report for a user that will work in Appian Mobile, even when the user is offline.
| You can create offline mobile tasks that users can access on Appian Mobile even if they don't have an internet connection.
To display these tasks in a task report, you'll need to follow the Design Best Practices for Offline Mobile.
Specifically, you will need to:
Load the data you need at the top of the interface.
Get the value for partially supported functions at the top of the interface, like the process task link component and user() function.
You will do this by creating local variables at the top of the interface expression. When a user refreshes their tasks while they are online, the local variables will be evaluated and their data will be cached on the device. That way, the data will be available even if the user is offline. For more information about how offline mobile works with data, see How Offline Mobile Works.
See alsoCopy link to clipboard
For more information about creating and configuring task reports, see:
Task Report Tutorial
Configuring Process Reports
Process Report Object
Process and Process Report Data
For the drag-and-drop pattern that can be used in non-offline mobile interfaces, see the Task Report Pattern.
Create a task report and constantCopy link to clipboard
For this recipe, you'll need to create a task report and a constant to reference the task report.
For simplicity, we'll duplicate the Active Tasks prebuilt system report. But if you'd like, you can use one of the other prebuilt system task reports, or create and edit a custom process report.
To create a new task report and constant:
In the Build view of your application, click NEW > Process Report.
Select Duplicate existing process report.
For Process Report to Duplicate, select active_tasks.
Enter a Name for the report.
For Save In, select a folder to save the report in.
Click CREATE.
Create a constant of type Document and select the process report for the Value.
Create an interface and enable it for offline mobileCopy link to clipboard
Create an interface.
Select EXPRESSION mode.
Copy and paste the interface expression into the Interface Definition.
Replace the cons!MY_ACTIVE_TASKS constant with the constant you created.
Click the settings icon > Properties.
Select Make Available Offline and click OK.
Interface expressionCopy link to clipboard
This expression is based off of the task report pattern, but it doesn't use a!forEach() to dynamically create the grid rows. Use this pattern if you know which columns your task report has and want the expression to be a bit more straightforward. You may need to update the columns with the columns from your task report.
See Configuring Process Reports for more information displaying task report data in an interface.
SAIL Code :
a!localVariables(
/* The task data returned by a process analytics query */
local!taskReportData: a!queryProcessAnalytics(
/* Replace this constant with a Document constant that uses a task report for the value */
report: cons!MY_ACTIVE_TASKS,
query: a!query(
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: -1,
sort: a!sortInfo(field: "c2")
)
)
),
/* a!processTaskLink() is partially compatible with offline mobile so
we call it in a local variable at the top of the interface */
local!processTaskLinks: a!forEach(
items: local!taskReportData,
/* In order to save the process task link for each row, we use update() to update the data
returned from local!taskReportData. For each row of data, we insert a new field
called "link" with the value of a!processTaskLink() for that row */
expression: a!update(
data: fv!item,
index: "link",
value: a!processTaskLink(
label: fv!item.c0,
task: fv!item.dp0
)
)
),
/* Because we also want to use the user() and group() functions to display the assignees,
we use update() to update the data returned from local!processTaskLinks. For each row of data we
insert a new field called "assigned" with the value of user() or group() for each row. */
local!updateOfflineData: a!forEach(
items: local!processTaskLinks,
expression: a!update(
data: fv!item,
index: "assigned",
/* Because tasks can be assigned to multiple users or groups,
we use a!forEach() to evaluate the if() logic for each user or group */
value: a!forEach(
items: fv!item.c8,
expression: if(
/* Check if User (which returns 4 for the runtime type number), otherwise its a Group */
runtimetypeof(fv!item) = 4,
if(a!isNotNullOrEmpty(fv!item), user(fv!item, "firstName") & " " & user(fv!item, "lastName"), ""),
if(a!isNotNullOrEmpty(fv!item), group(fv!item, "groupName"), "")
)
)
)
),
{
a!sectionLayout(
label: "Employee Tasks",
labelColor: "SECONDARY",
contents: {
a!gridField(
labelPosition: "COLLAPSED",
/* For the grid data, we use local!updateOfflineData,
which contains the new "link" and "assigned" fields */
data: local!updateOfflineData,
columns: {
a!gridColumn(
label: "Name",
value: a!linkField(
/* We reference the value for a!processTaskLink() using the new field name, "link" */
links: fv!row.link
)
),
a!gridColumn(
label: "Process",
value: fv!row.c3
),
a!gridColumn(
label: "Status",
value: a!match(
value: fv!row.c5,
equals: 0,
then: a!richTextDisplayField(
value: {a!richTextIcon(icon: "user-o", color: "#666666")," Assigned"}
),
equals: 1,
then: a!richTextDisplayField(
value: {a!richTextIcon(icon: "user-check", color: "ACCENT")," Accepted"}
),
default: fv!value
)
),
a!gridColumn(
label: "Assigned To",
/* We reference the user and group names using the new field name, "assigned" */
value: fv!row.assigned
),
a!gridColumn(
label: "Assigned On",
value: fv!row.c2
)
},
pageSize: 10,
borderStyle: "LIGHT",
rowHeader: 1
)
}
)
}
)
Display the task report on a site page.
To display the task report on a site page, you will need to configure it as an action. To do this, you will create a process model and add it as an action type page in a site.
To configure a process model to use the interface as a start form:
Create a process model.
Right-click the Start Node and select Process Start Form.
For Interface select the interface you created and click OK.
Click File > Save & Publish.
To create a site that displays the task report:
Create a site.
Click ADD PAGE and give the page a Title.
For Type, select Action.
For Content, select the process model you created and click ADD.
Click SAVE CHANGES.
Test the task report in Appian Mobile
Offline mobile interfaces evaluate differently in Appian Mobile than they do in a browser. In a browser, they evaluate like any other interface. In Appian Mobile, they sync with the server when the interface loads, then store that data on the device so that the user can access it whether they are online or offline.
In order to verify the offline-enabled task report works correctly on Appian Mobile, you need to test it in the Appian Mobile app.
To test the task report in Appian Mobile:
On a mobile device, open the Appian Mobile app.
Navigate to the site you created and select the page with the task report.
Select a task and use the paging in the grid. Verify that there are no errors.
Note: After syncing a custom task list, Appian recommends waiting approximately 5 minutes before opening an offline task to ensure all tasks have time to download to the device. If a user opens a task before the download completes, there is a chance that some of the data they enter into the form could be lost. The strength of their internet connection, volume of data, and memory capacity on the device will affect how quickly the tasks are downloaded to the device.
| Solve the following leet code problem |
Percentage of Online Sales
This pattern illustrates how to calculate the percent of sales generated from online orders and display it in a gauge component. This pattern also provides a sample scenario to show how you can take common business requirements and quickly turn them into a report.
You'll notice that this pattern provides more than just an expression, it shows you the fastest way to build reports in Design Mode. To get the most out of this pattern, follow the steps in Create this pattern to learn how to build advanced reports using the latest low-code features
| ScenarioCopy link to clipboard
Account managers at the Appian Retail company want to know how much of their 2021 sales were generated from online sales so they can determine if they need to do more online advertising, or hire more in-person staff.
To show the percentage of online sales, you’ll use the pattern on this page to create a query using a!queryRecordType() to calculate the sum of sales for all orders purchased in 2021 and the sum of sales for orders purchased online in 2021. Then, you'll uses a gauge component to calculate and display the percentage of online sales generated in 2021.
To allow account managers to better understand whether online sales are growing, stagnant, or decreasing, you'll also create a second gauge component that shows the percentage of online sales generated in 2020.
SetupCopy link to clipboard
This pattern uses data from the Appian Retail application, available for free in Appian Community Edition. To follow along with this pattern, log in to Appian Community to request the latest Appian Community Edition site.
If you do not see the Appian Retail application available in your existing Appian Community Edition, you can request a new Appian Community Edition to get the latest application contents available.
This pattern will use data from the following record types in the Appian Retail application:
Order record type: Contains order information like the order number, date, status, and whether it was purchased online or in stores. For example, order number SO43659 was purchased in stores on 5/31/2019 and the order is closed.
Order Detail record type: Contains specific order details like the number of order items, order totals, promo codes applied, and products. For example, the order above contained one product that cost $2,024.99.
Create this patternCopy link to clipboard
To create this pattern, you will:
Get the sum of total sales and the sum of online sales for orders purchased in 2021.
Show the percentage of online sales in 2021.
Get the sum of total sales and the sum of online sales for orders purchased in 2020.
Show the percentage of online sales in 2020.
Step 1: Get the sum of total sales and the sum of online sales for orders purchased in 2021Copy link to clipboard
Your first step is to get the sum of sales for all orders purchased in 2021, and the sum of sales for orders purchased online this year. To calculate these values, you'll create a query using a!queryRecordType() and save the value in a local variable within an interface.
In the query, you'll filter the data so you only return orders from 2021. Then, you'll group by the year when the order was made, and calculate two measures: the sum of all orders, and the sum of orders that have the onlineOrderFlag equal to 1, where 1 means the order was made online, and 0 means the order was made in-stores.
We'll use this query in the next step to calculate the percentage in the gauge component.
To calculate these values:
In the Appian Retail application, go to the Build view.
Click NEW > Interface.
Configure the interface properties and click CREATE.
Click EXPRESSION in the title bar.
Copy and paste the following expression. This creates a local variable with our query, and includes a column layout that we'll use later in this pattern:
Note: These record type references are specific to the Appian Retail application. If you're following along in the Appian Retail application, you can copy and paste this expression without updating the record type references.
SAIL CODE:
a!localVariables(
local!onlineSales2021: a!queryRecordType(
recordType: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order',
/* Only include orders created in 2021 */
filters: {
a!queryFilter(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.fields.{fbcc99f6-1ddf-4923-903b-18122a1737c6}orderDate',
operator: "BETWEEN",
value: {
todatetime("01/01/2021"),
todatetime("12/31/2021")
}
)
},
fields: {
a!aggregationFields(
/* Group by the order date year */
groupings: a!grouping(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.fields.{fbcc99f6-1ddf-4923-903b-18122a1737c6}orderDate',
interval: "YEAR",
alias: "orderDateYear"
),
measures: {
/* Get the sum of all orders */
a!measure(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.relationships.{0bde4028-fd7a-411f-97ad-7ad5b84e0d18}orderDetail.fields.{db456082-5f77-4765-bc3e-f662651e0d52}lineTotal',
function: "SUM",
alias: "totalSales"
),
/* Get the sum of all orders that have an online order flag */
a!measure(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.relationships.{0bde4028-fd7a-411f-97ad-7ad5b84e0d18}orderDetail.fields.{db456082-5f77-4765-bc3e-f662651e0d52}lineTotal',
function: "SUM",
alias: "onlineSales",
filters: {
a!queryFilter(
field: 'recordType!{bec4a875-9980-4bbf-a38c-c492ebed065a}Order Detail.relationships.{e6b1dbca-6c3c-4540-a093-3c581a73ad17}order.fields.{5bade7d5-5fbc-4cc4-807f-907f8f65969b}onlineOrderFlag',
operator: "=",
value: 1
),
}
)
}
)
},
pagingInfo: a!pagingInfo(1, 10)
).data,
/* Column layout that we'll use for our gauge components */
{
a!columnsLayout(
columns: {
a!columnLayout(contents: {}),
a!columnLayout(contents: {})
}
)
}
)
Step 2: Show the percentage of online sales in 2021Copy link to clipboard
Now that you have a query that calculates your total sales in 2021 and your sales from online orders that year, you can calculate the percentage of online sales directly in a gauge component.
To calculate and display the percentage of online sales in 2021:
In your interface, click DESIGN in the title bar. A column layout with two columns appears.
From the PALETTE, drag a GAUGE component into the left column layout.
In the Gauge component configuration, hover over Fill Percentage and click Edit as Expression.
In the Fill Percentage dialog, replace the existing value with the following expression. This will calculate the percent of online sales:
SAIL code :
local!onlineSales2021.onlineSales / local!onlineSales2021.totalSales * 100
Click OK.
In Secondary Text, enter 2021.
Hover over Tooltip and click Edit as Expression .
In the Tooltip dialog, enter the following expression. This will display the sum of sales for this year.
SAIL Code :
"Online Sales: " & a!currency(
isoCode: "USD",
value: a!defaultValue(local!onlineSales2021.onlineSales,0)
)
Click OK.
Step 3: Get the sum of total sales and the sum of online sales for orders purchased in 2020Copy link to clipboard
Now you need to calculate the percentage of online sales in 2020.
To get this percentage, you first need to gets the sum of sales for all orders purchased in 2020, as well as the sum of sales for orders purchased online that year.
To calculate these values:
In your interface, click EXPRESSION in the title bar.
In the Interface Definition, enter a new line after line 48.
Copy and paste the following expression on line 49. This creates a second local variable with our second query:
SAIL Code:
local!onlineSales2020: a!queryRecordType(
recordType: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order',
/* Only include orders created in 2020 */
filters: {
a!queryFilter(
field:'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.fields.{fbcc99f6-1ddf-4923-903b-18122a1737c6}orderDate',
operator: "BETWEEN",
value: {
todatetime("01/01/2020"),
todatetime("12/31/2020")
}
)
},
fields: {
a!aggregationFields(
/* Group by the order date year */
groupings: a!grouping(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.fields.{fbcc99f6-1ddf-4923-903b-18122a1737c6}orderDate',
interval: "YEAR",
alias: "orderDateYear"
),
measures: {
/* Get the sum of all orders */
a!measure(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.relationships.{0bde4028-fd7a-411f-97ad-7ad5b84e0d18}salesOrderDetail.fields.{db456082-5f77-4765-bc3e-f662651e0d52}lineTotal',
function: "SUM",
alias: "totalSales2020"
),
/* Get the sum of all orders that have an online order flag */
a!measure(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.relationships.{0bde4028-fd7a-411f-97ad-7ad5b84e0d18}salesOrderDetail.fields.{db456082-5f77-4765-bc3e-f662651e0d52}lineTotal',
function: "SUM",
alias: "onlineSales2020",
filters: {
a!queryFilter(
field: 'recordType!{bec4a875-9980-4bbf-a38c-c492ebed065a}Order Detail.relationships.{e6b1dbca-6c3c-4540-a093-3c581a73ad17}salesOrderHeader.fields.{5bade7d5-5fbc-4cc4-807f-907f8f65969b}onlineOrderFlag',
operator: "=",
value: 1
),
}
)
}
)
},
pagingInfo: a!pagingInfo(1,10)
).data,
Step 4: Show the percentage of online sales last yearCopy link to clipboard
Now that you have your query, you'll add a second gauge component to calculate and display the online sales percentage for 2020.
To calculate and display the percentage of online sales in 2020:
In your interface, click DESIGN in the title bar.
From the PALETTE, drag a GAUGE component into the right column layout.
In the Gauge component configuration, hover over Fill Percentage and click Edit as Expression .
In the Fill Percentage dialog, replace the existing value with the following expression:
SAIL Code:
local!onlineSales2020.onlineSales2020 / local!onlineSales2020.totalSales2020 * 100
Click OK.
In Secondary Text, enter 2020.
Hover over Tooltip and click Edit as Expression .
In the Tooltip dialog, enter the following expression:
SAIL Code Expression :
"Online Sales: " & a!currency(
isoCode: "USD",
value: a!defaultValue(local!onlineSales2020.onlineSales2020,0)
)
Click OK.
From the PALETTE, drag a RICH TEXT component above the columns layout and configure the following:
In Display Value, keep the default selection of Use editor.
In the editor, enter Percent of Online Sales.
In the editor, highlight the text, then click Size Size icon and select Medium Header.
Click SAVE CHANGES.
Full SAIL Code expression :
a!localVariables(
local!onlineSales2021: a!queryRecordType(
recordType: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order',
/* Only include orders created in 2021 */
filters: {
a!queryFilter(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.fields.{fbcc99f6-1ddf-4923-903b-18122a1737c6}orderDate',
operator: "BETWEEN",
value: {
todatetime("01/01/2021"),
todatetime("12/31/2021")
}
)
},
fields: {
a!aggregationFields(
/* Group by the order date year */
groupings: a!grouping(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.fields.{fbcc99f6-1ddf-4923-903b-18122a1737c6}orderDate',
interval: "YEAR",
alias: "orderDateYear"
),
measures: {
/* Get the sum of all orders */
a!measure(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.relationships.{0bde4028-fd7a-411f-97ad-7ad5b84e0d18}orderDetail.fields.{db456082-5f77-4765-bc3e-f662651e0d52}lineTotal',
function: "SUM",
alias: "totalSales"
),
/* Get the sum of all orders that have an online order flag */
a!measure(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.relationships.{0bde4028-fd7a-411f-97ad-7ad5b84e0d18}orderDetail.fields.{db456082-5f77-4765-bc3e-f662651e0d52}lineTotal',
function: "SUM",
alias: "onlineSales",
filters: {
a!queryFilter(
field: 'recordType!{bec4a875-9980-4bbf-a38c-c492ebed065a}Order Detail.relationships.{e6b1dbca-6c3c-4540-a093-3c581a73ad17}order.fields.{5bade7d5-5fbc-4cc4-807f-907f8f65969b}onlineOrderFlag',
operator: "=",
value: 1
),
}
)
}
)
},
pagingInfo: a!pagingInfo(1, 10)
).data,
local!onlineSales2020: a!queryRecordType(
recordType: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order',
/* Only include orders created in 2020 */
filters: {
a!queryFilter(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.fields.{fbcc99f6-1ddf-4923-903b-18122a1737c6}orderDate',
operator: "BETWEEN",
value: {
todatetime("01/01/2020"),
todatetime("12/31/2020")
}
)
},
fields: {
a!aggregationFields(
/* Group by the order date year */
groupings: a!grouping(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.fields.{fbcc99f6-1ddf-4923-903b-18122a1737c6}orderDate',
interval: "YEAR",
alias: "orderDateYear"
),
measures: {
/* Get the sum of all orders */
a!measure(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.relationships.{0bde4028-fd7a-411f-97ad-7ad5b84e0d18}orderDetail.fields.{db456082-5f77-4765-bc3e-f662651e0d52}lineTotal',
function: "SUM",
alias: "totalSales2020"
),
/* Get the sum of all orders that have an online order flag */
a!measure(
field: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order.relationships.{0bde4028-fd7a-411f-97ad-7ad5b84e0d18}orderDetail.fields.{db456082-5f77-4765-bc3e-f662651e0d52}lineTotal',
function: "SUM",
alias: "onlineSales2020",
filters: {
a!queryFilter(
field: 'recordType!{bec4a875-9980-4bbf-a38c-c492ebed065a}Order Detail.relationships.{e6b1dbca-6c3c-4540-a093-3c581a73ad17}order.fields.{5bade7d5-5fbc-4cc4-807f-907f8f65969b}onlineOrderFlag',
operator: "=",
value: 1
),
}
)
}
)
},
pagingInfo: a!pagingInfo(1, 10)
).data,
/* Column layout that we'll use for our gauge components */
{
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextHeader(text: { "Percent of Online Sales" })
}
),
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!gaugeField(
labelPosition: "COLLAPSED",
percentage: local!onlineSales2021.onlineSales / local!onlineSales2021.totalSales * 100,
primaryText: a!gaugePercentage(),
secondaryText: "2021",
tooltip: "Online Sales: " & a!currency(
isoCode: "USD",
value: a!defaultValue(local!onlineSales2021.onlineSales, 0)
)
)
}
),
a!columnLayout(
contents: {
a!gaugeField(
labelPosition: "COLLAPSED",
percentage: local!onlineSales2020.onlineSales2020 / local!onlineSales2020.totalSales2020 * 100,
primaryText: a!gaugePercentage(),
secondaryText: "2020",
tooltip: "Online Sales: " & a!currency(
isoCode: "USD",
value: a!defaultValue(
local!onlineSales2020.onlineSales2020,
0
)
)
)
}
)
}
)
}
)
| Solve the following leet code problem |
Refresh Data After Executing a Smart Service.
This scenario demonstrates:
How to force a variable to be refreshed after a smart service is executed to get the latest data.
| Sail Code expression :
a!localVariables(
local!updateCounter: 0,
local!employee: a!refreshVariable(
value: a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
logicalExpression: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(field: "id", operator: "=", value: 1)
},
ignoreFiltersWithEmptyValues: true
),
pagingInfo: a!pagingInfo(startIndex: 1, batchSize: 1)
),
fetchTotalCount: false
).data[1],
refreshOnVarChange: local!updateCounter
),
local!edit: false,
{
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!textField(
label: "First Name",
value: local!employee.firstName,
saveInto: local!employee.firstName,
readOnly: not(local!edit)
),
a!textField(
label: "Last Name",
value: local!employee.lastName,
saveInto: local!employee.lastName,
readOnly: not(local!edit)
)
}
),
a!columnLayout(
contents: {
a!textField(
label: "Department",
value: local!employee.department,
saveInto: local!employee.department,
readOnly: not(local!edit)
),
a!textField(
label: "Title",
value: local!employee.title,
saveInto: local!employee.title,
readOnly: not(local!edit)
)
}
),
a!columnLayout(
contents: {
a!textField(
label: "Phone Number",
value: local!employee.phoneNumber,
saveInto: local!employee.phoneNumber,
readOnly: not(local!edit)
),
a!dateField(
label: "Start Date",
value: local!employee.startDate,
saveInto: local!employee.startDate,
readOnly: not(local!edit)
)
}
)
}
),
a!sideBySideLayout(
items: {
a!sideBySideItem(
item: a!buttonArrayLayout(
buttons: {
a!buttonWidget(
label: "Cancel",
style: "OUTLINE",
color: "SECONDARY",
value: false,
saveInto: local!edit,
showWhen: local!edit
)
},
align: "START"
)
),
a!sideBySideItem(
item: a!buttonArrayLayout(
buttons: {
a!buttonWidget(
label: "Edit",
value: true,
saveInto: local!edit,
showWhen: not(local!edit)
),
a!buttonWidget(
label: "Save",
style: "SOLID",
showWhen: local!edit,
value: false,
saveInto: {
local!edit,
a!writeToDataStoreEntity(
dataStoreEntity: cons!EMPLOYEE_ENTITY,
valueToStore: local!employee,
onSuccess: a!save(
local!updateCounter,
local!updateCounter + 1
)
)
}
)
},
align: "END"
)
)
}
)
}
)
| Solve the following leet code problem |
Refresh Data Using a Refresh Button
This scenario demonstrates how to force a variable to be refreshed even if its dependencies haven't changed.
Notable implementation detailsCopy link to clipboard
The Refresh button increments a counter to make sure the value of local!refreshCounter always changes. Using a boolean flag that gets set to true when you click the button wouldn't work because the value wouldn't change between the first and second time you clicked the button.
Both local!startIndex and local!employees need to refresh when the refresh button is clicked. This makes sure that the user is on the first page once they click refresh and that the data is queried even if the start index didn't change (for example, if they were already on the first page).
If displaying a refresh button on an interface that is also refreshing on an interval, the last updated timestamp should be displayed next to the Refresh button.
| a!localVariables(
local!refreshCounter: 0,
local!startIndex: a!refreshVariable(
value: 1,
refreshOnVarChange: local!refreshCounter
),
local!pagingInfo: a!pagingInfo(local!startIndex, 5),
local!employees: a!refreshVariable(
value: a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
pagingInfo: local!pagingInfo
),
fetchTotalCount: true
),
refreshOnVarChange: local!refreshCounter
),
{
a!buttonArrayLayout(
buttons: {
a!buttonWidget(
label: "Refresh",
size: "SMALL",
style: "OUTLINE",
color: "SECONDARY",
saveInto: a!save(local!refreshCounter, local!refreshCounter + 1)
)
}
),
a!gridField(
labelPosition: "COLLAPSED",
data: local!employees,
columns: {
a!gridColumn(label: "Name", value: concat(fv!row.firstName, " ", fv!row.lastName)),
a!gridColumn(label: "Department", value: fv!row.department),
a!gridColumn(label: "Title", value: fv!row.title)
},
pagingSaveInto: a!save(local!startIndex, fv!pagingInfo.startIndex)
)
}
)
| Solve the following leet code problem |
Refresh Until Asynchronous Action Completes.
This scenario demonstrates:
How to enable a refresh interval after an asynchronous action is started and disable it once the asynchronous action is complete.
Notable implementation detailsCopy link to clipboard
The refreshInterval parameter can be set based on the current value of the variable using fv!value
The local!testRunResults variable is automatically updated when local!testRunStatus changes from "IN PROGRESS" TO "COMPLETE". However, it doesn't evaluate each time the timer goes off; it only evaluates when the value of local!testRunStatus actually changes.
| =a!localVariables(
local!testRunId,
local!error,
local!testRunStatus: a!refreshVariable(
value: if(isnull(local!testRunId), null, a!testRunStatusForId(local!testRunId)),
refreshInterval: if(or(isnull(fv!value), fv!value = "COMPLETE"), null, 0.5)
),
local!testRunResults: if(
local!testRunStatus = "COMPLETE",
a!testRunResultForId(local!testRunId),
null
),
{
a!buttonLayout(
secondaryButtons: {
a!buttonWidget(
label: "Run System Test",
size: "SMALL",
saveInto: {
a!startRuleTestsAll(
onSuccess: {
a!save(local!testRunId, fv!testRunId)
},
onError: {
a!save(local!error, "Could not execute test.")
}
)
}
)
}
),
a!sectionLayout(
label: "Summary" & if(
isnull(local!testRunResults),
null,
" - " & local!testRunResults.type
),
showWhen: not(isnull(local!testRunId)),
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!textField(
label: "Test-run ID",
labelPosition: "ADJACENT",
value: local!testRunId,
readOnly: true
),
a!richTextDisplayField(
label: "Status",
labelPosition: "ADJACENT",
value: if(
local!testRunStatus = "COMPLETE",
if(
local!testRunResults.status="ERROR",
{
a!richTextImage(
image: a!documentImage(document: a!iconIndicator("STATUS_ERROR"))
),
"One or more tests encountered an error"
},
local!testRunResults.status="FAIL",
{
a!richTextImage(
image: a!documentImage(document: a!iconIndicator("STATUS_NOTDONE"))
),
"One or more test case assertions failed"
},
{
a!richTextImage(
image: a!documentImage(document: a!iconIndicator("STATUS_OK"))
),
"All test case assertions passed"
}
),
{
a!richTextImage(
image: a!documentImage(document: a!iconIndicator("PROGRESS_RUNNING"))
),
"In progress"
}
)
)
}
),
a!columnLayout(
contents: {
a!pieChartField(
labelPosition: "COLLAPSED",
series: {
a!chartSeries(
label: "Passed",
data: local!testRunResults.passCount,
color: "GREEN"
),
a!chartSeries(
label: "Failed",
data: local!testRunResults.failureCount,
color: "YELLOW"
),
a!chartSeries(
label: "Error",
data: local!testRunResults.errorCount,
color: "RED"
)
},
showDataLabels: true,
showWhen: not(isnull(local!testRunResults))
)
}
)
}
)
}
)
}
)
| Solve the following leet code problem |
Sales by Country and Currency
This pattern illustrates how to create two different charts. One chart shows sales (calculated in US dollars) by country and the currency paid. The other shows sales by currency type, comparing the number of sales paid in US dollars versus the local currency. This pattern also provides a sample scenario to show how you can take common business requirements and quickly turn them into a report.
You'll notice that this pattern provides more than just an expression, it shows you the fastest way to build reports in Design Mode. To get the most out of this pattern, follow the steps in Create this pattern to learn how to build advanced reports using the latest low-code features.
ScenarioCopy link to clipboard
Account managers at the Appian Retail company want to see a breakdown of their 2021 sales by country and currency type. Although all sales are calculated in US dollars, some countries accept local currency as payment. For example, in Germany, sales occur in both US dollars and Euros, while sales in the United Kingdom only occur in pounds.
To better understand their customer demographic, account managers want to see two different charts:
One chart that shows sales (calculated in US dollars) by country and the currency used for payment.
Another chart that shows sales by currency type, comparing sales numbers in US dollars versus the local currency.
|
SetupCopy link to clipboard
This pattern uses data from the Appian Retail application, available for free in Appian Community Edition. To follow along with this pattern, log in to Appian Community to request the latest Appian Community Edition site.
If you do not see the Appian Retail application available in your existing Appian Community Edition, you can request a new Appian Community Edition to get the latest application contents available.
This pattern will use data from the following record types in the Appian Retail application:
Order record type: Contains order information like the order number, date, status, and whether it was purchased online or in stores. For example, order number SO43659 was purchased in store on 5/31/2019 and the order is closed.
Country record type: Contains country names. For example, the United States or Australia.
Currency Rate record type: Contains the average and end-of-day exchange rates between two currencies. For example, the average exchange rate from the US dollar to the Canadian dollar is 1.46, and the end-of-day rate is 1.47.
Currency record type: Contains the names of the various currencies used in sales. For example, Euro, United Kingdom pound, and Canadian dollar.
Create this patternCopy link to clipboard
This pattern contains two different charts. We'll break down the steps to create both in the following sections:
Create and set up a new interface.
Create the Sales by Country in US Dollars column chart.
Create the Sales by Currency Type bar chart.
Step 1: Set up the interfaceCopy link to clipboard
We’ll start this pattern by creating and setting up our interface. Since we’ll display two different charts in our report, we’ll use a Columns Layout to separate the two components.
To create and set up the interface:
In the Appian Retail application, go to the Build view.
Click NEW > Interface.
Configure the interface properties and click CREATE.
From the PALETTE, drag a COLUMNS component into the interface.
Click next to one of the Column Layouts to delete a column. We only need two columns for this pattern.
images/two-empty-columns.png
Step 2: Create the Sales by Country in US Dollars column chartCopy link to clipboard
Now we’ll start building our first chart.
The Sales by Country in US Dollars chart will display 2021 sales (calculated in US dollars) generated by each country and the currency those sales were initially made in.
To display this information, we'll use a column chart with two different groupings: the first grouping will categorize all sales by country name, while the second grouping will categorize the sales in those countries by currency type.
Create a column chartCopy link to clipboard
First, we'll add a column chart to the interface and define our primary grouping and measure.
To create the column chart:
From the PALETTE, drag a COLUMN CHART component into the left Column Layout.
From Data Source, select RECORD TYPE and search for the Order record type.
For Primary Grouping:
Remove the existing field selection.
Use the dropdown to hover over the salesRegion > country relationship and select the name field. The field will display as salesRegion.country.name.
Click the pencil icon next to the Measure to configure the chart's aggregation:
For Aggregation Function, select Sum of.
For Field, remove the existing field. Then, select the totalDue field.
For Format Value, use the dropdown to select Dollar.
Return to the Column Chart configuration.
Click FILTER RECORDS. We'll use a filter to only display 2021 sales.
Click Add Filter and configure the following conditions:
For Field, select orderDate.
For Condition, select Date Range.
For Value, use the context menu () to select Expression.
Click null to edit the expression.
Replace the existing value with the following expression:
{
todatetime("01/01/2021"),
todatetime("12/31/2021")
}
Click OK.
Click OK to close the dialog.
For Sort, click ADD SORT.
For Sort By:
Leave the default selection Alias.
Use the dropdown to select the totalDue_sum_measure1 alias.
Leave the default order of Descending.
For Label, enter Sales by Country in US Dollars (2021).
Add a secondary groupingCopy link to clipboard
Next, we'll add a secondary grouping to our chart so we can see the different currencies used for payment in each country.
To display this information, we'll use the name field from the Currency record type.
To add a secondary grouping:
For Secondary Grouping, click ADD GROUPING.
Use the dropdown to hover over the currencyRate > toCurrency relationship and select the name field. The field will display as currencyRate.toCurrency.name.
Tip: I see a toCurrency and a fromCurrency relationship. What's the difference between these two?
Both the toCurrency and fromCurrency relationships establish a relationship between the Currency Rate and Currency record types; however, they have different common fields in order to return different data. The toCurrency relationship uses the toCurrencyCode field as the common field to convert dollars to the local currency. The fromCurrency relationship uses the fromCurrencyCode field as the common field to convert the local currency into dollars.
For Stacking, select Normal.
Notice that there is a secondary grouping labeled [Series 1]. This means that there is a missing currency name for one of the values in our chart.
The reason for this is that US dollars is not listed as a currency name. Since we are sourcing data from the toCurrency relationship, the chart is only getting values for local currencies that will be converted into US dollars, so US dollars is excluded from this list.
Since we want US Dollars to appear as a secondary grouping in our chart, we will create a new custom record field that replaces any any null currencies associated with an order with "US Dollars". Then, we'll use that new field as our secondary grouping.
Create a custom record field to replace null valuesCopy link to clipboard
We'll create our new custom record field on the Order record type. This custom record field will evaluates in real-time so we can reference related data from the Currency record type.
Custom record fields that evaluate in real-time leverage a special set of functions called Custom Field functions. For this pattern, we'll use the custom field function called a!customFieldDefaultValue(), which allows us to replace null values with record fields, related record fields, or literal values.
To create the custom record field:
In the Appian Retail application, open the Order record type.
Click NEW CUSTOM RECORD FIELD.
From SELECT A TEMPLATE, choose Write Your Own Expression.
In the right-hand pane, select Real-time evaluation.
Click NEXT.
Copy and paste the following expression in the Expression dialog:
a!customFieldDefaultValue(
value: 'recordType!Order.relationships.currencyRate.relationships.toCurrency.fields.name',
default: "US Dollars"
)
Click TEST to preview the results.
Click NEXT.
For Name, enter currency.
Click CREATE. The new field currency appears in the list of fields available on the Order record type.
Click SAVE CHANGES.
Add the custom record field to the chartCopy link to clipboard
Now that we have our custom record field, let’s add it to the chart so the [Series 1] label is replaced with US Dollars.
To add the custom record field to the chart:
Return to the interface.
For Secondary Grouping:
Remove the existing field selection.
Use the dropdown to select the currency field.
Click SAVE CHANGES.
Step 3: Create the Sales by Currency Type bar chartCopy link to clipboard
Next we'll create our second chart.
The Sales by Currency Type chart will display 2021 sales by currency type, comparing sales numbers in US dollars versus the local currency.
To create this chart, we’ll group by currency name to see all local currencies. Then, we’ll add two measures to our chart: one calculating the total sales in US dollars, and another calculating the total sales in the local currency.
The final chart will look like this:
Create a bar chartCopy link to clipboard
We’ll start by adding a bar chart component to our interface and defining a primary grouping and measure.
To create the bar chart:
From the PALETTE, drag a BAR CHART component into the right Column Layout.
From Data Source, select RECORD TYPE and search for the Order record type.
For Primary Grouping:
Remove the existing field selection.
Use the dropdown to hover over the currencyRate > toCurrency relationship and select the name field. The field will display as currencyRate.toCurrency.name.
Click next to the Measure to configure the chart's aggregation:
For Label, enter Total Sales - US Dollars.
For Aggregation Function, select Sum of.
For Field, remove the existing field selection. Then, use the dropdown to select the totalDue field.
Return to the Bar Chart component configuration.
Click FILTER RECORDS. We'll use a filter to only display 2021 sales.
Click Add Filter and configure the following conditions:
For Field, select orderDate.
For Condition, select Date Range.
For Value, use the context menu () to select Expression.
Click null to edit the expression.
Replace the existing value with the following expression:
{
todatetime("01/01/2021"),
todatetime("12/31/2021")
}
Click OK.
Click OK to close the dialog.
For Sort, click ADD SORT.
For Sort By:
Leave the default selection Alias.
Use the dropdown to select the totalDue_sum_measure1 alias.
Leave the default order of Descending.
For Label, enter Sales by Currency Type (2021).
Similar to the first chart, this chart has a missing value for "US Dollars".
However, unlike our first chart, we don't need to display "US Dollars" as a grouping. Since this chart is meant to display sales in each local currency compared to sales in US dollars, we'll add a second measure so account managers can quickly compare the sales numbers side-by-side.
As such, we will remove the [Category 1] value from our chart in the next step
Filter out null categoriesCopy link to clipboard
To remove the [Category 1] value, we’ll add another filter on the chart so that only orders that have a currency rate are returned.
We can easily filter our data by filtering directly on the relationship reference recordType!Order.relationships.currencyRate.
You can use a record type relationship reference in the field parameter of a!queryFilter() when the operator is set to "is null" or "not null". This allows you to only return records that do or do not have any related records.
To filter out null categories:
Click FILTER RECORDS.
Select Expression.
Replace the expression with the following:
a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: 'recordType!Order.fields.orderDate',
operator: "between",
value: {
todatetime("01/01/2021"),
todatetime("12/31/2021")
}
),
a!queryFilter(
field: 'recordType!Order.relationships.currencyRate',
operator: "not null"
)
},
ignoreFiltersWithEmptyValues: true
)
Click OK.
Create a custom record field to calculate currency conversionCopy link to clipboard
Right now, our chart only displays the total sales generated in US dollars. To display the amount of sales generated in each local currency, we’ll create another custom record field on the Order record type that converts sales in US dollars to sales in the local currency.
To calculate this, we'll create a custom record field that evaluates in real-time.
We'll use the a!customFieldMultiply() function to multiply the order total by the daily average currency rate. However, the averageRate field will have a null value for US Dollars because there is no rate conversion between US Dollars and US Dollars. To prevent the function from returning a null value, we'll use the a!customFieldDefaultValue() function to replace null values with the total due in US Dollars.
To create this custom record field:
Return to the Order record type.
Click NEW CUSTOM RECORD FIELD.
From SELECT A TEMPLATE, choose Write Your Own Expression.
In the right-hand pane, select Real-time evaluation. Since we want to reference a related record field in our calculation, we need the field to evaluate in real-time.
Click NEXT.
Copy and paste the following expression in the Expression dialog:
a!customFieldDefaultValue(
value: a!customFieldMultiply(
value: {
'recordType!Order.fields.totalDue',
'recordType!Order.relationships.currencyRate.fields.averageRate'
}
),
default: 'recordType!Order.fields}totalDue'
)
Click TEST to preview the results.
Click NEXT.
For Name, enter totalInLocalCurrency.
Click CREATE. The new field totalInLocalCurrency appears in the list of fields available on the Order record type.
Click SAVE CHANGES.
Close the Order record type.
Add the custom record field as a second measureCopy link to clipboard
In this last step, we'll add our new custom record field as a second measure in the chart.
To add the custom record field as a second measure:
Return to the interface.
In the Sales by Currency Type (2021) bar chart, click ADD MEASURE.
Click next to the second Measure to configure the chart's aggregation:
For Label, enter Total Sales - Local Currency.
For Aggregation Function, select Sum of.
For Field, select totalInLocalCurrency.
Click SAVE CHANGES.
Full SAIL code expression :
{
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!columnChartField(
data: a!recordData(
recordType: 'recordType! Order',
filters: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: 'recordType!Order.fields.orderDate',
operator: "between",
value: {
todatetime("01/01/2021"),
todatetime("12/31/2021")
}
)
},
ignoreFiltersWithEmptyValues: true
)
),
config: a!columnChartConfig(
primaryGrouping: a!grouping(
field: 'recordType!Order.relationships.salesRegion.relationships.country.fields.name',
alias: "name_primaryGrouping"
),
/* Replace this field with the currency custom record field in your application */
secondaryGrouping: a!grouping(
field: recordType!Order.fields.currency,
alias: "currency_secondaryGrouping"
),
measures: {
a!measure(
function: "SUM",
field: 'recordType!Order.fields.totalDue',
alias: "totalDue_sum_measure1",
formatValue: "DOLLAR"
)
},
sort: {
a!sortInfo(field: "totalDue_sum_measure1")
},
dataLimit: 100
),
label: "Sales by Country in US Dollars (2021)",
stacking: "NORMAL",
showLegend: true,
showTooltips: true,
labelPosition: "ABOVE",
colorScheme: "CLASSIC",
height: "MEDIUM",
xAxisStyle: "STANDARD",
yAxisStyle: "STANDARD",
refreshAfter: "RECORD_ACTION"
)
}
),
a!columnLayout(
contents: {
a!barChartField(
data: a!recordData(
recordType: 'recordType!Order',
filters: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: 'recordType!Order.fields.orderDate',
operator: "between",
value: {
todatetime("01/01/2021"),
todatetime("12/31/2021")
}
),
a!queryFilter(
field: 'recordType!Order.relationships.currencyRate',
operator: "not null"
)
},
ignoreFiltersWithEmptyValues: true
)
),
config: a!barChartConfig(
primaryGrouping: a!grouping(
field: 'recordType!Order.relationships.currencyRate.relationships.toCurrency.fields.name',
alias: "name_primaryGrouping"
),
measures: {
a!measure(
label: "Total Sales - US Dollars",
function: "SUM",
field: 'recordType!Order.fields.totalDue',
alias: "totalDue_sum_measure1"
),
/* Replace this field with the totalInLocalCurrency custom record field in your application */
a!measure(
label: "Total Sales - Local Currency",
function: "SUM",
field: recordType!Order.fields.totalInLocalCurrency,
alias: "totalInLocalCurrency_sum_measure2"
)
},
sort: {
a!sortInfo(field: "totalDue_sum_measure1")
},
dataLimit: 100
),
label: "Sales by Currency Type (2021)",
labelPosition: "ABOVE",
stacking: "NONE",
showLegend: true,
showTooltips: true,
colorScheme: "CLASSIC",
height: "MEDIUM",
xAxisStyle: "STANDARD",
yAxisStyle: "STANDARD",
refreshAfter: "RECORD_ACTION"
)
}
)
}
)
}
| Solve the following leet code problem |
Sales by Region
This pattern illustrates how to create a bar chart that shows sales per sales region. This pattern also provides a sample scenario to show how you can take common business requirements and quickly turn them into a report.
You'll notice that this pattern provides more than just an expression, it shows you the fastest way to build reports in Design Mode. To get the most out of this pattern, follow the steps in Create this pattern to learn how to build advanced reports using the latest low-code features.
ScenarioCopy link to clipboard
Sales executives at the Appian Retail company want to know which global sales regions have the highest sales numbers so they can hire more employees and dedicate more resources to high-performance areas.
To show the sales regions with the highest sales, you'll use the pattern on this page to create a bar chart that displays the sum of sales generated by each region in 2021. To see if sales have improved for certain regions, you'll also show the sum of sales generated by each region in 2020.
| {
a!barChartField(
data: 'recordType!{c25947c0-2230-41cb-86a6-bd86d14d0af9}Sales Region',
config: a!barChartConfig(
primaryGrouping: a!grouping(
field: 'recordType!{c25947c0-2230-41cb-86a6-bd86d14d0af9}Sales Region.relationships.{0ea75675-bc93-491c-8cc2-3c74668c96d3}country.fields.{85846423-5eb5-46c0-ac1a-263e4f522be7}name',
alias: "name_primaryGrouping"
),
measures: {
a!measure(
label: "2021",
function: "SUM",
field: 'recordType!{c25947c0-2230-41cb-86a6-bd86d14d0af9}Sales Region.relationships.{91b8d190-173e-407a-bf9b-e42e8e32a437}order.relationships.{0bde4028-fd7a-411f-97ad-7ad5b84e0d18}orderDetail.fields.{db456082-5f77-4765-bc3e-f662651e0d52}lineTotal',
filters: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: 'recordType!{bec4a875-9980-4bbf-a38c-c492ebed065a}Order Detail.relationships.{e6b1dbca-6c3c-4540-a093-3c581a73ad17}order.fields.{fbcc99f6-1ddf-4923-903b-18122a1737c6}orderDate',
operator: "between",
value: {
todatetime("01/01/2021"),
todatetime("12/31/2021")
}
)
},
ignoreFiltersWithEmptyValues: true
),
alias: "sales2021",
formatValue: "DOLLAR"
),
a!measure(
label: "2020",
function: "SUM",
field: 'recordType!{c25947c0-2230-41cb-86a6-bd86d14d0af9}Sales Region.relationships.{91b8d190-173e-407a-bf9b-e42e8e32a437}order.relationships.{0bde4028-fd7a-411f-97ad-7ad5b84e0d18}orderDetail.fields.{db456082-5f77-4765-bc3e-f662651e0d52}lineTotal',
filters: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: 'recordType!{bec4a875-9980-4bbf-a38c-c492ebed065a}Order Detail.relationships.{e6b1dbca-6c3c-4540-a093-3c581a73ad17}order.fields.{fbcc99f6-1ddf-4923-903b-18122a1737c6}orderDate',
operator: "between",
value: {
todatetime("01/01/2020"),
todatetime("12/31/2020")
}
)
},
ignoreFiltersWithEmptyValues: true
),
alias: "sales2020",
formatValue: "DOLLAR"
)
},
sort: { a!sortInfo(field: "sales2021") },
dataLimit: 100
),
label: "Sales by Region",
labelPosition: "ABOVE",
stacking: "NONE",
showLegend: true,
showTooltips: true,
colorScheme: "MIDNIGHT",
height: "MEDIUM",
xAxisStyle: "STANDARD",
yAxisStyle: "NONE",
refreshAfter: "RECORD_ACTION"
)
}
| Solve the following leet code problem |
Save a User's Report Filters to a Data Store Entity.
Allow a user to save their preferred filter on a report and automatically load it when they revisit the report later.
This scenario demonstrates:
How to use the Write to Data Store smart service from a report.
| a!localVariables(
local!persistedFilterData: a!queryEntity(
entity: cons!CSRS_FILTER_ENTITY,
query: a!query(
filter: a!queryFilter(field: "username", operator: "=", value: loggedInUser()),
pagingInfo: a!pagingInfo(startIndex: 1, batchSize: 1)
),
fetchTotalCount: true
),
local!persistedFilter: if(
local!persistedFilterData.totalCount = 0,
/* There's no existing filter for this user, so create a new one */
'type!{urn:com:appian:types}SupportRequestReportFilter'(username: loggedInUser()),
cast('type!{urn:com:appian:types}SupportRequestReportFilter', local!persistedFilterData.data[1])
),
local!saveFilterError: false,
/* Store the current filter separate from the persisted filter so we know when they are the same */
local!filter: local!persistedFilter,
local!allPriorities: rule!CSRS_GetAllPriority().value,
local!allStatuses: rule!CSRS_GetAllStatus().value,
local!pagingInfo: a!pagingInfo(1, -1, a!sortInfo("createdOn", false)),
local!filterChanged: not(exact(local!persistedFilter, local!filter)),
/* Data that will be displayed in the grid given the *
* current search terms and applied filters */
{
a!sectionLayout(
contents:{
a!columnsLayout(
columns:{
a!columnLayout(
contents:{
a!dropdownField(
label: "Priority",
labelPosition: "ADJACENT",
placeholder: "All Priorities",
choiceLabels: local!allPriorities,
choiceValues: local!allPriorities,
value: local!filter.priority,
saveInto: local!filter.priority
),
a!dropdownField(
label: "Status",
labelPosition: "ADJACENT",
placeholder: "All Statuses",
choiceLabels: local!allStatuses,
choiceValues: local!allStatuses,
value: local!filter.status,
saveInto: local!filter.status
)
}
),
a!columnLayout(
contents:{
a!buttonLayout(
secondaryButtons: {
if(
local!saveFilterError,
a!buttonWidget(
label: "Could not save filters",
disabled: true
),
a!buttonWidget(
label: "Save Filters",
disabled: not(local!filterChanged),
saveInto: a!writeToDataStoreEntity(
dataStoreEntity: cons!CSRS_FILTER_ENTITY,
valueToStore: local!filter,
onSuccess: {
a!save(local!persistedFilter, local!filter)
},
onError: {
a!save(local!saveFilterError, true)
}
)
)
)
}
)
}
)
}
)
}
),
a!gridField(
emptyGridMessage: "No Support Requests available",
data: a!queryEntity(
entity: cons!CSRS_SUPPORT_REQUEST_DSE,
query: a!query(
selection: a!querySelection(
columns: {
a!queryColumn(field: "id"),
a!queryColumn(field: "title"),
a!queryColumn(field: "status"),
a!queryColumn(field: "priority")
}
),
logicalExpression: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: "status.value",
operator: "=",
value: local!filter.status
),
a!queryFilter(
field: "priority.value",
operator: "=", value:
local!filter.priority
)
},
ignoreFiltersWithEmptyValues: true
),
pagingInfo: fv!pagingInfo
),
fetchTotalCount: true
),
columns: {
a!gridColumn(
label: "Title",
sortField: "title",
value: fv!row.title
),
a!gridColumn(
label: "Status",
sortField: "status.value",
value: index(fv!row.status, "value", {})
),
a!gridColumn(
label: "Priority",
sortField: "priority.value",
value: a!imageField(
images: rule!CSRS_GetIconForPriority(index(fv!row.priority, "value", {}))
),
width: "NARROW",
align: "CENTER"
),
/*a!gridColumn(*/
/*label: "Priority",*/
/*sortField: "priority.value",*/
/*value: a!richTextDisplayField(*/
/*value: a!richTextIcon(*/
/*icon: displayvalue(*/
/*index(fv!row.priority, "value", {}),*/
/* Priority values */
/*{"Low", "Medium", "High", "Critical"},*/
/* Corresponding icons for each priority */
/*{"arrow-circle-down", "arrow-circle-right", "arrow-circle-up", "exclamation-circle"},*/
/*"circle"*/
/*),*/
/*size: "MEDIUM",*/
/*color: if(*/
/*contains(*/
/*{"High", "Critical"},*/
/*index(fv!row.priority, "value", {}),*/
/*),*/
/*"NEGATIVE",*/
/*"SECONDARY"*/
/*)*/
/*)*/
/*),*/
/*align: "CENTER",*/
/*width: "NARROW"*/
/*)*/
},
rowHeader: 1
)
}
)
| Solve the following leet code problem |
Searching on Multiple Columns.
Display a grid populated based on search criteria specified by end users.
This design pattern is not recommended for offline interfaces because reflecting immediate changes in an interface based on user interaction requires a connection to the server.
Tip: If the data source for a read-only grid is a record type, the grid will automatically add a search box above the grid that searches across all fields. This pattern is still useful if you want to limit which of the displayed columns you want to search, or if the data source for your grid is not a record type.
This scenario demonstrates:
How to store values from multiple fields to filter query results.
ExpressionCopy link to clipboard
| a!localVariables(
/* In a real app, these values should be held in the database or in a constant. */
local!allDepartments: {"Corporate", "Engineering", "Finance", "HR", "Professional Services", "Sales"},
/* These local variables store filter values. */
local!lastName,
local!title,
local!department,
/* The value of this variable is false if any of the filter variables are not null. */
local!noFiltersApplied: all(fn!isnull, {local!lastName, local!title, local!department}),
a!sectionLayout(
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
/* Refreshing after KEYPRESS means the filter is applied to the grid every
time the user presses a key. For large data sets where performance is an
issue, you could refresh after the user leaves the field (UNFOCUS).*/
a!textField(
label: "Last Name",
value: local!lastName,
saveInto: local!lastName,
refreshAfter: "KEYPRESS"
),
a!textField(
label: "Title",
value: local!title,
saveInto: local!title,
refreshAfter: "KEYPRESS"
),
a!dropdownField(
label: "Department",
placeholder: "All Departments",
choiceLabels: local!allDepartments,
choiceValues: local!allDepartments,
value: local!department,
saveInto: local!department
),
a!buttonLayout(
primaryButtons: {
a!buttonWidget(
label: "Clear",
saveInto: {
local!lastName,
local!title,
local!department
},
disabled: local!noFiltersApplied
)
}
)
}
),
a!columnLayout(
contents: {
a!gridField(
label: "Read-only Grid",
labelPosition: "ABOVE",
data: a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
selection: a!querySelection(
columns: {
a!queryColumn(field: "lastName"),
a!queryColumn(field: "title"),
a!queryColumn(field: "department")
}
),
logicalExpression: a!queryLogicalExpression(
operator: "AND",
filters: {
/* The 'includes' operator compares strings and will return partial matches,
which is how most searching filters work.
The filter will also reevaluate anytime the associated local variables
change. To use a button to search instead, make sure the search string
saves to a different local variable first. */
a!queryFilter(
field: "lastName",
operator: "includes",
value: local!lastName
),
a!queryFilter(
field: "title",
operator: "includes",
value: local!title
),
a!queryFilter(
field: "department",
operator: "=",
value: local!department
)
},
ignoreFiltersWithEmptyValues: true
),
pagingInfo: fv!pagingInfo
),
fetchTotalCount: true
),
columns: {
a!gridColumn(
label: "Last Name",
sortField: "lastName",
value: fv!row.lastName
),
a!gridColumn(
label: "Title",
sortField: "title",
value: fv!row.title
),
a!gridColumn(
label: "Department",
sortField: "department",
value: fv!row.department
)
},
pagesize: 5,
initialsorts: a!sortInfo(
field: "lastName",
ascending: true
)
)
}
)
}
)
}
)
)
| Solve the following leet code problem |
Set a Numeric Rating Using Rich Text Icons
Save a numeric score using a set of clickable rich text icons.
This example uses a familiar set of star icons capture a user's sentiment. To see how to display an aggregated set of rankings rating, see the Show a Numeric Rating as Rich Text Icons recipe.
This scenario demonstrates:
How to use a!forEach() within rich text.
How to set a parameter dynamically within an interface component.
How to reset a value back to its initial value.
| a!localVariables(
local!rating: 0,
local!totalStars: 10,
a!richTextDisplayField(
value: {
a!foreach(
items: enumerate(local!totalStars) + 1,
expression: {
a!richTextIcon(
icon: if(
fv!index <= local!rating,
"star",
"star-o"
),
color: "ACCENT",
linkstyle: "STANDALONE",
link: a!dynamicLink(
value: if(local!rating=fv!index, 0, fv!index),
saveInto: local!rating
)
)
}
)
}
)
)
| Solve the following leet code problem |
Set the Default Value Based on a User Input.
Set the default value of a variable based on what the user enters in another component.
This example only applies when the default value is based on the user's input in another component. See Set the Default Value of an Input on a Task Form recipe when the default value must be set as soon as the form is displayed and without requiring the user to interact with the form.
|
SAIL Code :
a!localVariables(
local!username,
local!email,
local!emailModified: false,
a!formLayout(
label: "Example: Default Value Based on User Input",
contents: {
a!textField(
label: "Username",
instructions: "Value saved: " & local!username,
value: local!username,
saveInto: {
local!username,
if(local!emailModified, {}, a!save(local!email, append(save!value, "@example.com")))
},
refreshAfter: "KEYPRESS"
),
a!textField(
label: "Email",
instructions: "Value saved: " & local!email,
value: local!email,
saveInto: {
local!email,
a!save(local!emailModified, true)
}
)
},
buttons: a!buttonLayout(
primaryButtons: a!buttonWidget(
label: "Submit",
submit: true
)
)
)
)
To write your data to processCopy link to clipboard
Save your interface as sailRecipe
Create rule inputs: username (Text), email (Text)
Delete local variables: local!username, local!email
In your expression, replace:
local!username with ri!username
local!email with ri!email
In your process model, on the process start form or forms tab of an activity, enter the name of your interface in the search box and select it
Click Yes when the Process Modeler asks, "Do you want to import the rule inputs?"
On a task form, this will create node inputs
On a start form, this will create parameterized process variables.
| Solve the following leet code problem |
Set the Default Value of CDT Fields Based on a User Input.
Set the value of a CDT field based on a user input.
| Sail Code begin:
a!localVariables(
local!myCdt: 'type!{http://www.appian.com/ae/types/2009}LabelValue'(),
a!formLayout(
label: "Example: Default Value Based on User Input",
instructions: "local!myCdt: " & local!myCdt,
contents: {
a!textField(
label: "Label",
instructions: "Value saved: " & local!myCdt.label,
value: local!myCdt.label,
saveInto: {
local!myCdt.label,
a!save(local!myCdt.value, append(save!value, "@example.com"))
},
refreshAfter: "KEYPRESS"
),
a!textField(
label: "Value",
instructions: "Value saved: " & local!myCdt.value,
value: local!myCdt.value,
saveInto: local!myCdt.value,
refreshAfter: "KEYPRESS"
)
},
buttons: a!buttonLayout(
primaryButtons: a!buttonWidget(
label: "Submit",
submit: true
)
)
)
)
Sail Code end
To write your data to processCopy link to clipboard
Any Type is not a supported data type in the Process Modeler. Before creating the process model, you will need to create a CDT that matches the data structure of local!myCdt.
Save your interface as sailRecipe
Create rule input: myCdt (CDT)
Remove the localVariables() function
Delete local variable: local!myCdt
In your expression, replace:
local!myCdt with ri!myCdt
In your process model, on the process start form or forms tab of an activity, enter the name of your interface in the search box and select it
Click Yes when the Process Modeler asks, "Do you want to import the rule inputs?"
On a task form, change the records node inputs to data type of the CDT used in the interface.
On a start form, change the records process variable to data type of the CDT used in the interface.
| Solve the following leet code problem |
Set the Default Value of an Input on a Start Form.
Display a default value in some form inputs on a start form, and save the value into the process when submitting.
| StepsCopy link to clipboard
Create an interface with one rule input called title (Text) and another one called date (Date).
Enter the following definition for the interface, and save it as sailRecipe.
In your process model, on the process start form enter the name of your interface in the search box and select it
Click Yes when the Process Modeler asks, "Do you want to import the rule inputs?"
This will create parameterized process variables
On the Variables Tab, give the process variables the following values:
caseTitle (Text): ="My default text"
date (Date): =today()
Save and publish the process model.
To view the start form in Tempo, add the process model to an application and configure it as an action. Don't forget to publish your application.
SAIL Code :
=a!formLayout(
label: "Example: Default Value",
contents: {
a!textField(
label: "Case Title",
value: ri!title,
saveInto: ri!title,
required: true
),
a!dateField(
label: "Date",
value: ri!date,
saveInto: ri!date,
required: true
)
},
buttons: a!buttonLayout(
primaryButtons: a!buttonWidget(
label: "Submit",
submit: true
)
)
)
| Solve the following leet code problem |
Set the Default Value of an Input on a Task Form.
Display a default value in some form inputs on a task form, and save the value to process when submitting.
| StepsCopy link to clipboard
Create an interface with one rule input called title (Text).
Enter the following definition for the interface, and save it as sailRecipe.
In your process model, drag a User Input Task on the canvas.
On the forms tab of that activity, enter the name of your interface in the search box and select it
Click Yes when the Process Modeler asks, "Do you want to import the rule inputs?"
This will create node inputs
On the Data tab, set caseTitle value parameter to ="My default text". Save the node input into a process variable.
Save and publish the process model.
Start a new process.
SAIL Code:
=a!formLayout(
label: "Example: Default Value",
contents: {
a!textField(
label: "Case Title",
value: ri!title,
saveInto: ri!title,
required: true
)
},
buttons: a!buttonLayout(
primaryButtons: a!buttonWidget(
label: "Submit",
submit: true
)
)
)
Watch out! A common mistake is to use load() and to configure a local variable called ri!title as follows:
=load(
ri!title: "Default text",
...
)
| Solve the following leet code problem |
Show Calculated Columns in a Grid.
Display calculated values in columns in a grid.
Use CaseCopy link to clipboard
You can configure a read-only grid to display calculated columns. These columns differ from the columns returned from your data source. Calculated columns allow you to combine data from two or more columns into a single value or display the result of a data calculation.
In this use case, we'll use a record type as the data source for the read-only grid and provide calculated values in two columns: Name and Next Performance Review. First, we will concatenate firstName and lastName to display as a single name. Next, we'll look at an employee's start date, calculate the employee's next performance review date, and display that calculated value in the Next Performance Review column.
| The expression pattern below shows you how to:
Concatenate two separate data points to create a single value.
Use the Retrieve Next Anniversary Date function recipe to format a date and improve its readability.
Sail code :
a!gridField(
label: "Performance Review Schedule",
labelPosition: "ABOVE",
data: recordType!Employee,
columns: {
a!gridColumn(
label: "Name",
sortField: recordType!Employee.fields.firstName,
/* In the value parameter, we used fv!row with a record type field
* reference to pull in the first name and last name fields. Then
* used ampersand (&) to concatenate both fields together into a
* single value. */
value: fv!row[recordType!Employee.fields.firstName] &" "& fv!row[recordType!Employee.fields.lastName]
),
a!gridColumn(
label: "Department",
sortField: recordType!Employee.fields.department,
value: fv!row[recordType!Employee.fields.department]
),
a!gridColumn(
label: "Title",
sortField: recordType!Employee.fields.title,
value: fv!row[recordType!Employee.fields.title]
),
a!gridColumn(
label: "Next Performance Review",
sortField: recordType!Employee.fields.startDate,
/* We used local variables to store the value of the employee's
* start month and start day. Then used the date() function to
* calculate the next review time based on the start date
* returned when using fv!row with a record type field to
* reference each employee's start date. */
value:
a!localVariables(
local!startMonth: month(fv!row[recordType!Employee.fields.startDate]),
local!startDay: day(fv!row[recordType!Employee.fields.startDate]),
if(
and(
local!startMonth <= month(today()),
local!startDay <= day(today())
),
date(1 + year(today()), local!startMonth, local!startDay),
date(year(today()), local!startMonth, local!startDay)
)
),
align: "END"
)
},
pagesize: 10,
showRefreshButton: true,
showExportButton: true,
refreshAfter: "RECORD_ACTION",
/* We added the "Add New Employee" record action to the grid for testing
* only. This record action was configured in the record type and brought
* into the grid. */
recordActions: {
a!recordActionItem(
action: recordType!Employee.actions.addNewEmployee
)
}
)
| Solve the following leet code problem |
Show a Numeric Rating as Rich Text Icons
Dynamically show a star rating based on a numeric score.
This example uses a familiar set of star icons to display an aggregated value taken from many previous rating. To see how to capture and display an individual rating, see the Set a Numeric Rating Using Rich Text Icons recipe.
This scenario demonstrates:
How to use a!forEach() within rich text.
How to dynamically set a parameter within an interface component.
| a!localVariables(
local!score: 5.88,
local!limit: 10,
a!richTextDisplayField(
value: {
a!forEach(
items: enumerate(local!limit) + 1,
expression: a!richTextIcon(
color: "ACCENT",
icon: if(
fv!index <= local!score,
"star",
if(
fv!index - 1 < local!score,
"star-half-o",
"star-o"
)
)
)
)
}
)
)
| Solve the following leet code problem |
Showing Validation Errors that Aren't Specific to One Component
Alert the user about form problems that aren't specific to one component, showing the message only when the user clicks "Submit".
In this case, there are two fields and although neither are required, at least one of them must be filled out to submit the form.
| a!localVariables(
local!phone,
local!email,
a!formLayout(
label: "Example: Showing Form Errors on Submission",
contents:{
a!textField(
label: "Phone Number",
value: local!phone,
saveInto: local!phone
),
a!textField(
label: "Email Address",
value: local!email,
saveInto: local!email
)
},
buttons: a!buttonLayout(
primaryButtons: a!buttonWidget(
label: "Submit",
submit: true
)
),
/*
* This validation occurs at the form level and is useful when the form or
* section's validation checks are non-field specific.
*/
validations: {
if(
and(isnull(local!phone), isnull(local!email)),
a!validationMessage(
message: "You must enter either a phone number or an email address!",
validateAfter: "SUBMIT"
),
{}
)
}
)
)
| Solve the following leet code problem |
Sync Records using a Record Action
Configure a record action with the Sync Records smart service so users can sync a set of records on demand.
This pattern focuses on re-syncing (or refreshing) a set of records that already exist in Appian. It also provides a sample scenario to show why you might use this pattern in your application.
ScenarioCopy link to clipboard
The Appian Retail Company uses a record action to create all new orders in the Order record type. Since this action uses a Write to Data Store Entity smart service, all new orders are automatically synced in Appian. Although new orders are created and synced using the Write to Data Store Entity smart service, some orders are updated using a third-party system. As a result, not all order changes are automatically synced in Appian.
To sync changes made by the third-party system, you will use the Sync Records smart service to re-sync the existing orders so they display the latest order information.
In this scenario, you will create a record action that allows end users to re-sync orders placed this month in the Northwest sales region. This way, users viewing a read-only grid with the monthly Northwest sales can ensure they see the latest order information.
| SetupCopy link to clipboard
This pattern uses data from the Appian Retail application, available for free in Appian Community Edition. To follow along with this pattern, log in to Appian Community to request the latest Appian Community Edition site.
If you do not see the Appian Retail application available in your existing Appian Community Edition, you can request a new Appian Community Edition to get the latest application contents available.
This pattern will use data from the following record types in the Appian Retail application:
Order record type: Contains order information like the order number, date, status, and whether it was purchased online or in stores. For example, order number SO43659 was purchased in stores on 5/31/2019 and the order is closed.
Customer record type: Contains individual customers who purchase products. For example, Terry Duffy.
Create this patternCopy link to clipboard
To create this pattern:
Get the record identifiers of orders placed in the Northwest sales region this month.
Create a process model with the Sync Records smart service to use in a record action.
Configure a record action to trigger the process model.
Add the record action to a read-only grid.
Get order identifiersCopy link to clipboard
To configure the Sync Records smart service, you need to provide the identifiers of the records you want to sync.
In this pattern, you'll create an expression rule that queries the Id field from the Order record type to return all orders placed in the Northwest sales region this month. You'll use this expression rule later in a process model when you configure the Sync Records smart service.
To get the order Ids:
In the Appian Retail application, go to the Build view.
Click NEW > Expression Rule.
In the Create Expression Rule dialog, configure the following properties:
Click CREATE.
Copy and paste the following expression. This returns the Ids of orders created this month in the Northwest sales region
SAIL Code:
a!queryRecordType(
recordType: 'recordType!Order',
fields: {
'recordType!Order.fields.}orderId'
},
filters: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: 'recordType!Order.relationships.salesRegion.fields.name',
operator: "=",
value: "Northwest"
),
a!queryFilter(
field: 'recordType!Order.fields.orderDate',
operator: "between",
value: /* Month-to-Date */{
toDatetime(eomonth(today(), - 1) + 1),
now()
}
)
},
ignoreFiltersWithEmptyValues: true
),
pagingInfo: a!pagingInfo(startIndex: 1, batchSize: 500)
).data['recordType!Order.fields.orderId']
Click TEST RULE to verify the query.
Click SAVE CHANGES.
Close the expression rule.
Create a process model to sync recordsCopy link to clipboard
Now that you have the order identifiers, you can configure a process model that uses the Sync Records smart service.
The process model will use a start form so users can confirm that they want to re-sync records. The workflow will include a cancel flow to end the process if the user ends the action. Additionally, you'll add a script task that calls the AR_getNorthwestOrders expression rule so you can pass the returned identifiers in a process variable to the Sync Records smart service.
Create a start formCopy link to clipboard
Before you build the process model, you'll start by creating a start form that asks users to confirm that they want to re-sync records.
To create the start form:
In the Appian Retail application, click NEW > Interface.
In the Create Interface dialog, configure the following properties:
Property Value
Name Enter AR_confirmSync.
Description Enter A start form to confirm that users want to sync record data.
Save In Select Rules & Constants.
Click CREATE.
In the Select a template panel, under FORMS, click One Column Form.
To rename the form title, click the title Form to select the Form Layout component.
In the COMPONENT CONFIGURATION pane, replace the default Label value with Re-sync Records?.
Click the title Section to select the Section Layout.
From the context menu, select Delete to remove this component.
From the PALETTE, drag a Rich Text component into the remaining Section Layout.
In the COMPONENT CONFIGURATION pane for the new Rich Text component, enter the following in the Display Value:
This will re-sync all existing Northwest orders submitted this month. Do you want to re-sync these records?
In the Display Value editor, highlight the text, then click Size icon Size and select Medium Text.
Click Submit to select the Button component.
In the COMPONENT CONFIGURATION pane, replace the default Label value with Re-sync.
Click SAVE CHANGES.
Close the interface.
Create a process model and set a start formCopy link to clipboard
Now that you have a start form interface, you will create a new process model and configure the start form.
To create a process model:
In the Appian Retail application, click NEW > Process Model.
In the Create Process Model dialog, configure the following properties:
Property Value
Name Enter AR Sync Northwest Orders.
Description Enter Process to sync Northwest orders placed this month.
Save In Click Create New Process Model Folder and name the folder AR Process Models.
Click CREATE.
In the Review Process Model Security dialog, click Add Users or Groups:
For User or Group, enter your username.
For Permission Level, select Administrator.
Click SAVE.
Once inside the process modeler, configure the start form:
Go to File > Properties. The Process Model Properties dialog opens.
Go to the Process Start Form tab.
In Interface, enter AR_confirmSync.
When asked if you want to Create Process Parameters to match your interface's inputs, click YES. This adds the cancel rule input from your interface into the process model.
Add a recordIds process variableCopy link to clipboard
In addition to the cancel process variable, you'll create another process variable called recordIds to store the record identifiers that you want to re-sync.
To create the recordIds process variable:
In the Process Model Properties dialog, go to the Variables tab.
Click + Add Variable.
In the New Process Variable dialog, configure the following properties:
Property Value
Name Enter recordIds.
Type Select Number (Integer).
Parameter Select the Allow the value for the variable to be provided when starting a process checkbox.
Multiple Select the Variable can store multiple values checkbox.
Click OK. You now have two process variables:
Click OK to close the Process Model Properties.
Create a cancel flowCopy link to clipboard
Next, you'll create a cancel flow to terminate the process if a user clicks CANCEL on the start form.
To create a cancel flow:
From the palette on the left, drag and drop an XOR gateway onto the connector line between the Start Node and End Node.
From the palette, drag an End Event node to the bottom of the XOR node. A red dot appears indicating that these two nodes will be connected.
Drop the End Event node. The two nodes are now connected.
Click the End Event label and enter Sync Canceled.
Double-click the XOR gateway to open the node.
In the Name field, enter Cancel Sync?
Go to the Decision tab.
Click NEW CONDITION. We're setting a condition so that, if the cancel process variable is true, the process flows to the Sync Canceled node.
In the Condition, click Expression Editor.
Enter pv!cancel to reference the process variable cancel.
Click SAVE AND CLOSE. The condition is already automatically set to is True.
From the Results dropdown list, select Sync Canceled.
For the Else if no rules are TRUE condition, select End Node.
Click OK.
Add a Terminate Process eventCopy link to clipboard
When a process has multiple end nodes, the different branches of a process remain active until each active path reaches one of the multiple end nodes. To stop all branches of a process, even those that have not yet reached an end node, you should add a Terminate Process event to each end node.
To add a terminate process event:
Double-click the End Node to open it.
Go to the Results tab.
Click the Terminate Process link. A Terminate Process row is added to the End Events list.
/terminate-process-tutorial
Click OK.
Repeat the previous four steps for the Sync Canceled node.
Configure the script taskCopy link to clipboard
To pass the record identifiers to the Sync Records smart service, you need to configure a script task to call the AR_getNorthwestOrders expression rule and save the results in the recordIds process variable.
To configure the script task:
From the palette on the left, drag and drop a Script Task node onto the connector line between Cancel Sync? and End Node.
Double-click the Script Task to open it.
In the Name field, enter Get Order Ids.
Go to the Data tab.
Go to the Outputs tab.
Click + New Custom Output.
In Expression, click Expression Editor.
In the Expression Editor, enter rule!AR_getNorthwestOrders().
Click SAVE AND CLOSE.
For Target, select the recordIds process variable.
Click OK.
Configure the Sync Records smart serviceCopy link to clipboard
Now that you have the record identifiers stored in a process variable, you can reference the process variable in a Sync Records node.
To configure the Sync Records smart service:
From the palette on the left, drag and drop a Sync Records node onto the connector line between Get Order Ids and End Node.
Double-click the Sync Records node to open it.
In the Name field, enter Re-sync Northwest Orders.
Go to the Data tab.
In the Inputs tab, click Record Type.
For Value, click Expression Editor.
In the Expression Editor, enter the record type reference recordType!Order.
Click SAVE AND CLOSE.
Click Identifiers.
For Value, select the recordIds process variable.
Click OK.
Add activity chaining and save the process modelCopy link to clipboard
Now that your process model is nearly complete, you will add activity chaining to allow the process to move more quickly between nodes, and then save the process model.
To add activity chaining and save the process model:
Right-click the connecting line between the Start Node and the Cancel Sync? node.
In the context menu, select Enable Activity Chaining.
Right-click the connecting line between the Cancel Sync? and Get Order Ids nodes.
In the context menu, select Enable Activity Chaining.
Repeat these steps on the remaining nodes.
Go to File > Save & Publish.
Close the process model.
Configure a record actionCopy link to clipboard
Next, you'll use the process model in a record action so users can re-sync this month's Northwest orders with the click of a button.
To configure a record action:
In the Appian Retail application, open the Order record type.
Go to Actions.
Click Configure a record action manually.
Under Record List Actions, click CONFIGURE NEW ACTION MANUALLY.
In the Create New Action dialog, configure the following properties:
Property Value
Display Name Enter Re-sync Records.
Key Leave as the default value.
Icon Search for the repeat icon and select the icon.
Dialog Box Size Select Small.
Process Model Select the AR Sync Northwest Records process model.
Click OK.
Click SAVE CHANGES.
Close the record type.
Add the record action to a read-only gridCopy link to clipboard
Lastly, you'll add the record action to a read-only grid so users can re-sync this month's Northwest orders to see the latest data in the grid.
To create a read-only grid with the record action:
In the Appian Retail application, click NEW > Interface.
In the Create Interface dialog, configure the following properties:
Property Value
Name Enter AR_NorthwestOrdersGrid.
Description Enter Grid display Northwest orders made this month.
Save In Select Rules & Constants.
Click CREATE.
From the PALETTE, drag a Read-only grid component into the interface.
For the grid's Data Source, select RECORD TYPE and search for the Order record type. The grid populates with all order data and the RE-SYNC RECORDS action.
Although the record action automatically displays on the grid, you'll want to filter the grid so it only displays orders placed in the correct sales region and during the current month.
To filter the grid:
Click FILTER RECORDS.
Click Add Filter and configure the following properties:
Property Value
Field Enter salesRegion.name. This selects the name field from the Region record type.
Condition Leave the default equal to.
Value Enter Northwest.
Click Add Filter again and configure the following properties:
Property Value
Field Enter orderDate.
Condition Select Date Range.
Value Select Month-to-Date.
Click OK.
In the COMPONENT CONFIGURATION pane, expand the LAYOUT section.
For Label, replace the default value with Northwest Orders This Month.
Click SAVE CHANGES.
| Solve the following leet code problem |
Top Customers and Their Latest Order.
This pattern illustrates how to create a grid that shows the top paying customers, their latest order, and their total sum of sales. This pattern also provides a sample scenario to show how you can take common business requirements and quickly turn them into a report.
You'll notice that this pattern provides more than just an expression, it shows you the fastest way to build reports in Design Mode. To get the most out of this pattern, follow the steps in Create this pattern to learn how to build advanced reports using the latest low-code features.
ScenarioCopy link to clipboard
Sales executives at the Appian Retail company want to know who are their top paying customers in 2021 so they can send 10 of them exclusive promotions for products purchased in their latest order.
To show the top paying customers, you'll use the pattern on this page to create a read-only grid that displays the customer name, their total sales, and a link to their latest order. You'll also add a filter on the grid so executives can filter the list of customers by a range of total sales.
| {
a!gridField(
label: "Top Customers in 2021",
labelPosition: "ABOVE",
data: a!recordData(
recordType: 'recordType!Customer',
relatedRecordData: {
a!relatedRecordData(
relationship: 'recordType!}Customer.relationships.order',
limit: 1,
sort: a!sortInfo(
field: 'recordType!Order.fields.orderDate',
ascending: false
),
filters: a!queryFilter(
field: 'recordType!Order.fields.orderDate',
operator: "BETWEEN",
value: {
todatetime("01/01/2021"),
todatetime("12/31/2021")
}
)
)
}
),
columns: {
a!gridColumn(
label: "Name",
sortField: 'recordType!Customer.relationships.person.fields.fullName',
value: a!linkField(
links: {
a!recordLink(
label: fv!row['recordType!Customer.relationships.person.fields.fullName'],
recordType: 'recordType!Customer',
identifier: fv!row['recordType!Customer.fields.CustomerID']
)
}
)
),
a!gridColumn(
label: "Latest Order",
sortField: 'recordType!Customer.relationships.order.fields.orderNumber',
value: a!linkField(
links: {
a!recordLink(
label: fv!row['recordType!Customer.relationships.order.fields.orderNumber'],
recordType: 'recordType!Order',
identifier: fv!row['recordType!Customer.relationships.order.fields.orderId']
)
}
),
align: "START"
),
/* Replace these fields with the totalSales2021 custom record field in your application */
a!gridColumn(
label: "Total Sales (2021)",
value: if(
isnull(
fv!row[recordType!Customer.fields.totalSales2021]
),
"-",
a!currency(
isoCode: "USD",
value: fv!row[recordType!Customer.fields.totalSales2021]
)
)
)
},
/* Replace this field with the totalSales2021 custom record field in your application */
initialSorts: {
a!sortInfo(
field: recordType!Customer.fields.totalSales2021
)
},
validations: {},
refreshAfter: "RECORD_ACTION",
userFilters: {
'recordType!{1b00c9c1-c2a1-455c-b204-1e6ec5c448a1}Customer.filters.{2dcd60f9-6620-412a-860d-3f3730315143}Total Sales'
},
showSearchBox: true,
showRefreshButton: true
)
}
| Solve the following leet code problem |
Total Orders Compared to Orders Purchased with Promo Codes.
This pattern illustrates how to create a column chart that compares the number of total orders and the number of orders that had at least one item purchased with a promo code. This pattern also provides a sample scenario to show how you can take common business requirements and quickly turn them into a report.
You'll notice that this pattern provides more than just an expression, it shows you the fastest way to build reports in Design Mode. To get the most out of this pattern, follow the steps in Create this pattern to learn how to build advanced reports using the latest low-code features.
ScenarioCopy link to clipboard
Account managers at the Appian Retail company want to know: of the total number of orders placed in 2021, how many orders had at least one item purchased with a promo code? Account managers will use this information to see if promo codes are having a positive effect on their total number of sales. Depending on the data, they may choose to send more promo codes during lower performing months to boost sales.
To allow account managers to analyze the relationship between promo codes and total orders, you'll use the pattern on this page to create a column chart that shows the count of total orders and the count of orders that contain at least one promo code.
| {
a!columnChartField(
data: a!recordData(
recordType: 'recordType!Order',
filters: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: 'recordType!Order.fields.orderDate',
operator: "between",
value: {
todatetime("01/01/2021"),
todatetime("12/31/2021")
}
)
},
ignoreFiltersWithEmptyValues: true
)
),
config: a!columnChartConfig(
primaryGrouping: a!grouping(
field: 'recordType!Order.fields.orderDate',
alias: "orderDate_month_primaryGrouping",
interval: "MONTH_SHORT_TEXT"
),
measures: {
a!measure(
label: "Total Orders",
function: "COUNT",
field: 'recordType!Order.fields.orderId',
alias: "orderId_count_measure1"
),
a!measure(
label: "Orders with Promo Codes",
function: "COUNT",
field: 'recordType!Order.fields.orderId',
filters: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: 'recordType!Order.relationships.orderDetail.relationships.promoCode.fields.description',
operator: "<>",
value: "No Discount"
)
},
ignoreFiltersWithEmptyValues: true
),
alias: "orderId_count_measure2"
)
},
dataLimit: 100,
showIntervalsWithNoData: true
),
label: "Order Trends in 2021",
stacking: "NONE",
showLegend: true,
showTooltips: true,
labelPosition: "ABOVE",
colorScheme: "SUNSET",
height: "MEDIUM",
xAxisStyle: "STANDARD",
yAxisStyle: "NONE",
refreshAfter: "RECORD_ACTION"
)
}
| Solve the following leet code problem |
Track Adds and Deletes in Inline Editable Grid.
In an inline editable grid, track the employees that are added for further processing in the next process steps.
This design pattern is not recommended for offline interfaces because reflecting immediate changes in an interface based on user interaction requires a connection to the server.
Also track the ids of items that are deleted for use in the Delete from Data Store Entities smart service after the user submits the form.
This scenario demonstrates:
How to store data into multiple variables when the user interacts with the components in a grid layout.
New employee values are seen immediately after updating in the New Employees field. This field is simply showing any values in local!employees without an value for id.
If you intend to immediately write the new and edited items using the Write to Data Store Entities smart service, you don't need to capture the array of added items separately from your items array. This is because the Write to Data Store Entity smart service can do updates and inserts at the same time. See also: Write to Data Store Entity Smart Service
The array of deleted item ids may contain null values corresponding to newly added items. You don't have to remove the nulls if you are planning on passing the ids to the Delete from Data Store Entities smart service. This is because the smart service ignores the null values. See also: Delete from Data Store Entities Smart Service
| a!localVariables(
/* In a real app, these values should be held in the database or in a constant */
local!departments: { "Corporate", "Engineering", "Finance", "HR", "Professional Services", "Sales" },
/*
* local!employees is provided in this recipe as a way to start with hard-coded
* data. However, this data is identical to the data created from the entity-backed
* tutorial. Replace the hard-coded data with a query to the employee data store
* entity and all of the employee records from the tutorial will appear.
*
* To replace this data with your own, replace (ctrl+H or cmd+H) all references to
* local!employees with your data source, either via rule input or local variable.
*/
local!employees: {
a!map( id: 1, firstName: "John" , lastName: "Smith" , department: "Engineering" , title: "Director" , phoneNumber: "555-123-4567" , startDate: today()-360 ),
a!map( id: 2, firstName: "Michael" , lastName: "Johnson" , department: "Finance" , title: "Analyst" , phoneNumber: "555-987-6543" , startDate: today()-360 ),
a!map( id: 3, firstName: "Mary", lastName: "Reed" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-456-0123" , startDate: today()-240 )
},
local!deletedEmployeeIds,
a!formLayout(
label: "Example: Inline Editable Grid Tracking Adds and Deletes",
contents: {
a!gridLayout(
totalCount: count(local!employees),
headerCells: {
a!gridLayoutHeaderCell(label: "First Name" ),
a!gridLayoutHeaderCell(label: "Last Name" ),
a!gridLayoutHeaderCell(label: "Department" ),
a!gridLayoutHeaderCell(label: "Title" ),
a!gridLayoutHeaderCell(label: "Phone Number" ),
a!gridLayoutHeaderCell(label: "Start Date", align: "RIGHT" ),
/* For the "Remove" column */
a!gridLayoutHeaderCell(label: "" )
},
/* Only needed when some columns need to be narrow */
columnConfigs: {
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight:3 ),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight:3 ),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight:3 ),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight:3 ),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight:3 ),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight:2 ),
a!gridLayoutColumnConfig(width: "ICON")
},
/*
* a!forEach() will take local!employee data and used that data to loop through an
* expression that creates each row.
*
* When modifying the recipe to work with your data, you only need to change:
* 1.) the number of fields in each row
* 2.) the types of fields for each column (i.e. a!textField() for text data elements)
* 3.) the fv!item elements. For example fv!item.firstName would change to fv!item.yourdata
*/
rows: a!forEach(
items: local!employees,
expression: a!gridRowLayout(
contents: {
/* For the First Name Column*/
a!textField(
/* Labels are not visible in grid cells but are necessary to meet accessibility requirements */
label: "first name " & fv!index,
value: fv!item.firstName,
saveInto: fv!item.firstName,
required: true
),
/* For the Last Name Column*/
a!textField(
label: "last name " & fv!index,
value: fv!item.lastName,
saveInto: fv!item.lastName,
required: true
),
/* For the Department Column*/
a!dropdownField(
label: "department " & fv!index,
placeholder: "-- Please Select-- ",
choiceLabels: local!departments,
choiceValues: local!departments,
value: fv!item.department,
saveInto: fv!item.department,
required: true
),
/* For the Title Column*/
a!textField(
label: "title " & fv!index,
value: fv!item.title,
saveInto: fv!item.title,
required: true
),
/* For the Phone Number Column*/
a!textField(
label: "phone number " & fv!index,
placeholder:"555-456-7890",
value: fv!item.phoneNumber,
saveInto: fv!item.phoneNumber,
validations: if( len(fv!item.phoneNumber) > 12, "Contains more than 12 characters. Please reenter phone number, and include only numbers and dashes", null )
),
/* For the Start Date Column*/
a!dateField(
label: "start date " & fv!index,
value: fv!item.startDate,
saveInto: fv!item.startDate,
required: true,
align: "RIGHT"
),
/* For the Removal Column*/
a!imageField(
label: "delete " & fv!index,
images: a!documentImage(
document: a!iconIndicator( "REMOVE"),
altText: "Remove Employee",
caption: "Remove " & fv!item.firstName & " " & fv!item.lastName,
link: a!dynamicLink(
value: fv!index,
saveInto: {
if(
isnull( fv!item.id),
{},
a!save( local!deletedEmployeeIds, append(local!deletedEmployeeIds, fv!item.id))
),
a!save( local!employees, remove(local!employees, save!value))
}
)
),
size: "ICON"
)
},
id: fv!index
)
),
addRowlink: a!dynamicLink(
label: "Add Employee",
/*
* For your use case, set the value to a blank instance of your CDT using
* the type constructor, e.g. type!Employee(). Only specify the field
* if you want to give it a default value e.g. startDate: today()+1.
*/
value: {
firstName: "",
lastName: "",
department: "",
title: "",
phoneNumber: "",
startDate: today() + 1
},
saveInto: {
a!save( local!employees, append(local!employees, save!value))
}
),
/* This validation prevents existing employee start date from changing to a date in the future*/
validations: if(
a!forEach(
items:local!employees,
expression: and( not( isnull( fv!item.id)), todate( fv!item.startDate) > today() )
),
"Existing Employees cannot have an effective start date beyond today",
null
),
rowHeader: 1
),
a!textField(
label: "New Employees",
labelPosition: "ADJACENT",
value: joinarray(
index(
local!employees,
where(
a!forEach(
local!employees,
isnull( fv!item.id)
)
),
{}
),
char(10)
),
readOnly: true
),
a!textField(
label: "Deleted Employees",
labelPosition: "ADJACENT",
value: local!deletedEmployeeIds,
readOnly: true
)
},
buttons: a!buttonLayout(
primaryButtons: a!buttonWidget(
label: "Submit",
submit: true
)
)
)
)
| Solve the following leet code problem |
Update an Entity-Backed Record from its Summary View.
This scenario demonstrates how to use the Write to Data Store smart service to update an entity-backed record in response to a user interaction
|
a!localVariables(
/* In a real app, these values should be held in the database or in a constant */
local!departments: { "Corporate", "Engineering", "Finance", "HR", "Professional Services", "Sales" },
/*
* Employee data is being passed in via a query and converted
* back to CDT.
*
* To use your date, replace the employee local variable with the
* appropriate data and update the component fields to fit your
* CDT data points.
*/
local!employee: cast(
'type!{urn:com:appian:types:Employee}Employee',
a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
selection: a!querySelection(columns: {
a!queryColumn( field: "id"),
a!queryColumn( field: "firstName"),
a!queryColumn( field: "lastName"),
a!queryColumn( field: "department"),
a!queryColumn( field: "title"),
a!queryColumn( field: "phoneNumber"),
a!queryColumn( field: "startDate")
}),
/*
* Replace the hard-coded value of 1 with your primary key
* via a rule input to bring back a single row of data
*/
filter: a!queryFilter( field: "id", operator:"=", value:1 ),
pagingInfo: a!pagingInfo(1,1)
)
).data
),
local!isTransfer: false,
/* Used to keep changes in a sandbox. */
local!updatedEmployeeData,
a!columnsLayout(
columns:{
a!columnLayout(
contents:{
a!textField(
label: "First Name",
labelPosition: "ADJACENT",
value: local!employee.firstName,
readOnly: true
),
a!textField(
label: "Last Name",
labelPosition: "ADJACENT",
value: local!employee.lastName,
readOnly: true
),
a!textField(
label: "Phone Number",
labelPosition: "ADJACENT",
value: local!employee.phoneNumber,
readOnly: true
)
}
),
a!columnLayout(
contents:{
if(
local!isTransfer,
{
a!dropdownField(
label: "New Department",
labelPosition: "ADJACENT",
choiceLabels: local!departments,
choiceValues: local!departments,
value: local!updatedEmployeeData.department,
saveInto: local!updatedEmployeeData.department
),
a!textField(
label: "New Title",
labelPosition: "ADJACENT",
required: true,
value: local!updatedEmployeeData.title,
saveInto: local!updatedEmployeeData.title
)
},
{
a!textField(
label: "Department",
labelPosition: "ADJACENT",
value: local!employee.department,
readOnly: true
),
a!textField(
label: "Title",
labelPosition: "ADJACENT",
value: local!employee.title,
readOnly: true
)
}
),
a!textField(
label: "Start Date",
labelPosition: "ADJACENT",
value: text( local!employee.startDate, "mmm dd, yyyy"),
readOnly: true
),
a!linkField(
labelPosition: "ADJACENT",
links: a!dynamicLink(
label: "Transfer employee",
value: true,
saveInto: {
local!isTransfer,
a!save( local!updatedEmployeeData, local!employee)
}
),
showWhen: not( local!isTransfer)
),
a!buttonLayout(
primaryButtons:{
a!buttonWidget(
label: "Transfer",
validate: true,
saveInto:{
a!writeToDataStoreEntity(
dataStoreEntity: cons!EMPLOYEE_ENTITY,
valueToStore: local!employee,
onSuccess: a!save(local!employee, local!updatedEmployeeData)
),
a!save( local!isTransfer, false)
}
)
},
secondaryButtons:{
a!buttonWidget(
label: "Go Back",
value: false,
saveInto: local!isTransfer
)
},
showWhen: local!isTransfer
)
}
)
}
)
)
| Solve the following leet code problem |
Use Links in a Grid to Show More Details and Edit Data.
Allow end users to click a link in a read-only grid to view the details for the row, and make changes to the data. The data available for editing may include more fields than are displayed in the grid.
This design pattern is not recommended for offline interfaces because reflecting immediate changes in an interface based on user interaction requires a connection to the server.
This scenario demonstrates:
1.How to use links in a grid that conditionally display other interface components.
2.How to allow editable fields to update the individual fields of the a data set.
| a!localVariables(
/* We load the employee data into this variable. If you are populating
this variable with a query, you would put .data at the end before passing
it to the grid. */
local!employees: {
a!map( id: 11, name: "Elizabeth Ward", dept: "Engineering", role: "Senior Engineer", team: "Front-End Components", pto: 15, startDate: today()-500),
a!map( id: 22, name: "Michael Johnson", dept: "Finance", role: "Payroll Manager", team: "Accounts Payable", pto: 2, startDate: today()-100),
a!map( id: 33, name: "John Smith", dept: "Engineering", role: "Quality Engineer", team: "User Acceptance Testing", pto: 5, startDate: today()-1000),
a!map( id: 44, name: "Diana Hellstrom", dept: "Engineering", role: "UX Designer", team: "User Experience", pto: 49, startDate: today()-1200),
a!map( id: 55, name: "Francois Morin", dept: "Sales", role: "Account Executive", team: "Commercial North America", pto: 15, startDate: today()-700),
a!map( id: 66, name: "Maya Kapoor", dept: "Sales", role: "Regional Director", team: "Front-End Components", pto: 15, startDate: today()-1400),
a!map( id: 77, name: "Anthony Wu", dept: "Human Resources", role: "Benefits Coordinator", team: "Accounts Payable", pto: 2, startDate: today()-300),
},
/* local!teamList would normally come from a constant or data source. */
local!teamList: {
"Accounts Payable",
"User Acceptance Testing",
"User Experience",
"Commercial North America",
"Front-End Components"
},
/* This variable is for storing the grid's selection. */
local!selection,
/* This variable is used to for the full row of data on the selected item
to be passed to the details section of the interface. */
local!selectedEmployee,
local!readOnly: true,
/*
* You can view values of your local variables in the
* Local Variables pane on the right side of your interface,
* so you can see you the changes being made to the data in realtime
*/
{
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!sectionLayout(
label: "Employees",
contents: {
a!gridField(
data: local!employees,
columns: {
a!gridColumn(
label: "Name",
value: fv!row.name
),
a!gridColumn(
label: "Team",
value: fv!row.team
)
},
pageSize: 10,
selectable: true,
selectionStyle: "ROW_HIGHLIGHT",
selectionValue: local!selection,
selectionSaveInto: {
/* Using the index function to return the last-selected item ensures that
only one item will be selected at a time, regardless of how fast the user
clicks. */
a!save(local!selectedEmployee, index(fv!selectedRows, length(fv!selectedRows), null)),
/* We use the same method as above to limit the selection variable. */
a!save(local!selection, index(save!value, length(save!value), null))
},
shadeAlternateRows: false,
rowHeader: 1
)
}
)
}
),
a!columnLayout(
contents: {
a!sectionLayout(
label: "Details",
contents: {
a!richTextDisplayField(
value: a!richTextItem(
text: "No employee selected.",
color: "SECONDARY",
size: "MEDIUM",
style: "EMPHASIS"
),
showWhen: isnull(local!selection)
),
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!textField(
label: "Name",
value: local!selectedEmployee.name,
readOnly: true
),
a!textField(
label: "Department",
value: local!selectedEmployee.dept,
readOnly: true
)
},
width: "MEDIUM"
),
a!columnLayout(
contents: {
/* In the following fields, we display from, and save to
local!selectedEmployee. */
a!textField(
label: "Role",
value: local!selectedEmployee.role,
saveInto: local!selectedEmployee.role,
readOnly: local!readOnly
),
/* Because dropdown components can't be readOnly, we use a textField to
display the value and an if() statement to swap it out for the dropdown
when it's time to edit. */
if(
local!readOnly,
a!textField(
label: "Team",
value: local!selectedEmployee.team,
readOnly: true
),
a!dropdownField(
label: "Team",
choiceLabels: local!teamList,
choiceValues: local!teamList,
value: local!selectedEmployee.team,
saveInto: local!selectedEmployee.team,
disabled: local!readOnly
)
),
/* The link enables editing in the other components, and is hidden when
editing is enabled. */
a!linkField(
labelPosition: "COLLAPSED",
links: a!dynamicLink(
label: "Reassign",
value: false,
saveInto: local!readOnly
),
showWhen: local!readOnly
)
},
width: "WIDE"
)
},
showWhen: not(isnull(local!selection))
)
}
),
a!buttonLayout(
primaryButtons: {
a!buttonWidget(
label: "Update",
value: local!selectedEmployee,
saveInto: {
/* When the user clicks UPDATE, we use the updatearray() function to update
local!employees with the new values in local!selectedEmployee. */
a!save(
local!employees,
updatearray(
local!employees,
where(tointeger(local!employees.id)=local!selectedEmployee.id),
local!selectedEmployee
)
),
a!save(local!readOnly, true)
},
style: "SOLID"
)
},
secondaryButtons: {
a!buttonWidget(
label: "Cancel",
value: true,
saveInto: {
local!readOnly,
/* If the user has made any changes to local!selectedEmployee, when they click
CANCEL, we need to reset local!selectedEmployee to previous values in local!employees
in order to keep the selectedEmployee details true. If you don't want to persist the
selection, you can simply reset the selections instead with:
a!save(local!selectedEmployee, null), a!save(local!selection, null) */
a!save(
local!selectedEmployee,
cast(typeof({a!map()}), /* Casting the value to "list of map" simplifies subsequent interactions. */
index(
local!employees,
where(tointeger(local!employees.id)=local!selectedEmployee.id),
null
)
)
)
},
submit: true,
style: "OUTLINE",
validate: false
)
},
showWhen: not(local!readOnly)
)
}
)
}
)
}
)
| Solve the following leet code problem |
Use Links in a Grid to Show More Details and Edit Data in External System.
Allow end users to click a link in a read-only grid to view the details for the row, and make changes to the data.
This design pattern is not recommended for offline interfaces because reflecting immediate changes in an interface based on user interaction requires a connection to the server.
The changes are immediately persisted to the external system where the data resides. Sorting and paging the grid shows the latest data from the external system.
|
SetupCopy link to clipboard
Unlike the previous grid examples, this recipe retrieves the values for the local!employees array from an external system via a web service. It does so by using the bind() function, which associates two rules or functions with a load() local variable: one that gets the data from the external system, and one that updates the data in the external system. When the variable is referenced, the getter rule or function is called and value is populated with the result.
The definition of the relevant getEmployees rule is given below. This supporting rule uses the webservicequery function to call a sample web service created for this recipe which returns the same employee information shown in previous examples.
SAIL Code :
=webservicequery(
a!wsConfig(
wsdlUrl: "http://localhost:8080/axis2/services/CorporateDirectoryService?wsdl",
service: "{http://bindrecipe.services.ws.appiancorp.com}CorporateDirectoryService",
port: "CorporateDirectoryServiceHttpSoap12Endpoint",
operation: "{http://bindrecipe.services.ws.appiancorp.com}getEmployees"
),
{
getEmployeesRequest: {}
}
).returnValue.getEmployeesResponse.return
The corresponding setEmployees rule uses the webservicewrite function. The setEmployees rule is never executed because the bound local variable local!employees is never saved into in this example. Although it isn't called as part of the example, definition of setEmployees is presented here for completeness.
SAIL Code :
=webservicewrite(
a!wsConfig(
wsdlUrl: "http://localhost:8080/axis2/services/CorporateDirectoryService?wsdl",
service: "{http://bindrecipe.services.ws.appiancorp.com}CorporateDirectoryService",
port: "CorporateDirectoryServiceHttpSoap12Endpoint",
operation: "{http://bindrecipe.services.ws.appiancorp.com}setEmployees"
),
{
setEmployeesRequest: {
ri!employees
}
}
)
This recipe writes the updated value of a single employee back to the external system by using another bound variable, local!updatedEmployee. The local!updatedEmployee variable is the saveInto target associated with the "Update" button. When the user clicks the button and the variable is saved into, the setter rule or function given as the second parameter to the bind function is executed. The setter rule or function must return a Writer, which is a special type of value that can be used to write data when an interface saves into a bound variable.
The definition of the relevant setSingleEmployee rule, which uses the webservicewrite function to write data to the external system through a web service call, is as follows:
SAIL Code :
=webservicewrite(
a!wsConfig(
wsdlUrl: "http://localhost:8080/axis2/services/CorporateDirectoryService?wsdl",
service: "{http://bindrecipe.services.ws.appiancorp.com}CorporateDirectoryService",
port: "CorporateDirectoryServiceHttpSoap12Endpoint",
operation: "{http://bindrecipe.services.ws.appiancorp.com}setSingleEmployee"
),
{
setSingleEmployeeRequest: {
employee: ri!employee
}
}
)
The corresponding getSingleEmployee reader rule is defined as follows:
=webservicequery(
a!wsConfig(
wsdlUrl: "http://localhost:8080/axis2/services/CorporateDirectoryService?wsdl",
service: "{http://bindrecipe.services.ws.appiancorp.com}CorporateDirectoryService",
port: "CorporateDirectoryServiceHttpSoap12Endpoint",
operation: "{http://bindrecipe.services.ws.appiancorp.com}getSingleEmployee"
),
{
getSingleEmployeeRequest: {
id: ri!id
}
}
).returnValue.getSingleEmployeeResponse.return
To adapt this example to work with your own web service:
Update the getter and setter rules defined in the bind functions in the example to call your web service operations that get and set the objects
Use the configured webservicequery and webservicewrite functions in the examples above as a guide to determine the corresponding parameters to set for your web services. Refer to the a!wsConfig() documentation to determine which values are appropriate for your web service.
Update the expression below to access and display the fields that are relevant for your web service. For instance, if your web service returns a product instead of an employee, you could replace local!employeeToUpdate.department with local!productToUpdate.description, etc.
See Also: webservicequery(), webservicewrite(), bind
load(
local!employees: bind(rule!getEmployees(), rule!setEmployees( _ )),
local!pagingInfo: a!pagingInfo(startIndex: 1, batchSize: 25),
local!employeeToUpdate,
with(
local!employeeDataSubset: todatasubset(local!employees, local!pagingInfo),
local!data: index(local!employeeDataSubset, "data", null),
a!formLayout(
label: "Example: Grid with Link to Show More and Edit Data in an External System",
contents: {
a!sectionLayout(
label: "Employees",
contents: {
a!gridField_19r1(
totalCount: local!employeeDataSubset.totalCount,
columns: {
a!gridTextColumn(
label: "Name",
data: index(local!data, "name", {}),
/* Creates a dynamic link for every item in local!data */
links: a!forEach(items: local!data, expression: a!dynamicLink(value: fv!item, saveInto: local!employeeToUpdate))
),
a!gridTextColumn(
label: "Department",
data: index(local!data, "department", null)
)
},
value: local!pagingInfo,
saveInto: local!pagingInfo,
rowHeader: 1
)
}
),
load(
local!updatedEmployee: bind(
rule!getSingleEmployee(employeeToUpdate.id),
rule!setSingleEmployee( _ )
),
a!sectionLayout(
label: "Employee Details: " & local!employeeToUpdate.name,
contents: {
a!textField(
label: "Name",
value: local!employeeToUpdate.name,
saveInto: local!employeeToUpdate.name
),
a!textField(
label: "Department",
value: local!employeeToUpdate.department,
saveInto: local!employeeToUpdate.department
),
a!textField(
label: "Title",
value: local!employeeToUpdate.title,
saveInto: local!employeeToUpdate.title
),
a!dateField(
label: "Start Date",
value: local!employeeToUpdate.startDate,
saveInto: local!employeeToUpdate.startDate
),
a!buttonLayout(
primaryButtons: a!buttonWidget(
label: "Update",
value: local!employeeToUpdate,
saveInto: local!updatedEmployee
)
)
},
showWhen: not(isnull(local!employeeToUpdate))
)
)
},
buttons: a!buttonLayout(
primaryButtons: a!buttonWidget(
label: "Done",
style: "SOLID",
submit: true
)
)
)
)
)
| Solve the following leet code problem |
Use Selection For Bulk Actions in an Inline Editable Grid.
Allow the user to edit data inline in a grid one field at a time, or in bulk using selection.
This scenario demonstrates:
How to use the grid layout component to build an inline editable grid
How to use selection to enable bulk actions
How to make a cell conditionally required based on the value in another cell
| SetupCopy link to clipboard
This example makes use of a custom data type. Create a PrItem custom data type with the following fields:
id (Number (Integer))
summary (Text)
qty (Number (Integer))
unitPrice (Number (Decimal))
dept (Text)
due (Date)
decision (Text)
reason (Text)
Now that we've created the supporting data type, let's move on to the main expression.
a!localVariables(
local!items: {
type!PrItem(id: 1, summary: "Item 1", qty: 1, unitPrice: 10, dept: "Sales", due: today() + 10),
type!PrItem(id: 2, summary: "Item 2", qty: 2, unitPrice: 20, dept: "Finance", due: today() + 20),
type!PrItem(id: 3, summary: "Item 3", qty: 3, unitPrice: 30, dept: "Sales", due: today() + 30)
},
local!selectedIndices: tointeger({}),
a!formLayout(
label: "Example: Inline Editable Grid using Selection for Bulk Actions",
contents: {
a!buttonArrayLayout(buttons: {
a!buttonWidget(
label: "Approve",
value: "Approve",
/* You can save into a field at many indices at a time `*/
saveInto: {
local!items[local!selectedIndices].decision,
/*`Clear the selected indices after a decision is made `*/
a!save(local!selectedIndices, tointeger({}))
},
disabled: count(local!selectedIndices) = 0
),
a!buttonWidget(
label: "Reject",
value: "Reject",
saveInto: {
local!items[local!selectedIndices].decision,
/*`Clear the selected indices after a decision is made `*/
a!save(local!selectedIndices, tointeger({}))
},
disabled: count(local!selectedIndices) = 0
),
a!buttonWidget(
label: "Need More Info",
value: "Need More Info",
saveInto: {
local!items[local!selectedIndices].decision,
/*` Clear the selected indices after a decision is made */
a!save(local!selectedIndices, tointeger({}))
},
disabled: count(local!selectedIndices) = 0
)
}),
a!gridLayout(
headerCells: {
a!gridLayoutHeaderCell(label: "Summary"),
a!gridLayoutHeaderCell(label: "Qty", align: "RIGHT"),
a!gridLayoutHeaderCell(label: "U/P", align: "RIGHT"),
a!gridLayoutHeaderCell(label: "Amount", align: "RIGHT"),
a!gridLayoutHeaderCell(label: "Department"),
a!gridLayoutHeaderCell(label: "Due", align: "RIGHT"),
a!gridLayoutHeaderCell(label: "Decision"),
a!gridLayoutHeaderCell(label: "Reason")
},
columnConfigs: {
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight: 5),
a!gridLayoutColumnConfig(width: "DISTRIBUTE"),
a!gridLayoutColumnConfig(width: "DISTRIBUTE"),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight: 2),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight: 3),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight: 3),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight: 3),
a!gridLayoutColumnConfig(width: "DISTRIBUTE", weight: 3)
},
rows: a!forEach(
items:local!items,
expression:{
a!gridRowLayout(
id: fv!index,
contents: {
a!textField(
/* Labels are not visible in grid cells but are necessary to meet accessibility requirements */
label: "summary " & fv!index,
value: fv!item.summary,
readOnly: true
),
a!integerField(
label: "qty " & fv!index,
value: fv!item.qty,
readOnly: true,
align: "RIGHT"
),
a!floatingPointField(
label: "unitPrice " & fv!index,
value: fv!item.unitPrice,
readOnly: true,
align: "RIGHT"
),
a!textField(
label: "amount " & fv!index,
value: if(
or(isnull(fv!item.qty), isnull(fv!item.unitPrice)),
null,
a!currency(
isoCode: "USD",
value: fv!item.qty * fv!item.unitPrice
)
),
readOnly: true,
align: "RIGHT"
),
a!dropdownField(
label: "dept " & fv!index,
choiceLabels: {"Finance", "Sales"},
placeholder: "--Select-- ",
choiceValues: {"Finance", "Sales"},
value: fv!item.dept,
disabled: true
),
a!dateField(
label: "due " & fv!index,
value: fv!item.due,
readOnly: true,
align: "RIGHT"
),
a!dropdownField(
label: "decision " & fv!index,
choiceLabels: {"Approve", "Reject", "Need More Info"},
placeholder: "--Select-- ",
choiceValues: {"Approve", "Reject", "Need More Info"},
value: fv!item.decision,
saveInto: fv!item.decision,
required: true
),
a!textField(
label: "reason" & fv!index,
value: fv!item.reason,
saveInto: fv!item.reason,
required: and(
not(isnull(fv!item.decision)),
fv!item.decision <> "Approve"
),
requiredMessage: "A reason is required for items that are not approved"
)
}
)
}
),
selectable: true,
selectionValue: local!selectedIndices,
/* Flatten the selected values so the result is easier to work with */
/* when the select/deselect all option is used in an editable grid */
selectionSaveInto: a!save(local!selectedIndices, a!flatten(save!value)),
rowHeader: 2
),
a!textField(
label: "Selected Values",
labelPosition: "ADJACENT",
instructions: typename(typeof(local!selectedIndices)),
value: local!selectedIndices,
readOnly: true
)
},
buttons: a!buttonLayout(
primaryButtons: a!buttonWidget(
label: "Submit",
submit: true
)
)
)
)
| Solve the following leet code problem |
Use Validation Groups for Buttons with Multiple Validation Rules.
This scenario demonstrates how to use validation groups in an interface.
| a!localVariables(
/*
* All of these local variables could be combined into the employee CDT and passed into
* a process model via a rule input
*/
local!firstName,
local!lastName,
local!department,
local!title,
local!phoneNumber,
local!startDate,
/*
* local!isFutureHire is a placeholder varaiable used to set the validation group trigger.
* When isFutureHire is set to true, a user can skip phone number and start date.
*/
local!isFutureHire,
local!isNumberValid:if( len( local!phoneNumber ) <= 12, true, false ),
a!formLayout(
label: "Example: Add Employee with Conditional Requiredness",
contents: {
a!textField(
label: "First Name",
value: local!firstName,
saveInto: local!firstName,
required: true
),
a!textField(
label: "Last Name",
value: local!lastName,
saveInto: local!lastName,
required: true
),
a!dropdownField(
label: "Department",
choiceLabels: { "Corporate", "Engineering", "Finance", "Human Resources", "Professional Services", "Sales" },
placeholder: "-- Please Select a Department -- ",
choiceValues: { "Corporate", "Engineering", "Finance", "Human Resources", "Professional Services", "Sales" },
value: local!department,
saveInto: local!department,
required: true
),
a!textField(
label: "Title",
value: local!title,
saveInto: local!title,
required: true
),
/*
* When a field has a validation group set, the required parameter and any validations
* are deferred until the validation group is triggered by a button or link.
*
* Multiple validations are added to the phone number field by adding a local variable
* that turns off required and validation group, but triggers a standard validation
* upon unfocus from the field (rather than the onboard button click).
*/
a!textField(
label: "Phone Number",
placeholder: "555-456-7890",
value: local!phoneNumber,
saveInto: local!phoneNumber,
required: local!isNumberValid,
requiredMessage:"A phone number is needed if you're going to onboard this employee",
validations: if(local!isNumberValid,"","Please enter a valid telephone less than 12 digits long."),
validationGroup:if(local!isNumberValid,"Future_Hire","")
),
a!dateField(
label: "Start Date",
value: local!startDate,
saveInto: local!startDate,
required:true,
requiredMessage:"A start date is needed if you're going to onboard this employee",
validationGroup:"Future_Hire"
)
},
buttons: a!buttonLayout(
primaryButtons: {
a!buttonWidget(
label: "Submit as Future Hire",
value: true,
saveInto: local!isFutureHire,
submit: true
),
a!buttonWidget(
label: "Onboard Employee Now",
value: false,
saveInto: local!isFutureHire,
submit: true,
validationGroup: "Future_Hire"
)
}
)
)
)
Notable Implementation DetailsCopy link to clipboard
The validationGroup parameter controls requiredness of the field, not the validation message.
The value can be any string that you define provided it doesn't contain spaces. For example, "validation group" is not a valid value. You must use "validation_group".
Components in a validation group will not display the asterisk (*) that normally denotes a field's requiredness.
For ease of implementation, these values are being saved into individual local variables. To use this form in a process, these local variables should be replaced with rule inputs.
| Solve the following leet code problem |
Use a Filter to Adjust Chart Reference Lines.
Using a dropdown, filter the results of a data set while also adjusting a chart reference line.
This scenario demonstrates:
1.How to conditionally adjust the value of a chart reference line to account for differing limits on a set of data.
2.How to configure multiple chart reference lines on a single chart.
| a!localVariables(
local!selectedDepartment: "Engineering",
local!data: {
a!map(department: "Engineering", quarter: "2015-Q1", spent: 15804),
a!map(department: "Engineering", quarter: "2015-Q2", spent: 13432),
a!map(department: "Engineering", quarter: "2015-Q3", spent: 23400),
a!map(department: "Engineering", quarter: "2015-Q4", spent: 15900),
a!map(department: "Engineering", quarter: "2016-Q1", spent: 12004),
a!map(department: "Engineering", quarter: "2016-Q2", spent: 13901),
a!map(department: "Engineering", quarter: "2016-Q3", spent: 14142),
a!map(department: "Engineering", quarter: "2016-Q4", spent: 17980),
a!map(department: "Engineering", quarter: "2017-Q1", spent: 13822),
a!map(department: "Engineering", quarter: "2017-Q2", spent: 11053),
a!map(department: "Engineering", quarter: "2017-Q3", spent: 16607),
a!map(department: "Engineering", quarter: "2017-Q4", spent: 15449),
a!map(department: "Professional Services", quarter: "2015-Q1", spent: 18883),
a!map(department: "Professional Services", quarter: "2015-Q2", spent: 22904),
a!map(department: "Professional Services", quarter: "2015-Q3", spent: 19192),
a!map(department: "Professional Services", quarter: "2015-Q4", spent: 20043),
a!map(department: "Professional Services", quarter: "2016-Q1", spent: 17790),
a!map(department: "Professional Services", quarter: "2016-Q2", spent: 24405),
a!map(department: "Professional Services", quarter: "2016-Q3", spent: 21031),
a!map(department: "Professional Services", quarter: "2016-Q4", spent: 25787),
a!map(department: "Professional Services", quarter: "2017-Q1", spent: 17401),
a!map(department: "Professional Services", quarter: "2017-Q2", spent: 19903),
a!map(department: "Professional Services", quarter: "2017-Q3", spent: 18400),
a!map(department: "Professional Services", quarter: "2017-Q4", spent: 20801),
a!map(department: "Sales", quarter: "2015-Q1", spent: 29990),
a!map(department: "Sales", quarter: "2015-Q2", spent: 32063),
a!map(department: "Sales", quarter: "2015-Q3", spent: 24504),
a!map(department: "Sales", quarter: "2015-Q4", spent: 24994),
a!map(department: "Sales", quarter: "2016-Q1", spent: 26803),
a!map(department: "Sales", quarter: "2016-Q2", spent: 37400),
a!map(department: "Sales", quarter: "2016-Q3", spent: 27880),
a!map(department: "Sales", quarter: "2016-Q4", spent: 22904),
a!map(department: "Sales", quarter: "2017-Q1", spent: 32701),
a!map(department: "Sales", quarter: "2017-Q2", spent: 27032),
a!map(department: "Sales", quarter: "2017-Q3", spent: 28443),
a!map(department: "Sales", quarter: "2017-Q4", spent: 23940)
},
local!selectedData: index(
local!data,
wherecontains(local!selectedDepartment, touniformstring(local!data.department)),
null /* Return nothing if the selected department isn't in the list */
),
{
a!sectionLayout(
contents: {
a!dropdownField(
label: "Department",
choiceLabels: {"Engineering", "Professional Services", "Sales"},
choiceValues: {"Engineering", "Professional Services", "Sales"},
value: local!selectedDepartment,
saveInto: local!selectedDepartment
),
a!lineChartField(
label: "Money Spent per Quarter",
categories: local!data.quarter,
series: a!chartSeries(data: local!selectedData.spent),
xAxisTitle: "Quarter",
yAxisTitle: "Amount Spent (in $)",
referenceLines: {
a!chartReferenceLine(
label: "100% Budget",
value: if(
local!selectedDepartment = "Engineering",
18000,
if(
local!selectedDepartment = "Professional Services",
21000,
30000
)
),
color: "ORANGE"
),
a!chartReferenceLine(
label: "125% Budget",
value: if(
local!selectedDepartment = "Engineering",
22500,
if(
local!selectedDepartment = "Professional Services",
26250,
37500
)
),
color: "RED",
style: "DASHDOT"
)
},
showLegend: false
)
}
)
}
)
Notable implementation detailsCopy link to clipboard
This example uses a hard-coded data set. To use data from a record type, use a!queryRecordType(). The dropdown would then populate the value passed into the query filter or logical expression.
The chart reference values are hard-coded. Typically, these limits would be stored in a custom rule, constant, or lookup table.
| Solve the following leet code problem |
Use the Gauge Fraction and Gauge Percentage Configurations.
This recipe provides a common configuration of the Gauge Component using a!gaugeFraction() and a!gaugePercentage(), and includes a walkthrough that demonstrates the benefits of using design mode when configuring the gauge component.
|
WalkthroughCopy link to clipboard
In this scenario, we are creating a gauge to show that a user has completed 5 of their 11 tasks. When adapting this pattern for your application, you will likely either query for the number of tasks completed and total tasks, or use a rule input.
SetupCopy link to clipboard
Let's start with a new interface where we'll set up our local variables and layout.
Click EXPRESSION, then enter the following expression:
a!localVariables(
local!tasksCompleted: 5,
local!totalTasks: 11,
{
a!sectionLayout(
label: "My Tasks",
contents: {}
)
}
)
Switch back to DESIGN mode.
From the component PALETTE, drag a GAUGE component into the content section of the Section layout.
From the COMPONENT CONFIGURATION, delete the value for Label (Gauge), and set Label Position to HIDDEN so it doesn't leave an empty space above the component.
Using the Gauge PercentageCopy link to clipboard
When you add a Gauge component to your interface in design mode, the default configuration includes a!guagePercentage() as the Primary Text component with a default Fill Percentage value of 60.1.
Let's change the percentage value to an expression that calculates a new value from our local variables.
From the COMPONENT CONFIGURATION, hover over Fill Percentage until the Edit as Expression icon () appears, then click it.
recipe_gauge_edit_icon.png
In the expression editor, replace the default value of 60.1 with the following expression: local!tasksCompleted/local!totalTasks * 100
Your interface should now look like this:
recipe_guage_45.png
If you click EXPRESSION* to switch to expression mode, you should see this interface expression:
a!localVariables(
local!tasksCompleted: 5,
local!totalTasks: 11,
{
a!sectionLayout(
label: "My Tasks",
contents: {
a!gaugeField(
label: "",
labelposition: "COLLAPSED",
percentage: local!tasksCompleted/local!totalTasks * 100,
primaryText: a!gaugePercentage()
)
}
)
}
)
Using the Gauge FractionCopy link to clipboard
From DESIGN mode, we can easily switch to using a!gaugeFraction() to display the same value we entered for the percentage.
From the COMPONENT CONFIGURATION, under Primary Text, select Fraction.
Notice that by default, the fraction shows 45/100. This is the same percentage value calculated over a denominator of 100, which is the default value for a!gaugeFraction(). Let's change it so it correctly displays 5/11.
Hover over Denominator until the Edit as Expression icon () appears, then click it.
In the expression editor, enter the following expression: local!totalTasks
For Secondary Text, enter Completed.
Your interface should now look like this:
recipe_gauge_completed.png
Notice that the text automatically increased in size to better fit the gauge.
Similar to a!gaugePercentage(), a!gaugeFraction() works by automatically calculating the numerator based on the fill percentage value and the denominator, rounded to the nearest integer. Because the configuration rounds to an integer, it only works well if you are calculating the percentage from a fractional value, as we did in this example.
And that's it! We are able to configure a gauge with either the Gauge Percentage or Gauge Fraction configurations.
ExpressionCopy link to clipboard
a!localVariables(
local!tasksCompleted: 5,
local!totalTasks: 11,
{
a!sectionLayout(
label: "My Tasks",
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!gaugeField(
label: "",
labelposition: "COLLAPSED",
percentage: local!tasksCompleted/local!totalTasks * 100,
primaryText: a!gaugeFraction(
denominator: 11
),
secondarytext: "Completed"
)
}
),
a!columnLayout(
contents: {
a!gaugeField(
label: "",
labelposition: "COLLAPSED",
percentage: local!tasksCompleted/local!totalTasks * 100,
primaryText: a!gaugePercentage(),
secondarytext: "Completed"
)
}
)
}
)
}
)
}
)
| Solve the following leet code problem |
Use the Write Records Smart Service Function on an Interface.
Allow the user to publish several rows of data to a database table with the a!writeRecords() smart service function.
Note: This expression uses direct references to the Employee record type, created in the Records Tutorial. If you've completed that tutorial in your environment, you can change the existing record-type references in this pattern to point to your Employee record type instead.
Follow this pattern to create example data and supporting objects to use with other interface patterns (including those that use record types) and tutorials like the Database-Backed Record Type Tutorial. After using this pattern, review other patterns to learn how to build reports and interfaces using this data in different components.
This page shows you:
How to use the a!writeRecords() smart service function to create record data directly from an interface.
How to use the disabled parameter of an interface component based on user interactions.
| SetupCopy link to clipboard
For this pattern, we'll create a record type with data sync enabled, and then use the a!writeRecords() smart service function in a basic interface to populate the record type's data source with example data. We'll use the Appian Tutorial application as a starting point.
To set up this pattern:
Create the Appian Tutorial application.
Create a record type.
Create a data model.
Create an interface.
Load the sample data.
Create the Appian Tutorial ApplicationCopy link to clipboard
Tip: The Appian Tutorial application is used throughout Appian tutorials. Skip the steps in this section if you've already created this application in another tutorial.
To begin, we need to create an application to contain our design objects.
We will be creating the Appian Tutorial application for this tutorial. All of Appian's tutorials use the Appian Tutorial application as the reference application. After completing this tutorial, you can reuse this application as you work through other Appian tutorials.
To create the Appian Tutorial application:
Log in to Appian Designer (for example, myappiansite.com/suite/design).
In the Applications view, click +New Application.
In the Create New Application dialog, configure the following properties:
Property Description
Name Enter Appian Tutorial.
Prefix Keep the default prefix, AT, which Appian constructs using the initial characters of each word you entered in the Name parameter. We'll be following the recommended naming standard, and using this short, unique prefix whenever we name an object in this application.
Description Leave blank. It's normally a best practice to add descriptions to all design objects. However, to save a little time during this tutorial, we'll skip adding descriptions unless the description displays to the end user.
Generate groups and folders to secure and organize objects Keep this checkbox selected, so that Appian will automatically generate standard groups and folders and assign default security groups for this application.
Click CREATE.
In the Review Application Security dialog, keep the default security settings. Because we selected the Generate groups and folders option in the previous step, Appian automatically uses the AT Users and AT Administrator groups it generated to set our application security appropriately.
Tip: The security of the application object is unrelated to the security of each of the objects contained within the application. This means that you will need to set security permissions for every object in an application in addition to the application object itself. For more information about security permissions for the application object, see Application Security.
Click SAVE.
screenshot of the Explore view
Right now, the application contains the folders and groups Appian generated automatically. To see these, click Build in the navigation pane. Each design object that you create during the course of this tutorial will appear in this list in the Build view and be associated with the tutorial application.
screenshot of the build view
Create a record typeCopy link to clipboard
To create the record type you'll need for this pattern:
In the Build view of the Appian Tutorial application, click NEW > Record type.
Configure the following properties:
Property Description
Name Keep the application prefix that prepopulates this property, and add Employee, so that the name is <prefix> Employee.
Display Name (Plural) Keep the generated value of Employees.
Description (Optional) Enter a brief description of the record type.
Click CREATE.
In the Review Record Type Security dialog, keep the default settings. AT Administrators group should be assigned Administrator permissions for the group.
Click SAVE.
Create a data modelCopy link to clipboard
You're ready to create the data model for the Employee record type. Instead of using an existing data source, we'll add a new table to the database to store employee data. This new data model includes six record fields for employee information, as well as some automatically generated metadata fields for tracking data creation and modification.
Note: This step takes advantage of codeless data modeling, which requires an environment connected to a supported database. Codeless data modeling supports MariaDB, MySQL, Oracle, SQL Server, PostgreSQL, and Aurora MySQL databases. For example, you can use an Appian Cloud or an Appian Community Edition environment.
If your environment connects to a different database, instead of following the instructions below, you'll need to create a database table that contains the needed fields, then choose that database table as the source of your record type.
To create the data model:
Click TELL US ABOUT YOUR DATA.
Select New Data Model.
Click NEXT.
For Data Source, select jdbc/Appian (Tomcat). This is the database included with each Appian instance.
Click NEXT.
In the row for the id field, click Add Multiple Fields Add Multiple Fields.
For Enter a number between 1 and 20, enter 5.
Click Add.
For each field in the following table, enter the field name in one of the empty fields created in the previous step.
Name Type
firstName Text
lastName Text
department Text
title Text
phoneNumber Text
In the list of Commonly Used Fields, click startDate.
Remove the following fields:
Created By
Created On
Modified By
Modified On
Click NEXT.
On the Relationships page, click NEXT.
On the Review page, click SAVE CHANGES.
On the success page, click FINISH. You can discard the database script created for the record type.
Note: It is normally a best practice to include the default Created By, Created On, Modified By, and Modified On fields in your record type, but we are removing them for the purposes of this recipe and the tutorials that rely on it.
Create an interfaceCopy link to clipboard
Now, let's create an interface to trigger the a!writeRecords() smart service function. This function publishes the sample data to your new database table and syncs those changes in Appian so they appear in the record type.
To create this interface:
In the Build view of your application, click NEW > Interface.
Configure the following properties:
Property Description
Name Enter: <prefix>_employeeData
Description Enter: Interface for loading employee data
Folder Select the appropriate folder in your application or, if it doesn't exist, create it by clicking the Create New Rule Folder link.
Click CREATE.
In your new interface, click EXPRESSION.
In the INTERFACE DEFINITION pane, paste the expression below.
Since record type references are specific to each environment, you need to update the expression to work with your application:
Line 28: In the cast() function, replace recordType!Employee with your record type.
Line 38: In the a!queryRecordType() function, replace the recordType value of recordType!Employee with your record type.
Line 44: In the a!sortInfo() function, replace the field value of recordType!Employee.field.id with a reference to your record type's id field.
Click SAVE CHANGES.
Load the sample data
You are ready to run the expression and populate the record type with data.
To load the data, in the PREVIEW pane of the interface, click PUBLISH DATA.
After data has been published to your database, the button text changes to DATA ALREADY PUBLISHED. The button will stay disabled as long as there is employee data present in the database table.
View the sample data
The disabled button means that the data was successfully published. If you want to see the new record data, you can do so in the record type.
To view the record data:
Return to the Employee record type.
Refresh your browser to refresh the record type.
Click DATA PREVIEW.
Data preview of Employee record type
Tip: Check out the Record Type Tutorial (Database) to configure the rest of this record type!
Expression
a!localVariables(
/* The data to load into the record data source. */
local!dataToLoad: a!forEach(
{
a!map( firstName: "John" , lastName: "Smith" , department: "Engineering" , title: "Director" , phoneNumber: "555-123-4567" , startDate: today()-360 ),
a!map( firstName: "Michael" , lastName: "Johnson" , department: "Finance" , title: "Analyst" , phoneNumber: "555-987-6543" , startDate: today()-360 ),
a!map( firstName: "Mary", lastName: "Reed" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-456-0123" , startDate: today()-240 ),
a!map( firstName: "Angela" , lastName: "Cooper" , department: "Sales" , title: "Manager" , phoneNumber: "555-123-4567" , startDate: today()-240 ),
a!map( firstName: "Elizabeth" , lastName: "Ward" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-987-6543" , startDate: today()-240 ),
a!map( firstName: "Daniel", lastName: "Lewis" , department: "HR" , title: "Manager" , phoneNumber: "555-876-5432" , startDate: today()-180 ),
a!map( firstName: "Paul" , lastName: "Martin" , department: "Finance" , title: "Analyst" , phoneNumber: "555-609-3691" , startDate: today()-150 ),
a!map( firstName: "Jessica" , lastName: "Peterson" , department: "Finance" , title: "Analyst" , phoneNumber: "555-987-6543" , startDate: today()-150 ),
a!map( firstName: "Mark" , lastName: "Hall" , department: "Professional Services" , title: "Director" , phoneNumber: "555-012-3456" , startDate: today()-150 ),
a!map( firstName: "Rebecca" , lastName: "Wood" , department: "Engineering" , title: "Manager" , phoneNumber: "555-210-3456" , startDate: today()-150 ),
a!map( firstName: "Pamela" , lastName: "Sanders" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-123-4567" , startDate:today()-120 ),
a!map( firstName: "Christopher" , lastName: "Morris" , department: "Professional Services" , title: "Consultant" , phoneNumber: "555-456-7890" , startDate: today()-120 ),
a!map( firstName: "Kevin" , lastName: "Stewart" , department: "Professional Services" , title: "Manager" , phoneNumber: "555-345-6789" , startDate: today()-120 ),
a!map( firstName: "Stephen" , lastName: "Edwards" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-765-4321" , startDate: today()-120 ),
a!map( firstName: "Janet", lastName:"Coleman" , department: "Finance" , title: "Director" , phoneNumber: "555-654-3210" , startDate: today()-90 ),
a!map( firstName: "Scott" , lastName: "Bailey" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-678-1235" , startDate: today()-30 ),
a!map( firstName: "Andrew" , lastName: "Nelson" , department: "Professional Services" , title: "Consultant" , phoneNumber: "555-789-4560" , startDate: today()-30 ),
a!map( firstName: "Michelle" , lastName: "Foster" , department: "HR" , title: "Director" , phoneNumber: "555-345-6789" , startDate: today()-30 ),
a!map( firstName: "Laura" , lastName:"Bryant" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-987-6543" , startDate: today()-14 ),
a!map( firstName: "William" , lastName: "Ross" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-123-4567" , startDate: today()-10 ),
a!map( firstName: "Arya" , lastName:"Colson" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-927-3343" , startDate: today()-5 )
},
cast(
recordType!Employee,
fv!item
)
),
/* This value gets updated when the user clicks on the PUBLISH DATA button in order to disable it
so the user can't click it multiple times. */
local!submitted: false,
/* The refresh variable watches local!submitted and reruns the query when it changes. */
local!records: a!refreshVariable(
value: a!queryRecordType(
recordType: recordType!Employee,
pagingInfo:
a!pagingInfo(
startIndex: 1,
batchSize: 1000,
sort: a!sortInfo(
field: recordType!Employee.fields.id,
ascending: true
)
),
fetchTotalCount: true
),
refreshOnVarChange: local!submitted
),
local!hasData: not(local!records.totalCount=0),
a!sectionLayout(
contents: {
a!buttonLayout(
secondaryButtons:{
a!buttonWidget(
label: if(local!hasData, "Data Already Published", "Publish Data"),
saveInto: {
a!writeRecords(
records: local!dataToLoad,
onSuccess: a!save(local!submitted, true)
)
},
submit: true,
style: "SOLID",
disabled: or(local!hasData, local!submitted)
)
}
)
}
)
)
| Solve the following leet code problem |
Use the Write to Data Store Entity Smart Service Function on an Interface.
Allow the user to publish several rows of data to a table through the a!writeToDataStoreEntity() smart service function.
Follow this pattern to create example data and supporting objects to use with other interface patterns (including those that use record types). After using this pattern, review other patterns to learn how to build reports and interfaces using this data in different components.
This scenario demonstrates:
1.How to use the a!writeToDataStoreEntity() smart service function to persist data directly from an interface.
2.How to use the showWhen parameter of an interface component to choose one component or another, based off a user's interactions.
| SetupCopy link to clipboard
Tip: Try to follow these setup steps verbatim. However, if you do need to adjust any of the values, you'll need to ensure that you make the necessary modifications to interface patterns that depend on this data.
For this pattern, we'll use a custom data type (CDT), then a smart service function to populate the related table with example data.
To set up this pattern:
Create a CDT.
Create a data store.
Create a constant for the data store entity.
Create an interface.
Test it out.
Note: For certain design objects, we recommend starting object names with a short, unique prefix specific to the related application. To follow that best practice, start the object names used in this pattern with your application's prefix.
Create a CDTCopy link to clipboard
To create the CDT you'll need for this pattern:
In the Build view of your application, click New > Data Type.
Configure the following properties:
Property Description
Namespace Leave the default value.
Name Keep the application prefix that prepopulates this property, and add employee, so that the name is <prefix>_employee.
Description (Optional) Enter a brief description of the data type.
Click CREATE.
Add the primary key field:
Click New Field.
For Name, enter id.
For Type, select Number (Integer).
Click the Key icon.
Select Primary Key.
Select Auto-generate … to let the database handle value assignment.
Click OK.
For each field in the following table, click New Field, then set the properties as specified:
Name Type
firstName Text
lastName Text
department Text
title Text
phoneNumber Text
startDate Date
Click SAVE CHANGES.
Create a data storeCopy link to clipboard
Next, create a data store named <prefix> Employee DS in the same application where you created the CDT. Add an entity to the data store with the Name property set to <prefix> employee and the Type property set to the employee CDT you created.
Create a constant for the data store entityCopy link to clipboard
Next, let's create a constant for the data store entity, so we can use the newly created data store in an expression.
Create a constant with following properties:
Property Description
Name Enter: <prefix>_EMPLOYEE_ENTITY
Type Select Data Store Entity.
Data Store Select the <prefix> Employee DS data store you created.
Entity Select the <prefix>_employee entity you created.
Save In Select the appropriate folder in your application or, if it doesn't exist, create it by clicking the Create New Rule Folder link.
Note: Constants inherit security from the parent folder.
Create an interfaceCopy link to clipboard
Finally, let's create an interface to display the example data in a grid and trigger the smart service function to publish the data to your data store entity.
To create this interface:
In the Build view of your application, click NEW > Interface.
Configure the following properties:
Property Description
Name Enter: <prefix>_employeeGrid
Description Enter: Grid of employees
Folder Select the appropriate folder in your application or, if it doesn't exist, create it by clicking the Create New Rule Folder link.
Click CREATE.
In your new interface, click EXPRESSION
In the INTERFACE DEFINITION pane, paste the expression below.
If you started your object names with an application prefix, customize the expression:
In the type constructor (line 4), replace 'type!{urn:com:appian:types}employee?list' with your data type's namespace and name. The format is: type!{<Namespace>}<Name>?list.
Throughout the expression, replace the constant references (cons!EMPLOYEE_ENTITY) with the constant name you used.
Click SAVE CHANGES.
Test it outCopy link to clipboard
To test the expression out:
In the interface, click TEST.
In the PREVIEW pane of the interface, click PUBLISH DATA.
Notice the ID values went from all N/A to a sequential value when shown in the new grid.
After data has been published to the relational database table, the button text changes to DATA ALREADY PUBLISHED. The button will stay disabled and remain disabled as long as there is employee data present in the relational database table.
Note: To customize this pattern to fit your business cases, see the section, Substitute with Manual Data.
ExpressionCopy link to clipboard
a!localVariables(
/* The data to load into the data store entity. */
local!dataToLoad: cast(
'type!{urn:com:appian:types}employee?list',
{
a!map( firstName: "John" , lastName: "Smith" , department: "Engineering" , title: "Director" , phoneNumber: "555-123-4567" , startDate: today()-360 ),
a!map( firstName: "Michael" , lastName: "Johnson" , department: "Finance" , title: "Analyst" , phoneNumber: "555-987-6543" , startDate: today()-360 ),
a!map( firstName: "Mary", lastName: "Reed" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-456-0123" , startDate: today()-240 ),
a!map( firstName: "Angela" , lastName: "Cooper" , department: "Sales" , title: "Manager" , phoneNumber: "555-123-4567" , startDate: today()-240 ),
a!map( firstName: "Elizabeth" , lastName: "Ward" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-987-6543" , startDate: today()-240 ),
a!map( firstName: "Daniel", lastName: "Lewis" , department: "HR" , title: "Manager" , phoneNumber: "555-876-5432" , startDate: today()-180 ),
a!map( firstName: "Paul" , lastName: "Martin" , department: "Finance" , title: "Analyst" , phoneNumber: "555-609-3691" , startDate: today()-150 ),
a!map( firstName: "Jessica" , lastName: "Peterson" , department: "Finance" , title: "Analyst" , phoneNumber: "555-987-6543" , startDate: today()-150 ),
a!map( firstName: "Mark" , lastName: "Hall" , department: "Professional Services" , title: "Director" , phoneNumber: "555-012-3456" , startDate: today()-150 ),
a!map( firstName: "Rebecca" , lastName: "Wood" , department: "Engineering" , title: "Manager" , phoneNumber: "555-210-3456" , startDate: today()-150 ),
a!map( firstName: "Pamela" , lastName: "Sanders" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-123-4567" , startDate:today()-120 ),
a!map( firstName: "Christopher" , lastName: "Morris" , department: "Professional Services" , title: "Consultant" , phoneNumber: "555-456-7890" , startDate: today()-120 ),
a!map( firstName: "Kevin" , lastName: "Stewart" , department: "Professional Services" , title: "Manager" , phoneNumber: "555-345-6789" , startDate: today()-120 ),
a!map( firstName: "Stephen" , lastName: "Edwards" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-765-4321" , startDate: today()-120 ),
a!map( firstName: "Janet", lastName:"Coleman" , department: "Finance" , title: "Director" , phoneNumber: "555-654-3210" , startDate: today()-90 ),
a!map( firstName: "Scott" , lastName: "Bailey" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-678-1235" , startDate: today()-30 ),
a!map( firstName: "Andrew" , lastName: "Nelson" , department: "Professional Services" , title: "Consultant" , phoneNumber: "555-789-4560" , startDate: today()-30 ),
a!map( firstName: "Michelle" , lastName: "Foster" , department: "HR" , title: "Director" , phoneNumber: "555-345-6789" , startDate: today()-30 ),
a!map( firstName: "Laura" , lastName:"Bryant" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-987-6543" , startDate: today()-14 ),
a!map( firstName: "William" , lastName: "Ross" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-123-4567" , startDate: today()-10 ),
a!map( firstName: "Arya" , lastName:"Colson" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-927-3343" , startDate: today()-5 )
}
),
/* This value gets updated when the user clicks on the PUBLISH DATA button in order to disable it
so the user can't click it multiple times. */
local!submitted: false,
/* The refresh variable watches local!submitted and reruns the query when it changes. */
local!datasubset: a!refreshVariable(
value: a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: -1,
sort: a!sortInfo(field: "id", ascending: true)
)
),
fetchTotalCount: true
),
refreshOnVarChange: local!submitted
),
local!hasData: not(local!datasubset.totalCount=0),
a!sectionLayout(
contents: {
a!buttonLayout(
secondaryButtons:{
a!buttonWidget(
label: if(local!hasData, "Data Already Published", "Publish Data"),
saveInto: {
a!writeToDataStoreEntity(
dataStoreEntity: cons!EMPLOYEE_ENTITY,
valueToStore: local!dataToLoad,
/* Since the writeToDataStoreEntity function doesn't change values in the
interface, we add an additional save to update a local variable so the
the query in local!datasubset runs again. */
onSuccess: a!save(local!submitted, true)
)
},
submit: true,
style: "SOLID",
disabled: or(local!hasData, local!submitted)
)
}
),
a!gridField(
label: "DATA TO WRITE",
labelPosition: "ABOVE",
data: local!dataToLoad,
columns: {
a!gridColumn(
label: "ID",
value: if(isnull(fv!row.id), "N/A", fv!row.id)
),
a!gridColumn(
label: "First Name",
value: fv!row.firstName
),
a!gridColumn(
label: "Last Name",
value: fv!row.lastName
),
a!gridColumn(
label: "Department",
value: fv!row.department
),
a!gridColumn(
label: "Title",
value: fv!row.title
),
a!gridColumn(
label: "Phone Number",
value: fv!row.phoneNumber
),
a!gridColumn(
label: "Start Date",
value: fv!row.startDate
)
},
validations: {},
showWhen: local!datasubset.totalCount = 0
),
a!gridField(
label: "DATA WRITTEN",
labelPosition: "ABOVE",
data: a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(pagingInfo: fv!pagingInfo),
fetchTotalCount: true
),
columns: {
a!gridColumn(
label: "ID",
value: fv!row.id
),
a!gridColumn(
label: "First Name",
value: fv!row.firstName
),
a!gridColumn(
label: "Last Name",
value: fv!row.lastName
),
a!gridColumn(
label: "Department",
value: fv!row.department
),
a!gridColumn(
label: "Title",
value: fv!row.title
),
a!gridColumn(
label: "Phone Number",
value: fv!row.phoneNumber
),
a!gridColumn(
label: "Start Date",
value: fv!row.startDate
)
},
initialSorts: a!sortInfo("id", true),
showWhen: not(local!datasubset.totalCount = 0)
)
}
)
)
Notable implementation details
Two grids are configured in this example, but only one will ever show at a time. Instead of writing the logic in each of the grid text columns, we are showing a grid with hard-coded data when nothing is in the database table and the other grid when there is database data available.
Substitute with Manual Data
This section describes how you can use the following manual data in place of an entity query featured in an interface pattern.
Manual Data
The following data is what you'll use in place of the entity query in the subsequent examples:
{
a!map( firstName: "John" , lastName: "Smith" , department: "Engineering" , title: "Director" , phoneNumber: "555-123-4567" , startDate: today()-360 ),
a!map( firstName: "Michael" , lastName: "Johnson" , department: "Finance" , title: "Analyst" , phoneNumber: "555-987-6543" , startDate: today()-360 ),
a!map( firstName: "Mary", lastName: "Reed" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-456-0123" , startDate: today()-240 ),
a!map( firstName: "Angela" , lastName: "Cooper" , department: "Sales" , title: "Manager" , phoneNumber: "555-123-4567" , startDate: today()-240 ),
a!map( firstName: "Elizabeth" , lastName: "Ward" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-987-6543" , startDate: today()-240 ),
a!map( firstName: "Daniel", lastName: "Lewis" , department: "HR" , title: "Manager" , phoneNumber: "555-876-5432" , startDate: today()-180 ),
a!map( firstName: "Paul" , lastName: "Martin" , department: "Finance" , title: "Analyst" , phoneNumber: "555-609-3691" , startDate: today()-150 ),
a!map( firstName: "Jessica" , lastName: "Peterson" , department: "Finance" , title: "Analyst" , phoneNumber: "555-987-6543" , startDate: today()-150 ),
a!map( firstName: "Mark" , lastName: "Hall" , department: "Professional Services" , title: "Director" , phoneNumber: "555-012-3456" , startDate: today()-150 ),
a!map( firstName: "Rebecca" , lastName: "Wood" , department: "Engineering" , title: "Manager" , phoneNumber: "555-210-3456" , startDate: today()-150 ),
a!map( firstName: "Pamela" , lastName: "Sanders" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-123-4567" , startDate:today()-120 ),
a!map( firstName: "Christopher" , lastName: "Morris" , department: "Professional Services" , title: "Consultant" , phoneNumber: "555-456-7890" , startDate: today()-120 ),
a!map( firstName: "Kevin" , lastName: "Stewart" , department: "Professional Services" , title: "Manager" , phoneNumber: "555-345-6789" , startDate: today()-120 ),
a!map( firstName: "Stephen" , lastName: "Edwards" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-765-4321" , startDate: today()-120 ),
a!map( firstName: "Janet", lastName:"Coleman" , department: "Finance" , title: "Director" , phoneNumber: "555-654-3210" , startDate: today()-90 ),
a!map( firstName: "Scott" , lastName: "Bailey" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-678-1235" , startDate: today()-30 ),
a!map( firstName: "Andrew" , lastName: "Nelson" , department: "Professional Services" , title: "Consultant" , phoneNumber: "555-789-4560" , startDate: today()-30 ),
a!map( firstName: "Michelle" , lastName: "Foster" , department: "HR" , title: "Director" , phoneNumber: "555-345-6789" , startDate: today()-30 ),
a!map( firstName: "Laura" , lastName:"Bryant" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-987-6543" , startDate: today()-14 ),
a!map( firstName: "William" , lastName: "Ross" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-123-4567" , startDate: today()-10 ),
a!map( firstName: "Arya" , lastName:"Colson" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-927-3343" , startDate: today()-5 )
}
Example: Full Query Replace
Whether the query is in a local variable, or in the data parameter of a grid, you can replace it with the manual data. First, identify the entity query (a!queryEntity) in the expression.
a!gridField(
label: "Read-only Grid",
labelPosition: "ABOVE",
data: a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
selection: a!querySelection(
columns: {
a!queryColumn(field: "firstName"),
a!queryColumn(field: "lastName"),
a!queryColumn(field: "department"),
a!queryColumn(field: "title"),
a!queryColumn(field: "startDate")
}
),
pagingInfo: fv!pagingInfo
),
fetchTotalCount: true
),
columns: {
...
Next, replace it with the manual data:
a!gridField(
label: "Read-only Grid",
labelPosition: "ABOVE",
data: {
a!map( firstName: "John" , lastName: "Smith" , department: "Engineering" , title: "Director" , phoneNumber: "555-123-4567" , startDate: today()-360 ),
a!map( firstName: "Michael" , lastName: "Johnson" , department: "Finance" , title: "Analyst" , phoneNumber: "555-987-6543" , startDate: today()-360 ),
a!map( firstName: "Mary", lastName: "Reed" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-456-0123" , startDate: today()-240 ),
a!map( firstName: "Angela" , lastName: "Cooper" , department: "Sales" , title: "Manager" , phoneNumber: "555-123-4567" , startDate: today()-240 ),
a!map( firstName: "Elizabeth" , lastName: "Ward" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-987-6543" , startDate: today()-240 ),
a!map( firstName: "Daniel", lastName: "Lewis" , department: "HR" , title: "Manager" , phoneNumber: "555-876-5432" , startDate: today()-180 ),
a!map( firstName: "Paul" , lastName: "Martin" , department: "Finance" , title: "Analyst" , phoneNumber: "555-609-3691" , startDate: today()-150 ),
a!map( firstName: "Jessica" , lastName: "Peterson" , department: "Finance" , title: "Analyst" , phoneNumber: "555-987-6543" , startDate: today()-150 ),
a!map( firstName: "Mark" , lastName: "Hall" , department: "Professional Services" , title: "Director" , phoneNumber: "555-012-3456" , startDate: today()-150 ),
a!map( firstName: "Rebecca" , lastName: "Wood" , department: "Engineering" , title: "Manager" , phoneNumber: "555-210-3456" , startDate: today()-150 ),
a!map( firstName: "Pamela" , lastName: "Sanders" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-123-4567" , startDate:today()-120 ),
a!map( firstName: "Christopher" , lastName: "Morris" , department: "Professional Services" , title: "Consultant" , phoneNumber: "555-456-7890" , startDate: today()-120 ),
a!map( firstName: "Kevin" , lastName: "Stewart" , department: "Professional Services" , title: "Manager" , phoneNumber: "555-345-6789" , startDate: today()-120 ),
a!map( firstName: "Stephen" , lastName: "Edwards" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-765-4321" , startDate: today()-120 ),
a!map( firstName: "Janet", lastName:"Coleman" , department: "Finance" , title: "Director" , phoneNumber: "555-654-3210" , startDate: today()-90 ),
a!map( firstName: "Scott" , lastName: "Bailey" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-678-1235" , startDate: today()-30 ),
a!map( firstName: "Andrew" , lastName: "Nelson" , department: "Professional Services" , title: "Consultant" , phoneNumber: "555-789-4560" , startDate: today()-30 ),
a!map( firstName: "Michelle" , lastName: "Foster" , department: "HR" , title: "Director" , phoneNumber: "555-345-6789" , startDate: today()-30 ),
a!map( firstName: "Laura" , lastName:"Bryant" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-987-6543" , startDate: today()-14 ),
a!map( firstName: "William" , lastName: "Ross" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-123-4567" , startDate: today()-10 ),
a!map( firstName: "Arya" , lastName:"Colson" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-927-3343" , startDate: today()-5 )
},
columns: {
Example: Just the Data
When just the data is being used from a query, it's usually defined in a local variable. You can tell because the query has a .data suffix.
a!localVariables(
/* This variable stores the grid's selection. */
local!selection,
/* This variable stores the row information for the grid's selection. */
local!selectedRows,
local!removedIds,
local!employeeData: a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
selection: a!querySelection(
columns: {
a!queryColumn(field: "id"),
a!queryColumn(field: "firstName"),
a!queryColumn(field: "lastName"),
a!queryColumn(field: "department"),
a!queryColumn(field: "title"),
}
),
pagingInfo: a!pagingInfo(startIndex: 1, batchSize: 10)
),
fetchTotalCount: true
).data,
Replace the entire query, including .data, with your manual data:
a!localVariables(
/* This variable stores the grid's selection. */
local!selection,
/* This variable stores the row information for the grid's selection. */
local!selectedRows,
local!removedIds,
local!employeeData: {
a!map( firstName: "John" , lastName: "Smith" , department: "Engineering" , title: "Director" , phoneNumber: "555-123-4567" , startDate: today()-360 ),
a!map( firstName: "Michael" , lastName: "Johnson" , department: "Finance" , title: "Analyst" , phoneNumber: "555-987-6543" , startDate: today()-360 ),
a!map( firstName: "Mary", lastName: "Reed" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-456-0123" , startDate: today()-240 ),
a!map( firstName: "Angela" , lastName: "Cooper" , department: "Sales" , title: "Manager" , phoneNumber: "555-123-4567" , startDate: today()-240 ),
a!map( firstName: "Elizabeth" , lastName: "Ward" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-987-6543" , startDate: today()-240 ),
a!map( firstName: "Daniel", lastName: "Lewis" , department: "HR" , title: "Manager" , phoneNumber: "555-876-5432" , startDate: today()-180 ),
a!map( firstName: "Paul" , lastName: "Martin" , department: "Finance" , title: "Analyst" , phoneNumber: "555-609-3691" , startDate: today()-150 ),
a!map( firstName: "Jessica" , lastName: "Peterson" , department: "Finance" , title: "Analyst" , phoneNumber: "555-987-6543" , startDate: today()-150 ),
a!map( firstName: "Mark" , lastName: "Hall" , department: "Professional Services" , title: "Director" , phoneNumber: "555-012-3456" , startDate: today()-150 ),
a!map( firstName: "Rebecca" , lastName: "Wood" , department: "Engineering" , title: "Manager" , phoneNumber: "555-210-3456" , startDate: today()-150 ),
a!map( firstName: "Pamela" , lastName: "Sanders" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-123-4567" , startDate:today()-120 ),
a!map( firstName: "Christopher" , lastName: "Morris" , department: "Professional Services" , title: "Consultant" , phoneNumber: "555-456-7890" , startDate: today()-120 ),
a!map( firstName: "Kevin" , lastName: "Stewart" , department: "Professional Services" , title: "Manager" , phoneNumber: "555-345-6789" , startDate: today()-120 ),
a!map( firstName: "Stephen" , lastName: "Edwards" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-765-4321" , startDate: today()-120 ),
a!map( firstName: "Janet", lastName:"Coleman" , department: "Finance" , title: "Director" , phoneNumber: "555-654-3210" , startDate: today()-90 ),
a!map( firstName: "Scott" , lastName: "Bailey" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-678-1235" , startDate: today()-30 ),
a!map( firstName: "Andrew" , lastName: "Nelson" , department: "Professional Services" , title: "Consultant" , phoneNumber: "555-789-4560" , startDate: today()-30 ),
a!map( firstName: "Michelle" , lastName: "Foster" , department: "HR" , title: "Director" , phoneNumber: "555-345-6789" , startDate: today()-30 ),
a!map( firstName: "Laura" , lastName:"Bryant" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-987-6543" , startDate: today()-14 ),
a!map( firstName: "William" , lastName: "Ross" , department: "Engineering" , title: "Software Engineer" , phoneNumber: "555-123-4567" , startDate: today()-10 ),
a!map( firstName: "Arya" , lastName:"Colson" , department: "Sales" , title: "Sales Associate" , phoneNumber: "555-927-3343" , startDate: today()-5 )
},
| Solve the following leet code problem |
Year-Over-Year Sales Growth.
ScenarioCopy link to clipboard
Sales executives at the Appian Retail company want to know how their sales in 2021 compared to their sales in 2020 so they can see, overall, how business is doing. Specifically, they need to know if business has grown over the year before they decide to expand existing product lines. If business has not grown, this may indicate that they need to shift their existing product strategy before expanding to new ones.
To show how 2021 sales compare to 2020 sales, you'll use the pattern on this page to calculate the company's year-over-year sales growth and display that value as a key performance indicator (KPI).
| SetupCopy link to clipboard
This pattern uses data from the Appian Retail application, available for free in Appian Community Edition. To follow along with this pattern, log in to Appian Community to request the latest Appian Community Edition site.
If you do not see the Appian Retail application available in your existing Appian Community Edition, you can request a new Appian Community Edition to get the latest application contents available.
This pattern will use data from the following record types in the Appian Retail application:
Order record type: Contains order information like the order number, date, status, and whether it was purchased online or in stores. For example, order number SO43659 was purchased in stores on 5/31/2019 and the order is closed.
Order Detail record type: Contains specific order details like the number of order items, order totals, promo codes applied, and products. For example, the order above contained one product that cost $2,024.99.
Create this patternCopy link to clipboard
To create this pattern:
Calculate sales growth.
Show sales growth in a KPI.
Show total sales in 2020 and total sales in 2021 as KPIs.
Step 1: Calculate year-over-year sales growthCopy link to clipboard
Sales growth is a common business metric that measures how quickly a company is growing its sales over a period of time. It's measured as a percentage using the following formula:
[(Sales for the current period - Sales for the previous period) / Sales for the previous period] x 100
For this example, you'll calculate the sum of sales in 2021 and 2020. You'll use the a!queryRecordType() function to calculate these values and store those values in two different local variables.
Once you have those variables, you can plug them into the sales growth formula and store the results in another local variable for easy reuse throughout the interface.
To calculate sales growth:
In the Appian Retail application, go to the Build view.
Click NEW > Interface.
Configure the interface properties and click CREATE.
Click EXPRESSION in the title bar.
Copy and paste the following expression:
Note: These record type references are specific to the Appian Retail application. If you're following along in the Appian Retail application, you can copy and paste this expression without updating the record type references.
a!localVariables(
/* Calculate the sum of sales for orders placed in 2021 */
local!sales2021: a!queryRecordType(
recordType: 'recordType!{ad898682-e651-4b2d-af67-47c1fcb1171f}Order',
filters: a!queryFilter(
field: 'recordType!Order.fields.orderDate',
operator: "BETWEEN",
value: {
/* 2021 year */
todatetime("01/01/2021"),
todatetime("12/31/2021")
}
),
fields: a!aggregationFields(
/* Group by order date year */
groupings: a!grouping(
field: 'recordType!Order.fields.orderDate',
alias: "orderDate",
interval: "YEAR"
),
/* Get the sum of line total for all order items */
measures: a!measure(
field: 'recordType!Order.relationships.orderDetail.fields.lineTotal',
function: "SUM",
alias: "sumOfOrders"
)
),
pagingInfo: a!pagingInfo(startIndex: 1, batchSize: 500)
).data,
/* Calculate the sum of sales for orders placed in 2020 */
local!sales2020: a!queryRecordType(
recordType: 'recordType!Order',
filters: a!queryFilter(
field: 'recordType!Order.fields.orderDate',
operator: "BETWEEN",
value: {
/* 2020 year */
todatetime("01/01/2020"),
todatetime("12/31/2020")
}
),
fields: a!aggregationFields(
/* Group by order date year */
groupings: a!grouping(
field: 'recordType!Order.fields.orderDate',
alias: "orderDate",
interval: "YEAR"
),
/* Get the sum of line total for all order items */
measures: a!measure(
field: 'recordType!Order.relationships.orderDetail.fields.lineTotal',
function: "SUM",
alias: "sumOfOrders"
)
),
pagingInfo: a!pagingInfo(startIndex: 1, batchSize: 500)
).data,
/* Sales growth calculation */
local!salesGrowth: (
local!sales2021.sumOfOrders - local!sales2020.sumOfOrders
) / local!sales2020.sumOfOrders * 100,
/* Column layout that we'll use for our KPIs */
{
a!columnsLayout(
columns: {
a!columnLayout(contents: {}),
a!columnLayout(contents: {}),
a!columnLayout(contents: {})
}
)
}
)
Step 2: Show sales growth in a KPICopy link to clipboard
Now that you have the sales growth percentage, you can display this value as a KPI in the interface. To create the KPI, you'll use a card layout to display the sales growth percentage and add two labels.
To display sales growth in a KPI:
In your interface, click DESIGN in the title bar. A column layout with three columns appears.
From the PALETTE, drag a CARD component into the right column.
From the PALETTE, drag a RICH TEXT component into the Card Layout.
In the Rich Text component configuration, under Display Value, select Configure items.
Click ADD RICH TEXT.
From the Add Rich Text dialog, select STYLED TEXT.
In Display Value, click Styled Text.
In Text, click Styled Text.
Replace the existing expression with the following expression. This will round the sales growth value to the second decimal place, and display a percentage sign.
{round(local!salesGrowth, 2) & "%"}
Click OK.
For Size, select Large.
For Style, select Strong.
Return to the Rich Text configuration.
For Alignment, select Center.
Now that the sales growth percentage is displayed, let's add some labels:
From the PALETTE, drag another RICH TEXT component above the existing rich text component containing the sales growth. You'll use this second rich text component as a label.
In the Rich Text component configuration, under Display Value, keep the default selection of Use editor.
In the editor, enter Sales Growth.
In the editor, highlight the text, then click Size Size icon and select Medium Text.
For Alignment, select Center.
From the PALETTE, drag another RICH TEXT component below the existing rich text component containing the sales growth. You'll use this third rich text component to display the time frame.
In the Rich Text component configuration, under Display Value, keep the default selection of Use editor.
In the editor, enter 2020 - 2021.
In the editor, highlight the text, then click Size Size icon and select Medium Text.
For Alignment, select Center.
The interface currently looks like this:
images/sales-growth-kpi-alone.png
Step 3: Show 2020 and 2021 sales as KPIsCopy link to clipboard
In addition to the sales growth, let's add two more KPI: one that shows the sum of sales in 2020, and another that shows the sum of sales in 2021. Showing these two KPIs will help sales executives visualize the sales growth percentage.
Create a KPI for sum of sales in 2020Copy link to clipboard
To show the sum of sales in 2020 as a KPI:
From the PALETTE, drag a CARD component into the left column.
From the PALETTE, drag a RICH TEXT component into the Card Layout.
In the Rich Text component configuration, under Display Value, select Configure items.
Click ADD RICH TEXT.
From the Add Rich Text dialog, select STYLED TEXT.
In Display Value, click Styled Text.
In Text, click Styled Text.
Replace the existing expression with the following expression. This will display the sum of sales from last year in a dollar amount.
a!currency(
isoCode: "USD",
value: local!sales2020.sumOfOrders
)
Click OK.
For Size, select Large.
For Style, select Strong.
Return to the Rich Text configuration.
For Alignment, select Center.
To add labels to your sales KPI:
From the PALETTE, drag another RICH TEXT component above the existing rich text component containing 2020 sales. You'll use this second rich text component as a label.
In the Rich Text component configuration, under Display Value, keep the default selection of Use editor.
In the editor, enter Total Sales.
In the editor, highlight the text, then click Size Size icon and select Medium Text.
For Alignment, select Center.
From the PALETTE, drag another RICH TEXT component below the existing rich text component containing 2020 sales. You'll use this third rich text component to display the time frame.
In the Rich Text component configuration, under Display Value, keep the default selection of Use editor.
In the editor, enter 2020.
In the editor, highlight the text, then click Size Size icon and select Medium Text.
For Alignment, select Center.
Create a KPI for sum of sales in 2021Copy link to clipboard
To show the sum of sales in 2021 as a KPI:
From the PALETTE, drag a CARD component into the middle column.
From the PALETTE, drag a RICH TEXT component into the Card Layout.
In the Rich Text component configuration, under Display Value, select Configure items.
Click ADD RICH TEXT.
From the Add Rich Text dialog, select STYLED TEXT.
In Display Value, click Styled Text.
In Text, click Styled Text.
Replace the existing expression with the following expression. This will display the sum of sales in 2021 in a dollar amount.
a!currency(
isoCode: "USD",
value: local!sales2021.sumOfOrders
)
Click OK.
For Size, select Large.
For Style, select Strong.
Return to the Rich Text configuration.
For Alignment, select Center.
To add labels to your sales KPI:
From the PALETTE, drag another RICH TEXT component above the existing rich text component containing 2021 sales. You'll use this second rich text component as a label.
In the Rich Text component configuration, under Display Value, keep the default selection of Use editor.
In the editor, enter Total Sales.
In the editor, highlight the text, then click Size Size icon and select Medium Text.
For Alignment, select Center.
From the PALETTE, drag another RICH TEXT component below the existing rich text component containing 2021 sales. You'll use this third rich text component to display the time frame.
In the Rich Text component configuration, under Display Value, keep the default selection of Use editor.
In the editor, enter 2021.
In the editor, highlight the text, then click Size Size icon and select Medium Text.
For Alignment, select Center.
The final interface looks like this:
images/sales-growth-kpi.png
Full expressionCopy link to clipboard
The resulting expression will look like this:
Note: You can copy and paste this expression into an interface in the Appian Retail application to see the fully configured pattern.
If you're using a different environment, you will need to replace the record field references.
a!localVariables(
/* Calculate the sum of sales for orders placed in 2021 */
local!sales2021: a!queryRecordType(
recordType: 'recordType!Order',
filters: a!queryFilter(
field: 'recordType!Order.fields.orderDate',
operator: "BETWEEN",
value: {
/* 2021 year */
todatetime("01/01/2021"),
todatetime("12/31/2021")
}
),
fields: a!aggregationFields(
/* Group by order date year */
groupings: a!grouping(
field: 'recordType!Order.fields.orderDate',
alias: "orderDate",
interval: "YEAR"
),
/* Get the sum of line total for all order items */
measures: a!measure(
field: 'recordType!Order.relationships.orderDetail.fields.lineTotal',
function: "SUM",
alias: "sumOfOrders"
)
),
pagingInfo: a!pagingInfo(startIndex: 1, batchSize: 500)
).data,
/* Calculate the sum of sales for orders placed in 2020 */
local!sales2020: a!queryRecordType(
recordType: 'recordType!Order',
filters: a!queryFilter(
field: 'recordType!Order.fields.orderDate',
operator: "BETWEEN",
value: {
/* 2020 year */
todatetime("01/01/2020"),
todatetime("12/31/2020")
}
),
fields: a!aggregationFields(`
/* Group by order date year */
groupings: a!grouping(
field: 'recordType!Order.fields.orderDate',
alias: "orderDate",
interval: "YEAR"
),
/* Get the sum of line total for all order items */
measures: a!measure(
field: 'recordType!Order.relationships.orderDetail.fields.lineTotal',
function: "SUM",
alias: "sumOfOrders"
)
),
pagingInfo: a!pagingInfo(startIndex: 1, batchSize: 500)
).data,
/* Sales growth calculation */
local!salesGrowth: (
local!sales2021.sumOfOrders - local!sales2020.sumOfOrders
) / local!sales2020.sumOfOrders * 100,
/* Column layout that we'll use for our KPIs */
{
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!cardLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(text: { "Total Sales" }, size: "MEDIUM")
},
align: "CENTER"
),
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: {
a!currency(
isoCode: "USD",
value: local!sales2020.sumOfOrders
)
},
size: "LARGE",
style: { "STRONG" }
)
},
align: "CENTER"
),
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(text: { "2020" }, size: "MEDIUM")
},
align: "CENTER"
)
},
height: "AUTO",
style: "TRANSPARENT",
marginBelow: "STANDARD"
)
}
),
a!columnLayout(
contents: {
a!cardLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(text: { "Total Sales" }, size: "MEDIUM")
},
align: "CENTER"
),
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: {
a!currency(
isoCode: "USD",
value: local!sales2021.sumOfOrders
)
},
size: "LARGE",
style: { "STRONG" }
)
},
align: "CENTER"
),
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(text: { "2021" }, size: "MEDIUM")
},
align: "CENTER"
)
},
height: "AUTO",
style: "TRANSPARENT",
marginBelow: "STANDARD"
)
}
),
a!columnLayout(
contents: {
a!cardLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(text: { "Sales Growth" }, size: "MEDIUM")
},
align: "CENTER"
),
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: { { round(local!salesGrowth, 2) & "%" } },
size: "LARGE",
style: { "STRONG" }
)
},
align: "CENTER"
),
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(text: { "2020 - 2021" }, size: "MEDIUM")
},
align: "CENTER"
)
},
height: "AUTO",
style: "TRANSPARENT",
marginBelow: "STANDARD"
)
}
)
)
}
)
}
)
| Solve the following leet code problem |
Function Recipes.
This page lists a collection of function recipes you can use throughout the Appian application. Similar to a cookbook, it shows the individual ingredients that go into creating an expression using Appian functions, the order in which to combine them, and tips on when to use them or modify for preference.
The expressions listed below are not the only way to accomplish each desired outcome. This page is intended to teach you methods for creating expressions using Appian functions that are practical and efficient, as well as provide working expressions you can implement as is. Just as with cooking recipes, you may want to alter the values in each recipe to accommodate your specific requirements.
The function recipes are categorized by the type of output. Each recipe is titled with the question in mind, "What do you want to do?"
| Date/time results
Retrieve next anniversary date
Use case
You want to retrieve next year's anniversary date based on a start date, such as an employee's hire date of 02/05/2011.
Ingredients
if()
today()
date()
day()
month()
year()
Inputs
start (date)
Expression
if(
and(month(ri!start) <= month(today()),day(ri!start) <= day(today())),
date(1 + year(today()), month(ri!start), day(ri!start)),
date(year(today()), month(ri!start), day(ri!start))
)
Start a timer one minute after a process starts
Use case
You want to set a timer to start exactly one minute after a process starts, as compared to automatically.
Ingredients
pp!start_time
minute()
Expression
Configure this in the "Delay until the date and time specified by this expression" on the Setup tab for the Timer Event.
pp!start_time + minute(1)
Note: To change the time difference from 1 minute to more, modify the value in the minute() function as desired.
Add ten minutes to a datetime value
Use case
You want to add ten minutes to a datetime value saved as pv!datetime.
Ingredients
datetime
intervalds()
Expression
pv!datetime + intervalds(0,10,0)
Note: To change interval added to the datetime value, modify the values in intervalds() as desired.
Determine if a date-time value falls within working hours
Use case
Users are able to enter any date-time value, but you want to perform an extra validation after users submit the form to determine if a date-time value (saved as ri!dt) falls between your company's working hours of 6:00 AM and 5:00 PM.
The idea is to work with one consistent time scale, which is done here by the use of timestamps rather than both hours and minutes. This function constructs new timestamps for the boundaries matching the input.
Ingredients
or()
gmt()
datetime()
year()
month()
day()
Inputs
dt (DateTime)
Expression
or(
ri!dt > gmt(
datetime(
year(ri!dt),
month(ri!dt),
day(ri!dt),
17,
0,
0
)
),
ri!dt < gmt(
datetime(
year(ri!dt),
month(ri!dt),
day(ri!dt),
6,
0,
0
)
)
)
Note: To change the working hours, modify the values within the datetime() function as desired
Display the number of days before a specific date
Use case
You want to tell users how many business days are left before a deal closes, if the deal has already closed, or if the deal is closing today.
Ingredients
if()
networkdays()
today()
Inputs
closeDate (Date)
Expression
if(
networkdays(today(), ri!closeDate)<=0,
"This deal has closed.",
if(
networkdays(today(), ri!closeDate)=1,
"This deal will close at the end of today.",
"This deal will close in" & networkdays(today(), ri!closeDate) & "business days."
)
)
Note: To change the text that displays, modify the text as desired. To base the number of days on a system calendar, replace any instance of networkdays(today(), ri!closeDate) with calworkdays(today(), ri!closeDate, "companyCalendar") where companyCalendar is the name of your system calendar. To include all days (including weekends), replace any instance of networkdays(today(), ri!closeDate) with tointeger(ri!closeDate - today()).
See also: calworkdays() and tointeger()
Convert an XML string into a value of type Datetime
Use case
You have a localized XML string representing a date and time and need to convert it to a value of type Datetime in the GMT timezone.
Ingredients
a!localVariables()
split()
left()
right()
datetime()
gmt()
Inputs
dateText (Text)
Expression
=a!localVariables(
local!fullArray: split(ri!dateText, "T"),
local!dateArray: split(local!fullArray[1], "-"),
local!timeArray: split(left(local!fullArray[2], 12), ":"),
local!smsArray: split(local!timeArray[3], "."),
local!timeZone: "GMT" & right(local!fullArray[2], 6),
local!rawDate: datetime(
local!dateArray[1],
local!dateArray[2],
local!dateArray[3],
local!timeArray[1],
local!timeArray[2],
local!smsArray[1],
local!smsArray[2]
),
gmt(
local!rawDate,
local!timeZone
)
)
yields 9/25/2013 1:50 AM GMT+00:00 where ri!dateText = 2013-09-24T19:50:24.192-06:00
Number results
Return the number of active employees in your application
Use case
You want to quickly display how many employee records exist in your application.
Ingedients
topaginginfo()
totalCount
Expression
myQueryRule(topaginginfo(1,0)).totalCount
Note: When using a batchsize of 0 and attempting to only retrieve a total count based on a query, the function detailed above is better to use than count(myQueryRule()). If you used count(myQueryRule()), the system would run the main query; whereas using .totalcount, the system only executes a count query against the database.
Return the total number of revisions made to a document
Use case
You want to show the number of times a document has had a new version saved.
Ingedients
document()
Input
doc (Document)
Expression
document(ri!doc,"totalNumberOfVersions")-1)
Return a random integer in a range
Use case
You want to return a random integer between two integers, inclusive.
Ingredients
rand()
tointeger()
Inputs
min (Number (Integer))
max (Number (Integer))
Expression
ri!min + tointeger(rand() * (ri!max - ri!min))
Text results
Truncate text after 50 characters
Use case
You want to truncate the remaining part of a text value once it surpasses 50 characters by replacing the excess text with an ellipsis (…).
Ingredients
if()
len()
Inputs
text (Text)
Expression
if(
len(ri!text) > 50,
left(ri!text, 50) & "...",
ri!text
)
Note: To change the amount of characters allowed before truncating, modify the numeric value as desired.
Display the full name of a user
Use case
You want to display the full name of a user despite knowing only the username. Additionally, the field that is storing user information may not always contain a value.
Tip: If the User record type has data sync enabled, you can reference the firstAndLastName record field instead of building this expression.
Ingredients
if()
isnull()
user()
Inputs
user (User)
Expression
if(
isnull(ri!user),
"",
user(ri!user, "firstName") & " " & user(ri!user, "lastName")
)
Note: To change the user information that is populated, modify the second parameter in the user() function as desired.
Create a title from any text value
Use case
You want to convert a text value to display as a title, which will capitalize the first word, and all words not found in a "no capitalize" list.
Ingredients
proper()
split()
trim()
a!localVariables()
a!forEach()
if()
contains()
and()
not()
Inputs
title (Text)
Expression
a!localVariables(
/* Breaks up the title into an array of words and removes whitespaces. */
local!titleArray: split(trim(ri!title), " "),
/* A list of words that will be ignored. Adjust this list to change what does not get capitalized. */
local!noCaps: {"a","an","the","at","by","in","of","up","as","and","but","or","for","nor","etc.","etc","on","at","to","from", "that"},
/* If the word is in local!noCaps but not the first word, don't capitalize. Otherwise capitalize the word. */
concat(
a!forEach(
items: local!titleArray,
expression: if(
and(not(fv!isFirst), contains(local!noCaps, fv!item)),
fv!item,
proper(fv!item)
) & if(fv!isLast, "", " ")
)
)
)
Note: To produce initial caps for your own text, modify the text value as desired.
Array results
Remove all values in an array
Use case
You want to remove all values in an array so it is considered empty.
Ingredients
ldrop()
count()
Inputs
array (Any Array)
Expression
ldrop(ri!array, count(ri!array))
Note: Instead of the word array, enter the name or array reference as needed.
Repeat each item in an array based on the values of a different array
Use case
You want to repeat each item in an array (for example, local!textList) a certain number of times as defined by the values in a different array (for example, local!frequencyList).
Where local!textList = {"a", "b", "c"} and local!frequencyList = {2, 3, 1}, the output would be {"a", "a", "b", "b", "b", "c"}.
Ingredients
a!forEach()
repeat()
Inputs
textList (Array)
frequencyList (Array)
Expression
load(
local!textList: {"a","b","c"},
local!frequencyList:{2,3,1},
a!forEach(
items:local!textList,
expression: repeat(
local!frequencyList[fv!index],
fv!item
)
)
)
Note: To change which variables to use, modify the textList value to the array variable that should determine the text to repeat and modify the frequencyList value to the array variable that should determine how many times each text value in the aforementioned array should be repeated.
Extract a list from an EntityData array of the data written to a single entity
Use case
You want to extract the list of data written to an entity (for example, Opportunity) based on the output generated by using the Write to Multiple Data Store Entities Smart Service to write to three entities: Opportunity, Contact, and Line Item.
See also: Write to Multiple Data Store Entities Smart Service
The explanation of the configuration is longer than the solution. If you configure the Write to Multiple Data Store Entities Smart Service to update data for three entities (Opportunity, Contact, and Line Item), each entity may show up more than once in the EntityData input array. Consequently, the output of the smart service ("Stored Values") would contain a dynamic number of elements for each EntityData.
To get the list of all Opportunities that were updated by the smart service, you need to append every Data field where the entity is equal to Opportunity.
Ingredients
a!forEach().
Write to Multiple Data Store Entity Smart Service.
StoredValue (EntityData).
OPPORTUNITY_ENTITY Constant (Data Store Entity).
entityData is the array to operate on and entity is the context parameter.
Expression
Within the expression editor of a new custom output:
a!forEach(
items: merge(ac!StoredValues, cons!OPPORTUNITY_ENTITY),
expression: if(
fv!item[1].entity = fv!item[2],
fv!item.Data,
{}
)
)
Note: To change the entity by which to pull the list of data from, modify the OPPORTUNITY_ENTITY value as desired.
Sort an array
Use case
You want to sort an array of values.
Ingredients
todatasubset()
a!forEach()
a!pagingInfo()
a!sortInfo()
Inputs
array (Any Array)
Expression
todatasubset(
a!forEach(
ri!array,
{
value: fv!item
}
),
a!pagingInfo(
startIndex: 1,
batchSize: -1,
sort: a!sortInfo(
field:"value",
ascending: true
)
)
).data.value
Boolean results
Determine if items in an array are contained within another array
Use case
You want to see if any of the items in an array are contained within another array.
Ingredients
contains()
a!forEach()
or()
Expression
or(
a!forEach(
items:ri!originalArray,
expression: contains(ri!compareArray, fv!item)
)
)
Matching results
Return a CDT from an array that contains a field value matching another value
Use case
You have an array of department CDTs, each containing a field called Id, and you want to retrieve the CDT with an id value matching the value of a process variable.
Ingedients
displayvalue()
rule input: ri!departmentid (Integer)
rule input: ri!departments (CDT Array)
Custom Data Type:
department (Text)
|- id (Integer)
|- address (Text)
Expression
displayvalue(ri!departmentId, ri!departments.id, ri!departments, "none")
Note: To change the value that displays if the ri!departmentId doesn't match any ri!department.id values, modify the "none" text value as desired.
| Solve the following leet code problem |
Query Recipes.
This provides a set of recipes designed to show how you can use the a!queryRecordType(), a!queryRecordByIdentifier(), and a!queryEntity() functions to retrieve, aggregate, filter, and sort data.
Recipes querying records
| SetupCopy link to clipboard
To work with a common set of data, we will use the Appian Retail application, available for free in Appian Community Edition. To follow along with this pattern, log on to Appian Community and request the latest Appian Community Edition site.
The sample expressions provided in each recipe can be copied into an expression rule and tested as written. You can modify these examples as you experiment further with the concepts and techniques explained in the recipe.
Return all record fields for a single recordCopy link to clipboard
Goal: Access the data for all fields on a record.
When you query a record type using the a!queryRecordByIdentifier() function, the result includes record fields and any custom record fields defined in the record type.
Expression
In this example, we'll look up all Customer information for the person with the CustomerID of 29484. Note that the fields keyword is not included in the function, so all fields are returned by default. To have the expression only return the queried data, add .data to the end of the a!queryRecordType() function.
a!queryRecordByIdentifier(
recordType: 'recordType!Customer',
identifier: 29484,
)
Expected result
The query returns the following data:
[Customer CustomerID=29484, personId=291, storeId=292, territoryId=5, accountNumber=0, salesByCustomer=1118051, productDistinctCount=1098, latestOrderDate=4/30/2021 12:00 AM GMT+00:00, uniqueNumberOfProducts=45, totalNumberOfProducts=1098, sumOfSales=1118051]
Return one record field from a single recordCopy link to clipboard
Goal: Access the data in a single field on a record.
Expression
a!queryRecordByIdentifier(
recordType: 'recordType!Order',
fields: 'recordType!Order.fields.dueDate',
identifier: 43659,
)['recordType!Order.fields.dueDate']
Expected result
The query returns the following data: 6/12/2019 12:00 AM GMT+00:00
Return all base record data and selected related record dataCopy link to clipboard
Goal: Access the data for all base record fields and specific related record fields.
If you only a related record field reference in the fields parameter, the query will return all fields from the base record type and the selected related record fields.
Expression
In this example, we'll retrieve all information about the customer, as well as the amounts of their fifteen most recent orders.
a!queryRecordByIdentifier(
recordType: 'recordType!Customer',
identifier: 29484,
fields: {
'recordType!Customer.relationships.order.fields.totalDue',
},
relatedRecordData: a!relatedRecordData(
relationship: 'recordType!Customer.relationships.order',
)
)
Expected result
The query returns the following data:
[Customer CustomerID=29484, order=[Order orderId=44132, totalDue=4560.286]; [Order orderId=45579, totalDue=4594.066]; [Order orderId=46389, totalDue=1439.148]; [Order orderId=47454, totalDue=30881.77]; [Order orderId=48395, totalDue=36669.05]; [Order orderId=49495, totalDue=27280.97]; [Order orderId=50756, totalDue=42379.62]; [Order orderId=144132, totalDue=4560.286]; [Order orderId=145579, totalDue=4594.066]; [Order orderId=146389, totalDue=1439.148]; [Order orderId=147454, totalDue=30881.77]; [Order orderId=148395, totalDue=36669.05]; [Order orderId=149495, totalDue=27280.97]; [Order orderId=150756, totalDue=42379.62]; [Order orderId=244132, totalDue=4560.286], personId=291, storeId=292, territoryId=5, accountNumber=0, salesByCustomer=1118051, productDistinctCount=1098]
Return the distinct values for a fieldCopy link to clipboard
Goal: Use an aggregation to get the unique values for a record field.
When adding a selection component to an interface, you may want to set the values for a field as the choiceLabels and choiceValues. For example, an Appian Retail customer may want to filter products by color. This could be presented as a checkbox component with the available color options.
Filter product example with distinct values
To get the list of colors, you need to query the Product record type and return all of the values used in the color field. In the fields parameter, create a grouping on the color field. To get the list of colors, use dot notation to access the .data.color values.
Expression
a!queryRecordType(
recordType: 'recordType!Product',
fields: a!aggregationFields(
a!grouping(field: 'recordType!Product.fields.color', alias: "color")
),
filters: a!queryFilter(
field: 'recordType!Product.fields.color',
operator: "not null"
),
pagingInfo: a!pagingInfo(startIndex: 1, batchSize: 100)
).data.color
Expected result
The query will return the following data:
Black; Blue; Grey; Multi; Red; Silver; Silver/Black; White; Yellow
Tip: Instead of building a query, you can use a record type to configure the choices for the checkbox and other selection components. See Checkbox Component for details about this alternative way to set up user selections.
Aggregate data from a fieldCopy link to clipboard
Goal: Group and measure data based on the values of a selected field.
An aggregation groups data based on the values of a field and optionally measures those grouped sets. Aggregations are set in the fields parameter with a!aggregationFields().
Imagine you are in charge of inventory for a clothing store. You may want to know how many products of each size you have, as well as whether you offer colorful options across the range of sizes. In this example, we group product records by their size, count the number of products in each group, and filter out any black or white products.
Expression:
a!queryRecordType(
recordType: 'recordType!Product',
fields: a!aggregationFields(
groupings: a!grouping(
field: 'recordType!Product.fields.size',
alias: "size"
),
measures: a!measure(
field: 'recordType!Product.fields.size',
function: "COUNT",
alias: "count",
filters: a!queryFilter(
field: 'recordType!Product.fields.color',
operator: "not in",
value: {"Black", "White"}
)
)
),
filters: a!queryFilter(
field: 'recordType!Product.fields.size',
operator: "not null"
),
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: 100
)
).data
Expected result
The query will return the following data:
[size:38,count:7]; [size:40,count:7]; [size:42,count:10]; [size:44,count:18]; [size:46,count:9]; [size:48,count:14]; [size:50,count:9]; [size:52,count:9]; [size:54,count:9]; [size:56,count:2]; [size:58,count:10]; [size:60,count:9]; [size:62,count:8]; [size:70,count:1]; [size:L,count:6]; [size:M,count:6]; [size:S,count:4]; [size:XL,count:2]
Aggregate data using date or timeCopy link to clipboard
Goal: Perform a time-based aggregation on all values of a field.
Aggregations that group data based on date or time information use the interval field in a!grouping() to specify how data is grouped. In this example, we count the number of products made available for sale in a given year.
Expression
a!queryRecordType(
recordType: 'recordType!Product',
fields: a!aggregationFields(
groupings: a!grouping(
field: 'recordType!Product.fields.sellStartDate',
alias: "yearAdded",
interval: "YEAR"
),
measures: a!measure(
field: 'recordType!Product.fields.productId',
function: "COUNT",
alias: "numberOfProducts"
)
),
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: 100
)
).data
Expected result
The query will return the following data:
[yearAdded:2008,numberOfProducts:211]; [yearAdded:2011,numberOfProducts:72]; [yearAdded:2012,numberOfProducts:85]; [yearAdded:2013,numberOfProducts:136]
Filter out data with null valuesCopy link to clipboard
Goal: Check for fields with null values and only return records with complete data.
For situations where you only want to return complete records (i.e., records that are not missing values), add a filter that excludes records with a null value for a specific field.
For example, an Appian Retail online order is not considered done until the customer's credit card is charged and the order is shipped. You can filter out in-progress or otherwise incomplete orders by checking if the record type's shipDate and creditCardApprovalCode fields are null.
Tip: You can also exclude records that do not have any related records by filtering by a relationship reference. Learn how.
Expression
There are two ways to build this expression depending on the level of detail required for your query. First, you could use a list of a!queryFilter to filter records where both fields are null (the AND operator is used to evaluate lists of filter functions).
a!queryRecordType(
recordType: 'recordType!Order',
filters: {
a!queryFilter(
field: 'recordType!Order.fields.shipDate',
operator: "not null"
),
a!queryFilter(
field: 'recordType!Order.fields.creditCardApprovalCode',
operator: "not null"
)
},
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: 10
)
).data
A more refined query uses an a!queryLogicalExpression() with the OR operator to filter out records with either or both of the null fields. This creates a more accurate list of in-progress orders since an order could be charged but not shipped.
a!queryRecordType(
recordType: 'recordType!Order',
filters: a!queryLogicalExpression(
operator: "OR",
filters: {
a!queryFilter(
field: 'recordType!Order.fields.shipDate',
operator: "not null"
),
a!queryFilter(
field: 'recordType!Order.fields.creditCardApprovalCode',
operator: "not null"
)
}
),
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: 10
)
).data
Expected result
The query will return Orders with the following orderIds:
43659; 43660; 43661; 43662; 43663; 43664; 43665; 43666; 43667; 43668
Return data between two datesCopy link to clipboard
Goal: Use a date range to filter the query results.
There are many cases where a user of your application will want to know about time-bound records. For example, an Appian Retail user may want to see the orders created over a weekend so they can start filling those orders at the start of the next week. To get this information in your query, you add a filter that defines the time range in question so only those records are returned.
Once you've built the basic a!queryRecordType() function and defined the recordType, fields, and pagingInfo, you can add the filters needed to refine the results. In the a!queryFilter() function, add the required parameters with the following values:
field - the record type being filtered.
operator - the string "between". This means that both the lower and upper values are included as matches when the query is run.
value - an a!todatetime() function whose arguments are the start and end dates of the range.
Filter by date range
The between operator takes an inclusive range of values.
Filter with between operator
Expression
Tip: Record fields containing date or time information can be configured using one of three data types: Date, Date and Time, or Time. This example filters on a Date and Time field, but the concepts apply to any of the three types.
a!queryRecordType(
recordType: 'recordType!Order',
fields: {
'recordType!Order.fields.orderNumber',
'recordType!Order.fields.totalDue',
},
filters: a!queryFilter(
field: 'recordType!Order.fields.orderDate',
operator: "between",
value: todatetime({"06/08/2019", "06/09/2019"})
),
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: 10
)
).data
Expected result
The query will return Orders with the following orderIds:
43728; 43729; 43730; 43731; 43732; 43733; 43734; 43735; 43736; 143728
Query data not matching a list of valuesCopy link to clipboard
Goal: Create a filter that excludes records with a field containing one of a specific set of values.
For example, the Appian Retail Company ships to several countries (the US, Canada, Australia, Germany, France, and Great Britain), and the head of sales wants to keep track of volume in each. The Country record type has a countryRegionCode field we can use to filter orders by location.
To retrieve the 100 most recent sales in North America, we need to exclude countries in the two other regions, Europe and the Pacific. This can be done by using the not in operator with a list of values to exclude from the results.
The not in operator is a simpler way to write multiple <> filters. You could filter out the countries individually as in the following example:
Multiple not equal statements
To make the expression rule easier to read and understand, replace the list of filters with a single a!queryFilter() that uses the not in operator.
Not if filter
Expression
a!queryRecordType(
recordType: 'recordType!Order',
fields: {
},
filters: a!queryFilter(
field: 'recordType!Order.relationships.salesRegion.fields.countryRegionCode',
operator: "not in",
value: {"FR", "DE", "AU", "GB"}
),
pagingInfo: a!pagingInfo(startIndex: 1, batchSize: 10)
).data
Expected result
The query will return Orders with the following orderIds:
43660; 43661; 43662; 43663; 43664; 43665; 43666; 43667; 43668; 43669
Search using multiple fieldsCopy link to clipboard
Goal: Retrieve records based on user-provided search criteria. Criteria that are left blank by the user should not be included in the query.
Some queries take user input and use those values to return the data needed by the user at that moment. In this example, we need to create three rule inputs:
firstName, a Text input
lastName, a Text input
storeId, a Number (Integer) input
These rule inputs are used as the value in our expression's filters. We also add the ignoreFiltersWithEmptyValues parameter so users are able to enter one, two, or three inputs and still get a list of results.
Expression
a!queryRecordType(
recordType: 'recordType!Customer',
fields: {
'recordType!Customer.relationships.person.fields.fullName',
'recordType!Customer.fields.latestOrderDate',
'recordType!Customer.fields.storeId',
'recordType!Customer.fields.sumOfSales'
},
filters: a!queryLogicalExpression(
operator: "OR",
filters: {
a!queryFilter(
field: 'recordType!Customer.relationships.person.fields.firstName',
operator: "includes",
value: ri!firstName
),
a!queryFilter(
field: 'recordType!Customer.relationships.person.fields.lastName',
operator: "includes",
value: ri!lastName
),
a!queryFilter(
field: 'recordType!Customer.fields.storeId',
operator: "=",
value: ri!storeId
),
},
ignoreFiltersWithEmptyValues: true
),
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: 50
)
).data
Sort on multiple fields in a selectionCopy link to clipboard
Goal: Sort on multiple fields when performing a selection query.
Selections return the data specified in the fields of a!queryRecordType. Organizing these query results with sorting is a powerful way to present usable data to users without requiring them to interact with a grid or chart to make their own sorting choices.
Imagine the Appian Retail sales team is interested in seeing the customers that purchase the widest variety of products and who spends the most overall. This example shows how you can select some useful fields and sort them based on user needs.
Expression
a!queryRecordType(
recordType: 'recordType!Customer',
fields: {
'recordType!Customer.fields.CustomerID',
'recordType!Customer.fields.latestOrderDate',
'recordType!Customer.fields.uniqueNumberOfProducts',
'recordType!Customer.fields.sumOfSales',
'recordType!Customer.relationships.person.fields.fullName'
},
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: 10,
sort: {
a!sortInfo(
field: 'recordType!Customer.fields.uniqueNumberOfProducts'
),
a!sortInfo(
field: 'recordType!Customer.fields.sumOfSales'
)
}
)
).data
Expected result
The query will return Customers with the following CustomerIds:
29722; 29950; 30107; 30048; 29712; 29734; 29702; 29744; 29559; 29996
Sort on multiple fields in an aggregationCopy link to clipboard
Goal: Sort on multiple aggregated fields.
The results of an aggregation can be sorted to present an organized view of the groupings or measures created from the queried record.
Appian Retail's sales team wants to know which territories had the most online orders. To get this information, you'll create a query that gets the total number of online orders for each sales region. To quickly see the top performing territories, you'll sort the results by the online order count in descending order.
Expression
a!queryRecordType(
recordType: 'recordType!Order',
filters: a!queryFilter(
field: 'recordType!Order.relationships.salesRegion.fields.countryRegionCode',
operator: "=",
value: "US"
),
fields: a!aggregationFields(
groupings: {
a!grouping(
field: 'recordType!Order.relationships.salesRegion.fields.name',
alias: "region"
)
},
measures: a!measure(
field: 'recordType!Order.fields.onlineOrderFlag',
function: "COUNT",
filters: a!queryFilter(
field: 'recordType!Order.fields.onlineOrderFlag',
operator: "=",
value: 1
),
alias: "onlineOrderCount"
)
),
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: 10,
sort: {
a!sortInfo(field: "onlineOrderCount"),
a!sortInfo(field: "region")
}
)
).data
Expected result
The query will return the following list of data:
[region:Southwest,onlineOrderCount:44546]; [region:Northwest,onlineOrderCount:32956]; [region:Southeast,onlineOrderCount:138]; [region:Northeast,onlineOrderCount:80]; [region:Central,onlineOrderCount:72]
Filter by one-to-many dataCopy link to clipboard
Goal: Return records that have at least one related record that meets the filter criteria.
When you filter by a related record field from a one-to-many relationship (that is, the "many" side of the relationship), the filter will return all records from the base record type (the "one" side of the relationship) that have at least one related record that meets the filter condition. In this example, the query returns the customers who made a purchase greater than $100,000 from a specific salesperson (in this case, with the ID 275).
If a query with related record types is not returning what you expect, it may help to consider what will not be returned based on the filters. In our example, if a customer made a purchase from a different salesperson or if their purchase was less than the dollar amount specified, that customer will not appear in the results. Remember that filters are applied with the AND operator, so the record type must meet all filter conditions to appear in the results.
Expression
a!queryRecordType(
recordType: 'recordType!Customer',
fields: a!aggregationFields(
groupings: a!grouping(
field: 'recordType!Customer.relationships.person.fields.fullName',
alias: "customerName"
)
),
filters: {
a!queryFilter(
field: 'recordType!Customer.relationships.order.fields.salesPersonId',
operator: "=",
value: 275
),
a!queryFilter(
field: 'recordType!Customer.relationships.order.fields.totalDue',
operator: ">",
value: 100000
)
},
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: 100
)
).data
Expected result
The query will return the following list of names:
Barbara J. Calone; Dave P. Browning; Elizabeth J. Sullivan; Helen J. Dennis; Janet M. Gates; Kirk DeGrasse; Robert R. Vessa; Stacey M. Cereghino; Valerie M. Hendricks
Recipes querying entitiesCopy link to clipboard
The recipes in this section show how to perform common data lookups using the a!queryEntity() function.
The recipes can be worked on in no particular order. However, make sure to read the Setup section before you begin.
Tip: You can experiment with all of these query recipes in the query editor. After you copy and paste a query recipe into an empty expression rule, Ctrl+Click (Cmd+Click on Mac) the a!queryEntity() function to open it in the query editor.
Note that if you change the data store entity in the query editor, all of query configurations will be lost and you will be starting over with a new query.
SetupCopy link to clipboard
To copy and paste these recipes, you’ll need the Employee data store entity (DSE) and a constant pointing to this DSE.
To create these two objects, complete the Use the Write to Data Store Entity Smart Service Function on an Interface pattern.
Retrieve the data for all fieldsCopy link to clipboard
Goal: Retrieve the data for all fields of an entity.
When you execute a query, it pulls back the data for all of the fields of the entity. This recipe replicates that functionality using a!queryEntity().
To retrieve all fields of the entity being queried, omit both the selection and aggregation parameters from a!query(). When using this approach, you should cast the result to the appropriate type to ensure that it works smoothly in process models and rules that use it. This is because a!queryEntity() always returns a DataSubset that includes a dictionary.
In this example, we retrieve the employee whose id is 8.
Expression
cast(
type!Employee,
a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
logicalexpression: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: "id",
operator: "=",
value: 8
)
}
),
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: 1
)
)
).data
)
Tip: In this example, we are nesting a!queryFilter() inside a!queryLogicalExpression(), which makes it possible to combine multiple filters. This isn't required since we only have one filter, but it makes it easier for you to add more filters or edit it in the query editor.
This example should return the following fields: [id=8, firstName=Jessica, lastName=Peterson, department=Finance, title=Analyst, phoneNumber=555-987-6543, startDate=2004-11-01]. This value will be of type Employee.
If you expect your query to return multiple results, you should instead cast to a list of CDT. In this example, we will retrieve any employees whose first name begins with "A".
Expression
cast(
typeof({type!Employee()}),
a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
logicalexpression: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: "firstName",
operator: "starts with",
value: "A"
)
}
),
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: 5
)
)
).data
)
Tip: In this example, we are nesting a!queryFilter() inside a!queryLogicalExpression(), which makes it possible to combine multiple filters. This isn't required since we only have one filter, but it makes it easier for you to add more filters and edit it in the query editor.
This example should return the value [id=17, firstName=Andrew, lastName=Nelson, department=Professional Services, title=Consultant, phoneNumber=555-789-4560, startDate=3/15/2005]; [id=4, firstName=Angela, lastName=Cooper, department=Sales, title=Manager, phoneNumber=555-123-4567, startDate=10/15/2005].
Retrieve the data for a single fieldCopy link to clipboard
Goal: Retrieve the data for a single field of an entity rather than all of the fields.
When you execute a query, it returns the data for all of the fields of the entity. The more data you retrieve from the database, the longer the query takes to run. A common way to restrict the amount of data returned by a query is to create several different data store entities that reference the same database table, each of which only contains some of the fields. Instead, using a!queryEntity() to select specific fields as shown below restricts the amount of returned data, is faster to develop, and has the advantage that the field or fields can be selected at run-time rather than design-time.
In this example we are going to retrieve the phone number, stored in the field phoneNumber, for the employee whose id is 8.
Expression
a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
selection: a!querySelection(
columns: {
a!queryColumn(
field: "phoneNumber"
)
}
),
logicalexpression: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: "id",
operator: "=",
value: 8
)
}
),
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: 1
)
)
).data.phoneNumber[1]
Tip: In this example, we are nesting a!queryFilter() inside a!queryLogicalExpression(), which makes it possible to combine multiple filters. This isn't required since we only have one filter, but it makes it easier for you to add more filters and edit it in the query editor.
This example should return the value 555-987-6543.
To retrieve data for more than one field, you can add more a!queryColumn()s to the columns array.
Get the distinct values of a fieldCopy link to clipboard
Goal: Retrieve the unique list of values in a given field.
It will almost always be significantly faster to have the data source do the uniqueness calculation before returning the data to Appian. This is especially true for large data sets. a!queryEntity() lets the data source perform the uniqueness calculation.
In this example, we are going to retrieve the list of departments that have employees using a!queryAggregation().
Expression
a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
aggregation: a!queryAggregation(
aggregationColumns: {
a!queryAggregationColumn(
field: "department",
isGrouping: true
)
}
),
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: -1,
sort: a!sortInfo(
field: "department",
ascending: true
)
)
)
).data.department
This example should return a list containing "Engineering", "Finance", "HR", "Professional Services", and "Sales". Note that even though there is more than one employee in many of these departments, each department is only listed once in the result.
Aggregating on a fieldCopy link to clipboard
Goal: Perform an aggregation or computation on all values of field.
In this example, we are going to count the number of employees in each department.
Expression
a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
aggregation: a!queryAggregation(
aggregationColumns: {
a!queryAggregationColumn(
field: "department",
isGrouping: true
),
a!queryAggregationColumn(
field: "department",
alias: "numberOfEmployees",
aggregationFunction: "COUNT"
)
}
),
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: -1,
sort: a!sortInfo(
field: "department",
ascending: true
)
)
)
)
This example should return one dictionary for each department where the keys in the dictionary are department and numberOfEmployees and the values match the following table.
department numberOfEmployees
Engineering 6
Finance 4
HR 2
Professional Services 4
Sales 4
Aggregating on year and monthCopy link to clipboard
Goal: Perform a time aggregation on all values of field.
In this example, we are going to count the number of employees that started on a specific month and year.
Expression
a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
aggregation: a!queryAggregation(
aggregationColumns: {
a!queryAggregationColumn(
field: "startDate",
alias: "year_startDate",
isGrouping: true,
groupingFunction: "YEAR"
),
a!queryAggregationColumn(
field: "startDate",
alias: "month_startDate",
isGrouping: true,
groupingFunction: "MONTH"
),
a!queryAggregationColumn(
field: "id",
alias: "idCount",
aggregationFunction:"COUNT"
)
}
),
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: -1
)
),
fetchTotalCount: true
)
This example should return a list of dictionaries for each distinct year and month combination with the count of the employees that have a start date in that month and year.
Querying on multiple conditionsCopy link to clipboard
Goal: Retrieve data that meets at least one of two different conditions.
The only way to find entries that match at least one of two conditions is to run two different queries and combine the results. Using a logicalExpression inside the Query object, we can execute the same logic in a single call to the data source, resulting in faster performance.
In this example, we are going to retrieve the names of employees who either started within the last 2 years or have the word "Associate" in their title.
Expression
a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
selection: a!querySelection(
columns: {
a!queryColumn(field: "firstName"),
a!queryColumn(field: "lastName")
}
),
logicalExpression: a!queryLogicalExpression(
operator: "OR",
filters: {
a!queryFilter(
field: "startDate",
operator: ">",
value: date(year(now())-2, month(now()), day(now()))
),
a!queryFilter(
field: "title",
operator: "includes",
value: "Associate"
)
},
ignoreFiltersWithEmptyValues: true
),
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: -1
)
)
)
The exact list of results that is returned will to depend on when you run the example:
Before Jan 2, 2015: John Smith will be the only employee returned because of the start date condition.
On or after Jan 2, 2015: no employees will be included in the results because of their start date.
Elizabeth Ward, Laura Bryant and Stephen Edwards will be included in the result regardless of when you run the example as they are included because their title contains the word Associate.
Querying on nested conditionsCopy link to clipboard
Goal: Retrieve data based on complex or nested conditions.
In this example, we are going to retrieve the names of the senior members of the Engineering department where "senior" is defined as either having a title of "Director" or having a start date of more than 10 years ago.
Expression
a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
selection: a!querySelection(
columns: {
a!queryColumn(field: "firstName"),
a!queryColumn(field: "lastName")
}
),
logicalExpression: a!queryLogicalExpression(
operator: "AND",
filters: a!queryFilter(
field: "department",
operator: "=",
value: "Engineering"
),
logicalExpressions: {
a!queryLogicalExpression(
operator: "OR",
filters: {
a!queryFilter(
field: "startDate",
operator: "<",
value: date(year(now())-10, month(now()), day(now()))
),
a!queryFilter(
field: "title",
operator: "includes",
value: "Director"
)
},
ignoreFiltersWithEmptyValues: true
)
},
ignoreFiltersWithEmptyValues: true
),
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: -1
)
)
)
This example should return John Smith and Mary Reed. John Smith is included because he is a Director and Mary Reed is included because her start date is more than 10 years ago. Both of them are in the Engineering department.
Filtering for null valuesCopy link to clipboard
Goal: Find entries where a given field is null.
In this example, we are going to find all employees who are missing either firstName, lastName, department, title, phoneNumber, or startDate.
Expression
a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
selection: a!querySelection(
columns: {
a!queryColumn(field: "firstName"),
a!queryColumn(field: "lastName")
}
),
logicalExpression: a!queryLogicalExpression(
operator: "OR",
filters: {
a!queryFilter(field: "firstName", operator: "is null"),
a!queryFilter(field: "lastName", operator: "is null"),
a!queryFilter(field: "department", operator: "is null"),
a!queryFilter(field: "title", operator: "is null"),
a!queryFilter(field: "phoneNumber", operator: "is null"),
a!queryFilter(field: "startDate", operator: "is null")
},
ignoreFiltersWithEmptyValues: true
),
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: -1
)
)
)
This example does not return any results because none of the employees in our sample data are missing any of the specified fields.
Filtering for null or empty valuesCopy link to clipboard
Goal: Find entries where a given field is null or empty.
In this example, we are going to find all employees who have a missing or empty value for firstName.
Expression
a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
selection: a!querySelection(
columns: {
a!queryColumn(field: "firstName")
}
),
logicalExpression: a!queryLogicalExpression(
operator: "OR",
filters: {
a!queryFilter(field: "firstName", operator: "is null"),
a!queryFilter(field: "firstName", operator: "in", value: {""})
}
),
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: -1
)
)
)
This example does not return any results because none of the employees in our sample data have a null or empty value for firstName.
Searching on multiple fieldsCopy link to clipboard
Goal: Retrieve data based on search criteria specified by end users e.g. when looking for employees by last name, title, or department. Search criteria that are left blank are not included in the query.
For an example on filtering for null values, see the recipe: Filtering for Null Values.
Expression
First, create an expression rule ucSearchEmployees with the following rule inputs:
lastName (Text)
title (Text)
department (Text)
pagingInfo (Any Type)
Enter the following definition for the rule:
a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
logicalExpression: a!queryLogicalExpression(
operator: "AND",
filters: {
a!queryFilter(
field: "lastName",
operator: "includes",
value: ri!lastName
),
a!queryFilter(
field: "title",
operator: "includes",
value: ri!title
),
a!queryFilter(
field: "department",
operator: "=",
value: ri!department
)
},
ignoreFiltersWithEmptyValues: true
),
pagingInfo: ri!pagingInfo
),
/* The fetchTotalCount parameter should be set to true when the totalCount returned */
/* in the datasubset is required. This example assumes the result will be used in a */
/* grid where totalCount is required for paging. */
fetchTotalCount: true
)
Test it out
Unlike the recipes above, this one is a rule with inputs. Rather than just getting a single result, let's take a look at several different results for different rule inputs.
First, let's try not specifying any fields except for pagingInfo:
rule!ucSearchEmployees(
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: 30,
sort: a!sortInfo(
field: "lastName",
ascending: true
)
)
)
This query will return the first 30 employees, sorted A-Z by last name.
Next, let's try specifying a department in addition to the pagingInfo:
rule!ucSearchEmployees(
department: "Sales",
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: 30,
sort: a!sortInfo(
field: "lastName",
ascending: true
)
)
)
This expression will return a list of employees in the Sales department, sorted alphabetically by last name. In this example, that is: Angela Cooper, Laura Bryant, Stephen Edwards, and Elizabeth Ward.
searching on multiple fields query recipe
We can also combine multiple filters together. Let's try searching by both last name and department:
rule!ucSearchEmployees(
lastName: "Bryant",
department: "Sales",
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: 30,
sort: a!sortInfo(
field: "lastName",
ascending: true
)
)
)
This expression will return a list of employees that are in the Sales department and have a last name that contains Bryant. In this case that's a single employee: Laura Bryant.
To see an example of integrating this query into an interface, see the Interface Recipe: Searching on Multiple Fields
Sorting on multiple fields without using aggregationsCopy link to clipboard
Goal: Demonstrate how to sort on multiple columns when there is no field aggregation.
Using the a!querySelection function allows you to define a set of column selection configurations. When using this function, you can sort on any of the fields in the data entity, whether the fields are included in the selection or not.
In this example we are going to retrieve the department, first name, and last name of employees and sort them in ascending order. The data will be sorted first by department, and then by title, even though title is not part of the query selection.
Expression
a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
selection: a!querySelection(columns: {
a!queryColumn(field: "department"),
a!queryColumn(field: "firstName"),
a!queryColumn(field: "lastName"),
}),
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: 20,
sort: {
a!sortInfo(
field: "department",
ascending: true
),
a!sortInfo(
field: "title",
ascending: true
)
}
)
),
/* The fetchTotalCount parameter should be set to true when the totalCount returned */
/* in the datasubset is required. This example assumes the result will be used in a */
/* grid where totalCount is required for paging. */
fetchTotalCount: true
)
Sorting on multiple fields when aggregation is appliedCopy link to clipboard
Goal: Demonstrate how to sort on multiple fields when aggregation is performed in one or more fields.
In this example, we are going to retrieve the count of employees by department and title. We are also going to sort the results in ascending order; first by department, then by title.
Expression
a!queryEntity(
entity: cons!EMPLOYEE_ENTITY,
query: a!query(
aggregation: a!queryAggregation(aggregationColumns: {
a!queryAggregationColumn(field: "department", isGrouping: true),
a!queryAggregationColumn(field: "title", isGrouping: true),
a!queryAggregationColumn(field: "lastName", aggregationFunction: "COUNT"),
}),
pagingInfo: a!pagingInfo(
startIndex: 1,
batchSize: 20,
sort: {
a!sortInfo(
field: "department",
ascending: true
),
a!sortInfo(
field: "title",
ascending: true
)
}
)
)
)
| Solve the following leet code problem |
all appian functions
| Name | Description | Syntax | Example | Result | Compatibility |
---|---|---|---|---|---|
Name
Description
Syntax
Example
Result
Compatibility
---|---|---|---|---|---|
ArrayUsed within your expressions to manipulate, insert, and/or select values from arrays. |
a!flatten() | Converts an array that contains other arrays into an array of single items.
a!flatten([array])
| a!flatten(merge({1,2},{11, 12}))
{1, 11, 2, 12}
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!update() | Inserts new values or replaces existing values at the specified index or field name and returns the resulting updated data.
a!update([data], [index], [value])
| a!update(a!map(a: 1, b: 2), "a", 5)
a!map(a: 5, b: 2)
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
append() | Appends a value or values to the given array, and returns the resulting array.
append([array], [value])
| append({10, 20, 30}, 99)
{10, 20, 30, 99}
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
index() | Returns the data[index] if it is valid or else returns the default value.
index([data], [index], [default])
| index({10, 20, 30}, 2, 1)
20
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
insert() | Inserts a value into the given array and returns the resulting array.
insert([array], [value], [index])
| insert({10, 20, 30, 40}, 99, 1)
{99, 10, 20, 30, 40}
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
joinarray() | Concatenates the elements of an array together into one string and inserts a string separator between each element.
joinarray([array], [separator])
| joinarray({1, 2, 3, 4}, "|")
1|2|3|4
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
ldrop() | Drops a given number of values from the left side of an array and returns the resulting array.
ldrop([array], [number])
| ldrop({10, 20, 30}, 1)
{20, 30}
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
length() | This function returns the number of elements in an array.
length([array])
| length({10, 20, 30})
3
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
rdrop() | Drops a given number of values from the right side of an array, and returns the resulting array.
rdrop([array], [number])
| rdrop({10, 20, 30}, 1)
{10, 20}
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
remove() | Removes the value at a given index from an array, and returns the resulting array.
remove([array], [index])
| remove({10, 20, 30}, 2)
{10, 30}
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
reverse() | Returns an array in reverse order.
reverse([array])
| reverse({10, 20, 30})
{30, 20, 10}
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
updatearray()
Replaced by a!update()
|
Inserts new values or modifies existing values at the specified index of a given array, and returns the resulting array.
updatearray([array], [index], [value])
| updatearray({10, 20, 30}, 2, 99)
{10, 99, 30}
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
where() | Returns the indexes where the values in the input array are true.
where([booleanArray], [default])
| where({true, false, true})
{1, 3}
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
wherecontains() | Receives one or more values and returns an array of indexes that indicate the position of the values within the array.
wherecontains([values], [array])
| wherecontains(20, {10, 20, 30})
{2}
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
SetUsed within your expressions to manipulate values from arrays. |
contains() | Checks whether an array contains the value.
contains([array], [value])
| contains({10, 20, 30}, 20)
true
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
difference() | Returns the values in array1 and not in array2.
difference([array1], [array2])
| difference({10, 20, 30, 40}, {30, 40})
{10, 20}
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
intersection() | Returns only those elements that appear in all of the given arrays.
intersection([array1], [array2])
| intersection({10, 20, 30}, {20, 30, 40})
{20, 30}
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
symmetricdifference() | Returns the values from two integer arrays that are not in both arrays.
symmetricdifference([array1], [array2])
| symmetricdifference({10, 20, 30}, {20, 30, 40})
{10, 40}
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
union() | Returns all unique elements from the given arrays.
union([array1], [array2])
| union({10, 20, 30}, {20, 30, 40})
{10, 20, 30, 40}
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
Base ConversionUsed within expressions to convert values into other base number formats. |
bin2dec() | Converts a Binary number as text to a Decimal number.
bin2dec([value])
| bin2dec(10000)
16
|
~portal~om+crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
bin2hex() | Converts a Binary number as text to a Hex number as text.
bin2hex([value], [place])
| bin2hex(1100100)
64
|
~portal~om+crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
bin2oct() | Converts a Binary number as text to an Octal number as text.
bin2oct([value], [place])
| bin2oct(1100100)
144
|
~portal~om+crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
dec2bin() | Converts a Decimal number to a Binary number as text.
dec2bin([value], [place])
| dec2bin(16)
10000
|
~portal~om+crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
dec2hex() | Converts a Decimal number to a Hex number as text.
dec2hex([value], [place])
| dec2hex(16)
10
|
~portal~om+crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
dec2oct() | Converts a Decimal number to an Octal number as text.
dec2oct([value], [place])
| dec2oct(16)
20
|
~portal~om+crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
hex2bin() | Converts a Hex number as text to a Binary number as text.
hex2bin([value], [place])
| hex2bin(64)
1100100
|
~portal~om+crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
hex2dec() | Converts a Hex number as text to a Decimal number.
hex2dec([value])
| hex2dec(10)
16
|
~portal~om+crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
hex2oct() | Converts a Hex number as text to an Octal number as text.
hex2oct([value], [place])
| hex2oct(64)
144
|
~portal~om+crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
oct2bin() | Converts an Octal number as text to a Binary number as text.
oct2bin([value], [place])
| oct2bin(144)
1100100
|
~portal~om+crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
oct2dec() | Converts an Octal number as text to a Decimal number.
oct2dec([value])
| oct2dec(20)
16
|
~portal~om+crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
oct2hex() | Converts an Octal number as text to a Hex number as text.
oct2hex([value], [place])
| oct2hex(144)
64
|
~portal~om+crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
ConnectorUsed to integrate Appian with popular enterprise software solutions. |
reCAPTCHAThe reCAPTCHA connector allows you to connect to Google reCAPTCHA services. |
a!verifyRecaptcha() | Allows you to verify the reCAPTCHA connection was successful and access reCAPTCHA scores to help protect your Portal against potentially malicious activity.
a!verifyRecaptcha([onSuccess], [onError])
| Click on the function name for examples. |
+portal-om-crf-rcrf-pr-pe
Compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
SAPThe SAP connector uses the SAP JCo 3.0 middleware library to connect to a SAP ERP systems release 3.1H or later. |
a!sapInvokeWithCommit() | The Invoke SAP BAPI Smart Service allows designers to safely invoke BAPIs with side effects in process.
a!sapInvokeWithCommit([scsExternalSystemKey], [usePerUserCredentials], [hostname], [clientNumber], [systemNumber], [bapi], [importParameters], [tableParameters], [connectionProperties], [commitTransaction], [onSuccess], [onError])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
Web Service Helper |
a!httpAuthenticationBasic() | Creates an object that contains the information required to perform HTTP Basic authentication.
a!httpAuthenticationBasic([username], [password], [preemptive])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!httpFormPart() | Creates an HTTP form part which can be passed in an integration’s multipart request body.
a!httpFormPart([name], [contentType], [value])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!httpHeader() | Creates an HTTP header object which can be passed to an HTTP function.
a!httpHeader([name], [value])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!httpQueryParameter() | Creates an HTTP query parameter object which can be passed to an HTTP function.
a!httpQueryParameter([name], [value])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!scsField() | Creates an object which contains the information required to access data in the Secure Credentials Store.
a!scsField([externalSystemKey], [fieldKey], [usePerUser])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!wsConfig() | Constructs the config parameter to the
a!wsConfig([wsdlUrl], [service], [port], [operation], [wsdlCredentials], [endpointcredentials], [extensions])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!wsHttpCredentials() | Constructs a WsHttpCredentials object for use with
a!wsHttpCredentials([username], [password], [domain])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!wsHttpHeaderField() | Constructs a WsHttpHeaderField object for use with
a!wsHttpHeaderField([name], [name])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!wsUsernameToken() | Constructs a WsUsernameToken object for use with
a!wsUsernameToken([username], [password])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!wsUsernameTokenScs() | Constructs a WsUsernameTokenScs object for use with
a!wsUsernameTokenScs([systemKey], [usePerUser])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
ConversionUsed to cast data from one data type into another. |
displayvalue() | Tries to match a value in a given array with a value at the same index in a replacement array and returns either the value at the same index or a default value if the value is not found.
displayvalue([value], [inArray], [replacement], [default])
| displayvalue( 1, {0, 1, 2}, {"Low", "Medium", "High"}, "Unknown" )
Medium
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
externalize() | Converts the given value to a string representation so that it can be saved externally.
externalize([value])
| externalize(todocument(1)) |
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
internalize() | Converts the given externalized string representation of a value to the original value.
internalize([externalizedText], [default])
| internalize(externalize(todocument(1)))
[Document:1]
|
+portal+om-crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
toboolean() | Converts a value to Boolean.
toboolean([value])
| toboolean(0)
false
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
tocommunity() | Converts a value to Community.
tocommunity([value])
| tocommunity(1)
[Community:1]
|
+portal+om-crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
todate() | Converts a value to Date with Timezone.
todate([value])
| todate(0)
1/1/2035
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
todatetime() | Converts a value to Date and Time with Timezone.
todatetime([value])
| todatetime(date(2005, 12, 13))
12/13/05 12:00 AM GMT
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
todecimal() | Converts a value to Decimal (double-precision floating-point number).
todecimal([value])
| todecimal("3.6")
3.6
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
todocument() | Converts a value to Document.
todocument([value])
| todocument(1)
[Document:1]
|
+portal+om-crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
toemailaddress() | Converts a value to email address.
toemailaddress([value])
| toemailaddress("john.doe"&char(64)&"company.com")
john.doe@company.com
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
toemailrecipient() | Converts a value to email recipient.
toemailrecipient([value])
| toemailrecipient(togroup(1))
[Group:1]
|
+portal+om-crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
tofolder() | Converts a value to Folder.
tofolder([value])
| tofolder({"1","2"})
[Folder:1], [Folder:2]
|
+portal+om-crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
tointeger() | Converts a value to Integer.
tointeger([value])
| tointeger("3")
3
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
tointervalds() | Converts a value to Interval (Day to Second).
tointervalds([value])
| tointervalds("11h 10m 30s")
111030::00:00:00.000
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
toknowledgecenter() | Converts a value to Knowledge Center.
toknowledgecenter([value])
| toknowledgecenter("2")
[Knowledge Center:2]
|
+portal+om-crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
tostring() | Converts a value to Text.
tostring([value])
| tostring(17)
"17"
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
totime() | Converts a value to Time.
totime([value])
| totime(datetime(2005, 12, 13, 12, 0, 0))
12:00 PM GMT
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
touniformstring() | Converts a value or list to text, preserving the original scalar or array structure.
touniformstring([value])
| touniformstring("John Doe 1060 West Addison Chicago", "IL")
{"John Doe 1060 West Addison Chicago", "IL"}
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
Custom FieldsUsed to create custom record fields that evaluate in real time. |
a!customFieldConcat() | Used to create a real-time custom record field, this function concatenates the specified values into a single value.
a!customFieldConcat([value])
| Click on the function name for examples. |
~portal-om-crf+rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Compatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!customFieldCondition() | Used in the whenTrue parameter of a!customFieldMatch(), this function allows you to create a condition.
a!customFieldCondition([field], [operator], [value])
| Click on the function name for examples. |
~portal-om-crf+rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Compatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!customFieldDateDiff() | Used to create a real-time custom record field, this function returns the difference between two dates as a Number (Integer). The difference can be returned in days, hours, minutes, or seconds. Returns null when the
a!customFieldDateDiff([startDate], [endDate], [interval])
| Click on the function name for examples. |
~portal-om-crf+rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Compatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!customFieldDefaultValue() | Used to create a real-time custom record field, this function returns a default value when the specified value is null or empty. All parameters must be of the same data type. When there are multiple default parameters, each parameter is evaluated in order and the first non-null or non-empty default will be returned.
a!customFieldDefaultValue([value], [default])
| Click on the function name for examples. |
~portal-om-crf+rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Compatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!customFieldDivide() | Used to create a real-time custom record field, this function returns the results of dividing two numbers. You can use record fields, related record fields, or literal values of type Number (Integer) or Number (Decimal) in your calculation.
a!customFieldDivide([numerator], [denominator])
| Click on the function name for examples. |
~portal-om-crf+rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Compatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!customFieldLogicalExpression() | Used in the whenTrue parameter of a!customFieldMatch(), this function allows you to group multiple logical conditions using the
a!customFieldLogicalExpression([operator], [conditions])
| Click on the function name for examples. |
~portal-om-crf+rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Compatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!customFieldMatch() | Used to create a real-time custom record field, this function evaluates the value parameter against multiple conditions and returns a value based on a match. If no match is found, the default parameter is returned.
a!customFieldMatch([value], [equals], [whenTrue], [then], [default])
| Click on the function name for examples. |
~portal-om-crf+rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Compatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!customFieldMultiply() | Used to create a real-time custom record field, this function returns the result of multiplying a series of values. You can multiply record fields, related record fields, or literal values of type Number (Integer) or Number (Decimal).
a!customFieldMultiply([value])
| Click on the function name for examples. |
~portal-om-crf+rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Compatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!customFieldSubtract() | Used to create a real-time custom record field, this function returns the difference between two numbers. You can subtract record fields, related record fields, or literal values of type Number (Integer) or Number (Decimal).
a!customFieldSubtract([value1], [value2])
| Click on the function name for examples. |
~portal-om-crf+rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Compatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!customFieldSum() | Used to create a real-time custom record field, this function returns a sum of values. You can calculate the sum of record fields, related record fields, or literal values of type Number (Integer) or Number (Decimal).
a!customFieldSum([value])
| Click on the function name for examples. |
~portal-om-crf+rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Compatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
Date and TimeUsed within an expressions for date, time, or date and time values. |
a!addDateTime() | Adds the specified increments of time to the startDateTime and returns a date and time value. You can select a process calendar to ensure the return value falls within the specified working days and time.
a!addDateTime([startDateTime], [years], [months], [days], [hours], [minutes], [seconds], [useProcessCalendar], [processCalendarName])
| a!addDateTime(startDateTime: datetime(2000,1,1,0,0,0), months: 1, days: 1, hours: 1, minutes: 1, seconds: 1)
2/2/2000 1:01 AM GMT+00:00
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!subtractDateTime() | Subtracts the specified increments of time from the startDateTime and returns a date and time value. You can select a process calendar to ensure the return value falls within the specified working days and time.
a!subtractDateTime([startDateTime], [years], [months], [days], [hours], [minutes], [seconds], [useProcessCalendar], [processCalendarName])
| a!subtractDateTime(startDateTime: datetime(2001, 1, 1, 0, 0, 0), months: 1, days: 1, hours: 1, minutes: 1, seconds: 1)
11/29/2000 10:58 PM GMT+00:00
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
calisworkday() | This returns whether or not the given Date and Time is a work day, according to the calendar defined for the system.
calisworkday([datetime], [calendar_name])
| calisworkday(datetime(2011, 12, 13, 12, 0, 0))
true
|
-portal-om+crf-rcrf+pr+pe
Incompatible
Portals
Incompatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
calisworktime() | This returns whether or not the given Date and Time is within working hours, according to the calendars defined for the system.
calisworktime([datetime], [calendar_name])
| calisworktime(datetime(2011, 12, 13, 12, 0, 0))
true
|
-portal-om+crf-rcrf+pr+pe
Incompatible
Portals
Incompatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
calworkdays() | This returns the actual number of work days between two Date and Times (both inclusive), according to the calendar defined for the system.
calworkdays([start_datetime], [end_datetime], [calendar_name])
| calworkdays(datetime(2011, 12, 13, 12, 0, 0), datetime(2011, 12, 20, 12, 0, 0))
6
|
-portal-om+crf-rcrf+pr+pe
Incompatible
Portals
Incompatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
calworkhours() | This returns the actual number of work hours between two given Date and Times (both inclusive), according to the calendar defined for the system.
calworkhours([start_datetime], [end_datetime], [calendar_name])
| calworkhours(datetime(2011, 12, 12, 12, 0, 0), datetime(2011, 12, 13, 12, 0, 0))
8
|
-portal-om+crf-rcrf+pr+pe
Incompatible
Portals
Incompatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
date() | Converts text into data accepted by the date data type and functions that require date parameters.
date([year], [month], [day])
| date(2011, 12, 13)
12/13/2011
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
datetime() | Converts the given Date and Time into a serial number that holds the Date and Time data type.
datetime([year], [month], [day], [hour], [minute], [second])
| datetime(2011, 12, 13, 12, 0, 0)
12/13/2011 12:00 PM GMT
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
datevalue() | Converts a value to a date.
datevalue([value])
| datevalue(0)
1/1/2035
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
day() | Returns the day of the month from the date specified.
day([date])
| day(datetime(2011, 12, 13, 12, 0, 0))
13
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
dayofyear() | Returns the day number within the year.
dayofyear([date])
| dayofyear(date(1957, 03, 14))
73
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
days360() | Returns the number of days between two dates, based on a 360-day calendar.
days360([start_date], [end_date], [method])
| days360(today(), today() + 365, 0)
360
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
daysinmonth() | Returns the number of days in the given month in the given year.
daysinmonth([month], [year])
| daysinmonth(2, 1800)
28
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
edate() | Returns the date that is the number of months before or after the given starting date.
edate([starting_date], [months])
| edate(date(2011, 12, 13), -6)
6/13/11
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
eomonth() | Returns the date for the last day of the month that is the number of months before or after the given starting date.
eomonth([starting_date], [months])
| eomonth(date(2011, 12, 13), -6)
6/30/2011
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
gmt() | Subtracts a time zone offset from a given Date and Time.
gmt([datetime], [timezone])
| gmt(datetime(2011, 12, 13, 12, 05), "America/New_York")
12/13/2011 5:05 PM GMT
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
hour() | Returns the hour from the time specified.
hour([time])
| hour(time(14, 20, 23))
14
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
intervalds() | Converts the given time components into an equivalent time duration, an interval expressing days to seconds. This value is treated as a duration (Joe ran the marathon in 3 hours and 23 minutes), not a point in time.
intervalds([hour], [minute], [second])
| intervalds(2, 4, 5)
0::02:04:05.000
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
isleapyear() | Returns a Boolean value for whether the given year is a leap year.
isleapyear([year])
| isleapyear(1996)
True
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
lastndays() | Returns a Boolean value for whether the given date is within the last given number of days.
lastndays([date], [n])
| lastndays(date(2011, 12, 13), 6)
False
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
local() | This is a Date and Time addition function, adding time zone offset to given Date and Time.
local([datetime], [timezone])
| local(datetime(2011, 12, 13, 12, 05), "America/New_York")
12/13/2011 7:05 AM GMT
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
milli() | This function returns the millisecond portion of a timestamp or the decimal number that represents 1 millisecond in days.
milli([time])
| milli(datetime(2011, 12, 13, 12, 0, 0, 25))
25
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
minute() | Returns the minute from the time specified.
minute([time], [minute])
| minute(time(14, 20, 23))
20
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
month() | Returns the month from the specified date.
month([date])
| month(date(2011, 12, 13))
12
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
networkdays() | Returns the number of working days between two specified dates.
networkdays([starting_date], [ending_date], [holidays])
| networkdays(date(2011, 12, 13), date(2011, 12, 20))
6
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
now() | Returns the current Date and Time as a serial number.
now([])
| now()
2/2/2022 2:02 PM
|
+portal+om-crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
second() | Returns the seconds from the specified time.
second([time])
| second(time(14, 20, 23))
23
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
time() | Converts the given time into an equivalent time value.
time([hour], [minute], [second], [millisecond])
| time(14, 20, 23)
2:20 PM
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
timevalue() | Converts the given time into an equivalent interval.
timevalue([time_text])
| timevalue(time(14, 20, 23))
2:20 PM
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
timezone() | Returns the default offset in minutes from GMT, which is generally the process initiator's time zone.
timezone([])
| timezone()
0
|
+portal-om+crf-rcrf+pr+pe
Compatible
Portals
Incompatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
timezoneid() | Returns the time zone ID for the current context.
timezoneid([])
| timezoneid()
GMT
|
+portal-om+crf-rcrf+pr+pe
Compatible
Portals
Incompatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
today() | Returns the current day in GMT.
today([])
| today()
2/2/2022
|
+portal+om-crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
weekday() | Returns the day of the week of the specified date.
weekday([date], [return_type])
| weekday(date(2011, 12, 13))
3
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
weeknum() | Returns the week number within the year for the given date using a given methodology.
weeknum([date], [methodology])
| weeknum(date(2011, 12, 13))
51
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
workday() | Returns the date the given number of workdays before or after the given date.
workday([starting_date], [days], [holidays])
| workday(date(2011, 12, 13), -6)
12/5/2011
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
year() | Returns the year for the date specified.
year([date])
| year(date(2011, 12, 13))
2011
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
yearfrac() | Determine the fraction of the year.
yearfrac([start_date], [end_date], [method])
| yearfrac(today(), today() + 270, 3)
0.739726
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
EvaluationUsed in expression to perform complex evaluations. |
a!localVariables() | Lets you define one or more local variables for use within an expression. When used within an interface, the value of each variable can be refreshed under a variety of conditions, configured using a!refreshVariable(). When used outside of an interface, all refresh properties configured using a!refreshVariable() are ignored.
a!localVariables([localVar1], [localVarN], [expression])
| Click on the function name for examples. |
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!refreshVariable() | The configuration for a specific local variable for use within a!localVariables(). When used within an interface, the value of the variable can be refreshed under a variety of conditions. When used outside of an interface, all refresh properties are ignored.
a!refreshVariable([value], [refreshAlways], [refreshInterval], [refreshOnReferencedVarChange], [refreshOnVarChange], [refreshAfter])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!save() | In interface saveInto parameters, updates the target with the given value. Use a!save for each item that you want to modify or alter in a
a!save([target], [value])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
bind() | Use in conjunction with the load function to bind getter and setter functions to a variable. When the variable is read, the getter function or rule will be called. When the variable is saved into, the writer returned by the setter function or rule will be called. The setter function must return a writer.
bind([get], [set])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
load()
Replaced by a!localVariables()
|
Lets you define local variables within an expression for an interface and evaluate the expression with the new variables, then re-evaluate the function with the local variables' values from the previous evaluation.
load([localVar1], [localVarN], [expression])
| Click on the function name for examples. |
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
with()
Replaced by a!localVariables()
|
Lets you define local variables within a function and evaluate the expression with the new variables.
with([localVar1], [localVarN], [expression])
| with(local!a:10, local!b:20, local!a+local!b)
30
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
InformationalUsed within expressions to expose system values and translate other information. |
a!automationId() | Returns the automation identifier for the automation type provided. Use this function to write the automation identifier for record events.
a!automationId([automationTypes])
| a!automationId("RPA")
2
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!automationType() | Returns the automation type for the automation identifier provided, translated according to the user’s language preferences.
a!automationType([automationIds])
| a!automationType(1)
None (User)
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!defaultValue() | Returns a default value when the specified value is null or empty. When there are multiple default parameters, each parameter is evaluated in order and the first non-null and non-empty default will be returned.
a!defaultValue([value], [default])
| a!defaultValue( null, date(2021,10,1), null)
`2021-10-01`
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!isNotNullOrEmpty() | Returns
a!isNotNullOrEmpty([value])
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!isNullOrEmpty() | Returns
a!isNullOrEmpty([value])
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!keys() | Returns the keys of the provided map, dictionary, CDT, or record.
a!keys([value])
| a!keys(a!map(a: 1, b: 2))
{"a"=>nil, "b"=>nil}
|
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!listType() | Returns the list type number for a given type number.
a!listType([typeNumber])
| a!listType(typeof(1)) |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
cast() | Converts a value from its existing type to the specified type.
cast([typeNumber], [value])
| cast(type!Date,"01-01-2017")
1/1/2017
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
error() | Raises an error with the given message, used for invalidating execution.This function never returns a value.
error([message])
| error("This is an error message.")
Expression evaluation error at function 'error': This is an error message.
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
infinity() | Represents a constant number that stands for positive infinity or a negative infinity if you negate the value.
infinity([])
| infinity()
∞
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
isinfinite() | Tests given numbers against positive and negative infinity, returning
isinfinite([number])
| isinfinite(1.5, 1.1)
false; false
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
isnegativeinfinity() | Tests given numbers against negative infinity, returning true if number is negative infinity, false if number is not negative infinity.
isnegativeinfinity([number])
| isnegativeinfinity(1)
false
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
isnull() | Returns true if value is null, false otherwise.
isnull([value])
| isnull("")
true
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
ispositiveinfinity() | Tests given numbers against positive infinity, returning
ispositiveinfinity([number])
| ispositiveinfinity(1)
false
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
nan() | Constant number representing Not A Number, generally used for comparison to the result of mathematical operations with invalid inputs. This is equivalent to a decimal (floating point) null, but nan() is provided for more explicit usage in mathematical expressions.
nan([])
| nan()
null
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
null() | Returns a null value.
null([value])
| null()
null
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
runtimetypeof() | Returns the numerical representation of an Appian system data type when used during process execution.
runtimetypeof([value])
| runtimetypeof( 12345)
9
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
typename() | Returns the type name of a given type number.
typename([typeNumber])
| typename(typeof(1))
Number (Integer)
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
typeof() | Returns the type number of a given value.
typeof([value])
| typeof("a")
3
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
Interface ComponentUsed to create Appian interfaces. |
Action |
a!authorizationLink() | Defines a link to authorize a user for a connected system that uses OAuth 2.0 Authorization Code grant.
a!authorizationLink([label], [connectedSystem], [showWhen])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!buttonArrayLayout() | Displays a list of buttons in the order they are specified. Use this layout for buttons within interfaces rather than for submission buttons at the bottom of forms
a!buttonArrayLayout([buttons], [showWhen], [align], [marginBelow], [accessibilityText])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!buttonLayout() | Displays a list of buttons grouped by prominence. Use this layout in cases where prominence needs to be explicitly specified.
a!buttonLayout([primaryButtons], [secondaryButtons], [accessibilityText], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!buttonWidget() | Displays a button that can conditionally be used to submit a form.
a!buttonWidget([label], [style], [confirmMessage], [value], [saveInto], [disabled], [submit], [validate], [validationGroup], [size], [width], [confirmHeader], [confirmButtonLabel], [cancelButtonLabel], [showWhen], [icon], [accessibilityText], [tooltip], [recaptchaSaveInto], [loadingIndicator], [iconPosition], [color])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!buttonWidget_23r3() | Displays a button that can conditionally be used to submit a form.
a!buttonWidget_23r3([label], [style], [confirmMessage], [value], [saveInto], [disabled], [submit], [validate], [validationGroup], [size], [width], [confirmHeader], [confirmButtonLabel], [cancelButtonLabel], [showWhen], [icon], [accessibilityText], [tooltip], [recaptchaSaveInto], [loadingIndicator], [iconPosition])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!documentDownloadLink() | Defines a link used to download a document.
a!documentDownloadLink([label], [document], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!dynamicLink() | Defines a link that triggers updates to one or more variables.
a!dynamicLink([label], [value], [saveInto], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!linkField() | Displays one or more links of any link type, including document links, task links, record view links, external web page links, and dynamic links that update variables.
a!linkField([label], [instructions], [links], [labelPosition], [align], [helpTooltip], [showWhen], [accessibilityText])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!newsEntryLink() | Defines a link to news entries.
a!newsEntryLink([label], [entry], [showWhen])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!processTaskLink() | Defines a link to a process task.
a!processTaskLink([label], [task], [showWhen], [openLinkIn])
| Click on the function name for examples. |
-portal~om-crf-rcrf-pr-pe
Incompatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!recordActionField() | Displays a list of record actions with a consistent style. A record action is an end-user action configured within a record type object, such as a related action or record list action.
a!recordActionField([actions], [style], [display], [openActionsIn], [align], [accessibilityText], [showWhen], [securityOnDemand])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!recordActionItem() | Displays a record action defined within a record action field or a read-only grid that uses a record type as the data source. A record action is an end-user action configured within a record type object, such as a related action or a record list action.
a!recordActionItem([action], [identifier])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!recordLink() | Defines a link to a record view. Record links must be used in a link parameter of another component, such as the links parameter in the link component.
a!recordLink([label], [recordType], [identifier], [dashboard], [showWhen], [openLinkIn], [targetLocation])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!reportLink() | Defines a link to a report.
a!reportLink([label], [report], [showWhen], [openLinkIn])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!safeLink() | Defines a link to an external web page.
a!safeLink([label], [uri], [showWhen], [openLinkIn])
| Click on the function name for examples. |
+portal-om-crf-rcrf-pr-pe
Compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!startProcessLink() | Defines a link to start a process and navigates the user through any initial chained forms.
a!startProcessLink([label], [processModel], [processParameters], [bannerMessage], [showWhen])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!submitLink() | Defines a link to trigger form submission.
a!submitLink([label], [confirmMessage], [confirmButtonStyle], [value], [saveInto], [skipValidation], [validationGroup], [confirmHeader], [confirmButtonLabel], [cancelButtonLabel], [showWhen])
| Click on the function name for examples. |
-portal+om-crf-rcrf-pr-pe
Incompatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!userRecordLink() | Defines a link to a user record. User record links must be used in a link parameter of another component, such as the links parameter in the link component.
a!userRecordLink([label], [user], [view], [showWhen], [openLinkIn], [targetLocation])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
Browsers |
a!documentAndFolderBrowserFieldColumns() | Displays the contents of a folder and allows users to navigate through a series of folders to find and select a folder or document.
a!documentAndFolderBrowserFieldColumns([label], [labelPosition], [instructions], [helpTooltip], [rootFolder], [navigationValue], [navigationSaveInto], [selectionValue], [selectionSaveInto], [showWhen], [readOnly], [height], [accessibilityText])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!documentBrowserFieldColumns() | Displays the contents of a folder and allows users to navigate through a series of folders to find and select a document.
a!documentBrowserFieldColumns([label], [labelPosition], [instructions], [helpTooltip], [rootFolder], [navigationValue], [navigationSaveInto], [selectionValue], [selectionSaveInto], [showWhen], [readOnly], [height], [accessibilityText])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!folderBrowserFieldColumns() | Displays the contents of a folder and allows users to navigate through a series of folders to find and select a folder.
a!folderBrowserFieldColumns([label], [labelPosition], [instructions], [helpTooltip], [rootFolder], [navigationValue], [navigationSaveInto], [selectionValue], [selectionSaveInto], [readOnly], [showWhen], [height], [accessibilityText])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!groupBrowserFieldColumns() | Displays group membership structure in columns. Users can navigate through the structure and select a single group.
a!groupBrowserFieldColumns([label], [labelPosition], [instructions], [helpTooltip], [rootGroup], [pathValue], [pathSaveInto], [selectionValue], [selectionSaveInto], [readOnly], [height], [hideUsers], [accessibilityText], [showWhen])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!hierarchyBrowserFieldColumns() | Displays hierarchical data in the form of drillable columns with selectable cells.
a!hierarchyBrowserFieldColumns([label], [labelPosition], [instructions], [helpTooltip], [firstColumnValues], [nodeConfigs], [pathValue], [pathSaveInto], [nextColumnValues], [selectionValue], [selectionSaveInto], [height], [accessibilityText], [showWhen])
| Click on the function name for examples. |
+portal-om-crf-rcrf-pr-pe
Compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!hierarchyBrowserFieldColumnsNode() | Returns a Hierarchy Browser Field Columns Node, used in the Node Configurations parameter of the Columns Browser to determine how items in the hierarchy are displayed.
a!hierarchyBrowserFieldColumnsNode([id], [label], [image], [link], [isSelectable], [isDrillable], [nextColumnCount], [showWhen])
| Click on the function name for examples. |
+portal-om-crf-rcrf-pr-pe
Compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!hierarchyBrowserFieldTree() | Displays hierarchical data in the form of drillable tree.
a!hierarchyBrowserFieldTree([label], [labelPosition], [instructions], [helpTooltip], [pathValue], [pathSaveInto], [nodeConfigs], [nextLevelValues], [accessibilityText], [showWhen])
| Click on the function name for examples. |
+portal-om-crf-rcrf-pr-pe
Compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!hierarchyBrowserFieldTreeNode() | Returns a Tree Node, used in the Node Configurations parameter of the Tree Browser Component to determine how items in the hierarchy are displayed.
a!hierarchyBrowserFieldTreeNode([id], [label], [description], [details], [image], [link], [isDrillable], [nextLevelCount], [showWhen])
| Click on the function name for examples. |
+portal-om-crf-rcrf-pr-pe
Compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!orgChartField() | Displays the organizational structure of users within Appian based on the users’ Supervisor field values.
a!orgChartField([label], [labelPosition], [instructions], [value], [saveInto], [showAllAncestors], [helpTooltip], [accessibilityText], [showWhen], [showTotalCounts])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!userAndGroupBrowserFieldColumns() | Displays group membership structure in columns. Users can navigate through the structure and select a single user or group.
a!userAndGroupBrowserFieldColumns([label], [labelPosition], [instructions], [helpTooltip], [rootGroup], [pathValue], [pathSaveInto], [selectionValue], [selectionSaveInto], [readOnly], [height], [accessibilityText], [showWhen])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!userBrowserFieldColumns() | Displays group membership structure in columns. Users can navigate through the structure and select a single user.
a!userBrowserFieldColumns([label], [labelPosition], [instructions], [helpTooltip], [rootGroup], [pathValue], [pathSaveInto], [selectionValue], [selectionSaveInto], [readOnly], [height], [accessibilityText], [showWhen])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
Charts |
a!areaChartConfig() | Contains configuration for how to display data in an area chart.
a!areaChartConfig([primaryGrouping], [secondaryGrouping], [measures], [sort], [dataLimit], [link], [showIntervalsWithNoData])
| Click on the function name for examples |
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!areaChartField() | Displays a series of numerical data as points connected by lines with the area between the line and axis shaded. Use an area chart to visualize trends over time and compare multiple values. If specific values are more important than the trend, consider using a column chart.
a!areaChartField([label], [instructions], [categories], [series], [xAxisTitle], [yAxisTitle], [yAxisMin], [yAxisMax], [stacking], [referenceLines], [showLegend], [showDataLabels], [showTooltips], [allowDecimalAxisLabels], [labelPosition], [helpTooltip], [showWhen], [connectNulls], [accessibilityText], [colorScheme], [height], [xAxisStyle], [yAxisStyle], [data], [config], [refreshAlways], [refreshInterval], [refreshOnReferencedVarChange], [refreshOnVarChange], [refreshAfter], [allowImageDownload])
| Click on the function name for examples. |
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!barChartConfig() | Contains configuration for how to display data in a bar chart.
a!barChartConfig([primaryGrouping], [secondaryGrouping], [measures], [sort], [dataLimit], [link], [showIntervalsWithNoData])
| Click on the function name for examples |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!barChartField() | Displays numerical data as horizontal bars. Use a bar chart to display several values at the same point in time.
a!barChartField([label], [instructions], [categories], [series], [xAxisTitle], [yAxisTitle], [yAxisMin], [yAxisMax], [stacking], [referenceLines], [showLegend], [showDataLabels], [showTooltips], [allowDecimalAxisLabels], [labelPosition], [helpTooltip], [accessibilityText], [showWhen], [colorScheme], [height], [xAxisStyle], [yAxisStyle], [data], [config], [refreshAlways], [refreshAfter], [refreshInterval], [refreshOnReferencedVarChange], [refreshOnVarChange], [allowImageDownload])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!chartReferenceLine() | Contains the reference line value for each threshold that is defined on a column, bar, line, or area chart.
a!chartReferenceLine([label], [value], [showWhen], [color], [style])
| Click on the function name for examples. |
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!chartSeries() | Defines a series of data for a bar, column, line, area, or pie chart. This component is always used within a chart component.
a!chartSeries([label], [data], [links], [color], [showWhen])
| Click on the function name for examples. |
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!colorSchemeCustom() | A custom list of colors to apply to any chart.
a!colorSchemeCustom([Colors])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!columnChartConfig() | Contains configuration for how to display data in a column chart.
a!columnChartConfig([primaryGrouping], [secondaryGrouping], [measures], [sort], [dataLimit], [link], [showIntervalsWithNoData])
| Click on the function name for examples |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!columnChartField() | Displays numerical data as vertical bars. Use a column chart to graphically display data that changes over time.
a!columnChartField([label], [instructions], [categories], [series], [xAxisTitle], [yAxisTitle], [yAxisMin], [yAxisMax], [stacking], [referenceLines], [showLegend], [showDataLabels], [showTooltips], [allowDecimalAxisLabels], [labelPosition], [helpTooltip], [accessibilityText], [showWhen], [colorScheme], [height], [xAxisStyle], [yAxisStyle], [data], [config], [refreshAlways], [refreshAfter], [refreshInterval], [refreshOnReferencedVarChange], [refreshOnVarChange], [allowImageDownload])
| Click on the function name for examples. |
+portal-om-crf-rcrf-pr-pe
Compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!grouping() | Determines the fields to group by in a query or chart that uses a record type as the source. The grouping should incorporate a record field or a related record field, an alias, and an optional interval to group by a date.
a!grouping([field], [interval], [alias], [formatValue])
| Click on the function name for examples. |
+portal-om-crf-rcrf-pr-pe
Compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!lineChartConfig() | Contains configuration for how to display data in a line chart.
a!lineChartConfig([primaryGrouping], [secondaryGrouping], [measures], [sort], [dataLimit], [link], [showIntervalsWithNoData])
| Click on the function name for examples |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!lineChartField() | Displays a series of numerical data as points connected by lines. Use a line chart to visualize trends of data that changes over time.
a!lineChartField([label], [instructions], [categories], [series], [xAxisTitle], [yAxisTitle], [yAxisMin], [yAxisMax], [referenceLines], [showLegend], [showDataLabels], [showTooltips], [allowDecimalAxisLabels], [labelPosition], [helpTooltip], [showWhen], [connectNulls], [accessibilityText], [colorScheme], [height], [xAxisStyle], [yAxisStyle], [data], [config], [refreshAlways], [refreshAfter], [refreshInterval], [refreshOnReferencedVarChange], [refreshOnVarChange], [allowImageDownload])
| Click on the function name for examples. |
+portal-om-crf-rcrf-pr-pe
Compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!measure() | Determines the numerical values to display on a query, chart, or KPI. The measure should incorporate a record field or a related record field, the appropriate calculation to run on the field, and an alias. If your record type has data sync enabled, you can also apply filters to determine which values are included in the calculation.
a!measure([field], [function], [alias], [label], [filters], [formatValue])
| Click on the function name for examples |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!pieChartConfig() | Contains configuration for how to display data in a pie chart.
a!pieChartConfig([primaryGrouping], [measures], [sort], [dataLimit], [link])
| Click on the function name for examples |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!pieChartField() | Displays numerical data as slices of a single circle. Use a pie chart to graphically display parts of a whole.
a!pieChartField([label], [instructions], [series], [showDataLabels], [showTooltips], [showAsPercentage], [labelPosition], [helpTooltip], [accessibilityText], [showWhen], [colorScheme], [style], [seriesLabelStyle], [height], [data], [config], [refreshAlways], [refreshAfter], [refreshInterval], [refreshOnReferencedVarChange], [refreshOnVarChange], [allowImageDownload])
| Click on the function name for examples. |
+portal-om-crf-rcrf-pr-pe
Compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!scatterChartField() | Displays the relationship between two numerical data points. Use a scatter chart to compare multiple values, visualize trends over time, and spot outliers.
a!scatterChartField([data], [label], [instructions], [xAxisTitle], [yAxisTitle], [xAxisMin], [xAxisMax], [yAxisMin], [yAxisMax], [referenceLines], [showDataLabels], [showLegend], [showTooltips], [allowDecimalAxisLabels], [labelPosition], [helpTooltip], [accessibilityText], [showWhen], [colorScheme], [height], [xAxisStyle], [yAxisStyle], [refreshAlways], [refreshInterval], [refreshOnReferencedVarChange], [refreshOnVarChange], [refreshAfter], [primaryGrouping], [secondaryGrouping], [xAxisMeasure], [yAxisMeasure], [sort], [dataLimit], [link], [allowImageDownload])
| Click on the function name for examples. |
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
Display |
a!documentImage() | Displays an image from document management.
a!documentImage([document], [altText], [caption], [link], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!documentViewerField() | Displays a document from document management on an interface.
a!documentViewerField([label], [labelPosition], [instructions], [helpTooltip], [document], [showWhen], [height], [altText], [disabled], [accessibilityText], [marginAbove], [marginBelow])
| Click on the function name for examples. |
+portal-om-crf-rcrf-pr-pe
Compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!gaugeField() | Displays completion percentage in a circular style with optional text.
a!gaugeField([label], [labelPosition], [instructions], [helpTooltip], [percentage], [primaryText], [secondaryText], [color], [size], [align], [accessibilityText], [showWhen], [tooltip], [marginAbove], [marginBelow])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!gaugeFraction() | Displays text in fractional format for use within the gauge field primary text parameter.
a!gaugeFraction([denominator])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!gaugeIcon() | Displays an icon for use within the gauge field primary text parameter.
a!gaugeIcon([icon], [altText], [color])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!gaugePercentage() | Displays the configured percentage of the gauge as an integer for use within the gauge field primary text parameter.
a!gaugePercentage([label], [labelPosition], [instructions], [helpTooltip], [percentage], [primaryText], [secondaryText], [color], [size], [align], [accessibilityText], [showWhen], [tooltip])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!horizontalLine() | Displays a horizontal line
a!horizontalLine([color], [weight], [marginAbove], [marginBelow], [showWhen], [style])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!imageField() | Displays an image from document management or the web.
a!imageField([label], [labelPosition], [instructions], [helpTooltip], [images], [showWhen], [size], [isThumbnail], [style], [align], [accessibilityText], [marginAbove], [marginBelow])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!kpiField() | Displays a key performance indicator that can be configured using a record type as the source.
a!kpiField([data], [primaryMeasure], [primaryText], [icon], [helpTooltip], [align], [accessibilityText], [tooltip], [showWhen], [secondaryMeasure], [trend], [trendFormat], [trendIcon], [trendColor], [secondaryText], [iconColor], [primaryTextColor], [primaryMeasureColor], [secondaryTextColor], [iconStyle], [template], [refreshAlways], [refreshInterval], [refreshOnReferencedVarChange], [refreshOnVarChange], [refreshAfter], [size])
| Click on the function name for examples. |
+portal~om-crf-rcrf-pr-pe
Compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!milestoneField() | Displays the completed, current, and future steps of a process or sequence.
a!milestoneField([label], [instructions], [steps], [links], [active], [labelPosition], [helpTooltip], [showWhen], [orientation], [accessibilityText], [color], [marginAbove], [marginBelow])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!progressBarField() | Displays a completion percentage in bar style.
a!progressBarField([label], [instructions], [percentage], [labelPosition], [helpTooltip], [accessibilityText], [color], [showWhen], [style], [showPercentage], [marginAbove], [marginBelow])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!richTextBulletedList() | Displays a bulleted list within a rich text component.
a!richTextBulletedList([items], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!richTextDisplayField() | Displays text in variety of styles, including bold, italics, underline, links, headers, and numbered and bulleted lists.
a!richTextDisplayField([label], [labelPosition], [instructions], [align], [value], [helpTooltip], [accessibilityText], [showWhen], [preventWrapping], [tooltip], [marginAbove], [marginBelow])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!richTextHeader() | Displays heading-styled text within a rich text component.
a!richTextHeader([text], [size], [link], [linkStyle], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!richTextIcon() | Displays a style icon within a rich text component.
a!richTextIcon([icon], [altText], [caption], [size], [color], [link], [linkStyle], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!richTextImage() | Displays an image within a rich text component.
a!richTextImage([image], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!richTextItem() | Displays styled text within a rich text component.
a!richTextItem([text], [style], [size], [color], [link], [linkStyle], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!richTextListItem() | Displays a numbered list within a rich text component.
a!richTextListItem([text], [nestedList], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!richTextNumberedList() | Displays a numbered list within a rich text component.
a!richTextNumberedList([items], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!stampField() | Displays an icon and/or text on a colored circular background.
a!stampField([label], [labelPosition], [instructions], [helpTooltip], [icon], [text], [backgroundColor], [contentColor], [size], [align], [tooltip], [showWhen], [accessibilityText], [link], [marginAbove], [marginBelow])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!tagField() | Displays a list of short text labels with colored background to highlight important attributes.
a!tagField([label], [labelPosition], [instructions], [helpTooltip], [tags], [align], [accessibilityText], [size], [showWhen], [marginAbove], [marginBelow])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!tagItem() | Displays a short text label with colored background for use with a!tagField.
a!tagItem([text], [backgroundColor], [textColor], [tooltip], [showWhen], [recordLink])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!timeDisplayField() | Displays a single time (hour, minute, second) but cannot take input.
a!timeDisplayField([label], [instructions], [value], [labelPosition], [helpTooltip], [accessibilityText], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!userImage() | Displays the profile photo of the user.
a!userImage([user], [altText], [caption], [link], [showWhen])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!videoField() | Creates a Video component.
a!videoField([label], [labelPosition], [instructions], [videos], [helpTooltip], [accessibilityText], [showWhen], [marginAbove], [marginBelow])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!webContentField() | Displays content inline from an external source.
a!webContentField([label], [labelPosition], [instructions], [helpTooltip], [showWhen], [source], [showBorder], [height], [altText], [disabled], [accessibilityText], [marginAbove], [marginBelow])
| Click on the function name for examples. |
+portal-om-crf-rcrf-pr-pe
Compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!webImage() | Displays an image from the web.
a!webImage([source], [altText], [caption], [link], [showWhen])
| Click on the function name for examples. |
+portal-om-crf-rcrf-pr-pe
Compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!webVideo() | Displays a video from the web for use in a video field.
a!webVideo([source], [tooltip], [showWhen])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
Grids and Lists |
a!eventData() | This function determines the event data to display for a single record type in the Event History List component.
a!eventData([recordType], [filters], [timestamp], [user], [eventTypeName], [details], [recordTypeForTag], [recordIdentifier])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!eventHistoryListField() | Displays the event history for one or more record types.
a!eventHistoryListField([label], [labelPosition], [instructions], [helpTooltip], [emptyListMessage], [eventData], [eventStyle], [formatTimestamp], [displayUser], [displayUserColorScheme], [previewListPageSize], [pageSize], [showWhen], [refreshAlways], [refreshAfter], [refreshInterval], [refreshOnReferencedVarChange], [refreshOnVarChange], [userFilters], [eventFilters], [CollapseDetailsByDefault], [showSearchBox], [showReverseSortButton])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!gridColumn() | Displays a column of data as read-only text, links, images, or rich text within the read-only grid.
a!gridColumn([label], [sortField], [helpTooltip], [value], [showWhen], [align], [width], [backgroundColor], [accessibilityText])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!gridField() | Accepts a set of data and displays it as read-only text, links, images, or rich text in a grid that supports selecting, sorting, and paging.
a!gridField([label], [labelPosition], [instructions], [helpTooltip], [emptyGridMessage], [data], [columns], [pageSize], [initialSorts], [secondarySorts], [pagingSaveInto], [selectable], [selectionStyle], [selectionValue], [selectionSaveInto], [selectionRequired], [selectionRequiredMessage], [disableRowSelectionWhen], [validations], [validationGroup], [showWhen], [spacing], [height], [borderStyle], [shadeAlternateRows], [rowHeader], [accessibilityText], [refreshAlways], [refreshAfter], [refreshInterval], [refreshOnReferencedVarChange], [refreshOnVarChange], [userFilters], [showSearchBox], [showRefreshButton], [showExportButton], [recordActions], [openActionsIn], [actionsDisplay], [actionsStyle], [maxSelections], [showSelectionCount])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!gridLayout() | Displays a tabular layout of SAIL components to provide quick inline editing of fields. For an example of how to configure an editable grid, see the Add, Edit, and Remove Data in an Inline Editable Grid SAIL Recipe.
a!gridLayout([label], [instructions], [headerCells], [columnConfigs], [rows], [validations], [validationGroup], [selectable], [selectionDisabled], [selectionRequired], [selectionValue], [selectionSaveInto], [addRowLink], [totalCount], [emptyGridMessage], [helpTooltip], [labelPosition], [showWhen], [shadeAlternateRows], [spacing], [height], [borderStyle], [selectionStyle], [rowHeader], [accessibilityText])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!gridLayoutColumnConfig() | Defines a column configuration for use in an editable grid (a!gridLayout).
a!gridLayoutColumnConfig([width], [weight], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!gridLayoutHeaderCell() | Defines a column header for use in an editable grid (a!gridLayout).
a!gridLayoutHeaderCell([label], [helpTooltip], [align], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!gridRowLayout() | Displays a row of components within an editable grid (a!gridLayout).
a!gridRowLayout([contents], [id], [selectionDisabled], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
Inputs |
a!barcodeField() | Displays and allows entry of a barcode value using a barcode scanner or manual input.
a!barcodeField([label], [labelPosition], [instructions], [acceptedTypes], [value], [saveInto], [refreshAfter], [required], [requiredMessage], [readOnly], [disabled], [validations], [validationGroup], [align], [placeholder], [helpTooltip], [masked], [accessibilityText], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!dateField() | Displays and allows entry of a single date (year, month, day). To display a read-only date using a custom format, use a text component.
a!dateField([label], [instructions], [required], [readOnly], [disabled], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [align], [labelPosition], [helpTooltip], [accessibilityText], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!dateTimeField() | Displays and allows entry of a single date and time (year, month, day, hour, minute, second). To display a read-only date and time using a custom format, use a text component.
a!dateTimeField([label], [instructions], [required], [readOnly], [disabled], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [labelPosition], [helpTooltip], [accessibilityText], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!encryptedTextField() | Allows entry of a single line of text that is encrypted when saved into a variable. The value remains encrypted while on the server and is only decrypted when displayed in the component.
a!encryptedTextField([label], [instructions], [required], [readOnly], [disabled], [value], [saveInto], [refreshAfter], [validationGroup], [requiredMessage], [align], [labelPosition], [placeholder], [helpTooltip], [masked], [accessibilityText], [showWhen], [inputPurpose])
| Click on the function name for examples. |
-portal+om-crf-rcrf-pr-pe
Incompatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!fileUploadField() | Allows users to upload one or more files. To upload files outside of a start form or task, use a!submitUploadedFiles() in the saveInto parameter of a submit button or link. Uploaded documents are not accessible until after form submission.
a!fileUploadField([label], [labelPosition], [instructions], [helpTooltip], [target], [fileNames], [fileDescriptions], [maxSelections], [value], [saveInto], [required], [requiredMessage], [disabled], [validations], [validationGroup], [buttonStyle], [buttonSize], [accessibilityText], [showWhen], [uploadMethods], [buttonDisplay], [placeholder], [showVirusScanMessage])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!floatingPointField() | Displays and allows entry of a single decimal number, stored with a floating point representation.
a!floatingPointField([label], [instructions], [required], [readOnly], [disabled], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [align], [labelPosition], [refreshAfter], [placeholder], [helpTooltip], [accessibilityText], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!integerField() | Displays and allows entry of a single integer number.
a!integerField([label], [instructions], [required], [readOnly], [disabled], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [align], [labelPosition], [refreshAfter], [placeholder], [helpTooltip], [masked], [accessibilityText], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!paragraphField() | Displays and allows entry of multiple lines of text.
a!paragraphField([label], [instructions], [required], [readOnly], [disabled], [value], [validations], [saveInto], [refreshAfter], [labelPosition], [validationGroup], [requiredMessage], [height], [placeholder], [helpTooltip], [showWhen], [accessibilityText], [characterLimit], [showCharacterCount])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!recordsChatField() | Creates a chatbot for chatting on a record summary view.
a!recordsChatField([label], [labelPosition], [instructions], [helpTooltip], [initialMessage], [suggestedQuestions], [recordType], [identifier], [fields], [relatedRecordData], [showWhen], [height], [buttonStyle])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!signatureField() | Allows users to capture and save a .png signature file. To upload signatures outside of a start form or task, use a!submitUploadedFiles() in the saveInto parameter of a submit button or link.
a!signatureField([label], [labelPosition], [instructions], [helpTooltip], [target], [fileName], [fileDescription], [value], [saveInto], [required], [requiredMessage], [buttonStyle], [buttonSize], [readOnly], [disabled], [validationGroup], [accessibilityText], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!textField() | Displays and allows entry of a single line of text.
a!textField([label], [instructions], [required], [readOnly], [disabled], [value], [validations], [saveInto], [refreshAfter], [validationGroup], [requiredMessage], [align], [labelPosition], [placeholder], [helpTooltip], [masked], [accessibilityText], [showWhen], [inputPurpose], [characterLimit], [showCharacterCount])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
Layouts |
a!barOverlay() | Displays a horizontal bar overlay for use in billboard layout.
a!barOverlay([position], [contents], [showWhen], [style], [padding])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!billboardLayout() | Displays a background color, image, or video with optional overlay content.
a!billboardLayout([backgroundMedia], [backgroundColor], [showWhen], [height], [marginBelow], [overlay], [accessibilityText], [marginAbove], [backgroundMediaPositionHorizontal], [backgroundMediaPositionVertical])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!boxLayout() | Displays any arrangement of layouts and components within a box on an interface.
a!boxLayout([label], [contents], [style], [showWhen], [isCollapsible], [isInitiallyCollapsed], [marginBelow], [accessibilityText], [padding], [shape], [marginAbove], [showBorder], [showShadow], [labelSize], [labelHeadingTag])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!cardLayout() | Displays any arrangement of layouts and components within a card on an interface. Can be styled or linked.
a!cardLayout([contents], [link], [height], [style], [showBorder], [showShadow], [tooltip], [showWhen], [marginBelow], [accessibilityText], [padding], [shape], [marginAbove], [decorativeBarPosition], [decorativeBarColor])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!columnLayout() | Displays a column that can be used within the columns layout.
a!columnLayout([contents], [width], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!columnOverlay() | Displays a vertical column overlay for use in billboard layout.
a!columnOverlay([alignVertical], [position], [width], [contents], [showWhen], [style], [padding])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!columnsLayout() | Displays any number of columns alongside each other. On narrow screens and mobile devices, columns are stacked.
a!columnsLayout([columns], [alignVertical], [showWhen], [marginBelow], [stackWhen], [showDividers], [spacing], [marginAbove])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!formLayout() | Displays any arrangement of layouts and components beneath a title and above buttons. Use this as the top-level layout for start and task forms.
a!formLayout([label], [instructions], [contents], [buttons], [validations], [validationGroup], [skipAutoFocus], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!fullOverlay() | Displays an overlay that covers the entire billboard layout.
a!fullOverlay([alignVertical], [contents], [showWhen], [style], [padding])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!headerContentLayout() | Displays any arrangement of layouts and components beneath a card or billboard flush with the edge of the page.
a!headerContentLayout([header], [contents], [showWhen], [backgroundColor], [contentsPadding], [isHeaderFixed])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!pane() | Displays a pane within a pane layout.
a!pane([contents], [width], [backgroundColor], [showWhen], [padding], [accessibilityText])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!paneLayout() | Displays two or three vertical panes, each with independent scrolling.
a!paneLayout([panes], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sectionLayout() | This layout requires Appian for Mobile Devices version 17.2 or later. Displays any arrangement of layouts and components beneath a section title on an interface.
a!sectionLayout([label], [contents], [validations], [validationGroup], [isCollapsible], [isInitiallyCollapsed], [showWhen], [divider], [marginBelow], [accessibilityText], [labelIcon], [iconAltText], [labelSize], [labelHeadingTag], [labelColor], [dividerColor], [dividerWeight], [marginAbove])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sideBySideItem() | Displays one item within a side by side layout.
a!sideBySideItem([item], [width], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sideBySideLayout() | Displays components alongside each other.
a!sideBySideLayout([items], [alignVertical], [showWhen], [spacing], [marginBelow], [stackWhen], [marginAbove])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
Pickers |
a!pickerFieldCustom() | Displays an autocompleting input for the selection of one or more items from an arbitrary data set. For an example of how to configure the picker, see the Configure an Array Picker SAIL Recipe.
a!pickerFieldCustom([label], [instructions], [required], [readOnly], [disabled], [maxSelections], [suggestFunction], [selectedLabels], [selectedTooltips], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [labelPosition], [placeholder], [helpTooltip], [selectedLinks], [accessibilityText], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!pickerFieldDocuments() | Displays an autocompleting input for the selection of one or more documents.
a!pickerFieldDocuments([label], [labelPosition], [instructions], [required], [requiredMessage], [readOnly], [disabled], [maxSelections], [folderFilter], [value], [validations], [validationGroup], [saveInto], [placeholder], [helpTooltip], [accessibilityText], [showWhen])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!pickerFieldDocumentsAndFolders() | Displays an autocompleting input for the selection of one or more documents or folders.
a!pickerFieldDocumentsAndFolders([label], [labelPosition], [instructions], [required], [requiredMessage], [readOnly], [disabled], [maxSelections], [folderFilter], [value], [validations], [validationGroup], [saveInto], [placeholder], [helpTooltip], [accessibilityText], [showWhen])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!pickerFieldFolders() | Displays an autocompleting input for selecting one or more folders.
a!pickerFieldFolders([label], [labelPosition], [instructions], [required], [requiredMessage], [readOnly], [disabled], [maxSelections], [folderFilter], [value], [validations], [validationGroup], [saveInto], [placeholder], [helpTooltip], [accessibilityText], [showWhen])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!pickerFieldGroups() | Displays an autocompleting input for selecting one or more groups.
a!pickerFieldGroups([label], [instructions], [required], [readOnly], [disabled], [maxSelections], [groupFilter], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [labelPosition], [placeholder], [helpTooltip], [accessibilityText], [showWhen])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!pickerFieldRecords() | Displays an autocompleting input for the selection of one or more records, filtered by a single record type. Suggestions and picker tokens use the title of the record.
a!pickerFieldRecords([label], [labelPosition], [instructions], [helpTooltip], [placeholder], [maxSelections], [recordType], [filters], [value], [saveInto], [required], [requiredMessage], [readOnly], [disabled], [validations], [validationGroup], [accessibilityText], [showWhen], [showRecordLinks])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!pickerFieldUsers() | Displays an autocompleting input for the selection of one or more users.
a!pickerFieldUsers([label], [instructions], [required], [requiredMessage], [readOnly], [disabled], [maxSelections], [groupFilter], [value], [validations], [validationGroup], [saveInto], [labelPosition], [placeholder], [helpTooltip], [accessibilityText], [showWhen])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!pickerFieldUsersAndGroups() | Displays an autocompleting input for selecting one or more users or groups.
a!pickerFieldUsersAndGroups([label], [instructions], [required], [readOnly], [disabled], [maxSelections], [groupFilter], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [labelPosition], [placeholder], [helpTooltip], [accessibilityText], [showWhen])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
Selection |
a!cardChoiceField() | Displays a set of cards from which the user may select one or many cards and saves a value based on the selected choice.
a!cardChoiceField([label], [labelPosition], [instructions], [helpTooltip], [data], [sort], [cardTemplate], [value], [saveInto], [maxSelections], [align], [showShadow], [required], [requiredMessage], [disabled], [validations], [validationGroup], [showWhen], [accessibilityText], [spacing])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!cardTemplateBarTextJustified() | Displays a bar card template with an icon, primary text, and secondary text justified on either side of the card. For use in the Card Choice Field cardTemplate parameter.
a!cardTemplateBarTextJustified([id], [primaryText], [secondaryText], [icon], [iconColor], [iconAltText], [tooltip], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!cardTemplateBarTextStacked() | Displays a bar card template with an icon and stacked primary text and secondary text. For use in the Card Choice Field cardTemplate parameter.
a!cardTemplateBarTextStacked([id], [primaryText], [secondaryText], [icon], [iconColor], [iconAltText], [tooltip], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!cardTemplateTile() | Displays a tile card template with a stacked icon, primary text, and secondary text. For use in the Card Choice Field cardTemplate parameter.
a!cardTemplateTile([id], [primaryText], [secondaryText], [icon], [iconColor], [iconAltText], [tooltip], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!checkboxField() | Displays a limited set of choices from which the user may select none, one, or many items and saves the values of the selected choices.
a!checkboxField([label], [instructions], [required], [disabled], [choiceLabels], [choiceValues], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [align], [labelPosition], [helpTooltip], [choiceLayout], [accessibilityText], [showWhen], [choiceStyle], [spacing], [data], [sort])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!checkboxFieldByIndex() | Displays a limited set of choices from which the user may select none, one, or many items and saves the indices of the selected choices.
a!checkboxFieldByIndex([label], [instructions], [required], [disabled], [choiceLabels], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [align], [labelPosition], [helpTooltip], [choiceLayout], [accessibilityText], [showWhen], [choiceStyle])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!dropdownField() | Displays a list of choices for the user to select one item and saves a value based on the selected choice.
a!dropdownField([label], [labelPosition], [instructions], [required], [disabled], [choiceLabels], [choiceValues], [placeholder], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [helpTooltip], [accessibilityText], [showWhen], [searchDisplay], [data], [sort])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!dropdownFieldByIndex() | Displays a list of choices for the user to select one item and saves the index of the selected choice.
a!dropdownFieldByIndex([label], [labelPosition], [instructions], [required], [disabled], [choiceLabels], [placeholder], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [helpTooltip], [accessibilityText], [showWhen], [searchDisplay])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!multipleDropdownField() | Displays a list of choices for the user to select multiple items and saves values based on the selected choices.
a!multipleDropdownField([label], [instructions], [required], [disabled], [placeholder], [choiceLabels], [choiceValues], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [labelPosition], [helpTooltip], [accessibilityText], [showWhen], [searchDisplay], [data], [sort])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!multipleDropdownFieldByIndex() | Displays a list of choices for the user to select multiple items and saves the indices of the selected choices.
a!multipleDropdownFieldByIndex([label], [labelPosition], [instructions], [required], [disabled], [placeholder], [choiceLabels], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [helpTooltip], [accessibilityText], [showWhen], [searchDisplay])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!radioButtonField() | Displays a limited set of choices from which the user must select one item and saves a value based on the selected choice.
a!radioButtonField([label], [instructions], [required], [disabled], [choiceLabels], [choiceValues], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [labelPosition], [choiceLayout], [helpTooltip], [accessibilityText], [showWhen], [choiceStyle], [spacing], [data], [sort])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!radioButtonFieldByIndex() | Displays a limited set of choices from which the user must select one item and saves the index of the selected choice.
a!radioButtonFieldByIndex([label], [instructions], [required], [disabled], [choiceLabels], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [labelPosition], [choiceLayout], [helpTooltip], [accessibilityText], [showWhen], [choiceStyle])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
LogicalUsed within expressions to derive logical results. |
a!match() | Evaluates the value against multiple conditions and returns a value based on a match. If no match is found, the default is returned. For example, if "a" then "b" else "c".
a!match([value], [equals], [whenTrue], [then], [default])
| Click on the function name for examples. |
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
and() | Returns
and([value])
| and(true(), false())
false
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
choose()
Replaced by a!match()
|
Evaluates the
choose([key], [choice1], [choiceN])
| choose(2, "a", "b", "c")
b
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
false() | Returns the Boolean value
false([returns])
| false()
false
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
if() | Returns
if([condition], [valueIfTrue], [valueIfFalse])
| if(isleapyear(2021), 1, 2)
2
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
not() | Converts
not([value])
| not(true(), false())
false, true
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
or() | Returns
or([value])
| or(true(), false())
true
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
true() | Returns the Boolean value
true([returns])
| true()
true
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
LoopingUsed within expressions to perform operations that call a rule or function for each item in an array. |
a!forEach() | Evaluates an expression for each item in a list and returns a new array of the results.
a!forEach([items], [expression])
| a!forEach(items: {1, 2, 3}, expression: fv!item + 10)
{11, 12, 13}
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
all() | Calls a rule or function that returns either true or false for each item in list, asks the question, "Do all items in this list yield true for this rule/function?", and returns true if all items in list evaluates to true.
all([predicate], [list], [context])
| all(fn!isnull, {10, null, 30})
false
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
any() | Calls a rule or function that returns either true or false for each item in list by asking the question, "Do any items in this list yield true for this rule/function?" with the intent to discover if any item(s) yield true.
any([predicate], [list], [context])
| any(fn!isnull, {10, null, 30})
true
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
apply()
Replaced by a!forEach()
|
Calls a rule or function for each item in a list, and provides any contexts specified.
apply([function], [list], [context])
| apply(fn!sum, {-1, 2, 3}, 2)
{1, 4, 5}
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
filter() | Calls a predicate for each item in a list and returns any items for which the returned value is true.
filter([predicate], [list], [context])
| filter(fn!isleapyear, {2015, 2016, 2017})
{2016}
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
merge() | Takes a variable number of lists and merges them into a single list (or a list of lists) that is the size of the largest list provided.
merge([list])
| merge({10, 20}, {30, 40})
{{10, 30}, {20, 40}}
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
none() | Calls a rule or function that returns either true or false for each item in list by asking the question, "Do all items in this list yield false for this rule/function?" with the intent to discover if no items will yield true.
none([predicate], [list], [context])
| none(fn!isnull, {1, null, 3})
false
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
reduce() | Calls a rule or function for each item in a list, passing the result of each call to the next one, and returns the value of the last computation.
reduce([function], [initial], [list], [context])
| reduce(fn!sum, 1, {2, 3, 4})
10
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
reject() | Calls a predicate for each item in a list, rejects any items for which the returned value is true, and returns all remaining items.
reject([predicate], [list], [context])
| reject(fn!isnull, {1, null, 3})
{1, 3}
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
MathematicalUsed within expressions to perform mathematical operations. |
a!distanceBetween() | Returns the distance between the two locations (in meters) specified by the start and end coordinates. The distance is calculated by tracing a line between the two locations that follows the curvature of the Earth, and measuring the length of the resulting arc.
a!distanceBetween([startLatitude], [startLongitude], [endLatitude], [endLongitude])
| a!distanceBetween(startLatitude: 38.932290, startLongitude: -77.218490, endLatitude: 38.963058, endLongitude: -77.363701)
13015.34
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
abs() | Returns the absolute value(s) of the specified number(s).
abs([number])
| abs(-1)
1
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
ceiling() | Rounds the number up to the nearest multiple of the specified significance.
ceiling([number], [significance])
| ceiling(1.6)
2
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
combin() | Calculates the number of unique ways to choose m elements from a pool of n elements.
combin([n], [m])
| combin(4, 2)
6
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
e() | Returns the value of e.
e([])
| e()
2.718282
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
enumerate() | Returns a list of integer numbers from 0 through n-1.
enumerate([n])
| enumerate(5)
0, 1, 2, 3, 4
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
even() | Rounds positive numbers up to nearest even integer and negative numbers down to the nearest even integer.
even([number])
| even(5)
6
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
exp() | Returns e raised to the specified power.
exp([power])
| exp(2)
7.389056
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
fact() | The factorial of specified number.
fact([number])
| fact(4)
24
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
factdouble() | The double factorial of specified number (mathematically n!!).
factdouble([number])
| factdouble(3)
3
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
floor() | Rounds the number down to the nearest multiple of the specified significance.
floor([number], [significance])
| floor(2.8888, .01)
2.88
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
int() | Rounds the specified number down to the nearest integer.
int([number])
| int(2.8888)
2
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
ln() | Returns the natural logarithm of the specified number, which is the power that e must be raised to in order to equal the specified number.
ln([number])
| ln(e())
1
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
log() | Returns the logarithm of the number using the specified base, which is the power that base must be raised to, to equal the number.
log([number], [base])
| log(25, 5)
2
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
mod() | Returns the remainder of dividend when divided by the divisor.
mod([dividend], [divisor])
| mod(40, 15)
10
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
mround() | Rounds the number to the specified multiple.
mround([number], [multiple])
| mround(2.8888, .01)
2.89
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
multinomial() | Adds the specified integers and divides the factorial of the sum by the factorial of the individual numbers.
multinomial([integer])
| multinomial(1, 2, 3)
60
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
odd() | Rounds positive numbers up to nearest odd integer and negative numbers down to the nearest odd integer.
odd([number])
| odd(10)
11
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
pi() | Returns the value of pi.
pi([])
| pi()
3.141593
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
power() | Returns the base number raised to the specified exponent.
power([base], [exponent])
| power(10, 2)
100
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
product() | Returns the product of the specified numbers.
product([factor])
| product(10, 2)
20
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
quotient() | Returns the quotient when numerator is divided by the denominator, and drops the remainder.
quotient([numerator], [denominator])
| quotient(20, 10)
2
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
rand() | Returns a random number between 0 and 1 based on an even probability distribution, which is seeded by the transaction time.
rand([count])
| rand()
0.4506349
|
+portal+om-crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
round() | Rounds off the number to the specified number of digits.
round([number], [num_digits])
| round(2.8888, 2)
2.89
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
rounddown() | Rounds the number down to the specified digit.
rounddown([number], [num_digits])
| round(2.8888, 2)
2.88
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
roundup() | Rounds the number up to the specified digit.
roundup([number], [num_digits])
| round(2.8888, 2)
2.89
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
sign() | Returns the number divided by its absolute value, which is 1 if the number is positive and -1 if the number is negative.
sign([number])
| sign(-10)
-1
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
sqrt() | Returns the square root(s) of the specified number(s).
sqrt([number])
| sqrt(25)
5
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
sqrtpi() | Multiplies the number by pi, then returns the square root of the product.
sqrtpi([number])
| sqrtpi(25 / pi())
5
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
sum() | Returns the sum of the specified numbers.
sum([addend])
| sum(1, 2, 3)
6
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
sumsq() | Squares each number and then returns the sum of the squares.
sumsq([number])
| sumsq(2,3)
13
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
trunc() | Truncates a decimal number to the specified number of places after the decimal point.
trunc([value], [numberOfDecimals])
| trunc(2.8888, 3)
2.888
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
PeopleUsed to perform evaluations and operations on users and groups. |
a!doesGroupExist() | Verifies whether a group with the specified group ID already exists in the environment.
a!doesGroupExist([groupId])
| a!doesGroupExist(6)
true
|
~portal+om-crf-rcrf-pr-pe
Partially compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!groupMembers() | Returns a DataSubset of group members of a given group.
a!groupMembers([group], [direct], [memberType], [pagingInfo])
| Click on the function name for examples. |
~portal+om-crf-rcrf-pr-pe
Partially compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!groupsByName() | Returns an array of groups with the given name, or an empty array if no group exists.
a!groupsByName([groupName])
| a!groupsByName("Case Viewers - " & ri!cvId)
{"Group:7"=>nil}
|
~portal+om-crf-rcrf-pr-pe
Partially compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!groupsByType() | Returns a DataSubset of the groups of a given group type.
a!groupsByType([groupType], [pagingInfo])
| Click on the function name for examples. |
~portal+om-crf-rcrf-pr-pe
Partially compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!groupsForUser() | Returns the groups where the user is a member or has Administrator permissions.
a!groupsForUser([username], [isGroupAdministrator], [groupTypes])
| a!groupsForUser(
username: "jane.doe"
)
{"7 - Group A (Group)"=>nil, "8 - Group B (Group)"=>nil}
|
~portal+om-crf-rcrf-pr-pe
Partially compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!isUserMemberOfGroup() | Identifies whether or not a user is a member of the specified groups. By default, this function returns true if the user is in at least one of the specified groups.
a!isUserMemberOfGroup([username], [groups], [matchAllGroups])
| a!isUserMemberOfGroup("john.doe", 2)
false
|
~portal+om-crf-rcrf-pr-pe
Partially compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
getdistinctusers() | Retrieves users from a set of users and groups.
getdistinctusers([peopleArray])
| getdistinctusers(topeople(cons!MY_GROUP))
{test.user1, test.user2}
|
~portal~om-crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
getgroupattribute() | Retrieves the value of the specified group attribute for the given group.
getgroupattribute([group], [attribute])
| getgroupattribute(cons!MY_GROUP, "created")
12/16/05 6:37 PM GMT
|
~portal~om-crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
group() | Returns information for group.
group([groupId], [property])
| group(2, "created")
12/16/05 6:37 PM GMT
|
~portal~om-crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
isusernametaken() | Verifies whether a user account with the specified username is already present.
isusernametaken([username])
| isusernametaken("john.doe")
true
|
~portal~om-crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
loggedInUser() | Returns the current user logged in to the application.
loggedInUser([])
| loggedInUser()
current.user
|
~portal+om-crf-rcrf+pr+pe
Partially compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
supervisor() | Returns the supervisor of the user if they have one.
supervisor([userinfo])
| supervisor("john.doe")
jane.smith
|
~portal~om-crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
togroup() | Converts a value to Group.
togroup([value])
| togroup(1)
[Group:1]
|
+portal+om-crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
topeople() | Converts a value to People.
topeople([value])
| topeople(1, "john.doe")
{[Group:1], john.doe}
|
~portal~om-crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
touser() | Converts a value to User.
touser([value])
| touser("john.doe")
john.doe
|
~portal~om-crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
user() | Returns information for a user.
user([username], [property])
| user("jane.smith", "created")
12/20/22 10:36 PM GMT
|
~portal~om-crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
ScriptingUsed within expressions to perform operations on process data and Appian objects. |
a!isNativeMobile() | Returns true if the interface is being viewed within the Appian for Mobile application. Returns false otherwise.
a!isNativeMobile([])
| Click on the function name for examples.
Boolean
|
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!isPageWidth() | Returns true if the interface is being viewed on a page that falls within the specified width ranges. Returns false otherwise. This function checks the width of the content area on the page, which may not be the width of the entire window.
a!isPageWidth([pageWidths])
|
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!urlForPortal() | Returns a URL for a portal page. Edit the page in the portal object to map the rule inputs to URL parameters, set default values, or opt out of encrypting URL parameters for the page.
a!urlForPortal([portalPage], [urlParameters])
| Click on the function name for examples. |
+portal-om-crf-rcrf-pr-pe
Compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!urlForRecord() | Returns the URL for one or more records in a site page or Tempo. Can also return the URL for a record list in Tempo.
a!urlForRecord([recordType], [targetLocation], [identifier], [view])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!urlForSite() | Returns a URL for a site page. If the page uses an Interface for the Type, you can optionally use URL parameters to pass values into it. These can be configured in the site object.
a!urlForSite([sitePage], [urlParameters])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!urlForTask() | This function returns the URL of a process task given the task ID.
a!urlForTask([taskIds], [returnTaskPathOnly])
| a!urlForTask(taskIds: 12345, returnTaskPathOnly: false)
https://<sitename>/suite/tempo/tasks/task/<task_path>
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
averagetaskcompletiontimeforprocessmodel() | Returns the average elapsed time in days between task assignment and task completion for all assigned, accepted, and completed tasks in all processes started from a given process model.
averagetaskcompletiontimeforprocessmodel([Id], [includeSubProcessData])
| averagetaskcompletiontimeforprocessmodel(4)
0.6979317434217448
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
averagetasklagtimeforprocessmodel() | Returns the average elapsed time in days between task assignment and task acceptance for all assigned, accepted, and completed tasks in processes for the specified process model.
averagetasklagtimeforprocessmodel([Id], [includeSubProcessData])
| averagetasklagtimeforprocessmodel(4)
0.4155682319223637
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
averagetaskworktimeforprocessmodel() | Returns the average elapsed time in days between task acceptance and task completion for all accepted and completed tasks in processes for this process model.
averagetaskworktimeforprocessmodel([Id], [includeSubProcessData])
| averagetaskworktimeforprocessmodel(processModelId)
0.00003523892184732956
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
community() | Returns the properties of a given community.
community([communityId], [property])
| community(1, "numberOfDocuments")
40
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
datetext() | Interprets the date or datetime specified in the user's preferred calendar and returns its string representation using given format.
datetext([value], [format])
| datetext(userdatevalue("8/18/1427"), "yyyy/MM/dd")
1427/8/18
|
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
document() | Returns property information for a document.
document([documentId], [property])
| document(101, "expirationDate")
12/21/05 2:28 PM GMT
|
+portal~om-crf-rcrf-pr-pe
Compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
folder() | Returns a property of the requested folder.
folder([folderId], [property])
| folder(54, "knowledgeCenterName")
System Knowledge Center
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
isInDaylightSavingTime() | Returns whether the given date and timezone are in daylight saving time.
isInDaylightSavingTime([date], [timezone])
| isInDaylightSavingTime(date(2005,12,13), "America/Los_Angeles")
false
|
~portal+om-crf-rcrf-pr-pe
Partially compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
knowledgecenter() | Returns the properties of a knowledge center.
knowledgecenter([knowledgeCenterId], [property])
| knowledgecenter(2, "name")
System Knowledge Center
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
numontimeprocessesforprocessmodel() | This function eturns the number of active and completed processes of the specified process model that are on time (not past the deadline).
numontimeprocessesforprocessmodel([processModelId], [includeSubProcessData])
| numontimeprocessesforprocessmodel(processModelId, true)
38
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
numontimetasksforprocessmodel() | Returns the number of tasks in process instances of the specified process model that are currently on time (if the task is still active) or were completed on time.
numontimetasksforprocessmodel([processModelId], [includeSubProcessData])
| numontimetasksforprocessmodel(processModelId, true)
147
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
numoverdueprocessesforprocessmodel() | Returns the number of active and completed processes for the specified process model, which are past the deadline.
numoverdueprocessesforprocessmodel([processModelId], [includeSubProcessData])
| numoverdueprocessesforprocessmodel(processModelId)
1
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
numoverduetasksforprocessmodel() | Returns the number of tasks in both active and completed process instances of the specified process model, which are currently overdue (if the task is still active) or were completed past their deadline.
numoverduetasksforprocessmodel([processModelId], [includeSubProcessData])
| numoverduetasksforprocessmodel(processModelId)
10
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
numprocessesforprocessmodelforstatus() | Counts and returns the number of process instances with the specified status for the process model.
numprocessesforprocessmodelforstatus([processModelId], [status], [includeSubProcessData])
| numprocessesforprocessmodelforstatus(processModelId, "completed")
38
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
numtasksforprocessmodelforstatus() | Returns the number of tasks with the specified status in process instances of the process model.
numtasksforprocessmodelforstatus([processModelId], [status], [includeSubProcessData])
| numtasksforprocessmodelforstatus(processModelId, "completed", true)
112
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
offsetFromGMT() | Returns the offset (in minutes) from GMT of the given date and timezone.
offsetFromGMT([date], [timezone])
| offsetFromGMT(date(2005,12,13), "America/Los_Angeles")
-480
|
~portal+om+crf-rcrf-pr-pe
Partially compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
property() | This function extracts a bean's property under a given key name (the
property([bean], [nameOfProperty], [valueIfMissing])
| property(msg!properties, "name", "no name was sent")
no name was sent
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
repeat() | This function takes an input of Any Type and returns a list with the input repeated a specified number of times.
repeat([times], [input])
| repeat(2, "strawberry")
{"strawberry", "strawberry"}
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
todatasubset() | The function takes an array of values as well as optional paging/sorting configurations and returns a DataSubset value with a subset of the array in a specified sort order and the total count of items in the initial array.
todatasubset([arrayToPage], [pagingConfiguration])
| todatasubset({1, 2, 3})
[startIndex=1, batchSize=-1, sort=, totalCount=3, data=1; 2; 3, identifiers=1; 2; 3]
|
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
topaginginfo() | Returns a PagingInfo value for use with the
topaginginfo([startIndex], [batchSize])
| topaginginfo(1, 25)
[startIndex=1, batchSize=25]
|
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
torecord() | Converts XML to a value of the given data type.
torecord([xml], [type])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
toxml() | Converts a value to its equivalent XML form.
toxml([value], [format], [name], [namespace])
| Click on the function name to see examples.
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
urlwithparameters() | This function allows you to build a URL from an expression, using arrays of process and constant data.
urlwithparameters([path], [parameterNames], [parameterValues])
| urlwithparameters("https://example.com", { "a", "b" }, { 1, 2 })
https://example.com?a=1&b=2
|
+portal~om-crf-rcrf-pr-pe
Compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
userdate() | Identifies the date represented by year, month, and day and then interprets it in the user preferred calendar, converting it into a serial number.
userdate([year], [month], [day])
| datetext(userdate(1427, 8, 18), "mm/dd/yyyy")
8/18/1427
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
userdatetime() | Interprets the given date and time in the user preferred calendar and converts it into a serial number.
userdatetime([year], [month], [day], [hour], [minute], [second])
| datetext(userdatetime(1427, 8, 18, 1, 2, 0))
08/18/1427 01:02 AM
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
userdatevalue() | Interprets the given date in the user preferred calendar and converts it into an equivalent serial number.
userdatevalue([date_text])
| datetext(userdatevalue("8/18/1427"), "yyyy/MM/dd") returns
38
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
userday() | Returns the day of the month from the date or datetime specified in the user preferred calendar.
userday([date])
| userday(11/31/2007)
31
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
userdayofyear() | Returns the number of day within in a specified date/datetime.
userdayofyear([date])
| userdayofyear(2/28/2006)
58
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
userdaysinmonth() | Interprets the year/month specified in the user preferred calendar and returns the number of days in a that month.
userdaysinmonth([month], [year])
| userdaysinmonth(04, 2006)
30
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
useredate() | Returns the date that is the number of months before or after the given starting date in the user preferred calendar.
useredate([start_date], [months])
| useredate(11/20/2006, -6)
05/20/2006
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
usereomonth() | Returns the date for the last day of the month that is the number of months before or after the given starting date in the user preferred calendar.
usereomonth([starting_date], [months])
| usereomonth(11/27/06, -6)
5/31/06
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
userisleapyear() | This functions lets you know if a given year is a leap year in the user preferred calendar.
userisleapyear([year])
| userisleapyear(2021)
false
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
userlocale() | Returns the preferred locale of the given user or the site primary locale if the user doesn't have a preference set.
userlocale([user])
| userlocale("john.doe")
en_US
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
usermonth() | Returns the month from the specified date or datetime in the user preferred calendar.
usermonth([date])
| usermonth(11/20/2006)
11
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
usertimezone() | Returns the site primary timezone if the application is configured to override user preferences; otherwise it returns the preferred timezone of the given user or the site primary timezone if the user doesn't have a preference set.
usertimezone([user])
| usertimezone(loggedinuser())
GMT
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
userweekday() | Returns the day of the week of the specified date or datetime in the user preferred calendar.
userweekday([date], [return_type])
| userweekday(07/10/2006, 1)
1
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
userweeknum() | Returns the week number within the year for the given date or datetime in the user preferred calendar, using a given methodology.
userweeknum([date], [methodology])
| userweeknum(02/06/2018, 1)
6
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
useryear() | Returns the year from the date or datetime specified in the user preferred calendar.
useryear([date])
| useryear(11/20/2018)
2018
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
webservicequery() | Invokes a web service configured by a WsConfig object with the supplied input data.
webservicequery([config], [data])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
webservicewrite() | Returns a Writer that can be used as the setter of a variable created using the bind() function.
webservicewrite([config], [data])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
xpathdocument() | This function finds information in an XML document stored in Appian's document management system.
xpathdocument([docId], [expression], [prefix])
| xpathdocument(cons!my_xml_document, "//temp/text()") & " degrees today"
Collab
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
xpathsnippet() | This function finds information in an XML document provided as Text.
xpathsnippet([snippet], [expression], [prefix])
| xpathsnippet("<weather><temp>72.3</temp><sky>Cloudy</sky></weather>", "//temp/text()") & " degrees today"
72.3 degrees today
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
Smart ServiceUsed within an interface component or Web API to execute a particular Appian Smart Service. |
Communication |
a!sendPushNotification() | The Send Push Notification smart service is used to send notifications to one or more Appian for Mobile Devices application users
a!sendPushNotification([recipients], [title], [body], [link], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
Data Services |
a!deleteFromDataStoreEntities() | The Delete from Data Store Entities Smart Service lets you delete data in multiple data store entities within the same data store based on your input.
a!deleteFromDataStoreEntities([dataToDelete], [deletionComment], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!deleteRecords() | The Delete Records smart service is a powerful tool that allows you to easily delete data from the source system and then automatically sync the changes in Appian.
a!deleteRecords([records], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!executeStoredProcedureOnSave() | The Execute Stored Procedure smart service lets you execute a stored procedure that is defined on any of the Appian supported relational databases that you have connected to.
a!executeStoredProcedureOnSave([dataSource], [procedureName], [inputs], [timeout], [autoCommit], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!syncRecords() | The Sync Records smart service allows you to sync a record or set of records in the specified record type.
a!syncRecords([recordType], [identifiers], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!writeRecords() | The Write Records smart service is a powerful tool that allows you to easily insert or update data in your source system and then automatically sync those changes in Appian.
a!writeRecords([records], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!writeToDataStoreEntity() | The Write to Data Store Entity Smart Service adds process data to an entity in a Data Store.
a!writeToDataStoreEntity([dataStoreEntity], [valueToStore], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!writeToMultipleDataStoreEntities() | The Write to Multiple Data Store Entities Smart Service writes multiple CDT values to multiple entities within the same data store based on your input.
a!writeToMultipleDataStoreEntities([valuesToStore], [onSuccess], [onError])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
Document Generation |
a!exportDataStoreEntityToCsv() | The Export Data Store Entity to CSV Smart Service allows designers to safely export large datasets.
a!exportDataStoreEntityToCsv([entity], [selection], [aggregation], [filters], [documentName], [documentDescription], [saveInFolder], [documentToUpdate], [includeHeader], [csvDelimiter], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!exportDataStoreEntityToExcel() | The Export Data Store Entity to Excel Smart Service allows designers to safely export large datasets.
a!exportDataStoreEntityToExcel([entity], [selection], [aggregation], [filters], [documentName], [documentDescription], [saveInFolder], [documentToUpdate], [includeHeader], [sheetName], [sheetNumber], [startingCell], [customCellPositions], [customCellValues], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!exportProcessReportToCsv() | The Export Process Reports to CSV Smart Service allows designers to safely export large datasets.
a!exportProcessReportToCsv([report], [filters], [context], [documentName], [documentDescription], [saveInFolder], [documentToUpdate], [includeHeader], [csvDelimiter], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!exportProcessReportToExcel() | The Export Process Report to Excel Smart Service allows designers to safely export large amounts of data from process reports.
a!exportProcessReportToExcel([report], [filters], [context], [documentName], [documentDescription], [saveInFolder], [documentToUpdate], [includeHeader], [sheetName], [sheetNumber], [startingCell], [customCellPositions], [customCellValues], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
Document Management |
a!createFolder() | The Create Folder smart service allows you to create a folder to store files within the Appian file system.
a!createFolder([name], [parentFolder], [parentKnowledgeCenter], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!createKnowledgeCenter() | A knowledge center is a second-level container in Appian Document Management (below Communities).
a!createKnowledgeCenter([name], [description], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!deleteDocument() | The Delete Document node allows you to select a document and then completely remove it from a Knowledge Center or Folder, as well as the server file system.
a!deleteDocument([document], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!deleteFolder() | The Delete Folder node allows you to select a folder and then completely remove it from the system, along with its sub-folders.
a!deleteFolder([folder], [deleteSubfolders], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!deleteKnowledgeCenter() | The Delete KC node allows you to select a Knowledge Center and then completely remove it from the system, along with any child folders.
a!deleteKnowledgeCenter([knowledgeCenter], [deleteSubfolders], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!editDocumentProperties() | The Edit Document Properties node allows you to update the name and description of a selected document.
a!editDocumentProperties([document], [name], [description], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!editFolderProperties() | The Rename Folder node allows you to select a folder and rename it.
a!editFolderProperties([folder], [name], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!editKnowledgeCenterProperties() | The Edit KC node lets you update the name, description and/or expiration date of a selected Knowledge Center.
a!editKnowledgeCenterProperties([knowledgeCenter], [name], [description], [expirationDays], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!lockDocument() | The Lock Document node allows you to select and check out a document so that no one else can upload a new version until it has been unlocked.
a!lockDocument([document], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!modifyFolderSecurity() | The Modify Folder Security smart service allows you to select a user to be added to a specified folder as a reader, author, and/or administrator.
a!modifyFolderSecurity([folder], [readers], [authors], [administrators], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!modifyKnowledgeCenterSecurity() | The Modify KC Security node allows you to select users and groups to be added to a Knowledge Center with one of a specific set of security roles.
a!modifyKnowledgeCenterSecurity([knowledgeCenter], [readers], [authors], [administrators], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!moveDocument() | The Move Document smart service allows you to select a document and move it to a new folder or a new Knowledge Center.
a!moveDocument([document], [destination], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!moveFolder() | The Move Folder node allows you to select a folder and move it to a new Knowledge Center or folder (which must already exist).
a!moveFolder([folder], [destinationFolder], [destinationKC], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!unlockDocument() | The Unlock Document node allows you to select a document that has previously been locked and alter the settings so that it becomes accessible.
a!unlockDocument([document], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
Identity Management |
a!addAdminsToGroup() | The Add Group Admins node allows you to give users the right to be the administrator of a group.
a!addAdminsToGroup([group], [newAdministrators], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!addMembersToGroup() | The Add Group Members smart service allows you to add a user (or users) to a group as a step in your process.
a!addMembersToGroup([group], [newMembers], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!createGroup() | The Create Group smart service allows you to add new groups at runtime via process model.
a!createGroup([name], [description], [groupType], [delegatedCreation], [parent], [membershipPolicy], [securityType], [groupPrivacy], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!createUser() | The Create User Node allows you to create new users on the system while executing your process application.
a!createUser([username], [firstName], [nickname], [middleName], [lastName], [email], [sendAccountCreationEmail], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!deactivateUser() | The Deactivate User smart service allows you to select an existing user and disable them from the system.
a!deactivateUser([user], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!deleteGroup() | The Delete Group smart service allows you to select a group and remove it from the system.
a!deleteGroup([group], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!editGroup() | The Edit Group smart service allows you to select a group and update any of its available fields, including its name, description, and parent group.
a!editGroup([group], [name], [description], [delegatedCreation], [parent], [membershipPolicy], [securityType], [groupPrivacy], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!modifyUserSecurity() | This smart service allows you to overwrite a specific user's entire role map with different users and groups.
a!modifyUserSecurity([group], [administrators], [editors], [viewers], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!reactivateUser() | The Reactivate User smart service allows you to select a user whose access to the system was previously disabled and re-enable the user account.
a!reactivateUser([user], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!removeGroupAdmins() | The Remove Group Admins node allows you to select one or more users within a group who have administrative rights over the group, and remove those rights.
a!removeGroupAdmins([group], [administratorsToRemove], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!removeGroupMembers() | The Remove Group Members node allows you to select a user within a group, and remove that user from the group.
a!removeGroupMembers([group], [members], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!renameUsers() | The Rename Users Node allows you to rename existing users on the system while executing your process application.
a!renameUsers([oldUsernames], [newUsernames], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!setGroupAttributes() | The Set Group Attributes smart service allows you to modify attribute values for the selected group.
a!setGroupAttributes([group], [attributes], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!updateUserProfile() | The Update User Profile Service Node allows you to update a selected user's personal data, including their name, address, phone number, supervisor and title.
a!updateUserProfile([group], [overwriteAllFields], [firstName], [middleName], [lastName], [nickname], [supervisor], [title], [email], [officePhone], [mobilePhone], [homePhone], [address1], [address2], [address3], [city], [state], [province], [zipCode], [country], [locale], [timeZone], [calendar], [customField1], [customField2], [customField3], [customField4], [customField5], [customField6], [customField7], [customField8], [customField9], [customField10], [onSuccess], [onError*])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!updateUserType() | The Change User Type Smart Service allows you to select a user and change the user's type from a Basic User to a System Administrator or from a System Administrator back to a Basic User.
a!updateUserType([user], [newUserType], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
Process Management |
a!cancelProcess() | The Cancel Process Smart Service allows you to halt all process flow and cancel all tasks associated with a process.
a!cancelProcess([processId], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!completeTask() | The Complete Task Smart Service allows you to complete a task belonging to another process from your current process.
a!completeTask([taskId], [taskInputs], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!startProcess() | The Start Process Smart Service allows you to initiate a process from another process, a web API, or an interface.
a!startProcess([processModel], [processParameters], [onSuccess], [onError])
| Click on the function name for examples. |
+portal-om-crf-rcrf-pr-pe
Compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
Testing |
a!startRuleTestsAll() | Executes test cases configured for all expression rules within an Appian system from web APIs and Interfaces
a!startRuleTestsAll([onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!startRuleTestsApplications() | Executes the test cases configured for all expression rules in the specified Appian application(s) from web APIs and interfaces.
a!startRuleTestsApplications([applications], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!testRunResultForId() | Provided a test-run ID, this function returns a TestRunResult data type containing the results of a rule test run. If the status of the test is IN PROGRESS, TestRunResult will contain only results for completed tests; if the status is COMPLETE, TestRunResult contains all test results.
a!testRunResultForId([testRunId])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!testRunStatusForId() | Provided a test-run ID, this function queries for the status of an expression rule test run.
a!testRunStatusForId([testRunId])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
StatisticalUsed within expressions to perform statistical operations. |
avedev() | Returns the average deviation of the specified number(s).
avedev([number])
| avedev(1, 2, 3, 4)
1
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
average() | Returns the average of the specified number(s).
average([number])
| average(1, 2, 3, 4)
2.5
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
count() | Returns the number items in all arrays passed to the function.
count([value])
| count({1, 2, 3, 4})
4
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
frequency() | Uses the bin array to create groups bounded by the elements of the array.
frequency([data_array], [bins_array])
| frequency({64, 74, 75, 84, 85, 86, 95}, {70, 79, 89})
{1, 2, 3, 1}
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
gcd() | Returns the greatest common denominator of the specified non-negative number(s), which is the largest number that divides all the given numbers without a remainder.
gcd([number])
| gcd(4, 12, 36)
4
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
geomean() | Returns the geometric mean of the specified number(s).
geomean([number])
| geomean(4, 9)
6
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
harmean() | Returns the harmonic mean of the specified number(s), which is the number of terms divided by the sum of the terms' reciprocals.
harmean([number])
| harmean(1, 2, 3)
1.636364
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
lcm() | Returns the least common multiple of the specified non-negative number(s), which is the smallest number that is a multiple of all the given numbers.
lcm([number])
| lcm(5,10,15)
30
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
lookup() | Returns location of data within multiple values, or valueIfNotPresent.
lookup([multipleValues], [dataToLookup], [valueIfNotPresent])
| lookup({"a", "b", "c", "d"}, "c", -1)
3
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
max() | Returns the maximum of the specified number(s).
max([number])
| max(1, 2, 3, 4)
4
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
median() | Returns the median of the specified number(s).
median([number])
| median(1, 2, 3, 4)
2.5
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
min() | Returns the minimum of the specified number(s).
min([number])
| min(1, 2, 3, 4)
1
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
mode() | Returns the mode of the specified number(s), which is the most commonly repeated element.
mode([number])
| mode(1, 2, 2, 3, 3, 3, 4)
3
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
rank() | Returns an integer representing the rank of the number in the specified array.
rank([number], [array], [order])
| rank(2, {1, 2, 3, 4}, false)
3
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
stdev() | Returns the standard deviation of the specified number(s).
stdev([number])
| stdev(1, 2, 3, 4)
1.290994
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
stdevp() | Returns the standard deviation of the specified number(s), assuming that the numbers form the entire data set and not just a sample.
stdevp([number])
| stdevp(1, 2, 3, 4)
1.118034
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
var() | Returns the variance of the specified number(s).
var([number])
| var(1, 2, 3, 4)
1.666667
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
varp() | Returns the variance of the specified number(s), assuming that the numbers form the entire data set and not just a sample.
varp([number])
| varp(1, 2, 3, 4)
1.25
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
SystemUsed within expressions to perform platform operations and data transformations |
a!aggregationFields() | Used to define a query against record data that performs an aggregation in
a!aggregationFields([groupings], [measures])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!applyComponents()
Replaced by a!forEach()
|
Calls a rule or function for each item in a list and supports the preservation of the local state on interfaces.
a!applyComponents([function], [array], [arrayVariable])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!dataSubset() | Creates a value of type DataSubset for defining the source of expression-backed records and for use with
a!dataSubset([startIndex], [batchSize], [sort], [totalCount], [data], [identifiers])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!deployment() | Returns a specific property of direct and external deployments.
a!deployment([deploymentUuid], [property])
| `deployment(101, "reviewedDate")`
`12/21/05 2:28 PM GMT`
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!entityData() | Creates an Entity Data for use with a!writeToMultipleDataStoreEntities()
a!entityData([entity], [data])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!entityDataIdentifiers() | Creates an EntityDataIdentifiers configuration for use with a!deleteFromDataStoreEntities().
a!entityDataIdentifiers([entity], [identifiers])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!executeStoredProcedureForQuery() | Executes a stored procedure in a database. Since this function could run more than once, do not use it with stored procedures that modify data to avoid unintentional changes.
a!executeStoredProcedureForQuery([dataSource], [procedureName], [inputs], [timeout], [autoCommit])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!fromJson() | Converts a JSON string into an Appian value.
a!fromJson([jsonText])
| a!fromJson("{""name"":""John Smith"", ""age"":49, ""likes"":[""green"",""dogs"",""long walks""]}")
[name:John Smith,age:49,likes:green; dogs; long walks]
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!getDataSourceForPlugin() | Provides capability for plug-ins to connect to Data Source Connected Systems and apply corresponding role map security configurations.
a!getDataSourceForPlugin([dataSourceConnectedSystem])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!httpResponse() | Returns an HTTP Response object for use in a Web API.
a!httpResponse([statusCode], [headers], [body])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!iconIndicator() | Returns the specified image from a list of standard indicator icons. Indicator icons can be used on interface within a document image.
a!iconIndicator([icon])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!iconNewsEvent() | Returns the specified image from a list of standard news event icons in one of six colors: blue, green, gray, orange, purple, or red.
a!iconNewsEvent([icon], [color])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!integrationError() | Creates an integration error value. Use when configuring custom error handling for integration objects.
a!integrationError([title], [message], [detail])
| Click on the function name for examples.
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!jsonPath() | Finds information in a JSON string. JSONPath is used to navigate through elements and attributes in a JSON string.
a!jsonPath([value], [expression])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!latestHealthCheck() | Returns the start time, run status, zip file, and report for the latest Health Check run.
a!latestHealthCheck([])
| a!latestHealthCheck()
[startDateTime=04/25/2020 16:18:38 GMT+00:00, runStatus=COMPLETED, zip=[Document:1408], report=[Document:1409]]
|
~portal+om-crf-rcrf-pr-pe
Partially compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!listViewItem() | Creates a value of type ListViewItem for use with record type definitions.
a!listViewItem([title], [details], [image], [timestamp])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!map() | Creates a map of values (Any Type) with each value stored at the corresponding string key. Values stored in maps are not wrapped in variants.
a!map([key1], [keyN])
| a!map(id: 1, name: "Jane Doe")
a!map(id: 1, name: "Jane Doe")
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!pagingInfo() | Creates a value of type PagingInfo for use with grids, queries, and
a!pagingInfo([startIndex], [batchSize], [sort])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!query() | Creates a
a!query([selection], [aggregation], [logicalExpression], [filter], [pagingInfo])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!queryAggregation() | Creates an
a!queryAggregation([aggregationColumns])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!queryAggregationColumn() | Creates an
a!queryAggregationColumn([field], [alias], [visible], [isGrouping], [aggregationFunction], [groupingFunction])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!queryColumn() | Creates a
a!queryColumn([field], [alias], [visible])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!queryEntity() | Executes a query on a given data store entity and returns the result.
a!queryEntity([entity], [query], [fetchTotalCount])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!queryFilter() | Creates a value of type
a!queryFilter([field], [operator], [value], [applyWhen])
| a!queryFilter(field: "name", operator: "=", value: 1)
[field=name, operator==, valueExpression=, value=1]
|
+portal~om-crf-rcrf-pr-pe
Compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!queryLogicalExpression() | Creates a
a!queryLogicalExpression([operator], [logicalExpressions], [filters], [ignoreFiltersWithEmptyValues])
| Click on the function name for examples. |
+portal~om-crf-rcrf-pr-pe
Compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!queryProcessAnalytics() | Executes process reports and returns the resulting data.
a!queryProcessAnalytics([report], [query], [contextGroups], [contextProcessIds], [contextProcessModels], [contextUsers])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!queryRecordByIdentifier() | Executes a query on a given record identifier and returns the record data.
a!queryRecordByIdentifier([recordType], [identifier], [fields], [relatedRecordData])
| Click on the function name for examples. |
+portal~om-crf-rcrf-pr-pe
Compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!queryRecordType() | Executes a query on a given record type and returns the result.
a!queryRecordType([recordType], [fields], [filters], [pagingInfo], [fetchTotalCount], [relatedRecordData])
| Click on the function name for examples. |
+portal~om-crf-rcrf-pr-pe
Compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!querySelection() | Returns a
a!querySelection([columns])
| a!querySelection(columns: a!queryColumn(field: "name"))
[columns=[field=name, alias=name, visible=true]]
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!recordData() | This function references a set of records from a record type and allows additional filtering in a read-only grid, chart, or selection component that uses a record type as the source. When referencing one-to-many relationships in grid columns, you can filter, sort, and limit that related record set using the relatedRecordData parameter and the
a!recordData([recordType], [filters], [relatedRecordData], [fields])
| Click on the function name for examples. |
+portal~om-crf-rcrf-pr-pe
Compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!recordFilterChoices() | Creates choices of a user filter for an expression-backed record.
a!recordFilterChoices([choiceLabels], [choiceValues])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!recordFilterDateRange() | Creates a user filter for a record list.
a!recordFilterDateRange([name], [field], [isVisible], [defaultFrom], [defaultTo])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!recordFilterList() | Creates a user filter category for the record list.
a!recordFilterList([name], [options], [defaultOption], [isVisible], [allowMultipleSelections])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!recordFilterListOption() | Creates a filter option for the
a!recordFilterListOption([id], [name], [filter], [dataCount])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!relatedRecordData() | References a one-to-many relationship defined on a record type and allows for additional filtering, sorting, and limiting of the related record set.
a!relatedRecordData([relationship], [limit], [sort], [filters])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sentimentScore() | Returns a list of scores representing the emotional or subjective sentiment expressed in each of the provided text values, ranging from 1.0 (positive) to -1.0 (negative).
a!sentimentScore([text])
| a!sentimentScore({"Hi, I hope you're having a great day"})
{0.79}
|
~portal+om-crf-rcrf-pr-pe
Partially compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sortInfo() | Creates a value of type SortInfo for use with grids and record queries.
a!sortInfo([field], [ascending])
| a!sortInfo(field: "a", ascending: true())
[field=a, ascending=true]
|
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!storedProcedureInput() | Creates an input to be passed to the
a!storedProcedureInput([name], [value])
| a!storedProcedureInput(name: "integer_input", value: 2) |
~portal+om-crf-rcrf-pr-pe
Partially compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!submitUploadedFiles() | To upload files outside of a start form or task, use this function in the saveInto parameter of a submit button or link. This function submits the files uploaded to any file upload or signature components in the interface to their target folder.
a!submitUploadedFiles([onSuccess], [onError], [documents])
| Click on the function name for examples. |
+portal-om-crf-rcrf-pr-pe
Compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!toJson() | Converts a value into a JSON string.
a!toJson([value], [removeNullOrEmptyFields])
| a!toJson(a!pagingInfo(startIndex: 1, batchSize: 10))
{"startIndex":1,"batchSize":10}
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!toRecordIdentifier() | Matches record IDs with their record type to return a value of type Record Identifier for each record ID passed to the function.
a!toRecordIdentifier([recordType], [identifier])
| a!toRecordIdentifier(recordType!<Record Type Name>, 1)
0
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!userRecordFilterList() | Returns the default user filters for the User record type. For use in the User record type only.
a!userRecordFilterList([])
| 0
0
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!userRecordIdentifier() | Returns a value of type Record Identifier for each user passed to the function.
a!userRecordIdentifier([users])
| a!userRecordIdentifier("john.smith")
0
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!userRecordListViewItem() | Returns the default list view item for the User record type. For use on the User record type only.
a!userRecordListViewItem([record])
| 0
0
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
TextUsed within expressions for manipulating text strings of data. |
a!currency() | Localizes a currency value based on the given ISO currency code.
a!currency([isoCode], [value], [decimalPlaces], [showSeparators], [format], [indicatorAlignment])
| a!currency( "USD", 13213.43 )
$13,213.43
|
+portal+om-crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
a!formatPhoneNumber() | Returns a formatted phone number based on the outputFormat parameter. The countryCode parameter, or any country code provided in the phone number, will verify that the phone number is valid. If the phone number does not match any provided country code, the phone number will be returned as invalid and unformatted.
a!formatPhoneNumber([phoneNumber], [countryCode], [outputFormat])
| a!formatPhoneNumber("703 333 3333", "US", "NATIONAL")
(703) 333-3333
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!isPhoneNumber() | Returns true if the phoneNumber parameter contains a valid phone number, otherwise returns false. A phone number is considered valid if its area code is valid, the length is appropriate based upon the value of the countryCode parameter, and the number after the area code is not all zeroes. This function supports countries and area codes for international numbers.
a!isPhoneNumber([phoneNumber], [countryCode])
| a!isPhoneNumber("+1 703 555 5555")
true
|
+portal+om+crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!swissFranc() | Converts the number into a Swiss franc value. Effectively adds a decimal point and an apostrophe for every three digits preceding the decimal. It also adds an optional Swiss franc symbol preceding the value.
a!swissFranc([number], [decimals], [noApostrophes], [showPrefixSymbol])
| a!swissFranc( 3213.43 )
3'213.43
|
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
cents() | Converts a number into its value in cents by effectively appending a cent sign to a fixed representation and one comma for every three digits preceding the decimal.
cents([number], [decimals])
| cents( 123412 )
123,412.00¢
|
+portal+om-crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
char() | Converts a number into its Unicode character equivalent.
char([number])
| char( 65 )
A
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
charat() | Returns the character at given index within specified string.
charat([text], [index])
| charat( "string", 2 )
t
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
clean() | Returns the specified text, minus any characters not considered printable. Printable characters are the 95 printable ASCII characters plus three special characters: BACKSPACE (0x08), TAB (0x09), and NEWLINE (0x0a).
clean([text])
| clean( "Please enter value in £" )
Please enter value in
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
cleanwith() | Returns the specified text, minus any characters not in the list of valid characters.
cleanwith([text], [with])
| cleanwith( "text string", "xte" )
textt
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
code() | Converts the text into Unicode integers.
code([text])
| code( "Convert to Unicode" )
67, 111, 110, 118, 101, 114, 116, 32, 116, 111, 32, 85, 110, 105, 99, 111, 100, 101
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
concat() | Concatenates the specified strings into one string, without a separator.
concat([text])
| concat( {"a", "b", "c"}, {"d", "e", "f"} )
abcdef
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
exact() | Compares two given text strings in a case-sensitive manner, returning true only if they are exactly the same.
exact([text1], [text2])
| exact( "Copy of the other", "Copy of the other" )
true
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
extract() | Returns the value (or values, if the text contains multiple delimited values) between the delimiters from the given text.
extract([text], [startDelimiter], [endDelimiter])
| extract( "name: Bob, name: Karen, name: Sam", ":", "," )
{"Bob", "Karen"}
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
extractanswers() | Returns an array of strings that respond to the questions provided.
extractanswers([questions], [text])
| extractanswers( {"What is your name?", "What is your age?"}, "1. What is your name? Ben 2. What is your age? 47 " )
{"Ben", "47"}
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
find() | Searches the text for a particular substring, returning the positional index of the first character of the first match.
find([search_text], [within_text], [start_num])
| find( "to", "Boston", 1 )
4
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
fixed() | Rounds the specified number off to a certain number of decimals and returns it as text, with optional commas.
fixed([number], [decimals], [no_commas])
| fixed( 7.36819 )
7.37
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
initials() | Returns only the uppercase characters from within the given text.
initials([text])
| initials( "John P. Smith" )
JPS
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
insertkey() | Returns the provided text, wrapped with the specified delimiters.
insertkey([key], [startDelimiter], [endDelimiter])
| insertKey( "hello", "[", "]" )
[hello]
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
insertkeyval() | Returns the provided key-value pairs, wrapped with the specified delimiters.
insertkeyval([key], [value], [startDelimiter], [endDelimiter])
| insertkeyval( {"hello", "goodbye"}, {"alpha", "beta"}, "[", "]")
[hello=alpha][goodbye=beta]
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
insertquestions() | Returns an array of questions with a ==EOQ== at the end, returning a single string that can be parsed with
insertquestions([questions])
| insertquestions({"What is your name?", "What is your age?"})
1. What is your name? 2. What is your age?
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
keyval() | Returns the value(s) associated with the given key(s).
keyval([text], [keys], [separators], [delimiters])
| keyval("[hello=alpha][goodbye=beta]", {"hello"}, "=", "]")
alpha
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
left() | Returns a specified number of characters from the text, starting from the first character.
left([text], [num_chars])
| left("Boston",3)
Bos
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
leftb() | Returns a specified number of bytes from the text, starting from the first byte.
leftb([text], [num_bytes])
| leftb("Boston",3)
Bos
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
len() | Returns the length in characters of the text.
len([text])
| len("Boston")
6
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
lenb() | Returns the length in bytes of the text.
lenb([text])
| lenb("Boston")
6
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
like() | Tests whether a string of text is like a given pattern.
like([text], [with])
| like("brian","*ian")
true
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
lower() | Converts all characters in the text into lowercase (Unicode case folding).
lower([text])
| lower("BOSTON")
boston
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
mid() | Returns a substring from the middle of the specified text.
mid([text], [start_num], [num_chars])
| mid("Boston", 4, 2)
to
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
midb() | Returns a substring from the middle of the specified text.
midb([text], [start_num], [num_bytes])
| midb("Boston", 4, 2)
to
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
padleft() | Pads text with spaces on the left so that it is a certain length.
padleft([text], [length])
| padleft("Boston", 10)
Boston
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
padright() | Pads text with spaces on the right so that it is a certain length.
padright([text], [length])
| padright("Boston", 10)
Boston
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
proper() | Converts each character in the text into proper case, meaning it will capitalize the first first letter of every word and convert the rest into lowercase.
proper([text])
| proper("coNvert eaCH cHaRacter iNTo ProPeR caSe")
Convert Each Character Into Proper Case
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
replace() | Replaces a piece of the specified text with new text.
replace([old_text], [start_num], [num_chars], [new_text])
| replace("oldtext",1,3,"new")
newtext
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
replaceb() | Replaces a piece of the specified text with new text.
replaceb([old_text], [start_num], [num_chars], [new_text])
| replaceb("oldtext",1,3,"new")
newtext
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
rept() | Concatenates the text to itself a specified number of times and returns the result.
rept([text], [repetitions])
| rept("do",3)
dododo
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
resource() | Retrieves a string of translated text appropriate for the current user, according to their language preference, by matching a given key with text.
resource([key])
| resource("city")
ciudad
|
~portal~om+crf-rcrf+pr+pe
Partially compatible
Portals
Partially compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
right() | Returns a specified number of characters from the text, starting from the last character.
right([text], [num_chars])
| right("Boston",3)
ton
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
search() | Searches the text for the given, case insensitive substring. Returns the one-based positional index of the first character of the first match. Returns zero if the substring is not found.
search([search_text], [within_text], [start_num])
| search("to","Boston",1)
4
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
searchb() | Searches the text for a particular substring, returning the positional index of the first byte of the first match.
searchb([search_text], [within_text], [start_num])
| searchb("to","Boston",1)
4
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
soundex() | Returns the soundex code, used to render similar sounding names via phonetic similarities into identical four (4) character codes.
soundex([text])
| soundex("John Smith")
J525
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
split() | Splits text into a list of text elements, delimited by the text specified in the separator.
split([text], [separator])
| split("Smith, John. Smith, Jane",".")
Smith, John; Smith, Jane
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
strip() | Returns the provided text, minus any characters considered printable. Printable characters are the 95 printable ASCII characters plus three special characters: BACKSPACE (0x08), TAB (0x09), and NEWLINE (0x0a).
strip([text])
| strip("this text is stripped")
[empty result]
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
stripHtml() | Changes the provided HTML string into a plain text string by converting
stripHtml([html])
| striphtml("<p>Click <b>Save</b>.</p>")
Click Save.
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
stripwith() | The function returns the provided text, minus any characters on the list of invalid characters.
stripwith([text], [with])
| stripwith("text string","xt")
e sring
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
substitute() | Substitutes a specific part of a string with another string.
substitute([text], [find], [replace_with])
| substitute("hello world","hello","my")
my world
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
text() | The text() function allows you to format Number, Date, Time, or Date and time values as you convert them into text strings.
text([value], [format])
| text(10.25, "$00.0000")
$10.2500
|
+portal+om-crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
toHtml() | Converts a string in plain text to the HTML equivalent that displays appropriately in an HTML page, by replacing reserved characters with their escaped counterparts.
toHtml([text])
| toHtml("Hello <br> World")
Hello <br> World
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
trim() | Removes all unnecessary spaces from the text.
trim([text])
| trim(" this text needs trimming ")
this text needs trimming
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
upper() | Converts all letters in the text into uppercase.
upper([text])
| upper("Boston")
BOSTON
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
value() | Converts text representing a number into an actual number or datetime.
value([text], [separator])
| value("1,2,3",",")
1; 2; 3
|
~portal-om+crf-rcrf+pr+pe
Partially compatible
Portals
Incompatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
TrigonometryUsed within expressions to perform trigonometry operations. |
acos() | Returns the arccosine(s) of the specified number(s) in radians.
acos([number])
| acos(-1)
3.141593
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
acosh() | Returns the hyperbolic arccosine(s) of the specified number(s) in radians.
acosh([number])
| acosh(2)
1.316958
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
asin() | Returns the arcsine(s) of the specified number(s) in radians.
asin([number])
| asin(1)
1.570796
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
asinh() | Returns the hyperbolic arcsine(s) of the specified number(s) in radians.
asinh([number])
| asinh(2)
1.443635
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
atan() | Returns the arctangent(s) of the specified number(s) in radians.
atan([number])
| atan(1)
0.7853982
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
atanh() | Returns the hyperbolic arctangent(s) of the specified number(s) in radians.
atanh([number])
| atanh(.9)
1.472219
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
cos() | Returns the cosine(s) of the specified number(s).
cos([number])
| cos(pi())
-1
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
cosh() | Returns the hyperbolic cosine(s) of the specified number(s).
cosh([number])
| cosh(1)
1.543081
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
degrees() | Converts the measure(s) of the specified angle(s) from radians to degrees.
degrees([angle_in_radians])
| degrees(pi()/2)
90
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
radians() | Converts the measure of the specified angle from degrees to radians.
radians([angle_in_degrees])
| radians(180)
3.141593
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
sin() | Returns the sine(s) of the specified number(s).
sin([number])
| sin(pi()/2)
1
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
sinh() | Returns the hyperbolic sine(s) of the specified number(s).
sinh([number])
| sinh(1)
1.175201
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
tan() | Returns the tangent(s) of the specified number(s).
tan([number])
| tan(pi()/4)
1
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
tanh() | Returns the hyperbolic tangent(s) of the specified number(s).
tanh([number])
| tanh(1)
0.7615942
|
+portal+om+crf-rcrf+pr+pe
Compatible
Portals
Compatible Offline Mobile
Compatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
[Deprecated]These functions have been deprecated and will be removed in a future release of Appian. |
a!buttonWidgetSubmit() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!cmiCopyDocumentFromAppian() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!cmiCopyDocumentToAppian() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!cmiCopyDocumentToAppianFolder() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!cmiCreateFolder() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!cmiDelete() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!cmiGetFolderChildren() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!cmiGetObjectIdByPath() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!cmiGetProperties() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!cmiGetRepoInfo() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!dashboardLayout() [Deprecated] |
a!dashboardLayout([contents], [showWhen])
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!dashboardLayout_17r1() [Deprecated] |
a!dashboardLayout_17r1( [firstColumnContents], [secondColumnContents] )
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!dashboardLayoutColumns() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!dynAssociate() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!dynCreate() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!dynDelete() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!dynDisassociate() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!dynRetrieve() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!dynRetrieveMultiple() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!dynUpdate() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!facet() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!facetOption() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!formLayoutColumns() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!gridImageColumn() [Deprecated] |
a!gridImageColumn([label], [field], [data], [showWhen], [size], [isThumbnail], [style])
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!gridImageColumn_17r3() [Deprecated] |
a!gridImageColumn_17r3( [label], [field], [data], [size] )
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!gridSelection() [Deprecated] |
a!gridSelection([pagingInfo], [Selected])
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!gridTextColumn() [Deprecated] |
a!gridTextColumn([label], [field], [data], [alignment], [links], [showWhen])
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!httpQuery() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!httpWrite() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sapBapiParameters() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sapInvoke() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sapInvokeWriter() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sblCreate() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sblDelete() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sblInvoke() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sblInvokeWriter() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sblQuery() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sblUpdateFieldValue() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sectionLayoutColumns() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sfcDelete() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sfcDescribeGlobal() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sfcDescribeSObjects() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sfcInsert() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sfcQuery() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sfcSearch() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sfcUpdate() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!shpCopyDocumentFromAppian() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!shpCopyDocumentToAppian() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!shpInvoke() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!shpInvokeWriter() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!userRecordFacets() [Deprecated] |
a!userRecordFacets()
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
byReference() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
caladddays() [Deprecated] | This function adds a given number of working days as designated on the process calendar to a Date and Time value, and returns a Date and Time value that falls within the work time defined in the process calendar.
caladddays([start_datetime], [number], [calendar_name])
| caladddays(datetime(2011, 12, 13, 12, 0, 0), 0)
12/13/2011 12:00 PM GMT
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
caladdhours() [Deprecated] | This function adds a given number of hours to a Date and Time plus any non-working hours (as designated on the process calendar) and returns the resulting Date and Time.
caladdhours([start_datetime], [number], [calendar_name])
| caladdhours(datetime(2011, 12, 13, 12, 0, 0), 12)
12/14/2011 4:00 PM GMT
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
dollar() [Deprecated] | Converts a decimal number into a dollar value by effectively adding a dollar sign ($), a decimal point, and optional comma for every three digits preceding the decimal.
dollar([number], [decimals], [no_commas])
| dollar( 13213.43 )
$13,213.43
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
euro() [Deprecated] | Converts a decimal number into a euro value by effectively adding a euro symbol (€), a decimal point, and optional comma for every three digits preceding the decimal.
euro([number], [decimals], [no_commas])
| euro( 13213.43 )
€13,213.43
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
fromHtml() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
getprocessemail() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
getprocessmodelemail() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
isNativePhone() [Deprecated] |
isNativePhone()
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
isNativeTablet() [Deprecated] |
isNativeTablet()
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
linktocommunity() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
linktocommunityinternal() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
linktodocument() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
linktodocumentinternal() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
linktofolder() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
linktofolderinternal() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
linktogroup() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
linktogroupinternal() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
linktoknowledgecenter() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
linktoknowledgecenterinternal() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
linktoprocessdashboard() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
linktoprocessdashboardinternal() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
linktoprocessmodeldashboard() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
linktoprocessmodeldashboardinternal() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
linktouser() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
linktouserinternal() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
message() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
page() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
pound() [Deprecated] | Converts the number into pounds by effectively adding a pound symbol (£), a decimal point, and one comma for every three digits preceding the decimal.
pound([number], [decimals], [no_commas])
| pound(3213.43,2)
£3,213.43
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
queryrecord() [Deprecated] |
queryrecord( recordType, query )
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
thread() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
todiscussionthread() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
toforum() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
tomessage() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
topage() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
toportlet() [Deprecated] |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
yen() [Deprecated] | Converts the number into yen by effectively adding a yen symbol (Â¥), a decimal point, and one comma for every three digits preceding the decimal.
yen([number], [decimals])
| yen(3213.43)
Â¥3,213.43
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
Document Management |
a!docExtractionResult() [Deprecated] | Retrieves results from a doc extraction run started by the Start Doc Extraction Smart Service.
a!docExtractionResult([docExtractionId], [typeNumber], [confidenceThreshold], [isStructuredDoc])
| a!docExtractionResult(docExtractionId:5)
ANYTYPEDATACDT
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!docExtractionStatus() [Deprecated] | Retrieves the status of a doc extraction run started by the Start Doc Extraction Smart Service.
a!docExtractionStatus([docExtractionId])
| a!docExtractionStatus(docExtractionId:5)
IN_PROGRESS
|
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
[Old Versions]These are older functions that have been replaced by newer versions. |
a!barChartField_21r4() | Displays numerical data as horizontal bars. Use a bar chart to display several values at the same point in time.
a!barChartField_21r4([label], [instructions], [categories], [series], [xAxisTitle], [yAxisTitle], [yAxisMin], [yAxisMax], [stacking], [referenceLines], [showLegend], [showDataLabels], [showTooltips], [allowDecimalAxisLabels], [labelPosition], [helpTooltip], [accessibilityText], [showWhen], [colorScheme], [height], [xAxisStyle], [yAxisStyle], [data], [config], [refreshAlways], [refreshAfter], [refreshInterval], [refreshOnReferencedVarChange], [refreshOnVarChange])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!billboardLayout_19r1() | Displays a background color, image, or video with optional overlay content.
a!billboardLayout( [backgroundMedia], [backgroundColor], [overlayPositionBar], [overlayPositionColumn], [overlayColumnWidth], [overlayStyle], [overlayContents], [height], [showWhen] )
| Click on the function name for examples. |
+portal-om-crf-rcrf-pr-pe
Compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!cancelProcess_17r3() | The Cancel Process Smart Service allows you to halt all process flow and cancel all tasks associated with a process.
a!cancelProcess_17r3([processId], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!checkboxField_23r3() | Displays a limited set of choices from which the user may select none, one, or many items and saves the values of the selected choices.
a!checkboxField_23r3([label], [instructions], [required], [disabled], [choiceLabels], [choiceValues], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [align], [labelPosition], [helpTooltip], [choiceLayout], [accessibilityText], [showWhen], [choiceStyle], [spacing])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!createKnowledgeCenter_17r4() | A knowledge center is a second-level container in Appian Document Management (below Communities).
a!createKnowledgeCenter_17r4([name], [description], [securityLevel], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!deleteRecords_23r3() | The Delete Records (23.3) smart service is a powerful tool that allows you to easily delete data from the source system and then automatically sync the changes in Appian.
a!deleteRecords_23r3([records], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!documentBrowserFieldColumns_17r3() | Displays the contents of a folder and allows users to navigate through a series of folders to find and download documents.
a!documentBrowserFieldColumns_17r3( [label], [labelPosition], [instructions], [helpTooltip], [folder], [height], [knowledgeCenter] )
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!dropdownField_20r2() | Displays a limited set of choices from which the user must select one item and saves a value based on the selected choice.
a!dropdownField_20r2([label], [labelPosition], [instructions], [required], [disabled], [choiceLabels], [choiceValues], [placeholderLabel], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [helpTooltip], [accessibilityText], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!dropdownFieldByIndex_20r2() | Displays a limited set of choices from which the user must select one item and saves the index of the selected choice.
a!dropdownFieldByIndex_20r2([label], [labelPosition], [instructions], [required], [disabled], [choiceLabels], [placeholderLabel], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [helpTooltip], [accessibilityText], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!fileUploadField_17r1() | Allows users to upload a file.
a!fileUploadField_17r1( [label], [labelPosition], [instructions], [helpTooltip], [target], [documentName], [documentDescription],[value], [saveInto], [required], [requiredMessage], [disabled], [validations], [validationGroup] )
| Click on the function name for examples. |
+portal-om-crf-rcrf-pr-pe
Compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!formLayout_17r1() | Displays up to two columns of components beneath a title and above buttons. Use this as the top-level layout of start and task forms.
a!formLayout_17r1( [label] , [instructions], [firstColumnContents], [secondColumnContents], [buttons], [validations], [validationGroup], [skipAutoFocus] )
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!fromJson_19r2() | Converts a JSON string into an Appian value.
a!fromJson_19r2([jsonText])
| a!fromJson("{""name"":""John Smith"", ""age"":49, ""likes"":[""green"",""dogs"",""long walks""]}")
[name:John Smith,age:49,likes:green; dogs; long walks]
|
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!gridField_19r1() | Displays read-only text, links, and images in a grid that supports selecting, sorting, and paging.
a!gridField( [label], [labelPostion], [instructions], [helpTooltip], [totalCount], [emptyGridMessage], [columns], [identifiers], [value], [saveInto], [selection], [requireSelection], [requiredMessage], [disabled], [validations], [validationGroup], [showWhen], [shadeAlternateRows], [spacing], [height], [borderStyle], [selectionStyle], [rowHeader] )
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!gridField_23r3() | Accepts a set of data and displays it as read-only text, links, images, or rich text in a grid that supports selecting, sorting, and paging.
a!gridField_23r3([label], [labelPosition], [instructions], [helpTooltip], [emptyGridMessage], [data], [columns], [pageSize], [initialSorts], [secondarySorts], [pagingSaveInto], [selectable], [selectionStyle], [selectionValue], [selectionSaveInto], [selectionRequired], [selectionRequiredMessage], [disableRowSelectionWhen], [validations], [validationGroup], [showWhen], [spacing], [height], [borderStyle], [shadeAlternateRows], [rowHeader], [accessibilityText], [refreshAlways], [refreshAfter], [refreshInterval], [refreshOnReferencedVarChange], [refreshOnVarChange], [userFilters], [showSearchBox], [showRefreshButton], [showExportButton], [recordActions], [openActionsIn], [actionsDisplay], [actionsStyle])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!httpResponse_17r4() | Returns an HTTP Response object for use in a Web API.
a!httpResponse_17r4([statusCode], [headers], [body])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!imageField_17r3() | Displays an image from document management or the web.
a!imageField_17r3( [label], [labelPosition], [instructions], [helpTooltip], [images], [size] )
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!lineChartField_19r1() | Displays a series of numerical data as points connected by lines. Use a line chart to visualize trends of data that changes over time.
a!lineChartField_19r1([label], [instructions], [categories], [series], [xAxisTitle], [yAxisTitle], [yAxisMin], [yAxisMax], [referenceLines], [showLegend], [showDataLabels], [showTooltips], [allowDecimalAxisLabels], [labelPosition], [helpTooltip], [showWhen], [connectNulls], [accessibilityText])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!multipledropdownField_20r2() | Displays a long list of choices from which the user may select none, one, or many items and saves values based on the selected choices.
a!multipledropdownField_20r2([label], [instructions], [required], [disabled], [placeholder], [choiceLabels], [choiceValues], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [labelPosition], [helpTooltip], [accessibilityText], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!multipleDropdownFieldByIndex_20r2() | Displays a long list of choices from which the user may select none, one, or many items and saves the indices of the selected choices.
a!multipleDropdownFieldByIndex_20r2([label], [labelPosition], [instructions], [required], [disabled], [placeholder], [choiceLabels], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [helpTooltip], [accessibilityText], [showWhen])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!pickerFieldRecords_20r2() | Displays an autocompleting input for the selection of one or more records, filtered by a single record type. Suggestions and picker tokens use the title of the record. This is an older version of
a!pickerFieldRecords_20r2([label], [labelPosition], [instructions], [helpTooltip], [placeholder], [maxSelections], [recordType], [filters], [value], [saveInto], [required], [requiredMessage], [readOnly], [disabled], [validations], [validationGroup], [accessibilityText], [showWhen])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!pickerFieldRecords_22r1() | Displays an autocompleting input for the selection of one or more records, filtered by a single record type. Suggestions and picker tokens use the title of the record.
a!pickerFieldRecords_22r1([label], [labelPosition], [instructions], [helpTooltip], [placeholder], [maxSelections], [recordType], [filters], [value], [saveInto], [required], [requiredMessage], [readOnly], [disabled], [validations], [validationGroup], [accessibilityText], [showWhen], [showRecordLinks])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!queryEntity_18r3() | Executes a query on a given data store entity and returns the result.
a!queryEntity_18r3([entity], [query])
| Click on the function name for examples. |
~portal+om-crf-rcrf-pr-pe
Partially compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!queryEntity_22r2() | Executes a query on a given data store entity and returns the result.
a!queryEntity_22r2([entity], [query], [fetchTotalCount])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!queryRecordType_20r4() | Executes a query on a given record type and returns the result. This is an older version of the
a!queryRecordType_20r4([recordType], [selection], [filters], [pagingInfo], [fetchTotalCount])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!radioButtonField_23r3() | Displays a limited set of choices from which the user must select one item and saves a value based on the selected choice.
a!radioButtonField_23r3([label], [instructions], [required], [disabled], [choiceLabels], [choiceValues], [value], [validations], [saveInto], [validationGroup], [requiredMessage], [labelPosition], [choiceLayout], [helpTooltip], [accessibilityText], [showWhen], [choiceStyle], [spacing])
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!recordActionField_23r3() | Displays a list of record actions with a consistent style. A record action is an end-user action configured within a record type object, such as a related action or record list action.
a!recordActionField_23r3([actions], [style], [display], [openActionsIn], [align], [accessibilityText], [showWhen])
| Click on the function name for examples. |
-portal-om-crf-rcrf-pr-pe
Incompatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!recordFilterDateRange_20r2() | Creates a user filter for a record list. This is an older version of the
a!recordFilterDateRange_20r2([name], [field], [defaultFrom], [defaultTo], [isVisible])
| Click on the function name for examples. |
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!richTextItem_18r1() | Displays styled text within a rich text component.
a!richTextItem_18r1( [Text], [style], [link], [linkStyle], [showWhen] )
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!sectionLayout_17r1() | Displays one or two columns of related components beneath a section title on an interface.
a!sectionLayout_17r1( [label] , [firstColumnContents], [secondColumnContents], [validations], [validationGroup], [isCollapsible], [isInitiallyCollapsed] )
| Click on the function name for examples. |
+portal+om-crf-rcrf-pr-pe
Compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!syncRecords_22r2() | The Sync Records smart service allows you to sync a record or set of records in the specified record type.
a!syncRecords_22r2([recordType], [identifiers], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!toJson_17r1() | Converts a value into a JSON string.
a!toJson_17r1([value])
| a!toJson_17r1(a!pagingInfo(startIndex: 1, batchSize: 10))
{"startIndex":1,"batchSize":10}
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!userRecordFilterList_22r3() | Returns the default user filters for the User record type. For use in the User record type only.
a!userRecordFilterList_22r3([])
| 0
0
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!userRecordListViewItem_22r3() | Returns the default list view item for the User record type. For use on the User record type only.
a!userRecordListViewItem_22r3([record])
| 0
0
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!writeRecords_23r2() | The Write Records smart service is a powerful tool that allows you to easily insert or update data in your source system and then automatically sync those changes in Appian.
a!writeRecords_23r2([records], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
a!writeRecords_23r4() | The Write Records smart service is a powerful tool that allows you to easily insert or update data in your source system and then automatically sync those changes in Appian.
a!writeRecords_23r4([records], [onSuccess], [onError])
| Click on the function name for examples. |
~portal-om-crf-rcrf-pr-pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
currency_22r4() | Converts a decimal number into a generic currency value by effectively adding a generic currency symbol (¤), a decimal point, and one comma for every three digits preceding the decimal.
currency_22r4([number], [decimals])
| currency_22r4( 13213.43 )
¤13,213.43
|
~portal-om-crf-rcrf+pr+pe
Partially compatible
Portals
Incompatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Compatible Process Reports
Compatible Process Events
|
isusermemberofgroup_21r2() | Identifies whether or not a user belongs to a group.
isusermemberofgroup_21r2([username], [groupId])
| isusermemberofgroup_21r2("john.doe", 2)
false
|
~portal+om-crf-rcrf-pr-pe
Partially compatible
Portals
Compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
|
urlForRecord_23r4() | This function allows you to return the URLs for one or more records or a record list view that can then be used in a link component.
urlForRecord_23r4([recordType], [recordIds])
| urlforrecord(cons!MY_RECORD_TYPE)
"https://<sitename>/suite/tempo/records/type/<record_type>/view/all"
|
~portal~om-crf-rcrf-pr-pe
Partially compatible
Portals
Partially compatible Offline Mobile
Incompatible Sync-Time Custom Record Fields
Incompatible Real-Time Custom Record Fields
Incompatible Process Reports
Incompatible Process Events
| Solve the following leet code problem |
Billboard Layout Component
a!billboardLayout( backgroundMedia, backgroundColor, showWhen, height, marginBelow, overlay, accessibilityText, marginAbove, backgroundMediaPositionHorizontal, backgroundMediaPositionVertical )
| a!billboardLayout( backgroundMedia, backgroundColor, showWhen, height, marginBelow, overlay, accessibilityText, marginAbove, backgroundMediaPositionHorizontal, backgroundMediaPositionVertical )
Displays a background color, image, or video with optional overlay content.
ParametersCopy link to clipboard
Name Keyword Types Description
Background Media
backgroundMedia
Any Type
Determines the background content. Takes priority over background color. Configure using a!documentImage, a!userImage, a!webImage, or a!webVideo.
Background Color
backgroundColor
Text
Determines the background color. When background media is also specified, the background color shows while media is loading or when background image is transparent. Must be a valid hex code. Default is #f0f0f0.
Visibility
showWhen
Boolean
Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default: true.
Height
height
Text
Determines the layout height. Valid values: "EXTRA_SHORT", "SHORT", "SHORT_PLUS", "MEDIUM" (default), "MEDIUM_PLUS", "TALL", "TALL_PLUS", "EXTRA_TALL", "AUTO". Auto renders as medium when no background media is set.
Margin Below
marginBelow
Text
Determines how much space is added below the layout. Valid values: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
Overlay Configurations
overlay
Any Type
Determines the overlay. Configure using a!columnOverlay, a!barOverlay, or a!fullOverlay.
Accessibility Text
accessibilityText
Text
Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
Margin Above
marginAbove
Text
Determines how much space is added above the layout. Valid values: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
Background Media Horizontal Position
backgroundMediaPositionHorizontal
Text
Determines the horizontal positioning of the billboard background media. Valid values: "LEFT", "CENTER" (default), "RIGHT".
Background Media Vertical Position
backgroundMediaPositionVertical
Text
Determines the vertical positioning of the billboard background media. Valid values: "TOP", "MIDDLE" (default), "BOTTOM".
Usage considerationsCopy link to clipboard
Default text colors for light and dark backgroundsCopy link to clipboard
When the overlay style is none, the standard text color changes based on the selected background color.
For light background colors, standard text is dark gray.
For dark background colors, standard text is switched to white.
These automatic text color changes apply even when background media is set.
Using overlaysCopy link to clipboard
A billboard layout may have either a bar, column, full, or no overlay.
When overlay content does not fit within the layout, it scrolls vertically.
Sizing and displaying background mediaCopy link to clipboard
For billboards with a value of "SHORT", "MEDIUM", or "TALL" for the height parameter, background media is displayed as large as possible to fill the available width.
When the background media's aspect ratio is different from the layout's aspect ratio, the background will be cut off at the top and bottom.
If it is important that the background media be fully visible, set the height to "AUTO". See the SAIL Design System for guidance on this setting.
Use backgroundMediaPositionHorizontal and backgroundMediaPositionVertical to keep the most important parts of your background media visible in various orientations and screen sizes.
When a video is used as the background, it plays automatically and does not have audio.
Using the backgroundMedia parameter in offline interfacesCopy link to clipboard
In offline interfaces, only document images are supported for the backgroundMedia parameter. User images, web images, and web videos are not supported for offline interfaces.
ExamplesCopy link to clipboard
Click EXPRESSION to copy and paste an example into the Interface Definition to see it displayed.
Billboard with overlayCopy link to clipboard
a!billboardLayout(
backgroundColor: "#619ed6",
overlay: a!barOverlay(
position: "BOTTOM",
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: "Finance Summary",
size: "LARGE"
)
}
)
}
),
a!columnLayout(
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!richTextDisplayField(
label: "Total Spending",
value: a!richTextItem(
text: "$31,000.00",
size: "MEDIUM"
)
)
}
),
a!columnLayout(
contents: {
a!richTextDisplayField(
label: "Remaining Budget",
value: a!richTextItem(
text: a!richTextItem(
text: "79%",
size: "MEDIUM"
),
color: "POSITIVE"
)
)
}
),
a!columnLayout(
contents: {
a!richTextDisplayField(
label: "Open Requests",
value: a!richTextItem(
text: "36",
size: "MEDIUM"
)
)
}
)
},
alignVertical: "TOP"
)
}
)
},
alignVertical: "MIDDLE"
)
},
style: "DARK"
),
height: "SHORT"
)
| Solve the following leet code problem |
interface component : Box Layout
| a!boxLayout( label, contents, style, showWhen, isCollapsible, isInitiallyCollapsed, marginBelow, accessibilityText, padding, shape, marginAbove, showBorder, showShadow, labelSize, labelHeadingTag )
Displays any arrangement of layouts and components within a box on an interface.
ParametersCopy link to clipboard
Name Keyword Types Description
Label
label
Text
Text to display as the box's title.
Contents
contents
Any Type
Components and layouts to display within the box.
Style
style
Text
Determines the color of the label and box outline. Valid values: Any valid hex color or "STANDARD" (default), "ACCENT", "SUCCESS", "INFO", "WARN", "ERROR".
Visibility
showWhen
Boolean
Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default: true.
Collapsible
isCollapsible
Boolean
Determines if an expand/collapse control appears in the box header. Default: false.
Initially Collapsed
isInitiallyCollapsed
Boolean
Determines if the box is collapsed when the interface first loads. Default: false.
Margin Below
marginBelow
Text
Determines how much space is added below the layout. Valid values: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
Accessibility Text
accessibilityText
Text
Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
Padding
padding
Text
Determines the space between the box edges and its contents. Valid values: "NONE", "EVEN_LESS", "LESS" (default), "STANDARD", "MORE", "EVEN_MORE".
Shape
shape
Text
Determines the box shape. Valid values: "SQUARED" (default), "SEMI_ROUNDED", "ROUNDED".
Margin Above
marginAbove
Text
Determines how much space is added above the layout. Valid values: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
Show border
showBorder
Boolean
Determines whether the layout has an outer border. Default: true.
Show shadow
showShadow
Boolean
Determines whether the layout has an outer shadow. Default: false.
Label Size
labelSize
Text
Determines the label size. Valid values: "LARGE_PLUS", "LARGE", "MEDIUM_PLUS", "MEDIUM", "SMALL", "EXTRA_SMALL" (default).
Accessibility Heading Tag
labelHeadingTag
Text
Determines the heading tag associated with the label for use by screen readers; produces no visible change. Valid values: "H1", "H2", "H3", "H4", "H5", "H6". The default is dependent on the chosen label size. See accessibility design guidance for more details to associate the proper heading tag with the box label to follow accessibility standards.
ExamplesCopy link to clipboard
Click EXPRESSION to copy and paste an example into the Interface Definition to see it displayed.
Box layout with success styleCopy link to clipboard
This example uses a box layout with the "SUCCESS" style. It displays the following interface.
screenshot of a box layout with green success styling and a confirmation message
a!boxLayout(
label: "Success! Your order was successfully processed",
style: "SUCCESS",
marginBelow: "STANDARD",
contents: {
a!textField(
labelPosition: "COLLAPSED",
value: "Your credit card has been charged.",
readOnly: true
)
}
)
Collapsible box layout with custom styleCopy link to clipboard
This example uses a collapsible box layout with a custom style for the header color. It displays the following interface.
screenshot of a box layout with burgundy styling and a list of students
a!boxLayout(
label: "Enrolled Students",
style: "#98002E",
marginBelow: "STANDARD",
isCollapsible: true,
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: a!richTextBulletedList(
items: {
"Elizabeth Ward",
"Fatima Cooper",
"Jaylen Smith",
"Michael Johnson",
"Jade Rao",
}
)
)
}
)
Box layout with label size and shadowCopy link to clipboard
This example uses a box layout with a "MEDIUM" label size. It displays the following interface.
screenshot of a box layout with custom styling and medium label size
Because the header content layout uses a transparent background, we are using a shadow instead of a border. See the box layout design guidance for more information on using borders and shadows.
a!localVariables(
local!currentClasses: {
a!map(courseNum: "JPN 202", title: "Intermediate Japanese II", students: 14),
a!map(courseNum: "JPN 270", title: "Intro to Japanese Culture", students: 8),
a!map(courseNum: "JPN 360", title: "Japanese Modern Women Writers", students: 5)
},
a!headerContentLayout(
contents: a!boxLayout(
label: "Current Classes",
labelSize: "MEDIUM",
contents: {
a!forEach(
items: local!currentClasses,
expression: a!sideBySideLayout(
items: {
a!sideBySideItem(
item: a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
fv!item.courseNum,
" ",
a!richTextItem(
text: {fv!item.title},
link: a!dynamicLink(),
linkStyle: "STANDALONE",
color: "#1a73e7"
)
}
),
width: "AUTO"
),
a!sideBySideItem(
item: a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
fv!item.students,
" ",
a!richTextIcon(icon: "users")
}
),
width: "MINIMIZE"
)
}
)
)
},
style: "#1a73e7",
marginBelow: "STANDARD",
showBorder: false,
showShadow: true
),
backgroundColor: "TRANSPARENT"
)
)
Rounded box layoutsCopy link to clipboard
This example uses a box layout with a rounded shape. It displays the following interface.
screenshot of a student dashboard with multiple rounded box layouts
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!boxLayout(
label: "Current Courses",
contents: {
a!sideBySideLayout(
items: {
a!sideBySideItem(
item: a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: {
"CRW470"
},
size: "STANDARD"
)
}
),
width: "MINIMIZE"
),
a!sideBySideItem(
item: a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
"Advanced Fiction Workshop"
}
)
)
}
),
a!sideBySideLayout(
items: {
a!sideBySideItem(
item: a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: {
"ENG463"
},
size: "STANDARD"
)
}
),
width: "MINIMIZE"
),
a!sideBySideItem(
item: a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
"Literature on the Move: Stories of Migration"
}
)
)
}
),
a!sideBySideLayout(
items: {
a!sideBySideItem(
item: a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: {
"ENG327"
},
size: "STANDARD"
)
}
),
width: "MINIMIZE"
),
a!sideBySideItem(
item: a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
"The Next Great American Graphic Novel"
}
)
)
}
)
},
style: "#363535",
shape: "ROUNDED",
marginBelow: "STANDARD"
)
}
),
a!columnLayout(
contents: {
a!boxLayout(
label: "Past Courses",
contents: {
a!sideBySideLayout(
items: {
a!sideBySideItem(
item: a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: {
"CRW370"
},
size: "STANDARD"
)
}
),
width: "MINIMIZE"
),
a!sideBySideItem(
item: a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
"Intermediate Fiction Workshop"
}
)
)
}
),
a!sideBySideLayout(
items: {
a!sideBySideItem(
item: a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: {
"ENG222"
},
size: "STANDARD"
)
}
),
width: "MINIMIZE"
),
a!sideBySideItem(
item: a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
"Literature of Regency England: Jane Austen "
}
)
)
}
),
a!sideBySideLayout(
items: {
a!sideBySideItem(
item: a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: {
"ENG301"
},
size: "STANDARD"
)
}
),
width: "MINIMIZE"
),
a!sideBySideItem(
item: a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
"How to Study Literature"
}
)
)
}
)
},
style: "#363535",
shape: "ROUNDED",
marginBelow: "STANDARD"
)
}
)
}
)
| Solve the following leet code problem |
Interface component. Card Layout Component
| a!cardLayout( contents, link, height, style, showBorder, showShadow, tooltip, showWhen, marginBelow, accessibilityText, padding, shape, marginAbove, decorativeBarPosition, decorativeBarColor )
Displays any arrangement of layouts and components within a card on an interface. Can be styled or linked.
ParametersCopy link to clipboard
Name Keyword Types Description
Contents
contents
Any Type
Components and layouts to display within the card.
Link
link
Any Type
Link to apply to the card. Create a link with a!documentDownloadLink(), a!dynamicLink(), a!newsEntryLink(), a!processTaskLink(), a!recordLink(), a!reportLink(), a!safeLink(), a!startProcessLink(), a!submitLink(), a!userRecordLink(), or a!authorizationLink().
Height
height
Text
Determines the card height. Valid values: "EXTRA_SHORT", "SHORT", "SHORT_PLUS", "MEDIUM", "MEDIUM_PLUS", "TALL", "TALL_PLUS", "EXTRA_TALL", "AUTO"(default).
Style
style
Text
Determines the card background color. Valid values: Any valid hex color or "NONE" (default), "TRANSPARENT", "STANDARD", "ACCENT", "SUCCESS", "INFO", "WARN", "ERROR", "CHARCOAL_SCHEME", "NAVY_SCHEME", "PLUM_SCHEME".
Show Border
showBorder
Boolean
Determines whether the layout has an outer border. Default: true.
Show Shadow
showShadow
Boolean
Determines whether the layout has an outer shadow. Default: false.
Tooltip
tooltip
Text
Text to display on mouseover.
Visibility
showWhen
Boolean
Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default: true.
Margin Below
marginBelow
Text
Determines how much space is added below the layout. Valid values: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
Accessibility Text
accessibilityText
Text
Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
Padding
padding
Text
Determines the space between the card edges and its contents. Valid values: "NONE", "EVEN_LESS", "LESS" (default), "STANDARD", "MORE", "EVEN_MORE".
Shape
shape
Text
Determines the card shape. Valid values: "SQUARED" (default), "SEMI_ROUNDED", "ROUNDED".
Margin Above
marginAbove
Text
Determines how much space is added above the layout. Valid values: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
Decorative Bar Position
decorativeBarPosition
Text
Determines where the decorative bar displays. Valid values: "TOP", "BOTTOM", "START", "END", "NONE" (default).
Decorative Bar Color
decorativeBarColor
Text
Determines the decorative bar color. Valid values: Any valid hex color or "ACCENT" (default), "POSITIVE", "WARN", "NEGATIVE".
Usage considerationsCopy link to clipboard
Using the decorativeBarPosition and decorativeBarColor parametersCopy link to clipboard
The decorativeBarColor is ignored unless the decorativeBarPosition is set.
To create a consistent and orderly UI, use the same decorativeBarPosition for all cards on an interface.
Using the style parameter with color schemes and header content layoutsCopy link to clipboard
If you're using a predefined or custom color scheme for your interface, use the card layout's style parameter to select matching or complimentary card colors.
If you use a header content layout with a predefined color scheme for your background, make sure that your header content layout and cards are using the same predefined color scheme.
If you use a dark custom background color for your header content layout, make your cards a lighter color. For more information on backgrounds, check out our header content layout design guidance.
If you need your card to blend into the background of your interface, use the "TRANSPARENT" style. This style is great for cards that will appear on multiple different interfaces and be reused throughout an application.
Feature compatibilityCopy link to clipboard
The table below lists this SAIL component's compatibility with various features in Appian.
Feature Compatibility Note
Portals Compatible
Offline Mobile Compatible
Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible
Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports Incompatible
Cannot be used to configure a process report.
Process Events Incompatible
Cannot be used to configure a process event node, such as a start event or timer event.
Related PatternsCopy link to clipboard
The following patterns include usage of the Card Layout Component.
Alert Banner Patterns (Choice Components): The alert banners pattern is good for creating a visual cue of different types of alerts about information on a page.
Call to Action Pattern (Formatting): Use the call to action pattern as a landing page when your users have a single action to take.
Cards as Buttons Pattern (Choice Components, Formatting, Conditional Display): The cards as buttons pattern is a great way to prominently display a select few choices.
Cards as List Items Patterns (Choice Components, Images): Use the cards as list items pattern to create visually rich lists as an alternative to grids or feeds. This pattern uses a combination of cards and billboards to show lists of like items. You can easily modify the pattern to change the card content or the number of cards per row to fit your use case.
Comments Patterns (Comments, Looping): Use this pattern when displaying a chronological list of messages from different users, such as comments on a topic or notes on a case.
Document List (Documents): Use the document list items pattern to display a list of documents that can be searched and filtered. This pattern uses a combination of cards and rich text to show an easy to navigate list of documents of different types.
Dual Picklist Pattern (Choice Components, Cards, Checkboxes, Buttons): Use this pattern to view side-by-side lists and move items from one list to the other. The dual picklist is great for moving items from one state to another, like from active to inactive.
Event Timelines (Timeline, Events): Use the event timeline pattern to display a dated list of events and actions in chronological order. This pattern uses a combination of cards, rich text, and user images to show an easy to navigate list of dated events.
Inline Survey (Radio Buttons, Checkboxes, Buttons): Use this pattern to create a clean and easy to navigate survey.
KPI Patterns (Formatting): The Key Performance Indicator (KPI) patterns provide a common style and format for displaying important performance measures.
Leaderboard (Looping): Use the leaderboard pattern to show a selection of your data in an easy to read ranked display.
Limit the Number of Rows in a Grid That Can Be Selected (Validation, Grids, Records): Limit the number of rows that can be selected to an arbitrary number.
Milestone Patterns (Looping): There are three options for milestone patterns which all display some form of a progress indicator to guide users through a series of steps.
Navigation Patterns (Conditional Display, Formatting, Navigation): Use the navigation patterns to help orient users and enable them to easily navigate pages and content.
Trend-Over-Time Report (Charts, Reports): This report provides an attractive, interactive design for exploring different series of data over time.
Year-Over-Year Report (Charts, Reports, Formatting): This is a feature-rich, interactive report for sales and profits by products over select periods of time.
Year-Over-Year Sales Growth (Records, Reports, Formatting): This pattern illustrates how to calculate year-over-year sales growth and display it in a KPI.
| Solve the following leet code problem |
Interface COMPONENT. Columns Layout.
| FunctionCopy link to clipboard
a!columnsLayout( columns, alignVertical, showWhen, marginBelow, stackWhen, showDividers, spacing, marginAbove )
Displays any number of columns alongside each other. On narrow screens and mobile devices, columns are stacked.
See also:
Responsive Design
Columns and Side By Side design guidance
ParametersCopy link to clipboard
Name Keyword Types Description
Columns
columns
Any Type
Columns to display using a column layout, a!columnLayout().
Vertical Alignment
alignVertical
Text
Determines vertical alignment of all column content with the layout. Valid values are "TOP" (default), "MIDDLE", and "BOTTOM".
Visibility
showWhen
Boolean
Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default: true.
Margin Below
marginBelow
Text
Determines how much space is added below the layout. Valid values: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
Stack When
stackWhen
List of Text
Determines the window width at which column layouts stack vertically. List all widths where columns should stack. Valid Values: "PHONE" (default), "TABLET_PORTRAIT", "TABLET_LANDSCAPE","DESKTOP", "DESKTOP_WIDE", "NEVER".
Show Dividers
showDividers
Boolean
Determines whether dividers appear between the columns. Default: false.
Column Spacing
spacing
Text
Determines the space between columns in the layout when they are not stacked. Valid values: “STANDARD” (default), “NONE”, “DENSE”, “SPARSE”.
Margin Above
marginAbove
Text
Determines how much space is added above the layout. Valid values: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
Usage considerationsCopy link to clipboard
Stacking on mobileCopy link to clipboard
On mobile phones, columns are stacked by default.
ExamplesCopy link to clipboard
Click EXPRESSION to copy and paste an example into the Interface Definition to see it displayed.
Three columns within one columns layoutCopy link to clipboard
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!textField(
label: "Customer",
value: "Jane Doe",
readOnly: true
),
a!textField(
label: "Status",
value: "Active",
readOnly: true
),
a!textField(
label: "Priority",
value: "High",
readOnly: true
)
}
),
a!columnLayout(
contents: {
a!textField(
label: "Customer",
value: "John Smith",
readOnly: true
),
a!textField(
label: "Status",
value: "Prospective",
readOnly: true
),
a!textField(
label: "Priority",
value: "High",
readOnly: true
)
}
),
a!columnLayout(
contents: {
a!textField(
label: "Customer",
value: "Michael Johnson",
readOnly: true
),
a!textField(
label: "Status",
value: "Prospective",
readOnly: true
),
a!textField(
label: "Priority",
value: "Medium",
readOnly: true
)
}
)
}
)
Displays the following:
screenshot of three columns within one columns layouts
Columns layout nested in another columns layoutCopy link to clipboard
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!textField(
label: "Customer",
value: "Jane Doe",
readOnly: true
),
a!textField(
label: "Status",
value: "Active",
readOnly: true
),
a!textField(
label: "Priority",
value: "High",
readOnly: true
)
}
),
a!columnLayout(
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!textField(
label: "Customer",
value: "John Smith",
readOnly: true
),
a!textField(
label: "Status",
value: "Prospective",
readOnly: true
),
a!textField(
label: "Priority",
value: "High",
readOnly: true
)
}
),
a!columnLayout(
contents: {
a!textField(
label: "Customer",
value: "Michael Johnson",
readOnly: true
),
a!textField(
label: "Status",
value: "Prospective",
readOnly: true
),
a!textField(
label: "Priority",
value: "Medium",
readOnly: true
)
}
)
}
)
}
)
}
)
Displays the following:
screenshot of nested columns layouts
Feature compatibilityCopy link to clipboard
The table below lists this SAIL component's compatibility with various features in Appian.
Feature Compatibility Note
Portals Compatible
Offline Mobile Compatible
Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible
Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports Incompatible
Cannot be used to configure a process report.
Process Events Incompatible
Cannot be used to configure a process event node, such as a start event or timer event.
Related PatternsCopy link to clipboard
The following patterns include usage of the Columns Layout.
Build a Wizard with Milestone Navigation (Wizards): Use the milestone component to show steps in a wizard.
Build an Interface Wizard (Wizards): Divide a big form into sections presented one step at a time with validation.
Call to Action Pattern (Formatting): Use the call to action pattern as a landing page when your users have a single action to take.
Cards as Buttons Pattern (Choice Components, Formatting, Conditional Display): The cards as buttons pattern is a great way to prominently display a select few choices.
Cards as List Items Patterns (Choice Components, Images): Use the cards as list items pattern to create visually rich lists as an alternative to grids or feeds. This pattern uses a combination of cards and billboards to show lists of like items. You can easily modify the pattern to change the card content or the number of cards per row to fit your use case.
Comments Patterns (Comments, Looping): Use this pattern when displaying a chronological list of messages from different users, such as comments on a topic or notes on a case.
Conditionally Hide a Column in a Grid (Grids, Conditional Display): Conditionally hide a column in a read-only grid when all data for that column is a specific value.
Document List (Documents): Use the document list items pattern to display a list of documents that can be searched and filtered. This pattern uses a combination of cards and rich text to show an easy to navigate list of documents of different types.
Drilldown Pattern (Grids): The drilldown pattern allows users to select an item from a grid to see more details in place of the grid.
Drilldown Report Pattern (Grids, Charts, Reports): The drilldown report pattern consists of a bar chart and column chart, which each drill down into a grid.
Dual Picklist Pattern (Choice Components, Cards, Checkboxes, Buttons): Use this pattern to view side-by-side lists and move items from one list to the other. The dual picklist is great for moving items from one state to another, like from active to inactive.
Dynamic Inputs (Inputs, Dynamic Links): Use the dynamic inputs pattern to allow users to easily add or remove as many values as needed.
Dynamically Show Sales by Product Category Compared to Total Sales (Records, Reports, Charts, Filtering): This pattern illustrates how to create an area chart that dynamically displays sales generated by product category compared to total sales.
Event Timelines (Timeline, Events): Use the event timeline pattern to display a dated list of events and actions in chronological order. This pattern uses a combination of cards, rich text, and user images to show an easy to navigate list of dated events.
Filter the Data in a Grid (Grids, Filtering, Records): Configure a user filter for your read-only grid that uses a record type as the data source. When the user selects a value to filter by, update the grid to show the result.
Form Steps (Stamps): Use the form steps patten to break down complicated forms into a series of quickly completed steps that are well organized and easy to navigate. This pattern uses a combination of cards and rich text to create steps that can represent fields from one or more interfaces.
Grid With Detail Pattern (Grids): The grid with detail pattern allows users to select an item from a grid to see more details next to the grid.
Grid with Heatmap Pattern (Grids): Displays a grid with conditional formatting of background colors at different thresholds.
Grid with Selection Pattern (Grids): This pattern is an example of good UX design for a grid that allows users to select items and easily view their selections when there are multiple pages of data. It also provides information on a common save behavior.
Inline Survey (Radio Buttons, Checkboxes, Buttons): Use this pattern to create a clean and easy to navigate survey.
KPI Patterns (Formatting): The Key Performance Indicator (KPI) patterns provide a common style and format for displaying important performance measures.
Leaderboard (Looping): Use the leaderboard pattern to show a selection of your data in an easy to read ranked display.
Limit the Number of Rows in a Grid That Can Be Selected (Validation, Grids, Records): Limit the number of rows that can be selected to an arbitrary number.
Make a Component Required Based on a User Selection (Validation): Make a paragraph component conditionally required based on the user selection.
Milestone Patterns (Looping): There are three options for milestone patterns which all display some form of a progress indicator to guide users through a series of steps.
Navigation Patterns (Conditional Display, Formatting, Navigation): Use the navigation patterns to help orient users and enable them to easily navigate pages and content.
Percentage of Online Sales (Records, Reports, Formatting): This pattern illustrates how to calculate the percent of sales generated from online orders and display it in a gauge component.
Refresh Data After Executing a Smart Service (Auto-Refresh, Smart Services):
Refresh Until Asynchronous Action Completes (Auto-Refresh): Use a refresh interval to display the results of an asynchronous action automatically.
Sales by Country and Currency (Records, Reports): This pattern illustrates how to create two different charts. One chart shows sales (calculated in US dollars) by country and the currency paid. The other shows sales by currency type, comparing the number of sales paid in US dollars versus the local currency.
Save a User's Report Filters to a Data Store Entity (Grids, Smart Services, Filtering, Reports): Allow a user to save their preferred filter on a report and automatically load it when they revisit the report later.
Searching on Multiple Columns (Grids, Filtering, Reports): Display a grid populated based on search criteria specified by end users.
Stamp Steps (Stamps): There are two similar stamp steps patterns. The stamp steps (icon) pattern is primarily icons and titles. It should be used for simple steps that don't require much information or instruction. The stamp steps (numbered) pattern is primarily text and should be used for steps that require context or explanation.
Task Report Pattern (Grids, Filters, Process Task Links, Task Reports): Provides a simple way to create and display an Appian task report.
Trend-Over-Time Report (Charts, Reports): This report provides an attractive, interactive design for exploring different series of data over time.
Update an Entity-Backed Record from its Summary View (Records, Smart Services): Enable users to make quick changes to a record by updating it right from a record view.
Use Links in a Grid to Show More Details and Edit Data (Grids): Allow end users to click a link in a read-only grid to view the details for the row, and make changes to the data. The data available for editing may include more fields than are displayed in the grid.
Use the Gauge Fraction and Gauge Percentage Configurations (Formatting, Reports): This recipe provides a common configuration of the Gauge Component using a!gaugeFraction() and a!gaugePercentage(), and includes a walkthrough that demonstrates the benefits of using design mode when configuring the gauge component.
Year-Over-Year Report (Charts, Reports, Formatting): This is a feature-rich, interactive report for sales and profits by products over select periods of time.
Year-Over-Year Sales Growth (Records, Reports, Formatting): This pattern illustrates how to calculate year-over-year sales growth and display it in a KPI.
| Solve the following leet code problem |
Interface Components. Form Layout
| FunctionCopy link to clipboard
a!formLayout( label, instructions, contents, buttons, validations, validationGroup, skipAutoFocus, showWhen )
Displays any arrangement of layouts and components beneath a title and above buttons. Use this as the top-level layout for start and task forms.
See also: Dashboard, Columns
ParametersCopy link to clipboard
Name Keyword Types Description
Label
label
Text
Optional text to display as the interface's title.
Instructions
instructions
Text
Optional text displayed below the field's label.
Contents
contents
Any Type Array
Components and layouts to display in the form body.
Buttons
buttons
Button Layout
Buttons to display at the bottom of the form, arranged using a!buttonLayout().
Validations
validations
Text or Validation Message
Validation errors displayed above the form buttons. Configured using a text array or an array with a mix of text and Validation Message using a!validationMessage(message, validateAfter).
Validation Group
validationGroup
Text or Validation Message Array
When present, the requiredness of the field is only evaluated when a button in the same validation group is pressed. The value for this parameter cannot contain spaces. For example, “validation group” is not a valid value. You need to add an underscore between words: “validation_group”. See the following recipes for more information:
Configure Buttons with Conditional Requiredness
Validation Groups for Buttons with Multiple Validation Rules'
Don’t automatically focus on first input
skipAutoFocus
Boolean
Determines whether the first input will receive focus when a form loads. Default is false.
Visibility
showWhen
Boolean
Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default: true.
Usage considerationsCopy link to clipboard
Using a!formLayout()Copy link to clipboard
A button layout must be present for a back button to appear for activity-chained tasks.
Use form validation messages for problems that are not specific to a single component.
This component cannot be read-only or disabled.
Initial behavior & focusingCopy link to clipboard
The component is not in an initially collapsed section.
Focus will automatically be applied on initial load to the first component in a form that is one of the following:
Checkbox
Date
Date and Time
Decimal
Dropdown
Encrypted Text
File-Upload
Integer
Multi-Dropdown
Paragraph
Picker Components
Radio Button
Text
Scroll behavior in wizardsCopy link to clipboard
When you use a form layout as part of a wizard, Appian will automatically handle the page scrolling between each step of the wizard. This means that whenever a user navigates to the next step, the page will automatically scroll to the top of the form.
However, there are certain scenarios where Appian will not automatically handle page scrolling. If your form contains multiple read-only components—elements that the user does not interact with—then the automatic page scrolling may not occur when the user navigates to the next step. Additionally, the buttons or dynamic links that control form navigation must be placed in the buttons parameter. If they are placed in the contents parameter, auto scrolling will not work.
ExamplesCopy link to clipboard
Click EXPRESSION to copy and paste an example into the Interface Definition to see it displayed.
Two-column formCopy link to clipboard
a!formLayout(
label: "Customers for Review",
instructions: "Review the profiles for the customers below and contact as needed",
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!textField(
label: "Customer",
value: "John Smith",
readOnly: true
),
a!textField(
label: "Status",
value: "Prospective",
readOnly: true
),
a!textField(
label: "Priority",
value: "High",
readOnly: true
)
}
),
a!columnLayout(
contents: {
a!textField(
label: "Customer",
value: "Michael Johnson",
readOnly: true
),
a!textField(
label: "Status",
value: "Prospective",
readOnly: true
),
a!textField(
label: "Priority",
value: "Medium",
readOnly: true
)
}
)
}
)
},
buttons: a!buttonLayout(
primaryButtons: {
a!buttonWidget(
label: "Submit",
submit: true
)
}
)
)
Displays the following:
screenshot of a two-column form
Feature compatibilityCopy link to clipboard
The table below lists this SAIL component's compatibility with various features in Appian.
Feature Compatibility Note
Portals Compatible
Offline Mobile Compatible
Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible
Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports Incompatible
Cannot be used to configure a process report.
Process Events Incompatible
Cannot be used to configure a process event node, such as a start event or timer event.
Old versionsCopy link to clipboard
There are older versions of this interface component. You can identify older versions by looking at the name to see if there is a version suffix. If you are using an old version, be sure to refer to the corresponding documentation from the list below.
Old Versions Reason for Update
a!formLayout_17r1
Replaced firstColumnContents and secondColumnContents with contents. Now supports greater than two-column layout.
To learn more about how Appian handles this kind of versioning, see the Function and Component Versions page.
Related PatternsCopy link to clipboard
The following patterns include usage of the Form Layout.
Add Multiple Validation Rules to One Component (Validation): Enforce that the user enters at least a certain number of characters in their text field, and also enforce that it contains the "@" character.
Add Validations to an Inline Editable Grid (Validation, Grids, Looping): Allows the user to change data directly in a grid, and validate a various entries.
Add, Edit, and Remove Data in an Inline Editable Grid (Grids, Looping): Allow the user to change data directly in an inline editable grid.
Add, Remove, and Move Group Members Browser (Hierarchical Data, Group Management): Display the membership tree for a given group and provide users with the ability to add, remove, and move user members from a single interface.
Build a Wizard with Milestone Navigation (Wizards): Use the milestone component to show steps in a wizard.
Build an Interface Wizard (Wizards): Divide a big form into sections presented one step at a time with validation.
Configure Buttons with Conditional Requiredness (Validation): Present two buttons to the end user and only make certain fields required if the user clicks a particular button
Configure a Boolean Checkbox (Choice Components): Configure a checkbox that saves a boolean (true/false) value, and validate that the user selects the checkbox before submitting a form.
Configure a Dropdown Field to Save a CDT (Choice Components): When using a dropdown to select values from the database, or generally from an array of CDT values, configure it to save the entire CDT value rather than just a single field.
Configure a Dropdown with an Extra Option for Other (Choice Components): Show a dropdown that has an "Other" option at the end of the list of choices. If the user selects "Other", show a required text field.
Make a Component Required Based on a User Selection (Validation): Make a paragraph component conditionally required based on the user selection.
Set the Default Value Based on a User Input (Default Value): Set the default value of a variable based on what the user enters in another component.
Set the Default Value of CDT Fields Based on a User Input (Default Value): Set the value of a CDT field based on a user input.
Set the Default Value of an Input on a Start Form (Default Value): Display a default value in some form inputs on a start form, and save the value into the process when submitting.
Set the Default Value of an Input on a Task Form (Default Value): Display a default value in some form inputs on a task form, and save the value to process when submitting.
Showing Validation Errors that Aren't Specific to One Component (Validation): Alert the user about form problems that aren't specific to one component, showing the message only when the user clicks "Submit".
Track Adds and Deletes in Inline Editable Grid (Grids): In an inline editable grid, track the employees that are added for further processing in the next process steps.
Use Links in a Grid to Show More Details and Edit Data in External System (Grids, Web Services): Allow end users to click a link in a read-only grid to view the details for the row, and make changes to the data.
Use Selection For Bulk Actions in an Inline Editable Grid (Grids): Allow the user to edit data inline in a grid one field at a time, or in bulk using selection.
Use Validation Groups for Buttons with Multiple Validation Rules (Validation): Present two buttons to the end user that, based on the selection, will validate only after a particular button is clicked.
| Solve the following leet code problem |
Interface Components
Header Content Layout Component
| FunctionCopy link to clipboard
a!headerContentLayout( header, contents, showWhen, backgroundColor, contentsPadding, isHeaderFixed )
Displays any arrangement of layouts and components beneath a billboard or card header that is flush with the edge of the page. Similar to a form layout, this is a top-level layout and cannot be nested within other layouts. The header layout is ideal for landing pages and reports.
To add a header content layout to your interface from design mode, drag out either a CARD HEADER or BILLBOARD HEADER from the interface palette.
See also: Header Content Layout style guidance
ParametersCopy link to clipboard
Name Keyword Types Description
Header
header
Any Type
Billboard, card, or list of billboards or cards to display at the top of the page. Configure using a!billboardLayout() or a!cardLayout().
Contents
contents
Any Type Array
Components and layouts to display in the body of the interface.
Visibility
showWhen
Boolean
Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default: true.
Background color
backgroundColor
Text
Color to show behind the contents of the page. Valid values: Any valid hex color or "WHITE" (default), "TRANSPARENT", "CHARCOAL_SCHEME", "NAVY_SCHEME", "PLUM_SCHEME".
Contents Padding
contentsPadding
Text
Determines the space surrounding the contents. Valid values: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
Fix header when scrolling
isHeaderFixed
Boolean
Determines whether the header remains at the top of the page when scrolling. Default: false.
Usage considerationsCopy link to clipboard
Billboard videosCopy link to clipboard
The backgroundMedia parameter accepts both images and videos. If you want to use a video for your billboard media, there are a few constraints to consider:
The video cannot be a document stored within your application like an image can.
The video must be hosted at a URL in the same way as a web image.
The video cannot be a URL to a website that contains a video player, it must be a direct URL to the source video.
For more information, see the Web Video Component page.
Designing headersCopy link to clipboard
For configuring record views with a flush header, consider using a record header.
If you are using a fixed header, be sure to view your interface on multiple screen sizes to make sure the content is accessible on all devices. See the header content layout design guidance for more information.
If fixed header is selected in the header content layout, but it isn't selected for the record header, neither header will be fixed. See Design Record Views for more information.
To quickly configure a fixed header in a one-page portal, consider enabling the header bar. On sites and multipage portals, the header bar is always enabled.
Report titles in Tempo and embedded interfacesCopy link to clipboard
This layout will not display the report title when viewed in Tempo and embedded interfaces.
ExamplesCopy link to clipboard
Click EXPRESSION to copy and paste an example into the Interface Definition to see it displayed.
Billboard layoutCopy link to clipboard
This example uses a billboard layout within the header content layout. It displays the following interface.
A billboard header with "Finance Summary" and details in a bar overlay, an example section layout is at the bottom
See the page on Billboard Layouts for more information on billboards and the SAIL Design System: Billboard Layout for guidance on when to use each overlay style.
Copy and paste this example into an an interface object to experiment with it.
a!headerContentLayout(
header: {
a!billboardLayout(
backgroundMedia: a!documentImage(
document: a!EXAMPLE_BILLBOARD_IMAGE()
),
backgroundColor: "#f0f0f0",
height: "SHORT",
marginBelow: "NONE",
overlay: a!barOverlay(
position: "BOTTOM",
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: {
"Finance Summary"
},
size: "LARGE"
)
}
)
}
),
a!columnLayout(
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!richTextDisplayField(
label: "Total Spending",
value: {
a!richTextItem(
text: {
"$31,000.00"
},
size: "MEDIUM_PLUS"
)
}
)
}
),
a!columnLayout(
contents: {
a!richTextDisplayField(
label: "Remaining Budget",
value: {
a!richTextItem(
text: {
"79%"
},
color: "POSITIVE",
size: "MEDIUM_PLUS"
)
}
)
}
),
a!columnLayout(
contents: {
a!richTextDisplayField(
label: "Open Requests",
value: {
a!richTextItem(
text: {
"36"
},
size: "MEDIUM_PLUS"
)
}
)
}
)
},
alignVertical: "TOP"
)
}
)
},
alignVertical: "MIDDLE"
)
},
style: "DARK"
)
)
},
contents: {
a!sectionLayout(
label: "Example Section",
contents: {
a!textField(
label: "YOUR CONTENT HERE",
readOnly: true()
)
}
)
}
)
Card layoutCopy link to clipboard
This example uses a card layout within the header content layout. It displays the following interface.
A header with "Finance Summary" and details in a gray background, an example section layout is at the bottom
See the page on Card Layouts for more information on cards.
Copy and paste this example into an an interface object to experiment with it.
a!headerContentLayout(
header: {
a!cardLayout(
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: {
"Finance Summary"
},
size: "LARGE"
)
}
)
}
),
a!columnLayout(
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!richTextDisplayField(
label: "Total Spending",
value: {
a!richTextItem(
text: {
"$31,000.00"
},
size: "MEDIUM_PLUS"
)
}
)
}
),
a!columnLayout(
contents: {
a!richTextDisplayField(
label: "Remaining Budget",
value: {
a!richTextItem(
text: {
"79%"
},
color: "POSITIVE",
size: "MEDIUM_PLUS"
)
}
)
}
),
a!columnLayout(
contents: {
a!richTextDisplayField(
label: "Open Requests",
value: {
a!richTextItem(
text: {
"36"
},
size: "MEDIUM_PLUS"
)
}
)
}
)
},
alignVertical: "TOP"
)
}
)
},
alignVertical: "MIDDLE"
)
},
style: "STANDARD"
)
},
contents: {
a!sectionLayout(
label: "Example Section",
contents: {
a!textField(
label: "YOUR CONTENT HERE",
readOnly: true()
)
}
)
}
)
Fixed headerCopy link to clipboard
This example uses a fixed header within the header content layout. It displays the following interface.
gif of a fixed header with order details
Note that this pattern contains two empty a!cardLayout() components to help you see the scrolling behavior with a fixed header. These components have no other purpose.
See the SAIL Design System: Header Content Layout for more information on fixed headers.
Copy and paste this example into an interface object to experiment with it.
a!headerContentLayout(
header: {
a!cardLayout(
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: "Order" & " " & "#12345667",
size: "LARGE",
style: "STRONG"
)
}
)
}
)
}
),
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: "Next Action",
color: "SECONDARY"
)
}
),
a!buttonArrayLayout(
buttons: {
a!buttonWidget(
label: if(
a!isPageWidth("TABLET_PORTRAIT"),
"Create Label",
"Create Shipping Label"
),
style: "SOLID"
)
},
align: "START",
marginBelow: "NONE"
)
}
),
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: "Shipping Priority",
color: "SECONDARY"
)
}
),
a!sideBySideLayout(
items: {
a!sideBySideItem(
item: a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: "Normal",
size: "MEDIUM",
style: "STRONG"
)
}
)
),
a!sideBySideItem(
item: a!buttonArrayLayout(
buttons: {
a!buttonWidget(
label: "Expedite",
size: "SMALL"
)
},
align: "START",
marginBelow: "NONE"
),
width: "MINIMIZE"
)
},
alignVertical: "MIDDLE",
stackWhen: "TABLET_PORTRAIT"
)
}
),
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: "Days Since Order Received",
color: "SECONDARY"
)
}
),
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: 6,
size: "MEDIUM",
style: "STRONG"
)
},
marginBelow: "NONE"
),
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: {
"Received on",
" ",
text(today()- 6, "MMM D, YYYY")
},
size: "SMALL"
)
}
)
}
),
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: "Assignee",
color: "SECONDARY"
)
}
),
a!sideBySideLayout(
items: {
a!sideBySideItem(
item: a!imageField(
labelPosition: "COLLAPSED",
images: a!userImage(),
size: "TINY",
style: "AVATAR"
),
width: "MINIMIZE"
),
a!sideBySideItem(
item: a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: "Anthony Wu",
link: a!userRecordLink(),
linkStyle: "STANDALONE",
size: "MEDIUM",
style: "STRONG"
)
},
preventWrapping: true
)
),
a!sideBySideItem(
item: a!buttonArrayLayout(
buttons: {
a!buttonWidget(
label: "Reassign",
size: "SMALL"
)
},
align: "START",
marginBelow: "NONE"
),
width: "MINIMIZE"
)
},
alignVertical: "MIDDLE",
stackWhen: "TABLET_PORTRAIT"
)
}
)
},
spacing: "SPARSE",
showDividers: true
)
},
padding: "STANDARD",
marginBelow: "MORE"
)
},
isHeaderFixed: if(a!isPageWidth("PHONE"),false,true),
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!sectionLayout(
label: "Example Section",
labelIcon: "box",
labelColor: "STANDARD",
contents: {
a!sectionLayout(
label: upper("Your content here"),
labelSize: "SMALL",
labelColor: "SECONDARY"
),
a!cardLayout(
contents: {},
height: "EXTRA_TALL",
style: "NONE",
marginBelow: "STANDARD",
showBorder: false
),
a!cardLayout(
contents: {},
height: "EXTRA_TALL",
style: "NONE",
marginBelow: "STANDARD",
showBorder: false
)
}
)
}
)
},
spacing: "SPARSE",
stackWhen: {"TABLET_LANDSCAPE", "TABLET_PORTRAIT", "PHONE"
}
)
}
)
Header content layout with navy color schemeCopy link to clipboard
This example uses the navy color scheme within a header content layout. It displays the following interface.
screenshot of a Admissions dashboard with a navy background
Copy and paste this example into an an interface object to experiment with it.
a!localVariables(
local!universityAdmissionsMetricsSpring: {
a!map(name: "Applications", totalCount: 1753),
a!map(name: "Admitted", totalCount: 367),
a!map(name: "Accepted", totalCount: 200),
a!map(name: "Enrolled", totalCount: 150)
},
local!universityAdmissionsMetricsFall: {
a!map(name: "Applications", totalCount: 3415),
a!map(name: "Admitted", totalCount: 429),
a!map(name: "Accepted", totalCount: 212),
a!map(name: "Enrolled", totalCount: 199)
},
a!headerContentLayout(
header:{},
contents:{
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value:
{
a!richTextItem(
text: {
"2021 Admissions Dashboard"
},
size: "LARGE"
),
char(10),
char(10)
}
),
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!cardLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: "2021 Spring Semester",
size: "MEDIUM_PLUS"
),
char(10),
char(10)
}
),
a!columnsLayout(
columns: {
a!forEach(
items: local!universityAdmissionsMetricsSpring,
expression: a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: fv!item.name,
color: "STANDARD"
),
char(10),
a!richTextItem(
text: fv!item.totalCount,
size: "LARGE",
style: "STRONG"
)
}
)
}
)
)
},
showDividers: true
)
},
style: "NAVY_SCHEME",
padding: "STANDARD",
marginBelow: "STANDARD",
showBorder: false
)
}
),
a!columnLayout(
contents: {
a!cardLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: "2021 Fall Semester",
size: "MEDIUM_PLUS"
),
char(10),
char(10)
}
),
a!columnsLayout(
columns: {
a!forEach(
items: local!universityAdmissionsMetricsFall,
expression: a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: fv!item.name,
color: "STANDARD"
),
char(10),
a!richTextItem(
text: fv!item.totalCount,
size: "LARGE",
style: "STRONG"
)
}
)
}
)
)
},
showDividers: true
)
},
style: "NAVY_SCHEME",
padding: "STANDARD",
marginBelow: "STANDARD",
showBorder: false
)
}
)
}
)
},
backgroundColor: "NAVY_SCHEME"
)
)
Feature compatibilityCopy link to clipboard
The table below lists this SAIL component's compatibility with various features in Appian.
Feature Compatibility Note
Portals Compatible
Offline Mobile Compatible
Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible
Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports Incompatible
Cannot be used to configure a process report.
Process Events Incompatible
Cannot be used to configure a process event node, such as a start event or timer event.
| Solve the following leet code problem |
Interface Components.
Section Layout Component
| FunctionCopy link to clipboard
a!sectionLayout( label, contents, validations, validationGroup, isCollapsible, isInitiallyCollapsed, showWhen, divider, marginBelow, accessibilityText, labelIcon, iconAltText, labelSize, labelHeadingTag, labelColor, dividerColor, dividerWeight, marginAbove )
This layout requires Appian for Mobile Devices version 17.2 or later. Displays any arrangement of layouts and components beneath a section title on an interface.
See also:
Dashboard
Form
Columns
Section Layout design guidance
ParametersCopy link to clipboard
Name Keyword Types Description
Label
label
Text
Text to display as the section's title.
Contents
contents
Any Type
Components and layouts to display in the section body.
Validations
validations
List of Variant
Validation errors to display above the section.
Validation Group
validationGroup
Text
When present, the requiredness of the field is only evaluated when a button in the same validation group is pressed. The value for this parameter cannot contain spaces. For example, “validation group” is not a valid value. You need to add an underscore between words: “validation_group”. See the following recipes for more information:
Configure Buttons with Conditional Requiredness
Validation Groups for Buttons with Multiple Validation Rules'
Collapsible
isCollapsible
Boolean
Determines if an expand/collapse control appears in the section label. Default is false.
Initially Collapsed
isInitiallyCollapsed
Boolean
Determines if the section is collapsed when the interface first loads. Default is false.
Visibility
showWhen
Boolean
Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default: true.
Divider Line
divider
Text
Determines where a divider appears within the section. Valid values: "NONE" (default), "ABOVE", "BELOW".
Margin Below
marginBelow
Text
Determines how much space is added below the layout. Valid values: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
Accessibility Text
accessibilityText
Text
Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
Label Icon
labelIcon
Text
Icon to display next to the label. For a list of available icons, see the Styled Icon component.
Icon Alternative Text
iconAltText
Text
Equivalent alternate text for use by screen readers.
Label Size
labelSize
Text
Determines the label size. Valid values: "LARGE_PLUS", "LARGE", "MEDIUM_PLUS", "MEDIUM" (default), "SMALL", "EXTRA_SMALL".
Accessibility Heading Tag
labelHeadingTag
Text
Determines the heading tag associated with the label for use by screen readers; produces no visible change. Valid values: "H1", "H2", "H3", "H4", "H5", "H6". The default is dependent on the chosen label size. For more information on header tags, see our header accessibility guidance.
Label Color
labelColor
Text
Determines the label color. Valid values: Any valid hex color or "ACCENT" (default), "STANDARD", "POSITIVE", "NEGATIVE", "SECONDARY".
Divider Color
dividerColor
Text
Determines the divider line color. Valid values: Any valid hex color or "SECONDARY" (default), "STANDARD", "ACCENT".
Divider Weight
dividerWeight
Text
Determines the divider line thickness. Valid values: "THIN" (default), "MEDIUM", "THICK".
Margin Above
marginAbove
Text
Determines how much space is added above the layout. Valid values: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
Usage considerationsCopy link to clipboard
ValidationsCopy link to clipboard
Sections that contain validation messages are not collapsible regardless of the collapsible parameter's value. For example, if a validation is triggered when the form loads, then that section is expanded even if you have specified true for the isInitiallyCollapsed parameter.
If you have nested section layouts, any validations on an inner section will also appear in the outer section.
Section headersCopy link to clipboard
The labelHeadingTag parameter allows you to add a descriptive tag to a section heading so that screen readers can more easily convey page structure to the user. For more information and examples, see our design guidance on Accessible Headers.
ExamplesCopy link to clipboard
Click EXPRESSION to copy and paste an example into the Interface Definition to see it displayed.
Two columns within one sectionCopy link to clipboard
a!sectionLayout(
label: "Customers for Review",
labelHeadingTag: "H1",
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!textField(
label: "Customer",
value: "John Smith",
readOnly: true
),
a!textField(
label: "Status",
value: "Prospective",
readOnly: true
),
a!textField(
label: "Priority",
value: "High",
readOnly: true
)
}
),
a!columnLayout(
contents: {
a!textField(
label: "Customer",
value: "Michael Johnson",
readOnly: true
),
a!textField(
label: "Status",
value: "Prospective",
readOnly: true
),
a!textField(
label: "Priority",
value: "Medium",
readOnly: true
)
}
)
}
)
}
)
Displays the following:
screenshot of two columns in a section layout
Nested sectionsCopy link to clipboard
{
a!sectionLayout(
label: "Patient Profile",
labelSize: "LARGE",
labelHeadingTag: "H1",
labelColor: "STANDARD",
contents: {
a!sectionLayout(
label: "Personal Details",
labelHeadingTag: "H2",
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!sectionLayout(
label: "Contact Information",
labelSize: "SMALL",
labelHeadingTag: "H3",
labelColor: "SECONDARY",
contents: {
a!textField(
label: "Name",
labelPosition: "ADJACENT",
value: "Katherine Johnson",
readOnly: true
),
a!textField(
label: "Phone",
labelPosition: "ADJACENT",
value: "(202) 555-7513",
readOnly: true
)
}
)
}
),
a!columnLayout(
contents: {
a!sectionLayout(
label: "Work Information",
labelSize: "SMALL",
labelHeadingTag: "H3",
labelColor: "SECONDARY",
contents: {
a!textField(
label: "Position",
labelPosition: "ADJACENT",
value: "Full-time remote",
readOnly: true
),
a!textField(
label: "Department",
labelPosition: "ADJACENT",
value: "Information Technology",
readOnly: true
)
}
)
}
)
}
),
a!sectionLayout(
label: "COVID-19 Health Information",
labelHeadingTag: "H2",
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!sectionLayout(
label: "Vaccination Status",
labelSize: "SMALL",
labelHeadingTag: "H3",
labelColor: "SECONDARY",
contents: {
a!textField(
label: "Status",
labelPosition: "ADJACENT",
value: "Partially Validated",
readOnly: true
),
a!textField(
label: "Vaccine",
labelPosition: "ADJACENT",
value: "Pfizer-BioNTech COVID-19 Vaccine",
readOnly: true
)
}
)
}
),
a!columnLayout(
contents: {
a!sectionLayout(
label: "History",
labelSize: "SMALL",
labelHeadingTag: "H3",
labelColor: "SECONDARY",
contents: {
a!textField(
label: "Have you ever tested positive for COVID-19?",
labelPosition: "ADJACENT",
value: "No",
readOnly: true
)
}
)
}
)
}
)
}
)
}
)
}
)
}
Displays the following:
screenshot of nested section layouts with patient information
Feature compatibilityCopy link to clipboard
The table below lists this SAIL component's compatibility with various features in Appian.
Feature Compatibility Note
Portals Compatible
Offline Mobile Compatible
Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible
Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports Incompatible
Cannot be used to configure a process report.
Process Events Incompatible
Cannot be used to configure a process event node, such as a start event or timer event.
Old versionsCopy link to clipboard
There are older versions of this interface component. You can identify older versions by looking at the name to see if there is a version suffix. If you are using an old version, be sure to refer to the corresponding documentation from the list below.
Old Versions Reason for Update
a!sectionLayout_17r1
Replaced firstColumnContents and secondColumnContents with contents. Now supports greater than two-column layout.
To learn more about how Appian handles this kind of versioning, see the Function and Component Versions page.
Related PatternsCopy link to clipboard
The following patterns include usage of the Section Layout Component.
Add and Populate Sections Dynamically (Looping): Add and populate a dynamic number of sections, one for each item in a CDT array.
Add, Remove, and Move Group Members Browser (Hierarchical Data, Group Management): Display the membership tree for a given group and provide users with the ability to add, remove, and move user members from a single interface.
Browse Hierarchical Data (Hierarchical Data): Display a hierarchical data browser.
Build a Wizard with Milestone Navigation (Wizards): Use the milestone component to show steps in a wizard.
Comments Patterns (Comments, Looping): Use this pattern when displaying a chronological list of messages from different users, such as comments on a topic or notes on a case.
Conditionally Hide a Column in a Grid (Grids, Conditional Display): Conditionally hide a column in a read-only grid when all data for that column is a specific value.
Configure Cascading Dropdowns (Conditional Display, Choice Components): Show different dropdown options depending on the user selection.
Configure a Chart Drilldown to a Grid (Charts, Grids, Query Data, Records): Displays a column chart with aggregate data from a record type and conditionally shows a grid with filtered records when a user selects a column on the chart.
Configure an Array Picker with a Show All Option (Pickers): Allow users to choose from a long text array using an autocompleting picker, but also allow them to see the entire choice set using a dropdown.
Display Last Refresh Time (Auto-Refresh, Grids, Records): Display the last time the interface was updated, either based on a user interaction or a timer.
Display Multiple Files in a Grid (Document Management, Grids): Show a dynamic number of files in a grid and edit certain file attributes.
Drilldown Pattern (Grids): The drilldown pattern allows users to select an item from a grid to see more details in place of the grid.
Drilldown Report Pattern (Grids, Charts, Reports): The drilldown report pattern consists of a bar chart and column chart, which each drill down into a grid.
Dual Picklist Pattern (Choice Components, Cards, Checkboxes, Buttons): Use this pattern to view side-by-side lists and move items from one list to the other. The dual picklist is great for moving items from one state to another, like from active to inactive.
Filter the Data in a Grid (Grids, Filtering, Records): Configure a user filter for your read-only grid that uses a record type as the data source. When the user selects a value to filter by, update the grid to show the result.
Filter the Data in a Grid Using a Chart (Charts, Grids, Filtering, Records): Display an interactive pie chart with selectable sections so that a user may filter the results in a grid.
Form Steps (Stamps): Use the form steps patten to break down complicated forms into a series of quickly completed steps that are well organized and easy to navigate. This pattern uses a combination of cards and rich text to create steps that can represent fields from one or more interfaces.
Grid With Detail Pattern (Grids): The grid with detail pattern allows users to select an item from a grid to see more details next to the grid.
Leaderboard (Looping): Use the leaderboard pattern to show a selection of your data in an easy to read ranked display.
Limit the Number of Rows in a Grid That Can Be Selected (Validation, Grids, Records): Limit the number of rows that can be selected to an arbitrary number.
Milestone Patterns (Looping): There are three options for milestone patterns which all display some form of a progress indicator to guide users through a series of steps.
Navigation Patterns (Conditional Display, Formatting, Navigation): Use the navigation patterns to help orient users and enable them to easily navigate pages and content.
Offline Mobile Task Report (Grids, Filters, Process Task Links, Task Reports, Looping): Display a task report for a user that will work in Appian Mobile, even when the user is offline.
Refresh Until Asynchronous Action Completes (Auto-Refresh): Use a refresh interval to display the results of an asynchronous action automatically.
Save a User's Report Filters to a Data Store Entity (Grids, Smart Services, Filtering, Reports): Allow a user to save their preferred filter on a report and automatically load it when they revisit the report later.
Searching on Multiple Columns (Grids, Filtering, Reports): Display a grid populated based on search criteria specified by end users.
Task Report Pattern (Grids, Filters, Process Task Links, Task Reports): Provides a simple way to create and display an Appian task report.
Use Links in a Grid to Show More Details and Edit Data (Grids): Allow end users to click a link in a read-only grid to view the details for the row, and make changes to the data. The data available for editing may include more fields than are displayed in the grid.
Use Links in a Grid to Show More Details and Edit Data in External System (Grids, Web Services): Allow end users to click a link in a read-only grid to view the details for the row, and make changes to the data.
Use a Filter to Adjust Chart Reference Lines (Filtering, Charts): Using a dropdown, filter the results of a data set while also adjusting a chart reference line.
Use the Gauge Fraction and Gauge Percentage Configurations (Formatting, Reports): This recipe provides a common configuration of the Gauge Component using a!gaugeFraction() and a!gaugePercentage(), and includes a walkthrough that demonstrates the benefits of using design mode when configuring the gauge component.
Use the Write Records Smart Service Function on an Interface (Smart Services, Looping): Allow the user to publish several rows of data to a database table with the a!writeRecords() smart service function.
Use the Write to Data Store Entity Smart Service Function on an Interface (Smart Services, Grids, Looping): Allow the user to publish several rows of data to a table through the a!writeToDataStoreEntity() smart service function
| Solve the following leet code problem |
Interface Components.
Side By Side Layout.
| FunctionCopy link to clipboard
a!sideBySideLayout( items, alignVertical, showWhen, spacing, marginBelow, stackWhen, marginAbove )
Displays components alongside each other.
See also:
Side By Side Item
Responsive Design
Side By Side and Columns design guidance
Side By Side design guidance
ParametersCopy link to clipboard
Name Keyword Types Description
Items
items
Any Type
List of items that are displayed in the layout. Accepts a!sideBySideItem.
Vertical Alignment
alignVertical
Text
Determines vertical alignment of all content within the layout. Valid values are "TOP" (default), "MIDDLE", and "BOTTOM".
Visibility
showWhen
Boolean
Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default: true.
Item Spacing
spacing
Text
Determines the space between columns in the layout when they are not stacked. Valid values: "STANDARD" (default), "NONE", "DENSE", "SPARSE".
Margin Below
marginBelow
Text
Determines how much space is added below the layout. Valid values: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
Stack When
stackWhen
List of Text
Determines the page width at which side by side items stack vertically. List all widths where items should stack. Valid values: "PHONE", "TABLET_PORTRAIT", "TABLET_LANDSCAPE", "DESKTOP_NARROW", "DESKTOP", "DESKTOP_WIDE", "NEVER" (default).
Margin Above
marginAbove
Text
Determines how much space is added above the layout. Valid values: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
ExamplesCopy link to clipboard
Click EXPRESSION to copy and paste an example into the Interface Definition to see it displayed.
Input fields with relative widthsCopy link to clipboard
a!sideBySideLayout(
items: {
a!sideBySideItem(
width: "4X",
item: a!textField(
label: "First Name"
)
),
a!sideBySideItem(
item: a!textField(
label: "M.I."
)
),
a!sideBySideItem(
width: "4X",
item: a!textField(
label: "Last Name"
)
)
}
)
Displays the following:
screenshot of an interface with input fields of different widths
Minimized width for icon and buttonCopy link to clipboard
a!sideBySideLayout(
alignVertical: "MIDDLE",
spacing: "DENSE",
items: {
a!sideBySideItem(
width: "MINIMIZE",
item: a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: a!richTextIcon(
icon: "user",
size: "LARGE"
)
)
),
a!sideBySideItem(
item: a!textField(
labelPosition: "COLLAPSED"
)
),
a!sideBySideItem(
width: "MINIMIZE",
item: a!buttonArrayLayout(
marginBelow: "NONE",
buttons: {
a!buttonWidget(
label: "Check Availability",
size: "SMALL",
style: "OUTLINE",
color: "SECONDARY"
)
}
)
)
}
)
Displays the following:
screenshot on an interface with inputs using minimized widths
Feature compatibilityCopy link to clipboard
The table below lists this SAIL component's compatibility with various features in Appian.
Feature Compatibility Note
Portals Compatible
Offline Mobile Compatible
Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible
Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports Incompatible
Cannot be used to configure a process report.
Process Events Incompatible
Cannot be used to configure a process event node, such as a start event or timer event.
Related PatternsCopy link to clipboard
The following patterns include usage of the Side By Side Layout.
Activity History Pattern (Formatting): The Activity History pattern provides a common style and format for displaying an organization's activity measures.
Alert Banner Patterns (Choice Components): The alert banners pattern is good for creating a visual cue of different types of alerts about information on a page.
Cards as List Items Patterns (Choice Components, Images): Use the cards as list items pattern to create visually rich lists as an alternative to grids or feeds. This pattern uses a combination of cards and billboards to show lists of like items. You can easily modify the pattern to change the card content or the number of cards per row to fit your use case.
Comments Patterns (Comments, Looping): Use this pattern when displaying a chronological list of messages from different users, such as comments on a topic or notes on a case.
Document List (Documents): Use the document list items pattern to display a list of documents that can be searched and filtered. This pattern uses a combination of cards and rich text to show an easy to navigate list of documents of different types.
Duration Display (Rich Text, Events): Use the duration display pattern to show the amount of time in between events in a quick, easy-to-read way.
Dynamic Inputs (Inputs, Dynamic Links): Use the dynamic inputs pattern to allow users to easily add or remove as many values as needed.
Event Timelines (Timeline, Events): Use the event timeline pattern to display a dated list of events and actions in chronological order. This pattern uses a combination of cards, rich text, and user images to show an easy to navigate list of dated events.
Inline Tags for Side-by-Side Layout Pattern (Formatting): This pattern shows the best practice for combining tags with standard-sized rich text, or plain text, using a side by side layout.
KPI Patterns (Formatting): The Key Performance Indicator (KPI) patterns provide a common style and format for displaying important performance measures.
Leaderboard (Looping): Use the leaderboard pattern to show a selection of your data in an easy to read ranked display.
Limit the Number of Rows in a Grid That Can Be Selected (Validation, Grids, Records): Limit the number of rows that can be selected to an arbitrary number.
Milestone Patterns (Looping): There are three options for milestone patterns which all display some form of a progress indicator to guide users through a series of steps.
Navigation Patterns (Conditional Display, Formatting, Navigation): Use the navigation patterns to help orient users and enable them to easily navigate pages and content.
Refresh Data After Executing a Smart Service (Auto-Refresh, Smart Services):
Stamp Steps (Stamps): There are two similar stamp steps patterns. The stamp steps (icon) pattern is primarily icons and titles. It should be used for simple steps that don't require much information or instruction. The stamp steps (numbered) pattern is primarily text and should be used for steps that require context or explanation.
Trend-Over-Time Report (Charts, Reports): This report provides an attractive, interactive design for exploring different series of data over time.
User List Pattern (Looping): The user list pattern retrieves all the users in a specified group and displays them in a single column.
Year-Over-Year Report (Charts, Reports, Formatting): This is a feature-rich, interactive report for sales and profits by products over select periods of time.
| Solve the following leet code problem |
LAYOUT ELEMENTS:
Bar Overlay
| FunctionCopy link to clipboard
a!barOverlay( position, contents, showWhen, style, padding )
Displays a horizontal bar overlay for use in billboard layout.
See also: Billboard, Billboard layout design guidance
ParametersCopy link to clipboard
Name Keyword Types Description
Position
position
Text
Determines where the bar overlay appears. Valid values: "TOP", "MIDDLE", "BOTTOM" (default).
Contents
contents
Any Type
The interface to display in the overlay. Accepts layouts and display components. Supported layouts and components: Box, Button, Card, Columns, Image, Link, Milestone, Progress Bar, Rich Text, Section, Side By Side.
Visibility
showWhen
Boolean
Determines whether the overlay is displayed on the interface. When set to false, the overlay is hidden and is not evaluated. Default: true.
Style
style
Text
Determines the overlay style. Valid values: "DARK" (default), "SEMI_DARK", "NONE", "SEMI_LIGHT", "LIGHT".
Padding
padding
Text
Determines the space between the overlay's edges and its contents. Valid values: "NONE", "EVEN_LESS", "LESS", "STANDARD"(default), "MORE", "EVEN_MORE".
ExamplesCopy link to clipboard
Click EXPRESSION to copy and paste an example into the Interface Definition to see it displayed.
Bar overlay with intro messageCopy link to clipboard
a!billboardLayout(
backgroundcolor: "#073763",
marginBelow: "STANDARD",
overlay: a!barOverlay(
position: "MIDDLE",
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(text: {"Hello, " & user(loggedinuser(), "firstName") & "."}, size: "MEDIUM"),
char(10),
a!richTextItem(text: {"What do you need help with?"}, size: "LARGE")
},
align: "CENTER"
)
},
style: "DARK"
)
)
Displays the following:
Bar Overlay Example
Feature compatibilityCopy link to clipboard
The table below lists this SAIL component's compatibility with various features in Appian.
Feature Compatibility Note
Portals Compatible
Offline Mobile Compatible
Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible
Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports Incompatible
Cannot be used to configure a process report.
Process Events Incompatible
Cannot be used to configure a process event node, such as a start event or timer event.
Related PatternsCopy link to clipboard
The following patterns include usage of the Bar Overlay.
Cards as List Items Patterns (Choice Components, Images): Use the cards as list items pattern to create visually rich lists as an alternative to grids or feeds. This pattern uses a combination of cards and billboards to show lists of like items. You can easily modify the pattern to change the card content or the number of cards per row to fit your use case.
| Solve the following leet code problem |
Column Layout
| FunctionCopy link to clipboard
a!columnLayout( contents, width, showWhen )
Displays a column that can be used within the columns layout.
See also:
Columns
Columns and Side By Side design guidance
Columns layout design guidance
ParametersCopy link to clipboard
Name Keyword Types Description
Contents
contents
Any Type
Values that define the interface components for a column.
Width
width
Text
Determines the width of the column. Valid values: "AUTO" (default), "EXTRA_NARROW", "NARROW", "NARROW_PLUS", "MEDIUM", "MEDIUM_PLUS", "WIDE", "WIDE_PLUS", "1X", "2X", "3X", "4X", "5X", "6X", "7X", "8X", "9X", "10X".
Visibility
showWhen
Boolean
Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default: true.
Usage considerationsCopy link to clipboard
Using the contents parameterCopy link to clipboard
The following layouts are not supported in the contents parameter: form layout, header content layout, and column layout. All other layouts can be used, including columns layout.
Column widthsCopy link to clipboard
Use the width parameter to set the width of each column. See the SAIL Design System for guidance on choosing between column widths.
Valid values are:
"AUTO" (Default)
Relative widths: "1X", "2X", "3X", "4X", "5X", "6X", "7X", "8X", "9X", "10X".
Fixed widths: "EXTRA_NARROW", "NARROW", "NARROW_PLUS", "MEDIUM", "MEDIUM_PLUS", "WIDE", "WIDE_PLUS".
Auto widthCopy link to clipboard
The "AUTO" column width distributes the space evenly across all columns. As you resize the screen, the columns will remain distributed evenly.
Relative widthsCopy link to clipboard
Relative column widths are always proportional to other columns in the same columns layout. If there is only one column in a columns layout and it is set it to a relative width, it would take up the entire width because there isn't another column to compare it to.
Relative widths are always a multiple of "1X". If you have two columns and one uses "2X" and the other uses "3X", you could imagine the columns being split into five sections. The "2X" column takes up 2/5 of the space, and the "3X" column takes up 3/5 of the space.
Fixed widthsCopy link to clipboard
As long as they have enough room on the screen, fixed column widths will always maintain the same pixel width.
If their combined width takes up more than the width of the screen, they will size down appropriately.
In this example, the "WIDE_PLUS" columns will almost always be wider than the "MEDIUM" column. But none of them will be as wide as their default width when the screen is wide enough to use their full width.
Combining column width typesCopy link to clipboard
Fixed and relative column widthsCopy link to clipboard
If you use fixed column widths and relative column widths in the same columns layout, the fixed width applies first. The relative columns split the remaining space.
Auto column widthsCopy link to clipboard
If used with relative column widths, "AUTO" column widths are equal to "1X".
If used with fixed column widths, "AUTO" column widths will take up the remaining space on the page.
Examples:
Single columnCopy link to clipboard
Use the interactive editor below to test out your code:
a!columnLayout(
width: "AUTO",
contents: {
a!textField(
label: "Customer",
value: "John Smith",
readOnly: true
),
a!textField(
label: "Status",
value: "Prospective",
readOnly: true
),
a!textField(
label: "Priority",
value: "High",
readOnly: true
)
}
)
Relative column width: aligning columns across rowsCopy link to clipboard
This example has three columns on the top row and two columns on the bottom row. The columns on the top row each take up 1/3 of the space and the columns on the bottom take up 1/3 and 2/3 of the space.
To do this, create two rows with the same number of columns. Use the same relative column widths for each row. This ensures that the margins will line up.
Then, for the column on the top row that lines up with the longer column on the bottom row, nest an a!columnsLayout() to split the space into to more columns.
{a!columnsLayout(
columns: {
a!columnLayout(
width: "1X",
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!cardLayout(
height: "AUTO",
style: "NONE",
marginBelow: "STANDARD",
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(text: "Energy Consumption", color: "SECONDARY"),
char(10),
a!richTextItem(text: "3,415", size: "LARGE", style: "STRONG")
}
)
}
)
}
)
}
)
}
),
a!columnLayout(
width: "2X",
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!cardLayout(
height: "AUTO",
style: "NONE",
marginBelow: "STANDARD",
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(text: "Transportation", color: "SECONDARY"),
char(10),
a!richTextItem(text: "3,415", size: "LARGE", style: "STRONG"
)
}
)
}
)
}
),
a!columnLayout(
contents: {
a!cardLayout(
height: "AUTO",
style: "NONE",
marginBelow: "STANDARD",
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(text: "Waste", color: "SECONDARY"),
char(10),
a!richTextItem(text: "3,415", size: "LARGE", style: "STRONG")
}
)
}
)
}
)
}
)
}
)
}
),
a!columnsLayout(
columns: {
a!columnLayout(
width: "1X",
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!cardLayout(
height: "AUTO",
style: "NONE",
marginBelow: "STANDARD",
contents: {
a!pieChartField(
label: "Emissions by Category",
labelPosition: "ABOVE",
series: {
a!chartSeries(label: "Energy", data: 314),
a!chartSeries(label: "Transportation", data: 219),
a!chartSeries(label: "Waste", data: 89)
},
colorScheme: "RAINFOREST",
style: "DONUT",
seriesLabelStyle: "ON_CHART",
height: "MEDIUM"
)
}
)
}
)
}
)
}
),
a!columnLayout(
width: "2X",
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!cardLayout(
height: "AUTO",
style: "NONE",
marginBelow: "STANDARD",
contents: {
a!areaChartField(
label: "Emissions over Time",
labelPosition: "ABOVE",
categories: {"Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"},
series: {
a!chartSeries(
label: "Energy",
data: {29.8, 28, 24.9, 21.5, 27.4, 27.2, 22.1, 29.9, 25.6, 26.4, 23.1, 25.3}
),
a!chartSeries(
label: "Transportation",
data: {15.2, 19.8, 17.1, 16.7, 18.8, 15, 19.5, 19.4, 16.9, 16.7, 15.3,16.6
}
),
a!chartSeries(
label: "Waste",
data: {7.1, 6.2, 7.1, 7.6, 7.9, 7.6, 6, 7.9, 6.5, 6.3, 6.6, 6.4
}
)
},
xAxisTitle: "2021",
yAxisTitle: "MTCO2e",
stacking: "NONE",
showLegend: true,
showTooltips: true,
colorScheme: "RAINFOREST",
height: "MEDIUM"
)
}
)
}
)
}
)
}
)
}
)
}
| Solve the following leet code problem |
Column Overlay
| FunctionCopy link to clipboard
a!columnOverlay( alignVertical, position, width, contents, showWhen, style, padding )
Displays a vertical column overlay for use in billboard layout.
See also: Billboard
ParametersCopy link to clipboard
Name Keyword Types Description
Vertical Alignment
alignVertical
Text
Determines vertical alignment of all content within the overlay. Valid values: "TOP" (default), "MIDDLE", and "BOTTOM".
Position
position
Text
Determines where the column overlay appears. Valid values: "START" (default), "CENTER", "END".
Width
width
Text
Determines the column overlay width. Valid values: "NARROW", "MEDIUM" (default), "WIDE".
Contents
contents
Any Type
The interface to display in the overlay. Accepts layouts and display components. Supported layouts and components: Box, Button, Card, Columns, Image, Link, Milestone, Progress Bar, Rich Text, Section, Side By Side.
Visibility
showWhen
Boolean
Determines whether the overlay is displayed on the interface. When set to false, the overlay is hidden and is not evaluated. Default: true.
Style
style
Text
Determines the overlay style. Valid values: "DARK" (default), "SEMI_DARK", "NONE", "SEMI_LIGHT", "LIGHT".
Padding
padding
Text
Determines the space between the overlay's edges and its contents. Valid values: "NONE", "EVEN_LESS", "LESS", "STANDARD"(default), "MORE", "EVEN_MORE".
ExamplesCopy link to clipboard
Click EXPRESSION to copy and paste an example into the Interface Definition to see it displayed.
Column overlay with intro messageCopy link to clipboard
a!billboardLayout(
backgroundcolor: "#073763",
marginBelow: "STANDARD",
overlay: a!columnOverlay(
alignvertical: "MIDDLE",
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(text: {"Hello, " & user(loggedinuser(), "firstName") & "."}, size: "MEDIUM"),
char(10),
a!richTextItem(text: {"What do you need help with?"}, size: "LARGE")
},
align: "CENTER"
)
},
style: "DARK",
padding: "MORE"
)
)
| Solve the following leet code problem |
Full Overlay
| FunctionCopy link to clipboard
a!fullOverlay( alignVertical, contents, showWhen, style, padding )
Displays an overlay that covers the entire billboard layout.
See also: Billboard, Billboard layout design guidance
ParametersCopy link to clipboard
Name Keyword Types Description
Vertical Alignment
alignVertical
Text
Determines vertical alignment of all content within the overlay. Valid values: "TOP" (default), "MIDDLE", and "BOTTOM".
Contents
contents
Any Type
The interface to display in the overlay. Accepts layouts and display components. Supported layouts and components: Box, Button, Card, Columns, Image, Link, Milestone, Progress Bar, Rich Text, Section, Side By Side.
Visibility
showWhen
Boolean
Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default: true.
Style
style
Text
Determines the overlay style. Valid values: "DARK" (default), "SEMI_DARK", "NONE", "SEMI_LIGHT", "LIGHT".
Padding
padding
Text
Determines the space between the overlay's edges and its contents. Valid values: "NONE", "EVEN_LESS", "LESS", "STANDARD"(default), "MORE", "EVEN_MORE".
ExamplesCopy link to clipboard
Click EXPRESSION to copy and paste an example into the Interface Definition to see it displayed.
Full overlay with intro messageCopy link to clipboard
a!billboardLayout(
backgroundMedia: a!documentImage(
document: a!EXAMPLE_BILLBOARD_IMAGE()
),
backgroundcolor: "#073763",
marginBelow: "STANDARD",
overlay: a!fullOverlay(
alignvertical: "MIDDLE",
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(text: {"Hello, " & user(loggedinuser(), "firstName") & "."}, size: "MEDIUM"),
char(10),
a!richTextItem(text: {"What do you need help with?"}, size: "LARGE")
},
align: "CENTER"
)
},
style: "DARK"
)
)
| Solve the following leet code problem |
Side By Side Item
| FunctionCopy link to clipboard
a!sideBySideItem( item, width, showWhen )
Displays one item within a side by side layout.
See also:
Side By Side Layout
Side By Side and Columns design guidance
Side By Side design guidance
ParametersCopy link to clipboard
Name Keyword Types Description
Item
item
Any Type
The component to display inside the layout.
Width
width
Text
Determines the amount of space allocated to each of the items in the row. Valid values: "AUTO" (default), "MINIMIZE", "1X", "2X", "3X", "4X", "5X", "6X", "7X", "8X", "9X", and "10X".
Visibility
showWhen
Boolean
Determines whether the component or layout is displayed on the interface. When set to false, the component or layout is hidden and is not evaluated. Default: true.
Usage considerationsCopy link to clipboard
Accepted widths and fieldsCopy link to clipboard
Most fields are allowed for Item, except for grids, hierarchy browsers, the org chart, and layouts.
The "MINIMIZE" width is appropriate for items with a fixed width, such as images or buttons. Use relative widths for items whose width is determined by the containing layout or user interaction, such as text inputs or dropdowns. For further explanation and examples, see UX Side by Side Guidance.
ExamplesCopy link to clipboard
Copy and paste an example into an Appian Expression Editor to experiment with it.
Input fields with relative widthsCopy link to clipboard
a!sideBySideLayout(
items: {
a!sideBySideItem(
width: "4X",
item: a!textField(
label: "First Name"
)
),
a!sideBySideItem(
item: a!textField(
label: "M.I."
)
),
a!sideBySideItem(
width: "4X",
item: a!textField(
label: "Last Name"
)
)
}
)
Displays the following:
screenshot of inputs of different widths
Minimized width for icon and buttonCopy link to clipboard
a!sideBySideLayout(
alignVertical: "MIDDLE",
spacing: "DENSE",
items: {
a!sideBySideItem(
width: "MINIMIZE",
item: a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: a!richTextIcon(
icon: "user",
size: "LARGE"
)
)
),
a!sideBySideItem(
item: a!textField(
labelPosition: "COLLAPSED"
)
),
a!sideBySideItem(
width: "MINIMIZE",
item: a!buttonArrayLayout(
marginBelow: "NONE",
buttons: {
a!buttonWidget(
label: "Check Availability",
size: "SMALL",
style: "OUTLINE",
color: "SECONDARY"
)
}
)
)
}
)
Displays the following:
screenshot of inputs using minimized widths
Feature compatibilityCopy link to clipboard
The table below lists this SAIL component's compatibility with various features in Appian.
Feature Compatibility Note
Portals Compatible
Offline Mobile Compatible
Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible
Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports Incompatible
Cannot be used to configure a process report.
Process Events Incompatible
Cannot be used to configure a process event node, such as a start event or timer event.
Related PatternsCopy link to clipboard
The following patterns include usage of the Side By Side Item.
Activity History Pattern (Formatting): The Activity History pattern provides a common style and format for displaying an organization's activity measures.
Alert Banner Patterns (Choice Components): The alert banners pattern is good for creating a visual cue of different types of alerts about information on a page.
Cards as List Items Patterns (Choice Components, Images): Use the cards as list items pattern to create visually rich lists as an alternative to grids or feeds. This pattern uses a combination of cards and billboards to show lists of like items. You can easily modify the pattern to change the card content or the number of cards per row to fit your use case.
Comments Patterns (Comments, Looping): Use this pattern when displaying a chronological list of messages from different users, such as comments on a topic or notes on a case.
Document List (Documents): Use the document list items pattern to display a list of documents that can be searched and filtered. This pattern uses a combination of cards and rich text to show an easy to navigate list of documents of different types.
Duration Display (Rich Text, Events): Use the duration display pattern to show the amount of time in between events in a quick, easy-to-read way.
Dynamic Inputs (Inputs, Dynamic Links): Use the dynamic inputs pattern to allow users to easily add or remove as many values as needed.
Event Timelines (Timeline, Events): Use the event timeline pattern to display a dated list of events and actions in chronological order. This pattern uses a combination of cards, rich text, and user images to show an easy to navigate list of dated events.
Inline Tags for Side-by-Side Layout Pattern (Formatting): This pattern shows the best practice for combining tags with standard-sized rich text, or plain text, using a side by side layout.
KPI Patterns (Formatting): The Key Performance Indicator (KPI) patterns provide a common style and format for displaying important performance measures.
Leaderboard (Looping): Use the leaderboard pattern to show a selection of your data in an easy to read ranked display.
Limit the Number of Rows in a Grid That Can Be Selected (Validation, Grids, Records): Limit the number of rows that can be selected to an arbitrary number.
Milestone Patterns (Looping): There are three options for milestone patterns which all display some form of a progress indicator to guide users through a series of steps.
Navigation Patterns (Conditional Display, Formatting, Navigation): Use the navigation patterns to help orient users and enable them to easily navigate pages and content.
Refresh Data After Executing a Smart Service (Auto-Refresh, Smart Services):
Stamp Steps (Stamps): There are two similar stamp steps patterns. The stamp steps (icon) pattern is primarily icons and titles. It should be used for simple steps that don't require much information or instruction. The stamp steps (numbered) pattern is primarily text and should be used for steps that require context or explanation.
Trend-Over-Time Report (Charts, Reports): This report provides an attractive, interactive design for exploring different series of data over time.
User List Pattern (Looping): The user list pattern retrieves all the users in a specified group and displays them in a single column.
Year-Over-Year Report (Charts, Reports, Formatting): This is a feature-rich, interactive report for sales and profits by products over select periods of time.
| Solve the following leet code problem |
Design Objects.
Applications contain a set of objects that function together to meet one or several business use cases. Applications allow these objects to be deployed from one environment to another.
When an object is created, it is assigned a universally unique identifier (UUID). This internal (hidden) property is not editable or configurable.
Each design object provides a specific piece of functionality, and each application contains many objects grouped by common purpose. Technically, applications do not contain these objects, but simply have a list of objects that are associated with them. The Objects view shows a list of objects ignoring the application association. The following sections describe each Appian object.
| Data objectsCopy link to clipboard
Record types, data stores and custom data types (CDTs) are all data-centric objects. Their icons will appear orange in grids and other displays in Appian Designer.
Data StoreData StoreCopy link to clipboard
A data store is a reference to an external relational database that is used to store application data. Each data store contains one or more data entities that correspond to a table in the database. When saving data from Appian to an external database, the data store defines the connection to the database, while data types define the structure of the data entity being stored.
Data TypeData TypeCopy link to clipboard
As opposed to a primitive or system data type, a custom data type (CDT) is a developer-defined data structure. Data Types allow designers to create a logical grouping of related data that can then be used by other objects to share data. Data can be shared internally, for instance between an interface and process model, or a web service that uses a CDT.
Because a data type will always be used in context of another object, it does not have individual security settings.
Record TypeRecord TypeCopy link to clipboard
A record type brings together all the data on a single topic and displays it in a series of record views. Records provide a centralized view of a given business function, along with all of its connections to related records.
Attaching process models to record views as related actions allows users to immediately take action on the information shown in the record view.
Process objectsCopy link to clipboard
Process models and process reports can be considered process-centric. Process models define how a process will function while process reports allow users access to data from the process. Process object icons will appear dark blue in grids and other displays in Appian Designer.
Process ModelProcess ModelCopy link to clipboard
A process model is the primary tool in Appian for describing a workflow. Developers graphically lay out the workflow, which may assign user tasks, manipulate data, post system events, or update other design objects. Process models are frequently used with record types to provide users with tools to act on the information shown by the record.
Process ReportProcess ReportCopy link to clipboard
A process report displays data from active and recently completed processes and tasks. Developers can choose to create process reports from scratch or pick from one of several dozen of out-of-the-box report templates.
Robotic TaskRobotic TaskCopy link to clipboard
A robotic task interacts with other applications through their front-end interfaces. Use them to automate manual, repetitive tasks on systems that don't have the right APIs. Developers can integrate robotic tasks into their Appian applications to achieve complete automation.
Learn more about Appian RPA.
Robot Pool Robot PoolCopy link to clipboard
A robot pool enables you to group robots based on their unique roles and capabilities and ensure that there is always a robot available and ready to handle any robotic task execution. With several robots in each pool, each robot pool can even handle multiple executions simultaneously. When you're creating or updating a robotic task, you get to choose the appropriate robot pool responsible for executing the task.
User objectsCopy link to clipboard
Objects that are primarily involved with interactive user displays fall into this category. Interfaces, reports, and sites are all objects are created in order for users to interact with the application. Although record types provide user interaction functionality, the object also is a query-able source of data.
User object icons will appear Appian blue in grids and other displays in Appian Designer.
InterfaceInterfaceCopy link to clipboard
An interface is an object that returns one or more components to display on a record view, Tempo report, or process form. This is the primary object that designers use to show user interfaces to application users.
ReportReportCopy link to clipboard
A report displays data from tasks, records, and other data sources in a single interface for end users to view. Through the use of charts, grids, pictures, and the dynamic behavior that SAIL offers, a report offers a high-level overview of aggregated data.
SiteSiteCopy link to clipboard
A site is a customizable user interface where a developer can create focused work environments for signed-in users. When working in a site, users can view and submit tasks, view reports and records, and start actions.
PortalPortalCopy link to clipboard
A portal is a public web app that allows users access to Appian workflows and information without having to sign in to Appian. Portal users can submit or view information in a portal, and their actions can start processes in Appian.
A portal object allows you to configure the settings and content for your portal.
Rule objectsCopy link to clipboard
Rule-based objects are used in expressions to reference specific values and perform complex operations or queries. Expression rules, decisions, translation sets, and constants are all considered rule-based objects. Rule object icons will appear purple in grids and other displays in Appian Designer.
ConstantConstantCopy link to clipboard
A constant holds a single literal value or list of values. A constant allows you to define a value once and then use it in many places in an application. If the value needs to be updated in the future, it only needs to be updated in one location. Constants are also used to reference other design objects in expressions. The most common uses for constants include:
single primitive value
a list of text values
a reference to an Appian object
DecisionDecisionCopy link to clipboard
A decision is a grouping of business rules that answers a specific question based on inputs. Unlike expression rules, which primarily calculate or manipulate data. Decisions are best used to encapsulate complex, business-specific logic.
Decisions can be called from any expression, so they can be reused across multiple objects throughout the system.
Expression RuleExpression RuleCopy link to clipboard
An expression rule is a statement that evaluates to return a value, much like a spreadsheet function.
They are a stored expression that works like an Appian function, except that users can create their own rule inputs (to use as parameters) and definition.
AI SkillAI SkillCopy link to clipboard
Use the AI Skill to create, train, and use machine learning models in your applications. The AI Skill interface offers a low-code way to customize a model to your use case and specifications.
For example, train an AI Skill to classify documents that are passed to your process. Use the smart service output to route the process properly.
Translation set iconTranslation setCopy link to clipboard
The translation set object is a collection of translation strings that allow you to easily translate new and existing applications in multiple languages. Each translation string is a collection of values translated into multiple languages, and includes the necessary contextual information for developers or translators.
Translation strings can be used in any expression editor throughout an application using the translation! domain prefix and a reference to a specific translation string.
Integration objectsCopy link to clipboard
Whenever an application needs to interact with a third-party system or vice versa, developers can use as many as three different type of objects: an integration, a connected system, and/or a web API. Integration object icons will appear bright green in grids and other displays in Appian Designer.
Connected SystemConnected SystemCopy link to clipboard
A connected system makes it easy to connect to databases and external web services. They provide a central location to store authentication details and connection information. In fact, a number of authentication types can only be leveraged by using a connected system.
You can deploy connected systems across environments alongside an import customization file, allowing you to use different authentication information for each environment.
IntegrationIntegrationCopy link to clipboard
An integration can be used to call external systems and web services from Appian. Integrations can be called in expressions, interfaces, web APIs, and process models to query or modify data in external systems. They can inherit connection details from a connected system.
Web APIWeb APICopy link to clipboard
A web API provides a way to expose an Appian endpoint to an external system. When a client makes an HTTP request to the given URL, the associated expression is executed and the result is returned to the client. Web APIs can be used to push data to Appian, to pull data from Appian, and even to initiate Appian processes.
Group objectsCopy link to clipboard
Appian manages object permissions through group membership and system roles. Groups and group types are the objects that support security and permissions throughout the application. Group object icons will appear red in grids and other displays in Appian Designer.
GroupGroupCopy link to clipboard
A group allows developers to organize users, usually for the purpose of determining what permissions they have to design or use application objects and data. In addition, tasks and News entries can be targeted to one or more groups, as well as to individual users. A group can either be a custom group or use an existing group type (defined below), as well as a list of users and member groups that belong to it.
Group TypeGroup TypeCopy link to clipboard
A group type is used to organize groups, and can only be created by users of type System Administrator. For example, the Region group type allows a developer to organize their sales teams by creating a different Region group for each sales team, for instance, Commercial West, Commercial East, Midwest.
Group types also define attributes that are shared across groups. For example, the group type Region might have a "regional VP" attribute. Then, each group of that group type would have a different value for the attribute, based on who that region's vice president is.
Content-management objectsCopy link to clipboard
Appian has a robust content management framework that allows developers to store and organize application content. For document management, there are three specific objects involved: knowledge centers, document folders, and documents. Icons for content-management objects will appear dark green in grids and other displays in Appian Designer.
Additionally, process model and rule folders exist to assist in the organization of those objects. Icons for these types of folders will appear the same color as the objects they organize.
DocumentDocumentCopy link to clipboard
A document is a file stored in Appian. Appian provides a management system for documents.
While process reports are stored as documents, they have a unique icon and are sorted and filtered as reports.
FolderFolderCopy link to clipboard
Folders allow you to organize your application content and centralize security settings. Design objects and documents can only belong to one folder at a time.
You can create folders within folders for multiple levels of organization. Items in a folder (including subfolders) are listed in both the folder view and the objects grid in either the Objects view or Build view.
Security settings for the folder apply to all items within it (with the exception of Process Model Folders). Folders created within other folders by default inherit security from their parent folder. Edit the security of the child folder to change this option: Inherit security from parent.
There are four types of folders to choose from (Rule, Process Model, Document, and Knowledge Center).
Document FolderDocument FolderCopy link to clipboard
Document folders can contain documents or other document folders.
Document folders can only be created within a knowledge center or within another document folder.
Knowledge CenterKnowledge CenterCopy link to clipboard
A knowledge center stores documents and document folders.
Rule FolderRule FolderCopy link to clipboard
Rule folders can store the following design object types:
Constant
Expression Rule
Interface
Decision
Integration
Rule Folder
Process Model FolderProcess Model FolderCopy link to clipboard
Process model folders can only store process models or other process model folders.
Note: Security set for a process model folder is not applied to its contents.
Notification objectsCopy link to clipboard
A feed object is created to support notifications on News in sites or Tempo. The feed icon will appear dark yellow in grids and other displays in Appian Designer.
FeedFeedCopy link to clipboard
A feed is a channel for delivering content to the News Feed in Tempo or Sites. Every post or event in the News Feed that isn't directly created by a user has a feed associated with it. Generally, developers use a separate feed for each topic for which their application creates events or comments.
| Solve the following leet code problem |
Appian Data Types
The data (process variables, node inputs, node outputs, rule inputs, data store entities, or constants) used by Appian must conform to certain data types.
Appian data types can be one of the system types or a custom data type built from an XML Schema Definition (XSD), Java object, or imported from a WSDL by the Call Web Service smart service.
| Any TypeCopy link to clipboard
The Any Type is a generic data type only available for use as an expression input for rules and certain expression functions, such as the if() function. It accepts data of any data type.
Data is stored in variables of this type by mapping an existing variable, rule, constant, or expression to its value.
Map TypeCopy link to clipboard
The map data type is for associative arrays that store data in key value pairs (e.g. a!map(key1: "value1", key2: "value2").
A map can be returned by a number of functions and objects or created using the function a!map(). The map type can also be selected as a variable type in process models.
Inside of a map, each key has an associated value and that value's type is preserved (i.e. the value is not variant-wrapped).
Primitive system data typesCopy link to clipboard
A system data type is a required format for data stored in Appian and includes primitive types and complex types. Each system data type can be used to store either a single value or a list of values.
The following primitive system data types are available.
BooleanCopy link to clipboard
Values include True / False.
1 is accepted as a literal value meaning Yes.
0 is accepted as a literal value meaning No.
The default value is null, which appears as [Empty Value] in a process variable. The output of an empty boolean value in an expression depends on the function used.
You can populate the value using results from the true() or false() functions.
The toboolean() function can be used to convert true/false and 0/1 values into a Boolean data type value.
See also: Casting
DateCopy link to clipboard
Data in a date format can be created using the date(year, month, date) function. Variables that have a date data type do not accept text string input.
The default value for a date is [Empty Value]. The minimum value is 1/1/1000, and maximum value is 12/31/9999. Dates values are not adjusted to a different time zone when saved or displayed.
Numerical and text values can be converted to a date value using the todate() function.
Date and TimeCopy link to clipboard
Variables that hold a Date and Time data type refer to a point in time that is the same for all users. Date and time variables do not accept text strings as input.
A Date and Time value is saved in Greenwich Mean Time (GMT) then converted to the end-user's time zone (accounting for daylight saving time) when displayed.
GMT is the default time zone used when evaluating expressions that include Date and Time values. You can specify a different time zone in your process model properties. The time zone used for display can be the user's preferred time zone, a globally specified time zone, or the time zone context.
If a function expects a Date and Time value, and you pass it a date, the date is automatically converted to a Date and Time value, using 12:00 am for the time component.
The Date and Time value is only converted to the end user's time zone when it is displayed in the following manner. (Use separate date values and time values if you do not want this conversion to take place.)
As a user input
When used in a calendar function
When cast to a string
See also Time Zone Context
Date and Time format data can be created using the datetime(year, month, date, hour, minute, second) function.
Numerical and text values can be converted to a Date and Time value using the todatetime() function.
See also: Appian Functions, Internationalization Settings
Encrypted TextCopy link to clipboard
This type is used to store an Encrypted Text value. An Encrypted Text value can be created in one of the following ways:
Entered by a user in a EncryptedTextField component
Generated in a plug-in using the EncryptionService public Java API
An Encrypted Text value is only decrypted when displayed as the value in an EncryptedTextField or within a plug-in using the EncryptionService public API.
A value of type Encrypted Text cannot be cast to any other type and no other type can be cast to it.
An encrypted value is larger than the corresponding plaintext value. Specifically, the value stored in memory or on disk will be the lowest multiple of 16 bytes that is greater than the size of the corresponding plaintext value in bytes.
An Encrypted Text value remains encrypted when stored on disk. The encryption key is unique to each installation.
The data type does not provide any additional access controls. Encrypted text entered by one user may be decrypted and displayed to another user if that other user has permission to view the interface in which the value is displayed.
See also: Encrypted Text Component
Number (Decimal)Copy link to clipboard
Holds numeric data stored as double precision floating-point decimal numbers. The default value is 0.0.
Decimal numbers can be created from text strings using the todecimal() function. When converted with this function, numbers less than -10,000,000 and greater than 10,000,000 are represented in scientific notation.
For forms, use one of the following Text Functions to display a decimal number as a default value to avoid rounding.
fixed()
text()
Also for forms, use the a!currency() function to localize a currency value based on a given ISO currency code.
See also: Text Functions
For PVs, if you enter a number that exceeds the maximum number of digits supported by double precision floating-points, the number is truncated down to the maximum number of digits when you save the process model. It does not provide you with a warning message if this occurs.
Number (Integer)Copy link to clipboard
Integer numbers can range from -2,147,483,647 to 2,147,483,647 (or from -231+1 to 231-1 in scientific notation).
The default value is 0 and the null value is -2\^31.
Integer numbers can be created from text strings using the tointeger() function.
When an arithmetic operation (such as an expression) creates a Number (Integer) value that exceeds the type's limits, the value wraps.
2147483647 + 10 = -2,147,483,639
2147483647 + 1 = -2147483648 - interpreted as null. When looking in the user interface at a process variable changed to this value, an [Empty Value] result is displayed.
When values that exceed the Number(Integer) range are passed through a user interface, the excessive value is changed.
In most cases, this is changed to a null value.
When a value that exceeds the Number(Integer) range is converted to Number(Integer) from a string in an engine server (such as when you convert text to an integer using the tointeger() function), the excessive value is changed to the maximum value.
On task forms, the Number Form Component prevents entry of values outside of the valid range.
If an expression is entered for a value and the Number Form Component is not mapped to a node input, any values that exceed 7 digits display in standard formatting with 7 digits of precision. For example, 2147483647 displays as 2147483000.
For PVs, if you enter a value that exceeds the Number(Integer) range, the integer will be replaced with a null value when you save the model. The Modeler does not provide you with a warning message if this occurs.
TextCopy link to clipboard
This type is used to store any UTF-8 text string. Numerical values can be entered into the text data type; however, data manipulation cannot be performed on the text data type (except for report aggregations). The default value is [Empty Value].
To display text, enclose it within double quotation marks ("").
TimeCopy link to clipboard
Time data can be created using the time(hour,minute,second) function. Variables that have a time data type do not accept text string input.
Time values are not adjusted to a different time zone when saved or displayed.
Complex System Data TypesCopy link to clipboard
The following complex system types are made available in the system to support smart services.
These types cannot be edited or deleted. Their XML structure is not guaranteed to remain the same from release to release.
ApplicationTestResultCopy link to clipboard
The ApplicationTestResult data type is designed to hold test result information for all expression rules in an application. This type also includes execution statistics for an individual application.
See also: ApplicationTestResult and Automated Testing for Expression Rules
DataSubsetCopy link to clipboard
The DataSubset data type is designed to hold the data returned by a query configured with a paging parameter.
It contains the following fields:
startIndex - This field holds a single Number(Integer) record.
batchSize - This field holds a single Number(Integer) record.
sort - This field holds multiple SortInfo records.
totalCount - This field holds a single Number(Integer) record.
data - This field holds multiple Any Type records.
identifiers - This field holds multiple Any Type records.
EntityDataCopy link to clipboard
The EntityData data type lets you define a target data store entity and the values to store in the target entity as an input value for the Write to Multiple Data Store Entities Smart Service.
It contains the following fields:
entity - This field holds a single Data Store Entity value in which the data to be updated is stored.
data - This field holds multiple Any Type values to store in the entity.
For example, a value of type EntityData where the entity and data values are stored as process variables could resemble the following:
a!entityData(entity: pv!ENTITY_OPPORTUNITIES, data: {pv!RadiationOpp, pv!NewBusinessOpp})
See also: Data Store Entity Data Type and Write to Multiple Data Store Entities Smart Service
EntityDataIdentifiersCopy link to clipboard
The EntityDataIdentifiers data type lets you define a target data store entity and the values to delete from the target entity as an input value for the Delete from Data Store Entities Smart Service.
It contains the following fields:
entity - This field holds a single Data Store Entity value in which the data to be deleted is stored.
identifiers - This field holds multiple Any Type values for the primary key values of the data to be deleted.
For example, a value of type EntityDataIdentifiers where the entity and data values are stored as process variables could resemble the following:
a!entityDataIdentifiers(entity: pv!ENTITY_OPPORTUNITIES, identifiers: {pv!RadiationOpp.id, pv!NewBusinessOpp.id})
Note: Make sure to use the primary key value IDs for the data rather than CDT values (for example, pv!opportunities.id rather than pv!opportunities). Using a CDT value will result in a casting error.
See also: Data Store Entity Data Type and Delete from Data Store Entities Smart Service
HealthCheckOutputCopy link to clipboard
The HealthCheckOutput data type is designed to hold the details of the latest Health Check run.
It contains the following fields:
startDateTime - This field of type Date and Time indicates when the latest Health Check run was started.
runStatus - This field of type Text indicates the status of the latest Health Check run. Possible values include: RUNNING, COMPLETED, FAILED, CANCELED, CANCELING.
zip - This field of type Document holds the zip file for the latest Health Check run.
report - This field of type Document holds the report for the latest Health Check run.
See also: a!latestHealthCheck()
IntegrationErrorCopy link to clipboard
The IntegrationError data type contains details on errors that occur when calling a web service or other integration via an Integration Rule.
It contains the following fields:
title - A short summary of the error or the error type.
message - A description of the error.
detail - Technical details about the error, including error codes or underlying error messages.
This data type is returned in any integration result if the integration returns an error. The response of the IntegrationError is dependent on information from the web service. For instance, suppose an API request returns a 400 - Bad Request error. The integration error may return a result like this:
title: 400 - Bad Request
message: The server cannot process the request due to an invalid request syntax
details: The request is missing a query parameter for dateRange to identify the start and end date to use in this query
In addition to the default response for an integration, the IntegrationError type can also be returned using the function a!integrationError().
LabelValueCopy link to clipboard
The LabelValue data type is designed to hold event labels and a nested hierarchy of subevent labels for use by the Post Event to Feed Smart Service and the Post System Event to Feed Smart Service.
It contains the following fields:
label - This field holds a single Text record.
value - This field holds multiple Any Type records.
LabelValueTableCopy link to clipboard
The LabelValueTable data type references the LabelValue type.
It contains the following field:
LabelValue - This field holds multiple LabelValue records.
ListViewItemCopy link to clipboard
Data type used to define the record list view for record types.
It contains the following fields:
image - This field of type Document or User defines the image to appear in the list view next to each item.Value must be entered as an expression. If left null or empty, the first two letters of the record title display. For image file types, a thumbnail of the document displays. For user values, the user's avatar displays.
title - This field of type Text defines the name or short text description of the item.
details - This field of type Text defines a longer text description of the item.
timestamp - This field of type Date and Time indicate the creation modification timestamp of the item. Valid values include variables for timestamp fields of the record such as creation timestamp, a last modified timestamp, or other timestamp.
See also: a!listViewItem()
FacetCopy link to clipboard
Data type produced when defining record user filters using expressions. See FacetOption for list options and configuration details.
See also: a!recordFilterList() and a!recordFilterDateRange()
FacetOptionCopy link to clipboard
Defines a list of options that a user can select from in a record user filter.
See also: a!recordFilterListOption()
ObjectTestResultCopy link to clipboard
The ObjectTestResult data type is designed to hold data for each of the expression rules with test cases.
See also: ObjectTestResult and Automated Testing for Expression Rules
PagingInfoCopy link to clipboard
The PagingInfo data type is designed to hold the paging configuration passed as a parameter to queries and the Read-Only Grid component.
It's used primarily as an argument for the todatasubset() and a!gridField() functions.
To create a value of type PagingInfo, use the a!pagingInfo() function.
See also: todatasubset() and a!pagingInfo()
ProcessInfoCopy link to clipboard
The ProcessInfo data type is designed to hold information about a running process. It contains three fields.
pp - A dictionary containing the properties of the process: id, name, priority, initiator, designer, start time, deadline, and timezone
pm - A dictionary containing the properties of the process' model at the time the process was started: id, name, description, version, creator, and timezone
pv - A dictionary containing the process variables of the process
See also: Process Model Properties, Process Variables, Start Process smart service.
QueryCopy link to clipboard
The Query data type defines the grouping, aggregation, filtering, paging, and sorting configuration to be applied when querying using a!queryEntity(). It also contains several supporting data types for each of these configurations.
Note: Process variables cannot be created as a Query data type.
It contains the following fields:
selection|aggregation (Selection or Aggregation) - This optional field determines the selections or grouping and aggregations for the query. Only one Selection or Aggregation value can be used. If neither are provided, all fields of the record type are returned.
See also: a!querySelection(), a!queryAggregation(), Selection and Aggregation
logicalExpression|filter|search (LogicalExpression, QueryFilter, or Search) - This optional field determines the filtration to apply to the query. Similar to the selection|aggregation field, only one value can be used. To include more than one filter, use the LogicalExpression data type with the AND operator. If none of them are provided, no filters will be applied.
See also: a!queryLogicalExpression(), a!queryFilter(), LogicalExpression, QueryFilter, and Search
pagingInfo - This required field holds a PagingInfo data type value and determines the paging configuration to use.
See also: a!pagingInfo(), PagingInfo
See also: a!query()
SelectionCopy link to clipboard
Data type accepted in the selection|aggregation field of the Query data type. It can contain one or more Column data types and should be used instead of an Aggregation data type when you just want to select the columns, rather than group them together or apply an aggregation function.
See also: a!querySelection()
ColumnCopy link to clipboard
The Column data type is only used in conjunction with the Selection data type.
It contains the following fields:
field - The field of the data type you want to retrieve. The fields available depend on the source of the data and the data type of that source. Fields that are children of a multiple cannot be selected. If the alias is not provided and the field name collides with another existing alias, the field name will be suffixed with an incremented digit appended to the end when returned in the result.
alias - (Optional) The short name by which the result of the Column value can be referenced in other areas of the query value. Values are case-sensitive. If no alias is given, the alias for the column will be inferred as the field value.
visible (Boolean) - (Optional) Determines whether the column should be visible to end users. If false, the data for the column will not be retrieved, but it can be used for sorting. Default value true.
See also: a!queryColumn()
AggregationCopy link to clipboard
Data type accepted in the selection|aggregation field of the Query data type. It can contain one or more AggregationColumn data types and should be used instead of a Selection data type when you want to perform a function on the selected columns. The following aggregation functions are supported: COUNT, SUM, AVG, MIN, and MAX.
See also: a!queryAggregation()
AggregationColumnCopy link to clipboard
The AggregationColumn data type is only used in conjunction with the Aggregation data type.
It contains the following fields:
field - The dot-notation to the field of the data, such as a record type, you want to group together and/or aggregate. The fields cannot be complex or multiple values.
alias - The short name by which the result of the AggregationColumn value can be referenced in other places of the Query value. Values are case-sensitive.
visible (Boolean) - (Optional) Determines whether the grouping or aggregation column should be visible to end users. If false, the data for the column will not be retrieved, but it can be used for sorting. Default value is true.
isGrouping (Boolean) - (Optional) Determines whether the field should be grouped. Default value is false.
aggregationFunction - The function to use when aggregating the field. Valid values include COUNT, SUM, AVG, MIN, and MAX. This value is required when isGrouping is set to false.
See also: a!queryAggregationColumn()
LogicalExpressionCopy link to clipboard
Data type that determines the filtration to apply.
It contains the following fields:
operator - Determines the operation to apply to the set filters in the logicalExpression|filter|search value. Currently the only valid values are AND and OR.
logicalExpression|filter|search (LogicalExpression, QueryFilter, or Search) - Nested LogicalExpression or QueryFilter values that will be operated on based on the operator value.
See also: a!queryLogicalExpression()
QueryFilterCopy link to clipboard
This data type is required to configure the filter options for a!pickerFieldRecords, a!query, a!queryRecordType, a!recordData, and a!recordFilterListOption.
It contains the following fields:
field - The dot notation to the field that you want to apply the filter to.
operator - The operator to apply to the filter. Valid values include =, <>, >, >=, <, <=, between, in, not in, is null, not null, starts with, not starts with, ends with, not ends with, includes, not includes.
value - The value to compare to the given field using the given operator. Optional if the operator value is is null or not null. If the operator value is between, the value must be a list of only two elements with the lower bound as the first element and the upper bound as the second.
See also: a!queryFilter(), a!queryRecordType(), a!recordData()
SearchCopy link to clipboard
Data type that indicates a user's search term. Used in the logicalExpression|filter|search field of a Query or LogicalExpression data type.
It contains a single field:
searchQuery - The text value to look for.
SaveCopy link to clipboard
The Save data type is designed to be used in conjunction with the a!save() function to create reusable custom components.
See also: a!save()
SortInfoCopy link to clipboard
The SortInfo data type is referenced by the PagingInfo and DataSubset types and determines how data is sorted in a subset.
To create a value of type SortInfo, use the a!sortInfo() function.
See also: a!sortInfo(), PagingInfo, and DataSubset
TestCaseResultCopy link to clipboard
The TestCaseResult data type is designed to hold data for each of the test cases in an object.
See also: TestCaseResult and Automated Testing for Expression Rules
TestRunResultCopy link to clipboard
The TestRunResult data type is designed to hold test statistics for a test run across all applications being tested.
See also: TestRunResult and Automated Testing for Expression Rules
WriterCopy link to clipboard
The Writer data type is a special data type returned by expression functions that intend to modify data. The modification of data must not happen during expression evaluation, so these functions return a Writer, which is then handled in a special way during the phase of an interface evaluation where saving into variables takes place. The Writer data type has no impact during expression evaluation - no data is written by the function that returns a writer until a variable created with the bind function is saved into an interface.
It contains the following fields:
name - The name of the function that returned the writer
parameters - The parameters that will be used when the writer executes the data update
See also: bind() and Writer Functions
Appian Object Data TypesCopy link to clipboard
An Appian Object data type is a required format for objects specific to the Appian system. Similar to primitive and complex system types, each can be used to store either a single value or a list of values.
Appian Object data types are only recognizable within the Appian system.
ApplicationCopy link to clipboard
Holds an integer ID number that represents an Appian application. It can be used as a rule input to expression rules or interfaces; it can also be used as a constant and referenced from interfaces, web APIs, and process models; and finally used as a process variable from the Process Modeler, or as inputs to the Start Rule Tests (Applications) - Smart Service. Custom data types cannot use this data type.
Classification ResultCopy link to clipboard
Stores data for each prediction made by the Classify Documents and Classify Emails smart services.
Each prediction result is stored in the Above Threshold, Below Threshold, or Failed outputs in these smart services, based on what the user enters as the confidence threshold in the smart service input. Above Threshold and Below Threshold outputs contain the document ID, class, and confidence score for each prediction. The Failed output contains the document ID and error message for each failed prediction.
See also: AI skill object
Connected SystemCopy link to clipboard
Holds an integer ID number that represents a connected system. A connected system represents an external system that is integrated with Appian.
See also: Connected System Objects
Data Store EntityCopy link to clipboard
Holds an integer ID number that represents a data store entity. Data store entities are named, typed storage units within a data store. They can map to one or more tables in an external database.
It can only be applied to process variables and cannot be used to save form data from a mobile form. Data store entity IDs are not reused if the entity is deleted.
See also: Data Stores
DocumentCopy link to clipboard
Holds an integer ID number that represents a document in Document Management. It can be used to save form data selected from a dropdown, radio button, or checkbox field input on a mobile form.
If the ID number of a document is known, you can convert it to this data type using the todocument() function. Document IDs are not reused if the document is deleted.
See also: Document Management
Document Management CommunityCopy link to clipboard
Holds an integer number that represents a Document Management Community ID.
If the ID of a Community is known, you can convert it to this data type using the tocommunity() function. Community IDs are not reused if the community is deleted.
It cannot be used to save form data from a mobile form.
Document or FolderCopy link to clipboard
Holds an integer ID number that represents a document or a folder that exists within Document Management. Document or folder IDs are not reused if the object is deleted.
It cannot be used to save form data from a mobile form.
Email AddressCopy link to clipboard
Holds data formatted as an email address. Variables that hold it do not accept text strings as direct input.
Email address data can be created from text strings using the toemailaddress() function.
Use the email recipient data type if you are sending email from a process.
It cannot be used to save form data from a mobile form.
Email RecipientCopy link to clipboard
Email address data must be converted to email recipient data for use by the Send E-Mail smart service.
This is done with the toemailrecipient() function, which accepts email address data, user data, or group data.
It cannot be used to save form data from a mobile form.
FolderCopy link to clipboard
Holds an integer ID number that represents a folder that exists within Document Management. It can be used to save form data selected from a dropdown, radio button, or checkbox field input on a mobile form.
If the ID number of a folder is known, you can convert it to this data type using the tofolder() function. Folder IDs are not reused if the folder is deleted.
GroupCopy link to clipboard
Holds an integer ID number that represents a group within the system.
It can be used as a record field type for record types with data sync enabled. It can also be used to save form data selected from a dropdown, radio button, or checkbox field input on a mobile form.
Tip: As a best practice, you should select Group as the record field type for fields with integer values that represent a group. This will not impact how you reference the record field, and it will allow you to use the fields in your record-level security configuration.
If the ID of a group is known, you can convert it to this data type using the togroup() function. A group ID may be reused if the group is deleted.
See also: Creating Groups
Knowledge CenterCopy link to clipboard
Holds an integer ID number that represents a Knowledge Center in Document Management.
If the ID number of a Knowledge Center is known, you can convert it to this data type using the toknowledgecenter() function. Knowledge Center IDs are not reused if it is deleted.
It cannot be used to save form data from a mobile form.
PortalCopy link to clipboard
Holds the definition of a portal.
You can use the portal object reference domain, portal!, to call a portal as a parameter value for functions related to portals, such as a!urlForPortal().
You can't use a constant to reference a portal, instead use the portal! domain.
Portal PageCopy link to clipboard
Holds the definition of a portal page. Portal pages are referenced using portal!portalName.pages.portalPageName. See Referencing portal pages for more information.
ProcessCopy link to clipboard
Holds the integer ID number of an instance of a process model.
Process ModelCopy link to clipboard
Holds the integer ID number of a process model. Each time a process model is launched, it runs as a separate process.
A process model ID may be reused if the process model is deleted.
Record ActionCopy link to clipboard
This data type points to an action configured on a record type, which makes it possible to reference the action's properties like the display name, key, description, icon, process model, and visibility configuration. References to this data type are used as the value of the action parameter in the a!recordActionItem() to display actions as interface components. Record actions are referenced using recordType!recordTypeName.actions.actionName.
Record DataCopy link to clipboard
The data type returned for the a!recordData() function. This reference is used to define the record type and filters for a grid or chart.
See a!recordData() for more information.
Record FieldCopy link to clipboard
Holds the definition of a record field. Record field references, like those defined in the fields parameter of a!queryRecordType(), use this type to define the data that is returned in a query or displayed in a grid or chart. Record fields are referenced using recordType!recordTypeName.fields.fieldName.
Record IdentifierCopy link to clipboard
Holds a record definition used to configure a link to the record in an interface such as a news post.
You can only create constants of this data type. Process variables cannot be created of this type, and custom data types cannot be saved as this type.
To create a value of type Record Identifier, use the a!toRecordIdentifier function. To create a value of type Record Identifier for a User record, use the a!userRecordIdentifier function.
See also: a!toRecordIdentifier() and a!userRecordIdentifier()
Values of type Record Identifier are used as inputs for the Post Event to Feed Smart Service and Post System Event to Feed Smart Service to specify the record tags for an event.
See also: Post Event to Feed Smart Service and Post System Event to Feed Smart Service
Record RelationshipCopy link to clipboard
Holds the definition of a record type relationship. These definitions are used to reference related record types in functions like a!relatedRecordData to sort, limit, or filter a query based on the value of a record's related data. Record relationships are referenced using recordType!recordTypeName.relationships.relationshipName.
Record TypeCopy link to clipboard
Holds the definition of a record type.
You can use the record type object reference domain, recordType!, to call a record type as a parameter value for functions related to records, such as a!queryRecordType(), queryRecordByIdentifier(), and urlforrecord().
Although you can still use a constant to reference your record type, the recordType! domain eliminates the need to create this additional object.
See urlforrecord(), Constants, a!queryRecordByIdentifier(), and a!queryRecordType() for more information.
ReportCopy link to clipboard
Holds an integer ID number that represents a report within the system.
Constants of type Report are commonly used as parameter values for report links.
SafeURICopy link to clipboard
Holds a URI value and enforces security rules during casting.
When casting from Text, the string will fail verification if it contains any of the following:
Any scheme other than http, https, ftp, tel, and mailto.
Invalid URI characters if not already escaped.
Empty text string.
A mailto value that contains an apostrophe.
The string does not change when cast to or from a Text data type.
This data type cannot be used in expressions for events or process reports.
See also: Safe Link: Link type that accepts SafeURI values to create an external link.
SiteCopy link to clipboard
Holds the definition of a site.
You can use the site object reference domain, site!, to call a site as a parameter value for functions, such as a!urlForSite().
You can't use a constant to reference a site, instead use the site! domain.
Site PageCopy link to clipboard
Holds the definition of a site page. Site pages are referenced using site!siteName.pages.sitePageName. See Reference a Site Page for more information.
TaskCopy link to clipboard
Holds the integer ID number of a process task.
It can be used to add a link to the Read-Only Grid component that opens a process task in Tempo.
See also: Read-Only Grid
Task ReportCopy link to clipboard
Holds an integer ID number that represents a task report within the system.
Constants of type Task Report are commonly used as parameter values for report links.
UserCopy link to clipboard
Holds an Appian user account ID number.
It can be used as a record field type for record types with data sync enabled. It can also be used to save form data selected from a dropdown, radio button, or checkbox field input on a mobile form.
Tip: As a best practice, you should select User as the record field type for fields with text values that represent users. This will not impact how you reference the record field, and it will allow you to use the field in your record-level security configuration.
See also: User Management
User or GroupCopy link to clipboard
Holds an Appian user account or group. It is sometimes referred to as a People data type.
It can be used to save form data selected from a dropdown, radio button, or checkbox field input on a mobile form.
User FilterCopy link to clipboard
Holds the definition of an end-user filter configured for a record type. A user filter can be applied by users viewing the record list or a records-powered grid as a convenient way to limit the list of records. User filters are referenced using recordType!recordTypeName.filters.filterName. Learn how to create user filters.
Record Data TypesCopy link to clipboard
This data type holds the data definition for all of the fields in a record type (or a subset of fields defined by your record type configuration), as well as the data values for the record.
When you make changes to the record type object, the record data type is also updated and stays current with any configuration changes you make. For example, if you change the name of a record field on a record type, the change is also captured on the record data type.
Note: Renaming record fields is available for record types with data sync enabled.
The record data type allows you to easily pass record data to your interfaces, records-powered components, and expression rules.
Learn more about using records in your apps:
Build Reports from Records
Configure Charts Using Records
Configure the Read-Only Grid
Referencing record data in an expression
Custom Data Types (CDTs)Copy link to clipboard
Designers can create or import their own custom data types (CDTs). These organize data into a structure that represents a logical grouping of related data, such as Employee and Contract.
For more information about creating and editing data types, see Custom Data Types (CDTs)
Mapping DataCopy link to clipboard
Careful attention must be paid to data types when passing the values from one variable to another (also called mapping data).
The variables used at the node level are called node inputs and node outputs. A node is often referred to as an activity. A node input or output can also be called an Activity Class. These variables can be mapped into process variables, enabling Process Modelers to access the variables in other nodes within the process model and pass the data to other processes and subprocesses. The following properties must be taken into consideration when mapping node inputs/outputs to process variables.
Appian does not support a direct mapping of data from one type into another, regardless of whether the data values are compatible. You can use an expression to cast a variable from one type into another and then save the result into a new variable.
Appian allows you to map variables that only store single values into variables that can store multiple values using a custom output on the output tab, but not when using results listed on the output tab. Results must match according to data type and whether the data type holds multiple values (its cardinality).
Mapping scalars (single values) to vectors (multiple values) is only applicable when mapping process variables. Therefore, vector values cannot be set as default values in a scalar variable. For example, a variable cannot be given the default value {1,6,9,8} if the variable does not support multiple values.
Data types also apply to rule inputs and constants, but data from a node input or a process variable cannot be mapped to a rule input or a constant.
See also: Casting
| Solve the following leet code problem |
The button is record field action and the grid is selectable. I would like to display the button in that row only which is selected. Can anyone please help me how to achieve this.
| {
a!localVariables(
local!employees: {
{id: 1, name: "Elizabeth Ward", dept: "Engineering", role: "Senior Engineer", team: "Front-End Components", pto: 15, startDate: today()-500},
{id: 2, name: "Michael Johnson", dept: "Finance", role: "Payroll Manager", team: "Accounts Payable", pto: 2, startDate: today()-100},
{id: 3, name: "John Smith", dept: "Engineering", role: "Quality Engineer", team: "User Acceptance Testing", pto: 5, startDate: today()-1000},
{id: 4, name: "Diana Hellstrom", dept: "Engineering", role: "UX Designer", team: "User Experience", pto: 49, startDate: today()-1200},
{id: 5, name: "Francois Morin", dept: "Sales", role: "Account Executive", team: "Commercial North America", pto: 15, startDate: today()-700},
{id: 6, name: "Maya Kapoor", dept: "Sales", role: "Regional Director", team: "Front-End Components", pto: 15, startDate: today()-1400},
{id: 7, name: "Anthony Wu", dept: "Human Resources", role: "Benefits Coordinator", team: "Accounts Payable", pto: 2, startDate: today()-300}
},
local!selectedEmployee,
local!selectedId,
local!isButtonSelected,
{
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!sectionLayout(
label: "Employees",
contents: {
a!gridField(
data: todatasubset(
local!employees,
fv!pagingInfo
),
columns: {
a!gridColumn(
label: "Name",
value: fv!row.name
),
a!gridColumn(
label: "Department",
value: fv!row.dept
),
/*Here you can replace this button with record action*/
a!gridColumn(
label: "Button",
value: a!buttonArrayLayout(
buttons:a!buttonWidget(
label:"Take Action",
style:"SOLID",
confirmMessage:"Do you want to take action?",
width:"MINIMIZE",
value:true,
saveInto: local!isButtonSelected,
/*Logic to show the button. */
showWhen:contains(tointeger(local!selectedId),fv!identifier)
))
)
},
pageSize: 7,
selectable: true,
selectionStyle: "CHECKBOX",
selectionValue: index(local!selectedEmployee, "id", {}),
selectionSaveInto: {
/*Storing id to enable the button*/
local!selectedId,
/*Below logic is for selecting only recently selected*/
/* This save replaces the value of the previously selected item with that of the newly selected item, ensuring only one item can be selected at once.*/
a!save(
local!selectedEmployee,
if(
length(fv!selectedRows) > 0,
fv!selectedRows[length(fv!selectedRows)],
null
)
),
a!save(
local!selectedId,
if(
length(fv!selectedRows) > 0,
fv!selectedRows[length(fv!selectedRows)].id,
null
)
),
},
shadeAlternateRows: false,
rowHeader: 1
)
}
)
}
),
a!columnLayout(
contents: {
}
)
},
stackWhen: {
"PHONE",
"TABLET_PORTRAIT"
}
)
}
)
}
| Solve the following leet code problem |
Code:
a!forEach(pv!addedResearchItems_cdt,
if(
and(rule!APN_isBlank(index(fv!item,"id",{})),rule!APN_isBlank(fv!item.url)),
cast('type!{urn:com:appian:types:gngp}GNGP_RESEARCH_ITEM',updatecdt(fv!item,{file_name:
if(not(isnull(fv!item.file_name)),
fv!item.file_name,
if(not(isnull(fv!item.document_id)),document(todocument(fv!item.document_id), "name") & "." & document(todocument(fv!item.document_id), "extension"),{})
)})),
fv!item
))
Getting below error:
(Expression evaluation error at function a!forEach: Error in a!forEach() expression during iteration 1: Expression evaluation error at function 'updatecdt' [line 5]: Length of input arrays must equal length of CDT/Dictionary array) (Data Outputs)
Please help to rectify the above error as what code changes needs to be done
| Make sure code returns a value to update or use a null check before
if(
not(isnull(fv!item.file_name)),
fv!item.file_name,
if(
not(isnull(fv!item.document_id)),
document(todocument(fv!item.document_id), "name") & "." & document(
todocument(fv!item.document_id),
"extension"
),
{}
)
)
| Solve the following leet code problem |
generate a calendar
| {
a!localVariables(
local!year: year(today()),
local!month: month(today()),
local!date: day(today()),
local!curD:today(),
local!darkMode: true(),
local!sampledate:a!refreshVariable(
value: date(local!year,local!month,local!date),
refreshOnVarChange:local!date
),
local!displayMonth: {
"January",
"February",
"March",
"April",
"May",
"June",
"July",
"August",
"September",
"October",
"November",
"December"
},
local!weekDay: weekday(day(local!year, local!month, 1)) - 1,
{
a!sectionLayout(
/*label: "Sectionnnn",*/
contents: {
a!cardLayout(
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: {
a!richTextIcon(
icon: "calendar"
),
" Calendar"
},
size: "MEDIUM_PLUS",
style: {
"STRONG"
}
)
}
)
}
)
}
)
},
height: "AUTO",
style: "TRANSPARENT",
shape: "ROUNDED",
marginAbove: "LESS",
marginBelow: "MORE",
showBorder: false,
showShadow: true,
decorativeBarPosition: "BOTTOM",
decorativeBarColor: rule!PK_GenericColorConfig(
Key: { "calenderColor", "bgCurrentDate" },
darkMode: ri!darkMode
)
),
a!cardLayout(
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextIcon(
icon: "angle-double-left-bold",
link: a!dynamicLink(
label: "Prev Year",
value: local!year - 1,
saveInto: local!year
),
linkStyle: "STANDALONE",
color: "#434343",
size: "MEDIUM_PLUS"
)
},
align: "CENTER",
marginAbove: "NONE",
marginBelow: "NONE"
)
},
width: "EXTRA_NARROW"
),
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextIcon(
icon: "angle-double-left-bold",
link: a!dynamicLink(
value: if(local!month = 1, 12, local!month - 1 ),
saveInto: if(
local!month = 1,
{
a!save(local!year, local!year - 1),
local!month
},
local!month
)
),
linkStyle: "STANDALONE",
color: "#434343",
size: "MEDIUM"
),
" ",
a!richTextItem(text: "MONTH", style: "STRONG"),
" ",
a!richTextIcon(
icon: "angle-double-right-bold",
link: a!dynamicLink(
label: "Next year",
value: if(local!month = 12, 1, local!month + 1 ),
saveInto: {
if(
local!month = 12,
{
a!save(local!year, local!year + 1),
local!month
},
local!month
)
}
),
linkStyle: "STANDALONE",
color: "#434343",
size: "MEDIUM"
)
},
align: "CENTER",
marginAbove: "LESS"
)
/*a!dropdownField(*/
/*label: "",*/
/*labelPosition: "ABOVE",*/
/*placeholder: "--- Select a Value ---",*/
/*choiceLabels: local!MonArr,*/
/*choiceValues: {1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12},*/
/*value: local!month,*/
/*saveInto: {local!month},*/
/**/
/*searchDisplay: "AUTO",*/
/*validations: {}*/
/*)*/
},
width: "NARROW_PLUS"
),
a!columnLayout(
contents: {
a!richTextDisplayField(
value: {
a!richTextItem(
text: {
upper(index(local!displayMonth, local!month, {})),
" ",
local!year
},
size: "MEDIUM",
style: "STRONG"
)},
align: "CENTER"
)
},
width: "MEDIUM"
),
a!columnLayout(
contents: {
},
width: "NARROW"
),
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextIcon(
icon: "angle-double-right-bold",
link: a!dynamicLink(
label: "Next year",
value: local!year + 1,
saveInto: local!year
),
linkStyle: "STANDALONE",
color: "#434343",
size: "MEDIUM_PLUS"
)
},
align: "CENTER",
marginAbove: "NONE"
)
},
width: "EXTRA_NARROW"
)
},
alignVertical: "TOP"
),
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: { " Sun" },
color: rule!PK_GenericColorConfig(
Key: { "calendarBgColors", "nameOfDay" },
darkMode: ri!darkMode
),
style: { "STRONG" }
)
},
align: "CENTER"
)
}
),
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: { " Mon" },
color: rule!PK_GenericColorConfig(
Key: { "calendarBgColors", "nameOfDay" },
darkMode: ri!darkMode
),
style: { "STRONG" }
)
},
align: "CENTER"
)
}
),
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: { " Tue" },
color: rule!PK_GenericColorConfig(
Key: { "calendarBgColors", "nameOfDay" },
darkMode: ri!darkMode
),
style: { "STRONG" }
)
},
align: "CENTER"
)
}
),
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: { " Wed" },
color: rule!PK_GenericColorConfig(
Key: { "calendarBgColors", "nameOfDay" },
darkMode: ri!darkMode
),
style: { "STRONG" }
)
},
align: "CENTER"
)
}
),
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: { " Thu" },
color: rule!PK_GenericColorConfig(
Key: { "calendarBgColors", "nameOfDay" },
darkMode: ri!darkMode
),
style: { "STRONG" }
)
},
align: "CENTER"
)
}
),
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: { " Fri" },
color: rule!PK_GenericColorConfig(
Key: { "calendarBgColors", "nameOfDay" },
darkMode: ri!darkMode
),
style: { "STRONG" }
)
},
align: "CENTER"
)
}
),
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: { "Sat " },
color: rule!PK_GenericColorConfig(
Key: { "calendarBgColors", "nameOfDay" },
darkMode: ri!darkMode
),
style: { "STRONG" }
)
},
align: "CENTER"
)
}
)
},
marginAbove: "NONE",
spacing: "DENSE",
stackWhen: { "NEVER" }
),
a!cardLayout(
contents: {
a!forEach(
items: enumerate(6),
expression: a!columnsLayout(
columns: a!localVariables(
local!index: fv!item,
local!week: weekday(date(local!year, local!month, 1)),
local!totdays: daysinmonth(local!month, local!year),
a!forEach(
items: enumerate(7) + 1,
expression: {
a!columnLayout(
contents: {
a!cardLayout(
contents: a!richTextDisplayField(
value: a!richTextItem(
text: {
if(
((fv!item + 1 + local!index * 7) - local!week) <= local!totdays,
if(
local!index = 0,
if(
fv!index < local!week,
null,
fv!item + 1 + local!index * 7 - local!week
),
fv!item + 1 + local!index * 7 - local!week
),
null
)
},
size: "MEDIUM",
style: "STRONG"
),
align: "CENTER"
),
link: a!dynamicLink(
label: "Clickable",
value: fv!item + 1 + local!index * 7 - local!week,
saveInto: {
local!date,
a!save(
ri!GridDate,
date(local!year,local!month,local!date)
)
}
),
style: {
if(
((fv!item + 1 + local!index * 7) - local!week) = day(today()),
rule!PK_GenericColorConfig(
Key: { "calenderColor", "bgCurrentDate" },
darkMode: ri!darkMode
),
if(
((fv!item + 1 + local!index * 7) - local!week) = day(local!sampledate),
"#7289da",
rule!PK_GenericColorConfig(
Key: { "calenderColor", "bgdateColor" },
darkMode: ri!darkMode
)
)
)
},
shape: "ROUNDED",
showBorder: false()
)
}
)
}
)
),
alignVertical: "MIDDLE",
spacing: "DENSE",
stackWhen: { "NEVER" }
)
)
},
height: "AUTO",
style: rule!PK_GenericColorConfig(
Key: { "bgColor", "bgCalendarColors" },
darkMode: ri!darkMode
),
shape: "ROUNDED",
marginBelow: "LESS",
showBorder: false,
decorativeBarPosition: "NONE",
decorativeBarColor: "#f5ddf8"
)
},
height: "AUTO",
style: rule!PK_GenericColorConfig(
Key: { "bgColor", "bgCalendarColors" },
darkMode: ri!darkMode
),
shape: "ROUNDED",
padding: "NONE",
marginAbove: "NONE",
marginBelow: "NONE",
showBorder: false,
showShadow: true,
decorativeBarColor: "#1d659c"
)
}
)
}
)
| Solve the following leet code problem |
I am getting an error trying to parse a list of docIds and convert it to a list of cdts I made. The cdt are of the form projectMouDocument{mouId(int), docId(int))
I pass in a static mouId and a list of docIds.
Heres my script for the output into a process variable that is a list of projectMouDocuments. I expect to get a list of projectMou documents from this.
a!forEach(
pv!documentIds,
cast( 'type!{urn:com:appian:types}DSC01_projectMouDocuments'(), a!map( docId: pv!mouId, mouId: tointeger(fv!item) ) )
)
Error in script task : An error occurred while evaluating expression: projectMouDocuments:a!forEach(pv!documentIds, cast('type!{urn:com:appian:types}DSC01_projectMouDocuments'(), a!map(docId:pv!mouId, mouId:tointeger(fv!item)))) (Expression evaluation error at function a!forEach: Error in a!forEach() expression during iteration 1: Expression evaluation error at function 'cast': Could not cast from DSC01_projectMouDocuments to Number (Integer). Details: CastInvalidCould not cast from DSC01_projectMouDocuments to Number (Integer). Details: CastInvalid) (Data Outputs)
| Based on the code you shared, it seems you're mapping docId to mouId and then mouId to the current item in documenIds. Is this intentional?
It's important to ensure that the pv!mouId data type matches the type of value it should hold. For example, if mouId represents a single integer value, then the CDT field should be an integer data type with a single value.
I'm sharing some code based on my understanding that docId and mouId should be mapped to their respective fields in the CDT.
a!forEach(
pv!documentIds,
'type!{urn:com:appian:types}DSC01_projectMouDocuments'(docId: tointeger(fv!item), mouId:pv!mouId )
)
| Solve the following leet code problem |