Activities
Connect to MSSQL
This activity connects to a Microsoft SQL Host. The Output of this activity should be used as input for all Connection parameters used for activities placed under Microsoft SQL category.
Activity Parameters
The Connect to MSSQL activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Authentication (combo box control) (type: string): the authentication method. For SQL Authentication, the Username and Password parameters are mandatory. For Windows authentication they are optional.
- Database (text box editor type) (type: string): the database name to connect to.
- Instance (text box editor type) (type: string): the instance name to connect to. If there is an SQL server with no instance, this field should be empty. Examples:
- localhost\sqlexpress - server with instance
- localhost - server with no instance
- Password (password editor type) (type: string): the password for the provided username. In case of Windows Authentication, if the user that connects to the database is the logged in one, the field can remain empty.
- Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the sql server. (This parameter is used only when the user wants to send an encripted password from outside the task, for example Flowster Portal). In case of Windows Authentication, if the user that connects to the database is the logged in one, the field can remain empty.
- Server Name (text box editor type) (type: string): the name or IP of the SQL Server to connect to. If it is a local SQL server, localhost is also accepted as a value.
- Username (text box editor type) (type: string): the the username of the SQL Server Administrator. In case of Windows Authentication, if the user that connects to the database is the logged in one, the field can remain empty.
The Read Only Output variable are the possible output values that the activity will provide:
- Connection (type: object): outputs a SQL connection. The Output of this activity should be used as input for all Connection parameters used for activities placed under Microsoft SQL category.
Disconnect from MSSQL
This activity disconnects from a Microsoft SQL Host.
Activity Parameters
The Disconnect from MSSQL activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Connection (text box editor type) (type: object): the output from a Connect to MSSQL activity.
Add User Access to Database
This activity adds privileges for an user to a database.
Activity Parameters
The Add User Access to Database activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- CSV Roles (text box editor type) (type: collection<string>): the database-level roles for the user access. Overrides the 'Database-level role' parameter. The values must be entered with the format: "db_owner,db_securityadmin,db_backupoperator,db_accessadmin".
- Database - level Role (value selector list) (type: string): the roles that will be added to the user. The roles will be selected from a list, after clicking the ... button. The list will display all possible roles that can be assigned to a SQL user.
- Username for Access (text box editor type) (type: string): the name of the user that will receive permissions. The user must be written by following the "domain\username" format.
Execution: the activity will check if the user exists as a login on the SQL server and if found, will grant access on the connected database, for the given roles:
Backup Database
This activity creates a backup .bak file of a selected database.
Activity Parameters
The Backup Database activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Backup Path (text box editor type) (type: string): the full path where the backup file will be created.
- Media Name (text box editor type) (type: string): the new media a media name. (E.g. 'C_SQLServerBackups').
- Name (text box editor type) (type: string): the name of the backup set. Names can have a maximum of 128 characters. (E.g. 'Full Backup of Database'). In the example the name of the backup is the same as the database's.
Execution: the activity will create a backup file of the database settled in the connection activity, in the specified folder:
The backup file can be seen in the given location:
Delete Row(s) from Table
This activity deletes Row(s) from a SQL Server database table.
Activity Parameters
The Delete Row(s) from Table activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Table (text box editor type) (type: string): the table name where the row(s) will be deleted.
- Where Statement (text box editor type) (type: string): the Where statement to filter the row(s) that will be deleted. For example: Column_name='Test'.
As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Delete Row(s) from Table activity:
Insert Row into Table
This activity inserts Row on a SQL Server database table.
Activity Parameters
The Insert Row into Table activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Fields (text box editor type) (type: string): the column headers that you want to be returned with the select command. If you enter more than one you should separate them with ','. For example: Name,Surname,Company.
- Table (text box editor type) (type: string): the table name where the row(s) will be inserted.
- Values (text box editor type) (type: string): the values for specified fields in Fields parameter. If you enter more than one you should separate them with ','. If you have more values each should be placed in the same order as you add the fields.For example: May,James,Amazon Prime.
The Read Only Output variable are the possible output values that the activity will provide:
- Output Last ID (type: string): outputs the last row inserted ID.
Execution: the activity will insert the new row into the selected table and will output the ID of the added row:
In the database, the row can be seen at the last position:
Remove User Access from Database
This activity removes privileges for an user to a database.
Activity Parameters
The Remove User Access from Database activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- CSV Roles (text box editor type) (type: collection<string>): the database-level roles that will be removed from the user. Overrides the 'Database-level role' parameter. The values must be entered with the format: "Role1,Role2,Role3...".
- Database - level Role (value selector list) (type: string): the roles that will be deleted from the user. The roles will be selected from a list, after clicking the ... button. The list will display all possible roles that can be assigned to a SQL user.
- Username for Access (text box editor type) (type: string): the name of the user that will have the permissions revoked.
As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Add User Access to Database activity:
Restore Database
This activity restores a Database from a backup .bak file.
Activity Parameters
The Restore Database activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Backup File Path (text box editor type) (type: string): the path of the backup file or select it with the File Browser. Should be a .bak extension file (E.G 'C:\BackupsFolder\BackupFile.bak' ).
As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Restore Database activity:
Run query
This activity runs a query on a SQL Server database.
Activity Parameters
The Run Query activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Query (text box editor type) (type: string): the SQL query string. For example: CREATE Table.
As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Run Query activity:
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: collection<collection<string>>): outputs a collection of returned rows.To use the elements of the collection, use ForEachFactory activity.
- Output Columns (type: int32): outputs the number of columns returned.
- Output Rows (type: int32): outputs the number of rows returned.
Select Row(s) from Table
This activity selects and returns Row(s) from a SQL Server database table. The example below displays a classic select query: select all data from a given table.
Activity Parameters
The Select Row(s) from Table activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Distinct (combo box control) (type: string): whether the returned values should be distinct or not.
- Fields (text box editor type) (type: string): the column headers that you want to be returned with the select command. If you enter more than one you should separate them with ','.
- Limit (text box editor type) (type: string): limit the number of results.
- Order By (text box editor type) (type: string): the column header that you want to result to be ordered by.
- Order by Direction (combo box control) (type: string): choose to order the resulted rows in ASC or DESC direction. It will be ignored if Order By is not set.
- Table (text box editor type) (type: string): the table name on which to run the select.
- WHERE (text box editor type) (type: string): the Where statement. For example: ID>2 where ID is a column header.
As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Select Row(s) from Table activity:
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: collection<collection<string>>): outputs a collection of collections of strings containing the selected rows.To use the elements of the collection, use Get Element From Collection activity.
- Output Columns (type: int32): outputs the number of columns returned.
- Output Rows (type: int32): outputs the number of rows returned.
