3.4 Misc Functions
- Jenni Wallin
- Former user (Deleted)
abort
Stops the workflow, and logs a user defined message to the System Log.
void abort( Throwable t )
| Parameter | Description |
|---|---|
t | An exception containing the reason for the abort, which is sent to the System Log when the workflow is aborted |
Returns | Nothing |
Note!
The block to be executed after an abort call is the deinitialize function block.
externalReferenceGet
This function fetches an External Reference value from an external source. For information about External References, see 8.11 External Reference Profile in the Desktop user's guide.
String getExternalReference( String profileName, String key );
| Parameter | Description |
|---|---|
| The External Reference Profile |
| The External Reference key |
Returns | The External Reference value Note! To convert the returned value type from string to another data type, use the standard Java type casting function. |
getDBConnection
This function retrieves the JDBC connection object from the connectionpool in the Database profile.
Closing Connections
Ensure that all connections are closed when it is no longer in use! This is to prevent any connection leaks.
Connection getDBConnection (String dbprofile) throws Exception;
| Parameter | Description |
|---|---|
| Name of the Database profile. |
Returns | Nothing |
Example - Using getDBConnection
connection = env.getDBConnection("Default.PRF_Oracle_Conn");
getInputTypes
This function will get the input types defined in the agent by their local names.
public Map<String, Type> getInputTypes();
| Parameter | Description |
|---|---|
Returns | The local name of the input types. |
getOutputTypes
This function will get the output types defined in the agent by their local names.
public Map<String, Type> getOutputTypes();
| Parameter | Description |
|---|---|
Returns | The local name of the output types. |
getRoutes
This function will get the routes defined in the agents by their local name. This is required to specify the routes for the route function.
public Map<String, Route> getRoutes();
| Parameter | Description |
|---|---|
Returns: | All connected routes by local name. |
isStopped
Returns true if the agent is instructed to stop.
boolean isStopped();
| Parameter | Description |
|---|---|
Returns |
|