JDBC Endpoints

You can use the JDBC Export integration to configure multiple database endpoints to use with the Workflow Engine. After you set up an endpoint, you can use the exportViaJDBC function to send it data.

Before you begin

Before you begin setting up the integration, make sure you have the following information about your endpoint:

  • Endpoint Name: A unique name for the endpoint to use in the Workflow Engine configuration.

  • Database Name: The database to use for the endpoint.

  • Database Type: The type of database in the connection. For example: MySQL, MS SQL, Oracle, or Other.

Host Details

Make sure you have the following information about the host:

  • Host: Name of the host for the database.

  • Port: Port to use to connect to the database.

  • Username: Name to use to authenticate to the database.

  • Password: Password to use with the username.

Additional Details

If you need to provide additional or advanced information to establish the connection to the host and database, you can add additional details here. For each additional detail you provide, add a property in the format.

  • Name: The property name.

  • Value: The property value.

Advanced Configuration

The Advanced Configuration settings are presented when you choose "Other" as the Database Type.

  • Column Start and End Identifier: The value start and end identifiers are used to surround text items (column names, values) in an insert statement. These are database dependent - refer to the vendor documentation to select the most appropriate for the target database.

  • JAR Files: One or more JAR file names with including path to the JAR files.

  • Class Name: Specific class name to use for the JAR files.

  • JDBC URL: Text to use for the URL needed to use the JAR file.

Schema Details

The schema details allow you to define the column details for the destination table. When you define the workflow function, you will need to provide both the endpoint name and the schema definition name.

Schema Details Properties

  • Schema Definition Name: Name to use to reference this specific schema from the workflow action.

  • Schema Name: Some database systems require the database, schema, and table to be referenced. Enter the Schema Name as needed.

  • Table Name: Name of the destination table for the export.

  • Operation Type: Select INSERT to perform direct inserts into the table, or Stored procedure to reference a specific procedure to pass the exported information to.

Column Details

By default, the values from a payload honor the source keyname and data type. The payload macros can be used to change a value's data type. See Payload Maps for additional information. Use the schema details to define overrides for the export, keys to column names, and value data-types. The supported data types are: auto-increment (0 will be sent), number, string, boolean (bare true or false value) or guid to generate a GUID.

  • Payload Key Name: The name of the payload key defined in Payload Maps.

  • Column Name: (Optional) Specify the name of the destination column if the Payload Key Name is not the same as the actual column name.

  • Column Type: Choose the data type of the destination column. The integration will attempt to translate the source value type to this type. Valid options are: use source Type, string, number, auto-increment, boolean, and guid.

Configure the Integration

You can configure multiple endpoints and schemas from this integration.

To configure an endpoint, provide the following:

  • A unique integration name. You can use the default name or customize the name according to your needs.

  • A unique endpoint name and all information required to access the endpoint.

To configure a schema, provide the following:

  • A unique schema definition name and all the information required to use the schema.

Use an Endpoint in a Workflow

After you complete the configuration, you can refer to the endpoint by name and schema by definition name in your workflows. See exportViaJDBC for more information.