dms.XMLMove

This job moves an object. A cabinet or document can be moved. The parent attributes (registerid, registertype and folderid) are the attributes that identify the new location.

In particular, the folderid should also be specified even when the new location of the object is a cabinet.

When moving a cabinet, it is moved together with its subobjects to the new location. Furthermore, for reference documents, the location must be specified as the 'sourceparent_id' attribute in the Object tag.

Documents can be moved to the user tray. For this, no location specifications in the object element of the XML are required, but the option WFTOUSERTRAY must be activated. The document to be moved must have been in the workflow tray beforehand, documents from folders and cabinets cannot be moved to the user tray.

Documents can be moved from the user tray or workflow tray. These documents can then be moved to a cabinet or folder. The job automatically detects whether the object is in a cabinet, folder, workflow tray or user tray.

1. Input Parameters

Name Type Required Description

Name	Type	Required	Description
`Flags`	INT	Yes	general options for the job (see Flags)
`Options`	STRING	Yes	semicolon-separated job options (e.g. ARCHIVABLE=1;CHECKACCESS=0) (see Parameter Options)
`XML`	BASE64	Yes	contains object description in XML format (see DMSData XML Format and the parameter XML)
`JobUserGUID`	STRING	Yes	determines the user context (see the parameter JobUserGUID)

Flags

INT

Yes

general options for the job (see Flags)

Options

STRING

Yes

semicolon-separated job options (e.g. ARCHIVABLE=1;CHECKACCESS=0) (see Parameter Options)

XML

BASE64

Yes

contains object description in XML format (see DMSData XML Format and the parameter XML)

JobUserGUID

STRING

Yes

determines the user context (see the parameter JobUserGUID)

2. 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.

If important attributes such as e.g. id are not needed, they should either be omitted entirely, set to '0' or '-1', depending on functionality.

XML for moving a cabinet

<?xml version="1.0" encoding="UTF-8"?>
<DMSData>
  <Archive id="-1" internal_name="press_archive">
    <ObjectType type="REGISTER" internal_name="file_register" id="-1">
      <Object object_id="28" folder_id="58" register_id="-1" register_type="-1"/>
    </ObjectType>
  </Archive>
</DMSData>

XML for moving a document

<?xml version="1.0" encoding="UTF-8"?>
<DMSData>
  <Archive id="-1" internal_name="press_archive">
    <ObjectType type="DOCUMENT" internal_name="word_documents" maintype="4" cotype="0" id="-1">
      <Object object_id="248" register_id="228" register_type="6488064" folder_id="58"/>
    </ObjectType>
  </Archive>
</DMSData>