Properties of Object Types

yuuvis® RAD designer 10.x »

As a component of the project schema, object types are the basis on which users in yuuvis® RAD client create business objects. Business objects can be folders and documents.

Object types are populated with properties that make up the content of the business object. Some properties can no longer be changed being created.

To edit the properties of an object type, show the Projects and Properties areas via the View ribbon tab and select Open from the project section of the context menu of the object type you require.

Object types can be populated with the following properties:

Type

ID

Serves to clearly identify the objects in the system. Created automatically and cannot be changed.
Technical name Unique name used in scripts. The technical name must start with a letter and may only contain letters, numbers, and underscores. It may not start with the string 'sys' and cannot be 'no'. You will need to modify the scripts accordingly if you change the technical name. The technical name is not shown on the yuuvis® RAD client user interface.
Data type The assigned data type cannot be changed.
Aliases

Aliases can be assigned to reference the object type in scripts (e.g., for data transfer) via this alias instead of the technical name.

You can specify several aliases with the same rights. Aliases for object types must be unique across the system.

Aliases contain the namespace and name, separated by a period. The use of special characters in aliases is governed by the following rules:

  • The characters "_" and ":" may be used in names.
  • The characters "_" and ":" may not be used in namespaces.
  • No other special characters may be used in either case.

Aliases with assignments for default metadata are deployed for automatic data transfers in yuuvis® RAD via yuuvis® RAD extraction-service.

Parent types

Abstract object types from which the current type is derived. Multiple abstract object types can be specified.

The forms may need to be checked if changes are made.

Subsystem

Subsystem in whose namespace the current object type was created. This cannot be changed.
Abstract type

Enabled: Indicates whether the current object type is an abstract object type. Abstract object types are templates for other object types, that is, other object types can be derived from abstract object types, retaining the fields of the abstract type. No business objects can be created from abstract object types.

The property cannot be changed.

Additional information

Additional information regarding the type (w/ name and value). The type system ignores this property.
Resources
Properties in this section are localizable. You can add translations for all supported languages using the ... button at the end of the row or the Localization view area.
Display name This is shown on the yuuvis® RAD client interface.
Description Only shown here in yuuvis® RAD designer.
Title format

The title of a business object is shown in yuuvis® RAD client in the header of the object view, in folder list elements, and in lists of different types. The content of the title can be formatted as a template with variables. Templates are evaluated according to the Java format classes. The metadata of the business object is available as variables.

If you enter an opening curly bracket in the title field, a drop-down list of available values opens. The title length can be limited by specifying the maximum field length in square brackets. Date and time are issued by default for calendar data. The date format (e.g., date for 'date only') can also be entered in the field name, separated with a comma. Make sure that the relevant metadata for the fields used is also set in the business object. All other entries are noted as constants.

Sample notation 1:

Rechnung {rechnungsnummer[5]} vom {datum,date}

Return value in title:

Invoice 12345 from 1/6/2015

Sample notation 2:

{counter:technischernamezaehler,number,#}

Return value in title:

Counter reading without thousands separator

Sample notation 3:

{invoiceType}{invoiceCount,choice,0#|0<'{1,number,#}'}

Examples:

  • invoiceType = 'supplier invoice', invoiceCount = '0'

    Return value in title: supplier invoice 

  • invoiceType = 'supplier invoice' invoiceCount = '12345'

    Return value in title: supplier invoice12345

This title formatting outputs a space for the 'invoiceCount' number field if the value is 0, otherwise, it outputs the indicated value. In the {1,number,#} section, the field name cannot be used ({invoiceCount,number,#}). Instead, the item number within the title format must be used. 'invoiceType' has the item number 0 and 'invoiceCount' has the item number 1.

The choice keyword is also part of the Java format classes.

You can consult the documentation for the sub-class 'MessageFormat' for more information on how templates (e.g., nesting) are evaluated.

Decimal numbers are either "," (de) or "." (en), depending on the language setting in yuuvis® RAD client. This may appear different than it does in forms.

The date, time, and numbers can also be formatted.

Description format The description is shown in a mixed hit list in addition to the title. The description can be formatted. Formatting is performed in the same way as described under 'title formatting'.
Icon Icon for marking the object type in yuuvis® RAD client. The ... button at the end of the field opens a selection dialog so you can assign an icon to the object type.
Behavior
Metadata version control

Enabled: Old versions of the metadata are saved.
Disabled: The metadata of all earlier versions is overwritten with the new metadata.

Allow sharing

This determines whether users can share objects of this type with other users. Sharing grants the Read object type right for the object. Users must have the Share object type right. The object type requires the Allow sharing property.

For folders, the user can use the Include documents option to additionally assign the Read object type right to all documents in the folder, even if the sharer does not have this right. Without this option the recipient will see only the folder without content.

Recipients require the Display object type right in order to access shared objects. Object type rights with conditions are also evaluated for the recipient. If a recipient has the Display and Edit object type rights, then they can also edit shared objects.

Content
File

This defines whether a document type can or must contain a document file:

  • Without: Document type does not contain any document file (minimum 0, maximum 0 files).
  • Optional: Document type can contain zero or one document file (minimum 0, maximum 1 file).
  • Mandatory: Document type must contain one document file (minimum 1, maximum 1 file)
Index file for full-text search Enabled: A full-text index is automatically included for all files of this object type during creation.
Initial rendition formats

This defines which format the document files will be converted into for display functions. Conversion then takes place automatically when files are created. PDF is the format for displaying in the content preview.

Select Text conversion for object types with 'hidden text'.

Rendition formats are saved in the rendition cache.

Database

Persistence name

The persistence name ensures unique and permanent identification in the database. The persistence name must not be changed after activation. Unauthorized changes, e.g., those resulting from deleting or creating data, can lead to inconsistencies in the database. The persistence name is limited to a maximum of nine letters in lowercase and cannot contain spaces or special characters.