Working with the IBM_BPM_Document_Properties property

Working with documents through the Content Integration node usually requires the manipulation of document properties.

About this task

When you are working with IBM BPM documents, you can use the document property IBM_BPM_Document_Properties to specify properties that are not defined in the document type IBM_BPM_Document. The IBM_BPM_Document_Properties property is defined as a string property that carries a name-value pair, each of which represents an extra property of the document.

Information about the document type IBM_BPM_Document and all of its available properties is found in the topic "The IBM_BPM_Document document type."

Information about working with the document property IBM_BPM_Document_Properties is found in the following topics:

  • Writing to the IBM_BPM_Document_Properties property
    Properties can be written into a document when it is created or updated. In both cases, you can optionally provide the operation with a list of ECMProperty objects.
  • Reading from the IBM_BPM_Document_Properties property
    The get document operation returns an ECMDocument object. This object contains the properties that are associated with the document.
  • Updating the IBM_BPM_Document_Properties property
    In an update scenario, only the properties that are passed into the check-in operation are updated in the document. IBM BPM document properties are stored in the single CMIS property object IBM_BPM_Document_Properties. When a value is passed to the property object, the existing value for the property is overwritten. Be careful to ensure that when updating the property, only the intended updates are sent to the server.
  • Specifying search criteria for the IBM_BPM_Document_Properties property
    After the "Document List" Coach View is configured to work with BPM documents, it automatically generates the CMIS query to pass to the search service. The query includes any required search conditions from the IBM BPM document options that are specified for the view. However, if you intend to write your own CMIS query, or configure the Content Integration node for a search operation, then you must manually specify the format of the search condition.
Parent topic: Working with IBM BPM documents
Related information:
The IBM_BPM_Document document type