Global Standard for the Paper and Forest Products
papiNet ISS tool user guide
August 2005
papiNet ISS tool
Table of Contents
Table of Contents ........................................................................................................ 1
Introduction ................................................................................................................ 2
Background ..................................................................................................................................... 2
Overview of papiNet ISS .................................................................................................................. 2
Contents of this document ............................................................................................................... 3
Preconditions for using papiNet ISS on your computer .............................................. 4
Microsoft XML Core Services (MSXML40) ........................................................................................... 4
Installing MSXML40 ......................................................................................................................... 4
How to use papiNet ISS to create an Excel worksheet of a schema ............................ 5
Opening the papiNet ISS dialogue to create a worksheet from a schema ............................................ 5
Using the papiNet ISS dialogue ........................................................................................................ 5
Description of the Excel worksheet created by papiNet ISS ....................................... 7
Overview ........................................................................................................................................ 7
Default formatting of the worksheet ................................................................................................. 7
Subset definition columns ................................................................................................................ 9
papiNet definitions columns ........................................................................................................... 10
Backend system mapping columns ................................................................................................. 11
Page 1 of 12
papiNet ISS tool
Introduction
Background
When implementing a papiNet message all the information content defined in the papiNet
schema is never needed. The implementation project will always restrict the use of the schema
by defining what elements, attributes and enumerations are actually used; papiNet calls this a
message ‘subset’. The papiNet ISS tool is designed to be used as a message subset documentation tool.
Overview of papiNet ISS
papiNet ISS is an Excel Visual Basic application that takes a papiNet XML schema as input and
creates an Excel worksheet of the schema with each row containing information about an element or an attribute.
Excel file created by papiNet ISS
When papiNet ISS creates the Excel worksheet the following information is extracted from the
XML schema:






element and attribute names
information whether the element or attribute is optional or required
maximum occurrence of the element or attribute.
data type of the element or attribute.
available enumerations of the element or attribute.
path of the element or attribute
To serve as a documentation tool for an implementation of papiNet message subset, the worksheet is pre-configured to contain detailed information about:






what elements and attributes of the message are used in the implementation subset and
whether these are required or optional
how many times repeatable elements and attributes can occur
what enumerations are used
what processing rules are enforced
information about how the elements and attributes relate to information held in backend
system(s), e.g. database tables.
space for remarks about both the subset and relation to information held in backend systems.
Page 2 of 12
papiNet ISS tool
Contents of this document
The following three chapters of this document go into further detail concerning:



Preconditions for using papiNet ISS; installation of Microsoft XML Core Services.
How to use papiNet ISS to create an Excel worksheet of a papiNet schema.
What information the papiNet ISS worksheet contains and how it can be used to document a papiNet implementation.
Page 3 of 12
papiNet ISS tool
Preconditions for using papiNet ISS on your computer
Microsoft XML Core Services (MSXML40)
To be able use papiNet ISS functionality to create an Excel worksheet of a papiNet XML schema
Microsoft XML Core Services (MSXML40) must be installed on the computer.
Once papiNet ISS has created the worksheet, MSXML40 is no longer required to open and modify the file.
The MSXML40 installation file (msxml.msi) can be downloaded from:
http://www.microsoft.com/downloads/details.aspx?familyid=3144b72b-b4f246da-b4b6-c5d7485f2b42&displaylang=en
Installing MSXML40
The download page also has the complete installation instructions, but the instructions below give a quick overview of how to install
MSXML40.
After downloading MSXML40
open Windows Explorer
browse to the folder where ‘msxml.msi’
was downloaded
 right-click the file
 select ‘Install’ to start the installation.
Wait for the installation to complete.


The computer is now configured to use
MSXML40 and you can start to use papiNet
ISS.
Page 4 of 12
papiNet ISS tool
How to use papiNet ISS to create an Excel worksheet of a schema
This chapter describes how to use the papiNet ISS tool to create an Excel worksheet of an XML
schema.
Opening the papiNet ISS dialogue to create a worksheet from a schema
Open the papiNet ISS Excel file.
Click ‘Create papiNet ISS’ to open the papiNet ISS dialogue box.
Using the papiNet ISS dialogue
Select a schema & its root element from provided lists
and click ‘Create ISS’.
The default schema list shows the schema files located
in folder papiNet ISS was opened from, to select another folder press the button with current folder name.
‘Create new workbook’ – Creates the worksheet in a new Excel workbook.
‘Create new worksheet’ – Creates a new worksheet in the
current Excel file.
‘Clear & Use current worksheet’ – Use current worksheet after clearing existing data from it.
Please note that you cannot change or add worksheets to
the file ‘papiNet ISS v1r5.xls’ itself. You will always have to
start by creating a new workbook.
‘Use ‘?’ instead of ‘No’ for ‘Used in subset’’ – Controls whether to use ‘?’ or ‘No’ as default value for
‘Used in subset’ column for optional elements / attributes.
‘Default subset max occurrence from schema’ – Controls whether to copy max occurrence from schema
as the default value for the subset.
‘Default subset enumerations from schema’ – Controls whether to copy enumerations from schema as
the default value for the subset.
‘Use conditional formatting’ – Controls whether the worksheet should be configured to automatically
set background color of rows based on whether the element is Required or Optional.
Page 5 of 12
papiNet ISS tool
‘Use cell value validation’ – Include validation of columns ‘Used in subset’ and ‘Optional/Required’. Allowed values are:

‘Yes’, ‘No’ or ‘?’ for column ‘Used in subset’

‘Required’ or ‘Optional’ for column ‘Optional/Required’.
‘Create project sheet’ – Creates an additional worksheet where you can record information about the
project and ISS versioning.
Page 6 of 12
papiNet ISS tool
Description of the Excel worksheet created by papiNet ISS
Overview
Once papiNet ISS has completed the worksheet it
hides all but the 3 leftmost columns and all the rows
where the hierarchical level is greater than 2.
The three leftmost columns in the worksheet are:
‘Seq’
Sequential numbering of the elements and
attributes in the schema.
‘Element’
Name of the element or attribute. To increase
readability the text in this column is indented
based on the ‘Level’ number in the next column.
The ‘@’ character is added as the first character of all attribute names.
‘Level’
Hierarchical level in the schema of the element or attribute.
The remaining columns in the worksheet are divided into three groups and the content of these
columns is described in more detail later in this chapter.
Default formatting of the worksheet
The worksheet created by papiNet ISS is pre-formatted as described below.
Worksheet row and column grouping
The rows in the worksheet are grouped based on the information in the ‘Level’ column so that levels 1
& 2 are always visible and levels 3 to 9 are by default hidden.
The columns are divided into groups based on their contents.
The row and column groups can be displayed or hidden by clicking the ‘+’ button or one of the group
numbers.
Worksheet auto filter
Excel AutoFilter is enabled by default so that rows can be filtered based on information in the columns.
Worksheet freeze panes
Worksheet Freeze Panes is set so that rows 1 to 5 and columns A to C are always visible when scrolling
the worksheet.
Validation of cell value
If ‘Use cell value validation’ was selected when creating worksheet, values in columns ‘Used in subset’
and ‘Optional/Required’ are validated and can include only pre-defined values (‘Yes’, ‘No’, ‘?’ and ‘Required’, ‘Optional’).
Page 7 of 12
papiNet ISS tool
Conditional formatting
If ‘Use conditional formatting’ was selected when creating worksheet the rows in the worksheet are
formatted to use pre-defined format using Excel’s conditional formatting functionality.
Values in columns ‘Used in subset’ and ‘Optional/Required’ control the conditional formatting of rows as
described in the table below.
‘Used in subset’
‘Optional/Required’
columns of ‘Subset definition group’
Yes
Required
green background.
Yes
Optional
yellow background.
?
n/a
pink background.
No
n/a
Grey text on white background (default format).
‘Status’ column of ‘Backend system mapping’ group
If ‘Status’ column contains text and text is not = ‘OK’ row is displayed using pink background.
Page 8 of 12
papiNet ISS tool
Subset definition columns
‘Subset definition’ columns are designed to be used to document the message subset, i.e. what
and how elements and attributes are used in an implementation.
‘Used in subset’ column has three possible values (contents of this column controls conditional formatting of rows):

‘Yes’ indicates that that the element or attribute is used in the implementation.

‘No’ indicates that the element or attribute is NOT used in the implementation.

‘?’ indicates that it is not yet defined whether the element or attribute will be used or
not.
Only above values are allowed for this column if ‘Use cell value validation’ was selected when creating
worksheet.
‘Optional/Required’ column has two possible values (contents of this column controls conditional formatting of rows):

‘Optional’ indicates that the element or attribute MAY be used in the implementation

‘Required’ indicates that the element or attribute MUST be used.
Only above values are allowed for this column if ‘Use cell value validation’ was selected when creating
worksheet.
‘Max occurrence’ is used to document the maximum occurrence of the element, where the schema defines the element as repeatable. Default value can be copied from schema when creating ISS.
‘Enumeration’ column is used to document the element and attribute enumerations available in the implementation. Default value can be copied from schema when creating ISS.
‘Rule’ column is used to document any rules relating to the use of the element or attribute.
‘Remarks’ column is used to document any remarks.
Page 9 of 12
papiNet ISS tool
papiNet definitions columns
‘papiNet definitions’ columns are extracted from the XML schema when the worksheet is created
and contain additional information about the elements and attributes as defined in the schema.
‘Optional/Required’ column has two possible values

‘Optional’ - the schema defines the element or attribute as optional

‘Required’ - the schema defines the element or attribute as required
‘Max occurrence’ column contains the maximum occurrence of the element or attribute
‘Data type’ column contains the data type of the element or attribute.
‘Enumeration’ column contains the available enumerations of the element or attribute.
‘Path’ column contains the XML path of the element or attribute.
Page 10 of 12
papiNet ISS tool
Backend system mapping columns
‘Backend system mapping’ columns are designed to be used to document how the information
relates to the backend system receiving or sending the data, e.g. a database table.
‘Fieldname’ column is used to document what information the element or attribute relates to in the
backend system, e.g. database table name & fieldname.
‘Mapping rule’ column is used to document any rule relating to the handling of the information.
‘Status’ column is designed to be used in the development phase of the backend system mapping. The
contents of this column controls conditional formatting of rows, i.e. if text is entered in this column and
the text is not = ‘OK’ the row will be highlighted using pink background colour.
‘Remarks’ column is used to document any remarks.
Page 11 of 12