Open topic with navigation
The ImportBulkArtifactJob class provides the functionality for adding a large number of Artifact objects to a Workspace. It includes a Settings property for setting import parameters, as well as an Execute() method for loading data and retrieving messages from the OnMessage event.
This page contains the following information:
The Import API performs field mapping during the first stage of execution for an import job that uses the ImportBulkArtifactJob class. After the Execute() method is called on the ImportBulkArtifactJob instance, the OnMessage event is raised multiple times, and passes Status objects that each have a Message property. This Message property contains information about the progress of the Import job, including these actions taken before the execution begins:
Field mapping occurs after the OnMessage event passes the following execution message: [Timestamp: DATE_TIME] [Record Info: X] message. The next OnMessage event passes the detailed information about the mapping process in the Message property. The content of this Message is a single string that includes the following information:
After field mapping completes, the OnMessage events pass the messages Progress Info and Record Info.
You can map instances of single- or multiple-object fields by name or ArtifactID. When multiple instances of an object share the same name, you can uniquely identify them by mapping them with their ArtifactIDs. For example, you can assign unique ArtifactIDs to custodians who have the same name.
To map a field, assign the ArtifactID for the field to the Settings.ObjectFieldIdListContainsArtifactId property of a ImportBulkArtifactJob instance. A document is flagged with an error when an instance of a single- or multiple-object field is linked to an ArtifactID that doesn't exist in the workspace. This document is not imported into the workspace.