/
1.3.1.2.3.1.2. Parameter Types

1.3.1.2.3.1.2. Parameter Types


TextBox

When selecting 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:

  • Read-Only: if the parameter should be non-editable in Portal
  • Hidden: if the parameter should be hidden in Portal
  • Set the number of rows. This will affect the way the value will be displayed in Portal
  • Dynamic Size: if there is desired to display the entire result on multiple lines


To configure a parameter of type TextBox Standard, follow the next steps:

  • Select the Parameter type: TextBox and select the Standard option
  • Set the number of rows. This will affect the way the value will be displayed in Portal.
  • If Active Directory values are used in Portal, the Textbox Standard parameter type gives two Active Directory specific options:

  • Autocomplete: there will be provided existing Active Directory entries, based on the input value
  • Validation: there will be checked if the provided input exists in Active Directory.

For both options there needs to be selected a domain where the validations should be made against.

NOTE: the Active Directory specific options are not available for Textbox  Standard with Default Value and for Regex.

  • If desired, check the Default Value option and type a value.

  • Read Only or Hidden can be checked, but only if Default Value was checked and a value entered in the respective field


To configure a parameter of type TextBox from Database, follow the next steps:

  • Select the Parameter type: TextBox and select the SQL option to open the From Database window:

  • Click Compose to build the connection string that will serve to connect to the database and execute the query written in the Command field. 
  • Select the Database type (Access, DSN, MySQL, Oracle, SQL Server)
  • Type in the required data for each database type
  • Select an authentication modeWindows or with Username/Password
  • Click OK and return to Edit Parameters – TextBox From Database
  • Type in the Command
  • Test the command by clicking the Preview Value button


Flowster Studio offers the possibility to use multiple databases types, via ODBC connections.

  • SQL Server – required info:
    • Hostname / IP Address
    • Instance name
    • Database name
  • Access – required info:
    • Database full path
  • DSN – required info:
    • Database. For example, DB2 ODBC connections can be inserted here or any other ODBC DSN name, for any kind of database
  • MySQL – required info:
    • Hostname / IP Address
    • Database name
  • Oracle – required info:
    • Hostname / IP Address
  • PostgreSQL – required info:
    • Hostname / IP Address
    • Port
    • Database name

The Authentication mode can be made with or without inserting passwords. A good example is a connection to MySQL, with the main user root, but without password.


To configure a parameter of type TextBox from AD,follow the next steps:

  • Select the Parameter type: TextBox and select the AD option to open the From Active Directory window:

  • Compose an LDAP connection string by using the samples (click the ? button):

Or

  • Click the Browse button in order to create a valid LDAP
  • There will be displayed a window where an Active Directory domain must be selected. After the domain is selected, the AD Picker window will be opened to allow the user to select an AD object from the tree
  • Click Select Object and return to Edit Parameters – TextBox from AD
  • Compose an LDAP connection string by using the samples (click the ? button):

Or

  • Type in an AD Filter (this action is optional), like for example objectClass=user
  • Type in an Attribute Name. By default, the application will return the distinguishedName attribute
  • Test the LDAP, the filter and the attribute by pressing the Preview Value button


To configure a parameter of type TextBox from Powershell, follow the next steps:

  • Select the Parameter type: TextBox and select the PS option to open the From Powershell window:

  • Type in a Powershell script inside the Editor field. Click on  for examples
  • 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 TextBox from WMI,follow the next steps:

  • Select the Parameter type: TextBox 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 TextBox from SSH, follow the next steps:

  • Select the Parameter type: TextBox 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:
      •  
      • 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
  • Type an SSH Script code. Click on  for examples
  • Test the script by pressing the Preview Values button


To configure a parameter of type TextBox from Javascript, follow the next steps:

  • Select the Parameter type: TextBox and select the Javascript option to open the From Javascript window:

  • Type in a Javascript script inside the Java Script editor field. Click on  for examples
  • The script code can be tested by clicking the Preview Values button


To configure a parameter of type TextBox from Python, follow the next steps:

  • Select the Parameter type: TextBox and select the Python option to open the From Python Script window:

  • Type in a python script inside the Python Script editor field. Click on  for examples
  • The script code can be tested by clicking the Preview Values button


ComboBox

When selecting 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 Custom Values, follow the next steps:

  • Type in a Display Name
  • Type in a (sent to the workflow) Value
  • Click Add
  • Repeat the steps above until all the desired values have been introduced


To configure a parameter of type ComboBox From Database, follow the next steps:

  • Select the Parameter type: ComboBox and select the SQL option:

  • Click Compose to build the connection string that will serve to connect to the database and execute the query written in the Command field
  • Select the Database type (Access, DSN, MySQL, Oracle, SQL Server)
  • Type in the required data for each database type
  • Select an authentication modeWindows or with Username/Password
  • Click OK and return to Edit Parameters – ComboBox From Database
  • Type in the required Command. Click on  for examples
  • Test the command by clicking the Preview Values button

Flowster Studio offers the possibility to use multiple databases types, via ODBC connections.

  • SQL Server– required info:
    • Hostname / IP Address
    • Instance name
    • Database name
  • Access– required info:
    • Database full path
  • DSN– required info:
    • Database. For example, DB2 ODBC connections can be inserted here or any other ODBC DSN name, for any kind of database
  • MySQL– required info:
    • Hostname / IP Address
    • Database name
  • Oracle– required info:
    • Hostname / IP Address
  • PostgreSQL– required info:
    • Hostname / IP Address
    • Port
    • Database name

The Authentication mode can be made with or without inserting passwords. A good example is a connection to MySQL, with the main user root, but without password.


To configure a parameter of type ComboBox From Active Directory, follow the next steps:

  • Select the Parameter type: ComboBox and select the AD option to open the From Active Directory window:

  • Compose an LDAP connection string by using the samples (click the ? button):

Or

  • Click the Browse button in order to build a valid LDAP URL
  • There will be displayed a window where an Active Directory domain must be selected. After selecting the domain, the AD Picker window will open to allow the user to select an AD object from the tree
  • Click Insert and return to Edit Parameters – ComboBox From ActiveDirectory
  • Compose an LDAP connection string by using the samples (click the ? button):

Or

  • Type in an AD Filter (this action is optional), like for example objectClass=user
  • Under the Display property field select which AD attribute you wish be displayed in Portal (default: displayName)
  • Under the Sent property field select which AD attribute you wish to be assigned as the parameter value sent to the workflow (default: sAMAccountName)
  • Test the LDAP and the filter by pressing the Preview Values button
  • Click on Save Changes to return to Edit Parameters window



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:

                                 

      • 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 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 the Parameter type: AD Picker and select the Standard option to open the Standard window:

  • Select an object type. By default, User will be selected
  • Click Browse in order to select a valid LDAP. There will be displayed a window where an Active Directory domain must be selected. The AD Browser window will be opened allowing the user to select an AD object from the tree
  • Click Select Object and return to Edit Parameters – AD Picker Standard
  • Test the settings by pressing the Preview Values button


To configure a parameter of type AD Picker From Advanced Picker, follow the next steps:

  • Select the Parameter type: AD Picker and select the Advanced option to open the From Advanced Picker window:

The advantage of using the AD Picker with the advanced option stands out when multiple AD Locations are needed. This means that the user can configure more than one AD Locations and then select one according to his requirements when executing the workflow in Portal.


To set an Advanced AD Picker parameter, 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 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 VMWareHyperV or XenServer.

To configure a parameter of type VM Picker VMWare , follow the next steps:

  • Select the Parameter type: VM Picker and select the Vmware option to open the VMWare VMPicker window:

  • Type in a server IP (vCenter IP or Host IP) and, optionally, a port
  • Select http or https. By default, the http protocol is checked
  • Type in the connection credentials 
  • Test if the connection is sucesful by clicking the Test Connection button
  • Type in a FullPath or a FolderID representing the folder that contains the VMs.
    • If you connect via vCenter IP:
      • The given example provides a full VM source path, where:
      • Datacenter is the VM's datacenter's name;
      • vm is mandatory to be written in the path. It contains all defined VMs
      • DemoVMs is the folder that contains the VMs
    • If you connect via Host IP:   
      • The full path of the VM should be obtained via powerCLI commands:
      • ha-datacenter is the VM's datacenter's name and it is obtained with the powerCLI command "$vm = (get-vm "VM_Name").Folder.Parent"
      • vm is the folder of type VM that holds all the vms on the specified host. It is obtained with the powerCLI command "$vm = (get-vm "VM_Name").Folder"
      • The FullPath is composed as follows: ha-datacenter/vm
  • Specify whether the returned values will be only Templates by checking the Templates option
  • Leave the Recursive option unchecked if the application should look for VMs only in the given folder
  • Click the Get VM List to check the VMs that are returned
  • Select a VM from the list to see its attributes and select which attribute will be displayed in Portal:


To set a HyperV VMPicker parameter follow the next steps:

  • Type in the HyperV Host IP
  • Type in a username and its password
  • Test if the connection is ok by pressing the Test Connection button
  • Click the Get VM List to check the VMs that are returned

To set a XenServer VMPicker parameter follow the next steps:

  • Type in the XenServer Host IP
  • Type in a value for Port
  • Type in a username and its password
  • Test if the connection is ok by pressing the Test Connection button
  • Click the Get VM List to check the VMs that are returned


Date Picker

When setting a parameter as Date Picker the user must also specify whether it will return the current date, a blank field or another specified date. You can limit the selection of date in calendar by specifying a validation interval or by not allowing values prior to workflow start date. Also, the calendar can be enabled, hidden or disabled.

In order to configure a default value for the Date Picker, select one of the three options: Current Date, Blank or Specify Value:

If the Specify Value is selected, users have the possibility to specify the date value from a script by clicking the From Script button. This will expand a script editor and the user can choose the language of the script. Dependencies from Global Variables and/or parameters can be used in the script editor. 

Possible combinations between Default Value and Rendering:

  • Current date – enabled
  • Current date – hidden
  • Current date – disabled
  • Blank – enabled
  • Specified value – enabled
  • Specified value – hidden
  • Specified value – disabled

Specify Min/Max Value(dd/MM/yyyy) and Don't allow values prior to workflow start date can be added to all combinations above but can't be checked both concurrently.  

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.

 

 By default, the checkbox Upload the file after start workflow is  unchecked, which means that the file is uploaded before the workflow start.

If checked, the  file upload will begin after 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:


PasswordBox

The user can see the value of password in plain text, by clicking on this button  .

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 Save changes 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).

Users can configure the Checked/Unchecked status of the parameter and in addition the Hidden option if the parameter should not be visible in Portal and/or Read Only option if the parameter should be editable or non editable in Portal:

When finished, click Save changes to return to Edit Parameters window. 


VMware Host Picker

This parameter type requires the parameter to be defined as a String[] in order to support multiple selection of hosts. 

To configure a parameter of type VMware Host Picker, follow the next steps:

  • Select the Parameter type: VMware Host Picker and wait for the VMware Host Picker window to open:

  • Type in a server IP (vCenter IP or Host IP) and, optionally, a port
  • Select http or https. By default, the http protocol is checked, but https is more often used for vCenters and Hosts connections
  • Type in valid connection credentials
  • Test if the connection is successful by pressing the Test Connection button
  • Click on Datacenters in order to retrieve all available datacenters:
    • If you connect via vCenter IP: there will be retrieved the names of the available datacenters (e.g. Datacenter, DemoFlowster)
    • If you connect via Host IP:   there will be retrieved the datacenter’s name, for example ha-datacenter
  • Optional: select a Datacenter from the list or leave the list empty:
    •  If a datacenter is selected, then in Start Workflow form there will be retrieved available hosts from the selected datacenter. Click on Clear if you wish to remove the value for the Datacenter field. 
    •  If no datacenter is selected, then in Start Workflow form a list with all available datacenters will be displayed


Object Selector

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[]
  • Single Selection: if selected, it forces the type of the parameter to be String and all configuration options will be hidden.

To configure a parameter of type Object Selector with Static values, follow the next steps:

  • 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
  • Remove an entry by selecting it and clicking the Remove button


To configure a parameter of type Object Selector From Database, follow the next steps:

  • 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):

  • Test the query by clicking on Preview Values

Flowster Studio offers the possibility to use multiple databases types, via ODBC connections.

  • SQL Server – required info:
    • Hostname / IP Address
    • Instance name
    • Database name
  • Access – required info:
    • Database full path
  • DSN – required info:
    • Database. For example, DB2 ODBC connections can be inserted here or any other ODBC DSN name, for any kind of database
  • MySQL – required info:
    • Hostname / IP Address
    • Database name
  • Oracle – required info:
    • Hostname / IP Address
  • PostgreSQL – required info:
    • Hostname / IP Address
    • Port
    • Database name

The Authentication mode can be made with or without inserting passwords. A good example is a connection to MySQL, with the main user root, but without password.



To configure a parameter of type Object Selector From Active Directory, follow the next steps:

  • 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)
  • Under the Display Value Property field select which AD attribute you wish be displayed in Portal (default: displayName).Other options are Display NameDistinguished NameName)
  • 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 NameDistinguished NameName)
  • Check the retrieved values from all the added LDAPs by clicking the Preview Value button


To configure a parameter of type Object Selector From Powershell, follow the next steps:

  • 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):

  • Test the script by clicking on Preview Values


To configure a parameter of type Object Selector From WMI, follow the next steps:

  • Select the Parameter type: Object Selector and select the WMI 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 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


To configure a parameter of type Object Selector from SSH, follow the next steps:

  • 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


To configure a parameter of type Object Selector from Javascript, follow the next steps:

  • 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


To configure a parameter of type Object Selector from Python, follow the next steps:

  • 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


Slider

When setting a parameter to be of type Slider, the user must also specify whether it is a slider of type Number or a slider of type Text.

To configure a parameter of type Slider Text, follow the next steps:

  • Select the Parameter type: Slider and select Text option:

  • Set the Display Value field and the Sent Value field and click on button
  • Repeat the steps above until all the desired values have been introduced
  • If you want to change the position of an item in the list, click either the  button or the button
  • If you want to delete an item from the list, click the button
  • Set a Start Value if desired. The Start Value should match the Sent Value in order to be preselected in Portal. This field allows the insert of global variables and/or parameter dependency


To configure a parameter of type Slider Number, follow the next steps:

  • Select the Parameter type: Slider and select Number option:

  • Set a Min Value and Max Value
  • Set a Step value
  • Set a Start Value if desired. This field allows the insert of global variables and/or parameter dependency


Grid

This parameter type allows the configuration of parameters values in a grid form, with possibility to single or multiple select the values in Start Workflow form. When configuring a parameter to be of type Grid (grid configuration can only be applied to parameters of type Collection<Collection<String>>), 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 grid:

When configuring this parameter, user has the following options:

  • Separator: separates items from the resulted string and structures them in columns and rows. The default value can be changed by the user 
  • Read Only: if checked, grid rows values will be non-editable in Start Workflow form
  • Autoselect: if checked, first row from the grid will be automatically selected in Start Workflow form
  • Send always the whole Grid to the workflow: if checked, it will hide rows selection and all rows will be automatically selected to be sent to the workflow in Start Workflow form
  • Min/Max rows selected: limits the user to a specified minimum/ maximum number of rows selected. Only positive numeric values are accepted. If the number of rows returned is lower than the Min rows selected value, the limitation validation will be ignored in Portal. If the parameter is optional, Portal validation for minimum/maximum selected rows will not be applied. For this limitation to take effect, Multiple Selection option must be checked also. 
  • Multiple Selection: if checked, allows multiple rows selection in Start Workflow form
  • Allow Add Button: if checked, the Add Row button will be visible in Start Workflow form, allowing the user to add an empty editable row
  • Allow Remove Button: if checked, the Delete Row button will be visible in Start Workflow form, allowing the user to add an empty editable row


Click on Grid Columns Help icon for information about the columns configuration options:

In order to configure the column options, see example below:

Where:

  • ID column will be hidden in Start Workflow form
  • Name column will be read only in Start Workflow form
  • Address column will be displayed as a drop-down list in Start Workflow form.

When the dl:ColumnName:dl pattern is typed in the Columns field, it automatically creates a button with the column's Name below the Columns field so the user can configure the drop-down list's values. When clicking on ColumnName button, it will open the Grid DropDownList Configuration window where user can configure the drop-down list items. Dependencies from global variables and parameters can be used in the script. 

In the Value field, the script should be adapted into using columns of type DropDownList by adding for the corresponding column the column name or a dummy value (value which will be replaced with the results of the DropDownList configuration in Start Workflow form):

  • Country column will be displayed as a regular column, no options applied

NOTE: In Portal, column names will be displayed without the predefined characters


To configure a parameter of type Grid with Static values,follow the next steps:

  • Select the Parameter type: Grid and select the Static option to open the Static window:

  • Configure the Columns and the Separator. The values from the Columns field will represent the grid’s header
  • Configure the Grid’s Values (move to a new line using Enter) 
  • Test the grid by clicking on Preview Values. There will be displayed a preview of how the grid would be displayed in the Portal


To configure a parameter of type Grid From Database, follow the next steps:

  • Select the Parameter type: Grid and select the SQL option to open the From Database window:

  • Configure the Columns and the Separator. The values from the Columns field will represent the grid’s header
  • 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 Editor field (dependencies from global variables or parameters can be used in the query)
  • Test the grid by clicking on Preview Values. There will be displayed a preview of how the grid would be displayed in the Portal


Flowster Studio offers the possibility to use multiple databases types, via ODBC connections.

  • SQL Server – required info:
    • Hostname / IP Address
    • Instance name
    • Database name
  • Access – required info:
    • Database full path
  • DSN – required info:
    • Database. For example, DB2 ODBC connections can be inserted here or any other ODBC DSN name, for any kind of database
  • MySQL – required info:
    • Hostname / IP Address
    • Database name
  • Oracle – required info:
    • Hostname / IP Address
  • PostgreSQL – required info:
    • Hostname / IP Address
    • Port
    • Database name

The Authentication mode can be made with or without inserting passwords. A good example is a connection to MySQL, with the main user root, but without password.



To configure a parameter of type Grid From Powershell, follow the next steps:

  • Select the Parameter type: Grid and select the PS option to open the From Powershell window:

  • Configure the Columns and the Separator. The values from the Columns field will represent the grid’s header (there can be used the same values as the ones selected with the PS Script)
  • For Remote executions, configure the Connection to the remote machine. For local executions leave the Connection fields blank
  • Insert the PS Script in the Powershell Script field (dependencies from global variables or parameters can be used in the script). Click on for examples
  • Test the grid by clicking Preview Values. There will be displayed a preview of how the grid would be displayed in the Portal (For the above example, the Name and ID values will be displayed for each retrieved process):



To configure a parameter of type Grid From WMI, follow the next steps:

  • Select the Parameter type: Grid and select the WMI option to open the From WMI window:

  • Configure the Columns and the Separator. The values from the Columns field will represent the grid’s header 
  • 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 Query field (dependencies from global variables or parameters can be used in the query). Click on for examples
  • Test the grid by clicking Preview Values. There will be displayed a preview of how the grid would be displayed in the Portal (For the above example, the services’ Names will be displayed for each retrieved process)


To configure a parameter of type Grid from SSH, follow the next steps:

  • Select the Parameter type: Grid and select the SSH option to open the From SSH window:

  • Configure the Columns and the Separator. The values from the Columns field will represent the grid’s header
  • 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
  • Type an SSH Script code (dependencies from global variables or parameters can be used in the script). Click on for examples
  • Test the grid by clicking Preview Values. There will be displayed a preview of how the grid would be displayed in the Portal


To configure a parameter of type Grid from Javascript, follow the next steps:

  • Select the Parameter type: Grid and select the Javascript option to open the From Javascript window:

  • Configure the Columns and the Separator. The values from the Columns field will represent the grid’s header
  • Type in a javascript script in the JavaScript field (dependencies from global variables or parameters can be used in the query). Click on for examples
  • Test the grid by clicking Preview Values. There will be displayed a preview of how the grid would be displayed in the Portal


To configure a parameter of type Grid from Python, follow the next steps:

  • Select the Parameter type: Grid and select the Python option to open the From Python window:

  • Configure the Columns and the Separator. The values from the Columns field will represent the grid’s header
  • Type in a javascript script in the JavaScript field (dependencies from global variables or parameters can be used in the query). Click on for examples
  • Test the grid by clicking Preview Values. There will be displayed a preview of how the grid would be displayed in the Portal



System Info

This parameter type retrieves different system information, like machine’s IP, Name, the Domain where it is joined, information about CPU, Memory or Board Maker.

  • Select the Type of information returned in Portal
  • Check Hidden option if the parameter should be invisible in Portal
  • Click on Save changes to return to Edit Parameters window

TimePicker

When setting a parameter as TimePicker the user must also specify whether it will return the current time, a blank field or another specified time. Also, the time picker can be enabled, hidden or disabled.

In order to configure a default value for the Time Picker, select one of the three options: Current Time, Blank or Specify Value:

If the Specify Value is selected, users have the possibility to specify the value from a script by clicking the From Script button. This will expand a script editor and the user can choose the language of the script. Dependencies from Global Variables and/or parameters can be used in the script editor:

Possible combinations between Default Value and Rendering:

  • Current date – enabled
  • Current date – hidden
  • Current date – disabled
  • Blank – enabled
  • Specified value – enabled
  • Specified value – hidden
  • Specified value – disabled


Terms Of Use

terms of use parameter forces the user to agree to given conditions stated in the parameter info in order to start a workflow in Portal. If the Terms Of Use is not checked, the Start Workflow button will be disabled until user agrees with the Terms Of Use parameter:








Related content

1.3.1.2.3.1.2. Parameter Types
1.3.1.2.3.1.2. Parameter Types
More like this
1.3.1.2.3.1.2. Parameter Types
1.3.1.2.3.1.2. Parameter Types
More like this
1.3.1.2.3.1.5. Parameter Preselection Configuration
1.3.1.2.3.1.5. Parameter Preselection Configuration
More like this
1.3.1.2.3.1.5. Parameter Preselection Configuration
1.3.1.2.3.1.5. Parameter Preselection Configuration
More like this
1.3.1.2.3.1. Edit Parameters
1.3.1.2.3.1. Edit Parameters
More like this
1.3.1.2.3.1. Edit Parameters
1.3.1.2.3.1. Edit Parameters
More like this