System Data toolkit
The System Data toolkit (TWSYS) provides the base types and services that are required to build a process, and is installed by default as a dependency with a process application. Additionally, the toolkit has integration services to integrate different technologies with a process. The technologies to integrate with include email, JDBC, HTTP, XML, and datasources, such as databases, URLs, and email servers.
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 another 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.
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 cannot edit or change
the artifacts in the System Data toolkit, but you can open the toolkit, view its artifacts, and
design assets based on the toolkit artifacts.
Services provided
The System Data toolkit provides several types of services:
- Database services – Use database services to upload or retrieve data from a database provider.
- Integration services – Use integration services to integrate content from an HTTP provider or the local file system.
- Mail services – Use mail services 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 into a process or service flow. The following services are not supported in the container version of Business Automation Workflow.
| Service name | Purpose |
|---|---|
| Call WebService via SOAP (Integration) | Creates a SOAP request and sends it to the specified provider to configure HTTP Basic Auth to be used on the SOAP request. The service uses the SOAPMessageConnector serviceability method. |
| Default BPD Event (Quick Start) | This service is used by the Fire Default BPD Event heritage human service. |
| Default System Service (Quick Start) | This service is used by IBM® Process Designer when a system service is created. |
| Email Get System Default Properties (SLAs) | This JavaScript gets the system default email configuration (SMTP configuration and address) from the TWConfig object. |
| Email Send IBM BPM Email (SLAs) | Gets the default email configuration and sends an email using the local variables that are defined in the process to specify the sender, recipient, content, and so on. |
| Extract XML Validation Results (XML) | This JavaScript 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 |
These services are 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 a username, password, and mailbox. It uses a mail service operation intermessage. |
| Read email via POP (Mail) | Reads email by using POP from server using a specified username and password. It uses a inter-message 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 a violation record parameter and also email parameters contained in an XMLElement. |
| SQL Blob to File (Database) | Reads a BLOB object from a specified data source by using the provided SQL query, and writes the BLOB to a file. This service can be called in a loop to read the BLOB in chunks by using index-setting parameters and to indicate what to append to the file. The SQLConnector operation directory is the service implementation. |
| SQL Blob to File (SQLStatement) (Database) | Reads a BLOB object from a specified data source by using the provided SQL query, and writes the BLOB to a file. This service can be called in a loop to read the BLOB in chunks by using index-setting parameters and to indicate what to append to the file. The SQLConnector operation blobTofile is the service implementation. |
| SQL Call Multiple Stored Procedures (Database) | Runs a number of SQL statements by using the callMultiple SQLConnector operation. |
| SQL Call Multiple Stored Procedures (SQLResult) (Database) | Runs a number of SQL statements by using the callMultiple SQLConnector operation. |
| SQL Call Stored Procedure (Database) | Runs an SQL statement by using the callFlat SQLConnector operation. |
| SQL Call Stored Procedure (SQLResult) (Database) | Runs an SQL statement by using the callFlat SQLConnector operation. |
| SQL Call Stored Procedure (SQLStatement) (Database) | Runs an SQL statement by using the call SQLConnector operation. |
| SQL Clob to File (Database) | Reads a CLOB from a data source by using the SQLStatement provided to the service. The service can be called in a loop, and the CLOB can be read and written to the file in chunks. The service uses the clobToFlatFile SQLConnector operation. |
| SQL Clob to File (SQLStatement) (Database) | Reads a CLOB from a data source by using the SQLStatement provided to the service. The service can be called in a loop, and the CLOB can be read and written to the file in chunks. The service uses the clobToFile SQLConnector operation. |
| SQL Execute Multiple Statements (Database) | Runs a collection of SQL statements on the provided data source by using the executeMultiple SQLConnector operation. |
| SQL Execute Multiple Statements (SQLResult) (Database) | Runs a collection of SQL statements on the provided datasource by using the executeMultiple SQLConnector operation. |
| SQL Execute Script (SQLResult) (Database) | Runs a SQL Script (ddl) on the provided datasource by using the executeScript SQLConnector operation. |
| SQL Execute Statement (Database) | Runs a single SQL statement on the provided datasource by using the executeFlat SQLConnector operation. |
| SQL Execute Statement (SQLResult) (Database) | Runs a single SQL statement on the provided datasource by 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 by using the provided query 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 by using the provided query 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 by using the provided query 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 by using the provided query and the fileToClob SQLConnector operation. |
| SQL Get Database Type (Database) | Gets the database type by 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 by using a retrieval service. |
| Transform XML Document to Document using specified XSL Document (XML) | Transforms an XML document to an XMLDocument by using the transformToXML XSLConnector operation. |
| Transform XML Document to Document using specified XSL file (XML) | Transforms an XML document to an XMLDocument by using a specified XSL file and the transformToXML XSLConnector operation. |
| Transform XML Document using XSL Document (XML) | Transforms an XML document to a String by using a specified XSL document and the transform XSLConnector operation. |
| Transform XML Document using XSL file (XML) | Transforms an XML document to a String by using a specified XSL file and the transform XSLConnector operation. |
| Transform XML file to Document using XSL file (XML) | Transforms an XML file to an XMLDocument by using a specified XSL file and the transformToXML XSLConnector operation. |
| Transform XML file using XSL file (XML) | Transforms an XML file to a String by using a 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 by using the validate SimpleXMLValidator operation. |
| Validate XML from URL (XML) | Validates an XML document from a URL by using the validate SimpleXMLValidator operation. |
| Validate XML String (XML) | Validates an XML document from a passed String variable by using the validate SimpleXMLValidator operation. |
| Write Text File (Integration) | Writes text to a specified file by using the writeTextToFile files service operation. |
User interfaces
The System Data toolkit provides the Heritage Human Services user interface,
which is composed of the following elements:
- 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, which defines the look and feel of the coach.
External services
The 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 or
XSL providers, and databases.
- Files – Reads or writes to a file on the local file system.
- HttpClient – Uses the HTTP protocol to read and write data from an HTTP provider.
- HttpClient2 – Uses the HTTPS protocol to securely read and write data from an HTTPS provider.
- Mail – Reads and writes mail using a MAP, POP, or SMTP protocol.
- SimpleXMLValidator – Validates XML documents.
- SOAPMessageConnector – Runs a web service.
- SQLConnector – Provides operations to run SQL statements on a database.
- XSLConnector – 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) named default BPD event.
Teams
The System Data toolkit provides the following teams that you can use to control the 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 that 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. For example, the integration.jar file that 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.