System Data toolkit
The System Data toolkit (TWSYS), which is installed with a process application by default as a dependency, provides the base types and services required to build a process. Plus, the toolkit has integration services for integrating different technologies, such as email, JDBC, HTTP, and XML, and datasource, such as databases, URLs, and email servers, with a process.
While IBM® Business Automation Workflow is installed, the System Data toolkit is imported into the IBM Workflow Center repository.
There are two versions of the System Data toolkit: one for use in projects when the target
environment is set to Traditional (8.6.0.0) and one
for use in projects when the target environment is set to Traditional or
Container (8.6.0.0_TC). Traditional: Predefined assets that
use and support deprecated capabilities are only in the 8.6.0.0 System Data toolkit, not in the
8.6.0.0_TC System Data toolkit.
Important: You can't edit or change the artifacts in the
System Data toolkit, but you can open the toolkit and view the artifacts in it and design artifacts
based on them.
Services provided
The System Data toolkit provides several types of services:
- Database services – these are services that can be used to upload or retrieve data from a database provider.
- Integration services – these are services that allow you to integrate content from an HTTP provider or the local file system.
- Mail services – these are services that allow you to send or receive eMail from a process.
- Quick Start services
- SLA services
- XML services
Traditional: The System Data toolkit provides various services that can be incorporated (wired into) into a process or service flow. The following services aren't supported in the container version of Business Automation Workflow.
| Service name | Purpose |
|---|---|
| Call WebService via SOAP (Integration) | Use to create a SOAP request and send it to the specified provider to configure HTTP Basic Auth to be used on the SOAP request. This services uses the SOAPMessageConnector service method serviceability. |
| Default BPD Event (Quick Start) | Used by the Fire Default BPD Event heritage human service. |
| Default System Service (Quick Start) | Used by IBM Process Designer when a system service is created. |
| Email Get System Default Properties (SLAs) | A JavaScript that gets the system default email configuration (smtp configuration and address) from the TWConfig object. |
| Email Send IBM BPM Email (SLAs) | Used to get the default email configuration and send an email using the local variables defined in the process to specify the sender, the recipient, the content, and so on. |
| Extract XML Validation Results (XML) | A JavaScript that extracts the XML validation results from a Map object. |
| Lsw Create Conditional Activity Selection Tree HTML, Lsw Create Insert CA Template Statement Lsw Create Update CA Template Statement Lsw Get Conditional Activity Template Names Lsw Get Next CA Template Primary Key Lsw Load Conditional Activity Template Lsw Save Conditional Activity Template |
Used by the LSW Conditional activity selection coach and the LSW Save Conditional Activity Template Coach. |
| Read email via IMAP (Mail) | Reads email by using IMAP from server using specified username, password, and mailbox. It uses a mail service operation intermessage. |
| Read email via POP (Mail) | Reads email by using POP from server using specified username and password. It uses a intermessage mail service operation. |
| Read from HTTP (Integration) | Connects to a URL and reads the HTTP document from the site. This service provides the option of using SSL and uses the HTTPClient service operation talk to read HTTP data. It uses the HTTPClient2 service operation talk to read HTTPS data. |
| Read Text File (Integration) | Reads a file from a specified location. This service uses the interferometer files service operation. |
| Send email via SMTP (Mail) | Sends email to an SMTP server. It uses a send Message mail service operation. |
| SLA Sent Alert Email (SLAs) | Sends an email with the SLAViolationRecord to the specified address. This service has the violation Record parameter and parameters that contain the email parameters in an XMLElement. |
| SQL Blob to File (Database) | Reads a BLOB object from a specified data source using the SQL query provided and writes the BLOB to a file. This service can be called in a loop to read the BLOB in chunks by using the parameters to set the index into the BLOB and to indicate whether to append to the file. The SQLConnector operation directorial is this service's implementation. |
| SQL Blob to File (SQLStatement) (Database) | Reads a BLOB object from a specified data source using the SQL query provided and writes the BLOB to a file. This service can be called in a loop to read the BLOB in chunks by using the parameters to set the index into the BLOB and to indicate whether to append to the file. The SQLConnector operation blobTofile is this service's implementation. |
| SQL Call Multiple Stored Procedures (Database) | Runs a number of SQL statements using the callMultiple SQLConnector operation. |
| SQL Call Multiple Stored Procedures (SQLResult) (Database) | Runs a number of SQL statements using the callMultiple SQLConnector operation. |
| SQL Call Stored Procedure (Database) | Runs an SQL statement using the callFlat SQLConnector operation. |
| SQL Call Stored Procedure (SQLResult) (Database) | Runs an SQL statement using the callFlat SQLConnector operation. |
| SQL Call Stored Procedure (SQLStatement) (Database) | Runs an SQL statement using the call SQLConnector operation. |
| SQL Clob to File (Database) | Reads a CLOB from a data source using the SQLStatement provided to the service. The service can be called in a loop and the CLOB read and written to the file in chunks. It uses the clobToFlatFile SQLConnector operation. |
| SQL Clob to File (SQLStatement) (Database) | Reads a CLOB from a data source using the SQLStatement provided to the service. The service can be called in a loop and the CLOB read and written to the file in chunks. It uses the clobToFile SQLConnector operation. |
| SQL Execute Multiple Statements (Database) | Runs a collection of SQL statements on the provided data source using the executeMultiple SQLConnector operation. |
| SQL Execute Multiple Statements (SQLResult) (Database) | Runs a collection of SQL statements on the provided datasource using the executeMultiple SQLConnector operation. |
| SQL Execute Script (SQLResult) (Database) | Runs a SQL Script (ddl) on the provided datasource using the executeScript SQLConnector operation. |
| SQL Execute Statement (Database) | Runs a single SQL statement on the provided datasource using the executeFlat SQLConnector operation. |
| SQL Execute Statement (SQLResult) (Database) | Runs a single SQL statement on the provided datasource using the executeFlat SQLConnector operation. |
| SQL File to Blob (Database) | Reads the contents of a file as binary data and writes it into the specified BLOB using the query provided and the fileToBlobFlat SQLConnector operation. |
| SQL File to Blob (SQLStatement) (Database) | Reads the contents of a file as binary data and writes it into the specified BLOB using the query provided and the fileToBlob SQLConnector operation. |
| SQL File to Clob (Database) | Reads the contents of a file as characters and writes it into the specified CLOB using the query provided and the fileToClobFlat SQLConnector operation. |
| SQL File to Clob (SQLStatement) (Database) | Reads the contents of a file as characters and writes it into the specified CLOB using the query provided and the fileToClob SQLConnector operation. |
| SQL Get Database Type (Database) | A service that gets the database type from the database using the getDatabaseType SQLConnector operation. |
| Team Filter Service Template | Process Designer uses this template when a team filter service is created. |
| Team Retrieval Service Template | Process Designer uses this template when a team is created using a retrieval service. |
| Transform XML Document to Document using specified XSL Document (XML) | Transforms an XML document to an XMLDocument using the transformToXML XSLConnector operation. |
| Transform XML Document to Document using specified XSL file (XML) | Transforms an XML document to an XMLDocument using the specified XSL file to transform and using the transformToXML XSLConnector operation. |
| Transform XML Document using XSL Document (XML) | Transforms an XML document to a String using the specified XSL document and uses the transform XSLConnector operation. |
| Transform XML Document using XSL file (XML) | Transforms an XML document to a String using the specified XSL file and the transform XSLConnector operation. |
| Transform XML file to Document using XSL file (XML) | Transforms an XML file to an XMLDocument using the specified XSL file and the transformToXML XSLConnector operation. |
| Transform XML file using XSL file (XML) | Transforms an XML file to a String using the specified XSL file and the transformToXML XSLConnector operation. |
| Update All SLA Statuses (SLAs) | Invokes the Packages.com.lombardisoftware.core.sla.SLATracking.updateAllSLAs(); JavaScript call. |
| Update SLA Status (SLAs) | Invokes the Packages.com.lombardisoftware.core.sla.SLATracking.updateSLA(tw.local.slaName); JavaScript call. |
| Validate XML File (XML) | Validates an XML file using the validate SimpleXMLValidator operation. |
| Validate XML from URL (XML) | Validates an XML document from a URL using the validate SimpleXMLValidator operation. |
| Validate XML String (XML) | Validates an XML document from a passed String variable using the validate SimpleXMLValidator operation. |
| Write Text File (Integration) | Writes text to the specified file using the writeTextToFile files service operation. |
User interfaces
The System Data toolkit provides the Heritage Human Services user interface, which is composed of
- Fire Default BPD Event (Quick Start)
- Heritage Default Human Service (deprecated)
- Lsw Conditional Activity Selection Coach
- Lsw Save Conditional Activity Template Coach
The System Data toolkit also provides the implementation for the Classic theme. This defines a look and feel for the coach.
External services
These following external services enable a service or workflow to read and write data from
external sources, such as the local file system, HTTP providers, web service providers, mail
servers, XML and XSL providers, and databases:
- Files – reads or writes to a file on the local file system
- HttpClient – uses HTTP to
- HttpClient2 – uses HTTPs to
- Mail – reads and write mail using MAP, POP, or SMTP
- SimpleXMLValidator – validates XML documents
- SOAPMessageConnector – runs a web service
- SQLConnector – provides operations to run SQL statements on a database
- XSLConnector – this is an external service that performs XSL transforms on documents
Deprecated services
The following services are deprecated:- XML transformation
- Transform XML Document to Document using XSL Document
- Transform XML Document to Document using XSL File
- Transform XML Document using XSL Document
- Transform XML Document using XSL File
- Transform XML file to Document using XSL file
Transform XML file using XSL file
- XML validation
- Extract XML Validation Results
- Validate XML File
- Validate XML from URL
- Validate XML String
Events
The System Data toolkit provides an undercover agent (UCA) called default BPD event.
Teams
The System Data toolkit provides the following teams you can use to control access to data and processes
- All Users
- Background
- Managers
- Managers of All Users
- Process Owner
- System
Data
The data section of the System Data toolkit contains all the standard business object definitions you can use in your processes and workflows, for example, Boolean, Integer, and String.
Files
The files provided in the System Data toolkit are used by the toolkit itself. One of the files is the integration.jar file, which contains the implementation of the external services.
Performance
The performance section of the System Data toolkit contains the following tracking groups:
- PROCESSFLOWS – captures the following values each time a line is traversed in a process:
- BPD_ID
- BPD_INSTANCE_ID
- LOCAL_SNAPSHOT_ID
- SEQUENCE_FLOW_ID
- SOURCE_UUID
- STEP_NUMBER
- TRACKING_GROUP_ID
- TRACKING_POINT_ID
- TASK_ID, FUNCTIONAL_TASK_ID
- TIME_STAMP
- SNAPSHOT
- ACRONYM
- TIME_STAMP data
- SLASTATUS – tracks the status of each SLA as a result of an SLA rollup.
- SLATHRESHOLDTRAVERSALS – tracks a value whenever an activity with an attached SLA completes.