General

The WSOM (WEBSALE OrderManager) is a Windows program which must be installed on your system. The following data can be retrieved from a shop server:

• Format and content - WS-Bestelldaten (EN)

• Format and content - WS-Adressdatenänderungen (EN)

• Format and content - WS-Anfragedaten (EN)

• Format and content - WS-Gutscheindaten (from-Shop) (EN)

Collection of the data

The data is transferred encrypted (128 bit Triple DES) from the shop server to the local server of the merchant.

Each data record is stored in a separate file and directory of your choice. Data transfer can be done manually or fully automatically at regular time intervals.

Manual pickup

To pick up your order data manually, proceed as follows:

Open

Check whether your shop ID and password are entered correctly by calling up the "Access data" menu item in the "Settings" menu. If necessary, you can also configure an HTTP proxy in this dialog.
Set the corresponding check mark for each data type you want to fetch.

Start the transfer of the order data by clicking the "OK" button.

Automated pick up

Open

To fetch the data automatically, proceed as follows:

Proceed as described under "Manual pickup", additionally make sure that the "Save password" box is checked. Start the transfer once manually to test whether the access data are configured correctly.

Call up the "Automatic fetch..." menu item in the "Settings" menu and configure there at which times and in which intervals the data should be fetched.

Note that the first fetch will generally not occur exactly at the time specified under "From". For example, for the setting shown above, the first pickup would occur sometime between 09:30 and 09:35.

Collection of order data

Open the "Settings"/"Access Data" dialog and check the box labeled "Orders".

In the "Settings"/"Directories" dialog you can optionally change the directory where the files with the orders are stored.
For each fetched record a single file with the extension ".ord" will be created.

Format of the order data

The standard format (similar to XML) of the order data is characterized by a division into sections, each of which is identified by a name. Example of the section named "ID":

<ID>
...
...
</ID>

Within the section, the individual values are identified by an assignment of the type "Parameter = Value".

Example:

OrderNumber = 0952872507055

CR/LF is used as separator between individual lines.
The order of parameters within a section, as well as the order of sections among themselves, can be arbitrary.
For better readability of the file, any number of spaces or tabs is allowed before the parameter name and before as well as after the "=" character.

Example section of an order record:

<header>
FormatID = WEBSALE-8
Generator = WEBSALE 8.0
Copyright(c) = WEBSALE AG 2012, www.websale.de
Remark = This File-Format is protected...
Remark = Use only with expressed written allowance of WEBSALE AG.
</header>

<ID>
MallID = test
ShopID = rwa-5
SubShopID = German
OrderNumber = 1118136132311
Date = 10/24/09
Time = 18:04:59
</ID>

All parameters and their values are passed in ISO-8859-1 format.
All names of the parameters have a maximum length of 64 characters.
All values of the parameters have a maximum length of 255 characters, exceptions to this are marked accordingly.

Conversion modules

The XML module uses a mechanism provided by WSOM, which you can also use for your own "conversion modules": For each incoming order, a program can be called that takes over the further processing of the order. This processing can consist e.g. in the conversion into an own format or in the import into an enterprise resource planning system.

Compared to the regular "polling" of the incoming order directory, this mechanism has two advantages:

• Your program is started (only) when new orders are actually received.

• No problems can occur because your program and the WSOM access an order file at the same time.

In the WSOM own conversion modules are configured analog to the XML module, in which the menu item "Settings"/"Conversion modules" is called.

The checkbox "Enabled/Convert orders" determines whether the module is called at all. "Inquiries" determines whether in addition to orders also fetched inquiries are to be converted. By checking "Address data changes" and "Vouchers", you can ensure that address data changes and vouchers are also forwarded to your module.

By default, the option "Call for each order" is activated for a newly set up module. In this case, when a conversion module is called by WSOM, the absolute file name of the order file is passed as the only parameter. For example, if you have configured "c:\wsom\spezial1.exe" as the program path and your orders are located in "c:\bestellungen\", then the command line that the WSOM calls up when an order is received could be, for example.E.g. "c:\wsom\spezial1.exe c:\bestellungen\neu\11387655678.ord".

If you activate "Call once per transfer" instead, WSOM will start your conversion module only after all new data has been fetched. Instead of using individual file names, your conversion module will be called with the names of the directories where the fetched files were stored, so a call could be e.g. "c:\wsom\spezial1.exe c:\bestellungen\neu".

Note that you have to make sure yourself that fetched files are not converted multiple times. An easy way to ensure this is to move the files to a backup directory after conversion.

One advantage of this approach is that files that were not converted after a transfer (e.g. due to an error in the configuration or a system crash during the conversion) are simply converted after the next transfer. Another advantage is that a separate process is not started for each fetched file, which can result in faster conversion.

Collection of request data

Open the "Settings"/"Access Data" dialog and check the box labeled "Requests".

In the "Settings"/"Directories" dialog you can optionally change the directory where the files with the requests are stored.

Analogous to the order data, a single file with the extension ".inq" is created for each request. As with the order data, you can include conversion modules that convert the WEBSALE format of the inquiries into the format you need.

Collection of address changes

Open the "Settings"/"Access data" dialog and check the box labeled "Address changes".

In the "Settings"/"Directories" dialog you can optionally change the directory where the files with the changed addresses are stored.

Analogous to the order data, a single file with the extension ".adr" is created for each data record that is retrieved. As with the order data, you can include conversion modules that convert the WEBSALE format of the address changes into the format you need.

Collection up voucher data

Open the "Settings"/"Access data" dialog and check the box labeled "Vouchers".

Only vouchers that have been newly generated by the voucher generator can be collected. To query changes to the voucher data that result from vouchers being redeemed in the shop, the order data must be evaluated.

Analogous to the order data, a single file with the extension ".dat" is created for each data record retrieved. As with the order data, you can include conversion modules that convert the WEBSALE format of the voucher data into the format you need.