R4160: Settings Values for each Add-on XML Config Attribute

 

These are the attributes and settings values of the add-on XML config element for defining a Service Task when you create your own auto-step.

 

Set-value by Attribute

name *

name="conf_MaxNum" Alphanumeric and "_" are available, max 64 letters

 

form-type

form-type="TEXTFIELD" Configured with String Inputing (Text Box single line)
form-type="TEXTAREA" Configured with String Inputing (Text Box multiple lines)
form-type="SELECT" Configured with Data Item Selection
(filtered by "select-data-type")

form-type="SELECT_LIST_SUB_DATA"

Configured by selecting a Sub Data Item of a Table-type Item
(Used with "depends-on")

form-type="SELECT_ITEM"

 Configured with Option Selection from Item list
(Options are defined by <item>)
form-type="TOGGLE" Configured with ON or OFF
form-type="QUSER" Configured with User Selection
form-type="QGROUP" Configured with Organization Selection
form-type="OAUTH2" Configured with HTTP Authorization Selection
  • The Default is TEXTFIELD
  • Specify "OAUTH2" even when "BASIC Authentication / Token Fixed Value" is used in the HTTP Authorization Setting.
  • Definition Sample of Options for "SELECT_ITEM":
    <item value="editor"><label>Editor</label></item>
    <item value="viewer"><label>Viewer</label></item>
  • The setting item defined in a config element with "SELECT_LIST_SUB_DATA" is displayed only under the following conditions
    • That config element has been defined to depend on another config element that contains "SELECT"
    • A table-type data item has been specified on the task settings screen for the setting item defined in the config element with "SELECT"

 

select-data-type

select-data-type="STRING" Select-List for configuration consisting of only String-type Items
select-data-type="STRING_TEXTFIELD" Select-List for configuration consisting of only String-single-line Items
select-data-type="STRING_TEXTAREA" Select-List for configuration consisting of only String-multi-lines Items
select-data-type="STRING_MARKDOWN" Select-List for configuration consisting of only String-markdown Items
select-data-type="STRING_MULTILINE" Select-List for configuration consisting of only String-multi-lines/String-markdown Items
select-data-type="DECIMAL" Select-List for configuration consisting of only Numeric-type Items
select-data-type="DATE" Select-List for configuration consisting of only Date-type Items
select-data-type="DATE_Y" Select-List for configuration consisting of only Date-Y-type Items
select-data-type="DATE_YM" Select-List for configuration consisting of only Date-YM-type Items
select-data-type="DATE_MD" Select-List for configuration consists of only Date-MD-type Items
select-data-type="DATE_YMD" Select-List for configuration consisting of only Date-YMD-type Items
select-data-type="DATETIME" Select-List for configuration consisting of only Datetime-type Items
select-data-type="SELECT" Select-List for configuration consisting of only Choice-type Items
select-data-type="SELECT_SINGLE" Select-List for configuration consisting of only Single-Choice-type Items
(Single-Choice-type: Radio Button / Select Box / Search Select Box)
select-data-type="SELECT_CHECKBOX" Select-List for configuration consisting of only Checkbox-type Items
select-data-type="QUSER" Select-List for configuration consisting of only User-type Items
select-data-type="QGROUP" Select-List for configuration consisting of only Organization-type Items
select-data-type="LIST" Select-List for configuration consisting of only Table-type Items
select-data-type="FILE" Select-List for configuration consisting of only File-type Items
select-data-type="DISCUSSION" Select-List for configuration consisting of only Discussion-type Items
  • The Default is STRING

 

required

required="true" "required=true" means the Item MUST be configured
required="false"
  • The Default is false

 

el-enabled

el-enabled="true" To allow Expression Language or not
(Insertion Command: M224) (Formats of Dynamic Values: M227)
el-enabled="false"
  • The Default is false

 

editable (for form-type="SELECT")

editable="true"

To allow Input to text-field or not at the setting of form-type="SELECT"

Return value of configs.getObject(“conf_select”) is;
* If a Data Item is selected: ProcessDataDefinitionView
* If typing in a text field: null
configs.get(“conf_select”) will return the strings entered in the text field
editable="false"
  • The Default is false

 

depends-on

depends-on="configName"

Specify the value of the name of the configuration item (configName) for form-type="TOGGLE" and show/hide this configuration item depending on the selection of the TOGGLE

Sample settings:

<config name="checked" form-type="TOGGLE">
  <label>Checked</label>
  <label locale="en">Checked</label>
</config>
<config name="note" form-type="TEXTFIELD" depends-on="checked">
  <label>Note</label>
</config>

 

Articles in this section

See more

Related articles