Export of data in Planning engine

The Export process is used to extract transactional data from Planning Engine to an external system.

A user can define the Export process in the SCP Interface service using a set of field mappings which determine the data that has to be exported from Planning Engine.

These mapping types are applicable for the Export process:


Mapped field	Description
Class.attribute	Resource attribute (user or system) value
Class.default property (*)	Resource default property value
Class.property	Resource property value
bucket.start	Bucket start date

Note: The fields for multiple classes can be specified, if all the classes in the mappings are related.

Validation

These validation rules are applicable for the Export process:

The common child class must be identified from the specified Class.name resource references. If common child class is not identified for the field mappings, this error message is displayed:
```
APACS155=No common child class found for parent classes: {0}.
```
Where {0} = List of classes from field mappings.
If more than one common child class is identified for the provided field mappings, this error message is displayed:
```
APACS156=More than one common child class found for parent classes: {0}. The common child classes found: {1}.
```
Where {0} = List of classes from field mappings, {1} = List of candidate child classes.
All Class.attribute mappings must be valid. Else, this error message is displayed:
```
APACS200=Class Attribute "{0}" is not valid.
```
Where {0} = Class.attribute name. This is followed by a message indicating the cause, for instance:
- ```
APACS110=There is no class defined with name "{0}".
```
  Where {0} = Class name.
- ```
APACS197=Unknown attribute "{0}" for class "{1}".
```
  Where {0} = attribute name, {1} = Class name.
All Class.property mappings must be valid. Else, this error message is displayed:
```
APACS109=There is no property with name "{0}" defined for class "{1}".
```
Where {0} = Property name, {1} = Class name.

Execution

A user can execute the Export process. The Export process is providing Planning Engine a set of field mappings and in response Planning Engine provides the exported data.

The common child class must be determined for the combination of all class references in the export field mappings.

For each resource of the common child class and each bucket in the planning horizon, a row is exported, providing values for all the mapped fields in the context of that resource and bucket.

Values for mapped fields are exported as follows:

For time-independent field types, such as attributes or default properties, values for the same resource are repeated for each of the buckets exported.
For fields referring to parent classes, the related resources for the parent class are identified in relation to the common child class:
- Parent related resource are resolved by first traversing Allocation component relations, and then using optional parent relations in sequence of parent class name. If a parent resource is not present for an optional relation, the values of fields of that parent class values are exported as NULL.