exportViaJDBC

A Workflow Engine function that exports alert and Situation data to an external JDBC endpoint. Supported JDBC endpoints include:

  • MySQL

  • SQL Server

  • Oracle

This function requires that the getPayload function precedes it to get the payloads and map payload keys to DB columns to be exported into.

JDBC Endpoint is configured via the JDBC Endpoints Integration tile, and payloads are configured via the Payloads Integration tile. Each of these Integration tiles contains detail on how to configure payloads and endpoints.

This function is available as a feature of the Add-ons v2.3 download and later.

This function is available for alert and Situation workflows.

The workflow sweep up filter applies to this function.

Back to Workflow Engine Functions Reference.

Arguments

Workflow Engine function exportViaJDBC takes the following arguments:

Name

Required

Type

Description

endpointName

yes

string

The name of the pre-defined JDBC endpoint to send data to.

schemaDefName

yes

string

The name of the schema definition specified under JDBC Endpoints integration in the UI, which includes:

  • schema name

  • table/procedure name

  • column/field mappings against payload mapping

Example

The following example demonstrates typical use of Workflow Engine function exportViaJDB.

Given a predefined JDBC endpoint named “AlertMySQLExport” and schemaDefName as “AlertMySQLExporter” the function arguments are as follows:

{"endpointName":"AlertMySQLExport", "schemaDefName": "AlertMySQLExporter}

The function returns true if the endpoint and schema configuration are found and the export was successful. It returns false if the endpoint and schema configuration were not found, or if the export was unsuccessful.

This function does not modify the in-scope CEvent object.