The next table presents the properties of a structure attribute.

Property

Description

Optionality

Default value

Obs.

Name

Internal name that identifies the attribute.

Mandatory

 

See rules for naming elements.

Description

Free text that describes the attribute. You can edit the text by directly typing it in the property or in the description editor which opens by clicking

Optional

 

Useful for documentation purposes.

The maximum size of this property is 2000 characters.

Label

Text used when the attribute is displayed in a Record Widget.

Optional

<Attribute Name>

 

Data Type

List of all the types supported by Service Studio except the Object type. In this list you'll also find the Identifiers of all the entities of the Space.

Mandatory

Text

Learn more about types of structure attributes

Length

Size of the attribute.

Optional

 

Mandatory for Text and Decimal types. In the Decimal types, this property includes the decimal part.

If the values for these types are not specified, default values are used.

The other types have a fixed length.

Decimals

Number of decimal places.

Optional

 

Mandatory only when the type is Decimal.

Is Mandatory

Boolean value that indicates whether the attribute is mandatory. If true, Platform Server validates, at run-time, if this attribute is filled-in. If false, when the attribute is not filled-in, the default empty values (spaces, 0, … ) are accepted.

Mandatory

No

 

Default Value

Default value of the attribute displayed if the attribute does not have a value introduced by the end-user.

Optional

 

The default value can be a literal or one of the following built-in functions:

NullDate(), NullIdentifier(), NullObject(), NullTextIdentifier(), CurrDate(), CurrTime(), CurrDateTime() or NewLine().

Advanced - The following properties are only visible for structures of consumed Web Services.

REST API - Properties for structures of consumed REST APIs.

Original Name

The name of the attribute.

N/A

 

Read-only.

Default Value

Default value of the attribute displayed if the attribute does not have a value introduced by the end-user.

Optional

 

The default value can be a literal or one of the following built-in functions:

NullDate(), NullIdentifier(), NullObject(), NullTextIdentifier(), CurrDate(), CurrTime(), CurrDateTime() or NewLine().

Send Default Value

Indicates whether the attribute is sent in the request payload when the attribute is holding its default value.

Definition of the Attribute in the REST API

Available Options

Mandatory

Yes: the default value is sent.

Optional

Yes: the default value is sent.

No: no value is sent.

N/A

 

 

SOAP - Properties for structures of consumed SOAP Web Services.

Original Name

The name of the attribute.

N/A

 

Read-only.

Default Value

Default value of the attribute displayed if the attribute does not have a value introduced by the end-user.

Optional

 

The default value can be a literal or one of the following built-in functions:

NullDate(), NullIdentifier(), NullObject(), NullTextIdentifier(), CurrDate(), CurrTime(), CurrDateTime() or NewLine().

Send Default Value

Indicates the value that is sent in the request payload when the attribute is holding its default value.

WSDL Definition of the Attribute

Available Options

Mandatory

Not Null

(Min.Occurences=1

Nillable='No')

Yes: the default value is sent.

See an example

Mandatory

Null Allowed

(Min.Occurences=1

Nillable='Yes')

Yes: the default value is sent.

No: the 'nil' value is sent instead of the default value.

See an example

Optional

Not Null

(Min.Occurences=0

Nillable='No')

Yes: the default value is sent.

No: no value is sent.

See an example

Optional

Null Allowed

(Min.Occurences=0

Nillable='Yes')

Yes: the default value is sent.

No: no value is sent.

Send 'nil': the 'nil' value is sent instead of the default value.

See an example

N/A

 

 

Original Description

The description of the attribute.

N/A

 

Read-only.

Original Default Value

The default value of the attribute as defined in the WSDL.

N/A

 

Read-only.

Min. Occurrences

The minimum number of occurrences of the attribute.

N/A

 

When set to 0 (zero) the attribute is optional.

Read-only.

Max. Occurrences

The maximum number of occurrences of the attribute.

N/A

 

When set to ‘unbounded’ it has no limit.

Read-only.

Nillable

Indicates whether the attribute allows nil values.

N/A

 

Read-only.

See Also

Create Structure Attributes