Properties

Overview

Each object is configured by a set of individual properties that are specific for the object type it belongs to. These type-specific properties are defined in the Definition section of the corresponding object editor.

Besides these properties all objects have a set of standard properties for the identification and documentation of the object within a project. These standard properties can be viewed and modified in the Properties section of the object editors.

i8  Note: In Desktop for Web, you can also edit the standard properties by right-clicking an object in the Dialog Designer or in the Object Browser, and clicking Properties in the respective context menu.

Properties

The Properties section contains the following information:


Property

Description

Size Limit in Bytes

Object ID

This ID is generated by VoiceObjects and cannot be changed. Please note that the actual object ID is only the part between OVAP and _BVO_. This is important when searching for a specific object ID.

 

Reference ID

Unique ID that can be set to reference the object. By default this ID is the same as the object ID.
When objects are used as parameters for external programs, plug-ins, or scripts, the reference ID can be used to refer to these objects within the external code.
The reference ID can be changed to a custom string that is shorter and easier to understand than the default.
The reference ID of an object must be unique within the project.
8   Caution: Only alphanumeric characters (a-z, A-Z, 0-9) and underscores are allowed. No special characters like blanks, ‘?’, ‘!’, ‘%’, ‘<’, ‘>’ etc., and no characters coming from character sets other than ISO-8859-1 can be used.
Note that the ID is not case-sensitive, so you cannot have two reference IDs in your project that only differ in case.
The reference ID may not be an empty string.

255

Creation date

Time stamp indicating when the object was first created. This is automatically set by VoiceObjects and cannot be changed.

 

Modification date

Time stamp indicating when the object was last modified. This is automatically set by VoiceObjects and cannot be changed.

 

Owner

Name of the user who created the object. This is automatically set by VoiceObjects and cannot be changed.

 

Last modified by

Name of the user who last modified the object. This is automatically set by VoiceObjects and cannot be changed.

 

Short description

Short description for the object. This information shows up as a tool tip in the Dialog Designer and Object Browser when pointing to the object.
The short description should always be entered, providing a quick overview of the object´s functionality. Using descriptions makes it easier to manage projects.

4000

Comment

A comment associated with this object. Can be used to add a temporary note to an object during the development phase. In the Dialog Designer this is indicated by a comment icon  along with a tool tip containing the comment, in case comments are activated in the Display Options.

8000

Keywords

Keywords associated with this object. Can be used to find objects more easily in the Object Search.

4000

Version description

Version-specific information for this object. May be used to document changes made to an object from one version to another.

8000

Error description

Error description for this object. If the object definition is invalid or changes were made to the object definition because of errors in the application, these changes can be documented in this field. This allows the developer to track the history of issue-related changes.

4000

Disable processing

Disables the processing of the object. This is particularly useful during the development and test cycles of a project.
Note that disabling the processing of an object affects every location where it is used in a dialog flow.

 

Lock object

Locks the object, so that users other than the owner of the lock cannot make any changes to it. Users with higher roles may break such locks. For information on how this interacts with locking whole projects or project versions see Chapter 3 – Repository Browser in the Desktop for Eclipse Guide or Chapter 2 – Working with Projects in the Desktop for Web Guide, respectively.

 

i8    Note: In case of the fields Short description, Comment, Keywords, Version description, and Error description using UTF-8 characters is allowed, but may reduce the given size limit, as some characters use more than one byte.

i8    Note: When using MaxDB as the Metadata Repository DBMS the following limits apply to the size of the standard properties described above:

Reference ID: 255 bytes; Short description: 500 bytes; Comment: 500 bytes; Keywords: 255 bytes; Version description: 500 bytes; Error description: 255 bytes.