Datapolis Process System SDK

Search:

Contents
:
IndexBookmarkPrint
Home > Activities > Activity XMLs > Activity Schema > Activities > Activity > Parameters > Parameter

Parameter

 

 

The activity parameter definition.

<Parameter
    Name = "Text"
    Title = "Text"
    Description = "Text"
    Type = "WBValueType"
    DataType = "WBActivityParameterDataType"
    SelectableTypes = "WBTreeNodeTypeList"
    AllowChildrenTypes = "WBTreeNodeTypeList"
    ParametersToEraseAfterChange = "Text"
    RootPath = "Text"
    Value = "Text"
    EmptyValue = "Text"
    Warning = "Text"
    Required = "Boolean"
    Direction = "Direction"
    StringLines = "Byte"
    DisableWhenUnchecked = "String"
    DisableWhenChecked = "String"
    ShowAsPassword "Boolean">
</Parameter>

 

Attributes


Name Description
Name Required Text. The name of a parameter. It should be used to parameter registration in code.
Title Required Text. The title of a parameter shown in Workbox Designer.
Description Required Text. The description of a parameter shown in Workbox Designer.
Type Required WBValueType. Specify the type supported by Datapolis Process System. There are the following supported types:

Value
String
Int
Bool
Double
DateTime
Guid
Hashtable
Object

DataType Optional WBActivityParameterDataType. Determines whether user who creates workflow could choose parameter value from lookup or not. There are following options:

Value Description
ManyLookups Allows to concatenate value from manually entered text with many lookups
OneLookup Restricts value to one lookup only
NoLookups Value can be manually edited only
Filter Gives the ability to filter list for elements matching entered criteria. For example elements might be selected by their identity number or name

 

When it is not set, the default value is ManyLookups. For more information about lookups see Datapolis Process System Lookup Fields.

SelectableTypes Optional WBTreeNodeTypeList. This attribute is used for limit possible to choose node types in lookup.
  • These node types that might be selected are spitted with ‘ ’ (space) sign. In order not to restrict selectable types leave empty value here. By default any restrictions are not applied.
  • For node names list expand the node Datapolis Process System Lookup Fields.
  • Example use: Set this attribute to 'List' and set DataType to 'OneLookup' to allow workflow developer to choose only SharePoint list or library in this parameter. This will result in getting selected list url in activity when workflow instance will work.
  • For more examples see Datapolis Process System Lookup Fields section Examples.
AllowChildrenTypes Optional WBTreeNodeTypeList. This attribute is used for limit possible to show node types in lookup.
  • Use same as SelectableTypes
  • Example use: Set this attribute to 'Current SharePoint SiteCollection Site WebCollection Web ListCollection List' and set DataType to 'OneLookup' to allow workflow developer to see only SharePoint site collections, sites, lists or libraries and no more nodes(ex. no list parameters or columns) on lookup tree while editing this parameter in Datapolis workflow designer.
  • For more information see SelectableTypes
ParametersToEraseAfterChange Optional Text. Names for parameter to be erased in designer after user changes this parameter value. By default any nodes are not impacted.
RootPath Optional Text. Optional Text. Useful when restricting visibility of node types. Points to the node that will be at top level in lookup tree while developer will edit this parameter in Workbox workflow designer.
  • Root Path can start from one of lookup tree forest root nodes, or point to other activity parameter, samples below:
    • /SharePoint/Current/Site- lookup tree root node will be site where developer is working.
    • /WorkflowParameters/WorkflowParameter- root node will point to workflow parameters
    • @selectedWebUrl/ListCollection- root node will be bound to the lookup selected in parameter which Name attribute is 'selectedWebUrl' and '/ListCollection' - e.g. it is used when selectedWebUrl has limited tree nodes by DataType, SelectableTypes and AllowChildrenTypes to allow selecting only SharePoint sites. It provides that in this parameter you could choose only nodes bellow list collection on selected site.
  • For more information see SelectableTypes
Value Optional Text. Indicates default value assigned into a parameter in Datapolis Designer.
EmptyValue Optional Text. Indicates which the parameter value should be used when the parameter value is empty. It is needed when the type is int, double, etc. and the vale attribute is empty.
Warning Optional Text. Text set in this attribute will be displayed as red message under a parameter in Datapolis Designer.
Required Optional Boolean. Determines if a parameter is required or not from Datapolis Designer's point of view. When it is not set, the default value is False.
Direction Optional Direction. Describes if a parameter is input or output one. The following values can be set:

Value
Input
Output

 

When it is not set, the default value is Input
StringLines Optional Byte. This attribute manage number of lines rendered in Datapolis Designer TextBox.

Note: This parameter defines height of the text box. Real number of lines that can be inputted can be greater.

DisableWhenUnchecked Optional String. Input names of the parameters which should be disabled when this parameter's checkbox will be unchecked by the user in the designer. When parameter is checked, these fields will be enabled. Note: even when fields are disabled, their value is still passed to the activity. This attribute is taken into account when the parameter Type is Bool.
DisableWhenChecked Optional String. Input names of the parameters which should be disabled when this parameter's checkbox will be checked by the user in the designer. When parameter is unchecked, these fields will be enabled. Note: even when fields are disabled, their value is still passed to the activity. This attribute is taken into account when the parameter Type is Bool.
ShowAsPassword

Optional Boolean. Shows parameter as password textbox - asterisks instead of characters. DataType setting is ignored and set to 'NoLookups'. Supported since 4.6/5.6 version. This attribute is taken into account when the parameter Type is Bool.



    DisableWhenUnchecked "String"