Some WorldServer objects can have custom attributes for which users can specify values. They are shown in various search screens. You can use attribute filters when you search or export TM or TD, as well as in the Translation Workbench. For more information, see the appropriate Online Help pages.
To create an attribute using the desc.xml file, use this template:
<attribute name="attribute name" ui_name="ui name" object_type="object_type" flags="flags" type="attribute type">
<option value="option1"/>
<option value="option2"/>
</attribute>
When you add a custom attribute, specify:
| Property | Description |
|---|
| name | Name of the attribute to be used in the API to retrieve the attribute from the object |
| ui_name | The user-friendly description or name of the attribute to be shown to the user wherever a user interface is available for attribute editing or presentation |
| object_type | The type of WorldServer object for which you are creating the custom attribute. The allowed values are:
- vendor
- project
- task
- user
- tmtranslation (TM entries)
- tdentry
- tdterm
- workflowrole
- workflowgroup
- tmgroup (covers TM and TM groups)
- tdgroup (covers TD and TD groups)
- workflow
- issue
- costmodel
|
| flags | Optional flags:
- is_hidden:The attribute is never shown in the UI; only the API can access the attribute
- is_readonly: The attribute cannot be changed in the UI; only the API can change the attribute
- is_required: A value must be assigned to the attribute
- is_included_in_translation_kit: The attribute will be included in translation kits created by WorldServer
|
| type | The type of data allowed for the attribute:
- boolean:
TRUE or FALSE
- date: A date
- integer: Any positive integer
- selector: A set of predefined values
- text_area: Text in a larger area
- text: Text in a field (select this for TM Attributes)
- user: A WorldServer User
- attachment: Value specifies the location of a file and is rendered as link
- multi_selector: Allows users to specify multiple values from a set of predefined values
- image: A specialized variation on the Attachment attribute type that is rendered in the UI as an image
- comment: A special type of text area that maintains a history of added text
- url: A sub-type of the text attribute type that is rendered as a link
- html: A variation of the large_text_area attribute type that enables advanced users to type in freeform HTML that WorldServer renders directly as HTML
- large_text_area: A variation of the text_area attribute type that enables users to store an unlimited amount of text data
- list: An arbitrary collection of one or more text items
For more information on the usage of these attribute types, refer to the WorldServer User Guide. |
| option value | Predefined value for the selector type attribute |
You can define multiple attributes by adding multiple entries to the desc.xml file. Note that all entries must be added within the <components> tags of the desc.xml file.