Managing a document structure

A document structure in this context is defined in terms of the document type and referenced attribute definitions. Remember that a document is a collection of revisions which is characterized by a document type. The document type specifies required and optional attributes (also see section Document model).

Methods for managing or customizing document types are provided by the ImaTypeService. The following table presents an overview of the available methods:

Service name

Description

addAttribute

This operation adds a new attribute definition to an existing document type. The new attribute must be optional and may not be a key attribute. If the attribute is a linked attribute, only an existing link on the document type can be used. It is impossible to add a new link to a document type.

addConstraint

This operation adds a new constraint to an existing attribute type or attribute definition. The new constraint will be applied to archived or updated revisions from this point forward. The added constraint does not affect revisions already present in the system.

createAttributeType

This operation creates a new attribute type.

createDocumentType

This operation creates a new document type.

createIndex

This operation creates a new database index on one or more attributes in a document type. The index can include multiple attributes only if they are all single-value attributes represented in the same underlying database table. Indices on multi-value attributes cannot include multiple attributes. An index is deleted automatically if its document type is deleted.

Depending on the capability of the underlying database and the used database edition (Enterprise Editions is needed), the index creation on existing large amounts of metadata does not result in the document type being blocked for a long time because the “online/concurrent” creation option is used. PostgreSQL is not supported to run the index creation in such a way.

deleteAttribute

This operation deletes an attribute definition from its document type.

The attribute to delete may not be a key attribute.

deleteConstraint

This operation removes a constraint from an attribute type or attribute definition.

deleteDocumentType

This operation removes an unused document type (no document or other document type references the type) from the system.

deleteIndex

This operation deletes an index from its document type.

createAttributeType

This operation creates a new attribute type.

listAttributeTypes

This operation returns the list of attribute types currently registered with the system.

listDocumentTypes

This operation returns the list of document types currently registered with the system.

listIndices

This operation returns the list of attribute indices attached to a document type.

updateAttributeBounds

This operation modifies the boundaries (minOccurs and maxOccurs) of an attribute definition. The change is only possible if there is no revision in the system with values that violate the new boundaries.

updateDescription

This operation updates the description of a document type, an attribute type, an attribute definition, a link or an index.

updateName

This operation updates the name of a document type, an attribute type, attribute definition, link or index. The change is made without modifying the ID of the object.

If you use the web services to rename a document type and still want to use the client in the common manner, further renaming actions are required to reach again a consistent state because the client uses a scheme where attribute names contain the document type name as a prefix. All the following manual steps are needed in this case:

  • Rename the document type itself.

  • Rename all attributes to match the new technical name of the document type.

  • Update the document type presentation to match all new technical names (concerning the document type and the attributes).

Similarly, be careful with any kind of renaming of elements (like attributes) in a document structure because other external operations (like adding or removing attributes or constraints) can rely on the initial names that were propagated within the system. There is no automatism that updates roles, document types, retention plans or any other effected configurations. This must be done manually by a system administrator.

updateSearchMode

This operation updates the search mode of a document type. Note that simply changing this setting does not cause automatic re-indexing of the existing data in the document type. Such changes need to be initiated manually through the search service.

Table 349: System management services overview for document structure – ImaTypeService

See the section “ImaTypeService” in the ImageMaster Integration Web Service Reference [WS IS].