#Wed Feb 28 13:35:36 UTC 2024
function.documentation_appian_internal.listOfUnnamedType=List of [Unnamed Type]
function.documentation_appian_internal.unnamedType=[Unnamed Type]
systemrules.addadminstogroup.description=Adds administrators to a group. This function will only execute inside a saveInto or a Web API.
systemrules.addadminstogroup.parameter.group=The selected users will be added as administrators to this group.
systemrules.addadminstogroup.parameter.newadministrators=The users that will be added as administrators.
systemrules.addadminstogroup.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.addadminstogroup.parameter.onsuccess=A list of saves or an HTTP response to execute when the smart service executed successfully. Created with a\!save() or a\!httpResponse().
systemrules.addmemberstogroup.description=Adds members to a group. This function will only execute inside a saveInto or a Web API.
systemrules.addmemberstogroup.parameter.group=The selected users and groups will be added as members to this group.
systemrules.addmemberstogroup.parameter.newmembers=The users and groups that will be added as members.
systemrules.addmemberstogroup.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.addmemberstogroup.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.aggregationfields.description=Used to define a query against record data that performs an aggregation. Uses a\!grouping() and a\!measure() to define aggregate fields. See the [documentation](links.docs.systemrules.aggregationfields.doc) for guidance about when to use different querying methods.
systemrules.aggregationfields.parameter.groupings=List of fields to group by using a list of a\!grouping(). Grouping functions can only be used within the context of a\!queryRecordType().
systemrules.aggregationfields.parameter.measures=List of calculations to perform using a list of a\!measure(). Measure functions can only be used within the context of a\!queryRecordType().
systemrules.applycomponents.description=NOTE\: The new looping function a\!forEach() does everything a\!applyComponents() does but with easier syntax, better null handling, and streamlined support of SAIL components. | a\!applyComponents() calls a rule for each item in an array and returns an array of the results.
systemrules.applycomponents.parameter.array=Array of items to pass as parameters to the function. Use merge() to pass multiple arrays.
systemrules.applycomponents.parameter.arrayvariable=An uninitialized load variable. This parameter is optional and only needed if additions or removals are being made to the "array" parameter in a SAIL interface, in which case equivalent operations must be made to the array created in this variable by a\!applyComponents().
systemrules.applycomponents.parameter.function=Rule to call on each item in the array.
systemrules.areachartconfig.description=Contains configuration for how to display data in an area chart.
systemrules.areachartconfig.parameter.datalimit=Maximum number of data points to display on the chart. Default\: 100. Valid values\: 1-5000.
systemrules.areachartconfig.parameter.link=Link to execute when a user selects a data point on the chart. Use fv\!selection to pass context from the selection made on the chart to the link. Create a link using a\!dynamicLink().
systemrules.areachartconfig.parameter.measures=Defines the numerical calculations for data in the chart, configured using a\!measure(). If no measure is provided, a count of records shows as the measurement in the chart.
systemrules.areachartconfig.parameter.primarygrouping=Defines the field labels to display on the axis in the chart, configured using a\!grouping().
systemrules.areachartconfig.parameter.secondarygrouping=Defines the field labels to display in the series of stacked or overlapping data points in the chart, configured using a\!grouping()
systemrules.areachartconfig.parameter.showintervalswithnodata=Determines whether the axis in the chart displays date or time values that do not have a value associated with them. For example, show January, February, and March, even if February has no data. This parameter is only available when a Date, Time, or Date and Time field is used as the primary grouping. Default\: false.
systemrules.areachartconfig.parameter.sort=Use a\!sortInfo() to define a sort in ascending or descending order. Use the alias of any groupings or measures to sort by the values in the chart. Use a record field or related record field reference to sort by data that is not referenced in the chart.
systemrules.areachartfield.description=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. See [documentation](links.docs.systemrules.areachartfield.doc) for more details.
systemrules.areachartfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.areachartfield.parameter.allowdecimalaxislabels=Allows dependent (vertical) values to display as decimal numbers instead of integers. Default\: false.
systemrules.areachartfield.parameter.allowimagedownload=Determines if the chart download button displays on the chart. Default\: false.
systemrules.areachartfield.parameter.categories=Text, Date, or Date and Time array to display on the x-axis below each data point. If you are using an array of Date or Date and Time, make sure the data is sorted prior to using it as a category.
systemrules.areachartfield.parameter.colorscheme=Determines which color scheme to use in the chart. Use one of the following valid values\: "CLASSIC" (default), "MIDNIGHT", "OCEAN", "MOSS", "BERRY", "PARACHUTE", "RAINFOREST", "SUNSET" or define a custom color scheme using a\!colorSchemeCustom. See the [documentation](links.docs.systemrules.charts.param.colorScheme) for guidance on how to use color schemes.
systemrules.areachartfield.parameter.config=Configures how to display data on the chart, including fields used for calculations and grouping, using a\!areaChartConfig(). Only applies when using a record type as a source in the data parameter. See the [documentation](links.docs.systemrules.chartconfig.doc) for more details on how to configure a chart with a record type as the source.
systemrules.areachartfield.parameter.connectnulls=Determines whether to connect an area across null points, or render a gap between the two points on either side of the null. Default\: false.
systemrules.areachartfield.parameter.data=Reference to the record type used for the source of this chart. Can accept a\!recordData or a Record Type Reference.
systemrules.areachartfield.parameter.height=Determines the chart height. Valid values\: "MICRO", "SHORT", "MEDIUM" (default), "TALL". See the [documentation](links.docs.systemrules.charts.param.height) for guidance on using the MICRO size.
systemrules.areachartfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.areachartfield.parameter.instructions=Supplemental text about this field.
systemrules.areachartfield.parameter.label=Text to display as the field label.
systemrules.areachartfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.areachartfield.parameter.referencelines=Array of reference line values for each threshold to be defined on the chart. Configured using a\!chartReferenceLine().
systemrules.areachartfield.parameter.refreshafter=Refreshes chart data each time a specified event completes. Valid values\: "RECORD_ACTION".
systemrules.areachartfield.parameter.refreshalways=When true, chart data will be refreshed after each user interaction and each interval refresh. Default\: false.
systemrules.areachartfield.parameter.refreshinterval=How often chart data gets refreshed in minutes. When null, chart data will not be refreshed on an interval. Valid values\: 0.5, 1, 2, 3, 4, 5, 10, 30, 60.
systemrules.areachartfield.parameter.refreshonreferencedvarchange=When true, chart data will be refreshed each time the value of any variable referenced in the data parameter is updated. To refresh chart data when another variable that is not used within the data parameter, use refreshOnVarChange. Default\: true.
systemrules.areachartfield.parameter.refreshonvarchange=Refreshes the chart data each time any of these specific variables change. This allows you to refresh the chart data when a variable that is not referenced in the data parameter is updated. You can define either using a single variable (e.g. refreshOnVarChange\: local\!var1) or a list of variables (e.g. refreshOnVarChange\: {local\!var1, local\!var2}).
systemrules.areachartfield.parameter.series=Array of data series created with a\!chartSeries().
systemrules.areachartfield.parameter.showdatalabels=Determines if data values are displayed next to each data point. Default\: false.
systemrules.areachartfield.parameter.showlegend=Determines if a color legend displays below the chart. Default\: true.
systemrules.areachartfield.parameter.showtooltips=Determines if a tooltip displays the data value for each data point. Default\: true.
systemrules.areachartfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.areachartfield.parameter.stacking=Determines if series values display as stacked, or stacked to a height of 100% to show the contribution to the whole, or overlapping. Valid values\: "NORMAL" (default),  "PERCENT_TO_TOTAL", "NONE".
systemrules.areachartfield.parameter.xaxisstyle=Determines how to display the labels and axis separators for the X-Axis. Valid values\: "STANDARD" (default), "NONE".
systemrules.areachartfield.parameter.xaxistitle=Title for the independent (horizontal) axis.
systemrules.areachartfield.parameter.yaxismax=Determines the maximum displayed point on the vertical axis.
systemrules.areachartfield.parameter.yaxismin=Determines the minimum displayed point on the vertical axis.
systemrules.areachartfield.parameter.yaxisstyle=Determines how to display the labels, axis separators, and grid lines for the Y-Axis. Valid values\: "STANDARD" (default), "MINIMAL", "NONE".
systemrules.areachartfield.parameter.yaxistitle=Title for the dependent (vertical) axis.
systemrules.authorizationlink.description=Defines a link to authorize a user for a connected system that uses OAuth 2.0 Authorization Code. Links can be used in charts, grids, hierarchy browsers, images, link fields, milestones, pickers, and rich text.
systemrules.authorizationlink.parameter.connectedsystem=Connected system used to generate the authorization link. Provide the connected system value returned by an integration when the response indicates that the user needs to authorize.
systemrules.authorizationlink.parameter.label=Text associated with this link.
systemrules.authorizationlink.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.barchartconfig.description=Contains configuration for how to display data in a bar chart.
systemrules.barchartconfig.parameter.datalimit=Maximum number of data points to display on the chart. Default\: 100. Valid values\: 1-5000.
systemrules.barchartconfig.parameter.link=Link to execute when a user selects a data point on the chart. Use fv\!selection to pass context from the selection made on the chart to the link. Create a link using a\!dynamicLink().
systemrules.barchartconfig.parameter.measures=Defines the numerical calculations for data in the chart, configured using a\!measure(). If no measure is provided, a count of records shows as the measurement in the chart.
systemrules.barchartconfig.parameter.primarygrouping=Defines the field labels to display on the axis in the chart, configured using a\!grouping().
systemrules.barchartconfig.parameter.secondarygrouping=Defines the field labels to display in the stacking or grouped bars in the chart, configured using a\!grouping().
systemrules.barchartconfig.parameter.showintervalswithnodata=Determines whether the axis in the chart displays date or time values that do not have a value associated with them. For example, show January, February, and March, even if February has no data. This parameter is only available when a Date, Time, or Date and Time field is used as the primary grouping. Default\: false.
systemrules.barchartconfig.parameter.sort=Use a\!sortInfo() to define a sort in ascending or descending order. Use the alias of any groupings or measures to sort by the values in the chart. Use a record field or related record field reference to sort by data that is not referenced in the chart.
systemrules.barchartfield.description=Displays numerical data as horizontal bars. Use a bar chart to display several values at the same point in time. See [documentation](links.docs.systemrules.barchartfield.doc) for more details.
systemrules.barchartfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.barchartfield.parameter.allowdecimalaxislabels=Allows dependent (horizontal) values to display as decimal numbers instead of integers. Default\: false.
systemrules.barchartfield.parameter.allowimagedownload=Determines if the chart download button displays on the chart. Default\: false.
systemrules.barchartfield.parameter.categories=Text to display on the x-axis next to each bar.
systemrules.barchartfield.parameter.colorscheme=Determines which color scheme to use in the chart. Use one of the following valid values\: "CLASSIC" (default), "MIDNIGHT", "OCEAN", "MOSS", "BERRY", "PARACHUTE", "RAINFOREST", "SUNSET" or define a custom color scheme using a\!colorSchemeCustom. See the [documentation](links.docs.systemrules.charts.param.colorScheme) for guidance on how to use color schemes.
systemrules.barchartfield.parameter.config=Configures how to display data on the chart, including fields used for calculations and grouping, using a\!barChartConfig(). Only applies when using a record type as a source in the data parameter. See the [documentation](links.docs.systemrules.chartconfig.doc) for more details on how to configure a chart with a record type as the source.
systemrules.barchartfield.parameter.data=Reference to the record type used for the source of this chart. Can accept a\!recordData or a Record Type Reference.
systemrules.barchartfield.parameter.height=Determines the chart height. Valid values\: "MICRO", "SHORT", "MEDIUM", "TALL", "AUTO" (default). See the [documentation](links.docs.systemrules.charts.param.height) for guidance on using the MICRO size.
systemrules.barchartfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.barchartfield.parameter.instructions=Supplemental text about this field.
systemrules.barchartfield.parameter.label=Text to display as the field label.
systemrules.barchartfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.barchartfield.parameter.referencelines=Array of reference line values for each threshold to be defined on the chart. Configured using a\!chartReferenceLine().
systemrules.barchartfield.parameter.refreshafter=Refreshes chart data each time a specified event completes. Valid values\: "RECORD_ACTION".
systemrules.barchartfield.parameter.refreshalways=When true, chart data will be refreshed after each user interaction and each interval refresh. Default\: false.
systemrules.barchartfield.parameter.refreshinterval=How often chart data gets refreshed in minutes. When null, chart data will not be refreshed on an interval. Valid values\: 0.5, 1, 2, 3, 4, 5, 10, 30, 60.
systemrules.barchartfield.parameter.refreshonreferencedvarchange=When true, chart data will be refreshed each time the value of any variable referenced in the data parameter is updated. To refresh chart data when another variable that is not used within the data parameter, use refreshOnVarChange. Default\: true.
systemrules.barchartfield.parameter.refreshonvarchange=Refreshes the chart data each time any of these specific variables change. This allows you to refresh the chart data when a variable that is not referenced in the data parameter is updated. You can define either using a single variable (e.g. refreshOnVarChange\: local\!var1) or a list of variables (e.g. refreshOnVarChange\: {local\!var1, local\!var2}).
systemrules.barchartfield.parameter.series=Array of data series created with a\!chartSeries().
systemrules.barchartfield.parameter.showdatalabels=Determines if data values are displayed next to each bar. Default\: false.
systemrules.barchartfield.parameter.showlegend=Determines if a color legend displays below the chart. Default\: true.
systemrules.barchartfield.parameter.showtooltips=Determines if a tooltip displays the data value for a bar. Default\: true.
systemrules.barchartfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.barchartfield.parameter.stacking=Determines if series values display as separate bars or stacked within one bar. Valid values\: "NONE" (default), "NORMAL", "PERCENT_TO_TOTAL".
systemrules.barchartfield.parameter.xaxisstyle=Determines how to display the labels and axis separators for the X-Axis. Valid values\: "STANDARD" (default), "NONE".
systemrules.barchartfield.parameter.xaxistitle=Title for the independent (vertical) axis.
systemrules.barchartfield.parameter.yaxismax=Determines the maximum displayed point on the horizontal axis.
systemrules.barchartfield.parameter.yaxismin=Determines the minimum displayed point on the horizontal axis.
systemrules.barchartfield.parameter.yaxisstyle=Determines how to display the labels, axis separators, and grid lines for the Y-Axis. Valid values\: "STANDARD" (default), "MINIMAL", "NONE".
systemrules.barchartfield.parameter.yaxistitle=Title for the dependent (horizontal) axis.
systemrules.barchartfield_21r4.description=This is an older version of the a\!barChartField() function. You can continue to use this version of the function by its new name\: a\!barchartfield_21r4(). The new version of a\!barChartField() has new functionality. Displays numerical data as horizontal bars. Use a bar chart to display several values at the same point in time. See [documentation](links.docs.systemrules.barchartfield.doc) for more details.
systemrules.barchartfield_21r4.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.barchartfield_21r4.parameter.allowdecimalaxislabels=Allows dependent (horizontal) values to display as decimal numbers instead of integers. Default\: false.
systemrules.barchartfield_21r4.parameter.categories=Text to display on the x-axis next to each bar.
systemrules.barchartfield_21r4.parameter.colorscheme=Determines which color scheme to use in the chart. Use one of the following valid values\: "CLASSIC" (default), "MIDNIGHT", "OCEAN", "MOSS", "BERRY", "PARACHUTE", "RAINFOREST", "SUNSET" or define a custom color scheme using a\!colorSchemeCustom. See the [documentation](links.docs.systemrules.charts.param.colorScheme) for guidance on how to use color schemes.
systemrules.barchartfield_21r4.parameter.config=Configures how to display data on the chart, including fields used for calculations and grouping, using a\!barChartConfig(). Only applies when using a record type as a source in the data parameter. See the [documentation](links.docs.systemrules.chartconfig.doc) for more details on how to configure a chart with a record type as the source.
systemrules.barchartfield_21r4.parameter.data=Reference to the record type used for the source of this chart. Can accept a\!recordData or a Record Type Reference.
systemrules.barchartfield_21r4.parameter.height=Determines the chart height. Valid values\: "MICRO", "SHORT", "MEDIUM", "TALL", "AUTO" (default). See the [documentation](links.docs.systemrules.charts.param.height) for guidance on using the MICRO size.
systemrules.barchartfield_21r4.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.barchartfield_21r4.parameter.instructions=Supplemental text about this field.
systemrules.barchartfield_21r4.parameter.label=Text to display as the field label.
systemrules.barchartfield_21r4.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.barchartfield_21r4.parameter.referencelines=Array of reference line values for each threshold to be defined on the chart. Configured using a\!chartReferenceLine().
systemrules.barchartfield_21r4.parameter.refreshafter=Refreshes chart data each time a specified event completes. Valid values\: "RECORD_ACTION".
systemrules.barchartfield_21r4.parameter.refreshalways=When true, chart data will be refreshed after each user interaction and each interval refresh. Default\: false.
systemrules.barchartfield_21r4.parameter.refreshinterval=How often chart data gets refreshed in minutes. When null, chart data will not be refreshed on an interval. Valid values\: 0.5, 1, 2, 3, 4, 5, 10, 30, 60.
systemrules.barchartfield_21r4.parameter.refreshonreferencedvarchange=When true, chart data will be refreshed each time the value of any variable referenced in the data parameter is updated. To refresh chart data when another variable that is not used within the data parameter, use refreshOnVarChange. Default\: true.
systemrules.barchartfield_21r4.parameter.refreshonvarchange=Refreshes the chart data each time any of these specific variables change. This allows you to refresh the chart data when a variable that is not referenced in the data parameter is updated. You can define either using a single variable (e.g. refreshOnVarChange\: local\!var1) or a list of variables (e.g. refreshOnVarChange\: {local\!var1, local\!var2}).
systemrules.barchartfield_21r4.parameter.series=Array of data series created with a\!chartSeries().
systemrules.barchartfield_21r4.parameter.showdatalabels=Determines if data values are displayed next to each bar. Default\: false.
systemrules.barchartfield_21r4.parameter.showlegend=Determines if a color legend displays below the chart. Default\: true.
systemrules.barchartfield_21r4.parameter.showtooltips=Determines if a tooltip displays the data value for a bar. Default\: true.
systemrules.barchartfield_21r4.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.barchartfield_21r4.parameter.stacking=Determines if series values display as separate bars or stacked within one bar. Valid values\: "NONE" (default), "NORMAL", "PERCENT_TO_TOTAL".
systemrules.barchartfield_21r4.parameter.xaxisstyle=Determines how to display the labels and axis separators for the X-Axis. Valid values\: "STANDARD" (default), "NONE".
systemrules.barchartfield_21r4.parameter.xaxistitle=Title for the independent (vertical) axis.
systemrules.barchartfield_21r4.parameter.yaxismax=Determines the maximum displayed point on the horizontal axis.
systemrules.barchartfield_21r4.parameter.yaxismin=Determines the minimum displayed point on the horizontal axis.
systemrules.barchartfield_21r4.parameter.yaxisstyle=Determines how to display the labels, axis separators, and grid lines for the Y-Axis. Valid values\: "STANDARD" (default), "MINIMAL", "NONE".
systemrules.barchartfield_21r4.parameter.yaxistitle=Title for the dependent (horizontal) axis.
systemrules.barcodefield.description=Displays and allows entry of a barcode using a barcode scanner or manually. See [documentation](links.docs.systemrules.barcodefield.doc) for more details.
systemrules.barcodefield.parameter.acceptedtypes=Determines the types of barcodes that are accepted in the field. Null results in all types being accepted. Valid values\: "CODE39", "CODE93", "CODE128", "DATAMATRIX", "EAN8", "EAN13", "PDF417", "QRCODE", "UPCA", "UPCE".
systemrules.barcodefield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.barcodefield.parameter.align=Determines alignment of the text value. Valid values\: "LEFT" (default), "CENTER", "RIGHT".
systemrules.barcodefield.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.barcodefield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.barcodefield.parameter.instructions=Supplemental text about this field.
systemrules.barcodefield.parameter.label=Text to display as the field label.
systemrules.barcodefield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.barcodefield.parameter.masked=Determines if the value is obscured from view. Default\: false.
systemrules.barcodefield.parameter.placeholder=Text to display in the field when it is empty. Does not show if the field is read only.
systemrules.barcodefield.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.barcodefield.parameter.refreshafter=Determines when the saveInto expression is evaluated. Valid values\: "UNFOCUS" (default), "KEYPRESS".
systemrules.barcodefield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.barcodefield.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.barcodefield.parameter.saveinto=One or more variables that are updated with the text when the user changes it. Use a\!save() to save a modified or alternative value to a variable.
systemrules.barcodefield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.barcodefield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.barcodefield.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.barcodefield.parameter.value=Text to display in the field.
systemrules.baroverlay.description=Displays a horizontal overlay for use in billboard layout.
systemrules.baroverlay.parameter.contents=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, Record Action Field, Rich Text, Section, Side By Side.
systemrules.baroverlay.parameter.padding=Determines the space between the overlay\u2019s edges and its contents. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.baroverlay.parameter.position=Determines where the bar overlay appears. Valid values\: "TOP", "MIDDLE", "BOTTOM" (default).
systemrules.baroverlay.parameter.showwhen=Determines whether the overlay is displayed on the interface. When set to false, the overlay is hidden and is not evaluated. Default\: true.
systemrules.baroverlay.parameter.style=Determines the overlay style. Valid values\: "DARK" (default), "SEMI_DARK", "NONE", "SEMI_LIGHT", "LIGHT".
systemrules.billboardlayout.description=Displays a background color, image, or video with optional overlay content. See the [documentation](links.docs.systemrules.billboardlayout.doc) for guidance on choosing the best background image for your interface.
systemrules.billboardlayout.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.billboardlayout.parameter.backgroundcolor=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.
systemrules.billboardlayout.parameter.backgroundmedia=Determines the background content. Takes priority over background color. Configure using a\!documentImage, a\!userImage, a\!webImage, or a\!webVideo.
systemrules.billboardlayout.parameter.backgroundmediapositionhorizontal=Determines the horizontal positioning of the billboard background media. Valid values\: "LEFT", "CENTER" (default), "RIGHT".
systemrules.billboardlayout.parameter.backgroundmediapositionvertical=Determines the vertical positioning of the billboard background media. Valid values\: "TOP", "MIDDLE" (default), "BOTTOM".
systemrules.billboardlayout.parameter.height=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.
systemrules.billboardlayout.parameter.marginabove=Determines how much space is added above the layout. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.billboardlayout.parameter.marginbelow=Determines how much space is added below the layout. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.billboardlayout.parameter.overlay=Determines the overlay. Configure using a\!columnOverlay, a\!barOverlay, or a\!fullOverlay.
systemrules.billboardlayout.parameter.showwhen=Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default\: true.
systemrules.billboardlayout_19r1.description=This is an older version of the a\!billboardLayout function. You can continue to use this version of the function by its new name\: a\!billboardLayout_19r1. The new version of a\!billboardLayout has new functionality. Displays a background color, image, or video with optional overlay content. See the [documentation](links.docs.systemrules.billboardlayout.doc) for guidance on choosing the best background image for your interface.
systemrules.billboardlayout_19r1.parameter.backgroundcolor=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.
systemrules.billboardlayout_19r1.parameter.backgroundmedia=Determines the background content. Takes priority over background color. Configure using a\!documentImage, a\!userImage, a\!webImage, or a\!webVideo.
systemrules.billboardlayout_19r1.parameter.height=Determines the layout height. Valid values\: "SHORT", "MEDIUM" (default), "TALL".
systemrules.billboardlayout_19r1.parameter.marginbelow=Determines how much space is added below the layout. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.billboardlayout_19r1.parameter.overlaycolumnwidth=Determines the column overlay width. Ignored when a bar overlay is also specified. Valid values\: "NARROW", "MEDIUM" (default), "WIDE".
systemrules.billboardlayout_19r1.parameter.overlaycontents=The interface to display on top of the background. Accepts layouts and display components. Supported layouts and components\: Box, Button, Card, Columns, Image, Link, Milestone, Progress Bar, Rich Text, Section, Side By Side.
systemrules.billboardlayout_19r1.parameter.overlaypositionbar=Determines where the bar overlay appears. Takes priority over column overlay. Valid values\: "TOP", "MIDDLE", "BOTTOM" (default).
systemrules.billboardlayout_19r1.parameter.overlaypositioncolumn=Determines where the column overlay appears. Ignored when a bar overlay is also specified. Valid values\: "START", "CENTER", "END".
systemrules.billboardlayout_19r1.parameter.overlaystyle=Determines the overlay style. Valid values\: "DARK" (default), "LIGHT", "NONE".
systemrules.billboardlayout_19r1.parameter.showwhen=Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default\: true.
systemrules.boxlayout.description=Displays any arrangement of layouts and components within a box on an interface. See [documentation](links.docs.systemrules.boxlayout.doc) for more details.
systemrules.boxlayout.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.boxlayout.parameter.contents=Components and layouts to display within the box.
systemrules.boxlayout.parameter.iscollapsible=Determines if an expand/collapse control appears in the box header. Default\: false.
systemrules.boxlayout.parameter.isinitiallycollapsed=Determines if the box is collapsed when the interface first loads. Default\: false.
systemrules.boxlayout.parameter.label=Text to display as the box\u2019s title.
systemrules.boxlayout.parameter.labelheadingtag=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 [documentation](links.docs.systemrules.shared.accessibility.header) for more details to associate the proper heading tag with the box label to follow accessibility standards.
systemrules.boxlayout.parameter.labelsize=Determines the label size. Valid values\: "LARGE_PLUS", "LARGE", "MEDIUM_PLUS", "MEDIUM", "SMALL", "EXTRA_SMALL" (default).
systemrules.boxlayout.parameter.marginabove=Determines how much space is added above the layout. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.boxlayout.parameter.marginbelow=Determines how much space is added below the layout. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.boxlayout.parameter.padding=Determines the space between the box edges and its contents. Valid values\: "NONE", "EVEN_LESS", "LESS" (default), "STANDARD", "MORE", "EVEN_MORE".
systemrules.boxlayout.parameter.shape=Determines the box shape. Valid values\: "SQUARED" (default), "SEMI_ROUNDED", "ROUNDED".
systemrules.boxlayout.parameter.showborder=Determines whether the layout has an outer border. Default\: true.
systemrules.boxlayout.parameter.showshadow=Determines whether the layout has an outer shadow. Default\: false.
systemrules.boxlayout.parameter.showwhen=Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default\: true.
systemrules.boxlayout.parameter.style=Determines the color of the label and box outline. Valid values\: Any valid hex color or "STANDARD" (default), "ACCENT", "SUCCESS", "INFO", "WARN", "ERROR".
systemrules.buttonarraylayout.description=Displays a list of buttons in the order they are specified. Use this layout when the default positioning for the buttons is sufficient. See [documentation](links.docs.systemrules.buttonarraylayout.doc) for more details.
systemrules.buttonarraylayout.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.buttonarraylayout.parameter.align=Determines alignment of the button(s). Valid values\: "START", "CENTER", "END" (default).
systemrules.buttonarraylayout.parameter.buttons=Array of buttons created with a\!buttonWidget().
systemrules.buttonarraylayout.parameter.marginabove=Determines how much space is added above the layout. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.buttonarraylayout.parameter.marginbelow=Determines how much space is added below the buttons. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.buttonarraylayout.parameter.showwhen=Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default\: true.
systemrules.buttonlayout.description=Displays a list of buttons grouped by prominence. Use this layout in cases where prominence needs to be explicitly specified. See [documentation](links.docs.systemrules.buttonlayout.doc) for more details.
systemrules.buttonlayout.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.buttonlayout.parameter.primarybuttons=Array of prominent buttons created with a\!buttonWidget().
systemrules.buttonlayout.parameter.secondarybuttons=Array of less prominent buttons created with a\!buttonWidget().
systemrules.buttonlayout.parameter.showwhen=Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default\: true.
systemrules.buttonwidget.description=Displays a button that can conditionally be used to submit a form. Buttons must be placed inside a button layout.
systemrules.buttonwidget.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.buttonwidget.parameter.cancelbuttonlabel=Text to display on the cancel button.
systemrules.buttonwidget.parameter.color=Determines the button color. Valid values\: Any valid hex color or "ACCENT" (default), "NEGATIVE", "SECONDARY".
systemrules.buttonwidget.parameter.confirmbuttonlabel=Text to display on the confirmation button.
systemrules.buttonwidget.parameter.confirmheader=Text to display at the top of the confirmation dialog.
systemrules.buttonwidget.parameter.confirmmessage=Text to display in a confirmation dialog box.
systemrules.buttonwidget.parameter.disabled=Determines if the user is prevented from pressing the button. Default\: false.
systemrules.buttonwidget.parameter.icon=Icon to display before any text inside the button. See the [documentation for available icons](links.docs.systemrules.styledIcon.doc).
systemrules.buttonwidget.parameter.iconposition=Determines where the icon appears in relation to the text. Valid values\: "START" (default), "END".
systemrules.buttonwidget.parameter.label=Text to display on the button.
systemrules.buttonwidget.parameter.loadingindicator=Determines whether the button will display a loading indicator on press and be disabled while processing. Default\: false.
systemrules.buttonwidget.parameter.recaptchasaveinto=One or more variables that are updated after reCAPTCHA executes. Use a\!verifyRecaptcha() to verify the reCAPTCHA result and a\!save() to save a modified or alternative value to a variable. See [documentation](links.docs.portals.recaptcha) to learn more about setting up reCAPTCHA keys and defining logic. Only for use in Portals.
systemrules.buttonwidget.parameter.saveinto=One or more variables that are updated with the button value when the user presses it. Use a\!save() to save a modified or alternative value to a variable.
systemrules.buttonwidget.parameter.showwhen=Determines whether the button is displayed on the interface. When set to false, the button is hidden and is not evaluated. Default\: true.
systemrules.buttonwidget.parameter.size=Determines the size of the button. Valid values\: "SMALL", "STANDARD" (default), "LARGE".
systemrules.buttonwidget.parameter.style=Determines the button\u2019s appearance and behavior. Valid values\: "OUTLINE" (default), "GHOST", "LINK", "SOLID".
systemrules.buttonwidget.parameter.submit=Determines if this button submits a form after saving its value. Default\: false.
systemrules.buttonwidget.parameter.tooltip=Text to display on mouseover (web) or long press (mobile).
systemrules.buttonwidget.parameter.validate=Determines if this button performs validation. Default\: false, unless submit is true.
systemrules.buttonwidget.parameter.validationgroup=Components in the same validation group are validated when the button is used and "validate" is true. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.buttonwidget.parameter.value=Value to be saved when the button is pressed.
systemrules.buttonwidget.parameter.width=Determines button width. Valid values are "MINIMIZE" and "FILL". "MINIMIZE" width is determined by button label. "FILL" width fills the button container. Default behavior displays "FILL" width buttons on phone size screens and "MINIMIZE" buttons on wider screens.
systemrules.buttonwidget_23r3.description=This is an older version of the a\!buttonWidget() function. You can continue to use this version of the function by its new name\: a\!buttonwidget_23r3(). The new version of a\!buttonWidget() has new functionality. Displays a button that can conditionally be used to submit a form. Buttons must be placed inside a button layout. See [documentation](links.docs.systemrules.buttonwidget.doc) for more details.
systemrules.buttonwidget_23r3.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.buttonwidget_23r3.parameter.cancelbuttonlabel=Text to display on the cancel button.
systemrules.buttonwidget_23r3.parameter.confirmbuttonlabel=Text to display on the confirmation button.
systemrules.buttonwidget_23r3.parameter.confirmheader=Text to display at the top of the confirmation dialog.
systemrules.buttonwidget_23r3.parameter.confirmmessage=Text to display in a confirmation dialog box.
systemrules.buttonwidget_23r3.parameter.disabled=Determines if the user is prevented from pressing the button. Default\: false.
systemrules.buttonwidget_23r3.parameter.icon=Icon to display before any text inside the button. See the [documentation for available icons](links.docs.systemrules.styledIcon.doc).
systemrules.buttonwidget_23r3.parameter.iconposition=Determines where the icon appears in relation to the text. Valid values\: "START" (default), "END".
systemrules.buttonwidget_23r3.parameter.label=Text to display on the button.
systemrules.buttonwidget_23r3.parameter.loadingindicator=Determines whether the button will display a loading indicator on press and be disabled while processing. Default\: false.
systemrules.buttonwidget_23r3.parameter.recaptchasaveinto=One or more variables that are updated after reCAPTCHA executes. Use a\!verifyRecaptcha() to verify the reCAPTCHA result and a\!save() to save a modified or alternative value to a variable. See [documentation](links.docs.portals.recaptcha) to learn more about setting up reCAPTCHA keys and defining logic. Only for use in Portals.
systemrules.buttonwidget_23r3.parameter.saveinto=One or more variables that are updated with the button value when the user presses it. Use a\!save() to save a modified or alternative value to a variable.
systemrules.buttonwidget_23r3.parameter.showwhen=Determines whether the button is displayed on the interface. When set to false, the button is hidden and is not evaluated. Default\: true.
systemrules.buttonwidget_23r3.parameter.size=Determines the size of the button. Valid values\: "SMALL", "STANDARD" (default), "LARGE".
systemrules.buttonwidget_23r3.parameter.style=Determines the intent of the button. Valid values\: "NORMAL" (default), "PRIMARY", "SECONDARY", "DESTRUCTIVE", and "LINK".
systemrules.buttonwidget_23r3.parameter.submit=Determines if this button submits a form after saving its value. Default\: false.
systemrules.buttonwidget_23r3.parameter.tooltip=Text to display on mouseover (web) or long press (mobile).
systemrules.buttonwidget_23r3.parameter.validate=Determines if this button performs validation. Default\: false, unless submit is true.
systemrules.buttonwidget_23r3.parameter.validationgroup=Components in the same validation group are validated when the button is used and "validate" is true. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.buttonwidget_23r3.parameter.value=Value to be saved when the button is pressed.
systemrules.buttonwidget_23r3.parameter.width=Determines button width. Valid values are "MINIMIZE" and "FILL". "MINIMIZE" width is determined by button label. "FILL" width fills the button container. Default behavior displays "FILL" width buttons on phone size screens and "MINIMIZE" buttons on wider screens.
systemrules.buttonwidgetsubmit.description=WARNING\: This function is deprecated and may be removed in a future release. Instead, use a\!buttonWidget() with the submit attribute set to true. Displays a button that submits a form. Buttons must be placed inside a button layout.
systemrules.buttonwidgetsubmit.parameter.cancelbuttonlabel=Text to display on the cancel button.
systemrules.buttonwidgetsubmit.parameter.confirmbuttonlabel=Text to display on the confirmation button.
systemrules.buttonwidgetsubmit.parameter.confirmheader=Text to display at the top of the confirmation dialog.
systemrules.buttonwidgetsubmit.parameter.confirmmessage=Text to display in a confirmation dialog box.
systemrules.buttonwidgetsubmit.parameter.disabled=Determines if the user is prevented from pressing the button. Default\: false.
systemrules.buttonwidgetsubmit.parameter.label=Text to display on the button.
systemrules.buttonwidgetsubmit.parameter.saveinto=One or more variables that are updated with the button value when the user presses it. Use a\!save() to save a modified or alternative value to a variable.
systemrules.buttonwidgetsubmit.parameter.showwhen=Determines whether the button is displayed on the interface. When set to false, the button is hidden and is not evaluated. Default\: true.
systemrules.buttonwidgetsubmit.parameter.size=Determines the size of the button. Valid values\: "SMALL", "STANDARD" (default), "LARGE".
systemrules.buttonwidgetsubmit.parameter.skipvalidation=Determines if validation is skipped. Default\: false.
systemrules.buttonwidgetsubmit.parameter.style=Determines the intent of the button. Valid values\: "NORMAL" (default), "PRIMARY", "SECONDARY", "DESTRUCTIVE", and "LINK".
systemrules.buttonwidgetsubmit.parameter.validationgroup=Components in the same validation group are validated when the button is used and "validate" is true. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.buttonwidgetsubmit.parameter.value=Value to be saved when the button is pressed.
systemrules.calllanguagemodel.description=Passes specified data to a private large language model to use generative AI to create outputs. 
systemrules.calllanguagemodel.parameter.maxoutputlength=The approximate maximum number of words the language model should return in response. Accepted inputs are between 60-2000, the default is 2000.
systemrules.calllanguagemodel.parameter.model=Valid values include "CLAUDE_INSTANT" (default), "TITAN", "JURASSIC", or "LLAMA_2".
systemrules.calllanguagemodel.parameter.prompt=Instructions and data to send to the language model. If your model requires user roles you must append/prepend the roles to the prompt. See [here](https\://docs.google.com/document/d/1IH53htCwnSZus57prbw-IEQdP3fOWJl-fXGaDA_XY-s) to understand how to format your prompt.
systemrules.calllanguagemodel.parameter.temperature=Temperature controls the randomness of the model\u2019s output, with higher values making the responses more diverse and lower values making them more focused and deterministic. Accepted inputs are between 0-1, with the default configured differently per model.
systemrules.cancelprocess.description=Cancels a process. This function will only execute inside a saveInto or a Web API.
systemrules.cancelprocess.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.cancelprocess.parameter.onsuccess=A list of saves or an HTTP response to execute when the smart service executed successfully. Created with a\!save() or a\!httpResponse(). The boolean function variable fv\!alreadyClosed indicates whether the process was already closed.
systemrules.cancelprocess.parameter.processid=The id of the process to cancel.
systemrules.cancelprocess_17r3.description=This is an older version of the a\!cancelProcess function. You can continue to use this version of the function by its new name\: a\!cancelProcess_17r3. The new version of a\!cancelProcess has new functionality. Cancels a process. This function will only execute inside a saveInto or a Web API.
systemrules.cancelprocess_17r3.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.cancelprocess_17r3.parameter.onsuccess=A list of saves or an HTTP response to execute when the smart service executed successfully. Created with a\!save() or a\!httpResponse().
systemrules.cancelprocess_17r3.parameter.processid=The id of the process to cancel.
systemrules.cardchoicefield.description=Displays a set of cards from which the user may select one or many cards and saves a value based on the selected choice. See [documentation](links.docs.systemrules.cardchoicefield.doc) for more details.
systemrules.cardchoicefield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.cardchoicefield.parameter.align=Determines alignment of the card(s). Valid values\: "START" (default), "CENTER", "END".
systemrules.cardchoicefield.parameter.cardtemplate=Determines how a card should be displayed on the interface. Create using [a\!cardTemplateTile](links.docs.systemrules.cardtemplatetile.doc), [a\!cardTemplateBarTextStacked](links.docs.systemrules.cardtemplatebartextstacked.doc), or [a\!cardTemplateBarTextJustified](links.docs.systemrules.cardtemplatebartextjustified.doc). Access data in cards by using fv\!data with dot notation, such as fv\!data.id, or other function variables\: fv\!index, fv\!identifier, fv\!isFirst, or fv\!isLast. Cards that use record data must use the recordType\! domain to reference a record field or related record field. For example, fv\!data[recordType\!Case.fields.caseName].
systemrules.cardchoicefield.parameter.data=The data to display in cards. Use a record type reference or a\!recordData() to source your data from records. For other cases, you can use a query, such as a\!queryEntity(), a Data Subset, a list of map or dictionary, or a list of data. When using a query that returns a DataSubset, you must specify fetchTotalCount as true.
systemrules.cardchoicefield.parameter.disabled=Determines if the cards should display as potentially selectable but grayed out. Default\: false.
systemrules.cardchoicefield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.cardchoicefield.parameter.instructions=Supplemental text about this field.
systemrules.cardchoicefield.parameter.label=Text to display as the field label.
systemrules.cardchoicefield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.cardchoicefield.parameter.maxselections=Maximum number of allowed selections. For maximum selections greater than 1, a validation message will appear once the number is exceeded.
systemrules.cardchoicefield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.cardchoicefield.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.cardchoicefield.parameter.saveinto=One or more variables that are updated when a card is selected. Use a\!save() to save a modified or alternative value to a variable.
systemrules.cardchoicefield.parameter.showshadow=Determines whether cards have an outer shadow. Default\: false.
systemrules.cardchoicefield.parameter.showwhen=Determines whether the cards are displayed on the interface. When set to false, the cards are hidden and are not evaluated. Default\: true.
systemrules.cardchoicefield.parameter.sort=Array of Sort Info configurations created with a\!sortInfo().
systemrules.cardchoicefield.parameter.spacing=Determines the space between the options. Valid values\: "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.cardchoicefield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.cardchoicefield.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.cardchoicefield.parameter.value=Value of choice card to display as selected.
systemrules.cardlayout.description=Displays any arrangement of layouts and components within a card on an interface. Can be styled or linked. See [documentation](links.docs.systemrules.cardlayout.doc) for more details.
systemrules.cardlayout.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.cardlayout.parameter.contents=Components and layouts to display within the card.
systemrules.cardlayout.parameter.decorativebarcolor=Determines the decorative bar color. Valid values\: Any valid hex color or "ACCENT" (default), "POSITIVE", "WARN", "NEGATIVE".
systemrules.cardlayout.parameter.decorativebarposition=Determines where the decorative bar displays. Valid values\: "TOP", "BOTTOM", "START", "END", "NONE" (default).
systemrules.cardlayout.parameter.height=Determines the card height. Valid values\: "EXTRA_SHORT", "SHORT", "SHORT_PLUS", "MEDIUM", "MEDIUM_PLUS", "TALL", "TALL_PLUS", "EXTRA_TALL", "AUTO" (default).
systemrules.cardlayout.parameter.link=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().
systemrules.cardlayout.parameter.marginabove=Determines how much space is added above the layout. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.cardlayout.parameter.marginbelow=Determines how much space is added below the layout. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.cardlayout.parameter.padding=Determines the space between the card edges and its contents. Valid values\: "NONE", "EVEN_LESS", "LESS" (default), "STANDARD", "MORE", "EVEN_MORE".
systemrules.cardlayout.parameter.shape=Determines the card shape. Valid values\: "SQUARED" (default), "SEMI_ROUNDED", "ROUNDED".
systemrules.cardlayout.parameter.showborder=Determines whether the layout has an outer border. Default\: true.
systemrules.cardlayout.parameter.showshadow=Determines whether the layout has an outer shadow. Default\: false.
systemrules.cardlayout.parameter.showwhen=Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default\: true.
systemrules.cardlayout.parameter.style=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". See [documentation](links.docs.sd.colorScheme.learnMore) for more information about how to use color schemes.
systemrules.cardlayout.parameter.tooltip=Text to display on mouseover (web) or tap (mobile).
systemrules.cardtemplatebartextjustified.description=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](links.docs.systemrules.cardchoicefield.doc) cardTemplate parameter.
systemrules.cardtemplatebartextjustified.parameter.icon=Icon to display inside the card. See the [documentation for available icons](links.docs.systemrules.styledIcon.doc).
systemrules.cardtemplatebartextjustified.parameter.iconalttext=Equivalent alternate text for use by screen readers.
systemrules.cardtemplatebartextjustified.parameter.iconcolor=Determines the icon color. Valid values\: Any hex color or "ACCENT" (default), "STANDARD", "SECONDARY", "POSITIVE", "NEGATIVE".
systemrules.cardtemplatebartextjustified.parameter.id=Value that identifies the card.
systemrules.cardtemplatebartextjustified.parameter.primarytext=Optional text to display at the start of the card.
systemrules.cardtemplatebartextjustified.parameter.secondarytext=Optional text to display at the end of the card.
systemrules.cardtemplatebartextjustified.parameter.showwhen=Determines whether the card is displayed in the set of card choices. When set to false, the card is hidden. Default\: true.
systemrules.cardtemplatebartextjustified.parameter.tooltip=Text to display on mouseover (web) or tap (mobile).
systemrules.cardtemplatebartextstacked.description=Displays a bar card template with an icon and stacked primary text and secondary text. For use in the [Card Choice Field](links.docs.systemrules.cardchoicefield.doc) cardTemplate parameter.
systemrules.cardtemplatebartextstacked.parameter.icon=Icon to display inside the card. See the [documentation for available icons](links.docs.systemrules.styledIcon.doc).
systemrules.cardtemplatebartextstacked.parameter.iconalttext=Equivalent alternate text for use by screen readers.
systemrules.cardtemplatebartextstacked.parameter.iconcolor=Determines the icon color. Valid values\: Any hex color or "ACCENT" (default), "STANDARD", "SECONDARY", "POSITIVE", "NEGATIVE".
systemrules.cardtemplatebartextstacked.parameter.id=Value that identifies the card.
systemrules.cardtemplatebartextstacked.parameter.primarytext=Optional text to display on the first line inside the card.
systemrules.cardtemplatebartextstacked.parameter.secondarytext=Optional text to display beneath the primary text inside the card.
systemrules.cardtemplatebartextstacked.parameter.showwhen=Determines whether the card is displayed in the set of card choices. When set to false, the card is hidden. Default\: true.
systemrules.cardtemplatebartextstacked.parameter.tooltip=Text to display on mouseover (web) or tap (mobile).
systemrules.cardtemplatetile.description=Displays a tile card template with a stacked icon, primary text, and secondary text. For use in the [Card Choice Field](links.docs.systemrules.cardchoicefield.doc) cardTemplate parameter.
systemrules.cardtemplatetile.parameter.icon=Icon to display inside the card. See the [documentation for available icons](links.docs.systemrules.styledIcon.doc).
systemrules.cardtemplatetile.parameter.iconalttext=Equivalent alternate text for use by screen readers.
systemrules.cardtemplatetile.parameter.iconcolor=Determines the icon color. Valid values\: Any hex color or "ACCENT" (default), "STANDARD", "SECONDARY", "POSITIVE", "NEGATIVE".
systemrules.cardtemplatetile.parameter.id=Value that identifies the card.
systemrules.cardtemplatetile.parameter.primarytext=Optional text to display on the first line inside the card.
systemrules.cardtemplatetile.parameter.secondarytext=Optional text to display beneath the primary text inside the card.
systemrules.cardtemplatetile.parameter.showwhen=Determines whether the card is displayed in the set of card choices. When set to false, the card is hidden. Default\: true.
systemrules.cardtemplatetile.parameter.tooltip=Text to display on mouseover (web) or tap (mobile).
systemrules.certifiedsailextension.parameter.alttext=Equivalent alternate text provided to assistive technology.
systemrules.certifiedsailextension.parameter.disabled=Determines if the user is prevented from interacting with the field. Default\: false.
systemrules.certifiedsailextension.parameter.genericSaveinto=One or more variables that are updated with the {0} value when the user changes it. Use a\!save() to save a modified or alternative value to a variable.
systemrules.certifiedsailextension.parameter.height=Determines the layout height. Valid values\: "SHORT", "MEDIUM", "TALL", "AUTO" (default).
systemrules.certifiedsailextension.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.certifiedsailextension.parameter.instructions=Supplemental text about this field.
systemrules.certifiedsailextension.parameter.label=Text to display as the field label.
systemrules.certifiedsailextension.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.certifiedsailextension.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.certifiedsailextension.parameter.showborder=Determines whether the field has an outer border. Default\: false.
systemrules.certifiedsailextension.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.certifiedsailextension.parameter.source=Location of the external content.
systemrules.certifiedsailextension.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.certifiedsailextension.parameter.vendorname=*** This component is provided by a component plug-in from {0}. ***
systemrules.chartreferenceline.description=Contains the reference line value for each threshold that is defined on a column, bar, or line chart.
systemrules.chartreferenceline.parameter.color=Color for the reference line; overrides the auto-assignment from color scheme. Valid values are\: Any valid hex color or "ACCENT", "BLUEGRAY", "GREEN", "GOLD", "ORANGE", "PURPLE", "RED", "SKYBLUE", "LIMEGREEN", "YELLOW", "AMBER", "PINK", and "VIOLETRED".
systemrules.chartreferenceline.parameter.label=Text to display on top of the reference line.
systemrules.chartreferenceline.parameter.showwhen=Determines whether the reference line is displayed on the interface. When set to false, the reference line is hidden and is not evaluated. Default\: true.
systemrules.chartreferenceline.parameter.style=Style of the reference line. Valid values are\: "SOLID", "DOT", "DASH" (default), "DASHDOT", "SHORTDASH".
systemrules.chartreferenceline.parameter.value=The numeric value at which the reference line will be drawn.
systemrules.chartseries.description=Defines a series of data for a bar, column, line, or pie chart.
systemrules.chartseries.parameter.color=Overrides the auto-assignment of series color with a specific value. Valid values\: Any valid hex color or "ACCENT", "BLUEGRAY", "GREEN", "GOLD", "ORANGE", "PURPLE", "RED", "SKYBLUE", "LIMEGREEN", "YELLOW", "AMBER", "PINK", "VIOLETRED".
systemrules.chartseries.parameter.data=Array of decimal data values to display in a chart.
systemrules.chartseries.parameter.label=Name to display in the legend.
systemrules.chartseries.parameter.links=Array of links that determines behavior when a data point is clicked. Create links with a\!documentDownloadLink(), a\!dynamicLink(), a\!newsEntryLink(), a\!processTaskLink(), a\!recordLink(), a\!reportLink(), a\!safeLink(), a\!startProcessLink(), a\!submitLink(), a\!userRecordLink(), or a\!authorizationLink().
systemrules.chartseries.parameter.showwhen=Determines whether the series is displayed in the chart. When set to false, the series is hidden and is not evaluated. Default\: true.
systemrules.checkboxfield.description=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. See [documentation](links.docs.systemrules.checkboxfield.doc) for more details.
systemrules.checkboxfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.checkboxfield.parameter.align=Determines alignment of choice labels. Appian recommends this setting only be used inside the Grid Layout component. Valid values\: "LEFT", "CENTER", "RIGHT".
systemrules.checkboxfield.parameter.choicelabels=Array of options for the user to select. When the data source is a record type, this is a record field or related record field.
systemrules.checkboxfield.parameter.choicelayout=Determines the layout. Valid values\: "STACKED" (default), "COMPACT".
systemrules.checkboxfield.parameter.choicestyle=Determines how the choices should be displayed on the interface. Valid values\: "STANDARD" (default), "CARDS".
systemrules.checkboxfield.parameter.choicevalues=Array of values associated with the corresponding choices. When the data source is a record type, this is a record field (usually the primary key field).
systemrules.checkboxfield.parameter.data=The record type used as the source of the component\u2019s choices. This can be specified with a record type reference or a\!recordData().
systemrules.checkboxfield.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.checkboxfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.checkboxfield.parameter.instructions=Supplemental text about this field.
systemrules.checkboxfield.parameter.label=Text to display as the field label.
systemrules.checkboxfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.checkboxfield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.checkboxfield.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.checkboxfield.parameter.saveinto=One or more variables that are updated with the choice values when the user changes the selections. Use a\!save() to save a modified or alternative value to a variable.
systemrules.checkboxfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.checkboxfield.parameter.sort=Array of Sort Info configurations created with a\!sortInfo().
systemrules.checkboxfield.parameter.spacing=Determines the space between the options. Valid values\: "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.checkboxfield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.checkboxfield.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.checkboxfield.parameter.value=Values of choices to display as selected.
systemrules.checkboxfield_23r3.description=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. See [documentation](links.docs.systemrules.checkboxfield.doc) for more details.
systemrules.checkboxfield_23r3.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.checkboxfield_23r3.parameter.align=Determines alignment of choice labels. Appian recommends this setting only be used inside the Grid Layout component. Valid values\: "LEFT", "CENTER", "RIGHT".
systemrules.checkboxfield_23r3.parameter.choicelabels=Array of options for the user to select.
systemrules.checkboxfield_23r3.parameter.choicelayout=Determines the layout. Valid values\: "STACKED" (default), "COMPACT".
systemrules.checkboxfield_23r3.parameter.choicestyle=Determines how the choices should be displayed on the interface. Valid values\: "STANDARD" (default), "CARDS".
systemrules.checkboxfield_23r3.parameter.choicevalues=Array of values associated with the available choices.
systemrules.checkboxfield_23r3.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.checkboxfield_23r3.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.checkboxfield_23r3.parameter.instructions=Supplemental text about this field.
systemrules.checkboxfield_23r3.parameter.label=Text to display as the field label.
systemrules.checkboxfield_23r3.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.checkboxfield_23r3.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.checkboxfield_23r3.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.checkboxfield_23r3.parameter.saveinto=One or more variables that are updated with the choice values when the user changes the selections. Use a\!save() to save a modified or alternative value to a variable.
systemrules.checkboxfield_23r3.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.checkboxfield_23r3.parameter.spacing=Determines the space between the options. Valid values\: "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.checkboxfield_23r3.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.checkboxfield_23r3.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.checkboxfield_23r3.parameter.value=Values of choices to display as selected.
systemrules.checkboxfieldbyindex.description=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.
systemrules.checkboxfieldbyindex.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.checkboxfieldbyindex.parameter.align=Determines alignment of choice labels. Appian recommends this setting only be used inside the Grid Layout component. Valid values\: "LEFT", "CENTER", "RIGHT".
systemrules.checkboxfieldbyindex.parameter.choicelabels=Array of options for the user to select.
systemrules.checkboxfieldbyindex.parameter.choicelayout=Determines the layout. Valid values\: "STACKED" (default), "COMPACT".
systemrules.checkboxfieldbyindex.parameter.choicestyle=Determines how the choices should be displayed on the interface. Valid values\: "STANDARD" (default), "CARDS".
systemrules.checkboxfieldbyindex.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.checkboxfieldbyindex.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.checkboxfieldbyindex.parameter.instructions=Supplemental text about this field.
systemrules.checkboxfieldbyindex.parameter.label=Text to display as the field label.
systemrules.checkboxfieldbyindex.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.checkboxfieldbyindex.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.checkboxfieldbyindex.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.checkboxfieldbyindex.parameter.saveinto=One or more variables that are updated with the choice indexes when the user changes the selections. Use a\!save() to save a modified or alternative value to a variable.
systemrules.checkboxfieldbyindex.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.checkboxfieldbyindex.parameter.spacing=Determines the space between the options. Valid values\: "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.checkboxfieldbyindex.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.checkboxfieldbyindex.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.checkboxfieldbyindex.parameter.value=Indices of choices to display as selected.
systemrules.cmicopydocumentfromappian.description=[Deprecated - use an HTTP Connected System instead] Copies an Appian document to a folder in the CMIS target system. This function returns a writer and must be used with the bind() function.
systemrules.cmicopydocumentfromappian.parameter.appiandocument=The Appian document to copy to the target CMIS system.
systemrules.cmicopydocumentfromappian.parameter.appiandocumentallowexpired=Determines if expired Appian documents can be copied. Default\: true.
systemrules.cmicopydocumentfromappian.parameter.appiandocumentversion=The version number of the Appian document to copy to the target CMIS system. Default\: current version.
systemrules.cmicopydocumentfromappian.parameter.atompuburl=The Atom Pub URL of the CMIS target system.
systemrules.cmicopydocumentfromappian.parameter.objectid=The object id of the CMIS folder to which the Appian document will be copied.
systemrules.cmicopydocumentfromappian.parameter.properties=The CMIS document properties, given as a dictionary. The string "cmis\:" will automatically be included in the key name if no colon is present in key name. Example\: {name\:"test name", description\:"test description"}.
systemrules.cmicopydocumentfromappian.parameter.repositoryid=The repository id on the CMIS target system.
systemrules.cmicopydocumentfromappian.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.cmicopydocumentfromappian.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.cmicopydocumenttoappian.description=[Deprecated - use an HTTP Connected System instead] Copies a CMIS document from the target system to a new version of an Appian document. This function returns a writer and must be used with the bind() function.
systemrules.cmicopydocumenttoappian.parameter.appiandocument=The Appian document to which the document from the CMIS system will be copied as a new version.
systemrules.cmicopydocumenttoappian.parameter.atompuburl=The Atom Pub URL of the CMIS target system.
systemrules.cmicopydocumenttoappian.parameter.objectid=The object id of the CMIS document that will be copied to Appian.
systemrules.cmicopydocumenttoappian.parameter.repositoryid=The repository id on the CMIS target system.
systemrules.cmicopydocumenttoappian.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.cmicopydocumenttoappian.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.cmicopydocumenttoappianfolder.description=[Deprecated - use an HTTP Connected System instead] Copies a CMIS document from the target system to an Appian folder, creating a new document. This function returns a writer and must be used with the bind() function.
systemrules.cmicopydocumenttoappianfolder.parameter.appianfolder=The Appian folder to which the document from the CMIS system will be copied.
systemrules.cmicopydocumenttoappianfolder.parameter.atompuburl=The Atom Pub URL of the CMIS target system.
systemrules.cmicopydocumenttoappianfolder.parameter.objectid=The object id of the CMIS document that will be copied to Appian.
systemrules.cmicopydocumenttoappianfolder.parameter.repositoryid=The repository id on the CMIS target system.
systemrules.cmicopydocumenttoappianfolder.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.cmicopydocumenttoappianfolder.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.cmicreatefolder.description=[Deprecated - use an HTTP Connected System instead] Creates a new folder in the CMIS target system. This function returns a writer and must be used with the bind() function.
systemrules.cmicreatefolder.parameter.atompuburl=The Atom Pub URL of the CMIS target system.
systemrules.cmicreatefolder.parameter.parentid=The object id of the CMIS folder which will be the parent of the new folder. Use null() for root.
systemrules.cmicreatefolder.parameter.properties=The CMIS folder properties, given as a dictionary. The string "cmis\:" will automatically be included in the key name if no colon is present in key name. Example\: {name\:"test name", description\:"test description"}.
systemrules.cmicreatefolder.parameter.repositoryid=The repository id on the CMIS target system.
systemrules.cmicreatefolder.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.cmicreatefolder.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.cmidelete.description=[Deprecated - use an HTTP Connected System instead] Delete an object in the CMIS target system. This function returns a writer and must be used with the bind() function.
systemrules.cmidelete.parameter.allversions=Determines whether all versions of the object should be deleted, if applicable. Default\: true.
systemrules.cmidelete.parameter.atompuburl=The Atom Pub URL of the CMIS target system.
systemrules.cmidelete.parameter.objectid=The object id of the CMIS object to delete.
systemrules.cmidelete.parameter.repositoryid=The repository id on the CMIS target system.
systemrules.cmidelete.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.cmidelete.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.cmigetfolderchildren.description=[Deprecated - use an HTTP Connected System instead] Retrieves the children of the given folder from the CMIS target system.
systemrules.cmigetfolderchildren.parameter.atompuburl=The Atom Pub URL of the CMIS target system.
systemrules.cmigetfolderchildren.parameter.folderid=The object id of the CMIS folder.
systemrules.cmigetfolderchildren.parameter.paginginfo=The start index and batch size of the list of objects to retrieve, created with a\!pagingInfo(). The sort values in the paging info are ignored.
systemrules.cmigetfolderchildren.parameter.repositoryid=The repository id on the CMIS target system.
systemrules.cmigetfolderchildren.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.cmigetfolderchildren.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.cmigetobjectidbypath.description=Retrieves the CMIS object id from the CMIS target system, using the given path.
systemrules.cmigetobjectidbypath.description[Deprecated=- use an HTTP Connected System instead] \=Retrieves the CMIS object id from the CMIS target system, using the given path.
systemrules.cmigetobjectidbypath.parameter.atompuburl=The Atom Pub URL of the CMIS target system.
systemrules.cmigetobjectidbypath.parameter.path=The CMIS path of the object. The meaning of the path is defined by the CMIS server (e.g., /folder1/folder2/mydocument3).
systemrules.cmigetobjectidbypath.parameter.repositoryid=The repository id on the CMIS target system.
systemrules.cmigetobjectidbypath.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.cmigetobjectidbypath.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.cmigetproperties.description=[Deprecated - use an HTTP Connected System instead] Retrieves the CMIS object properties from the CMIS target system, using the given object id.
systemrules.cmigetproperties.parameter.atompuburl=The Atom Pub URL of the CMIS target system.
systemrules.cmigetproperties.parameter.objectid=The object id of the CMIS object whose properties will be retrieved.
systemrules.cmigetproperties.parameter.repositoryid=The repository id on the CMIS target system.
systemrules.cmigetproperties.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.cmigetproperties.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.cmigetrepoinfo.description=DMS GRetrieves information about the target CMIS target system repository.
systemrules.cmigetrepoinfo.parameter.atompuburl=The Atom Pub URL of the CMIS target system.
systemrules.cmigetrepoinfo.parameter.repositoryid=The repository id on the CMIS target system.
systemrules.cmigetrepoinfo.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.cmigetrepoinfo.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.colorschemecustom.description=A custom list of colors to apply to the component.
systemrules.colorschemecustom.parameter.colors=List of colors to use in the custom color scheme. Valid values\: any valid hex colors; Maximum colors allowed\: 12.
systemrules.columnchartconfig.description=Contains configuration for how to display data in a column chart.
systemrules.columnchartconfig.parameter.datalimit=Maximum number of data points to display on the chart. Default\: 100. Valid values\: 1-5000.
systemrules.columnchartconfig.parameter.link=Link to execute when a user selects a data point on the chart. Use fv\!selection to pass context from the selection made on the chart to the link. Create a link using a\!dynamicLink().
systemrules.columnchartconfig.parameter.measures=Defines the numerical calculations for data in the chart, configured using a\!measure(). If no measure is provided, a count of records shows as the measurement in the chart.
systemrules.columnchartconfig.parameter.primarygrouping=Defines the field labels to display on the axis in the chart, configured using a\!grouping().
systemrules.columnchartconfig.parameter.secondarygrouping=Defines the field labels to display in the stacking or grouped columns in the chart, configured using a\!grouping().
systemrules.columnchartconfig.parameter.showintervalswithnodata=Determines whether the axis in the chart displays date or time values that do not have a value associated with them. For example, show January, February, and March, even if February has no data. This parameter is only available when a Date, Time, or Date and Time field is used as the primary grouping. Default\: false.
systemrules.columnchartconfig.parameter.sort=Use a\!sortInfo() to define a sort in ascending or descending order. Use the alias of any groupings or measures to sort by the values in the chart. Use a record field or related record field reference to sort by data that is not referenced in the chart.
systemrules.columnchartfield.description=Displays numerical data as vertical bars. Use a column chart to graphically display data that changes over time. See [documentation](links.docs.systemrules.columnchartfield.doc) for more details.
systemrules.columnchartfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.columnchartfield.parameter.allowdecimalaxislabels=Allows dependent (vertical) values to display as decimal numbers instead of integers. Default\: false.
systemrules.columnchartfield.parameter.allowimagedownload=Determines if the chart download button displays on the chart. Default\: false.
systemrules.columnchartfield.parameter.categories=Text to display on the x-axis next to each column.
systemrules.columnchartfield.parameter.colorscheme=Determines which color scheme to use in the chart. Use one of the following valid values\: "CLASSIC" (default), "MIDNIGHT", "OCEAN", "MOSS", "BERRY", "PARACHUTE", "RAINFOREST", "SUNSET" or define a custom color scheme using a\!colorSchemeCustom. See the [documentation](links.docs.systemrules.charts.param.colorScheme) for guidance on how to use color schemes.
systemrules.columnchartfield.parameter.config=Configures how to display data on the chart, including fields used for calculations and grouping, using a\!columnChartConfig(). Only applies when using a record type as a source in the data parameter. See the [documentation](links.docs.systemrules.chartconfig.doc) for more details on how to configure a chart with a record type as the source.
systemrules.columnchartfield.parameter.data=Reference to the record type used for the source of this chart. Can accept a\!recordData or a Record Type Reference.
systemrules.columnchartfield.parameter.height=Determines the chart height. Valid values\: "MICRO", "SHORT", "MEDIUM" (default), "TALL". See the [documentation](links.docs.systemrules.charts.param.height) for guidance on using the MICRO size.
systemrules.columnchartfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.columnchartfield.parameter.instructions=Supplemental text about this field.
systemrules.columnchartfield.parameter.label=Text to display as the field label.
systemrules.columnchartfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.columnchartfield.parameter.referencelines=Array of reference line values for each threshold to be defined on the chart. Configured using a\!chartReferenceLine().
systemrules.columnchartfield.parameter.refreshafter=Refreshes chart data each time a specified event completes. Valid values\: "RECORD_ACTION".
systemrules.columnchartfield.parameter.refreshalways=When true, chart data will be refreshed after each user interaction and each interval refresh. Default\: false.
systemrules.columnchartfield.parameter.refreshinterval=How often chart data gets refreshed in minutes. When null, chart data will not be refreshed on an interval. Valid values\: 0.5, 1, 2, 3, 4, 5, 10, 30, 60.
systemrules.columnchartfield.parameter.refreshonreferencedvarchange=When true, chart data will be refreshed each time the value of any variable referenced in the data parameter is updated. To refresh chart data when another variable that is not used within the data parameter, use refreshOnVarChange. Default\: true.
systemrules.columnchartfield.parameter.refreshonvarchange=Refreshes the chart data each time any of these specific variables change. This allows you to refresh the chart data when a variable that is not referenced in the data parameter is updated. You can define either using a single variable (e.g. refreshOnVarChange\: local\!var1) or a list of variables (e.g. refreshOnVarChange\: {local\!var1, local\!var2}).
systemrules.columnchartfield.parameter.series=Array of data series created with a\!chartSeries().
systemrules.columnchartfield.parameter.showdatalabels=Determines if data values are displayed on each column. Default\: false.
systemrules.columnchartfield.parameter.showlegend=Determines if a color legend displays below the chart. Default\: true.
systemrules.columnchartfield.parameter.showtooltips=Determines if a tooltip displays the data value for a column. Default\: true.
systemrules.columnchartfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.columnchartfield.parameter.stacking=Determines if series values display as separate columns or stacked within one column. Valid values\: "NONE" (default), "NORMAL", "PERCENT_TO_TOTAL".
systemrules.columnchartfield.parameter.xaxisstyle=Determines how to display the labels and axis separators for the X-Axis. Valid values\: "STANDARD" (default), "NONE".
systemrules.columnchartfield.parameter.xaxistitle=Title for the independent (horizontal) axis.
systemrules.columnchartfield.parameter.yaxismax=Determines the maximum displayed point on the vertical axis.
systemrules.columnchartfield.parameter.yaxismin=Determines the minimum displayed point on the vertical axis.
systemrules.columnchartfield.parameter.yaxisstyle=Determines how to display the labels, axis separators, and grid lines for the Y-Axis. Valid values\: "STANDARD" (default), "MINIMAL", "NONE".
systemrules.columnchartfield.parameter.yaxistitle=Title for the dependent (vertical) axis.
systemrules.columnlayout.description=Displays a column that can be used within a\!columnsLayout.
systemrules.columnlayout.parameter.contents=Array of SAIL components to display in this column.
systemrules.columnlayout.parameter.showwhen=Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default\: true.
systemrules.columnlayout.parameter.width=Determines the column width. 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".
systemrules.columnoverlay.description=Displays a vertical overlay for use in billboard layout.
systemrules.columnoverlay.parameter.alignvertical=Determines vertical alignment of all content within the overlay. Valid values are "TOP" (default), "MIDDLE", and "BOTTOM".
systemrules.columnoverlay.parameter.contents=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, Record Action Field, Rich Text, Section, Side By Side.
systemrules.columnoverlay.parameter.padding=Determines the space between the overlay\u2019s edges and its contents. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.columnoverlay.parameter.position=Determines where the column overlay appears. Valid values\: "START" (default), "CENTER", "END".
systemrules.columnoverlay.parameter.showwhen=Determines whether the overlay is displayed on the interface. When set to false, the overlay is hidden and is not evaluated. Default\: true.
systemrules.columnoverlay.parameter.style=Determines the overlay style. Valid values\: "DARK" (default), "SEMI_DARK", "NONE", "SEMI_LIGHT", "LIGHT".
systemrules.columnoverlay.parameter.width=Determines the column overlay width. Valid values\: "NARROW", "MEDIUM" (default), "WIDE".
systemrules.columnslayout.description=Displays any number of columns alongside each other. On narrow screens and mobile devices, columns are stacked. See [documentation](links.docs.systemrules.columnslayout.doc) for more details.
systemrules.columnslayout.parameter.alignvertical=Determines vertical alignment of all column content with the layout. Valid values are "TOP" (default), "MIDDLE", and "BOTTOM".
systemrules.columnslayout.parameter.columns=Columns to display using a\!columnLayout.
systemrules.columnslayout.parameter.marginabove=Determines how much space is added above the layout. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.columnslayout.parameter.marginbelow=Determines how much space is added below the layout. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.columnslayout.parameter.showdividers=Determines whether dividers appear between the columns. Default\: false.
systemrules.columnslayout.parameter.showwhen=Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default\: true.
systemrules.columnslayout.parameter.spacing=Determines the space between columns in the layout when they are not stacked. Valid values\: "STANDARD" (default), "NONE", "DENSE", "SPARSE".
systemrules.columnslayout.parameter.stackwhen=Determines the page width at which column layouts stack vertically. List all widths where columns should stack. Valid values\: "PHONE" (default), "TABLET_PORTRAIT", "TABLET_LANDSCAPE", "DESKTOP_NARROW", "DESKTOP", "DESKTOP_WIDE", "NEVER". Review [UX best practices](links.docs.systemrules.shared.responsive.doc) for responsive design.
systemrules.completetask.description=Completes a task using the provided parameters as task inputs. This function will only execute inside a saveInto or a Web API.
systemrules.completetask.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.completetask.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.completetask.parameter.taskid=The ID of the task to complete.
systemrules.completetask.parameter.taskinputs=A dictionary containing keys and values that corresponds to the task\u2019s inputs.
systemrules.createcustomgroup.description=WARNING\: This function is deprecated and may be removed in a future release. Instead, use a\!createGroup().
systemrules.createcustomgroup.parameter.delegatedcreation=Should administrators of this group be permitted to create additional groups as children? Default\: false.
systemrules.createcustomgroup.parameter.description=The description of the group.
systemrules.createcustomgroup.parameter.groupprivacy=Should members be able to view all other members of the group? Valid values\: "LOW" (default), "HIGH".
systemrules.createcustomgroup.parameter.grouptype=The type of the group.
systemrules.createcustomgroup.parameter.membershippolicy=How will users become members of this group? Valid values\: "CLOSED" (default), "EXCLUSIVE", "AUTOMATIC".
systemrules.createcustomgroup.parameter.name=The name of the group.
systemrules.createcustomgroup.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.createcustomgroup.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). The created group is available in the function variable fv\!group.
systemrules.createcustomgroup.parameter.parent=The group\u2019s parent. You must be an administrator of the selected parent group.
systemrules.createcustomgroup.parameter.securitytype=Who should have access to this group? Valid values\: "PUBLIC" (default), "PERSONAL", "RESTRICTED".
systemrules.createfolder.description=Creates a new folder. This function will only execute inside a saveInto or a Web API.
systemrules.createfolder.parameter.name=The name of the new folder.
systemrules.createfolder.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.createfolder.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). The created folder is available in the function variable fv\!folder.
systemrules.createfolder.parameter.parentfolder=If not null, the new folder will be created in this Folder.
systemrules.createfolder.parameter.parentknowledgecenter=If not null, the new folder will be created in this Knowledge Center.
systemrules.creategroup.description=Creates a new group. This function will only execute inside a saveInto or a Web API.
systemrules.creategroup.parameter.delegatedcreation=Should administrators of this group be permitted to create additional groups as children? Default\: false.
systemrules.creategroup.parameter.description=The description of the group.
systemrules.creategroup.parameter.groupprivacy=Should members be able to view all other members of the group? Valid values\: "LOW" (default), "HIGH".
systemrules.creategroup.parameter.grouptype=The type of the group.
systemrules.creategroup.parameter.membershippolicy=How will users become members of this group? Valid values\: "CLOSED" (default), "EXCLUSIVE", "AUTOMATIC".
systemrules.creategroup.parameter.name=The name of the group.
systemrules.creategroup.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.creategroup.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). The created group is available in the function variable fv\!group.
systemrules.creategroup.parameter.parent=The group\u2019s parent. You must be an administrator of the selected parent group.
systemrules.creategroup.parameter.securitytype=Who should have access to this group? Valid values\: "PUBLIC" (default), "PERSONAL", "RESTRICTED".
systemrules.createknowledgecenter.description=Creates a new Knowledge Center. This function will only execute inside a saveInto or a Web API.
systemrules.createknowledgecenter.parameter.description=The description of the new Knowledge Center.
systemrules.createknowledgecenter.parameter.name=The name of the new Knowledge Center.
systemrules.createknowledgecenter.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.createknowledgecenter.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). The created Knowledge Center is available in the function variable fv\!knowledgecenter.
systemrules.createknowledgecenter_17r4.description=Creates a new Knowledge Center. This function will only execute inside a saveInto or a Web API.
systemrules.createknowledgecenter_17r4.parameter.description=The description of the new Knowledge Center.
systemrules.createknowledgecenter_17r4.parameter.name=The name of the new Knowledge Center.
systemrules.createknowledgecenter_17r4.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.createknowledgecenter_17r4.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). The created Knowledge Center is available in the function variable fv\!knowledgecenter.
systemrules.createknowledgecenter_17r4.parameter.securitylevel=Security Level of the Knowledge Center to create. Valid values\: "HIGH" (default), "MEDIUM", "LOW".
systemrules.createuser.description=Creates a new user. This function will only execute inside a saveInto or a Web API.
systemrules.createuser.parameter.email=The email address of the new user.
systemrules.createuser.parameter.firstname=The first name of the new user.
systemrules.createuser.parameter.lastname=The last name of the new user.
systemrules.createuser.parameter.middlename=The middle name of the new user.
systemrules.createuser.parameter.nickname=The nickname of the new user.
systemrules.createuser.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.createuser.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). The created user is available in the function variable fv\!user.
systemrules.createuser.parameter.sendaccountcreationemail=If true (default), an email with a temporary password will be sent to the new user.
systemrules.createuser.parameter.username=The username of the new user.
systemrules.customfieldconcat.description=Used to create a custom record field, this function concatenates the specified values into a single value.
systemrules.customfieldconcat.parameter.value=An array of 2 to 10 values to concatenate. Values can be any combination of record fields, related record fields, custom field functions, or literal values of type Text and Number (Integer).
systemrules.customfieldcondition.description=Used in the \u2019whenTrue\u2019 parameter of a\!customFieldMatch(), this function allows you to create a condition.
systemrules.customfieldcondition.parameter.field=The record field, related record field, or custom field function to be compared in the condition. Use the recordType\! domain to reference a record field or related record field. For example, recordType\!Case.fields.caseName.
systemrules.customfieldcondition.parameter.operator=The operator used to compare the \u2019field\u2019 and \u2019value\u2019 parameters. Valid values\: "\=", "<>", ">", ">\=", "<", "<\=", "between", "in", "not in", "is null", "not null", "starts with", "not starts with", "ends with", "not ends with", "includes", "not includes".
systemrules.customfieldcondition.parameter.value=The value to compare to the given field using the given operator. This value must be a literal.
systemrules.customfielddatediff.description=Used to create a custom record field, this function returns the difference between two dates. The difference can be returned in days, hours, minutes, or seconds. Returns null when the startDate or endDate is null or empty.
systemrules.customfielddatediff.parameter.enddate=The record field or expression that evaluates to a Date or Date and Time value to use in the date subtraction.
systemrules.customfielddatediff.parameter.interval=Determines whether the difference is calculated in days, hours, minutes, or seconds. Valid values\: "DAY" (default), "HOUR", "MINUTE", "SECOND".
systemrules.customfielddatediff.parameter.startdate=The record field or expression that evaluates to a Date or Date and Time value to use in the date subtraction.
systemrules.customfielddivide.description=Used to create a custom record field, this function returns the results of dividing two numbers. You can divide by record fields, related record fields, or literal values of type Number (Integer) or Number (Decimal).
systemrules.customfielddivide.parameter.denominator=The record field, related record field, or literal value by which the numerator is divided. Valid data types\: Number (Integer) or Number (Decimal).
systemrules.customfielddivide.parameter.numerator=The record field, related record field, or literal value to divide. Valid data types\: Number (Integer) or Number (Decimal).
systemrules.customfieldlogicalexpression.description=Used in the \u2019whenTrue\u2019 parameter of a\!customFieldMatch(), this function allows you to group multiple logical conditions using the "AND" and "OR" operators.
systemrules.customfieldlogicalexpression.parameter.conditions=A list of a\!customFieldLogicalExpression(), a\!customFieldCondition(), or both. Alternatively, you can provide any custom field function or record field that returns a boolean. You can reference record fields or related record fields using the recordType\! domain. You can also use fv\!value to access the \u2019value\u2019 parameter from a\!customFieldMatch().
systemrules.customfieldlogicalexpression.parameter.operator=Determines how a set of conditions are evaluated. Valid values\: "AND" and "OR".
systemrules.customfieldmultiply.description=Used to create a custom record field, this function returns the result of multiplying a series of values. You can multiply by record fields, related record fields, or literal values of type Number (Integer) or Number (Decimal).
systemrules.customfieldmultiply.parameter.value=An array containing any combination of record fields, related record fields, or literal values to be multiplied. 
systemrules.customfieldsubtract.description=Used to create a 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).
systemrules.customfieldsubtract.parameter.value1=The record field, related record field, or literal value from which value2 is subtracted. Valid data types\: Number (Integer) or Number (Decimal).
systemrules.customfieldsubtract.parameter.value2=The record field, related record field, or literal value to subtract. Valid data types\: Number (Integer) or Number (Decimal).
systemrules.customfieldsum.description=Used to create a 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).
systemrules.customfieldsum.parameter.value=An array containing any combination of record fields, related record fields, or literal values to be summed. 
systemrules.dashboardlayout.description=WARNING\: This function is deprecated and may be removed in a future release. Instead, use another layout or a list of components.
systemrules.dashboardlayout.parameter.contents=Components and layouts to display in the dashboard body.
systemrules.dashboardlayout.parameter.showwhen=Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default\: true.
systemrules.dashboardlayout_17r1.description=WARNING\: This function is deprecated and may be removed in a future release. Instead, use another layout or a list of components.
systemrules.dashboardlayout_17r1.parameter.firstcolumncontents=Array of components to display in the first column.
systemrules.dashboardlayout_17r1.parameter.secondcolumncontents=Array of components to display in the second column.
systemrules.dashboardlayout_17r1.parameter.showwhen=Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default\: true.
systemrules.dashboardlayoutcolumns.description=This function has been deprecated. Use a\!dashboardLayout instead. See the documentation for a\!dashboardLayout to learn about this function. Displays up to two columns of components. Use this as the top-level layout for record views and Tempo reports when you are defining columns using a rule that is may be used in other layouts or if you are displaying empty columns.
systemrules.dashboardlayoutcolumns.parameter.columns=Array of columns to display on the dashboard, created with a\!columnLayout().
systemrules.dashboardlayoutcolumns.parameter.showwhen=Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default\: true.
systemrules.datasubset.description=Creates a value of type DataSubset for service-backed records and custom pickers, leaving the data as provided. To apply sorting or paging, use todatasubset().
systemrules.datasubset.parameter.batchsize=Number of items to return. It must be -1 (indicating all items) or greater.
systemrules.datasubset.parameter.data=Array of data values.
systemrules.datasubset.parameter.identifiers=Array of identifiers.
systemrules.datasubset.parameter.sort=Array of Sort Info configurations created with a\!sortInfo().
systemrules.datasubset.parameter.startindex=Index of the source data where the current page begins. It must be greater than zero.
systemrules.datasubset.parameter.totalcount=Number of rows of data across all pages.
systemrules.datedisplayfield.description=WARNING\: This function is deprecated and may be removed in a future release. Instead, use a\!dateField() with the readOnly attribute set to true.
systemrules.datedisplayfield.parameter.instructions=Supplemental text about this field.
systemrules.datedisplayfield.parameter.label=Text to display as the field label.
systemrules.datedisplayfield.parameter.value=Date to display in the field.
systemrules.datefield.description=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. See [documentation](links.docs.systemrules.datefield.doc) for more details.
systemrules.datefield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.datefield.parameter.align=Determines alignment of the date value. Appian recommends this setting only be used inside the Grid Layout component. Valid values\: "LEFT", "CENTER", "RIGHT".
systemrules.datefield.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.datefield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.datefield.parameter.instructions=Supplemental text about this field.
systemrules.datefield.parameter.label=Text to display as the field label.
systemrules.datefield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.datefield.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.datefield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.datefield.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.datefield.parameter.saveinto=One or more variables that are updated with the date when the user changes it. Use a\!save() to save a modified or alternative value to a variable.
systemrules.datefield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.datefield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.datefield.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.datefield.parameter.value=Date to display in the field.
systemrules.datetimedisplayfield.description=WARNING\: This function is deprecated and may be removed in a future release. Instead, use a\!dateTimeField() with the readOnly attribute set to true.
systemrules.datetimedisplayfield.parameter.instructions=Supplemental text about this field.
systemrules.datetimedisplayfield.parameter.label=Text to display as the field label.
systemrules.datetimedisplayfield.parameter.value=Date and time to display in the field.
systemrules.datetimefield.description=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. See [documentation](links.docs.systemrules.datetimefield.doc) for more details.
systemrules.datetimefield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.datetimefield.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.datetimefield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.datetimefield.parameter.instructions=Supplemental text about this field.
systemrules.datetimefield.parameter.label=Text to display as the field label.
systemrules.datetimefield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.datetimefield.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.datetimefield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.datetimefield.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.datetimefield.parameter.saveinto=One or more variables that are updated with the date and time when the user changes it. Use a\!save() to save a modified or alternative value to a variable.
systemrules.datetimefield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.datetimefield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.datetimefield.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.datetimefield.parameter.value=Date and time to display in the field.
systemrules.deactivateuser.description=Deactivates a user. This function will only execute inside a saveInto or a Web API.
systemrules.deactivateuser.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.deactivateuser.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.deactivateuser.parameter.user=The user to deactivate.
systemrules.deletedocument.description=Deletes a document. This function will only execute inside a saveInto or a Web API.
systemrules.deletedocument.parameter.document=The document to delete.
systemrules.deletedocument.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.deletedocument.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.deletefolder.description=Deletes a folder. This function will only execute inside a saveInto or a Web API.
systemrules.deletefolder.parameter.deletesubfolders=Delete subfolders? Default\: false.
systemrules.deletefolder.parameter.folder=The folder to delete.
systemrules.deletefolder.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.deletefolder.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.deletefromdatastoreentities.description=Deletes data from data store entities. This function will only execute inside a saveInto or a Web API.
systemrules.deletefromdatastoreentities.parameter.datatodelete=A list of EntityDataIdentifiers that identify the items to delete.
systemrules.deletefromdatastoreentities.parameter.deletioncomment=Additional info to capture in the audit logs, for example, if the node is run as an administrator, indicate the user who requested the deletion.
systemrules.deletefromdatastoreentities.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.deletefromdatastoreentities.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.deletegroup.description=Deletes the group. This function will only execute inside a saveInto or a Web API.
systemrules.deletegroup.parameter.group=The group to delete.
systemrules.deletegroup.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.deletegroup.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.deleteknowledgecenter.description=Deletes a knowledge center. This function will only execute inside a saveInto or a Web API.
systemrules.deleteknowledgecenter.parameter.deletesubfolders=Delete subfolders? Default\: false.
systemrules.deleteknowledgecenter.parameter.knowledgecenter=The knowledge center to delete.
systemrules.deleteknowledgecenter.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.deleteknowledgecenter.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.deleterecords.description=Delete data in your data source and immediately sync those changes in your record type. This function is only available for database-backed record types with data sync enabled, and can be used within an interface or a web API.
systemrules.deleterecords.parameter.onerror=A list of saves or an HTTP response to execute when the smart service fails to delete rows. Created with a\!save() or a\!httpResponse(). Use fv\!error to reference any errors from the source.
systemrules.deleterecords.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service successfully deletes rows. Created with a\!save() or a\!httpResponse(). Use fv\!countOfRecordsDeleted to reference the number of records deleted.
systemrules.deleterecords.parameter.records=The list of records to delete.
systemrules.deleterecords_23r3.description=This is an older version of the a\!deleteRecords() function. You can continue to use this version of the function by its new name\: a\!deleteRecords(). The new version of a\!deleteRecords() has new functionality.
systemrules.deleterecords_23r3.parameter.onerror=A list of saves or an HTTP response to execute when the smart service fails to delete rows. Created with a\!save() or a\!httpResponse(). Use fv\!error to reference any errors from the source.
systemrules.deleterecords_23r3.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service successfully deletes rows. Created with a\!save() or a\!httpResponse(). Use fv\!countOfRecordsDeleted to reference the number of records deleted.
systemrules.deleterecords_23r3.parameter.records=The list of records to delete.
systemrules.deleterecordsfromsource.description=Delete data in your data source and immediately sync those changes in your record type. This function is only available for database-backed record types with data sync enabled, and can be used within an interface or a web API.
systemrules.deleterecordsfromsource.parameter.onerror=A list of saves or an HTTP response to execute when the smart service fails to delete rows. Created with a\!save() or a\!httpResponse(). Use fv\!errors to reference any errors from the source.
systemrules.deleterecordsfromsource.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service successfully deletes rows. Created with a\!save() or a\!httpResponse(). Use fv\!countOfRecordsDeleted to reference the number of records deleted.
systemrules.deleterecordsfromsource.parameter.records=The list of records to delete.
systemrules.documentandfolderbrowserfieldcolumns.description=Displays the contents of a folder and allows users to navigate through a series of folders to find and select a folder or document. See [documentation](links.docs.systemrules.documentandfolderbrowserfieldcolumns.doc) for more details.
systemrules.documentandfolderbrowserfieldcolumns.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.documentandfolderbrowserfieldcolumns.parameter.height=Determines the height of the component. Valid values\: "SHORT", "MEDIUM" (default), "TALL".
systemrules.documentandfolderbrowserfieldcolumns.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.documentandfolderbrowserfieldcolumns.parameter.instructions=Supplemental text about this field.
systemrules.documentandfolderbrowserfieldcolumns.parameter.label=Text to display as the field label.
systemrules.documentandfolderbrowserfieldcolumns.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.documentandfolderbrowserfieldcolumns.parameter.navigationsaveinto=Variable or list of variables to update when the navigation folder changes.
systemrules.documentandfolderbrowserfieldcolumns.parameter.navigationvalue=The folder that has been navigated to whose contents are displayed in the rightmost column.
systemrules.documentandfolderbrowserfieldcolumns.parameter.readonly=Determines whether selection is enabled. Default\: false.
systemrules.documentandfolderbrowserfieldcolumns.parameter.rootfolder=The contents of the specified folder or knowledge center are displayed in the first column of the browser.
systemrules.documentandfolderbrowserfieldcolumns.parameter.selectionsaveinto=Variable or list of variables to update when a document or folder is clicked.
systemrules.documentandfolderbrowserfieldcolumns.parameter.selectionvalue=The document or folder to show as selected.
systemrules.documentandfolderbrowserfieldcolumns.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.documentbrowserfieldcolumns.description=Displays the contents of a folder and allows users to navigate through a series of folders to find and select a document. See [documentation](links.docs.systemrules.documentbrowserfieldcolumns.doc) for more details.
systemrules.documentbrowserfieldcolumns.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.documentbrowserfieldcolumns.parameter.height=Determines the height of the component. Valid values\: "SHORT", "MEDIUM" (default), "TALL".
systemrules.documentbrowserfieldcolumns.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.documentbrowserfieldcolumns.parameter.instructions=Supplemental text about this field.
systemrules.documentbrowserfieldcolumns.parameter.label=Text to display as the field label.
systemrules.documentbrowserfieldcolumns.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.documentbrowserfieldcolumns.parameter.navigationsaveinto=Variable or list of variables to update when the navigation folder changes.
systemrules.documentbrowserfieldcolumns.parameter.navigationvalue=The folder that has been navigated to whose contents are displayed in the rightmost column.
systemrules.documentbrowserfieldcolumns.parameter.readonly=Determines whether selection is enabled. Default\: false.
systemrules.documentbrowserfieldcolumns.parameter.rootfolder=The contents of the specified folder or knowledge center are displayed in the first column of the browser.
systemrules.documentbrowserfieldcolumns.parameter.selectionsaveinto=Variable or list of variables to update when a document is clicked.
systemrules.documentbrowserfieldcolumns.parameter.selectionvalue=The document to show as selected.
systemrules.documentbrowserfieldcolumns.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.documentbrowserfieldcolumns_17r3.description=This is an older version of the a\!documentBrowserFieldColumns function. You can continue to use this version of the function by its new name\: a\!documentBrowserFieldColumns_17r3. The new version of a\!documentBrowserFieldColumns has new functionality. Displays the contents of a folder and allows users to navigate through a series of folders to find and download documents.
systemrules.documentbrowserfieldcolumns_17r3.parameter.folder=The contents of the selected folder are displayed in the document browser.
systemrules.documentbrowserfieldcolumns_17r3.parameter.height=Determines the height of the component. Valid values\: "SHORT", "MEDIUM" (default), "TALL".
systemrules.documentbrowserfieldcolumns_17r3.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.documentbrowserfieldcolumns_17r3.parameter.instructions=Supplemental text about this field.
systemrules.documentbrowserfieldcolumns_17r3.parameter.knowledgecenter=The contents of the selected knowledge center are displayed in the document browser.
systemrules.documentbrowserfieldcolumns_17r3.parameter.label=Text to display as the field label.
systemrules.documentbrowserfieldcolumns_17r3.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "COLLAPSED".
systemrules.documentbrowserfieldcolumns_17r3.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.documentdownloadlink.description=Defines a link used to download a document. Links can be used in charts, grids, hierarchy browsers, images, link fields, milestones, pickers, and rich text.
systemrules.documentdownloadlink.parameter.document=The document to download when the link is clicked.
systemrules.documentdownloadlink.parameter.label=Label associated with this link.
systemrules.documentdownloadlink.parameter.showwhen=Determines whether the link is displayed in the component. When set to false, the link is hidden and is not evaluated. Default\: true.
systemrules.documentimage.description=Displays an image from document management for use in an image field, rich text, hierarchy tree browser, billboard, or image column in a grid.
systemrules.documentimage.parameter.alttext=Equivalent alternate text used when accessibility issues prevent the image from displaying.
systemrules.documentimage.parameter.caption=Text to display in mouseovers and slideshows.
systemrules.documentimage.parameter.document=The document to display as an image.
systemrules.documentimage.parameter.link=Link that determines the behavior when the image is clicked. 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().
systemrules.documentimage.parameter.showwhen=Determines whether the image is displayed in the component. When set to false, the image is hidden and is not evaluated. Default\: true.
systemrules.documentviewerfield.description=Displays a document from document management on an interface. See [documentation](links.docs.systemrules.documentviewerfield.doc) for more details.
systemrules.documentviewerfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.documentviewerfield.parameter.alttext=Equivalent alternate text provided to assistive technology.
systemrules.documentviewerfield.parameter.disabled=Determines if the user is prevented from interacting with the document. Default\: false.
systemrules.documentviewerfield.parameter.document=The document to display.
systemrules.documentviewerfield.parameter.height=Determines the field height. Valid values\: "SHORT", "MEDIUM" (default), "TALL".
systemrules.documentviewerfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.documentviewerfield.parameter.instructions=Supplemental text about this field.
systemrules.documentviewerfield.parameter.label=Text to display as the field label.
systemrules.documentviewerfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "COLLAPSED", "JUSTIFIED".
systemrules.documentviewerfield.parameter.marginabove=Determines how much space is added above the field. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.documentviewerfield.parameter.marginbelow=Determines how much space is added below the field. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.documentviewerfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.dropdownfield.description=Displays a list of choices for the user to select one item and saves a value based on the selected choice. See [documentation](links.docs.systemrules.dropdownfield.doc) for more details.
systemrules.dropdownfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.dropdownfield.parameter.choicelabels=Array of options for the user to select. When the data source is a record type, this is a record field or related record field.
systemrules.dropdownfield.parameter.choicevalues=Array of values associated with the corresponding choices. When the data source is a record type, this is a record field (usually the primary key field).
systemrules.dropdownfield.parameter.data=The record type used as the source of the component\u2019s choices. This can be specified with a record type reference or a\!recordData().
systemrules.dropdownfield.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.dropdownfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.dropdownfield.parameter.instructions=Supplemental text about this field.
systemrules.dropdownfield.parameter.label=Text to display as the field label.
systemrules.dropdownfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.dropdownfield.parameter.placeholder=Text to display when nothing is selected and the value is null.
systemrules.dropdownfield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.dropdownfield.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.dropdownfield.parameter.saveinto=One or more variables that are updated with the choice value when the user changes the selection. Use a\!save() to save a modified or alternative value to a variable.
systemrules.dropdownfield.parameter.searchdisplay=Determines when a search box displays above the options. Valid values\: "AUTO" (default), "ON", "OFF". When set to "AUTO", the search box displays if there are more than 11 options.
systemrules.dropdownfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.dropdownfield.parameter.sort=Array of Sort Info configurations created with a\!sortInfo().
systemrules.dropdownfield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.dropdownfield.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.dropdownfield.parameter.value=Value of the choice to display as selected.
systemrules.dropdownfield_20r2.description=This is an older version of the a\!dropdownField function. You can continue to use this version of the function by its new name\: a\!dropdownField_20r2. The new version of a\!dropdownField has new functionality which allows users to search the list of choices. To upgrade to the new version, simply remove "_20r2" from the name and rename the parameter "placeholderLabel" to "placeholder". Displays a list of choices for the user to select one item and saves a value based on the selected choice. See [documentation](links.docs.systemrules.dropdownfield.doc) for more details.
systemrules.dropdownfield_20r2.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.dropdownfield_20r2.parameter.choicelabels=Array of options for the user to select.
systemrules.dropdownfield_20r2.parameter.choicevalues=Array of values associated with the available choices.
systemrules.dropdownfield_20r2.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.dropdownfield_20r2.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.dropdownfield_20r2.parameter.instructions=Supplemental text about this field.
systemrules.dropdownfield_20r2.parameter.label=Text to display as the field label.
systemrules.dropdownfield_20r2.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.dropdownfield_20r2.parameter.placeholderlabel=Text to display when nothing is selected and the value is null.
systemrules.dropdownfield_20r2.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.dropdownfield_20r2.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.dropdownfield_20r2.parameter.saveinto=One or more variables that are updated with the choice value when the user changes the selection. Use a\!save() to save a modified or alternative value to a variable.
systemrules.dropdownfield_20r2.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.dropdownfield_20r2.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.dropdownfield_20r2.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.dropdownfield_20r2.parameter.value=Value of the choice to display as selected.
systemrules.dropdownfieldbyindex.description=Displays a list of choices for the user to select one item and saves the index of the selected choice.
systemrules.dropdownfieldbyindex.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.dropdownfieldbyindex.parameter.choicelabels=Array of options for the user to select.
systemrules.dropdownfieldbyindex.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.dropdownfieldbyindex.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.dropdownfieldbyindex.parameter.instructions=Supplemental text about this field.
systemrules.dropdownfieldbyindex.parameter.label=Text to display as the field label.
systemrules.dropdownfieldbyindex.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.dropdownfieldbyindex.parameter.placeholder=Text to display when nothing is selected and the value is null.
systemrules.dropdownfieldbyindex.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.dropdownfieldbyindex.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.dropdownfieldbyindex.parameter.saveinto=One or more variables that are updated with the choice index when the user changes the selection. Use a\!save() to save a modified or alternative value to a variable.
systemrules.dropdownfieldbyindex.parameter.searchdisplay=Determines when a search box displays above the options. Valid values\: "AUTO" (default), "ON", "OFF". When set to "AUTO", the search box displays if there are more than 11 options.
systemrules.dropdownfieldbyindex.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.dropdownfieldbyindex.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.dropdownfieldbyindex.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.dropdownfieldbyindex.parameter.value=Index of the choice to display as selected.
systemrules.dropdownfieldbyindex_20r2.description=This is an older version of the a\!dropdownFieldByIndex function. You can continue to use this version of the function by its new name\: a\!dropdownFieldByIndex_20r2. The new version of a\!dropdownFieldByIndex has new functionality which allows users to search the list of choices. To upgrade to the new version, simply remove "_20r2" from the name and rename the parameter "placeholderLabel" to "placeholder". Displays a list of choices for the user to select one item and saves the index of the selected choice.
systemrules.dropdownfieldbyindex_20r2.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.dropdownfieldbyindex_20r2.parameter.choicelabels=Array of options for the user to select.
systemrules.dropdownfieldbyindex_20r2.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.dropdownfieldbyindex_20r2.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.dropdownfieldbyindex_20r2.parameter.instructions=Supplemental text about this field.
systemrules.dropdownfieldbyindex_20r2.parameter.label=Text to display as the field label.
systemrules.dropdownfieldbyindex_20r2.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.dropdownfieldbyindex_20r2.parameter.placeholderlabel=Text to display when nothing is selected and the value is null.
systemrules.dropdownfieldbyindex_20r2.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.dropdownfieldbyindex_20r2.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.dropdownfieldbyindex_20r2.parameter.saveinto=One or more variables that are updated with the choice index when the user changes the selection. Use a\!save() to save a modified or alternative value to a variable.
systemrules.dropdownfieldbyindex_20r2.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.dropdownfieldbyindex_20r2.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.dropdownfieldbyindex_20r2.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.dropdownfieldbyindex_20r2.parameter.value=Index of the choice to display as selected.
systemrules.dynamiclink.description=Defines a link that triggers updates to one or more variables. Links can be used in charts, grids, images, link fields, milestones, pickers, and rich text.
systemrules.dynamiclink.parameter.label=Label associated with this link.
systemrules.dynamiclink.parameter.saveinto=One or more variables that are updated with the link\u2019s value when the user clicks it. Use a\!save() to save a modified or alternative value to a variable.
systemrules.dynamiclink.parameter.showwhen=Determines whether the link is displayed in the component. When set to false, the link is hidden and is not evaluated. Default\: true.
systemrules.dynamiclink.parameter.value=Value to save when the link is clicked.
systemrules.dynassociate.description=[Deprecated - use the Dynamics Connected System instead] Creates a relationship between two or more entities in Dynamics. This function returns a writer and must be used with the bind() function.
systemrules.dynassociate.parameter.endpoint=The Dynamics organization endpoint URL.
systemrules.dynassociate.parameter.parameters=The entities to associate, given as a dictionary with fields for EntityName, EntityId (GUID), Relationship, and RelatedEntities.
systemrules.dynassociate.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.dynassociate.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.dyncreate.description=[Deprecated - use the Dynamics Connected System instead] Creates a new business entity in Dynamics. This function returns a writer and must be used with the bind() function.
systemrules.dyncreate.parameter.endpoint=The Dynamics organization endpoint URL.
systemrules.dyncreate.parameter.parameters=The entity to create, given as a dictionary with the same field structure as a Dynamics Entity.
systemrules.dyncreate.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.dyncreate.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.dyndelete.description=[Deprecated - use the Dynamics Connected System instead] Delete a business entity from Dynamics. This function returns a writer and must be used with the bind() function.
systemrules.dyndelete.parameter.endpoint=The Dynamics organization endpoint URL.
systemrules.dyndelete.parameter.parameters=The entity to delete, given as a dictionary with fields for EntityName and Id (GUID).
systemrules.dyndelete.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.dyndelete.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.dyndisassociate.description=[Deprecated - use the Dynamics Connected System instead] Removes a relationship between two or more entities in Dynamics. This function returns a writer and must be used with the bind() function.
systemrules.dyndisassociate.parameter.endpoint=The Dynamics organization endpoint URL.
systemrules.dyndisassociate.parameter.parameters=The entities to disassociate, given as a dictionary with fields for EntityName, EntityId (GUID), Relationship, and RelatedEntities.
systemrules.dyndisassociate.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.dyndisassociate.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.dynretrieve.description=[Deprecated - use the Dynamics Connected System instead] Retrieves a single business entity from Dynamics.
systemrules.dynretrieve.parameter.endpoint=The Dynamics organization endpoint URL.
systemrules.dynretrieve.parameter.parameters=The entity to retrieve, given as a dictionary with fields for EntityName, Id (GUID), and ColumnSet.
systemrules.dynretrieve.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.dynretrieve.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.dynretrievemultiple.description=[Deprecated - use the Dynamics Connected System instead] Retrieves a collection of business entities from Dynamics based on the given query parameters.
systemrules.dynretrievemultiple.parameter.endpoint=The Dynamics organization endpoint URL.
systemrules.dynretrievemultiple.parameter.parameters=The query, given as a dictionary with a field named FetchExpression that has a value in the Dynamics FetchXML format.
systemrules.dynretrievemultiple.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.dynretrievemultiple.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.dynupdate.description=[Deprecated - use the Dynamics Connected System instead] Updates a business entity in Dynamics. This function returns a writer and must be used with the bind() function.
systemrules.dynupdate.parameter.endpoint=The Dynamics organization endpoint URL.
systemrules.dynupdate.parameter.parameters=The entity to update, given as a dictionary with the same field structure as a Dynamics Entity.
systemrules.dynupdate.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.dynupdate.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.editdocumentproperties.description=Modifies the properties of a document. This function will only execute inside a saveInto or a Web API.
systemrules.editdocumentproperties.parameter.description=The new description of the document.
systemrules.editdocumentproperties.parameter.document=The document to modify.
systemrules.editdocumentproperties.parameter.name=The new name of the document.
systemrules.editdocumentproperties.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.editdocumentproperties.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.editfolderproperties.description=Modifies the properties of a Folder. This function will only execute inside a saveInto or a Web API.
systemrules.editfolderproperties.parameter.folder=The folder to modify.
systemrules.editfolderproperties.parameter.name=The new name of the folder.
systemrules.editfolderproperties.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.editfolderproperties.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.editgroup.description=Modifies the properties of a group. This function will only execute inside a saveInto or a Web API.
systemrules.editgroup.parameter.delegatedcreation=Should administrators of this group be permitted to create additional groups as children? Default\: false.
systemrules.editgroup.parameter.description=A new description for the group.
systemrules.editgroup.parameter.group=The group to modify.
systemrules.editgroup.parameter.groupprivacy=Should members be able to view all other members of the group? Valid values\: "LOW" (default), "HIGH".
systemrules.editgroup.parameter.membershippolicy=How will users become members of this group? Valid values\: "CLOSED" (default), "EXCLUSIVE", "AUTOMATIC".
systemrules.editgroup.parameter.name=A new name for the group.
systemrules.editgroup.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.editgroup.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). The created group is available in the function variable fv\!group.
systemrules.editgroup.parameter.parent=The group\u2019s parent. You must be an administrator of the selected parent group.
systemrules.editgroup.parameter.securitytype=Who should have access to this group? Valid values\: "PUBLIC" (default), "PERSONAL", "RESTRICTED".
systemrules.editknowledgecenterproperties.description=Modifies the properties of a knowledge center. This function will only execute inside a saveInto or a Web API.
systemrules.editknowledgecenterproperties.parameter.description=The new description of the knowledge center.
systemrules.editknowledgecenterproperties.parameter.expirationdays=The number of days after which documents in the selected knowledge center will expire.
systemrules.editknowledgecenterproperties.parameter.knowledgecenter=The knowledge center to modify.
systemrules.editknowledgecenterproperties.parameter.name=The new name of the knowledge center.
systemrules.editknowledgecenterproperties.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.editknowledgecenterproperties.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.encryptedtextfield.description=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. See [documentation](links.docs.systemrules.encryptedtextfield.doc) for more details.
systemrules.encryptedtextfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.encryptedtextfield.parameter.align=Determines alignment of text value. Appian recommends this setting only be used inside the Grid Layout component. Valid values\: "LEFT", "CENTER", "RIGHT".
systemrules.encryptedtextfield.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.encryptedtextfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.encryptedtextfield.parameter.inputpurpose=Indicates the intent of input for accessibility improvements, like autocomplete, used by browsers and assistive technologies. Valid values are "NAME", "EMAIL", "PHONE_NUMBER", "STREET_ADDRESS", "POSTAL_CODE", "CREDIT_CARD_NUMBER", and "OFF".
systemrules.encryptedtextfield.parameter.instructions=Supplemental text about this field.
systemrules.encryptedtextfield.parameter.label=Text to display as the field label.
systemrules.encryptedtextfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.encryptedtextfield.parameter.masked=Determines if the value is obscured from view. Default\: false.
systemrules.encryptedtextfield.parameter.placeholder=Text to display in the field when it is empty. Does not show if the field is read only.
systemrules.encryptedtextfield.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.encryptedtextfield.parameter.refreshafter=Determines when the saveInto expression is evaluated. Valid values\: "UNFOCUS" (default), "KEYPRESS".
systemrules.encryptedtextfield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.encryptedtextfield.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.encryptedtextfield.parameter.saveinto=One or more variables that are updated with the encrypted text when the user changes the field.
systemrules.encryptedtextfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.encryptedtextfield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.encryptedtextfield.parameter.value=Text to display in the text field.
systemrules.entitydata.description=Creates an Entity Data for use with a\!writeToMultipleDataStoreEntities().
systemrules.entitydata.parameter.data=This field holds multiple Any Type values to store in the entity.
systemrules.entitydata.parameter.entity=This field holds a single Data Store Entity value in which the data to be updated is stored. It is required for the data type.
systemrules.entitydataidentifiers.description=Creates a EntityDataIdentifiers configuration for use with a\!deleteFromDataStoreEntities().
systemrules.entitydataidentifiers.parameter.entity=This field holds a single Data Store Entity value in which the data to be deleted is stored. It is required for the data type.
systemrules.entitydataidentifiers.parameter.identifiers=This field holds multiple Any Type values for the primary key values of the data to be deleted.
systemrules.eventdata.description=Contains the configurations for a single record for an Event History List Field component.
systemrules.eventdata.parameter.details=Any additional information about the event. If you generated an Event History record type, this field is not automatically included, but can be manually added by a developer. You must use the fv\!data prefix to access the data in this field. For example, fv\!data[recordType\!Order Event History.fields.details]. This parameter is not supported in the Timeline style.
systemrules.eventdata.parameter.eventfields=The fields that populate the event, created using a\!eventFields().
systemrules.eventdata.parameter.eventtype=The type of event. If you generated an Event Type record type, use a related record field reference for this parameter. For example, recordType\!Case.relationships.Case Events.relationships.Case Event Type.fields.name.
systemrules.eventdata.parameter.eventtypename=A record field that displays the type of event that occurred. If you generated an Event Type Lookup record type, use the eventType relationship on the Event History record type to select the name field. You must use the fv\!data prefix to access the data in this field. For example, fv\!data[recordType\!Order Event History.relationships.eventType.fields.name].
systemrules.eventdata.parameter.filters=A single logical expression or a list of query filters, which are applied together with an AND operation, can be provided to apply additional filters to the record set. Queries also inherit the record-level security or default filters defined on the referenced record type. When filtering, use only record fields or related record fields from the referenced record type. Record types sourced from a web service or other expression only support this parameter if the data is synced.
systemrules.eventdata.parameter.recordidentifier=The record identifier that links your Event History record type to your base record type.
systemrules.eventdata.parameter.recordtype=A reference to a record type, configured using the recordType\! domain. For example, recordType\!Order. If you configured [record events](links.docs.recordEvents), use the Event History record type.
systemrules.eventdata.parameter.recordtypefortag=The record type linked in the tag for an event.
systemrules.eventdata.parameter.timestamp=A record field of type Date or Date and Time that displays the timestamp when an event occurred. The list of event data will be sorted in descending order by this field. If you generated an Event History record type, use the timestamp field from that record type.
systemrules.eventdata.parameter.user=A record field of type User that displays who completed the event. If you generated an Event History record type, use the user field from that record type.
systemrules.eventfields.description=Determines the event data to display for a single record type in an Event History List Field Component.
systemrules.eventfields.parameter.createdby=A record field of type User that displays who created the event.
systemrules.eventfields.parameter.createdon=A record field of type Date and Time, Date, or Time that displays the timestamp when an event was created. The list of event data will be sorted in descending order by this field.
systemrules.eventfields.parameter.description=The mapping of the description. Access data for this particular configuration using fv\!data.
systemrules.eventfields.parameter.eventtype=The type of event. If you generated an Event Category record type, Appian suggests using a related record field reference for this parameter. For example, recordType\!Case.relationships.Case Events.relationships.Case Event Category.fields.label.
systemrules.eventhistory.description=Displays the event history for a record. Use this component to leverage multiple records in order to display the event history. 
systemrules.eventhistory.parameter.avatarcolorscheme=Determines which color scheme to use for users in the event audit component. Use one of the following valid values\: "CLASSIC", "APPIAN", "PARACHUTE" (default) or define a custom color scheme using a\!colorSchemeCustom. See [Chart Color Scheme](links.docs.systemrules.charts.param.colorScheme) for color scheme examples.
systemrules.eventhistory.parameter.displayavatar=Determines how to display user avatars. Valid values\: "NONE" (default), "INITIALS", "IMAGE".
systemrules.eventhistory.parameter.emptylistmessage=Text to display in the list when no data is available. Default is "No items available".
systemrules.eventhistory.parameter.eventInfo=The record event data that populates the list, created using one or more instances of a\!eventInfo().
systemrules.eventhistory.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is "COLLAPSED".
systemrules.eventhistory.parameter.instructions=Supplemental text about this component.
systemrules.eventhistory.parameter.label=Text to display as the component label.
systemrules.eventhistory.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.eventhistory.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.eventhistorylistfield.description=Displays the event history for one or more record types. 
systemrules.eventhistorylistfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.eventhistorylistfield.parameter.avatarcolorscheme=Determines which color scheme to use for users in the event audit component. Use one of the following valid values\: "CLASSIC", "APPIAN", "PARACHUTE" (default) or define a custom color scheme using a\!colorSchemeCustom. See [Chart Color Scheme](links.docs.systemrules.charts.param.colorScheme) for color scheme examples.
systemrules.eventhistorylistfield.parameter.collapsedetailsbydefault=Determines if the event details are collapsed when the interface first loads. Default\: true.
systemrules.eventhistorylistfield.parameter.displayavatar=Determines how to display user avatars. Valid values\: "NONE" (default), "INITIALS", "IMAGE".
systemrules.eventhistorylistfield.parameter.displayuser=Determines if and how to display user avatars. Valid values\: "NONE", "INITIALS" (default), "IMAGE".
systemrules.eventhistorylistfield.parameter.displayusercolorscheme=If no profile picture is available, determines which color scheme to use for users in the event history list. Valid values\: "PARACHUTE" (default), "VIBRANT", "CLASSIC", or define a custom color scheme using a\!colorSchemeCustom. See [Chart Color Scheme](links.docs.systemrules.charts.param.colorScheme) for color scheme examples.
systemrules.eventhistorylistfield.parameter.emptylistmessage=Text to display in the list when no data is available. Default is "No events to display".
systemrules.eventhistorylistfield.parameter.eventdata=The record event data that populates the list, created using one or more instances of a\!eventData().
systemrules.eventhistorylistfield.parameter.eventfilters=Determines which out-of-the-box filters to show. Multiple may be applied. Valid values\: "USER", "EVENT_TYPE", "DATE_RANGE".
systemrules.eventhistorylistfield.parameter.eventstyle=Determines how the component displays. Valid values\: "PREVIEW_LIST" (default), "FULL_LIST", "TIMELINE".
systemrules.eventhistorylistfield.parameter.formattimestamp=Determines how the component formats the event data timestamp. Valid values\: "DATE", "DATE_TIME" (default), "DATE_TIME_TIMEZONE".
systemrules.eventhistorylistfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is "COLLAPSED".
systemrules.eventhistorylistfield.parameter.instructions=Supplemental text about this component.
systemrules.eventhistorylistfield.parameter.label=Text to display as the component label.
systemrules.eventhistorylistfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "COLLAPSED", "JUSTIFIED".
systemrules.eventhistorylistfield.parameter.pagesize=The maximum number of rows to display in each page of the list when the "FULL_LIST" or "TIMELINE" event style is selected. When the "PREVIEW_LIST" event style is selected, this parameter applies to the list as it appears in the View All dialog. For "FULL_LIST" or "PREVIEW_LIST" valid values include 1-100, for "TIMELINE" valid values include 1-25. Default\: 10.
systemrules.eventhistorylistfield.parameter.previewlistpagesize=The maximum number of rows to display in each page of the initial list when the "PREVIEW_LIST" event style is selected. To set the paging for the View All dialog, see pageSize. Valid values\: 1-10. Default\: 5.
systemrules.eventhistorylistfield.parameter.refreshafter=Refreshes event data each time a specified event completes. Valid values\: "RECORD_ACTION".
systemrules.eventhistorylistfield.parameter.refreshalways=When true, event data will be refreshed after each user interaction and each interval refresh. Default\: false.
systemrules.eventhistorylistfield.parameter.refreshinterval=How often event data gets refreshed in minutes. When null, event data will not be refreshed on an interval. Valid values\: 0.5, 1, 2, 3, 4, 5, 10, 30, 60.
systemrules.eventhistorylistfield.parameter.refreshonreferencedvarchange=When true, data will be refreshed each time the value of any variable referenced in the eventData parameter is updated. To refresh event data when another variable that is not used in the eventData parameter changes, use refreshOnVarChange. Default\: true.
systemrules.eventhistorylistfield.parameter.refreshonvarchange=Refreshes data each time any of these specific variables change. This allows you to refresh the data when a variable that is not referenced in the eventData parameter is updated. You can define a single variable (e.g. refreshOnVarChange\: local\!var1) or a list of variables (e.g. refreshOnVarChange\: {local\!var1, local\!var2}).
systemrules.eventhistorylistfield.parameter.shortlistpagesize=The maximum number of rows to display in each page of the initial list when the "SHORT_LIST" event style is selected. To set the paging for the View All dialog, see pageSize. Valid values include 1-10. Default\: 5.
systemrules.eventhistorylistfield.parameter.showreversebutton=Determines if the button to reverse the event data sort should be shown. Default\: true
systemrules.eventhistorylistfield.parameter.showreversesortbutton=Determines if the button to reverse the event data sort should be shown. Default\: true
systemrules.eventhistorylistfield.parameter.showsearchbox=Determines if the record search box should be shown. Default\: true.
systemrules.eventhistorylistfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.eventhistorylistfield.parameter.userfilters=List of user filter references to display, configured using the recordType\! domain. For example, recordType\!Case.filters.status. You may only reference user filters defined on the source record type used for the event data. This parameter only applies when there is only one event data.
systemrules.eventinfo.description=Contains the configurations for a single record for an Event History component.
systemrules.eventinfo.parameter.createdby=The mapping of the user. Access data for this particular configuration using fv\!data.
systemrules.eventinfo.parameter.createdon=The record field containing the timestamp the event was created on. This field is how the data will be sorted.
systemrules.eventinfo.parameter.description=The mapping of the description. Access data for this particular configuration using fv\!data.
systemrules.eventinfo.parameter.eventtype=The event type of the Record entry. Access data for this particular configuration using fv\!data.
systemrules.eventinfo.parameter.filters=A single logical expression or a list of query filters, which are applied together with an AND operation, can be provided to apply additional filters to the record set. Queries also inherit the default filters defined on the referenced record type. When filtering, use only record fields or related record fields from the referenced record type. Record types sourced from a web service or other expression only support this parameter if the data is synced.
systemrules.eventinfo.parameter.recordtype=A reference to a record type, configured using the recordType\! domain. For example, recordType\!Case.
systemrules.example_amenities_image.description=Returns example image.
systemrules.example_apartment_building_image.description=Returns example image.
systemrules.example_billboard_image.description=Returns example image.
systemrules.example_call_to_action_image.description=Returns example image.
systemrules.example_document_image.description=Returns example image.
systemrules.example_facilities_image.description=Returns example image.
systemrules.example_finance_image.description=Returns example image.
systemrules.example_floor_plans_image.description=Returns example image.
systemrules.example_insurance_image.description=Returns example image.
systemrules.example_it_support_image.description=Returns example image.
systemrules.example_receptionist_image.description=Returns example image.
systemrules.example_vertical_connector_image.description=Returns example image.
systemrules.executestoredprocedureforquery.description=Executes stored procedures in a database. Because this function can run more than once, do not use it with stored procedures that modify data as it could have unintended effects. For stored procedures that modify data, use a\!executeStoredProcedureOnSave.
systemrules.executestoredprocedureforquery.parameter.autocommit=Determines whether the database will automatically issue a "COMMIT" operation after every SQL operation.
systemrules.executestoredprocedureforquery.parameter.datasource=The data source that contains the stored procedure. The value depends on how your data source is connected. For data source connected systems, enter the connected system constant. For data sources connected in the Administration Console, enter the name of the data source or a Text constant that stores the name.
systemrules.executestoredprocedureforquery.parameter.inputs=A list of names and values of the IN and INOUT parameters to the stored procedure created using a\!storedProcedureInput(). An input must be provided for every IN and INOUT parameter. Stored procedure parameter names in Oracle, Db2, and PostgreSQL databases are case-sensitive.
systemrules.executestoredprocedureforquery.parameter.procedurename=Name of the stored procedure. Stored procedure names in Oracle, Db2, and PostgreSQL databases are case-sensitive.
systemrules.executestoredprocedureforquery.parameter.timeout=Amount of time in seconds until the execution is canceled.
systemrules.executestoredprocedureonsave.description=Executes stored procedures in a database. This function will only execute inside a saveInto or a Web API.
systemrules.executestoredprocedureonsave.parameter.datasource=The data source that contains the stored procedure. The value depends on how your data source is connected. For data source connected systems, enter the connected system constant. For data sources connected in the Administration Console, enter the name of the data source or a Text constant that stores the name.
systemrules.executestoredprocedureonsave.parameter.inputs=A list of names and values of the IN and INOUT parameters to the stored procedure created using a\!storedProcedureInput(). An input must be provided for every IN and INOUT parameter. Stored procedure parameter names in Oracle, Db2, and PostgreSQL databases are case-sensitive.
systemrules.executestoredprocedureonsave.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse(). The error message is available in the function variable fv\!errorMessage.
systemrules.executestoredprocedureonsave.parameter.onsuccess=A list of saves or an HTTP response to execute after the function executes successfully. Created with a\!save() or a\!httpResponse(). The result sets and parameters are available in the function variables fv\!resultSets and fv\!parameters, respectively.
systemrules.executestoredprocedureonsave.parameter.procedurename=Name of the stored procedure. Stored procedure names in Oracle, Db2, and PostgreSQL databases are case-sensitive.
systemrules.executestoredprocedureonsave.parameter.timeout=Amount of time in seconds until the execution is canceled. Default is 30 seconds and maximum is 300 seconds.
systemrules.exportdatastoreentitytocsv.description=Exports the selected data store entity to CSV. This function will only execute inside a saveInto or a Web API.
systemrules.exportdatastoreentitytocsv.parameter.aggregation=(Optional) A list of fields and the operations you wish to perform on them when retrieving the data, created with a\!queryAggregation().
systemrules.exportdatastoreentitytocsv.parameter.csvdelimiter=(Optional) The field delimiter used to separate fields in the CSV file. Valid values are\: "TAB", "COMMA", "SEMICOLON", "SPACE", "PIPE", "CARET". Default\: "COMMA".
systemrules.exportdatastoreentitytocsv.parameter.documentdescription=(Optional) A brief description of the document.
systemrules.exportdatastoreentitytocsv.parameter.documentname=The name of the new document that is to be created by this smart service.
systemrules.exportdatastoreentitytocsv.parameter.documenttoupdate=The existing document to update with the exported data. Using this parameter will append new contents at the end of the file. Note\: A new version of this document will be created.
systemrules.exportdatastoreentitytocsv.parameter.entity=The data store entity to query.
systemrules.exportdatastoreentitytocsv.parameter.filters=(Optional) A set of conditions to apply to the queried data before any grouping or aggregation. Can use either a list of a\!queryFilter() or a single a\!queryLogicalExpression(). When using a list of a\!queryFilter(), all filters are combined using the AND operator.
systemrules.exportdatastoreentitytocsv.parameter.includeheader=(Optional) Outputs the field name or its alias, if available, in the first row of the document if set to true. Default\: true
systemrules.exportdatastoreentitytocsv.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.exportdatastoreentitytocsv.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). The document ID of the created/updated document is returned in the fv\!newDocument function variable.
systemrules.exportdatastoreentitytocsv.parameter.saveinfolder=The folder where the newly created document is to be stored. Applicable and required when creating a new document.
systemrules.exportdatastoreentitytocsv.parameter.selection=(Optional) A list of fields that you wish to retrieve, created with a\!querySelection().
systemrules.exportdatastoreentitytoexcel.description=Exports the selected data store entity to Excel. This function will only execute inside a saveInto or a Web API.
systemrules.exportdatastoreentitytoexcel.parameter.aggregation=(Optional) A list of fields and the operations to perform on them when retrieving the data, created with a\!queryAggregation(). The aggregation accepts up to 50 columns.
systemrules.exportdatastoreentitytoexcel.parameter.customcellpositions=(Optional) Array of cell positions where custom cell values should be added.
systemrules.exportdatastoreentitytoexcel.parameter.customcellvalues=(Optional) Array of values to be added on the specified custom cell position.
systemrules.exportdatastoreentitytoexcel.parameter.documentdescription=(Optional) A brief description of the document.
systemrules.exportdatastoreentitytoexcel.parameter.documentname=The name of the new document that is to be created by this smart service.
systemrules.exportdatastoreentitytoexcel.parameter.documenttoupdate=The existing document to update with the exported data. This can be useful when using the smart service multiple times in the same process model, or if formatting is needed. See [Supported Excel Formatting](links.docs.export.dse.excel.update.formatting). Appian supports Excel 2007 and above. Note\: A new version of this document will be created.
systemrules.exportdatastoreentitytoexcel.parameter.entity=The data store entity to query.
systemrules.exportdatastoreentitytoexcel.parameter.filters=(Optional) A set of conditions to apply to the queried data before any grouping or aggregation. Can use either a list of a\!queryFilter() or a single a\!queryLogicalExpression(). When using a list of a\!queryFilter(), all filters are combined using the AND operator.
systemrules.exportdatastoreentitytoexcel.parameter.includeheader=(Optional) Outputs the field name or its alias, if available, in the first row of the document if set to true. Default\: true
systemrules.exportdatastoreentitytoexcel.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.exportdatastoreentitytoexcel.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). The document ID of the created/updated document is returned in the fv\!newDocument function variable.
systemrules.exportdatastoreentitytoexcel.parameter.saveinfolder=The folder where the newly created document is to be stored. Applicable and required when creating a new document.
systemrules.exportdatastoreentitytoexcel.parameter.selection=(Optional) A list of fields to retrieve, created with a\!querySelection(). The selection accepts up to 50 columns.
systemrules.exportdatastoreentitytoexcel.parameter.sheetname=(Optional) The name of the sheet where data will be added as a result of executing this smart service. The following characters will be replaced with underscores\: [ ] / \\ ? *
systemrules.exportdatastoreentitytoexcel.parameter.sheetnumber=(Optional) The sheet number where data will be added as a result of executing this smart service. Default is 1, the first sheet.
systemrules.exportdatastoreentitytoexcel.parameter.startingcell=(Optional) The cell where the output will begin. Default\: "A1". Any data in rows above this cell will remain in the sheet; any data in the same row or below will be removed and overwritten.
systemrules.exportdatastoreentitytoexcel_18r2.description=Exports the selected data store entity to Excel. This function will only execute inside a saveInto or a Web API.
systemrules.exportdatastoreentitytoexcel_18r2.parameter.aggregation=(Optional) A list of fields and the operations you wish to perform on them when retrieving the data, created with a\!queryAggregation().
systemrules.exportdatastoreentitytoexcel_18r2.parameter.customcellpositions=(Optional) Array of cell positions where custom cell values should be added.
systemrules.exportdatastoreentitytoexcel_18r2.parameter.customcellvalues=(Optional) Array of values to be added on the specified custom cell position.
systemrules.exportdatastoreentitytoexcel_18r2.parameter.documentdescription=(Optional) A brief description of the document.
systemrules.exportdatastoreentitytoexcel_18r2.parameter.documentname=The name of the new document that is to be created by this smart service.
systemrules.exportdatastoreentitytoexcel_18r2.parameter.documenttoupdate=The existing document to update with the exported data. Note\: A new version of this document will be created.
systemrules.exportdatastoreentitytoexcel_18r2.parameter.filters=(Optional) A set of conditions to apply to the queried data before any grouping or aggregation. Can use either a list of a\!queryFilter() or a single a\!queryLogicalExpression(). When using a list of a\!queryFilter(), all filters are combined using the AND operator.
systemrules.exportdatastoreentitytoexcel_18r2.parameter.includeheader=(Optional) Outputs the field name or its alias, if available, in the first row of the document if set to true. Default\: true
systemrules.exportdatastoreentitytoexcel_18r2.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.exportdatastoreentitytoexcel_18r2.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). The document ID of the created/updated document is returned in the fv\!newDocument function variable.
systemrules.exportdatastoreentitytoexcel_18r2.parameter.saveinfolder=The folder where the newly created document is to be stored. Applicable and required when creating a new document.
systemrules.exportdatastoreentitytoexcel_18r2.parameter.selection=(Optional) A list of fields that you wish to retrieve, created with a\!querySelection().
systemrules.exportdatastoreentitytoexcel_18r2.parameter.sheetname=(Optional) The name of the sheet where data will be added as a result of executing this smart service. The following characters will be replaced with underscores\: [ ] / \\ ? *
systemrules.exportdatastoreentitytoexcel_18r2.parameter.sheetnumber=(Optional) The sheet number where data will be added as a result of executing this smart service. Default is 1, the first sheet.
systemrules.exportdatastoreentitytoexcel_18r2.parameter.source=The data store entity to query.
systemrules.exportdatastoreentitytoexcel_18r2.parameter.startingcell=(Optional) The cell where the output will begin. Default\: "A1".
systemrules.exportprocessreporttocsv.description=Exports data from a process report to CSV. This function will only execute inside a saveInto or a Web API.
systemrules.exportprocessreporttocsv.parameter.context=Contains an array of either Group, User, Number (Integer), or Process Model to pass to the report context.
systemrules.exportprocessreporttocsv.parameter.csvdelimiter=(Optional) The field delimiter used to separate fields in the CSV file. Valid values are\: "TAB", "COMMA", "SEMICOLON", "SPACE", "PIPE", "CARET". Default\: "COMMA".
systemrules.exportprocessreporttocsv.parameter.documentdescription=(Optional) A brief description of the document.
systemrules.exportprocessreporttocsv.parameter.documentname=The name of the new document that is to be created by this smart service.
systemrules.exportprocessreporttocsv.parameter.documenttoupdate=The existing document to update with the exported data. Using this parameter will append new contents at the end of the file. Note\: A new version of this document will be created.
systemrules.exportprocessreporttocsv.parameter.filters=(Optional) A set of conditions to apply to the queried data. Can use either a list of a\!queryFilter() or a single a\!queryLogicalExpression(). When using a list of a\!queryFilter(), all filters are combined using the AND operator. User filters saved to the process report are applied before these are.
systemrules.exportprocessreporttocsv.parameter.includeheader=(Optional) Outputs the field\u2019s label in the first row of the document if set to true. Default\: true
systemrules.exportprocessreporttocsv.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.exportprocessreporttocsv.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). The document ID of the created/updated document is returned in the fv\!newDocument function variable.
systemrules.exportprocessreporttocsv.parameter.report=The process report to query.
systemrules.exportprocessreporttocsv.parameter.saveinfolder=The folder where the newly created document is to be stored. Applicable and required when creating a new document.
systemrules.exportprocessreporttoexcel.description=Exports data from a process report to Excel. This function will only execute inside a saveInto or a Web API.
systemrules.exportprocessreporttoexcel.parameter.context=Contains an array of either Group, User, Number (Integer), or Process Model to pass to the report context.
systemrules.exportprocessreporttoexcel.parameter.customcellpositions=(Optional) Array of cell positions where custom cell values should be added.
systemrules.exportprocessreporttoexcel.parameter.customcellvalues=(Optional) Array of values to be added on the specified custom cell position.
systemrules.exportprocessreporttoexcel.parameter.documentdescription=(Optional) A brief description of the document.
systemrules.exportprocessreporttoexcel.parameter.documentname=The name of the new document that is to be created by this smart service.
systemrules.exportprocessreporttoexcel.parameter.documenttoupdate=The existing document to update with the exported data. This can be useful when using the smart service multiple times in the same process model, or if formatting is needed. See [Supported Excel Formatting](links.docs.export.report.excel.update.formatting). Appian supports Excel 2007 and above. Note\: A new version of this document will be created.
systemrules.exportprocessreporttoexcel.parameter.filters=(Optional) A set of conditions to apply to the queried data. Can use either a list of a\!queryFilter() or a single a\!queryLogicalExpression(). When using a list of a\!queryFilter(), all filters are combined using the AND operator. User filters saved to the process report are applied before these are.
systemrules.exportprocessreporttoexcel.parameter.includeheader=(Optional) Outputs the field\u2019s label in the first row of the document if set to true. Default\: true
systemrules.exportprocessreporttoexcel.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.exportprocessreporttoexcel.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). The document ID of the created/updated document is returned in the fv\!newDocument function variable.
systemrules.exportprocessreporttoexcel.parameter.report=The process report to query.
systemrules.exportprocessreporttoexcel.parameter.saveinfolder=The folder where the newly created document is to be stored. Applicable and required when creating a new document.
systemrules.exportprocessreporttoexcel.parameter.sheetname=(Optional) The name of the sheet where data will be added as a result of executing this smart service. The following characters will be replaced with underscores\: [ ] / \\ ? *
systemrules.exportprocessreporttoexcel.parameter.sheetnumber=(Optional) The sheet number where data will be added as a result of executing this smart service. Default is 1, the first sheet.
systemrules.exportprocessreporttoexcel.parameter.startingcell=(Optional) The cell where the output will begin. Default\: "A1". Any data in rows above this cell will remain in the sheet; any data in the same row or below will be removed and overwritten.
systemrules.externalimagefield.description=WARNING\: This function is deprecated and may be removed in a future release. Instead, use a\!imageField().
systemrules.externalimagefield.parameter.alttext=Equivalent alternate text used when accessibility issues prevent the image from displaying.
systemrules.externalimagefield.parameter.instructions=Supplemental text about this field.
systemrules.externalimagefield.parameter.label=Text to display as the field label.
systemrules.externalimagefield.parameter.source=Source of the image to display.
systemrules.externallinkfield.description=WARNING\: This function is deprecated and may be removed in a future release. Instead, use a\!linkField().
systemrules.externallinkfield.parameter.instructions=Supplemental text about this field.
systemrules.externallinkfield.parameter.label=Text to display as the field label.
systemrules.externallinkfield.parameter.links=Array of links to display in the field.
systemrules.facet.description=WARNING\: This function is deprecated and may be removed in a future release. Instead, use a\!recordFilterList()
systemrules.facet.parameter.allowmultipleselections=Determines if the filter will allow the user to select a single option or multiple options. Default is true.
systemrules.facet.parameter.defaultoption=Determines which, if any, filter option is applied when a record list first loads.
systemrules.facet.parameter.isvisible=Determines whether the filter is visible to the user at runtime. Default is true.
systemrules.facet.parameter.name=Name of the user filter.
systemrules.facet.parameter.options=Array of filter options created with a\!facetOption().
systemrules.facet_17r1.description=Creates a value of type Facet used to define a user filter.
systemrules.facet_17r1.parameter.defaultoption=Determines which, if any, filter option is applied when a record list first loads.
systemrules.facet_17r1.parameter.isvisible=Determines whether the filter is visible to the user at runtime. Default is true.
systemrules.facet_17r1.parameter.name=Name of the user filter.
systemrules.facet_17r1.parameter.options=Array of filter options created with a\!facetOption().
systemrules.facetoption.description=WARNING\: This function is deprecated and may be removed in a future release. Instead, use a\!recordFilterListOption()
systemrules.facetoption.parameter.datacount=Number of items associated with the filter.
systemrules.facetoption.parameter.filter=Filter to apply when the filter option is selected, created with a\!queryFilter().
systemrules.facetoption.parameter.id=Integer identifier of the filter option. This must be unique across all other filter options within the same user filter.
systemrules.facetoption.parameter.name=Display name of the filter option.
systemrules.fileuploadfield.description=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. See [documentation](links.docs.systemrules.fileuploadfield.doc) for more details.
systemrules.fileuploadfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.fileuploadfield.parameter.buttondisplay=Determines if the file upload will display a button with a label or an icon. Valid values\: "LABEL", "ICON", and "LABEL_AND_ICON". Default behavior displays "LABEL" on web and "LABEL_AND_ICON" on mobile.
systemrules.fileuploadfield.parameter.buttonsize=Determines the size of the upload button. Valid values\: "SMALL" (default), "STANDARD", "LARGE".
systemrules.fileuploadfield.parameter.buttonstyle=Determines the style of the upload button. Valid values\: "PRIMARY", "SECONDARY" (default), "STANDARD", "LINK".
systemrules.fileuploadfield.parameter.disabled=Determines if the field should display as potentially editable but grayed out. When files are present in this state, they may not be deleted. Default\: false.
systemrules.fileuploadfield.parameter.filedescriptions=Determines the descriptions for the files. When not provided, the descriptions of the new files are empty. Access name, size, and extension of each file using the variables fv\!file.name, fv\!file.size, and fv\!file.extension. Access the index of each file using the variable fv\!index.
systemrules.fileuploadfield.parameter.filenames=Determines the names for the files. When not provided, the uploaded filenames are used. Access name, size, and extension of each file using the variables fv\!file.name, fv\!file.size, and fv\!file.extension. Access the index of each file using the variable fv\!index.
systemrules.fileuploadfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.fileuploadfield.parameter.instructions=Supplemental text about this field.
systemrules.fileuploadfield.parameter.label=Text to display as the field label.
systemrules.fileuploadfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.fileuploadfield.parameter.maxselections=Maximum number of allowed files. Once this number is reached, further uploads are blocked until a file is removed.
systemrules.fileuploadfield.parameter.placeholder=Text to display when no file is uploaded. Default\: "Drop files here".
systemrules.fileuploadfield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.fileuploadfield.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.fileuploadfield.parameter.saveinto=One or more variables that are updated with the files when the user uploads files. Removing all uploaded files saves a null document. Use a\!save() to save a modified or alternative value to a variable.
systemrules.fileuploadfield.parameter.showvirusscanmessage=Determines whether the "Scanning for viruses" message appears during file upload. When set to false, the message is hidden, but the file is still scanned for viruses. An error message will still appear if real-time virus scanning is enabled and the uploaded file contains a virus. Default\: true.
systemrules.fileuploadfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.fileuploadfield.parameter.target=Determines the eventual location of the uploaded files.
systemrules.fileuploadfield.parameter.uploadmethods=(Mobile-only) Determines which mobile upload methods are displayed to users. If one method is specified, the upload button will be customized. Multiple may be applied. If value is null, all methods are provided. Valid values include\: null (default), "SIGNATURE", "CAMERA", "CHOOSE_PHOTO", "CHOOSE_FILE".
systemrules.fileuploadfield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.fileuploadfield.parameter.validations=Validation errors to display below the field when the value is not null. Access the names, sizes, and extensions of the uploaded files using the variables fv\!files.name, fv\!files.size, and fv\!files.extension.
systemrules.fileuploadfield.parameter.value=The files associated with this field.
systemrules.fileuploadfield_17r1.description=This is an older version of the a\!fileUploadField function. You can continue to use this version of the function by its new name\: a\!fileUploadField_17r1. The new version of a\!fileUploadField has new functionality. Allows users to upload a file. File upload is only enabled on start forms and task forms. Uploaded documents are not accessible until after form submission.
systemrules.fileuploadfield_17r1.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.fileuploadfield_17r1.parameter.documentdescription=Determines the description for the document. When not provided, the description of the new file or version is empty.
systemrules.fileuploadfield_17r1.parameter.documentname=Determines the name for the document. When not provided, the uploaded filename is used.
systemrules.fileuploadfield_17r1.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.fileuploadfield_17r1.parameter.instructions=Supplemental text about this field.
systemrules.fileuploadfield_17r1.parameter.label=Text to display as the field label.
systemrules.fileuploadfield_17r1.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.fileuploadfield_17r1.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.fileuploadfield_17r1.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.fileuploadfield_17r1.parameter.saveinto=One or more variables that are updated with the document when the user uploads a file. Removing an uploaded file saves a null document. Use a\!save() to save a modified or alternative value to a variable.
systemrules.fileuploadfield_17r1.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.fileuploadfield_17r1.parameter.target=Determines the eventual location of the uploaded file.
systemrules.fileuploadfield_17r1.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.fileuploadfield_17r1.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.fileuploadfield_17r1.parameter.value=The document associated with this field.
systemrules.floatingpointdisplayfield.description=WARNING\: This function is deprecated and may be removed in a future release. Instead, use a\!floatingPointField() with the readOnly attribute set to true.
systemrules.floatingpointdisplayfield.parameter.instructions=Supplemental text about this field.
systemrules.floatingpointdisplayfield.parameter.label=Text to display as the field label.
systemrules.floatingpointdisplayfield.parameter.value=Number to display in the field.
systemrules.floatingpointfield.description=Displays and allows entry of a single decimal number, stored with a floating point representation. See [documentation](links.docs.systemrules.floatingpointfield.doc) for more details.
systemrules.floatingpointfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.floatingpointfield.parameter.align=Determines alignment of the number value. Appian recommends this setting only be used inside the Grid Layout component. Valid values\: "LEFT", "CENTER", "RIGHT".
systemrules.floatingpointfield.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.floatingpointfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.floatingpointfield.parameter.instructions=Supplemental text about this field.
systemrules.floatingpointfield.parameter.label=Text to display as the field label.
systemrules.floatingpointfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.floatingpointfield.parameter.placeholder=Text to display in the field when it is empty. Does not show if the field is read only.
systemrules.floatingpointfield.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.floatingpointfield.parameter.refreshafter=Determines when the saveInto expression is evaluated. Valid values\: "UNFOCUS" (default), "KEYPRESS".
systemrules.floatingpointfield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.floatingpointfield.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.floatingpointfield.parameter.saveinto=One or more variables that are updated with the number when the user changes it. Use a\!save() to save a modified or alternative value to a variable.
systemrules.floatingpointfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.floatingpointfield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.floatingpointfield.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.floatingpointfield.parameter.value=Number to display in the field.
systemrules.folderbrowserfieldcolumns.description=Displays the contents of a folder and allows users to navigate through a series of folders to find and select a folder. See [documentation](links.docs.systemrules.folderbrowserfieldcolumns.doc) for more details.
systemrules.folderbrowserfieldcolumns.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.folderbrowserfieldcolumns.parameter.height=Determines the height of the component. Valid values\: "SHORT", "MEDIUM" (default), "TALL".
systemrules.folderbrowserfieldcolumns.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.folderbrowserfieldcolumns.parameter.instructions=Supplemental text about this field.
systemrules.folderbrowserfieldcolumns.parameter.label=Text to display as the field label.
systemrules.folderbrowserfieldcolumns.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.folderbrowserfieldcolumns.parameter.navigationsaveinto=Variable or list of variables to update when the navigation folder changes.
systemrules.folderbrowserfieldcolumns.parameter.navigationvalue=The folder that has been navigated to whose contents are displayed in the rightmost column.
systemrules.folderbrowserfieldcolumns.parameter.readonly=Determines whether selection is enabled. Default\: false.
systemrules.folderbrowserfieldcolumns.parameter.rootfolder=The contents of the specified folder or knowledge center are displayed in the first column of the browser.
systemrules.folderbrowserfieldcolumns.parameter.selectionsaveinto=Variable or list of variables to update when a folder is clicked.
systemrules.folderbrowserfieldcolumns.parameter.selectionvalue=The folder to show as selected.
systemrules.folderbrowserfieldcolumns.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.foreach.description=Evaluates the provided expression once for every item and returns an array of the results.
systemrules.foreach.parameter.expression=The expression to be evaluated with each iteration. The following special variables are available\: fv\!item (the current array item), fv\!index (the current item\u2019s index in the array), fv\!itemCount (the number of items), fv\!identifier (when using a DataSubset, the current item\u2019s identifier), fv\!isFirst (true during the first iteration, false afterward), fv\!isLast (true during the last iteration, false beforehand).
systemrules.foreach.parameter.items=Array or DataSubset containing the items over which to iterate.
systemrules.formlayout.description=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 [documentation](links.docs.systemrules.formlayout.doc) for more details.
systemrules.formlayout.parameter.buttons=Buttons to display at the bottom of the form, arranged using a\!buttonLayout(). A Button Layout must be present for a back button to appear for activity-chained tasks.
systemrules.formlayout.parameter.contents=Components and layouts to display in the form body.
systemrules.formlayout.parameter.instructions=Supplemental text about this form.
systemrules.formlayout.parameter.label=Text to display as the form\u2019s title.
systemrules.formlayout.parameter.showwhen=Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default\: true.
systemrules.formlayout.parameter.skipautofocus=Determines whether the first input will receive focus when a form loads. Default is false.
systemrules.formlayout.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.formlayout.parameter.validations=Validation errors to display below the form.
systemrules.formlayout_17r1.description=This is an older version of the a\!formLayout function. You can continue to use this version of the function by its new name\: a\!formLayout_17r1. The new version of a\!formLayout has new functionality. 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.
systemrules.formlayout_17r1.parameter.buttons=Buttons to display at the bottom of the form, arranged using a\!buttonLayout(). A Button Layout must be present for a back button to appear for activity-chained tasks.
systemrules.formlayout_17r1.parameter.contents=Components and layouts to display in the form body.
systemrules.formlayout_17r1.parameter.firstcolumncontents=Array of components to display in the first column.
systemrules.formlayout_17r1.parameter.instructions=Supplemental text about this form.
systemrules.formlayout_17r1.parameter.label=Text to display as the form\u2019s title.
systemrules.formlayout_17r1.parameter.secondcolumncontents=Array of components to display in the second column.
systemrules.formlayout_17r1.parameter.showwhen=Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default\: true.
systemrules.formlayout_17r1.parameter.skipautofocus=Determines whether the first input will receive focus when a form loads. Default is false.
systemrules.formlayout_17r1.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.formlayout_17r1.parameter.validations=Validation errors to display below the form.
systemrules.formlayoutcolumns.description=This function has been deprecated. Use a\!formLayout instead. See the documentation for a\!formLayout to learn about this function. 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 when you are defining columns using a rule that is may be used in other layouts or if you are displaying empty columns.
systemrules.formlayoutcolumns.parameter.buttons=Buttons to display at the bottom of the form, arranged using a\!buttonLayout().
systemrules.formlayoutcolumns.parameter.columns=Array of columns to display on the form, created with a\!columnLayout().
systemrules.formlayoutcolumns.parameter.instructions=Supplemental text about this form.
systemrules.formlayoutcolumns.parameter.label=Text to display as the form\u2019s title.
systemrules.formlayoutcolumns.parameter.skipautofocus=Determines whether the first input will receive focus when a form loads. Default is false.
systemrules.formlayoutcolumns.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.formlayoutcolumns.parameter.validations=Validation errors to display below the form.
systemrules.fromjson.description=Converts a JSON string into an Appian value.
systemrules.fromjson.parameter.jsontext=The text to convert from a JSON string to an Appian value.
systemrules.fromjson_19r2.description=Converts a JSON string into an Appian value.
systemrules.fromjson_19r2.parameter.jsontext=The text to convert from a JSON string to an Appian value.
systemrules.fulloverlay.description=Displays a complete overlay for use in billboard layout.
systemrules.fulloverlay.parameter.alignvertical=Determines vertical alignment of all content within the overlay. Valid values are "TOP" (default), "MIDDLE", and "BOTTOM".
systemrules.fulloverlay.parameter.contents=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, Record Action Field, Rich Text, Section, Side By Side.
systemrules.fulloverlay.parameter.padding=Determines the space between the overlay\u2019s edges and its contents. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.fulloverlay.parameter.showwhen=Determines whether the overlay is displayed on the interface. When set to false, the overlay is hidden and is not evaluated. Default\: true.
systemrules.fulloverlay.parameter.style=Determines the overlay style. Valid values\: "DARK" (default), "SEMI_DARK", "NONE", "SEMI_LIGHT", "LIGHT".
systemrules.gaugefield.description=Displays completion percentage in a circular style with optional text. See [documentation](links.docs.systemrules.gaugefield.doc) for more details.
systemrules.gaugefield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.gaugefield.parameter.align=Determines alignment of the gauge. Valid values\: "START", "CENTER" (default), "END".
systemrules.gaugefield.parameter.color=Determines the color. Access the percentage using fv\!percentage. Valid values\: Any valid hex color or "ACCENT" (default), "POSITIVE", "NEGATIVE", "WARN".
systemrules.gaugefield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.gaugefield.parameter.instructions=Supplemental text about this field.
systemrules.gaugefield.parameter.label=Text to display as the field label.
systemrules.gaugefield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.gaugefield.parameter.marginabove=Determines how much space is added above the field. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.gaugefield.parameter.marginbelow=Determines how much space is added below the field. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.gaugefield.parameter.percentage=Number to display between 0 and 100.
systemrules.gaugefield.parameter.primarytext=Content to display on the first line inside the gauge. Create using plain text, a\!gaugeIcon(), a\!gaugePercentage(), or a\!gaugeFraction().
systemrules.gaugefield.parameter.secondarytext=Optional text to display on the second line inside the gauge.
systemrules.gaugefield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.gaugefield.parameter.size=Determines the size of the gauge. Valid values\: "SMALL", "MEDIUM" (default), "LARGE".
systemrules.gaugefield.parameter.tooltip=Text to display as a tooltip on the gauge.
systemrules.gaugefraction.description=Displays text in a fractional format for use within the gauge field primary text parameter.
systemrules.gaugefraction.parameter.denominator=Value to display as the bottom portion of the fraction. Value cannot be negative. Default\: 100. Numerator is calculated automatically based on denominator and fill percentage.
systemrules.gaugeicon.description=Displays an icon for use within the gauge field primary text parameter.
systemrules.gaugeicon.parameter.alttext=Equivalent alternate text to display in the hover tooltip and for use by screen readers.
systemrules.gaugeicon.parameter.color=Determines the icon color. Access the percentage using fv\!percentage. Valid values\: Any valid hex color or "ACCENT", "POSITIVE", "NEGATIVE", "WARN". Defaults to the gauge field color.
systemrules.gaugeicon.parameter.icon=Icon to display. See the [documentation for available icons](links.docs.systemrules.styledIcon.doc).
systemrules.gaugepercentage.description=Displays the configured percentage of the gauge, rounded to the nearest integer, for use within the gauge field primary text parameter.
systemrules.getdatasourceforplugin.description=Looks up a Data Source Connected System referenced by a constant and returns it to be passed to the plug-in.
systemrules.getdatasourceforplugin.parameter.datasourceconnectedsystem=Constant referencing the Data Source Connected System.
systemrules.gridcolumn.description=Displays a column of data as read-only text, links, images, rich text, or other components supported within the read-only grid.
systemrules.gridcolumn.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.gridcolumn.parameter.align=Determines the alignment for the header label and all values within the column. Valid values\: "START" (default), "CENTER", "END".
systemrules.gridcolumn.parameter.backgroundcolor=Determines the cell background color. To set the color based on the value of the cell, use fv\!row and dot notation to reference the field (such as fv\!row.status). Grids that use record data must use the recordType\! domain to reference a record field or related record field. For example, fv\!row[recordType\!Case.fields.status]. Valid colors\: Any valid hex color or "NONE" (default), "ACCENT", "SUCCESS", "INFO", "WARN", "ERROR".
systemrules.gridcolumn.parameter.helpTooltip=Displays a help icon in the column header with the specified text as a tooltip.
systemrules.gridcolumn.parameter.helptooltip=Displays a help icon in the column header with the specified text as a tooltip.
systemrules.gridcolumn.parameter.label=Text to display as the column header.
systemrules.gridcolumn.parameter.showwhen=Determines whether the column is displayed in the grid. When set to false, the column is hidden and is not evaluated. Default\: true.
systemrules.gridcolumn.parameter.sortfield=The field used to sort the grid when selecting this column header. Grids that use record data must use the recordType\! domain to reference a record field or related record field. For example, recordType\!Case.fields.caseName.
systemrules.gridcolumn.parameter.value=The value to display in each cell within the column. The value can be text, a\!imageField(), a\!linkField(), a\!richTextDisplayField(), a\!tagField(), a\!buttonArrayLayout(), a\!recordActionField(), or a\!progressBarField(). It is evaluated once for each row. Reference fields from the source using dot notation, such as fv\!row.status, or the identifier using fv\!identifier. Grids that use record data must use the recordType\! domain to reference a record field or related record field. For example, fv\!row[recordType\!Case.fields.caseName].
systemrules.gridcolumn.parameter.width=Determines the column width. Valid values\: "AUTO" (default), "ICON", "ICON_PLUS", "NARROW", "NARROW_PLUS", "MEDIUM", "MEDIUM_PLUS", "WIDE", "1X", "2X", "3X", "4X", "5X", "6X", "7X", "8X", "9X", and "10X". Review [UX best practices](links.docs.systemrules.gridcolumn.width) for configuring grid column widths.
systemrules.gridfield.description=Accepts a set of data and displays it in a grid that supports selecting, sorting, and paging. You can choose to display your data as read-only text, links, images, rich text, or other components supported in read-only grids. See [documentation](links.docs.systemrules.gridfield.doc) for more details.
systemrules.gridfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.gridfield.parameter.actionsdisplay=Determines which details are shown for record actions, regardless of style. Valid values\: "LABEL_AND_ICON" (default), "LABEL", "ICON".
systemrules.gridfield.parameter.actionsstyle=Determines how the list of actions should be displayed above the grid. Valid values\: "TOOLBAR" (default), "TOOLBAR_PRIMARY". See the [documentation](links.docs.systemrules.gridfield.doc) for guidance on how to use different styles effectively.
systemrules.gridfield.parameter.borderstyle=Determines the style of the grid border. Valid values\: "STANDARD" (default), "LIGHT".
systemrules.gridfield.parameter.columns=The columns to display in the grid, configured using a\!gridColumn().
systemrules.gridfield.parameter.data=The data to display in the grid. Use a record type reference or a\!recordData() to source your data from records and utilize records functionality, such as user filters and export. For other cases, you can use a query, such as a\!queryEntity(), a Data Subset, a list of Dictionary, or an array of data. When necessary, specify pagingInfo as fv\!pagingInfo to have the grid automatically manage paging. When using a query that returns a datasubset, you must specify fetchTotalCount as true.
systemrules.gridfield.parameter.disablerowselectionwhen=Determines for each row if selection is disabled. The condition defined in this parameter is evaluated once for each row. Reference fields from the source using dot notation, such as fv\!row.status, or the identifier of the row using fv\!identifier. Grids that use record data must use the recordType\! domain to reference a record field or related record field. For example, fv\!row[recordType\!Case.fields.caseName]. Default\: false.
systemrules.gridfield.parameter.emptygridmessage=Text to display in the grid when no data is available. Default is "No items available".
systemrules.gridfield.parameter.height=Determines the height of the grid. Valid values\: "SHORT", "SHORT_PLUS", "MEDIUM", "MEDIUM_PLUS", "TALL", "TALL_PLUS", "EXTRA_TALL", "AUTO" (default). The header is frozen for all values except AUTO.
systemrules.gridfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.gridfield.parameter.initialsorts=Sorts applied to the grid upon initial load only. The first sort in this list will be displayed to the user as an arrow in the header of the corresponding grid column (if applicable).
systemrules.gridfield.parameter.instructions=Supplemental text about this grid.
systemrules.gridfield.parameter.label=Text to display as the grid label.
systemrules.gridfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.gridfield.parameter.maxselections=The maximum number of items the user can select. When the user selects the maximum number of items, row selection is disabled.
systemrules.gridfield.parameter.openactionsin=Determines how record actions should open to the user. Valid values\: "DIALOG" (default), "NEW_TAB", "SAME_TAB".
systemrules.gridfield.parameter.pagesize=The maximum number of rows to display in the grid. Default\: 10
systemrules.gridfield.parameter.pagingsaveinto=One or more variables that are updated only when user invokes a paging action on the grid. You can reference the current paging of the grid using fv\!pagingInfo.
systemrules.gridfield.parameter.recordactions=List of record action items to display above the grid, configured using a\!recordActionItem(). If you use fv\!identifier in the identifier parameter of a\!recordActionItem(), you will also need to configure selection for the grid. This parameter only applies when a record type is used as the source in the data parameter.
systemrules.gridfield.parameter.refreshafter=Refreshes grid data each time a specified event completes. Valid values\: "RECORD_ACTION".
systemrules.gridfield.parameter.refreshalways=When true, grid data will be refreshed after each user interaction and each interval refresh. Default\: false.
systemrules.gridfield.parameter.refreshinterval=How often grid data gets refreshed in minutes. When null, grid data will not be refreshed on an interval. Valid values\: 0.5, 1, 2, 3, 4, 5, 10, 30, 60.
systemrules.gridfield.parameter.refreshonreferencedvarchange=When true, grid data will be refreshed each time the value of any variable referenced in the data parameter is updated. To refresh grid data when another variable that is not used within the grid configuration, use refreshOnVarChange. Default\: true.
systemrules.gridfield.parameter.refreshonvarchange=Refreshes the grid data each time any of these specific variables change. This allows you to refresh the grid data when a variable that is not referenced in the grid configuration is updated. You can define either using a single variable (e.g. refreshOnVarChange\: local\!var1) or a list of variables (e.g. refreshOnVarChange\: {local\!var1, local\!var2}).
systemrules.gridfield.parameter.rowheader=Index of the column to be used as the row header. Screen readers will announce the value in each row header when navigating to other cells within that row. Used only for accessibility; produces no visible change.
systemrules.gridfield.parameter.secondarysorts=Sorts applied to the data in the grid after every user sort interaction. No sorts in this list will be displayed to the user as an arrow in the header of a grid column. If your data is a reference to a record type sourced from processes, this parameter is not supported.
systemrules.gridfield.parameter.selectable=Determines if grid rows are selectable. When selection style is "CHECKBOX" (default), the selection column is displayed. Default\: false.
systemrules.gridfield.parameter.selectionrequired=Determines if a selection is required to submit the form. Default\: false.
systemrules.gridfield.parameter.selectionrequiredmessage=Custom message to display when a selection is required and not provided.
systemrules.gridfield.parameter.selectionsaveinto=One or more variables that are updated with the selected identifiers when the user changes selections. Use a\!save() to save a modified or alternative value to a variable. You can reference the rows selected and deselected in the most recent user interaction (not all selected or deselected rows) using fv\!selectedRows and fv\!deselectedRows respectively.
systemrules.gridfield.parameter.selectionstyle=Determines the style when a row is selected. Valid values\: "CHECKBOX" (default), "ROW_HIGHLIGHT".
systemrules.gridfield.parameter.selectionvalue=Identifiers of the rows that should appear as selected. Can be set to have rows be pre-selected for the user. Supported types\: Text Array and Integer Array.
systemrules.gridfield.parameter.shadealternaterows=Determines whether alternate rows are shaded. Default\: true.
systemrules.gridfield.parameter.showexportbutton=Determines if grid data can be exported. This parameter only applies when a record type is used as the source in the data parameter. Default\: false.
systemrules.gridfield.parameter.showrefreshbutton=Determines if the grid should include a refresh button to manually refresh data. This parameter only applies when a record type is used as the source in the data parameter. Default\: true.
systemrules.gridfield.parameter.showsearchbox=Determines if the record search box should be shown. This parameter only applies when a record type is used as the source in the data parameter. Default\: true.
systemrules.gridfield.parameter.showselectioncount=Determines when the number of selected items displays below the grid. Valid values\: "AUTO" (default), "ON", "OFF". "AUTO" displays the selection count if the value of the maxSelections parameter is greater than 1.
systemrules.gridfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.gridfield.parameter.spacing=Determines the spacing within grid cells. Valid values\: "STANDARD" (web default), "DENSE" (mobile default).
systemrules.gridfield.parameter.userfilters=List of user filter references to display, configured using the recordType\! domain. For example, recordType\!Case.filters.status. You may only reference user filters defined on the source record type used for the grid data. This parameter only applies when a record type is used as the source in the data parameter.
systemrules.gridfield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed.
systemrules.gridfield.parameter.validations=Validation errors to display below the grid when the data is invalid, configured using a\!validationMessage(). You can reference the current page of data using fv\!currentPage.
systemrules.gridfield_19r1.description=This is an older version of the a\!gridField() function. You can continue to use this version of the function by its new name\: a\!gridField_19r1(). The new version of a\!gridField() has new functionality. Displays read-only text, links, and images in a grid that supports selecting, sorting, and paging.
systemrules.gridfield_19r1.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.gridfield_19r1.parameter.borderstyle=Determines the style of the grid border. Valid values\: "STANDARD" (default), "LIGHT".
systemrules.gridfield_19r1.parameter.columns=Array of Grid Columns to display. Columns can be created with a\!gridTextColumn() or a\!gridImageColumn().
systemrules.gridfield_19r1.parameter.disabled=Determines if the user is prevented from changing which rows are selected. Default\: false.
systemrules.gridfield_19r1.parameter.emptygridmessage=Text to display in the grid when no data is available. Default is "No items available".
systemrules.gridfield_19r1.parameter.height=Determines the height of the grid. Valid values\: "SHORT", "MEDIUM", "TALL", "AUTO" (default). When set to SHORT, MEDIUM, or TALL, the header is frozen.
systemrules.gridfield_19r1.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.gridfield_19r1.parameter.identifiers=Array of Texts or Integers that uniquely identify rows for selection.
systemrules.gridfield_19r1.parameter.instructions=Supplemental text about this field.
systemrules.gridfield_19r1.parameter.label=Text to display as the field label.
systemrules.gridfield_19r1.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.gridfield_19r1.parameter.requiredmessage=Custom message to display when selection is required and no selection is made.
systemrules.gridfield_19r1.parameter.requireselection=Determines if a selection is required to submit the form. Default\: false.
systemrules.gridfield_19r1.parameter.rowheader=Index of the column to be used as the row header. Screen readers will announce the value in each row header when navigating to other cells within that row. Used only for accessibility; produces no visible change.
systemrules.gridfield_19r1.parameter.saveinto=One or more variables that are updated with the paging or grid selection configuration when the user pages, sorts, or changes the grid\u2019s selections. Use a\!save() to save a modified or alternative value to a variable.
systemrules.gridfield_19r1.parameter.selection=Determines if the selection column is displayed. Default\: false.
systemrules.gridfield_19r1.parameter.selectionstyle=Determines the style when a row is selected. Valid values\: "CHECKBOX" (default), "ROW_HIGHLIGHT".
systemrules.gridfield_19r1.parameter.shadealternaterows=Determines whether alternate rows are shaded. Default\: true.
systemrules.gridfield_19r1.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.gridfield_19r1.parameter.spacing=Determines the spacing within grid cells. Valid values\: "STANDARD" (web default), "DENSE" (mobile default).
systemrules.gridfield_19r1.parameter.totalcount=Number of rows of data for all pages in the grid.
systemrules.gridfield_19r1.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.gridfield_19r1.parameter.validations=Validation errors to display below the field.
systemrules.gridfield_19r1.parameter.value=Determines the grid\u2019s paging and (if applicable) selection state. The value can be created with a\!pagingInfo() or a\!gridSelection().
systemrules.gridfield_23r3.description=This is an older version of the a\!gridField() function. You can continue to use this version of the function by its new name\: a\!gridField_23r3(). The new version of a\!gridField() has new functionality. Read-only grids that use a record type as the source will only query the record fields specified in the "columns", "pagingSaveInto", and "selectionSaveInto" parameters. This allows for more optimal grid performance. Additionally, if your grid includes dynamic behavior, you can configure the "fields" parameter in a\!recordData() to specify when to query fields in the grid.
systemrules.gridfield_23r3.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.gridfield_23r3.parameter.actionsdisplay=Determines which details are shown for record actions, regardless of style. Valid values\: "LABEL_AND_ICON" (default), "LABEL", "ICON".
systemrules.gridfield_23r3.parameter.actionsstyle=Determines how the list of actions should be displayed above the grid. Valid values\: "TOOLBAR" (default), "TOOLBAR_PRIMARY". See the [documentation](links.docs.systemrules.gridfield.doc) for guidance on how to use different styles effectively.
systemrules.gridfield_23r3.parameter.borderstyle=Determines the style of the grid border. Valid values\: "STANDARD" (default), "LIGHT".
systemrules.gridfield_23r3.parameter.columns=Array of Grid Columns to display. Columns can be created with a\!gridTextColumn() or a\!gridImageColumn().
systemrules.gridfield_23r3.parameter.data=The data to display in the grid. Use a record type reference or a\!recordData() to source your data from records and utilize records functionality, such as user filters and export. For other cases, you can use a query, such as a\!queryEntity(), a Data Subset, a list of Dictionary, or an array of data. When necessary, specify pagingInfo as fv\!pagingInfo to have the grid automatically manage paging. When using a query that returns a datasubset, you must specify fetchTotalCount as true.
systemrules.gridfield_23r3.parameter.disabled=Determines if the user is prevented from changing which rows are selected. Default\: false.
systemrules.gridfield_23r3.parameter.disablerowselectionwhen=Determines for each row if selection is disabled. The condition defined in this parameter is evaluated once for each row. Reference fields from the source using dot notation, such as fv\!row.status, or the identifier of the row using fv\!identifier. Grids that use record data must use the recordType\! domain to reference a record field or related record field. For example, fv\!row[recordType\!Case.fields.caseName]. Default\: false.
systemrules.gridfield_23r3.parameter.emptygridmessage=Text to display in the grid when no data is available. Default is "No items available".
systemrules.gridfield_23r3.parameter.height=Determines the height of the grid. Valid values\: "SHORT", "MEDIUM", "TALL", "AUTO" (default). When set to SHORT, MEDIUM, or TALL, the header is frozen.
systemrules.gridfield_23r3.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.gridfield_23r3.parameter.identifiers=Array of Texts or Integers that uniquely identify rows for selection.
systemrules.gridfield_23r3.parameter.initialsorts=Sorts applied to the grid upon initial load only. The first sort in this list will be displayed to the user as an arrow in the header of the corresponding grid column (if applicable).
systemrules.gridfield_23r3.parameter.instructions=Supplemental text about this field.
systemrules.gridfield_23r3.parameter.label=Text to display as the field label.
systemrules.gridfield_23r3.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.gridfield_23r3.parameter.maxselections=The maximum number of items the user can select. When the user selects the maximum number of items, row selection is disabled.
systemrules.gridfield_23r3.parameter.openactionsin=Determines how record actions should open to the user. Valid values\: "DIALOG" (default), "NEW_TAB", "SAME_TAB".
systemrules.gridfield_23r3.parameter.pagesize=The maximum number of rows to display in the grid. Default\: 10
systemrules.gridfield_23r3.parameter.pagingsaveinto=One or more variables that are updated only when user invokes a paging action on the grid. You can reference the current paging of the grid using fv\!pagingInfo.
systemrules.gridfield_23r3.parameter.recordactions=List of record action items to display above the grid, configured using a\!recordActionItem(). If you use fv\!identifier in the identifier parameter of a\!recordActionItem(), you will also need to configure selection for the grid. This parameter only applies when a record type is used as the source in the data parameter.
systemrules.gridfield_23r3.parameter.refreshafter=Refreshes grid data each time a specified event completes. Valid values\: "RECORD_ACTION".
systemrules.gridfield_23r3.parameter.refreshalways=When true, grid data will be refreshed after each user interaction and each interval refresh. Default\: false.
systemrules.gridfield_23r3.parameter.refreshinterval=How often grid data gets refreshed in minutes. When null, grid data will not be refreshed on an interval. Valid values\: 0.5, 1, 2, 3, 4, 5, 10, 30, 60.
systemrules.gridfield_23r3.parameter.refreshonreferencedvarchange=When true, grid data will be refreshed each time the value of any variable referenced in the data parameter is updated. To refresh grid data when another variable that is not used within the grid configuration, use refreshOnVarChange. Default\: true.
systemrules.gridfield_23r3.parameter.refreshonvarchange=Refreshes the grid data each time any of these specific variables change. This allows you to refresh the grid data when a variable that is not referenced in the grid configuration is updated. You can define either using a single variable (e.g. refreshOnVarChange\: local\!var1) or a list of variables (e.g. refreshOnVarChange\: {local\!var1, local\!var2}).
systemrules.gridfield_23r3.parameter.requiredmessage=Custom message to display when selection is required and no selection is made.
systemrules.gridfield_23r3.parameter.requireselection=Determines if a selection is required to submit the form. Default\: false.
systemrules.gridfield_23r3.parameter.rowheader=Index of the column to be used as the row header. Screen readers will announce the value in each row header when navigating to other cells within that row. Used only for accessibility; produces no visible change.
systemrules.gridfield_23r3.parameter.saveinto=One or more variables that are updated with the paging or grid selection configuration when the user pages, sorts, or changes the grid\u2019s selections. Use a\!save() to save a modified or alternative value to a variable.
systemrules.gridfield_23r3.parameter.secondarysorts=Sorts applied to the data in the grid after every user sort interaction. No sorts in this list will be displayed to the user as an arrow in the header of a grid column. If your data is a reference to a record type sourced from processes, this parameter is not supported.
systemrules.gridfield_23r3.parameter.selectable=Determines if grid rows are selectable. When selection style is "CHECKBOX" (default), the selection column is displayed. Default\: false.
systemrules.gridfield_23r3.parameter.selection=Determines if the selection column is displayed. Default\: false.
systemrules.gridfield_23r3.parameter.selectionrequired=Determines if a selection is required to submit the form. Default\: false.
systemrules.gridfield_23r3.parameter.selectionrequiredmessage=Custom message to display when a selection is required and not provided.
systemrules.gridfield_23r3.parameter.selectionsaveinto=One or more variables that are updated with the selected identifiers when the user changes selections. Use a\!save() to save a modified or alternative value to a variable. You can reference the rows selected and deselected in the most recent user interaction (not all selected or deselected rows) using fv\!selectedRows and fv\!deselectedRows respectively.
systemrules.gridfield_23r3.parameter.selectionstyle=Determines the style when a row is selected. Valid values\: "CHECKBOX" (default), "ROW_HIGHLIGHT".
systemrules.gridfield_23r3.parameter.selectionvalue=Identifiers of the rows that should appear as selected. Can be set to have rows be pre-selected for the user. Supported types\: Text Array and Integer Array.
systemrules.gridfield_23r3.parameter.shadealternaterows=Determines whether alternate rows are shaded. Default\: true.
systemrules.gridfield_23r3.parameter.showexportbutton=Determines if grid data can be exported. This parameter only applies when a record type is used as the source in the data parameter. Default\: false.
systemrules.gridfield_23r3.parameter.showrefreshbutton=Determines if the grid should include a refresh button to manually refresh data. This parameter only applies when a record type is used as the source in the data parameter. Default\: true.
systemrules.gridfield_23r3.parameter.showsearchbox=Determines if the record search box should be shown. This parameter only applies when a record type is used as the source in the data parameter. Default\: true.
systemrules.gridfield_23r3.parameter.showselectioncount=Determines when the number of selected items displays below the grid. Valid values\: "AUTO" (default), "ON", "OFF". "AUTO" displays the selection count if the value of the maxSelections parameter is greater than 1.
systemrules.gridfield_23r3.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.gridfield_23r3.parameter.spacing=Determines the spacing within grid cells. Valid values\: "STANDARD" (web default), "DENSE" (mobile default).
systemrules.gridfield_23r3.parameter.totalcount=Number of rows of data for all pages in the grid.
systemrules.gridfield_23r3.parameter.userfilters=List of user filter references to display, configured using the recordType\! domain. For example, recordType\!Case.filters.status. You may only reference user filters defined on the source record type used for the grid data. This parameter only applies when a record type is used as the source in the data parameter.
systemrules.gridfield_23r3.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.gridfield_23r3.parameter.validations=Validation errors to display below the field.
systemrules.gridfield_23r3.parameter.value=Determines the grid\u2019s paging and (if applicable) selection state. The value can be created with a\!pagingInfo() or a\!gridSelection().
systemrules.gridimagecolumn.description=NOTE\: This is a deprecated function for use in an older version of the a\!gridField() function. You can continue to use this function in the older version of the a\!gridField() function by its new name\: a\!gridField_19r1(). The new version of a\!gridField() uses a\!gridColumn() instead.
systemrules.gridimagecolumn.parameter.data=Array of images to display, created with a\!documentImage(), a\!userImage(), or a\!webImage().
systemrules.gridimagecolumn.parameter.field=Name of the data field associated with the column for use in sorting.
systemrules.gridimagecolumn.parameter.isthumbnail=Determines whether the images can be viewed at a larger size when clicked. Multiple images will be visible in a slideshow. Default\: false.
systemrules.gridimagecolumn.parameter.label=Text to display as the column header.
systemrules.gridimagecolumn.parameter.showwhen=Determines whether the column is displayed in the grid. When set to false, the column is hidden and is not evaluated. Default\: true.
systemrules.gridimagecolumn.parameter.size=Determines how the images are sized. Valid values\: "ICON" (default), "GALLERY", "TINY", "SMALL", "MEDIUM", "LARGE".
systemrules.gridimagecolumn.parameter.style=Determines how the images are rendered. Valid values\: "STANDARD" (default), "AVATAR".
systemrules.gridimagecolumn_17r3.description=NOTE\: This is an older version of the a\!gridImageColumn function for use in an older version of the a\!gridField() function. You can continue to use this version of the function in the a\!gridField_19r1() function by its new name\: a\!gridImageColumn_17r3. The new version of a\!gridField() uses a\!gridColumn() instead.
systemrules.gridimagecolumn_17r3.parameter.data=Array of images to display, created with a\!documentImage() or a\!webImage().
systemrules.gridimagecolumn_17r3.parameter.field=Name of the data field associated with the column for use in sorting.
systemrules.gridimagecolumn_17r3.parameter.label=Text to display as the column header.
systemrules.gridimagecolumn_17r3.parameter.showwhen=Determines whether the column is displayed in the grid. When set to false, the column is hidden and is not evaluated. Default\: true.
systemrules.gridimagecolumn_17r3.parameter.size=Determines how the images are sized. Valid values\: "THUMBNAIL" (default), "ICON".
systemrules.gridlayout.description=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](links.docs.systemrules.gridlayout.recipe).
systemrules.gridlayout.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.gridlayout.parameter.addrowlink=Link for adding a row to the grid. Create link using a\!dynamicLink().
systemrules.gridlayout.parameter.allowrowreordering=Determines if grid rows can be reordered by dragging and dropping. Default\: false.
systemrules.gridlayout.parameter.borderstyle=Determines the style of the grid border. Valid values\: "STANDARD" (default), "LIGHT".
systemrules.gridlayout.parameter.columnconfigs=Array of column configurations created with a\!gridLayoutColumnConfig().
systemrules.gridlayout.parameter.emptygridmessage=Text to display in the grid when no data is available. Default is "No items available".
systemrules.gridlayout.parameter.headercells=Array of column headers created with a\!gridLayoutHeaderCell().
systemrules.gridlayout.parameter.height=Determines the height of the grid. Valid values\: "SHORT", "SHORT_PLUS", "MEDIUM", "MEDIUM_PLUS", "TALL", "TALL_PLUS", "EXTRA_TALL", "AUTO" (default). The header is frozen for all values except AUTO.
systemrules.gridlayout.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.gridlayout.parameter.instructions=Supplemental text about this grid.
systemrules.gridlayout.parameter.label=Text to display as the grid label.
systemrules.gridlayout.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.gridlayout.parameter.rowheader=Index of the column to be used as the row header. Screen readers will announce the value in each row header when navigating to other cells within that row. Used only for accessibility; produces no visible change.
systemrules.gridlayout.parameter.roworderdata=The list of data that is updated when the user drops the row in a different position. For example, "local\!data" or "ri\!data".
systemrules.gridlayout.parameter.roworderfield=Field containing the row\u2019s order value (for example "order" or recordType\!Task.field.order) When a row is moved, its index is saved to this field.
systemrules.gridlayout.parameter.rowordertooltip=Determines if a tooltip is shown in the header of the drag-and-drop column. Default\: true.
systemrules.gridlayout.parameter.rows=Array of grid rows created with a\!gridRowLayout().
systemrules.gridlayout.parameter.selectable=Determines if the selection column is displayed. Default\: false.
systemrules.gridlayout.parameter.selectiondisabled=Determines if selection is disabled on all rows. Default\: false.
systemrules.gridlayout.parameter.selectionrequired=Determines if a selection is required to submit the form. Default\: false.
systemrules.gridlayout.parameter.selectionsaveinto=One or more variables that are updated with the selected identifiers when the user changes selections. Use a\!save() to save a modified or alternative value to a variable.
systemrules.gridlayout.parameter.selectionstyle=Determines the style when a row is selected. Valid values\: "CHECKBOX" (default), "ROW_HIGHLIGHT".
systemrules.gridlayout.parameter.selectionvalue=Identifiers of selected rows.
systemrules.gridlayout.parameter.shadealternaterows=Determines whether alternate rows are shaded. Default\: true.
systemrules.gridlayout.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.gridlayout.parameter.spacing=Determines the spacing within grid cells. Valid values\: "STANDARD" (web default), "DENSE" (mobile default).
systemrules.gridlayout.parameter.totalcount=Number of rows of data displayed in the grid.
systemrules.gridlayout.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.gridlayout.parameter.validations=Validation errors to display below the grid.
systemrules.gridlayoutcolumnconfig.description=Defines a column configuration for use in an editable grid (a\!gridLayout).
systemrules.gridlayoutcolumnconfig.parameter.showwhen=Determines whether the column configuration is displayed in the grid. When set to false, the column configuration is hidden and is not evaluated. Default\: true.
systemrules.gridlayoutcolumnconfig.parameter.weight=Determines how wide distributed columns are in relation to each other. Valid values\: integers from 1 (default) to 10.
systemrules.gridlayoutcolumnconfig.parameter.width=Determines the column width. Valid values\: "DISTRIBUTE" (default), "ICON", "ICON_PLUS", "NARROW", "NARROW_PLUS", "MEDIUM", "MEDIUM_PLUS", "WIDE".
systemrules.gridlayoutheadercell.description=Defines a column header for use in an editable grid (a\!gridLayout).
systemrules.gridlayoutheadercell.parameter.align=Determines the header label\u2019s alignment. Valid values\: "LEFT", "CENTER", "RIGHT".
systemrules.gridlayoutheadercell.parameter.helptooltip=Displays a help icon with the specified text as a tooltip.
systemrules.gridlayoutheadercell.parameter.label=Text to display as the column header.
systemrules.gridlayoutheadercell.parameter.showwhen=Determines whether the header cell is displayed in the grid. When set to false, the header cell is hidden and is not evaluated. Default\: true.
systemrules.gridlinkcolumn.description=WARNING\: This function is deprecated and may be removed in a future release. Instead, use the "links" parameter on a\!gridTextColumn() instead.
systemrules.gridlinkcolumn.parameter.alignment=Determines the alignment of the link. Valid values\: "LEFT", "CENTER", "RIGHT".
systemrules.gridlinkcolumn.parameter.data=Array of links to display in the column. Create links with a\!documentDownloadLink(), a\!dynamicLink(), a\!newsEntryLink(), a\!processTaskLink(), a\!recordLink(), a\!safeLink(), a\!submitLink(), a\!userRecordLink(), or a\!authorizationLink().
systemrules.gridlinkcolumn.parameter.field=Name of the data field associated with the column for use in sorting.
systemrules.gridlinkcolumn.parameter.label=Text to display as the column header.
systemrules.gridrowlayout.description=Displays a row of components within an editable grid (a\!gridLayout).
systemrules.gridrowlayout.parameter.contents=Array of components to display in the grid cell. Supported components\: Barcode, Buttons, Checkboxes, Date, Date & Time, Dropdown, Decimal, Encrypted Text, File Upload, Image, Integer, Link, Multiple Dropdown, Paragraph, Pickers, Progress Bar, Radio Buttons, Record Action Field, Rich Text, Tags, and Text.
systemrules.gridrowlayout.parameter.id=Value that uniquely identifies this row for selection.
systemrules.gridrowlayout.parameter.selectiondisabled=When selection is enabled, determines if the selection checkbox is disabled for this row. Default\: false.
systemrules.gridrowlayout.parameter.showwhen=Determines whether the row is displayed in the grid. When set to false, the row is hidden and is not evaluated. Default\: true.
systemrules.gridselection.description=NOTE\: This is a deprecated function for use in an older version of the a\!gridField() function. You can continue to use this function in the older version of the a\!gridField() function by its new name\: a\!gridField_19r1(). The new version of a\!gridField() has new paging and selection capabilities.
systemrules.gridselection.parameter.paginginfo=Paging and sorting configuration created with a\!pagingInfo().
systemrules.gridselection.parameter.selected=Array of selected identifiers. Supported types\: Text Array and Integer Array.
systemrules.gridtextcolumn.description=NOTE\: This is a deprecated function for use in an older version of the a\!gridField() function. You can continue to use this function in the older version of the a\!gridField() function by its new name\: a\!gridField_19r1(). The new version of a\!gridField() uses a\!gridColumn() instead.
systemrules.gridtextcolumn.parameter.alignment=Determines the alignment of the column header and data. Valid values\: "LEFT", "CENTER", "RIGHT".
systemrules.gridtextcolumn.parameter.data=Array of text values to display in the column.
systemrules.gridtextcolumn.parameter.field=Name of the data field associated with the column for use in sorting.
systemrules.gridtextcolumn.parameter.label=Text to display as the column header.
systemrules.gridtextcolumn.parameter.links=Array of links to apply to the data. Create links with a\!documentDownloadLink(), a\!dynamicLink(), a\!newsEntryLink(), a\!processTaskLink(), a\!recordLink(), a\!reportLink(), a\!safeLink(), a\!startProcessLink(), a\!submitLink(), a\!userRecordLink(), or a\!authorizationLink().
systemrules.gridtextcolumn.parameter.showwhen=Determines whether the column is displayed in the grid. When set to false, the column is hidden and is not evaluated. Default\: true.
systemrules.groupbrowserfieldcolumns.description=Displays group membership structure in columns. Users can navigate through the structure and select a single group. See [documentation](links.docs.systemrules.groupbrowserfieldcolumns.doc) for more details.
systemrules.groupbrowserfieldcolumns.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.groupbrowserfieldcolumns.parameter.height=Determines the height of the component. Valid values\: "SHORT", "MEDIUM" (default), "TALL".
systemrules.groupbrowserfieldcolumns.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.groupbrowserfieldcolumns.parameter.hideusers=Determines whether users will be displayed. Default\: false.
systemrules.groupbrowserfieldcolumns.parameter.instructions=Supplemental text about this field.
systemrules.groupbrowserfieldcolumns.parameter.label=Text to display as the field label.
systemrules.groupbrowserfieldcolumns.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.groupbrowserfieldcolumns.parameter.pathsaveinto=Variable or list of variables to update when a user clicks on a group.
systemrules.groupbrowserfieldcolumns.parameter.pathvalue=The path from the first column to the current navigation.
systemrules.groupbrowserfieldcolumns.parameter.readonly=Determines whether selection is enabled. Default\: false.
systemrules.groupbrowserfieldcolumns.parameter.rootgroup=The direct members of the initial group are displayed in the first column.
systemrules.groupbrowserfieldcolumns.parameter.selectionsaveinto=Variable or list of variables to update upon selection of a group.
systemrules.groupbrowserfieldcolumns.parameter.selectionvalue=This group is displayed as selected when it is present in the navigation path array.
systemrules.groupbrowserfieldcolumns.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.grouping.description=Determines fields to group by in a query or chart that uses records. The grouping should incorporate a record field or related record field, an alias, and an optional interval to group by a date. When used with a\!aggregationFields(), at least one measure or at least one grouping is required.
systemrules.grouping.parameter.alias=The short name by which the result of the grouping field can be referenced in other places of the chart or query configuration. Values are case-sensitive.
systemrules.grouping.parameter.field=The record field or related record field to group by. Use the recordType\! domain to reference the field. For example, recordType\!Case.fields.status.
systemrules.grouping.parameter.formatvalue=Display value for the given grouping value. Only applies when the grouping is used in a chart. This parameter is evaluated once for each value returned. You can reference the unformatted result from the data source using fv\!value. This display value does not affect the values used in calculations for the chart; it is only used for display.
systemrules.grouping.parameter.interval=The date or time interval to group by. This parameter can only be used when the field is of type Date, Date and Time, or Time. Valid values\: "AUTO" (default), "YEAR", "MONTH_OF_YEAR", "MONTH_OF_YEAR_SHORT_TEXT", "MONTH_OF_YEAR_TEXT", "MONTH_TEXT", "MONTH_SHORT_TEXT", "MONTH_DATE", "DATE", "DATE_SHORT_TEXT", "DATE_TEXT", "DAY_OF_MONTH", "HOUR_OF_DAY", "HOUR", "MINUTE_OF_HOUR", "MINUTE".
systemrules.headercontentlayout.description=Displays any arrangement of layouts and components beneath a card or billboard flush with the edge of the page. Use this as the top-level layout for landing pages and reports. See [documentation](links.docs.systemrules.headercontentlayout.doc) for more details.
systemrules.headercontentlayout.parameter.backgroundcolor=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". See [documentation](links.docs.sd.colorScheme.learnMore) for more information about how to use color schemes.
systemrules.headercontentlayout.parameter.contents=Components and layouts to display in the body of the interface.
systemrules.headercontentlayout.parameter.contentspadding=Determines the space surrounding the contents. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.headercontentlayout.parameter.header=Billboard, card, or list of billboards or cards to display at the top of the page. Configure using a\!billboardLayout() or a\!cardLayout().
systemrules.headercontentlayout.parameter.isheaderfixed=Determines whether the header remains at the top of the page when scrolling. Default\: false.
systemrules.headercontentlayout.parameter.showwhen=Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default\: true.
systemrules.hierarchybrowserfieldcolumns.description=Displays hierarchical data in the form of drillable columns. See the [documentation](links.docs.systemrules.hierarchyBrowserFieldColumns.doc) for a detailed explanation of how the hierarchy browser works and how to configure it.
systemrules.hierarchybrowserfieldcolumns.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.hierarchybrowserfieldcolumns.parameter.firstcolumnvalues=Values in the first column. For example, a\!queryEntity(...).data or rule\!CRM_getAllCustomers().
systemrules.hierarchybrowserfieldcolumns.parameter.height=Determines the height of the component.Valid values\: "SHORT", "MEDIUM" (default), "TALL".
systemrules.hierarchybrowserfieldcolumns.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.hierarchybrowserfieldcolumns.parameter.instructions=Supplemental text about this field.
systemrules.hierarchybrowserfieldcolumns.parameter.label=Text to display as the field label.
systemrules.hierarchybrowserfieldcolumns.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.hierarchybrowserfieldcolumns.parameter.nextcolumnvalues=Given a node value, describe how to get the next column\u2019s values using the variable fv\!nodeValue. For example, rule\!CRM_getTicketsForCustomer(customer\: fv\!nodeValue, isActive\: true). This rule or expression is evaluated for each value in pathValue where fv\!nodeValue refers any value in pathValue.
systemrules.hierarchybrowserfieldcolumns.parameter.nodeconfigs=Describe how to display a value as a node using a\!hierarchyBrowserFieldColumnsNode() and fv\!nodeValue. This rule or expression is evaluated for each value where fv\!nodeValue is any node value.
systemrules.hierarchybrowserfieldcolumns.parameter.pathsaveinto=Variable or list of variables to update when a user clicks on a drillable or selectable node, as determined by the node configurations. For example, local\!path. Use a\!save() to save a modified or alternative value to a variable.
systemrules.hierarchybrowserfieldcolumns.parameter.pathvalue=As the user clicks through the browser, clicked nodes become highlighted. These clicked nodes\u2019 values are in the pathValue. They should be stored in a variable, for example local\!path. The clicked node\u2019s value is used to determine the next column, generated by nextColumnValues.
systemrules.hierarchybrowserfieldcolumns.parameter.selectionsaveinto=Variable or list of variables to update when a user clicks on a selectable node, as determined by the node configurations. Use a\!save() to save a modified or alternative value to a variable.
systemrules.hierarchybrowserfieldcolumns.parameter.selectionvalue=Value of the currently selected node. The selection will be indicated by a unique display if present in the navigation path.
systemrules.hierarchybrowserfieldcolumns.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.hierarchybrowserfieldcolumnsnode.description=Returns a Hierarchy Column Node.
systemrules.hierarchybrowserfieldcolumnsnode.parameter.id=Required unique identifier of the node. This value only needs to be unique within the node\u2019s column.
systemrules.hierarchybrowserfieldcolumnsnode.parameter.image=Required image to display on the left side of the node\u2019s cell, created with a\!documentImage(), a\!userImage(), or a\!webImage().
systemrules.hierarchybrowserfieldcolumnsnode.parameter.isdrillable=If true, clicking the node will drill into it, saving the columns browser\u2019s navigation path and revealing another column to the user. If false, clicking the node will not reveal another column. It may still save the navigation path if the node is selectable. On hover, a drillable node will have a unique display. (default\: true).
systemrules.hierarchybrowserfieldcolumnsnode.parameter.isselectable=If true, clicking the node will select it, saving the columns browser\u2019s selection value and navigation path. If false, clicking the node will not save the selection value. It may still save the navigation path if the node is drillable. On hover, a selectable node will have a unique display. (default\: true).
systemrules.hierarchybrowserfieldcolumnsnode.parameter.label=Required text to display in the node.
systemrules.hierarchybrowserfieldcolumnsnode.parameter.link=Optional link that determines behavior when a node\u2019s label title is clicked. Create links with a\!documentDownloadLink(), a\!dynamicLink(), a\!newsEntryLink(), a\!processTaskLink(), a\!recordLink(), a\!reportLink(), a\!safeLink(), a\!startProcessLink(), a\!userRecordLink(), or a\!authorizationLink().
systemrules.hierarchybrowserfieldcolumnsnode.parameter.nextcolumncount=Optional count of nodes that would be displayed in the next column were this node in the navigation path. This value is displayed on mobile only.
systemrules.hierarchybrowserfieldcolumnsnode.parameter.showwhen=Determines whether the node is displayed in the component. When set to false, the node is hidden and is not evaluated. Default\: true.
systemrules.hierarchybrowserfieldtree.description=Displays hierarchical data in the form of drillable tree. See the [documentation](links.docs.systemrules.hierarchybrowserfieldtree.doc) for a detailed explanation of how the hierarchy browser works and how to configure it.
systemrules.hierarchybrowserfieldtree.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.hierarchybrowserfieldtree.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.hierarchybrowserfieldtree.parameter.instructions=Supplemental text about this field.
systemrules.hierarchybrowserfieldtree.parameter.label=Text to display as the field label.
systemrules.hierarchybrowserfieldtree.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.hierarchybrowserfieldtree.parameter.nextlevelvalues=Given a node value, describe how to get the next level\u2019s values using the variable fv\!nodeValue. For example, rule\!CRM_getCustomerUsersBySupervisor(customer\: fv\!nodeValue, isActive\: true). This rule or expression is evaluated for each value in pathValue where fv\!nodeValue refers any value in pathValue.
systemrules.hierarchybrowserfieldtree.parameter.nodeconfigs=Describe how to display a value as a node using a\!hierarchyBrowserFieldTreeNode() and fv\!nodeValue. This rule or expression is evaluated for each value where fv\!nodeValue is any node value.
systemrules.hierarchybrowserfieldtree.parameter.pathsaveinto=Variable or list of variables to update when a user clicks on a drillable node, as determined by the node configurations. For example, local\!path. Use a\!save() to save a modified or alternative value to a variable.
systemrules.hierarchybrowserfieldtree.parameter.pathvalue=The first value in the pathValue array appears in the uppermost level of the tree and is the root of the visible hierarchy. As the user clicks through the browser, clicked nodes become highlighted. These clicked nodes\u2019 values are in the pathValue. They should be stored in a variable, for example local\!path. A clicked node\u2019s value is used to determine the next level, generated by nextLevelValues. The pathValue must have a default value.
systemrules.hierarchybrowserfieldtree.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.hierarchybrowserfieldtreenode.description=Returns a Hierarchy Tree Node.
systemrules.hierarchybrowserfieldtreenode.parameter.description=Text to display below the node label.
systemrules.hierarchybrowserfieldtreenode.parameter.details=Text to display below the node description.
systemrules.hierarchybrowserfieldtreenode.parameter.id=Required unique identifier of the node. This value only needs to be unique within the node\u2019s level.
systemrules.hierarchybrowserfieldtreenode.parameter.image=Required image to display in the node, created with a\!documentImage(), a\!userImage(), or a\!webImage().
systemrules.hierarchybrowserfieldtreenode.parameter.isdrillable=If true, clicking the node will drill into it, saving the tree browser\u2019s navigation path and revealing another level to the user. If false, clicking the node will not reveal another level, but the navigation path will still be saved (default\: true).
systemrules.hierarchybrowserfieldtreenode.parameter.label=Required text to display as the title of the node.
systemrules.hierarchybrowserfieldtreenode.parameter.link=Optional link that determines behavior when a node\u2019s label title is clicked. Create links with a\!documentDownloadLink(), a\!newsEntryLink(), a\!processTaskLink(), a\!recordLink(), a\!reportLink(), a\!safeLink(), a\!startProcessLink(), a\!userRecordLink(), or a\!authorizationLink().
systemrules.hierarchybrowserfieldtreenode.parameter.nextlevelcount=Optional count of nodes that would be displayed in the next level were this node in the navigation path.
systemrules.hierarchybrowserfieldtreenode.parameter.showwhen=Determines whether the node is displayed in the component. When set to false, the node is hidden and is not evaluated. Default\: true.
systemrules.horizontalline.description=Displays a horizontal line
systemrules.horizontalline.parameter.color=Determines the horizontal line color. Valid values\: Any valid hex color or "SECONDARY" (default), "STANDARD", "ACCENT".
systemrules.horizontalline.parameter.marginabove=Determines how much space is added above the component. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.horizontalline.parameter.marginbelow=Determines how much space is added below the component. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.horizontalline.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.horizontalline.parameter.style=Determines how the component displays. Valid values\: "SOLID" (default), "DOT", "DASH".
systemrules.horizontalline.parameter.weight=Determines the horizontal line thickness. Valid values\: "THIN" (default), "MEDIUM", "THICK".
systemrules.httpauthenticationbasic.description=Creates an object that contains the information required to perform HTTP Basic authentication.
systemrules.httpauthenticationbasic.parameter.password=The password to use during the authentication. Created with a\!scsField().
systemrules.httpauthenticationbasic.parameter.preemptive=Determines whether or not authentication credentials are sent only after a 401 Not Authorized response or, when true, before the system has challenged. Default\: false.
systemrules.httpauthenticationbasic.parameter.username=The username to use during the authentication. Created with a\!scsField().
systemrules.httpformpart.description=Creates an HTTP form part which can be passed in an integration\u2019s multipart request body.
systemrules.httpformpart.parameter.contenttype=The form part content type. This field can be set to "auto-detect" to automatically detect the content type of a document value.
systemrules.httpformpart.parameter.name=The form part name.
systemrules.httpformpart.parameter.value=The form part value. If the value is a document, it can be streamed by setting the contentType to "auto-detect".
systemrules.httpheader.description=Creates an HTTP header object which can be passed to an HTTP function.
systemrules.httpheader.parameter.name=The header name.
systemrules.httpheader.parameter.value=The header value. Either Text or a\!scsField().
systemrules.httpquery.description=[Deprecated - use an Integration instead] Makes an HTTP request.
systemrules.httpquery.parameter.basicauthenticationcredentials=The credentials for the request. Built with a\!httpAuthenticationBasic().
systemrules.httpquery.parameter.headers=A list of headers you wish to send as part of the request. Built with a\!httpHeader().
systemrules.httpquery.parameter.method=The http method with which to call the url. Available options are "GET" (default), "HEAD", "OPTIONS", and "TRACE".
systemrules.httpquery.parameter.queryparameters=A list of query parameters you wish to add to the request. Built with a\!httpQueryParameter().
systemrules.httpquery.parameter.url=The URL for the request.
systemrules.httpqueryparameter.description=Creates an HTTP query parameter object which can be passed to an HTTP function.
systemrules.httpqueryparameter.parameter.name=The query parameter name.
systemrules.httpqueryparameter.parameter.value=The value of the query parameter. Either Text or a\!scsField().
systemrules.httpresponse.description=Creates a Web API Response.
systemrules.httpresponse.parameter.body=The body of the response. This value can be either text or a document. If a document is supplied, the document will be streamed as binary data to the caller, and default headers will be set.
systemrules.httpresponse.parameter.headers=A list of headers for the response. Built with a\!httpHeader(). Header values set using a\!scsField() will be ignored.
systemrules.httpresponse.parameter.statuscode=The status code of the response. Default is "200" meaning successful completion of the request.
systemrules.httpresponse_17r4.description=This is an older version of the a\!httpResponse function. You can continue to use this version of the function by its new name\: a\!httpResponse_17r4. The new version of a\!httpResponse has new functionality. Creates a Web API Response.
systemrules.httpresponse_17r4.parameter.body=The body of the response.
systemrules.httpresponse_17r4.parameter.headers=A list of headers for the response. Built with a\!httpHeader().
systemrules.httpresponse_17r4.parameter.statuscode=The status code of the response. Default is "200" meaning successful completion of the request.
systemrules.httpwrite.description=[Deprecated - use an Integration instead] Makes an HTTP request. This function returns a writer and must be used with the bind() function.
systemrules.httpwrite.parameter.basicauthenticationcredentials=The credentials for the request. Built with a\!httpAuthenticationBasic().
systemrules.httpwrite.parameter.body=The request body.
systemrules.httpwrite.parameter.headers=A list of headers you wish to send as part of the request. Built with a\!httpHeader().
systemrules.httpwrite.parameter.method=The http method with which to call the url.
systemrules.httpwrite.parameter.queryparameters=A list of query parameters you wish to add to the request. Built with a\!httpQueryParameter().
systemrules.httpwrite.parameter.url=The URL for the request.
systemrules.iconindicator.description=Returns a document image that corresponds to the given icon.
systemrules.iconindicator.parameter.icon=Icon to display. See the [documentation](links.docs.systemrules.iconindicator.parameter.icon.doc) for available icons. Valid values\: "ADD", "COPY", "DOC_GENERIC", "FACE_HAPPY", "FACE_INDIFFERENT", "FACE_SAD", "FOLDER", "HARVEY_0", "HARVEY_25", "HARVEY_50", "HARVEY_75", "HARVEY_100", "MOVE_DOWN", "MOVE_DOWN_DISABLED", "MOVE_LEFT", "MOVE_LEFT_DISABLED", "MOVE_RIGHT", "MOVE_RIGHT_DISABLED", "MOVE_UP", "MOVE_UP_DISABLED", "PREVIEW", "PRIORITY_HIGH", "PRIORITY_LOW", "PROGRESS_PAUSED", "PROGRESS_RUNNING", "PROGRESS_STOPPED", "RATING_EXCELLENT", "RATING_FAIR", "RATING_GOOD", "RATING_POOR", "RATING_VERYGOOD", "REMOVE", "REMOVE_DISABLED", "STATUS_ERROR", "STATUS_NOTDONE", "STATUS_OK", "STATUS_WARN", "TREND_DOWN_BAD", "TREND_DOWN_GOOD", "TREND_FLAT", "TREND_UP_BAD", "TREND_UP_GOOD", "WAIT_CLOCK".
systemrules.iconnewsevent.description=Returns a document image that corresponds to the given icon and color.
systemrules.iconnewsevent.parameter.color=Color of icon to display. Valid values\: "BLUE", "GREEN", "GREY", "ORANGE", "PURPLE", "RED".
systemrules.iconnewsevent.parameter.icon=Icon to display. See the [documentation](links.docs.systemrules.iconnewsevent.parameter.icon.doc) for available icons. Valid values\: "ADD_PERSON", "AIRPLANE", "ARCHIVE", "ATTACHMENT", "BANK", "BAR_CHART", "BARCODE", "BOOK", "BRIEFCASE", "BUILDING", "CALENDAR", "CAR", "CHEVRONS", "CLIPBOARD", "CLOCK", "CLOUDY", "COMPOSE", "CONVERSATION", "CREDIT_CARD", "CROSSOVER", "CURRENCY_DOLLAR", "CURRENCY_EURO", "CURRENCY_POUND", "CURRENCY_YEN", "DELETE", "DISCS", "DOCUMENT", "DOWNLOAD", "ENVELOPE", "EXIT", "EYE", "FACTORY", "FILE_CABINET", "FILE_DOC", "FILE_DOCX", "FILE_PDF", "FILE_PPT", "FILE_PPTX", "FILE_XLS", "FILE_XLSX", "FOLDER", "FOUNTAIN_PEN", "GEAR", "GEARS", "GLOBE", "HAMMER", "HANDSHAKE", "HOME", "HOURGLASS", "ID_CARD", "KEY", "LIFE_PRESERVER", "LIGHT_GLOW", "LIGHTNING", "LINE_CHART", "LINE_CHART_UP", "LIST", "MAGNIFY", "MEDAL", "MICROPHONE", "MUSIC_NOTE", "PADLOCK", "PAINT_ROLLER", "PAPER_AIRPLANE", "PARTLY_CLOUDY", "PAUSE", "PEN", "PENCIL", "PEOPLE_2", "PEOPLE_3", "PEOPLE_4", "PERSON", "PERSON_INFO", "PIE_CHART", "PIGGY", "PLAY", "PLUS", "PRESENTATION", "PROCESS", "QUESTION_BOX", "QUESTION_BUBBLE", "QUESTION_CIRCLE", "REFRESH", "REMOVE_PERSON", "REPLY", "REPLY_ALL", "RETURN", "RIBBON", "ROAD_SIGN_CURVES", "ROAD_SIGN_TURN", "ROCKET", "SCALE", "SHARE", "SHOPPING_CART", "SIGN_POST", "SIGNATURE", "SMART_PHONE", "SPEECH_BUBBLE", "SPEECH_BUBBLE_DOTS", "SPINNER", "STEPS", "STOP", "STORMY", "SUITCASE", "SUN", "TABLE", "TARGET", "TASK", "TASK_BIG", "TASK_PROBLEM", "THUMBS_DOWN", "THUMBS_UP", "TRAFFIC_CONE", "TROPHY", "UMBRELLA", "VIDEO", "WARNING", "WHEELCHAIR", "WRENCH", "ZOOM_IN", "ZOOM_OUT".
systemrules.imagefield.description=Displays an image from document management or the web. See [documentation](links.docs.systemrules.imagefield.doc) for more details.
systemrules.imagefield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.imagefield.parameter.align=Determines alignment of the image(s). Valid values\: "START", "CENTER", "END". Image fields in grids are center-aligned by default. Image fields outside of grids are start-aligned by default.
systemrules.imagefield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.imagefield.parameter.images=Array of images to display, created with a\!webImage(), a\!userImage(), or a\!documentImage().
systemrules.imagefield.parameter.instructions=Supplemental text about this field.
systemrules.imagefield.parameter.isthumbnail=Determines whether the images can be viewed at a larger size when clicked. Multiple images will be visible in a slideshow. Default\: false.
systemrules.imagefield.parameter.label=Text to display as the field label.
systemrules.imagefield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.imagefield.parameter.marginabove=Determines how much space is added above the field. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.imagefield.parameter.marginbelow=Determines how much space is added below the field. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.imagefield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.imagefield.parameter.size=Determines how the images are sized. Valid values\: "ICON", "ICON_PLUS", "TINY", "EXTRA_SMALL", "SMALL", "SMALL_PLUS", "MEDIUM" (default), "MEDIUM_PLUS", "LARGE", "LARGE_PLUS", "EXTRA_LARGE", "FIT", "GALLERY". See the [documentation](links.docs.systemrules.imageField.doc) for guidance on how to use different image sizes effectively.
systemrules.imagefield.parameter.style=Determines how the images are rendered. Valid values\: "STANDARD" (default), "AVATAR".
systemrules.imagefield_17r3.description=This is an older version of the a\!imageField function. You can continue to use this version of the function by its new name\: a\!imageField_17r3. The new version of a\!imageField has new functionality. Displays an image from document management or the web.
systemrules.imagefield_17r3.parameter.align=Determines alignment of the image(s). Valid values\: "START", "CENTER", "END". Image fields in grids are center-aligned by default. Image fields outside of grids are start-aligned by default.
systemrules.imagefield_17r3.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.imagefield_17r3.parameter.images=Array of images to display, created with a\!webImage() or a\!documentImage().
systemrules.imagefield_17r3.parameter.instructions=Supplemental text about this field.
systemrules.imagefield_17r3.parameter.label=Text to display as the field label.
systemrules.imagefield_17r3.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.imagefield_17r3.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.imagefield_17r3.parameter.size=Determines how the images are sized. Valid values\: "STANDARD" (default), "ICON", "THUMBNAIL", "SMALL", "MEDIUM", "LARGE".
systemrules.integerdisplayfield.description=WARNING\: This function is deprecated and may be removed in a future release. Instead, use a\!integerField() with the readOnly attribute set to true.
systemrules.integerdisplayfield.parameter.instructions=Supplemental text about this field.
systemrules.integerdisplayfield.parameter.label=Text to display as the field label.
systemrules.integerdisplayfield.parameter.value=Number to display in the field.
systemrules.integerfield.description=Displays and allows entry of a single integer number. See [documentation](links.docs.systemrules.integerfield.doc) for more details.
systemrules.integerfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.integerfield.parameter.align=Determines alignment of number value. Appian recommends this setting only be used inside the Grid Layout component. Valid values\: "LEFT", "CENTER", "RIGHT".
systemrules.integerfield.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.integerfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.integerfield.parameter.instructions=Supplemental text about this field.
systemrules.integerfield.parameter.label=Text to display as the field label.
systemrules.integerfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.integerfield.parameter.masked=Determines if the value is obscured from view. Default\: false.
systemrules.integerfield.parameter.placeholder=Text to display in the field when it is empty. Does not show if the field is read only.
systemrules.integerfield.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.integerfield.parameter.refreshafter=Determines when the saveInto expression is evaluated. Valid values\: "UNFOCUS" (default), "KEYPRESS".
systemrules.integerfield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.integerfield.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.integerfield.parameter.saveinto=One or more variables that are updated with the integer when the user changes it. Use a\!save() to save a modified or alternative value to a variable.
systemrules.integerfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.integerfield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.integerfield.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.integerfield.parameter.value=Number to display in the field.
systemrules.integrationerror.description=Creates an integration error value. Use when configuring custom error handling for integration objects.
systemrules.integrationerror.parameter.detail=Technical details about the error, including error codes or underlying error messages.
systemrules.integrationerror.parameter.message=A description of the error.
systemrules.integrationerror.parameter.title=A short summary of the error or the error type.
systemrules.isnativemobile.description=If the interface is being viewed on the Appian Mobile application, returns true. Otherwise, returns false. Use to specify how an expression or component should behave on the mobile app compared to a browser. To specify how the interface should change based on device width, use [a\!isPageWidth()](links.docs.function.isPageWidth.doc).
systemrules.isnativephone.description=WARNING\: This function is deprecated and may be removed in a future release. Instead, use a\!isPageWidth to style phone width UI or a\!isNativeMobile to know if the interface is viewed within the Appian for Mobile application.
systemrules.isnativetablet.description=WARNING\: This function is deprecated and may be removed in a future release. Instead, use a\!isPageWidth to style tablet width UI or a\!isNativeMobile to know if the interface is viewed within the Appian for Mobile application.
systemrules.ispagewidth.description=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.
systemrules.ispagewidth.parameter.pagewidths=Valid values\: "PHONE", "TABLET_PORTRAIT", "TABLET_LANDSCAPE", "DESKTOP_NARROW", "DESKTOP", "DESKTOP_WIDE". Review [UX best practices for responsive design](links.docs.systemrules.shared.responsive.doc).
systemrules.jsonpath.description=Find information in a JSON string. JSONPath is used to navigate through elements and attributes in a JSON string.
systemrules.jsonpath.parameter.expression=JSONPath expression to evaluate.
systemrules.jsonpath.parameter.value=A JSON string.
systemrules.kpifield.description=Displays a key performance indicator and an optional trend using a record type as the data source.
systemrules.kpifield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.kpifield.parameter.align=Determines alignment of the text on the KPI. Valid values\: "START" (default), "CENTER", "END".
systemrules.kpifield.parameter.backgroundcolor=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".
systemrules.kpifield.parameter.data=Reference to the record type used as the source of the KPI. Can accept a\!recordData() or a record type reference.
systemrules.kpifield.parameter.datalimit=Maximum number of KPI cards to display for the grouping. Default\: 10. Valid values\: 1-20.
systemrules.kpifield.parameter.grouping=Defines the field used to generate KPI cards in a group, configured using a\!grouping().
systemrules.kpifield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip.
systemrules.kpifield.parameter.icon=Icon to display next to the primary text. See the [documentation for available icons](links.docs.systemrules.styledIcon.doc).
systemrules.kpifield.parameter.iconcolor=Determines the color applied to the icon. Valid values\: any valid hex color or "STANDARD" (default), "ACCENT", "POSITIVE", "NEGATIVE", "SECONDARY".
systemrules.kpifield.parameter.iconstyle=Determines the kind of image shown next to the KPI value and text. Valid values\: "ICON" (default), "STAMP".
systemrules.kpifield.parameter.label=Text to display as the field label.
systemrules.kpifield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "COLLAPSED", "JUSTIFIED".
systemrules.kpifield.parameter.link=Link to execute when a user clicks on the KPI. Use fv\!selection to pass context from the KPI to the link. Create a link using a\!dynamicLink().
systemrules.kpifield.parameter.primarymeasure=Determines the numerical values shown in the KPI, configured using a\!measure(). By default, a count of records is displayed.
systemrules.kpifield.parameter.primarymeasurecolor=Determines color applied to the primary measure. Valid values\: any valid hex color or one of the following values\: "STANDARD" (default), "ACCENT", "POSITIVE", "NEGATIVE", "SECONDARY".
systemrules.kpifield.parameter.primarytext=The main text that identifies or describes the primary measure.
systemrules.kpifield.parameter.primarytextcolor=Determines the color applied to the primary text. Valid values\: any valid hex color or "STANDARD" (default), "ACCENT", "POSITIVE", "NEGATIVE", "SECONDARY".
systemrules.kpifield.parameter.refreshafter=Refreshes KPI data each time a specified event completes. Valid values\: "RECORD_ACTION".
systemrules.kpifield.parameter.refreshalways=When true, KPI data will be refreshed after each user interaction and each interval refresh. Default\: false.
systemrules.kpifield.parameter.refreshinterval=How often KPI data gets refreshed in minutes. When null, KPI data will not be refreshed on an interval. Valid values\: 0.5, 1, 2, 3, 4, 5, 10, 30, 60.
systemrules.kpifield.parameter.refreshonreferencedvarchange=When true, KPI data will be refreshed each time the value of any variable referenced in the data parameter is updated. To refresh KPI data when another variable that is not used within the data parameter, use refreshOnVarChange. Default\: true.
systemrules.kpifield.parameter.refreshonvarchange=Refreshes the KPI data each time any of these specific variables change. This allows you to refresh the KPI data when a variable that is not referenced in the data parameter is updated. You can define either using a single variable (e.g. refreshOnVarChange\: local\!var1) or a list of variables (e.g. refreshOnVarChange\: {local\!var1, local\!var2}).
systemrules.kpifield.parameter.secondarymeasure=Defines the numerical calculations for the KPI\u2019s trend elements, configured using a\!measure().
systemrules.kpifield.parameter.secondarytext=The text placed next to the trend to identify, explain, or provide more information about the data.
systemrules.kpifield.parameter.secondarytextcolor=Determines the color applied to the secondary text. Valid values\: any valid hex color or "STANDARD" (default), "ACCENT", "POSITIVE", "NEGATIVE", "SECONDARY".
systemrules.kpifield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.kpifield.parameter.size=Determines the size of the KPI. Valid values\: "SMALL", "STANDARD" (default), "LARGE".
systemrules.kpifield.parameter.sort=Use a\!sortInfo() to define a sort for the KPI cards in a group in ascending or descending order. Use the alias of the grouping or measures to sort by the values in the KPI.
systemrules.kpifield.parameter.spacing=Determines the space between columns in the layout when they are not stacked. Valid values\: "STANDARD" (default), "NONE", "DENSE", "SPARSE".
systemrules.kpifield.parameter.template=Defines the template to be used to display the KPI elements.  Valid values\: "COMPACT" (default), "ADJACENT", "STACKED". See the [documentation](links.docs.systemrules.kpi.doc) for component display best practices.
systemrules.kpifield.parameter.tooltip=Text to display when a user hovers over (web) or long presses (mobile) the KPI. You can use the fv\!primaryMeasure and fv\!secondaryMeasure variables as part of an expression defining the tooltip.
systemrules.kpifield.parameter.trend=Defines the numerical calculations for trend data in the KPI, configured using the variables fv\!primaryMeasure and fv\!secondaryMeasure. If no secondary measure is provided, this parameter is ignored. Valid values\: "AUTO" (default), "DIFFERENCE", "PERCENTAGE", "NONE".
systemrules.kpifield.parameter.trendcolor=Determines the color applied to the trend and its icon, configured using fv\!primaryMeasure and fv\!secondaryMeasure. Valid values\: any valid hex color or "AUTO" (default), "STANDARD", "ACCENT", "POSITIVE", "NEGATIVE", "SECONDARY", "REVERSE".
systemrules.kpifield.parameter.trendformat=Display value for the given trend. Valid values\: "AUTO" (default), "INTEGER", "DECIMAL", "DOLLAR", "EURO", "POUND", "YEN", "SWISS_FRANC", or a custom format defined with text(). For a custom format, you can reference the unformatted result from the data source using fv\!value. The display format does not affect the values used in the calculations for the KPI; it is only used for display.
systemrules.kpifield.parameter.trendicon=Icon to display next to the trend. Valid values\: any valid expression, "AUTO" (default), or "NONE". See the [documentation for available icons](links.docs.systemrules.styledIcon.doc).
systemrules.kpifield.parameter.width=Determines the width of the column. Valid values\: "AUTO" (default), "EXTRA_NARROW", "NARROW", "NARROW_PLUS", "MEDIUM", "MEDIUM_PLUS", "WIDE", "WIDE_PLUS".
systemrules.linechartconfig.description=Contains configuration for how to display data in a line chart.
systemrules.linechartconfig.parameter.datalimit=Maximum number of data points to display on the chart. Default\: 100. Valid values\: 1-5000.
systemrules.linechartconfig.parameter.link=Link to execute when a user selects a data point on the chart. Use fv\!selection to pass context from the selection made on the chart to the link. Create a link using a\!dynamicLink().
systemrules.linechartconfig.parameter.measures=Defines the numerical calculations for data in the chart, configured using a\!measure(). If no measure is provided, a count of records shows as the measurement in the chart.
systemrules.linechartconfig.parameter.primarygrouping=Defines the field labels to display on the axis in the chart, configured using a\!grouping().
systemrules.linechartconfig.parameter.secondarygrouping=Defines the field labels to display across each line in the chart, configured using a\!grouping().
systemrules.linechartconfig.parameter.showintervalswithnodata=Determines whether the axis in the chart displays date or time values that do not have a value associated with them. For example, show January, February, and March, even if February has no data. This parameter is only available when a Date, Time, or Date and Time field is used as the primary grouping. Default\: false.
systemrules.linechartconfig.parameter.sort=Use a\!sortInfo() to define a sort in ascending or descending order. Use the alias of any groupings or measures to sort by the values in the chart. Use a record field or related record field reference to sort by data that is not referenced in the chart.
systemrules.linechartfield.description=Displays a series of numerical data as points connected by lines. Use a line chart to visualize trends of data that changes over time. If specific values are more important than the trend, consider using a column chart. See [documentation](links.docs.systemrules.linechartfield.doc) for more details.
systemrules.linechartfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.linechartfield.parameter.allowdecimalaxislabels=Allows dependent (vertical) values to display as decimal numbers instead of integers. Default\: false.
systemrules.linechartfield.parameter.allowimagedownload=Determines if the chart download button displays on the chart. Default\: false.
systemrules.linechartfield.parameter.categories=Text, Date, or Date and Time array to display on the x-axis below each data point. If you are using an array of Date or Date and Time, make sure the data is sorted prior to using it as a category.
systemrules.linechartfield.parameter.colorscheme=Determines which color scheme to use in the chart. Use one of the following valid values\: "CLASSIC" (default), "MIDNIGHT", "OCEAN", "MOSS", "BERRY", "PARACHUTE", "RAINFOREST", "SUNSET" or define a custom color scheme using a\!colorSchemeCustom. See the [documentation](links.docs.systemrules.charts.param.colorScheme) for guidance on how to use color schemes.
systemrules.linechartfield.parameter.config=Configures how to display data on the chart, including fields used for calculations and grouping, using a\!lineChartConfig(). Only applies when using a record type as a source in the data parameter. See the [documentation](links.docs.systemrules.chartconfig.doc) for more details on how to configure a chart with a record type as the source.
systemrules.linechartfield.parameter.connectnulls=Determines whether to connect a graph line across null points, or render a gap between the two points on either side of the null. Default\: false.
systemrules.linechartfield.parameter.data=Reference to the record type used for the source of this chart. Can accept a\!recordData or a Record Type Reference.
systemrules.linechartfield.parameter.height=Determines the chart height. Valid values\: "MICRO", "SHORT", "MEDIUM" (default), "TALL". See the [documentation](links.docs.systemrules.charts.param.height) for guidance on using the MICRO size.
systemrules.linechartfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.linechartfield.parameter.instructions=Supplemental text about this field.
systemrules.linechartfield.parameter.label=Text to display as the field label.
systemrules.linechartfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.linechartfield.parameter.referencelines=Array of reference line values for each threshold to be defined on the chart. Configured using a\!chartReferenceLine().
systemrules.linechartfield.parameter.refreshafter=Refreshes chart data each time a specified event completes. Valid values\: "RECORD_ACTION".
systemrules.linechartfield.parameter.refreshalways=When true, chart data will be refreshed after each user interaction and each interval refresh. Default\: false.
systemrules.linechartfield.parameter.refreshinterval=How often chart data gets refreshed in minutes. When null, chart data will not be refreshed on an interval. Valid values\: 0.5, 1, 2, 3, 4, 5, 10, 30, 60.
systemrules.linechartfield.parameter.refreshonreferencedvarchange=When true, chart data will be refreshed each time the value of any variable referenced in the data parameter is updated. To refresh chart data when another variable that is not used within the data parameter, use refreshOnVarChange. Default\: true.
systemrules.linechartfield.parameter.refreshonvarchange=Refreshes the chart data each time any of these specific variables change. This allows you to refresh the chart data when a variable that is not referenced in the data parameter is updated. You can define either using a single variable (e.g. refreshOnVarChange\: local\!var1) or a list of variables (e.g. refreshOnVarChange\: {local\!var1, local\!var2}).
systemrules.linechartfield.parameter.series=Array of data series created with a\!chartSeries().
systemrules.linechartfield.parameter.showdatalabels=Determines if data values are displayed next to each data point. Default\: false.
systemrules.linechartfield.parameter.showlegend=Determines if a color legend displays below the chart. Default\: true.
systemrules.linechartfield.parameter.showtooltips=Determines if a tooltip displays the data value for each data point. Default\: true.
systemrules.linechartfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.linechartfield.parameter.xaxisstyle=Determines how to display the labels and axis separators for the X-Axis. Valid values\: "STANDARD" (default), "NONE".
systemrules.linechartfield.parameter.xaxistitle=Title for the independent (horizontal) axis.
systemrules.linechartfield.parameter.yaxismax=Determines the maximum displayed point on the vertical axis.
systemrules.linechartfield.parameter.yaxismin=Determines the minimum displayed point on the vertical axis.
systemrules.linechartfield.parameter.yaxisstyle=Determines how to display the labels, axis separators, and grid lines for the Y-Axis. Valid values\: "STANDARD" (default), "MINIMAL", "NONE".
systemrules.linechartfield.parameter.yaxistitle=Title for the dependent (vertical) axis.
systemrules.linechartfield_19r1.description=This is an older version of the a\!lineChartField() function. You can continue to use this version of the function by its new name\: a\!lineChartField_19r1(). The new version of a\!lineChartField() has new functionality. Displays a series of numerical data as points connected by lines. Use a line chart to visualize trends of data that changes over time.
systemrules.linechartfield_19r1.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.linechartfield_19r1.parameter.allowdecimalaxislabels=Allows dependent (vertical) values to display as decimal numbers instead of integers. Default\: false.
systemrules.linechartfield_19r1.parameter.categories=Text to display on the x-axis below each data point.
systemrules.linechartfield_19r1.parameter.connectnulls=Determines whether to connect a graph line across null points, or render a gap between the two points on either side of the null. Default\: false.
systemrules.linechartfield_19r1.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.linechartfield_19r1.parameter.instructions=Supplemental text about this field.
systemrules.linechartfield_19r1.parameter.label=Text to display as the field label.
systemrules.linechartfield_19r1.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.linechartfield_19r1.parameter.referencelines=Array of reference line values for each threshold to be defined on the chart. Configured using a\!chartReferenceLine().
systemrules.linechartfield_19r1.parameter.series=Array of data series created with a\!chartSeries().
systemrules.linechartfield_19r1.parameter.showdatalabels=Determines if data values are displayed next to each data point. Default\: false.
systemrules.linechartfield_19r1.parameter.showlegend=Determines if a color legend displays below the chart. Default\: true.
systemrules.linechartfield_19r1.parameter.showtooltips=Determines if a tooltip displays the data value for each data point. Default\: true.
systemrules.linechartfield_19r1.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.linechartfield_19r1.parameter.xaxistitle=Title for the independent (horizontal) axis.
systemrules.linechartfield_19r1.parameter.yaxismax=Determines the maximum displayed point on the vertical axis.
systemrules.linechartfield_19r1.parameter.yaxismin=Determines the minimum displayed point on the vertical axis.
systemrules.linechartfield_19r1.parameter.yaxistitle=Title for the dependent (vertical) axis.
systemrules.linkfield.description=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. See [documentation](links.docs.systemrules.linkfield.doc) for more details.
systemrules.linkfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.linkfield.parameter.align=Determines alignment of link labels. Appian recommends this setting only be used inside the Grid Layout component. Valid values\: "LEFT", "CENTER", "RIGHT".
systemrules.linkfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.linkfield.parameter.instructions=Supplemental text about this field.
systemrules.linkfield.parameter.label=Text to display as the field label.
systemrules.linkfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.linkfield.parameter.links=Array of links to display. Create links with a\!documentDownloadLink(), a\!dynamicLink(), a\!newsEntryLink(), a\!processTaskLink(), a\!recordLink(), a\!reportLink(), a\!safeLink(), a\!startProcessLink(), a\!submitLink(), a\!userRecordLink(), or a\!authorizationLink().
systemrules.linkfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.listviewitem.description=Creates a List View Item for use with record type definitions.
systemrules.listviewitem.parameter.details=Description of the item.
systemrules.listviewitem.parameter.image=An image associated with the item, either an image document to display or a user whose avatar should be shown.
systemrules.listviewitem.parameter.timestamp=The creation or modification timestamp of the item.
systemrules.listviewitem.parameter.title=Name of the item.
systemrules.lockdocument.description=Locks a document. This function will only execute inside a saveInto or a Web API.
systemrules.lockdocument.parameter.document=The document to lock.
systemrules.lockdocument.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.lockdocument.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.measure.description=Determines the numerical values to display on a query, chart, or KPI. The measure should incorporate a record field or related record field, the appropriate calculation to run on the field, and an alias. When used with a\!aggregationFields(), at least one measure or at least one grouping is required.
systemrules.measure.parameter.alias=The short name by which the result of the measure field can be referenced in other places of the query configuration. Values are case-sensitive.
systemrules.measure.parameter.field=The record field or related record field to use in the calculation. Use the recordType\! domain to reference the field. For example, recordType\!Case.fields.status.
systemrules.measure.parameter.filters=A single logical expression or a list of query filters to filter the record set. Queries also apply the default filters defined on the referenced record type. This parameter is only available on record types with sync enabled. You can filter on record fields or on related record fields from a one-to-many relationship. See the [documentation](links.docs.systemrules.measure.doc) for more information.
systemrules.measure.parameter.formatvalue=Display value for the given measure value. Only applies when the measure is used in a chart or KPI. Valid values are "AUTO" (default), "INTEGER", "DECIMAL", "DOLLAR", "EURO", "POUND", "YEN", "SWISS_FRANC", or a custom format defined with text(). You can reference the unformatted result from the data source using fv\!value. The display format does not affect the values used in the calculations; it is only used for display.
systemrules.measure.parameter.function=Function to use with calculations on the field provided. Valid values are\: "COUNT", "SUM", "AVG", "MIN", "MAX", or "DISTINCT_COUNT".
systemrules.measure.parameter.label=Text to display in the legend or tooltip when using the measure in a chart. If no label is defined, the label displays with the function name and field name. The label only displays if a single grouping is used on a bar, column, or line chart.
systemrules.milestonefield.description=Displays the completed, current, and future steps of a process or sequence. See [documentation](links.docs.systemrules.milestonefield.doc) for more details.
systemrules.milestonefield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.milestonefield.parameter.active=Index of the current step. When null, all steps are in the future. When -1, all steps are completed.
systemrules.milestonefield.parameter.color=Determines the color. Valid values\: Any valid hex color or "ACCENT" (default), "POSITIVE", "NEGATIVE", "WARN".
systemrules.milestonefield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.milestonefield.parameter.instructions=Supplemental text about this field.
systemrules.milestonefield.parameter.label=Text to display as the field label.
systemrules.milestonefield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.milestonefield.parameter.links=Array of links to apply to the steps. Create links with a\!documentDownloadLink(), a\!dynamicLink(), a\!newsEntryLink(), a\!processTaskLink(), a\!recordLink(), a\!reportLink(), a\!safeLink(), a\!startProcessLink(), a\!submitLink(), a\!userRecordLink(), or a\!authorizationLink().
systemrules.milestonefield.parameter.marginabove=Determines how much space is added above the field. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.milestonefield.parameter.marginbelow=Determines how much space is added below the field. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.milestonefield.parameter.orientation=Determines the layout of the milestone steps. Valid values\: "HORIZONTAL" (default), "VERTICAL".
systemrules.milestonefield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.milestonefield.parameter.steps=Array of labels describing the sequence of steps.
systemrules.modifyfoldersecurity.description=Modifies the security of a folder. This function will only execute inside a saveInto or a Web API.
systemrules.modifyfoldersecurity.parameter.administrators=The new users and groups to have administrator access to the folder.
systemrules.modifyfoldersecurity.parameter.authors=The new users and groups to have author access to the folder.
systemrules.modifyfoldersecurity.parameter.folder=The folder you want to set security for.
systemrules.modifyfoldersecurity.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.modifyfoldersecurity.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.modifyfoldersecurity.parameter.readers=The new users and groups to have reader access to the folder.
systemrules.modifyknowledgecentersecurity.description=Modifies the security of a knowledge center. This function will only execute inside a saveInto or a Web API.
systemrules.modifyknowledgecentersecurity.parameter.administrators=The new users and groups to have administrator access to the knowledge center.
systemrules.modifyknowledgecentersecurity.parameter.authors=The new users and groups to have author access to the knowledge center.
systemrules.modifyknowledgecentersecurity.parameter.knowledgecenter=The knowledge center you want to set security for.
systemrules.modifyknowledgecentersecurity.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.modifyknowledgecentersecurity.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.modifyknowledgecentersecurity.parameter.readers=The new users and groups to have reader access to the knowledge center.
systemrules.modifyusersecurity.description=Changes the visibility of a user\u2019s profile information. This function will only execute inside a saveInto or a Web API.
systemrules.modifyusersecurity.parameter.administrators=List of users or groups that will have administrative privileges on the user.
systemrules.modifyusersecurity.parameter.editors=List of users or groups that will have editor privileges on the user.
systemrules.modifyusersecurity.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.modifyusersecurity.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.modifyusersecurity.parameter.user=The user that will be updated.
systemrules.modifyusersecurity.parameter.viewers=List of users or groups that will have viewer privileges on the user.
systemrules.movedocument.description=Moves a document. This function will only execute inside a saveInto or a Web API.
systemrules.movedocument.parameter.destination=The new parent folder for the selected document.
systemrules.movedocument.parameter.document=The document to move.
systemrules.movedocument.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.movedocument.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.movefolder.description=Moves a folder. This function will only execute inside a saveInto or a Web API.
systemrules.movefolder.parameter.destinationfolder=The new parent folder for the selected folder.
systemrules.movefolder.parameter.destinationkc=The new parent knowledge center for the selected folder.
systemrules.movefolder.parameter.folder=The folder to move.
systemrules.movefolder.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.movefolder.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.multipledropdownfield.description=Displays a list of choices for the user to select multiple items and saves values based on the selected choices. See [documentation](links.docs.systemrules.multipledropdownfield.doc) for more details.
systemrules.multipledropdownfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.multipledropdownfield.parameter.choicelabels=Array of options for the user to select. When the data source is a record type, this is a record field or related record field.
systemrules.multipledropdownfield.parameter.choicevalues=Array of values associated with the corresponding choices. When the data source is a record type, this is a record field (usually the primary key field).
systemrules.multipledropdownfield.parameter.data=The record type used as the source of the component\u2019s choices. This can be specified with a record type reference or a\!recordData().
systemrules.multipledropdownfield.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.multipledropdownfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.multipledropdownfield.parameter.instructions=Supplemental text about this field.
systemrules.multipledropdownfield.parameter.label=Text to display as the field label.
systemrules.multipledropdownfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.multipledropdownfield.parameter.placeholder=Text to display in the field when it is empty.
systemrules.multipledropdownfield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.multipledropdownfield.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.multipledropdownfield.parameter.saveinto=One or more variables that are updated with the choice values when the user changes the selections. Use a\!save() to save a modified or alternative value to a variable.
systemrules.multipledropdownfield.parameter.searchdisplay=Determines when a search box displays above the options. Valid values\: "AUTO" (default), "ON", "OFF". When set to "AUTO", the search box displays if there are more than 11 options.
systemrules.multipledropdownfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.multipledropdownfield.parameter.sort=Array of Sort Info configurations created with a\!sortInfo().
systemrules.multipledropdownfield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.multipledropdownfield.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.multipledropdownfield.parameter.value=Values of choices to display as selected.
systemrules.multipledropdownfield_20r2.description=This is an older version of the a\!multipleDropdownField function. You can continue to use this version of the function by its new name\: a\!multipleDropdownField_20r2. The new version of a\!multipleDropdownField has new functionality which allows users to search the list of choices. To upgrade to the new version, simply remove "_20r2" from the name. Displays a list of choices for the user to select multiple items and saves values based on the selected choices. See [documentation](links.docs.systemrules.multipledropdownfield.doc) for more details.
systemrules.multipledropdownfield_20r2.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.multipledropdownfield_20r2.parameter.choicelabels=Array of options for the user to select.
systemrules.multipledropdownfield_20r2.parameter.choicevalues=Array of values associated with the available choices.
systemrules.multipledropdownfield_20r2.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.multipledropdownfield_20r2.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.multipledropdownfield_20r2.parameter.instructions=Supplemental text about this field.
systemrules.multipledropdownfield_20r2.parameter.label=Text to display as the field label.
systemrules.multipledropdownfield_20r2.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.multipledropdownfield_20r2.parameter.placeholder=Text to display in the field when it is empty.
systemrules.multipledropdownfield_20r2.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.multipledropdownfield_20r2.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.multipledropdownfield_20r2.parameter.saveinto=One or more variables that are updated with the choice values when the user changes the selections. Use a\!save() to save a modified or alternative value to a variable.
systemrules.multipledropdownfield_20r2.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.multipledropdownfield_20r2.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.multipledropdownfield_20r2.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.multipledropdownfield_20r2.parameter.value=Values of choices to display as selected.
systemrules.multipledropdownfieldbyindex.description=Displays a list of choices for the user to select multiple items and saves the indices of the selected choices.
systemrules.multipledropdownfieldbyindex.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.multipledropdownfieldbyindex.parameter.choicelabels=Array of options for the user to select.
systemrules.multipledropdownfieldbyindex.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.multipledropdownfieldbyindex.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.multipledropdownfieldbyindex.parameter.instructions=Supplemental text about this field.
systemrules.multipledropdownfieldbyindex.parameter.label=Text to display as the field label.
systemrules.multipledropdownfieldbyindex.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.multipledropdownfieldbyindex.parameter.placeholder=Text to display in the field when it is empty.
systemrules.multipledropdownfieldbyindex.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.multipledropdownfieldbyindex.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.multipledropdownfieldbyindex.parameter.saveinto=One or more variables that are updated with the choice indexes when the user changes the selections. Use a\!save() to save a modified or alternative value to a variable.
systemrules.multipledropdownfieldbyindex.parameter.searchdisplay=Determines when a search box displays above the options. Valid values\: "AUTO" (default), "ON", "OFF". When set to "AUTO", the search box displays if there are more than 11 options.
systemrules.multipledropdownfieldbyindex.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.multipledropdownfieldbyindex.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.multipledropdownfieldbyindex.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.multipledropdownfieldbyindex.parameter.value=Indices of choices to display as selected.
systemrules.multipledropdownfieldbyindex_20r2.description=This is an older version of the a\!multipleDropdownFieldByIndex function. You can continue to use this version of the function by its new name\: a\!multipleDropdownFieldByIndex_20r2. The new version of a\!multipleDropdownFieldByIndex has new functionality which allows users to search the list of choices. To upgrade to the new version, simply remove "_20r2" from the name. Displays a list of choices for the user to select multiple items and saves the indices of the selected choices.
systemrules.multipledropdownfieldbyindex_20r2.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.multipledropdownfieldbyindex_20r2.parameter.choicelabels=Array of options for the user to select.
systemrules.multipledropdownfieldbyindex_20r2.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.multipledropdownfieldbyindex_20r2.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.multipledropdownfieldbyindex_20r2.parameter.instructions=Supplemental text about this field.
systemrules.multipledropdownfieldbyindex_20r2.parameter.label=Text to display as the field label.
systemrules.multipledropdownfieldbyindex_20r2.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.multipledropdownfieldbyindex_20r2.parameter.placeholder=Text to display in the field when it is empty.
systemrules.multipledropdownfieldbyindex_20r2.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.multipledropdownfieldbyindex_20r2.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.multipledropdownfieldbyindex_20r2.parameter.saveinto=One or more variables that are updated with the choice indexes when the user changes the selections. Use a\!save() to save a modified or alternative value to a variable.
systemrules.multipledropdownfieldbyindex_20r2.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.multipledropdownfieldbyindex_20r2.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.multipledropdownfieldbyindex_20r2.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.multipledropdownfieldbyindex_20r2.parameter.value=Indices of choices to display as selected.
systemrules.newsentrylink.description=Defines a link to a news entry. Links can be used in charts, grids, hierarchy browsers, images, link fields, milestones, pickers, and rich text.
systemrules.newsentrylink.parameter.entry=The ID of the linked feed entry.
systemrules.newsentrylink.parameter.label=Text associated with this link.
systemrules.newsentrylink.parameter.showwhen=Determines whether the link is displayed in the component. When set to false, the link is hidden and is not evaluated. Default\: true.
systemrules.orgchartfield.description=Displays the organizational structure of users within Appian based on the users\u2019 Supervisor field values. See [documentation](links.docs.systemrules.orgchartfield.doc) for more details.
systemrules.orgchartfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.orgchartfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.orgchartfield.parameter.instructions=Supplemental text about this field.
systemrules.orgchartfield.parameter.label=Text to display as the field label.
systemrules.orgchartfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.orgchartfield.parameter.saveinto=One or more variables that are updated with the user value. Use a\!save() to save a modified or alternative value to a variable.
systemrules.orgchartfield.parameter.showallancestors=Determines if all ancestors above the user are displayed. Default is false, which displays only the user\u2019s supervisor.
systemrules.orgchartfield.parameter.showtotalcounts=Determines who is included in the report count. When set to true, the count includes both direct and indirect reports. When set to false, the count only includes direct reports. Default\: false.
systemrules.orgchartfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.orgchartfield.parameter.value=The user who is the focus of the org chart.
systemrules.paginginfo.description=Creates a Paging Info configuration for use with grids, queries, and todatasubset().
systemrules.paginginfo.parameter.batchsize=The number of items to return. When used with records, valid values are 0 to 5,000. When used with an entity, valid values include those greater than or equal to -1. See the [documentation](links.docs.systemrules.pagingInfo.doc) for more information.
systemrules.paginginfo.parameter.sort=Array of Sort Info configurations created with a\!sortInfo().
systemrules.paginginfo.parameter.startindex=Index where the current page begins. It must be greater than zero.
systemrules.pane.description=Displays a pane within a pane layout.
systemrules.pane.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.pane.parameter.backgroundcolor=Color to show behind the contents of the pane. Valid values\: Any valid hex color or "WHITE" (default), "GRAY", "TRANSPARENT", "CHARCOAL_SCHEME", "NAVY_SCHEME", "PLUM_SCHEME".
systemrules.pane.parameter.contents=Components and layouts to display within the pane.
systemrules.pane.parameter.padding=Determines the space between the pane edges and its contents. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.pane.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.pane.parameter.width=Determines the width of the pane. Valid values\: "AUTO" (default), "EXTRA_NARROW", "NARROW", "NARROW_PLUS", "MEDIUM", "MEDIUM_PLUS", "WIDE", "WIDE_PLUS".
systemrules.panelayout.description=Displays two or three vertical panes, each with independent scrolling.
systemrules.panelayout.parameter.panes=List of two or three panes to display in the pane layout.
systemrules.panelayout.parameter.showwhen=Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default\: true.
systemrules.paragraphfield.description=Displays and allows entry of multiple lines of text. See [documentation](links.docs.systemrules.paragraphfield.doc) for more details.
systemrules.paragraphfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.paragraphfield.parameter.characterlimit=Determines the maximum number of characters. Depending on the language, some characters may count as more than one.
systemrules.paragraphfield.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.paragraphfield.parameter.height=Determines the field height. Valid values\: "SHORT", "MEDIUM" (default), "TALL".
systemrules.paragraphfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.paragraphfield.parameter.instructions=Supplemental text about this field.
systemrules.paragraphfield.parameter.label=Text to display as the field label.
systemrules.paragraphfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.paragraphfield.parameter.placeholder=Text to display in the field when it is empty. Does not show if the field is read only.
systemrules.paragraphfield.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.paragraphfield.parameter.refreshafter=Determines when the saveInto expression is evaluated. Valid values\: "UNFOCUS" (default), "KEYPRESS".
systemrules.paragraphfield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.paragraphfield.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.paragraphfield.parameter.saveinto=One or more variables that are updated with the text when the user changes it. Use a\!save() to save a modified or alternative value to a variable.
systemrules.paragraphfield.parameter.showcharactercount=Determines if the character count displays on the paragraph field. Only applicable if the character limit is set. Default\: true.
systemrules.paragraphfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.paragraphfield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.paragraphfield.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.paragraphfield.parameter.value=Text to display in the field.
systemrules.paymentinfofield.description=Captures payment card information to allow for payment processing.
systemrules.paymentinfofield.parameter.align=Determines alignment of the payment button. Valid values\: "LEFT" (default), "CENTER", "RIGHT".
systemrules.paymentinfofield.parameter.buttonlabel=Text to display on the button. Default is "Capture Payment Info" initially and "Recapture Payment Info" once the payment information has been captured.
systemrules.paymentinfofield.parameter.disabled=Determines if the field should display as potentially editable but disabled. Default\: false.
systemrules.paymentinfofield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.paymentinfofield.parameter.instructions=Supplemental text about this field.
systemrules.paymentinfofield.parameter.label=Text to display as the field label.
systemrules.paymentinfofield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "COLLAPSED".
systemrules.paymentinfofield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.paymentinfofield.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.paymentinfofield.parameter.saveinto=One or more variables that are updated with the Payment Info when the user changes it. Use a\!save() to save a modified or alternative value to a variable.
systemrules.paymentinfofield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.paymentinfofield.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.paymentinfofield.parameter.value=Holds the payment information collected from the payment card.
systemrules.pickerfieldcustom.description=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](links.docs.systemrules.pickerfieldcustom.recipe).
systemrules.pickerfieldcustom.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.pickerfieldcustom.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.pickerfieldcustom.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.pickerfieldcustom.parameter.instructions=Supplemental text about this field.
systemrules.pickerfieldcustom.parameter.label=Text to display as the field label.
systemrules.pickerfieldcustom.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.pickerfieldcustom.parameter.maxselections=Maximum number of allowed selections. Once this number is reached, further selections are blocked until a selection is removed.
systemrules.pickerfieldcustom.parameter.placeholder=Text to display in the field when it is empty. Does not show if the field is read only.
systemrules.pickerfieldcustom.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.pickerfieldcustom.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.pickerfieldcustom.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.pickerfieldcustom.parameter.saveinto=One or more variables that are updated with the array of selected identifiers when the user adds or removes an item. Use a\!save() to save a modified or alternative value to a variable.
systemrules.pickerfieldcustom.parameter.selectedlabels=Array of text display labels for the currently selected items.
systemrules.pickerfieldcustom.parameter.selectedlinks=Array of links to apply to the selected tokens. Create links with a\!authorizationLink(), a\!documentDownloadLink(), a\!dynamicLink(), a\!newsEntryLink(), a\!processTaskLink(), a\!recordLink(), a\!reportLink(), a\!safeLink(), a\!startProcessLink(), a\!submitLink(), or a\!userRecordLink().
systemrules.pickerfieldcustom.parameter.selectedtooltips=Array of text tooltips for the currently selected items.
systemrules.pickerfieldcustom.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.pickerfieldcustom.parameter.suggestfunction=A reference to a rule or function that populates the suggestion pane. The rule or function must take a single Text parameter and must return a DataSubset, created via a\!dataSubset() or a plugin function, where "data" contains the labels to display and "identifiers" contains the values to save.
systemrules.pickerfieldcustom.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.pickerfieldcustom.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.pickerfieldcustom.parameter.value=Array of selected identifiers.
systemrules.pickerfielddocuments.description=Displays an autocompleting input for the selection of one or more documents. See [documentation](links.docs.systemrules.pickerfielddocuments.doc) for more details.
systemrules.pickerfielddocuments.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.pickerfielddocuments.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.pickerfielddocuments.parameter.folderfilter=When present, only documents that are inside this folder and its subfolders are suggested.
systemrules.pickerfielddocuments.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.pickerfielddocuments.parameter.instructions=Supplemental text about this field.
systemrules.pickerfielddocuments.parameter.label=Text to display as the field label.
systemrules.pickerfielddocuments.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.pickerfielddocuments.parameter.maxselections=Maximum number of allowed selections. Once this number is reached, further selections are blocked until a selection is removed.
systemrules.pickerfielddocuments.parameter.placeholder=Text to display in the field when it is empty. Does not show if the field is read only.
systemrules.pickerfielddocuments.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.pickerfielddocuments.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.pickerfielddocuments.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.pickerfielddocuments.parameter.saveinto=One or more variables that are updated with the array of selected documents when the user selects or removes a document. Use a\!save() to save a modified or alternative value to a variable.
systemrules.pickerfielddocuments.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.pickerfielddocuments.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.pickerfielddocuments.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.pickerfielddocuments.parameter.value=Array of currently selected documents.
systemrules.pickerfielddocumentsandfolders.description=Displays an autocompleting input for the selection of one or more documents or folders. See [documentation](links.docs.systemrules.pickerfielddocumentsandfolders.doc) for more details.
systemrules.pickerfielddocumentsandfolders.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.pickerfielddocumentsandfolders.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.pickerfielddocumentsandfolders.parameter.folderfilter=When present, only documents and folders that are inside this folder and its subfolders are suggested.
systemrules.pickerfielddocumentsandfolders.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.pickerfielddocumentsandfolders.parameter.instructions=Supplemental text about this field.
systemrules.pickerfielddocumentsandfolders.parameter.label=Text to display as the field label.
systemrules.pickerfielddocumentsandfolders.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.pickerfielddocumentsandfolders.parameter.maxselections=Maximum number of allowed selections. Once this number is reached, further selections are blocked until a selection is removed.
systemrules.pickerfielddocumentsandfolders.parameter.placeholder=Text to display in the field when it is empty. Does not show if the field is read only.
systemrules.pickerfielddocumentsandfolders.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.pickerfielddocumentsandfolders.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.pickerfielddocumentsandfolders.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.pickerfielddocumentsandfolders.parameter.saveinto=One or more variables that are updated with the array of selected documents and folders when the user selects or removes a document or folder. Use a\!save() to save a modified or alternative value to a variable.
systemrules.pickerfielddocumentsandfolders.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.pickerfielddocumentsandfolders.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.pickerfielddocumentsandfolders.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.pickerfielddocumentsandfolders.parameter.value=Array of currently selected documents and folders.
systemrules.pickerfieldfolders.description=Displays an autocompleting input for selecting one or more folders. See [documentation](links.docs.systemrules.pickerfieldfolders.doc) for more details.
systemrules.pickerfieldfolders.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.pickerfieldfolders.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.pickerfieldfolders.parameter.folderfilter=When present, only folders that are inside this folder and its subfolders are suggested.
systemrules.pickerfieldfolders.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.pickerfieldfolders.parameter.instructions=Supplemental text about this field.
systemrules.pickerfieldfolders.parameter.label=Text to display as the field label.
systemrules.pickerfieldfolders.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.pickerfieldfolders.parameter.maxselections=Maximum number of allowed selections. Once this number is reached, further selections are blocked until a selection is removed.
systemrules.pickerfieldfolders.parameter.placeholder=Text to display in the field when it is empty. Does not show if the field is read only.
systemrules.pickerfieldfolders.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.pickerfieldfolders.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.pickerfieldfolders.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.pickerfieldfolders.parameter.saveinto=One or more variables that are updated with the array of selected folders when the user selects or removes a folder. Use a\!save() to save a modified or alternative value to a variable.
systemrules.pickerfieldfolders.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.pickerfieldfolders.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.pickerfieldfolders.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.pickerfieldfolders.parameter.value=Array of currently selected folders.
systemrules.pickerfieldgroups.description=Displays an autocompleting input for selecting one or more groups. See [documentation](links.docs.systemrules.pickerfieldgroups.doc) for more details.
systemrules.pickerfieldgroups.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.pickerfieldgroups.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.pickerfieldgroups.parameter.groupfilter=When present, only groups which are members of this group are suggested.
systemrules.pickerfieldgroups.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.pickerfieldgroups.parameter.instructions=Supplemental text about this field.
systemrules.pickerfieldgroups.parameter.label=Text to display as the field label.
systemrules.pickerfieldgroups.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.pickerfieldgroups.parameter.maxselections=Maximum number of allowed selections. Once this number is reached, further selections are blocked until a selection is removed.
systemrules.pickerfieldgroups.parameter.placeholder=Text to display in the field when it is empty. Does not show if the field is read only.
systemrules.pickerfieldgroups.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.pickerfieldgroups.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.pickerfieldgroups.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.pickerfieldgroups.parameter.saveinto=One or more variables that are updated with the array of selected groups when the user selects or removes a group. Use a\!save() to save a modified or alternative value to a variable.
systemrules.pickerfieldgroups.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.pickerfieldgroups.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.pickerfieldgroups.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.pickerfieldgroups.parameter.value=Array of currently selected groups.
systemrules.pickerfieldrecords.description=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. See [documentation](links.docs.systemrules.pickerfieldrecords.doc) for more details.
systemrules.pickerfieldrecords.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.pickerfieldrecords.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.pickerfieldrecords.parameter.filters=A single logical expression or a list of query filters can be provided to apply additional filters to the record set. Queries inherit the default filters defined on the referenced record type. Service-backed record types can only be filtered using a logical expression if data sync is enabled.
systemrules.pickerfieldrecords.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.pickerfieldrecords.parameter.instructions=Supplemental text about this field.
systemrules.pickerfieldrecords.parameter.label=Text to display as the field label.
systemrules.pickerfieldrecords.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.pickerfieldrecords.parameter.maxselections=Maximum number of allowed selections. Once this number is reached, further selections are blocked until a selection is removed.
systemrules.pickerfieldrecords.parameter.openlinksin=(Browser-only) Determines where the linked content should open. Valid values\: "SAME_TAB" (default), "NEW_TAB".
systemrules.pickerfieldrecords.parameter.placeholder=Text to display in the field when it is empty. Does not show if the field is read only.
systemrules.pickerfieldrecords.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.pickerfieldrecords.parameter.recordtype=Required, singular. Filters picker to select records of this type.
systemrules.pickerfieldrecords.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.pickerfieldrecords.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.pickerfieldrecords.parameter.saveinto=One or more variables that are updated with the array of selected records when the user selects or removes a record. Use a\!save() to save a modified or alternative value to a variable.
systemrules.pickerfieldrecords.parameter.showrecordlinks=Determines whether selected records display links to their summary views. Default\: true.
systemrules.pickerfieldrecords.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.pickerfieldrecords.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.pickerfieldrecords.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.pickerfieldrecords.parameter.value=Array of currently selected records. This will be either a List of Text or a List of Number (Integer), depending on the recordType selected.
systemrules.pickerfieldrecords_20r2.description=This is an older version of the a\!pickerFieldRecords() function. You can continue to use this version of the function by its new name\: a\!pickerFieldRecords_20r2(). Use this version of the function when working with record types that have not yet been updated to use record type field references. 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. See [documentation](links.docs.systemrules.pickerfieldrecords.doc) for more details.
systemrules.pickerfieldrecords_20r2.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.pickerfieldrecords_20r2.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.pickerfieldrecords_20r2.parameter.filters=List of filters to apply when searching for records.
systemrules.pickerfieldrecords_20r2.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.pickerfieldrecords_20r2.parameter.instructions=Supplemental text about this field.
systemrules.pickerfieldrecords_20r2.parameter.label=Text to display as the field label.
systemrules.pickerfieldrecords_20r2.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.pickerfieldrecords_20r2.parameter.maxselections=Maximum number of allowed selections. Once this number is reached, further selections are blocked until a selection is removed.
systemrules.pickerfieldrecords_20r2.parameter.placeholder=Text to display in the field when it is empty. Does not show if the field is read only.
systemrules.pickerfieldrecords_20r2.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.pickerfieldrecords_20r2.parameter.recordtype=Required, singular. Filters picker to select records of this type.
systemrules.pickerfieldrecords_20r2.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.pickerfieldrecords_20r2.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.pickerfieldrecords_20r2.parameter.saveinto=One or more variables that are updated with the array of selected records when the user selects or removes a record. Use a\!save() to save a modified or alternative value to a variable.
systemrules.pickerfieldrecords_20r2.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.pickerfieldrecords_20r2.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.pickerfieldrecords_20r2.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.pickerfieldrecords_20r2.parameter.value=Array of currently selected records. This will be either a List of Text or a List of Number (Integer), depending on the recordType selected.
systemrules.pickerfieldrecords_22r1.description=This is an older version of the a\!pickerFieldRecords() function. You can continue to use this version of the function by its new name\: 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. See [documentation](links.docs.systemrules.pickerfieldrecords.doc) for more details.
systemrules.pickerfieldrecords_22r1.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.pickerfieldrecords_22r1.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.pickerfieldrecords_22r1.parameter.filters=List of filters to apply when searching for records.
systemrules.pickerfieldrecords_22r1.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.pickerfieldrecords_22r1.parameter.instructions=Supplemental text about this field.
systemrules.pickerfieldrecords_22r1.parameter.label=Text to display as the field label.
systemrules.pickerfieldrecords_22r1.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.pickerfieldrecords_22r1.parameter.maxselections=Maximum number of allowed selections. Once this number is reached, further selections are blocked until a selection is removed.
systemrules.pickerfieldrecords_22r1.parameter.placeholder=Text to display in the field when it is empty. Does not show if the field is read only.
systemrules.pickerfieldrecords_22r1.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.pickerfieldrecords_22r1.parameter.recordtype=Required, singular. Filters picker to select records of this type.
systemrules.pickerfieldrecords_22r1.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.pickerfieldrecords_22r1.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.pickerfieldrecords_22r1.parameter.saveinto=One or more variables that are updated with the array of selected records when the user selects or removes a record. Use a\!save() to save a modified or alternative value to a variable.
systemrules.pickerfieldrecords_22r1.parameter.showrecordlinks=Determines whether selected records display links to their summary views. Default\: true.
systemrules.pickerfieldrecords_22r1.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.pickerfieldrecords_22r1.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.pickerfieldrecords_22r1.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.pickerfieldrecords_22r1.parameter.value=Array of currently selected records. This will be either a List of Text or a List of Number (Integer), depending on the recordType selected.
systemrules.pickerfieldusers.description=Displays an autocompleting input for the selection of one or more users. See [documentation](links.docs.systemrules.pickerfieldusers.doc) for more details.
systemrules.pickerfieldusers.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.pickerfieldusers.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.pickerfieldusers.parameter.groupfilter=When present, only users who are members of this group are suggested.
systemrules.pickerfieldusers.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.pickerfieldusers.parameter.instructions=Supplemental text about this field.
systemrules.pickerfieldusers.parameter.label=Text to display as the field label.
systemrules.pickerfieldusers.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.pickerfieldusers.parameter.maxselections=Maximum number of allowed selections. Once this number is reached, further selections are blocked until a selection is removed.
systemrules.pickerfieldusers.parameter.placeholder=Text to display in the field when it is empty. Does not show if the field is read only.
systemrules.pickerfieldusers.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.pickerfieldusers.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.pickerfieldusers.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.pickerfieldusers.parameter.saveinto=One or more variables that are updated with the array of selected users when the user selects or removes a user. Use a\!save() to save a modified or alternative value to a variable.
systemrules.pickerfieldusers.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.pickerfieldusers.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.pickerfieldusers.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.pickerfieldusers.parameter.value=Array of currently selected users.
systemrules.pickerfieldusersandgroups.description=Displays an autocompleting input for selecting one or more users or groups. See [documentation](links.docs.systemrules.pickerfieldusersandgroups.doc) for more details.
systemrules.pickerfieldusersandgroups.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.pickerfieldusersandgroups.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.pickerfieldusersandgroups.parameter.groupfilter=When present, only users or groups which are members of this group are suggested.
systemrules.pickerfieldusersandgroups.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.pickerfieldusersandgroups.parameter.instructions=Supplemental text about this field.
systemrules.pickerfieldusersandgroups.parameter.label=Text to display as the field label.
systemrules.pickerfieldusersandgroups.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.pickerfieldusersandgroups.parameter.maxselections=Maximum number of allowed selections. Once this number is reached, further selections are blocked until a selection is removed.
systemrules.pickerfieldusersandgroups.parameter.placeholder=Text to display in the field when it is empty. Does not show if the field is read only.
systemrules.pickerfieldusersandgroups.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.pickerfieldusersandgroups.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.pickerfieldusersandgroups.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.pickerfieldusersandgroups.parameter.saveinto=One or more variables that are updated with the array of selected users or groups when the user selects or removes a user or group. Use a\!save() to save a modified or alternative value to a variable.
systemrules.pickerfieldusersandgroups.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.pickerfieldusersandgroups.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.pickerfieldusersandgroups.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.pickerfieldusersandgroups.parameter.value=Array of currently selected users or groups.
systemrules.piechartconfig.description=Contains configuration for how to display data in a pie chart.
systemrules.piechartconfig.parameter.datalimit=Maximum number of data points to display on the chart. Default\: 100. Valid values\: 1-5000.
systemrules.piechartconfig.parameter.link=Link to execute when a user selects a data point on the chart. Use fv\!selection to pass context from the selection made on the chart to the link. Create a link using a\!dynamicLink().
systemrules.piechartconfig.parameter.measures=Defines the numerical calculations for data in the chart, configured using a\!measure(). If no measure is provided, a count of records shows as the measurement in the chart.
systemrules.piechartconfig.parameter.primarygrouping=Defines the field labels to display for each slice of the pie chart, configured using a\!grouping().
systemrules.piechartconfig.parameter.sort=Use a\!sortInfo() to define a sort in ascending or descending order. Use the alias of any groupings or measures to sort by the values in the chart. Use a record field or related record field reference to sort by data that is not referenced in the chart.
systemrules.piechartfield.description=Displays numerical data as slices of a single circle. Use a pie chart to graphically display parts of a whole. See [documentation](links.docs.systemrules.piechartfield.doc) for more details.
systemrules.piechartfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.piechartfield.parameter.allowimagedownload=Determines if the chart download button displays on the chart. Default\: false.
systemrules.piechartfield.parameter.colorscheme=Determines which color scheme to use in the chart. Use one of the following valid values\: "CLASSIC" (default), "MIDNIGHT", "OCEAN", "MOSS", "BERRY", "PARACHUTE", "RAINFOREST", "SUNSET" or define a custom color scheme using a\!colorSchemeCustom. See the [documentation](links.docs.systemrules.charts.param.colorScheme) for guidance on how to use color schemes.
systemrules.piechartfield.parameter.config=Configures how to display data on the chart, including fields used for calculations and grouping, using a\!pieChartConfig(). Only applies when using a record type as a source in the data parameter. See the [documentation](links.docs.systemrules.chartconfig.doc) for more details on how to configure a chart with a record type as the source.
systemrules.piechartfield.parameter.data=Reference to the record type used for the source of this chart. Can accept a\!recordData or a Record Type Reference.
systemrules.piechartfield.parameter.height=Determines the chart height. Valid values\: "SHORT", "MEDIUM" (default), "TALL".
systemrules.piechartfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.piechartfield.parameter.instructions=Supplemental text about this field.
systemrules.piechartfield.parameter.label=Text to display as the field label.
systemrules.piechartfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.piechartfield.parameter.refreshafter=Refreshes chart data each time a specified event completes. Valid values\: "RECORD_ACTION".
systemrules.piechartfield.parameter.refreshalways=When true, chart data will be refreshed after each user interaction and each interval refresh. Default\: false.
systemrules.piechartfield.parameter.refreshinterval=How often chart data gets refreshed in minutes. When null, chart data will not be refreshed on an interval. Valid values\: 0.5, 1, 2, 3, 4, 5, 10, 30, 60.
systemrules.piechartfield.parameter.refreshonreferencedvarchange=When true, chart data will be refreshed each time the value of any variable referenced in the data parameter is updated. To refresh chart data when another variable that is not used within the data parameter, use refreshOnVarChange. Default\: true.
systemrules.piechartfield.parameter.refreshonvarchange=Refreshes the chart data each time any of these specific variables change. This allows you to refresh the chart data when a variable that is not referenced in the data parameter is updated. You can define either using a single variable (e.g. refreshOnVarChange\: local\!var1) or a list of variables (e.g. refreshOnVarChange\: {local\!var1, local\!var2}).
systemrules.piechartfield.parameter.series=Array of data series created with a\!chartSeries().
systemrules.piechartfield.parameter.serieslabelstyle=Determines where to display the series labels. Valid values\: "ON_CHART" (default), "LEGEND", "NONE".
systemrules.piechartfield.parameter.showaspercentage=Determines if the data is shown as a percentage. Default\: false.
systemrules.piechartfield.parameter.showdatalabels=Determines if data values are displayed with each pie slice. Default\: false.
systemrules.piechartfield.parameter.showtooltips=Determines if a tooltip displays the data value for a pie slice. Default\: false.
systemrules.piechartfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.piechartfield.parameter.style=Determines if the chart displays as a full pie or as a donut. Valid values\: "PIE" (default), "DONUT".
systemrules.processtasklink.description=Defines a link to a process task. Links can be used in charts, grids, hierarchy browsers, images, link fields, milestones, pickers, and rich text.
systemrules.processtasklink.parameter.label=Label associated with this link.
systemrules.processtasklink.parameter.openlinkin=(Browser-only) Determines where the linked content should open. Valid values\: "SAME_TAB" (default), "NEW_TAB".
systemrules.processtasklink.parameter.showwhen=Determines whether the link is displayed in the component. When set to false, the link is hidden and is not evaluated. Default\: true.
systemrules.processtasklink.parameter.task=Process task to view when the link is clicked.
systemrules.progressbarfield.description=Displays a completion percentage. See [documentation](links.docs.systemrules.progressbarfield.doc) for more details.
systemrules.progressbarfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.progressbarfield.parameter.color=Determines the color. Valid values\: Any valid hex color or "ACCENT" (default), "POSITIVE", "NEGATIVE", "WARN".
systemrules.progressbarfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.progressbarfield.parameter.instructions=Supplemental text about this field.
systemrules.progressbarfield.parameter.label=Text to display as the field label.
systemrules.progressbarfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.progressbarfield.parameter.marginabove=Determines how much space is added above the field. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.progressbarfield.parameter.marginbelow=Determines how much space is added below the field. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.progressbarfield.parameter.percentage=Number to display between 0 and 100.
systemrules.progressbarfield.parameter.showpercentage=Determines whether the progress bar displays the percentage. Default\: true.
systemrules.progressbarfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.progressbarfield.parameter.style=Thickness of the progress bar. Valid values\: "THIN" (default), "THICK".
systemrules.query.description=Creates a Query configuration for use with queryrecord(). See the [documentation](links.docs.systemrules.queries.doc.guidance) for guidance about when to use different querying methods.
systemrules.query.parameter.aggregation=Aggregation configuration for data retrieval created with a\!queryAggregation().
systemrules.query.parameter.filter=A single condition to apply to the queried data before any grouping or aggregation, created with a\!queryFilter().
systemrules.query.parameter.logicalexpression=Logical Expression filters to apply to queried data before grouping or aggregation, created with a\!queryLogicalExpression().
systemrules.query.parameter.paginginfo=The paging and sorting configurations to apply when retrieving the data.
systemrules.query.parameter.selection=Array of fields to retrieve created with a\!querySelection().
systemrules.queryaggregation.description=Creates an Aggregation configuration for use with a\!query().
systemrules.queryaggregation.parameter.aggregationcolumns=Array of Aggregation Columns indicating which fields to group or aggregate, created with a\!queryAggregationColumn.
systemrules.queryaggregationcolumn.description=Creates an Aggregation Column configuration for use with a\!queryAggregation().
systemrules.queryaggregationcolumn.parameter.aggregationfunction=The function to use when aggregating the field. Valid values are "COUNT", "SUM", "AVG", "MIN", and "MAX". This value is required when isGrouping is set to false.
systemrules.queryaggregationcolumn.parameter.alias=(Optional) 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.
systemrules.queryaggregationcolumn.parameter.field=The dot-notation to the data field to be grouped or aggregated.
systemrules.queryaggregationcolumn.parameter.groupingfunction=(Optional) A function that can be applied on the selected field. Valid values are "YEAR" and "MONTH". This parameter can only be used with Date and Date and Time data types. Requires isGrouping to be true.
systemrules.queryaggregationcolumn.parameter.isgrouping=(Optional) Determines whether the field should be grouped. Default\: false.
systemrules.queryaggregationcolumn.parameter.visible=(Optional) Determines whether the 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.
systemrules.queryaggregationcolumnes.description=Creates an Aggregation Column configuration for use with a\!queryAggregation() when used with fn\!queryrulemetrics_appian_internal.
systemrules.queryaggregationcolumnes.parameter.aggregationfunction=The function to use when aggregating the field. Valid values\: "COUNT", "SUM" (?), "AVG", "MIN", "MAX", "INTERVAL_HOUR", "INTERVAL_DAY", "INTERVAL_WEEK". The final 3 can be used in conjunction with isGrouping\=true to group by datetime intervals.
systemrules.queryaggregationcolumnes.parameter.alias=The short name by which the resulting value can be referenced. Fields which are grouped by cannot have aliases.
systemrules.queryaggregationcolumnes.parameter.field=The name of the field to be grouped or aggregated, as defined in the search server schema for the relevant index.
systemrules.queryaggregationcolumnes.parameter.isgrouping=Determines if the field should be grouped. Default\: false.
systemrules.queryaggregationcolumnes.parameter.visible=Determines if the column is retrieved or is only available for sorting. Default\: true. (this behavior is undefined and not guaranteed).
systemrules.querycolumn.description=Creates a Query Column for use with a\!querySelection().
systemrules.querycolumn.parameter.alias=The short name by which the resulting value can be referenced.
systemrules.querycolumn.parameter.field=The dot notation to the data field to retrieve.
systemrules.querycolumn.parameter.visible=Determines if the column is retrieved or is only available for sorting. Default\: true.
systemrules.queryentity.description=Executes a query on a given Data Store Entity and returns the resulting DataSubset. See the [documentation](links.docs.systemrules.queryentity.doc) for guidance about when to use different querying methods.
systemrules.queryentity.parameter.entity=The Data Store Entity to query.
systemrules.queryentity.parameter.fetchtotalcount=If set to true, runs the query that retrieves the total number of rows in the totalCount parameter of the resulting datasubset. In cases where you don\u2019t need the totalCount, skipping this query can improve the performance of a\!queryEntity(). Default\: false. See the [documentation](links.docs.systemrules.queryentity.doc) for more information.
systemrules.queryentity.parameter.query=The query to execute, created using a\!query().
systemrules.queryentity_18r3.description=This is an older version of the a\!queryEntity() function. You can continue to use this version of the function by its new name\: a\!queryEntity_18r3(). The new version of a\!queryEntity() has new functionality\: By default, the query that retrieves the total number of rows in the totalCount parameter of the resulting datasubset is not executed. In cases where you don\u2019t need the totalCount, skipping this query can improve the performance of a\!queryEntity(). See the [documentation](links.docs.systemrules.queryentity.syntax) for more information.
systemrules.queryentity_18r3.parameter.entity=The Data Store Entity to query.
systemrules.queryentity_18r3.parameter.query=The query to execute, created using a\!query().
systemrules.queryentity_22r2.description=This is an older version of the a\!queryEntity() function. You can continue to use this version of the function by its new name\: a\!queryEntity_22r2(). The new version of a\!queryEntity() replaces an incorrect behavior, where a sort was being added on the last a\!queryColumn specified as part of a selection. Moving forward, if the query isn\u2019t sorted by the identifier, a final identifier sort is added to ensure deterministic sorting.
systemrules.queryentity_22r2.parameter.entity=The Data Store Entity to query.
systemrules.queryentity_22r2.parameter.fetchtotalcount=If set to true, runs the query that retrieves the total number of rows in the totalCount parameter of the resulting datasubset. In cases where you don\u2019t need the totalCount, skipping this query can improve the performance of a\!queryEntity(). Default\: false. See the [documentation](links.docs.systemrules.queryentity.syntax) for more information.
systemrules.queryentity_22r2.parameter.query=The query to execute, created using a\!query().
systemrules.queryfilter.description=Creates a Query Filter configuration for use with a\!pickerFieldRecords, a\!query, a\!queryRecordType, a\!recordData, and a\!recordFilterListOption.
systemrules.queryfilter.parameter.applywhen=Determines whether the filter is applied on the query. When set to false, the filter is not evaluated. Default\: true.
systemrules.queryfilter.parameter.field=The name of the field or relationship to be filtered. When filtering record data, use the recordType\! domain to reference a record field, related record field, or record type relationship. For example, recordType\!Case.fields.caseName.
systemrules.queryfilter.parameter.operator=Filter operator to apply to the data. Valid values\: "\=", "<>", ">", ">\=", "<", "<\=", "between", "in", "not in", "is null", "not null", "starts with", "not starts with", "ends with", "not ends with", "includes", "not includes".
systemrules.queryfilter.parameter.value=The value to compare to the given field using the given operator. Can be entered as an expression. Optional if the operator value is "is null" or "not null". Filter is ignored if value is empty or null and operator is neither "is null" or "not null".
systemrules.querylogicalexpression.description=Creates a Logical Expression configuration for use with a\!query().
systemrules.querylogicalexpression.parameter.filters=Array of Query Filters to apply, created using a\!queryFilter().
systemrules.querylogicalexpression.parameter.ignorefilterswithemptyvalues=Specifies whether to ignore filters within a\!queryLogicalExpression() if the filter\u2019s value parameter is empty. If you are using nested logical expressions, this parameter must have the same value for each logical expression. For example, if the value is set to true for the parent logical expression, it should be set to true for all children logical expressions. Default\: false
systemrules.querylogicalexpression.parameter.logicalexpressions=Array of Logical Expression to apply, created with a\!queryLogicalExpression().
systemrules.querylogicalexpression.parameter.operator=Determines how to combine the filters. Valid values\: "AND", "OR", "AND_ALL". The "AND_ALL" value is only valid when filtering by one-to-many related record fields. See the [documentation](links.docs.systemrules.querylogicalexpression.operators.doc) for more details.\u00a0
systemrules.queryrecordbyidentifier.description=Executes a query on a given record identifier and returns the record data.  See the [documentation](links.docs.systemrules.queryrecordbyidentifier.doc) for guidance about when to use different querying methods and possible error codes.
systemrules.queryrecordbyidentifier.parameter.fields=Fields to be retrieved for the query. Use a list of record field or related record field references defined with the recordType\! domain. When this parameter is null, all record fields from the specified record type are returned.
systemrules.queryrecordbyidentifier.parameter.identifier=The identifier of the record to query. This is typically the primary key field.
systemrules.queryrecordbyidentifier.parameter.recordtype=A reference to a record type. You must reference the record type directly from the recordType\! domain. For example, recordType\!Case.
systemrules.queryrecordbyidentifier.parameter.relatedrecorddata=When selecting one-to-many related record data, use a\!relatedRecordData() to filter, sort, and limit the related record sets. See the [documentation](links.docs.systemrules.relatedrecorddata.doc) for more information.
systemrules.queryrecordtype.description=Executes a query on a given record type and returns the resulting data. See the [documentation](links.docs.systemrules.queryrecordtype.doc) for guidance about when to use different querying methods and possible error codes.
systemrules.queryrecordtype.parameter.fetchtotalcount=If set to true, runs the query that retrieves the total number of rows in the totalCount parameter of the resulting datasubset. In cases where you do not need the totalCount, skipping this additional query can improve performance. Default\: false. See the [documentation](links.docs.systemrules.queryrecordtype.doc) for more information. (Not applicable for process-backed or unsynced expression-backed record types)
systemrules.queryrecordtype.parameter.fields=Fields to be retrieved for the query. This parameter accepts different values depending on the type of query to run. When performing a selection, use a list of record field or related record field references defined with the recordType\! domain. When performing an aggregation, use a\!aggregationFields() to define the configuration for the aggregated fields.
systemrules.queryrecordtype.parameter.filters=A single logical expression or a list of query filters can be provided to apply additional filters to the record set. Queries also inherit the default filters defined on the referenced record type. Reference record fields or related record fields from the specified record type using the recordType\! domain. Record types sourced from a web service or other expression only support this parameter if the data is synced.
systemrules.queryrecordtype.parameter.paginginfo=The paging and sorting configurations to apply when retrieving the record data.
systemrules.queryrecordtype.parameter.recordtype=A reference to a Record Type, configured using the recordType\! domain. For example, recordType\!Case.
systemrules.queryrecordtype.parameter.relatedrecorddata=When selecting one-to-many related record data, use a\!relatedRecordData to filter, sort, and limit the related record sets. This parameter is not supported when performing an aggregation. See the [documentation](links.docs.systemrules.relatedrecorddata.doc) for more information.
systemrules.queryrecordtype_20r4.description=This is an older version of the a\!queryRecordType() function. You can continue to use this version of the function by its new name\: a\!queryRecordType_20r4(). The new version of a\!queryRecordType() has new functionality. Executes a query on a given record type and returns the record data. See the [documentation](links.docs.systemrules.queryrecordtype.doc) for guidance about when to use different querying methods and possible error codes.
systemrules.queryrecordtype_20r4.parameter.fetchtotalcount=If set to true, runs a separate query that retrieves the total number of records in the totalCount parameter of the query result. In cases where you do not need the totalCount, skipping this additional query can improve performance. Only applies to record types that source from a data store entity. Default\: false. See the [documentation](links.docs.systemrules.queryrecordtype.doc) for more information.
systemrules.queryrecordtype_20r4.parameter.filters=A single, logical expression or a list of query filters can be provided to filter the results. Without a logical expression, a list of query filters will only return those records where all filters evaluate to true (`AND` comparisons). Queries also apply the default filters defined on the referenced record type.
systemrules.queryrecordtype_20r4.parameter.paginginfo=The paging and sorting configurations to apply when retrieving the record data.
systemrules.queryrecordtype_20r4.parameter.recordtype=A reference to a record type. You must reference the record type directly from the `recordType\!` domain. For example, `recordType\!Case`.
systemrules.queryrecordtype_20r4.parameter.selection=List of record fields to be retrieved from the query. Record fields must be directly referenced from the recordType\! domain. For example, `recordType\!Case.fields.caseName`. When no record fields are specified, all record fields are returned in the order they are configured in the record type\u2019s data model.
systemrules.queryselection.description=Creates a Query Selection configuration for use with a\!query().
systemrules.queryselection.parameter.columns=Array of Query Columns indicating which fields to retreive, created with a\!queryColumn().
systemrules.radiobuttonfield.description=Displays a limited set of choices from which the user must select one item and saves a value based on the selected choice. See [documentation](links.docs.systemrules.radiobuttonfield.doc) for more details.
systemrules.radiobuttonfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.radiobuttonfield.parameter.choicelabels=Array of options for the user to select. When the data source is a record type, this is a record field or related record field.
systemrules.radiobuttonfield.parameter.choicelayout=Determines the layout. Valid values\: "STACKED" (default), "COMPACT".
systemrules.radiobuttonfield.parameter.choicestyle=Determines how the choices should be displayed on the interface. Valid values\: "STANDARD" (default), "CARDS".
systemrules.radiobuttonfield.parameter.choicevalues=Array of values associated with the corresponding choices. When the data source is a record type, this is a record field (usually the primary key field).
systemrules.radiobuttonfield.parameter.data=The record type used as the source of the component\u2019s choices. This can be specified with a record type reference or a\!recordData().
systemrules.radiobuttonfield.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.radiobuttonfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.radiobuttonfield.parameter.instructions=Supplemental text about this field.
systemrules.radiobuttonfield.parameter.label=Text to display as the field label.
systemrules.radiobuttonfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.radiobuttonfield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.radiobuttonfield.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.radiobuttonfield.parameter.saveinto=One or more variables that are updated with the choice value when the user changes the selection. Use a\!save() to save a modified or alternative value to a variable.
systemrules.radiobuttonfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.radiobuttonfield.parameter.sort=Array of Sort Info configurations created with a\!sortInfo().
systemrules.radiobuttonfield.parameter.spacing=Determines the space between the options. Valid values\: "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.radiobuttonfield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.radiobuttonfield.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.radiobuttonfield.parameter.value=Value of choice to display as selected.
systemrules.radiobuttonfield_23r3.description=Displays a limited set of choices from which the user must select one item and saves a value based on the selected choice. See [documentation](links.docs.systemrules.radiobuttonfield.doc) for more details.
systemrules.radiobuttonfield_23r3.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.radiobuttonfield_23r3.parameter.choicelabels=Array of options for the user to select.
systemrules.radiobuttonfield_23r3.parameter.choicelayout=Determines the layout. Valid values\: "STACKED" (default), "COMPACT".
systemrules.radiobuttonfield_23r3.parameter.choicestyle=Determines how the choices should be displayed on the interface. Valid values\: "STANDARD" (default), "CARDS".
systemrules.radiobuttonfield_23r3.parameter.choicevalues=Array of values associated with the available choices.
systemrules.radiobuttonfield_23r3.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.radiobuttonfield_23r3.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.radiobuttonfield_23r3.parameter.instructions=Supplemental text about this field.
systemrules.radiobuttonfield_23r3.parameter.label=Text to display as the field label.
systemrules.radiobuttonfield_23r3.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.radiobuttonfield_23r3.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.radiobuttonfield_23r3.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.radiobuttonfield_23r3.parameter.saveinto=One or more variables that are updated with the choice value when the user changes the selection. Use a\!save() to save a modified or alternative value to a variable.
systemrules.radiobuttonfield_23r3.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.radiobuttonfield_23r3.parameter.spacing=Determines the space between the options. Valid values\: "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.radiobuttonfield_23r3.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.radiobuttonfield_23r3.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.radiobuttonfield_23r3.parameter.value=Value of choice to display as selected.
systemrules.radiobuttonfieldbyindex.description=Displays a limited set of choices from which the user must select one item and saves the index of the selected choice.
systemrules.radiobuttonfieldbyindex.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.radiobuttonfieldbyindex.parameter.choicelabels=Array of options for the user to select.
systemrules.radiobuttonfieldbyindex.parameter.choicelayout=Determines the layout. Valid values\: "STACKED" (default), "COMPACT".
systemrules.radiobuttonfieldbyindex.parameter.choicestyle=Determines how the choices should be displayed on the interface. Valid values\: "STANDARD" (default), "CARDS".
systemrules.radiobuttonfieldbyindex.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.radiobuttonfieldbyindex.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.radiobuttonfieldbyindex.parameter.instructions=Supplemental text about this field.
systemrules.radiobuttonfieldbyindex.parameter.label=Text to display as the field label.
systemrules.radiobuttonfieldbyindex.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.radiobuttonfieldbyindex.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.radiobuttonfieldbyindex.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.radiobuttonfieldbyindex.parameter.saveinto=One or more variables that are updated with the choice index when the user changes the selection. Use a\!save() to save a modified or alternative value to a variable.
systemrules.radiobuttonfieldbyindex.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.radiobuttonfieldbyindex.parameter.spacing=Determines the space between the options. Valid values\: "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.radiobuttonfieldbyindex.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.radiobuttonfieldbyindex.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.radiobuttonfieldbyindex.parameter.value=Index of the choice to display as selected.
systemrules.reactivateuser.description=Reactivates a user. This function will only execute inside a saveInto or a Web API.
systemrules.reactivateuser.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.reactivateuser.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.reactivateuser.parameter.user=The user to reactivate.
systemrules.recordactionfield.description=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. See [documentation](links.docs.systemrules.recordactionfield.doc) for more details.
systemrules.recordactionfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.recordactionfield.parameter.actions=List of record action items to display in the field, configured using a\!recordActionItem().
systemrules.recordactionfield.parameter.align=Determines alignment of the actions. Valid values\: "START", "CENTER", "END".
systemrules.recordactionfield.parameter.display=Determines which details are shown for the actions, regardless of style. Valid values\: "LABEL_AND_ICON" (default), "LABEL", "ICON".
systemrules.recordactionfield.parameter.openactionsin=(Browser-only) Determines how actions should open to the user. Valid values\: "DIALOG" (default), "SAME_TAB", "NEW_TAB".
systemrules.recordactionfield.parameter.securityondemand=Determines when record action security is evaluated for "MENU" and "MENU_ICON" styled actions. By default (true), security is evaluated when the user clicks the record action. When false, security is evaluated when the interface loads.
systemrules.recordactionfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component, along with any record action items, is hidden and is not evaluated. Default\: true.
systemrules.recordactionfield.parameter.style=Determines how the list of actions should be displayed on the interface. Valid values\: "TOOLBAR" (default), "LINKS", "CARDS", "SIDEBAR", "CALL_TO_ACTION", "MENU", "MENU_ICON", "TOOLBAR_PRIMARY", "SIDEBAR_PRIMARY". See the [documentation](links.docs.systemrules.recordActionField.param.style.doc) for guidance on how to use different styles effectively.
systemrules.recordactionfield_23r3.description=This is an older version of the a\!recordActionField() function. You can continue to use this version by its new name\: a\!recordActionField_23r3(). The new version of a\!recordActionField() has new functionality.
systemrules.recordactionfield_23r3.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.recordactionfield_23r3.parameter.actions=List of record action items to display in the field, configured using a\!recordActionItem().
systemrules.recordactionfield_23r3.parameter.align=Determines alignment of the actions. Valid values\: "START", "CENTER", "END".
systemrules.recordactionfield_23r3.parameter.display=Determines which details are shown for the actions, regardless of style. Valid values\: "LABEL_AND_ICON" (default), "LABEL", "ICON".
systemrules.recordactionfield_23r3.parameter.openactionsin=(Browser-only) Determines how actions should open to the user. Valid values\: "DIALOG" (default), "SAME_TAB", "NEW_TAB".
systemrules.recordactionfield_23r3.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component, along with any record action items, is hidden and is not evaluated. Default\: true.
systemrules.recordactionfield_23r3.parameter.style=Determines how the list of actions should be displayed on the interface. Valid values\: "TOOLBAR" (default), "LINKS", "CARDS", "SIDEBAR", "CALL_TO_ACTION", "MENU", "MENU_ICON", "TOOLBAR_PRIMARY", "SIDEBAR_PRIMARY". See the [documentation](links.docs.systemrules.recordActionField.param.style.doc) for guidance on how to use different styles effectively.
systemrules.recordactionitem.description=Displays a record action defined within a record action field or read-only grid sourced from a record type. A record action is an end-user action configured within a record type object, such as a related action or a record list action.
systemrules.recordactionitem.parameter.action=A record action reference associated with a record type, configured using the recordType\! domain. For example, recordType\!Case.actions.editCase. This action will use the display name, process model, icon, context, and visibility set in the record type object.
systemrules.recordactionitem.parameter.identifier=Record instance identifier, which is required if the action parameter references a related action. The related action will not display if the identifier is null or invalid. No identifier is needed when the action parameter references a record list action.
systemrules.recorddata.description=References a set of records from a record type and allows for additional filtering if necessary.
systemrules.recorddata.parameter.filters=A single logical expression or a list of query filters, which are applied together with an AND operation, can be provided to apply additional filters to the record set. Queries also inherit the default filters defined on the referenced record type. When filtering, use only record fields or related record fields from the referenced record type. Record types sourced from a web service or other expression only support this parameter if the data is synced.
systemrules.recorddata.parameter.recordtype=A reference to a record type, configured using the recordType\! domain. For example, recordType\!Case.
systemrules.recorddata.parameter.relatedrecorddata=When selecting one-to-many related record data, use a\!relatedRecordData to filter, sort, and limit the related record sets. This parameter is not supported when performing an aggregation. See the [documentation](links.docs.systemrules.relatedrecorddata.doc) for more information.
systemrules.recordfilterchoices.description=Used to configure user filter choices for expression-backed records.
systemrules.recordfilterchoices.parameter.choicelabels=Array of labels for the user filter choices.
systemrules.recordfilterchoices.parameter.choicevalues=Array of values associated with the available choices.
systemrules.recordfilterdaterange.description=Creates a value of type Facet to define a date range user filter.
systemrules.recordfilterdaterange.parameter.defaultfrom=Determines the default start date, if any, for the date range filter.
systemrules.recordfilterdaterange.parameter.defaultto=Determines the default end date, if any, for the date range filter.
systemrules.recordfilterdaterange.parameter.field=The record field or related record field the filter will apply to.
systemrules.recordfilterdaterange.parameter.isvisible=Determines whether the filter is visible to the user. Default is true.
systemrules.recordfilterdaterange.parameter.name=Name of the date range user filter.
systemrules.recordfilterdaterange_20r2.description=This is an older version of the a\!recordFilterDateRange() function. You can continue to use this version of the function by its new name\: a\!recordFilterDateRange_20r2(). Use this version of the function when working with record types that have not yet been updated to use record type field references. Creates a value of type Facet used to define a date range user filter.
systemrules.recordfilterdaterange_20r2.parameter.defaultfrom=Determines the default start date, if any, for the date range filter.
systemrules.recordfilterdaterange_20r2.parameter.defaultto=Determines the default end date, if any, for the date range filter.
systemrules.recordfilterdaterange_20r2.parameter.field=Name of the field the date range filter will filter against.
systemrules.recordfilterdaterange_20r2.parameter.isvisible=Determines whether the filter is visible to the user at runtime. Default is true.
systemrules.recordfilterdaterange_20r2.parameter.name=Name of the date range user filter.
systemrules.recordfilterlist.description=Creates a list user filter to be used in a record list.
systemrules.recordfilterlist.parameter.allowmultipleselections=Determines if the filter will allow the user to select a single option or multiple options. Default is true.
systemrules.recordfilterlist.parameter.defaultoption=Determines which, if any, filter option is applied when a record list first loads.
systemrules.recordfilterlist.parameter.isvisible=Determines whether the filter is visible to the user at runtime. Default is true.
systemrules.recordfilterlist.parameter.name=Name of the user filter.
systemrules.recordfilterlist.parameter.options=Array of filter options created with a\!recordFilterListOption().
systemrules.recordfilterlistoption.description=Creates a filter option to be used in a list user filter.
systemrules.recordfilterlistoption.parameter.datacount=Number of items associated with the filter.
systemrules.recordfilterlistoption.parameter.filter=Filter to apply when the filter option is selected, created with a\!queryFilter().
systemrules.recordfilterlistoption.parameter.id=Integer identifier of the filter option. This must be unique across all other filter options within the same user filter.
systemrules.recordfilterlistoption.parameter.name=Display name of the filter option.
systemrules.recordgridfield.description=Displays a read-only grid with data from the record type. The grid can display data as read-only text, links, images, rich text, or other components supported in read-only grids. See [documentation](links.docs.systemrules.recordgridfield.doc) for more details.
systemrules.recordgridfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.recordgridfield.parameter.borderstyle=Determines the style of the grid border. Valid values\: "STANDARD" (default), "LIGHT".
systemrules.recordgridfield.parameter.columns=The columns to display in the grid, configured using a\!gridColumn().
systemrules.recordgridfield.parameter.emptygridmessage=Text to display in the grid when no data is available. Default is "No items available".
systemrules.recordgridfield.parameter.initialsorts=Sorts applied to the grid upon initial load only. The first sort in this list will be displayed to the user as an arrow in the header of the corresponding grid column (if applicable).
systemrules.recordgridfield.parameter.pagesize=The maximum number of rows to display in the grid. Default\: 50
systemrules.recordgridfield.parameter.rowheader=Index of the column to be used as the row header. Screen readers will announce the value in each row header when navigating to other cells within that row. Used only for accessibility; produces no visible change.
systemrules.recordgridfield.parameter.secondarysorts=Sorts applied to the data in the grid after every user sort interaction. No sorts in this list will be displayed to the user as an arrow in the header of a grid column. If your data is a reference to a record type sourced from processes, this parameter is not supported.
systemrules.recordgridfield.parameter.shadealternaterows=Determines whether alternate rows are shaded. Default\: true.
systemrules.recordgridfield.parameter.spacing=Determines the spacing within grid cells. Valid values\: "STANDARD" (web default), "DENSE" (mobile default).
systemrules.recordlink.description=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.
systemrules.recordlink.parameter.dashboard=The URL stub for the record view that the link will open. Default is "summary". Go to the record type and click Views to find the URL stub for each record view.
systemrules.recordlink.parameter.identifier=The identifier of the record. This is typically the primary key field.
systemrules.recordlink.parameter.label=Link text that users click to open the link.
systemrules.recordlink.parameter.openlinkin=Determines how the record link should open, either in the same tab or a new tab. Valid values\: "SAME_TAB" (default) or "NEW_TAB". This parameter only applies to web browsers.
systemrules.recordlink.parameter.recordtype=The reference to the record type. Reference the record type using the recordType\! domain or a constant that points to a record type.
systemrules.recordlink.parameter.showwhen=Determines whether the link is displayed in the component. When set to false, the link is hidden and is not evaluated. Default\: true.
systemrules.recordlink.parameter.targetlocation=Determines where the record view should open, which can be either the page the user is on or a specific site page. To reference a site page, use the following structure\: site\![site name].pages.[page web address identifier]. Valid values\: "SAME_PAGE" (default) or a reference to a site page.
systemrules.recordnewsfield.description=Creates a Record News Field component.
systemrules.recordnewsfield.parameter.identifier=Unique identifier for the record, either the primary key (entity-backed), the process ID (process-backed), or the ID in the DataSubset\u2019s "identifiers" field (service-backed).
systemrules.recordnewsfield.parameter.instructions=Supplemental text about this field.
systemrules.recordnewsfield.parameter.label=Text to display as the field label.
systemrules.recordnewsfield.parameter.recordtype=Record type of the record.
systemrules.recordschatfield.description=Chat about a record using natural language.
systemrules.recordschatfield.parameter.buttonstyle=Determines the style of the chat send button. Valid values\: "NORMAL" Displays the label and border in the accent color. "PRIMARY" (Default) Displays the label in white on an accent color background."LINK" Displays the label in the accent color and has no border until focused.
systemrules.recordschatfield.parameter.fields=The record type\u2019s fields to be sent to the chatbot. Use a list of record field or related record field references defined with the recordType\! domain. When this parameter is null, all record fields from the specified record type are returned.
systemrules.recordschatfield.parameter.height=Determines the layout height. Valid values\: "SHORT", "MEDIUM", "TALL", "AUTO" (default).
systemrules.recordschatfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.recordschatfield.parameter.identifier=The record ID (identifier) identifies the individual record within the record type.
systemrules.recordschatfield.parameter.initialmessage=Initial message shown to the user from the chatbot. This will be the beginning of the chat conversation.
systemrules.recordschatfield.parameter.instructions=Supplemental text about this field.
systemrules.recordschatfield.parameter.label=Text to display as the field label.
systemrules.recordschatfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "COLLAPSED".
systemrules.recordschatfield.parameter.recordtype=A reference to a record type. You must reference the record type directly from the recordType\! domain. For example, recordType\!Case.
systemrules.recordschatfield.parameter.relatedrecorddata=When selecting one-to-many related record data, use a\!relatedRecordData() to filter, sort, and limit the related record sets. The maximum number is 100.
systemrules.recordschatfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.recordschatfield.parameter.suggestedquestions=Displays up to three questions the user can choose from when first interacting with the chatbot.
systemrules.recordtype.description=Returns a Record Type with the given uuid and an id of -1.
systemrules.recordtype.parameter.typeuuid=The uuid of the desired record type.
systemrules.relatedrecorddata.description=References a one-to-many relationship defined on a record type and allows for additional filtering, sorting, and limiting of the related record set.
systemrules.relatedrecorddata.parameter.filters=A single logical expression or a list of query filters, which are applied together with an AND operation, can be provided to apply additional filters to the related record set.  When defining fields to filter on, reference record fields or related record fields directly from the related record type. For example, filter on the field recordType\!Employee.fields.status when "relationship" is recordType\!Department.relationships.employees. Queries also inherit the default filters defined on the referenced record type. You may only filter on fields from the referenced related record type.
systemrules.relatedrecorddata.parameter.limit=Number of related records to return. If you\u2019re using this function in a\!queryRecordType() or in a records-powered component, the maximum number is 10. If you\u2019re using this function in a\!queryRecordByIdentifier(), the maximum number is 100.
systemrules.relatedrecorddata.parameter.relationship=A reference to a one-to-many record type relationship, configured using the recordType\! domain. For example, recordType\!Department.relationships.employees.
systemrules.relatedrecorddata.parameter.sort=Array of Sort Info configurations created with a\!sortInfo(). When defining the field to sort on, reference a record field or related record field directly from the related record type. For example, sort on the field recordType\!Employee.fields.status when "relationship" is recordType\!Department.relationships.employees.
systemrules.removegroupadmins.description=Removes administrators from a group. This function will only execute inside a saveInto or a Web API.
systemrules.removegroupadmins.parameter.administratorstoremove=The users that will be removed as administrators.
systemrules.removegroupadmins.parameter.group=The selected users will be removed as administrators of this group.
systemrules.removegroupadmins.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.removegroupadmins.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.removegroupmembers.description=Removes members from a group. This function will only execute inside a saveInto or a Web API.
systemrules.removegroupmembers.parameter.group=The selected users will be removed as members of this group.
systemrules.removegroupmembers.parameter.members=The users that will be removed as members.
systemrules.removegroupmembers.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.removegroupmembers.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.renameusers.description=Renames existing users. This function will only execute inside a saveInto or a Web API. Note that during a bulk rename, if any one username change fails, the expression will fail and none of the given usernames will be changed.
systemrules.renameusers.parameter.newusernames=The new username of the user.
systemrules.renameusers.parameter.oldusernames=The current username of the user.
systemrules.renameusers.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.renameusers.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.reportlink.description=Defines a link to a report. Links can be used in charts, grids, hierarchy browsers, images, link fields, milestones, pickers, and rich text.
systemrules.reportlink.parameter.label=Text associated with this link.
systemrules.reportlink.parameter.openlinkin=(Browser-only) Determines where the linked content should open. Valid values\: "SAME_TAB" (default), "NEW_TAB".
systemrules.reportlink.parameter.report=The linked report.
systemrules.reportlink.parameter.showwhen=Determines whether the link is displayed in the component. When set to false, the link is hidden and is not evaluated. Default\: true.
systemrules.richtextbulletedlist.description=Displays a bulleted list within a rich text component.
systemrules.richtextbulletedlist.parameter.items=Array of text to display as a bulleted list. Text can be further formatted using a\!richTextItem() or a\!richTextHeader(). Nested lists can be created using a\!richTextListItem().
systemrules.richtextbulletedlist.parameter.showwhen=Determines whether the list is displayed in the component. When set to false, the list is hidden and is not evaluated. Default\: true.
systemrules.richtextdisplayfield.description=Displays text in variety of styles, including bold, italics, underline, links, headers, and numbered and bulleted lists. See [documentation](links.docs.systemrules.richtextdisplayfield.doc) for more details.
systemrules.richtextdisplayfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.richtextdisplayfield.parameter.align=Determines alignment of the text value. Valid values\: "LEFT", "CENTER", "RIGHT". Does not apply to lists.
systemrules.richtextdisplayfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.richtextdisplayfield.parameter.instructions=Supplemental text about this field.
systemrules.richtextdisplayfield.parameter.label=Text to display as the field label.
systemrules.richtextdisplayfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.richtextdisplayfield.parameter.marginabove=Determines how much space is added above the field. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.richtextdisplayfield.parameter.marginbelow=Determines how much space is added below the field. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.richtextdisplayfield.parameter.preventwrapping=Determines if wrapping to multiple lines will be prevented. When set to true, each header, paragraph, or list item will truncate to a single line. Default\: false.
systemrules.richtextdisplayfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.richtextdisplayfield.parameter.tooltip=Text to display on mouseover (web) or long press (mobile).
systemrules.richtextdisplayfield.parameter.value=Array of rich text to display. Create rich text using a combination of text, a\!richTextItem(), a\!richTextHeader(), a\!richTextImage(), a\!richTextIcon(), a\!richTextBulletedList(), or a\!richTextNumberedList(). Example\: {"Hello ", a\!richTextItem(text\: "World", style\: "STRONG"), "\!"}.
systemrules.richtextheader.description=Displays a header within a rich text component.
systemrules.richtextheader.parameter.link=Link to apply to the text. 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(). If more than one link is provided, only the first will be used.
systemrules.richtextheader.parameter.linkstyle=Determines how the link renders. Valid values\: "INLINE" (default), "STANDALONE".
systemrules.richtextheader.parameter.showwhen=Determines whether the rich text header is displayed in the component. When set to false, the rich text header is hidden and is not evaluated. Default\: true.
systemrules.richtextheader.parameter.size=Determines the header size. Valid values\: "SMALL", "MEDIUM" (default), "LARGE".
systemrules.richtextheader.parameter.text=Array of text to display as a rich text header.
systemrules.richtexticon.description=Displays an icon for use in rich text.
systemrules.richtexticon.parameter.alttext=Equivalent alternate text to display when accessibility or browser compatibility issues prevent the icon from displaying.
systemrules.richtexticon.parameter.caption=Text to display in mouseovers.
systemrules.richtexticon.parameter.color=Determines the icon color. Valid values\: Any valid hex color or "STANDARD" (default), "ACCENT", "POSITIVE", "NEGATIVE", "SECONDARY".
systemrules.richtexticon.parameter.icon=Icon to display. See the [documentation](links.docs.systemrules.richTextIcon.parameter.icon.doc) for available icons.
systemrules.richtexticon.parameter.link=Link that determines the behavior of the icon when clicked. Create links with a\!authorizationLink(), a\!documentDownloadLink(), a\!dynamicLink(), a\!newsEntryLink(), a\!processTaskLink(), a\!recordLink(), a\!userRecordLink(), a\!reportLink(), a\!safeLink(), a\!startProcessLink(), or a\!submitLink(). If more than one link is provided, only the first will be used.
systemrules.richtexticon.parameter.linkstyle=Determines how the link renders. Valid values\: "INLINE" (default), "STANDALONE".
systemrules.richtexticon.parameter.showwhen=Determines whether the icon is displayed in the component. When set to false, the icon is hidden and is not evaluated. Default\: true.
systemrules.richtexticon.parameter.size=Determines the icon size. Valid values\: "SMALL", "STANDARD" (default), "MEDIUM", "MEDIUM_PLUS", "LARGE", "LARGE_PLUS", "EXTRA_LARGE".
systemrules.richtextimage.description=Displays an icon-sized image within a rich text component.
systemrules.richtextimage.parameter.image=Image to display, created with a\!documentImage(), a\!userImage(), or a\!webImage().
systemrules.richtextimage.parameter.showwhen=Determines whether the image is displayed in the component. When set to false, the image is hidden and is not evaluated. Default\: true.
systemrules.richtextitem.description=Displays styled text within a rich text component.
systemrules.richtextitem.parameter.color=Determines the text color. Valid values\: Any valid hex color or "STANDARD" (default), "ACCENT", "POSITIVE", "NEGATIVE", "SECONDARY".
systemrules.richtextitem.parameter.link=Link to apply to the text. 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(). If more than one link is provided, only the first will be used.
systemrules.richtextitem.parameter.linkstyle=Determines how the link renders. Valid values\: "INLINE" (default), "STANDALONE".
systemrules.richtextitem.parameter.showwhen=Determines whether the rich text is displayed in the component. When set to false, the rich text is hidden and is not evaluated. Default\: true.
systemrules.richtextitem.parameter.size=Determines the text size. Valid values\: "SMALL", "STANDARD" (default), "MEDIUM", "MEDIUM_PLUS", "LARGE", "LARGE_PLUS", "EXTRA_LARGE".
systemrules.richtextitem.parameter.style=Determines the text style. Multiple styles may be applied. Valid values\: "PLAIN" (default), "EMPHASIS", "STRONG", "UNDERLINE".
systemrules.richtextitem.parameter.text=Array of text to display as a rich text item. Text can be further formatted using a\!richTextItem().
systemrules.richtextitem_18r1.description=This is an older version of the a\!richTextItem function. You can continue to use this version of the function by its new name\: a\!richTextItem_18r1. The new version of a\!richTextItem has new functionality. Displays styled text within a rich text component.
systemrules.richtextitem_18r1.parameter.link=Link to apply to the text. 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().
systemrules.richtextitem_18r1.parameter.linkstyle=Determines how the link renders. Valid values\: "INLINE" (default), "STANDALONE".
systemrules.richtextitem_18r1.parameter.showwhen=Determines whether the rich text is displayed in the component. When set to false, the rich text is hidden and is not evaluated. Default\: true.
systemrules.richtextitem_18r1.parameter.style=Determines the style to apply to the text value. Valid values\: "NORMAL" (default), "EMPHASIS", "STRONG", "UNDERLINE", "LARGE", "MEDIUM", "SMALL", "HEADER_LARGE", "HEADER_MEDIUM", "HEADER_SMALL", "POSITIVE", "NEGATIVE", "SECONDARY".
systemrules.richtextitem_18r1.parameter.text=Array of text to display as a rich text item. Text can be further formatted using a\!richTextItem().
systemrules.richtextlistitem.description=Displays a nested list within a bulleted or numbered list in a rich text component.
systemrules.richtextlistitem.parameter.nestedlist=A bulleted or numbered list to nest within the rich text list item.
systemrules.richtextlistitem.parameter.showwhen=Determines whether the list item is displayed in the component. When set to false, the list item is hidden and is not evaluated. Default\: true.
systemrules.richtextlistitem.parameter.text=Array of text to display as a rich text list item. Text can be formatted using a\!richTextItem().
systemrules.richtextnumberedlist.description=Displays a numbered list within a rich text component.
systemrules.richtextnumberedlist.parameter.items=Array of text to display as a numbered list. Text can be further formatted using a\!richTextItem() or a\!richTextHeader(). Nested lists can be created using a\!richTextListItem().
systemrules.richtextnumberedlist.parameter.showwhen=Determines whether the list is displayed in the component. When set to false, the list is hidden and is not evaluated. Default\: true.
systemrules.safelink.description=Defines a link to a web page. Links can be used in charts, grids, hierarchy browsers, images, link fields, milestones, pickers, and rich text.
systemrules.safelink.parameter.label=Text associated with this link.
systemrules.safelink.parameter.openlinkin=(Browser-only) Determines where the linked content should open. Valid values\: "SAME_TAB", "NEW_TAB" (default).
systemrules.safelink.parameter.showwhen=Determines whether the link is displayed in the component. When set to false, the link is hidden and is not evaluated. Default\: true.
systemrules.safelink.parameter.uri=URI destination of this link.
systemrules.sapbapiparameters.description=[Deprecated - use an HTTP Connected System instead] Lists the parameters required to call the given SAP BAPI.
systemrules.sapbapiparameters.parameter.bapi=The name of the SAP BAPI to for which the parameters will be listed.
systemrules.sapbapiparameters.parameter.clientnumber=The SAP client number used to access the system.
systemrules.sapbapiparameters.parameter.connectionproperties=The connection properties to use when creating the connection to the SAP instance, given as a dictionary. The dictionary fields are the camel-cased names of the properties with \u2019.\u2019s removed, and the values are the properties values to use.
systemrules.sapbapiparameters.parameter.hostname=The hostname of the SAP server.
systemrules.sapbapiparameters.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.sapbapiparameters.parameter.systemnumber=The system number of the SAP application server.
systemrules.sapbapiparameters.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.sapinvoke.description=[Deprecated - use an HTTP Connected System instead] Invokes an SAP BAPI function. This function should be used for reads only. Use a\!sapInvokeWithCommit to write to SAP.
systemrules.sapinvoke.parameter.bapi=The name of the SAP BAPI function to invoke.
systemrules.sapinvoke.parameter.clientnumber=The SAP client number used to access the system.
systemrules.sapinvoke.parameter.connectionproperties=The connection properties to use when creating the connection to the SAP instance, given as a dictionary. The dictionary fields are the camel-cased names of the properties with \u2019.\u2019s removed, and the values are the properties values to use.
systemrules.sapinvoke.parameter.hostname=The hostname of the SAP server.
systemrules.sapinvoke.parameter.importparameters=The import parameters to send to the BAPI function, given as a dictionary.
systemrules.sapinvoke.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.sapinvoke.parameter.systemnumber=The system number of the SAP application server.
systemrules.sapinvoke.parameter.tableparameters=The table parameters to send to the BAPI function, given as a dictionary.
systemrules.sapinvoke.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.sapinvokewithcommit.description=[Deprecated - use an HTTP Connected System instead] The a\!sapInvokeWithCommit function invokes the given BAPI for the purpose of writing data. This function will only execute inside a saveInto or a Web API.
systemrules.sapinvokewithcommit.parameter.bapi=The name of the SAP BAPI to for which the parameters will be listed.
systemrules.sapinvokewithcommit.parameter.clientnumber=The SAP client number used to access the system.
systemrules.sapinvokewithcommit.parameter.committransaction=Flag indicating if a commit transaction should be automatically executed at the end.
systemrules.sapinvokewithcommit.parameter.connectionproperties=The connection properties to use when creating the connection to the SAP instance, given as a dictionary. The dictionary fields are the camel-cased names of the properties with \u2019.\u2019s removed, and the values are the properties values to use.
systemrules.sapinvokewithcommit.parameter.hostname=The hostname of the SAP server.
systemrules.sapinvokewithcommit.parameter.importparameters=The import parameters to send to the BAPI function, given as a dictionary.
systemrules.sapinvokewithcommit.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse(). Error details are available in the function variables fv\!errorTitle and fv\!errorMessage.
systemrules.sapinvokewithcommit.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). Result details are available in the function variable fv\!result.
systemrules.sapinvokewithcommit.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.sapinvokewithcommit.parameter.systemnumber=The system number of the SAP application server.
systemrules.sapinvokewithcommit.parameter.tableparameters=The table parameters to send to the BAPI function, given as a dictionary.
systemrules.sapinvokewithcommit.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.sapinvokewriter.description=[Deprecated - use a\!sapInvokeWithCommit instead] Invokes an SAP BAPI function. This function returns a writer and must be used with the bind() function.
systemrules.sapinvokewriter.parameter.bapi=The name of the SAP BAPI function to invoke.
systemrules.sapinvokewriter.parameter.clientnumber=The SAP client number used to access the system.
systemrules.sapinvokewriter.parameter.connectionproperties=The connection properties to use when creating the connection to the SAP instance, given as a dictionary. The dictionary fields are the camel-cased names of the properties with \u2019.\u2019s removed, and the values are the properties values to use.
systemrules.sapinvokewriter.parameter.hostname=The hostname of the SAP server.
systemrules.sapinvokewriter.parameter.importparameters=The import parameters to send to the BAPI function, given as a dictionary.
systemrules.sapinvokewriter.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.sapinvokewriter.parameter.systemnumber=The system number of the SAP application server.
systemrules.sapinvokewriter.parameter.tableparameters=The table parameters to send to the BAPI function, given as a dictionary.
systemrules.sapinvokewriter.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.sblcreate.description=[Deprecated - use an HTTP Connected System instead] Creates a new record in Siebel. This function returns a writer and must be used with the bind() function.
systemrules.sblcreate.parameter.appmanager=The active application manager of the target system.
systemrules.sblcreate.parameter.enterpriseapp=The enterprise application of the target system.
systemrules.sblcreate.parameter.fieldvalues=The field values of the new record to create, given as a dictionary with the field names based on the fields of the Business Object and values set to the desired new field values.
systemrules.sblcreate.parameter.hostname=The hostname of the Siebel server.
systemrules.sblcreate.parameter.language=The target system language.
systemrules.sblcreate.parameter.parameters=The record to create, given as a dictionary with the field structure of the Siebel Business Component and Business Object to create.
systemrules.sblcreate.parameter.port=The port the Siebel server is listening on.
systemrules.sblcreate.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.sblcreate.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.sbldelete.description=[Deprecated - use an HTTP Connected System instead] Deletes a record from Siebel. This function returns a writer and must be used with the bind() function.
systemrules.sbldelete.parameter.appmanager=The active application manager of the target system.
systemrules.sbldelete.parameter.enterpriseapp=The enterprise application of the target system.
systemrules.sbldelete.parameter.hostname=The hostname of the Siebel server.
systemrules.sbldelete.parameter.language=The target system language.
systemrules.sbldelete.parameter.parameters=The record to delete, given as a dictionary with the field structure of the Siebel Business Component and Business Object to delete.
systemrules.sbldelete.parameter.port=The port the Siebel server is listening on.
systemrules.sbldelete.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.sbldelete.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.sblinvoke.description=[Deprecated - use an HTTP Connected System instead] Invokes a method in the Siebel Business Service. This function should be used for reads only. Use a\!sblInvokeWriter to write to Siebel.
systemrules.sblinvoke.parameter.appmanager=The active application manager of the target system.
systemrules.sblinvoke.parameter.businessservice=The name of the Siebel Business Service on which to invoke the method.
systemrules.sblinvoke.parameter.enterpriseapp=The enterprise application of the target system.
systemrules.sblinvoke.parameter.hostname=The hostname of the Siebel server.
systemrules.sblinvoke.parameter.language=The target system language.
systemrules.sblinvoke.parameter.method=The name of the method to invoke.
systemrules.sblinvoke.parameter.parameters=The input parameters for the method, given as a dictionary.
systemrules.sblinvoke.parameter.port=The port the Siebel server is listening on.
systemrules.sblinvoke.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.sblinvoke.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.sblinvokewriter.description=[Deprecated - use an HTTP Connected System instead] Invokes a method in the Siebel Business Service. This function returns a writer and must be used with the bind() function.
systemrules.sblinvokewriter.parameter.appmanager=The active application manager of the target system.
systemrules.sblinvokewriter.parameter.businessservice=The name of the Siebel Business Service on which to invoke the method.
systemrules.sblinvokewriter.parameter.enterpriseapp=The enterprise application of the target system.
systemrules.sblinvokewriter.parameter.hostname=The hostname of the Siebel server.
systemrules.sblinvokewriter.parameter.language=The target system language.
systemrules.sblinvokewriter.parameter.method=The name of the method to invoke.
systemrules.sblinvokewriter.parameter.parameters=The input parameters for the method, given as a dictionary.
systemrules.sblinvokewriter.parameter.port=The port the Siebel server is listening on.
systemrules.sblinvokewriter.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.sblinvokewriter.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.sblquery.description=[Deprecated - use an HTTP Connected System instead] Retrieves records from Siebel.
systemrules.sblquery.parameter.appmanager=The active application manager of the target system.
systemrules.sblquery.parameter.enterpriseapp=The enterprise application of the target system.
systemrules.sblquery.parameter.hostname=The hostname of the Siebel server.
systemrules.sblquery.parameter.language=The target system language.
systemrules.sblquery.parameter.parameters=The records to query, given as a dictionary with the field structure of the Siebel Business Component and Business Object.
systemrules.sblquery.parameter.port=The port the Siebel server is listening on.
systemrules.sblquery.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.sblquery.parameter.sort=The sort order to apply to the query, given as a dictionary with field names based on the fields of the Business Object. Valid values\: "ASCENDING" or "DESCENDING".
systemrules.sblquery.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.sblupdatefieldvalue.description=[Deprecated - use an HTTP Connected System instead] Set the field values of a record in Siebel. This function returns a writer and must be used with the bind() function.
systemrules.sblupdatefieldvalue.parameter.appmanager=The active application manager of the target system.
systemrules.sblupdatefieldvalue.parameter.enterpriseapp=The enterprise application of the target system.
systemrules.sblupdatefieldvalue.parameter.fieldvalues=The field values of the new record to update, given as a dictionary with the field names based on the fields of the Business Object and values set to the desired new field values.
systemrules.sblupdatefieldvalue.parameter.hostname=The hostname of the Siebel server.
systemrules.sblupdatefieldvalue.parameter.language=The target system language.
systemrules.sblupdatefieldvalue.parameter.parameters=The record on which the values will be set, given as a dictionary with the field structure of the Siebel Business Component and Business Object to create. The dictionary should contain an Id field with the value of identifier of the record to update.
systemrules.sblupdatefieldvalue.parameter.port=The port the Siebel server is listening on.
systemrules.sblupdatefieldvalue.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.sblupdatefieldvalue.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.scatterchartfield.description=Displays numerical data as coordinates. Use a scatter chart to display values for two variables for a set of data.See [documentation](links.docs.systemrules.scatterchartfield.doc) for more details.
systemrules.scatterchartfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.scatterchartfield.parameter.allowdecimalaxislabels=Allows values to display as decimal numbers instead of integers. Default\: false.
systemrules.scatterchartfield.parameter.allowimagedownload=Determines if the chart download button displays on the chart. Default\: false.
systemrules.scatterchartfield.parameter.colorscheme=Determines which color scheme to use in the chart. Use one of the following valid values\: "CLASSIC" (default), "MIDNIGHT", "OCEAN", "MOSS", "BERRY", "PARACHUTE", "RAINFOREST", "SUNSET" or define a custom color scheme using a\!colorSchemeCustom. See the [documentation](links.docs.systemrules.charts.param.colorScheme) for guidance on how to use color schemes.
systemrules.scatterchartfield.parameter.data=Reference to the record type used for the source of this chart. Can accept a\!recordData or a Record Type Reference.
systemrules.scatterchartfield.parameter.datalimit=Maximum number of data points to display on the chart. Default\: 5000. Valid values\: 1-5000.
systemrules.scatterchartfield.parameter.height=Determines the chart height. Valid values\: "MICRO", "SHORT", "MEDIUM", "TALL", "AUTO" (default). See the [documentation](links.docs.systemrules.charts.param.height) for guidance on using the MICRO size.
systemrules.scatterchartfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.scatterchartfield.parameter.instructions=Supplemental text about this field.
systemrules.scatterchartfield.parameter.label=Text to display as the field label.
systemrules.scatterchartfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.scatterchartfield.parameter.link=Link to execute when a user selects a data point on the chart. Use fv\!selection to pass context from the selection made on the chart to the link. Create a link using a\!dynamicLink().
systemrules.scatterchartfield.parameter.primarygrouping=Defines the field labels to display on the points in the chart. Configured using a\!grouping().
systemrules.scatterchartfield.parameter.referencelines=Array of reference line values for each threshold to be defined on the chart. Configured using a\!chartReferenceLine().
systemrules.scatterchartfield.parameter.refreshafter=Refreshes chart data each time a specified event completes. Valid values\: "RECORD_ACTION".
systemrules.scatterchartfield.parameter.refreshalways=When true, chart data will be refreshed after each user interaction and each interval refresh. Default\: false.
systemrules.scatterchartfield.parameter.refreshinterval=How often chart data gets refreshed in minutes. When null, chart data will not be refreshed on an interval. Valid values\: 0.5, 1, 2, 3, 4, 5, 10, 30, 60.
systemrules.scatterchartfield.parameter.refreshonreferencedvarchange=When true, chart data will be refreshed each time the value of any variable referenced in the data parameter is updated. To refresh chart data when another variable that is not used within the data parameter, use refreshOnVarChange. Default\: true.
systemrules.scatterchartfield.parameter.refreshonvarchange=Refreshes the chart data each time any of these specific variables change. This allows you to refresh the chart data when a variable that is not referenced in the data parameter is updated. You can define either using a single variable (e.g. refreshOnVarChange\: local\!var1) or a list of variables (e.g. refreshOnVarChange\: {local\!var1, local\!var2}).
systemrules.scatterchartfield.parameter.secondarygrouping=Defines the field labels to display in the legend and tooltips in the chart. Configured using a\!grouping().
systemrules.scatterchartfield.parameter.showdatalabels=Determines if data values are displayed next to each point. Default\: false.
systemrules.scatterchartfield.parameter.showlegend=When a secondary grouping is used, determines if a color legend displays below the chart. Default\: true.
systemrules.scatterchartfield.parameter.showtooltips=Determines if a tooltip displays the data value for a point. Default\: true.
systemrules.scatterchartfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.scatterchartfield.parameter.sort=Use a\!sortInfo() to define a sort in ascending or descending order. Use the alias of any groupings or measures to sort by the values in the chart. Use a record field or related record field reference to sort by data that is not referenced in the chart.
systemrules.scatterchartfield.parameter.xaxismax=Determines the maximum displayed point on the horizontal axis.
systemrules.scatterchartfield.parameter.xaxismeasure=Defines the numerical calculations for the x-axis of the chart. Configured using a\!measure().
systemrules.scatterchartfield.parameter.xaxismin=Determines the minimum displayed point on the horizontal axis.
systemrules.scatterchartfield.parameter.xaxisstyle=Determines how to display the labels and axis separators for the X-Axis. Valid values\: "STANDARD" (default), "NONE".
systemrules.scatterchartfield.parameter.xaxistitle=Title for the horizontal axis.
systemrules.scatterchartfield.parameter.yaxismax=Determines the maximum displayed point on the vertical axis.
systemrules.scatterchartfield.parameter.yaxismeasure=Defines the numerical calculations for the y-axis of the chart. Configured using a\!measure().
systemrules.scatterchartfield.parameter.yaxismin=Determines the minimum displayed point on the vertical axis.
systemrules.scatterchartfield.parameter.yaxisstyle=Determines how to display the labels, axis separators, and grid lines for the Y-Axis. Valid values\: "STANDARD" (default), "MINIMAL", "NONE".
systemrules.scatterchartfield.parameter.yaxistitle=Title for the vertical axis.
systemrules.scsfield.description=Creates an object which contains the information required to access data in the Secure Credentials Store.
systemrules.scsfield.parameter.externalsystemkey=The key of the corresponding external system in the Third Party Credentials admin console page.
systemrules.scsfield.parameter.fieldkey=The key for the field which stores the requested data.
systemrules.scsfield.parameter.useperuser=If true, the current user\u2019s credentials for the third party system will be used. If false, the system-wide credentials for the third party system will be used. Default\: false.
systemrules.sectionlayout.description=Displays any arrangement of layouts and components beneath a section title on an interface. See [documentation](links.docs.systemrules.sectionlayout.doc) for more details.
systemrules.sectionlayout.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.sectionlayout.parameter.contents=Components and layouts to display in the section body.
systemrules.sectionlayout.parameter.divider=Determines where a divider appears within the section. Valid values\: "NONE" (default), "ABOVE", "BELOW".
systemrules.sectionlayout.parameter.dividercolor=Determines the divider line color. Valid values\: Any valid hex color or "SECONDARY" (default), "STANDARD", "ACCENT".
systemrules.sectionlayout.parameter.dividerweight=Determines the divider line thickness. Valid values\: "THIN" (default), "MEDIUM", "THICK".
systemrules.sectionlayout.parameter.iconalttext=Equivalent alternate text for use by screen readers.
systemrules.sectionlayout.parameter.iscollapsible=Determines if an expand/collapse control appears in the section label. Default is false.
systemrules.sectionlayout.parameter.isinitiallycollapsed=Determines if the section is collapsed when the interface first loads. Default is false.
systemrules.sectionlayout.parameter.label=Text to display as the section\u2019s title.
systemrules.sectionlayout.parameter.labelcolor=Determines the label color. Valid values\: Any valid hex color or "ACCENT" (default), "STANDARD", "POSITIVE", "NEGATIVE", "SECONDARY".
systemrules.sectionlayout.parameter.labelheadinglevel=Determines the heading level tag associated with the section label for use by screenreaders. Valid values\: "h1", "h2", "h3", "h4", "h5", "h6". The default is dependent on the chosen label size. See [documentation](links.docs.systemrules.shared.accessibility.header) for more details to associate the proper heading level with the section label to follow accessibility standards.
systemrules.sectionlayout.parameter.labelheadingtag=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 [documentation](links.docs.systemrules.shared.accessibility.header) for more details to associate the proper heading tag with the section label to follow accessibility standards.
systemrules.sectionlayout.parameter.labelicon=Icon to display next to the label. See the [documentation](links.docs.systemrules.richTextIcon.parameter.icon.doc) for available icons.
systemrules.sectionlayout.parameter.labelsize=Determines the label size. Valid values\: "LARGE_PLUS", "LARGE", "MEDIUM_PLUS", "MEDIUM" (default), "SMALL", "EXTRA_SMALL".
systemrules.sectionlayout.parameter.marginabove=Determines how much space is added above the layout. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.sectionlayout.parameter.marginbelow=Determines how much space is added below the layout. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.sectionlayout.parameter.showwhen=Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default\: true.
systemrules.sectionlayout.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.sectionlayout.parameter.validations=Validation errors to display above the section.
systemrules.sectionlayout_17r1.description=This is an older version of the a\!sectionLayout function. You can continue to use this version of the function by its new name\: a\!sectionLayout_17r1. The new version of a\!sectionLayout has new functionality. Displays one or two columns of related components beneath a section title on an interface.
systemrules.sectionlayout_17r1.parameter.firstcolumncontents=Array of components to display in the section\u2019s first column.
systemrules.sectionlayout_17r1.parameter.iscollapsible=Determines if an expand/collapse control appears in the section label. Default is false.
systemrules.sectionlayout_17r1.parameter.isinitiallycollapsed=Determines if the section is collapsed when the interface first loads. Default is false.
systemrules.sectionlayout_17r1.parameter.label=Text to display as the section\u2019s title.
systemrules.sectionlayout_17r1.parameter.secondcolumncontents=Array of components to display in the section\u2019s second column.
systemrules.sectionlayout_17r1.parameter.showwhen=Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default\: true.
systemrules.sectionlayout_17r1.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.sectionlayout_17r1.parameter.validations=Validation errors to display above the section.
systemrules.sectionlayoutcolumns.description=This function has been deprecated. Use a\!sectionLayout instead. See the documentation for a\!sectionLayout to learn about this function. Displays one or two columns of related components beneath a section title on an interface. Use this when you are defining columns using a rule that is may be used in other layouts or if you are displaying empty columns.
systemrules.sectionlayoutcolumns.parameter.columns=Array of columns to display in the section, created with a\!columnLayout().
systemrules.sectionlayoutcolumns.parameter.label=Text to display as the section\u2019s title.
systemrules.sectionlayoutcolumns.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.sectionlayoutcolumns.parameter.validations=Validation errors to display above the section.
systemrules.sendpushnotification.description=Send a push notification to recipients.
systemrules.sendpushnotification.parameter.body=The message to display below the title, truncated starting at 140 characters on some devices.
systemrules.sendpushnotification.parameter.link=The link to open when the user taps on the notification. Create links with a\!newsEntryLink(), a\!processTaskLink(), a\!recordLink(), a\!reportLink(), or a\!userRecordLink().
systemrules.sendpushnotification.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.sendpushnotification.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.sendpushnotification.parameter.recipients=Recipients of the push notification. If a user is included multiple times, they receive a single notification.
systemrules.sendpushnotification.parameter.title=The title to display in the notification, truncated starting at 49 characters on some devices.
systemrules.setgroupattributes.description=Sets attributes on a group. This function will only execute inside a saveInto or a Web API.
systemrules.setgroupattributes.parameter.attributes=The attributes to set on the group.
systemrules.setgroupattributes.parameter.group=The group whose attributes will be set.
systemrules.setgroupattributes.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.setgroupattributes.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.sfcdelete.description=[Deprecated - use the Salesforce Connected System instead] Deletes objects from Salesforce. This function returns a writer and must be used with the bind() function.
systemrules.sfcdelete.parameter.endpoint=The Salesforce endpoint URL to use for authentication.
systemrules.sfcdelete.parameter.ids=The ids of the objects to delete.
systemrules.sfcdelete.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.sfcdelete.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.sfcdescribeglobal.description=[Deprecated - use the Salesforce Connected System instead] Lists all of the objects available from the Salesforce instance.
systemrules.sfcdescribeglobal.parameter.endpoint=The Salesforce endpoint URL to use for authentication.
systemrules.sfcdescribeglobal.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.sfcdescribeglobal.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.sfcdescribesobjects.description=[Deprecated - use the Salesforce Connected System instead] Lists all of the attributes and their types of the given objects.
systemrules.sfcdescribesobjects.parameter.endpoint=The Salesforce endpoint URL to use for authentication.
systemrules.sfcdescribesobjects.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.sfcdescribesobjects.parameter.sobjectnames=The names of the objects to describe.
systemrules.sfcdescribesobjects.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.sfcinsert.description=[Deprecated - use the Salesforce Connected System instead] Inserts new objects into Salesforce. This function returns a writer and must be used with the bind() function.
systemrules.sfcinsert.parameter.endpoint=The Salesforce endpoint URL to use for authentication.
systemrules.sfcinsert.parameter.parameters=The data to insert, given as a dictionary with the same field structure as the sObject to insert.
systemrules.sfcinsert.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.sfcinsert.parameter.sendtimewithdatetime=If false, the time component of datetimes sent to Salesforce will be lost, resulting in a time of 00\:00\:00 being written. If true, the full datetime will be preserved. This field defaults to false to preserve backwards compatibility but should be set to true for new uses of the function.
systemrules.sfcinsert.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.sfcquery.description=[Deprecated - use the Salesforce Connected System instead] Runs a SOQL query against Salesforce.
systemrules.sfcquery.parameter.endpoint=The Salesforce endpoint URL to use for authentication.
systemrules.sfcquery.parameter.query=The SOQL query to send to Salesforce.
systemrules.sfcquery.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.sfcquery.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.sfcsearch.description=[Deprecated - use the Salesforce Connected System instead] Runs a SOSL query against Salesforce.
systemrules.sfcsearch.parameter.endpoint=The Salesforce endpoint URL to use for authentication.
systemrules.sfcsearch.parameter.query=The SOSL query to send to Salesforce.
systemrules.sfcsearch.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.sfcsearch.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.sfcupdate.description=[Deprecated - use the Salesforce Connected System instead] Updates existing objects in Salesforce. This function returns a writer and must be used with the bind() function.
systemrules.sfcupdate.parameter.endpoint=The Salesforce endpoint URL to use for authentication.
systemrules.sfcupdate.parameter.parameters=The data to update, given as a dictionary with the fields and corresponding values of the sObject to update.
systemrules.sfcupdate.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.sfcupdate.parameter.sendtimewithdatetime=If false, the time component of datetimes sent to Salesforce will be lost, resulting in a time of 00\:00\:00 being written. If true, the full datetime will be preserved. This field defaults to false to preserve backwards compatibility but should be set to true for new uses of the function.
systemrules.sfcupdate.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.shpcopydocumentfromappian.description=[Deprecated - use the SharePoint Connected System instead] Copies a document from Appian to SharePoint. This function returns a writer and must be used with the bind() function.
systemrules.shpcopydocumentfromappian.parameter.appiandocument=The Appian document to copy to SharePoint.
systemrules.shpcopydocumentfromappian.parameter.hostname=The hostaname of the SharePoint server.
systemrules.shpcopydocumentfromappian.parameter.path=The path portion of the REST API URL that represents the location in SharePoint to which the document will be copied.
systemrules.shpcopydocumentfromappian.parameter.port=The port the SharePoint server is listening on.
systemrules.shpcopydocumentfromappian.parameter.retries=The number of times to retry a request after receiving a timeout.
systemrules.shpcopydocumentfromappian.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.shpcopydocumentfromappian.parameter.subsitepath=(Optional) The path portion of the REST API URL that represents the SharePoint subsite. It must start with a forward slash (/). Leave blank if accessing the base site.
systemrules.shpcopydocumentfromappian.parameter.timeout=The amount of time to wait for a response from SharePoint, in milliseconds.
systemrules.shpcopydocumentfromappian.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.shpcopydocumenttoappian.description=[Deprecated - use the SharePoint Connected System instead] Copies a document from SharePoint to an Appian folder. This function returns a writer and must be used with the bind() function.
systemrules.shpcopydocumenttoappian.parameter.appiandocumentname=The name that will be given to the Appian document that is created.
systemrules.shpcopydocumenttoappian.parameter.appianfolder=The Appian folder to which the document from SharePoint will be copied.
systemrules.shpcopydocumenttoappian.parameter.hostname=The hostaname of the SharePoint server.
systemrules.shpcopydocumenttoappian.parameter.path=The path portion of the REST API URL that represents the document to copy from SharePoint.
systemrules.shpcopydocumenttoappian.parameter.port=The port the SharePoint server is listening on.
systemrules.shpcopydocumenttoappian.parameter.retries=The number of times to retry a request after receiving a timeout.
systemrules.shpcopydocumenttoappian.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.shpcopydocumenttoappian.parameter.timeout=The amount of time to wait for a response from SharePoint, in milliseconds.
systemrules.shpcopydocumenttoappian.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.shpinvoke.description=[Deprecated - use the SharePoint Connected System instead] Invokes a SharePoint REST API endpoint. This function should be used for reads only. Use a\!shpInvokeWriter() to write to SharePoint.
systemrules.shpinvoke.parameter.hostname=The hostaname of the SharePoint server.
systemrules.shpinvoke.parameter.httpmethod=The HTTP method to use when invoking the REST API. Valid values\: "GET". Use a\!shpInvokeWriter() for calls that use the "POST", "PUT", "DELETE", "MERGE" methods.
systemrules.shpinvoke.parameter.parameters=The data to use in the body of the request, given as a dictionary.
systemrules.shpinvoke.parameter.path=The path portion of the REST API URL to invoke.
systemrules.shpinvoke.parameter.port=The port the SharePoint server is listening on.
systemrules.shpinvoke.parameter.retries=The number of times to retry a request after receiving a timeout.
systemrules.shpinvoke.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.shpinvoke.parameter.subsitepath=(Optional) The path portion of the REST API URL that represents the SharePoint subsite. It must start with a forward slash (/). Leave blank if accessing the base site.
systemrules.shpinvoke.parameter.timeout=The amount of time to wait for a response from SharePoint, in milliseconds.
systemrules.shpinvoke.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.shpinvokewriter.description=[Deprecated - use the SharePoint Connected System instead] Invokes a SharePoint REST API endpoint. This function returns a writer and must be used with the bind() function.
systemrules.shpinvokewriter.parameter.hostname=The hostaname of the SharePoint server.
systemrules.shpinvokewriter.parameter.httpmethod=The HTTP method to use when invoking the REST API. Valid values\: "GET", "POST", "PUT", "DELETE", "MERGE".
systemrules.shpinvokewriter.parameter.parameters=The data to use in the body of the request, given as a dictionary.
systemrules.shpinvokewriter.parameter.path=The path portion of the REST API URL to invoke.
systemrules.shpinvokewriter.parameter.port=The port the SharePoint server is listening on.
systemrules.shpinvokewriter.parameter.retries=The number of times to retry a request after receiving a timeout.
systemrules.shpinvokewriter.parameter.scsexternalsystemkey=The authentication credentials key from the Third Party Credentials admin console page.
systemrules.shpinvokewriter.parameter.subsitepath=(Optional) The path portion of the REST API URL that represents the SharePoint subsite. It must start with a forward slash (/). Leave blank if accessing the base site.
systemrules.shpinvokewriter.parameter.timeout=The amount of time to wait for a response from SharePoint, in milliseconds.
systemrules.shpinvokewriter.parameter.useperusercredentials=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.
systemrules.sidebysideitem.description=Displays one item within a side by side layout.
systemrules.sidebysideitem.parameter.item=The component to display inside the layout.
systemrules.sidebysideitem.parameter.showwhen=Determines whether the component/layout is displayed on the interface. When set to false, the component/layout is hidden and is not evaluated. Default\: true.
systemrules.sidebysideitem.parameter.width=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".
systemrules.sidebysidelayout.description=Displays components alongside each other.
systemrules.sidebysidelayout.parameter.alignvertical=Determines vertical alignment of all content within the layout. Valid values are "TOP" (default), "MIDDLE", and "BOTTOM".
systemrules.sidebysidelayout.parameter.disabled=Determines if all items within the layout should display as potentially editable but grayed out. Default\: false.
systemrules.sidebysidelayout.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.sidebysidelayout.parameter.instructions=Supplemental text about this layout.
systemrules.sidebysidelayout.parameter.items=List of items that are displayed in the layout. Accepts a\!sideBySideItem.
systemrules.sidebysidelayout.parameter.label=Text to display as the layout label.
systemrules.sidebysidelayout.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.sidebysidelayout.parameter.marginabove=Determines how much space is added above the layout. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.sidebysidelayout.parameter.marginbelow=Determines how much space is added below the layout. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.sidebysidelayout.parameter.readonly=Determines if all items within the layout should display as not editable. Default\: false.
systemrules.sidebysidelayout.parameter.required=Determines if all values within the layout are required to submit the form. Default\: false.
systemrules.sidebysidelayout.parameter.requiredmessage=Custom message to display when the layout\u2019s values are required and not provided.
systemrules.sidebysidelayout.parameter.showwhen=Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default\: true.
systemrules.sidebysidelayout.parameter.spacing=Determines the space between items in the layout when they are not stacked. Valid values\: "STANDARD" (default), "NONE", "DENSE", "SPARSE".
systemrules.sidebysidelayout.parameter.stackwhen=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). Review [UX best practices](links.docs.systemrules.shared.responsive.doc) for responsive design.
systemrules.sidebysidelayout.parameter.validationgroup=When present, all items within the layout are only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.sidebysidelayout.parameter.validations=Validation errors to display below the layout when the values are not null.
systemrules.signaturefield.description=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. See [documentation](links.docs.systemrules.signaturefield.doc) for more details.
systemrules.signaturefield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.signaturefield.parameter.buttonsize=Determines the size of the signature button. Valid values\: "SMALL" (default), "STANDARD", "LARGE".
systemrules.signaturefield.parameter.buttonstyle=Determines the style of the signature button. Valid values\: "PRIMARY", "SECONDARY" (default), "STANDARD", "LINK".
systemrules.signaturefield.parameter.disabled=Determines if the field should display as potentially editable but grayed out. When a signature is present in this state, it may not be deleted. Default\: false.
systemrules.signaturefield.parameter.filedescription=Determines the description for the signature file. When not provided, the description of the new file is empty.
systemrules.signaturefield.parameter.filename=Determines the name for the signature file. When not provided, the timestamp will be used.
systemrules.signaturefield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.signaturefield.parameter.instructions=Supplemental text about this field.
systemrules.signaturefield.parameter.label=Text to display as the field label.
systemrules.signaturefield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.signaturefield.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.signaturefield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.signaturefield.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.signaturefield.parameter.saveinto=Variable that is updated with the signature file when the user saves a signature. Removing a signature file removes the document and saves a null. Use a\!save() to save a modified or alternative value to a variable.
systemrules.signaturefield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.signaturefield.parameter.target=Determines the eventual location of the saved signature file.
systemrules.signaturefield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.signaturefield.parameter.value=The signature file associated with this field.
systemrules.soln_application.description=Returns a map of properties of an application.
systemrules.soln_application.parameter.application=The application to retrieve by ID.
systemrules.soln_wizardlayout.parameter.formstyle=Determines how the sections should be displayed on the interface. Valid values\: "MULTI_PAGE" (default), "SINGLE_PAGE".
systemrules.soln_wizardlayout.parameter.hasfollowingpage=Indicates a Next button should be shown on the last page of the wizard rather than a Submit button. The onSubmit save will still be triggered on clicking the Next button of the final page. Default\: false.
systemrules.soln_wizardlayout.parameter.hasleadingpage=Indicates a Back button should be shown on the first page of the wizard which will execute onBack when clicked. Default\: false.
systemrules.soln_wizardlayout.parameter.onback=A list of saves to execute when the back button is pressed on the first page when hasLeadingPage is true.
systemrules.soln_wizardlayout.parameter.onsubmit=A list of saves to execute when the wizard submits. Note that if "hasFollowingPage" is True, this will execute when the Next button of the final page is clicked
systemrules.sortinfo.description=Creates a Sort Info configuration for use with read-only grids, charts, card choice field, a\!pagingInfo(), and a\!dataSubset().
systemrules.sortinfo.parameter.ascending=Determines what order the data is sorted in. Sorted in ascending order when the value is true and descending order when the value is false. Default\: false.
systemrules.sortinfo.parameter.field=The name of the field used to sort by. When sorting record data, use the recordType\! domain to reference a record field or related record field. For example, recordType\!Case.fields.caseName. When sorting on aggregate data, the field parameter can also accept the alias.
systemrules.stampfield.description=Displays an icon and/or text on a colored circular background. See [documentation](links.docs.systemrules.stampfield.doc) for more details.
systemrules.stampfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.stampfield.parameter.align=Determines alignment of the stamp. Valid values\: "START" (default), "CENTER", "END".
systemrules.stampfield.parameter.backgroundcolor=Determines the background color. Valid values\: Any valid hex color or "ACCENT" (default), "POSITIVE", "NEGATIVE", "SECONDARY", "TRANSPARENT". If "TRANSPARENT" is selected, the circle border will take on the content color and the circle fill will be transparent.
systemrules.stampfield.parameter.contentcolor=Determines the icon and/or text color. Valid values\: Any hex color or "STANDARD" (default), "ACCENT", "POSITIVE", "NEGATIVE".
systemrules.stampfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.stampfield.parameter.icon=Icon to display inside the stamp. See the [documentation for available icons](links.docs.systemrules.styledIcon.doc).
systemrules.stampfield.parameter.instructions=Supplemental text about this field.
systemrules.stampfield.parameter.label=Text to display as the field label.
systemrules.stampfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "COLLAPSED", "JUSTIFIED".
systemrules.stampfield.parameter.link=Link to apply to the stamp. 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().
systemrules.stampfield.parameter.marginabove=Determines how much space is added above the field. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.stampfield.parameter.marginbelow=Determines how much space is added below the field. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.stampfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.stampfield.parameter.size=Determines the size of the stamp. Valid values\: "TINY", "SMALL", "MEDIUM" (default), and "LARGE".
systemrules.stampfield.parameter.text=Text to display within the stamp.
systemrules.stampfield.parameter.tooltip=Text to display on mouseover (web) or tap (mobile).
systemrules.startprocess.description=Asynchronously starts a process using the provided parameters. This function will only execute inside a saveInto or a Web API. See the [documentation](links.docs.systemrules.startProcess.doc.guidance) for guidance about when to use different methods of starting a process from an interface.
systemrules.startprocess.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.startprocess.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). When configuring this input, the fv\!processInfo function variable ([ProcessInfo](links.docs.domains.type.processInfo)) is available to specify process properties of the process that was started (such as fv\!processInfo.pp.id), properties of the process model (such as fv\!processInfo.pm.name), and the values of process variables (such as fv\!processInfo.pv.employeeId) once all initial activity-chaining is complete. For more information, see [Function Variables](links.docs.expressions.functionVariables).
systemrules.startprocess.parameter.processmodel=The process model to start asynchronously.
systemrules.startprocess.parameter.processparameters=A dictionary containing the parameters for the process and their values.
systemrules.startprocesslink.description=Defines a link to start a process. Users are shown the start form or first chained attended node and any subsequent chained forms. After submitting the last form, the chain completes, the user returns to the original interface, and that interface reloads. Links can be used in charts, grids, hierarchy browsers, images, link fields, milestones, pickers, and rich text. See the [documentation](links.docs.systemrules.startProcess.doc.guidance) for guidance about when to use different methods of starting a process from an interface.
systemrules.startprocesslink.parameter.bannermessage=The text shown in the banner when a process starts successfully after completing any initial forms. When not provided, no banner is displayed.
systemrules.startprocesslink.parameter.label=Text associated with this link.
systemrules.startprocesslink.parameter.processmodel=The process model to start.
systemrules.startprocesslink.parameter.processparameters=A dictionary containing the parameters for the process model and their values.
systemrules.startprocesslink.parameter.showwhen=Determines whether the link is displayed in the component. When set to false, the link is hidden and is not evaluated. Default\: true.
systemrules.startruletestsall.description=Executes all test cases configured for expression rules in the Appian system.
systemrules.startruletestsall.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.startruletestsall.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). The test-run ID of the executed test run is available in the function variable fv\!testRunId. This can be used to query information about the test-run with a\!testRunStatusForId() and a\!testRunResultForId().
systemrules.startruletestsapplications.description=Executes all test cases configured for expression rules in the specified Appian application(s).
systemrules.startruletestsapplications.parameter.applications=The applications containing expression rules, whose test cases will be executed.
systemrules.startruletestsapplications.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.startruletestsapplications.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). The test-run ID of the executed test run is available in the function variable fv\!testRunId. This can be used to query information about the test-run with a\!testRunStatusForId() and a\!testRunResultForId().
systemrules.storedprocedureinput.description=Creates an input to be passed to the a\!executeStoredProcedureOnSave or a\!executeStoredProcedureForQuery functions. See the [documentation](links.docs.systemrules.executestoredprocedure.smart-service.doc) for guidance about how to execute stored procedures from Appian.
systemrules.storedprocedureinput.parameter.name=Name of the input to the stored procedure.
systemrules.storedprocedureinput.parameter.value=Value of the input to be passed to the stored procedure.
systemrules.studio_booleancheckboxfield.description=Creates a checkbox field with one option that handles a boolean value.
systemrules.studio_booleancheckboxfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.studio_booleancheckboxfield.parameter.align=Determines alignment of choice labels. Appian recommends this setting only be used inside the Grid Layout component. Valid values\: "LEFT", "CENTER", "RIGHT".
systemrules.studio_booleancheckboxfield.parameter.choicelabel=Option for the user to select.
systemrules.studio_booleancheckboxfield.parameter.choicestyle=Determines how the choices should be displayed on the interface. Valid values\: "STANDARD" (default), "CARDS".
systemrules.studio_booleancheckboxfield.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.studio_booleancheckboxfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.studio_booleancheckboxfield.parameter.instructions=Supplemental text about this field.
systemrules.studio_booleancheckboxfield.parameter.label=Text to display as the field label.
systemrules.studio_booleancheckboxfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.studio_booleancheckboxfield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.studio_booleancheckboxfield.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.studio_booleancheckboxfield.parameter.saveinto=One or more variables that are updated with the choice values when the user changes the selections. Use a\!save() to save a modified or alternative value to a variable.
systemrules.studio_booleancheckboxfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.studio_booleancheckboxfield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.studio_booleancheckboxfield.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.studio_booleancheckboxfield.parameter.value=Values of choices to display as selected.
systemrules.studio_brandingpalette.description=Returns a map of colors used in Appian Solutions.
systemrules.studio_datamanager.description=Studio interface to view and edit a record type definition.
systemrules.studio_datamanager.parameter.application=The application which this record type should be added to.
systemrules.studio_datamanager.parameter.recordtypeuuid=The UUID of the record type to view and edit.
systemrules.studio_datamanager.parameter.recordtypeuuidstohide=If a relationship maps to a record type with this UUID, it will not be shown.
systemrules.studio_emailaddressfield.description=Creates a simple field for inputting an email address. Automatically validates that the email address has an appropriate format.
systemrules.studio_emailaddressfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.studio_emailaddressfield.parameter.align=Determines alignment of the text value. Appian recommends this setting only be used inside the Grid Layout component. Valid values\: "LEFT", "CENTER", "RIGHT".
systemrules.studio_emailaddressfield.parameter.characterlimit=Determines the maximum number of characters. Depending on the language, some characters may count as more than one.
systemrules.studio_emailaddressfield.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.studio_emailaddressfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.studio_emailaddressfield.parameter.instructions=Supplemental text about this field.
systemrules.studio_emailaddressfield.parameter.label=Text to display as the field label.
systemrules.studio_emailaddressfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.studio_emailaddressfield.parameter.placeholder=Text to display in the field when it is empty. Does not show if the field is read only.
systemrules.studio_emailaddressfield.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.studio_emailaddressfield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.studio_emailaddressfield.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.studio_emailaddressfield.parameter.saveinto=One or more variables that are updated with the text when the user changes it. Use a\!save() to save a modified or alternative value to a variable.
systemrules.studio_emailaddressfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.studio_emailaddressfield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.studio_emailaddressfield.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.studio_emailaddressfield.parameter.value=Text to display in the text field.
systemrules.studio_formbuilder.description=Studio interface to build an intake form.
systemrules.studio_formbuilder.parameter.application=The application which this interface should be added to.
systemrules.studio_formbuilder.parameter.interfaceuuid=The UUID of the interface to build.
systemrules.studio_formbuilder.parameter.onclose=Saves to run when the form is closed.
systemrules.studio_image.description=Returns a stock image as a Web Image.
systemrules.studio_image.parameter.caption=Text to display in mouseovers and slideshows.
systemrules.studio_image.parameter.seed=An optional seed which, if passed, guarantees the same image output.
systemrules.studio_image.parameter.showwhen=Determines whether the image is displayed in the component. When set to false, the image is hidden and is not evaluated. Default\: true.
systemrules.studio_interfacecreator.description=Displays a button that creates an interface by specification.
systemrules.studio_interfacecreator.parameter.application=The application which this interface should be added to.
systemrules.studio_interfacecreator.parameter.interfacename=The name of the interface to create.
systemrules.studio_interfacecreator.parameter.interfacetemplate=The type of the interface to create. Valid values\: "WIZARD".
systemrules.studio_interfacecreator.parameter.oncreate=A list of saves to execute after the interface is created. Use fv\!interfaceUuid to reference the UUID of the created interface.
systemrules.studio_interfacecreator.parameter.recordtypeuuid=The UUID of the record type this interface will be interacting with.
systemrules.studio_interfacecreator.parameter.selectorinterface=A rule reference to the interface which will call this created one by the selector contract.
systemrules.studio_readonlydisplayfield.description=Displays read-only data in a standard manner. The underlying display is dynamic based on the type of the input value.
systemrules.studio_readonlydisplayfield.parameter.label=Text to display as the field label.
systemrules.studio_readonlydisplayfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.studio_readonlydisplayfield.parameter.value=Data to display in the field.
systemrules.studio_validatedateisafterrelative.description=Returns a message if the date given is not an appropriate number of days after the current day.
systemrules.studio_validatedateisafterrelative.parameter.date=The date to be compared.
systemrules.studio_validatedateisafterrelative.parameter.includestargetdate=Determines whether the target date should be included in the comparison. Default\: true.
systemrules.studio_validatedateisafterrelative.parameter.numdaysaftertoday=The number of days after the current day. Can be negative.
systemrules.studio_validatedateisafterrelative.parameter.validatewhen=Determines whether the validation is displayed on the interface. When set to false, the validation is hidden and is not evaluated. Default\: true.
systemrules.studio_validatedateisaftertarget.description=Returns a message if the date given is not an appropriate number of days after the target date.
systemrules.studio_validatedateisaftertarget.parameter.date=The date to be compared.
systemrules.studio_validatedateisaftertarget.parameter.includestargetdate=Determines whether the target date should be included in the comparison. Default\: true.
systemrules.studio_validatedateisaftertarget.parameter.targetdate=The target date for comparison.
systemrules.studio_validatedateisaftertarget.parameter.validatewhen=Determines whether the validation is displayed on the interface. When set to false, the validation is hidden and is not evaluated. Default\: true.
systemrules.studio_validatedateisbeforerelative.description=Returns a message if the date given is not an appropriate number of days before the current day.
systemrules.studio_validatedateisbeforerelative.parameter.date=The date to be compared.
systemrules.studio_validatedateisbeforerelative.parameter.includestargetdate=Determines whether the target date should be included in the comparison. Default\: true.
systemrules.studio_validatedateisbeforerelative.parameter.numdaysbeforetoday=The number of days after the current day. Can be negative.
systemrules.studio_validatedateisbeforerelative.parameter.validatewhen=Determines whether the validation is displayed on the interface. When set to false, the validation is hidden and is not evaluated. Default\: true.
systemrules.studio_validatedateisbeforetarget.description=Returns a message if the date given is not an appropriate number of days before the target date.
systemrules.studio_validatedateisbeforetarget.parameter.date=The date to be compared.
systemrules.studio_validatedateisbeforetarget.parameter.includestargetdate=Determines whether the target date should be included in the comparison. Default\: true.
systemrules.studio_validatedateisbeforetarget.parameter.targetdate=The target date for comparison.
systemrules.studio_validatedateisbeforetarget.parameter.validatewhen=Determines whether the validation is displayed on the interface. When set to false, the validation is hidden and is not evaluated. Default\: true.
systemrules.studio_validatedatetimeisafterrelative.description=Returns a message if the date given is not an appropriate number of days after the current day.
systemrules.studio_validatedatetimeisafterrelative.parameter.datetime=The date and time to be compared.
systemrules.studio_validatedatetimeisafterrelative.parameter.numdaysafternow=The number of days after the current date and time. Can be negative.
systemrules.studio_validatedatetimeisafterrelative.parameter.validatewhen=Determines whether the validation is displayed on the interface. When set to false, the validation is hidden and is not evaluated. Default\: true.
systemrules.studio_validatedatetimeisaftertarget.description=Returns a message if the date and time given is not an appropriate number of days after the target date and time.
systemrules.studio_validatedatetimeisaftertarget.parameter.datetime=The date and time to be compared.
systemrules.studio_validatedatetimeisaftertarget.parameter.targetdatetime=The target date and time for comparison.
systemrules.studio_validatedatetimeisaftertarget.parameter.validatewhen=Determines whether the validation is displayed on the interface. When set to false, the validation is hidden and is not evaluated. Default\: true.
systemrules.studio_validatedatetimeisbeforerelative.description=Returns a message if the date and time given is not an appropriate number of days before the current date and time.
systemrules.studio_validatedatetimeisbeforerelative.parameter.datetime=The date and time to be compared.
systemrules.studio_validatedatetimeisbeforerelative.parameter.numdaysbeforenow=The number of days after the current date and time. Can be negative.
systemrules.studio_validatedatetimeisbeforerelative.parameter.validatewhen=Determines whether the validation is displayed on the interface. When set to false, the validation is hidden and is not evaluated. Default\: true.
systemrules.studio_validatedatetimeisbeforetarget.description=Returns a message if the date and time given is not an appropriate number of days before the target date and time.
systemrules.studio_validatedatetimeisbeforetarget.parameter.datetime=The date and time to be compared.
systemrules.studio_validatedatetimeisbeforetarget.parameter.targetdatetime=The target date and time for comparison.
systemrules.studio_validatedatetimeisbeforetarget.parameter.validatewhen=Determines whether the validation is displayed on the interface. When set to false, the validation is hidden and is not evaluated. Default\: true.
systemrules.studio_validateemailaddressalloweddomains.description=Given an email address and a list of email domains, validates whether the email address domain is in the list.
systemrules.studio_validateemailaddressalloweddomains.parameter.alloweddomains=A list of valid full domains for the email address.
systemrules.studio_validateemailaddressalloweddomains.parameter.emailaddress=The email address to be evaluated.
systemrules.studio_validateemailaddressalloweddomains.parameter.validatewhen=Determines whether the validation is displayed on the interface. When set to false, the validation is hidden and is not evaluated. Default\: true.
systemrules.studio_validatenumberbetweenlimits.description=Returns a message if the given number value is not between provided number limit values.
systemrules.studio_validatenumberbetweenlimits.parameter.includelimitvalues=Includes the upper and lower limits in the comparison.
systemrules.studio_validatenumberbetweenlimits.parameter.lowerlimit=The lower limit of the range of numbers for comparison.
systemrules.studio_validatenumberbetweenlimits.parameter.number=The number to be compared.
systemrules.studio_validatenumberbetweenlimits.parameter.upperlimit=The upper limit of the range of numbers for comparison.
systemrules.studio_validatenumberbetweenlimits.parameter.validatewhen=Determines whether the validation is calculated on a component. When set to false, the validation is not evaluated. Default\: true.
systemrules.studio_validatenumbergreaterthanlowerlimit.description=Returns a message if the given number value is not greater than provided number limit.
systemrules.studio_validatenumbergreaterthanlowerlimit.parameter.includelimitvalue=Includes the target number in the comparison.
systemrules.studio_validatenumbergreaterthanlowerlimit.parameter.lowerlimit=The target number for comparison.
systemrules.studio_validatenumbergreaterthanlowerlimit.parameter.number=The number to be compared.
systemrules.studio_validatenumbergreaterthanlowerlimit.parameter.validatewhen=Determines whether the validation is calculated on a component. When set to false, the validation is not evaluated. Default\: true.
systemrules.studio_validatenumberlessthanupperlimit.description=Returns a message if the given number value is not less than provided number limit.
systemrules.studio_validatenumberlessthanupperlimit.parameter.includelimitvalue=Includes the target number in the comparison.
systemrules.studio_validatenumberlessthanupperlimit.parameter.number=The number to be compared.
systemrules.studio_validatenumberlessthanupperlimit.parameter.upperlimit=The target number for comparison.
systemrules.studio_validatenumberlessthanupperlimit.parameter.validatewhen=Determines whether the validation is calculated on a component. When set to false, the validation is not evaluated. Default\: true.
systemrules.studio_wizardlayout.description=Studio interface to display a list of pages in a wizard.
systemrules.studio_wizardlayout.parameter.label=Text to display as the wizard label.
systemrules.studio_wizardlayout.parameter.oncancel=A list of saves to execute when the wizard is canceled.
systemrules.studio_wizardlayout.parameter.onsubmit=A list of saves to execute when the wizard submits.
systemrules.studio_wizardlayout.parameter.pages=Pages to display using a\!soln_wizardPage.
systemrules.studio_wizardpage.description=Displays a page that can be used within a\!soln_wizardLaout.
systemrules.studio_wizardpage.parameter.contents=Components and layouts to display within the page.
systemrules.studio_wizardpage.parameter.label=Text to display as the page label.
systemrules.studio_yesnoradiobuttonfield.description=Creates a radio button field with two options (yes and no) that handles a boolean value.
systemrules.studio_yesnoradiobuttonfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.studio_yesnoradiobuttonfield.parameter.choicelayout=Determines the layout. Valid values\: "STACKED" (default), "COMPACT".
systemrules.studio_yesnoradiobuttonfield.parameter.choicestyle=Determines how the choices should be displayed on the interface. Valid values\: "STANDARD" (default), "CARDS".
systemrules.studio_yesnoradiobuttonfield.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.studio_yesnoradiobuttonfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.studio_yesnoradiobuttonfield.parameter.instructions=Supplemental text about this field.
systemrules.studio_yesnoradiobuttonfield.parameter.label=Text to display as the field label.
systemrules.studio_yesnoradiobuttonfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.studio_yesnoradiobuttonfield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.studio_yesnoradiobuttonfield.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.studio_yesnoradiobuttonfield.parameter.saveinto=One or more variables that are updated with the choice values when the user changes the selections. Use a\!save() to save a modified or alternative value to a variable.
systemrules.studio_yesnoradiobuttonfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.studio_yesnoradiobuttonfield.parameter.spacing=Determines the space between the options. Valid values\: "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.studio_yesnoradiobuttonfield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.studio_yesnoradiobuttonfield.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.studio_yesnoradiobuttonfield.parameter.value=Values of choices to display as selected.
systemrules.submitlink.description=Defines a link to trigger form submission. Links can be used in charts, grid columns, images, link fields, milestones, pickers, and rich text.
systemrules.submitlink.parameter.cancelbuttonlabel=Text to display on the cancel button.
systemrules.submitlink.parameter.confirmbuttonlabel=Text to display on the confirmation button.
systemrules.submitlink.parameter.confirmbuttonstyle=Determines the intent of the button. Valid values\: "PRIMARY", "DESTRUCTIVE".
systemrules.submitlink.parameter.confirmheader=Text to display at the top of the confirmation dialog.
systemrules.submitlink.parameter.confirmmessage=Text to display in a confirmation dialog box.
systemrules.submitlink.parameter.label=Text associated with this link.
systemrules.submitlink.parameter.saveinto=One or more variables that are updated with the link value when the user clicks it. Use a\!save() to save a modified or alternative value to a variable.
systemrules.submitlink.parameter.showwhen=Determines whether the link is displayed in the component. When set to false, the link is hidden and is not evaluated. Default\: true.
systemrules.submitlink.parameter.skipvalidation=Determines if validation is skipped. Default\: false.
systemrules.submitlink.parameter.validationgroup=Components in the same validation group are validated when the link is used and "validate" is true. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.submitlink.parameter.value=Value to be saved when the link is clicked.
systemrules.submituploadedfiles.description=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.
systemrules.submituploadedfiles.parameter.documents=Use this optional parameter when you have multiple file upload or signature components on an interface and each one submits with a different button or link. This parameter accepts a list of documents to submit when the user clicks the button or link. Documents that have already been submitted or cannot be found will be ignored. If this parameter isn\u2019t used, all uploaded files will be submitted.
systemrules.submituploadedfiles.parameter.onerror=A list of saves to execute after the uploaded files are not submitted successfully. Use fv\!error to access the returned error code. See the [documentation](links.docs.systemrules.submituploadedfiles.doc) for possible error codes.
systemrules.submituploadedfiles.parameter.onsuccess=A list of saves to execute after the uploaded files are submitted successfully.
systemrules.syncrecords.description=Sync a record or set of records in the specified record type.
systemrules.syncrecords.parameter.identifiers=The primary key values of the records to sync.
systemrules.syncrecords.parameter.onerror=An HTTP response or a list of a\!save to return after the integration does not execute successfully. Created with a\!httpResponse() or a\!save().
systemrules.syncrecords.parameter.onsuccess=An HTTP response or a list of a\!save to return after the integration executes successfully. Created with a\!httpResponse() or a\!save(). The updated records are available in fv\!recordsUpdated (but the related record data is not included). If the query to get this list of records fails, the error message is available in fv\!queryError.
systemrules.syncrecords.parameter.recordtype=A reference to a record type with data sync enabled. You must reference the record type directly from the recordType\! domain. For example, recordType\!Case.
systemrules.syncrecords_22r2.description=This is an older version of the a\!syncRecords() function. You can continue to use this version of the function by its new name\: a\!syncRecords(). The new version of a\!syncRecords() has new functionality.
systemrules.syncrecords_22r2.parameter.identifiers=The primary key values of the records to sync.
systemrules.syncrecords_22r2.parameter.onerror=An HTTP response or a list of a\!save to return after the integration does not execute successfully. Created with a\!httpResponse() or a\!save().
systemrules.syncrecords_22r2.parameter.onsuccess=An HTTP response or a list of a\!save to return after the integration executes successfully. Created with a\!httpResponse() or a\!save(). The updated records are available in fv\!recordsUpdated (but the related record data is not included). If the query to get this list of records fails, the error message is available in fv\!queryError.
systemrules.syncrecords_22r2.parameter.recordtype=A reference to a record type with data sync enabled. You must reference the record type directly from the recordType\! domain. For example, recordType\!Case.
systemrules.syncrecordsfromsource.description=Sync a record or set of records in the specified record type.
systemrules.syncrecordsfromsource.parameter.identifiers=The primary key values of the records to sync.
systemrules.syncrecordsfromsource.parameter.onerror=An HTTP response or a list of a\!save to return after the integration does not execute successfully. Created with a\!httpResponse() or a\!save().
systemrules.syncrecordsfromsource.parameter.onsuccess=An HTTP response or a list of a\!save to return after the integration executes successfully. Created with a\!httpResponse() or a\!save().
systemrules.syncrecordsfromsource.parameter.recordtype=A reference to a record type with data sync enabled. You must reference the record type directly from the recordType\! domain. For example, recordType\!Case.
systemrules.tagfield.description=Displays a list of short text labels with colored background to highlight important attributes. See [documentation](links.docs.systemrules.tagfield.doc) for more details.
systemrules.tagfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.tagfield.parameter.align=Determines alignment of the tags. Valid values\: "START" (default), "CENTER", "END".
systemrules.tagfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.tagfield.parameter.instructions=Supplemental text about this field.
systemrules.tagfield.parameter.label=Text to display as the field label.
systemrules.tagfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "COLLAPSED", "JUSTIFIED".
systemrules.tagfield.parameter.marginabove=Determines how much space is added above the field. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.tagfield.parameter.marginbelow=Determines how much space is added below the field. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.tagfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.tagfield.parameter.size=Determines the size of the tags. Valid values\: "SMALL", "STANDARD" (default).
systemrules.tagfield.parameter.tags=List of tags to display. Configured using a\!tagItem().
systemrules.tagitem.description=Displays a short text label with colored background for use with a\!tagField.
systemrules.tagitem.parameter.backgroundcolor=Determines the background color. Valid values\: Any valid hex color or "ACCENT" (default), "POSITIVE", "NEGATIVE", "SECONDARY".
systemrules.tagitem.parameter.recordlink=Link to apply to the tag. Create a link with a\!recordLink() or a\!userRecordLink().
systemrules.tagitem.parameter.showwhen=Determines whether the tag is displayed on the interface. When set to false, the tag is hidden and is not evaluated. Default\: true.
systemrules.tagitem.parameter.text=Text to display within the tag. The tag displays a maximum of 40 characters.
systemrules.tagitem.parameter.textcolor=Determines the text color. Valid values\: Any valid hex color or "STANDARD" (default).
systemrules.tagitem.parameter.tooltip=Text to display as a tooltip on the tag.
systemrules.testrunresultforid.description=Provided a test-run ID, this function returns a TestRunResult data type containing the results of a rule test-run.
systemrules.testrunresultforid.parameter.testrunid=The test-run ID of the test-run you want to check on.
systemrules.testrunstatusforid.description=Provided a test-run ID, this function queries for the status of a rule test-run.
systemrules.testrunstatusforid.parameter.testrunid=The test-run ID of the test-run you want to check on.
systemrules.textfield.description=Displays and allows entry of a single line of text. See [documentation](links.docs.systemrules.textfield.doc) for more details.
systemrules.textfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.textfield.parameter.align=Determines alignment of the text value. Appian recommends this setting only be used inside the Grid Layout component. Valid values\: "LEFT", "CENTER", "RIGHT".
systemrules.textfield.parameter.characterlimit=Determines the maximum number of characters. Depending on the language, some characters may count as more than one.
systemrules.textfield.parameter.disabled=Determines if the field should display as potentially editable but grayed out. Default\: false.
systemrules.textfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.textfield.parameter.inputpurpose=Indicates the intent of input for accessibility improvements, like autocomplete, used by browsers and assistive technologies. Valid values are "NAME", "EMAIL", "PHONE_NUMBER", "STREET_ADDRESS", "POSTAL_CODE", "CREDIT_CARD_NUMBER", and "OFF".
systemrules.textfield.parameter.instructions=Supplemental text about this field.
systemrules.textfield.parameter.label=Text to display as the field label.
systemrules.textfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.textfield.parameter.masked=Determines if the value is obscured from view. Default\: false.
systemrules.textfield.parameter.placeholder=Text to display in the field when it is empty. Does not show if the field is read only.
systemrules.textfield.parameter.readonly=Determines if the field should display as not editable. Default\: false.
systemrules.textfield.parameter.refreshafter=Determines when the saveInto expression is evaluated. Valid values\: "UNFOCUS" (default), "KEYPRESS".
systemrules.textfield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.textfield.parameter.requiredmessage=Custom message to display when the field\u2019s value is required and not provided.
systemrules.textfield.parameter.saveinto=One or more variables that are updated with the text when the user changes it. Use a\!save() to save a modified or alternative value to a variable.
systemrules.textfield.parameter.showcharactercount=Determines if the character count displays on the text field. Only applicable if the character limit is set. Default\: true.
systemrules.textfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.textfield.parameter.validationgroup=When present, this field is only validated when a button in the same validation group is pressed. See the [documentation](link.docs.systemrules.shared.validation-groups) for more information about how to use validation groups.
systemrules.textfield.parameter.validations=Validation errors to display below the field when the value is not null.
systemrules.textfield.parameter.value=Text to display in the text field.
systemrules.timedisplayfield.description=Displays a single time (hour, minute, second) but cannot take input.
systemrules.timedisplayfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.timedisplayfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.timedisplayfield.parameter.instructions=Supplemental text about this field.
systemrules.timedisplayfield.parameter.label=Text to display as the field label.
systemrules.timedisplayfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.timedisplayfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.timedisplayfield.parameter.value=The time to display.
systemrules.togglewidget.description=Displays a series of buttons similar to an old style tape deck with only one active at a time.
systemrules.togglewidget.parameter.choiceiconidentifiers=A list of FontAwesome icon identifiers.
systemrules.togglewidget.parameter.choicelabels=A list of text which will be used as labels for each button.
systemrules.togglewidget.parameter.choicetooltips=A list of text that will appear as tooltips for each button.
systemrules.togglewidget.parameter.choicevalues=The value for each individual button when selected.
systemrules.togglewidget.parameter.saveinto=One or more variables that are updated with the text when the user selects a button.
systemrules.togglewidget.parameter.value=The value for the selected button.
systemrules.tojson.description=Converts a value into a JSON string.
systemrules.tojson.parameter.removenulloremptyfields=Determines whether fields with values that are null, empty strings, or empty arrays are removed from the JSON output. Default\: false.
systemrules.tojson.parameter.value=The value to convert into a JSON string.
systemrules.tojson_17r1.description=NOTE\: This is an old version of the a\!toJson() function. Take advantage of improvements in the new version by switching to a\!toJson(). | a\!toJson_17r1() converts a value into a JSON string.
systemrules.tojson_17r1.parameter.value=The value to convert into a JSON string.
systemrules.torecordidentifier.description=Creates Record Identifiers for use with Post Event smart services.
systemrules.torecordidentifier.parameter.identifier=Array of identifiers, either the primary key (entity-backed), the process ID (process-backed), or the ID in the DataSubset\u2019s "identifiers" field (service-backed).
systemrules.torecordidentifier.parameter.recordtype=Record type of the created record identifiers.
systemrules.unlockdocument.description=Unlocks a document. This function will only execute inside a saveInto or a Web API.
systemrules.unlockdocument.parameter.document=The document to unlock.
systemrules.unlockdocument.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.unlockdocument.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.updateuserprofile.description=Updates a user\u2019s profile information. This function will only execute inside a saveInto or a Web API. See the [documentation](links.docs.function.updateUserProfile.description) for additional guidance.
systemrules.updateuserprofile.parameter.address1=The new address of the user.
systemrules.updateuserprofile.parameter.address2=The new address of the user.
systemrules.updateuserprofile.parameter.address3=The new address of the user.
systemrules.updateuserprofile.parameter.calendar=The new calendar of the user. If not provided, defaults to the primary calendar. Valid values\: "gregorian", "Epoch A T1", "Epoch A T2", "Epoch B T1", "Epoch B T2", "Umm Al Qura".
systemrules.updateuserprofile.parameter.city=The new city of the user.
systemrules.updateuserprofile.parameter.country=The new country of the user.
systemrules.updateuserprofile.parameter.customfield1=The new value of custom field 1 of the user.
systemrules.updateuserprofile.parameter.customfield10=The new value of custom field 10 of the user.
systemrules.updateuserprofile.parameter.customfield2=The new value of custom field 2 of the user.
systemrules.updateuserprofile.parameter.customfield3=The new value of custom field 3 of the user.
systemrules.updateuserprofile.parameter.customfield4=The new value of custom field 4 of the user.
systemrules.updateuserprofile.parameter.customfield5=The new value of custom field 5 of the user.
systemrules.updateuserprofile.parameter.customfield6=The new value of custom field 6 of the user.
systemrules.updateuserprofile.parameter.customfield7=The new value of custom field 7 of the user.
systemrules.updateuserprofile.parameter.customfield8=The new value of custom field 8 of the user.
systemrules.updateuserprofile.parameter.customfield9=The new value of custom field 9 of the user.
systemrules.updateuserprofile.parameter.email=The new email address of the user.
systemrules.updateuserprofile.parameter.firstname=The new first name of the user.
systemrules.updateuserprofile.parameter.homephone=The new home phone number of the user.
systemrules.updateuserprofile.parameter.lastname=The new last name of the user.
systemrules.updateuserprofile.parameter.locale=The new [locale code](links.docs.admin.locale.languageSettings) of the user, such as "en_US" or "de". If not provided, defaults to the primary locale.
systemrules.updateuserprofile.parameter.middlename=The new middle name of the user.
systemrules.updateuserprofile.parameter.mobilephone=The new mobile phone number of the user.
systemrules.updateuserprofile.parameter.nickname=The new nickname of the user.
systemrules.updateuserprofile.parameter.officephone=The new office phone number of the user.
systemrules.updateuserprofile.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.updateuserprofile.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.updateuserprofile.parameter.overwriteallfields=Set to true to overwrite all fields with the specified values (or null when no value is specified). Set to false to only overwrite fields with specified value and keep the original values when no value is specified. Default\: false.
systemrules.updateuserprofile.parameter.province=The new province of the user.
systemrules.updateuserprofile.parameter.state=The new state of the user.
systemrules.updateuserprofile.parameter.supervisor=The new supervisor of the user.
systemrules.updateuserprofile.parameter.timezone=The new time zone ID of the user, such as "America/New_York". If not provided, defaults to the primary time zone.
systemrules.updateuserprofile.parameter.title=The new title of the user.
systemrules.updateuserprofile.parameter.user=The user whose profile will be updated.
systemrules.updateuserprofile.parameter.zipcode=The new ZIP code of the user.
systemrules.updateuserprofile_22r1.description=This is an older version of the a\!updateUserProfile function. You can continue to use this version of the function by calling\: a\!updateUserProfile_22r1. The new version of a\!updateUserProfile has new functionality which allows setting additional fields, such as locale and timezone.
systemrules.updateuserprofile_22r1.parameter.address1=The new address of the user.
systemrules.updateuserprofile_22r1.parameter.address2=The new address of the user.
systemrules.updateuserprofile_22r1.parameter.address3=The new address of the user.
systemrules.updateuserprofile_22r1.parameter.city=The new city of the user.
systemrules.updateuserprofile_22r1.parameter.country=The new country of the user.
systemrules.updateuserprofile_22r1.parameter.email=The new email address of the user.
systemrules.updateuserprofile_22r1.parameter.firstname=The new first name of the user.
systemrules.updateuserprofile_22r1.parameter.homephone=The new home phone number of the user.
systemrules.updateuserprofile_22r1.parameter.lastname=The new last name of the user.
systemrules.updateuserprofile_22r1.parameter.middlename=The new middle name of the user.
systemrules.updateuserprofile_22r1.parameter.mobilephone=The new mobile phone number of the user.
systemrules.updateuserprofile_22r1.parameter.officephone=The new office phone number of the user.
systemrules.updateuserprofile_22r1.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.updateuserprofile_22r1.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.updateuserprofile_22r1.parameter.overwriteallfields=Set to True to overwrite all fields with specified values or null if no value is specified.
systemrules.updateuserprofile_22r1.parameter.state=The new state of the user.
systemrules.updateuserprofile_22r1.parameter.supervisor=The new supervisor of the user.
systemrules.updateuserprofile_22r1.parameter.title=The new title of the user.
systemrules.updateuserprofile_22r1.parameter.user=The user whose profile will be updated.
systemrules.updateuserprofile_22r1.parameter.zipcode=The new zip code of the user.
systemrules.updateusertype.description=Changes the type of a user. This function will only execute inside a saveInto or a Web API.
systemrules.updateusertype.parameter.newusertype=The new type for the user. Valid values\: "ADMINISTRATOR" (default), "BASIC".
systemrules.updateusertype.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.updateusertype.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse().
systemrules.updateusertype.parameter.user=The user to change the type of.
systemrules.userandgroupbrowserfieldcolumns.description=Displays group membership structure in columns. Users can navigate through the structure and select a single user or group. See [documentation](links.docs.systemrules.userandgroupbrowserfieldcolumns.doc) for more details.
systemrules.userandgroupbrowserfieldcolumns.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.userandgroupbrowserfieldcolumns.parameter.height=Determines the height of the component.Valid values\: "SHORT", "MEDIUM" (default), "TALL".
systemrules.userandgroupbrowserfieldcolumns.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.userandgroupbrowserfieldcolumns.parameter.instructions=Supplemental text about this field.
systemrules.userandgroupbrowserfieldcolumns.parameter.label=Text to display as the field label.
systemrules.userandgroupbrowserfieldcolumns.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.userandgroupbrowserfieldcolumns.parameter.pathsaveinto=Variable or list of variables to update when a user clicks on a user or group.
systemrules.userandgroupbrowserfieldcolumns.parameter.pathvalue=The path from the first column to the current navigation.
systemrules.userandgroupbrowserfieldcolumns.parameter.readonly=Determines whether selection is enabled. Default\: false.
systemrules.userandgroupbrowserfieldcolumns.parameter.rootgroup=The direct members of the initial group are displayed in the first column.
systemrules.userandgroupbrowserfieldcolumns.parameter.selectionsaveinto=Variable or list of variables to update upon selection of a user or group.
systemrules.userandgroupbrowserfieldcolumns.parameter.selectionvalue=This user or group is displayed as selected when it is present in the navigation path array.
systemrules.userandgroupbrowserfieldcolumns.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.userbrowserfieldcolumns.description=Displays group membership structure in columns. Users can navigate through the structure and select a single user. See [documentation](links.docs.systemrules.userbrowserfieldcolumns.doc) for more details.
systemrules.userbrowserfieldcolumns.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.userbrowserfieldcolumns.parameter.height=Determines the height of the component.Valid values\: "SHORT", "MEDIUM" (default), "TALL".
systemrules.userbrowserfieldcolumns.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.userbrowserfieldcolumns.parameter.instructions=Supplemental text about this field.
systemrules.userbrowserfieldcolumns.parameter.label=Text to display as the field label.
systemrules.userbrowserfieldcolumns.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.userbrowserfieldcolumns.parameter.pathsaveinto=Variable or list of variables to update when a user clicks on a user or group.
systemrules.userbrowserfieldcolumns.parameter.pathvalue=The path from the first column to the current navigation.
systemrules.userbrowserfieldcolumns.parameter.readonly=Determines whether selection is enabled. Default\: false.
systemrules.userbrowserfieldcolumns.parameter.rootgroup=The direct members of the initial group are displayed in the first column.
systemrules.userbrowserfieldcolumns.parameter.selectionsaveinto=Variable or list of variables to update upon selection of a user.
systemrules.userbrowserfieldcolumns.parameter.selectionvalue=This user is displayed as selected when it is present in the navigation path array.
systemrules.userbrowserfieldcolumns.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.userimage.description=Displays a user\u2019s profile photo for use in an image field, rich text, hierarchy tree browser, billboard, or image column in a grid.
systemrules.userimage.parameter.alttext=Equivalent alternate text used when accessibility issues prevent the image from displaying.
systemrules.userimage.parameter.caption=Text to display in mouseovers.
systemrules.userimage.parameter.link=Link that determines the behavior of an image when clicked. Create links with a\!documentDownloadLink(), a\!dynamicLink(), a\!newsEntryLink(), a\!processTaskLink(), a\!recordLink(), a\!userRecordLink(), a\!reportLink(), a\!safeLink(), a\!startProcessLink(), or a\!submitLink().
systemrules.userimage.parameter.showwhen=Determines whether the image is displayed in the component. When set to false, the image is hidden and is not evaluated. Default\: true.
systemrules.userimage.parameter.user=The user whose profile photo will be shown.
systemrules.userrecordfacets.description=[Deprecated] This function has been deprecated. Use the new a\!userRecordFilterList function instead. Defines the user filters for the User record type.
systemrules.userrecordfilterlist.description=Defines the user filters for the User record type.
systemrules.userrecordfilterlist_22r3.description=This is an older version of the a\!userRecordFilterList() function which uses the unsynced User record type. Take advantage of the latest features and improvements by updating the User record type to be synced and switching to the latest version of a\!userRecordFilterList().
systemrules.userrecordidentifier.description=Creates Record Identifiers for User records for use with Post Event smart services.
systemrules.userrecordidentifier.parameter.users=The list of Users for whom record identifiers are to be created.
systemrules.userrecordlink.description=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.
systemrules.userrecordlink.parameter.label=Link text that users click to open the link.
systemrules.userrecordlink.parameter.openlinkin=Determines how the record link should open, either in the same tab or a new tab. Valid values\: "SAME_TAB" (default) or "NEW_TAB". This parameter only applies to web browsers.
systemrules.userrecordlink.parameter.showwhen=Determines whether the link is displayed in the component. When set to false, the link is hidden and is not evaluated. Default\: true.
systemrules.userrecordlink.parameter.targetlocation=Determines where the record view should open, which can be either the page the user is on or a specific site page. To reference a site page, use the following structure\: site\![site name].pages.[page web address identifier]. Valid values\: "SAME_PAGE" (default) or a reference to a site page.
systemrules.userrecordlink.parameter.user=The User whose record will be linked.
systemrules.userrecordlink.parameter.view=The URL stub for the record view that the link will open. Default is "summary". Go to the record type and click Views to find the URL stub for each record view.
systemrules.userrecordlistviewitem.description=Defines the List View Item Template for the synced User record type.
systemrules.userrecordlistviewitem.parameter.record=The reference to the current User record, provided via rv\!record.
systemrules.userrecordlistviewitem_22r3.description=This is an older version of the a\!userRecordListViewItem() function which uses the unsynced User record type. Take advantage of the latest features and improvements by updating the User record type to be synced and switching to the latest version of a\!userRecordListViewItem().
systemrules.userrecordlistviewitem_22r3.parameter.record=The reference to the current unsynced User record, provided via rv\!record.
systemrules.validationmessage.description=Defines a validation message for form, section, and editable grid components.
systemrules.validationmessage.parameter.message=The validation message to display.
systemrules.validationmessage.parameter.showwhen=Determines whether the validation is displayed on the interface. When set to false, the validation is hidden and is not evaluated. Default\: true.
systemrules.validationmessage.parameter.validateafter=Determines when the validation message is displayed. Valid values\: "REFRESH" (default), "SUBMIT".
systemrules.verifyrecaptcha.description=a\!verifyRecaptcha() allows you to verify the reCAPTCHA result and define logic to help protect your page against abusive traffic. This function will only execute inside the recaptchaSaveInto parameter on a\!buttonWidget(). See [documentation](links.docs.portals.recaptcha) for information on configuring Google reCAPTCHA keys, handling different reCAPTCHA scores, and testing reCAPTCHA logic. Only for use in Portals.
systemrules.verifyrecaptcha.parameter.onError=A list of saves to execute after reCAPTCHA does not execute successfully. Use fv\!error to access the returned error. This parameter is required.
systemrules.verifyrecaptcha.parameter.onSuccess=A list of saves to execute after reCAPTCHA executes successfully. Use fv\!score to access the score returned by reCAPTCHA. Define conditional logic to protect your page based on whether the interaction is likely a bot or human. A score of 1.0 is very likely a human while a score of 0.0 is very likely a bot. This parameter is required. See [documentation](links.docs.portals.recaptcha) for more information on how to interpret the score. 
systemrules.verifyrecaptcha.parameter.onerror=A list of saves to execute after reCAPTCHA does not execute successfully. Use fv\!error to access the returned error.
systemrules.verifyrecaptcha.parameter.onsuccess=A list of saves to execute after reCAPTCHA executes successfully. Use fv\!score to access the score returned by reCAPTCHA. Define conditional logic to protect your page based on whether the interaction is likely a bot or human. A score of 1.0 is likely a human while a score of 0.0 is likely a bot. See [documentation](links.docs.portals.recaptcha) for more information on how to interpret the score.
systemrules.videofield.description=Creates a Video component. See [documentation](links.docs.systemrules.videofield.doc) for more details.
systemrules.videofield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.videofield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.videofield.parameter.instructions=Supplemental text about this field.
systemrules.videofield.parameter.label=Text to display as the field label.
systemrules.videofield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.videofield.parameter.marginabove=Determines how much space is added above the field. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.videofield.parameter.marginbelow=Determines how much space is added below the field. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.videofield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.videofield.parameter.videos=Array of videos to display, created with a\!webVideo().
systemrules.webcontentfield.description=Displays content inline from an external source. See [documentation](links.docs.systemrules.webcontentfield.doc) for more details.
systemrules.webcontentfield.parameter.accessibilitytext=Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
systemrules.webcontentfield.parameter.alttext=Equivalent alternate text provided to assistive technology.
systemrules.webcontentfield.parameter.disabled=Determines if the user is prevented from interacting with the web content. Default\: false.
systemrules.webcontentfield.parameter.height=Determines the layout height. Valid values\: "SHORT", "MEDIUM" (default), "TALL".
systemrules.webcontentfield.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.webcontentfield.parameter.instructions=Supplemental text about this field.
systemrules.webcontentfield.parameter.label=Text to display as the field label.
systemrules.webcontentfield.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.webcontentfield.parameter.marginabove=Determines how much space is added above the field. Valid values\: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".
systemrules.webcontentfield.parameter.marginbelow=Determines how much space is added below the field. Valid values\: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".
systemrules.webcontentfield.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.webcontentfield.parameter.showborder=Determines whether the field has an outer border. Default\: false.
systemrules.webcontentfield.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.webcontentfield.parameter.source=Location of the external content.
systemrules.webcontentfield_deprecated.description=This component has been deprecated. Use a\!webContentField instead. Displays content inline from an external source.
systemrules.webcontentfield_deprecated.parameter.alttext=Equivalent alternate text provided to assistive technology.
systemrules.webcontentfield_deprecated.parameter.disabled=Determines if the user is prevented from interacting with the web content. Default\: false.
systemrules.webcontentfield_deprecated.parameter.height=Determines the layout height. Valid values\: "SHORT", "MEDIUM" (default), "TALL".
systemrules.webcontentfield_deprecated.parameter.helptooltip=Displays a help icon with the specified text as a tooltip. The help icon does not show when the label position is "COLLAPSED".
systemrules.webcontentfield_deprecated.parameter.instructions=Supplemental text about this field.
systemrules.webcontentfield_deprecated.parameter.label=Text to display as the field label.
systemrules.webcontentfield_deprecated.parameter.labelposition=Determines where the label appears. Valid values\: "ABOVE" (default), "ADJACENT", "JUSTIFIED", "COLLAPSED".
systemrules.webcontentfield_deprecated.parameter.required=Determines if a value is required to submit the form. Default\: false.
systemrules.webcontentfield_deprecated.parameter.showborder=Determines whether the field has an outer border. Default\: false.
systemrules.webcontentfield_deprecated.parameter.showwhen=Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default\: true.
systemrules.webcontentfield_deprecated.parameter.source=Location of the external content.
systemrules.webimage.description=Displays an image from the web for use in an image field, rich text, hierarchy tree browser, billboard, or image column in a grid.
systemrules.webimage.parameter.alttext=Equivalent alternate text used when accessibility issues prevent the image from displaying.
systemrules.webimage.parameter.caption=Text to display in mouseovers and slideshows.
systemrules.webimage.parameter.link=Link that determines the behavior of an image when clicked. Create links with a\!documentDownloadLink(), a\!dynamicLink(), a\!newsEntryLink(), a\!processTaskLink(), a\!recordLink(), a\!reportLink(), a\!safeLink(), a\!startProcessLink(), a\!submitLink(), a\!userRecordLink(), or a\!authorizationLink().
systemrules.webimage.parameter.showwhen=Determines whether the image is displayed in the component. When set to false, the image is hidden and is not evaluated. Default\: true.
systemrules.webimage.parameter.source=Location of the image.
systemrules.webvideo.description=Displays a video from the web for use in a\!videoField().
systemrules.webvideo.parameter.showwhen=Determines whether the video is displayed in the component. When set to false, the video is hidden and is not evaluated. Default\: true.
systemrules.webvideo.parameter.source=Location of the video.
systemrules.webvideo.parameter.tooltip=Text to display in mouseovers.
systemrules.writerecords.description=Create or update data in your data source and immediately sync those changes in your record type. This function is only available for database-backed record types with data sync enabled, and can be used within an interface or a web API.
systemrules.writerecords.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse(). Use fv\!error to reference any errors from the source.
systemrules.writerecords.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). Use fv\!recordsUpdated to reference the updated records in the success response.
systemrules.writerecords.parameter.records=The list of records to create or update.
systemrules.writerecords_23r2.description=This is an older version of the a\!writeRecords() function. You can continue to use this version of the function by its new name\: a\!writeRecords(). The new version of a\!writeRecords() has new functionality.
systemrules.writerecords_23r2.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse(). Use fv\!error to reference any errors from the source.
systemrules.writerecords_23r2.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). Use fv\!recordsUpdated to reference the updated records in the success response.
systemrules.writerecords_23r2.parameter.records=The list of records to create or update.
systemrules.writerecords_23r4.description=This is an older version of the a\!writeRecords() function. You can continue to use this version of the function by its new name\: a\!writeRecords(). The new version of a\!writeRecords() has new functionality.
systemrules.writerecords_23r4.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse(). Use fv\!error to reference any errors from the source.
systemrules.writerecords_23r4.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). Use fv\!recordsUpdated to reference the updated records in the success response.
systemrules.writerecords_23r4.parameter.records=The list of records to create or update.
systemrules.writerecordstosource.description=Create or update data in your data source and immediately sync those changes in your record type. This function is only available for database-backed record types with data sync enabled, and can be used within an interface or a web API.
systemrules.writerecordstosource.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse(). Use fv\!errors to reference any errors from the source.
systemrules.writerecordstosource.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). Use fv\!recordsUpdated to reference the updated records in the success response.
systemrules.writerecordstosource.parameter.records=The list of records to create or update.
systemrules.writetodatastoreentity.description=Creates or updates data in a data store entity. This function will only execute inside a saveInto or a Web API.
systemrules.writetodatastoreentity.parameter.datastoreentity=The data store entity where you want to save your data.
systemrules.writetodatastoreentity.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.writetodatastoreentity.parameter.onsuccess=A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a\!save() or a\!httpResponse(). The stored values are available in the function variable fv\!storedValues.
systemrules.writetodatastoreentity.parameter.valuetostore=The data value to create or update.
systemrules.writetomultipledatastoreentities.description=Creates or updates data in multiple data store entities in a single database transaction. This function will only execute inside a saveInto or a Web API.
systemrules.writetomultipledatastoreentities.parameter.onerror=A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a\!save() or a\!httpResponse().
systemrules.writetomultipledatastoreentities.parameter.onsuccess=A list of saves or an HTTP response to execute when the smart service executed successfully. Created with a\!save() or a\!httpResponse(). The stored values are available in the function variable fv\!storedValues.
systemrules.writetomultipledatastoreentities.parameter.valuestostore=A list of the target entity and data values to store in the target entity, created with a\!entityData().
systemrules.wsconfig.description=Creates a web service configuration for use with webservicequery().
systemrules.wsconfig.parameter.endpointcredentials=Credentials with which to invoke the web service, created with a\!wsHttpCredentials().
systemrules.wsconfig.parameter.extensions=Array of HTTP headers to pass to the web service, created with a\!wsHttpHeaderField(), or WS-Security Username Tokens, created with a\!wsUsernameToken() or a\!wsUsernameTokenScs().
systemrules.wsconfig.parameter.operation=The operation on the web service to invoke, as defined in the <wsdl\:operation> element.
systemrules.wsconfig.parameter.port=The port name within the given service to invoke, as defined in the <wsdl\:port> element.
systemrules.wsconfig.parameter.service=Service name to invoke, as defined in the WSDL\u2019s <wsdl\:service> element.
systemrules.wsconfig.parameter.wsdlcredentials=Credentials with which to access the web service\u2019s WSDL, created with a\!wsHttpCredentials().
systemrules.wsconfig.parameter.wsdlurl=The URL of the WSDL for the web service.
systemrules.wshttpcredentials.description=Creates authentication credentials for use with a\!wsConfig().
systemrules.wshttpcredentials.parameter.domain=The domain against which to authenticate, if required by the authentication scheme.
systemrules.wshttpcredentials.parameter.password=The password used to authenticate.
systemrules.wshttpcredentials.parameter.username=The username used to authenticate.
systemrules.wshttpheaderfield.description=Creates an HTTP header for use with a\!wsConfig().
systemrules.wshttpheaderfield.parameter.name=The name of the header.
systemrules.wshttpheaderfield.parameter.value=The value of the header.
systemrules.wsusernametoken.description=Creates a WS-Security Username Token for use with a\!wsConfig().
systemrules.wsusernametoken.parameter.password=The password used to authenticate.
systemrules.wsusernametoken.parameter.username=The username used to authenticate.
systemrules.wsusernametokenscs.description=Retrieves a WS-Security Username Token retrieved from the Secure Credential Store for use with a\!wsConfig().
systemrules.wsusernametokenscs.parameter.systemkey=The key of the corresponding Secure Credential Store external system.
systemrules.wsusernametokenscs.parameter.useperuser=Determines if the current user\u2019s credentials are used instead of system-wide credentials. Default\: false.