Application management : Tools : Data Aggregation : Configuration of Data Aggregation : Configuring ContainerSX in Field Definer
Configuring ContainerSX in Field Definer
The ContainerSX extension is configured in the Data Aggregation Definition business object:
On the Extension tab, add to the following extension:
Extension = nl.planon.cs.dam.ContainerSX
Event type = AI, AfterDBInsert
Sequence of execution = 1
The content of the Parameter field contains all configurable parameters, necessary for the ContainerSX to work properly. The complete content must be:
Key
Value example / Description
Container.BO.Name
DataAggregationDefinition
Description
The name of the business object that holds the definition (container) records (current business object)
Data.BO.Name
DataAggregationData
Description
The name of the business object that holds the benchmark data level. This level has a 1-n relation with the definition (container) level.
BenchmarkEntity.­BO.Name
Property
Description
The name of the business object that holds the records (entities) that must be benchmarked. Typically, this is the Property business object.
Data.BO.Container­Ref.Name
DataAggregation­DefinitionRef
Description
The name of the field of the data level business object which holds the link to the definition (container) level business object.
Data.BO.Benchmark­EntityRef.Name
FreeString12
Description
The name of the field of the data level business object that holds the link to the business object of the entities to benchmark. Typically, this is a link to the Property business object.
Data.BO.ParentRef.­Name
ParentRef
Description
The name of the field of the data level business object that holds the link to the data level business object that in the hierarchy is the ‘parent’ of the current business object
BenchmarkEntity.BO.­ParentRef.Name
AlternativeParent­Ref
Description
The name of the field of the business object of the entities to benchmark which holds the link to a similar business object that is to be the parent in the hierarchical benchmark structure.
BenchmarkEntity.BO.­BenchmarkRef.Name
FK_ALTERNATIVE_­PARENT_PROPERTY
Description
Same as previous, but here the database name of the field.
Benchmark.Picklist.­Name
BENCHMARK
Description
Name of code/descriptive pick list in which all benchmarks that can be used are specified.
Benchmark.Code
IPD
Description
The code of the specific benchmark for which purpose the Data business object is configured (is part of Benchmark.Picklist.Name)
Create.Hierarchical.­Structure
false or true
Description
When generating the data business objects, a hierarchical structure is created as defined by the parameters Data.BO.ParentRef.Name, BenchmarkEntity.­BO.ParentRef.Name and BenchmarkEntity.BO.­BenchmarkRef.Name. However, if this parameter is set to false, the hierarchical structure will not be created and the three previously mentioned parameters will be ignored.
Strict.ParentRef.­Check
false or true
Description
If set to true (default value) then, when creating a hierarchical structure, all members of the hierarchy must have a link to the specified benchmark code. If that is not the case, then the data business objects of this hierarchical family are not created.
However, if this parameter is set to false, then the data business objects will be created if the corresponding benchmark entity has a link to the specified benchmark code. The hierarchical structure will only be created if both parent and child have this link to the specified benchmark code.
Example
In the hierarchy, if the grandparent and grandchild have a link to the specified benchmark code, but the parent does not, then data business objects will be created for both grandparent and grandchild, but in a flat list.
Error.Mandatory.­Parameters.Missing
Please provide parameter(s) :
Description
The default text of the error message that will appear if one or more parameters are missing.
Error.Mandatory.­Parameter.Values.­Missing
Please provide value for parameter(s) :
Description
The default text of the error message that will appear if the values of one or more parameters are missing.
Error.Invalid.­Parameter.Value
Invalid value for Parameter :
Description
The default text of the error message that will appear if one or more parameters are set to an invalid value.
When the extension is configured on the business object with correct layouts, TSI and authorizations are configured, you can create a definition (container) record.
After inserting a new definition (container) record the ContainerSX will be executed. This SX will create the data level records based on the specified parameters. The records will be created in the specified hierarchical structure (unless the parameter Create.Hierarchical.Structure is set to false).
Example of Parameter field
Container.BO.Name=UsrAggregationDefinition2
Data.BO.Name=UsrAggregationData
BenchmarkEntity.BO.Name=Property
Data.BO.ContainerRef.Name=DataAggregationDefinitionRef
Data.BO.BenchmarkEntityRef.Name=FreeString12
Data.BO.ParentRef.Name=ParentRef
BenchmarkEntity.BO.ParentRef.Name=AlternativeParentRef
BenchmarkEntity.BO.BenchmarkRef.Name=FK_ALTERNATIVE_PARENT_PROPERTY
Benchmark.Picklist.Name=BENCHMARK
Benchmark.Code=IPD
Create.Hierarchical.Structure=true
Strict.ParentRef.Check=false
Error.Mandatory.Parameters.Missing=Please provide parameter(s):
Error.Mandatory.Parameter.Values.Missing=Please provide value for parameter(s):
Error.Invalid.Parameter.Value=Invalid value for Parameter: