SYSTEM GUIDES

PRICER FILE INTERFACE

(PFI) SPECIFICATION
Information in this document is subject to change without notice. No part of this document may be
reproduced or re-transmitted in any form or by any means, electronic or mechanical, for any purpose,
without permission in writing from Pricer AB.

Pricer File Interface (PFI) Specification, Pricer Part number: 50777-01-F

R3/ English
Copyright © 2000-2010 Pricer AB. All rights reserved.

PFI-2 PRICER FILE INTERFACE

Contents

1 Introduction ................................................................................... 4
1.1 Target Audience..................................................................... 4
2 PFI Overview................................................................................. 6
2.1 Communication Interface ...................................................... 6
2.2 Text Files ............................................................................... 6
2.3 Environment Independent ...................................................... 7
3 PFI Specification ........................................................................... 8
3.1 PFI Procedures and Communication Method ........................ 8
3.1.1 Message File Formats .................................................... 9
3.1.2 Data File Formats ........................................................ 10
3.1.3 Result File Formats ...................................................... 12
3.2 PFI File Names .................................................................... 13
4 PFI Message Specifications ......................................................... 14
4.1 UPDATE ............................................................................. 14
4.1.1 PFI Timed Updates ...................................................... 15
4.2 TARGETLINK .................................................................... 15
4.3 PRINT .................................................................................. 17
4.4 REFRESH ............................................................................ 18
4.5 SETGLOBAL ...................................................................... 18
4.6 DELETE .............................................................................. 19
4.7 ESLUPDATE ...................................................................... 20
4.8 PFI Configuration ................................................................ 21
4.8.1 PFI Configuration Summary ........................................ 21
4.8.2 System Parameters for PFI .......................................... 22
Appendix A A Complete List of PFI Fields ................................. 23
Appendix B Complete List of R7 Return Codes .............................. 29
Appendix C R 2.4 Compatibility Issues ........................................... 31
Index .................................................................................................... 33

PRICER FILE INTERFACE PFI-3

1 Introduction

This document includes a complete specification of the Pricer File Interface (PFI) for the R3 and any future
releases of the Pricer system. Included in this document are the specifications of the generic “low level”
formats of the PFI files and the specific contents (depending on the messages). The complete lists of PFI
fields and R7 return codes are included as appendices.
The Pricer File Interface is geared towards developers involved in integrating the Pricer System with another
system in the store.
This manual contains:
 PFI Overview
 PFI Specification
 PFI Message Specifications

1.1 Target Audience

This document specifies the Pricer File Interface (PFI). It is a defined interface description and does not
imply any system design or implementation suggestions regarding the implementation of the PFI service in
the Pricer System.
The reader is expected to have a basic knowledge of the Pricer System. This document provides a detailed
PFI description for the individual who implements the system and uses the PFI. For more information, see
the list of related documents.
The implementation of the PFI configuration mechanisms are not described in the main text of this
document. All options, configuration parameters and settings are only specified in a generic manner. The
procedure to manage the PFI configuration is located in the PFI Configuration section.

PFI-4 PRICER FILE INTERFACE

PRICER FILE INTERFACE PFI-5
2 PFI Overview

The PFI text based interface communicates with the Pricer System through the PCA. The term PCA is used
for the customer system that contains the Price Controlling Application. This is a Pricer term that is used to
describe the component that provides the Pricer System with information. In a particular customer
environment, the PCA can be the Back-Office Computer System, the POS-system, the Host System or any
other system that controls the actual price of an item and provides the Pricer System with updates whenever
the price is changed. The PCA system interacts with the Pricer System to supply information to the ESLs,
either through the Pricer File Interface (PFI) or through the Pricer Server API.
This section contains:
 Communication Interface
 Text Files
 Environment Independent
The interface takes the following actions:
 Links and unlinks ESLs to items.
 Prints overlays for the ESLs.
 Item maintenance, including add and/or update item information in the Pricer database. The Pricer
System will automatically transmit valid information from the PCA to the ESLs.
NOTE: The Pricer Server API is not covered in this document.

2.1 Communication Interface

The PFI is not a user interface. It is designed to be a software-to-software interface. Before the PFI
information (i.e. the result file) is presented to a user, it should be formatted in a user-friendly way. This
service is not within the scope of the PFI.

2.2 Text Files

The transportation mechanisms through the PFI are common text files, in 8 bit ASCII format or 2-byte
UNICODE. The Pricer System automatically detects the format of the input files.
The PCA delivers two files to the Pricer Server, one file to specify the operation to be performed, and the
other file containing the actual data. The two input files for the Pricer Server are:
 The M1file
A message file produced by the PCA. Contains information about which operation to perform,
where to find the corresponding data file (I1), and where to put the result file.
 The I1 file
The data file related to the operation specified in the M1 file. Produced by the PCA.
The reason for having two separate files as input to the Pricer System (the M1 and I1 files), is that this
allows PCAs built with older components to make the I1 files into static record formats. The Pricer Server
creates the result file, R7 which contains result messages which can be used by the PCA.
NOTE: In the PFI configuration file, the creation of the result file can be optionally switched off.

PFI-6 PRICER FILE INTERFACE

2.3 Environment Independent
The PFI is not limited to a specific target environment or operating system other than what is required for the
Pricer Server itself. There are no limitations regarding host computers for the PCA and the Pricer Server.
They may be running on the same computer or on two or more different computers. The only prerequisite is
that all PFI files are reachable and can be read and written within any path of a mounted drive or file system
known to the computer where the PFI service is running.

PRICER FILE INTERFACE PFI-7

3 PFI Specification

This section contains:

 PFI Procedures and Communication Method
 PFI File Names

3.1 PFI Procedures and Communication Method

The general PFI procedures and communication method are described in the steps below:
1. The PCA produces the I1 file and puts it into a specific directory. The Pricer Server should have
full access to this directory.
2. The PCA produces the M1 file and copies it to the pre-defined message directory.
3. The Pricer System finds the M1 file and processes the message. The scan interval of the directory is
configurable.
4. The I1 file must be accessible in a location specified in the M1-file at the time when the Pricer
Server reads the M1 file. The Pricer Server first checks that the information provided through the
interface is syntactically and semantically correct. If not, proper error codes are put into the result
file, and the correct records are processed.
5. The Pricer System produces the result file (i.e. of R7 type), and puts it in the position specified in
the M1 file. The generation of the result file occurs when the Pricer server has received and
accepted all information in the PFI message (i.e. the M1 file and the corresponding I1 file). The
Pricer System removes the M1 file. The I1 file can also be optionally removed.
6. As a result of the PFI messages, a send out is initiated to any ESL(s) and/or printing overlays.

PCA

1 2

PFI
I1 M1 R7

4 3 5

Pricer Server
6 6

Pricer labels Paper overlays

Figure 1. PFI Overview.

PFI-8 PRICER FILE INTERFACE

Special Considerations

If more than one M1-file is found in the directory, the Pricer System creates an internal list of the files that
have been found, and starts to process the oldest one (i.e. the system checks the modified date of the file).
When that M1 file has been processed, the next file in the list is read. When the list is processed, the
directory is scanned again.

3.1.1 Message File Formats

Message files are 8 bit ASCII or 2-byte UNICODE files. The system automatically detects which file is
used. Each message file contains only one record.

M1 File

The M1 record consists of information regarding where to find the data file (I1), and where to produce a
result file. The M1 file must be placed in a special directory, serving as a message area (like a mailbox). The
Pricer Server scans this directory and any files present in this directory are processed as M1 files. If more
than one file is found in the message directory at the same time, they are handled in the order they were
created.
M1 record format
 PFI Message
 Sign
 StartPath
 DataPath
 ResultPath
NOTE: A comma is used as a field separator.
The message format is not in free text form. Spaces are valid characters. No “white space” characters (i.e.
space, tab, return) are allowed directly before or after the comma. The message format is always one line.
Four commas are required. An omitted parameter is represented by an empty string, but the commas must
still be there. If the StartPath is omitted, then the format is:
 PFI Message
 Sign
 DataPath
 ResultPath
Data path and result path include the file name with an absolute path.

M1 Record Components

Table 1 M1 record components

Component Length Type Description
PFI Message 1 - 25 AN Mandatory: PFI Message. The PFI
Message command must be in upper case
letters.
Comp. separator 1 Mandatory: Comma (hex 2C).
Sign 4 N Mandatory: A signature used through out
the entire transaction and returned in the

PRICER FILE INTERFACE PFI-9

 Component Length Type Description
result file. It is highly recommended that
this signature is unique for the transaction
to avoid mixing results from different
transactions. Non-numeric values are
reserved for system purposes.
NOTE: Always exactly four digits!
Comp. separator 1 Mandatory: Comma (hex 2C).
StartPath 0 - 80 AN Deprecated component. Leave this empty.
Comp. separator 1 Mandatory: Comma (hex 2C).
DataPath 0 - 80 AN Mandatory: optional or ignored,
depending on the PFI Message. Full path to
the data file (I1).
Comp. separator 1 Mandatory: Comma (hex 2C).
ResultPath 0 - 80 AN Optional: The full path to the result file. If
omitted, the result file is created with a
default path.
NOTE: The creation of the result file can
be optionally switched off in the PFI
configuration file.

Example of a correct update message:

UPDATE,0001,,C:\pricer\PFIFiles\DataFiles\FIL.I1,C:\pricer\PFIFiles\ResultFiles\RESULTFILE
.R7

3.1.2 Data File Formats

Message files are 8 bit ASCII or 2-byte UNICODE files. The system automatically detects which file is
used.
One I1 file may contain 1 - N records, where N is an unlimited number of records.

I1 File

The I1 file is a text file that contains item information formatted in records.
I1 record format:
Sign ItemID [ FieldID Pic |Data| ]... ,
[ Sign ItemID [ FieldID Pic |Data| ]... , ]...

Legend:
[ ] Brackets enclose an optional component or set of components.
… Iteration symbol (0 - N).

I1 record component separators:

The following field separators are valid in I1 files:
Character Value (hex)
Space 20

PFI-10 PRICER FILE INTERFACE

PFI field data enclosure:
Any characters, apart from field separators, record separators and EOF, can enclose the data fields. It is
configured via the file PFIConfigurationParameterProfile.xml. The R3 default data enclosure is the pipe |.
You can only use the separator that is specified in the configuration file. Avoid characters in the interval 00-
1f (hex) or any other character that is likely to appear in item descriptions or other item data.
I1 record separator:
Comma (hex 2C)

I1 Record Components

Table 2 I1 record components

Component Length Type Description
Sign 4 N Mandatory: All non-numerical use of
this field is reserved for system
purposes. This must be the same sign
as in the corresponding M1 file.
Comp. separator 1- Mandatory.
ItemID 1-19 N Mandatory: It contains the item
identity number (e.g. the EAN code.
The ItemID may under certain
circumstances be replaced by a wild
card symbol *.
Comp. separator 1- *) Mandatory.
FieldID 1-4 N *) The PFI field identifier. The first
digit must not be 0.
Comp. separator 1- *) Mandatory.
Pic 1 N This field is not used and should be
set to zero.
Comp. separator 1- *) Mandatory.
Data enclosure 1 *)
Data 0-50 AN *) The value of the PFI field in text
string format (must not contain field
or record separator).
Data enclosure 1 *)
Comp. separator 0- Optional.
Record separator 1 Mandatory.

*) FieldID, Pic and Data together constitute one PFI field. They are optional as a group, but mandatory
within the group, (i.e. if one is present, they all must be present).
The PFI fields are handled by the Pricer Server. The correct fields are processed and inserted into the
database. Fields that are not contained in the configuration are reported in
...\R3Server\logs\BackOfficeLog.txt.
The input stream uses free text format. Any number of blank characters may be present between the different
elements (see the definition of component separators above). It is recommended that the input data file is

PRICER FILE INTERFACE PFI-11

formatted in a readable way since this will simplify debugging. The performance of the system is not
affected by the format of the input data files. All three examples shown below are correctly assembled.
Example 1 (unformatted):
0001 7311540029202 23 0 |00560| 45 0 |01120|,0001 7311540029203 23 0 |01500| 45 0 |06000|
7 0 |Grape Juice|,

Example 2 (formatted):
0001 7311540029202 23 0 |560| 45 0 |1120|,
0001 7311540029203 23 0 |1500| 45 0 |6000| 7 0 |Grape Juice|,

3.1.3 Result File Formats

Message files are 8 bit ASCII or 2-byte UNICODE files. The system automatically detects which file is
used.
The result file contains one record per line. The format of this file can be configured. Creation of the result
file can be optionally switched off.
R7 File
The R7 file format prescribes that a result file is produced for each PFI message file executed by the Pricer
Server. This file contains a status report indicating the success or failure of the corresponding PFI message
file operation. The result file does not include the result of the actual send-out.
The result file is placed in the specified location by the ResultPath in the M1 record, or, if ResultPath is
omitted, at a default location. This is configurable in PFIConfigurationParameterProfile.xml. Default
location and file name is C:\pricer\PFIFiles\ResultFiles\ResultFile.r7.
One record in the R7 file may refer to either:
 The complete PFI message.
 One record in the I1 file.

R7 File Record Components

Component Length Type Description

Sign 4 N Always present. Sign (the same as in the
M1 and I1 files).
ItemID 19 AN Always present. Item identity (as in the
corresponding I1 file). Item identity is
set to 19 spaces (ASCII 20 hex) if the
item id is not relevant for the R7 record.
ResultCode 3 AN Always present. Result code (i.e. E00 if
OK).
Separator 1 Always present. Comma (hex 2C).
CRLF 2 Always present. <CR><LF> (hex 0D
0A). Marks end of record.

PFI-12 PRICER FILE INTERFACE

Example of R7 records:
0001 7310070009401E00
0001 7324568003215E09
0001 E37

NOTE: The difference between the records: The first two records refer to an I1 record, and the fourth to a
complete PFI message.

3.2 PFI File Names

There are no restrictions on how to name the PFI files. The only rule is that the M1 file must be moved or
copied to a directory that is configured for the Pricer Server.
The PFI message server will consider each file found in that directory as an M1 file. The full paths (drive,
directory path and file name) to the I1 and result files are specified within the contents of the M1 file.

PRICER FILE INTERFACE PFI-13

4 PFI Message Specifications

This section covers the PFI messages supported by the Pricer System. The function and syntax for each
message is described in detail. For a complete list of return codes, refer to Appendix B.
This chapter describes the following commands:
 UPDATE
 TARGETLINK
 PRINT
 REFRESH
 SETGLOBAL
 DELETE
 ESLUPDATE

4.1 UPDATE
The UPDATE PFI message is used for item maintenance. This message is mainly used for updating the
information (e.g. the price) on different items. A send out is always performed on all ESLs that do not have
up-to-date information. The result file is normally created when updating the Pricer database and is finished
before the send out is complete.
The behavior of the message can be configured according to the following parameters:

“Unknown item in UPDATE”

Install Adds the item to the Pricer item database.

Report Reports an error in the result file and ignores the
item.
Ignore Ignores the item.

“Reject UPDATE on Unlinked”

True Does not allow an unlinked item to be updated.

False Allows an unlinked item to be updated.
M1 File
PFI Messages: UPDATE
Mandatory M1 parameters: PFI Message, Sign, DataPath
Optional M1 parameters: StartPath, ResultPath
Ignored M1 parameters: None

M1 record examples:
UPDATE,0001,,C:\UPDATE.I1,C:\UPDATE.R7

PFI-14 PRICER FILE INTERFACE

I1 File (for both messages)

All PFI fields can be used, except for those normally used in TARGETLINK (1 and 124).
Field 121 is used to specify the Item Presentation Form for the item, and decides which layout to use for the
send out.
Format of field 121:
121 0 |IPF|
I1 record examples
0001 1111122222333 23 0 |1230| 45 0 |12300| 43 0 |54321| 121 0 |normalprice|,

R7 File

The R7 file contains the result codes.

4.1.1 PFI Timed Updates

Normally the item table is updated immediately after a PFI Update file is found in the message folder. To
delay the update and schedule a future change it is possible to use the system PFI field 9500 for specifying
the date and time for the change to take effect.
Format of field 9500:
9500 0 |Date|
Date format is either yyyy-MM-dd HH:mm:ss or the locale based long format. If an incorrect date format is
detected the error code E64 is returned in the R7 result file, and the I1 record is rejected.
If a past date/time is detected the update will take immediate effect.
I1 record example:
0001 1111122222333 23 0 |1230| 45 0 |12300| 43 0 |54321| 9500 0 |2007-06-06 13:23:00|,

The Timed Update function requires a license key. If the system does not have a valid license key the I1
record is rejected and error code E65 is returned in the R7 result file.

4.2 TARGETLINK
The TARGETLINK message is used for linking and unlinking ESLs to and from items in the Pricer System
database. As the result of a successful linking operation, the ESL is automatically updated with the current
item information. "OFF” is sent to the ESL which is unlinked from its item as a result of a TARGETLINK
message. The TARGETLINK message can specify which subcell OFF is sent. If the subcell is not specified,
OFF is sent in the Back Office subcell or in the last known subcell location. The result file is generated prior
to any send out completion.
NOTE: Items are never deleted from the Pricer database as a consequence of this message.
The behavior of the TARGETLINK message can be configured according to the following parameters:
 “Item must exist”: true/false
If “false”, a link between the ESL and the item is prepared in advance, and fulfilled when the item
is updated in the Pricer server by an UPDATE PFI message.
If “true”, a link between the ESL and a non existing item is rejected.
 “Allow moving PL”: true/false
If “true”, a given ESL that is already linked to another item then the one specified in the I1 record,
will have the old link removed, and a new one created.
If “false”, an already linked ESL cannot be linked to a new item.

PRICER FILE INTERFACE PFI-15

  Report unnecessary unlink”: true/false
If a link that is to be unlinked does not exist, and the parameter is set to true, a special result error
code (E50 instead of E00), is indicated.

M1 File

PFI Message: TARGETLINK

Mandatory M1 parameters: PFI Message, Sign, DataPath
Optional M1 parameters: StartPath, ResultPath
Ignored M1 parameters: None

M1 record example:
TARGETLINK,0001,,C:\TARGLINK.I1,C:\TARGLINK.R7

I1 File

The PFI field 1 is used to specify whether it is a "link" or an "unlink" operation. The PFI field 93 holds the
ESL ID, a 17 character code that is found both as a barcode and in clear text on the back of each ESL. The
PFI field 124 is used to choose a model. The model can be seen as a soft ESL type, not only deciding the
physical ESL type, but also which type of paper overlay to use, and what ESL layouts to use for specific
item presentation forms.
Generic rules:
Mandatory PFI fields: 1
If PFI field 1 is set to”N” (install a new ESL), then ItemID and field 93 are mandatory. The PFI field, 124 is
optional according to the following list:
93, 124 Link an item to ESL, use the model specified in field 124.
93 Link an item to ESL and use a default model for the ESL
type.

Field 9100 (subcell) can be used to specify that an ESL is placed at a certain location in the store.
It is also possible to include the system specific fields 9104 (ESL Location) and 9105 (Facings) in the I1
record.
If the PFI field 1 is set to”D”, (remove a link between an item and an ESL or a group of ESLs) the ItemID or
field 93 may be excluded according to the following lists (the “excluded” ItemID is set to the wild card
character *). Field 124 is never used. Valid combinations if field 1 is set to ”D”:
ItemID Remove the link(s) between ItemID and all its ESLs.
Field 93 is not allowed. All ESLs linked to the item are
deleted.
93 Remove the link between the ESL and the item. The
ItemID is set to „*‟.

NOTE: The ESL ID and Item ID may not be used together. Either use ESL ID with Item ID set to „*‟, or the
Item ID. Field 9100 (subcell) may be used when removing the link between an item and an ESL. It specifies
where OFF is sent.
I1 record examples:
0001 1111122222444 1 0 |N| 93 0 |D4575254697412032| 124 0 |3P-FOOD|,
0001 1111122222555 1 0 |N| 93 0 |D4575254697412032|,
0001 1111122222666 1 0 |D|,
0001 * 1 0 |D| 93 0 |D4575254697412032|,

PFI-16 PRICER FILE INTERFACE

I1 record examples with defined subcells:
0001 1111122222444 1 0 |N| 93 0 |D4575254697412032| 124 0 |3P-FOOD| 9100 0 |Subcell/A02|,
0001 1111122222666 1 0 |D| 9100 0 |Subcell/A02|,,
0001 * 1 0 |D| 93 0 |D4575254697412032| 9100 0 |Subcell/A02|,

I1 record examples with defined ESL Location and Facings:

0001 1111122222444 1 0 |N| 93 0 |D4575254697412032| 124 0 |3P-FOOD| 9100 0 |Subcell/A02|
9104 0 |Row4| 9105 0 |9|,

R7 File

The R7 file contains the result codes.

4.3 PRINT
This PFI Message is used for printing overlays.

M1 File

PFI Message: PRINT

Mandatory M1 parameters: PFI Message, Sign, DataPath
Optional M1 parameters: StartPath, ResultPath
Ignored M1 parameters: None

M1 record example:
PRINT,0001,,C:\PRINT.I1,C:\PRINT.R7

I1 File

The following PFI fields may be used in the I1 file:

 124 - The name of the model.
 77 - The number of overlay copies.
If any of these fields are missing, the default values will be used. The default for field 124 depends on the
ESL. The default for field 77 is 1 and is configurable via the OverlayPrintingOptions.xml file.
I1 record examples:
0001 1111122222441 124 0 |B_MODEL_0| 77 0 |2|,
0001 1111122222442 124 0 |B_MODEL_0 |,
0001 1111122222443,

Result File

The result file contains the result codes.

PRICER FILE INTERFACE PFI-17

4.4 REFRESH
This message is used for creating a send out to all ESLs if the displayed information is not currently up-to-
date because of a change in the item information or the ESL layout. ESLs that do not respond are sent into
roaming.

M1 File

PFI Message REFRESH

Mandatory M1 parameters PFI Message, Sign
Optional M1 parameters StartPath, ResultPath
Ignored M1 parameters DataPath

M1 record example:
REFRESH,0001,,,C:\REFRESH.R7

I1 File

No I1 file is used for this PFI Message.

Result File

The result file contains an E00 if the PFI Message was successfully executed or an E04 if the transmission
failed.

4.5 SETGLOBAL
This message is used for setting the value of global system parameters. It is normally used for currency
handling. Note that you need to send a PFI REFRESH command after the SETGLOBAL command to
trigger a price update.

M1 File

PFI Message SETGLOBAL

Mandatory M1 parameters PFI Message, Sign, DataPath
Optional M1 parameters StartPath, AnswerPath
Ignored M1 parameters None

M1 record example:
SETGLOBAL,0001,,C:\SETGLOB.I1,C:\SETGLOB.R7

I1 File

The following PFI fields are used to specify the parameter name and the associated value in the I1 file:7001,
7002.
The Item ID should be set to the wildcard character (*, hex 2A), indicating that no item is involved in this
operation, PFI field 7001 specifies the name of the system parameter. PFI field 7002 holds the value to be
assigned to the parameter.

PFI-18 PRICER FILE INTERFACE

Mandatory PFI fields: 7001, 7002
I1 record example:
0001 * 7001 0 |CurrencyRate:SEK| 7002 0 |3.5|,

Result File

This file contains the result codes.

4.6 DELETE
The DELETE message is used for deleting items from the Pricer database. If the item is linked to an ESL the
link will be removed. (OFF is sent to the ESL) and the item is deleted.

M1 File

PFI Message: DELETE

Mandatory M1 parameters: PFI Message, Sign, DataPath
Optional M1 parameters: StartPath, ResultPath
Ignored M1 parameters: None

M1 record example:
DELETE,0001,,C:\pricer\PFIFiles\DataFiles\Delete.i1,C:\pricer\PFIFiles\ResultFiles\Delete.
r7

I1 File

No PFI fields are mandatory in the I1 file. The I1 record can include only the sign and item ID or also
include the item fields for the item properties that are used.
Mandatory PFI fields: none
I1 record example:
0001 11111222222344,

Result File

The result file contains the result of the PFI Message File (an R7 code).
 E00
This error is reported when the command is successfully processed.
 E50
This error is reported if the item does not exist in the Pricer database.
R7 record examples:
0001 11111222222344E00

PRICER FILE INTERFACE PFI-19

4.7 ESLUPDATE
The ESLUPDATE message is used for updating ESL properties on individual ESL basis. To use the
command the integrating system must have the knowledge of which ESLs that are linked to which items. For
a transmission to occur, support in the layout script is required.

M1 File

PFI Message: ESLUPDATE

Mandatory M1 parameters: PFI Message, Sign, DataPath
Optional M1 parameters: StartPath, ResultPath
Ignored M1 parameters: None

M1 record example:
ESLUPDATE,0001,,C:\pricer\PFIFiles\DataFiles\Eslupdate.i1,C:\pricer\PFIFiles\ResultFiles\E
slupdate.r7

I1 File

The PFI fields 9104 (location) and 9105 (facings) can be used.
I1 record example:
0001 * 93 0 |A4645160001912138| 9104 0 |Row4|,
0001 * 93 0 |A4645160001912138| 9104 0 |Row4| 9105 0 |2|,

Result File

The result file contains the result of the PFI Message File (an R7 code).
 E00
This error is reported when the command is successfully processed.
 E52
When specified label does not exist in your system.
.
R7 record examples:
0001 * E00
0001 * E52

PFI-20 PRICER FILE INTERFACE

4.8 PFI Configuration
This section lists all the general options and configuration parameters which direct the detailed functionality
of the PFI. Options which are specific to each PFI message are not included in this list. They are specified in
the section for each message.
The implementation of the PFI configuration management is not described in the main text of this document.

4.8.1 PFI Configuration Summary

The PFI is configurable with the:
 Path to message directory
Specifies where PFI should look for M1 files.
 Scan interval
Specifies the number of seconds between each scan of the message directory.
 Delete I1 file
Specifies whether PFI should remove the I1 file when the operation is completed.
 Create result file
Specifies whether the result file should be created or not.
 Delimiter for data fields in the R7 record
Specifies which character to use as a delimiter for the data fields added to each record in the R7
file.
The PFI is configured via the file PFIConfigurationParameterProfile.xml, located in the {Installation
Directory}\Pricer\R3Server\config folder.
<MessageFilePath>D:\Pricer\PFIFiles\MessageFiles</MessageFilePath>

Edit the path of the message file. The R3 server looks for message files in the specified folder. This path is
the same as the path for the Adapter/PCA in the generation of message files.

<DeleteDataFile>false</DeleteDataFile>

Change this tag value to true if the data file is deleted when the operation is finished.

<UseUnicodeResultFile>false</UseUnicodeResultFile>

Change this tag value to true if the result file is required to be in Unicode format.

<ItemPropertyValueDelimeter>|</ItemPropertyValueDelimeter>

Use this tag to configure the delimiter for item property values in a PFI data file.
NOTE: The delimiter specified here has to be used. No other delimiter is valid.

<ReportUnnecessaryUnlink>false</ReportUnnecessaryUnlink>

Set this parameter to true, if the unlink of an ESL which is not linked, is reported in the result file.

<ReportUnknownItems>false</ReportUnknownItems>

This parameter depends on the parameter UnknownItemInUpdate. If UnknownItemInUpdate is set to

„report‟ and „ReportUnknownItem‟ is set to true an unknown item in an update is ignored but the result is
written in the result file.

PRICER FILE INTERFACE PFI-21

<UnknownItemInUpdate>Install</UnknownItemInUpdate>

This parameter controls how to handle unknown items in an update message.

It has three values
1. Install
2. Report (not supported)
3. Ignore (not supported)
At install, the item is inserted in the database and the result is written in the result file. If this parameter is set
to ignore then the item is not inserted into the database and no result is written in the result file. If there is a
report then the item is not inserted into the database. The result is written in the result file.
NOTE: This parameter depends on the parameter „ReportUnknownItems‟.

<RejectUpdateOnUnlinked>false</RejectUpdateOnUnlinked>

Change this tag value to true to reject the update of an item that is not linked to an ESL.

<CreateResultFile>true</CreateResultFile>

When this parameter is set to true a result file is created and placed in a predefined directory.

<DefaultResultFilePath>D:\Pricer\PFIFiles\ResultFiles\ResultFile.r7
</DefaultResultFilePath>

The value of „DefaultResultFilePath‟ tag specifies the default path for the result file. This path is used to
write the error code of any PFI processing if:
 there is some exception in parsing the Message File
 the result file path is specified and the message file is incorrect

<ItemMustExist>true</ItemMustExist>

If an ESL is being linked to an item and the Item Id specified for the link is not present in the Pricer
database, the value of this tag is checked by the R3 Server. If the value is „true‟ the link request is rejected
and then an error code, E50 is written to the result file. If the value is „false‟ then the item is inserted in the
Pricer database with NULL values and the ESL is linked to the item. As a result, the ESL turns blank after
transmission.

AllowMovingPL

If an already linked ESL is linked to a new item, the value of „AllowMovingPL‟ tag handles this scenario. If
this value is „ON‟ then the ESL is unlinked from the old item and linked to the new item. If the value of the
tag is „OFF‟, an error code E60 is written to the result file.
Note that AllowMovingPL is configured in the PLAdvancedConfig.prop file in {Installation
Directory}\Pricer\R3Server\config\advanced folder.

4.8.2 System Parameters for PFI

To support the PFI Delayed Update feature the parameter Item_Delayed_Thread_Time in the
systemparameters table is required. The parameter defines how often the Delayed update table should be
scanned. Default value is 1 second.

PFI-22 PRICER FILE INTERFACE

Appendix A A COMPLETE LIST OF PFI FIELDS

The table below specifies the preferred use of various PFI fields. If a certain field is used for a specific
purpose then troubleshooting the configuration will be easier. However, there are no restrictions about which
number to use (with a few exceptions), or the actual field size. The size of the item table column associated
with a certain PFI field is defined in the database script.
The size and type specifications are mainly recommendations. Size is the number of characters. Any size can
be used. Type N is numerical and type AN is alphanumerical. The item table columns are always
alphanumeric. The use of each PFI field is specified in the layout specification, for each customer.
The PFI fields have three main categories:

Customer specific These fields are specified for a customer as part of the
PFI fields Customer Configuration. The Layout Specification
document specifies what properties to use and how to
use them.
Any unassigned number may be used freely, but it is
recommended to use numbers starting from 300 for
customer specific fields. The actual fields to use can be
configured via Properties.prp (IPF target)
System specific These fields are mandatory, used by the system for the
item fields default report set. These fields should be present,
unless specific reports are developed for the customer.
System specific These fields have special meaning, and are parsed by
(reserved) PFI the system in a pre-defined process. These fields must
fields always follow the recommended procedure.

PRICER FILE INTERFACE PFI-23

System Specific Fields

No Field Size Type Note

1 ESL action 1 AN Used in the TARGETLINK message.
This field is used to indicate the type of operation
that is carried out for an ESL in the Pricer Server
database.
N = Create a link between an ESL and an item.
D = Remove a link between an ESL and an item.
77 Number of labels 3 N The number of overlay copies to be printed, must be
in the 1 – 255 range.
93 ESL id 27 AN Used in the TARGETLINK message.
121 Item presentation form x AN Used in the UPDATE message to choose item
presentation form (IPF).
The syntax is: normalprice
124 Model 50 AN Used in TARGETLINK to specify a model.
7001 System Parameter ID 50 AN Used to identify a global system parameter. The
format is “name of parameter”.
7002 System Parameter Value 50 AN The value to set for the global system parameter.
9100 Subcell 50 AN Used in TARGETLINK to specify a subcell.
The syntax is : subcell/<subcellname>
9104 ESL Location 20 AN This is an ESL property that provides the ESLs
location in the store. Used in ESLUPDATE
message. Optionally, this location can be specified
in TARGETLINK.
9105 Facings 20 AN This is an ESL property that provides the ESLs
facings in the store. Used in ESLUPDATE message.
Optionally, this location can be specified in
TARGETLINK.
9500 Delayed update N/a N/a Date and time for the delayed update to be activated
(VALID_FROM). Accepted formats are either
yyyy-MM-dd HH:mm:ss
or the locale based long format
250 PFI update time N/a N/a Reserved for the Pricer System.
2 Item ID N/a N/a Reserved for the Pricer System.
3 PL Barcode N/a N/a Reserved for the Pricer System.

System Specific Item Fields

No Field Size Type Note

5 Department 4 N Used for a department ID.
6 Item group 6 N Used for an item group ID.
7 Item name 25 AN The name of the item.

PFI-24 PRICER FILE INTERFACE

 No Field Size Type Note
23 Price 8 N Standard price including VAT

NOTE: Used for default reports.

Customer Specific Fields

These fields are specified for a customer as part of the Customer Configuration. The preferred fields are
described to make troubleshooting and maintaining the configuration easier.
No Field Size Type Note
3 Order number 10 N Order number of the item.
4 Item number 15 N Used for a supplier specific item number.
8 Description 25 AN Item description/information (i.e. brand name).
9 Supplier name 15 AN The supplier of the item.
10 Retailer package size 5 N Number of items in a retailer package.
11 Pallet number 5 N Number of retailer packages on each pallet.
12 Unit/Weight 10 AN This is a text field normally used to hold a complete
unit or weight string, e.g.”100g” or ”2 Liters”.
13 Data 5 AN Used freely for POS-specific information.
14 Sales data 8 N Used for sales statistics.
15 Shelf space 5 N Shelf space occupied by the item.
16 Order quantity 5 N Used to indicate the standard order quantity.
17 Order level 5 N Indicates when a new order is created. If the number
of items on the shelf is lower than the order level,
more items should be ordered.
18 Unit factor 5 N Unit factor.
19 Text below unit price 2 N
20 Text below price 2 N
22 Refund code 2 N
23 Price 8 N Standard price including VAT.
24 Purchase price 8 N Retailer purchase price.
25 Discount price 8 N Discount price including VAT.
26 Discount purchase price 8 N Discount retailer purchase price.
27 Discount start date 10 N
28 Discount end date 10 N
29 New price 8 N
30 New purchase price 8 N
31 New price start date 10 N
32 New price end date 10 N
33 Compare price 8 N This field may be used for a comparative price (i.e. the

PRICER FILE INTERFACE PFI-25

 No Field Size Type Note
”standard list price” of the item or the price of a
competitor).
34 Save price 8 N This field is normally used to indicate the difference
between the price and the compare price.
35 Overlay type 1 AN
36 Overlay 5 N
37 Discount price flag 1 N Reserved for backward compatibility reasons
(UPDATE message).
38 Information layout index 1 N Reserved for backward compatibility reasons
(UPDATE message).
39 Item group name 25 AN The name of the item group.
42 Department name 25 AN The name of the department.
43 Information field 1 18 AN This field may be used freely for POS-specific
information.
44 Information field 2 19 AN This field may be used freely for POS-specific
information.
45 Unit price 8 N Unit price. Price per liter or per kg.
46 Discount unit price 8 N Unit price of discount price.
47 Text above discount price 2 N
48 Text above compare price 2 N
49 Text above price 2 N
50 Text above save price 2 N
51 Text above unit price 2 N
52 Bar code 1 N
53 Refund 8 N Numerical refund value.
54 VAT 8 N Numerical VAT value.
60 Segment 1 1 N Specific ESL segment control.
61 Segment 2 1 N Specific ESL segment control.
62 Segment 3 1 N Specific ESL segment control.
63 Segment 4 1 N Specific ESL segment control.
64 Segment 5 1 N Specific ESL segment control.
65 Search no. 2 N PCA specific search code.
66 Total net price 8 N Total net price.
67 Single net price 8 N Single net price.
68 Total gross price 8 N Total gross price.
69 Price excluding VAT 8 N Price with no VAT added.
70 Unit price excluding VAT 8 N Unit price with no VAT added.
71 Unit code 1 AN This field selects a unit for the item.
1 = kg, 2 = hg, 3 = l, 4 = g, 5 = JE, 6 = pcs, 7 = st, 11

PFI-26 PRICER FILE INTERFACE

 No Field Size Type Note
= kg,
12 = Tml, 13 = l, 14 = ml, 15 = m, 16 = st, 17 = g, 18
= hg,
19 = dl, 20 = m2, 21 = UNITE
72 Quality code 1 AN This field selects a quality level for the item.
1 = EXTRA, 2 = I, 3 = II, 4 = III
73 Numeric quality 1 N Numeric quality information (0 - 9).
74 Size code 1 AN This field selects a size for the item.
1 = A, 2 = AA, 3 = AAA, 4 = AAAA, 5 = B, 6 = C, 7
=D
75 Numeric size 2 N Numeric size information (0 - 9).
76 Unit number 3 N Numerical weight/size or number information. One
decimal.
78 Overlay action 1 A
79 Secondary unit code. - - See PFI no. 71.
86 Price_x_refund 8 N A price without a refund value.
87 Uprice_x_refund 8 N The unit price without a refund value.
88 Space_Index 4 N An Index for the best placement on a shelf.
89 Face_now 4 N The number of items currently on a shelf, according to
the space program.
90 Face_proposed 4 N The number of items on a shelf as proposed by the
space program.
91 Empty_Shelf 4 N The number of days before the shelf is empty.
92 Space_date 6 N Last space date.
210 Primary currency id 5 AN The primary currency that will be displayed on the
ESL.
211 Secondary currency id 5 AN The secondary currency that will be displayed on the
ESL.

PRICER FILE INTERFACE PFI-27

PFI-28 PRICER FILE INTERFACE
Appendix B COMPLETE LIST OF R7 RETURN CODES

Legend to "A List of PFI Result Codes"

Legend Description
1 The return code refers to the complete PFI message.
Type
2 The return code refers to one I1 record.
F REFRESH message.
T TARGETLINK message.
U UPDATE message.
Message
P PRINT message.
D DELETE message
S SETGLOBAL message
E ESLUPDATE message
Normal Normal operation.

Severity Warning Operation fulfilled with minor non-fatal problems.

Error Operation failed, but the system continues to work
normally.
Fatal Fatal error, the system is degraded or non-operating.

List of PFI Result Codes

Error Code Type Message Severity Description

E00 12 TUFPDSE Normal Operation OK.

E01 -2 -U----- Error/Warning The item has no ESL linked to it.

E04 -2 --F---- Warning Transmission failed.

E08 -2 TU-PDSE Error Signature mismatch between M1 file and record in

I1 file.

E19 1- TU-PDSE Warning The I1 file was empty.

PRICER FILE INTERFACE PFI-29

 Error Code Type Message Severity Description

E21 1- TUFPDSE Error PFI processing interrupted. This error code is

present if the server was shut down in the middle
of a PFI job. The message file will be processed
again the next time the server is started.

E25 1- TU-PDSE Fatal I1 file could not be opened.

E27 1- TUFPDSE Error The result file could not be created at the position
specified in M1. A result file is created at the
default position.

E29 1- TUFPDSE Error Unknown PFI message.

E36 12 TUFPDSE Error Syntax error in M1 file or I1 file.

E37 12 TUFPDSE Error Semantic error in M1 file or I1 file. (Including

"unknown ESL type".)

E39 -2 T------ Error TARGETLINK failed.

E41 -2 -----S- Error System parameter not defined.

E50 -2 TU-PD-- Error Unknown item. I1 record is rejected.

E51 -2 T------ Warning Unknown item. I1 record is handled.

E52 -2 ------E Error Unknown ESL. I1 record is rejected.

E54 -2 T--P--- Error Unknown model. I1 record is rejected.

E56 -2 ---P--- Error Overlay could not be found.

E60 -2 T------ Error ESL is already linked to another item. I1 record is

rejected.

E61 -2 T------ Warning ESL is already linked to another item. I1 record is

handled.

E62 -2 T------ Warning SUBCELL_INPUT_CHANGED_DEFAULT

This means that the subcell specified in PFI file is
changed due to some reason. The transmission
will occur in default subcell.

E63 1- T------ Error SUBCELL_TABLE_NULL

This means that there is no subcell configured, so
transmission has failed.

E64 -2 -U----- Error Date/time format in PFI field 9500 is incorrect. I1

record is rejected.

E65 -2 -U----- Error No license for Timed Updates. I1 record is

rejected.

E66 -2 -U----- Warning Item was updated but one or more item properties
were truncated because it was too long for its
database column.
This return code has been removed. Instead a
log messages is written when truncation has
occurred.

PFI-30 PRICER FILE INTERFACE

Appendix C R 2.4 COMPATIBILITY ISSUES

PFI Backward Compatibility Summary

List of Obsolete PFI Messages

The following available commands are available in R2.4 but not supported in R3.
 ITEMREAD
 PLREAD
 DBWRITE

TARGETLINK

The targetlink message in R3 has support to add the ESL properties ESL Location (field 9104) and Facings
(field 9105). Two new error codes; E62 and E63 are added for subcell handling.

UPDATE

R3 does not support the following options for “unknown” item in UPDATE.

R3 does not support IPF (ItemPresentationForm) per ESL page on the format:
121 0 |priceIPF:infoIPF:overlayIPF|

And the equivalent to specifying fields 201, 202, and 203.

The IPF pointed out in R3 selects IPF for ESL on the format:
121 0 |IPF|

PRINT

No changes are made in the print message.

DELETE

Item DELETE is a new command in R3 as compared to R2.4. Items are deleted from the Pricer database by
this command.

Message File Format

The R3 Pricer System does not support to execute a “follow-up” program (as could be specified in the R2.4
M1 file). The format of the message file should always include two commas after the signature:
UPDATE,0001,,C:\pricer\PFIFiles\...

PRICER FILE INTERFACE PFI-31

Data File Format

The default data enclosure in R2.4 is a quotation mark (“), where as R3 has pipe (|). In R3 you can only use
the separator that is specified in the configuration in PFIConfigurationParameterProfile.xml.
The PFI fields are handled by the Pricer Server; if a field is not in the configuration then it goes into a log
file. The correct fields are processed and inserted into the database. The log file is generated in
C:\pricer\R3Server\logs\BackOfficeLog.txt. In R2.4, values that are not handled are ignored.

Result File Format

 A transmission result file and semaphore file was used in R 2.4, is not supported in R3.
 The condensed format of the result file, called R8 in R2.4 is not supported in R3.
 In R3 you cannot get one record per ESL page which was possible in R2.4. Consequently, the result
file components ESL page (indicates which ESL page the record is referring to in R2.4) is not
supported in R3.
 The PFI field report format (where the record can include a list of PFI fields) is not supported by
R3.

Miscellaneous

 “Last way out files” including target link and update files, as used in R2.4 recovery situations, are
not automatically created when the Pricer Server is shut down. R3 contains scripts for creating the
files.
 The Pricer Server first checks that the information provided through the interface is syntactically
and semantically correct. If not, the correct error codes are put into the result file. In R2.4 nothing
in the I1 file is processed, not even any correct parts. In R3 correct records are processed.
 The R3 Pricer System does not support to execute a “follow-up” program (which can be specified
in the R2.4 M1 file).
 Error code E18 are not used any longer. Instead E54 is used for all errors related to “Unknown
model”.

Configuration needed to get R2.4 Functionality

The R3 PFI configuration is created via the file PFIConfigurationParameterProfile.xml. The parameters to
configure this file are the same as R2.4.

PFI-32 PRICER FILE INTERFACE

Index

C PFI Delayed Updates, 15

Communication Interface, 6 PFI field data enclosure, 11
Comp. separator, 9 PFI File Names, 13
Create result file, 21 PFI Message, 9
Customer Specific Fields, 25 PFI Message Specifications, 14
Customer specific PFI fields, 23 PFI Overview, 6
D PFI Procedures and Communication Method, 8
Data, 11 PFI RESULT CODES, 29
Data File Formats, 10 PFI Specification, 8
DataPath, 9, 10 Pic, 11
DELETE, 19 PRINT, 17
Delete I1 file, 21 R
Delimiter for data fields in the R7 record, 21 R7 File, 12, 15
E REFRESH, 18
Environment Independent, 7 Reject UPDATE on Unlinked, 14
F Release Specific Fields, 24
FieldID, 11 Release specific PFI fields, 23
I Result File, 18
I1 file, 6 Result File Formats, 12
I1 File, 10, 18 ResultCode, 12
I1 File (for both messages), 15 ResultPath, 9, 10
I1 record component separator, 10 S
I1 Record Components, 11 Scan interval, 21
I1 record separator, 11 Separator, 12
ItemID, 11 SETGLOBAL, 18
L Sign, 9
List of Obsolete PFI Messages, 31 Special Considerations, 9
M StartPath, 9, 10
M1 File, 9 System specific (reserved) PFI fields., 23
M1 Record Components, 9 System Specific Fields, General, 24
M1file, 6 T
Message File Formats, 9 Target Audience, 4
P TARGETLINK, 15
Path to message directory, 21 Text Files, 6
PFI Backward Compatibility Summary, 31 U
PFI Configuration, 21 Unknown item in UPDATE, 14
PFI Configuration Summary, 21 UPDATE, 14

PRICER FILE INTERFACE PFI-33

 Pricer File Interface

R3 / English

PFI-34 PRICER FILE INTERFACE