Utility Entries
Utility Entries
Truncate tables
Description
Truncate Tables is a Process Entry in the Utilities plugin for Process Studio Processes. This process entry allows you to truncate one or several tables at once without writing any SQL command.
Configurations
No.
Field Name
Description
1
Process Entry name
Specify a unique name for the process entry, on the workspace area. A process entry can be placed on the canvas several times; and each instance of the entry must have a unique name.
2
Connection
Name of the database connection on which the tables reside. Use "Edit..." and "New..." to edit and/or create a new connection.
3
Previous results to args?
Check this option if you want to get in a dynamic way tables to truncate from results of previous process entry.
Note: The first field has to be the table name and the second one the schema (leave it Null if it's not needed).
4
Click here to return tables name list
This button will return all tables defined on the connection. Select tables (one or several) and press "OK". Tables name will be automatically added to "Selected tables" grid.
5
Selected tables grid
Specify here the tables to truncate (insert it manually or use the previous button). If the table is in a different schema that the default one, please specify the schema name.
6
Delete
Remove entries from grid (select one several entries and click on this button to remove it).
7
OK
Click on this button to save process entry settings changes
8
Cancel
Discard process entry settings changes
Display Msgbox Info
Description
Display Msgbox Info is a Process Entry in the Utilities plugin for Process Studio Processes. This process entry displays a message box in a process. You can easily see where you are in the process. This entry is only available when using the Graphical User Interface of Process Studio to execute the process.
The message box displays "OK" and "Cancel" buttons.
- Clicking on "OK" exits on the green hop
- Clicking on "Cancel" exits on the red hop
- When running this entry from a non-Graphical User Interface, the entry always exits on the green hop
Configurations
No.
Field Name
Description
1
Process Entry name
Specify a unique name for the process entry, on the workspace area. A process entry can be placed on the canvas several times; and each instance of the entry must have a unique name.
2
Message title
The title of the message
3
Message body
The message to display
Evaluate rows number in a table (Wait for SQL)
Description
Wait for SQL is a Process Entry in the Utilities plugin for Process Studio Processes. The Wait for SQL process entry scans a database and checks if the specified database table meets user-defined conditions.
Configurations
No.
Field Name
Description
1
Process Entry name
Specify a unique name for the process entry, on the workspace area. A process entry can be placed on the canvas several times; and each instance of the entry must have a unique name.
2
Connection
Identifies the database connection to use
3
Target schema
Name of the table schema to evaluate
4
Target table name
Name of the table to evaluate
5
Success when rows count
Defines the evaluation method used to compare the number of rows with the given value
6
Value
Defines the value used for the evaluation
7
Maximum timeout
After this timeout period, the process entry continues with a fail, by default, or success, if the Success on timeout option is checked
8
Check cycle time
Sets the amount time between evaluations
9
Success on timeout
Defines process entry success behavior when timeout is reached---when checked, reaching the maximum timeout limit causes the process entry to succeed. When left unchecked, reaching the maximum timeout limit causes the process entry to fail.
10
Custom SQL
Enables the use of custom SQL queries
11
Use variable substitution
Replaces environment variables in the SQL script with their actual value
12
Clear list of result rows before execution
Clears the list of result rows before running this process entry
13
Add rows to result
Includes returned rows to the result set
Abort process
Description
Abort process is a Process Entry in the Utilities plugin for Process Studio Processes. Abort process Entry aborts a process.
Configurations
No.
Field Name
Description
1
Process Entry name
Specify a unique name for the process entry, on the workspace area. A process entry can be placed on the canvas several times; and each instance of the entry must have a unique name.
2
Message
Message to add in log when aborting
Ping a host
Description
Ping a host is a Process Entry in the Utilities plugin for Process Studio Processes. Ping a host process entry to pings a host using the ICMP protocol. The result it true when the host is reachable, otherwise false.
Configurations
No.
Field Name
Description
1
Process Entry name
Specify a unique name for the process entry, on the workspace area. A process entry can be placed on the canvas several times; and each instance of the entry must have a unique name.
2
Host name/IP
The name or the IP address of the host to ping
3
Ping type
Classic ping: This calls the ping as a command line of the operating system. The result is true when no packets (defined in the "Nr. packets to send" option) are lost.
System ping: This option uses the Java implemented methods. The result is true when the host name can be resolved and the host is reachable within the given timeout period.
System ping then classic ping: try both options (first the system ping and when that fails, try the classic ping)4
Timeout (ms)
The timeout in ms when the system ping option is used.
5
Nr. packets to send
The number of packets to send (by default 2, only used by the Classic ping option).
Write to Log
Description
Write to Log is a Process Entry in the Utilities plugin for Process Studio Processes. Write to Log Process Entry writes log messages to the PROCESS STUDIO logging system. Log messages may include Process Studio variables that are replaced at run time.
Configurations
No.
Field Name
Description
1
Process Entry name
Specify a unique name for the process entry, on the workspace area. A process entry can be placed on the canvas several times; and each instance of the entry must have a unique name.
2
Log level
The logging level to use
3
Log subject
The subject to use in the logging line(s)
4
Log message
The log message to write to the log