- TextBox
- ComboBox
- AD Picker
- VM Picker
- Date Picker
- File Browser
- Logged in user
- PasswordBox
- CheckBox
- VMware Host Picker
- Object Selector
- Slider
- Grid
- System Info
- TimePicker
- Terms Of Use
TextBox
When selecting a a TextBox parameter type, a modal dialog is displayed asking the user to further configure the parameter.
Regardless of the datasource selected for configuration, these options are common:
...
- The script code can be tested by clicking the Preview Values button
ComboBox
When selecting a a Combobox parameter type, a modal dialog is displayed asking the user to further configure the parameter.
A ComboBox type parameter allows single value selection in Start Workflow form. If the Is ListView option is checked (option available for all elements in the source drop down list), this will enable users to select multiple values in Start Workflow form and in this case the parameter should be defined in Designer as an Array[T] type. For example, if strings will be used, the the argument should be an String[] type.
When checking the Is ListView option, user may also add limitations for minimum/maximum selected items. Only positive numeric values are accepted. If other values are inserted, a validation message will prevent user from saving the configuration. If left empty, no limitation validation will be applied for the parameter.
NOTES:
- when minimum/maximum selected values are used in addition to preselected values, if the number of preselected values exceeds the number of maximum values, Portal validation for minimum/maximum selected items will be applied when Start Workflow windows is opened but no item will be automatically unchecked
- if the parameter is optional, Portal validation for minimum/maximum selected items will NOT be applied
...
To configure a parameter of type ComboBox From Powershell, follow the next steps:
- Select the Parameter type: ComboBox and select the PS option to open the From Powershell window:
- Type in a Powershell script inside the Editor field. Click on for examples. Each item which contains the ';' separator will be treated like a display value / sent value item pair in Portal, this means that only the display value is visible in Portal, but the sent value pair is sent to the workflow
In order to execute the powershell script on a remote machine, a username (domain\user format), a password and a machine name/IP should be inserted. If no credentials or no machine name/IP are provided, the code will be executed locally
- The script code can be tested by clicking the Preview Values button
To configure a parameter of type ComboBox from WMI,follow the next steps:
- Select the Parameter type: ComboBox and select the WMI option to open the From WMI window:
- In order to execute the script on a remote machine, a username (domain\user format), a password and a machine name/IP should be inserted. If no credentials or no machine name/IP are provided, the code will be executed locally
- Type in a WMI Query inside the WMI Query editor field. Click on for examples
- Test the query by pressing the Preview Values button
To configure a parameter of type ComboBox from SSH, follow the next steps:
- Select the Parameter type: ComboBox and select the SSH option to open the From SSH window:
- Insert the credentials for the SSH machine where the script will be executed. The SSH Script code will be executed on the selected Machine, with the given Username and Password. Click on Advanced Settings to set a different connection type:
- SSH connections can also be established by using certificates, with or without passwords:
- Click on Upload Certificate and select a valid certificate. If the certificate is without password, when Passphrase window opens, leave the field empty and click on Set button to return to Advanced Settings window:
- Certificate based connections can also be made by using binary configured Global Variables. Select a global variable/attribute into the Global Variable field. If the certificate is without password, when Passphrase window opens, leave the field empty and click on Set button to return to Advanced Settings window:
- SSH connections can also be established by using certificates, with or without passwords:
- A connection based on a certificate can be removed by clicking Clear Certificate or the button if a certificate was selected from the Global Variable structure
- Separator: the main separator (default:';') is used for separating items from the execution resulted string
- Type an SSH Script code. Click on for examples. Each item which contains the ',' separator will be treated like a display value / sent value item pair in Portal, this means that only the display value is visible in Portal, but the sent value pair is sent to the workflow
- Test the script by pressing the Preview Values button
To configure a parameter of type ComboBox from Javascript, follow the next steps:
- Select the Parameter type: ComboBox and select the Javascript option to open the From Javascript window:
- Separator: the main separator (default:';') is used for separating items from the execution resulted string
- Type in a javascript script inside the Java Script editor field. Click on for examples. Each item which contains the ',' separator will be treated like a display value / sent value item pair in Portal, this means that only the display value is visible in Portal, but the sent value pair is sent to the workflow
- The script code can be tested by clicking the Preview Values button
To configure a parameter of type ComboBox from Python, follow the next steps:
- Select the Parameter type: ComboBox and select the Python option to open the From Python Script window:
- Separator: the main separator (default:';') is used for separating items from the execution resulted string
- Type in a python script inside the Python Script editor field. Click on for examples. Each item which contains the ',' separator will be treated like a display value / sent value item pair in Portal, this means that only the display value is visible in Portal, but the sent value pair is sent to the workflow
- The script code can be tested by clicking the Preview Values button
AD Picker
When selecting a a AD Picker parameter type, a modal dialog is displayed asking the user to further configure the parameter.
To configure a parameter of type AD Picker Standard, follow the next steps:
...
- Select an object type. By default, User will be selected
- Type in a Display Value
- Type in a valid Domain Path (LDAP) or copy it from a Standard AD Picker's Location field
- Click Add
- Repeat the previous step for as many AD Locations as desired
- Set one value as Default by selecting the line and checking the Default value column
- Test the results by clicking the Preview Values button
- In order to edit a configured line, select it, then select the Actions drop-down list and click Edit. In order to remove a configured line select it and click Remove
VM Picker
When selecting a a VM Picker parameter type, a modal dialog is displayed asking the user to further configure the parameter.
When setting a parameter to be a VM Picker, the user must also specify whether if it takes its values from VMWare, HyperV or XenServer.
...
Allow time selection in portal can be added to all the combinations from above. When having this option checked, the user will also be able to choose the time from Portal.
Clear button: User could delete the current date via the default Clear button of the calendar, if no default value was set.
File Browser
This type of parameter can be configured by clicking on Edit File Browser.
...
If checked, the file upload will begin after the workflow start the workflow start .
If the user have multiple fileuploads with the same name, a timestamp as suffix will be added to the filename.
Logged in user
This type of parameter does not require additional settings and it will be set as Hidden by default. In Portal, this kind of parameter will automatically return the username that is currently logged in. If the Hidden checkbox is not checked, the parameter will be visible:
...
There are four ways of configuring this type of parameter: Hidden, Complexity, Enable Password Confirm, Hide Password Length
- saving the password into the database:
- check the Hidden option and the fields will become active
- type a password
- retype the password in the Confirm field
- Click Save changes to return to Edit Parameters
- The parameter will be hidden in Portal
- by manual input in Portal: leave the Hidden option unchecked. The field will be visible and editable in Portal
The data will be encrypted when configuring the password from Administrator or from Portal.
- Check the complexity option
The user can configure the complexity of the password by checking the options.
The configuration also include a field where the user will set the invalid message according to his complexity password criteria.
When finished, click click Save changes to to return to Edit Parameters window.
- Check the Enable Password Confirm option
The user can check this option and a new field (Password Confirm) will appear in Start Workflow.
- Check the Hide Password Length option
CheckBox
This type of parameter takes True/False values depending on the check status (Checked = True, Unchecked = False).
...
This parameter type allows the configuration of parameters values in an object selector form, with possibility to single or multiple select the items in Start Workflow form. When configuring a parameter to be of type Object Selector, the user must also specify whether it has static values, or if it takes values from a datasource:
Configuration Options
The configuration options are available regardless of the datasource selected for the object selector:
- Min/Max: limits the user to a specified minimum/ maximum number of items selected. Only positive numeric values are accepted. If the number of items returned is lower than the Min value, the limitation validation will be ignored in Portal. If the parameter is optional, Portal validation for minimum/maximum selected items will not be applied. For this limitation to take effect, Multiple Selection option must be checked also.
- Auto Search: if checked, a search operation will be performed automatically when opening Start Workflow form in Portal without clicking the Search button.
- Allow Duplicates: if checked, it allows the addition of the same item multiple times in the Selected Items area in Start Workflow form in Portal.
- Cross Check: if checked, the preselected values will be populated automatically in the Selected List values (Autosearch flag will be checked automatically when Cross Check flag is checked).
- Multiple Selection: if selected, it forces the type of the parameter to be String[]
- Singe Single Selection: if selected, it forces the type of the parameter to be String and all configuration options will be hidden.
...
- Select the Parameter type: Object Selector and select the Static option to open the Static window:
- Add the desired users in a static text format by writing the value and clicking the Add button
...
- Select the Parameter type: Object Selector and select the SQL option to open the Objects Selector window:
- Compose the Connection string to the SQL Server and to the database by clicking the Compose button
- Insert the Command query (for example, SELECT queries) in the Database Editor field. Click on for examples. Dependencies from global variables or parameters can be used in the query as well as Search Variables, available only for Object Selector parameter type. The <%Search Variable%> is replaced in the Command query with the input value given by the user in the Search field in Start Workflow form (Search field is used to filter objects):
...
- Select the Parameter type: Object Selector and select the AD option to open the Objects Selector window:
- Select the desired Active Directory LDAP by clicking the Add button or click Browse to open the AD picker window for a selected domain and select the LDAP path to be added
- Set the AD Filter based on which the searches will be made (this field is optional. If left empty, the searches will be made on all objects)
- Select the attribute by which the data will Under the Display Value Property field select which AD attribute you wish be displayed in the Available Users list Portal (by default the items will be displayed by sAMAccountNamedefault: displayName).Other options are Display Name, Distinguished Name, Name)
- Under the Sent Value Property field select which AD attribute you wish to be assigned as the parameter value sent to the workflow (default: sAMAccountName).Other options are Display Name, Distinguished Name, Name)
- check Check the retrieved values from all the added LDAPs by clicking the Preview Value button
...
- Select the Parameter type: Object Selector and select the PS option to open the Objects Selector window:
- For Remote executions, configure the Connection to the remote machine. For local executions leave the Connection fields blank
- Insert the Powershell script in the PowerShell Editor field. Click on for examples. Dependencies from global variables or parameters can be used in the script as well as Search Variables, available only for Object Selector parameter type. The <%Search Variable%> is replaced in the script with the input value given by the user in the Search field in Start Workflow form (Search field is used to filter objects):
...
- For Remote executions, configure the Connection to the remote machine. For local executions leave the Connection fields blank
- Insert the WMI Query in the WMI Editor field. Click on for examples. Dependencies from global variables or parameters can be used in the script as well as Search Variables, available only for Object Selector parameter type. The <%Search Variable%> is replaced in the query with the input value given by the user in the Search field in Start Workflow form (Search field is used to filter objects):
- Test the script by clicking on Preview Values
...
- Select the Parameter type: Object Selector and select the SSH option to open the Objects Selector window:
- Separator: the main separator (default:';') is used for separating items from the execution resulted string
- Insert the credentials for the SSH machine where the script will be executed. The SSH Script code will be executed on the selected Machine, with the given Username and Password. Click on Advanced Settings to set a different connection type:
- SSH connections can also be established by using certificates, with or without passwords:
- Click on Upload Certificate and select a valid certificate. If the certificate is without password, when Passphrase window opens, leave the field empty and click on Set button to return to Advanced Settings window:
- Certificate based connections can also be made by using binary configured Global Variables. Select a global variable/attribute into the Global Variable field. If the certificate is without password, when Passphrase window opens, leave the field empty and click on Set button to return to Advanced Settings window:
- A connection based on a certificate can be removed by clicking Clear Certificate or the button if a certificate was selected from the Global Variable structure
- Insert the SSH script in the SSH Editor field. Click on for examples. Dependencies from global variables or parameters can be used in the script as well as Search Variables, available only for Object Selector parameter type. The <%Search Variable%> is replaced in the script with the input value given by the user in the Search field in Start Workflow form (Search field is used to filter objects)
- Test the grid by clicking Preview Values
...
- Select the Parameter type: Object Selector and select the Javascript option to open the Objects Selector window:
- Separator: the main separator (default:';') is used for separating items from the execution resulted string
- Insert the Javascript script in the JavaScript Editor field. Click on for examples. Dependencies from global variables or parameters can be used in the script as well as Search Variables, available only for Object Selector parameter type. The <%Search Variable%> is replaced in the script with the input value given by the user in the Search field in Start Workflow form (Search field is used to filter objects)
- Test the results by clicking Preview Values
...
- Select the Parameter type: Object Selector and select the Python option to open the Objects Selector window:
- Separator: the main separator (default:';') is used for separating items from the execution resulted string
- Insert the Python script in the Python Editor field. Click on for examples. Dependencies from global variables or parameters can be used in the script as well as Search Variables, available only for Object Selector parameter type. The <%Search Variable%> is replaced in the script with the input value given by the user in the Search field in Start Workflow form (Search field is used to filter objects)
- Test the results by clicking Preview Values
...