Configure Custom Tables

This page details the specific configuration and input options for the Configure Custom Tables Orchestrator.

This guidance should be read in conjunction with the Common Configuration page which details the standard application configuration.

Purpose

The key purpose of this Orchestrator is the update of Custom Tables in iManage.

Operation Name

ConfigureCustomTables

Common Configuration

There is common configuration available within this job Orchestrator. The common configuration options can be found here.

Input Data Schema

Data can be read via SQL or CSV and requires the following data headers and values:

CSV

Headers	Description	Mandatory	Expected Value
`Id`	This is the row ID	Yes	Numeric value
`TargetLibraryId`	The ID of the iManage Library	Yes	iManage Library identifier i.e. ‘Active’
`TargetObjectId`	Allows you to target a specific custom table	No	iManage identifier i.e. custom1, custom2
`Action`	Specifies the action being applied	Yes	`create` or `update`
`Alias`	The value of the custom entry alias / “id”	Yes	iManage Custom Field Alias for example: ‘1234’
`Description`	The description to apply to the Custom Field	No	iManage Custom Field Description for example: ‘Client X’
`EntryEnabled`	Sets the enabled status for the Custom Field	No If blank then: For updates it will not update the status For creation it will default to enabled	`true` `false`
`EntryHipaa`	Sets the Hipaa status for the Custom Field	No If blank then: For updates it will not update the status For creation it will default to disabled	`true` `false`
`ParentAlias`	Sets the parent value alias for the Custom Field	Yes (only for Custom 2 and 30)	iManage Custom Field Alias for example: ‘1234’
`Processed`	Indicates if the row has been processed	No	'0'

SQL

SQL Input uses the same values as the CSV input above. The SQL Schema is detailed below:

SQL

CREATE TABLE ConfigureCustomTablesInput (
  Id INT IDENTITY(1,1) PRIMARY KEY,
  Processed BIT NOT NULL,
  TargetLibraryId VARCHAR(25) NOT NULL,
  TargetObjectId VARCHAR(25),
  [Action] VARCHAR(25) NOT NULL,
  Alias NVARCHAR(32) NOT NULL,
  [Description] VARCHAR(254),
  EntryEnabled BIT NOT NULL,
  EntryHipaa BIT NOT NULL,
  ParentAlias VARCHAR(255)
);

Job File Options

This section details the configurable options within the orchestrator.

Configuration	Description	Expected Value
Create
`Enabled`	Sets whether the create process is enabled or disabled	`true` `false`
`AllowEmptyDescription`	If false, empty/null `Description` values will cause a row processing failure	`true` `false`
Update
`Enabled`	Sets whether the update process is enabled or disabled	`true` `false`
`AllowEmptyDescription`	If false, empty/null `Description` values will cause a row processing failure	`true` `false`

Output Events

These output events are specific to the Configure Custom Tables Orchestrator and works in addition to the common output events detailed in Common Configuration

The following output events can be persisted via the ‘Subscribed To’ configuration

Target	Action	Status	Full Event Identifier
`CustomTable`	`Create`	`Success` `Failed` `Skipped`	`customtable:create:success customtable:create:failed customtable:create:skipped`
`CustomTable`	`Update`	`Success` `Failed` `Skipped`	`customtable:update:success customtable:update:failed customtable:update:skipped`

These should be listed in the Orchestrator in the following format ‘Target:Action:Status’.

The event output schema is shown below:

SQL

CREATE TABLE ConfigureCustomTablesOutput (
  Id INT IDENTITY(1,1) PRIMARY KEY,
  EventTime DATETIMEOFFSET NOT NULL,
  CorrelationId VARCHAR(36) NOT NULL,
  [Action] VARCHAR(30) NOT NULL,
  [Status] VARCHAR(25) NOT NULL,
  [Message] NVARCHAR(MAX) NOT NULL,
  DataSourceRowId VARCHAR(25),
  TargetObjectType VARCHAR(25) NOT NULL,
  TargetObjectId VARCHAR(25),
  Alias VARCHAR(50),
  ParentAlias VARCHAR(50),
  [Description] VARCHAR(244)
);

Sample Job File

This is an example Job File for the ConfigureCustomTables Orchestrator:

JSON

{
  "Operation": "ConfigureCustomTables",
  "Options": {
    "Create": {
      "Enabled": true,
      "AllowEmptyDescription": true
    },
    "Update": {
      "Enabled": true,
      "AllowEmptyDescription": true
    }
  },
  "InputType": "CSV",
  "Inputs": {
    "CSV": {
      "Path": "<repo>\\source\\WorkspaceAutomate\\Test Files\\Csvs\\ConfigureCustomTables.csv"
    }
  },
  "Outputs": {
    "Console": {
      "Enabled": true,
      "SubscribedTo": [ "*" ]
    }
  },
  "Integrations": {
    "IManage": {
      "URL": "<url>",
      "Username": "<username>",
      "Password": "<password>"
    }
  }
}

Failure and Skip Behaviour

This Orchestrator follows the standard behaviour for failed/skipped records:

Skipped = Scenarios configured to not be processed for a specific reason e.g. AllowEmptyDescription: false would mark any custom field updates that have empty descriptions found as part of the processing of the operation as skipped.

Failed = Administrate tried to perform an action on the target object and an unexpected error occurred. e.g. iManage connection dropped and Administrate was unable to update a custom field that was configured to be updated.

iManage Behaviour

This section details the different behaviour across different versions of iManage i.e. On-Prem, iManage Cloud and Cloud iManage.

There are no differences for this operation between On-Prem and Cloud iManage