---
title: CMS_API_UPDATE
slug: docuflow-guides/cmsapiupdate
docTags:
createdAt: 2020-03-10T21:15:24.000Z
---
| **Functionality **
**** | **Description **
| **FileNet Notes ** | **Documentum Notes ** | **Box Notes ** | **O365/SharePoint Notes ** |
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| IV\_CMSPROFILE
| Required: Determines which configured CMS Profile in docuflow SAP to utilize. Combination of CMS Profile and CMS Tag determine the API destination and thus load across an RFC destination. | | | | |
| IV\_CMSTAG | Required: Determine which configured CMS Profile in docuflow SAP to utilize. Combination of CMS Profile and CMS Tag determine the API destination and thus load across an RFC destination. | | | | |
| IV\_REPOSITORY | Required: Determines which configured repository in docuflow SAP to utilize | Object Store
| Docbase
| Default is the only Store/Repository supported since Box currently doesn’t support the notion of different repositories. | Site, site collection
|
| IV\_TYPE
| Optional: what CMS type to update. | DOCUMENT CLASS
| OBJECT TYPE
| METADATA TEMPLATE
| CONTENT TYPE
|
| IV\_USE\_MAPPING
| Optional: use mapping of IV\_TYPE to CMS type in Enterprise Connector if CMS. Used if ArchiveLink doctype name to CMS type mapping is required. | | | | |
| IV\_CHECKOUT | Optional: allows you to checkout a document. | Only available in newer versions.
| Only available in newer versions.
| | Not supported
|
| IV\_CANCEL\_CHECKOUT | Optional: allows you to cancel the checkout of a document. This will return an error if the document is already checked out. | | | | |
| IV\_LOCATION | Optional: (Mandatory for O365/SharePoint only and not used in any other CMS system) Specifies where to document to update resides. | Not utilized.
| Not utilized.
| Not utilized.
| This is required and is the Document Library. For documents originally created by docuflow, this is stored at the time of create in a docuflow table in the scenario that the config changes and thus can be used for subsequent updates. |
| IV\_FOLDER\_METADATA | Optional: If suppored by your CMS, setting this flag to true will apply metadata at the folder level. The ID's located in the IT\_IDS table will be folder IDs. | | | Applied metadata at the top level folder only | Applied metadata at all levels of folders |
| | | | | | |
| | | | | | |
| | | | | | |
| IT\_IDS | Table of file ID's (or folders ID's if supported by your CMS) | | | | |
| IT\_METADATA | Mandatory: metadata to set during updates. Some metadata cannot be set during update and is only read only (some system properties). Updating some system properties in certain repositories may lead to unkown results. The docuflow username and timestamp properties are automatically set as metadata during update if they are configured on the particular CMS tab in the docuflow Enterprise Connector. When the same keys are used multi valued properties are set with all of the specified values. The ZMULTI flag is ignored during an update since the same key signifies a multi valued property by default. | To assist with the date format for FileNet, you may choose to utilize the DocuFlow helper method ‘/dflow/cl\_utilities\_helper=>format\_date’ to format a system date field to the format desired
| To assist with the date format for Documentum, you may choose to utilize the DocuFlow helper method ‘/dflow/cl\_utilities\_helper=>format\_date’ to format a system date field to the format desired
| Currently doesn’t support multi valued metadata. Where a date field is part of the metadata being sent, the format must be MM/dd/yyyy hh\:mm\:ss a z, where a z = the AM/PM and TIMEZONE example: 12/31/9999 12:00:00 PM MST T o assist with the date format for Box, you may choose to utilize the DocuFlow helper method ‘/dflow/cl\_utilities\_helper=> format\_date\_plus\_sys\_timezone’ to format a system date field to the format desired and also appending the system timezone
| Supports multi valued metadata for Lookup, Choices and multi line of text.
|
| ET\_RETURN
| Table that indicates a success of an error. The TYPE field will contain an ‘S’ or ‘E’ respectively and the MESSAGE field will contain information in the case of an error. | | | | |
| CT\_CUSTOM | Future use | | | | |