CMS_API_READ
Functionality | Description | FileNet Notes | Documentum Notes | Box Notes | M365/SharePoint Notes |
|---|---|---|---|---|---|
IV_CMSPROFILE | Required: Determines which configured CMS Profile in Enterprise 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 Enterprise 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 Link Enterprise 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 create. | 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_ID | Optional: id to use for versioning a document. When specified a new version of the existing id is created with the given content. | GUID
| r_object_id
| id
| Versioning not supported
|
IV_CHECKOUT | Optional: allows you to checkout a document. | Only available in newer versions. | Only available in newer versions. | | Not supported
|
IV_GET_CONTENT | Optional: Indicates whether to pass the content of the document back in table ET_CONTENT_MULTI | | | | |
IV_LOCATION | Optional: (Mandatory for M365/SharePoin to only and not used in any other CMS system) Specified where to read the document from. | Not utilized
| Not utilized
| Not utilized
| This is required and is the Document Library. For documents created by Link Enterprise, this is stored at the time of create in a Link Enterprise table in the scenario that the config changes and thus can be used for subsequent reads. |
IT_METADATA_FILTER | If specified, only metadata properties indicated will be returned. By default of no filter is provided, all metadata for a document is retrieved. | | | | |
ET_METADATA | Contains the metadata retrieved. | | | | |
ET_FILES | Table containing the filename, size, and mime-type of the files retrieved if get content is enabled. | | | | |
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 | | | | |
General FileNet comments:
- For performance considerations it’s best to limit the read to the particular metadata that is necessary for processing and not retrieve all of the available metadata.
- For performance considerations it’s best to limit the read to the particular metadata that is necessary for processing and not retrieve all of the available metadata.
- For performance considerations it’s best to limit the read to the particular metadata that is necessary for processing and not retrieve all of the available metadata.
- Currently VersionSeries isn’t supported with Box since there is currently no unique id that represents all versions of a document.
- FoldersFiledIn only returns the parent folder for a Box document.
Link Enterprise has a test hardness that is located under the API Gateway. You can choose to either:
- Single click on a gateway entry and choose the menu path Execute->Read Again. This will populate values into the test harness from the line you have selected
- Choose the the menu path Execute->Read New. This provide a blank test harness.
To set a break-point to see how this call is executed, the program the test harness uses for READ is:
Program SE38: /DFLOW/ZCMSAPI_READ_01
Below is a sample call:
