dms.XMLCopy
This job copies objects, folders, cabinets and documents can be copied. When copying cabinets or folders, the option COPYCASCADING can be used to determine whether all contained objects should be copied cascading.
When copying a document, it can be copied as a new document or a reference to the original document can be created at the new location. The document will then have two locations, but only one index data record will exist. To link the document in this way, the job option LINKDOCUMENT must be specified. For such a reference copy, the source and target location must differ. This option also applies to all documents copied using the option COPYCASCADING.
The parent attributes (registerid, registertype and folderid) are the attributes that identify the new location. The folderid should also be specified even when the new location of the object is a cabinet. The registertype can be determined by the executor, but for performance reasons it should always be specified.
1. Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
|
INT |
Yes |
general options for the job (see Flags) |
|
STRING |
Yes |
semicolon-separated job options (e.g. LINKDOCUMENT=1;CHECKACCESS=0) (see Parameter Options) |
|
BASE64 |
Yes |
contains object description in XML format (see DMSData XML Format and the parameter XML) |
|
STRING |
Yes |
determines the user context (see the parameter JobUserGUID) |
3. Return Value
(INT): 0 = Job successful, otherwise error code
Complete list of error codes
No job-specific return values.
| The following XML examples always contain all tags and tag attributes that can be used for the respective action. Unused tags or attributes can naturally be omitted. |
<?xml version="1.0" encoding="UTF-8"?>
<DMSData>
<Archive id="-1" internal_name="press_archive">
<ObjectType type="DOCUMENT" internal_name="word_documents" id="-1">
<Object object_id="28" folder_id="58" register_id="-1" register_type="-1"/>
</ObjectType>
</Archive>
</DMSData>