PEPPOL Client Tool Documentation

Version 0.2

18/01/11

Contents

1Background to the client

2The client

2.1Pre-requisites

2.2How to configure the client on your local machine

2.3Operations with e-Catalogues

2.3.1Create new e-Catalogue

2.3.2Import e-Catalogue from XML, CSV and ODS format

2.3.3Export e-Catalogue

Annex 1: Workarounds

Annex 2: Contact details

Document History

Version / Date / Comment / Modified Pages
0.1 / 13/09/2010 / Initial draft / All
0.2 / 17/01/2011 / Annexes / As required

Page 1

1Background to the client

The following tool is provided by the PEPPOL project ( in the context of information exchange between the PEPPOL and e-PRIOR projects. The tool can be used to facilitate the creation and manipulation of e-Catalogues that will be useful in processes such as the mapping of e-Catalogues to be used as input for the e-PRIOR services.

2The client

2.1Pre-requisites

Java Version

The java version installed on your computer must be 1.6.0_16 or newer.

2.2How to configure the client on your local machine

  1. Extract DEMOClient-30-11-10-en.zip to your local directory.

You will run the client from the DEMOClient folder.

Note that application data is located in folder
C:\Documents and Settings\ <user> \DEMORepository

Open the DEMOClient folder. Run the client by double clicking the When the client is downloaded, unzip it, you will find the following structure.

• For windows, double click to the install-windows-x[VERSION].bat

• For linux, d double click to the install-unix-x[VERSION].bat

(NOTE: This step will delete the current DEMORepository folder so the application can

2.3Operations with e-Catalogues

The operations possible with e-Catalogues are (see the picture below):

  1. Create new e-Catalogue
  2. Import e-Catalogue from XML CSV and ODS
  3. Export e-Catalogue

2.3.1Create new e-Catalogue

When choosing the option new e-Catalogue, the following screen is displayed.

The screen has four tabs:

  • Details
  • Provider Party
  • Receiver Party
  • Catalogue Line

At the bottom of the screen there are the following options:

  • Save to Draft Folder
  • Prepare to send
  • Delete document
  • Validate

2.3.1.1Explanation of the tabs

Details tab contains:

  • e-Catalogue Details
  • Validity Period
  • Referenced Contract
  • Seller Supplier
  • Contractor Customer Party

Provider party tab contains:

  • Party
  • Party Identification
  • Party Name
  • Postal Address
  • Party Tax Scheme

Receiver party tab contains:

  • Party
  • Party Identification
  • Party Name
  • Postal Address
  • Party Tax Scheme

NOTE: Wherever you find the option to choose between Read Contacts List and New Contact, choose New Contact. The Read Contact List refers to functionality that is implemented by the PEPPOL project and allows the creation of contacts that can be re-used. However the way these contacts are created, are not used in the context of e-PRIOR.

Read Contacts List / New Contact

The e-Catalogue line tab gives the option of creating each e-Catalogue Line.

Once an e-Catalogue line has been created, the line can be Edited or Deleted.

Once all the mandatory fields have been created, (the mandatory fields are marked with *), the e-Catalogue can be validated. The result of the validation is presented in the following screen:

In case of errors, a new screen with the details of these errors can be displayedby clicking the option more information.

Once the e-Catalogue is saved into Drafts, it can be viewed from the main screen:

2.3.2Import e-Catalogue from XML, CSV and ODS format

When choosing to import an e-Catalogue, a screen is opened. After selecting the document path and the Procurement Type, click the Import button to complete the process. The successfully imported documents are found in the Draft folder of the tool or as shown in the Document Path.

When there are errors during the import, the Catalogue is not imported.

NOTE:When importing an XML document,ensure that the following elements are present in the input file.

<cbc:UBLVersionID>2.0</cbc:UBLVersionID>

<cbc:CustomizationID>BiiCoreTrdm019</cbc:CustomizationID>

<cbc:ProfileID>BII01</cbc:ProfileID>

NOTE:An ODS template can be found in “resources\ODSConverter\ODS examples v1.0”.

2.3.3Export e-Catalogue

The e-Catalogue can be exported toXML and CSV format. First select the e-Catalogue to be exported and then choose following menu item:“New>Export XML”.

The exporteddocument will be in the UBL format. Taking into account that the exact structure and business rules can vary between the PEPPOL and e-PRIOR project, be sure to validate the e-Catalogue using the e-PRIOR Validation tool which can be found in the ICD annexes (ICD\Annexes\007_Tools\ValidationTool).

Manual changes to the generated e-Catalogue might be required after running the Validation Tool. The output window of the ValidationTool will point out possible issues. If the errors/warnings persist, please do not hesitate to contact us (please see contact details inAnnex 2: Contact details).

Annex 1: Workarounds

The current version of the tool has some limitations that will be fixed in a newer version. The workarounds listed belowhelp to bypassthese limitations.

  1. IE Browsing settings :

Ensure that the “Disable script debugging (Internet Explorer)” and “Disable script debugging (Other)” are enabled. In the case that these settings are not enabled, debugging information is displayed when using the tool.

  1. Format of the Date fields in the ODS: All data input in the ODS file has to have the following format:

yyyy-mm-dd

When a wrong data format is imported, especially in the area Price, Lead Time and Delivery Address (see the picture below), the Import needs to be re-done, as this Tab is not properly saving the Catalogue to “Draft folder”.

In the other areas where data fields are used, the data can be corrected in the GUI, using the calendar icon that is present next to any data input.

  1. Remove wrongly initialized fields that trigger .xsd violations.

Export the Catalogue to XML format and perform an additional validation with the Validation tool published on circa. This validation will detect any violations that were missed by the tool.

(For example the Party Legal entity is created empty, without the children elements, which generates an .xsd violation)

  1. Remove ItemSpecificationDocumentReference

Export the Catalogue to xml format and look for ItemSpecificationDocumentReference. In case it is present, remove the following:

cac:ItemSpecificationDocumentReference

cbc:ID/>

cac:Attachment

cac:ExternalReference

cbc:URI/>

</cac:ExternalReference

</cac:Attachment

</cac:ItemSpecificationDocumentReference

  1. Add the Allowances and Charges in the Notes manually.

Export the Catalogue to xml format and add the Note manually.

It is recommended that the Allowances and Charges are implemented using the Note and the Note has the following structure:

cbc:NoteCharge::(CountryCode)::Name of Charge::Value::Currency </cbc:Note

Should there be more allowances and charges, these should be present in the same note, concatenated using “//”.

  1. Add the SellerSupplier, Contractor Customer Party, Provider Party and Receiver Party ID(mandatory fields) that is in the ODS as Additional Identifier, but are not mandatory(see example below).

In case these fields are not completed, the validation of the Catalogue will fail.

  1. Use of Excel Office 2007

It is recommended that for the ODS manipulation, Excel Office 2007 is used. When using other editors the formatting of the data might be affected and the import of the document might be unsuccessful.

Annex 2: Contact details

For questions or assistance, do not hesitate to contact the e-PRIOR team.

Mail:

Phone: +32 2 299 4183 (Working days between 09.00 and 17.00 CET)

Page 1