Page Comparison

...

Below is a list of methods that scripts can access to retrieve and manipulate data from any concept (configuration area, unit, configuration and configuration item):

Method	Return Type	Description
`getId()`	`ObjectId`	Retrieves the unique identifier of the concept.
`getTitle()`	`String`	Retrieves the title of the concept.
`getDescription()`	`String`	Retrieves the description of the concept.
`getConceptTypeKey()`	`String`	Retrieves the key that identifies the concept type.
`getStateKey()`	`String`	Retrieves the key that identifies the concept state.
`getArchived()`	`Instant`	Retrieves the timestamp when the concept was archived.
`getTags()`	`List<ObjectId>`	Retrieves a list of tags associated with the concept.
`getConceptType()`	`ConceptType`	Retrieves the concept type of the concept

Accessing Properties and Complex Properties

...

These methods allow you to retrieve simple properties directly from a concept in different data types. The methods that return the property as their type throw an exception if the property doesn’t actually have this type:

Method	Return Type	Description
`getProperty(String key)`	`String`	Retrieves a property by its key as a string. This method is always available, no matter the data type of the property.
`getPropertyAsInt(String key)`	`Integer`	Retrieves an integer property value by its key.
`getPropertyAsDouble(String key)`	`Double`	Retrieves a double property value by its key.
`getPropertyAsBigDecimal(String key)`	`BigDecimal`	Retrieves a BigDecimal property value by its key.
`getPropertyAsBoolean(String key)`	`Boolean`	Retrieves a boolean property value by its key.
`getPropertyAsInstant(String key)`	`Instant`	Retrieves an instant (timestamp) property value by its key.
`getPropertyAsLong(String key)`	`Long`	Retrieves a long property value by its key.

Complex Property (Record) Access Methods

...

Methods Available in ComplexProperty

Method	Return Type	Description
`getPropertyByIndex(int index, String propertyKey)`	`String`	Retrieves a string property value by its index and key within the complex property. (Always available)
`getPropertyAsIntByIndex(int index, String key)`	`Integer`	Retrieves an integer property value by its index and key.
`getPropertyAsDoubleByIndex(int index, String key)`	`Double`	Retrieves a double property value by its index and key.
`getPropertyAsBooleanByIndex(int index, String key)`	`Boolean`	Retrieves a boolean property value by its index and key.
`getPropertyAsBigDecimalByIndex(int index, String key)`	`BigDecimal`	Retrieves a BigDecimal property value by its index and key.
`getPropertyAsLongByIndex(int index, String key)`	`Long`	Retrieves a long property value by its index and key.
`getPropertyAsInstantByIndex(int index, String key)`	`Instant`	Retrieves an instant property value by its index and key.

ConceptType Object Methods

...

Below is a list of methods provided by the ConceptType object, accessible through the Concept object:

Method	Return Type	Description
`getBaseKind()`	`ConceptBaseKind`	Retrieves the base kind of the concept type, indicating its general classification.
`getAssociatedChildConceptTypeKey()`	`String`	Retrieves the key for any associated child concept type.
`getPropertyTypeKeys()`	`List<String>`	Retrieves a list of keys for the property types defined for this concept type.
`getRecordTypeKeys()`	`List<String>`	Retrieves a list of keys for the record types defined for this concept type.
`getStateMachineKey()`	`String`	Retrieves the key for the state machine associated with this concept type, if any.

Type-Specific Concept Methods

Depending on the type of concept instance, additional methods are available that facilitate accessing related concepts and properties specific to their functional role within the application. Below is a breakdown of these methods by concept type:

Unit (Component)

For concepts that are instances of "Unit" or known as "Component":

Method	Return Type	Description
`getConfigurationArea()`	`Concept`	Retrieves the parent configuration area

Configuration

For concepts that are instances of "Configuration":

Method	Return Type	Description
`getComponent()`	`Concept`	Returns the parent component of this configuration.
`getConfigurationItems()`	`List<Concept>`	Returns the configuration items of this configuration

Configuration Item

For concepts that are instances of "Configuration Item":

Method	Return Type	Description
`getStorageLocation()`	`StorageLocation`	Returns the storage location associated with the configuration item.

StorageLocation Methods

The StorageLocation object provides specific information about where the configuration item is stored:

Method	Return Type	Description
`name()`	`String`	Retrieves the name of the storage location.
`storageLocationType()`	`String`	Retrieves the type of the storage location.

Accessing Master Data

Scripts have the capability to access and utilize master data, which are tables of fixed data independent of the concept units. Master data provides a stable dataset that scripts can rely on for performing various operations, such as validations and computations.

...

Version	Old Version 3	New Version 4
Changes made by	Wanja Mensch	Wanja Mensch
Saved on	May 15, 2024	May 15, 2024