Document types classify the documents that belong to a
case. Document types provide order to the many kinds of documents
that can occur in a case. You can configure a case to start when a
document of a specified document type is filed into the IBM® BPM
content store.
You can also set a precondition on an activity to start the activity
when a document of a specified document type is filed in the IBM BPM
content store
About this task
Case management functions
are only available if you have IBM BPM Advanced with the Basic Case
Management feature installed.
You create a document type from the Cases category
in the library.
Procedure
- Select Cases from the library. Click +. In the Cases menu, select Document Type.
- In the New Document Type dialog, enter
a name for the document type.
For example, if you were creating a document type for the Credit
Card Dispute Resolution application, you might enter SupportingCustomerDocumentation.
- Click Finish. The Document Type
editor opens for your document type.
- Enter the properties for the document type. The properties
provide the structure for your document type. These properties become
fields at run time when a business user enters information in them. You can use the following attributes:
- List: the property is a list (or array).
- Hidden: the business user cannot see the
property in Process Portal, but it is visible in the IBM BPM
content store.
- Required: the property must be completed
by the business user. The property is marked as required in Process
Portal, and the user cannot proceed without entering a value for it.
Restriction: A document property can
reference only a custom simple type business object. It cannot reference
a complex type business object or one of the simple types, such as
a String, directly. Also, it cannot reference a custom simple
type business object that has a base type of Selection.
For example, SupportingCustomerDocumentation might have a property for the customer's credit card number with
a required attribute. If all vendors were available in a list, another
property might be the name of the vendor that sold the goods to the
customer with a list attribute. Finally, there might be a property
for a system where the document is stored with a hidden attribute.
- Document properties also have display and symbolic names.
The Display name field shows a generated name
that is based on the property type. This name appears in Process Portal
and on the case folder in the IBM BPM
content store.
The Symbolic name field shows a generated
name that is based on the property type. The symbolic name is a unique
identifier for the property within the IBM BPM
content store.
You can use this name for Content Management Interoperability Services
(CMIS).
What to do next
To rename or delete a document type, select
it in the Document Type list and either right-click
or click the arrow to its right.
As time progresses,
you might update the properties of your document type. If you remove
properties from your document type, the removed properties still appear
in Process Portal. The removed properties remain active until they are deleted from
the embedded content store by using the cleanupDocumentStoreProperties command.