Infoworks 6.1.3
Admin and Operations

Custom Audit Columns

The Custom Audit Columns feature allows you to add, edit, delete the additional columns of a Source or a Pipeline, for auditing purposes. You can sync the custom audit columns for Pipelines only.

NOTE The custom audit columns that are added apply to all target tables. For pre-existing tables, you must truncate, recrawl, and re-ingest the tables. The custom audit columns are automatically added for new pipeline targets.

Add Custom Audit Columns for Sources

To add the custom audit columns, perform the following steps:

  1. Select Custom Audit Columns from the Administration menu on the left navigation panel.
  1. Click Add Custom Audit Columns.
  2. Enter the following fields in the Add Custom Audit Columns screen.
FieldDescription
Column NameEnter the name of the audit column that you are adding. By default, the column name appears with the prefix ZIW.
DescriptionEnter a description for the column.
Entity TypeSelect Source from the drop-down menu. This is the entity that the column will apply to.
ParameterSelect a parameter from the drop-down menu. This is the information that will be written to the column.
  1. You can add the following parameters for the sources:
ParameterDescription
Job IDThe last Job ID that processed the record.
Schema nameThe schema name of the source table.
Source IDThe Source ID of the table.
Table IDThe Table ID of the table.
Workflow IDThe Workflow ID of the table.
Workflow Run IDThe workflow ID of the record that is processed.
Source NameThe source name of the table.
Table NameThe table name where the custom audit column is added.
  1. Click Save to save the changes.

View the Change History of the Custom Audit Columns

To view the change history of the audit columns, click View Audits. The Audits for Custom Audit Columns screen appears.

NOTE Only the newly added and deleted audit columns appear in the change history.

Edit the Custom Audit Columns

You can edit only the description of an Audit column.

To edit the description, perform the following steps:

  1. Select the Edit icon under the Actions column in the Custom Audit Columns screen.
  2. Update the Description in the Edit Custom Audit screen.
  3. Click Save. The details are updated.

Delete the Custom Audit Column

To delete the custom audit column, perform the following steps:

  1. Click the Delete icon in the Actions column in the Custom Audit Columns screen.
  2. Click Yes to continue in the confirmatory dialog box that appears. The Audit column is deleted.

Sync Custom Audit Columns for Sources

NOTE For Kafka, JSON, and Confluent sources there is no recrawl and truncate options available for custom audit columns.

Perform the following steps for these sources to sync the custom audit columns.

  1. Navigate to one of the Kafka, JSON, or Confluent sources.
  1. Click Topic Mappings on the top navigation panel.

NOTE For JSON source, you must click File Mappings.

  1. Select the Topic Mappings to be updated and edit the columns in the schema under Edit Schema.
  2. Click Sync Custom Audit Columns and Save Schema. The audit columns are synced and the schema defined is saved.

Add Custom Audit Columns for Pipelines

To add the custom audit columns, perform the following steps:

  1. Select Custom Audit Columns from the Administration menu on the left.
  2. Click Add Custom Audit Columns.
  3. Enter the following fields in the Add Custom Audit Columns screen.
ParameterDescription
Column NameEnter the name of the audit column that you are adding. By default, the column name appears with the prefix ZIW.
DescriptionEnter a description for the column.
Entity TypeSelect the Pipeline from the drop-down menu. This is the entity that the column will apply to.
ParameterSelect a parameter from the drop-down menu. This is the information that will be written to the column.
  1. You can add the following parameters for Pipelines:
ParameterDescription
Job IDThe last Job ID that processed the record.
Pipeline IDThe Pipeline ID of the target table.
Workflow IDThe Workflow ID of the target table.
Workflow Run IDThe workflow Run ID of the Pipeline that is processed.
  1. Click Save to save the details.

Sync Custom Audit Columns for Pipelines

You must perform this procedure to sync the pipeline targets whenever a custom audit column is added or deleted.

To sync the custom audit column, perform the following steps:

  1. Select Domains from the left navigation panel.
  2. Select one of the domains and the pipelines from the list.
  1. Click Open Editor at the top right corner.
  1. Double-click the Target on the editor and navigate to the Outputs tab.
  2. Click Sync Custom Audit Columns. The custom audit columns are synced successfully.
  Last updated