Table of Contents

Search

  1. Preface
  2. Overview, Downloading, and Installing
  3. Administration API
  4. Identity Service API
  5. Screenflow Programming and SDK
  6. ActiveVOS WSHT API
  7. Embedding Request Forms in Standalone Web Pages
  8. XML-JSON for Process Central

7. APIs, SDKs, and Services

7. APIs, SDKs, and Services

Built-In Data Types

Built-In Data Types

Process Designer ships with a variety of supported data types along with a default renderer for each. Data types can be customized with a variety of options that affect how a field is rendered and validated.
Type: boolean
The
boolean
data type supports rendering of true/false data in either a check box control or a pair of radio buttons with the labels
Yes/No
or
No/Yes.
Options are as follows:
Option Name
Description
boolean_show_as
Choose how the boolean is rendered. Choices are:
  • Checkbox
  • Yes/No
  • No/Yes
Type: currency
The
currency
data type extends the base type double and inherits all the options supported by
double
. It also has the following options:
Option Name
Description
scale
The maximum number of digits to the right of the decimal point. If you enter 0, there cannot be digits to the right of the decimal point. The default is 2
Type: date
The
date
data type renders a date picker control to choose a date that does not have a time component. There are no options to this data type.
Type: datetime
The
datetime
data type renders a date/time picker control to choose a date and time. There are no options to this data type.
Type: double
The
double
data type can contain fractional portions. Options are as follows:
Option Name
Description
precision
Total number of digits, including those to the left and the right of the decimal place
scale
Maximum number of digits to the right of the decimal place
hover_text
Tool tip value displayed when a user hovers over the control
min
The minimum value allowed
max
The maximum value allowed
Type: email
An
email
data type contains an email address.
Type: formatted string
The
formattedString
data type has a base type of string so it inherits all of its options. It also has the following options:
Option Name
Description
format
A custom format; see http://digitalbush.coojects/masked-input-plugin/ for supported formatting syntax
Type: id
The
id
type is used to for
ObjectId
fields. This type extends the base
string
type, so it inherits all of its options. It also has the following options:
Option Name
Description
referenceTo
The "name" of the object defining the ID field.
display_as_name
Boolean value indicating if the
ObjectId
or object name is rendered on screen.
Type: int
The
int
data type contains numbers with no fractional portion. Options are as follows:
Option Name
Description
digits
The maximum number of digits that an integer can have
hover_text
Tool tip value displayed when a user hovers over the control
min
The minimum value allowed
max
The maximum value allowed
Type: multipicklist
The
multipicklist
data type is a picklist from which one or more values can be selected and includes a set of enumerated values. This type extends
picklist
. Options are as follows:
Option Name
Description
multiSelect
When set to true, multiselection within picklists can be used
Type: objectlist
An
objectlist
data type represents one or more object reference. It extends the base type
picklist
. It also has the following options:
Option Name
Description
referenceTo
The name of the object the
ObjectList
will reference
display-options
A complex JSON structure that contains columns to display and any pagination and filtering options when references are stored in a data table.
multiSelect
When set to true (which is the default), multiple values can be selected from the picklist
Type: percent
The
percent
data type extends the base type
double
and inherits all the options supported by
double
. It also has the following options:
Option Name
Description
precision
The maximum number of digits in the number. The default: 5.
scale
The maximum number of digits to the right of the decimal point. If you enter 0, there are no digits to the right of the decimal point. The default: 2.
min
The minimum percent value. The default: 0
max
The maximum percent value. The default: 100
Type: phone
The
phone
data type contains phone numbers, which can include alphabetic characters. A guide's designer is responsible for phone number formatting.
Type: picklist
The
picklist
data type is a list or choice that is rendered as an HTML option list. The picklist type extends the
string
base type. It also has the following options:
Option Name
Description
values
Picklist values in the form of the picklist element type. This is a comma-separated list of the items in the list.
Type: reference
The
reference
data type is used when a field refers to the
ObjectId
of another object, which makes the
referenceTo
option required and the value will be the name of the object being referred to. The base type of reference is
id
, so it inherits all of the
id
and
string
options plus those shown in the following table:
Option Name
Description
display-options
A complex JSON structure that contains columns to display and any pagination and filtering options when references are stored in a data table
Type: richtextarea
A
richtextarea
data type extends the base
textarea
type and supports rich formatting of text. It also has the following options:
Option Name
Description
text_width
The width of the text area relative to the guide's width.
text_height
The number of rows within the area the guide displays into which the user can type text.
length
The maximum number of characters that can be entered in the text area.
text_size
The size of the displayed text.
Type: string
Character strings are of data type
string
and contain text. Some have length restrictions, depending upon the data being stored. Options are as follows:
Option Name
Description
text_size
Font size of the text on the screen
hover_text
Tool tip value displayed when a user hovers over the control
length
The number of characters in the string
Type: textarea
A
textarea
type extends the base string type, so it inherits all of the string option. It also has the options shown in the following table:
Option Name
Description
text_width
The width of the text area relative to the guide's width.
text_height
The number of rows within the area the guide displays into which the user can type text.
length
The maximum number of characters that can be entered in the text area.
text_size
Font size of the text on the screen
Type: time
A
time
data type handles time values.
Type: url
A
url
data type contains a URL. Options are as follows:
Option Name
Description
urlDisplayReadonlyAs
Your choices are Link, Button, or IFrame
urlDisplayReadOnlyLabel
Text that identifies the contents of the field.
frame_height
The height of the area in which the URL's target is displayed.
frame_width
The width of the area in which the URL's target is displayed.