Move Workspace Folder Contents

This page details the specific configuration and input options for the Move Workspace Folder Contents 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 to move the contents of a folder or sub-folder to a new location within the same workspace.

Operation Name

MoveWorkspaceFolderContents

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 Workspace Id	No (unless `TargetObjectSearchQuery` is blank). Takes priority over the search query	iManage identifier i.e. ‘Active!1234’
`TargetObjectSearchQuery`	A JSON object which contains a dictionary matching any applicable profile parameters for the corresponding `TargetObjectType`	No (unless `TargetObjectId` is blank)	JSON format i.e. `{"custom1": "*", "custom2": "test"}` if using csv input then escaped values need to be used for multiple parameter queries. The following keys can be provided: `custom1-30` `name` `edit_date_from` `edit_date_to` `owner`
`SourceFolderPath`	Specifies the folder path of the parent folder containing the subfolders and document(s) to be moved	No	`/` delimited path of folder names. For example: `Folder A/Sub Folder 1/Target Folder` There should not be any spaces after the `/` delimiter
`TargetFolderPath`	Specifies the folder path of the parent folder of where the subfolders and document(s) will be moved	No	`/` delimited path of folder names. For example: `Folder A/Sub Folder 1/Target Folder` There should not be any spaces after the `/` delimiter
`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 MoveWorkspaceFolderContentsInput (
    Id INT IDENTITY(1,1) PRIMARY KEY,
    Processed BIT NOT NULL,
    TargetLibraryId NVARCHAR(MAX) NOT NULL,
    TargetObjectId NVARCHAR(MAX) NULL,
    TargetObjectSearchQuery NVARCHAR(MAX) NULL,
    SourceFolderPath NVARCHAR(MAX) NULL,
    TargetFolderPath NVARCHAR(MAX) NULL
);

Job File Options

This section details the configurable options within the orchestrator.

Configuration	Description	Expected Value
`Enabled`	Sets whether the update process is enabled or disabled	`true` `false`
`ActionMultipleQueryResults`	If enabled then the application will process all results returned by the search query. When disabled then the application will only process the request if one search result is identified	`true` `false`
`ExcludeNestedFolders`	If enabled only the document(s) stored in the Target Folder will be moved and excludes entire sub-folders	`true` `false`
`CreateTargetFolderIfMissing`	If enabled then the entire Target Folder path will be created if it doesn’t currently exist	`true` `false`

Output Events

These output events are specific to the Move Workspace Folder Contents 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
`Workspace`	`Object Query`	`Success` `Failed`	`workspace:objectquery:success workspace:objectquery:failed`
`Folder`	`Move`	`Success` `Failed` `Skipped`	`folder:move:success folder:move:failed folder:move: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 MoveWorkspaceFolderContentsOutput (
  Id INT IDENTITY(1,1) PRIMARY KEY,
  EventTime DATETIMEOFFSET NOT NULL,
  CorrelationId VARCHAR(36) NOT NULL,
  [Action] VARCHAR(25),
  [Status] VARCHAR(25) NOT NULL,
  [Message] NVARCHAR(MAX) NOT NULL,
  DataSourceRowId VARCHAR(25),
  TargetObjectType VARCHAR(25) NOT NULL,
  TargetObjectId VARCHAR(25),
  SourceFolder NVARCHAR(MAX),
  TargetFolder NVARCHAR(MAX),
  Workspace NVARCHAR(500),
  Folders NVARCHAR(MAX),
  Documents NVARCHAR(MAX),
  TargetSearchQuery NVARCHAR(MAX),
  TargetSearchQueryResultCount INT,
  TargetSearchQueryResultList NVARCHAR(MAX)
);

Sample Job File

This is an example Job File for the MoveWorkspaceFolderContents Orchestrator:

JSON

{
  "Operation": "MoveWorkspaceFolderContents",
  "Options": {
    "Enabled": true,
    "ActionMultipleQueryResults": false,
    "ExcludeNestedFolders": false,
    "CreateTargetFolderIfMissing": true
  },
  "InputType": "CSV",
  "Inputs": {
    "CSV": {
      "Path": "<repo>\\source\\WorkspaceAutomate\\Test Files\\Csvs\\PurgeWorkspace.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. ExcludeNestedFolders: true would mark any subfolders that were 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 move folder contents that were configured to be moved.

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