Public Attributes (ttadv7114m000)

Use this session to define the public attributes of a business object.

Public attributes are used for the following purposes:

  • As arguments in public methods.
  • As entry points for external applications to the data of the business object.
Note

You cannot map public attributes directly to table fields or to form fields. In stead, they must be mapped to protected attributes that, in turn, are mapped to table fields or form fields. The protected attributes may belong to the same business object/component as the public attributes or to a related business object/component.

If the protected attributes belong to a related business object/component, the specific business object/component relationship details must be specified.

Prerequisites

Before you can run the current session, you must have defined protected attributes.

 

Attribute

The name of the attribute.

The following rules apply to the attribute name:

  • The name must be unique within the business object.
  • The name must refer to business concepts and/or the functionality of the business object. Do not use a name that refers to a technical solution.
  • Use standardized business terminology, for example, OAGIS.
  • The name must be meaningful.
  • Only alphanumeric characters ([A-Z], [a-z], [0-9]) are allowed.
  • Spaces are not allowed.
  • If the name consists of one word, start it with a lowercase character.
  • If the name consists of several words, start each word, including the first word, with a capital.

Example: customer, OrderedQuantity.

Domain

The domain of the attribute.

Domains are defined in the Domains (ttadv4500m000) session.

Data Type

The Data Type of the attribute's domain, e.g. String, Long or Double.

Map Operator

The Map operator for the attribute.

Note

If the map operator is Protected Attribute, you can specify only one attribute. If the map operator is Calculate, you can specify several attributes.

Origin BO

The package code of the business object of the linked protected attribute.

Origin BO

The module code of the business object of the linked protected attribute.

Origin BO

The three-digit identifying code of the business object of the linked protected attribute.

Origin Component

The component of the linked protected attribute.

If the business object of the linked protected attribute has no components, this field is empty.

Mapping

The protected attribute that is linked to the public attribute specified in the Attribute field.

BO Relation

This field is only available if you map a public attribute to a protected attribute from a related business object. You must enter the position number of a business object relationship detail line, which specifies the exact relationship between the two business objects. You can zoom to the Relationship Details (ttadv7119m000) session.

Default domain

If you selected Protected Attribute in the Map Operator field, the default domain is that of the selected protected attribute. If you selected Calculate or Not Applicable, this field is empty and you must specify a domain manually.

Override default domain

If this check box is selected, you must manually specify a domain for the attribute. You must enter this domain in the next fields.

Note

If you selected Protected Attribute in the Map Operator field, the default domain is that of the selected protected attribute. If you selected Calculate or Not Applicable, you must always specify a domain manually.

Domain

The package code of the domain.

Domain

The identification code of the domain.

Data Type

The Data Type of the attribute's domain, e.g. String, Long or Double.

Use as XML Element

If this check box is selected, the content of this attribute will be read and interpreted as XML content. As a result, if you clear this check box, the content is not interpreted as XML content. This option allows you to communicate XML content while preventing that it is automatically processed.

This check box is only available if the Data Type of the domain of the attribute is long.

Read-only

If this check box is selected, the value of this attribute is controlled by LN, and you cannot change the value directly.

An attribute can be read-only for various reasons:

  • The attribute has a calculated value.
  • External applications are only allowed to read the value, and not to change it.
  • The protected attribute linked to the public attribute belongs to a related business object or component.
Note

Read-only attributes that are not identifying can only be used as output arguments, that is, as arguments that deliver output.

Identifier

If this check box is selected, the attribute is part of the identification of the business object.

Mandatory

If this check box is selected, the attribute must always have a value.

An attribute can be mandatory for various reasons:

  • Attributes must be mandatory if they are mandatory input for the standard method Create.
  • If the public attribute is linked to a protected attribute that is mandatory, the public attribute must also be mandatory.

Note that it is recommended to make a public attribute not mandatory if it is linked to a protected attribute that is not mandatory.

Default available

If this check box is selected, the attribute has a default value.

 

Generate Public Attributes

Click to generate all possible public attributes based on the available protected attributes.

The map operator of the generated public attributes will be Protected Attribute.