10/3/2019

Electronic File Manager: Format

De nition Overview
Generated on: 2019-10-03

SAP Business One | 9.3

PUBLIC

Warning

This document has been generated from the SAP Help Portal and is an incomplete version of the official SAP product
documentation. The information included in custom documentation may not re ect the arrangement of topics in the SAP Help
Portal, and may be missing important aspects and/or correlations to other topics. For this reason, it is not for productive use.

For more information, please visit the SAP Help Portal.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da370… 1/66
10/3/2019

Electronic File Manager: Format De nition

Overview
Electronic File Manager: Format De nition (EFM) is an SAP Business One add-on used to design various electronic le format
projects. A format project maps input to output between different formats, and each project itself is saved into a single format le.

Overview of Different Format Projects

The following table is an overview of different format projects:

Format Project Abbreviation Source File Target File Embedded File Supports Supports User
Format Format Translation Script

Generic GEP RPT XML, CSV, TXT, None Yes Yes

Electronic File XBRL, JSON
Format Project

Bank Payment BPP RPT XML, CSV, TXT, An RPT Payment Yes Yes
File Format JSON Wizard Results
Project source le

Bank Statement BFP XML, TXT XML, JSON An XML Bank No Yes
File Format Statement target
Project le

Special-Purpose SPP XML XML, CSV, TXT, An XML source le No Yes

File Format XBRL, JSON for each subtype:
Project
Electronic
Document

Electronic
Authority
Report

For more information about the usage of each format project in relation to SAP Business One, see Usage of Format Projects in SAP
Business One.

Features
With its user-friendly interface and advanced functions for designing simple or complex electronic format solutions, the Electronic
File Manager: Format De nition add-on provides the following features:

A exible approach to importing or manually creating source or target les:

Tree structures to present the source or target le formats

Mapping settings to create mapping rules between source and target les

Customized views to display format trees

Validation settings to embed runtime validation parameters into format projects

Format veri cation to verify mapping settings, validation settings, and so on

Test runs to simulate runtime format project execution with sample data or external data

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da370… 2/66
10/3/2019

More Information
Usage of Format Projects in SAP Business One

How to Create a File Format Project

Electronic File Manager: Format De nition Window

Usage of Format Projects in SAP Business

One
Depending on their usages in SAP Business One, different format projects may or may not provide embedded source or target
les; the source and target le formats may also vary.

The following table summarizes the usage of each format project in the SAP Business One client application:

Format Where to Import the Format Project Where to Use

Project

GEP Electronic File Manager window According to the de nition in the format project, a menu entry
is created for a wizard.
SPP

BPP File Formats - Setup window Payment wizard - step 8

Prerequisites:

You have installed the Payment Engine add-on.

The payment means for at least one transaction is

bank transfer.

BFP Bank statement processing (BSP)

For more information about the various windows and functions where these format projects are used, see the online help of SAP
Business One.

GEP and SPP Format Projects

Among the four format projects, the GEP and SPP format projects support the same output formats and their usages are also
similar in the SAP Business One client application: After you import a GEP or an SPP format project into SAP Business One, a
menu entry is created for a corresponding wizard. You can then run the wizard to specify selection criteria and generate output
les.

Note
The selection criteria depend on the parameters de ned in the source RPT les.

SQL syntaxes differ between the Microsoft SQL Server and the SAP HANA database. If you want to reuse a format project, be
sure to make necessary adjustments to the commands in the source les.

These two format projects allow XBRL (eXtensible Business Reporting Language) as the target format. XBRL is a widely used
standard for nancial reporting and exchange of business information. After importing the project into SAP Business One, you can
produce XBRL instance documents based on SAP Business One data.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da370… 3/66
10/3/2019
BPP and BFP Format Projects

The other two format projects - the BPP and BFP format projects - are two sides of the same coin. The BPP format project is used
to export payment data from SAP Business One to a payment le (bank le) using the payment wizard in conjunction with the
Payment Engine add-on. When the bank receives the payment le, the bank makes payments accordingly to your suppliers and
reconciles the incoming payments. The bank issues a bank statement to you on a regular basis, which includes the bank transfer
details.

The BFP format project is then used to import the bank statement into SAP Business One using the bank statement processing
(BSP) function. Documents are reconciled with the bank statement and payment documents are created to clear unreconciled
transactions - transactions without payment information in the system; the transactions may or may not have been paid by the
bank.

Recommendation
Execute payment order runs instead of executing payment runs directly. While a payment run creates both a payment le (or
several les, based on the settings) and payment documents, a payment order run creates only a payment le. By executing a
payment order run and then reconciling the bank statement with transactions included in the order run, you can ensure that
the system records only payments that have actually been made by the bank.

The usages of the BPP and BFP format projects are illustrated in the following graph:

More Information
https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da370… 4/66
10/3/2019
Electronic File Manager: Format De nition Overview

How to Create a File Format Project

How to Create a File Format Project

Prerequisites
You have drawn up a design speci cation or understand the design speci cation well.

To create advanced mapping rules, you have learned and can work with the XSLT (Extensible Stylesheet Language
Transformation) language and regular expressions.

EFM supports XSLT version 1.0.

[BFP] To create a BFP format project with TXT sources, you have learned and can work with regular expressions in
Microsoft .NET Framework.

Procedure
To create a format project, proceed as follows:

1. Create a blank format project.

For more information, see Step 1: Creating a Blank Format Project.

2. Add one or more source les and one target le.

For more information, see Step 2: Adding Source and Target Files.

3. De ne the source and target tree structures. For more information, see Step 3: De ning the Source and Target Tree
Structures.

4. Map between the source and target trees.

For more information, see Step 4: Mapping Between the Source and Target Trees.

5. De ne validation rules for the runtime. For more information, see Step 5: Creating Validation Rules for the Runtime.

6. Test run each mapping. If the test run fails, correct the issues.

For more information, see Step 6: Test Running a Format Project.

7. Save the format.

For more information, see Step 7: Saving a Format Project.

More Information
Electronic File Manager: Format De nition Overview

Usage of Format Projects in SAP Business One

Step 1: Creating a Blank Format Project

Prerequisites
https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da370… 5/66
10/3/2019
You have prepared the source or target les, if necessary. For more information, see Preparing Source and Target Files.

You have started the Electronic File Manager: Format De nition add-on. For information about how to install, assign, and
start an add-on, see the online help of SAP Business One.

Procedure
1. To open the Electronic File Manager: Format De nition (EFM) add-on, in the SAP Business One menu bar, choose
Tools Electronic File Manager: Format De nition .

2. To create a new format project, do one of the following:

On the start page, under Create a new format project, choose the format project you want to create.

Click in the toolbar, or choose File New from the menu bar.

a. In the Create a New Format window, select the format project you want to create.

b. Specify the format name.

c. Specify the storage location.

d. Choose the OK button.

For information on the usages of different format projects, see Usage of Format Projects in SAP Business One.

3. If you chose to create a BFP format project, you are prompted to select whether to work in the new designer or the old
designer.

New designer: You will continue to work in the Electronic File Manager: Format De nition window. The new
designer lets you create BFP format projects with XML as well as TXT source les. Some enhancements and bug
xes are available only in the new designer.

Old designer: A new SAP Business One Format De nition window opens for you to design the BFP format project.
The old designer is targeted only for TXT source les.

For more information about the old designer, see its online help. To open the online help, in the SAP Business One
Format De nition window, press F1 or choose Help Online Help .

If you chose to create an SPP format project, select a format subtype and then choose the OK button.

Results
A default mapping is created, with embedded les (if any).

Recommendation
During your design process, save the format project from time to time to prevent data loss. For more information, see Saving a
Format Project

Related Information
How to Create a File Format Project
Usage of Format Projects in SAP Business One
Updating Source or Target Files
Creating an XBRL Target Tree

Preparing Source and Target Files

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da370… 6/66
10/3/2019
Before creating a format project, you must prepare the necessary source and target les.

Preparing Source Files

Among the four types of format projects, it is mandatory to prepare source les for the GEP format projects. For the other types of
format projects, preparation of source les is only required in some cases.

GEP Format Projects

For a GEP format project, you must manually create one or more source les. Each source le must be an RPT le (Crystal report)
which uses the SAP Business One data source.

Each GEP format project is presented as a wizard after it is imported into the SAP Business One client. The welcome page and the
last two steps of this wizard are prede ned; the other steps contain parameters requiring user input and which are determined by
the source RPT le. If you want to group the parameters into several steps, create one source RPT le for each step; or you can
create sub-reports within the main report to achieve the same effect.

For more information about how to create such a Crystal report, search for the following resources at SAP Help Portal:

"How to Work with Crystal Reports in SAP Business One"

[SAP HANA version only] "How to Set Up SAP Business One, version for SAP HANA Data Sources for Crystal Reports"

SPP Format Projects

The SPP format project has two subtypes, each of which provides an embedded source XML le.

If the localization of your company supports electronic documents, you can obtain an updated source le in the SAP Business One
client. To do so, in the SAP Business One client menu bar, choose Tools Customization Tools Generate EFM XML Datasource .

The regenerated data source tables vary from localization to localization and include user-de ned elds as well as system elds.
The data source also contains information of the imported certi cate covering a digital seal of the issuing taxpayer. For more
information, see the how-to guide "How to Implement and Use Electronic Documents with SAP Business One" at SAP Help Portal.

BPP Format Projects

The BPP format project provides an embedded source RPT le (Crystal report), which includes SAP Business One database tables
deemed necessary for creating the payment le to be sent to your bank. However, if you want to include data in your user-de ned
elds in the payment le, you must do either of the following:

Create one or more additional RPT les and add them as new source les.

Save the embedded source le to a local device, update the RPT le in SAP Crystal Reports, and then update the original
source le with the new le.

BFP Format Projects

If the bank statement issued by your bank is in the XML format, you can ask your bank for an example XML document or the XML
schema. Otherwise, you need to manually create a source tree in either the TXT or the XML format.

Preparing Target Files

Except for BFP format projects, all format projects support various target formats. The BFP format project provides an embedded
target XML le which you cannot delete or update. For the other three format projects, the need to prepare a target le depends
on the required target format, as below:

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da370… 7/66
10/3/2019
XBRL: It is mandatory for you to prepare a taxonomy resource. The resource can be either an XML document or XML
schema, or it can be a URL to the schema.

XML: You can import either the XML schema or the structure directly from an XML document, but you can also create the
structure from scratch.

CSV: You can either import the structure from a CSV document, or create it from scratch.

TXT: You must create the structure from scratch.

More Information
How to Create a File Format Project

Updating Source or Target Files

Updating Source or Target Files

Context
You can update source les or target les while retaining mapping connections and mapping settings between the source format
tree and the target format tree.

Note
You can update only XML and XBRL target les.

Procedure
1. Do one of the following:

Right-click the source le under the Source folder and choose Update....

Right-click the target le under the Target folder and choose Update....

2. Select the new source or target le and choose the Open button.

The new source or target le is added under the Source folder or the Target folder, respectively. Its format tree is
automatically added to the mapping tab with an automatic mapping switch:

If the node in the original format nds a matching node in the new format tree, the mapping connection and
mapping setting are switched to the new format tree. Depending on the le format, there are different matching
rules; the match can succeed only if the rules are met, as explained below:

RPT:

RPT eld: A eld with the same object name exists in the new format tree.

RPT section: The section in the same position of the new format tree has the same elds.

XML: In the new format tree, the node with the same tag name and namespace is found in the same path,
and each node in the path has the same tag name and namespace.

XBRL:

Unit: A unit with the same name exists in the new format tree.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da370… 8/66
10/3/2019
Context: A context with the same name exists in the new format tree. The match will also apply to the
period and the scenario in this context.

Item and entity: An item or entity with the same name exists in the same context in the new format
tree.

Tuple: A tuple with the same name exists in the new format tree. The match will also apply to the
subnodes.

If no matching node is found, the mapping connection and the mapping settings are retained in the original format
tree. You can manually adjust the mapping connection and settings.

After update, the mapping status messages are displayed with the following detailed information on the Message tab:

Amount of successfully switched mappings

Amount of lost mappings

Detailed information of lost mappings in the following format:

Source Node Target Node Formula

<XML Name> <XML Name> of <Target Name> <Value Formula>

3. After completing the mapping switch, remove the original source le or target le from the Format Explorer area. After you
delete the original les, the corresponding format trees are removed automatically from the mapping tab.

Related Information
How to Create a File Format Project
Preparing Source and Target Files

Creating an XBRL Target Tree

Prerequisites
You have created a GEP or SPP format project. For more information, see Creating a Blank Format Project.

Context
XBRL (eXtensible Business Reporting Language) is a widely used standard for nancial reporting and exchange of business
information. A report expressed in XBRL is an XBRL instance document and must conform to a particular taxonomy created and
published by the reporting authority. With EFM, you can create GEP or SPP format projects with XBRL as the target format. After
importing the project into SAP Business One, you can produce XBRL instance documents based on SAP Business One data .

Procedure
1. In the Format Explorer, right-click the Target folder, choose Add, and then select XBRL.

2. In the XBRL Taxonomy Selection window, specify one or more taxonomy resources and then choose the Add button. The
schema resource can be either a le (XSD le for a schema or XML le for a linkbase) or a URL link.

Note
If you specify an XBRL linkbase, the linkbase must reference one or more taxonomy schemas. Otherwise, you cannot
create required nodes.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da370… 9/66
10/3/2019
The taxonomy resource is displayed in the lower pane.

3. To add more taxonomy resources, repeat step 2.

4. If you want to use only some of the resources, in the pane below, select the particular resources.

5. Choose the OK button.

Results
A target tree structure is created with default nodes, and schema information is loaded.

You now can continue to add nodes to the target tree and de ne the properties. For more information, see De ning the Source and
Target File Structures and Properties.

To add more schemas, in the target tree, right-click the Schema References node and choose Add Schema Reference. To add
more linkbases, do likewise with the Linkbase References node.

Step 2: Adding Source and Target Files

A mapping requires one or more sources and one target.

Depending on the format project, supported formats for the source and the target may differ, as summarized in Electronic File
Manager: Format De nition Overview.

Prerequisites
If necessary, you have prepared the source and target les. For more information, see Preparing Source and Target Files.

You have created or opened a format project. For more information, see Creating a Blank Format Project.

Procedure
To add a source le for the format project, in the format explorer, right-click the Source folder and then choose Add; to add a
target le, right-click the Target folder and then choose Add.

As only one target is allowed, if a default target le has already been loaded, you can either update it with a new le or delete it and
then add a new le.

For the BFP format project, the target le is embedded; you can neither delete nor update the embedded target le.

Depending on the format, you may be able to import a le structure directly, import a le with the required structure, or create the
structure manually.

Note
If you want to test run the format project using the data in a source RPT le, you must ensure that the RPT le has been saved
with data. For more information, see the SAP Crystal Reports online help.

For the XBRL format, you must specify a taxonomy schema. For more information, see Creating an XBRL Target Tree.

Result

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 10/66
10/3/2019
If you import a le or a le structure, the le structure is presented as a tree structure on the mapping tab. If you manually create a
structure, a blank tree structure is created with only the root element.

An RPT le is imported based on the following rules:

Report Section Imported or Ignored

Report Header Imported, unless hidden or suppressed in the report. Note that only
elds are imported and displayed as a tree node; the other objects
Report Footer (for example, text, charts) are ignored.

Details

Group Header

Group Footer

Page Header Ignored

Pager Footer

You can now proceed to de ne the source and target tree structures. For more information, see De ning the Source and Target File
Structures and Properties.

More Information
How to Create a File Format Project

Step 3: De ning the Source and Target File

Structures and Properties
Before mapping between source and target les, you must de ne the structure of each le: nodes (for example, section, eld),
sequence of nodes, relationship between each node. In addition, you need to de ne the properties of the format project, the
mapping, the source and target les, and the individual nodes.

Note
You cannot modify the structures of embedded les.

Prerequisites
You have added the source and target les in the required formats. For more information, see Step 3: Adding Source and
Target Files.

You have a speci cation at hand and know how the source or target le is structured. For example, to create a BPP format
project, you must know your bank's requirements for the payment le structure (for example, how the transactions are
grouped).

Procedure
You can de ne the properties of nodes after you have created the whole structure, or you can de ne the property of each node
immediately after you create the node. The following procedure provides all the necessary steps.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 11/66
10/3/2019
1. If you created the source or target le from scratch (for example, the le format is TXT), add nodes under the root node in
the appropriate sequence and structure. If you imported a le or a le structure, you can also modify the existing structure.

For more information about the nodes for different formats, see Nodes in Different File Structures.

2. De ne the properties of the following:

The format project: For example, specify the menu path for a GEP format project after it is imported into SAP
Business One.

The mapping: For GEP and SPP format projects, you can provide a Javascript or CSharp script to handle heavy
calculations or loop functions.

Each source le: For example, de ne the encoding of an XML source le.

The target le: For example, de ne encoding of an XBRL target le.

For example, to de ne the properties of the format project, in the format explorer, choose Format and then in the
Properties area, de ne the properties of the format project.

3. De ne the properties of individual nodes.

For more information about the properties, see Properties.

Result
You can now proceed to map between the source les and the target le. For more information, see Step 4: Mapping Between the
Source and Target Trees.

More Information
How to Create a File Format Project

Working with Nodes

Nodes in Different File Structures

EFM presents the structure of each source or target le in a tree. Depending on the le format, the tree structure has different
types of nodes and different rules. The following sections provide descriptions of the nodes in different le structures. Note that
the RPT le structure is not discussed here because it cannot be created or modi ed in EFM.

XML

The following table describes the available nodes in an XML tree structure:

Node Type Description Remarks

Element Simple element, used to describe data; cannot have child Cannot contain child nodes. Must be nested within an order
elements or attributes. indicator node.

Element Complex element, used to describe data; can have child /

(Container) elements and attributes.

Attribute Used to provide additional information that is not relevant Cannot contain child nodes.
to the data.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 12/66
10/3/2019

Node Type Description Remarks

All An order indicator which speci es that the child elements These nodes are exclusive of each other.
can appear in any order.

Choice An order indicator which speci es that there are only two
child elements and either this or that child element can
occur at one time.

Sequence An order indicator which speci es that the child elements

must appear in the speci ed order.

All, Choice, and Sequence nodes specify the order of the child elements of a parent element. To create child elements (whether
they be elements or element containers), you must rst indicate their order by creating an order indicator node.

CSV

The following table describes the available nodes in a CSV tree structure:

Node Type Description

Header Column title.

Field Column eld.

TXT

The following table describes the available nodes in a TXT tree structure:

Node Type Description

Segment Group A section containing elds and other subsections (standard

segments).

Standard Segment A section containing elds.

Field A eld containing meaningful data.

XBRL

The following table describes the available nodes in an XBRL tree structure:

XBRL-Speci c XML Node Description

XBRL Instance Root node. Parent node of all other nodes.

Containing schema references.

Schema References

Schema Reference Containing various schemas.

An XBRL taxonomy schema de nes the IDs, names, and other properties of various elements. Each
XBRL instance document requires a taxonomy schema to recognize and understand the elements.

Linkbase References Containing linkbase references.

Linkbase Reference Containing various linkbases.

An XBRL taxonomy linkbase de nes the relationship between XBRL taxonomy elements. Note that if
you specify only a taxonomy linkbase for the format project, you must ensure that the linkbase
references the required schema. Otherwise, you cannot de ne the XBRL elements.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 13/66
10/3/2019

XBRL-Speci c XML Node Description

Units Containing units of measure that are used within an XBRL document.

Unit Measures a value.

Measure A simple unit of measure. For example, "USD", "shares", or "million pounds".

Divisional Measure A complex unit of measure that is represented in a divisional form. For example, "earnings (value) in
USD (numerator) per share (denominator)".

Numerator The numerator of a divisional measure.

Denominator The denominator of a divisional measure.

Contexts Contains one Entity node and multiple Context nodes.

Entity The entity that does the XBRL reporting, for example, a company or a division thereof.

Identi er A code that speci es the scheme identifying the XBRL reporting entity.

Identi cation Scheme A required attribute that is used to identify the XBRL reporting entity. For example,
www.example.com.

Context De nes the background of one or more business concepts (for example, gross pro t): the period type
and the scenario (usually optional). A concept that is placed in a context is a fact, expressed either as
an item or a tuple.

Note
If you add an XBRL fact directly under a Context node (by adding an Item or Presentation Tree
node), this fact is placed in this particular context and you cannot specify a different context for the
fact.

Period Contexts can be any of the following period types:

Duration: A speci ed period of time (for example, for change of capital over the year 2015).

Instant: A speci ed point in time (for example, for an asset value on 2015.1.1).

Forever: No de nite time frames (for example, for tax codes).

Scenario De nes some additional information that is usually optional.

Presentation Tree Various XBRL facts are presented in a tree structure according to a speci ed presentation linkbase
which de nes the relationship between these facts.

Item A simple XBRL fact with a de nite value which does not have to be derived from other element values.

Tuples Contains various tuples.

Tuple Contains various items which derive their meaning and value from each other.

Depending on the parent node, you can add only restricted types of child nodes. The child nodes may be XBRL-speci c XML nodes
or regular XML nodes. The following graph illustrates the relationship map of the nodes in an XBRL tree structure:

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 14/66
10/3/2019

Note 1: The light-colored nodes are XML nodes, (see the section above about XML nodes). The dark-colored nodes are XBRL-
speci c XML nodes.

Note 2: You can de ne attributes for certain nodes but this relationship map does not include attribute nodes.

Note 3: Nodes with an asterisk (*) must be added manually.

More Information
Step 3: De ning the Source and Target File Structures and Prope

Working with Nodes

Working with Nodes

Procedure
Adding a Node

1. Select the parent node below which you want to create a node.

2. Right-click and choose one of the adding options.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 15/66
10/3/2019

Note
For the XML format, you can add both technical nodes and non technical nodes.

3. Specify the properties for the node.

Copying/Cutting and Pasting a Node

1. Select the node that you want to copy/cut.

2. Right-click and choose Copy/ Cut.

3. Right-click the node below which you want to paste and choose Paste.

Note
You cannot paste a node to a leaf node.

4. Specify the properties for the node.

Deleting a Node

1. Select the node that you want to delete.

2. Right-click and choose Delete.

If you delete a node with child nodes, all the child nodes are automatically deleted.

Duplicating a Node

1. Select the node that you want to duplicate.

2. Right-click and choose Duplicate.

A duplicated node is added to the same structure level of the format tree. If you duplicate a node with child nodes, all the
child nodes are automatically duplicated.

The name of the duplicated node is the original node name suffixed with "(n)". ("n" is the duplication number of the node.)
For example, Balance(1) is the name of the rst duplicated node for the node: Balance. Balance(2) is the name of the
second duplicated node for the node: Balance, and so on.

Removing Duplicated Nodes

You have two options for removing the duplicated nodes of an original node:

Removing one duplicated node:

1. Select the duplicated node that you want to remove.

2. Right-click and choose Remove Duplicate.

The selected duplicated node is removed.

Removing all the duplicated nodes

1. Select the source node that you have duplicated.

2. Right-click and choose Remove All Duplicate.

All the duplicated nodes are removed.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 16/66
10/3/2019

More Information
Properties

Step 4: Mapping Between the Source and

Target Trees
You can map between the source format tree and the target format tree by creating connections and mapping rules for each node.

You can create a connection by dragging a line from a node in the source format tree (source node) and dropping it on the node in
the target format tree (target node). You can map more than one source node to a target node and move connections to other
source nodes or target nodes.

Mapping rules that you specify on the Mapping Setting tab determine the value output in the runtime execution. For each
mapping setting, you can specify one or multiple conditions and one "else" condition. For multiple conditions, the rst condition is
checked rst; if the rst condition is not met, the second condition is checked; and the check continues until one condition is met
or if no condition is met, the "else" condition determines the value output.

Prerequisites
You have de ned the source and target tree structures. For more information, see De ning the Source and Target Tree Structures.

Procedure
Mapping a Source Node to a Target Node

1. Click the node in the source format tree.

2. Drag and drop on the node to which you want to map in the target format tree. A connection line is created and the
Mapping Setting tab is enabled for the connection.

To create mapping settings for a target node that is not required to be directly mapped to any source node, right-click the
target node and choose Mapping Setting.

3. To add a condition, choose .

To remove a condition, choose .

4. To change the condition name, choose the Rename eld and specify the new name.

5. To specify details of a condition, specify one or multiple expressions and value output if the condition is met.

a. Specify expressions for the condition:

You can create multiple expressions by connecting them with logical operators and braces in a tree structure, for
example, expression 1 and (expression 2 or expression 3).

To add an expression, select the condition in the expression tree, choose , and choose Row.

To change the expression name, choose Rename.

Specify the following elds for the expression:

Type1: Select the type of the rst argument.

Arg1: Specify the rst argument.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 17/66
10/3/2019
Op: Select the operator.

Type2: Select the type of the second argument.

Arg2: Specify the second argument.

For arguments as the function type, you can specify functions. For more information, see Using Functions.

To add a brace ("()"), select the condition in the expression tree and choose .

The brace determines the priorities of processing expressions for a condition. The expressions in the brace
have a higher priority. Under a brace, you can add expressions, braces, and logical operators by selecting the
brace and choosing .

To add a logical operator, choose the condition in the expression tree and choose .

You can add And and Or operators to connect expressions.

To remove an expression, brace, or logical operator, select it and choose .

b. Specify the value output, if the condition is met.

Copy Value From Source Node: Uses the value from the source node.

Constant Value: Specify a constant value.

Function: Specify a function that generates a value.

You can specify complex functions with arguments as the results of other expressions. For more information,
see Using Functions.

No Value: No value is outputted.

6. To specify the value output if one condition is not met, select the Else Condition checkbox and specify the value.

7. To move the connection line to another node, click the connection line and do one of the following:

From an original source node to a new source node: click the source end of the connection line on the source format
tree and drag the line to the new source node.

From an original target node to a new target node: click the target end of the connection line on the target format
tree and drag the line to the new target node.

8. To map another source node to a target node that is already mapped, do the following:

a. Click another source node and drag and drop it on the target node.

b. In the message window that appears, choose the Duplicate Node button. Another connection line is created from
the source node to the target node.

To replace the original connection, choose the Replace Connection button. The new connection line from the new
source node to the target node replaces the original connection line.

Displaying Mapping Settings

To display the mapping setting for a target node, right-click a target node and choose Mapping Setting.

Clearing Mapping Settings

Right-click the target node from which you want to clear the mapping settings and choose Clear Mapping Setting.

Copying and Pasting Mapping Settings

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 18/66
10/3/2019
1. Click the connection line of the mapping settings you want to copy and choose Copy Mapping Settings.

2. Click the connection line of the mapping settings you want to paste and choose Paste Mapping Settings.

Cutting and Pasting Mapping Settings

1. Click the connection line of the mapping settings you want to cut and choose Cut Mapping Settings.

2. Click the connection line of the mapping settings you want to paste and choose Paste Mapping Settings.

Deleting Mapping Settings

Select the connection line you want to delete and do one of the following:

Press the Delete key.

Right-click and choose Delete.

Both the connection line and the mapping settings are deleted.

More Information
Functions

BFP: Validating Mapping Settings with TXT Source Data

How to Create a File Format Project

BFP: Validating Mapping Settings with TXT

Source Data
Prerequisites
The bank statement le is in the TXT format and its structure matches the source tree.

You have de ned the mapping setting for at least one source node. Nevertheless, we recommend that you use this function
after you have nished de ning the mapping settings for all the source nodes; this helps you avoid missing any nodes, as
well as avoiding going back and forth between the Mapping Setting tab and the Source tab.

Context
If the BFP format project uses TXT as the source, you can validate the mapping settings with data from a sample bank statement
le. This function helps you ensure the source nodes are mapped to the target SAP Business One tables and elds according to
the speci cation.

Procedure
1. Click anywhere in the source tree. The Source tab appears on the right.

2. On the Source tab, choose the browse button (...) and open the bank statement le.

The le content is displayed in the EFM.

3. To validate the mapping setting made for a source node, click the source node.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 19/66
10/3/2019

Results
Depending on the mapping setting, the corresponding data is highlighted on the Source tab. If the node is repetitive and more
than one record exists, the records are highlighted in alternating colors.

Related Information
How to Create a File Format Project
Step 4: Mapping Between the Source and Target Trees

Step 5: Creating Validation Rules for the

Runtime
You can create validation rules for the runtime.

Note
Except for the Customize type, you can create only one validation rule for each parameter type.

At runtime, the validation rules check the relevant values retrieved from SAP Business One. You can provide a warning or error
message for any error that may occur during runtime validation:

Error message: If any error occurs, the message appears and the validation process fails.

Warning message: If any error occurs, the message appears, but the validation process continues.

A default error message is provided. You can modify the error message or change it to a warning message. You can use functions
to compose the messages.

Procedure
To create a validation rule, do the following:

1. Select a node in the target format tree.

2. Select the Validation tab.

3. To add a validation rule, click and select one of the following validation types:

Length: Validates if the length of the output value stays within a range.

Valid Value: Validates if the output value is a valid one.

Data Range: Validates if the output value stays within a range.

Number of Occurrences: Validates how many times a value is outputted for the target node.

Customize: You can create advanced validation rules by selecting this type.

Creating Length Validation Rules

1. Specify the length range.

If you leave the From eld empty, it means that the value in the From eld is zero. If you leave the To eld empty, it means
that the value in the To eld is in nity.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 20/66
10/3/2019
2. De ne an error message or a warning message.

Creating Valid Value Validation Rules

1. Specify a valid value.

2. To add the value to the valid value list, choose .

3. Repeat steps 1 and 2 until you have included all valid values in the list.

To remove a value from the valid value list, select the value and choose .

4. De ne an error message or a warning message.

Creating Data Range Validation Rules

1. Specify a data range.

To include the beginning or ending value within the data range, select the Inclusive checkbox.

2. De ne an error message or a warning message.

Creating Occurrence Number Validation Rules

1. Specify the occurrence number for the target node.

If you leave the From eld empty, it means that the value in the From eld is zero. If you leave the To eld empty, it means
that the value in the To eld is in nity.

2. De ne an error message or a warning message.

Creating Customized Validation Rules

1. De ne one or more advanced conditions for runtime validation.

2. De ne an error message or a warning message.

More Information
Functions

Using Functions

How to Create a File Format Project

Step 6: Test Running a Format Project

You can test run each mapping to simulate the runtime execution and run validation checks on the mapping.

If the test run fails, the relevant messages are displayed on the Message tab. For runtime data validation failure, the messages you
specify on the Validation tab appear.

To save the test run results, right-click any space on the Output tab and choose Export All. Then in the Save As window, specify
the le name, and choose the Save button.

Simple Test Run

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 21/66
10/3/2019
To test run the current mapping using the sample data saved in the source les, do one of the following:

In the toolbar, click .

In the menu bar, choose Project Test Run .

On your keyboard, press F5 .

Note
For the BFP format project, you always need an external le for the test run; even if the source is in the XML format, embedded
data is

Advanced Test Run

You can also test run the mappings using some advanced options. To start an advanced test run, do one the following:

In the toolbar, click .

In the menu bar, choose Project Advanced Test Run .

On your keyboard, press F6 .

In the Advanced Test Run window, you can do the following:

Test run each mapping in turn

De ne different data sources for different sources les

If you have translated runtime text (error messages and parameters), you can select different base languages to display
translations.

Depending on the source le type and the speci ed data source option, the data used for test run can be different, as listed in the
table below:

Source File Option Source Data Comments

Type

RPT Use sample data in the source Sample data in the source le None.
.rpt le

Use External XML le exported Updated data in an XML le that is For more information about how to
from the source .rpt le exported from the source RPT le update data in an RPT le and how to
export an RPT le to the XML format,
see the SAP Crystal Reports online help.

Preview RPT Data Live data in a connected SAP Business If you are not designing your format
One company project on the landscape server, you
need to provide the System Landscape
Directory server address.

You can specify different parameter

values to have different output.

XML Use the embedded XML data Sample data in the source le None.

Use an external XML le Data in a le whose structure matches The structure of the external XML le
the source le must match the source le. For
information about the matching rules,
see Updating Source or Target Files.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 22/66
10/3/2019

Source File Option Source Data Comments

Type

TXT Use an external text le Data in a le whose structure matches None.

the source le

More Information
How to Create a File Format Project

Step 7: Saving a Format Project

Recommendation
During your design process, save the format project from time to time to prevent data loss.

Procedure
To save the format project, do one of the following:

In the menu bar, choose File Save .

In the toolbar, click .

Press CTRL + S .

To save the format project under a different name, in the menu bar, choose File Save As... and specify the new format name.

More Information
How to Create a File Format Project

Referencing Nodes
You can use drag-and-drop to reference source and target nodes when de ning mapping conditions or validation rules. The
reference number must be unique for each node.

Procedure
Using Node Values as Arguments

You can directly use the value of a node as an argument in an expression, as follows:

1. Add a mapping condition or customized validation rule.

2. In an expression, specify the type of an argument as Reference No.

3. Do either of the following:

Enter <Reference Number> in the function. For example, if the reference number is "Ref", enter Ref in the
argument eld.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 23/66
10/3/2019
Press Ctrl and drag the node to the argument eld.

Referencing Nodes in Functions

You can also reference a node in a function in either of the following ways:

Enter %<Reference Number> in the function. For example, if the reference number is "Ref", enter %Ref in the function.

Press Ctrl and drag the node to the function. A percent sign (%) is automatically added before the reference number.

For more information, see Using Functions and Functions.

More Information
How to Create a File Format Project

Nodes in Different File Structures

Using Functions
Procedure
You can use functions in the following scenarios.

Using Functions in Mapping Conditions

1. Right-click a target node and choose Mapping Setting.

The Mapping Setting tab opens.

2. On the Mapping Setting tab, add a condition.

3. In an expression, specify the type of an argument as Function.

Using Functions for Retrieving Target Values

1. Right-click a target node and choose Mapping Setting.

The Mapping Setting tab opens.

2. On the Mapping Setting tab, in the Value area, select the Function radio button.

Using Functions in Customized Validation Rules

1. Select a target node and select the Validation tab.

2. Choose and from the dropdown list, select Customize.

3. In an expression, specify the type of an argument as Function.

More Information
Functions

Referencing Nodes

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 24/66
10/3/2019
How to Create a File Format Project

Functions
The following types of functions are supported:

Boolean

Date

Node-set

Number

String

More Information
Using Functions

Functions: Boolean

Functions: Date

Functions: Node Set

Functions: Number

Functions: String

Functions: Boolean
boolean(object)

Description: Returns a boolean value for a number, string, or node-set. This function converts arguments to booleans according to
the following rules:

If the argument is a negative or positive number, it is converted to the boolean value true. If the argument is zero or an NaN
value, it is converted to false.

If the argument is a non empty node-set, it is converted to true. An empty node-set is converted to false.

If the argument is a non-empty string, it is converted to true. An empty string is converted to false.

If the argument is an object of a type other than the four basic types, it is converted to a boolean in a way that is dependent
on that type.

Samples:

boolean(0) = false

boolean(1) = true

boolean(-100) = true

boolean(100) = true

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 25/66
10/3/2019
boolean(NaN) = false

boolean('hello') = true

boolean('') = false

not(boolean)

Description: Returns true if the argument is false; otherwise false.

Sample:

not(true) returns false

true()

Description: Returns true

lang(string)

Description: Returns true if the language of the current node matches the language of the speci ed language

Sample:

lang("en") is true for <p xml:lang="en">...</p>

lang("de") is false for <p xml:lang="en">...</p>

false()

Description: Returns false

*equal(object, object)

Description: Returns true if argument 1 equals argument 2; otherwise false

Sample:

equal(1, 2) = false

*notequal(object, object)

Description: Returns true if argument 1 does not equal argument 2; otherwise false

Sample:

notequal(1, 2) = true

*equal-or-greater(number, number)

Description: Returns true if arg1 is equal to or greater than arg2, otherwise false.

Sample:

equal-or-greater(2, 2) = true

*equal-or-less(number, number)

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 26/66
10/3/2019
Description: Returns true if arg1 is equal to or less than arg2; otherwise false

Sample:

equal-or-less(1, 2) = true

*greater(number, number)

Description: Returns true if arg1 is greater than arg2; otherwise false

Sample:

greater(1, 2) = false

*less(number, number)

Description: Returns true if arg1 is less than arg2; otherwise false

Sample:

less(1, 2) = true

*logical-and(boolean, boolean)

Description: Returns true if arg1 and arg2 are both true; otherwise false

Sample:

logical-and(true, true) = true

*logical-or(boolean, boolean)

Description: Returns true if arg1 or arg2 is true, otherwise false.

Sample:

logical-or(true, false) = true

More Information
Functions

Functions: Date
Functions with "*" are extended functions for the Electronic File Manager: Format De nition add-on.

Parameters suffixed with a question mark "?" have a default value and can be omitted.

*now(string format?)

Description: Returns the current date and time in a speci c format. The default format is ISO8601 "yyyy-MM-ddTHH-mm-ss".

Sample:

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 27/66
10/3/2019
now('yyyyMMddhhmmss') returns "20090929094252"

now() returns "2009-09-29T09-42-52"

*today(string format?)

Description: Returns the current date in a speci c format. The default format is ISO8601 "yyyy-MM-dd".

Sample:

today('yyyyMMdd') returns "20090929"

today() returns "2009-09-29"

*format-date(string date, string dateFormat, string targetFormat)

Description: Converts a string of date to a string with target format.

Sample:

format-date(today(), 'yyyy-MM-dd', 'MM/dd/yyyy') returns '09/04/2009'

*date-diff(string date1, string date2, string format1?, string format2?)

Description: Returns the number of different days between two dates. The default value of format1 and format2 is ISO8601 "yyyy-
MM-dd".

Sample:

date-diff("20091026", "20090930", "yyyyMMdd", "yyyyMMdd") returns 26

date-diff("2009-09-30", "2009-10-26") returns -26

*date-add(string date, number day, string format)

Description: Returns a speci ed date with the speci ed number interval (signed integer) added to a speci ed date part of that
date.

Sample:

date-add(today('yyyyMMdd'), 1, 'yyyyMMdd') returns '20090905'

More Information
Functions

Functions: Node Set

Functions with "*" are extended functions for the Electronic File Manager: Format De nition add-on.

Parameters suffixed with a question mark "?" have a default value and can be omitted.

id(object)

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 28/66
10/3/2019
Description: Selects elements by their unique ID.

Sample:

<?xml version = 1.0"?>

<Text>

<Persons>

<Person>A</Person>

<Person>B</Person>

<Person>C</Person>

</Persons>

</Text>

id("A") would be <Person a ="A"></Person>.

*node-concat(node-set, string spaceMark?)

Description:

Returns a string concat value of node-set with argument 2 as separator

Default value of argument 2 is a space

Sample:

<?xml version = 1.0"?>

<Text>

<Persons>

<Person>A</Person>

<Person>B</Person>

<Person>C</Person>

</Persons>

</Text>

Suppose the reference number of node set Persons is PersonRef. node-concat(%PersonRef, ", ") returns "A,B,C".

More Information
Functions

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 29/66
10/3/2019

Functions: Number
Functions with "*" are extended functions for the Electronic File Manager: Format De nition add-on.

Parameters suffixed with a question mark "?" have a default value and can be omitted.

format-number(number, string Format, string decimalFormat?)

Description: Converts a number to a string using the format pattern speci ed by the second argument and optionally, to the
decimal-format named by the third argument.

The format pattern string is in the syntax speci ed by the JDK 1.1 DecimalFormat class. For more information, see
https://docs.oracle.com .

Sample:

format-number(0.23456, "#%") = 23%

last()

Description: Returns a number equal to the context size of the expression evaluation context

Sample:

<?xml version = 1.0"?>

<Text>

<Persons>

<Person>A</Person>

<Person>B</Person>

<Person>C</Person>

</Persons>

</Text>

If the context is //Persons/Person, the value of last() would be 3.

position()

Description: Returns the position or index number of the node, relative to all the selected nodes in the node list. The position of
the node is 1-based, so the rst node returns a position of 1.

Sample:

<?xml version = 1.0"?>

<Text>

<Persons>

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 30/66
10/3/2019
<Person>A</Person>

<Person>B</Person>

<Person>C</Person>

</Persons>

</Text>

If the context is Person B, the value of position would be 2.

count(node-set)

Description: Returns the number of nodes in the node-set argument

Sample:

<?xml version = 1.0"?>

<Text>

<Persons>

<Person>A</Person>

<Person>B</Person>

<Person>C</Person>

</Persons>

</Text>

Suppose the reference number of node set Persons is PersonRef. count(%PersonRef) returns 3.

number(object?)

Description: Returns the numeric value of the argument.

Sample: number('100') = 100.

sum(node-set)

Description: Returns the sum of all nodes in the node set. Each node is rst converted to a number value before summing.

Sample:

<?xml version = 1.0"?>

<root>

<a>1</a>

<a>2</a>

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 31/66
10/3/2019
<a>3</a>

</root>

Suppose the reference number of node a is a. sum(%a) returns 6.

ceiling(number)

Description: Returns the smallest integer that is not less than the argument

Sample:

ceiling(2.5) = 3

ceiling(-2.3) = -2

ceiling(4) = 4

oor(number)

Description: Returns the largest integer that is not greater than the argument

Sample:

oor(3.5) = 3

oor(-1.3) = -2

oor(4) = 4

round(number)

Description: Returns an integer closest in value to the argument

Sample:

round(2.6) = 3

round (2.4) = 2

round(2.5) = 3

round(-1.6) = -2

round(-1.5) = -1

*roundup(number, number of decimal places)

Description: Rounds up a number to the speci ed number of decimal places.

Sample:

roundup(1054.32179, 0) = 1054

roundup(1054.32179, 1) = 1054.3

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 32/66
10/3/2019
roundup(1054.32179, 2) = 1054.32

roundup(1054.32179, 3) = 1054.322

roundup(1054, 3) = 1054.000

*add(number, number, number?)

Description: Returns the sum of the arguments

Sample:

add(2, 3) = 5

*subtract(number, number, number?)

Description: Returns the difference between the arguments

Sample:

subtract(6, 2, 1) = 3

*multiply(number, number, number?)

Description: Returns the product of the arguments

Sample:

multiply(1, 2, 3) = 6

*divide(number, number, number?)

Description: Returns the quotient of the arguments

Sample:

divide(6, 3, 2) = 1

*modulus(number, number, number?)

Description: Returns the integer that can be divided without a remainder into the difference between num1 and num2

Sample:

modulus(5, 2) = 1

*sum-if(node-set, boolean)

Description: Returns the sum of the node set if arg2 is true

Sample:

<?xml version = 1.0"?>

<root>

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 33/66
10/3/2019
<a>1</a>

<a>3</a>

<a>2</a>

</root>

Suppose the reference number of node a is a. sum-if(%a, true) = 6

*count-if(node-set, boolean)

Description: Returns the count of the node set if arg2 is true

Sample:

<?xml version = 1.0"?>

<root>

<a>1</a>

<a>3</a>

<a>2</a>

</root>

Suppose the reference number of node a is a. count-if(%a, true) = 3

*is-number(object value)

Description: Returns true if the argument can be converted to a number

Sample: is-number('1') returns true; is-number('NaN') returns false

More Information
Functions

Functions: String
Functions with "*" are extended functions for the Electronic File Manager: Format De nition add-on.

Parameters suffixed with a question mark "?" have a default value and can be omitted.

string-length(string?)

Description: Returns the number of characters in the string.

Sample:

string-length("abcd") returns 4

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 34/66
10/3/2019
local-name(node-set?)

Description: Returns the local part of the expanded name of the node in the node-set argument that is rst in the document order.

Sample:

<?xml version = 1.0"?>

<Text>

<Persons>

<Person>A</Person>

<Person>B</Person>

<Person>C</Person>

</Persons>

</Text>

If the context node is Person A, local-name() would be "Person".

namespace-uri(node-set?)

Description: Returns the namespace Uniform Resource Identi er (URI) of the expanded name of the node in the node-set
argument that is rst in the document order.

Sample:

<?xml version = 1.0"?>

<T: Text xmlns: T=x-schema:Text.xml">

<Text>

<Persons>

<Person>A</Person>

<Person>B</Person>

<Person>C</Person>

</Persons>

</Text>

namespace-uri() would be "x-schema:Test.xml".

name(node-set?)

Description: Returns a string containing a QName representing the expanded name of the node in the node-set argument that is
rst in the document order.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 35/66
10/3/2019
Sample:

<?xml version = 1.0"?>

<Text>

<Persons>

<Person>A</Person>

<Person>B</Person>

<Person>C</Person>

</Persons>

</Text>

If the context node is Person A, name() would be "Person".

string(object?)

Description: Returns the string value of the argument, which could be a number, boolean, or node-set.

Sample:

string(314) returns "314"

concat(string, string, string?)

Description: Returns the concatenation of the strings.

Sample:

concat('XPath','is','FUN!') Result: 'XPath is FUN!'

starts-with(string, string)

Description: Returns true if the rst argument string starts with the second argument string; otherwise returns false.

Sample:

starts-with('XML','X') Result: true

contains(string, string)

Description: Checks whether the rst argument string contains the second argument string.

Sample:

contains('XML','XM') Result: true

substring-before(string, string)

Description: Returns the substring of the rst argument string that precedes the rst occurrence of the second argument string in
the rst argument string, or the empty string if the rst argument string does not contain the second argument string.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 36/66
10/3/2019
Sample:

substring-before("1999/04/01","/") returns "1999".

substring-after(string, string)

Description: Returns the substring of the rst argument string that follows the rst occurrence of the second argument string in
the rst argument string, or the empty string if the rst argument string does not contain the second argument string.

Sample:

substring-after("1999/04/01","/") returns "04/01".

substring(string, number, number?)

Description: Returns the substring of the rst argument starting at the position speci ed in the second argument and having the
length speci ed in the third argument. Index begins from 1.

Sample:

substring("12345",2,3) returns "234"

substring("12345",2) returns "2345"

normalize-space(string?)

Description: Returns the argument string with the leading, trailing, and repeating white spaces stripped.

Sample:

normalize-space(" abc def ") returns "abc def"

translate(string, string, string)

Description: Returns the rst argument string with occurrences of characters in the second argument string replaced by the
character at the corresponding position in the third argument string.

Sample:

translate("bar","abc","ABC") returns "BAr"

*replace(string input, string from, string to)

Description: Returns a string that replaces argument 2 with argument 3 in argument 1.

Sample:

replace("hello", "h", "H") = "Hello"

*padding(number length, string padding)

Description: Returns a string lled with argument 2 and with length as argument 1. Sample: padding(10, "abc") = "abcabcabca"

*align(string target, string padding, bool alignToLeft)

Description: Returns a string that aligns argument 1 within argument 2.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 37/66
10/3/2019
Sample: align("abc", 'dddd', true) = "abcd"

*padding-align(string target, number length, string padding, boolean alignToLeft, boolean allowTruncate?)

Description: Padding the target string with the speci ed padding character and also aligning and truncating as speci ed. Default
value of allowTruncate is true.

Sample:

padding-align("hello", 10, "a", true, true) = "helloaaaaa"

*split-by-length(string input, int unitLength)

Description: Returns the node set that is separated by unit length.

Sample:split-by-length('abcdefg', 3) returns {'abc', 'def', 'g'}

*split(string input, string separator)

Description: Returns the node set that is separated by a separator.

Sample:

split('a, b, c', ',') returns {'a', 'b', 'c'}

* nd(string input, string target, number startat?)

Description: Reports the index of the rst occurrence of a String. Index begins at 1. If not found, returns 0.

Sample:

nd('ab cd', ' ') returns 3 nd('ab cd ef', ' ', 4) returns 6

*left(string input, number length)

Description: Returns the rst length chars in input.

Sample:

left('abcdefg', 5) returns 'abcde'

*right(string input, number length)

Description: Returns the last length chars in input.

Sample:

right('abcdefg',3) returns 'efg'

*repeat(string input, number frequency)

Description: Repeats an input several times.

Sample:

repeat('+',10) returns '++++++++++'

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 38/66
10/3/2019
*lower(string input)

Description: Returns a string that is lowercase.

Sample:

lower('abC') returns 'abc'

*upper(string input)

Description: Returns a string that is uppercase.

Sample:

upper('ABc') returns 'ABC'

*regex- nd(string input, string pattern, number startat?)

Description: Finds the position of the sub-string matching the pattern. Index begins at 1. If not found, returns 0

Sample:

regex- nd("hello2345", "\d+", 1) = 6

*regex-match(string input, string pattern, number startat?)

Description: Returns true if input matches the regex pattern

Sample:

regex-match("2345", "\d+", 1) returns true

*regex-replace(string input, string pattern, string replacement, number startat?)

Description: Replaces all the matches in the input with a replacement string

Sample:

regex-replace("hello 2345", "\d+", "sunshine") = "hello sunshine"

*regex-split(string input, string pattern)

Description: Returns the node set that is generated by a separator pattern.

Sample:

regex-split('a, b, c','[, ]') returns {'a', 'b', 'c'}

*format(string format, object obj1?, object obj2?, object obj3?, object obj4?, object obj5?)

Description: Replaces the format item in a speci ed string with the text equivalent of the value of a speci ed object instance.

Sample:

format("My name is {0}", "Ray") = "My name is Ray"

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 39/66
10/3/2019

More Information
Functions

Escape Sequences
The backslash (\) is used as the escape character in the EFM, and the EFM supports a range of escape sequences, as listed in the
table below:

Escape Sequence Hexadecimal Value Description

\r 0x0d Carriage return

\n 0x0a New line

\t 0x09 Tab

\v 0x0b Vertical slash (|)

\f 0x0c Form feed

\0 0x00 Null

\a 0x07 Bell character

\b 0x08 Backspace

\\ 0x5c Backslash

More Information
Using Functions

Verifying Format Projects

Context
The veri cation process checks the mapping settings or the validation settings of the target tree nodes:

XML: Checks the mapping settings of only the nodes required by the imported XML schema and the validation settings of
all the nodes.

You can import an XML schema by selecting one of the following options when you add an XML target le:

Import an XML schema

Import the structure from an XML document

CSV: Checks both the mapping settings and validation settings of all the nodes.

TXT: Checks only the validation settings of all the nodes.

Procedure
1. To verify the format, do one of the following:

Click .

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 40/66
10/3/2019
Choose Project Verify .

Press the F7 key.

2. After the veri cation is nished, messages of error, warning, or information appear on the Message tab.

To display different types of messages, choose the Errors, Warning, or Information button. By default, all types of
messages are displayed.

To export messages, right-click any space on the Message tab and choose Export All. In the Save As window, specify the
le name and choose the Save button.

Related Information
How to Create a File Format Project

Searching for Nodes or Texts

You can search for nodes on a mapping tab of the Workspace area or for texts on the Output tab by doing the following:

Entering the entire node name or text

Entering only parts of the node name or text

Procedure
Searching for Nodes in the Mapping Area

1. Select a mapping tab and select a format tree.

2. To open the Find window, do one of the following:

Press Ctrl + F .

Click .

3. In the Find window, from the Look In dropdown list, select Mapping and do one of the following:

To search for a node by its name, in the Find eld, specify the node name, and from the Find By dropdown list,
select Name.

To search for a node by its reference number, in the Find eld, specify the reference number, and from the Find By
dropdown list, select Reference No..

4. To use the advanced nd function, select Match Case or Match Whole Word.

5. To start the search, choose the Find button or press Enter .

6. The found node is highlighted in the le format tree. If more than one node matches the keyword, choose the Find button
repeatedly.

Searching for Texts on the Output Tab

1. Select a mapping tab.

2. To open the Find window, do one of the following:

Press Ctrl + F .

Click .

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 41/66
10/3/2019
3. In the Find window, from the Look In dropdown list, select Output, and in the Find eld, specify the text.

4. To use the advanced nd function, select Match Case or Match Whole Word.

5. To start the search, choose the Find button or press Enter .

6. The found texts are highlighted on the Output tab. If more than one text is found, choose the Find button repeatedly.

More Information
How to Create a File Format Project

Viewing Target Format Tree

You can view an XML target format tree with technical nodes and non technical nodes displayed or hidden.

Full View

In full view, all the nodes, including the technical nodes, are displayed in the target format tree. A target format tree with XML
schema is opened in full view by default.

Default Compact View

In compact view, technical nodes are hidden and not displayed as follows:

Choice: The Choice node is hidden but only the rst child node is displayed by default .

All: The All node is hidden but all the child nodes are displayed.

Sequence: The Sequence node is hidden but all the child nodes are displayed.

Customized Compact View

You can customize a tree view by displaying or hiding non technical nodes in full view and displaying the customized tree view in
compact view.

When you hide a node, all the child nodes are hidden automatically in the compact view.

After you map a non technical node, you cannot hide the node. If you map a hidden non technical node, it switches to
display automatically in compact view.

For the Choice node, only the rst sub node is displayed by default in compact view. But you can hide the other sub nodes
under the Choice node.

Procedure
Viewing a Format Tree in Full View or Compact View

Right-click the format tree head and choose the view to which you want to switch.

Viewing a Format Tree in Customized Compact View

1. Display the XML format tree in full view.

2. To hide a non technical node, click the non technical node until the node is greyed out.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 42/66
10/3/2019
To display the non technical node, click the node until the node is enabled.

3. Display the XML format tree in compact view.

Translating Runtime Text of GEP and BPP

Format Projects
When you create or modify a GEP or BPP format project, you de ne some particular strings for the source RPT les and the
format project itself. These strings appear as the runtime text once you have imported the format project into SAP Business One:

(GEP only) Menu name

(GEP only) RPT le parameters

Note
Although you can de ne parameters for the RPT source les of a BPP format project, these parameters are ignored.
Therefore, EFM does not support translation of RPT le parameters for BPP format projects.

Validation messages

You can translate these strings into all languages supported by SAP Business One.

Note
EFM supports translation into the Hebrew language, but does not support the right-to-left writing convention.

Translating in EFM Designer

To translate the strings of a GEP or BPP format project in the EFM add-on, proceed as follows:

1. Open the format project in the EFM designer tool.

2. Select the Translation Explorer tab.

All the translatable strings are displayed. The RPT le parameters are grouped by each source RPT le. Neither the RPT le
parameters nor the validation messages are grouped by different mappings.

3. Select the menu name, an RPT le parameter, or a validation message, and the Translation tab is automatically displayed
in the work space.

4. In the Text eld of the corresponding language, enter the translation of the string in the base language.

5. Save the translations by choosing File Save or clicking .

After saving the translations, you can export them to an XML or CSV le.

Exporting Translations
For a GEP or BPP format project, you can export the translatable strings in the base language and their translations to an XML or
CSV le. The export procedure is as follows:

1. Open the format project in the EFM add-on.

2. Choose Project Export Translation .

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 43/66
10/3/2019
3. In the Save As dialog box, specify the le path, name, and type, and choose the Save button.

After export, you can modify the translations and then import the XML or CSV le back into the format project or other format
projects with the same structure.

Caution
The export XML or CSV le cannot be imported back into the original format project if you change the following items:

Menu

RPT le parameters

All strings in the base language

Importing Translations
You can import translations in an XML or CSV le into a GEP or BPP format project.The import procedure is as follows:

1. Open the format project in the EFM add-on.

2. Choose Project Import Translation .

3. In the Open dialog box, nd and select the XML or CSV le and choose the Open button.

Working with Mappings

Prerequisites
You have created a format project or opened an existing format project.

Procedure
Adding a Mapping

1. To add a mapping, do one of the following:

Choose Project Add Mapping .

Click .

A mapping tab appears in the workspace.

2. Specify the properties of the mapping.

Displaying a Mapping

To display a mapping on the mapping tab, do one of the following:

If the mapping tab is open, choose Project Window <Mapping Name> , or right-click the icon of the mapping in the
format explorer and choose Open....

If the mapping tab is closed, right-click the icon of the mapping and choose Open....

Deleting a Mapping

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 44/66
10/3/2019
To delete a mapping, right-click the icon of the mapping and choose Delete.

Note
Closing the mapping tab does not delete the mapping.

Moving a Mapping

To move a mapping up or down, right-click the icon of the mapping and choose Move Up or Move Down.

Electronic File Manager: Format De nition

Window
Area Description

Menu bar Displays menu commands for working with a format project.

For more information, see Menu Bar.

Toolbar Displays easy access to common functions for working with a format project.

For more information, see Toolbar.

Format Explorer Displays a format project with source and target les.

For more information, see Format Explorer.

Property Displays the properties of a format project, a mapping, a source or target tree, or a node.

For more information, see Properties.

Workspace area Contains the following:

Start Page: You can create a new format project or open an existing format project. Recently opened
projects are displayed.

One or multiple mapping tabs for a format project. Each mapping tab displays the relevant source tree and
target tree.

Translation tab for a mapping, where you can enter translations for runtime text. For more information, see
Translating Runtime Text of GEP and BPP Format Projects.

For more information, see File Format Tree.

Message tab Displays error, warning, or information messages resulting from veri cation and test runs. You can export all the
messages.

For more information, see Verifying Format Projects.

Output tab Displays test run results. You can export the test run results.

For more information, see Test Running a Format Project.

Mapping Setting tab You specify mapping conditions for a target node on this tab.

For more information, see Mapping Between the Source and Target Trees.

Validation tab You specify validation rules for a target node on this tab.

For more information, see Creating Validation Rules for the runtime.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 45/66
10/3/2019

Area Description

Source tab For a BFP format project with a TXT le source, you can validate the mapping settings with data from a sample TXT
bank statement le.

For more information, see BFP: Validating Mapping Settings with TXT Source Data.

Menu Bar
The area at the top of the Electronic File Manager: Format De nition window containing commands and functions that enable
you to work with the tool.

File Menu
File

Menu Command Description/Activity

New Creates a new format

Open Opens an existing format

Close Closes the current format

Save Saves changes to the format

Save as Saves the updated format with a new le name

Exit Exits the format de nition tool

Edit Menu
Edit

Menu Command Description/Activity

Cut Cuts a node or a connection

Copy Copies a node or a connection

Paste Pastes a node or a connection

Delete Deletes a node or a connection

View Menu
View

Menu Command Description/Activity

Message Displays the Message tab

Output Displays the Output tab

Mapping Setting Displays the Mapping Setting tab

Validation Displays the Validation tab

Start Page Displays the start page

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 46/66
10/3/2019

Project Menu

Menu Command Description/Activity

Add Mapping Adds a new mapping to the current format project

Test Run Test runs a mapping

Advanced Test Run Test runs each mapping with different data sources

Verify Veri es the format

Import Translation Available for GEP and BPP format projects only

Imports translations of translatable strings into the format project

Export Translation Available for GEP and BPP format projects only

Exports translatable strings in the base language and their

translations to an XML or CSV le

Window Displays all the opened tabs in the work space

Choosing a menu item displays its corresponding tab.

Help Menu

Menu Command Description/Activity

Online Help Opens the online help of the Electronic File Manager: Format
De nition add-on

About... Displays the exact version number and build information of the
Electronic File Manager: Format De nition add-on

Toolbar
The toolbar, located below the menu bar, is a collection of icons that provide quick access to commonly used functions. Active
functions are shown in color, while inactive ones are grayed out.

The functions represented by the buttons are also available in the menu bar.

Toolbar Icons

Icon Description/Activity

Creates a new format

Opens an existing format

Saves the format

Cuts a node or a connection

Copies a node or a connection

Pastes a node or a connection

Deletes a node or a connection

Test runs a mapping with sample data in the source le

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 47/66
10/3/2019

Icon Description/Activity

Test runs each mapping with one of the following data sources:

Sample data in the source .rpt le

External data in the XML format, which is exported from the source .rpt le

Data from a connected SAP Business One company

Veri es a format

Adds a mapping

Opens the Translation tab in the work space

Opens the Find window

Enables full screen of mapping by hiding Format Explorer and Properties

Opens the online help of the Electronic File Manager: Format De nition add-on

Format Explorer
The Format Explorer area displays the format project in a tree structure.

Format Structure

Name Position Options and rules

( Format Project) Root Displays the name of the format project.

A format project can contain more than one

mapping.

To add a mapping, right-click the node.

( Mapping) First Level Displays the names of mappings.

A project can contain more than one

mapping. All the mappings are displayed in
the same level. Each mapping has a
corresponding tab in the Mapping area.

After right-clicking the node, you can do the

following:

Open the mapping in the Mapping

area by choosing Open....

Add source les or target les by

choosing Add Source or Add Target.

Delete the mapping by choosing

Delete.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 48/66
10/3/2019

Name Position Options and rules

( Source Folder) Second Level Lists source les (RPT).

You can add more than one source le for a

mapping.

To add a source le, right-click the node,

choose Add RPT , and specify the source
le.

( Target Folder) Second Level Lists only one target le (XML/CSV/TXT).

To add a target le, right-click the node,

choose Add XML/CSV/TXT , and specify
the target le.

Source File: Third Level Displays the names of the source les. A
mapping can contain more than one source
le. Each source le has a corresponding
format tree on its mapping tab in the
Mapping area.

After right-clicking the node, you can do the

following:

Update the source le by choosing

Update....

Save the source le with another

name by choosing Save as....

Delete the source le by choosing

Delete.

Move up or down the mapping by

choosing Move Up or Move Down, if
more than one mapping exists.

Target File: Third Level Displays the name of the target le. The
target le has a corresponding format tree
on its mapping tab in the Mapping area.

To delete the target le, right-click the node

and choose Delete.

Translation Explorer
The Translation Explorer area displays the translatable strings of a format project in a tree structure.

Translation String Structure

Node Position Description

Format project Root Displays the name of the format project

Menu Name First level Available for GEP format projects only

Format name that appears as a menu entry in SAP Business One

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 49/66
10/3/2019

Node Position Description

RPT File First level Available for GEP format projects only
Parameters
Groups all RPT le parameters by the RPT le to which they belong

> RPT le Second level Displays the name of the RPT le

>> Parameter Third level Displays the name of the parameter

Validation First level Groups all validation messages

Messages

> Validation Second level Displays the name of the validation message
message
The default naming convention of a message is
Msg_<Validation Type>_<Sequential number>, for example,
Msg_Occurrence_1. The sequence of the numbers is determined by the creation order
of the validation messages, but not according to the position of the node in the structure.

Properties
The Properties area displays all the properties available for de ning the entire format project, each mapping, each source or
target le, and each source or target node. As a rule, we recommend that you de ne the properties following the order below:

1. Format Project Properties

2. Mapping Properties

3. Source and Target File Properties

4. Tree Node Properties

More Information
How to Create a File Format Project

Format Project Properties

By de ning the properties of a format project, you specify such details as which versions or localizations of SAP Business One are
appropriate for deploying this format project.

To de ne the properties of the format project, in the format explorer, choose the format project node (icon: ) and the
properties of the format project are displayed in the Properties area.

Deployment Properties

Applicable Format Projects Property Description Example

All Version Version of the format project, The initial value is 1.0.
speci ed for the convenience of
future maintenance. You can de ne two digits for a
minor version, such as 1.11.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 50/66
10/3/2019

Applicable Format Projects Property Description Example

GEP Module Module in SAP Business One. Financials

The speci ed module

determines the Menu Path
property.

GEP Menu Name Format project name to be EU Sales Report

displayed in the SAP Business
One Main Menu.

All Author Person or organization that SAP

created the format project.

All [Optional] Compatible Versions Versions of SAP Business One 9.10.150

that support the format.

Choose the Browse button and

specify the supported versions,
one version per line.

Note
When you import the format
project into a different
version of SAP Business One,
the application warns you
that the format project is not
intended for this version.
However, SAP Business One
does not prevent you from
importing the format project
if you insist on doing so.

To nd out the version of SAP

Business One, in the SAP
Business One client application,
in the menu bar, choose
Help About SAP Business One .

All Last Changed By Person or organization that last SAP

changed the format project.

All Last Changed On Date on which the format project 6/11/2010 3:19 PM
was last changed; includes the
time.

GEP Menu Path Menu path of the format project Financials Financial
after it is imported into SAP Reports Electronic Financial
Business One. Report EU Sales Report

GEP Show Welcome Step To display the welcome step True

when running the EFM wizard in
SAP Business One, set this
property to True.

General Properties

Applicable Format Projects Property Description Example

All Name Name of the format project. EU Sales

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 51/66
10/3/2019

Applicable Format Projects Property Description Example

All [Optional] Description Description of the format The report lists the
project. goods and services sold
by a company to
customers in European
Union countries,
grouped by the country
and tax ID of the
customers.

All Type Type of the format project; Generic Electronic File

uneditable. Format Project

All [Optional] Localization Target localizations of the United Kingdom

format project.

Note
When you import the format
project into an SAP Business
One company with different
local settings, SAP Business
One warns you that the
format project is not
intended for this localization.
However, SAP Business One
does not prevent you from
importing the format project
if you insist on doing so.

All File Path Storage place of the format D:\Documents and

project le. Settings\All Users\My
Documents\EU_Sales.GEP

GEP, SPP Subtype Purpose of the format project. Intrastat

More Information
Properties

Mapping Properties
You can give each mapping a more appropriate name or a detailed description, which would be bene cial for future maintenance.
For GEP and SPP format projects, it is even possible to write a user script to handle computing-intensive tasks (for example, heavy
calculations and loop functions).

To de ne the properties of a mapping, in the format explorer, choose the mapping node (icon: ) and the properties of the
mapping are displayed in the Properties area.

General Properties

Property Description

Name Name of the mapping

Description Description or purpose of the mapping

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 52/66
10/3/2019
[GEP and SPP] User Script

Property Description

Script Type The EFM supports the following two types of user script:

CSharp

JavaScript

Note
Both types of script are based on MSXSL scripts.

Functions Click the ellipsis button in the eld to write functions in the user
script editor.

Syntax for calling a function de ned in the user script: user:

<Function Name>(<Parameter 1>, <Parameter 2>...)

More Information
Properties

Source and Target File Properties

Regardless of the le format, source and target les share some common properties. On the other hand, some properties are
available only to the source or to the target le.

To de ne the properties of a le, in the format explorer, choose the le node (under the Source or the Target folder node) and the
properties of the le are displayed in the Properties area.

General Properties

General

Property Description Example

Document Version Version of the le. 1.1

This property is not available for all les (for

example, the embedded les for SPP format
projects).

Is System Indicates whether the structure was True

generated by the tool (true).

Name Name of the le. Payment Wizard Results

Description Description of the le. RPT file with database tables for
the payment wizard

Type Type of the le. RPT

Source File-Speci c Properties

Each format has its unique properties to de ne and the property section title may also be different from others.

File Format Property Section Title Property Description Example

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 53/66
10/3/2019

File Format Property Section Title Property Description Example

RPT RPT [GEP] Preview Indicates whether users De ne this property as

are allowed to preview True and import the
the RPT le when running format project into SAP
the EFM wizard in SAP Business One. When you
Business One. run the wizard, a Preview
button is available in the
corresponding step.

TXT, XML File Encoding Indicates the encoding of ANSI/OEM

the source le. Simplified Chinese
GBK

XML XML Target Namespace Default target /

namespace of the XML
le.

Target File-Speci c Properties

Data

File Format Property Section Title Property Description Example

XML, XBRL File Output File Name Name of the output le de-eusales-1.0.xml
generated at runtime.
Note
Encoding Encoding of the output UTF-8; ISO-8859-1
For BFP format le.
projects, these
properties are Indent Indicates whether to True
prede ned and indent the XML elements
cannot be edited. in the output le.

[GEP] Always Generated Indicates whether to False

generate the output le
in all cases, even when
validation error occurs.

XML Target Namespace Default target www.example.com

namespace of the XML
document.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 54/66
10/3/2019

File Format Property Section Title Property Description Example

Namespaces You can de ne a /

collection of namespaces
that will be used by
individual le structure
nodes. When you later
de ne the properties of
nodes, and some nodes
use a different
namespace from the
default target
namespace, you can
select from the collection
instead of manually
entering the namespace
for the nodes.

To de ne a collection of
namespaces, do the
following:

1. Click the
Namespaces
eld and choose
the ellipsis
button.

2. In the
Namespaces
Editor window,
enter the pre x
and URI for the
rst namespace.

3. To de ne more
namespaces,
press ENTER
and repeat step
2.

4. When you have

nished de ning
the namespaces,
choose the Save
and Close
button.

Schema Location Location of the schema /

le.

CSV, TXT File Encoding Encoding of the output UTF-8; ISO-8859-1

le.

Fixed Line Length Fixed length of line. 0

Line Break Element or character Carriage Return

that forces a break in the (\n)
line of a le.

Output File Name Name of the output le Ouput.csv

generated at runtime.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 55/66
10/3/2019

File Format Property Section Title Property Description Example

[GEP] Always Generated Indicates whether to False

generate the output le
in all cases, even when
validation error occurs

CSV Data Default Separator Default eld separator Tab (\t)

for the entire output le.
You can also keep this
value blank.

Default Escape Char. Default escape character Double Quote (")

for the entire output le.

The character preserves

the literal meaning of the
character or character
sequence used as the
eld separator.

Example
You have de ned "\t"
(tab) as the eld
separator. In some
exceptional cases,
"\t" is part of a
character sequence
(for example,
"...\tab").

To preserve the literal

meaning of "\t" in this
character sequence,
de ne the double
quote character (") as
the escape character.
As a result, "\t" will be
enclosed in the target
le within a pair of
double quotes.

More Information
Properties

Tree Node Properties

The structure of each source or target le is represented as a tree in the workspace. Some of the properties of a tree node are
speci c to the node; the others use the default values de ned for the le but can be modi ed to override those of the le.

To de ne the properties of a tree node, in the workspace, in the particular tree, choose the node; the properties of the node are
displayed in the Properties area.

General Properties

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 56/66
10/3/2019
Regardless of their le format and of whether they are in the source or the target tree, the tree nodes share some common
properties.

Property Description Example

Optional Available only to Attribute nodes in XML le True

formats.

Speci es whether or not the node can be

omitted in the document.

Reference No. Not available to order indicator nodes (for ItemCode

example, Sequence node) in XML le
formats .

Unique reference code or alias of the node.

Use the reference number to reference the
node in a function or a condition expression.

For more information, see Referencing

Nodes.

Name Not available to order indicator nodes in Item Code

XML le formats (for example, Sequence
node).

Name of the node.

Type Node type. Field, RPT

Description Description of the node. The item code

UID Unique ID of the node, generated by the N_1_4

application.

RPT-Speci c Node Properties

The RPT eld nodes hold actual data and have the following RPT-speci c properties (grouped in the RPT section):

Property Description Example

Further Information Additional data about the Crystal Reports CINF.LawsSet

eld node; for example, eld information
from the database.

Formula Name Formula name, taken from the RPT le. {CINF.LawsSet}

Use Original Formatted Value Indicates whether to use the original False: The original value of the eld will be
formatted value in the target document. used.

Original Value Original value from the data source. 2015.03.15

Original Formatted Value Original value formatted from the data 15.03.2015
source according to the format.

CSV-Speci c Node Properties

Different node types in a CSV le have different data properties.

Node Type Property Description Example

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 57/66
10/3/2019

Node Type Property Description Example

Line Separator Field separator, used to separate Comma (,)

a column from the next column.

Escape Character The character preserves the Double Quote (")

literal meaning of the character
or character sequence used as
the eld separator.

Section Header Indicates whether to output the False

column header to the target le.

Except Last Line Break Indicates whether to insert the False

line break after the last line.

Field Default Value Default value of the eld 10

TXT-Speci c Node Properties

Source TXT nodes and target TXT nodes have different properties. Different node types also have different properties.

TXT as Source Format

Node Type Property Description Example

All (except for the root node) Is Mandatory Indicates whether or not the False
node must exist in the source
le.

Is Repetitive Indicates whether or not the Usually a bank statement

node can appear repetitively. contains information about
more than one transaction. If
you group the transaction
details in one segment, you can
set this property as True for
this segment.

Locating Method Speci es one of the following /

methods to locate the data
segment or data eld in the
source le:

By the position of the

segment or eld

By some keywords

By a separator

By a regular expression

For more information, see TXT

Source Node: Locating Methods.

Field Data Type Speci es the data type of the String, Date, Numeric
eld.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 58/66
10/3/2019

Node Type Property Description Example

Data Format Speci es the data format of the /

eld.

Each data type has different

data formats. For more
information, see TXT Source
Node: Data Format Strings.

TXT as Target Format

Node Type Property Description Example

Standard Segment Include Line Break Indicates whether to True

automatically include the line
break at the end of the text.

Except Last Line Break Indicates whether to insert the False

line break after the last line.

Field Offset Starting position of the eld. 1

Length Length of the eld, including 8

padding characters. To indicate
an inde nite length, specify a
negative integer.

Padding Character Specify the character to be used Zero (0) is the padding
to ll empty spaces of a eld character and the text is aligned
when its text is shorter than the to the left. If the eld value is
required length. "123", the output will be
"12300000".

Text Alignment Indicates how text is aligned in Left

the eld.

Default Value Default value of the eld. 18

XML-Speci c Node Properties

Different nodes in an XML le contain only some or all of the properties.

Section Title Node Type Property Description Example

Data Lowest-level Allows Null Indicates False

element whether the XML
element can
accept the "null"
value.

Default Value Default value of 8

the node.

XML All XML Name XML tag name in StrtNm

the XML
document.

XML Namespace Namespace urn:iso:std:iso:20022:tech:xsd:pain.001.001.02

under which the
XML node is
de ned.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 59/66
10/3/2019

Section Title Node Type Property Description Example

XML Source Pre x Declared pre x Prefix

Node of the
namespace to
which this node
belongs.

More Information
Properties

TXT Source Node: Locating Methods

You must specify a method to locate each data segment ( Segment Group or Standard Segment node) or data eld ( Field node)
in the source le, as follows:

1. In the TXT source tree, select the segment or eld.

2. In the Properties area, in the Data section, click in the Locating Method eld and then choose the browse button.

3. In the Locating Method window, select a method from the dropdown list and then specify all necessary attributes.

For details about these methods, refer to the descriptions in the sections below.

4. To save the settings, choose the OK button.

Locating Method: Position

Use this method when you locate the segment or eld by its absolute position within its parent segment.

Field Description

Position Starting position of the segment or eld within its parent segment.
Must be an integer number larger than 0.

Example
A segment group contains several segments. The rst segment
starts at the rst character within the segment group. If you
locate this segment by its position within the segment group,
you need to de ne the position as 1.

Fixed Length Select this checkbox to de ne a xed length for the segment or
eld.

Length Available only if you have selected the Fixed Length eld.

Min. Length Available only if you have not selected the Fixed Length eld.

Max. Length

Locating Method: Keywords

Use this method when you locate the segment or eld by some keywords.

Field Description

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 60/66
10/3/2019

Field Description

Starting Keyword Keyword that begins the segment or eld.

Ending Keyword Keyword that ends the segment or eld.

Fixed Length Select this checkbox to de ne a xed length for the segment or
eld.

Length Available only if you have selected the Fixed Length eld.

Min. Length Available only if you have not selected the Fixed Length eld.

Max. Length

Prior Keyword Keyword which immediately precedes the segment or eld.

Following Keyword Keyword which immediately follows the segment or eld.

Locating Method: Separator

Use this method when you locate the segment or eld by a separator.

Field Description

Separator A character or character sequence which separates the parent

segment into different sections.

Index
If the eld or segment is not repetitive ( Is Repetitive =
False), you can de ne this attribute to specify the relative
position of the segment or eld within the parent segment.
The position is determined by the separator.

If the eld or segment is repetitive ( Is Repetitive = True),

this attribute is not editable and all strings are matched.

Use Regular Expression to Identify Separator Select this checkbox if you want to use a regular expression to
identify the separator. For example, (\r?\n|\r)+ treats a
sequence of consecutive line breaks as one line break.

Example
There are 4 elds in each line of a TXT le. These elds are separated by tab characters and are not repetitive. If you want to
locate the second eld by the separator, enter \t in the Separator eld and 2 in the Index eld.

Locating Method: Regular Expression

Use this method when you locate the segment or eld by a regular expression.

The EFM supports Microsoft .NET Framework regular expressions. For more information, see the Microsoft documentation at
https://msdn.microsoft.com/library .

More Information
Tree Node Properties

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 61/66
10/3/2019

TXT Source Node: Data Format Strings

Different data types are provided with different format strings.

Data Type: String

Name Description

No Padding The eld is not padded by any character to a xed length.

Left-Aligned (Ending 0) Left-aligned and padded by zeroes in the end.

Left-Aligned (Ending Space) Left-aligned and padded by spaces in the end.

Right-Aligned (Leading 0) Right-aligned and padded by zeroes in the beginning.

Right-Aligned (Leading Space) Right-aligned and padded by spaces in the beginning.

Example
A left-aligned eld has a xed length of 5 characters and uses zero (0) as the padding character. If the source eld value is
BOE00, SAP Business One ignores the two ending zeroes.

Data Type: Date

Format String Description

YYYYMMDD Four-digit year number (YYYY), two-digit month number (MM), and
two-digit day number (DD), with no separators.
DDMMYYYY

MMDDYYYY

YYMMDD Two-digit year number (YY), two-digit month number (MM), and
two-digit day number (DD), with no separators.
DDMMYY

MMDDYY

YYYY.MM.DD Four-digit year number (YYYY), two-digit month number (MM), and
two-digit day number (DD), with a period (.) as the separator.
DD.MM.YYYY

MM.DD.YYYY

YY.MM.DD Two-digit year number (YY), two-digit month number (MM), and
two-digit day number (DD), with a period ( . ) as the separator.
DD.MM.YY

MM.DD.YY

YYYY/MM/DD Four-digit year number (YY), two-digit month number (MM), and
two-digit day number (DD), with a slash ( / ) as the separator.
DD/MM/YYYY

MM/DD/YYYY

YY/MM/DD Two-digit year number (YY), two-digit month number (MM), and
two-digit day number (DD), with a slash ( / ) as the separator.
DD/MM/YY

MM/DD/YY

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 62/66
10/3/2019

Format String Description

YYYY Four-digit year number only.

YY Two-digit year number only.

MM Two-digit month number only.

DD Two-digit day number only.

YYDDD Two-digit year number (YY) and the day-of-year number (DDD), with
no separators.

Example
"15101" represents 1 April, 2015.

YY.DDD Two-digit year number (YY) and the day-of-year number (DDD), with
a period (.) as the separator.

YY/DDD Two-digit year number (YY) and the day-of-year number (DDD), with
a slash (/) as the separator.

MMDD Two-digit month number (MM) and two-digit day number (DD), with
no separators.

HHMMSS Two-digit number of hours (HH), two-digit number of minutes (MM)

and two-digit number of seconds (SS), with no separators.
SSMMHH

HH:MM:SS Two-digit number of hours (HH), two-digit number of minutes (MM)

and two-digit number of seconds (SS), with a colon (:) as the
SS:MM:HH separator.

HHMM Two-digit number of hours (HH) and two-digit number of minutes

(MM), with no separators.

HH:MM Two-digit number of hours (HH) and two-digit number of minutes

(MM), with a colon (:) as the separator.
MM:HH

HH Two-digit number of hours only.

DDMMMYY Two-digit day number (DD), three-letter form of month (MMM) and
two-digit year number (YY), with no separators.

Example
"12JAN06" represents 12 January, 2006.

Date Format Conversion

In SAP Business One, the standard date format is YYYY-MM-DD. If a source date eld has a different format, SAP Business One
converts the date format automatically to the standard one, as follows:

Date Format Converted Date Format

Complete date format Standard date format: YYYY-MM-DD

Example
YYMMDD is automatically converted to 20YY-MM-DD.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 63/66
10/3/2019

Date Format Converted Date Format

Incomplete date format Incomplete standard date format

Example
MMDD is automatically converted to MM-DD.

For source elds that do not use the complete date format (that is, the year, the month or the day is missing), you must use
functions to get the complete date information. For more information, see Functions.

Example
The EntryDate eld uses MMDD as its date format. The ValueDate eld, with the reference number ValueDate, uses YYMMDD as
its date format. The system automatically converts EntryDate and ValueDate to the date format MM-DD and YYYY-MM-DD,
respectively.

To get the complete date information for EntryDate, use concat(substring(%ValueDate,1,5),.) as the mapping
method. Substring (%ValueDate,1,5) returns the year of ValueDate with dash "-" as the separator.
Concat(substring(%ValueDate,1,5),.) concatenates the result of substring(%ValueDate,1,5) with the
converted value of EntryDate.

Data Type: Numeric

Format String Description

00123456 Right-aligned, with or without leading zeroes, no decimal places.

00123456(.)1 Right-aligned, with or without leading zeroes, no decimal point, one

decimal place.

00123456(.)12 Right-aligned, with or without leading zeroes, no decimal point, two

decimal places.

00123456(.)123 Right-aligned, with or without leading zeroes, no decimal point,

three decimal places.

00123456.XX Right-aligned, with or without leading zeroes, dot (.) as the decimal
point, number of decimal places not xed.

00123456,XX Right-aligned, with or without leading zeroes, comma (,) as the

decimal point, number of decimal places not xed.

__123456(.)1 Right-aligned, with or without leading spaces, no decimal point, one

decimal place.

__123456(.)12 Right-aligned, with or without leading spaces, no decimal point, two

decimal places.

__123456(.)123 Right-aligned, with or without leading spaces, no decimal point,

three decimal places.

__123456.XX Right-aligned, with or without leading spaces, dot (.) as the decimal
point, number of decimal places not xed.

__123456,XX Right-aligned, with or without leading spaces, comma (,) as the

decimal point, number of decimal places not xed.

12345600 Left-aligned, with or without ending zeroes, no decimal places.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 64/66
10/3/2019

Format String Description

123456(.)100 Left-aligned, with or without ending zeroes, no decimal point, one

decimal place.

123456(.)1200 Left-aligned, with or without ending zeroes, no decimal point, two

decimal places.

123456(.)12300 Left-aligned, with or without ending zeroes, no decimal point, three

decimal places.

123456.XX00 Left-aligned, with or without ending zeroes, dot (.) as the decimal
point, number of decimal places not xed.

123456,XX00 Left-aligned, with or without ending zeroes, comma (,) as the

decimal point, number of decimal places not xed.

123456(.)1__ Left-aligned, with or without ending spaces, no decimal point, one

decimal place.

123456(.)12__ Left-aligned, with or without ending spaces, no decimal point, two

decimal places.

123456(.)123__ Left-aligned, with or without ending spaces, no decimal point, three

decimal places.

123456.XX__ Left-aligned, with or without ending spaces, dot (.) as the decimal
point, number of decimal places not xed.

123456,XX__ Left-aligned, with or without ending spaces, comma (,) as the

decimal point, number of decimal places not xed.

More Information
Tree Node Properties

File Format Tree

Each source le or target le has a corresponding le format tree in the Mapping area. The source format tree is read-only and you
cannot edit it.

Crystal Report Node

Node Icon Description

Crystal Report Document Root of the Crystal Report document

Report Header or Group Report header or group

Field Field

XML Node

Node Icon Description

Root Root element

Element (Container) Normal XML element containing child

elements

Element Normal XML element with data

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 65/66
10/3/2019

Node Icon Description

All XML non technical node that is not

displayed in compact view.

Only the rst child node shall be displayed in

compact view by default.

The All node speci es that the child nodes

can appear in any order. Each child element
can occur 0 or 1 time.

Sequence XML non technical node that is not

displayed in compact view.

Only the rst child node shall be displayed in

compact view by default.

The Sequence node speci es that the child

elements must appear in a sequence. Each
child element can occur from 0 to any
number of times.

Choice XML non technical node that is not

displayed in compact view.

Only the rst child node shall be displayed in

compact view by default.

The Choice node allows only one of the

elements contained in the declaration to be
present within the containing element.

Attribute Attribute of XML element

CSV Node

Node Icon Description

Root Root of CSV format tree

Header Line containing elds

Field Field

Leaf node of CSV format tree

TXT Node

Node Icon Description

Root Root of TXT format tree

Segment Group Segment containing other segments

Standard Segment Segment containing only elds

Field Field

Leaf node of TXT format tree

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=20464774&topics=712b8e10c2e3473f978671da37… 66/66