This form is used to define an integration object, that is, a container of data to be exchanged over an interface with an external system; see Data exchanges.
For rules on how to use the fields, see Detail form.
Header
- Integration object: Identifier of the object.
- Name: Name of the object.
- Primary business object: The CARL Source entity on which the integration object is based. All the objects of the dictionary in the "Entity" category are offered.
- Standard: A standard object cannot be changed. To adapt an object to your needs, create your object by copying it.
Objects
The list of CARL Source objects comprising the integration object. It includes the main business object and any necessary sub-objects.
- Object: Identifier of the object.
- Name: Name of the object.
- Parent object: For a sub-object, the name of the object that contains it.
-
Object alias:
- XML format: Identifier of the object in the XML file,
- Flat file: to be indicated for the corresponding record in the standard.
-
Collection alias:
- XML format: A tag surrounding the collection elements,
- Flat file: to be indicated for the corresponding record in the standard.
- Additional identifiers: List of (alias, attribute) pairs corresponding to the attributes to export, separated by commas.
On import, this setting can be used to specify the element of a collection to be updated if it already exists.
Example:
A has a functional key comprising: it is identified by the line number and the PR code.
→ Dans la colonne "Identifiants complémentaires" de l'attribut deliveryLine_PRLine : lineNumber=lineNumber,PR_coderef=PR.code
Attributes
This list is synchronized with the previous one: the displayed attributes are those of the object selected on the list above.
Upon initialization, all the attributes of the main object capable of being used in the exchange are added. You can delete or add them (in particular, for sub-objects).
An attribute present in the integration object and not used in the interface does not cause an error.