Batch Interface: Business Partner creation

The batch interface for business partner creation allows the oppsition, gathering business partner into a file and send them for further processing to dsb.

The interface is based on XML (eXtensible Markup Language). The entire XML-structure is transferred into a data. The XML-structure consists in substance of a Header-Part in which the general document descriptions (XML-Version, encoding, etc.) are stored which count for the entire data. The specific order data is within the <body>-tag in the actual XML-structure stored.

There can be multiple business partner with a specific role implementation at one subscription. There can be multiple premiums and multiple messages.

Data is transferred per ftp to dsb-server. The address of the server is called: ftp.dsb.net. At this point data is transferred to the list of dsb. Name of data is freely selectable. To be able to collect the data you need FTP-access. Your customer service will tell you that.

We reserve change in structure of element structure and element attributes (see therefore also section 2.5)

Some filed attributes depends on client specific settings(master data or customizing). For further information about client specific customizing, please contact your customer service.

All business partners are sent within a XML-document and therefore within a XML file. The business-partners are summarized within the <body>-Tag. The elements of a single business-partner are surrounded by a <business-partner> tag.

For general information see chapter 16.1

shematic description:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE message SYSTEM "BusinessPartner.xsd">
<message system="avs/3" version="1.0">
    <header>
        <creation-date/>
        <creation-time/>
        <collection-office/>
        <file-name/>
        <file-number/>
        <client/>
        <number-of-entries/>
    </header>
    <body>
        <business-partner>
            <!--fields and elements according to the description -->
        </business-partner>
        <business-partner>
            <!-- addition business-partner -->
        </business-partner>
        <business-partner>
            <!-- addition business-partner -->
        </business-partner>
    </body>
</message>

The structure of the served XML fragments business-partner has the same composition in the batch- as in the realtime modus.

The files has generally no size limitation. But they should not contain more than 1500 orders, to prevent excessive memory allocation. If more orders will be delivered, they should be splitted into more XML files with the unique counter.

Encryption of customer data

There are two different ways to encrypt data:

Symmetric encryption: The data is encrypted with an password . The advantage of this procedure is a simple implementation. The disadvantage is the relative weak encryption of data on this procedure. The strength of the encryption depends on the qualitiy of the password.
Public-Key encryption: The data will be encrypted with dsb's public key. The advantage in this case is the strong encryption of data .

The disadvantage is the more complex implementation depending on the software.

dsb offers both of these ways of encrypting customer data.

The examples use GnuPG: https://www.gnupg.org/

Symmetric encryption

To encrypt a customer file with name a3gul5221510200200.xml insert in a DOS-Box:

gpg --symmetric a3fnk5251510200201.xml

or

gpg --c a3fnk5251510200201.xml

Type in the password for encryption. The program generates automatically an encrypted file a3gul5221510200200.xml.pgp. This file and a corresponding “OK” file can then be transferred on dsb’s ftp server.

The password for encryption is provided before production start by the customer service and must be used on every data encryption.

Asymetric encryption

To integrate the public key from dsb, use the following command:

gpg --import Schlüsseldatei

dsb's public key can be found here: publicKey

To verify the correct integration use the following command

gpg –kv

Ecrypt a customer file with name a3gul5221510200200.xml via public key method:

gpg --default-recipient <ID dsb public key> --encrypt a3fnk5251510200201.xml

The program automatically generates the encrypted file

a3gul5221510200200.xml.pgp. This file and a corresponding “OK” file (a3gul5221510200200.xml.pgp.ok) can then be transferred on dsb’s ftp server.

Important The encrypted file must not be signed.

XML-Definition: Header

Structure

<creation-date></creation-date>
<creation-time></creation-time>
<collection-office></collection-office>
<file-name></file-name>
<file-number></file-number>
<client></client>
<number-of-entries></number-of-entries>

</header> </code>

Element Definitions

Field Name	Length	Type	Text	m = Must k = can (m) = conditional	Remark, field supply or encoding
creation-date	10	C	creation date of file	m
creation-time	8	C	creation time of file	m
collection-office	12	C	collection office	m	same value as in field input-office (please contact your cusomer service)
file-name	30	C	filename(verification)	m
file-number	2	N	continious filenumber(assigned by the collection-office)	m	01 up to 99 (rollierend).
client	3	N	client number	m	(please contact your cusomer service)
number-of-entries	8	N	quantity of entries	m	quantity of 'subscription' entries