Global

Members

readonlyAlertColorStylestring

Enum for AlertColorStylevalues. Available alert color styles
Properties:
Name Type Default Description
Primary string P
Info string I
Success string S
Warning string W
Danger string G

readonlyAutoCustomSelectionstring

Enum for AutoCustomSelectionvalues. Selection with choices: auto or custom
Properties:
Name Type Default Description
Auto string auto
Custom string custom

readonlyBadgeColorStylestring

Enum for BadgeColorStylevalues. Available badge color styles
Properties:
Name Type Default Description
Default string D
Primary string P
Info string I
Success string S
Warning string W
Danger string E

readonlyBadgeShapeStylestring

Enum for BadgeShapeStylevalues. Available Badge Shape Styles
Properties:
Name Type Default Description
Badge string B
Label string L
Tag string T

readonlyBPMDocAttachModestring

Enum for BPMDocAttachModevalues. Available attachment modes for BPM attachments
Properties:
Name Type Default Description
None string None
Any_Properties string Any Properties
All_Properties string All Properties

readonlyButtonColorStylestring

Enum for ButtonColorStylevalues. Available Button Color Styles
Properties:
Name Type Default Description
Default string D
Primary string P
Info string I
Success string S
Warning string W
Danger string G

readonlyButtonShapeStylestring

Enum for ButtonShapeStylevalues. Available button shape styles
Properties:
Name Type Default Description
Default string D
Rounded string R
Flat string F

readonlyButtonSizeStylestring

Enum for ButtonSizeStylevalues. Available button size styles
Properties:
Name Type Default Description
Default string D
Large string L
Small string S
Extra_Small string X

readonlyCalendarTypestring

Enum for CalendarTypevalues. Business object that provides selection options for the type of calendar to display.
Properties:
Name Type Default Description
Gregorian string gregorian
Hebrew string hebrew
Islamic string islamic

readonlyCaptionPlacementstring

Enum for CaptionPlacementvalues. Available caption placements
Properties:
Name Type Default Description
Top string T
Left string L
Bottom string B
Right string R

readonlyChartBackgroundColorStylestring

Enum for ChartBackgroundColorStylevalues. Available chart background color styles
Properties:
Name Type Default Description
Transparent string T
Primary string P
Info string I
Success string S
Warning string W
Danger string G

readonlyChartDataModestring

Enum for ChartDataModevalues. Available chart data modes.  I.E. where does chart data come from
Properties:
Name Type Default Description
From_Service string S
From_Config_Option string B

readonlyChartDataSeriesColorStylestring

Enum for ChartDataSeriesColorStylevalues. Available chart data series color styles
Properties:
Name Type Default Description
Default string L
Primary string P
Info string I
Success string S
Warning string W
Danger string G

readonlyChartGridLinesStylestring

Enum for ChartGridLinesStylevalues. Available chart grid lines styles
Properties:
Name Type Default Description
None string N
Light string L
Dark string D

readonlyChartKindstring

Enum for ChartKindvalues. Available chart kinds (types of charts)
Properties:
Name Type Default Description
Bar string B
Line string L
Area string A
Spline string S
Area_Spline string R
Step string T
Area_Step string E
Pie string P
Doughnut string D

readonlyChartLegendPlacementstring

Enum for ChartLegendPlacementvalues. Available chart legend placements
Properties:
Name Type Default Description
None string N
Bottom_Center string B
Middle_Right string M

readonlyChartSDSColorStylestring

Enum for ChartSDSColorStylevalues. Available chart single data series color styles
Properties:
Name Type Default Description
Light string L
Primary string P
Info string I
Success string S
Warning string W
Danger string G

readonlyChartTooltipStylestring

Enum for ChartTooltipStylevalues. Available chart tooltip styles
Properties:
Name Type Default Description
None string N
Grouped string G
Ungrouped string U

readonlyChartTypestring

Enum for ChartTypevalues. Available chart types
Properties:
Name Type Default Description
Bar string B
Line string L
Doughnut string D
Pie string P
Radar string R
Polar_Area string O

readonlyChartXYAxisStylestring

Enum for ChartXYAxisStylevalues. Available chart XY axis styles
Properties:
Name Type Default Description
None string N
Light___Labels_Only string K
Dark___Labels_Only string C
Light string L
Dark string D

readonlyCollapsiblePanelColorStylestring

Enum for CollapsiblePanelColorStylevalues. Available collapsible panel color styles
Properties:
Name Type Default Description
Default string D
Primary string P
Success string S
Info string I
Warning string W
Danger string G

readonlyColumnVisibilitystring

Enum for ColumnVisibilityvalues. Available column visibilities
Properties:
Name Type Default Description
Visible string VISIBLE
Read_Only string READONLY
None string NONE

readonlyContentListColumnTypestring

Enum for ContentListColumnTypevalues. Available ECM content column types
Properties:
Name Type Default Description
Doc_Name_Clickable string cmis:name
Doc_Name string DocumentTitle
Type_File_or_URL string IBM_BPM_Document_FileType
File_Name string IBM_BPM_Document_FileNameURL
Version_Label string cmis:versionLabel
Last_Modified_By string cmis:lastModifiedBy
Last_Modified_Date string cmis:lastModificationDate
Created_By string cmis:createdBy
Created_Date string cmis:creationDate
MIME_Type string cmis:contentStreamMimeType
Size_or_Length string cmis:contentStreamLength
Thumbnail string _thumbnail

CurrencyCodeSelectionTypestring

Enum for CurrencyCodeSelectionTypevalues. * @readonly
Properties:
Name Type Default Description
None string NONE
United_Arab_Emirates_dirham string AED
Afghan_afghani string AFN
Albanian_lek string ALL
Armenian_dram string AMD
Netherlands_Antillean_guilder string ANG
Angolan_kwanza string AOA
Argentine_peso string ARS
Australian_dollar string AUD
Aruban_florin string AWG
Azerbaijani_manat string AZN
Bosnia_and_Herzegovina_convertible_mark string BAM
Barbados_dollar string BBD
Bangladeshi_taka string BDT
Bulgarian_lev string BGN
Bahraini_dinar string BHD
Burundian_franc string BIF
Bermudian_dollar string BMD
Brunei_dollar string BND
Boliviano string BOB
Bolivian_Mvdol string BOV
Brazilian_real string BRL
Bahamian_dollar string BSD
Bhutanese_ngultrum string BTN
Botswana_pula string BWP
Belarusian_ruble string BYR
Belize_dollar string BZD
Canadian_dollar string CAD
Congolese_franc string CDF
WIR_Euro string CHE
Swiss_franc string CHF
WIR_Franc string CHW
Unidad_de_Fomento string CLF
Chilean_peso string CLP
Chinese_yuan string CNY
Colombian_peso string COP
Unidad_de_Valor_Real string COU
Costa_Rican_colon string CRC
Cuban_convertible_peso string CUC
Cuban_peso string CUP
Cape_Verde_escudo string CVE
Czech_koruna string CZK
Djiboutian_franc string DJF
Danish_krone string DKK
Dominican_peso string DOP
Algerian_dinar string DZD
Egyptian_pound string EGP
Eritrean_nakfa string ERN
Ethiopian_birr string ETB
Euro string EUR
Fiji_dollar string FJD
Falkland_Islands_pound string FKP
Pound_sterling string GBP
Georgian_lari string GEL
Ghanaian_cedi string GHS
Gibraltar_pound string GIP
Gambian_dalasi string GMD
Guinean_franc string GNF
Guatemalan_quetzal string GTQ
Guyanese_dollar string GYD
Hong_Kong_dollar string HKD
Honduran_lempira string HNL
Croatian_kuna string HRK
Haitian_gourde string HTG
Hungarian_forint string HUF
Indonesian_rupiah string IDR
Israeli_new_sheqel string ILS
Indian_rupee string INR
Iraqi_dinar string IQD
Iranian_rial string IRR
"Icelandic_króna" string ISK
Jamaican_dollar string JMD
Jordanian_dinar string JOD
Japanese_yen string JPY
Kenyan_shilling string KES
Kyrgyzstani_som string KGS
Cambodian_riel string KHR
Comoro_franc string KMF
North_Korean_won string KPW
South_Korean_won string KRW
Kuwaiti_dinar string KWD
Cayman_Islands_dollar string KYD
Kazakhstani_tenge string KZT
Lao_kip string LAK
Lebanese_pound string LBP
Sri_Lankan_rupee string LKR
Liberian_dollar string LRD
Lesotho_loti string LSL
Lithuanian_litas string LTL
Latvian_lats string LVL
Libyan_dinar string LYD
Moroccan_dirham string MAD
Moldovan_leu string MDL
Malagasy_ariary string MGA
Macedonian_denar string MKD
Myanma_kyat string MMK
Mongolian_tugrik string MNT
Macanese_pataca string MOP
Mauritanian_ouguiya string MRO
Mauritian_rupee string MUR
Maldivian_rufiyaa string MVR
Malawian_kwacha string MWK
Mexican_peso string MXN
Mexican_Unidad_de_Inversion_UDI string MXV
Malaysian_ringgit string MYR
Mozambican_metical string MZN
Namibian_dollar string NAD
Nigerian_naira string NGN
"Nicaraguan_córdoba" string NIO
Norwegian_krone string NOK
Nepalese_rupee string NPR
New_Zealand_dollar string NZD
Omani_rial string OMR
Panamanian_balboa string PAB
Peruvian_nuevo_sol string PEN
Papua_New_Guinean_kina string PGK
Philippine_peso string PHP
Pakistani_rupee string PKR
"Polish_złoty" string PLN
"Paraguayan_guaraní" string PYG
Qatari_riyal string QAR
Romanian_new_leu string RON
Serbian_dinar string RSD
Russian_rouble string RUB
Rwandan_franc string RWF
Saudi_riyal string SAR
Solomon_Islands_dollar string SBD
Seychelles_rupee string SCR
Sudanese_pound string SDG
Swedish_krona string SEK
Singapore_dollar string SGD
Saint_Helena_pound string SHP
Sierra_Leonean_leone string SLL
Somali_shilling string SOS
Surinamese_dollar string SRD
South_Sudanese_pound string SSP
"São_Tomé_and_Príncipe_dobra" string STD
Syrian_pound string SYP
Swazi_lilangeni string SZL
Thai_baht string THB
Tajikistani_somoni string TJS
Turkmenistani_manat string TMT
Tunisian_dinar string TND
"Tongan_paʻanga" string TOP
Turkish_lira string TRY
Trinidad_and_Tobago_dollar string TTD
New_Taiwan_dollar string TWD
Tanzanian_shilling string TZS
Ukrainian_hryvnia string UAH
Ugandan_shilling string UGX
United_States_dollar string USD
United_States_dollar_next_day string USN
United_States_dollar_same_day string USS
Uruguay_Peso_en_Unidades_Indexadas string UYI
Uruguayan_peso string UYU
Uzbekistan_som string UZS
"Venezuelan_bolívar_fuerte" string VEF
Vietnamese_dong string VND
Vanuatu_vatu string VUV
Samoan_tala string WST
CFA_franc_BEAC string XAF
Silver string XAG
Gold string XAU
European_Composite_Unit_EURCO string XBA
European_Monetary_Unit_EMU_6 string XBB
European_Unit_of_Account_9_EUA_9 string XBC
European_Unit_of_Account_17_EUA_17 string XBD
East_Caribbean_dollar string XCD
Special_drawing_rights string XDR
UIC_franc string XFU
CFA_Franc_BCEAO string XOF
Palladium string XPD
CFP_franc string XPF
Platinum string XPT
Yemeni_rial string YER
South_African_rand string ZAR
Zambian_kwacha string ZMK
Zimbabwe_dollar string ZWL

readonlyDatePickerColorStylestring

Enum for DatePickerColorStylevalues. Available date picker color styles
Properties:
Name Type Default Description
Default string D
Info string I
Success string S
Warning string W
Danger string E

readonlyDatePickerMinViewModestring

Enum for DatePickerMinViewModevalues. Available date picker minimum view modes
Properties:
Name Type Default Description
Days string 0
Months string 1
Years string 2

readonlyDatePickerOrientationstring

Enum for DatePickerOrientationvalues. Available data picker calendar orientations (relative to the text field)
Properties:
Name Type Default Description
Auto string A
Top_Auto string TA
Bottom_Auto string BA
Auto_Left string AL
Top_Left string TL
Bottom_Left string BL
Auto_Right string AR
Top_Right string TR
Bottom_Right string BR

readonlyDatePickerStartViewstring

Enum for DatePickerStartViewvalues. Available start views for the calendar displayed by a date picker
Properties:
Name Type Default Description
Month string 0
Year string 1
Decade string 2

readonlyDatePickerTypestring

Enum for DatePickerTypevalues. Available entry types for date picker control
Properties:
Name Type Default Description
Text_Input string TI
Inline string I

readonlyDatePickerWeekStartstring

Enum for DatePickerWeekStartvalues. Available start of week days for Date Picker calendar display
Properties:
Name Type Default Description
Sunday string 0
Monday string 1
Tuesday string 2
Wednesday string 3
Thursday string 4
Friday string 5
Saturday string 6

readonlyExcelFileTypestring

Enum for ExcelFileTypevalues. Available file types for Data Export control output
Properties:
Name Type Default Description
Microsoft_Excel_2007plus_file_type_xlsx string xlsx
Comma_Separated_Values_filet_type_csv string csv

GeoMonitoringModestring

Enum for GeoMonitoringModevalues. * @readonly
Properties:
Name Type Default Description
Once_on_Load string L
Continuous string C
Initially_Stopped string S

readonlyGlobalTextDirectionstring

Enum for GlobalTextDirectionvalues. Available text diretctions for LTR display
Properties:
Name Type Default Description
Auto string D
Left_to_Right string L
Right_to_Left string R

GoogleMapTypestring

Enum for GoogleMapTypevalues. * @readonly
Properties:
Name Type Default Description
Roadmap string ROADMAP
Satellite string SATELLITE
Hybrid string HYBRID
Terrain string TERRAIN

readonlyHorizontalAlignmentstring

Enum for HorizontalAlignmentvalues. Available Horizontal layout alignments
Properties:
Name Type Default Description
Justified string J
Left string L
Center string C
Right string R

readonlyIconColorStylestring

Enum for IconColorStylevalues. Available Icon control color styles
Properties:
Name Type Default Description
Default string D
Primary string P
Info string I
Success string S
Warning string W
Danger string G
Transparent string T

readonlyImageCaptionPositionstring

Enum for ImageCaptionPositionvalues. Available Image control caption positions
Properties:
Name Type Default Description
Top string T
Left string L
Bottom string B
Right string R

readonlyInputGroupButtonKindstring

Enum for InputGroupButtonKindvalues. Available Input group control kids of buttons to display
Properties:
Name Type Default Description
Icon string I
Text string T
Menu string M

readonlyInputGroupButtonLocstring

Enum for InputGroupButtonLocvalues. Available Input Group button locations
Properties:
Name Type Default Description
Left string L
Right string R

readonlyInvisibilitystring

Enum for Invisibilityvalues. Available Visibilities for controls
Properties:
Name Type Default Description
Hidden string H
None string N

readonlyLabelPlacementstring

Enum for LabelPlacementvalues. Available placements for the Label on controls which support one
Properties:
Name Type Default Description
Top string T
Left string L

readonlyLayoutFlowstring

Enum for LayoutFlowvalues. Available flow values for Layout controls (Horizontal and Vertical)
Properties:
Name Type Default Description
Vertical string V
Vertical_Tight string Y
Horizontal string P
Horizontal_Inline_Scroll string H
Horizontal_Tight string I
Horizontal_Auto_wrap string W

readonlyLayoutFlow2string

Enum for LayoutFlow2values. Available layout flows
Properties:
Name Type Default Description
Horizontal string P
Horizontal_Inline_Scroll string H
Horizontal_Tight string I
Horizontal_Auto_wrap string W
Vertical string V
Vertical_Tight string Y

readonlyLinkTypestring

Enum for LinkTypevalues. Available link types for Link controls
Properties:
Name Type Default Description
Boundary_Event string B
URL string U

readonlyMapSourcestring

Enum for MapSourcevalues. Available map sources
Properties:
Name Type Default Description
OpenStreetMap string osm
Bing_Maps string bing

readonlyMapTypestring

Enum for MapTypevalues. Available map types
Properties:
Name Type Default Description
Roadmap string 0
Satellite string 1
Hybrid string 2
Enum for MenuBadgeShapevalues. Available shapes for badges used in menu controls
Properties:
Name Type Default Description
None string N
Square string S
Rounded string R
Enum for MenuHorizontalAlignmentvalues. Available horizontal placement for Menus
Properties:
Name Type Default Description
Left string L
Right string R
Enum for MenuItemTypevalues. Available types of menu items
Properties:
Name Type Default Description
Label string L
Separator string S
Section_Header string H
Enum for MenuVerticalAlignmentvalues. Available vertical alignent for menus
Properties:
Name Type Default Description
Bottom string B
Top string T

readonlyNoteColorStylestring

Enum for NoteColorStylevalues. Available color styles for the Note control
Properties:
Name Type Default Description
Default string D
Primary string P
Success string S
Info string I
Warning string W
Danger string G

readonlyNoteLabelStylestring

Enum for NoteLabelStylevalues. Available label styles for the Note control
Properties:
Name Type Default Description
Default string H4
Heading_1 string H1
Heading_2 string H2
Heading_3 string H3

readonlyOutputTextSizeStylestring

Enum for OutputTextSizeStylevalues. Available text size styles
Properties:
Name Type Default Description
Default string D
Super_Large string R
Extra_Large string X
Larger string G
Large string L
Small string S
Smaller string M

readonlyOutputTextWeightStylestring

Enum for OutputTextWeightStylevalues. Available text weight styles
Properties:
Name Type Default Description
Default string D
Slim string S
Normal string N
Semi_bold string M
Bold string B

page

Global page object which points to the top of the view tree. Valid everywhere, but should only be used inside coach page javascript, not in Coach Views
Properties:
Name Type Description
ui bpmext.ui.View Reference to the top of the view tree (provides methods to access all other views in the tree)

readonlyPageLayoutTargetstring

Enum for PageLayoutTargetvalues. Available page layout targets
Properties:
Name Type Default Description
Mobil_or_Tablet_or_Desktop string MTD
Mobile_or_Desktop string MD

readonlyPanelColorStylestring

Enum for PanelColorStylevalues. Available panel color styles
Properties:
Name Type Default Description
Default string D
Primary string P
Success string S
Info string I
Warning string W
Danger string G
Transparent string T

readonlyParagraphColorStylestring

Enum for ParagraphColorStylevalues. Available paragraph color styles
Properties:
Name Type Default Description
Default string H
Normal string D
Muted string M
Light_gray string L
Primary string P
Info string I
Success string S
Warning string W
Danger string G

readonlyQRErrorCorrectionLevelstring

Enum for QRErrorCorrectionLevelvalues. Available error correction levels for QRCodes
Properties:
Name Type Default Description
Level_L___up_to_7_percent_damage string L
Level_M___up_to_15_percent_damage string M
Level_Q___up_to_25_percent_damage string Q
Level_H___up_to_30_percent_damage string H

readonlySelectItemsLookupModestring

Enum for SelectItemsLookupModevalues. Available lookup modes for select style controls
Properties:
Name Type Default Description
Start_Empty string E
Items_From_Service string S
Items_From_Static_List string L
Items_From_Config_Option string B

readonlyServiceDataTableCellRenderTypestring

Enum for ServiceDataTableCellRenderTypevalues. Available render types for Service Data Tables
Properties:
Name Type Default Description
Simple_HTML string H
Custom string C

readonlyServiceIndicatorTypestring

Enum for ServiceIndicatorTypevalues. Available types of "Running" indicators to indicate AJAX service running
Properties:
Name Type Default Description
None string X
Spinner string S
Refresh string R
Cog string C

readonlySignatureColorStylestring

Enum for SignatureColorStylevalues. Available color styles for the Signature control
Properties:
Name Type Default Description
Default string D
Success string S
Info string I
Warning string W
Danger string G

readonlySplitPaneHandleLocationstring

Enum for SplitPaneHandleLocationvalues. Available positions for the handle in a split panel control
Properties:
Name Type Default Description
None string N
Middle string M
Top string S
Bottom string E

readonlyStandardFileTypestring

Enum for StandardFileTypevalues. Available file types that can be specified for Uploader and Dropzone controls
Properties:
Name Type Default Description
Custom string *
Excel_Files_2003_thru_2007_type_xls string application/vnd.ms-excel
Excel_Files_2010_and_up_type_xlsx string application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Word_Files_2003_thru_2007_type_doc string application/msword
Word_Files_2010_and_up_type_docx string application/vnd.openxmlformats-officedocument.wordprocessingml.document
Text_Files string text/plain
Image_Files_types_png_or__jpg_or__etc string image/*
Video_Files_types_avi_or__mpeg_or__mp4_or__etc string video/*
Audio_Files_types_mp3_or__wav_or__etc string audio/*
HTML_Files_types_htm_or__html string text/html

readonlySwitchLabelTypestring

Enum for SwitchLabelTypevalues. Available types of labels to use on the Switch control
Properties:
Name Type Default Description
Text string T
Icon string I

readonlySwitchShapeStylestring

Enum for SwitchShapeStylevalues. Available shape styles for the Switch control
Properties:
Name Type Default Description
Default string D
Square string S
Modern string M

readonlySwitchSizeStylestring

Enum for SwitchSizeStylevalues. Available size styles for Switch control
Properties:
Name Type Default Description
Default string D
Large string L
Small string S

readonlyTabColorStylestring

Enum for TabColorStylevalues. Available panel color styles
Properties:
Name Type Default Description
Default string D
Primary string P
Success string S
Info string I
Warning string W
Danger string G

readonlyTableCellRenderTypestring

Enum for TableCellRenderTypevalues. Available render types for the Table control
Properties:
Name Type Default Description
Coach_View string V
Seamless_Coach_View string S
Simple_HTML string H
Custom string C

readonlyTableColorStylestring

Enum for TableColorStylevalues. Available color styles for table controls
Properties:
Name Type Default Description
None string D
Light string L
Primary string P
Info string I
Success string S
Warning string W
Danger string G

readonlyTableColumnVisibilitystring

Enum for TableColumnVisibilityvalues. Available table column visibities for table controls
Properties:
Name Type Default Description
Visible string V
Read_Only string R
None string N

readonlyTableLayoutBorderStylestring

Enum for TableLayoutBorderStylevalues. Available styles for the layout border in table layout control
Properties:
Name Type Default Description
Separate string S
Collapse string C

readonlyTableSelectionModestring

Enum for TableSelectionModevalues. Available selection modes for table controls
Properties:
Name Type Default Description
None string N
Single string S
Multiple string M

readonlyTableStylestring

Enum for TableStylevalues. Available table styles used when displaying table data
Properties:
Name Type Default Description
Default string D
Elegant string E
Bordered string B
Striped string S
Hover_Row string H
Condensed string C

readonlyTabsStylestring

Enum for TabsStylevalues. Available styles for the tabs in a Tab Control
Properties:
Name Type Default Description
Default string D
Simple string S

readonlyTextAlignmentstring

Enum for TextAlignmentvalues. Available text alignments
Properties:
Name Type Default Description
Left string L
Center string C
Right string R

readonlyTextColorStylestring

Enum for TextColorStylevalues. Available color styles for the text in a Status Box control
Properties:
Name Type Default Description
Default string D
Primary string P
Success string S
Info string I
Warning string W
Error string E

readonlyTextSizeStylestring

Enum for TextSizeStylevalues. Available text size styles
Properties:
Name Type Default Description
Default string D
Large string L
Small string S

readonlyTextStatusStylestring

Enum for TextStatusStylevalues. Available text styles for the Status control
Properties:
Name Type Default Description
None string N
Default string D
Dark string K
Simple string S

readonlyTooltipColorStylestring

Enum for TooltipColorStylevalues. Available color styles for the Tooltip control
Properties:
Name Type Default Description
Default string D
Primary string P
Info string I
Success string S
Warning string W
Danger string G

readonlyTooltipHorizontalAlignmentstring

Enum for TooltipHorizontalAlignmentvalues. Available horizontal alignments for the tooltip control
Properties:
Name Type Default Description
Left string L
Center string C
Right string R

readonlyTooltipVerticalAlignmentstring

Enum for TooltipVerticalAlignmentvalues. Available vertical alignements for the Tooltip control
Properties:
Name Type Default Description
Top string T
Bottom string B

readonlyTypeAheadItemsLookupModestring

Enum for TypeAheadItemsLookupModevalues. Available lookup modes for the Type Ahead control
Properties:
Name Type Default Description
Start_Empty string E
Items_From_Service string S
Items_From_List string L

readonlyURLTypestring

Enum for URLTypevalues. Available types of URL
Properties:
Name Type Default Description
Web string Web
External string External
Server string Server
Design string Design

readonlyVerticalAlignmentstring

Enum for VerticalAlignmentvalues. Available vertical alignments
Properties:
Name Type Default Description
Top string T
Middle string M
Bottom string B

readonlyVideoSourceTypestring

Enum for VideoSourceTypevalues. Available video source types
Properties:
Name Type Default Description
MP4 string video/mp4
WEBM string video/webm
FLV string video/flv

readonlyVisibilitystring

Enum for Visibilityvalues. Available visibility values
Properties:
Name Type Default Description
Visible string V
None string N
Hidden string H

readonlyWellColorDarknessstring

Enum for WellColorDarknessvalues. Available color darkness values for Well controls
Properties:
Name Type Default Description
None string N
Dark string D
Darker string R

readonlyWellIconPositionstring

Enum for WellIconPositionvalues. Available icon positions for the Well control
Properties:
Name Type Default Description
Bottom_Right string BR
Bottom_Left string BL
Top_Right string TR
Top_Left string TL

Type Definitions

AddressComponentObject

Properties:
Name Type Description
shortName String -
longName String -
type String -

AjaxErrorObject

This object is returned by an AJAX service that ends in error.
Properties:
Name Type Description
errorText String Error description
errorCode String Error Code
serviceInError String Name of the AJAX service in Error

BoxFactorObject

Box factors used with responsive controls
Properties:
Name Type Description
name String Box factor name. This is the name that will be referenced by responsive horizontal and vertical layouts
widthUpTo Integer Maximum width this box factor applies to

BPMDocDeletionObject

Facilitates ECM document deletions
Properties:
Name Type Description
id String Document ID to be deleted
allVersions Boolean When true all versions of the document are deleted

BPMDocQueryObject

Document query paramters used with ECM
Properties:
Name Type Description
maxItems Integer maximum items to return
skipCount Integer number of documents to skip in the returned query before returning maxItems
searchAllVersions Boolean return all versions when multiple versions exist
cmisQuery String CMIS query string to be used
versionIdentifier String For US 921

ColumnSpecObject

Data export column formatting specification
Properties:
Name Type Description
columnFormatString String Strings used to determine data formatting for each column in output file, according to Microsoft formatting standards, which can be found here. Note that any color styling that is set will not be kept when exporting to csv.

CSSSpecObject

CSS specification information
Properties:
Name Type Description
cssFile String CSS file name/url (e.g. "CompanyStyle1.css"). If css file has not been uploaded to process designer, a full url is needed. Otherwise, only the name and extension are required
cssType URLType File/URL category. If css file has been uploaded to process designer, this can be found by looking under files for the section the css file is under. Otherwise, URL type should be external
appAcronym String Acronym of the process app the css file is stored in
themeName String Name to use when referencing this theme

DataDimensionObject

Dimension information used for Drill down
Properties:
Name Type Description
name String Name of this dimension
value ANY Value of this dimension

DataPointObject

Object which describes a data point on a chart
Properties:
Name Type Description
value Decimal The value of the point
label String The label of the associated point

DataSeriesObject

Object which describes a Data Series
Properties:
Name Type Description
seriesName String Name for the Data Series
dataPoints DataPoint List of Data Points to include in the Data Series

DatePickerDisabledWeekDaysObject

Indicator of which days of the week are disabled.  I.E. unavailable in the calendar
Properties:
Name Type Description
Sunday Boolean Disable Sundays
Monday Boolean Disable Mondays
Tuesday Boolean Disable Tuesdays
Wednesday Boolean Disable Wednesdays
Thursday Boolean Disable Thursdays
Friday Boolean Disable Fridays
Saturday Boolean Disable Saturdays

DeviceInfoObject

Data returned by the Device Info control
Properties:
Name Type Description
isAndroid Boolean Indicates an Android device
isIEMobile Boolean Indicates an IE Mobile device
isIPad Boolean Indicates an IPad
isIPhone Boolean Indicates an IPhone
os String Operating System identifier
screenWidth Integer Screen width of the device in pixels
clientWidth Integer Client width of the device in pixels
browserName String Name of the browser in use
browserMajorVersion String Version of the browser being used
language String Language specification

DrillDownInputObject

Input for a Drill down chart
Properties:
Name Type Description
drillDownStack DataDimension The drill down stack for this chart.  I.E. drill down hierarchy

DrillDownOutputObject

Drill down information
Properties:
Name Type Description
dataSeries DataSeries The data series being displayed
availableForDrillDown DataDimension Dimensions available for drill down
drillDownStack DataDimension The associated drill down stack

GeoLocationObject

Properties:
Name Type Description
latitude Decimal -
longitude Decimal -
accuracy Decimal -
altitude Decimal -
altitudeAccuracy Decimal -
heading Decimal -
speed Decimal -
time Date -
timestamp Decimal -
errorCode Integer -
errorMessage String -

I18NDataObject

Data to be used by I18N enabled controls
Properties:
Name Type Description
gregorianCalendar I18NGregorianCalendar Gregorian calendar information
other ANY Additional information

I18NGregorianCalendarObject

Gregorian calendar definition used in I18N enabled date picker controls
Properties:
Name Type Description
days I18NGregorianCalendarDays Day names to use
daysShort I18NGregorianCalendarDays Abbreviated day names to display
daysMin I18NGregorianCalendarDays Minimum day names to display
months I18NGregorianCalendarMonths Month names to display
monthsShort I18NGregorianCalendarMonths Abbreviated Month names to display
clear String Text for clear button
today String Text for Today button

I18NGregorianCalendarDaysObject

Day names to be used when I18N is enabled. Default is English
Properties:
Name Type Description
sunday String Sunday name
monday String Monday name
tuesday String Tuesday name
wednesday String Wednesday Name
thursday String Thursday name
friday String Friday name
saturday String Saturday name

I18NGregorianCalendarMonthsObject

Month Names for I18 enabled date picker controls.  Default is English
Properties:
Name Type Description
january String January name
february String February name
march String March name
april String April name
may String May name
june String June name
july String July name
august String August name
september String September name
october String October name
november String November name
december String December name

LatLongObject

Latitude and Longitude information
Properties:
Name Type Description
latitude Decimal Location latitude
longitude Decimal Location longitude
Specifications for a Menu Item
Properties:
Name Type Description
command String Command to execute when this menu item is selected
itemType MenuItemType Type of menu item this is (affects how item is displayed)
icon String Icon to add to this item (leave blank for no icon)
itemText String Text to display for this item (no text is displayed for separators)
badgeShape MenuBadgeShape Badge shape to use (if any)
badgeColor TooltipColorStyle Badge color style
badgeText String Text to add to badge

ResponsiveBehaviorObject

Responsive Behavior data for layout controls
Properties:
Name Type Description
boxFactorName String Name of responsive sensor box factor to apply these attributes to
childLayout LayoutFlow Layout to use with specified box factor
childAlign HorizontalAlignment Alignment to use with specified box factor
childWidth String Child widths to use with this box factor (e.g. 60%) Note that several (space-delimited) widths can be specified for the various controls contained in the layout - e.g. 80% 20%
visibility Visibility Visibility settings to use with this box factor
width String Section width to use with this box factor
height String Section height to use at this box factor
cssStyle String CSS styles to apply at this box factors
cssClass String CSS classes to add at this box factor

SelectDataMappingObject

Specifications for the Display and Value properties on select type controls
Properties:
Name Type Description
optionValueProperty String Property to use for option values
optionDisplayProperty String Property to use for option display

ServiceDataTableColumnObject

Column data used for Service Data Tables
Properties:
Name Type Description
dataElementName String Name of the data element to display for column
renderAs ServiceDataTableCellRenderType Select how cell should be rendered
visibility TableColumnVisibility Column visibility
sortable Boolean If enabled, table may be sorted using this column
options String Optional data to pass to cell, depending on type of data in column. Includes:  - Decimal: thousandsSeparator, decimalPlaces, decimalSeparator, postfix, prefix  - DatePicker: datePattern  - Link: href  - Integer: thousandSeparator
css String CSS options to add to column (e.g., color:#00ff00)
width String Column width
label String Set the column label

SplitPaneSpecObject

Specification used with Split panels
Properties:
Name Type Description
size String Width when expanded (in px, %, em, etc...)
collapsedSize String Width when collapsed (in px, %, em, etc...)
splitterThickness String Thickness of divider (in px, %, em, etc...)
handleLocation SplitPaneHandleLocation Location of handle for expanding/collapsing

StreetAddressObject

Properties:
Name Type Description
streetNumber String -
route String Usally maps to street name
locality String Usually maps to name of city/town
administrativeAreaLevel1 String Usually maps to state/province
administrativeAreaLevel2 String Usually maps to county
administrativeAreaLevel3 String -
postalCode String -
country String -
formatted String -
components AddressComponent -

TableColumnObject

Specifications for the columns in a Table control
Properties:
Name Type Description
renderAs TableCellRenderType How cell contents should be rendered
visibility TableColumnVisibility Column visibility
sortable Boolean When enabled, table can be sorted using this column
options String Optional data to pass to cell, depending on type of data in column. Includes:  - Decimal: thousandsSeparator, decimalPlaces, decimalSeparator, postfix, prefix  - DatePicker: datePattern  - Link: href  - Integer: thousandSeparator
css String CSS styling to apply to column (e.g. color:#00ff00)
width String Column width
label String Set the Column Label

VideoSourceObject

Video Source information
Properties:
Name Type Description
src String -
type VideoSourceType -