CMS_API_CREATE

functionality description filenet notes documentum notes box notes m365/sharepoint notes iv cmsprofile required determines which configured cms profile in link 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 defaults to the “document” document class if unspecified object type defaults to the “dm document” class if unspecified metadata template defaults to creating a document with no metadata template if not specified content type defaults to creating a document of content type document if not specified 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 filename optional the filename of the content being added to the cms if omitted some systems allow for a contentless document to be added used for the “content element” as well as the “documenttitle” unless “documenttitle” is set in the metadata which will override this may be empty for a contentless document used as the “object name “as well as the “title” metadata property unless title is set in the metadata which will override this if the filename is empty then the “title” is set to the “object id ” may be empty for a contentless document used as the “name” metadata property unless “name” is set in the metadata which will override this box requires that a filename and subsequent content be passed in since currently there is no support for a contentless document used as the “linkfilename” metadata property iv checkin as min optional performs the check in as a minor version not supported not supported iv checkout optional allows you to checkout a document prior to creating a new version of the document only available with new versions only available with new versions checks out the document prior to creation and cancels the checkout after the creation has occurred to help guarantee no other person or process modifies the document while the creation call is happening not supported iv find curfrom id optional allows you to find the latest version from the given id (since the id might not be the latest version of the document) not supported since currently box ids are the same for every version not supported since currently sharepoint ids are the same for every version iv location optional (mandatory for m365/sharepoint) allows you to specify where to add the document in the content management system if unspecified documents are left unfiled if unspecified documents are stored in root of the users cabinet a number for the exact folder location can be specified if unspecified documents are stored in the configured root relative folder names can be used with a / being the root if a root folder is configured for the box cms in the enterprise connector all relative folder locations will be relative to the root folder configured relative folder names are not recommended for performance reasons this is required and is the document library it folder metadata optional metadata will be applied at the folder level instead of the file level not supported not supported applies metadata at the top level folder only applies metadata at the top level folder only iv folder nested optional set to x if the use of ct custom you choose to use nested folders not supported not supported x = nested folders not supported it metadata optional metadata to set during creation some metadata cannot be set during creation and is only read only (some system properties) updating some system properties in certain repositories may lead to unknown results the link enterprise username and timestamp properties are automatically set as metadata during creation if they are configured on the particular cms tab in the link 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 a create 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 link enterprise 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 link enterprise 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 link enterprise 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 currently doesn’t support multi valued metadata it content optional if cms supports folder creation and 1 or more folder are specified ev returnid the id of the document added to the cms 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 when you use the it custom folder to create folders, the return table will also pass back the folder id's created the parent folder is indicated by a ! exclamation point, all sub folders are indicated by a tild example of return table when folders are created !sap 4500017723,147811962292 sap subfolder1,938382828 sap subfolder2,938382829 sap subfolder3,938382830 refer to the below examples for more return table samples ct custom optional if supported by your cms repository, the list of folder(s) to create this requires the badi /dflow/docmanger storeandlink to be implemented you have two choices 1 flat folder structure 2 nested folder structure for nested, you must set the flag iv folder nested the first line is the parent folder, lines 2 and above are subfolders (optional) by default, link enterprise places the content (when applicable) in the first folder/first line (when flat) or top level folder (when nested) you can override this by placing a tild preceding the folder name example 1 sap po header 4500012349 sap po line 00010 sap po line 00020 (content will be placed in first/top folder by default) example 2 sap po header 4500012349 sap po line 00010 sap po line 00020 (content will be placed in last/lowest sub folder) note the flag cs zdmc01 zownfolder must be set for fodlers to be created this can be et either in the docmanager rule or directly via the badi not supported general box comments it is recommended to configure the “error on duplicate” in the link enterprise connector since automatically versioning of documents with the same name can produce unpredictable results locations can be specified either using the exact folder number or via a relative path with / being the root if the location is specified via a relative path the folder names can take upwards of 1 2 minutes before a create using a relative path in the location field will find it general cleanup utilities are present in box so that if an error happens when creating a document the document is attempted to be permanently deleted if permissions allow it otherwise subsequent cleanup may be required for failed documents for instance if setting the metadata fails but creation of the document succeeds they are handled via separate calls to box so grouping them into a single transaction that can be rolled back is not possible by default (for performance reasons), link comes with the updating of box system properties (referred to as basic metadata) turned off this affects both the create and update api's if you want to update basic metadata (note the any metadata templates and properties you create on your own are considered custom metadata, of which is always enabled), you will need to change the config properties property box basicmetadataupdate=yes refer to the section "adjusting box rate limit and basic metadata" in the base installation and configuration guide for more detail example below is an example call from storing a document via services for object place a breakpoint at metadata passed custom table passed in this example, we instructed link enterprise to create a 1 level subfolder this is done by filling the custom table with the folder name return table received note in this return table, we see that we also have link enterprise configured to create a folder when this occurs, the '!' indicates the folder name and the second value is the folder id