ERP Profile

Updated on

Using the information stored in the ERP profile, self-developed clients can - when converting the received data into CSV format - define which fields should be written into the file, as well as their order and scope.

zanox has assigned a profile to every program whose ERP data will be exported. The GetUserPrograms function delivers the profile description in the element <erpprofile> in XML format, with the following information:

Data format for the client-side storage of data
Number and order of CSV columns
Names of the individual columns
Constant values for individual columns

The profile will be delivered in simple XML format.

Example

<erpprofile>
    <![CDATA[<?xml version="1.0" encoding="utf-8"?>
    <profile saveas="csv">
        <fieldlist trackingtype="3" csvdelimiter=";">
            <field intern="prog_id" extern="Programm ID" export="1"/>
            <field intern="tcat_cid" export="1"/>
            <field intern="update_flag" extern="Update" value="0" export="1"/>
        </fieldlist>
        <fieldlist trackingtype="4">
            <field intern="prog_id" extern="Programm ID" export="1"/>
            <field intern="tcat_cid" export="1"/>
            <field intern="update_flag" extern="Update" value="0" export="1"/>
        </fieldlist>
        <fieldlist trackingtype="23" csvdelimiter=",">
            <field intern="prog_id" extern="Programm ID" export="1"/>
            <field intern="tcat_cid" export="1"/>
            <field intern="update_flag" extern="Update" value="0" export="0"/>
        </fieldlist>
    </profile>
    ]]>
</erpprofile>

Element <profile>

Object	Data Type	Description
`<profile>`		Contains n elements `<fieldlist>` as children
saveas	normalizedstring	Format in which the data should be saved on the client-side
`<fieldlist>`		Contains n elements `<field>` as children
trackingtype	unsignedbyte	ID of the tracking type assigned to the element `<fieldlist>`
csvdelimiter	normalizedstring	Field delimiter, which should be used for the CSV export for the stated tracking type
<field>		Element with different attribute values, represents a data field. The order of the individual attribute values must correspond with the order of the individual CSV columns.
intern	normalizedstring	Internally-used field name
extern	normalizedstring	Column name for the CSV export. If this is not stated, the internal field name (attribute "intern") should be used.
export	unsignedbyte	Indicates whether the field should be exported (0 = yes, 1 = no)
value	normalizedstring	Fixed value, which should always be used for this field

The meta information that can be retrieved with the help of the GetFieldInfosCommon function also contain the attribute "intern" for each field. Accordingly, the name stated here can be used to map both information sources to each other.