The IBM_BPM_Document document type
In the IBM BPM document store, IBM BPM documents are represented by instances of the predefined document type IBM_BPM_Document.
The properties for the document type IBM_BPM_Document are shown
in the following table:
| Property | Type | Description | Value |
|---|---|---|---|
| IBM_BPM_Document_DocumentId | Integer | The numeric document identifier in IBM Business Process Manager. | The identifier is automatically calculated and cannot be overwritten. |
| IBM_BPM_Document_ParentDocumentId | Integer | The numeric document identifier of the parent document in IBM BPM. | The identifier is automatically calculated and cannot be overwritten. |
| IBM_BPM_Document_FileType | String | Indicates whether the document content contains "FILE" or references "URL". | Optional. If a value is not set, the value "FILE" is used. |
| IBM_BPM_Document_FileNameURL | String | The file name of the original document or URL. It is recommended that this property is set. | Optional. |
| IBM_BPM_Document_HideInPortal | Boolean | Indicates whether the document should be hidden from Process Portal. | Optional. If a value is not set, the document is shown in Process Portal. |
| IBM_BPM_Document_ProcessInstanceId | Integer | The process instance identifier. If this property is set, the document is associated to the lifecycle of the process instance. The document content can only be viewed by those users who have authority to view the process instance. | Optional. If a value is not set, the document is associated to an instance (if the document creation is performed in the context of that process instance). The value can only be set on document creation. |
| IBM_BPM_Document_Properties | String[] | The additional properties of the document. The key and value should be separated by the comma (,) character. | Optional. |
| IBM_BPM_Document_UserId | Integer | The creator or last modifier of the document. | Optional. If a value is not set, the user ID of the caller is used. The caller can be the human service user (or the engine user when a human service is not used). |