OpenGroupwareIntegrationEngine

[Home] Example Worklow Routes

• OpenGroupware Integration Engine
  • Supported Actions
  • Look-up Tables
  • Flow Control
  • Articles
  • Formats
  • External Data Sources
    • LDAP
    • SQL

OpenGroupware Integration Engine

The OpenGroupware Integration Engine, or OIE for short, is a workflow solution built into OpenGroupware Coils. OIE allows for the automation of a variety of tasks in a controlled, manageable, and audit-able manner; the intention is to largely eliminate the need for scripts and other ad-hoc solutions for performing data motion such as ETLs or report generation.

See Developing a Workflow UI if you are interesting in helping with that.

Supported Actions

Note that this is not a comprehensive list of actions supported by OIE but a list maintained to illustrate the comprehensive capabilities of OIE.

• [sqlInsertAction] : Insert records into an SQL database,
• [sqlUpdateAction] : Update records in an SQL database,
• [sqlUpsertAction] : Conditionally update or insert records in an SQL database.
• [sqlDeleteAction] : Delete records from an SQL database.
• [sqlExecuteAction] : Execute an arbitrary SQL command sequence.
• [ldapSearchAction] : Search an LDAP DSA
• [rmlToPDFAction] : Transform RML (XML) to PDF
• [transformAction] : Perform XSLT transforms
• [printToLPRAction] : Submit a job to an LPR print server
• [assignAction] : Assign arbitrary content to a message
• [sshGetFileAction] : Retrieve a file via SCP
• [sshPutFileAction] : Upload a file via SCP
• [sshExecCommandAction] : Execute a command on a remote host via SSH
• [readAction] : Read and translate via a defined format. (CSV, DIF, Fixed, or XLS)
• [writeAction] : Write XML data to a defined format. (CSV, DIF, Fixed, or XLS)
• [sendMailAction] : Send a message via SMTP
• [xpathMergeAction] : Merge two XML documents
• [xpathAction] : Query an XML document using XPath
• [smbGetFileAction] : Retrieve a file from a CIFS/SMB server
• [smbPutFileAction] : Submit a file to a CIFS/SMB server
• [ftpGetFileAction] : Retrieve a file from an FTP service.
• [extractFromZipArchiveAction] : Extract an object from a ZIP archive.
• [queueProcessAction] : Queue another process for execution.

Look-up Tables

[OIE Lookup Tables]

Flow Control

Foreach and switch flow control structures are supported. While is not yet implemented.

Articles

• Presentation on OIE given at GRPUG 2012-11-19.
• Preventing a completed route from being deleted.
• Using socket connections to drive data to OIE
• Invoking an OIE route from PHP
• XSLT extensions in OIE
• An introduction to OIE tables
• Using the workflow scheduler
• SQL Operation Filtering
• Using SSH & SCP from OIE
• Starting & Stopping Process Invocation
• The SMTP Listener

Formats

A variety of format classes are provided for importing and exporting data. Primarily these formats are used by the [readAction] and [writeAction] work-flow actions. Supported formats include:

Format Class	Read	Write	Description
[SimpleDIFFormat]	Implemented	Not Implemented	Processes DIF format columnar row-oriented data.
[SimpleDelimitedFieldFormat]	Implemented	Implemented	Processes line-oriented delimited data.
[SimpleFixedFieldFormat]	Implemented	Implemented	Processes line-orient fixed field length data.
[SimpleXLSFormat]	Not Tested	Implemented	Primarily for producing XLS (pre-Excel 2007) worksheets.
[ColumnarXLSReaderFormat]	Implemented	Not Implemented	Reads XLS (pre-Excel 2007) worksheets to create row oriented data.
[NestedDelimitedFieldFormat]	Implemented	Implemented	Processes delimited files of varying record type based upon a record type identified in a field.
[NestedFixedFieldFormat]	Implemented	Not Implemented	Processes fixed record length data of varying record type based upon a record type indentified at a specified offset.

XML data is supported naturally, usually transformed using the [transformAction]. There is a [readJSONAction] for accepting JSON data for transformation.

In addition to the format classes the [xlsToXmlAction] can be used to process pre-Excel 2007 XLS worksheets into XML without expectation of a specific structure.

External Data Sources

LDAP

SQL

Provisioned SQL datasources are determined by the [OIESQLDataSources] default.