Representation (naming parameters)
To modify the naming parameters
-
Adjust the Display Name, Document Identifier Pattern and Description.
See table Document types – naming parameters for the field descriptions.
Mandatory input fields on this web page are marked with an asterisk (*).
Optionally, localize the display name or description in the available languages (see chapter Localization).
-
Click Save to complete your changes.
Parameter |
Mandatory |
Description |
---|---|---|
Identifier |
Yes |
The technical document type name, i.e. an identifier that must be unique This identifier can be changed since a document type is internally still associated with a unique, fix ID that is generated at creation time. This identifier is the same as the document type name that can be updated via the web service operation “updateName”. 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:
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. |
Display Name |
Yes, for the default language |
The display name of the document type, initially equal to the identifier The name can be specified in several languages by using the link Localize. |
No |
A pattern to define an explicit document title, which overrides the default behavior By default the document title is generated from the localized document type name and from the values of such attributes that have been set as Part of Document Identifier. This default behavior can be overridden here, by specifying a pattern based on placeholders and hard-coded separators. The following placeholders are supported. These must be specified in square brackets, each one starting with a dollar sign
Example: Assume that the current language is English and that the pattern for the document type “offer” is set to the following: $[offer] - $[offer.number] When displaying a document, the document title could result in something like this: Proposal - 0815(Hardware) In this example, it is assumed that the document type with the identifier “offer” has the display name “Proposal”. The document identifier can be used as a placeholder in the print label configuration. A document identifier can appear in several locations in the WorkplaceClient. For example, after selecting a document in the hit list, a document identifier is displayed in the top area (above the hit list). After having opened a document in the view “Documents”, this identifier is also used in the list of opened documents. In a full-text search, the document identifier is used as the title of a search result. |
|
Short Document Identifier Pattern |
No |
A pattern to define a document title when displaying the document in the browser tab, which overrides the default behavior. The functionality is the same as for the Document Identifier Pattern. The present identifier is used only as a browser tab name in case of document printing. If several documents are printed, the short document identifier of the first selected in the list document is used. In case no Short Document Identifier Pattern is specified, the Document Identifier Pattern will be used in browser tab name when printing the document. |
Description |
Yes, for the default language |
A short description of the document type, initially equal to the identifier Description is displayed as a tooltip within the document type selection list when a document type is chosen. The description can be specified in several languages by using the link Localize. |