OpenText™ Vendor Invoice Management

for SAP® Solutions

Configuration Guide for Foundation

This guide describes the general configuration of the

Foundation component of Vendor Invoice Management.

The components of Vendor Invoice Management include

Foundation, Invoice Solution, and Solutions Beyond Invoice.

VIM200405-CGF-EN-02
OpenText™ Vendor Invoice Management for SAP® Solutions
Configuration Guide for Foundation
VIM200405-CGF-EN-02
Rev.: 2023-June-29
This documentation has been created for OpenText™ Vendor Invoice Management for SAP® Solutions 20.4 SPS5.
It is also valid for subsequent software releases unless OpenText has made newer documentation available with the product,
on an OpenText website, or by any other means.

Open Text Corporation

275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1

Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Support: https://support.opentext.com
For more information, visit https://www.opentext.com

Copyright © 2023 Open Text. All Rights Reserved.

Trademarks owned by Open Text.

One or more patents may cover this product. For more information, please visit https://www.opentext.com/patents.

Disclaimer

No Warranties and Limitation of Liability

Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the
accuracy of this publication.
 Table of Contents
1 About Vendor Invoice Management for SAP Solutions ......... 7
1.1 Architectural Overview ....................................................................... 9
1.2 About this document ........................................................................ 10
1.2.1 Target audience .............................................................................. 10
1.2.2 Further information sources ............................................................. 10

2 Basic configuration ................................................................. 13

2.1 Activating BC sets ........................................................................... 13
2.2 Configuring authorization ................................................................. 14
2.3 Configuring logical systems ............................................................. 15

Part 1 Customizing 17

3 General settings ...................................................................... 19

3.1 Configuring general settings ............................................................ 19
3.2 Configuring logical systems ............................................................. 24
3.3 Configuring VIM solutions ................................................................ 25
3.4 Configuring plug-in integration ......................................................... 26
3.5 Configuring logging ......................................................................... 31
3.6 Integrating translation services ......................................................... 34
3.7 Configuring Analytics ....................................................................... 35
3.8 Configuring image caching .............................................................. 56

4 Inbound Configuration ............................................................ 59

4.1 Customizing basic settings for Inbound Configuration ........................ 60
4.2 Configuring channels ....................................................................... 64
4.3 Creating scenario classifications ...................................................... 64
4.4 Customizing incoming documents through the document handler ....... 66
4.5 API for document registration ......................................................... 100
4.6 Add additional logic to standard actions (BAdI /OTX/
PF32_IDF_WOBJ_ACTION) .......................................................... 102
4.7 Rendition management ................................................................. 104

5 Capture Integration ............................................................... 107

5.1 Business Center Capture ............................................................... 107
5.2 Information Extraction Service ....................................................... 109
5.3 Customizing validation ................................................................... 182
5.4 Customizing feedback ................................................................... 187
5.5 Creating reject reasons ................................................................. 188
5.6 Customizing look-ups .................................................................... 188
5.7 Mapping a look-up field ................................................................. 192

VIM200405-CGF-EN-02 Configuration Guide for Foundation iii

Table of Contents

6 Process Foundation .............................................................. 195

6.1 Basic Settings ............................................................................... 196
6.2 Data model configuration ............................................................... 197
6.3 Process Foundation profile ............................................................ 206
6.4 Business data model assignment ................................................... 207

7 Process Configuration .......................................................... 209

7.1 Profile configuration ...................................................................... 209
7.2 Profile assignment ......................................................................... 259
7.3 Authorizations ............................................................................... 260

8 Workplace Configuration ...................................................... 263

8.1 Work object types ......................................................................... 266
8.2 Exit for dynamic filter criteria .......................................................... 293
8.3 Navigation .................................................................................... 293
8.4 Authorization objects ..................................................................... 303

9 Fiori Task App ........................................................................ 307

9.1 Application modes ......................................................................... 308
9.2 Fiori Task App Launchpad integration ............................................. 316
9.3 Fiori Task App essentials ............................................................... 330
9.4 Displaying documents in the Fiori Task App .................................... 335
9.5 Actions ......................................................................................... 339
9.6 Configuration ................................................................................ 372
9.7 Editing perspectives and layouts .................................................... 427
9.8 Interfaces and exits ....................................................................... 444
9.9 Helper classes for exit methods: /OTX/PF62_CL_UTILITIES ........... 512
9.10 Integrating UI5 widgets for Extended ECM or Document Access ...... 517

10 Fiori Monitoring and Analytics reports ............................... 519

10.1 Generation and configuration ......................................................... 520
10.2 Custom Extensions ....................................................................... 528

11 Useful methods ...................................................................... 531

11.1 /OTX/
PF00_CL_UTILITIES=>STRUCTURE_FIELD_VALUE_CONVERT .. 531
11.2 /OTX/
PF00_CL_UTILITIES=>FIELD_VALUE_CONVERT_STRUCTURE .. 531
11.3 /OTX/PF00_CL_UTILITIES=>TABLE_DATA_PACK ........................ 531
11.4 /OTX/PF00_CL_UTILITIES=>TABLE_DATA_UNPACK ................... 531
11.5 /OTX/PF00_CL_UTILITIES=>STRUCTURE_DATA_PACK .............. 532
11.6 /OTX/PF00_CL_UTILITIES=>STRUCTURE_DATA_UNPACK ......... 532

12 Document classification ....................................................... 533

iv OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 Table of Contents

12.1 Document type handling ................................................................ 535

12.2 Processing impacts ....................................................................... 536
12.3 Classification integration ................................................................ 538
12.4 BAdI /OTX/PF40_CLASSIFICATION .............................................. 538

13 Troubleshooting .................................................................... 541

13.1 Fiori Monitoring and Analytics reports ............................................. 541

GLS Glossary 545

VIM200405-CGF-EN-02 Configuration Guide for Foundation v

Chapter 1

About Vendor Invoice Management for SAP

Solutions

OpenText Vendor Invoice Management for SAP Solutions (VIM) is an ABAP add-on
solution to SAP ECC and SAP S/4HANA.

VIM automates the processing of incoming documents into SAP.

Document-centric business processes like the processing of incoming invoices from

vendors or incoming sales orders from customers are typical use cases for VIM.
After capture, data is enriched and validated against predefined business rules.

If no business rules fail, the document is posted in SAP without human intervention.
Although a straight through, no-touch process is the ultimate objective, VIM also
supports the fast and efficient handling and resolution of exceptions.

Exceptions are routed via workflow to the relevant user or user group based on the
role assigned to the exception.

For managers VIM offers a comprehensive suite of operational and analytical

reports. In addition, VIM offers the tools to identify common exceptions that should
be addressed to achieve even higher levels of automation.

VIM includes the following solutions:

• Invoice Solution

• Procure to Pay Solutions

– Order Confirmation

– Delivery Note

– Quotation

• Order to Cash Solutions

– Sales Order

– Remittance Advice

Each solution consists of a best practice implementation for a specific document

scenario. It includes preconfigured mapping rules, enrichment rules, business rules,
user roles and user actions. Learning-based enrichments features embedded easy to
configure machine learning that automates input based on previous user input.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 7

Chapter 1 About Vendor Invoice Management for SAP Solutions

Since VIM resides inside SAP, enrichments and business rules have direct access to
SAP master and transactional data, which avoids complex interfaces and the
replication and duplication of data.

Each solution offers a Workplace used by end-users and managers to manage and
monitor outstanding and completed work items. Each solution includes a
preconfigured set of analytical measures tailored for the specific document scenario.
Solutions can be enhanced to support company-specific business requirements.

VIM Solutions use features offered by its powerful feature rich Foundation.

The VIM Foundation consists of the following components:

• Inbound
• Process
• Workplace
• Analytics

VIM also supports custom solutions where a preconfigured solution is not available
for a specific, less common business process.

VIM offers a simple and intuitive user interface for end-users, managers and
administrators.

Users can choose between the classic SAP GUI or the modern SAP Fiori interface.

SAP Fiori offers a responsive web-based user interface that supports desktop and
mobile devices.

VIM supports various input channels including scan, fax¸ e-mail and web services.

It also supports various input formats, including paper, PDF, TIFF, IDoc and XML.

VIM requires an ArchiveLink-compliant SAP-certified content repository for the

storage of incoming documents. OpenText recommends OpenText Archiving and

8 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 1.1. Architectural Overview

Document Access for SAP Solutions or OpenText Core Archive for SAP Solutions for
the storage of documents.

VIM integrates seamlessly via its Inbound component with OpenText Intelligent
Capture for SAP Solutions and OpenText Core Capture for SAP Solutions, which
uses advanced machine learning algorithms to extract metadata from imaged-based
documents like PDF and TIFF.

VIM also offers integration with OpenText Extended ECM for SAP Solutions and
OpenText Document Presentment for SAP Solutions.

1.1 Architectural Overview

The following figure gives an overview of the basis architecture. It shows how the
core components of VIM are integrated into SAP and which additional OpenText
components like Document Pipeline, Document Storage, Information Extraction
Service and WebViewer are completing the solution.

Beside the components of this graphic, VIM offers additional components such as
SAP NetWeaver Business Warehouse or BW/4Hana for specific solutions which are
not shown in this basis architectural overview.

Figure 1-1: Technical system landscape

VIM200405-CGF-EN-02 Configuration Guide for Foundation 9

Chapter 1 About Vendor Invoice Management for SAP Solutions

1.2 About this document

This document describes the configuration of the Foundation component of Vendor
Invoice Management for SAP Solutions. It also describes the various implementation
aspects of configuring the Foundation component to suite the specific business
requirements for any organization. Vendor Invoice Management is designed to be
highly configurable to accommodate varied business scenarios.

To learn about the administration tasks of Vendor Invoice Management is designed,

see OpenText Vendor Invoice Management for SAP Solutions - Installation Guide (VIM-
IGD).

1.2.1 Target audience

This document addresses those who participate in the customization and
implementation of the Foundation component of Vendor Invoice Management for
SAP Solutions. This includes:

• SAP Basis Administrators

• SAP Workflow Administrators
• SAP Configuration and Development Support

1.2.2 Further information sources

Product docu- The following documentation is available on OpenText My Support (https://
mentation knowledge.opentext.com/knowledge/cs.dll/Open/10151494):

• OpenText Vendor Invoice Management for SAP Solutions - User Guide for Invoice
Solution (VIM-UGD)
• OpenText Vendor Invoice Management for SAP Solutions - Configuration Guide for
Invoice Solution (VIM-CGD)
• OpenText Vendor Invoice Management for SAP Solutions - Administration Guide
(VIM-AGD)
• OpenText Vendor Invoice Management for SAP Solutions - Reference Guide for Invoice
Solution (VIM-RGD)
• OpenText Vendor Invoice Management for SAP Solutions - Scenario Guide for Invoice
Solution (VIM-CCS)
• OpenText Vendor Invoice Management for SAP Solutions - Security Guide (VIM-GSM)
• OpenText Vendor Invoice Management for SAP Solutions - Security Guide (VIM-GSM)
• OpenText Vendor Invoice Management for SAP Solutions - Configuration Guide for
Foundation (VIM-CGF)
• OpenText Vendor Invoice Management for SAP Solutions - Configuration Guide for
Solutions Beyond Invoice (BOCP-CCS)

10 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 1.2. About this document

• OpenText Vendor Invoice Management for SAP Solutions - User Guide for Solutions
Beyond Invoice (BOCP-UGD)

For the particular solutions, guides are available on OpenText My Support.

Documentation for the Solution for Incoming Sales Orders and Solution for
Incoming Quotations is available in OpenText Vendor Invoice Management for SAP
Solutions - Configuration Guide for Solutions Beyond Invoice (BOCP-CCS).

Release Notes Release Notes describe:

• The software supported by the product

• Requirements
• Restrictions
• Important dependencies
• New features
• Known issues
• Fixed issues
• Documentation extensions

The Release Notes are updated continuously . The latest version of the Release Notes
is available on OpenText My Support (https://knowledge.opentext.com/knowledge/
cs.dll/Open/10151494).

VIM200405-CGF-EN-02 Configuration Guide for Foundation 11

Chapter 2
Basic configuration

Before you start with installation and detailed configuration, make sure that the
following actions have been performed:

• Install and configure an archiving system that supports the SAP HTTP Content
Server interface.
• Create User IDs with appropriate developer and configuration authorizations.
Authorizations need to include developer as well as workflow administrator
authorizations.
• Make sure that the SAP Business Workflow Runtime Engine is configured.

The configuration steps describe the basic mandatory customizing. This customizing
must be done with every installation and for every used solution. For the solution
specific customizing, see the respective parts in this document.

2.1 Activating BC sets

For every client, including client 000, you must activate the Business Configuration
sets (BC sets) after installation. Activate the BC set in the specific configuration client
of the development system that contains the business scenarios. Then create a
transport from BC set activation, and move the transport to the required systems.

Do not activate the BC set in the production system. Create a customization

transport in the configuration client of the development system. Therefore, activate
the BC set and move it to the wanted systems.

Each part of the Foundation has its own name space that is used for customizing
settings. These name spaces are:

Solution Configuration Namespace

Inbound PF01 / PF11-PF13 / PS11
Process PF31 / PF32
Analytics PF04
Workplace PF03 / PF62
Cross Solution PS00

Important

• For the following procedure, you must sign in in English to avoid problems
with the activation of the BC sets.
• You must activate all BC sets using Expert Mode.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 13

Chapter 2 Basic configuration

• When upgrading VIM Foundation, select the option to overwrite data to

make sure you get the latest changes within the customizing.
• Before activating a BC set, use the compare option to find out if current
customizing will be overwritten during the BC set activation. If needed, you
can revert those changes after the BC set activation manually in the
customizing.
• When you activate the BC sets, you might get dialog boxes, for example a
message about an error in Object Editing. Just confirm them with Copy
Values or OK.

Activate the BC sets only for English language. Other languages are delivered with
specific language packs. You find the language packs on OpenText My Support.

To activate BC sets:

1. Sign in in English and run the SCPR20 transaction.

2. In the Business Configuration Set screen, activate the following BC sets:

• /OTX/PFRM_ECM_006_01 for OpenText VIM Extended ECM Integration

(optional)
• /OTX/PF00_BASE_006_05 for the OpenText Process Base
• /OTX/PS00_BASE_006_05 for the OpenText VIM Solution Base

Important
After updating the backend versions and activating the BC sets, you must
execute the transaction /OTX/PF62_ADMIN in this backend system and clean up
WebIds, search helps and DataCollections.

2.2 Configuring authorization

Foundation component of Vendor Invoice Management for SAP Solutions is
delivered with new authorization objects. SAP authorization object SAP_ALL must
be regenerated to apply the authorizations to this object. The delivered authorization
objects are described in the following sections in OpenText Vendor Invoice
Management for SAP Solutions - Configuration Guide for Foundation (VIM-CGF):

• Workplace Configuration: “Authorization objects” on page 303

• Process Configuration: “Authorizations” on page 260

With the Foundation component of Vendor Invoice Management for SAP Solutions,
the following general authorization objects are delivered:

14 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 2.3. Configuring logical systems

Authority Description Usage

J_6NPF_NAV Checks navigation in workplace according VIM Central Workplace
to the workplace ID. For more
information, see “Authorization objects”
on page 303.
J_6NPF_WTY Checks work object type with related VIM Central Workplace
actions, functions, and nodes. For more
information, see “Authorization objects”
on page 303.
J_6NPF_PRF Checks the process configuration profile Processing Screen
with profile ID, characteristic attribute, Business Process
and process step. For more information,
see “Authorizations” on page 260.
J_6NPF_ADM Is checked in all administrative reports, Administration
transactions, and programs. For more
information, see “Authorization objects”
on page 303.
J_6NPF_RFC Is checked in all RFC functions and Processing
executable programs. For more
information, see “Authorization objects”
on page 303.

2.3 Configuring logical systems

The VIM Central Workplace can connect to various systems and collect related data
from these systems.

The Inbound Configuration also enables a multiple-system access by starting the

application process on a specific target system when using one system for document
registration.

Caution
On each system running VIM Foundation, exactly one entry with LOCAL
as logical system must exist. For this entry, no RFC destination must be
maintained.

For every system that needs to be connected, an additional entry is

required. For more information, see “Configuring logical systems”
on page 24.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 15

 Part 1
Customizing
Part 1 Customizing

VIM Foundation provides different components, which are each configured in a

special area in the /OTX/PF00_IMG IMG transaction.

Important

• Do not change the delivered customizing entries of BC Sets but create new
profiles and new settings.
• New configuration must have the prefix Z_ or 9xx according to the data
element.

18 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

Chapter 3
General settings

The general settings are global settings, which are used in different areas.

The General Settings customizing structure in the /OTX/PF00_IMG transaction

contains all views that are relevant for the different components.

3.1 Configuring general settings

The general settings are used to configure global parameters.

To configure general settings:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > General Settings
> General Settings.
3. In the General Settings Overview screen, configure the following global
parameters.

Validity time for locks in seconds

Enter the validity time for lock entries.
Note: The validity time is only used in the context of the Fiori Task
App. Lock entries in SAP GUI only get a timeout if a session timeout
occurs. For more information, see “Configuring locking” on page 20.
Validity for data collections in seconds
Define the validity time for data collections in seconds. Clean up reports
like /OTX/PF62_ADMIN only remove data collections that are not valid
anymore.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 19

Chapter 3 General settings

Logo is displayed in Workplace and Index Screen

Enter X to display the logo in VIM Central Workplace and Processing
Screen.
Logo description for accessibility mode
Enter a meaningful description for the logo, which will be used in
accessibility mode, for example by a screen reader software.
Height of logo
Enter the height of the logo if a custom logo must be displayed with
individual height.
URL for logo
Enter the URL for the logo that is displayed in VIM Central Workplace and
Processing Screen. You can upload a custom logo with the SMW0 transaction.
Location for Document URL generation for Fiori App
Enter EXTSDOKLOC to define the external location that is used at the URL
generation for a document, if the URL is requested from the Fiori Task App.
For more information, see “Accessing archived documents using a proxy
service” on page 335.
Inbound Destination for bgRFC
Enter the inbound destination to start background RFC modules. This is an
optional parameter. If the parameter is not defined, the default inbound
destination /OTX/PF00_BGRFC_INB_DEST is used.
Background RFC is used while processing responses from IES
asynchronously.
Server Group for pRFC
Enter the server group that starts the parallel RFC modules. By default, all
available application servers are used to start parallel RFC modules.
Parallel RFC is used when processing responses from IES asynchronously.

3.1.1 Configuring locking

A general locking mechanism for SAP GUI transactions and the Fiori Task App is
available. This locking mechanism works comprehensively and independently of
solutions.

This mechanism concatenates the key fields of the object to a key for the object
identification. This key has a maximum length of 117 characters. The Fiori Task App
builds this key as defined in the key definition of the work object type. For more
information, see “Defining keys for the work object type” on page 375.

For the key definition, the Process Configuration always uses the fields PROJECT_ID,
PLKEY, and WI_ID. Work object types for process instances of the Process
Configuration must use exactly these fields. The standard lock is always set in the
logical system of the object.

All locks have a limited validity. By default, the validity is 1800 seconds.

20 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 3.1. Configuring general settings

To change the lock validity:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > General Settings

> General Settings.

3. In the General Settings Overview screen, change the lock validity using the
parameter Validity time for locks in seconds.

The Fiori Task App can request a change for a lock entry. In this case, a check value
checks if the change applies to the same lock entry that was originally requested by
this instance of the Fiori Task App. This check value is generated and returned to the
requestor at the set of lock entries. You must use the check value as import
parameter for all further changes that are requested for this lock entry.

You can implement additional lock operations using the /OTX/PF00_LOCK BAdI.
This BAdI has the following interface.

CHECK_LOCK_WOBJ method – This method is called to check if an object is

locked. This method is only called if the standard BC check does not find a lock
entry for this object.

Parameter Type Description

PI_ID Importing Object ID
PI_WOBJ_TYPE Importing Work object type
PI_CHECK_VALUE Importing Generated check value created at the set of
the standard lock entry
PIS_LOCK Importing Existing entry in locking table
PC_LOCK_ED Changing Is object locked?
PCS_LOCK_MESSAGE Changing Message

SET_LOCK_WOBJ method – This method is called when an instance of a work

object type is locked.

Parameter Type Description

PI_ID Importing Object ID
PI_WOBJ_TYPE Importing Work object type
PI_MODE Importing Mode (Web UI or SAP GUI)
PI_LOGSYS Importing Logical system
PI_CHECK_VALUE Importing Generated check value created at the set of
the standard lock entry

VIM200405-CGF-EN-02 Configuration Guide for Foundation 21

Chapter 3 General settings

Parameter Type Description

PC_LOCK_STATUS Changing Possible values:
SUCCESS - Successfully locked
LOCKED - Foreign lock
TECH_ERROR - Technical error
TIMEOUT - Lock is not valid anymore
PCS_LOCK_MESSAGE Changing Message
PC_LOCK_TIMEOUT Changing This parameter contains the calculated
time when the lock ends. It can be
changed within these BAdI’s methods.
The changed time is then considered by
the standard BC lock / locking mechanism.

SET_LOCK_PROJECT method – This method is called when a process instance is

locked.

For the interface, see “SET_LOCK_WOBJ method” on page 21. Instead of parameter
PI_WOBJ_TYPE, parameter PI_PROJECT is used. It contains the project ID of the
corresponding process instance.

REMOVE_LOCK_WOBJ and REMOVE_LOCK_PROJECT methods – These

methods are called when an instance of a work object type or a process instance is
unlocked.

Parameter Type Description

PI_ID Importing Object ID
PI_WOBJ_TYPE or Importing Work object type or
PI_PROJECT Project ID
PI_MODE Importing Mode (Web UI or SAP GUI)
PI_LOGSYS Importing Logical system
PI_CHECK_VALUE Importing Generated check value created at the set of
the standard lock entry

UPDATE_LOCK_WOBJ and UPDATE_LOCK_PROJECT methods – These

methods are called when the lock for a work object type instance or a process
instance is updated. Time out is exceeded.

Parameter Type Description

PI_ID Importing Object ID
PI_WOBJ_TYPE or Importing Work object type or
PI_PROJECT Project ID
PI_MODE Importing Mode (Web UI or SAP GUI)
PI_LOGSYS Importing Logical system

22 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 3.1. Configuring general settings

Parameter Type Description

PI_CHECK_VALUE Importing Generated check value created at the set of
the standard lock entry
PC_LOCK_STATUS Changing Possible values:
SUCCESS - Successfully locked
LOCKED - Foreign lock
TECH_ERROR - Technical error
TIMEOUT - Lock is not valid anymore
PCS_LOCK_MESSAGE Changing Message
PC_LOCK_TIMEOUT Changing This parameter contains the calculated
(UPDATE_LOCK_WOBJ only) time when the lock ends. It can be
changed within these BAdI’s methods.
The changed time is then considered by
the standard BC lock / locking mechanism.

DELETE_LOCK_WOBJ and DELETE_LOCK_PROJECT methods – These methods

are called when the lock entry for a work object type instance or a process instance is
deleted.

Parameter Type Description

PI_ID Importing Object ID
PI_WOBJ_TYPE or Importing Work object type or
PI_PROJECT Project ID
PI_MODE Importing Mode (Web UI or SAP GUI)
PI_LOGSYS Importing Logical system

CONVERT_OBJECT_ID_WOBJ and CONVERT_OBJECT_ID_PROJECT

methods – With these methods, you can replace the technical object key with any
other text. These methods are called, for example, before messages are displayed, so
that the user gets a meaningful object description.

Parameter Type Description

PI_ID Importing Object ID
PI_WOBJ_TYPE or Importing Work object type or
PI_PROJECT Project ID
PI_MODE Importing Mode (Web UI or SAP GUI)
PI_LOGSYS Importing Logical system
PC_ID_TEXT Changing Description of the object instance, which is
used in messages instead of technical
object key

VIM200405-CGF-EN-02 Configuration Guide for Foundation 23

Chapter 3 General settings

3.2 Configuring logical systems

The VIM Central Workplace can connect to various systems and collect related data
from these systems.

The Inbound Configuration enables a multiple-system access, as well. The

application process can start on a specific target system when using one system for
document registration.

Caution
On each system running VIM Foundation, exactly one entry with LOCAL
as logical system must exist. For this entry, no RFC destination must be
maintained.

For every system that needs to be connected, an additional entry is

required.

To configure logical systems:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > General Settings
> Logical Systems.

3. In the Logical Systems Overview screen, configure logical systems, using the
following parameters.

Logical system
Name of the logical system. See the SAP documentation on how to set up a
logical system.
Description
Enter a description of the system.
RFC for System Communication
Enter the RFC destination for communicating to the system. OpenText
recommends that you use this RFC destination with system or
communication users, not with dialog users. See the SM59 transaction to
create an RFC destination.
RFC for Dialog Communication
Enter the RFC destination for communicating by active dialog screen.
OpenText recommends that you use a trusted RFC destination in this case.
See the SAP documentation on how to set up trusted connections between
SAP ERP systems.

24 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 3.3. Configuring VIM solutions

3.3 Configuring VIM solutions

The Solutions activity in the General Settings folder of /OTX/PF00_IMG allows to
define solutions and assign objects to the solutions. This customizing is used to
evaluate the framework version that is currently supported by the solution
implementation.

If a solution is enhanced or changed you need to assign additional objects to the

solution definition.

To configure VIM solutions:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > General Settings

> Solutions.

3. In the Change View “Solutions: Overview screen, define solutions

Solution Id
ID of the solution.

Version
Solution version.

Version (OTBCBAS)
Framework version.

Description
Description of the maintained solution version.

4. Optional If a solution is enhanced or changed, mark the solution and double-click

the Assigned Objects folder in the Dialog Structure.

5. Assign the additional objects to solutions, using the following parameters.

Type
Available object types are Inbound Classification Profile, Process
Foundation Profile, Process Configuration Profile and Workplace Work
Object Type.

Object Id
ID of the object.

ID Addition
Addition to the Id, used for the versions of Process Configuration Profiles
and Process Foundation Profiles.

Description
Option to maintain a description of the object .

VIM200405-CGF-EN-02 Configuration Guide for Foundation 25

Chapter 3 General settings

3.4 Configuring plug-in integration

Different end-user screens (VIM Central Workplace, Processing Screen) are enabled
to use integrated plug-in views to display detail information for a process.

The following customization steps are necessary:

• Define the plug-in type

• Define the plug-in ID
• Assign the plug-in IDs to plug-in types
• Assigning the plug-in IDs to business objects

Business Center delivers the following application plug-ins:

Processing Screen

• Display archived image: /OTX/PF41_CL_PLUGIN_IDX_IMAGE

• Display Line Items: /OTX/PF41_CL_PLUGIN_IDX_ITEMS
• Display Comments: /OTX/PF41_CL_PLUGIN_IDX_NOTE
• Display History: /OTX/PF41_CL_PLUGIN_IDX_HIST
• Display Attachments: /OTX/PF41_CL_PLUGIN_IDX_ATTACH

VIM Central Workplace - Process work object

• Display archived image: /OTX/PF31_CL_PLUGIN_BPF_IMAGE

• Display Line Items: /OTX/PF31_CL_PLUGIN_BPF_ITEMS
• Display Comments: /OTX/PF31_CL_PLUGIN_BPF_NOTE
• Display History: /OTX/PF31_CL_PLUGIN_BPF_HIST
• Display Agents: /OTX/PF31_CL_PLUGIN_BPF_AGENT
• Display BPF Process Log: /OTX/PF31_CL_PLUGIN_BPF_LOG
• Display Attachments: /OTX/PF31_CL_PLUGIN_BPF_ATTACH

VIM Central Workplace - Inbound Configuration work object

• Display External Data: /OTX/PF32_CL_PLUGIN_IDF_EXTDAT

• Display History: /OTX/PF32_CL_PLUGIN_IDF_HIST
• Display Image: /OTX/PF32_CL_PLUGIN_IDF_IMAGE
• Display Application Log: /OTX/PF32_CL_PLUGIN_IDF_LOG
• Display Entity Candidates: /OTX/PF32_CL_PLUGIN_IDF_ENTITY
• Display Extraction Trace: /OTX/PF32_CL_PLUGIN_IDF_PART

26 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 3.4. Configuring plug-in integration

• Display Attachments: /OTX/PF32_CL_PLUGIN_IDF_ATTACH

VIM Central Workplace– IES Profile work object

• Display Activity Log: /OTX/PF32_CL_PLUGIN_PROF_ACLOG

• Display Error Log: /OTX/PF32_CL_PLUGIN_PROF_ERLOG

VIM Central Workplace– IES Request work object

• Display History: /OTX/PF32_CL_PLUGIN_IES_R_HIST

• Display Error Log: /OTX/PF32_CL_PLUGIN_IES_R_LOG

VIM Central Workplace– IES Pre-Learning work object

• Display Log: /OTX/PF32_CL_PLUGIN_CLM_LOG

VIM Central Workplace - Mixed work objects

• Display SD document flow: /OTX/PS99_CL_SD_DOCFLOW

• xECM Workspace: /OTX/PFRM_CL_PLUGIN_WOBJ

Note: To integrate the xECM Workspace plug-in into the VIM Central
Workplace, you must assign the delivered xECM plug-in ID to the
related plug-in types (see “Assigning the plug-in IDs to plug-in types”
on page 30) because this setting is not delivered in a BC set.
The following plug-in IDs are delivered in the xECM Integration BC set.
You can assign them to the corresponding plug-in types:

– PFRM_ECM_CUST - Display Customer Workspace (object KNA1) using

field KUNNR
– PFRM_ECM_CUST2 - Display Customer Workspace (object KNA1) using
field KUNAG
– PFRM_ECM_VEND - Display Vendor Workspace (object LFA1) using
field LIFNR
• GOS Attachment List: /OTX/PF31_CL_PLUGIN_BPF_GOSAT

VIM200405-CGF-EN-02 Configuration Guide for Foundation 27

Chapter 3 General settings

3.4.1 Defining the plug-in type

To use different plug-ins in different end-user screens, a plug-in type definition is
used to combine all plug-ins within one control.

To define the plug-in type:

1. Run the /n/OTX/PF00_IMG transaction and navigate to OpenText Vendor

Invoice Management Foundation > General Settings > Processing Plug-In
Configuration > Define Plug-In Types.

2. In the Plug-In Type Definition Overview screen, define the plug-in type, using
the following parameters:

Plug-In Type
Unique ID of a plug-in type to be used within an end-user screen.
Plug-In Type Description
Enter a description of the plug-in type.

3.4.2 Defining the plug-in ID

The plug-in ID definition describes all necessary technical information for the called
plug-in.

To define the plug-in ID:

1. Run the /n/OTX/PF00_IMG transaction and navigate to OpenText Vendor

Invoice Management Foundation > General Settings > Processing Plug-In
Configuration > Define Plug-In IDs.

2. In the Plug-In Definition Overview screen, define the plug-in ID, using the
following parameters:

Plug-In ID
Unique ID of the plug-in.
Plug-In title
Enter the title of the plug-in, which is displayed on the button in the plug-in
toolbar.
Plug-In description
Enter the tooltip of the plug-in, which is displayed on the button in the
plug-in toolbar.
Plug-In class
To process the corresponding logic for the plug-in, enter the class to be
called during runtime.
For more information, see “Methods of the plug-in superclass /OTX/
PF00_CL_PLUGIN” on page 29.

28 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 3.4. Configuring plug-in integration

Note: You may want to create a completely new plug-in from scratch
for which no suitable standard class implementation is already
available. In this case, you must create your own plug-in class with
superclass /OTX/PF00_CL_PLUGIN.
Plug-In Icon
Enter the icon of the plug-in, which is displayed on the button in the plug-in
toolbar.

Methods of the plug-in superclass /OTX/PF00_CL_PLUGIN

The following methods are available for redefinition. OpenText recommends that
you do not change any other method.

PLUGIN_CONTROL_INIT – You must use this method to initiate a plug-in SAP

GUI control.

Parameter Parameter type Description

PIH_PARENT Importing Parent control to which the plug-in control
must be embedded
PIH_DATA Importing Currently used plug-in data context

PLUGIN_CONTROL_REFRESH – You must use this method to refresh a plug-in

SAP GUI control.

Parameter Parameter type Description

PIH_PARENT Importing Parent control to which the plug-in control
must be embedded
PIH_DATA Importing Currently used plug-in data context

FREE – You must use this method to reset the corresponding plug-in SAP GUI
control and any used data or class attributes.

PLUGIN_ACTIVE_SKIP – Use this method to apply any custom logic in order to

dynamically skip the creation of the corresponding plug-in button during runtime.

Parameter Parameter type Description

PE_SKIP Returning Dynamically skip the plug-in button
creation during runtime.

PLUGIN_BUTTON_MODIFY – Use this method to modify the appearance of the

created plug-in button during runtime.

Parameter Parameter type Description

PC_ICON Changing Button icon
PC_TITLE Changing Button title text

VIM200405-CGF-EN-02 Configuration Guide for Foundation 29

Chapter 3 General settings

Parameter Parameter type Description

PC_TOOLTIP Changing Button tooltip

PLUGIN_DATA_CONTEXT_SET – You must use this method to set the plug-in

data context.

3.4.3 Assigning the plug-in IDs to plug-in types

You define the possible plug-ins for a plug-in type within the mapping. For each
defined plug-in type, all plug-in definitions are maintained.

To assign plug-in IDs to plug-in types:

1. Run the /n/OTX/PF00_IMG transaction and navigate to OpenText Vendor

Invoice Management Foundation > General Settings > Processing Plug-In
Configuration > Assign Plug-In IDs to Plug-In Types.

2. In the Plug-In Type Mapping Overview screen, assign plug-in IDs to plug-in
types, using the following parameters:

Plug-In Type
Unique ID of the plug-in type definition.
Plug-In ID
Unique ID of the plug-in definition.
Plug-In Sequence
Define the order of the buttons for the plug-in.
Handle
Define a unique ID of the Handle.
For one plug-in type you can assign different plug-in definitions that
implement an ALV table control (for example History, Actual Agent or Line
Items). For each ALV table control, you can store an individual layout. To
provide this functionality if there are several plug-in definitions assigned to
one plug-in type, the Handle must be different for the plug-in IDs that
implement an ALV table control.
Note: Special number ranges are used for Handle values, any custom
plug-ins must use the Handle number range 8000 - 9999.
PI Active
Select this check box to activate the plug-in on the screen.

30 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 3.5. Configuring logging

3.4.4 Assigning plug-in IDs to business objects

You can assign plug-in IDs that are used in a different business context to different
business objects. For the Extended ECM for SAP Solutions plug-in and the GOS
attachment plug-in, you must assign the plug-in to the specific business object and
to the related key fields of the business object of the source data structure.

To assign plug-in IDs to business objects:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > General Settings
> Processing Plug-In Configuration > Assign Plug-In IDs to Business Object.
3. In the Plug-In Business Object Relation Overview screen, assign plug-in IDs to
business objects, using the following parameters.

Plug-In ID
Unique ID of the plug-in definition.
Object Type
Enter the SAP business object type used by the plug-in.
Field List (Key)
Enter key fields of the business object in a comma-separated list. The key
fields are used in the data context provider of the plug-in class to get the
related information.

3.5 Configuring logging

The application log is used to store the status information of each task of the
incoming document handler. Like the Incoming Document Framework (IDF), all
other components create an application log that you can use to check the status in
case of any issue.

To view the application log, run the SLG1 transaction. You can access the whole
application log in the /OTX/PF00 object. To access a specific component of the log,
you can use the related sub-objects.

Sub-objects of /OTX/PF00

• /OTX/PF00: Basic functions logs component OTBCBAS

• /OTX/PF01: Inbound Configuration logs component OTBCFND / OTBCBAS
• /OTX/PF02: Process Foundation logs component OTBCFND / OTBCBAS
• /OTX/PF03: Workplace Configuration logs component OTBCFND / OTBCBAS
• /OTX/PF05: Web Services - Metadata logs component OTBCWSR / OTBCWUI
• /OTX/PF06: Web Services - Data provider logs component OTBCWSR / OTBCWUI
• /OTX/PF08: Analytics Configuration logs component OTBCFND / OTBCBAS

VIM200405-CGF-EN-02 Configuration Guide for Foundation 31

Chapter 3 General settings

• /OTX/PFRM: Extended ECM Integration logs component OTBCRM

• /OTX/PF61: Web Services - Interface logs component OTBCFND / OTBCBAS /
OTBCWSR / OTBCWUI

3.5.1 Configuring log levels

To configure what information should be logged, you can globally configure a log
level for the related component.

To configure log levels:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > General Settings

> Logging > Log Levels.

3. In the Log Levels Overview screen, configure log levels, using the following
parameters.

Object
Name of the log object
Subobject
Name of the detailed log-subobject
Loglevel
Enter the level at which issue types should be logged (this level and higher)

• very important
• important
• medium
• Additional information
• Other

Days to expiry
Number of days until the created log entries expire. This setting is only
used if no detailed setting is found on log point level. If both values are not
maintained a default value of 90 days is used.

32 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 3.5. Configuring logging

3.5.2 Configuring log points

The log point is a unique identifier for application or application area. The log point
helps in finding the area that is generating the message. The log point determines
the program from where the error is generated. Because the system is maintained
using Object and Subobject, the log point also determines them. If the log level is not
maintained at Log Point level, the global log level will be used; see “Configuring log
levels” on page 32.

To configure log points:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > General Settings

> Logging > Log Points.

3. In the Log Points Overview screen, configure log points, using the following
parameters.

Log Point
Unique log point
Short Text
Enter a description of the log point.
Program Name
Enter the name of the program or the part name of the program where the
log entry is written
Object
Enter the name of the log object
Subobject
Enter the name of the detailed log-subobject
Loglevel
Enter the level at which issue types should be logged (this level and higher)

• very important
• important
• medium

VIM200405-CGF-EN-02 Configuration Guide for Foundation 33

Chapter 3 General settings

• Additional information
• Other

Days to expiry
Number of days until the created log entries expire. If no value is
maintained the log level setting is used. If both values are not maintained, a
default value of 90 days is used.

3.6 Integrating translation services

You can integrate an external web service for the translation of the process
comments in the Fiori Task App and in the comments plug-in of the Workplace and
SAP Processing Screen.

3.6.1 Configuring languages

To configure languages for the translation service:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation> General Settings >

Translation Service > Languages.

3. In the Languages Overview screen, configure languages, using the following

parameters:

Language:
SAP language key

Language Key:
Language key used within the translation service

3.6.2 BAdI for translation service

To activate the translation option, you also must implement the following BAdI to
call the web service:

Enhancement spot
/OTX/PF00_ES_SRV_TRANSLATION

BADI
/OTX/PF00_BADI_TRANSLATION

You must implement the following methods. The methods in the example class
maintained in the enhancement spot contain further instructions.

34 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 3.7. Configuring Analytics

GET_AVAILABLE_LANGUAGES
This method returns the allowed target languages for translations. Required are
the language key in the format for the translation service and the corresponding
SAP language key with the description.
The /OTX/PF00_CL_TRANSLATION_FALL example class B provides logic to read
the available languages from the language configuration. Copy the example
class during your BAdI implementation.

CALL_TRANSLATION_SERVICE
In this method, you can implement the call to the external translation service.
You find examples how to call the web service in the API description of the
chosen service provider.
You must send the input string (PIV_INPUT) to the external service. You must
export the translated string in export parameter PEV_TRANSLATED_STRING. The
requested language is imported in parameter PIV_LANGUAGE.

Note: As the source language of the comment string cannot be safely

determined from ABAP side, an additional call to a language
determination service might be necessary. Some translation services
include this determination when calling the translation service.

IS_ACTIVE
This method returns whether the Translate action should be displayed in the
Fiori apps. To activate this functionality globally, you can set the export
parameter PEV_ACTIVE to true (X) without any further logic.
The method provides several import parameters for more complex activation
logic, for example to build activation logic based on authorizations.

3.7 Configuring Analytics

Regarding analytic evaluations, different requirements exist.

SAP provides a lot of different tools to create analytic reports, for example SAP
Smart Business, SAP Lumira, SAP BW, SAP Business Objects, or the classic SAP GUI
ALV.

Due to this variety of tools and due to the fact that all customers have different
reporting requirements, OpenText does not provide an Analytics report.

What OpenText provides is a layer with a lot of data, prepared for evaluations. This
data may serve as a base for end user reports, which you can create using your
preferred reporting tool.

You can perform analytic evaluations on database tables that are written throughout
the process. These database tables contain the transactional data.

However, key figures may need to be transformed into different formats or they
need to be calculated “on the fly”.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 35

Chapter 3 General settings

In these cases, the runtime of analytic reports may decrease very quickly when the
amount of documents is growing. This is the reason, why OpenText decided to
introduce a further set of database tables, especially designed for the purpose of
Analytics. Let us call them Analytics database tables, being part of an Analytics
layer. You can configure whether these Analytics database tables are written or not.

This section describes this and other settings regarding the Analytics layer:

• It provides details how to configure the update of the Analytics layer.

• It provides details of the basic Analytics class that is updating the Analytics
database layer.
• It describes the available characteristics and key figures of the Analytics database
layer.

3.7.1 Introduction: Analytics Database Schema

The end-to-end process may start with the inbound process, where the incoming
document is extracted and validated. After that, the business process starts and
consumes the data populated from inbound process. The analytics component
contains the following two parts:

• Analytics for business processes

• Analytics for inbound processes

Regarding analytic evaluations for inbound and business processes, different

requirements may exist. By configuration, you can activate Analytics database tables
Analytics database tables for inbound and business processes. For more information,
see “Configuring the Analytics profile” on page 48. If not activated, the tables will
stay empty. With these tables, a lot of different evaluations are possible. This section
gives an introduction to the most important tables for evaluations for inbound and
business processes.

The following graphic shows a Structured Entity Relationship (SERM) diagram of

the most important database tables that are available for analytic evaluations for
inbound and business processes.

36 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 3.7. Configuring Analytics

Header related Analytics data

This database table comprises characteristics and key figures on process ledger
header level, like the total duration of the process or the number of touches per
document.
Activity related Analytics data
This database table comprises characteristics and key figures on user activity
level. In this context, an activity is defined as a processing unit of an end user.
This means, an activity starts as soon as an end user opens a work item in the
VIM Central Workplace to work on it. It ends as soon as the work item is closed.
An activity also starts as soon as an end user starts editing data in the Fiori Task
App. It ends as soon as the end user clicks the Save button. An example for a
key figure related to an activity is the duration of an activity or the number of
actions done during an activity.
History related Analytics data
This database table comprises characteristics and key figures on history level. A
history logs all the actions of an end user. An example for a characteristic on
history level is the calendar week in which the action was started.
Process Step Log
This database table comprises snapshots of the process steps that failed or were
checked successfully at different points in time during a process.
Rule Log
This database table comprises snapshots of the rules that failed, passed
successfully, or that were inactive, skipped, or bypassed.
Inbound related Analytics data
This database table comprises characteristics and key figures on inbound
process level.
IES Extraction related Analytics data
This database table comprises characteristics and key figures related to the
extraction process on inbound process level using IES server.

3.7.2 Available characteristics and key figures for business

processes
Currently, no UI is provided to display the basics of the Analytics database layer.
However, a lot of tools for that purpose are available. This section gives an overview
of the available data for Analytics and provides some examples.

• Characteristics are descriptions of fields, such as Customer ID, Sales Organization,

Company Code, Unit of Measure, and Purchase Order Date.
• Key figures are numeric values or quantities, such as Per Unit Sales Price,
Quantity Sold, and Order Placement Cycle Time in days.

Note: The guide can only provide some examples to give an idea about
possible evaluations. You can create a lot more evaluations with the existing
key figures.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 37

Chapter 3 General settings

Time characteristics are calculated using the UTC time zone. Use the available
timestamps in the tables to calculate user-specific time characteristics.

Additionally, you can enhance the Analytics class (see “Analytics class”
on page 53) to provide additional custom or solution specific key figures.

The examples are grouped by the underlying database table.

• “Example evaluations on Header Level” on page 38.

• “Example evaluations on Activity Level” on page 40.
• “Example evaluations on History Level” on page 41.
• “Example evaluations on Process Step Level” on page 42.
• “Example evaluations on Rule Level” on page 43.

3.7.2.1 Example evaluations on Header Level

Name of database table: /OTX/P<+++>_T_PLHA, where <+++> is replaced by 3
characters, for example /OTX/PS02_T_PLHA

With this table, you can design evaluations that deliver key figures on document
level, for example to get the number of documents processed in a given period of
time.

Table 3-1: Characteristics

Name of Characteristic Example for usage

CHANNEL_ID Allows grouping and/or filtering by input channel
Example: Number of documents by channel
START_DATE, Time characteristic that allows grouping and/or filtering by
START_DAY, the start of the process
START_WEEKDAY, Example 1: Number of documents by channel last week
START_WEEK, Example 2: Average number of touches per document and
START_YRWEEK, month in the last year
START_MONTH, …
END_DATE, Time characteristic that allows grouping and/or filtering by
END_DAY, the end of the process
END_WEEKDAY, Example: Number of documents finished last month
END_WEEK,
END_YRWEEK, Note: If a business process is still running, the end
END_MONTH, … characteristics are not populated.
PROC_FINISHED Indicator which easily allows to distinguish running and
finished processes

38 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 3.7. Configuring Analytics

Table 3-2: Key Figures - Process Counts

Name of Key Figure Example for usage

DOC_COUNTER Document Placement (number of documents) or
DOC_COUNTER Document Placement Channels (number of documents by
channel)
NO_ACTIONS Average number of actions per document
NO_CAT_CHECKED Average number of checked manual process steps per
document
NO_CAT_FAILED Average number of failed manual process steps per
document
NO_CAT_FAILED_I Average number of failed manual process steps per
document (at document entry)
NO_MOD_CHECKED Average number of rules needing manual interaction per
document
NO_MOD_BYPASSED Average number of bypassed rules per document
NO_MOD_FAILED Average number of failed rules needing manual interaction
per document
NO_MOD_FAILED_I Average number of failed rules needing manual interaction
per document (at document entry)
NO_DIALOG_ACV Average number of touches per document
NON_TOUCH_IND Perfect Document Placement (number of documents
processed non-touch)

Note: If a business process is still running, the duration key figures are not
populated.

Table 3-3: Key Figures - Timings

Name of Key Figure Example for usage

PROC_DURATION_D, Document Cycle Time (Total process time from start to end)

PROC_DURATION_S,

PROC_DURATION_H,

PROC_DURATION_M
PROC_DURATION_D, Document Cycle Time when rules failed (Total process time
PROC_DURATION_S, when rules failed)
NO_MOD_FAILED

VIM200405-CGF-EN-02 Configuration Guide for Foundation 39

Chapter 3 General settings

Name of Key Figure Example for usage

ACV_DURATION_M, Document Processing Time (Summarized manual
processing time)
ACV_DURATION_D,
Note: The manual processing time cannot be
ACV_DURATION_H,
determined if the dialog step is not finished properly.
ACV_DURATION_S
Example: An end user started editing a document on
his notebook. The user does not close the application
by clicking Save or Cancel but closes the notebook or
terminates the process with operation system means.
In this case, the processing time from the start of the
editing to closing the notebook or terminating the
process is 0.

3.7.2.2 Example evaluations on Activity Level

Name of database table: /OTX/P<+++>_T_ACVA, , where <+++> is replaced by 3
characters, for example /OTX/PS02_T_ACVA

With this table, you can design user and role specific evaluations, for example to get
the number of documents processed by a user or role in a given period of time.

Table 3-4: Characteristics

Name of Characteristic Example for usage

AGENT Allows grouping and/or filtering by user
Example: Number of documents processed by user last
month
ROLE_ID Allows grouping and/or filtering by role
Example: Number of documents processed by role last week
START_DATE, Time characteristic that allows grouping and/or filtering by
START_DAY, start of the activity
START_WEEKDAY, Example: Average number of activities per role and month
START_WEEK, in the last calendar year
START_YRWEEK,
START_MONTH, …
END_DATE, Time characteristic that allows grouping and/or filtering by
END_DAY, the end of the activity
END_WEEKDAY,
END_WEEK,
END_YRWEEK,
END_MONTH, …

Table 3-5: Key Figures - Process Counts

Name of Key Figure Example for usage

ACV_COUNTER Number of touches by user or role in a period of time

40 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 3.7. Configuring Analytics

Name of Key Figure Example for usage

NO_MOD_SUCC_DELT Number of rules solved by user or role in a period of time
NO_MOD_FAIL_DELT Number of rules raised by user or role in a period of time
NO_MOD_BYPA_DELT Number of rules that were bypassed by user or role in a
period of time
NO_ACTIONS Average number of actions per touch by role in a period of
time

Table 3-6: Key Figures - Timings

Name of Key Figure Example for usage

ACV_DURATION_M, Average processing time for a document by role
ACV_DURATION_S
ACV_DURATION_M, Average time spent by user for a document
ACV_DURATION_S
WAIT_TIME_M, Average time it took until users processed the document

WAIT_TIME_D,

WAIT_TIME_H,

WAIT_TIME_S
ACV_DURATION_M, Breakdown between wait time and work time by role

ACV_DURATION_D,

ACV_DURATION_H

ACV_DURATION_S,

WAIT_TIME_D,

WAIT_TIME_S

3.7.2.3 Example evaluations on History Level

Name of database table: /OTX/P<+++>_T_HISA, where <+++> is replaced by 3
characters, for example: /OTX/PS02_T_HISA

With this table, you can design evaluations providing information about user
actions, for example an evaluation how often a specific action, like the Refer action,
has been performed in a given time period.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 41

Chapter 3 General settings

Table 3-7: Characteristics

Name of Characteristic Example for usage

PROFILE_ID, VERSION, Allows grouping and/or filtering by action
ACT_ID Example: Top n actions in the last week (most frequently
executed actions)
PROFILE_ID, VERSION, Together with a JOIN operation to the header table /OTX/
ACT_ID P<+++>_T_PLHA, the following evaluation is possible:
Number of documents with a specific action
AGENT Allows grouping and/or filtering by user
Example: Number of a specific action by user in the last
month
ROLE_ID Allows grouping and/or filtering by role
Example: Number of a specific action per role in the last
quarter
START_DATE, Time characteristic that allows grouping and/or filtering by
START_DAY, point of time when the action was executed
START_WEEKDAY, Example: actions overview (list of actions that were
START_WEEK, executed in a period of time)
START_YRWEEK,
START_MONTH, …

Table 3-8: Key Figures - Process Counts

Name of Key Figure Example for usage

HIST_COUNTER Number of a specific action, for example Refer, by user or
role in a period of time
HIST_COUNTER Together with a JOIN operation to the header table /OTX/
P<+++>_T_PLHA, the following evaluation is possible:
Average number of a specific action, for example Refer, by
document in a period of time

3.7.2.4 Example evaluations on Process Step Level

Name of database table: /OTX/PF08_T_CAT

With this table, you can design evaluations providing information about process
steps, for example an evaluation about the number of documents with a specific,
required process step.

42 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 3.7. Configuring Analytics

Table 3-9: Characteristics

Name of Characteristic Example for usage

PROFILE_ID, Allows grouping and/or filtering by process step
VERSION, Example: Top n failed process steps at document entry
CHARACTERISTIC,
CAT_ID,
CAT_RUN_STAT = ‘2’,
LOG_POINT = ‘800’
PROFILE_ID, Together with a JOIN operation to the header table /OTX/
VERSION, P<+++>_T_PLHA, the following evaluation is possible:
CHARACTERISTIC, Number of documents with a specific process step failed
CAT_ID,
CAT_RUN_STAT = ‘2’

3.7.2.5 Example evaluations on Rule Level

Name of database table: /OTX/PF08_T_MOD

With this table, you can design evaluations providing information about failed or
bypassed rules.

Table 3-10: Characteristics

Name of Characteristic Example for usage

PROFILE_ID, VERSION, Allows grouping and/or filtering by rule
CHARACTERISTIC, CAT_ID, MOD_ID, Example: Top n bypassed rules at document
MOD_RUN_STAT = ‘5’ entry last month
PROFILE_ID, VERSION, Top n failed rules at document entry last month
CHARACTERISTIC, CAT_ID, MOD_ID,
MOD_RUN_STAT = ‘2’
PROFILE_ID, VERSION, Together with a JOIN operation to the header
CHARACTERISTIC, CAT_ID, MOD_ID, table /OTX/P<+++>_T_PLHA, the following
MOD_RUN_STAT = ‘2’ evaluation is possible: Critical channels regarding
number of failed rules
PROFILE_ID, VERSION, Together with a JOIN operation to the header
CHARACTERISTIC, CAT_ID, MOD_ID, table /OTX/P<+++>_T_PLHA, the following
MOD_RUN_STAT = ‘2’ evaluation is possible: Number of documents
where a specific rule failed

VIM200405-CGF-EN-02 Configuration Guide for Foundation 43

Chapter 3 General settings

3.7.3 Available characteristics and key figures for inbound

processes
3.7.3.1 Example evaluation on Inbound process level
An inbound process registers and processes the incoming document of most
business processes.

This section gives an overview of the available data of the inbound process which
can be used for analytics of business processes.

Fields which are not described here are either technical fields or not relevant for
business processes. Some fields are reserved for future use.

Table 3-11: Characteristics

Name Description
INB_SYS Inbound Logical System
CHANNEL_ID Inbound Channel ID
REGID Inbound Registration ID
HANDLE_ID Inbound Handle ID
CLASSIFY Inbound Classify
ORIGIN_TIME Inbound Origin Time
ORIGIN_USER Inbound User
EDI_DOCNUM Inbound IDOC Number
EXTRACTION_IND Indicator that extraction is applied
VALIDATION_IND Indicator that validation is applied
EXTRACTION_TYPE Technical field:
• “CLOUD”: IES-API is applied.
• “”: BCC is applied.
CLOUD_EXTRACTION Technical field:
• “x”: IES Cloud is applied.
• “”: IES on Premise is applied.
PROC_FINISHED Indicator that the inbound process is finished
LOGSYS Logical system of the solution system
PROJECT_ID Profile ID of the solution
PLKEY Process ledger key of the solution
START_DATE Start date of the inbound process
START_TIME Start date of the inbound process

44 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 3.7. Configuring Analytics

Name Description
START_<...> Start week, month, quarter or year
depending on the <...> name
END_DATE End date of inbound process
END_TIME End time of inbound process
END_<...> End week, month, quarter or year depending
on the <...> name
CHANGE_DATE Technical field: Date of the update of the log
entry
CHANGE_TIME Technical field: Time of the update of the log
entry

Note: Timestamps and time characteristics are provided in UTC format.

Table 3-12: Time characteristics

Name Description
TSP_REGISTER Timestamp for the document registration in
the inbound process
TSP_CHANGE Timestamp for an entry change in /OTX/
PF01_T_1REG table.
TSP_FINISH Timestamp for the completion of the
inbound process
TSP_UPDATE Timestamp for an entry update in /OTX/
PF08_T_REGA table
START_DATE Start date of the inbound process
START_TIME Start date of the inbound process
START_<...> Start week, month, quarter or year
depending on the <...> name
END_DATE End date of inbound process
END_TIME End time of inbound process
END_<...> End week, month, quarter or year depending
on the <...> name
CHANGE_DATE Technical field: Date of the update of the log
entry
CHANGE_TIME Technical field: Time of the update of the log
entry

VIM200405-CGF-EN-02 Configuration Guide for Foundation 45

Chapter 3 General settings

Table 3-13: Key figures

Name Description
DOC_COUNTER The dummy document number is 1. When
cumulated it provides the number of
documents for a certain filtering.
PROC_DURATION_S The total inbound process time in seconds.
PROC_DURATION_M The total inbound process time in minutes.
PROC_DURATION_H The total inbound process time in hours.
PROC_DURATION_D The total inbound process time in days.

3.7.3.2 Example evaluation on IES Extraction level

Name of database table: /OTX/P<+++>_T_DEAS, where <+++> is replaced by 3
characters, for example: /OTX/PS02_T_DEAS

With this table, you can design solution-specific key figures information for the IES
Extraction Analytics, for example an evaluation how often a field was correctly
extracted by the Information Extraction Service.

The IES Extraction Analytics solution-specific key figures are only relevant for work
items that were captured and validated by the Information Extraction Service. All
work items ingested by other channels or work items without validation do not lead
to an entry in these tables.

IES extraction analytics measures are calculated for two different “Evaluation
Points”:

• Validation (VA): The logic calculates the differences between the values of the
IES Extraction and the user inputs during the validation.
• Process End (PF): The logic calculates the differences between the values of IES
Extraction and the values, the user inputs during the solution process.

Note: Calculation of “Process End” Call Point: The line item based
calculation based measures are useful only if these lines are used in the
processing. In some cases, for example, invoice solutions, if the line items
from OCR are deleted or replaced, the calculation of IES extraction
Analytics for line items measures fails. This happens because the
connection between the actual invoice document lines and the actual posted
lines was removed. In this case, only the calculation of the header fields can
be used for analysis.

Table 3-14: Key figures

Name of Key Figure Example for usage

H_<FIELDNAME>_CNT For Header field: will be 1 if found in the validation data

46 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 3.7. Configuring Analytics

Name of Key Figure Example for usage

H_<FIELDNAME>_OK For Header field: will be 1 if the extraction delivered the
same value as in the validation, otherwise 0
H_<FIELDNAME>_RATE For Header field: is calculated by 100 *
(H_<FIELDNAME>_OK / H_<FIELDNAME>_CNT)
I_<FIELDNAME>_CNT For Item fields: counts, how often this field was found in
the validation data
I_<FIELDNAME>_OK For Item fields: counts, how often this field was matched
in the extraction results
I_<FIELDNAME>_RATE For Item fields: is calculated by 100 *
(I_<FIELDNAME>_OK / I_<FIELDNAME>_CNT)
INCLUDE /OTX/ This provides general measurements such as total counts
PF08_S_DEA_MEASUREMENTS of header and line item fields. For more information, see
Section 3.6.1 “Inbound Documents” in OpenText Vendor
Invoice Management for SAP Solutions - Administration
Guide (VIM-AGD).

Adding key figures per extraction field needs to be defined according the following
naming convention:

For each extraction field, the key figures are calculated automatically, if the field
names defined in the mapping (<FIELDNAME>, for example BUKRS) match the field
name in the analytics table.

For existing pre-delivered solution tables (/OTX/PSxx_T_DEAS), additional or custom

fields can be added by extending the DEAS Table with a custom Append-Structure. If
the naming of the new fields in the Append-Structure follows the above naming
convention, no additional coding is required to calculate the custom measures. For
more information, see “Analytics class” on page 53

A match is calculated by the following logic:

• Validation data needs to be available and is basis for calculation.

• The validation values are assigned to coordinates on the image (POS_X and
POS_Y filled in table /OTX/PF11_T_DEHI).
• The logic searches for a line match based on the coordinates and calculates each
field in the matched line.
• The validation value is not empty.
• For a match, the validation value is equal the extraction value. Equality is defined
on normalized values, that means after removing trailing zeros.
• Deleted extraction lines are not considered.
• For existing Solutions Beyond Invoice, you can add custom fields in the same
naming convention by appending a custom structure to the existing tables.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 47

Chapter 3 General settings

Notes

– If there are no entries in the Analytics Tables even if all conditions are
met, go to General Settings > Logging > Log Points and set the log level
of Point 800 to Additional Information. For newly started processes,
errors are logged in the application log. Alternatively, to analyze errors
for existing entries, you can use report /OTX/PF08_P_DEAS_UPD in test
mode.
– If the Inbound Process is triggering a process on a different system
(multiple-system access, see “Configuring logical systems” on page 15),
the Analytics data is only calculated if an IES profile with the same name
exists on the inbound and the processing system or if the Inbound System
is configured in General Settings > Logical systems of the Solution
System.

3.7.4 Configuring the Analytics profile

Analytic evaluations can imply different requirements. To enable fast evaluations,
data may need to be prepared and saved on the database. The Analytics
configuration defines these database tables for Analytics purposes and activates or
deactivates the process of writing data to the tables.

To configure Analytics, the following customizing steps are available:

• “Selecting a profile type” on page 48

• “Learning about data levels” on page 49
• “Defining profiles” on page 50
• “Maintaining data tables” on page 50
• “Assigning the Analytics profile to the Process Configuration profile”
on page 53

3.7.4.1 Selecting a profile type

Different scenarios may require the update of database tables for the purpose of
Analytics. One scenario is to prepare and update analytic key figures for business
processes. (Currently this is also the only one.) Each of the scenarios is represented
by a profile type.

The supported scenarios, respectively the profile types, are predefined. Adding new
profile types or deleting existing profile types is not supported.

To select a profile type:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click General Settings > Analytics Configuration > Analytics Configuration.

3. In the Profile Types Overview screen, select a profile type.

48 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 3.7. Configuring Analytics

Profile Type 1 (Process KPIs) is used for writing Analytics data for business
processes.

3.7.4.2 Learning about data levels

You may need data for the purpose of Analytics for different levels. For example,
there may be key figures on level of the process ledger header or there may be key
figures that are related to single user activities.

To learn about data levels:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click General Settings > Analytics Configuration > Analytics Configuration.

3. In the Profile Types Overview screen, mark a profile type, and then double-
click Levels in the Dialog Structure.

4. In the Levels Overview screen, watch the different levels of Analytics data.
The following hierarchy levels for profile type 1 (Process KPIs) are available:

1 - KPIs on Header Level

This level comprises characteristics and key figures on process ledger
header level, for example the total duration of the process or the number of
touches per document.
2 - KPIs on Activity Level
This level comprises characteristics and key figures on user activity level,
for example the processing time from starting to edit a document to leaving
the edit mode by pressing the Save button.
3 - KPIs on History Level
This level comprises characteristics and key figures on history level. A
history entry represents a single user action. This data level allows
evaluations about the different user actions.
4 - KPIs on Inbound Level
This level comprises characteristics and key figures on inbound level and
allows analysis of IES extraction results on field level.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 49

Chapter 3 General settings

3.7.4.3 Defining profiles

A profile within the Analytics Configuration is based on the following questions:

• Which Analytics Profile should be active? This means, it is updating the database
tables for Analytics.
• Which database tables are to be used for the different levels of Analytics data?

Note: With standard delivery, a simple dummy profile DEFAULT is delivered.

This profile is independent from any business scenario data context. You can
use it to start and test the update of example Analytics data.

To define a profile:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click General Settings > Analytics Configuration > Analytics Configuration.

3. In the Profile Types Overview screen, mark a profile type, and then double-
click Profiles in the Dialog Structure.

4. In the Profiles Overview screen, define the profile using the following
parameters.

Profile ID
Define the profile with a unique ID.
Active
To set the profile to active, select this check box. If the profile is inactive, no
data is prepared and updated for the purpose of Analytics.
Prof. Desc.
Profile Description. Enter a meaningful profile description.
Analytics Class
Enter the class that is responsible for the preparation of data for Analytic
evaluations. For more information, see “Analytics class” on page 53.

3.7.4.4 Maintaining data tables

In this step, you define the database tables that serve as a base for Analytics
evaluations for a corresponding business scenario implementation.

Before you can maintain the data tables, you must create the business scenario
related data tables. They must fulfill the following mandatory conditions:

Table 3-15: Mandatory key fields for the Analytics header tables

Field Name Data Element

MANDT MANDT

50 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 3.7. Configuring Analytics

Field Name Data Element

LOGSYS LOGSYS
PROJECT_ID /OTX/PF02_E_PROJECT_ID
PLKEY /OTX/PF02_E_PLKEY

Optional include structure for the Analytics header table:

• /OTX/PF08_S_PLH_ANALYTIC_DATA

Note: The optional include structure comprises several time characteristics to

the process start and process end (field names beginning with START_ or END_).
You can easily include time characteristics for the fiscal year and the fiscal
period in the business scenario context if the company code is available in the
process ledger header table. By appending fields for the company code (field
name: BUKRS), the fiscal year (field names: START_FISCYEAR, END_FISCYEAR),
and the fiscal period (field names: START_FISCPERIOD, END_FISCPERIOD), the
determination of the fiscal year and fiscal period is triggered automatically.

Table 3-16: Mandatory key fields for the Analytics activity tables

Field Name Data Element

MANDT MANDT
LOGSYS LOGSYS
PROJECT_ID /OTX/PF02_E_PROJECT_ID
PLKEY /OTX/PF02_E_PLKEY
LOG_ENTRY /OTX/PF02_E_LOG_ENTRY
TASK_LINE /OTX/PF02_E_LINE
ACV_LINE /OTX/PF02_E_LOG_ENTRY

Optional include structure for the Analytics activity tables:

• /OTX/PF08_S_ACV_ANALYTIC_DATA

Note: The optional include structure comprises several time characteristics to

the activity start and activity end (field names beginning with START_ or END_).
You can easily include time characteristics for the fiscal year and the fiscal
period in the business scenario context if the company code is available in the
process ledger header table. By appending fields for the fiscal year (field
names: START_FISCYEAR, END_FISCYEAR), and the fiscal period (field names:
START_FISCPERIOD, END_FISCPERIOD) in the Analytics activity table and by
appending the company code (field name: BUKRS) in the Analytics header table,
the determination of the fiscal year and fiscal period is triggered automatically.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 51

Chapter 3 General settings

Table 3-17: Mandatory key fields for the Analytics history tables

Field Name Data Element

MANDT MANDT
LOGSYS LOGSYS
PROJECT_ID /OTX/PF02_E_PROJECT_ID
PLKEY /OTX/PF02_E_PLKEY
LOG_ENTRY /OTX/PF02_E_LOG_ENTRY
TASK_LINE /OTX/PF02_E_LINE
ACV_LINE /OTX/PF02_E_LOG_ENTRY
HIST_LINE /OTX/PF02_E_LINE

Optional include structure for the Analytics history tables:

• /OTX/PF08_S_HIST_ANALYTIC_DATA

Note: The optional include structure comprises several time characteristics to

the point of time when the action was performed (field names beginning with
START_). You can easily include time characteristics for the fiscal year and the
fiscal period in the business scenario context if the company code is available
in the process ledger header table. By appending fields for the fiscal year (field
name: START_FISCYEAR) and the fiscal period (field name: START_FISCPERIOD)
in the Analytics history table and by appending the company code (field name:
BUKRS) in the Analytics header table, the determination of the fiscal year and
fiscal period is triggered automatically.

Table 3-18: Mandatory fields for the “IES Extraction Analytics solution-specific
key figures” results tables

Field name Data element Key field

MANDT MANDT Yes
LOGSYS LOGSYS Yes
PROJECT_ID /OTX/PF02_E_PROJECT_ID Yes
PLKEY /OTX/PF02_E_PLKEY Yes
EVALUATION_POINT /OTX/PF08_E_EVALUATION_POINT Yes
REGID /OTX/PF01_E_REGID No
TSP_UPDATE TIMESTAMP No
INB_LOGSYS /OTX/PF08_E_INB_LOGSYS No
INB_PROFILE_ID /OTX/PF11_E_PROFILE_ID No
.INCLUDE /OTX/PF08_S_DEA_MEASUREMENTS No

52 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 3.7. Configuring Analytics

Note: For defining key figures, the naming convention defined in “Example
evaluation on IES Extraction level” on page 46 apply.

To maintain data tables:

1. In the Profiles Overview screen (see “Defining profiles” on page 50), select a
profile, and then double-click Data Tables in the Dialog Structure.

2. In the Data Tables Overview screen, define the data tables using the following
parameters.

Data Hier. Level

Data Hierarchy Level. Enter the hierarchy level to which a data table
belongs. For a list of the available hierarchy levels, see “Learning about data
levels” on page 49.

Table Name
Enter the name of the corresponding Analytics table to be used in the
hierarchy level.

3.7.4.5 Assigning the Analytics profile to the Process Configuration

profile
This step is only required if you want to prepare and update analytic key figures for
business processes.

You have maintained Analytics profiles with profile type 1 (Process KPIs). Assign
these Analytics profiles to the Analytics Profile field in all relevant Process
Configuration profile versions. For more information how to maintain version
settings and especially the Analytics Profile field, see “Maintaining version
settings” on page 212.

3.7.5 Analytics class

For the preparation of data for Analytics evaluations, you must assign each
Analytics class to an Analytics profile. For more information, see “Defining profiles”
on page 50. For every Analytics profile type, a subclass of the basic Analytics class /
OTX/PF08_CL_ANALYTICS_DATA is available. This superclass provides the
ANALYTICS_DATA_INST_CREATE method to create an instance of the profile type
specific subclass. Additionally, it provides some helper methods for general
conversions.

Analytics subclass for Process KPIs

The basic Analytics class for writing data for finished documents is /OTX/PF08_CL_
PROCESS_KPIS, derived from the /OTX/PF08_CL_ANALYTICS_DATA superclass. The /
OTX/PF08_CL_PROCESS_KPIS class prepares general data for analytic evaluations for
business processes and saves the data to the database.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 53

Chapter 3 General settings

Every business scenario must derive a subclass of the /OTX/PF08_CL_PROCESS_KPIS

class. In this subclass, you may want to adjust the default logic or add your own
logic for additional business scenario specific fields.

Create a subclass of the /OTX/PF08_CL_PROCESS_KPIS class or any of its subclasses.

Redefine the following methods:

HEAD_DEFAULT_TABLE_GET – Usually, you maintain the name of the database

table that contains the process ledger header related data for analytic evaluations in
the configuration, see “Maintaining data tables” on page 50. If no database table is
maintained in the configuration, set the name of a default database table.

Parameter Parameter type Description

PR_TABNAME Returning Default table for Analytics data on header
level

ACV_DEFAULT_TABLE_GET – Usually, you maintain the name of the database

table that contains the activity related data for analytic evaluations in the
configuration, see “Maintaining data tables” on page 50. If no database table is
maintained in the configuration, set the name of a default database table.

Parameter Parameter type Description

PR_TABNAME Returning Default table for Analytics data on activity
level

HIST_DEFAULT_TABLE_GET – Usually, you maintain the name of the database

table containing the history related data for analytic evaluations in the configuration,
see “Maintaining data tables” on page 50. If no database table is maintained in the
configuration, set the name of a default database table.

Parameter Parameter type Description

PR_TABNAME Returning Default table for Analytics data on history
level

INBOUND_DEFAULT_TABLE_GET – Usually, you maintain the name of the

database table containing the inbound related data for analytic evaluations in the
configuration, see “Maintaining data tables” on page 50. If no database table is
maintained in the configuration, set the name of a default database table.

Parameter Parameter type Description

Default table for Analytics data on
PR_TABNAME Returning
inbound level

HEAD_DATA_DETERMINE (optional) – You may have added custom or solution

specific fields in the database table that contains the process ledger header related
data for analytic evaluations. In this case, redefine this method. With calling method
head_data_determine of the superclass in the beginning of the code, you can

54 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 3.7. Configuring Analytics

ensure that the standard fields are populated as well. You can also change the
content of the standard fields in your program code.

Parameter Parameter type Description

PIS_HEAD Importing Process ledger header data to be
used but not changed
PIH_ITEM Importing Process ledger item data to be used
but not changed
PES_HEAD_ANALYTICS Exporting Header related Analytics data to be
updated

ACV_DATA_DETERMINE (optional) – You may have added custom or solution

specific fields in the database table that contains the activity related data for analytic
evaluations. In this case, redefine this method. With calling method acv_data_
determine of the superclass in the beginning of the code, you can ensure that the
standard fields are populated as well. You can also change the content of the
standard fields in your program code.

Parameter Parameter type Description

PIS_HEAD Importing Process ledger header data to be
used but not changed
PIS_ACV Importing Activity data to be used but not
changed
PES_ACV_ANALYTICS Exporting Activity related Analytics data to be
updated

HIST_DATA_DETERMINE (optional) – You may have added custom or solution

specific fields in the database table that contains the history related data for analytic
evaluations. In this case, redefine this method. With calling method hist_data_
determine of the superclass in the beginning of the code, you can ensure that the
standard fields are populated as well. You can also change the content of the
standard fields in your program code.

Parameter Parameter type Description

PIS_HEAD Importing Process ledger header data to be
used but not changed
PIS_HIST Importing History data to be used but not
changed
PES_HIST_ANALYTICS Exporting History related Analytics data to be
updated

INBOUND_DATA_DETERMINE (optional) – You may have added custom or

solution specific fields in the database table that contains the “IES Extraction
Analytics solution-specific key figures”. If these fields follow the name conventions
defined in “Example evaluation on IES Extraction level” on page 46, there is no need
to add custom logic.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 55

Chapter 3 General settings

In more complex custom use cases, redefine this method. With calling method
inbound_data_determine of the superclass in the beginning of the code, you can
ensure that the standard fields are populated as well. You can also change the
content of the standard fields in your program code. Alternatively, you can create a
custom subclass of /OTX/PF08_CL_INB_ANLY_CALC and adjust the calculating logic
itself.

Parameter Parameter type Description

Process ledger header data
PIS_HEAD Importing
to be used but not changed
Extraction result history to
PIT_DATA_EXT_RESLT_HIST_INB Importing
be used but not changed
Extraction analytics data (to
PES_EXTRACTION_ANALYTICS Exporting
be changed)

3.8 Configuring image caching

Image caching allows optimized access to content repository when displaying
document images in SAPGUI and SAPGUI for HTML. When activated, the image is
not read directly by the browser instance running on end user workstation, but it is
read from the SAP ERP / S/4HANA application server and then sent from the
application server to the end user workstation.

The caching helps reduce read accesses during processing of the same document
(workitem) because the document is read only once. The same mechanism can also
be helpful in cases when you need to restrict the direct network access from end user
workstations to the content repository (for example, in VPN environments).

Note: A similar but separate feature is provided for Fiori apps. For
information, see Stream document in “Configuring basic settings”
on page 372.

You can enable the caching in the following two ways:

• For all documents on all content repositories.

• For specific content repositories and image formats defined by MIME type.

To enable the caching globally for all content repositories:

1. Navigate to General Settings of VIM Foundation customizing.

56 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 3.8. Configuring image caching

2. Create an entry with Image memory cache active with value X.

To enable the caching for specific content repositories and image formats:

1. Navigate to the node Image Caching Control in General Settings of VIM

Foundation customizing.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 57

Chapter 3 General settings

2. For each relevant content repository and MIME type, create an entry with
enabled check box to activate caching.
In the following example. the caching is active for PDFs and deactivated for
TIFF.

Note: If you use the setting per content repository and MIME type, do not
use the global setting.

58 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

Chapter 4
Inbound Configuration

This chapter provides details about the Inbound Configuration. It is part of the
Foundation.

With Inbound Configuration, you define how to import or capture incoming

documents and then dispatch them, for example to a subsequent workflow or to
archiving.

Inbound Configuration allows you to configure the classification scenario . The

classification scenario registers documents for further processing according to their
business context, for example Sales Order or Delivery Note. You also configure how
the documents are processed coming from different channels.

Each document runs through defined process steps, which are indicated by the
inbound handler process. Each process step comprises several service modules.
These service modules are integrated components of Inbound that offer the
functionality.

For Inbound Configuration, you define:

• Channels that define the way how a document is imported into the system. This
can be, for example, paper through scan, fax, email, or IDoc. To configure a
channel, you need the registration type.
• Scenario classifications that identify the different types of business scenarios for
incoming documents. They also define the corresponding target application and
target system that are triggered at the end of the incoming document process.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 59

Chapter 4 Inbound Configuration

• Registration types that define the scenario which is used to import documents.
The import can happen, for example, by email, IDoc or Document Pipeline.
Depending on the registration type, standard SAP customizing is needed, for
example, for ArchiveLink or SMTP.
• Document handlers and service modules that route the incoming document
through the incoming documents process. You must customize them to
sequentially process the document, based on the respective document status.
• Business Center Capture and Information Extraction Service that automate the
capture of paper documents by using OCR to extract data. Business Center
Capture and Information Extraction Service use SAP ERP as backend to store and
retrieve image information.

The Inbound Configuration customizing structure in the /OTX/PF00_IMG transaction

contains all customizing screens that are relevant for handling incoming documents.

Some authorizations are needed to monitor the Inbound Configuration. For more
information, see Example 8-1, “Authorizations necessary to monitor the Inbound
Configuration” on page 304.

4.1 Customizing basic settings for Inbound

Configuration
You configure basic parameters for Inbound Configuration that apply to all
incoming document scenarios.

To customize basic settings:

1. Run the /OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Basic Settings.

3. In the Basic Settings Overview screen, configure settings, using the following
parameters:

ArchiveID for XML

This parameter is mandatory. It is only relevant if Business Center Capture
is used for document extraction. Enter the Content Repository for XML
documents. The repository is used to store and archive the extraction result
of the Business Center Capture.

Capture Cancel Code

Status code delivered by Business Center Capture: Extraction/Validation is
canceled.

Capture Error Code

Status code delivered by Business Center Capture: Extraction/Validation is
in error.

60 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.1. Customizing basic settings for Inbound Configuration

Capture Reject Code

Status code delivered by Business Center Capture: Extraction/Validation is
rejected.

Capture Success Code

Status code delivered by Business Center Capture: Extraction/Validation is
successful.

Default Language
Enter the default language for error messages and fallback.

Delay for Extraction (Minutes)

This parameter is only relevant if Business Center Capture is used for
document extraction.
Enter the delay before sending the document to extraction in minutes.
Use this parameter if there are frequent situations when a document is
selected for extraction but is not yet accessible from the archive.

Exit Extraction Sorting

By default, sorting is done by priority, registration timestamp, and
registration key.
This parameter is only relevant if Business Center Capture is used for
document extraction. Enter the exit function module to sort documents for
extraction. Sorting works according to the available registration data. After
extraction, sorting can also work by the extracted data. Use template
function /OTX/PF01_UTIL_EXIT_EX_SORT.
For documents extracted with IES, the documents are sent to IES according
to the priority in the inbound handler.

Exit Validation Sorting

By default, sorting is done by priority, registration timestamp and
registration key
This parameter is only relevant if Business Center Capture is used for
document extraction. Enter the exit function module to sort documents for
validation. Sorting works according to the available registration data. After
extraction, sorting can also work by the extracted data. Use template
function /OTX/PF01_UTIL_EXIT_VA_SORT.
For documents extracted with IES, you can sort documents for validation
with the handle class exit method to change the document priority,
described in “Creating a document handler” on page 68.

Retry Counter Extraction

This parameter is only relevant if Business Center Capture is used for
document extraction.
Enter the maximum allowed number of retries for extraction. When this
number is reached, the document status is set to error Maximum number of
retries reached.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 61

Chapter 4 Inbound Configuration

Retry Counter Validation

Enter the maximum allowed number of retries for validation. When this
number is reached, the document status is set to error Maximum number of
retries reached.

Look-up Download Entries in Pack

Enter the number of packs that can be downloaded from the Business
Center Capture server to get data from staging tables. The download is
triggered from the Business Center Capture hotspot by calling the /OTX/
PF01_IF_LOOKUP_DOWNLOAD function. If no value is maintained, a default
pack size of 10,000 is used. For more information, see “To create a look-up:“
on page 189.
Look-up Hits Validation
Enter the number of entries within search in validation.
Enter the default number of entries that can be shown when the user
searches online in the Validation Client for entries in staging tables. The
look-up is triggered from Business Center Capture Validation Client by
calling the /OTX/PF01_IF_LOOKUP_VAL function. If no value is maintained
and also no maxhits are provided in the Validation Client, a default of a
1,000 maximum hits is used. For more information, see “To create a look-up:
“ on page 189.
Auto-Forward Extraction Retry
This parameter is only relevant if Business Center Capture is used for
document extraction.
The setting forwards the document automatically to the target application if
the extraction retry counter is reached.
Set this value to X.
The document is not set to error status within inbound processing.
Auto-Forward Validation Retry
Automatically forwards the document to the target application when the
extraction retry counter is reached.
Set the value to X.
The document is not set to error status within inbound processing.
Auto-Forward no Image for Extraction
Automatically forwards the document to the target application, if no image
for extraction exists.
Set the value to X.
The document is not set to error status within inbound processing.
HTTP Connection for Signature Validation Service (AIC)
Intended for future use.
Rendition Server ID
Name of the rendition server which is used in the document handler
process to render documents. For more information, see “Rendition

62 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.1. Customizing basic settings for Inbound Configuration

management” on page 104. The rendition server is configured

within Archiving and Document Access for SAP Solutions.
Rendition Server Profile
Name of the profile to render documents. For more information, see
“Rendition management” on page 104. The rendition server profile (for
example examplePDFA-2b default profile ) is configured within Archiving
and Document Access for SAP Solutions.
Retry and Auto-Forward for Timeout in Document Handler
The setting activates the retry and auto-forward option configuration in the
document handler process for the module. For more information, see
“Configuring modules for the required processing steps” on page 69. If
the document handler is globally in processing status (waiting step), set the
value to X.
Reserve for Validation Time Limit (Seconds)
Only relevant if the Capture Validation Workcenter is used.
Enter the time limit (in seconds) until a document is reserved for validation
in the Capture Validation Workcenter.
Exit for tax rate list
Enter the exit function module to provide a list of all possible tax rates
depending on the vendor, company code, and IES profile countries. You can
use the function module to provide tax rates different from rates
maintained in transaction FTXP. For example, if too many rates are provided
in FTXP, reducing the list will help prevent performance issues. Use
template function /OTX/PS00_TAXRATE_EXIT.
Document Handler for Training Documents
Enter the document handler used to process training documents. Document
handler TRAIN_IES is delivered.
Work Object Type for Capture Validation
Enter the work object type used for the capture validation. If no value is
explicitly set, the default setting is PF32_IES_VAL.
Submit Processing for Capture Validation
Enter the submit processing mechanism used for the Capture Validation.
ASYNC is the default setting if no value is explicitly maintained.
The possible values are:

• ASYNC: Asynchronous submit processing. This requires additional RFC

authorizations. For more information, see OpenText Vendor Invoice
Management for SAP Solutions - Security Guide (VIM-GSM).
• SYNC: Synchronous submit processing.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 63

Chapter 4 Inbound Configuration

4.2 Configuring channels

Channels define the way how a document is imported into the system. This can be,
for example, paper through scan, fax, email, or IDoc. The channel is assigned to a
specific document registration type. For more information, see “Customizing
registration types” on page 71. You can use the channel in solutions to identify
how documents have been imported into the system.

To configure channels:

1. Run the /OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound
Configuration > Channels.
3. In the Channels Overview screen, configure channels using the following
parameters:

Channel
Technical ID of the channel
Registration Type
Select the type of the registration used for this channel. According to the
registration type, the channel ID is available in the registration
configuration. The following registration types are available: Early
Archiving, Idoc, Mail, Upload, Custom. For more information, see
“Customizing registration types” on page 71.
In the current version, the Registration Type is only used to control the F4-
Help in the registration configuration. It has no further technical impact for
any other component or processing logic.
Description
Enter a description of the channel.

4.3 Creating scenario classifications

Scenario classifications are used to identify the different types of business scenarios,
for example Sales Order or Delivery Note, for incoming documents. Scenario
classification also defines the corresponding target application and target system.
The classification is assigned to a specific registration type. For more information,
see “Customizing registration types” on page 71.

To create a scenario classification:

1. Run the /OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound
Configuration > Scenario Classification.
3. In the Scenario Classification Overview screen, configure the scenario
classification, using the following parameters:

64 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.3. Creating scenario classifications

Classification Profile
Technical ID of the classified business scenario

Description
Enter a description of the classification.

Application
Select the target application, which is triggered at the end of the Incoming
Document Framework process for the registered document. The following
target applications are available:

Trigger Process Foundation

Start a business process in Process Foundation (see “Process
Foundation“ on page 195).

Trigger Vendor Invoice Management

Start an invoice process in VIM.

Trigger Custom Processing

Start a custom business application. The Exit Application function
module will be triggered.

Profile ID (PF)
Enter the profile ID of the corresponding Process Foundation (PF)
configuration used for Process Foundation trigger. For more information,
see “Process Foundation profile” on page 206.

Exit Application
Enter the exit function to start any business application used for the Custom
Processing trigger. See template function /OTX/PF01_UTIL_EXIT_APPL.

Logical System
Enter the target system where the business application is started.

Exit System Determination

Optional: Enter the function that is run to determine the target system. Use
the /OTX/PF01_UTIL_EXIT_TARGET_SYS template.

4.3.1 Assigning document types to classifications

To avoid creating different channels for different scenarios, you must configure
additional document types for scenario classifications. This also allows defining
which document types are classified and which ones are not.

This configuration is only necessary in connection with document classification

scenarios. For more information, see “Document classification“ on page 533,
especially “Processing impacts” on page 536.

To assign document types to classifications:

1. Run the /OTX/PF00_IMG transaction.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 65

Chapter 4 Inbound Configuration

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Scenario Classification.
3. In the Scenario Classification Overview screen, mark a scenario classification,
and then double-click Classification Document Types in the Dialog Structure.
4. In the Classification Document Types Overview screen, assign document
types to the classification, using the following parameters.

Classification
Selected classification profile
Doc. Type
Enter document types that you want to assign to the classification.
Category
Select the category of the document type from the list.
The following categories are available:

• Classified
• Unclassified

4.4 Customizing incoming documents through the

document handler
The document handler manages the registration types and the process flow of
incoming documents. Thereby, the document handler considers the corresponding
status handling.

Basis for the document handler is a status queueing engine. You must plan the /
OTX/PF01_P_IDF_TRIGGER report as a periodic job to trigger the service modules
accordingly. For more information, see OpenText Vendor Invoice Management for SAP
Solutions - Administration Guide (VIM-AGD).

Status When a service module finishes its step, it assigns a status to the document. This
status then triggers the next step in the processing sequence.

The status helps, for example, to identify documents that are ready for validation or
need to get extracted.

Important

• The delivered status must not be changed. For custom service modules, use
a new status in the corresponding customer namespace and number range.
• Do not change the delivered customizing entries of BC Sets but create new
profiles and new settings.
• New configuration must have the prefix Z_ or 9xx according to the data
element.

66 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.4. Customizing incoming documents through the document handler

4.4.1 Creating a document handler process

A service module identifies a processing step in the document handler. The
processing steps are assigned to a document handler, which represents the
document flow in Inbound Configuration.

Important
At the last step of the handler process, the target business application is
triggered. The status is set to 99 (Business application / Process started).
After that, the handler is set to the handler end status.

4.4.1.1 Configuring the document handler status

The document handler status defines the status of the document during the Inbound
Configuration process. The status is shown on the History tab of the Detail Pane in
VIM Central Workplace. With the BC set of the Inbound Configuration, status
entries with values between 1 and 100 are delivered.

Important
Do not change the delivered status! If you need to configure an own status, use
a number starting with 900. For more information, see “Customizing”
on page 17.

To configure the document handler status:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Document Handler > Status.

3. In the Status Overview screen, configure statuses, using the following

parameters:

Status
Enter a unique status number.
Description
Enter a meaningful description.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 67

Chapter 4 Inbound Configuration

4.4.1.2 Creating a document handler

The document handler describes the process flow for each incoming document. The
document handler processes different service modules according to their
registration type. For paper-based documents, there is a document handler for
manual indexing and a document handler for processing documents in Business
Center Capture and Information Extraction Service.

To create a document handler:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Document Handler > Modules.

3. In the Handler Overview screen, configure the document handler, using the
following parameters.

Handler
Technical ID of the document handler
Description
Enter the description of the document handler.
Start Handle
Enter the start status of the document handler process.
The start status identifies the status when the document handler is triggered
and processed.
End Handle
Enter the end status of the document handler process.
The end status identifies the status when the whole document handler
process is finished.
Handle Class
Optional: Enter the user exit class to implement additional logic. The user
exit class implements the /OTX/PF01_IF_HANDLER interface.
Methods of interface /OTX/PF01_IF_HANDLER:

EXIT_HANDLER_END
This method allows you to trigger own logic at the end of the handler
processing after the target application is started or in error case.

Parameter Type Description

PIS_1REG Importing Registration data
PIS_PRO Importing Handler data
PIS_PRF Importing Classification profile
PIO_LOG Importing Log object

68 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.4. Customizing incoming documents through the document handler

Parameter Type Description

PI_TEST Importing Handler executed within test mode

CHANGE_PRIO_VALIDATION
This method changes the priority of the document processed in
inbound handler to sort documents for validation. Exit is called within
handler module class /OTX/PF01_CL_MODULE_CC_VALIDA.

Parameter Type Description

PIS_1REG Importing Registration
data
PIT_EXTDATA Importing External data
from BCC
PIT_EXTDATA_CLOUD Importing External data
from IES
PIT_EXTDATA_CLOUD_PATH Importing External data
from IES with
full path
PC_PRIO Changing Priority of the
processed
document

4.4.1.3 Configuring modules for the required processing steps

Modules are the processing steps of the document handler. A module is triggered in
the step sequence. This happens when the end status of the previous module has
been set. This also happens when the corresponding start status is set within the
status engine or outside.

To configure a module:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Document Handler > Modules.

3. In the Handler Overview screen, mark a row, and then double-click Modules in
the Dialog Structure.

4. In the Modules Overview screen, configure the modules, using the following
parameters.

Module ID
Technical ID of the module
Sequence
Define the sequence how the modules are processed.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 69

Chapter 4 Inbound Configuration

Description
Enter the description of the module.
Active
Select this check box to activate the module.
Module Class
Enter the implementation class of the processing logic. Modules must
implement the /OTX/PF01_IF_MODULE interface.
There are possible methods for a custom implementation in the /OTX/PF01_
IF_MODULE interface. For a custom implementation, use a redefinition of
the /OTX/PF01_CL_MODULE_HANDLER class:
PROCESS_MODULE
This method provides logic to process the service module.
The method is called in /OTX/PF01_CL_IDF_TRIGGER within document
handler program /OTX/PF01_P_IDF_TRIGGER

Transformation
Optional: Enter an XSLT transformation program to process an XML
transformation within the module class.
End Status
Enter the status of the module that is set at the end of a module.
The end status must be unique. Do not use status 99. It is reserved for the
business application start.
Start Stat
Enter the start status. You can configure it for modules that must be
triggered only when the start status is set. It is, for example, used in the
communication with Business Center Capture to route documents to the
correct steps, or when steps must be skipped. For example, validation can
be skipped in some cases.
Error Stat
Enter the error status, which is set in error case.
Time limit
Enter the maximum time limit (in seconds) for a module to finish its
processing. If the time limit is reached, the module is set into error status.
The time limit is only taken into account if the document handler is globally
in processing status. The No.ofRetry setting is not relevant because the
module is set into error status immediately after the time is reached.
If the basic setting Retry and Auto-Forward for Timeout in Document
Handler is activated the No.ofRetry will be taken into account. For more
information, see “Customizing basic settings for Inbound Configuration”
on page 60.
A module waiting for the extraction result of a Business Center Capture
integration should have a time limit of 7200. A module waiting for the

70 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.4. Customizing incoming documents through the document handler

validation result of a Business Center Capture integration should have a

time limit of 3600.
No.ofRetry
Enter the number of retry attempts for a service module in error case. When
the number is reached, the processing handler or document flow is set into
error status.
Timeout Status
Enter the timeout status, which is set when the time limit of the module
(waiting step) has been exceeded.
The basic setting Retry and Auto-Forward for Timeout in Document
Handler must be activated. For more information, see “Customizing basic
settings for Inbound Configuration” on page 60.
Continue/Forward
Allows to alter the default processing in case when errors happen or
timeout is reached. The following settings can be used:

• Default (empty): The processing stops (after specified retry) in case of

errors or timeout.
• C = Continue after error: When an error is raised by the processing step,
it is ignored. The specified end status is set and the processing continues
to the next step.
• Auto-Forward after Retry:: Automatically forwards the document to the
target application when the retry counter is reached. To get a timeout
error the Basic setting Retry and Auto-Forward for Timeout in
Document Handler must be activated. For more information, see
“Customizing basic settings for Inbound Configuration” on page 60

4.4.2 Customizing registration types

Document registration is the initial touch-point of a document with SAP ERP and
the entry point for Inbound Configuration. Document registration in Inbound
Configuration can be done in different ways. The following registration types are
available:

• Early Archiving
• Inbound IDoc
• Incoming Mail
• Pipeline
• Custom / Others
If you need to configure a custom registration within a completely new incoming
document scenario, you must implement the /OTX/PF01_IF_REGISTRATION

VIM200405-CGF-EN-02 Configuration Guide for Foundation 71

Chapter 4 Inbound Configuration

interface. You can use the custom registration type to configure and access
specific settings.

Registration There are possible methods for a custom implementation in the /OTX/PF01_IF_
Class REGISTRATION interface:

REGISTER
This method registers a document in the /OTX/PF01_T_1REG table and sets the
status in the /OTX/PF01_T_STA table.
This method is called in the available registration classes:

• Early Archiving: /OTX/PF01_CL_REGISTER_OAWD

• Inbound IDoc: /OTX/PF01_CL_REGISTER_IDOC
• Incoming Mail/OTX/PF01_CL_REGISTER_MAIL
• Document Pipeline: /OTX/PF01_CL_REGISTER_PIPELINE

All incoming documents are registered within the /OTX/PF01_T_1REG table. The
registration uses a SAP number range object.

To create a number range interval:

1. Run the SNUM transaction for number range object /OTX/PF01.

Note: This object is not delivered in the BC set.

2. Maintain the number range 01 with the range 1 to 999999999999.

4.4.2.1 Customizing the early archiving registration type

The early archiving registration type describes a process in which a scanned
document is archived before the details of the underlying business transaction are
available in the SAP ERP system.

Document registration with early archiving is processed in the standard

ArchiveLink interface. This section describes the document registration, and also the
mandatory settings for the ArchiveLink configuration.

The early archiving registration type is also used when documents are uploaded and
archived with the Fiori App Store Documents, which is available in the /OTBCWUI/
PF07_BC_FOUNDATION tile catalog. For more information, see “Integrating Fiori Task
App into Fiori Launchpad” on page 317.

Note: You can use any scan client and content repository that are certified by
SAP, for example OpenText Imaging Enterprise Scan and OpenText Archive
Center.

72 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.4. Customizing incoming documents through the document handler

4.4.2.1.1 Maintaining general ArchiveLink settings

Incoming paper documents are scanned and archived, using the early archiving
registration type.

In ArchiveLink, every document type is assigned to a workflow. The workflow is

started when a document with the given ArchiveLink document type is uploaded in
the OAWD transaction.

You must perform the following configuration when the content repository (Archive
Center) is installed and the basic ArchiveLink settings are completed. Depending on
your requirements, the number and attributes of the ArchiveLink settings might be
different.

Notes

• For further details about ArchiveLink, see the SAP documentation.

• For the early archiving registration type, use an ArchiveLink document type
that is assigned to the Inbound Configuration workflow task WS00297300
and object type /OTX/PF01R.

4.4.2.1.2 Creating a Content Repository ID

To determine where the scanned document is archived, you must maintain the
Content Repository ID. This is standard ArchiveLink customizing. If you already
have a working ArchiveLink customizing, you can skip this section.

To create a Content Repository ID:

1. Run the OAC0 transaction.

2. In the Change Content Repositories Overview screen, click Create .
3. Enter the following parameters:

Note: For more details on the parameters, see Section 7.2 “Maintaining an
HTTP content repository in the SAP system” in OpenText Archiving and
Document Access for SAP Solutions - Scenario Guide (ER-CCS).

• Content Rep.: Content Repository ID

• Description
• DocArea (Document Area): ArchiveLink
• Storage type: HTTP content server
• Protocol: This setting defines the file source for archiving and image
displaying media.
• Version no.: for example, 0046
• HTTP srvr:port (HTTP server and port)
• HTTP script: archive

VIM200405-CGF-EN-02 Configuration Guide for Foundation 73

Chapter 4 Inbound Configuration

• Transfer drctry (Transfer directory)

4. Click .

4.4.2.1.3 Creating the presetting folder

A presetting folder groups document types that are related by workplace or by

application. Grouping document types together in a presetting folder provides a
more effective overview of document types on the initial screen of the storage
process Store Documents in the OAWD transaction.

For each document type, you determine the agents that are responsible for the work
item. You also choose which storage scenario is used. The following storage
scenarios are available for Early Archiving:

• Storing for subsequent entry

• Storing for subsequent assignment
• Store and enter
• Store and assign

The scenario “Storing for subsequent entry”, for example, consists of assigning the
document type and processing the work item.

To create the presetting folder:

1. Run the OAWS transaction.

2. In the Default setting: Overview screen, click New Entries in the application
tool bar.

3. Create the new presetting folder using the following parameters:

Pr
Enter the presetting folder name.
Long text
Enter a description of the new folder.

4. Click .

To add a document type to the presetting folder:

Note: If you store the Archive Document Type in the presetting folder during
its creation, you do not have to perform this action. Nevertheless, if you need
to reassign any Archive Document Type to another folder or you need to
assign Archive Document Types to the presetting folder, you can perform this
action. Assigning all relevant Archive Document Types to the presetting folder
is useful for identifying the Archive Document Types easily. For more
information, see “Creating an ArchiveLink document type” on page 75.

74 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.4. Customizing incoming documents through the document handler

Tip: With the Business Center Foundation BC set, the presetting folder /OTX -
Business Center Inbound is already available.

1. Run the OAWS transaction.

2. Select the presetting folder, and then double-click Entries.

3. In the Entries Overview screen, click New Entries in the application tool bar.

4. Add the Doc. type, for example /OTX/SO4, and select the appropriate storage
scenario check box, for example Storing for subsequent entry.

Note: Optionally, you can select an Object Type in the OT column and an
Agent ID for the document type.

5. Click to save your changes.

4.4.2.1.4 Creating an ArchiveLink document type

In this step, you create an ArchiveLink document type, for example /OTX/SO4, and
store it in the presetting folder created before. For more information, see “Creating
the presetting folder” on page 74. Then, you assign the ArchiveLink document type
to Early Archiving (Storing for subsequent entry).

After the ArchiveLink document type is maintained, every incoming document that
is associated with the given document type will be stored in a predefined archive
and a customized workflow will start afterwards.

To create an ArchiveLink document type:

1. To start the Document Type Customizing Wizard, run the OAD5 transaction.
On the Start screen, click Continue.

2. Document type

Doc.type
Enter a name for the new document type. For example, use archive
document type /OTX/SO4 or another document type for your namespace.
Name
Enter a description.

Click Continue in the upcoming screens until you reach the Workflow
document type screen.

3. Workflow document type

Select the Workflow document type check box, and then click Continue.

4. Document class
Enter Doc. class PDF ,and then click Continue.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 75

Chapter 4 Inbound Configuration

5. Object, method and tasks

Enter the following information:

Obj. type
/OTX/PF01R

Entry
Task
WS00297300

Click Continue.

6. In the Workflow Parameter screen, click Continue.

76 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.4. Customizing incoming documents through the document handler

7. Storage system and link table

Click Continue.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 77

Chapter 4 Inbound Configuration

8. Selection from available presettings

Select the ID of the delivered presetting folder (available in the Business Center
Foundation BC set), and then click Continue.
9. In the Create new presettings screen, click Continue.
10. Details of presettings
Select the Storing for subsequent entry check box, and then click Continue.
11. End
To save the archive document type /OTX/SO4, click Complete and confirm the
changes.

4.4.2.1.5 Linking an ArchiveLink document type to a registration object

Every incoming document is associated with an ArchiveLink document type and a

business object.

To know where to store the incoming document , you must maintain the links, as
described in this section.

To link the ArchiveLink document type to the registration object:

1. Run the OAC3 transaction.

2. In the Links for Content Repositories Overview screen, click New Entries.

78 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.4. Customizing incoming documents through the document handler

3. Enter the following parameters:

Object Type
/OTX/PF01REG

Document type
Enter /OTX/SO4
Link Status
Enter X
Storage system
Enter the Content Repository ID. For more information, see “Creating a
Content Repository ID” on page 73.
Link
Enter TOA01

4. Click .

You can also link the document to the relevant SAP target business object. To do
this, continue as described in this section for any SAP business object that you want
to link to the document. For details about the related settings and the supported
business objects, see the description in the related solution guides (for example Sales
Order with the related Business Objects for Sales Orders).

VIM200405-CGF-EN-02 Configuration Guide for Foundation 79

Chapter 4 Inbound Configuration

4.4.2.1.6 Customizing the ArchiveLink registration

For the registration of documents, the ArchiveLink document type is linked to the
document handler, to a channel, and to the classification profile.

To customize the ArchiveLink registration:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Document Handler > Registration > Early Archiving.
3. In the Registration - Early Archiving Overview screen, configure the
registration, using the following parameters.

Document Type
ArchiveLink document type used for the registration
Channel
Enter the Channel ID used for this registration type. For more information,
see “Configuring channels” on page 64.
Handler
Enter the Handler ID that represents the processing steps of the service
modules for this document. For more information, see “Customizing
incoming documents through the document handler” on page 66.
Classify
Enter the Classification ID of the incoming document. For more
information, see “Creating scenario classifications” on page 64.
Pre Exit Registration
Optional: Enter the function that is executed before the document is
registered in Inbound Configuration. Use template /OTX/PF01_UTIL_EXIT_
REG_BEFORE.

Past Exit Registration

Optional: Enter the function that is executed after the document is
registered in Inbound Configuration. Use template /OTX/PF01_UTIL_EXIT_
REG_AFTER.

Register synchron
Activate register synchron in order to trigger the inbound handler for the
registered document synchronously

80 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.4. Customizing incoming documents through the document handler

4.4.2.2 Customizing the Inbound IDoc registration type

The Electronic Data Interchange (EDI) scenario is based on the standard SAP
document format Intermediate Document (IDoc). IDocs allow different application
systems to be linked through a message-based interface. The following list shows
some examples of how you can benefit from using IDocs.

• Business documents are exchanged in a structured way in order to process them

automatically.
• The various degrees of structural complexity as displayed by different
application systems can be reduced to a structure that is as simple as possible.

Example: The structure of an SAP application document and the structure of the
corresponding EDI message under the UN/EDIFACT standard

The function module /OTX/PF01_UTIL_IDOC_INPUT for inbound documents creates

a registration entry from incoming IDocs. To enable this, the following configuration
steps are necessary. The configuration describes a possible incoming order
configuration. Depending on your requirements, the number and attributes of the
inbound IDoc settings might be different.

Note: For further details about inbound IDoc processing, see the SAP
documentation.

4.4.2.2.1 Defining settings for the inbound function module

In this step, you choose the input type for the IDocs.

To define settings for the inbound function module:

1. Run the BD51 transaction.

2. In the Characteristics of Inbound Function Modules view, click New Entries.

3. Define the inbound function module, using the following parameters:

Function module (inbound)

Enter /OTX/PF01_UTIL_IDOC_INPUT

Input type
Enter 0 (for Mass processing).

Dialog allowed
If you want to process IDocs in dialog mode, select this check box. With
baseline implementation, the check box is cleared.

4. Click Save .

VIM200405-CGF-EN-02 Configuration Guide for Foundation 81

Chapter 4 Inbound Configuration

4.4.2.2.2 Linking the inbound function module to IDoc type and message type

In this step, you establish the link between the inbound function module, the basic
IDoc type, and the message type.

To link the inbound function module to IDoc type and message type:

1. Run the WE57 transaction.

2. In the IDoc: Assignment of FM to Log. Message and IDoc Type view, click
Change .
3. Click New Entries.
4. Configure the assignment using the following parameters:

Function module
/OTX/PF01_UTIL_IDOC_INPUT

Function type
Select Function Module.
Basic type
Enter the basic type, for example ORDERS01.
Message Type
Enter the message type, for example Orders.
Direction
Select Inbound.
Description
Enter a meaningful description.

5. Click Save .

82 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.4. Customizing incoming documents through the document handler

4.4.2.2.3 Creating a new process code

In this step, you create a new process code and assign the inbound function module
to this process code.

The process code is a logical name for the processing function module. The process
code is used to uniquely determine a function module that processes the received
IDoc data and converts an IDoc to an SAP document.

To create a new process code:

1. Run the WE42 transaction.

2. In the Inbound process code view, click Change .

3. Click New Entries.

4. Define the new process code using the following parameters:

Process code
Enter the process code name.

Note: You can choose a name for the process code that suits your
needs.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 83

Chapter 4 Inbound Configuration

Description
Enter a meaningful description.
Identification
Enter the inbound function module /OTX/PF01_UTIL_IDOC_INPUT.
Option ALE
Click Processing with ALE service.
Processing type
Click Processing by function module.

5. Click .

6. Double-click Logical message in the Dialog Structure.

7. Assign the new process code to the logical message using the following
parameters:

Process code
Process code name as defined in Step 4.
Message type
Enter the message type, for example Orders.

8. Click Save .

84 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.4. Customizing incoming documents through the document handler

4.4.2.2.4 Configuring the partner profile

When data is exchanged between partners, it is important that sender and receiver
define the exact syntax and semantics of the data to be exchanged beforehand. The
partner profile defines the type of data and communication paths of that data
exchange.

In this step, you assign the new process code to the IDoc partner profile. You must
specify partner and partner type. You must also specify whether you define a profile
for inbound or outbound data exchange. You can use an existing partner profile. The
partner type must be Logical system (LS).

Tip: If you want to create a new partner profile, you must first create a new
logical system. See the SAP documentation for details.

To configure the partner profile:

1. Run the WE20 transaction.

2. Select the partner profile under Partner Profiles > Partner Type LS.
3. Below the Inbound parmtrs. panel, click Add .
4. Configure the inbound parameters.

Partner No.
ID of the partner profile,

VIM200405-CGF-EN-02 Configuration Guide for Foundation 85

Chapter 4 Inbound Configuration

Partn. Type
Partner Type: Enter LS for logical system.
Message type
Enter the message type, for example ORDERS.

5. On the Inbound options tab, enter the Process code that you created in
“Creating a new process code” on page 83.
6. Click Save .

4.4.2.2.5 Linking inbound IDoc with document handler, channel, and classification

For the registration of documents, you link the IDoc parameters with the handler
process, a channel, and the classification profile. You also process the relevant field
mapping of the IDoc segments.

To configure the inbound IDoc registration:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound
Configuration > Document Handler > Registration > Inbound IDoc.
3. In the Registration IDoc Details screen, configure the registration, using the
following parameters.

Partner Number, Partner Type, Partner Role, Message Type, Message Code,
Message Function, Test
For these parameters, see the SAP documentation: IDoc Interface /
Electronic Data Interchange (BC-SRV-EDI).
Channel
Enter the Channel ID used for this registration type. For more information,
see “Configuring channels” on page 64.
Module Handler
Enter the Handler ID that represents the processing steps of the service
modules for this document. For more information, see “Customizing
incoming documents through the document handler” on page 66.
Classification
Enter the Classification ID of the incoming document. For more
information, see “Creating scenario classifications” on page 64.
Document Type
You can configure a document type that is used to create and archive a
readable PDF out of the IDoc. To create and archive a PDF, you must
implement the Pre Exit Registration.
Document Type Attachment
If the IDoc also delivers an attachment (for example embedded in DOC
segments), you can configure the corresponding ArchiveLink document

86 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.4. Customizing incoming documents through the document handler

type. To archive an attachment, you must implement the Pre Exit

Registration. To support different mime types, leave the document class
empty for this ArchiveLink document type in the OAC2 transaction.

Pre Exit Registration

Enter a function that is executed before the document is registered in
Inbound Configuration. Use template /OTX/PF01_UTIL_EXIT_REG_BEFORE.
You can use this function to configure the document type that is used to
create and archive a readable PDF out of the IDoc.

Past Exit Registration

Enter a function that is executed after the document is registered in Inbound
Configuration. Use template /OTX/PF01_UTIL_EXIT_REG_AFTER.

Register synchron
Activate register synchron in order to trigger the inbound handler for the
registered document synchronously

4.4.2.2.6 Mapping IDoc fields to target fields

Each IDoc field can be mapped to a target field. The mapping result is stored in the /
OTX/PF01_T_1EXT table, which collects all extracted data intermediately.

The final mapping of the fields to the target business application is done within the
Data Model Configuration. For more information, see “Data model configuration”
on page 197.

Note: To handle the scenario for the processing of IDOC with an invoice type
that is set to INVO, CRME, SUBC, SUBD, do the following:

• Change the configuration for the field name BSART:

E1EDK01 segment, INVOIC02 object name)

• Use the document field name VORGANG instead of CREDIT_MEMO

• Use the Function Module value /OTX/PS03_EXIT_IDOC_CR_MEMO

These changes are applicable for the INVOIC message type.

To configure the IDoc mapping:

1. Run the /n/OTX/PF00_IMG transaction

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Document Handler > Registration > Inbound IDoc.

3. In the Registration IDoc Details screen, double-click IDoc Mapping in the

Dialog Structure. In the IDoc Mapping Overview screen, double-click an entry.

4. In the IDoc Mapping Details screen, configure the IDoc mapping, using the
following parameters.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 87

Chapter 4 Inbound Configuration

Partner Number, Partner Type, Partner Role, Message Type, Message Code,
Message Function, Test
For these parameters, see the SAP documentation: IDoc Interface /
Electronic Data Interchange (BC-SRV-EDI).
Object Name
Development object name: the IDoc type ORDERS01
Segment Type
Segment type in IDoc type
Field Name
Segment field
IDoc Qualifier
Qualifier of the segment
Qualifier Value
Value of the segment qualifier
Field Type
Select either Header or Item type.
External Field Name
Enter the Intermediate field name.
Field Mapping Type
Select one of the following mapping types from the list:

• Segment Field (from IDoc)

• Constant (fixed value)
• System variable
• Function Module

Value
If you have selected Constant (fixed value), System variable, or
Function Module as the field mapping type, enter the corresponding value.
If you have selected Function Module, you can use the /OTX/PF01_UTIL_
EXIT_IDOC_MAP function module as a template.

88 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.4. Customizing incoming documents through the document handler

4.4.2.2.7 Customizing the IDoc hierarchy item

For the item fields, an assignment to an intermediate external table name is

necessary. This table is mapped to the final target business ledger item table. The
mapping is done within the Data Model Configuration. For more information, see
“Data model configuration” on page 197.

To customize the IDoc hierarchy item:

1. In the IDoc Mapping Details screen, double-click IDoc Hierarchy Item in the
Dialog Structure.

2. In the IDoc Hierarchy Item Details screen, customize the IDoc hierarchy item,
using the following parameters.

Partner Number, Partner Type, Partner Role, Message Type, Message Code,
Message Function, Test
For these parameters, see the SAP documentation: IDoc Interface /
Electronic Data Interchange (BC-SRV-EDI).
Object Name
Development object name: the IDoc type, for example ORDERS01
Segment Type
Segment type in IDoc type which represents an item segment (only one item
segment supported)
External Field Name
Enter the intermediate table field name.

4.4.2.3 Customizing the incoming email registration type

SAP NetWeaver Application Server ABAP supports the Simple Mail Transfer
Protocol (SMTP). This enables email exchange between the SAP ERP system and an
SMTP email server, without having to use additional external components.

All information of the incoming email object is logged. This means, all incoming
email data received through the SMTP interface can be viewed in SAPconnect. Later
on, the information can be used, for example, for reporting.

Note: The product standard does not support sending emails back to the
sender or forwarding messages to SAP Business Workplace.

Prerequisites

• The email server must be SMTP-compatible.

• The customized address space for the default domain must match the DNS
address on the external email server.

To enable the incoming email registration, the following customization steps are
necessary.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 89

Chapter 4 Inbound Configuration

Note: For further details about incoming SMTP email processing, see the SAP
documentation.

4.4.2.3.1 Checking the SMTP service

1. To check the customizing of the SMTP service, run the SMICM transaction.

2. On the Goto menu, click Services.

The SMTP service is active on port 25.

3. If the port is not set to 25, select the SMTP service. In the Service menu, click
Change.

4. Set the port value to 25 and save the changes.

4.4.2.3.2 Configuring the profile parameters

If you want to use the SMTP function, you must adjust the system profile of the SAP
ERP system.

To configure profile parameters:

1. To access the Edit Profiles screen, run the RZ10 transaction.

90 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.4. Customizing incoming documents through the document handler

2. Choose the instance profile, click Extended maintenance, and then click
Change.
3. Configure the following new profile parameters as a Name = Value pair.
The placeholder <*> stands for the sequence number (starting at zero) of
frequently occurring parameters.

icm/server_port_<*> = PROT=SMTP,PORT=25
This parameter opens a TCP/IP port for receiving emails through the SMTP
plug-in.
Note: After adding this parameter, the ICM service is set
automatically to port 25 when the application server is restarted.
is/SMTP/virt_host_<*> = <host>:<port>, <port>,...;
This parameter defines a virtual email host for receiving emails. If all
incoming emails are received and processed by one single client of the SAP
ERP system, this parameter is not required.

4.4.2.3.3 Creating a service user

You must create a service user for processing incoming emails in every SAP ERP
system client in which you want to receive emails. Every user that receives emails in
an SAP ERP system requires an Internet email address. This is also used as a sender
address.

To create a service user:

1. Run the SU01 transaction.

2. Create a user with type Service and assign the profile S_A.SCON to this user.
3. On the Address tab, under E-Mail, enter the Internet email address for the user.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 91

Chapter 4 Inbound Configuration

4.4.2.3.4 Assigning the SAP ERP system client to an SMTP server

Every SAP ERP system client that receives and processes incoming emails must have
an SMTP server. One SMTP server (called SAPconnect) has already been created in
the SICF transaction and is delivered with every SAP ERP system.

To assign the SAP ERP system client to an SMTP server:

1. Run the SICF transaction and open the Virtual Host SAPCONNECT.

2. Select SAPconnect. To display the Create/Change a Virtual Host screen, click

Change .

3. Configure the following settings on the SMTP servers:

Host Data
Enter the sequence number of the is/SMTP/virt_host_<*> parameter from
the profile. For more information, see “Configuring the profile parameters”
on page 90. If you have only created one client and therefore have not
specified this parameter type, enter 0.
Logon Data
Enter the logon data of the system user that you created for the incoming
emails.
Handler List
At position 1, enter CL_SMTP_EXT_SAPCONNECT.

4. For each additional client, create another SMTP server.

Note: You must activate each SMTP server (Service/Virt. Host > Activate)
after creating or changing it. Inactive servers appear dimmed.

92 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.4. Customizing incoming documents through the document handler

4.4.2.3.5 Administering SAPconnect

You must configure SAPconnect settings for every client that is used for send
processes.

To administer SAPconnect:

1. Run the SCOT transaction.

2. On the Settings menu, click Default Domain.

3. Default Domain
Define the domain of the SAP ERP system client.
This action has the following consequences:

• The SMTP plug-in logs on to the email server using this domain as the ID.
• The message ID of the outbound emails is assembled with this domain.
• An SAP user might not have an Internet email address. If such a user sends
an email, a sender address consisting of the SAP user name and this domain
is generated.

Each client has an SMTP node. This node is created by the SAP ERP system and
cannot be deleted.

4. Nodes
Enter the specific customizing data like output format for SAP documents and
other types of documents. See details in the SAPconnect documentation.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 93

Chapter 4 Inbound Configuration

5. Inbound Processing
You may want incoming emails that have a particular address or particular
content to automatically start a program that processes these emails. In this
case, configure the following on the menu: Settings > Inbound Processing.

6. Add new entries using the following parameters:

Communication Type
Select Internet Mail.
Recipient Address
Enter email address.
Document Class
Enter the * wildcard.
Exit Name
Enter the default framework class name /OTX/PF01_CL_REGISTER_MAIL.
Call Sequence
Enter the call sequence according to your requirements.

7. Save your settings.

For a more detailed description of how to enable the Simple Mail Transfer Protocol
Service in SAP ERP, see the SAP Help.

4.4.2.3.6 Customizing inbound email registration

For the registration of documents, the email address is assigned to the handler
process, a channel, and the classification profile.

To attach an email as PDF document, you must fill the following attributes:

• recipient mail,
• channel,
• handler,
• classify,
• document type,

• document type mail,

94 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.4. Customizing incoming documents through the document handler

• attach body = X,
• render body = X or A,
• preregistration exit.

The conversion of HTML email document to PDF covers a limited range of special
characters and formatting. Depending on functionality of standard SAP method
cl_crm_email_utility (convert_html_to_plain_text). The PDF document can look
different to the HTML or TXT document

To customize the inbound email registration:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound
Configuration > Document Handler > Registration > Incoming Mail.
3. In the Registration - Mail Overview screen, customize the inbound email
registration, using the following parameters.

Recipient Mail
Email address that receives the email. This address is configured within the
SCOT transaction. For more information, see “Administering SAPconnect”
on page 93.
Channel
Enter the ID of the channel that is used for this registration type. For more
information, see “Configuring channels” on page 64.
Handler
Enter the ID of the document handler that represents the processing steps of
the service modules for this document. For more information, see
“Customizing incoming documents through the document handler”
on page 66.
Classify
Enter the Classification ID of the incoming document. For more
information, see “Creating scenario classifications” on page 64.
Document Type
You can configure a document type that is used to archive the leading
application document, for example order or delivery note. To archive any
document, you must implement the Pre Exit Registration.
Document Type Attachment
You can configure a document type that can be used to archive any
attachment. Leave the document class empty for this ArchiveLink
document type in the OAC2 transaction. To archive any document, you must
implement the Pre Exit Registration.
Document Type Mail
You can configure a document type that can be used to archive the email
body. Leave the document class empty for this ArchiveLink document type

VIM200405-CGF-EN-02 Configuration Guide for Foundation 95

Chapter 4 Inbound Configuration

in the OAC2 transaction. To archive any document, you must implement the
Pre Exit Registration.

Attach Body
If this option is selected and the Render to PDF option is not selected, then
the body of the email is archived according to the format configured in the
SAPConnect interface (text/html mail).|

Render Body
You can configure one of the three settings:

• “” = email body is not rendered

• “X” = email body is rendered if it is not empty

• “A”’ = email body is always rendered, even if it is empty

If this option is set to “X” or “A”, then a basic PDF rendition is created that
contains the email body text and the selected email properties (sender,
recipient, subject and others). This feature does not create an exact PDF
rendition of the entire e-mail and is therefore not suitable for OCR
purposes. This feature may not function correctly for all emails, in
particular highly formatted emails with embedded HTML content. This
feature requires a Unicode SAP system. Installation of Adobe Reader Font
Packs may be required to open the PDF document.

Pre Exit Registration

Enter a function that is executed before the document is registered in
Inbound Configuration. Use the /OTX/PF01_UTIL_EXIT_REG_BEFORE
template. For the email processing function, /OTX/PF01_UTIL_EXIT_REG_
MAIL is delivered to process the relevant archiving of the various documents
(leading document / attachments / mail body). The /OTX/PF01_UTIL_EXIT_
REG_MAIL function archives the leading documents according to the mime
type assigned to the ArchiveLink document type. If more than one
document with the mime type of the leading document exists, each
document is registered of its own.

Past Exit Registration

Enter a function that is executed after the document is registered in Inbound
Configuration. Use the /OTX/PF01_UTIL_EXIT_REG_AFTER template.

Register synchron
Activate register synchron in order to trigger the inbound handler for the
registered document synchronously

Note: The email addresses might be different across the system landscape.
Therefore, the /OTX/PF01_ADM_SMAI transaction is available to adjust the
values in test and production systems. In general, production systems do not
allow any configuration changes. The transaction is protected against a special
administration authorization. For more information, see “Authorizations”
on page 260.

96 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.4. Customizing incoming documents through the document handler

4.4.2.4 Customizing the Document Pipeline registration type

You can handle incoming documents using the OpenText Document Pipeline
(Document Pipeline).

You must link the Document Pipeline processing to the defined function module of
the Inbound Configuration inside SAP ERP. You must set a specific RFC mode that
must match the customizing entry on the remote Document Pipeline.

For details about the Document Pipeline, see OpenText Document Pipelines - Overview
and Import Interfaces (AR-CDP).

4.4.2.4.1 Maintaining general settings

Add a new entry to the J_6NGTE26 table with the following values:

RFC_Mode
8

FUNCNAME
/OTX/PF01_UTIL_PIPELINE_INPUT

The Document Pipeline typically requires one COMMANDS and one IXATTR file in
addition to the actual image file (for example image.pdf) and the LOG file. See the
following example:
COMMANDS
R3_CLIENT 800
R3_DESTINATION DW3
USE_VR4WFL 8
DOCTYPE PDF
COMP data PDF image.pdf
ARCHIVID Y4

IXATTR
NEWDOC
ATTRIBUTES /OTX/PS01_T_PLH|MANDT|CC|800|
ATTRIBUTES /OTX/PS01_T_PLH|BLDAT|DD|20141010|
ATTRIBUTES /OTX/PS01_T_PLH|BUKRS|CC|1000|
ATTRIBUTES /OTX/PS01_T_PLH|BUDAT|DD|20141010|
ATTRIBUTES TOAV0|MANDT|CC|800|/OTX/PS01_T_PLH|
ATTRIBUTES TOAV0|AR_OBJECT|CC|/OTX/DN2|/OTX/PS01_T_PLH|
ATTRIBUTES TOAV0|SAP_OBJECT|CC|/OTX/1REG|/OTX/PS01_T_PLH|
ARCHIVIDATTR TOAV0|ARCHIV_ID|CC|%s|/OTX/PS01_T_PLH|
DOCIDATTR TOAV0|ARC_DOC_ID|CC|%s|/OTX/PS01_T_PLH|

The document attributes must be transferred according to the business application

target table settings. For more information, see “Data model configuration”
on page 197. The attributes and values are stored in the /OTX/PF01_T_1EXT table,
which collects all extracted data intermediately.

The final mapping of the fields to the target business application is done within the
Data Model Configuration. For more information, see “Data model configuration”
on page 197.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 97

Chapter 4 Inbound Configuration

4.4.2.4.2 Customizing the Document Pipeline registration

For the registration of documents, the ArchiveLink document type is assigned to the
handler process, a channel, and the classification profile.

To customize the Document Pipeline registration:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Document Handler > Registration > Pipeline.
3. In the Registration - Pipeline Overview screen, customize the Document
Pipeline registration, using the following parameters.

Document Type
ArchiveLink document type that is used for the registration
Channel
Enter the ID of the channel that is used for this registration type. For more
information, see “Configuring channels” on page 64.
Handler
Enter the ID of the document handler that represents the processing steps of
the service modules for this document. For more information, see
“Customizing incoming documents through the document handler”
on page 66.
Classify
Enter the Classification ID of the incoming document. For more
information, see “Creating scenario classifications” on page 64.
Pre Exit Registration
Enter a function that is executed before the document is registered in
Inbound Configuration. Use the /OTX/PF01_UTIL_EXIT_REG_BEFORE
template.
Past Exit Registration
Enter a function that is executed after the document is registered in Inbound
Configuration. Use the /OTX/PF01_UTIL_EXIT_REG_AFTER template.

98 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.4. Customizing incoming documents through the document handler

4.4.2.5 Customizing a custom registration type

Besides the registration types that are described in the previous sections, you can
customize document registration using a custom registration. You might need to
configure a custom registration within a completely new incoming document
scenario. In this case, you must implement the /OTX/PF01_IF_REGISTRATION
interface. You can use the custom registration type to configure and access specific
settings.

To customize a custom registration:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Document Handler > Registration > Custom / Others.

3. In the Registration – Custom / Others screen, customize the registration, using

the following parameters.

External Profile
Unique ID to identify the setting and access the setting for the custom
registration type in your custom registration implementation.

Channel
Enter the channel ID that is used for this registration type. For more
information, see “Configuring channels” on page 64.

Module Handler
Enter the handler ID that represents the processing steps of the service
modules for this document. For more information, see “Customizing
incoming documents through the document handler” on page 66.

Classification
Enter the classification ID of the incoming document. For more information,
see “Creating scenario classifications” on page 64.

Document type
You can configure a document type that is used to archive the leading
application document, for example an order or a delivery note. To archive
any document, you must implement the Pre Exit Registration.

Document type att.

Document Type Attachment. You can configure a document type that is
used to archive any attachment. Leave the document class empty for this
ArchiveLink document type in the OAC2 transaction. To archive any
attachment, you must implement the Pre Exit Registration.

Pre Exit Reg.

Pre Exit Registration. Enter a function that runs before the document is
registered in Inbound Configuration. Use the /OTX/PF01_UTIL_EXIT_REG_
BEFORE template.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 99

Chapter 4 Inbound Configuration

Past Exit Reg.

Past Exit Registration. Enter a function that runs after the document is
registered in Inbound Configuration. Use the /OTX/PF01_UTIL_EXIT_REG_
AFTER template.

4.5 API for document registration

Starting with version 16.3.2, Business Center provides an API for the registration of
documents. This allows the start of Business Center processes from none-SAP
systems.

Available services:

• /OTBCINB/PF01_REGIST_DOC

4.5.1 /OTBCINB/PF01_REGIST_DOC
The service registers the document as customized for the archive object and
document type.

The request is a multipart request that comprises three parts:

• register_document_request
• document
• metadata

The first part register_document_request is an XML structure and contains the

key information for the document.

Note: The structure of multipart requests is described in “Organisation of a

Multipart Request” on SAP Help portal (https://help.sap.com/).

The XML is transferred using the XML transformation /OTX/PF01_REGIST_DOC_

REQUEST with the /OTX/PF01_S_REGIST_DOC_REQUEST DDIC structure . The length
restrictions of this DDIC structure apply for all fields.

Element Description
Scan date.
scan_date The format for the scan date is YYYY-MM-DD in the time zone of the
SAP system.
Scan time.
scan_time
The format is hh:mm:ss in the time zone of the SAP system.
scan_user Scan user
ar_object Document type

100 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.5. API for document registration

Element Description
doc_type Document class
Document ID in Archive (only in case the document has already been
arc_doc_id
archived)
archive_id Archive ID
Version of the API that is called. Current version is version 1. If version
version
is not provided in call, then the latest version will be used.

Example 4-1: Example for xml structure

The second part document contains the document and is of type binary. If the
document has already been archived and the parameters ARC_DOC_ID and ARCHIV_
ID have been provided in the first part, you can leave this part empty.

The third part metadata is an XML structure and can contain information from an
extraction service. The provided data is mapped to the structure of the process data
as defined in the data model of the process. This part is only processed if the
document was also provided in the second part. It contains an array with the
following structure:

Element Description
extindex External index of field
Additional field information (for example row information in case of
fieldinfo
line items)
extfield External field name
extvalue Value

As a response, the service returns a multipart structure. This currently comprises

only a “response” part, which has the following XML structure:

Element Description
regid Registration ID of the document

Running the service requires the authorization OTBCINB for authorization object S_
ICF.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 101

Chapter 4 Inbound Configuration

4.5.2 BAdI /OTX/PF01_REGISTER

You can implement additional logic using the /OTX/PF01_REGISTER BAdI. This
BAdI has the following interface.

PROC- This method is called at the beginning of the API. It allows you to access the
ESS_PRE_RE metadata to process own logic. It is also possible to skip the whole standard logic to
GISTER
method –
register the document

Parameter Type Description

PE_SKIP Exporting Skip processing / registration
PE_RESPNSE_REASON Exporting HTTP response reason which
is sent when the processing is
skipped
PE_RESPONSE_CODE Exporting HTTP response reason which
is sent when the processing is
skipped
PCT_MULTIPART Changing Multipart content

PROC- This method is called at the end of the API when the document was registered. It
ESS_PAST_RE allows you to access the metadata and the response (with the registration ID).
GISTER
method –
Parameter Type Description
PIT_MULTIPART IMPORTING Multipart content
PIS_RESPONSE IMPORTING Response information which
is sent with multipart

4.6 Add additional logic to standard actions (BAdI /

OTX/PF32_IDF_WOBJ_ACTION)
The /OTX/PF32_IDF_WOBJ_ACTION BAdI is part of the /OTX/PF32_IDF_WOBJ_
ACTION enhancement spot and implements the /OTX/PF32_IF_BADI_IDF_WOBJ_ACT
interface.

The BAdl allows to add additional logic to the following standard actions that are
available in the Inbound Administration work center of the VIM Central
Workplacee:

• Change Status
• Reject
• Reset Retry Counters
• Reset Training
• Submit Handler

102 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.6. Add additional logic to standard actions (BAdI /OTX/PF32_IDF_WOBJ_ACTION)

For more information, see Section 2.1 “Navigating the VIM Central Workplace” in
OpenText Vendor Invoice Management for SAP Solutions - User Guide for Solutions
Beyond Invoice (BOCP-UGD).

4.6.1 Add custom code before executing the action

(BEFORE_EXECUTE_ACTION)
This method allows to add custom code before executing the corresponding action.

Parameter Type Description

PI_BULK Importing Indicator that an action is a
bulk action
PI_ACTION Importing Technical ID of the executed
action
PIS_WOBJ_TYPE Importing Corresponding work object
type configuration
PIS_DISPLAY_ Importing Current inbound attribute
ATTRIBUTES data values
PCT_RETURN Changing Returns messages of the
BAdI method.

Any message that returns

with E type stops the
execution of the action and
displays the error message to
the user.

4.6.2 Add custom code after executing the action

(AFTER_EXECUTE_ACTION)
This method allows to add custom code after executing the corresponding action.

Parameter Type Description

PI_BULK Importing Indicator that an action is a
bulk action
PI_ACTION Importing Technical ID of the executed
action
PIS_WOBJ_TYPE Importing Corresponding work object
type configuration
PIS_DISPLAY_ Importing Current inbound attribute
ATTRIBUTES data values
PI_ACTION_SUCCESS Importing Indicator if the action has
been executed successfully or
not

VIM200405-CGF-EN-02 Configuration Guide for Foundation 103

Chapter 4 Inbound Configuration

Parameter Type Description

PIT_ACTION_RETURN Importing Returns messages of the
executed action
PCT_AFTER_RETURN Changing Returns messages of the
BAdI method.

It is not possible to revert the

execution of the standard
action in this stage.

Only return messages other

than E type can be returned
and displayed to the user in
addition to the standard
action return messages.

4.7 Rendition management

The inbound configuration provides the possibility to integrate document rendering
by using the rendition management of OpenText™ Archiving and Document Access
for SAP Solutions. You must therefore, install and configure the corresponding
components of Archiving and Document Access for SAP Solutions. For more
information, see OpenText Archiving and Document Access for SAP Solutions -
Installation and Upgrade Guide (ER-IGD).

For further information about rendition management, see the documentation of

Archiving and Document Access for SAP Solutions.

In some scenarios you will receive a Microsoft Office document and not the PDF
document that you need for processing. This PDF can get processed in the further
processing steps.

To do archiving and extraction for these documents, the rendition management

renders the document into a PDF within the document handler process. For more
information, see “Creating a document handler process” on page 67.

To integrate the rendition management, configure your own document handler

process with a new module. For more information, see “Configuring modules for
the required processing steps” on page 69.

Sequence
Define the sequence how the modules are processed. The Render and archive
image module should be processed before the document is sent to the extraction
service

Module Class
Implement processing logic in /OTX/PF01_CL_MODULE_RENDER class.
Redefine this class to your need. The class supports the following file formats:
DOC, XLS, TXT, and RTF

104 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 4.7. Rendition management

End Status
Enter the status 35 “Document rendered and archived”.

Additionally to the configuration of a document handler process, you have to

maintain parameters for the rendition server. The rendition server must be set up
according to the documentation of Archiving and Document Access for SAP
Solutions.

For more information see “Customizing basic settings for Inbound Configuration”
on page 60.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 105

Chapter 5
Capture Integration

5.1 Business Center Capture

For solutions that require OCR, you can integrate OpenText Business Center
Capture for SAP Solutions (Business Center Capture).

Business Center Capture automates the capture of paper documents by using OCR
to extract the data. Business Center Capture uses SAP ERP as backend to store and
retrieve image information through the inbound process.

Using service modules of Inbound Configuration, you can control all tasks that are
related to the following actions of Business Center Capture:

• Storing documents
• Retrieving documents
• Extracting documents
• Validating documents

Steps from the paper invoice to document registration with Business Center
Capture (BCC)

1. SAP ERP calls the scan client through the Early Archiving registration type,
using the OAWD transaction.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 107

Chapter 5 Capture Integration

2. The scan client deposits the image to the content repository (Archive).
The OAWD transaction creates a registration entry in SAP ERP using the
registration interface class implementation /OTX/PF01_CL_REGISTER_OAWD.
The registration method inserts an entry to tables /OTX/PF01_T_1REG and /OTX/
PF01_T_1IMG and sets status Registered.
Alternative: Incoming email is used for registration of a new document.
3. The document handler (periodic job for report /OTX/PF01_P_IDF_TRIGGER)
processes the required service modules in SAP ERP and sets the status
accordingly.
4. The BCC Extraction service calls the API function /OTX/PF01_IF_GET_NEW_DOC_
LIST using a scheduled batch job on BCC side and gets new documents for
processing:

• Gets all documents in status Ready for OCR extraction along with secure
URL for image and XML document, which will be created by the BCC
Extraction service.
• Updates the document status to Sent to OCR.
5. The BCC Extraction service picks the documents from step 3 and imports the
corresponding images from the archive.
6. The Export module of the BCC Extraction service calls the API function /OTX/
PF01_IF_OCR_DATA_UPDATE_N with call point EX:

• Updates the status and OCR data appropriately. This API exports the data to
SAP ERP after completion of the extraction phase. Table /OTX/PF01_T_1EXT
will be updated with extracted data.
• Updates the document status to Extraction Completed.
7. The BCC Extraction service sends the detailed results XML file of the exported
data to the Archive using the URL retrieved from SAP ERP in step 4. The BCC
Validation engine uses the XML file.
Results for each data exported to SAP ERP are stored in an XML file and
archived.
8. The document handler picks up the registered items with status Wait for
Extraction completed and checks the time elapsed. If it exceeds the configured
time, the status is set to Error.
9. The document handler picks up the registered items with status Extraction
Completed. The document handler checks if validation is required or not. If
validation is required, the status is set to Ready for Validation. If validation is
not required, the document handler will process the corresponding service
modules and trigger the target application.
10. The BCC Validation service calls the /OTX/PF01_IF_GET_VAL_DOC_LIST API
and gets a list of documents for validation:

• Gets all the documents in status Ready for Validation.

108 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

• For each document, it gets the secure URL for image and XML documents,
which will be used by the BCC Validation Client.
11. The BCC Validation service picks documents (both image and XML) from the
Archive for each validation document, using the URL retrieved from SAP ERP.
12. The BCC Validation service calls the /OTX/PF01_IF_OCR_DATA_UPDATE_N API
with call point VA:

• Updates the status and OCR data appropriately. This API exports the data to
SAP ERP after completion of the validation phase. The /OTX/PF01_T_1EXT
table is updated with validation data.
• Updates the document status to Validation Completed.
13. The document handler picks up registered items with status Wait for
Validation completed, and after elapsed time sets the status to Error.

14. The document handler picks up registered items with status Validation
Completed, processes the corresponding service modules, and triggers the target
application.

5.1.1 Checking archive settings for XML documents

The component type for the XML document that is created by the BCC or IES
Extraction service is assigned to the used archive. Usually, you do not need to
change this entry, except for some cases (according to the used archiving system) to
configure the component ID data for the related content repository.

5.2 Information Extraction Service

5.2.1 Functional Overview
5.2.1.1 Architecture
Information Extraction Service is a Microsoft Windows based data extraction
services which is called by SAP via REST based web services, supporting HTTP and
HTTPS.

Information Extraction Service API provides three services which are called from
SAP:

• Configuration Service: Receives configuration data for recognition profiles

related to business scenarios.
• Extraction Service: Receives requests for extracting data from an image file and
provides result data.
• Learning Service: Receives feedback data.
You can configure the feedback source. It can be sent after validation from the
Validation client. Or after the end of the business process. You can use the
SCESAPGUI or Fiori Validation for the validation within the business process.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 109

Chapter 5 Capture Integration

Learning data is separated at subscription level.

The Learning Service processes the feedback data and stores machine learning data
in its repository:

• Intelligent Capture for SAP® Solutions uses the SAP database as repository.
• Core Capture for SAP® Solutions uses the OT2 public cloud as repository.

5.2.1.2 Scenarios and Capture profile concept

The configuration of the scenarios is completely done in the Inbound Configuration,
that means that you need not configure the Information Extraction Server.

Capture profile A profile is a specific configuration of a scenario and allows the following
configuration customizing:

• Definition of preferred format interpretation for dates, amounts, and other

country specific values.
• Definition of additional custom extraction fields.
• Definition of field settings for validation.

To use document capture with IES, you must configure at least one profile for the
used scenario. In a scenario, standard extraction fields and extraction parameters are
defined for one type of document.

The number of profiles per scenario and the overall number of profiles is not limited.

110 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

The profile configuration depends on the specific business requirement, such as

different company codes or countries.

The following graphic illustrates the relation between a scenario and a profile:

All settings in the customizing activity “Capture Profile Maintenance” are

transportable. This means that they are maintained in a customizing client and then
transported to a test or production system.

Capture Profile Activation is executed only in clients where IES is intended to be

used. Usually this is a test or production system.

5.2.1.3 Intelligent field types

Intelligent field types include the knowledge about the data structure, potential local
formats, their meaning in different business contexts, tax compliance and how they
are used in SAP. As an example, a field type specifies date formats, for example
MMDDYYYY, DDMMYYYY, DD.MM.YYYY, DD/MM/YYYY, and date writing styles, for example
month spelled out, without the need of defining it for any solution.

All scenarios are based on intelligent field types which incorporate the knowledge
about identification and interpretation of typical data found in business documents:
dates, amounts, table items and so on.

For all fields of preconfigured scenarios, data transfer and mapping to the fields of
the corresponding VIM scenarios are part of the product.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 111

Chapter 5 Capture Integration

For a preconfigured scenario, a defined set of fields is provided which cannot be

modified except you select the following options for validation:

• Input: Open for data entry.

• Hide: Not visible.
• Read only: Visible but not open for data entry.
• Required: Mandatory, highlighted in red if no data entered.

Preconfigured scenarios and custom scenarios can be extended by custom fields. For
custom fields the following field types are available:

• Amount
• Currency
• Classification
• Date
• Decimal
• Stringlist
• Lookup
• Partner
• String
• Table

Description

Description
Description is a field type which is specialized to extract text spanning over
multiple lines and columns.

Learning supported
Yes

Layout dependent
Yes

Use case
Extract complex item description text, for example material description from
tables.

Parameters
No parameters

Header/table supported
Table

112 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

Amount
Description
The amount field is a specialized decimal field which is limited to a defined
number of decimals according to the format interpretation list. The amount
field intepretes data with regards to the settings of the format interpretation
list, which defines the correct interpretation of thousand and decimal
separators.
Learning supported
Yes
Layout dependent
No
Use case
Item amount, total amount
Parameters
Format interpretation list
Header/table supported
Header/table

Classification
Description
Classification is a string field and learns to determine different classes for
different document types.
Learning supported
Yes
Layout dependent
Yes
Use case
Classification of specific document types (transportation invoices, leasing
invoices), for example for routing to specific VIM workflows.
Parameters
Class name
Header/table supported
Header/table

Currency
Description
Currency is a specialized string field which identifies supported currencies
and currency symbols on the document and normalizes it to ISO names for
supported currencies.
Learning supported
Yes

VIM200405-CGF-EN-02 Configuration Guide for Foundation 113

Chapter 5 Capture Integration

Layout dependent
No

Use case
Document currency, amount currency

Parameters
No parameters

Header/table supported
Header/table

Date

Description
A date field is a strucured field which suppports typical date structures
(ddmmyyyy, mmddyyyy, month in letters and so on) for the supported
languages, depending on the settings of the format interpretation list. The
field is learned across layouts, considering typical surrounding keywords,
text and data structure.

Learning supported
Yes

Layout dependent
No

Use case
Document date, delivery date and so on

Parameters
Format interpretation list

Header/table supported
Header/table

Decimal

Description
The decimal field supports up to 4 decimals. The decimal field intepretes
data with regards to the settings of the format interpretation list, which
defines the correct interpretation of thousand and decimal separators (“.” or
“,”). The field is learned across layouts, considering typical surrounding
keywords, text and data structure.

Learning supported
Yes

Layout dependent
No

Use case
Quantity, unit price

114 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

Parameters
Format interpretation list
Header/table supported
Header/table

Partner
Description
The partner field is determining the business partner. The partner field
learns an ID for the partner related to the document layout. The partner field
can also learn multiple IDs related to one layout. The partner field is
connected to a staging table, which is used by the validation user for
retrieving the partner ID with F9.
Learning supported
Yes
Layout dependent
Yes
Use case
Supplier, customer
Parameters
Staging table
Header/table supported
Header

String
Description
The string field does not have any normalization but learns a string as it is.
Learning supported
Yes
Layout dependent
No
Use case
Text, numbers
Parameters
No parameters
Header/table supported
Header/table

Stringlist
Description
The stringlist is a list of strings. The user picks values with SCE and the field
type will then learn to extract all relevant strings of the same structure.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 115

Chapter 5 Capture Integration

Learning supported
Yes
Layout dependent
Yes
Use case
PO list, DN list
Parameters
No parameters
Header/table supported
Header

Table
Description
One profile supports multiple tables. A table is a structure consisting of lines
and columns. For every custom table column a field type needs to be
defined. A table will be learned related to a specific layout.
Learning supported
Yes
Layout dependent
Yes
Use case
Invoice table, sales order table
Parameters
Define field types for columns
Header/table supported
Table

For more information about recognition and processing details for the fields of
invoice applications, see Section 9 “Field references for IES” in OpenText Vendor
Invoice Management for SAP Solutions - Scenario Guide for Invoice Solution (VIM-CCS),
“Defining custom fields” on page 166, and “Defining custom table fields”
on page 172.

116 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

5.2.1.4 Machine learning

The key advantage of Information Extraction Service is the reduction of
implementation and configuration efforts, combined with fast learning success. That
is why Information Extraction Service include preconfigured scenarios. For the
invoice solution the invoice knowledge base has been integrated and runs combined
with the intelligent field types leveraging a learning voting algorithm.

5.2.1.4.1 Learning algorithms

The learning algorithms foundation named CSA (= Continuous Self Adaptation) of

Information Extraction Service uses a combination of learning algorithms: Statistics
based algorithms in combination with artificial intelligence algorithms. All learning
algorithms are developed and owned by OpenText. OpenText has patents pending
for it. The focus of CSA learning algorithms is learning based on a small sample set
of business documents through user feedback or feedback from automated business
rules. CSA starts learning as soon as the first document is processed. Learning is
based on a combination of two different algorithm types and a mixture of both:

• Layout based algorithms, for example business partner determination, and item
table recognition. These work based on the layout. Layout based learning means
that internally a model is computed per document layout. Layout definition is
mostly text based and also considers geometry of the data located on a
document. So typically a document related to a business partner may be
considered as a layout. But in reality multiple business partners are sharing the
same layout, the learning algorithm is also able to handle sublayouts.
Layout based algorithms learn very fast, providing automatic recognition result
from the second pass of the same layout. For complex tables more passes may be
necessary.
• Layout independent algorithms, for example data, such as amounts, dates and
document references. These algorithms identify relevant data structures and
keywords and learn to extract it also on documents with an entirely different
layout.
Layout independent algorithms take more time to learn data structures, related
keywords and surrounding text. What has been learned by this algorithm type
will also be applied to completely unknown documents containing the same data
structures, keywords and surrounding text. With this technique, the data entry
effort diminishes more and more, and the longer the system is in production it
learns more document layouts.

Learning Before using Information Extraction Service, the user manually entered data from
system business documents. With Information Extraction Service, the user continues to do
his daily work, and with this he provides feedback data to the learning service,
which learns to capture the data automatically starting from the second pass of a
document with either the same layout or showing the same data type, for example
date field with the same format and key word.

Learning is permanently active for adapting continuously to the documents

processed in customer environment.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 117

Chapter 5 Capture Integration

For invoices the user starts from a higher level, because he will get “out of the box”
recognition results from the invoice knowledge base where applicable. A user will
only need to enter data for additional fields that are not supported by the invoice
knowledge base, for example a material number, or fields that could not be extracted
by the invoice knowledge base for some reason, for example complex invoice line
items.

No training phase is required as the system learns unattended in the background.

The business user is the best source of knowledge for the learning process because
he knows exactly which is the relevant data to be captured for creating a business
object in SAP.

5.2.1.4.2 Best practise learning strategy

In general, customers want to prepare the system for business users by applying
preparative learning before business users are using the system.

5.2.1.5 Processing steps

You can control the following tasks with service modules of the Inbound
Configuration:

• Storing documents
• Retrieving documents
• Extracting documents
• Validating documents

Steps for document extraction with Information Extraction Service:

1. The document handler processes the required service modules and sends the
image along with parameters for extraction and business data to Information
Extraction Service.

118 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

• The status is set to Sent to Extraction.

2. Information Extraction Service processes the document and sends the extraction
result back.

• Extraction result is stored in /OTX/PF11_T_DEXT table.

• Document status is set to Extraction Completed.
3. The document handler picks the registered items with status Extraction
Completed and checks if validation is required.
If validation is required, the status is set to Ready for Validation.
If validation is not required, the document handler processes the corresponding
service modules and triggers the target application.
4. The validation service calls the /OTX/PF11_VAL_GET_DATA API and gets the next
document for validation:

• It gets one document in status Ready for Validation.

• For this document, it gets the extraction result, which is used by the
Validation Client.
5. When the validation is completed by submitting extraction results, the
Validation Client calls the /OTX/PF11_VAL_SET_DATA API:

• It updates the extraction data in table /OTX/PF11_T_DEXT with validation

data.
• It updates the document status to Validation Completed.
6. The /OTX/PF11_VAL_SET_DATA API checks if the feedback should be sent after
validation.
If it should be sent, the validated extraction result is sent to Information
Extraction Service and processed accordingly.
7. The document handler picks the registered items with status Validation
Completed, processes the corresponding service modules, and triggers the target
application.

The following parameters for request time-out, retry of requests, and waiting period
in case of temporary connection problems are set for communication of SAP and
Information Extraction Service:

Request Type Timeout Retries Waiting period for retry (seconds)

(seconds)
Feedback 16200 3 60 (doubled for each retry)
Extract 16200 3 60 (doubled for each retry)
Ping 3600 3 60 (doubled for each retry)
Create profile 60 0 60 (doubled for each retry)

VIM200405-CGF-EN-02 Configuration Guide for Foundation 119

Chapter 5 Capture Integration

Request Type Timeout Retries Waiting period for retry (seconds)

(seconds)
Delete profile 60 3 60 (doubled for each retry)
Update profile 60 0 60 (doubled for each retry)

Note: In contrast to retry configuration, time-out configuration is only relevant

for Information Extraction Service on-premises deployment.

5.2.2 Configure connection

5.2.2.1 On-Premises: Configuring the connection
There is a communication in two directions between SAP and IES. To establish an
outbound as well as an inbound connection, the communication must be configured.

The IES Request handler must be scheduled to monitor timeouts and initiate
automatic retries of requests. For more information, see Section 2.2.4 “IES request
handler” in OpenText Vendor Invoice Management for SAP Solutions - Administration
Guide (VIM-AGD).

Note: Configure the relevant HTTP or HTTPS settings within the Information
Extraction Service. For more information, see Section 6.13.1 “Intelligent
Capture for SAP (on-premises)” in OpenText Vendor Invoice Management for SAP
Solutions - Administration Guide (VIM-AGD).

From a security perspective, in most cases communication via http or https

without client certificate authentication is sufficient. Be aware that
communication via https with client certificate authentication is much more
complex and additional requirements have to be met.

5.2.2.1.1 On-Premises: Outbound communication

There are several scenarios for the outbound communication:

5.2.2.1.1.1 Scenario 1: Communication using HTTP

To configure the outbound communication using HTTP:

1. Run the SM59 transaction to configure a new RFC connection.

2. Create a new RFC destination of type G (HTTP Connection to External Server)

with the following parameters:
Header parameters

RFC Destination
Technical ID of the connection
Connection Type
Choose type G.

120 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

Description
Enter a description for the connection.

Technical Settings tab

Target Host
Full qualified host name of the IES service
Service No.
Port of IES service which should be used to retrieve requests. For HTTP
connections, this is usually 8080.

Special Options tab

Timeout
Use either an ICM Default Timeout, or specify a deviating timeout based on
your requirements or network infrastructure.
HTTP Version
HTTP 1.1
Compression
Inactive
Compressed Response
Yes
Accept Cookies
No

3. Save your settings.

4. Run a connection test using the corresponding button in the application toolbar.
The test result should include status HTTP response 200.

Note: This RFC connection test just verifies if the target service is
reachable. A comprehensive connection test is possible after completion of
all connection settings. For more information, see “Performing a
connection test” on page 139.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 121

Chapter 5 Capture Integration

5.2.2.1.1.2 Scenario 2: Communication using HTTPS w/o SSL client certificate

authentication

To configure the outbound communication using HTTPS w/o SSL client

certificate authentication

1. Run the SM59 transaction to configure a new RFC connection.

2. Create a new RFC destination of type G (HTTP Connection to External Server)

with the following parameters:
Header parameters

RFC Destination
Technical ID of the connection
Connection Type
Choose type G.
Description
Enter a description for the connection.

Technical Settings tab

Target Host
Full qualified host name of the IES service
Service No.
Port of IES service which is used to retrieve requests. For HTTPS port, this is
usually 443.

Note: To trust the IES server certificate, add its intermediate and root
CA certificates to the certificate list of the SSL client PSE of the SAP
system. For details, see SAP Note 510007.

Special Options tab

Timeout
Use either an ICM Default Timeout, or specify a deviating timeout based on
your requirements or network infrastructure.
HTTP Version
HTTP 1.1
Compression
Inactive
Compressed Response
Yes
Accept Cookies
No

122 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

3. On the Login & Security tab , perform the following configuration:

SSL
Select Active.

SSL Certificate
Select the appropriate SSL Client Identity (PSE) which does not use the SSL
client certificate, typically SSL Client (Anonymous).

4. Run a connection test using the corresponding button in the application toolbar.
The test result should include status HTTP response 200.

Note: This RFC connection test just verifies if the target service is
reachable. A comprehensive connection test is possible after completion of
all connection settings. For more information, see “Performing a
connection test” on page 139.

5.2.2.1.1.3 Scenario 3: Communication using HTTPS with SSL client certificate

To configure the outbound communication using HTTPS with SSL client

certificate authentication:

1. Perform the first two steps of scenario 2 (“Scenario 2: Communication using

HTTPS w/o SSL client certificate authentication” on page 125).

Notes

• The IES requires the subject name field (CN) of the SSL client certificate
of the SAP system to contain the fully qualified host name of the SAP
system. The default SSL client certificate does not meet this requirement
and therefore must be replaced.
• By default, the SSL client certificate is provided via client PSE SSL client
SSL Client (Standard).
• To trust the IES server certificate, add its intermediate and root CA
certificates to the certificate list of the SSL client PSE of the SAP system.
• For details, see SAP Note 510007.

2. On the tab Login & Security, perform the following configuration:

SSL
Select Active.

SSL Certificate
Select the appropriate SSL Client Identity (PSE) containing the SSL client
certificate, typically SSL Client (Standard).

3. Run a connection test using the corresponding button in the application toolbar.
The test result should include status HTTP response 200.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 123

Chapter 5 Capture Integration

Note: This RFC connection test just verifies if the target service is
reachable. A comprehensive connection test is possible after completion of
all connection settings. For more information, see “Performing a
connection test” on page 139.

5.2.2.1.2 On-Premises: Inbound communication

There are several scenarios for the inbound communication:

5.2.2.1.2.1 Scenario 1: Communication using HTTP

To configure the inbound communication using HTTP:

1. Run the PFCG transaction to create a role for processing inbound requests from
IES.

a. Define authorization for object S_ICF (Authorization Check for ICF Access)
with the following values:

• ICF_FIELD: 'SERVICE'
• ICF_VALUE: 'OTBCINB'
b. Add the authorization for the J_6NPF_RFC object (BC RFC calls) with the
values: ACTVT: '03'.
c. Save and generate the role.

2. Run the SU01 transaction to create a user of type Service for processing
inbound requests from IES and assign the authorization role defined in Step 1
on page 124.

3. Run the SICF transaction to create services for processing inbound requests
from IES.

Caution
Do not change any values on the selection screen and press the execute
button to get to the service maintenance screen.
Services are created below a virtual host. For example, default_host.
Align with your SAP basis administrator where to create the services
for inbound requests from IES.

4. Create a new service for repository requests of type Independent Service. For
example, zpf12_repo.

a. On the detail screen of the service, open the Service Data tab and define the
SAP authorization OTBCINB.
b. Switch to the Logon Data tab and set the procedure to Required with
Logon Data. In the logon data section, define the user name and the
password of the service user created in Step 2 on page 124.

124 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

c. Switch to the Handler List tab and define class /OTX/PF12_CL_SERVICE_

HNDL_REPO as handler with order number 1.
d. Activate the service and test it. When testing the service, an HTTP 400 error
with message ‘“Failed to load resource: the server responded with a status
of 400 (Request method GET not allowed)” should be displayed in a
browser window. This is the correct reaction because the handler class
blocks HTTP GET requests. If this message is visible, the configuration of
the service is correct, and the handler class is invoked.

5. Create a new service for result requests of type Independent Service. For
example, zpf11_result.

a. On the detail screen of the service, open the Service Data tab and define the
SAP authorization OTBCINB.
b. Switch to the Logon Data tab and set the procedure to Required with
Logon Data. In the logon data section, define the user name and the
password of the service user created in Step 2 on page 124.
c. Switch to the Handler List tab and define class /OTX/PF11_CL_SERVICE_
HNDL_RSLT as handler with order number 1.
d. Activate the service and test it. When testing the service, an HTTP 400 error
with message ‘“Failed to load resource: the server responded with a status
of 400 (Request method GET not allowed)” should be displayed in a
browser window. This is the correct reaction because the handler class
blocks HTTP GET requests. If this message is visible, the configuration of
the service is correct, and the handler class is invoked.

5.2.2.1.2.2 Scenario 2: Communication using HTTPS w/o SSL client certificate

authentication

To configure the inbound communication using HTTP:

1. Run the PFCG transaction to create a role for processing inbound requests from
IES.

a. Define authorization for object S_ICF (Authorization Check for ICF Access)
with the following values:

• ICF_FIELD: 'SERVICE'
• ICF_VALUE: 'OTBCINB'
b. Add the authorization for the J_6NPF_RFC object (BC RFC calls) with the
values: ACTVT: '03'.
c. Save and generate the role.

2. Run the SU01 transaction to create a user of type Service for processing
inbound requests from IES and assign the authorization role defined in Step 1
on page 125.

3. Run the SICF transaction to create services for processing inbound requests
from IES.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 125

Chapter 5 Capture Integration

Caution
Do not change any values on the selection screen and press the execute
button to get to the service maintenance screen.
Services are created below a virtual host. For example, default_host.
Align with your SAP basis administrator where to create the services
for inbound requests from IES.

4. Create a new service for repository requests of type Independent Service. For
example, zpf12_repo.

a. On the detail screen of the service, open the Service Data tab and define the
SAP authorization OTBCINB.

b. Switch to the Logon Data tab and set the procedure to Required with
Logon Data. In the logon data section, define the user name and the
password of the service user created in Step 2 on page 125.

c. Switch to the Handler List tab and define class /OTX/PF12_CL_SERVICE_

HNDL_REPO as handler with order number 1.

d. Activate the service and test it. When testing the service, an HTTP 400 error
with message ‘“Failed to load resource: the server responded with a status
of 400 (Request method GET not allowed)” should be displayed in a
browser window. This is the correct reaction because the handler class
blocks HTTP GET requests. If this message is visible, the configuration of
the service is correct, and the handler class is invoked.

5. Create a new service for result requests of type Independent Service. For
example, zpf11_result.

a. On the detail screen of the service, open the Service Data tab and define the
SAP authorization OTBCINB.

b. Switch to the Logon Data tab and set the procedure to Required with
Logon Data. In the logon data section, define the user name and the
password of the service user created in Step 2 on page 125.

c. Switch to the Handler List tab and define class /OTX/PF11_CL_SERVICE_

HNDL_RSLT as handler with order number 1.

d. Activate the service and test it. When testing the service, an HTTP 400 error
with message ‘“Failed to load resource: the server responded with a status
of 400 (Request method GET not allowed)” should be displayed in a
browser window. This is the correct reaction because the handler class
blocks HTTP GET requests. If this message is visible, the configuration of
the service is correct, and the handler class is invoked.

126 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

5.2.2.1.2.3 Scenario 3: Communication using HTTPS with SSL client certificate

authentication

To configure the inbound communication using HTTPS with SSL client

certificate authentication:

1. Perform the first two steps of scenario 1 (“To configure the inbound
communication using HTTP:“ on page 124).

Notes

• To trust the IES SSL client certificate, add its intermediate and root CA
certificates to the certificate list of the server PSE of the SAP system.
• By default, the server certificate is provided via server PSE SSL server
Standard.
• For details, see SAP Note 510007.
2. Instead of creating two new services for inbound communication, you may
leverage the two provided services /otbcinb/pf11_result and /otbcinb/
pf12_repository as they are. Activate these services if they are not yet active.

Note: As the inbound HTTPS communication requires IES’s SSL client

certificate to be sent, the logon procedure for both inbound services must
be Required with SSL Certificate.
As a result, you cannot test the services from within the SAP system itself.
3. Run the SM30 transaction to assign IES’s SSL client certificate to the service user
created in Step 1 on page 127 for processing inbound requests from IES, using
the following parameters:

Table/View
Enter VUSREXTID, and then click Maintain.
External ID type
Select DN and continue.

4. To create a new entry, click New Entries:

a. Export the IES SSL client certificate into a file with suffix .cer.
b. To obtain the External ID from the .cer file, click the import button.
c. Select the service user for inbound communication created during Step 1
on page 127.
d. Enable the Activated flag.
5. Save your settings.

SAP is offering a new way of assigning client certificates to SAP users. This is
configured by the profile parameter login/certificate_mapping_rulebased in
the RZ10 transaction. If this parameter is set to 1, you must use the CERTRULE
transaction instead of table view VUSREXTID.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 127

Chapter 5 Capture Integration

5.2.2.1.3 On-Premises: Connection parameters

Note: Connection parameters are client-dependent and are not transportable.

Therefore you need to maintain connection parameters manually on each client
which you want to connect to IES.

To define connection parameters:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Capture > Information Extraction Service > Connection
parameters.

3. On the Global Settings Overview screen, define connection parameters using

the following keys:

Host name for inbound requests

Full qualified host name of the SAP system processing the inbound requests
from the IES service.
Not needed if the outbound communication to IES uses https with client
certificates. In this case, the host name is extracted from the CN attribute of
the SAP SSL client certificate used for the HTTPS communication from SAP
to IES.
You can either specify the host name of a dedicated SAP application server
or the host name of a load balancer.

Port for inbound requests (http)

Port of the SAP application server or load balancer that should be used to
process http requests from the IES service. Default is 8000.
Just needed if inbound communication with http is used.

Port for inbound requests (https)

Port of the SAP application server or load balancer that should be used to
process https requests from the IES service. Default is 8443.
Just needed if inbound communication with https is used.

4. Double-click Connection On-premise in the Dialog Structure.

5. On the Connection Overview screen, create a new entry.

Use the following parameters:

Connection ID
Technical ID of the connection to IES

Destination
Technical ID of the RFC destination to IES created in “On-Premises:
Outbound communication” on page 120.

128 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

SSL Enabled
Select this check box if SSL should be used for the request sent from IES to
SAP.
URL Path Repository
Enter the path to the service for inbound repository requests configured in
“On-Premises: Inbound communication” on page 124.
Note: Do not forget to start the path with a leading slash (/).

URL Path Result

Enter the path to the service for inbound result requests configured in “On-
Premises: Inbound communication” on page 124.
Note: Do not forget to start the path with a leading slash (/).

6. Save your configuration and return to the VIM Foundation Configuration.

7. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Capture > Information Extraction Service > Connection test.

8. Execute a connection test for the connection ID that you created in the previous
steps.
The result screen should show that the connection test for all 3 services was
successful.

5.2.2.2 Cloud Edition: Configuring the connection

The communication from SAP to IES Cloud Edition is unidirectional. To establish
the outbound connection, the communication must be configured.

The IES Request handler must be scheduled to enable the unidirectional

communication to IES. Furthermore, this request handler monitors timeouts and
initiates automatic retries of requests. For more information, see Section 2.2.4 “IES
request handler” in OpenText Vendor Invoice Management for SAP Solutions -
Administration Guide (VIM-AGD).

Tip: Before you start the configuration in SAP, obtain the client ID and the
client secret for accessing capture services.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 129

Chapter 5 Capture Integration

5.2.2.2.1 Cloud Edition: Outbound communication

Note: To trust the IES SSL server certificate (Core Capture for SAP), add its
root CA certificate to the certificate list of the SSL client PSE (Anonymous) of
the SAP system through transaction code STRUST.

For details, see SAP Note 510007.

Table 5-1: Parameters for available data centers

Services Region: North America Region: European Union

Capture services – Target capture.ot2.opentext. capture.ot2.opentext.
Host com eu
Capture services – Root USERTrust RSA Certification Authority Download
Certificate PEM file (https://crt.sh/?id=1199354)
Token service – Host name otdsauth.ot2. otdsauth.ot2.
opentext.com opentext.eu
Token service – Root USERTrust RSA Certification Authority Download
Certificate PEM file (https://crt.sh/?id=1199354)

To configure the outbound communication:

1. Run the SM59 transaction.

2. Create a new RFC destination for the connection to capture services.

130 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

Note: The application screen elements may differ depending of the

installed SAP version.

Use the following settings:

RFC Destination
Technical ID of the connection. For example CC4S_OT2_PROD_EU.
Connection Type
Type G (HTTP Connection to External Server)
Description
A description for the connection.
Technical Settings tab

• Target Host: Full qualified host name of capture services. Depending on

your location, enter either capture.ot2.opentext.eu or capture.ot2.
opentext.com.

• Path Prefix: Path to the home document of capture services. Enter /cp-
rest.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 131

Chapter 5 Capture Integration

• Service No.: 443

• HTTP Proxy Options: Configure the proxy options, if proxy is required
to connect from the network where your SAP system is hosted to the
Internet.

Logon & Security tab

• Logon Procedure: No Logon

• SSL: Active
• SSL Certificate: ANONYM – SSL Client (Anonymous)

132 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

Special Options tab

• Timeout: Use either an ICM Default Timeout, or specify a deviating

timeout based on your requirements or network infrastructure.
• HTTP Version: HTTP V1.1
• Compression: Inactive
• Compressed Response: Yes
• Accept Cookies: No

3. Save the connection, and then click the Connection Test button.
The test result should include status HTTP response 200.
With this test you validate that the URL for the capture service is correct and
that the service can be reached.
4. Create a new RFC destination for the connection to the token service.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 133

Chapter 5 Capture Integration

Note: The application screen elements may differ depending of the

installed SAP version.

Use the following settings:

RFC Destination
Technical ID of the connection. For example CC4SAP_OT2_PROD_EU_TOKEN.
Connection Type
Type G (HTTP Connection to External Server)
Description
A description for the connection.
Technical Settings tab

• Target Host: Full qualified host name of the token service. Depending
on your location, enter otdsauth.ot2.opentext.eu or otdsauth.ot2.
opentext.com.
• Path Prefix: Path to the OAuth2 token service . Enter /oauth2/token.
• Service No.: 443

134 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

• HTTP Proxy Options: Configure the proxy options, if proxy is required

to connect from the network where your SAP system is hosted on the
Internet.

Logon & Security tab

• Logon Procedure: Basic Authentication

• SSL: Active
• SSL Certificate: ANONYM - SSL Client (Anonymous)
• Logon - User: Client ID for accessing capture services
• Logon - Password: Client Secret for accessing capture services

VIM200405-CGF-EN-02 Configuration Guide for Foundation 135

Chapter 5 Capture Integration

Special Options tab

• Timeout: Use either an ICM Default Timeout, or specify a deviating

timeout based on your requirements or network infrastructure.
• HTTP Version: HTTP 1.1
• Compression: Inactive
• Compressed Response: Yes
• Accept Cookies: No

5. Save the connection, and then click the Connection Test button.
The test result should include HTTP response 405 ‑ Method Not Allowed status.
With this test you validated that the URL for the OAuth2 token service is correct
and the service can be reached.

136 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

5.2.2.2.2 Cloud Edition: Connection parameters

Note: Connection parameters are client-dependent and are not transportable.

Therefore you need to maintain connection parameters manually on each client
which you want to connected to IES.

To configure the connection parameters:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation> Inbound

Configuration > Capture > Information Extraction Service > Connection
parameters.
3. Double-click Connection – Public Cloud.

4. On the Connection Public Cloud Overview screen, create a new entry.

Use the following parameters:

Connection ID
Technical ID of the connection to IES.
Destination IES
Technical ID of the RFC destination for the capture services. For
example IES_CAPTURE.
The ID is created in the Outbound communication. For more information,
see “Cloud Edition: Outbound communication” on page 130.
Destination Token
Technical ID of the RFC destination for the OAuth2 token service. For
example IES_TOKEN.
The ID is created in the Outbound communication. For more information,
see “Cloud Edition: Outbound communication” on page 130.

5. Save your configuration and return to the VIM Foundation Configuration.

6. Click OpenText Vendor Invoice Management Foundation> Inbound

Configuration > Capture > Information Extraction Service > Connection test.

7. Execute a connection test for the connection ID that you created in the previous
steps.
The result screen should show that the connection test for all 3 services was
successful.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 137

Chapter 5 Capture Integration

5.2.2.3 Configure asynchronous processing

In order to distribute the load for various tasks of the IES integration, asynchronous
processing is in place in following situations:

• to process extraction results retrieved from IES

• to process a validation result retrieved from Validation Client
• to process a validation result retrieved from Capture Validation. In this case
asynchronous processing is in place by default; this can be changed to
synchronous processing on demand by changing the basic setting. For more
information see “Customizing basic settings for Inbound Configuration”
on page 60.

For the optimal throughput, a parallel RFC (pRFC) runs without any queuing. If
running pRFC is not possible because of resource shortage, a background RFC
(bgRFC) runs using a queuing mechanism.

To configure asynchronous processing, follow these steps:

1. Restrict load distribution to specific application servers (optional).

2. Use a custom inbound destination (optional).
3. Create and schedule a background inbound destination.

For more information about inbound destinations for bgRFC definition and server
group definition, see SAP documentation (https://help.sap.com/).

For additional information about RFC scenarios, see the following SAP notes:

• 986373 - RFC load distribution

• 2309399 - How to use SBGRFCCONF effectively
• 74141 - Resource Management for tRFC and aRFC

5.2.2.3.1 Restricting load distribution

By default, the pRFC uses all available application servers to distribute the load. You
can restrict the pRFC from using specific application servers. This is an optional
procedure.

To restrict specific application servers:

1. Run the RZ12 transaction.

2. Define dedicated server group definition.

3. Run the /n/OTX/PF00_IMG transaction.

4. Click OpenText Vendor Invoice Management Foundation > General Settings

> General Settings.

138 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

5. Add parameter Server Group for pRFC and assign the server group defined in
step 2.

5.2.2.3.2 Using a custom inbound destination

The bgRFC uses a background inbound destination to start the RFC. The default
inbound destination is /OTX/PF00_BGRFC_INB_DEST, but you can configure a
different inbound destination. This is an optional procedure.

To use a different inbound destination

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > General Settings

> General Settings.

3. Add parameter Inbound Destination for bgRFC and define the name of the
custom inbound destination.

5.2.2.3.3 Creating and scheduling a background inbound destination

You must create and schedule either the default or a custom inbound destination.

To create and schedule a background inbound destination:

1. Run the SBGRFCCONF transaction.

2. Make sure a supervisor destination is assigned. You have to create a supervisor

destination if it is not available.

3. Define an inbound destination and save the changes. Optionally, you can assign
a dedicated server group. Queue prefixes are not required.

4. Configure Scheduler for the inbound destination, adjust settings according to

the requirements, and save the changes.

5.2.2.4 Performing a connection test

After you configure the asynchronous request processing, you should perform a
connection test.

This connection test verifies, that all the connection settings are correct and that the
end-to-end communication is working.

In contrast to a simple ping to the RFC destination this connection test verifies:

• The credentials that are used to obtain the access tokens (just relevant for cloud
edition).
• The inbound connection (just relevant for on-premises).
• The IES server processing.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 139

Chapter 5 Capture Integration

To perform a connection test:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation> Inbound

Configuration > Capture > Information Extraction Service > Connection Test.

3. On the selection screen use the following parameter:

Connection ID
Technical ID of the connection to IES

4. Click Execute.

5. Verify if the connection test was successful.

5.2.3 Customizing
The following mandatory configurations, set up a best practice default to capture
information.

To use Information Extraction Service there are following mandatory tasks in

Inbound Configuration:

1. Reuse existing document handler or create your own module handler. Use:

• CAPTURE_CL for solutions beyond invoice

• PS03_IES for invoice solution
• Module class /OTX/PF11_CL_MOD_REQUEST_SEND to create your own module
handler with Information Extraction Service. For more information, see
“Creating a document handler” on page 68.
2. Create a registration type which is using this document handler. For more
information, see “Customizing registration types” on page 71.
3. Create a Capture profile and assign it to the scenario. For more information, see
“Creating a Capture profile” on page 146.
4. Assign the ArchiveLink document type which is used for your registration type
to the profile. For more information, see “Assigning an ArchiveLink document
type” on page 175.
5. Activate the Capture profile and specify the IES connection. For more
information, see “Activating and updating a Capture profile” on page 179.

Note: OpenText recomments to consider the optional tasks regarding format

interpretation and validation field settings into account.

As learning is one of the central features of Information Extraction Service make sure
that feedback is provided in an optimal way as described in the Best practice
learning strategy. For more information, see “Customizing feedback” on page 187.

140 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

To enable validation, see the dedicated configuration. For more information, see
“Customizing validation” on page 182.

If there is a need for additional extraction fields, see:

• “Defining custom fields” on page 166

• “Defining custom table fields” on page 172

You can customize the default Business Entity Determination behavior:

• “Customizing the Business Entity determination” on page 141.

• “Defining custom fields for entity determination” on page 155

• “Assigning an entity determination field” on page 159

• “Assigning an entity determination” on page 160

5.2.3.1 Customizing the Business Entity determination

To process business documents within SAP the determination of relevant SAP
business entities is important. A business entity represents for example the
corresponding business partner or a legal entity:

Example:

• Order

– Ship-to party
– Sold-to party
• Invoice

– Supplier/Vendor
– Company code
• Delivery Note

– Plant
• Order Confirmation

– Plant
• Remittance Advices

– Receiver
– Payer

VIM200405-CGF-EN-02 Configuration Guide for Foundation 141

Chapter 5 Capture Integration

5.2.3.1.1 Processing of the Business Entity determination

Various data (business entity determination fields) which can appear on business
documents is used to determine business entity candidates in SAP.

Determination fields which are extracted from a document belong either to the
master data of the business entity, for example name, address, bank details, tax
number or they are related to some transaction data (to a reference document, for
example, purchase order).

Extracted determination fields are used in SAP to look up possible business entity
candidates. In an additional extraction step, the determined business entity
candidates are matched with a specific confidence against further available
information on the document.

The result is used to determine the business entity on SAP side.

In the past, IES used solely a learning-based method to determine business entities.
This requires some training.

142 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

Business entity determination and configuration provides the possibility to consider

SAP master data and/or transactional data for business entity determination in
combination with a learning-based method. The business entity is only determined
based on the result of the related matcher fields. For more information, see
“Configuring the Determination Definition” on page 176.

To use business entity determination with IES, you must configure at least one
profile with the new version 2 scenario for the used scenario. For more information,
see “Creating a Capture profile” on page 146.

In a scenario, standard determination fields and extraction parameters are defined

for the specific scenario version. The pre-configured determination fields are used in
the business entity determination configuration which provides a best practice
implementation to determine the business entity. Custom determination fields to
determine the business entity candidates can also be added to the profile
configuration.

Delivered determination fields for entity determination:

Determination field Type Description Field Exit

IBANCandidates iban_number IBAN numbers
MailAddresses email Mail addresses /OTX/
PS00_CL_ATTR_CA
ND_MAIL
PayerAddresses address Payer addresses /OTX/
PS00_CL_ATTR_AD
DR_ACC
PayerAttributes attribute_extractor Payer attribute /OTX/
extractor PS00_CL_ATTR_EXT
R_ACC
PayerMatcher entity_matcher Entity matcher for /OTX/
payer PS00_CL_ATTR_MA
TCH_ACC
PlantAddresses address Plant addresses /OTX/
PS00_CL_ATTR_AD
DR_WERKS
PlantAttributes attribute_extractor Plant attribute /OTX/
extractor PS00_CL_ATTR_EXT
R_WERKS
PlantMatcher Entity matcher Entity matcher for /OTX/
plant PS00_CL_ATTR_MA
TCH_WERKS
POCandidates range Purchase order /OTX/
numbers PS00_CL_ATTR_CA
ND_PO

VIM200405-CGF-EN-02 Configuration Guide for Foundation 143

Chapter 5 Capture Integration

Determination field Type Description Field Exit

ReceiverAddresses address Receiver addresses /OTX/
PS00_CL_ATTR_AD
DR_BUKRS
ReceiverAttributes attribute_extractor Receiver attribute /OTX/
extractor PS00_CL_ATTR_EXT
R_BUKRS
ReceiverMatcher entity_matcher Entity matcher for /OTX/
receiver PS00_CL_ATTR_MA
TCH_BUKRS
ShipToAddresses address ShipTo addresses /OTX/
PS00_CL_ATTR_AD
DR_SHIPTO
ShipToAttributes attribute_extractor ShipTo attribute /OTX/
extractor PS00_CL_ATTR_EXT
R_SHIPTO
ShipToMatcher entity_matcher Entity matcher for /OTX/
ShipTo PS00_CL_ATTR_MA
TCH_SHIPTO
SoldToAddresses address SoldTo addresses /OTX/
PS00_CL_ATTR_AD
DR_SOLDTO
SoldToAttributes attribute_extractor SoldTo attribute /OTX/
extractor PS00_CL_ATTR_EXT
R_SOLDTO
SoldToMatcher entity_matcher Entity matcher for /OTX/
SoldTo PS00_CL_ATTR_MA
TCH_SOLDTO
SupplierAddresses address Supplier addresses /OTX/
PS00_CL_ATTR_AD
DR_LIFNR
SupplierAttributes attribute_extractor Supplier attribute /OTX/
extractor PS00_CL_ATTR_EXT
R_LIFNR
SupplierMatcher entity_matcher Entity matcher for /OTX/
supplier PS00_CL_ATTR_MA
TCH_LIFNR
TaxNumberCandidat tax_number VAT IDs
es
URLAddresses url URL addresses /OTX/
PS00_CL_ATTR_CA
ND_URL

Assigned entity determination for entity fields within scenario configuration:

144 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

Determination
Scenario Entity field Staging table Key field
definition
SoldTo PS02_SOLDTO /OTX/ Customer
Sales Order
ShipTo PS02_SHIPTO PS00_T_STG2 Customer
/OTX/
Supplier PS08_SUPPLIER Vendor
PS00_T_STG1
Invoice
/OTX/
Recipient PS08_RECIPIENT Company Code
PS00_T_STG3
/OTX/
Delivery Note ShipTo PS01_SHIPTO Plant
PS11_T_STG6
/OTX/
Payer PS07_ACCOUNT Customer
PS00_T_STG2
Remittance Advice
/OTX/
Receiver PS07_RECIPIENT Company Code
PS00_T_STG3
Order /OTX/
ShipTo PS09_SHIPTO Plant
Confirmation PS11_T_STG6

The look up of possible business entity candidates from extracted determination

fields is processed from the staging tables. You must therefore schedule the
corresponding reports to fill the staging tables. For more information, see OpenText
Vendor Invoice Management for SAP Solutions - Administration Guide (VIM-AGD).

Notes

• Ensure that your master data is maintained correctly.

• Duplicate data entries or master data which is not available on the extracted
document leads to incorrect results for business entity determination.
• Do not add multiple bank data to the staging table via the staging report for
company code determination.
• For a profile with version 2 scenario, the business entity determination is
preconfigured for the delivered scenarios.
• There is no need to upgrade a profile from version 1 scenario to version 2
scenario for a productive profile. An upgrade makes sense if business entity
determination fails due to identical document layouts with different or
changing business entities.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 145

Chapter 5 Capture Integration

5.2.3.1.2 Migration

In order to migrate a profile of version 1 scenario (learning-based method) to the

new version 2 scenario (using business entity determination), the following steps are
required:

Note: Migration of a custom profile (PF11_CUSTOM scenario) from version 1 to

version 2 is not supported!

• Create a snapshot of your active profile which you want to migrate. For more
information, see Section 4.1 “Creating a snapshot” in OpenText Vendor Invoice
Management for SAP Solutions - Administration Guide (VIM-AGD).
Copy the profile that you want to migrate to a new profile, and then specify
version 2. For more information, see “Copying a Capture profile” on page 154.
• Activate the newly created profile with restore of snapshot. For more
information, see Section 4.3 “Restoring a snapshot” in OpenText Vendor Invoice
Management for SAP Solutions - Administration Guide (VIM-AGD).
• Execute pre-learning for business entity determination operators. For more
information, see Section 2.4.5.2 “Initiating pre-learning of a selection variant for
BED” in OpenText Vendor Invoice Management for SAP Solutions - Administration
Guide (VIM-AGD).
• Assign the archive link document type from the old profile to your newly created
profile to run newly injected documents with the new profile.
• Ensure that the report to fill the related staging tables is executed again. For more
information, see Section 2.2.2 “Staging tables for capture integration” in OpenText
Vendor Invoice Management for SAP Solutions - Administration Guide (VIM-AGD).

5.2.3.2 Creating a Capture profile

To create a Capture profile:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Capture > Information Extraction Service > Capture Profile
Maintenance.

3. On the Profile Overview screen, create a new entry, using the following
parameters:

Capture Profile ID
Technical ID of the profile.
Capture Profile Description
Enter the description of the profile.
Scenario
Assign the scenario.

146 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

Version
Assign version of scenario.
Note: For Incoming Supplier Invoice, Incoming Order, Incoming
Delivery Notes, Incoming Order Confirmations, and Incoming
Remittance Advice scenarios, a scenario version 2 exists which uses
Business Entity Determination by default.
Doc.type training
Assign the ArchiveLink document type for the training process. You can
assign specific users to validate a document within the training. For more
information, see “Assigning an agent to an ArchiveLink document type”
on page 186.
The document type is used when the training is triggered either manually
through the Start Training action in Inbound Administration or
automatically through a job based on the Training required indicator. For
more information on Start Training action in Inbound Administration and
Training required indicator, see Section 3.6 “Inbound Administration work
center” in OpenText Vendor Invoice Management for SAP Solutions -
Administration Guide (VIM-AGD).
For documents in the training process the validation step is obligatory and
feedback is sent after validation.
Scenario Description
Description of the scenario.
Entity Class
This is an optional setting.
Default value: <Empty>
Enter the user exit class to implement additional logic that filters or changes
the business entity determination. The user exit class implements the
interface /OTX/PF11_IF_ENTITY_HANDLE and is only applicable for a profile
of scenario version 2 with business entity determination. For more
information, see “Customizing the Business Entity determination”
on page 141.
If you want to change the standard logic, you can inherit the class /OTX/
PF11_CL_ENTITY_HANDLE, change it according to your requirement, and
then enter it as custom entity class. For some scenarios, a scenario specific
logic is called. You can also inherit from the following scenario related
classes to include your custom logic:

• Invoice: /OTX/PS00_CL_BED_INV_HANDLE:

– Filters CompanyCode based on PONumber.

– Filters Supplier based on CompanyCode.
– Filters Supplier based on PONumber.
• Sales Order: /OTX/PS00_CL_BED_ORDER_HANDLE: Filters ShipTo based
on SoldTo.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 147

Chapter 5 Capture Integration

Methods of interface /OTX/PF11_IF_ENTITY_HANDLE:

FILTER_ENTITY_CANDIDATES
Filters the determined candidates after the lookup inside SAP. The
method is called after the lookup inside SAP and is processed for each
entity field of the profile. You can only remove values from table PCT_
CANDIDATE.

Parameter Type Description

PI_REGID Importing Registration ID
PI_STEP Importing Scenario step
PI_ENTITY_FIELD Importing Field name of the
business entity field
PIT_EXTDATA Importing Data extraction result
PCT_CANDIDATE Changing Computed candidate
keys after lookup

FILTER_CHNG_ENTITY_RESULT
Changes the determined entity and filters the result of the entity
candidates of the matcher. The method is called after all extraction steps
have been processed and is called for each entity field. You can access
the result of all determined entities. You can only remove values from
table PCT_MATCHER_RESULT.

Parameter Type Description

PI_REGID Importing Registration ID
PI_ENTITY_FIELD Importing Field name of the
business entity field
PIT_EXTDATA Importing Data extraction result
PIT_ENTITY_VALUES Importing Result of for all entity
fields
PC_ENTITY_VALUE Changing Determined entity key
PCT_MATCHER_RESU Changing Determined candidate
LT keys of the entity
matcher after extraction

CHANGE_EXECUTION_CONTEXT
Changes the execution context which IES uses for the entity
determination. Default implementation will provide document type,
recipient mail, and sender mail.

Parameter Type Description

PI_REGID Importing Registration ID

148 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

Parameter Type Description

PCT_EXECUTION_CO Changing Key value pairs for
NTEXT context

Extraction class
This is an optional setting.
Default value: <Empty>
Enter the user exit class to implement additional logic that changes the
extraction or validation result. The user exit class implements the interface /
OTX/PF11_IF_HANDLE_RESULT.

Methods of interface /OTX/PF11_IF_HANDLE_RESULT:

PROCESS_EXTRACTION_RESULT
Provides the extraction result. The method is called for each extraction
step.

Parameter Type Description

PI_REGID Importing Registration Id
PI_PROFILE_ID Importing Capture profile Id
PI_SCENARIO_ID Importing Scenario Id
PI_VERSION Importing Scenario version
PI_STEP Importing Scenario step
PIT_EXTRACTION_RES Importing Extraction result
ULT
PIT_EXTRACTION_RES Importing Extraction result with
ULT_PATH path

PROCESS_VALIDATION_RESULT
Provides the validation result. The method is called for each extraction
step.

Parameter Type
PI_REGID Importing
PI_PROFILE_ID Importing
PI_SCENARIO_ID Importing
PI_VERSION Importing
PI_STEP Importing
PIT_EXTRACTION_RESULT Importing
PIT_EXTRACTION_RESULT_PATH Importing

VIM200405-CGF-EN-02 Configuration Guide for Foundation 149

Chapter 5 Capture Integration

FORMAT_EXTRACTION_VALUE
Formats the extraction value for each field. The method is called for
each extraction step for each field of type string, date and decimal. You
can change the VALUE of one field (defined with its ID) within the PCS_
EXTRACTION_RESULT structure and access all relevant information of the
whole extraction result within PIT_EXTRACTION_RESULT.

Parameter Type Description

PI_REGID Importing Registration Id
PI_PROFILE_ID Importing Capture profile Id
PI_SCENARIO_ID Importing Scenario Id
PI_VERSION Importing Scenario version
PI_STEP Importing Scenario step
PIT_EXTRACTION_RES Importing Extraction result
ULT
PIT_EXTRACTION_RES Importing Extraction result with
ULT_PATH path
PCS_EXTRACTION_RE Changing Extraction result field
SULT

FORMAT_VALIDATION_VALUE
Formats the extraction value for each field. The method is called for
each validation step for each field of type string, date and decimal. You
can change the VALUE of one field (defined with its ID) within the PCS_
EXTRACTION_RESULT structure and access all relevant information of the
whole extraction result within PIT_EXTRACTION_RESULT.

Parameter Type Description

PI_REGID Importing Registration Id
PI_PROFILE_ID Importing Capture profile Id
PI_SCENARIO_ID Importing Scenario Id
PI_VERSION Importing Scenario version
PI_STEP Importing Scenario step
PIT_EXTRACTION_RES Importing Extraction result
ULT
PIT_EXTRACTION_RES Importing Extraction result with
ULT_PATH path
PCS_EXTRACTION_RE Changing Extraction result field
SULT

150 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

Caution
• Only the VALUE field of PCS_EXTRACTION_RESULT structure
is processed.
• The value can only be reformatted. A new value no matter
if it is with or without relation to the document and the
extracted raw value is not learned.

• Write the VALUE according to the field types (date, decimal,

string) with the correct internal SAP format, for example:

– type decimal = 3232112.12

– type date = 20181228 (format YYYYMMDD)

Extract first Pages

IES can stop the extraction after a defined amount of pages. Enter the
number of pages which you want to extract. By default this parameter is not
active and full text recognition is done for all pages and relevant data fields
are extracted on these pages.
Single Click Entry (SCE) can only work for documents with fulltext which
may not exceed a certain number of pages. The useful limitation is a value
below internal recognition timeout, that is 4 hours per document.
Tip: By using Extract first Pages and Extract last Pages together, IES
can read the first pages as well as the last pages of a document. This
will skip the middle part of long documents.
Extract last Pages
IES can also be instructed to read a limited amount of pages at the end of
the document. Here, only the defined amount of pages, beginning from the
end of the document, are extracted. Enter the number of pages which
should get extracted. By default this parameter is not active and full text
recognition is done for all pages and also relevant data fields are extracted
on these pages.
Skip Image Rendering of Middle Pages
This setting is only considered if parameters Extract first Pages and Extract
last Pages are specified.
If this setting is enabled, the middle pages of a document are not rendered.
That leads to a faster recognition times of long documents. The middle
pages will be replaced by a generic placeholder image in Microsoft
Windows Validation Client and Fiori Capture Validation Workplace.
Use PDF e-Text
Uses the e-text from a searchable PDF. The following options are available:

• Ignore (OCR from image):: PDF files are transformed to tiff, regardless
if they are a searchable PDF or not. OCR recognition extracts the data
only from the image, without using e-text.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 151

Chapter 5 Capture Integration

• Consider (OCR from image voted with e-text): PDF files are
transformed to tiff. e-text is preserved. OCR recognition extracts the data
from the image. The extraction result is rated with e-text. The priority is
OCR data, e-text is just used for supporting OCR.
• Prefer (OCR from e-text or image): PDF files are analyzed page by page:
for pages where e-text is available, OCR recognition is skipped and e-
text is used. Only for pages where no e-text exists, a tif is created and
OCR recognition extracts data from image.

Skip Extraction of Items

Optional setting
Default value: Disabled
If you select this option, the item table is not extracted.
To add the tag Skip Items in the generated XML, method ADD_ELEMENT_
CUSTOM_SCENARIO_OP is called inside method GENERATE_EXTRACT of Class /
OTX/PF11_CL_TRANSFORMATION.

Validation Perspective ID
Optional setting
Default value: <Empty>
Enter the name of a custom Capture Validation Perspective ID to be used
for the Capture profile. By default, the Perspective ID delivered with the
corresponding scenario version is used.
Note: If you use a custom Capture Validation Perspective, you must
map any custom table views to corresponding extraction tables
properly. This is possible by inheriting the default perspective class /
OTX/PF32_CL_CAPT_VAL_WEB_PERS (Solutions Beyond Invoice) or /
OTX/PF32_CL_CAPT_VAL_INV_PERS (Invoice Solution) and redefining
the DETERMINE_VAL_TABLE_BY_VIEW_ID method accordingly.
BAdI /OTX/PF32_CAPT_VAL_CHG_PERS
BAdI /OTX/PF32_CAPT_VAL_CHG_PERS implements the /OTX/PF32_IF_
CAPT_VAL_CHG_PERS interface.
Available interface method: CHANGE_CAPT_VAL_ITEM_PERS
The method allows you to dynamically change the determined item
perspective for the Capture Validation during runtime. It is called when
preparing and loading any item from the Capture Validation Workplace.

Parameter Type Description

PIS_REG Importing Registration Data
PC_ITEM_PERS_ID Changing Item Perspective ID

Validation Check Class

Optional setting
Default value: <Empty>

152 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

Enter the name of a custom Validation Check Class. By default, the

Validation Check Class /OTX/PF11_CL_VAL_CHECK_LOGIC is used.
If the standard logic must be changed for any reasons, you can inherit the
class /OTX/PF11_CL_VAL_CHECK_LOGIC, redefine it as needed, and enter it
as custom check class.
The following method is supposed to be redefined if needed: PF11_VAL_
CHECK_CUSTOM. OpenText recommends that you do not change any other
method. This method allows entering custom validation check logic. For an
implementation example, refer to standard method PF11_VAL_CHECK_
FIELD_SUM.

Parameter Type Description

PIS_VAL_CHECK_DATA-
Importing User settings for validation
VAL_USER_SETTINGS
PIS_VAL_CHECK_DATA-
Importing General settings for validation
VAL_GENERAL_SETTINGS
PIS_VAL_CHECK_DATA-
Importing Field configuration for validation
VAL_FIELD_CONFIG
PIS_VAL_CHECK_DATA-
Importing Current validation result
VAL_RESULT
Full path of the erroneous
extraction field (as imported in
PIS_VAL_CHECK_DATA-
PET_VAL_CHECK_RESULT-
Exporting VAL_RESULT)
VAL_CHECK_PATH
Global check messages without
field dependency can be returned
by leaving the field path empty
PET_VAL_CHECK_RESULT- Field index (0 = header field, 1-n
Exporting
VAL_CHECK_PATH_INDEX = item/ table field)
X in case of check errors
PET_VAL_CHECK_RESULT-
Exporting Not relevant in case of global
VAL_CHECK_ERROR
check messages
PET_VAL_CHECK_RESULT-
Exporting Check error messages
VAL_CHECK_MSG

Note: The standard logic of class /OTX/PF11_CL_VAL_CHECK_LOGIC

implements the field sum check logic as maintained in the profile
validation field settings and in the custom field and custom table field
settings. Additionally for fields with display type currency a validity
check is executed. If no standard logic should be reused at all, it is
allowed to simply implement the /OTX/PF11_IF_VAL_CHECK_LOGIC
interface instead of inheriting the /OTX/PF11_CL_VAL_CHECK_LOGIC
class.
Validation Column Class
Optional setting

VIM200405-CGF-EN-02 Configuration Guide for Foundation 153

Chapter 5 Capture Integration

Default value: <Empty>

Enter the name of a custom Validation Column Class. By default, the
Validation Column Class /OTX/PS00_CL_DYN_COLUMNS_MAP is used. This
maps extracted fields to dynamic columns which are shown within the
Capture Validation Workplace, Fiori Capture Validation, and inbound
Administration (“Processing” and “Error” nodes).
If the standard logic must be changed for any reasons, you can inherit the
class /OTX/PS00_CL_DYN_COLUMNS_MAP, redefine it as needed, and enter it
as a custom column class.
The following method is supposed to be redefined if needed: CUSTOM_
MAPPING. The default mapping already maps relevant information valid for
all scenarios into some dynamic fields. If you need some specific mapping
for your scenario to show this information in the list, you can add your own
logic in this method.

Parameter Type Description

PIT_EXTRACTION_RESULT Importing Extraction result
PIT_EXTRACTION_RESULT_KE Extraction result with path
Importing
Y information
PCS_COLUMNS Changing Dynamic columns

5.2.3.3 Copying a Capture profile

Note: For transporting a copy of the Capture profile customization, you have
to manually include the relevant table content into a transport request. You can
do it under Capture Profile Maintenance activity. Ensure that you also select
the option that includes the dependent entries.

To copy an existing profile and all its dependent settings to a new profile:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click Inbound Configuration > Capture Information Extraction Service >

Copy Capture Profiles.

3. Define the source profile and click enter.

The scenario and the scenario version of the source profile is now displayed.

4. Define the name of the target profile.

The target profile ID must be unique and must not exist.
If you copy a profile, you cannot change the scenario. The scenario version of
the source profile is reused by default for the target profile. But you can specify
a different scenario version manually.

154 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

5.2.3.4 Defining custom fields for entity determination

You configure custom extraction determination fields. These fields are used to
determine business entity candidates.

To configure determination fields

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation> Inbound
Configuration > Capture > Information Extraction Service > Capture Profile
Maintenance.
3. On the Profile Overview screen, double-click Entity Determination Custom
Fields in the Dialog Structure.
4. On the Entity Determination Fields Overview screen, maintain new fields,
using the following parameters:

Determination field
Technical ID of the attribute extraction input field.
Description
Enter a description of the custom field.
Type
Select the field type from the list. The following values are possible:

• address: Recognizes all addresses and returns a structure with the

following fields:

– Name1
– Name2
– Street
– House number
– ZIPCode
– POBox
– City
– Region
– Country
• email: Extracts a list of all available email addresses.
• iban_number: Extracts a list of all iban numbers of a specific format
with checksum processing.
• range: Extracts a list of all numbers within the provided range
(FromString - ToString). The standard field exit class /OTX/PS00_CL_
ATTR_CAND_PO for the POCandidates scenario field provides internal

VIM200405-CGF-EN-02 Configuration Guide for Foundation 155

Chapter 5 Capture Integration

SAP number ranges and external numeric number ranges for the
EINKBELEG number range object . For more information, see “Processing
of the Business Entity determination” on page 142.
IES also supports alphanumeric ranges.
Limitations are:

– Only capital unicode characters from A-Z

– Minimum of 7 characters in the FromString and To String
– FromString and To String must have the same amount of characters.
– FromString and To String must have characters and numbers at
identical positions.
– The characters of the From String must be lexicographically smaller
than the To string.
– Leading zeros are accepted but not delivered, if the length of the PO
number does not exceed ten characters including the leading zero.

In order to extract alphanumeric ranges a custom entity determination

field with its own field exit class can be implemented. Or the staging
table /otx/ps00_t_stg4 has to include the range according to the
supported format.
• entity_matcher: Accesses the entities provided as a list by matching
their attributes against the document. Returns the best matching entities
with confidence as a structured set of data.
• attribute_extractor: Extracts entity attributes from the document as a
structured set via learning.
• tax_number: Extracts a list of all available tax numbers of a specific
format.
• url: Extracts a list of all available URLs.
• regex: Extracts a list of all available information according to your
defined pattern.

Determination field exit

Enter the user exit class to implement logic for specific field types. The user
exit class implements the /OTX/PF11_IF_ENTITY_ATTRMethods interface of
the /OTX/PF11_IF_ENTITY_ATTR interface:

• SET_REGEX_PARAMETER: Sets the parameter for the regular expression

pattern and optional a replacement parameter. This method must be
implemented for determination fields of regex type. The regular
expression must be static and when the regular expression or
replacement parameter is changed you must update the profile for the
changes to take effect. An invalid pattern will raise an error during
activation or update of the profile.

156 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

Parameter Type Description

PI_PROFILE_ID Importing Document Profile Id
PI_SCENARIO_ID Importing Document Scenario ID
PE_REGEX Exporting Pattern parameter for
Regex. Match method
according to the .NET
Framework for regular
expressions of Microsoft.
PE_REPLACE Exporting Replacement parameter
for Regex. Replace
method according to
the .NET Framework for
regular expressions of
Microsoft.

• SET_RANGE_PARAMETER: Sets the parameter for ranges and the type of

the range. This method must be implemented for determination fields of
range type.

Parameter Type Description

PI_PROFILE_ID Importing Document Profile Id
PI_SCENARIO_ID Importing Document Scenario ID
PET_RANGE Exporting Range
PE_CATEGORY Exporting Category of Range

• SET_ADDRESS_PARAMETER: Sets the category of an address parameter

which identifies the address type. This method must be implemented for
determination fields of address type.

Parameter Type Description

PI_PROFILE_ID Importing Document Profile Id
PI_SCENARIO_ID Importing Document Scenario ID
PE_CATEGORY Exporting Category of Address

• SET_MATCH_PARAMETER: Sets the attributes which are used to extract the

business entity and additional information. The keys are extracted from
the document based on the canditate keys that are provided within the
lookup. This method must be implemented for the determination fields
of the entity_matcher.

Parameter Type Description

PI_PROFILE_ID Importing Document profile Id
PI_SCENARIO_ID Importing Document scenario ID

VIM200405-CGF-EN-02 Configuration Guide for Foundation 157

Chapter 5 Capture Integration

Parameter Type Description

PI_SNAPMATCH_STRUC Importing Data structure of the
entity matcher field
PIT_CANDIDATE Importing Computed candidate keys
PIS_LEARNED Importing Learned candidate with
feedback
PET_SNAPMATCH Exporting Table of business entity
candidates with attributes
PE_CATEGORY Exporting Category of matcher

• SET_MATCH_RESULT: Sets the final business entity key after the

extraction. This method must be implemented for determination fields
of entity_matcher. The exit is only called if an extraction result for the
related field of entity_matcher (parameter PIT_SNAPMATCH_RESULT) is
available. Otherwise the entity is not determined.

Parameter Type Description

PI_PROFILE_ID Importing Document profile ID
PI_SCENARIO_ID Importing Document scenario ID
PI_SNAPMATCH_FIELD Importing Field name of the entity
matcher extraction field
PI_SNAPMATCH_PATH Importing Path for the entity
matcher extraction field
in the extraction result
PIT_SNAPMATCH_RESULT Importing Result of the entity
matcher
PIT_EXTDATA Importing Data extraction result
PIS_LEARNED Importing Learned candidate with
feedback
PC_ENTITY_VALUE Changing Determined business
entity key

• SET_MATCH_FEEDBACK: Sets the feedback attributes for the related

business entity key. You determine the same attributes when you use
the SET_MATCH_PARAMETER method of one business entity. This method
must be implemented for determination fields of entity_matcher.
• SET_LOOKUP_VALUES: Sets the values that are used for the lookup.

Parameter Type Description

PI_PROFILE_ID Importing Document profile Id
PI_SCENARIO_ID Importing Document scenario ID
PI_LOOKUP_FIELD Importing LookUp fieldname

158 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

Parameter Type Description

PI_ATTRIBUTE_FIELD Importing Determination field
PI_ATTRIBUTE_PATH Importing Determination field path
in the extraction result
PIT_EXTDATA Importing Data extraction result
PCT_VALUE_LIST Changing Values for the database
lookup

Entity matcher data structure

Data structure to set the fields for the entity candidates for the parameter in
the exit implementation of /OTX/PF11_IF_ENTITY_ATTR=>SET_MATCH_
PARAMETER. See /OTX/PF11_S_MATCH example structure - include /OTX/
PF11_S_MATCH_KEY is required for a custom structure.

5.2.3.5 Assigning an entity determination field

You assign custom extraction determination fields in the Capture profile of the
related profile extraction step. The custom extraction determination fields are used
in the business entity determination of the candidates. For more information, see
“Maintaining the LookUp condition” on page 177.

To assign determination fields:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Capture > Information Extraction Service > Capture Profile
Maintenance.

3. On the Profile Overview screen, mark an entry.

4. In the dialog structure, double-click Entity Determination Custom Field

Assignment.

5. On the Custom Entity Determination Field Assignment screen, assign a field

using the following parameters:

Step
Extraction step when the field is used. It is usually set to step 1. only for the
fields of entity_matcher type step 2 setting is used.
Determination field
Select the custom determination field which is used in the scenario.

Note: You cannot update an activated profile if you change the type of a
field.
Update an activated profile, if you add or delete existing entity
determination fields. The changes take effect after the update.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 159

Chapter 5 Capture Integration

5.2.3.6 Assigning an entity determination

You can use and assign your own business entity determination within the profile. If
you configure an own determination for a scenario related business entity field, the
scenario related determination will not be processed.

For a standard scenario without a custom business entity determination, you do not
need to configure the assignment.

To assign a determination to an entity field:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound
Configuration > Capture > Information Extraction Service > Capture Profile
Maintenance.
3. On the Profile Overview screen, mark an entry.
4. In the dialog structure, double-click Entity Determination Assignment.
5. On the Entity Determination Assignment, enter the following parameters:

Entity field
Select the business entity field which is available in the related search help
(scenario or custom field of business_entity type).
Determination ID
Select the configured determination ID which is available in the related
search help. For more information, see “Information Extraction Service”
on page 109.

Note: Update an activated profile, if you add or delete existing entity

determination fields. The changes take effect after the update.

5.2.3.7 Maintaining format interpretation

You can customize the preferred format interpretation for a Capture profile. This
impacts the document extraction within IES as well as the behavior of the Validation
Client.

The configuration of the format interpretation list allows to change the classifier. The
classifier defines the OCR character set of the profile. Each profile always has one
character set.

The first entry in the format interpretation list is used to derive the OcrClassifier
and so defines the set of characters that can be recognized on the documents. If
nothing is defined, then the default, international, character set is used which is
defined by the first default entry which is en-UK.

The second functionality of the format interpretation list is the culture specific
interpretation of strings on the document as dates and decimals. The cultures, for

160 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

example UK, in the format interpretation list are used to determine dates and
amounts in the correct format according to the default sequence or the defined
sequence.

If a string shall be interpreted as a date or a decimal, it will be shown to the

respective .net functionalites using the cultures defined in the list one by one in
order of their definition. As soon as the first culture succeeds in interpretation, this
interpretation is used as the result.

Example 5-1: Dates and decimals

Date example: “12/01/2020”

Format interpretation list: “en-us”, “en-gb”, “de-de”: Result 1 December,
2020
Format interpretation list: “de-de”, “en-us”, “en-gb”: Result 12 January,
2020

Date example: “12/31/2020”

Format interpretation list: “en-us”, “en-gb”, “de-de”: Result 31 December,
2020
Format interpretation list: “de-de”, “en-us”, “en-gb”: Result 31 December,
2020
(as “de-de” does not succeed because this is not a valid date in german
interpretation)
Decimal example: “1.000”
Format interpretation list: “en-us”, “en-gb”, “de-de”: Result: Decimal
“One”
Format interpretation list: “de-de”, “en-us”, “en-gb”: Result: Decimal “One
Thousand”

Note: When changing character sets, a profile reset is necessary, which means
that learning data will get lost.

When changing a sequence of format interpretation for languages supported

by the same character set, a reset of the profile is not required and learning
data are preserved.

The following classifiers are available:

VIM200405-CGF-EN-02 Configuration Guide for Foundation 161

Chapter 5 Capture Integration

OCR character sets Supported Languages

International Afrikaans, Catalan, Danish, Dutch, English,
Finnish, French, German, Icelandic,
Indonesian, Italian, Luxembourgish,
Norwegian, Portuguese, Spanish, Swedish
Albanian, Bosnian(Latin), Croatian, Czech,
English, Hungarian, Polish, Romanian,
Serbian (Latin), Slovak, Slovenian
Estonian, Latvian, Lithuanian
Azeri (Latin), Turkish, Uzbek (Latin)
Cyrillic Azeri (Cyrillic), Belarussian, Bosnian
(Cyrillic), Bulgarian, Kazakh, Kyrgyz,
Macedonian, Russian, Serbian, Tajik,
Ukrainian, Uzbek (Cyrillic), English
Greek Greek, English
China Mainland, China Traditional Simplified Chinese, Traditional Chinese,
English
Japanese Japanese, English
Korean Korean, English
Thai Thai, English
Vietnamese Vietnamese, English

When configuring the profile, consider the following:

• All languages in a box can be combined in one profile.

• The list of supported cultures is defined in the profile.
• Separate profiles are required for non-latin character sets.
• A profile also defines data fields used and visible in the Validation UI.
• Feedback for learning is defined per archive document-type assigned to the
profile.
• The validation assignment is defined per archive document-type assigned to the
profile.

To configure format interpretation:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound
Configuration > Capture > Information Extraction Service > Capture Profile
Maintenance.
3. On the Profile Overview screen, mark an entry, and then double-click Format
interpretation list in the Dialog Structure.
4. On the Format interpretation list Overview screen, rank the preferred format
interpretation keys, using the following parameters:

162 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

Int. key
Interpretation key. Key for format interpretation, for example de-DE.
Note: Make sure that you only combine the languages of one OCR
character set. For example, the Greek OCR character set only allows to
combine Greek and English. All other languages are in a different
OCR character set and must be defined in a different profile.
Sequence
Use the sequence to rank format interpretation. The format interpretation
with the lowest sequence number has the highest priority and also defines
the character set for the profile. Be careful if you change this first entry for a
profile with learning data, because a change of the character set for the
profile needs a profile reset which results in a reset of the learning data.

Note: The value help for the interpretation key also shows the default
sequence for format interpretation. If no format interpretation is defined
for a profile, this default ranking is used.
If you change format interpretation after a profile is activated, you must
update the profile for the changes to take effect.

5.2.3.8 Maintaining classifications

You can configure a classification which is used for a specific custom field of the
type class.

You can use the classification for a document classification or to classify one
document with a specific attribute. For example, the priority.

The attribute classification can get configured for a custom field or a custom table
field. For the attribute classification values are configured. These classification
values are available within the Windows Validation Client or the Fiori Capture
Validation Workplace for the custom field. IES learns the classification after a user
validated the document. An attribute of an document for a classification can for
example be the priority or special qualification of a single line item for example for
an invoice where a line represents the freight costs.

For more information about document classification, see:

• “Defining custom fields” on page 166

• “Defining custom table fields” on page 172
• “Document classification“ on page 533

To configure a classification:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound
Configuration > Capture > Information Extraction Service > Capture Profile
Maintenance.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 163

Chapter 5 Capture Integration

3. On the Profile Overview screen, mark an entry.

4. In the Dialog Structure, double-click Classification.

5. On the Classification list Overview screen, add a Classification ID.

6. Optional To classify documents into certain document types for example as sales
order or invoice, you have to add a classification profile ID. The classification ID
represents the ID of the scenario classification. For more information, see
“Creating scenario classifications” on page 64 and “Document classification“
on page 533.
Document classification does not require classification values as the assigned
document types of the scenario classification are used. For more information,
see “Assigning document types to classifications” on page 65.

7. Optional To assign one attribute to a document or parts of a document, for

example the priority of a document or the classification of an invoice line as
fright position:

Note: Do not enter a classification profile if you want to have own

classification values.

a. Select a Classification and in the Dialog Structure, double-click

Classification value.
b. On the Classification values: Overview screen, define classification values.
Use the following parameters:

Value
Value of the classification.
Description
Description of the classification value.

8. Save your configuration.

5.2.3.9 Maintaining validation field settings

If you want to change the standard behavior of the fields, you customize the type
and the label of fields in the Validation Client.

If an attribute is not defined for a field (description, field status, field sequence) the
default attribute value is used.

To maintain validation field settings:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Capture > Information Extraction Service > Capture Profile
Maintenance.

164 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

3. On the Profile Overview screen, mark an entry, and then double-

click Validation field settings in the Dialog Structure.

4. On the Validation field settings Overview screen, define validation fields that
should appear in the Validation Client, using the following parameters.

Note: If you change validation field settings you have to close the
application in validation and open it again for the changes to take effect.

Validation Fieldname
Select the validation field name from the list of available fields.
Description
Enter a description for the field. This text is used as label for the field in the
Validation Client.
Validation Fld. stat.
Validation field status. Select the field status from the list. The following
values are possible:
Display Only
Field is not editable.
Hide
Field is not displayed.
Input
Field is editable.
Required
Field is editable and indicated as required.

Fld. Sequ.
Validation Field sequence. Enter the sequence in which the fields are
displayed in the Validation Client. The standard scenario fields always have
a sequence with 10 (10, 20, 30). Therefore, you can place custom fields in
between.
Sum Check Field
Enter the fieldname of the header field to do a sum check. The Validation
Client will sum up the related item field and check against the sum field.
When the item sum does not match the sum field an error is shown in the
Validation Client. Use the search field to select the sum check fieldname.
You can configure a scenario or a custom field. The sum check is only
processed in the Microsoft Windows Validation Client and the Fiori
Capture Validation Workplace.

Note: Make sure that you only configure fields where a sum check
makes sense (for example, amount fields). Also ensure that you assign
a header field to the Sum Check field and not an item field (sum check
field is always the related total field). Incorrect configuration result in
a wrong calculation on the Validation Client.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 165

Chapter 5 Capture Integration

Training Fld. stat.

Field status for the training process. If no training field status is maintained
for a field, then the validation field status is also relevant for documents in
the training process.
Select the field status from the list. The following values are possible:

Display Only
Field is not editable.

Hide
Field is not displayed.

Input
Field is editable.

Required
Field is editable and indicated as required.

5.2.3.10 Defining custom fields

In addition to standard scenario extraction fields, you can define custom extraction
fields. Machine learning is also available for these fields.

To define custom fields:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Capture > Information Extraction Service > Capture Profile
Maintenance.

3. On the Profile Overview screen, mark an entry, and then, in the Dialog
Structure, double-click Custom field definition.

4. On the Custom field definition Overview screen, define custom fields, using
the following parameters:

Name
Technical ID of the custom field. The technical ID should not contain any
special characters and no blanks.

Description
Enter a description of the custom field. This text is used as label for the field
in the Validation Client.

Type
Select the field type from the list. The following values are possible:

date
Structured field, which supports typical date structures for the
supported languages. The structure depends on the settings of the

166 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

format interpretation list. For example, ddmmyyyy, mmddyyyy or

month in letters.
decimal
Field which supports up to 4 decimals, and which interprets data in
regards to the settings of the format interpretation list. The format
interpretation list defines the correct interpretation of thousand and
decimal separators (“.” or “,” ).
string
Field which has no normalization.
string_list
Field which contains a list of strings of similar format.
If you want to validate the field within the Fiori Capture Validation
Workplace, you must create a custom Validation Perspective ID and
map a new custom table view to the corresponding extraction field
properly (see “Creating a Capture profile” on page 146). For this field
type, extraction delivers a list of strings within the result which have to
be processed in Fiori Capture Validation Workplace within a custom
table view.
amount
Special decimal field which is limited to two decimals. It interprets data
in regards to the settings of the format interpretation list. The format
interpretation list defines the correct interpretation of thousand and
decimal separators.
currency
Special string field which identifies supported currencies and currency
symbols on the document. It normalizes the data to ISO names for
supported currencies.
business_entity
Field that determines the business entity which is related to the
document layout.
class
Field which is used to process the document classification or to classify
a field with a specific attribute which is not available on the document.
Document classification is only possible on header level. For more
information, see:

• “Document classification“ on page 533

• “Maintaining classifications” on page 163

barcode
Field which is used to maintain the barcode type. It contains a list of
barcodes of the same type.
The following barcodes are supported:

VIM200405-CGF-EN-02 Configuration Guide for Foundation 167

Chapter 5 Capture Integration

• A2of5
• Aztec
• BCC32
• Codabar
• Code128
• Code2of5
• Code3of9
• Code3of9Extended
• Code3ofNOSS
• Code93
• CodeQR
• DataMatrix
• EAN13
• EAN8
• FourState
• I2of5
• Matrix2of5
• PDF417
• Patch
• Planet
• Postnet
• UCC128
• UPCA
• UPCE

regex
Extracts a list of all available information according to your defined pattern.
The related field exit must be implemented for this field type, see Custom
field exit on page 169.
If you want to validate the field within the Fiori Capture Validation
Workplace, you must create a custom Validation Perspective ID and map a
new custom table view to the corresponding extraction field properly (see
“Creating a Capture profile” on page 146). For this field type, extraction
delivers a list of strings within the result which have to be processed in Fiori
Capture Validation Workplace within a custom table view.

168 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

Validation Fld. stat.

Validation Field Status. Select the field status for the Windows Validation
Client or Fiori Capture Validation Workplace from the list. The following
values are possible:

Display Only
Field is not editable.

Hide
Field is not displayed.

Input
Field is editable.

Required
Field is editable and indicated as required.

Classification ID
Select the classification ID for the field type class which configure when you
maintain classifications. For more information, see:

• “Maintaining classifications” on page 163

• “Maintaining classifications” on page 163

LookUp ID
Select the look-up ID for the field type business entity which you
configured.The related look-up is used within the Validation Client to
search for the business entity.

Fld. Sequ.
Validation Field Sequence. Enter the sequence in which the fields are
displayed in the Validation Client. The standard scenario fields always have
a sequence with 10 (10, 20, 30). Therefore, you can place custom fields in
between.

Custom field exit

Enter the user exit class to implement logic for specific field types. The user
exit class implements the /OTX/PF11_IF_FIELD_ATTR interface:

• SET_REGEX_PARAMETER: Sets the parameter for the regular expression

pattern and optional a replacement parameter. This method must be
implemented for attribute fields of regex type. The regular expression
must be static and when the regular expression or replacement
parameter is changed you must recalculate the profile for the changes to
take effect. An invalid pattern raises an error during activation or update
of the profile.

Parameter Type Description

PI_PROFILE_ID Importing Document Profile ID

VIM200405-CGF-EN-02 Configuration Guide for Foundation 169

Chapter 5 Capture Integration

Parameter Type Description

PI_SCENARIO_ID Importing Document Scenario ID
PE_REGEX Exporting Pattern parameter for
Regex. Match method for
regular expressions
according to .NET
Framework of Microsoft.
PE_REPLACE Exporting Replacement parameter
for Regex. Replace
method for regular
expressions according
to .NET Framework of
Microsoft.

Barcode Type
Select the barcode type for the field type barcode which you configured.
Display Type
Select the display type from the list for the Fiori validation for the related
field type. Take care to select a correct subset for the display type. The
following values are possible:
amount
Special decimal field which is formatted according to the user settings
and according to the reference currency. Also enter the related reference
currency.
boolean
Field is shown as a check box.
currency
Special string field which identifies supported currencies and currency
symbols on the document. It normalizes the data to ISO names for
supported currencies.
date
Structured field, which supports typical date structures for the
supported languages. The structure depends on the settings of the
format interpretation list. For example ddmmyyyy, mmddyyyy or month in
letters.
decimal
Field which supports up to 4 decimals. The field interprets data in
regards to the settings of the format interpretation list.
integer
Field which shows the numeric value in integer format. Choose this
display type for a string field.

170 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

quantity
Special decimal field which is formatted according to the user settings
and according to the reference unit. Also enter the related reference unit
of measure.
string
Field which has no special formatting

External Field Reference (path)

Enter the reference field with the full qualified path in the extraction result
of the reference fields for display type amount (related currency field) and
quantity (related unit of measure field).
Note: You can retrieve a complete list of fully qualified field path
information for a given capture profile ID from table /OTX/PF11_T_
PRSE. Additionally, you can check which standard field references are
already used for non custom fields in the corresponding scenario itself
in table /OTX/PF11_T_DESD.

Example: Valid amount reference path values could be “ExtractionResult-

InvoiceAmountBlock-DocumentCurrency” in case of invoices and
“ExtractionResult-DocumentCurrency”in case of sales orders.

Training Fld. stat.

Field status for the training process. If no training field status is maintained
for a field, then the validation field status is also relevant for documents in
the training process.
Select the field status from the list. The following values are possible:
Display Only
Field is not editable.
Hide
Field is not displayed.
Input
Field is editable.
Required
Field is editable and indicated as required.

Note: If you add or delete existing custom fields after a profile is

activated, you must update the profile for the changes to take effect. You
cannot update an activated profile if you change the type of a field. If you
change the validation field settings of custom fields, close the application
in validation and open it again to apply the changes.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 171

Chapter 5 Capture Integration

5.2.3.11 Defining custom table fields

In addition to standard scenario extraction fields, you can define custom extraction
table fields. Machine learning is also available for these fields.

To define custom fields:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Capture > Information Extraction Service > Capture Profile
Maintenance.

3. On the Table for custom fields Overview screen, select the table you want to
enhance with custom fields, and then in the Dialog Structure, double-
click Custom field definition. You can also enter a new table which will only be
supported within IES extraction and windows validation client.

4. On the Custom table field definition: Overview screen, define custom fields,
using the following parameters:

Name
Technical ID of the custom field. The technical ID should not contain any
special characters and no blanks.
Description
Enter a description of the custom field. This text is used as label for the field
in the Validation Client.
Type
Select the field type from the list. The following values are possible:
date
Structured field, which supports typical date structures for the
supported languages. The structure depends on the settings of the
format interpretation list. For example, ddmmyyyy, mmddyyyy or
month in letters.
decimal
Field which supports up to 4 decimals, and which interprets data in
regards to the settings of the format interpretation list. The format
interpretation list defines the correct interpretation of thousand and
decimal separators (“.” or “,” ).
string
Field which has no normalization.
amount
Special decimal field which is limited to two decimals. It interprets data
in regards to the settings of the format interpretation list. The format
inperpretation list defines the correct interpretation of thousand and
decimal separators.

172 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

class
Field which is used to process the document classification or to classify
a field with a specific attribute which is not available on the document.
Document classification is only possible on header level. For more
information, see “Document classification“ on page 533.
description
Field which has no normalization. Provides the best capture result for
longer description texts within a column.

Validation Fld. stat.

Validation Field Status. Select the field status for the Windows Validation
Client or Fiori Capture Validation Workplace from the list. The following
values are possible:
Display Only
Field is not editable.
Hide
Field is not displayed.
Input
Field is editable.
Required
Field is editable and indicated as required.

Classification ID
Select the classification ID for the field type class which configure when you
maintain classifications. For more information, see “Maintaining
classifications” on page 163.
Fld. Sequ.
Validation Field Sequence. Enter the sequence in which the fields are
displayed in the Validation Client. The standard scenario fields always have
a sequence with 10 (10, 20, 30). Therefore, you can place custom fields in
between.
Sum Check Field
Enter the fieldname of the header field to do a sum check. The Validation
Client will sum up the related item field and check against the sum field.
When the item sum does not match the sum field an error is shown in the
Validation Client. Use the search field to select the sum check fieldname.
You can configure a scenario or a custom field. The sum check is only
processed in the Microsoft Windows Validation Client and the Fiori
Capture Validation Workplace.

Note: Make sure that you only configure fields where a sum check
makes sense, for example amount fields. Also ensure that you assign a
header field to the Sum Check field and not an item field (sum check
field is always the related total field). Incorrect configuration result in
a wrong calculation on the Validation Client.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 173

Chapter 5 Capture Integration

Display Type
Select the display type from the list for the Fiori validation for the related
field type. Take care to select a correct subset for the display type. The
following values are possible:
amount
Special decimal field which is formatted according to the user settings
and according to the reference currency. Also enter the related reference
currency.
boolean
Field is shown as a check box.
currency
Special string field which identifies supported currencies and currency
symbols on the document. It normalizes the data to ISO names for
supported currencies.
date
Structured field, which supports typical date structures for the
supported languages. The structure depends on the settings of the
format interpretation list. For example ddmmyyyy, mmddyyyy or month in
letters.
decimal
Field which supports up to 4 decimals. The field interprets data in
regards to the settings of the format interpretation list.
integer
Field which shows the numeric value in integer format. Choose this
display type for a string field.
quantity
Special decimal field which is formatted according to the user settings
and according to the reference unit. Also enter the related reference unit
of measure.
string
Field which has no special formatting

External Field Reference (path)

Enter the reference field with the full qualified path in the extraction result
of the reference fields for display type amount (related currency field) and
quantity (related unit of measure field).
Note: You can retrieve a complete list of fully qualified field path
information for a given capture profile ID from table /OTX/PF11_T_
PRSE. Additionally, you can check which standard field references are
already used for non custom fields in the corresponding scenario itself
in table /OTX/PF11_T_DESD.

174 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

Example: Valid amount reference path values could be “ExtractionResult-

InvoiceAmountBlock-DocumentCurrency” in case of invoices and
“ExtractionResult-DocumentCurrency”in case of sales orders.

Training Fld. stat.

Field status for the training process. If no training field status is maintained
for a field, then the validation field status is also relevant for documents in
the training process.
Select the field status from the list. The following values are possible:
Display Only
Field is not editable.
Hide
Field is not displayed.
Input
Field is editable.
Required
Field is editable and indicated as required.

Note: If you add or delete existing custom fields after a profile is

activated, you must update the profile for the changes to take effect. You
cannot update an activated profile, if you change the type of a field.
If you change validation field settings of custom table fields, close the
application in validation and open it again to apply the changes.

5.2.3.12 Assigning an ArchiveLink document type

To assign an ArchiveLink document type to a profile:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound
Configuration > Capture > Information Extraction Service > Capture Profile
Maintenance.
3. On the Profile Overview screen, in the Dialog Structure, ´double-
click Document Type Assignment.
4. On the Document Type Assignment Overview screen, maintain the
assignment of document types to a profile, using the following parameters:

Doc. type
ArchiveLink document type
Capture Profile Id
Enter the technical ID of a profile which should be used for extraction.
Note: The following parameters depend on the Capture Profile ID and
the scenario: Description, Scenario, Version, and Description. For
more information, see “Creating a Capture profile” on page 146.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 175

Chapter 5 Capture Integration

If the ArchiveLink document type is not assigned to a profile (or is

deleted), the documents get into error status within inbound
processing and they are not available in the windows Validation
Client for validation.

5.2.3.13 Configuring the Determination Definition

The determination definition is pre-delivered and used within a scenario for the
corresponding business entity fields. An own determination definition can be used,
which is assigned within the Capture profile maintenance to the corresponding
entity field. For more information, see “Assigning an entity determination”
on page 160.

To define a determination:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation> Inbound

Configuration > Capture > Information Extraction Service > Capture Profile
Maintenance.

3. On the Profile Overview screen, double-click Entity Determination

Definition in the Dialog Structure.

4. On the Determination Definition Overview screen, create a new entry with the
following parameters:

Determination ID
Technical ID of the determination.

Description
Description of the determination.

Confidence
The minimum confidence to select the business entity (integer value
describing a percentage between 0 and 100). If the confidence is not
maintained the business entity with the highest confidence is automatically
used if there does not exist an additional business entity with the same
confidence.

Distance
Distance between matching confidences of different business partners to
select a business entity (integer value). If the distance is not maintained the
highest confidence is used.

Matcher field
Assign the entity matcher field which is used to extract and match the
business entity with additional information on the document with a specific
confidence.

176 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

Scenario related matcher

For delivered entity matcher scenario fields (not custom fields) the check
box must be selected.

Attribute extractor field

Field which is used to extract learned business attributes from a document.

Scenario related attribute

For delivered attribute extractor scenario fields (not custom fields) the check
box must be selected.

5.2.3.14 Maintaining the LookUp condition

You have to maintain the LookUp condition for each extracted attribute field which is
used to determine the business entity candidates in SAP.

To configure the lookup:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation> Inbound

Configuration > Capture > Information Extraction Service > Capture Profile
Maintenance.

3. On the Profile Overview screen, in the Dialog Structure double-click Entity

Determination Definition.

4. On the Determination Definition Overview screen, Mark an entry and then in

the Dialog Structure, double-click Determination LookUp.

5. On the Determination Field Lookup screen, create a new entry using the
following parameters:

Attribute field
Select a scenario-related or a custom attribute field that is used to extract the
information on the document. For more information, see “Assigning an
entity determination field” on page 159.

Scenario related
For pre-delivered attribute scenario fields (not custom fields) the check box
must be selected.

LookUp table
Enter the table which is used to look up the values.

LookUp field name

Enter the table field which is used to look up the values.

LookUp entity key field

Enter the table field which is selected and which defines the business entity.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 177

Chapter 5 Capture Integration

External field name (path)

For extracted attribute fields with a deep structure (for example, fields of
type address) enter the field path of the related field.

Normalize
Mark this check box to normalize the extracted value of the attribute field.
This processes the lookup against a value which was normalized in the
same way. The normalization of the value is processed within the /OTX/
PF11_CL_UTILITIES=> NORMALIZE_LOOKUP_VALUE method, which you
should reuse for your own lookup fields.
If you need to apply an own normalization logic, you can configure single
character values for normalization within maintenance view /OTX/PF11_V_
NORM. This is run after the standard normalization logic.

5.2.3.15 Maintaining Entity Key Assignment

With the Entity Key Assignment, you can assign the key value for your entity field
for specific inbound parameters. You have, for example, an option to assign the
company code value to the ArchiveLink document type for an invoice profile. To
determine the assigned entity, all inbound parameters of the registration key are
used.

The configuration is used in profiles with scenario version 1 and version 2, and
overrules any business entity determination.

To maintain entity key

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Capture > Information Extraction Service > Capture Profile
Maintenance.

3. On the Profile Overview screen, in the Dialog Structure, double-click Entity

Key Assignment.

4. On the Entity Key Assignment screen, maintain the assignment of entity key
values to specific inbound parameters, using the following parameters:

Capture Profile Id
Enter the technical ID of a Capture profile.

Entity Field
Enter the entity field of the profile.

Entity Key
Enter the key value of the entity field which should be assigned.

Doc.Type
ArchiveLink document type.

178 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

Mail address of Recipient

Receiver mail address for a mail registration.

Mail address of Sender

Sender mail address for a mail registration.

Notes

• For the inbound parameters Doc.Type, Mail address of Recipient and

Sender the Configuration of a wildcard entry is possible (*). If you do
not configure a specific value or a wildcard, the empty value in the
registration entry is checked.
• Transaction /OTX/PF11_TEST_EKA can be used to test the entity key
assignment for a specific registration key or for dedicated test data.

5.2.3.16 Activating and updating a Capture profile

Capture profile activation is mandatory to use a profile for extraction on an SAP
system. By activating a Capture profile, the relevant profile settings are transferred
from SAP to IES and its repository.

Profile update is mandatory to activate the changed profile settings of an activated

and running profile. By updating a profile, the relevant profile settings are
transferred from SAP to IES and its repository.

The option to update a Capture profile is available if the settings of a profile that is
using Capture Profile Maintenance activity changed since the last profile update or
profile activation.

Some special configuration need to update a profile although the action is not
available in the column of the profile. In this case use the Update profile button
in the toolbar.

To delete a profile setting and all its learning data from the IES repository, you can
reset a profile.

Tip: The profile reset cannot be reverted.

You are only allowed to reset the profile if there are no active sessions for this
profile. You can check for active sessions using the Extraction node in the IES
Administration Work Center in the VIM Central Workplace. Furthermore all
processes for inbound documents which are using this profile have to be finished or
cancelled before resetting the profile.

Note: The Capture profile activation and update is processed within the IES
Administration workcenter of the VIM Central Workplace. To process this task
the relevant authorization for the workplace is required. For more information,
see “Authorization objects” on page 303.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 179

Chapter 5 Capture Integration

To activate a Capture profile:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Capture > Information Extraction Service > Capture Profile
Activation.
In the overview table of the IES Administration, all configured profiles are
listed. Newly created profiles are in status Inactive.

3. To activate a profile, click the Activate profile button in the Action column
of the profile.

4. Select the corresponding connection ID. For more information, see “On-
Premises: Connection parameters” on page 128. You must assign a dedicated
IES server to a profile.
After initiating the activation, the profile is in status Activation in process.
Profile activation usually takes a few seconds.

5. To check if the activation is completed, click the Refresh button in the

application toolbar. The status is Active. If a problem occurred during
activation, the status is Error.
In this case, you can display details about the problem by showing the Error
Log in the Detail pane.

To update a Capture profile:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Capture > Information Extraction Service > Capture Profile
Activation.
In the overview table of the IES Administration, all configured profiles are
listed. Active profiles are in status Active.

3. In the Action column, click the Update profile button.

After initiating the update, the profile is in status Activation in process.
Profile update usually takes a few seconds.

4. To check if the update is completed, click the Refresh button in the application
toolbar.
The status switches to Active.
If a problem occurred during activation, the status is Error. In this case, you can
display details about the problem by showing the Error Log in the Detail pane.

Notes

• To get a list with all activities for a profile, display the Detail pane and show
the Activity Log.

180 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.2. Information Extraction Service

• In case of errors, check the log for details in the detail pane and solve the root
cause. After that you can reset the profile using the Reset profile button
and try to activate again.
• You change the connection ID of an active profile using the Change
Connection button in the toolbar.

To reset a Capture profile:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Capture > Information Extraction Service > Capture Profile
Activation.
In the overview table of the IES Administration, all configured profiles are
listed.
Active profiles are in status Active.

3. Select the profile that you want tor reset, and then click the Reset profile button
in the toolbar.

4. Confirm the reset.

Note: Profile reset usually takes a few seconds. The profile is in

status Reset in progress.

5. Optional To check if the reset is completed, click the Refresh button in the
application toolbar.
The status switches to Reset.
If a problem occurs, the status is Error. In this case, you can display details
about the problem by showing the Error Log in the Detail pane.

5.2.4 Accessing OCR full text

You cannot additionally script on the capture side, when using an IES integration.

You find various exits and enhancement options within Inbound Configuration or
Process Configuration of SAP.

Use the /OTX/PF02_CL_UTILITIES=>GET_FULLTEXT static method to access the full

text of the extracted document to integrate additional logic. If you implement this
method within the inbound configuration, you provide the registration key. If you
implement the method within the process configuration, you provide the process
keys. For the process related integration, solutions beyond invoice scenarios are
supported.

Note: For VIM Invoice Solution, the class method /OTX/PS03_CL_IES_

UTIL=>GET_FULLTEXT must be used with the same parameters.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 181

Chapter 5 Capture Integration

Parameter Type Description

PI_REGID Importing Registration ID if called within
inbound (optional)
PI_PROJECT_ID Importing Profile of process if called within
process (optional)
PI_PLKEY Importing Process key if called within process
(optional)
PET_FULLTEXT Exporting Full text for each page as string
with CRLF identifier.

5.3 Customizing validation

The Validation Client and the Capture Validation in Fiori are the user interfaces for
data completion and manual data entry. All user actions contribute to the
continuous learning process. You can use the client itself on an unlimited number of
workstations.

The Validation Client provides functions for easy data capture:

• With Single Click Entry (SCE), you can pick the data directly from the image into
the data fields. You do not need to type the data. This avoids errors due to typos.
• With Table Auto Completion (TAC), you only need to pick the data of the first
item line with Single Click Entry (SCE). Table Auto Completion (TAC)
automatically captures the data of all remaining line items.

The image view highlights all data that has been recognized automatically and the
user can see at first glance if data is missing, for example line items.

The validation framework determines whether a document that is captured needs

validation or not. The validation framework also assigns the validation agents to
validate the document. The framework bases on the customizing defined for the
ArchiveLink document type associated with the captured document.

5.3.1 Creating a validation

You can customize if and when an incoming document is validated. The validation
can always be active or only if defined check fields have no values. You can also
define who must manually validate the document.

To create a validation:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Capture > Validation.

3. In the Capture - Validation Overview screen, configure general validation

settings, using the following parameters:

182 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.3. Customizing validation

Validation ID
Technical ID of the validation settings
Description
Enter the description of the validation setting.
Validation Determination
Select the determination from the list. The following values are possible:
Validate always
Validation is always active.
Validate never
Validation is not active.
Validate for selected fields
If check fields are missing, validation is run. For more information, see
“Maintaining validation check fields” on page 184.
Validate based on profile settings
If mandatory validation fields of the profile are missing (see
“Maintaining validation field settings” on page 164) or a validation
check (sum check or custom check logic - see “Creating a Capture
profile” on page 146) raises an error, validation is run.

Validation / Agent Determination

Use this function to control when the validation is run, to determine the
validator and optionally if a validator specific importance should be used.
Use template function /OTX/PF01_UTIL_EXIT_VAL_DETERM to create a
custom logic. You can set and use the following validator-specific
importance values as additional sorting criteria following the global
document priority:

• 1: Very important
• 2: Important
• 3: Standard (default value if no validator-specific importance is set)

For IES integration you can also control validation determination with
Validate based on profile settings and custom check logic.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 183

Chapter 5 Capture Integration

5.3.2 Maintaining validation check fields

For the validation setting Validate for selected fields, you can customize the
external field names.

To configure validation check fields:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Capture > Validation.
3. In the Capture - Validation Overview screen, mark an entry, and then double-
click Capture - Validation Check Fields in the Dialog Structure.

4. In the Capture - Validation Check Fields Overview screen, configure check

fields, using the following parameters:

Step ID
Field counter
External Field Name
External field name for the scenario.
Note: You must configure the field name in the same way as it is
delivered (case-sensitive).
IES Field Path for Table or List
The field is only relevant if you use IES for extraction.
Single header fields have to be set to ExtractionResult. All other fields
are specified by the complete path
Notes

• You must configure the field names and full paths in the same way
as it is delivered (case-sensitive).
• You can retrieve a complete list of fully qualified field path
information for a given capture profile ID from table /OTX/PF11_T_
PRSE. Additionally, you can check which standard field references
are already used for non custom fields in the corresponding
scenario itself in table /OTX/PF11_T_DESD.

Example 5-2: Configuration and result of Validation Check

The following configuration shows the possible configuration for an
extraction of an ínvoice. Four fields are extracted

184 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.3. Customizing validation

Table 5-2: Capture – Validation Check Fields

St External Field Name IES Field Path for Table or List

ep
Id
1 PONumber ExtractionResult-PONumber
2 InvoiceNumber ExtractionResult
3 InvoiceAmountBlock-DocumentCurrency ExtractionResult
4 Amount ExtractionResult-Items

The result of a configuration can look as shown below. The fields that are
defined as check fields display the extracted values.

5.3.3 Assigning an ArchiveLink document type to a validation

You must assign the ArchiveLink document type used in the Early Archiving
registration to the validation ID. For more information, see “Customizing the early
archiving registration type” on page 72.

To assign the ArchiveLink document type to the validation ID:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Capture > Validation Assignment.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 185

Chapter 5 Capture Integration

3. In the Capture - Validation DocType Assignment Overview screen, assign the

ArchiveLink document type to the validation ID, using the following
parameters:

Document type
ArchiveLink document type of registration
Validation ID
Enter the validation ID for processing. For more information, see
Validation ID on page 183.

5.3.4 Validation Settings based on solution specific Entity

Profiles
You can override the default validation setting based on ArchiveLink Document
type by validation settings based on an entity profile on solution level. For more
details on supplier profiles, see Section 34 “Vendor profiles” in OpenText Vendor
Invoice Management for SAP Solutions - Configuration Guide for Invoice Solution (VIM-
CGD).

5.3.5 Assigning an agent to an ArchiveLink document type

If validation is required for an ArchiveLink document type and you do not use a
custom logic to determine the validator, you must assign the corresponding agent to
the ArchiveLink document type.

Note: An agent which is assigned to validate documents must have a

authorization for object S_WFAR_OBJ with the corresonding ArchiveLink
document type.

To assign an agent to an ArchiveLink document type:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Capture > Validation Assignment.

3. In the Capture - Validation DocType Assignment Overview screen, mark an

entry, and then double-click Capture - Validation Agent Assignment in the
Dialog Structure.

4. In the Capture - Validation Agent Assignment Overview screen, assign the

agent to the ArchiveLink document type, using the following parameters:

Document Type
ArchiveLink document type
Object Type
Enter the organizational object that must be configured. The following
objects are supported:

186 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.4. Customizing feedback

• Rule
• Organizational Unit

• Center

• Position

• Work Center

• User

Agent ID
Enter the corresponding agent ID for the related organizational object.

Note: The IDs of organizational object assignments might be different

across the system landscape. Therefore, the /OTX/PF01_ADM_VALA
transaction is available to adjust the values in test and production
systems. In general, production systems do not allow any
configuration changes. The transaction is protected against a special
administration authorization. For more information, see
“Authorizations” on page 260.

EvalPath
Maintain the evaluation path. A special evaluation path might be required
for specific object types. As long as no special evaluation path has been set
up, the standard evaluation path WF_ORGUS is always used.

5.4 Customizing feedback

The feedback function for BCC or IES is based on ArchiveLink document types and
predefined feedback points. For each process, feedback is only sent once. BCC or IES
then can use the provided feedback as input for learning.

To activate feedback for BCC or IES:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Capture > Feedback.

3. In the Feedback Overview screen, activate feedback for document types, using
the following parameters:

Document Type
Document type for which feedback shall be activated.

Active
Select this check box to activate feedback.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 187

Chapter 5 Capture Integration

5.5 Creating reject reasons

In validation, users can select a reason when they reject a document manually.

The reject reason is displayed in the document registration table /OTX/PF01_T_1REG.

To create reject reasons:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Capture > Reject Reasons.

3. In the Capture - Reject Reasons Overview screen, configure reject reasons,

using the following parameters:

Reject Reason
Reason code of the rejection
Description
Enter the description of the reject reason.

5.6 Customizing look-ups

You can customize look-ups to provide the following features in the BCC or IES
application:

• Searching for any related SAP information in the Validation Client. If IES is used
only custom fields of business_entity type can be defined with a look-up. For
more information, see “Defining custom fields” on page 166.
• Enabling the access and download of master data to the BCC or IES database. If
IES is used, only access, no download is enabled.

The look-up for business partners is done on staging tables. A staging table collects
all relevant information of vendor, customer, or company code. A staging table can
also collect information from multiple systems, when BCC or IES is connected to one
SAP ERP system as single point of contact.

The staging tables are filled with corresponding reports, which can be planned as
periodic job on SAP ERP side.

/OTX/PS00_P_IDF_COMP_CODE
Report to fill staging table for company codes
/OTX/PS00_P_IDF_CUSTOMER
Report to fill staging table for customers
/OTX/PS00_P_IDF_VENDOR
Report to fill staging table for vendors

188 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.6. Customizing look-ups

/OTX/PS00_P_IDF_PLANT
Report to fill staging table for plant

For more information, see OpenText Vendor Invoice Management for SAP Solutions -
Administration Guide (VIM-AGD).

For more information from BCC side, see Section 4.10 “Configuring a Partner
function” in OpenText Business Center Capture for SAP Solutions - Customization Guide
(CPBC-CGD) and Section 4.12 “Configuring a LookupList function” in OpenText
Business Center Capture for SAP Solutions - Customization Guide (CPBC-CGD).

Look-up fields are used to map the SAP fields of the related data selection fields
structure to the external field names used in the Business Center Capture
application. For more information, see “To map a look-up field:“ on page 192.

To create a look-up:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound

Configuration > Capture > Look-up.

3. In the Look-up Overview screen, configure look-ups, using the following

parameters:

LookUp ID
Describes the technical identification of data search and retrieval in SAP
ERP.
Description
Enter a description of the look-up.
Data selection fields
Enter the structure of the fields. These fields are used within the mapping.
They assign the external field name of BCC or IES to the internal SAP field
name of the corresponding database table or database view. For more
information about the mapping, see “To map a look-up field:“ on page 192.
Source Table Name
Enter the database table or view used for the data retrieval.
Handler class
You can use the handler class to implement custom logic in your own
handler class for a look-up. The handler class needs to implement the /OTX/
PF01_IF_LOOKUP interface. If no custom handler class is configured, the
standard handler class /OTX/PF01_CL_INTERFACE_LOOKUP is called.
The standard class allows to search entries with selection criteria that is
concatenated by AND. All search criteria is character-based and used with
LIKE.
The function has no special treatment for date or amount values.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 189

Chapter 5 Capture Integration

Handler Class – The following methods are possible for a custom

implementation in the /OTX/PF01_IF_LOOKUP interface.

Note: The parameter naming in VIM follows the following rules:

1st Character
P fix, indicates a parameter.

2nd character
I (Importing) or C (Changing) or E (Exporting).

3rd character
<empty> (variable) or S (structure) or T (table).

LOOKUP_DOWNLOAD
The LOOKUP_DOWNLOAD method provides a look-up to download data.
This method is used in the BCC API function /OTX/PF01_IF_LOOKUP_
DOWNLOAD.

Parameter Parameter type Description

PIT_QUERY Importing Query attributes from BCC
application
PET_DATA Exporting Look-up result in csv-format
PET_FIELDS Exporting External look-up fields
PE_COMPLETE Exporting Parameter to indicate if all
possible entries have been
processed
PET_RETURN Exporting Return messages
PE_RC Exporting Return error code

LOOKUP_DOWNLOAD_INIT
The LOOKUP_DOWNLOAD_INIT method initializes the download.
This method is used in the BCC API function /OTX/PF01_IF_LOOKUP_INIT.

Parameter Parameter type Description

PET_RETURN Exporting Return messages

LOOKUP_DOWNLOAD_COMPLETE
The LOOKUP_DOWNLOAD_COMPLETE method completes the download.
This method is used in the BCC API function /OTX/PF01_IF_LOOKUP_
COMPLETE.

190 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.6. Customizing look-ups

Parameter Parameter type Description

PI_COMPLETE Importing Parameter to indicate if all
possible entries have been
processed
PET_RETURN Exporting Return messages

LOOKUP_VALIDATION
The LOOKUP_VALIDATION method provides a look-up processed from the
Validation Client.
This method is used in the BCC / IES API function /OTX/PF01_IF_LOOKUP_
VAL.

Parameter Parameter type Description

PI_MAXHITS Importing Maximum number of hits
PIT_QUERY Importing Query attributes from BCC / IES
application
PET_DATA Exporting Look-up result in csv-format
PET_FIELDS Exporting External look-up fields
PE_COMPLETE Exporting Parameter to indicate if all
possible entries have been
processed
PET_RETURN Exporting Return messages
PE_RC Exporting Return error code

LOOKUP_VALIDATION_CHANGE
The LOOKUP_VALIDATION_CHANGE method allows to change the look-up
processed by the Validation Client. The currently processed look-up field
and also the field values (only header fields) are provided with the
registration ID. They are used to implement additional filter logic or
authorization checks. If you want to enhance the query parameter with
additional fields, these fields also have to be available within the mapping
of the look-up fields. You must provide the field value with apostrophe. For
example “1000”.
This method is used in the BCC / IES API function /OTX/PF01_IF_LOOKUP_
VAL.

Parameter Parameter type Description

PI_REGID Importing Registration ID
PI_LOOKUP_FIELD Importing Currently processed look-up
field name
PIT_VAL_FIELDS Exporting Currently processed validation
field values (header)

VIM200405-CGF-EN-02 Configuration Guide for Foundation 191

Chapter 5 Capture Integration

Parameter Parameter type Description

PC_MAXHITS Changing Maximum number of hits
PCT_QUERY Changing Query attributes from BCC / IES
application

5.7 Mapping a look-up field

To map a look-up field:

1. Run the /OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Inbound
Configuration > Capture > Look-up.
3. In the Look-up Overview screen, mark an entry, and then double-click Look-up
Fields in the Dialog Structure.
4. In the Look-up Fields Overview screen, configure look-up fields, using the
following parameters:

External Field Name

Name of the field in the BCC or IES application
Field Name
Enter the name of the SAP field of the configured structure. For more
information, see Data selection fields on page 189
Case sens.
Case sensitivity. Select Case-sensitive or Case-invariant from the list.
BCC or IES already provides a search operation for a specific field. For
example, the user can enter search options in the Validation Client. You can
configure how this search is processed. Either the search is case-sensitive or
the search is case-invariant.
Tip: A case-invariant search is the slower search option.

Row number
Enter the column number to identify the related field in BCC or IES.
Index
Mark the index field of the look-up which identifies the business partner/
business entity.

Caution
The index field must be case-sensitive.

Sort
Define the fields with sort criteria which show the details of the selected
business partner/business entity in the Validation Client.

192 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 5.7. Mapping a look-up field

Element Name
Field name of the mapped entity determination fields of the entity matcher
data structure. For more information, see “Defining custom fields for entity
determination” on page 155.
Medium Field Label
Sets the description that should be displayed. If this text is not maintained,
then the label of the related data element of the structure is used.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 193

Chapter 6
Process Foundation

The Process Foundation is a completely flexible framework to configure and run

processes. It is not a workflow engine but utilizes generic workflow definitions,
which are processed by the SAP Business Workflow engine.

The technical concept assumes that every task in the process will end with a result.
These possible results are defined by the content of single task modules. Linking one
task to another, depending on the result of the previous one, allows to create a
complete process flow.

How a single task of the process flow appears is determined by task types, for
example dialog or background task. You can further control the appearance by usual
concepts like requested start or end conditions and event handling capabilities.
Therefore, the Process Foundation allows an easy configuration of processes without
the need for complex development.

Per design, the Process Foundation does not contain any business data context or
business data processing logic. It expects that these are implemented by each
business scenario using suitable data models and processing modules, which are
executed during runtime. Therefore, the Process Foundation has to be considered as
a pure technical platform to simplify the use of SAP Business Workflow.

Important
The Process Foundation is reserved for internal use only. Any custom
configurations beside the activities described in this document are not

VIM200405-CGF-EN-02 Configuration Guide for Foundation 195

Chapter 6 Process Foundation

supported. With the standard delivery of the product, a pre-configured Process

Foundation profile PF_DEFAULT is delivered. It covers all processing aspects
required for any business scenario and must not be changed at any time.

To add business scenario related content to the generic process patterns, the product
offers the following concepts. They all are mandatory steps that must be performed:

• Data Model Configuration

• Process Foundation Profile Generation
• Data Model Assignment
• Definition and Assignment of a Process Configuration Profile

The definition and assignment of a business configuration profile is part of the

product component Process Configuration. It mainly focuses on how to map
complex business scenario requirements into meaningful business rules, agent roles,
process steps, and process actions. It finally focuses on how to create corresponding
SAP documents without the need to think about the technical background of the
SAP Business Workflow engine.

Important
You must configure the SAP Business Workflow engine to run processes based
on Process Foundation as prerequisite. Additionally, maintain the following
tasks as general tasks in the PFTC transaction:

• Workflow Template 00297300

• Workflow Template 00297330
• Standard Task 00297316
• Standard Task 00297303

6.1 Basic Settings

In this step, you configure basic settings for the Process Foundation.

To configure basic settings:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click Process Foundation > Basic Settings.

3. In the Basic Settings Overview screen, configure basic settings, using the
following parameters.

Default Language
Enter the default language.
The default language is used to read description texts in some customizing
views. This applies if no description texts are found in the current logon

196 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 6.2. Data model configuration

language. Set the value to EN because this language is already included in

the standard delivery.
Default Profile
Enter the default profile.
The default profile entered here is used as a template when generating new
process foundation profiles. For more information, see “Process Foundation
profile” on page 206.

6.2 Data model configuration

The data model configuration defines process ledger tables and the relationship
between these tables. Usually a business scenario uses two data tables, one header
data and one item data table.

The following customizing steps are required to configure data models:

• Define data model

• Define levels
• Maintain level key fields
• Define external data mapping
• Assign mapping channel

Note: The data model configuration is used by an internal data handling API.
It automatically reads and writes data to the defined process ledger tables. You
must not perform any database updates manually without using this API. In
general, all usable or extendable interfaces in the product already offer the
corresponding process ledger data. This includes header and item data for use
or to be changed. The interfaces also automatically take care about updates
without the need to use any methods of the data handling API at any point of
time.

6.2.1 Defining a data model

In this step, you define a data model for a corresponding business scenario
implementation.

To define a data model:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click Process Foundation > Data Model.
3. In the Data Model Configuration Overview screen, define the data model
using the following parameters:

Data Model ID
Define the data model ID, a 10 character unique ID.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 197

Chapter 6 Process Foundation

Description
Enter a meaningful description to outline for which purpose the data model
is used.
Author
Enter the user name of the creator of the data model or the responsible
person.
Lock Object
Enter the lock object which has been created for the process header ledger
table. If no lock object is provided, no data lock is performed.

6.2.2 Defining levels

Within the level definition, the process ledger header and item tables are maintained
and assigned to data hierarchy levels.

Before you can define the levels, you must create the business scenario related data
tables. They must fulfill the following mandatory conditions:

Table 6-1: Mandatory key fields for the header table

Fieldname Data Element

MANDT MANDT
PROJECT_ID /OTX/PF02_E_PROJECT_ID
PLKEY /OTX/PF02_E_PLKEY

Mandatory include structures for the header table

• /OTX/PF02_S_PLH_DATA
• /OTX/PF04_S_BCF_DATA

Table 6-2: Mandatory key fields for the item table

Fieldname Data Element

MANDT MANDT
PROJECT_ID /OTX/PF02_E_PROJECT_ID
PLKEY /OTX/PF02_E_PLKEY
ITEM_NR /OTX/PF02_E_ITEM_NR

Table 6-3: Mandatory non-key fields for the item table

Fieldname Data Element

EXTINDEX /OTX/PF00_E_EXTINDEX

198 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 6.2. Data model configuration

Note: When creating work object types based on data tables, always make
sure to include the key fields PROJECT_ID, PLKEY and (in case of item tables)
ITEM_NR in the table field list of the corresponding dynamic data selection.
Also make sure to include the non-key field EXTINDEX. For more information,
see “Defining dynamic data selection” on page 288.

To define levels:

1. In the Data Model Configuration Overview screen (see “Defining a data

model” on page 197), mark an entry, and then double-click Levels in the Dialog
Structure.

2. In the Levels Overview screen, define levels using the following parameters.

Data Hierarchy Level

Enter the hierarchy level to which a data table belongs. The following
hierarchy levels for the process ledger tables are available:

• 1 - Header table (mandatory)

• 2 - Item table (optional)

Note: Only the hierarchy levels 1 and 2 are supported by the product
standard. Higher hierarchy levels are generally possible using the
standard configuration. However, they are not provided anywhere in
the standard delivery.
Description
Enter a meaningful description for the data hierarchy level.
Table Name
Enter the name of the corresponding process ledger table to be used in the
hierarchy level.
External Field Name
Enter an external alias for the table used by external applications that send
data to the system. The external field name is required to determine the
internal SAP table name.
Note: This setting has been replaced by the level mapping
configuration. For more information, see “Maintaining level mapping”
on page 203. But the setting remains available for downward
compatibility reasons. As a consequence, no further evaluation of the
level mapping configuration takes place as long as any value is
maintained in the level definition setting.
Last Changed Field
Optional setting.
Default value: <Empty>
Enter the name of a timestamp field to be updated for the data hierarchy
level every time the corresponding process ledger table is updated.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 199

Chapter 6 Process Foundation

Note: By default, the field TIMESTAMP_CHANGE, which is included in

the mandatory header table include structure /OTX/PF02_S_PLH_
DATA, is used for all process ledger header table updates. This setting
must not be changed as it is a prerequisite for other framework
functionalities to properly work. For all other data hierarchy levels,
the Last Changed Field setting is not used from a framework
perspective.
There still may be custom scenarios which require a custom Last
Changed Field for other data levels. For these scenarios, you can
utilize the setting as needed.

6.2.3 Maintaining level key fields

The relationship between data hierarchy levels and the assigned process ledger
tables is established using the level key fields. Additionally these settings control
how to determine the key field values themselves.

To maintain level key fields:

1. In the Levels Overview screen (see “Defining levels” on page 198), mark an
entry, and then double-click Fields in the Dialog Structure.

2. In the Fields Overview screen, maintain the level key fields, using the following
parameters.

Field Name
Name of the key field of the process ledger table where data of the
corresponding hierarchy level is hold.
Key type
This parameter defines how the value of the key field is determined when
inserting new data entries. Select one of the possible values from the list:
Create key by number range object
The key field value is retrieved from a number range object. This only
makes sense within data hierarchy level 1 to generate the next unique
process ledger key.
Automatic indexing
The key field value is populated by sequential numbering using the
logic defined with the index parameter fields. This only makes sense for
numeric data types.
Timestamp
The key field value is determined by a timestamp. The field must be of
data type TIMESTAMP or TIMESTAMPL.
Key is self-managed by the requester
The key field value is managed by custom logic and already provided
when inserting values.

200 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 6.2. Data model configuration

Object
Enter the name of the number range object used for the key field in case of
key type Create key by number range object.
Number range number
Enter the number range interval used for the key field in case of key type
Create key by number range object.
Important
The number range interval must be configured in the SNUM transaction
for number range object /OTX/PF02L (not delivered in BC set).
Maintain the number range 01 with the range 1 to 999999999999.
This number range object is used within the DEFAULT Data Model (also
used within solutions).
Subobject field in group table
Optional setting.
Enter the field name that contains the value of the sub-object to be used in
the number range object in case of key type Create key by number range
object.

Fieldname to-year
Optional setting.
Enter the field name that contains the value of the to-year to be used in the
number range object in case of key type Create key by number range
object.

Index start
Enter the first index value used for the key field in case of key type
Automatic indexing.

Index interval
Enter the Interval used for new key index determination for the key field in
case of key type Automatic indexing.
If a data entry already exists and the value of the highest index does not
apply to the interval definition, the next generated value is the next free one
of the interval.

Example 6-1: Index interval

Index Start = 10
Index Interval = 10
Existing entries are 10, 20, 30, and for example 37, then the next
generated index will be 40.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 201

Chapter 6 Process Foundation

6.2.4 Defining external data mapping

External data mapping is used to map the attributes and values that are stored in
the /OTX/PF01_T_1EXT table or the /OTX/PF11_T_DEXT table intermediately to the
relevant business process ledger header and item table.

To define external data mapping:

1. In the Data Model Configuration Overview screen (see “Defining a data

model” on page 197), mark an entry, and then double-click External Data
Mapping in the Dialog Structure.

2. In the External Data Mapping Overview screen, define the external data
mapping using the following parameters:

Mapping ID
Unique technical ID which identifies the mapping scenario
Description
Enter a meaningful description for the mapping scenario.
Mapping Class
You can use this to implement custom logic in your own handler class for
the mapping. The handler class must implement the /OTX/PF20_IF_FIELD_
MAPPING interface. If no custom handler class is configured, the standard
handler class /OTX/PF02_CL_FIELD_MAPPING will be called.
Default
Select this check box for one mapping ID. To process different mapping for
different incoming channels, the mapping ID is assigned to an incoming
channel. If no assignment to a channel can be found, the default mapping is
processed. The default mapping usually maps the external fields one-to-one
to the internal ledger table fields.

Handler Class – The following methods are possible for a custom

implementation in the /OTX/PF20_IF_FIELD_MAPPING interface.

MAP_HEADER
This method maps external header fields (EXTINDEX = 1 in /OTX/PF01_T_
1EXT) to header table (Level = 1).
It is used for frame workflow processing in /OTX/PF02_CL_WORKFLOW ->
INIT_FRAMEWORKFLOW.

Parameter Parameter type Description

PI_PROJECT_ID Importing Process Foundation Profile ID
PI_PLKEY Importing Process ledger key
PI_UPDATE Importing Flag to indicate that update on database
table is done

202 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 6.2. Data model configuration

Parameter Parameter type Description

PET_RETURN Exporting Return parameters in error case
PES_DATA Exporting Target structure with mapping result

MAP_ITEMS
This method maps external item fields (EXTINDEX = 2 to 999 in /OTX/PF01_
T_1EXT) to item table (Level = 2).
It is used for frame workflow processing in /OTX/PF02_CL_WORKFLOW ->
INIT_FRAMEWORKFLOW.

Parameter Parameter type Description

PI_PROJECT_ID Importing Process Foundation Profile ID
PI_PLKEY Importing Process ledger key
PI_INSERT Importing Flag to indicate that insert on database
table is done
PET_RETURN Exporting Return parameters in error case

PROCESS_MAPPING
This method is used for process mapping. It is called inside mapping class.

Parameter Parameter type Description

PIT_EXTDATA Importing External data values
PI_LVL Importing Data hierarchy level (see “Defining
levels” on page 198)
PI_CURRENCY Importing Currency to map currency fields
PET_RETURN Exporting Return parameters in error case
PET_INTDATA Exporting Mapping result

6.2.5 Maintaining level mapping

In this step, you define an external alias for each data level used by external
applications that send data to the system. The external field name is required to
determine the internal SAP table name behind each data level.

To maintain the level mapping:

1. In the External Data Mapping Overview screen (see “Defining external data
mapping” on page 202), mark an entry, and then double-click Level Mapping
in the Dialog Structure.

2. In the Level Mapping Overview screen, maintain the level mapping, using the
following parameters.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 203

Chapter 6 Process Foundation

Data Hierarchy Level

Define the hierarchy level to which a data table belongs. The hierarchy level
identifies the corresponding target table (see “Defining levels” on page 198).

External Field Name

Enter the external alias for the level used by external applications that send
data to the system.

Note: You must configure the external field name for the level in the
same way as it is delivered (case-sensitive).

6.2.6 Maintaining field mapping

In this step, you map the external field names to the target ledger table fields.

To maintain the field mapping:

1. In the Level Mapping Overview screen (see “Defining external data mapping”
on page 202), mark an entry, and then double-click Field Mapping in the
Dialog Structure.

2. In the Field Mapping Overview screen, maintain the field mapping, using the
following parameters.

External Field Name

External alias for the field used by external applications that send data to
the system. You find the external field name in the /OTX/PF01_T_1EXT-
EXTFIELD table or the /OTX/PF11_T_DEXT-NAME table.

Note: You must configure the external field name in the same way as
it is delivered (case-sensitive).

Field Name
Enter the name of the table field in the ledger target table in the
corresponding data hierarchy level.

Currency Field
Select this check box to indicate a currency field.

Field Mapping Type

Enter the field mapping type. The mapping is processed according to the
mapping type. The following values are possible:

External Field with Conversion (SAP / Custom)

The field is mapped according the assignment of external and internal
field name. It takes the necessary conversion of the SAP field into
account. If a field conversion exit is configured, this exit is processed. If
no exit is configured, the standard SAP conversion is processed which
is assigned to the SAP field.

204 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 6.2. Data model configuration

External Field without Conversion

The field is mapped according the assignment of external and internal
field name. It does not take the necessary conversion of the SAP field
into account.
Constant (fixed value)
A constant value is assigned to the target field. The value is configured
in the Value field (see Value on page 205).
System variable
A system variable is assigned to the target field. The value is configured
in the Value field (see Value on page 205).

Field Conversion Exit

Enter the field conversion exit. The exit is processed for field mapping type
External Field with Conversion (SAP / Custom). Use function /OTX/
PF20_UTIL_EXIT_FIELD_MAP as a template to create a custom exit.

Ignore Character
Enter characters that are deleted in an extra step before mapping continues.
This is useful, for example, if there are apostrophes in a Reference Number.
The field can contain up to 6 characters.
Condense
Select this check box to condense the value. If you select the check box, any
leading and trailing blanks are removed.
Value
For field mapping type constant or system variable, assign the related
value. The value must be character-like.

6.2.7 Assigning the mapping channel

In this step, you assign the mapping ID to a specific incoming document channel. If
no assignment is found, the default mapping is processed (see Default on page 202).

The following mapping IDs are delivered:

CAPTURE
Mapping for Business Center Capture application created before Business
Center Capture 16.5
CAPT_BCC
Mapping for Business Center Capture application created with Business Center
Capture 16.5 and later
CAPT_IES
Mapping for Information Extraction Service

According to your scenario, assign the corresponding mapping ID to the related

channel used in your registration scenario. For more information, see “Customizing
registration types” on page 71.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 205

Chapter 6 Process Foundation

To assign the mapping channel:

1. In the Data Model Configuration Overview screen (see “Defining a data

model” on page 197), mark an entry, and then double-click Mapping Channel
Assignment in the Dialog Structure.
2. In the Mapping Channel Assignment Overview screen, assign the mapping ID
to the channel. using the following parameters.

Channel
Incoming channel in which the document has been processed. For more
information, see “Configuring channels” on page 64).
Mapping ID
Enter the unique technical ID which identifies the mapping scenario.

6.3 Process Foundation profile

Generating a Process Foundation profile is a mandatory technical step to assign a
configured business data model. There is a fixed one-to-one relationship between
the Process Foundation profile and the business data model.

Note: Each Process Foundation profile must be assigned to a scenario. During

generation of a Process Foundation profile, you must select the correct business
scenario that is used for this profile, for example Invoice or Sales Order. This
assignment is required for the correct license measurement.

To generate a Process Foundation profile:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click Process Foundation > Generate Profiles.

Note: To run this activity, authorization for J_6NPF_ADM is needed. For

more information, see “Authorization objects” on page 303.
3. In the Generate Process Foundation Profiles screen, in the Generate profile
field, enter a suitable Process Foundation profile name to be generated. Make
sure the profile name does not exist yet. Click the Execute button.

Note: By default, a new profile is always generated using the template

profile PF_DEFAULT. You can control which profile is used as generation
template by the Default Profile parameter.
4. To change the the Default Profile parameter available in the basic settings of
the Process Foundation:

a. Run the /n/OTX/PF00_IMG transaction.

b. Click Process Foundation > Basic Settings. .
c. If you leave the parameter value empty, you can freely choose any existing
Process Foundation profile as a template for the generation of a new profile

206 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 6.4. Business data model assignment

To add generated profiles to a transport request:

1. Run the /n/OTX/PF00_IMG transaction

2. Click Process Foundation > Profiles.

3. Select the profile that you want to transport. Click Table View > Transport from
the menu and include all corresponding configuration settings in a transport
request.

Note: You must always manually add profile entries in the tables /OTX/
PF02_T_TBWD and /OTX/PF02_T_TBWT to a transport from the SE16
transaction.

6.4 Business data model assignment

The last step before starting to implement the detailed business scenario
requirements using the Process Configuration is to assign the configured business
data model to the generated Process Foundation profile.

To assign a business data model to a Process Foundation profile:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click Process Foundation > Profiles.

3. In the Profile Configuration Overview screen, assign the configured business

data model ID to the generated Process Foundation profile, using the following
parameters:

Profile ID
ID of the Process Foundation profile
Data Model ID
Enter the name of the business data model containing the process ledger
header and item tables. This stores the business data of the corresponding
business scenario.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 207

Chapter 7

Process Configuration

Process Configuration allows an easy and technically simplified configuration of

complex business scenario aspects. You do not have to consider any detailed SAP
Business Workflow related requirements. The following configuration aspects are
covered within Process Configuration:

• Profile configuration

• Profile assignment

7.1 Profile configuration

A profile within Process Configuration comprises the following definitions:

• which business rules must be checked for a business scenario

• which corresponding process steps should be executed

• which agent roles should execute them, using specific screen layouts and suitable
process actions

The profile configuration also offers versioning capabilities. This means, it allows
changing the defined business scenarios at any time without disrupting the already
running process instances in any way.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 209

Chapter 7 Process Configuration

Note: Within the standard delivery, a simple dummy profile PC_DEFAULT is

delivered. This profile is independent from any business scenario data context.
It can be easily used to start and test example processes.

The following customizing steps are necessary to configure profiles:

• “Defining a profile” on page 210

• “Defining a profile version” on page 211
• “Defining actions” on page 220
• “Defining roles” on page 229
• “Configuring data enrichments” on page 231
• “Configuring the process split functionality” on page 237
• “Configuring characteristics” on page 242
• “Maintaining process steps” on page 243
• “Configuring PDF history” on page 258

7.1.1 Defining a profile

A profile is defined by a unique profile ID, a meaningful description, and a
responsible user name.

To define a profile:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click Process Configuration > Profiles.
3. In the Profile Configuration Overview screen, define the profile using the
following parameters:

Profile ID
Define the profile with a unique ID.
Profile Description
Enter a meaningful profile description.
User
Enter the responsible person or creator for the profile.

To copy an existing profile and all its dependent settings to a different profile
name:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click Process Configuration > Copy Profiles.

Note: To run this activity, authorization for J_6NPF_ADM is needed. For

more information, see “Authorization objects” on page 303.

210 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

The copied version will always start with a first profile version again,
independent from the current version counter currently used by the copied
profile.

7.1.2 Defining a profile version

In this step, you define the main settings for a profile version and the characteristic
and Processing Screen settings. For each profile, there must be only one active
version at the same time.

To define a profile version:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click Process Configuration > Profiles.

3. In the Profile Configuration Overview screen, mark an entry, and then double-
click Version Definition.

4. In the Version Definition Details screen, define the version using the following
parameter.

Version
Next higher version counter

To generate a new version for an existing profile by reusing all already

available settings

Note: You can chang or enhanc the settings afterwards

1. Run the /n/OTX/PF00_IMG transaction.

2. Click Process Configuration > Create Profile Versions.

Note: To run this activity, an authorization for J_6NPF_ADM is needed. For

more information, see “Authorization objects” on page 303.

This will set the old version to inactive and copy all current settings to a new
active profile version automatically.

Note: To remain consistent, running processes will always continue to use

the profile version for which they have been started. This also applies if
the corresponding profile version has been set to inactive in the meantime
due to a newer active profile version. Therefore, it is not allowed to delete
profile versions from the configuration at any time.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 211

Chapter 7 Process Configuration

7.1.2.1 Maintaining version settings

To maintain version settings:

• In the Version Definition Details screen (see “Defining a profile version”

on page 211), maintain the version settings, using the following parameters.

Version Description
Enter a meaningful description of the current profile version.
Active
Select this check box to set the version to active. Clear the check box to set
the version to inactive.
Creation Date
Enter the date when the version has been created.
Created by
Enter the responsible person or creator for the profile version.
Profile Class
Enter the profile class. The profile class contains the highest level profile
related processing logic that is required to execute a profile configuration
during runtime. If no class is maintained, the standard class /OTX/PF04_CL_
PROFILE is always used.
Default value: <Empty>
If the standard logic has to be changed for any reasons, the class /OTX/
PF04_CL_PROFILE must be inherited, redefined as needed, and entered as
custom profile class.
The following methods are supposed to be redefined if needed. OpenText
recommends that you do not change any other method.
AUTH_CHECK_DATA
This method implements custom authorization checks based on the
current characteristic value, process step, and process ledger data.
When executing dialog work items, the method is called for the
activities 02 - Change and 03 - Display.
If any authorization check fails, the exception /OTX/CX_PF04_
EXCEPTION has to be raised passing a suitable error message.

FINALIZE_PROCESSING
You can use this method to implement any finalization or data cleanup
activities at the end of the overall business process.

Data Class
Enter the data class. The data class is used during profile processing. It
handles read and write database accesses to the corresponding process
ledger header and item data tables. It also handles the determination of the
characteristic value. If no class is maintained, the standard class /OTX/
PF04_CL_DATA is always used.

212 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

Default value: <Empty>

If the standard logic has to be changed for any reasons, the class /OTX/
PF04_CL_DATA must be inherited, redefined as needed, and entered as
custom data class.
The following method is supposed to be redefined if needed. OpenText
recommends that you do not change any other method.
CHARACTERISTIC_EXIT
This method dynamically determines the characteristic value based on
the current process ledger data. This is necessary if the characteristic
value cannot be determined statically by a single process ledger header
table field value.
This method is used when writing data back to the process ledger
header table and during processing of a profile configuration.
The determined characteristic value is written back to the process
ledger header table field BCF_CHAR.

Analyt. Prof.
Analytics Profile. For analytic evaluations, data may need to be prepared on
the database. Enter the Analytics profile with profile type 1 - Process KPIs ,
if you want to trigger the update of Analytics database tables designed for
business processes. For details how to maintain an Analytics profile, see
“Configuring Analytics” on page 35.

7.1.2.2 Maintaining characteristic settings

To maintain characteristic settings:

• In the Version Definition Details screen (see “Defining a profile version”

on page 211), maintain the characteristic settings, using the following
parameter.

Characteristic Field (optional)

The characteristic might be represented statically by the current value of
just one single process ledger header table field during runtime. In this case,
you can maintain the table field name here. All available process ledger
header table fields can be used, except the characteristic field BCF_CHAR
itself. The BCF_CHAR field always must store the latest determined value.
Default value: <Empty>
Note: As soon as a static process ledger header table field is
maintained, no dynamic characteristic determination using the
method CHARACTERISTIC_EXIT of the class /OTX/PF04_CL_DATA takes
place anymore.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 213

Chapter 7 Process Configuration

7.1.2.3 Maintaining Processing Screen settings

The Processing Screen is called when executing process steps in dialog. The
Processing Screen offers the corresponding business scenario related index data. It
also offers suitable process actions and further scenario or related data context
information. This is required to resolve issues represented by a dialog process step
in a fast and flexible way.

You can control the basic technical functionality of the Processing Screen and its
different screen areas by maintaining the Processing Screen settings described in this
section.

Important
To use the Processing Screen in a proper way, a minimum screen resolution of
1600 x 900 is required.

The following screen areas are available and together form the overall appearance of
the Processing Screen during runtime:

Action Pane
The action pane integrates all process actions that have been configured for an
agent role. These process actions are available for a combination of the current
characteristic value (if applicable) and the process step. Each process action is
represented by a separate action button.
A maximum of 20 process actions is allowed. They are displayed by 5 action
button rows consisting of 4 action buttons each. The arrangement of the buttons

214 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

starts in row 1 and takes place from left to right using the process action
sequence as maintained in the action assignment configuration. For more
information, see “Defining actions” on page 220. As soon as a button row
exceeds the limit of 4 action buttons, the next row is populated.
Info Pane
The info pane displays all check results of the business rules assigned to the
current agent role, characteristic value (if applicable), and process step.
The rule check status is visualized by an indicator light icon in combination with
the return messages of the check. The first check result message is displayed
directly in the info pane area overview. All further check messages can be
displayed by clicking on the message line hyperlink.
Detail Pane
In the detail pane area, additional process data context information is displayed.
The detail pane uses the processing plug-in concept. For more information, see
“Configuring plug-in integration” on page 26.
Tab Strip Area
Within the tab strip area, the index data itself is displayed. It is grouped into
several meaningful tab strip sections. Each tab strip allows calling a custom sub
screen containing the corresponding business scenario related index data fields.
Depending on the related business scenario, the index data fields can be
completely different.
You can activate a maximum of 6 different tab strip sections. Tab strips that have
not been activated will not be displayed during runtime.

To maintain Processing Screen settings:

• In the Version Definition Details screen (see “Defining a profile version”

on page 211), maintain the Processing Screen settings, using the following
parameters.

Main Class
Enter the main class. The main Processing Screen class contains all logic
required for the screen processing. If no class is maintained, the standard
class /OTX/PF40_CL_IDX_SCREEN is always used.
Default value: <Empty>
If the standard logic has to be changed for any reasons, the class /OTX/
PF40_CL_IDX_SCREEN must be inherited, redefined as needed, and entered
as custom Processing Screen class.
Note: A redefinition of the main class is not required.

Sub Class
Enter the subclass. The Processing Screen subclass contains all logic for the
subscreen processing. Copy the general class /OTX/PF41_CL_IDX_
SUBSCREEN, enhance it with business scenario specific logic, and enter it as
Processing Screen subclass.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 215

Chapter 7 Process Configuration

Note: An inheritance of the general class is not possible because the

associated types of the following class attributes must be replaced
with suitable types that are business-scenario specific:

• MS_HEAD
• MT_ITEM
• MS_ITEM
• MT_ITEM_TCTRL
• MS_ITEM_TCTRL

The attribute names themselves must remain unchanged.

Action Pane Class

Enter the action pane class. This class provides the integration and handling
of process actions into the action pane. If no class is maintained, the
standard class /OTX/PF40_CL_ACTION_PANE is always used.
Default value: <Empty>
If the standard logic must be changed for any reasons, the class /OTX/PF40_
CL_ACTION_PANE must be inherited, redefined as needed, and entered as
custom action pane class.

Note: In general, no redefinition of the action pane class is required.

Info Pane Class

Enter the info pane class. This class handles the integration of the business
rule check results into the info pane. If no class is maintained, the standard
class /OTX/PF40_CL_INFO_PANE is always used.
Default value: <Empty>
If the standard logic must be changed for any reasons, the class /OTX/PF40_
CL_INFO_PANE must be inherited, redefined as needed, and entered as
custom info pane class.

Note: In general, no redefinition of the info pane class is required.

Tab Strip Class

Enter the tab strip class. This class handles the integration of the tab strip
control into the main index data tab strip area. If no class is maintained, the
standard class /OTX/PF40_CL_TABSTRIP is always used.
Default value: <Empty>
If the standard logic must be changed for any reasons, the class /OTX/PF40_
CL_TABSTRIP must be inherited, redefined as needed, and entered as
custom tab strip class.

Note: In general, no redefinition of the tab strip class is required.

216 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

Field Handl. Class

Enter the field handler class. This class handles the general availability and
the input status of the business scenario related Processing Screen data
fields. If no class is maintained, the standard class /OTX/PF40_CL_FLD_
HANDLER is always used.
Default value: <Empty>
The maintained field settings determine whether a screen field is available
and what the field input status should be for a combination of current agent
role, characteristic value, and process step.
If the standard logic must be changed for any reasons, the class /OTX/PF40_
CL_FLD_HANDLER must be inherited, redefined as needed, and entered as
custom field handler class.
The following methods are supposed to be redefined if needed. OpenText
recommends that you do not change any other method.
FIELD_STATUS_HEAD_SET
This method sets the screen field status of business scenario related
index header data fields.
This method has to be called in the PBO module of every business
scenario related tab strip header data sub screen.
FIELD_STATUS_ITEM_SET
This method sets the screen field status of business scenario related
index item data fields.
This method has to be called in the PBO module of every business
scenario related tab strip item data sub screen.

Parameter Parameter type Description

PCS_TAB_CONTROL Changing Table control containing the
current item field list
display

Note: The field handler class method FIELD_STATUS_HEAD_SET must

be called in the PBO module of every business scenario related tab
strip header data subscreen, regardless if it has been redefined or not.
Also the field handler class method FIELD_STATUS_ITEM_SET has to
be called in the PBO module of every business scenario related tab
strip item data subscreen regardless if it has been redefined or not. The
reason is that both methods can be used within the sub screens to
integrate the maintained field setting configuration without the need
to manually evaluate these settings in every scenario related sub
screen PBO module over and over again.
Tab Program
Enter the name of the main program where the business scenario related
subscreens are located in. Usually, this is the main program of a function
group.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 217

Chapter 7 Process Configuration

Note: You can use the general function group /OTX/PF41_IDX_

DEFAULT_SCRN as a copy template. It already contains basic subscreens
for header and item data. Moreover, the function group contains the
corresponding screen logic, which is independent of the business
scenario. The function group also contains the required global data
declarations.
After copying the function group, replace all associated types of the
general data declarations in the TOP include by suitable types that are
related to the business scenario. Resolve all activation errors resulting
from the type changes within the copied function group. Additionally,
adjust the subscreen table control of the item data following the type
changes.
This approach significantly reduces development efforts when
implementing new business scenarios. It prevents developing the
same basic screen logic over and over again and therefore also lowers
maintenance efforts across different business scenarios.
Data Sync. FM
Enter the data synchronization function module. It must be created and
located in the function group where all the business scenario related
subscreens are located in. This function module allows data exchange
between the subscreens and the main Processing Screen frame screen or
program.
If you have copied the template function group /OTX/PF41_IDX_DEFAULT_
SCRN, the data synchronization function is already in place.
To create a data synchronization function completely from scratch, copy the
template function /OTX/PF40_IDX_DATA_SYNC_TEMPL into the
corresponding subscreen function group and enhance it as needed. The
objects to be synchronized by this function module are the following:

• the index header and item data

• a data changed indicator (needed to save index data if not done
already)
• the class instance of the field handler class

The following different data synchronization call modes are available. They
are initiated by the frame screen. They must be handled by the
synchronization function accordingly:
Import Mode
The import mode transfers the current screen data, the data changed
indicator, and the field handler instance to the subscreen function
group. It is called during initialization of the Processing Screen. It is
further called in the PAI section after execution of a process action and
also in the PAI after a possible change of the current characteristic
value. A characteristic value change could be caused, for example, from
changed data by a process action.

218 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

Export Mode
The export mode transfers the index data, the data changed indicator,
and the field handler instance from the subscreen function group back
to the frame screen program. It is called in the beginning of the PAI
section.

Exit Mode
When finally leaving the Processing Screen the synchronization
function is called in exit mode. It executes any final cleanup or data
reset activities. The data changed indicator has a special importance
here. It is used to ask the user if data changes should be saved before
leaving the screen.

Note: Index header data, index item data, the data changed indicator,
and the field handler class instance must be synchronized. Therefore,
suitable global data definitions must be made in the top include of the
corresponding function group.

PAI Sync. FM
Enter the PAI synchronization function module. Create it and locate it in the
function group where all the subscreens that are business scenario related
are located in. This function module allows the exchange of screen user
commands between the subscreens and the main Processing Screen frame
screen or program. If you have copied the template function group /OTX/
PF41_IDX_DEFAULT_SCRN, the PAI synchronization function is already in
place.
To create a PAI synchronization function completely from scratch, copy the
function module /OTX/PF41_IDX_PAI_SYNC_DEF into the corresponding
subscreen function group and enhance it as needed.

Tab 1-6 Subscreens , Tab 1-6 Text

Assign all business scenario specific subscreen numbers to the tabs.
Maintain the texts for the single tabs as well.

Inquire Role
Enter the inquire role. Inquiry is a special simplified process step referral
functionality. It does not need a receiving role to be chosen but only
requires the target users to be entered. To allow maintenance of suitable
process actions and field settings, you must maintain a technical role name
that is used to maintain and evaluate these settings.

Display Role
Enter the display role. It is used to read the maintained Processing Screen
field configuration if the Processing Screen is called in standalone mode
outside of any running process.

Display Process Step

Enter the display process step. It is used to read the maintained Processing
Screen field configuration if the Processing Screen is called in standalone
mode outside of any running process.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 219

Chapter 7 Process Configuration

Detail Pane State

Select the detail pane state from the list. When calling the Processing Screen
for the first time, this setting is used to determine if the detail pane should
be shown or hidden. Afterwards the current state is stored user-specifically
for all further screen calls.
Possible values: Hide, Show, No Detail Pane
Detail Pane Side
Select the detail pane side from the list. When calling the Processing Screen
for the first time, this setting is used to determine on which side the detail
pane should be docked. Afterwards the current docking side is stored user-
specifically for all further screen calls.
Possible values: Left Justified, Right Justified
Detail Pane %
Enter the detail pane ratio in percent. When calling the Processing Screen
for the first time, this setting is used to determine the screen size of the
detail pane in percent. Afterwards the current size is stored user-specifically
for all further screen calls.
Note: Only ratio values between 5 and 90 % are allowed to prevent
that either the main screen or the detail pane is completely overlain.
Plug-In Type
Assign the plug-in type that shall be used in the detail pane.
Plug-In ID
Maintain the plug-in ID that should initially be displayed in the detail pane
when the screen is called for the first time. Afterwards the current plug-in
ID is stored user-specifically for all further screen calls.

7.1.3 Defining actions

In this step, you define the process actions which must be available to be assigned to
process steps in combination with the current characteristic value and agent role.

To define actions:

1. In the Version Definition Details screen (see “Defining a profile version”

on page 211), double-click Action Definition in the Dialog Structure.
2. In the Action Definition Overview screen, define actions, using the following
parameters.

Action ID
Define the action using a 15 character unique action ID.
Note: Every action ID that is relevant for processing on Fiori side also
needs to be maintained as a corresponding work object type action
using the same action ID. For more information, see “Defining and
assigning node actions” on page 392.

220 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

Action Title
Enter the action title. It will be displayed as button text for the created
process action button in the action pane area of the Processing Screen.
Action Description
Enter a description of the action. The description will be displayed as tooltip
when the pointer is moved over the process action button.
Action Type
Select the action type from the list. The action type determines how a
defined action is handled during processing. It also determines whether the
action needs to be displayed in the action pane area of the Processing Screen
or not. The following action types are available:
Background Action
All actions of this type are not displayed in the action pane area of the
Processing Screen. However, these actions can be assigned to process
steps that are executed in background.
Dialog Action
For every dialog action, which is assigned to a process step, current
characteristic value, and agent role, an executable process action button
is created in the action pane area of the Processing Screen.
History Action
A history action is some kind of “dummy” action. It is nor available
from an Processing Screen process action button or within a
background process step. It can be used from anywhere in the process
to create a history entry for any purpose.
Referral Action
This action type is a special dialog action which is used to refer process
steps to other agent roles and/or users. It is displayed as an action
button in the action pane area of the Processing Screen.

Important
The following actions are framework actions that must be available in
all profile definitions:

Action ID Action Title/ Action Action Class

Action Type
Description
FRM_HIST_ACTIV Activate Rule History /OTX/
Action PF41_CL_ACTION_
ACTIVATE
FRM_HIST_BYPASS Bypass Rule History /OTX/
Action PF41_CL_ACTION_
BYPASS

VIM200405-CGF-EN-02 Configuration Guide for Foundation 221

Chapter 7 Process Configuration

Action ID Action Title/ Action Action Class

Action Type
Description
FRM_WP_REASSIGN Reassign Referral /OTX/
Action PF41_CL_ACTION_
ASSIGN_EXT
FRM_WP_CLASSI Reclassify Dialog /OTX/
Action PF41_CL_ACTION_
CLASSI_EXT

Action Class
Enter the action class. The action class contains the logic that is processed
when executing an action during runtime. If no class is maintained, the
standard class /OTX/PF04_CL_ACTION is always used.
Default value: <Empty>
If the standard logic must be changed for any reasons, the class /OTX/PF04_
CL_ACTION must be inherited, redefined as needed, and entered as custom
action class.
The following methods are supposed to be redefined if needed. OpenText
recommends that you do not change any other method.

ACTION_LOGIC
This method provides logic that is executed for action of type Dialog
Action and Referral Action.
The method is called by the Processing Screen action pane when
pressing a process action button.

Parameter Parameter type Description

PIT_ACTION_REASONS Importing This parameter contains
action reasons which could
potentially be selected
during executing actions
from the Fiori Task App.
PCS_PLH Changing Process ledger header data
that can be used and
changed by the action
PCT_PLI Changing Process ledger item data
that can be used and
changed by the action
PE_SUCCESS Exporting If the action has been
processed successfully, this
parameter has to be
returned with X. This
indicates that the ledger
data can be saved and the
process can be continued.

222 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

Parameter Parameter type Description

PE_NO_DIRECT_LEDGE Exporting This parameter can be used
R_SAVE to prevent a dialog action
from directly saving data
changes to the process
ledger tables after its
successful execution.
Therefore, it leaves the
handling of the database
save up to the calling
application. This may be
useful if any changes should
explicitly be saved by the
Save button of the
Processing Screen only. On
the other hand, the changes
should also be discarded if
the Confirm Save dialog
box is denied when leaving
the Processing Screen.
PET_MESSAGES Exporting All messages returned with
this parameter are saved as
action messages for the
corresponding history entry.
PET_REFERRAL_AGENT Exporting In case of the action type
S Referral Action, all
referral agents are returned
to the process by this
parameter.
PET_COMMENT Exporting This parameter allows
returning comments, which
are written to the comment
history.
PC_FINISH_STEP Changing This parameter contains the
customizing setting if a
dialog step should be
finished after executing the
corresponding process
action. It can be overwritten
if needed in some rare cases.
PC_FINISH_PROCESS Changing This parameter contains the
customizing setting if the
whole process should be
finished after executing the
corresponding process
action. It can be overwritten
if needed in some rare cases.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 223

Chapter 7 Process Configuration

Parameter Parameter type Description

PC_RESTART_PROCESS Changing This parameter contains the
customizing setting if the
process should be restarted
after executing the
corresponding process
action. It can be overwritten
if needed in some rare cases.

ACTION_LOGIC_PRE_CHECK
This method allows to check if executing an action is allowed or should
be stopped. The method is called for actions of type Dialog Action and
Referral Action.

Parameter Parameter type Description

PIS_ACTION_ASSIGNMENT Importing Corresponding action
assignment settings
defined in the
configuration
PIT_ACTION_REASONS Importing Corresponding action
reasons if applicable and
selected during execute
action
PIS_PLH Importing Process Ledger Header
Data
PIT_PLI Importing Process Ledger Item
Data
PET_MESSAGES Exporting If the execute action
should be prevented/
stopped, return any
messages of type E

ACTION_LOGIC_BGR
This method provides logic that is executed for action of type
Background Action. The method is called when executing background
process steps.

Parameter Parameter type Description

PCS_PLH Changing Process ledger header
data that can be used
and changed by the
action
PCT_PLI Changing Process ledger item data
that can be used and
changed by the action

224 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

Parameter Parameter type Description

PE_SUCCESS Exporting If the action has been
processed successfully,
this parameter has to be
returned with X. This
indicates that the ledger
data can be saved and
the process can be
continued.
PE_FINISH_PROCESS Exporting You can use this
parameter to finish the
whole process after
successfully executing
the corresponding
process action.
PE_RESTART_PROCESS Exporting You can use this
parameter to restart the
process after
successfully executing
the corresponding
process action.
PET_MESSAGES Exporting All messages returned
with this parameter are
saved as action messages
for the corresponding
history entry.

ACTION_LOGIC_HIST
This method provides logic that is executed for action of type History
Action.
This method can be called whenever a dedicated history entry needs to
be created independent from the regular functionality of dialog actions
in the action pane or background actions within background steps.
Standard history entries will be created for both scenarios automatically
without the need for further history handling.

Parameter Parameter type Description

PIS_PLH Importing Process ledger header data
that can be used but not
changed by the action
PIT_PLI Importing Process ledger item data
that can be used but not
changed by the action

VIM200405-CGF-EN-02 Configuration Guide for Foundation 225

Chapter 7 Process Configuration

Parameter Parameter type Description

PIT_ACTION_REASONS Importing This parameter contains
action reasons which could
potentially be selected
during executing actions
from the Fiori Task App.
PE_SUCCESS Exporting If the action has been
processed successfully, this
parameter must be returned
with X. This indicates that
the history entry can be
saved to the database and
the process can be
continued.
PET_MESSAGES Exporting All messages returned with
this parameter are saved as
action messages for the
corresponding history entry.

ACTION_MESSAGE_FORMAT
This method formats action messages for screen output. This can be
required if some special formatting requirements need to be fulfilled,
for example amount formatting. It can also be required if some
language specific description texts should be displayed, for example
agent role descriptions.
This method is called when displaying action messages from the
process history plug-in.

Parameter Parameter type Description

PIS_HIST Importing History entry for which a
message line should be
formatted for screen display
PCS_MESSAGE Changing Formatted output message

ACTION_SKIP_BUTTON
This method can be used to dynamically skip the button creation for an
assigned dialog action during runtime. As soon as a button has been
skipped, it is not possible to execute the corresponding dialog action
anymore.
This method is called when creating the buttons for assigned dialog
actions in the Processing Screen action pane and the Fiori screens.

226 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

Parameter Parameter type Description

PIS_PLH Importing Process ledger
header data that can
be used but not
changed by the
action
PIT_PLI Importing Process ledger item
data that can be used
but not changed by
the action
PIS_ACTION_ASSIGNMENT Importing Configuration
settings of the action
assignment
PIS_SCREEN_SETTINGS Importing Configured screen
settings
PI_READ_ONLY_MODE Importing Indicates whether the
screen currently runs
in read only mode or
not.
PE_ACTION_SKIP_BUTTON Exporting If this parameter is
returned with value
X, no button will be
created for the dialog
action.

ACTION_SKIP_HIST_GET
This method allows to overwrite the Skip History setting of the action
configuration during runtime.
This method is used when preparing the process history entries for
screen output.

Parameter Parameter type Description

PIS_HIST Importing History entry for the
executed action in the
process history
PIT_HISM Importing History message lines for a
process history entry
PE_ACT_SKIP_HIST Exporting If this parameter is returned
with value X, the
corresponding history entry
for the action will be
skipped in the process
history screen output.

ACTION_REASONS_GET
This method allows to offer action reasons to be selected when
executing actions from the Fiori Task App.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 227

Chapter 7 Process Configuration

Parameter Parameter type Description

PIS_PLH Importing Process ledger header
data that can be used but
not changed by the
action
PIT_PLI Importing Process ledger item data
that can be used but not
changed by the action
PE_ACTION_REASON_STA Exporting This parameter controls
TE whether the selection of
action reasons is
required, optional, or
inactive.
PE_ACTION_REASON_OPT Exporting This parameter controls
whether the action
reasons are offered as a
multiple or single
selection.
PET_ACTION_REASONS Exporting Action reasons
represented by unique
IDs and suitable
descriptions. The default
action reason to be
preselected can also be
set here.

ACTION_COMMENT_INPLACE_CHECK
You can use this method to control whether action comments are
handled by one of the following:

• the action itself using a suitable inplace comment box (for example,
referral actions)
• the corresponding comment dialog box offered on framework side

Parameter Parameter type Description

PR_COMMENT_INPLACE Returning Set the parameter to X if
comments are handled
by the action itself,
otherwise return an
empty value.

Skip History
Select this check box to skip the display of history entries in the process
history. For example, adding a comment may not be relevant to be
displayed in the history as an executed action.

228 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

Action Icon
For dialog and referral actions, assign an icon symbol, which is displayed
on the created process action button in the action pane area of the
Processing Screen.
Timeline Icon
Assign an icon for visualization in the Fiori history screens.
Tip: All available icons are defined in the “SAP UI5 Icon Explorer”:
https://openui5.hana.ondemand.com/iconExplorer.html. The URL
might be object to changes.

7.1.4 Defining roles

In this step, you define the agent roles that participate in the processing of the dialog
process steps. You also define how these roles are resolved during runtime. The
roles are also used to assign process actions, possible referral, and Processing Screen
field settings to the corresponding agents. An agent role can represent a group of
users or just one single user responsible for specific process steps.

To define roles:

1. In the Version Definition Details screen (see “Defining a profile version”

on page 211), double-click Role Definition in the Dialog Structure.
2. In the Role Definition Overview screen, define roles using the following
parameters:

Role ID
Define the role using a 15 character unique role ID.
Role Description
Enter a meaningful role description.
Role Type
Select the role type from the list. Based on the defined role type, the system
determines how the role has to be resolved. You can select one of the
following role types:
Organizational Object Assignment
You can assign a fixed organizational object type and ID to the role, for
example work center.
Role Resolution Logic
You can program a dynamic role resolution logic, which will be used
for the role resolution. For this role type, the assignment of a custom
role class is mandatory.

Role Class
Enter a custom role class if necessary. It contains all required logic to
resolve the assigned role users during runtime. If no class is maintained the
standard class /OTX/PF04_CL_ROLE is always used.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 229

Chapter 7 Process Configuration

Default value: <Empty>

If the standard logic must be changed for any reasons, the class /OTX/PF04_
CL_ROLE must be inherited, redefined as needed, and entered as custom role
class.
The following method is supposed to be redefined if needed. OpenText
recommends that you do not change any other method.
ROLE_LOGIC
Within this method, you can define any custom role resolution logic.
This method is called by the role resolution function modules when
creating dialog process steps and when referring process steps in dialog
to propose the possible recipient list.

Parameter Parameter type Description

PET_ROLE_RESULT Exporting List of resolved users

Object Type
Enter the organizational object type, for example work center to be selected
for the role type Organizational Object Assignment.
Agent ID
Enter the agent ID or the ID of another organizational object, for example
work center, depending on the chosen object type.

Note: The IDs of organizational object assignments may be different

across the system landscape. Therefore, the /OTX/PF04_ADM_ROLE
transaction is available to adjust the values in test and production
systems, which in general do not allow any configuration changes.
The transaction is protected against a special administration
authorization. For more information, see “Authorizations”
on page 260.
EvalPath
Maintain the evaluation path. A special evaluation path might be required
to resolve the connected users for a role. As long as no special evaluation
path has been set up, the standard evaluation path WF_ORGUS is always
used.

230 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

7.1.5 Configuring data enrichments

In this step you configure data enrichments. Use data enrichments to determine data
at any point of time throughout the process life cycle.

Implement one or more of the following general data enrichment strategies:

• Rules based data enrichment, for example setting different Sales Order document
types.
• Document content based data enrichment, for example setting a high processing
priority if the document full text contains the “urgent” keyword .
• Master data based data enrichment, for example setting the material number
from the material master info record using the customer material number.
• Learning based data enrichment, for example setting payment terms from
learned index data in combination with provided document keywords or
descriptions.

Technically two different data enrichment configuration options are available:

1. Determine a target field value based on values learned from previous processes
with the same source field value.
2. Determine one or more target field values using logic implemented by a data
enrichment exit interface.

To configure data enrichments:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click Process Configuration > Profiles.
3. On the Profile Configuration Overview screen, mark a profile.
4. Double-click Version Definition in the Dialog Structure.
5. On the Version Definition Details screen, double-click Data Enrichment
Configuration in the Dialog Structure.
6. On the Data Enrichment Configuration Overview screen, configure data
enrichments.
Use the following parameters:

Data Enrichment ID
Define the data enrichment using a 16 character unique ID.
Data Enrichment Description
Enter a meaningful description.
Enrichment Type
The enrichment type reflects two different technical data enrichment
configuration options.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 231

Chapter 7 Process Configuration

The following enrichment types are available:

• Learning based data enrichment

Note: If you select this enrichment type the Data Enrichment

Class parameter is not applicable anymore.
• Logic based data enrichment

Note: If you select this enrichment type the field type, learning
target field, and learning source field parameters are not
applicable anymore.

Learning Source Field

Select the data enrichment point at which the data enrichment is executed.
The following data enrichment points are available:

• Data enrichment during process initialization. Executed within the

process framework before the business rules are processed.
• Data enrichment during indexing in dialog.
• Data enrichment during process initialization & dialog indexing
• Data enrichment at all points.

Field Type
The field type controls on which process ledger hierarchy level the data
enrichment is done. Select the field type from the list.
The following field types are available:

• Header Field
• Item Field

Learning Target Field

Define the target process ledger field which is populated by the data
enrichment.

Enrichment Source Field

Define the source process ledger field. It is used to retrieve the field value of
the target process ledger field by involving the learned data enrichment
linkages between source field values and target field values.

Data Enrichment Class

Enter a data enrichment class. Implement the /OTX/PF04_IF_DATA_
ENRICH_EX exit interface if necessary.
For a detailed description of the methods of the exit interface, see “Methods
of the data enrichment exit interface” on page 234.

232 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

Active
Select the check box to set the data enrichment to active. Clear the check box
to set the data enrichment to inactive.

7.1.5.1 Maintaining data enrichment learning keys

You use data enrichment learning keys to restrict learned data enrichment results to
special business data contexts. For example to learn and enrich payment terms
depending on the sales organization and customer number, instead of globally using
the same learning data in every case.

Note: Data enrichment learning keys are only applicable for learning based
data enrichments.

To maintain data enrichment learning keys:

1. On the Data Enrichment Configuration Overview screen, mark an entry.

2. Double-click data enrichment learning keys in the dialog structure.

3. On the Data Enrichment Learning Keys Overview screen, maintain data

enrichment learning keys.
Use the following parameters:

Enrichment Key Fields

From the process ledger header table, select a data enrichment key field.
The field is used by the system to dynamically form data enrichment keys
for learning and managing learned linkages. Linked are the data enrichment
source field values and the data enrichment target field values. You can
maintain multiple field names if needed.

Sequence
Define the sequence that processes the data enrichment key fields to form
the corresponding data enrichment key.

7.1.5.2 Maintaining data enrichment logic target fields

Use the data enrichment logic target fields to tell the system which target fields are
enriched by each logic based data enrichment. This is important if a combination of
logic and learning based data enrichments is used for the same target fields. In this
context learning based data enrichments should only learn from user inputs but not
from previous results of logic based data enrichments.

Example: Material numbers should be determined in a two step approach. First from the
material master using a customer material number. If no result can be found then the material
number should be determined by learned user inputs as a fail safe option. If no data
enrichment logic target fields are maintained for the logic based data enrichment, the learning
based data enrichment can learn from the previous logic based data enrichment result instead
of user data inputs.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 233

Chapter 7 Process Configuration

Note: Data enrichment logic target fields are only applicable for logic based
data enrichments.

To maintain data enrichment logic target fields:

1. On the Data Enrichment Configuration Overview screen, mark an entry.

2. Double-click data enrichment logic target fields in the dialog structure.

3. On the Data Enrichment Logic Target Fields Overview screen, maintain data
enrichment keys. Use the following parameters:

Field Type:
The field type reflects on which process ledger hierarchy level the data
enrichment is done. Select the field type from the list.
The following field types are available:

• Header Field
• Item Field
• Logic Target Field: Define the target process ledger field which is
populated by the data enrichment.

Logic Target Field

Define the target process ledger field which is populated by the data
enrichment.

7.1.5.3 Methods of the data enrichment exit interface

You must implement the /OTX/PF04_IF_DATA_ENRICH_EX exit interface, if you
define a custom logic for data enrichments.

The following methods can be implemented:

DATA_ENRICH_LOGIC
You can define any data enrichment logic within this method.

Parameter Parameter Type Description

PI_CHARACTERISTIC Importing Current characteristic value
PI_ENRICH_ID Importing Processed data enrichment
ID
PI_ENRICH_KEY Importing Currently formed data
enrichment key value
PI_ENRICH_POINT Importing Data enrichment point
PIS_DEC Importing Data enrichment
configuration

234 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

Parameter Parameter Type Description

PIT_DERK Importing Data enrichment key fields
PET_RETURN Importing Return messages
PCS_HEAD Changing Enriched process ledger
header data
PCT_ITEM Changing Enriched process ledger
item data

DATA_ENRICH_CHECK
You can implement any custom logic that checks if the result of a business rule
that checks the correctness of the data enrichment result fails or succeeds.

Note: A data enrichment result check that fails, indicates a mismatch

between target field values. Check the currently indexed process ledger
target field value which differs from the enrichment value.

Parameter Parameter Type Description

PI_CHARACTERISTIC Importing Current characteristic value
PI_ENRICH_ID Importing Processed data enrichment
ID
PI_ENRICH_KEY Importing Currently formed data
enrichment key value
PIS_DEC Importing Data enrichment
configuration
PIT_DERK Importing Data enrichment key fields
PET_RETURN Importing Return messages
PIS_HEAD Importing Process ledger header data
PIT_ITEM Importing Process ledger item data
PES_CHECK_RESULT Exporting Result of the data
enrichment check. Defined
by data enrichment ID, data
enrichment key value and
data enrichment target field

VIM200405-CGF-EN-02 Configuration Guide for Foundation 235

Chapter 7 Process Configuration

7.1.5.4 Assigning data enrichments

You must assign data enrichments to characteristic values to process them during
runtime.

You must additionally set the following process configurations to handle the
assigned data enrichments.

For more information, see “Maintaining process steps” on page 243 and “Assigning
process actions” on page 250.

Process Step Step Type Step Description Rule Rule Rule Class
Type
ENRICH_MIS Dialog Data enrichment [Data Check /OTX/PF41_CL_RULE_CHK_
mismatch Enrichment DE_RSLT
ID]

Process Action Action Description Action Class

ACT_ENRICH Enrich Data (SAP GUI) /OTX/PF41_CL_ACTION_DE_RUN
ACT_ENRICH_EXT Enrich Data (Fiori) /OTX/PF41_CL_ACTION_DE_RUN_
EXT
ACT_ENRICH_UPD Update learning data from mismatches /OTX/PF41_CL_ACTION_DER_UPD
ACT_ENRICH_DISP Display learned data enrichments /OTX/PF41_CL_ACTION_DER_DISP

Note: OpenText recommends to define one check rule per defined data
enrichment. This allows bypassing each failed data enrichment result check
separately.

To assign data enrichments:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click Process Configuration > Profiles.

3. On the Profile Configuration Overview screen, mark a profile.

4. In the Dialog Structure, double-click Version Definition .

5. On the Version Definition Details screen, in the Dialog Structure, double-click

Characteristic Configuration.

6. On the Characteristic Configuration Overview screen, mark a characteristic.

7. In the Dialog Structure, double-click Assign Data Enrichments .

8. On the Assign Data Enrichment Configuration Overview screen, assign data

enrichments.
Use the following parameters:

236 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

Data Enrichment ID
Enter data enrichment IDs that are processed for the current characteristic
value.
Sequence
Maintain the sequence in which the assigned data enrichments are
processed.
Check Mismatch Step
Enter the dialog process step, which checks if the determined data
enrichment results are valid or not.
Check Mismatch Rule
Enter the check rule which checks if the determined data enrichment result
is valid or not.

Note: If a data enrichment is defined for execution at the Data enrichment

during process initialization point, the Check Mismatch Step and Check
Mismatch RuleEnrichment Step parameters are not applicable.

7.1.6 Configuring the process split functionality

In this step, you configure the process split functionality. You can use it to split a
business process into multiple processes depending on the defined split criteria. You
can assign a process split to characteristic values afterwards. This allows using
different logic for process splits dependent on the current characteristic value.

When splitting business processes, the following technical assumptions are made:

1. After successfully splitting a business process into several target processes, the
source process is immediately finished.
2. Each target process is linked to the source process by writing the source process
ledger key to the target header ledger data table.
3. The started target process is not linked to any inbound process anymore.
4. The archived images connected to the source process will also be linked to the
target processes without rearchiving these images.
5. If the first target process workflow start fails, the process split is stopped
immediately without taking further action.
6. If the first target process workflow has been started successfully but any other
workflow start fails, the process split writes error log entries. They can be
accessed and reprocessed using a dedicated work center at any point of time.
Automatic reprocessing of workflow start errors is also possible by scheduling
the ABAP report /OTX/PF04_P_PTEL_REPROCESS.

To configure the process split functionality:

1. Run the /n/OTX/PF00_IMG transaction.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 237

Chapter 7 Process Configuration

2. Click Process Configuration > Profiles.

3. On the Profile Configuration Overview screen, mark a profile, and then

double-click Version Definition in the Dialog Structure.

4. On the Version Definition Details screen, double-click Process Split

Configuration in the Dialog Structure.

5. On the Process Split Configuration Overview screen, configure the process

split, using the following parameters:

Split ID
Process Split ID. Define the process split using a 16 character unique ID.
Process Split Desc.
Process Split Description. Enter a meaningful description.
Process Split Type
Select the process split type from the list. Based on the defined process split
type, the system determines how the process split must be determined and
processed. Currently only one process split type is available:
Process split based on line item grouping
You can maintain line item grouping fields that are used as process split
criteria, as described in “Maintaining line item grouping” on page 239.
With this split type the system uses the maintained line item grouping
fields to determine the corresponding line item groups. For each of the
determined line item groups a separate new business process is started.
In the following graphic, each row of empty gray boxes represents a line
item.

Process Split Class

Enter a custom process split class if necessary. It contains all required logic
to split a business process based on the selected process split type and its
connected configuration during runtime. If no class is maintained the
standard class will always be used for the following process split type:
Process split based on line item grouping: /OTX/PF41_CL_PROC_
SPLIT_LG

238 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

Default value: <Empty>

If you must change the standard logic for any reasons, inherit the class /
OTX/PF04_CL_PROC_SPLIT, redefine it as needed, and enter it as custom
process split class for the corresponding process split type.
For a detailed description of the methods of the /OTX/PF04_CL_PROC_SPLIT
class, see “Methods of the process split class” on page 239.
Dialog
Select this check box to force dialog processing for all process splits.

7.1.6.1 Maintaining line item grouping

The line item grouping settings are currently only used by the Process split based
on line item grouping. You can use them as process split criteria.

To maintain line item grouping fields:

1. On the Process Split Configuration Overview screen (see “To configure the
process split functionality:“ on page 237), mark an entry, and then double-click
Line item grouping in the Dialog Structure.
2. On the Line item grouping Overview screen, maintain line item grouping fields
using the following parameter.

Field Name
From the process ledger item data table, select a line item field that is used
by the system to group line items for process splitting. You can maintain
multiple field names if needed.

7.1.6.2 Methods of the process split class

You can redefine the following methods of the /OTX/PF04_CL_PROC_SPLIT class if
needed. OpenText recommends that you do not change any other method.

PROC_SPLIT_REQUIRED_CHECK
Within this method, you can implement the logic if a process split is required or
not. It is called in the business rule class /OTX/PF41_CL_RULE_CHK_PS used for
the business rule Process split required.

Parameter Parameter Description

type
PIS_PLH Importing Process ledger header data
PIT_PLI Importing Process ledger item data
PR_PROC_SPLIT_REQUIRED Returning Process split required indicator

PROC_SPLIT_GROUPS_DETERMINE
Within this method, you can implement the logic to define into how many
different target processes a process must be splitted and which index data is

VIM200405-CGF-EN-02 Configuration Guide for Foundation 239

Chapter 7 Process Configuration

assigned to each target process. It is called in the standard process split action
classes /OTX/PF41_CL_ACTION_PS_BGR, /OTX/PF41_CL_ACTION_PS_DIA and /
OTX/PF41_CL_ACTION_PS_EXT depending on if the process split takes place in
background or dialog and based on which user interface.

Parameter Parameter Description

type
PIS_PLH Importing Process ledger header data
PIT_PLI Importing Process ledger item data
PRT_PROC_SPLIT_GROUPS Returning Determined process split groups
including used split criteria and
assigned index data

PROC_SPLIT_RESULT_CONFIRM
This method allows you to add a dedicated SAP GUI user confirmation dialog
before processing the determined process split result. It is called in the standard
SAP GUI process split action class /OTX/PF41_CL_ACTION_PS_DIA during dialog
processing.

Parameter Parameter Description

type
PIT_PROC_SPLIT_RESULT Importing Determined process split result
PE_CANCELLED Exporting Flag to indicate that the user did
not confirm and therefore
cancelled the process split

PROC_SPLIT_DATA_HEAD_SET
You can use this method to influence the header index data used for the target
processes. It is called during the process split result determination. By default,
the same header index data is used as in the source process.

Parameter Parameter Description

type
PI_PROC_GROUP Importing Determined split group of the
target process
PIS_PLH Importing Process ledger header data
PIT_PLI Importing Process ledger item data
PRT_PROC_DATA_HEAD Returning Header data to be used for the
target process

Note: To map data to the target ledger data tables, the system uses the
default field mapping ID. For more information, see “Defining external
data mapping” on page 202.
PROC_SPLIT_DATA_ITEM_SET
You can use this method to influence the item index data used for the target
processes. It is called during the process split result determination. By default,

240 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

no item index data is set because this can depend strongly on the process split
logic itself.

Parameter Parameter Description

type
PI_PROC_GROUP Importing Determined split group of the
target process
PIS_PLH Importing Process ledger header data
PIT_PLI Importing Process ledger item data
PRT_PROC_DATA_ITEM Returning Item data to be used for the target
process

Note: For the process split type Process split based on line item
grouping, the standard class /OTX/PF41_CL_PROC_SPLIT_LG already
provides a logic to assign the line items to the target processes that
correspond to the maintained line item grouping fields.

PROC_SPLIT_CRITERIA_OUTPUT_GET
Within this method, you can format the used process split criteria for output in
the corresponding process split result confirmation dialog.

Parameter Parameter Description

type
PR_PROC_SPLIT_CRIT Returning External representation of the
used process split criteria

PROC_SPLIT_MSG_ERROR_ADD
This method allows adding custom error messages to the process history if any
of the target process starts fail.

Parameter Parameter Description

type
PI_PROC_GROUP Importing Determined split group of the
target process
PI_PROC_SPLIT_CRIT Importing External representation of the
used process split criteria
PI_PROC_SPLIT_VALUE Importing Process split value resulting from
the process split criteria
PRT_MSG_ERROR Returning Error messages for process history

PROC_SPLIT_MSG_SUCCESS_ADD
This method allows adding custom success messages to the process history in
case of a successfully started target process.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 241

Chapter 7 Process Configuration

Parameter Parameter Description

type
PI_PROC_GROUP Importing Determined split group of the
target process
PI_PROC_SPLIT_CRIT Importing External representation of the
used process split criteria
PI_PROC_SPLIT_VALUE Importing Process split value resulting from
the process split criteria
PRT_MSG_SUCCESS Returning Success messages for process
history

7.1.7 Configuring characteristics

The characteristic value is supposed to represent any criteria that can be determined
from the current set of business data field values in order to structure the relevant
process configuration.

Example: If different business rule checks are required in a Sales Order processing scenario,
the characteristic configuration can be used to execute different rule checks based on the
current sales organization value. It also may combine different fields like the sales
organization, sales office, and distribution channel to form some kind of virtual criteria from
this multiple criteria. The virtual criteria can then be used to distinguish different process
configurations.

To configure characteristics:

1. In the Version Definition Details screen (see “Defining a profile version”

on page 211), double-click Characteristic Configuration in the Dialog
Structure.

2. In the Characteristic Configuration Overview screen, configure characteristics

using the following parameters:

Characteristic Value
Enter a direct (for example sales organization) or an indirect virtual
characteristic value (for example a transcoded combination of sales
organization, sales office, and distribution channel). Values up to 10
characters are allowed.
Direct characteristic values can be represented by a single statically
assigned process ledger header field. For more information, see
“Maintaining characteristic settings” on page 213.
Indirect virtual characteristic values need to be dynamically determined by
coding logic and transcoded into a key value. For more information, see
“Maintaining version settings” on page 212.

Note: If no special characteristic configuration is required at all,

configure an empty characteristic value.

242 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

Characteristic Description
Enter a meaningful description for the defined characteristic.

Process Split ID
Enter a process split configuration which is used to split a business process
for the current characteristic value if required. If you do not assign any
process split configuration, the process split functionality is considered as
inactive.

Note: Multiple similar characteristic configurations might need to be

performed. In this case, you can use the /OTX/PF04_CHAR_COPY
transaction to copy any characteristic configuration (and all its dependent
settings) to a different characteristic value. Afterwards the different
settings can easily be adjusted without the need to completely define each
single characteristic value from scratch over and over again. The copy
transaction only allows to copy characteristic values of currently active
profile versions to prevent old versions from being changed by mistake.

7.1.8 Maintaining process steps

The process step maintenance is based on a profile version and connected to the
current characteristic configuration. It contains all processing aspects for a business
scenario including business rule checks, process action assignments, and referral
settings as well as business rule simulate/bypass, index data field, and general
Processing Screen settings.

During runtime, each process step is represented by a SAP Business Workflow

dialog or background work item depending on the corresponding step type.

The following customizing steps are necessary to maintain process steps:

• “Defining a process step” on page 244

• “Defining business rules” on page 246

• “Assigning process actions” on page 250

• “Maintaining referral settings” on page 252

• “Maintaining simulate settings” on page 253

• “Maintaining bypass rules” on page 254

• “Maintaining rules that are excluded from simulation in the Info pane and Check
messages popup” on page 255

• “Maintaining field settings” on page 255

• “Maintaining screen settings” on page 257

VIM200405-CGF-EN-02 Configuration Guide for Foundation 243

Chapter 7 Process Configuration

7.1.8.1 Defining a process step

To define a process step:
1. In the Characteristic Configuration Overview screen (see “Configuring
characteristics” on page 242), mark an entry, and then double-click Process
Steps in the Dialog Structure.
2. In the Process Steps Overview screen, configure process steps using the
following parameters.

Process Step ID
Define the process step using a 10 character unique ID.
Process Step Description
Enter a meaningful process step description.
Step Type
Select the process step type from the list. The process step type controls how
a process step is determined and executed. The following process step types
are available.
Background Processing Only
Use this step type to execute background actions. It can be executed
only a fixed number of times. Otherwise, it would result in an endless
processing loop if the background processing fails over and over again.
The assignment of a background action ID is mandatory here. See
Action ID on page 246.
Background Processing with Dialog (Dialog on Fail)
Use this step type as the usual choice for steps that must be processed in
background. It automatically sends the process step to dialog if the
background action fails and therefore offers more flexibility than simple
background steps. The assignment of a background action ID is
mandatory here. See Action ID on page 246.
Dialog Processing
Use this step type for all dialog processing steps. They must be defined
using this step type.
Data Preparation Only
Use this step type for simple background activities, for example data
enrichments. The step type will be executed in background. However,
unlike the step type Background Processing Only, it will be executed
within the regular business rule check sequence without creating
separate work items.
Note: The step type Data Preparation Only can be useful to
always ensure a correctly prepared data basis within the business
rule check sequence if needed. However, it is not suitable for
complex background actions like SAP document creations.
Technical errors cannot be handled in a comfortable way using the
SAP Business Workflow functionality Restart after error.

244 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

Process Node Assignment

Use this step type as an enhanced step type whose usage should not be
required in general. It allows assigning technical process nodes defined
in the Process Foundation to fulfill special requirements which cannot
be implemented using any of the above mentioned process step types.

Process Step Class

Enter the process step class. It contains all logic required to check the
following:

• if a process step should be raised

• which initial role it should be assigned to
• which logic should be executed in dialog or background depending on
the defined step type

If no class is maintained, the standard class /OTX/PF04_CL_CATEGORY is

always used.
Default value: <Empty>
If the standard logic must be changed for any reasons, the class /OTX/PF04_
CL_CATEGORY must be inherited, redefined as needed, and entered as
custom process step class.
The following methods are supposed to be redefined if needed. OpenText
recommends that you do not change any other method.
CATEGORY_INITIAL_ROLE_GET
You can use this method to dynamically determine the initial role if no
fixed initial role assignment is possible.
The method is called after a process step has been determined to be the
next active process step, and no fixed initial role assignment is
available.

Parameter Parameter type Description

PE_ROLE_ID Exporting Determined initial role

CATEGORY_BGR_ACT_ID_GET
You can use this method to dynamically determine the background
action ID if no fixed assignment is possible.
The method is called before executing background steps.

Parameter Parameter type Description

PR_BGR_ACT_ID Returning Background action ID

Sequence
Define the processing sequence of the process steps within a characteristic
value.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 245

Chapter 7 Process Configuration

Action ID
Enter the Action ID. For all process steps with type Background Processing
Only and Background Processing with Dialog (Dialog on Fail), it is
mandatory to assign an action ID that contains the logic to be executed in
background.

Note: An action ID can only be assigned to step types Background

Processing Only and Background Processing with Dialog (Dialog
on Fail).

Role ID
To define the initial role assignment statically, enter the role ID.

Note: You can set an initial role only for the step types Background
Processing with Dialog (Dialog on Fail), Dialog Processing
and Process Node Assignment.

Process Node ID
For the process step type Process Node Assignment, enter a corresponding
process node defined in the Process Foundation.

Note: This setting is mandatory for process step type Process Node
Assignment.

Time Value
Maintain the time value when processing of a dialog or background step
should be started.

Time Unit
Maintain the time unit when processing of a dialog or background step
should be started: Minutes, Hours, Days, or Working days

7.1.8.2 Defining business rules

Business rules are assigned to process steps. As soon as at least one business rule
check fails, the process step is relevant for processing. It will result in a dialog or
background work item depending on its step type. If no business rule for any of the
defined process steps fails, no work item is created and the overall process is
successfully completed.

To define business rules:

1. In the Process Steps Overview screen (see “Defining a process step”

on page 244), mark an entry, and then double-click Rules in the Dialog
Structure.

2. In the Rules Overview screen, define the business rules using the following
parameters.

Rule ID
Define the business rule using a 10 character unique rule ID.

246 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

Rule Description
Enter a meaningful business rule description.

Rule Type
Select the business rule type from the list. The business rule type controls
how a business rule is handled during runtime. The following rule types are
available.

Check Data Only

The business rule is a check-only rule. That means, it cannot change any
data but only check the given data for its validity.

Note: This rule type cannot be selected for business rules that are
assigned to the process step type Data Preparation Only.

Change Data
If this business rule type is selected, the corresponding business rule
may change the given data, for example data enrichments. It is not
possible to set this rule type to status failed.

Note: This rule type must only be selected for business rules
assigned to the process step type Data Preparation Only.

Rule Class
The business rule class contains all logic required to execute a business rule
during the business rule run in background or during business rule
simulation (if applicable).
For every business rule, a valid business rule class must be inherited from
the standard class /OTX/PF04_CL_MODULE, redefined as needed, and entered
as custom rule class.
The following methods are supposed to be redefined if needed. OpenText
recommends that you do not change any other method.

MODULE_EXEC_CHECK
This method defines business rule check logic for the rule type Check
Data Only.

This method is called when running the business rule run in

background or during simulation in dialog.

Parameter Parameter type Description

PIS_PLH Importing Process ledger header data
to be used for the check but
not changeable
PIT_PLI Importing Process ledger item data to
be used for the check but
not changeable

VIM200405-CGF-EN-02 Configuration Guide for Foundation 247

Chapter 7 Process Configuration

Parameter Parameter type Description

PIS_CATEGORY_DATA Importing Customizing settings for the
process step to which the
rule has been assigned to
PE_MOD_RUN_STATUS Exporting Return the business rule
check result (see fixed
domain values of the
corresponding data type)
PET_MOD_MSG Exporting Business rule check return
messages

MODULE_EXEC_CHANGE
This method defines business rule change logic for the rule type Change
Data.
This method is called when running the business rule in background or
during simulation (if applicable) in dialog.

Parameter Parameter type Description

PI_SIMULATION_MODE Importing Indicates that a module is
currently executed in
simulation mode. No
changes to database tables
other than the process
ledger tables should be
performed at all. All
changes to the process
ledger tables are reverted
after a simulation run
automatically. However,
changes to other tables
cannot be reverted and
therefore should not be
done in simulation mode.
PIS_CATEGORY_DATA Importing Customizing settings for the
process step to which the
rule has been assigned to
PCS_PLH Changing Process ledger header data
to be changed
PCT_PLI Changing Process ledger item data to
be changed
PET_MOD_MSG Exporting Business rule change return
messages (if needed)

MODULE_MESSAGE_FORMAT
This method formats the business rule message(s) for dialog screen
output, for example amount or quantity conversions.

248 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

This method is called when displaying rule check result messages from
the business rule simulation (if applicable).

Parameter Parameter type Description

PCS_MESSAGE Changing Business rule return
message to be formatted for
dialog screen output

Note: For check rules which should always fail by default without
further check requirements, you can use the /OTX/PF41_CL_RULE_
CHK_FAILED class without the need to create similar classes for every
rule check over and over again.
Sequence
Define in which sequence the business rules are executed within a process
step.
Frequency
Define how often a business rule is executed within a process step. The
following values are available.
Always
This means that a business rule will always be executed.
Custom
For this frequency, you must define a fixed number.

Note: For business rules that are assigned to process step type
Background Processing Only, you must restrict the number of
executions to prevent endless loops.
Frequency Count
If a Custom frequency is assigned, define how often a business rule is
executed.
Dialog
Select this check box to skip processing the corresponding background
action and to directly force dialog processing. This setting is only available
for process steps of type Background Processing with Dialog (Dialog on
Fail).

Active
Select this check box to set the business rule to active. Clear the check box to
set the business rule to inactive.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 249

Chapter 7 Process Configuration

7.1.8.3 Assigning process actions

The action assignment defines which process actions are available for an agent role
based on the used UI, current characteristic value, and dialog process step.

To assign process actions:

1. In the Process Steps Overview screen (see “Defining a process step”

on page 244), mark an entry, and then double-click Action Assignment in the
Dialog Structure.
2. In the Action Assignment Overview screen, assign actions using the following
parameters.

UI Type
Select the UI type from the list. The following values are available.

• SAP GUI
• Web

Role ID
Enter the role ID. With this field, you can define to which role the
corresponding actions are assigned. The assigned actions will be available
in the action pane of the Processing Screen and within the Fiori screens,
depending on the chosen UI type.
Note: If not all roles should have a special action assignment, it is also
possible to leave the Role ID field empty. This simplifies the
configuration. This general setting will then be used for roles that do
not have a dedicated action assignment. However, as soon as a role
specific setting is made, the general settings will not be considered for
this special role anymore.
Action ID
Assign the action ID, which should be available for execution.
Sequence
Define the sequence. It determines the order in which the action buttons are
created in the action pane area of the Processing Screen.
Process Node ID
Enter the process node ID. This setting allows assigning a process node ID
defined in the Process Foundation. When executing an action, the assigned
process node ID will be started next. Similar to the Process Node
Assignment in the process step definition (see Process Node Assignment
on page 245), this should not be required in general. You should use it only
in very rare cases where the requirements cannot be implemented using the
regular functionality.
Time Value
Maintain the time value when processing an assigned process node ID
should be started. The setting is only used if a process node ID is assigned.

250 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

Time Unit
Maintain the time unit when processing an assigned process node ID
should be started. The setting is only used in case a process node ID is
assigned. Possible values: Minutes, Hours, Days, or Working days

Finish Step
Select this check box to determine that a process step should be finished
after executing the corresponding process action. After finishing a process
step, the defined business rules will be checked automatically to determine
the next required process step. The current value of this setting will be
passed into the method of the action class, which contains the action logic,
and can be overwritten there if needed.

Finish Process
Select this check box to determine that the whole process should be finished
after executing the corresponding process action. The current value of this
setting will be passed into the method of the action class, which contains the
action logic, and can be overwritten there if needed.

Restart Process
Select this check box to determine that the process is restarted after
performing the corresponding process action. The current value of this
setting is passed into the method of the action class, which contains the
action logic. The value can be overwritten there if needed.
A process restart runs the process initiation again and therefore
redetermines the Process Configuration profile and the corresponding
active profile version. Additionally, the current status of all related business
rules is reset, for example, whether a business rule has been bypassed or
how many times a business rule has been run already, or the business rule
results.

Comment Required
Select this check box to determine that a comment is required before
executing a process action.

Confirmation Required
Select this check box to determine that a confirmation dialog box is
displayed before executing a process action.

Active
Select this check box to set the action assignment to active. Clear the check
box to set the action assignment to inactive.

Note: The role ID which has been defined as Inquire Role (see
“Maintaining Processing Screen settings” on page 214) must only have one
“return action” (Finish Step check box selected) assigned. It must not be
allowed to send the process to further steps or roles using the inquire
functionality. The inquire step is only intended to represent a simple send/
return pattern. As soon as any “return action” is executed within the
inquire step, the process is directly returned to the sender of the inquiry.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 251

Chapter 7 Process Configuration

7.1.8.4 Maintaining referral settings

The referral settings define to which roles the current role can refer a process step.
Referral is based on the used UI, current characteristic value, and dialog process
step.

To maintain referral settings:

1. In the Process Steps Overview screen (see “Defining a process step”

on page 244), mark an entry, and then double-click Referral Settings in the
Dialog Structure.

2. In the Referral Settings Overview screen, maintain referral settings, using the
following parameters.

UI Type
Select the UI type from the list. The following values are available.

• SAP GUI
• Web

Note: Referral settings for the Fiori screens are intended for future
use only. They are not evaluated so far.

Action ID
Enter the action ID. If multiple different referral actions have been defined
in a business scenario, you can use this setting to refine the referral settings
for these different referral actions.
If the referral settings should be used for all referral actions in the same
way, leave the field empty.
Role ID
Enter the role for which the referral settings should be relevant.
Note: You might want to configure that not all roles should have
special referral settings. In this case, it is possible to leave the Role ID
field empty. This simplifies the configuration. This general setting will
then be used for roles that do not have a dedicated referral setting.
However, as soon as a role specific setting is made, the general
settings will not be considered for this special role anymore.
Refer to Role
Maintain which referral roles should be available. The maintained referral
roles will be available when executing a referral option. As soon as one of
the offered referral roles is selected in the refer action dialog box, all
corresponding users will be resolved accordingly.
Sequence
Define the sequence in which the possible referral roles should be offered in
the refer action dialog box.

252 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

Comment Required
Select this check box to determine that a comment is required during
referral.

Evaluation Path
Maintain the evaluation path. A special evaluation path might be required
to resolve the connected users when selecting a referral role. As long as no
special evaluation path has been set up, the standard evaluation path WF_
ORGUS is always used.

BAdI /OTX/PF40_REFERRAL
The /OTX/PF40_REFERRAL BAdI implements the /OTX/PF40_IF_BADI_REFERRAL
interface. The following interface method is available:

CHANGE_REASSIGN_REFER_OPTIONS – This method allows to change the

corresponding referral options. It is called when processing a referral action from the
SAP GUI processing screen or the SAP GUI workplace.

Parameter Type Description

PI_REFERRAL_MODE Importing Referral mode. Possible values:
S - Standard Referral Mode
R - Reassignment Mode
I - Inquire Mode
PIS_PLH Importing Process Ledger Header Data
PIT_PLI Importing Process Ledger Item Data
PCT_REASSIGN_REFER_OPTIONS Changing Referral Options to be changed by
the BAdI

7.1.8.5 Maintaining simulate settings

Using the simulate settings, you can define which process types can be simulated
depending on the current characteristic value, process step, and agent role.

Note: This presumes that the general simulate business rules functionality has
been assigned to the corresponding agent role using the action assignment. If
the functionality has not been assigned to an agent role, the settings described
in this section are not relevant.

To maintain simulate settings:

1. In the Process Steps Overview screen (see “Defining a process step”

on page 244), mark an entry, and then double-click Simulate Settings in the
Dialog Structure.

2. In the Simulate Settings Overview screen, maintain simulate settings, using the
following parameters.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 253

Chapter 7 Process Configuration

Role ID
Enter the role for which the simulate settings should be relevant.
Note: If not all roles should have special simulate settings, you can
leave the Role ID field empty. This simplifies the configuration. This
general setting will then be used for roles that do not have a dedicated
simulate setting. However, as soon as a role specific setting is made,
the general settings will not be considered for this special role
anymore.
Simulate Step
Enter the process step that should be considered in the business rule
simulation run.
Active
Select this check box to set the simulation setting to active. Clear the check
box to set the simulation setting to inactive.

7.1.8.6 Maintaining bypass rules

By defining bypass rules, you can control which rules of a simulated process step
can be bypassed to be skipped during further processing.

To maintain bypass rules:

1. In the Simulate Settings Overview screen (see “Maintaining simulate settings”

on page 253), mark an entry, and then double-click Bypass Rules in the Dialog
Structure.

2. In the Bypass Rules Overview screen, maintain bypass rules, using the
following parameters.

Rule ID
Enter the business rules of the corresponding process step that can be
bypassed if required.
Comment Required
Select this check box to determine that a comment is required before
bypassing or reactivating a business rule.
Active
Select this check box to set the bypassing of a business rule to active. Clear
the check box to set the bypassing to inactive.

254 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

7.1.8.7 Maintaining rules that are excluded from simulation in the Info
pane and Check messages popup
You can exclude one or multiple business rules from the simulation in the info pane
of the SAP GUI processing screen as well as from the Fiori task app check
messages popup.

The screen and the popup are updated regularly during data indexing.

If you frequently process business rules with complex logic, performance can be
reduced significantly. For example, by calling BAPI functions to simulate document
postings. Therefore, it can be necessary to exclude business rules in certain
constellations and notify the end user that a corresponding business rule is
excluded.

Note: Business rules that are excluded, are still available in the simulate rules
process action. The Simulate process action is executed explicitly. Therefore, it
is not having an ongoing performance impact during data indexing.

To maintain excluded rules:

1. In the Simulate Settings Overview screen mark an entry. For more information,
see “Maintaining simulate settings” on page 253.
2. In the dialog structure double-click Exclude Rule Simulation from Info Pane.
3. In the Exclude Rules Simulation from Info Pane Overview screen, maintain
excluded rules.
Use the following parameter:

Rule ID
Enter the business rules of the excluded process step.

7.1.8.8 Maintaining field settings

You can maintain the business scenario related index data field settings using the
settings described in this section. All maintained settings will be read by the field
handler class and provided to the tab strip subscreens used in the Processing Screen
tab strip area.

To maintain field settings:

1. In the Process Steps Overview screen (see “Defining a process step”

on page 244), mark an entry, and then double-click Field Settings in the Dialog
Structure.
2. In the Field Settings Overview screen, maintain field settings using the
following parameters.

UI Type
Select the UI type from the list. The following values are available.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 255

Chapter 7 Process Configuration

• SAP GUI
• Web

Role ID
Enter the role for which the field settings should be relevant.

Note: If not all roles should have a special simulate settings, you can
leave the Role ID field empty. This simplifies the configuration. This
general setting will then be used for roles that do not have dedicated
field settings. However, as soon as a role specific setting is made, the
general settings will not be considered for this special role anymore.

Field Type
Select the field type from the list. Possible values: Header Field, Item
Field

Field Name
Enter the name of the header field and/or item index data field. The fields
must be available in the header and/or item process ledger table assigned to
the used business scenario.

Field Status
Select one of the following field status values from the list:

• Input

• Required

• Hide

• Display Only

Notes

• The field statuses Input, Required, and Display Only are only
evaluated if the current agent role opens the Processing Screen in
change mode.

• Field status settings for the Fiori screens are intended for future use.
They currently only support read-only fields.

Sequence
This setting is only relevant for the UI type Mobile.
Define the sequence of index data fields within the Fiori screens.

Mobile Priority
This setting is only relevant for the UI type Mobile.
Select this check box for the fields that should always be displayed in the
Fiori screens without the need to switch to the detail view.

256 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.1. Profile configuration

7.1.8.9 Maintaining screen settings

By maintaining the screen settings. you can configure some general parameters for
the Processing Screen.

To maintain screen settings:

1. In the Process Steps Overview screen (see “Defining a process step”

on page 244), mark an entry, and then double-click Screen Settings in the
Dialog Structure.

2. In the Screen Settings Overview screen, maintain screen settings using the
following parameters.

UI Type
Select the UI type from the list. The following values are available.

• SAP GUI

• Web

Note: Screen settings for the Fiori screens are intended for future
use only. They are not evaluated so far.

Role ID
Enter the role for which the screen settings should be relevant.

Note: If not all roles should have special screen settings, you can leave
the Role ID field empty. This simplifies the configuration. This
general setting will then be used for roles that do not have dedicated
screen settings. However, as soon as a role specific setting is made, the
general settings will not be considered for this special role anymore.

Initial Tab
Select the initial tab from the list. This defines which tab of the tab strip
containing the index data fields is the starting point when opening a process
step. You can select from of a maximum of 6 available tabs.

Allow Changes
Select this check box to determine that an agent role is allowed to change
data.
As soon as a role is not allowed to perform changes, the screen field settings
Input, Required, and Display Only are not relevant anymore.

Display Image
Select this check box to determine that the scanned image is automatically
opened and closed in a separate window when executing a process step.
This is independent form the currently chosen detail pane plug-in, which
could be Display Image at the same time as well.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 257

Chapter 7 Process Configuration

7.1.9 Configuring PDF history

In this step, you configure PDF history settings. The inbound and process history of
the document is attached as a PDF file when the process is ended, by posting or
obsoleting.

To configure PDF history:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click Process Configuration > Profiles.

3. On the Profile Configuration Overview screen, mark a profile.

4. Double-click Version Definition in the Dialog Structure.

5. On the Version Definition Details screen, mark a version and double-

click Characteristic Configuration in the Dialog Structure.

6. Mark a Characteristic in the Dialog Structure and double-click Archive History

Definition.

7. On the Archive History Definition Overview screen, configure PDF history

settings, using the following parameters:

Smartform
Enter a valid smartform.
Default value: /OTX/PF04_SF_PDF_HIST
If the standard smartform needs to be changed for any reasons, copy it to a
customer specific smartform. Carry out changes in the customer specific
smartform.
Language Key
Enter a valid language key. Only English is valid.
Default value: EN
Document Type
Enter the solution specific history document type.

Example: /OTBC/1DN3 (for delivery notes)

Enrichment Class
Enter a valid enrichment class for the header fields.
Default value: /OTX/PS00_CL_PDF_HEADER
Active
Select this check box to set the creation of PDF history for the profile to
active. Clear the check box to set the creation of PDF history for the profile
to inactive.

258 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.2. Profile assignment

7.1.9.1 Maintaining archive history header fields

To maintain archive history header fields:

1. On the Archive History Definition screen, mark an entry.

2. Double-click Archive History Header Field Definition in the dialog structure.
3. On the Archive History Header Field Definition screen, maintain header
fields, using the following parameters:

Field Name
Enter the name of the header field. The fields must be available in the
header process ledger table assigned to the used business scenario.
Sequence
Define the sequence of header data fields on the PDF history.
Description
If you do not like the header field description on the PDF history, you can
define new names up to a length of 30 characters.

7.2 Profile assignment

Within the profile assignment, a Process Configuration profile is assigned to a
Process Foundation profile.

• The Process Foundation profile covers the technical SAP Business Workflow
requirements.
• The Process Configuration profile mainly focuses on pure business scenario
related aspects.

You can make the profile assignment static by maintaining a fixed one-to-one
relationship. You can make it dynamic by maintaining a flexible one-to-n
relationship between Process Foundation profile and Process Configuration profile.
In general, no dynamic profile assignment is required. This would only make sense
if multiple Process Configuration profiles should be processed by one Process
Foundation profile due to any reasons.

To maintain the profile assignment:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click Process Configuration > Profile Assignment.
3. In the Profile Assignment Overview screen, maintain the profile assignment
using the following parameters.

PF Profile
Enter the name of the corresponding Process Foundation profile, which
covers the technical SAP Business Workflow aspects.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 259

Chapter 7 Process Configuration

PC Profile
In case of a fixed one-to-one assignment, enter the name of the Process
Configuration profile, which handles the business scenario requirements.

Profile Determination Class

If a dynamic Process Configuration profile determination is required, enter
a suitable profile determination class. The profile determination class
always must be inherited from the /OTX/PF04_CL_PROFILE_DETERMINE
class. The following method must be redefined as needed.

PROFILE_DETERMINE
This method allows to implement any custom logic to dynamically
determine a Process Configuration profile and version.
This method is called by the Process Foundation when initializing the
Process Configuration profile.

Parameter Parameter type Description

PIS_HEAD Importing Process ledger header data
to be used but not changed
PIT_ITEM Importing Process ledger item data to
be used but not changed
PE_PROFILE_ID Exporting Determined Process
Configuration profile ID
PE_VERSION Exporting Determined Process
Configuration profile
version (this must be the
currently active version)

7.3 Authorizations
During processing of dialog work items, the standard authorization object J_6NPF_
PRF is checked. Therefore, it must be implemented using suitable authorization roles
or profiles. The /OTX/PF04_ADM_ROLE transaction also uses the authorization object
to check if administration authorizations are available.

The authorization object J_6NPF_PRF offers the following authorization fields:

J_6NPF_PRF
Process Configuration profile ID

J_6NPF_CH
Current characteristic value

J_6NPF_CAT
Current process step

260 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 7.3. Authorizations

ACTVT
Activity (02 - Change, 03 - Display, 70 - Administer)

VIM200405-CGF-EN-02 Configuration Guide for Foundation 261

Chapter 8
Workplace Configuration

The VIM Central Workplace is the central tool to process work objects in Business
Center.

• It allows you to switch between work centers, and to navigate in a process-

dependent tree.
• It provides access to different business objects.
• It enables you to access an inbox with personal and shared work item lists.
• It provides status information for all objects in process.
• It includes selection screens, where you can restrict entries to be displayed in a
dashboard. Each work object type has a different selection screen. Entries in the
dashboard (ALV grid) are selected when you click the node. The selection screen
is not required for this. You can use the selection screen to filter or restrict objects
at the data selection.
The entries in the ALV grid can stand for tasks, documents, business objects,
finished processes, and so on.
• It provides the detail pane where, for example, document image, process history,
and other plug-ins (depending on the work object) are shown. For more
information, see “Configuring plug-in integration” on page 26.

Areas The following screen areas are available. Together, they form the overall appearance
of the VIM Central Workplace screen during runtime:

VIM200405-CGF-EN-02 Configuration Guide for Foundation 263

Chapter 8 Workplace Configuration

Navigation - Work Centers

A work center can include a single work object or many work objects. They
allow to access data in a structured way and according to authority.
Notes

• A maximum of seven different work centers are displayed as navigation

buttons. If a user has authority for more than seven work centers, a list
will appear.
• You can configure that the work centers are always displayed as a list. In
the user profile, set the user parameter /OTX/PF03_WP_DISPLAY to the
value LIST. If you do not set this parameter, the list will only appear if
eight or more work centers are available for the user.
• Users might be authorized for only one work center. In this case, the
work center list is not visible, but the user’s work center is selected
directly.
Navigation - Nodes
Nodes provide access to one or more different work objects and different data in
a structured way. Access is provided according to the configured selection
criteria. Nodes can be displayed statically according to the configuration. They
can also be determined dynamically during runtime.
Work Object Functions
For each work object, you can maintain functions. A function can call a
transaction, a report, or any other implemented logic, according to the work
object.

264 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 Work Object List
The work object list shows you all data for a specific work object’s node. The
data is displayed in an ALV table view. In the work object list, you can have
different actions. They can be executed for one work object type.
Selection
For each work object, you can define a selection screen to execute a selection.
Therefore, the pre-selected list of work objects according to the node will be
selected. Thereby, the additional selection parameters of the selection screen are
used.
Detail Pane
Additional work object context information is displayed in the detail pane area.
Therefore, the processing plug-in concept is used. For more information, see
“Configuring plug-in integration” on page 26.

Access To access the VIM Central Workplace, run the /n/OTX/PF03_WP transaction. For a
description how to work with the VIM Central Workplace as an end user, see
Section 2 “VIM Central Workplace” in OpenText Vendor Invoice Management for SAP
Solutions - User Guide for Solutions Beyond Invoice (BOCP-UGD).

Important
To use VIM Central Workplace in a proper way, a minimum screen resolution
of 1600 x 900 is required.

This section provides information how the VIM Central Workplace is configured.
This happens in the Workplace Configuration branch of the /n/OTX/PF00_IMG
transaction.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 265

Chapter 8 Workplace Configuration

8.1 Work object types

A work object type represents a processing object within the VIM Central
Workplace. Thereby the work object type can represent a process object, a SAP
business object, or information from any SAP tables.

A work object is defined by the data selection, by the display of the data, and by
actions and functions.

8.1.1 Defining work object types

In this step, you define the selection, display, and processing of work objects.

To define work object types:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Workplace

Configuration > Work object types > Work object types.

3. In the Work Object Types Overview screen, double-click a work object type.

266 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.1. Work object types

4. Define the work object type, using the following parameters:

Description
Enter a meaningful description of the work object type.

Authorization Exit
Enter the exit for additional authorization checks. This exit implements
interface /OTX/PF03_IF_AUTH_WOBJ_TYPE. For more information, see
“Authorization Exit” on page 269.

Handler class
Enter the class for data selection. This class is called for the selection of data
for the work object type. The class implements the /OTX/PF03_IF_WOBJ_
HANDLER interface. Class /OTX/PF03_CL_DATA_HANDLER_DYN allows a
dynamic data selection without implementation effort. For more
information, see “Handler class” on page 271.
Important
OpenText strongly advises against using the dynamic data handler for
the data access in remote systems. In case of data selection from
remote systems, you must create your own implementation of the /
OTX/PF03_IF_WOBJ_HANDLER interface.

Selection Exit
Enter the user exit to adjust the selection or the selection results before and
after the selection. Interface: /OTX/PF03_IF_CHANGE_SELECT. For more
information, see “Selection Exit” on page 274

VIM200405-CGF-EN-02 Configuration Guide for Foundation 267

Chapter 8 Workplace Configuration

Display class
Enter the class for the display of selected objects of the work object type, for
example in the ALV grid or in the tree. This class also displays information
in the detail pane. The class implements the /OTX/PF03_IF_UI_DATA_VIEW
interface. Class /OTX/PF03_CL_DATA_VIEWER_ALV allows a dynamic object
display without implementation effort. For more information, see “Display
class” on page 276.

Class: Change ALV

Enter the exit to change the ALV layout. This is only used if the /OTX/PF03_
CL_DATA_VIEWER_ALV class is used as display class. For more information,
see “Class: Change ALV” on page 278.

Display structure
Enter the display structure to define the fields of the work object.
Important
The display structure must be flat and have the following fields:

Field name Data Type

WOBJ_ID /OTX/PF03_E_WOBJ_ID
WOBJ_LOGSYS LOGSYS

Item structure
Define the display structure of the items.

Variant handle
Enter the identification number (Handle ID). If the same display class is
used in several work object types, this number allows to save work object
type specific variants for ALV grids.
If you use the /OTX/PF03_CL_DATA_VIEWER_ALV display class, set this
parameter. It must be unique.

Data selection structure

Enter the structure to define the selection fields. These fields can be
considered as selection conditions by the Handler class. The display
structure will include text fields that should not be used as selection fields.

Report ID screen
Enter the report that contains the selection screen. For more information, see
“Report ID screen” on page 280.

Screen number
Enter the Dynpro number that shall be called for the display of the selection
screen. Before and after displaying the selection screen, there is a certain
processing logic, dependent on the structure of the selection screens.
Selection screens are normally generated. Therefore, this logic cannot be
implemented directly in the selection screen. The selection screen is not
called directly but it is wrapped with another screen.

268 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.1. Work object types

Variant screen
Enter the actual Dynpro number of the selection screen. This number is set
in the dialog boxes for processing variants. It saves the user from selecting
the correct screen if several selection screens are linked with the Report ID
screen program.
Display details
Select this check box to display the detail pane when initially calling the
VIM Central Workplace with the related work object.
Plug-In Type
Enter the plug-in type that should be displayed in the detail pane. The plug-
in type is used by the /OTX/PF03_CL_DATA_VIEWER_ALV class. For more
information, see “Configuring plug-in integration” on page 26.
Plug-In ID
Enter the plug-in ID that is selected by default.

8.1.1.1 Field details in work object type customizing

This section provides details about the fields that are available in work object type
customizing.

8.1.1.1.1 Authorization Exit

This customizing allows you to activate a work object type specific user exit for
authorization checks. This exit is called after the check on the standard authorization
object J_6NPF_WTY. You can overwrite the result of the standard authorization check
with this user exit. This user exit implementation needs to implement interface /
OTX/PF03_IF_AUTH_WOBJ_TYPE.

Methods of interface /OTX/PF03_IF_AUTH_WOBJ_TYPE

CHECK_WOBJ_TYPE
This method checks the authorization for the current work object type. This
check is performed when the navigation tree contains nodes which are related to
a work object type. Nodes with a work object type that the user is not authorized
for are not displayed.
The following table shows the parameters that are available:

Parameter Parameter type Description

PI_WOBJ_TYPE Importing Work object type
PC_AUTHORIZED Changing User is authorized or not. This parameter
contains the result of the standard
authorization check, which can be
overwritten by the user exit.

CHECK_ACTIONS
This method checks the authorization for an action of the work object type. This
check is performed at the display of work objects and before performing an

VIM200405-CGF-EN-02 Configuration Guide for Foundation 269

Chapter 8 Workplace Configuration

action. Actions that the user is not authorized for are not transferred to the
display class.
The following table shows the parameters that are available:

Parameter Parameter type Description

PI_WOBJ_TYPE Importing Work object type
PI_ACTION Importing Action ID
PI_NODE_ID Importing Node in which the action will be available
(optional)
PC_AUTHORIZED Changing User is authorized or not. This parameter
contains the result of the standard
authorization check, which can be
overwritten by the user exit.

CHECK_NODE
This methods checks the authorization for a node which is related to the work
object type. This check is performed when the navigation tree contains nodes
which are related to a work object type. It is also called for nodes requested by
web services. Nodes that the user is not authorized for are not displayed.
The following table shows the parameters that are available:

Parameter Parameter type Description

PI_WOBJ_TYPE Importing Work object type
PI_NODE_ID Importing Node ID
PC_AUTHORIZED Changing User is authorized or not. This parameter
contains the result of the standard
authorization check, which can be
overwritten by the user exit.

CHECK_FUNCTION
This method checks the authorization for work object type functions. This check
is performed when a node that is related to a work object type is selected in the
navigation tree. Only the functions that the user is authorized for are available.
The following table shows the parameters that are available:

Parameter Parameter type Description

PI_WOBJ_TYPE Importing Work object type
PI_FUNCTION_ID Importing Function ID
PC_AUTHORIZED Changing User is authorized or not. This parameter
contains the result of the standard
authorization check, which can be
overwritten by the user exit.

270 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.1. Work object types

8.1.1.1.2 Handler class

For the data selection, each work object type needs a handler class. The standard
handler class is /OTX/PF03_CL_DATA_HANDLER_DYN. This class selects the data as
defined in the dynamic data selection. Using the selection exit enables you to change
the result of the data selection. For more information, see “Defining dynamic data
selection” on page 288.

Alternatively, you can implement your own handler class with interface /OTX/PF03_
IF_WOBJ_HANDLER. Therefore, you must implement the following methods of this
interface:

Methods of interface /OTX/PF03_IF_WOBJ_HANDLER

GET_INSTANCE
This method returns the instance of the handler class.

Parameter Parameter type Description

PI_WOBJ_TYPE Importing Work object type
PI_CLASSNAME Importing Name of the implementing class
PRH_INSTANCE Returning Handler class instance

GET_NUMBER_OF_ENTRIES
This method returns the number of entries for display in the navigation tree.

Parameter Parameter type Description

PIT_SEL Importing Selection criteria for entries
PI_NODE_ID Importing Node ID
PI_COUNT_MODE Importing Indicates which entries must be
counted. Possible values:
BOTH or ALL - Return only
number of all entries
SINGLE - Check if at least one
entry exists
PE_ENTRIES Exporting Number of entries

SELECT_DATA
This method returns data objects. The /OTX/CX_PF03_EXCEPTION exception
displays messages with exception.

Parameter Parameter type Description

PIT_SEL Importing Selection criteria
PI_LOGSYS Importing Logical system

VIM200405-CGF-EN-02 Configuration Guide for Foundation 271

Chapter 8 Workplace Configuration

Parameter Parameter type Description

PI_MAX_HITS Importing Number of hits that should be
selected
PI_SELECT_MODE Importing Selection mode:
COUNT: Only count entries, return
no data
DATA: Only return data
BOTH: Count and return data
PI_NODE_ID Importing Node ID
PIT_ORDER_BY Importing Order by criteria. This parameter
should be used for selection so that
the user gets the most important
entries if the number is restricted.

Note: This parameter can

contain the value PF07_
DEFAULT in the FIELDNAME
field. In this case, the value of
the TABNAME field is empty.
This indicates that, in the Fiori
Task App, the user changed
from a specific sort order back
to the default sort order. The
parameters of the default sort
order are also included in the
PIT_ORDER_BY parameter.
PI_IS_SINGLE_OBJECT Importing This parameter is true when the
selection request is for a single object.
PI_SKIP Importing This parameter is set in case of
paging. These number of entries
should be skipped. Number of
displayed entries is PI_MAX_HITS
minus PI_SKIP.
If the solution implementation does
not skip the entries, this will
automatically be done by the
framework.
PE_ENTRIES Exporting Number of entries
PET_DATA Exporting Data

Parameter PET_DATA is a table of structure /OTX/PF03_S_DATA, which has the

following fields:

Component Description
LOGSYS Logical system ID
ATTRIBUTES Data
Expected is the “Display structure” of the work object type.

272 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.1. Work object types

GET_OBJECTS
This method converts the selected data to instance of class /OTX/PF03_CL_WOBJ.

Parameter Parameter type Description

PIT_DATA Importing Selected data
PRT_OBJECTS Returning Work objects

Note: The most efficient way to implement your own handler class is probably
to inherit from class /OTX/PF03_CL_DATA_HANDLER_DYN. In this case, a
redefinition of the methods SELECT_DATA and GET_NUMBER_OF_ENTRIES
should be sufficient.

Additional methods of interface /OTX/PF03_IF_WOBJ_TYPE – The methods GET_

SELECTION_FMODULE and GET_LOGSYS support a simple redefinition of class /OTX/
PF03_CL_DATA_HANDLER_DYN.

GET_SELECTION_FMODULE
This method returns the name of the function module that is used for the data
selection. The standard implementation of class /OTX/PF03_CL_DATA_HANDLER_
DYN uses function module /OTX/PF03_DATA_SELECT_DYNAMIC for the data
selection. You can copy this function module and implement your own data
selection method.

Important
Do not change the parameters of the function module.

Parameter Parameter type Definition

PR_FMODULE Returning Function module name

GET_LOGSYS
This method returns the logical systems that are used for the data selection. The
standard implementation of class /OTX/PF03_CL_DATA_HANDLER_DYN returns all
logical systems defined for the VIM Foundation. For more information, see
“Configuring logical systems” on page 24. If you want to restrict the logical
systems for a specific work object type, you can redefine this method and restrict
the logical systems.

Parameter Parameter type Definition

PRT_LOGSYS Returning Logical systems

VIM200405-CGF-EN-02 Configuration Guide for Foundation 273

Chapter 8 Workplace Configuration

8.1.1.1.3 Selection Exit

The user exit for data selection is available in the Selection Exit field in work object
type customizing. This user exit enables you to influence the selection criteria before
the data selection and to filter or change the results after the data selection. You
must implement the /OTX/PF03_IF_CHANGE_SELECT interface for this exit.

Methods of interface /OTX/PF03_IF_CHANGE_SELECT

CHANGE_SELECTION_CRITERIA
This method allows to change the selection criteria before the data selection is
performed.

Parameter Parameter type Description

PI_NODE_ID Importing Node ID
PI_LOGSYS Importing Logical system
PCT_SEL Changing Selection criteria
PC_MAX_HITS Changing Maximum hits
PCT_ORDER_BY Changing Order by criteria
PI_APP_MODE Importing Set to true (“X”) when the exit has
been called from the BC Fiori Task
App.
PIS_WOBJ_TYPE Importing Work object type as customized in
current (remote) system

CHANGE_SELECTION_RESULT
This method is called after the data selection. It allows to restrict the data (for
example because of authorization checks) and to add data (for example texts).

Parameter Parameter type Description

PIT_SEL Importing Selection criteria used for the data
selection
PI_MAX_HITS Importing Maximum number of hits
PIT_ORDER_BY Importing Order by criteria
PI_NODE_ID Importing Node ID
PI_LOGSYS Importing Logical system
PCT_DATA Changing Selected data; table has structure of
“Display structure” of the work object
type.
PC_ENTRIES Changing Number of entries
PI_APP_MODE Importing Set to true (“X”) when the exit has
been called from the BC Fiori Task
App.

274 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.1. Work object types

Parameter Parameter type Description

PIS_WOBJ_TYPE Importing Work object type as customized in
current (remote) system

CHANGE_NUMBER_OF_ENTRIES
This method is called when the number of entries is required for a node. It
allows to change the number of entries.

Parameter Parameter type Description

PI_NODE_ID Importing Node ID
PIT_SEL Importing Selection criteria for entries
PC_ENTRIES Changing Number of entries
PI_APP_MODE Importing Set to true (“X”) when the exit has
been called from the BC Fiori Task
App.
PIS_WOBJ_TYPE Importing Work object type as customized in
current (remote) system

CHANGE_DYNAMIC_SELECTION
This method is only called if the /OTX/PF03_CL_DATA_HANDLER_DYN class is
used as data handler. It is called in function module /OTX/PF03_DATA_SELECT_
DYN_RFC, which performs the data selection for this data handler. When you
select data from a remote system, this exit allows you to perform a check of the
selected data in the remote system before the data is transferred to the system
from which the call was started.

Parameter Parameter type Description

PIS_WOBJ_TYPE Importing Work object type as customized in
current (remote) system
PI_MAX_HITS Importing Maximum hits
PI_SELECT_MODE Importing Selection mode:
COUNT: Only count entries, return
no data
DATA: Only return data
BOTH: Count and return data
PIH_SEL_STATEMENT Importing Class with information for dynamic
data selection (as customized in
dynamic data selection)
PCT_DATA Changing Selected data with structure of
“Display structure” of work object
type
PCT_RETURN Changing Messages
PC_ENTRIES Changing Number of selected entries

VIM200405-CGF-EN-02 Configuration Guide for Foundation 275

Chapter 8 Workplace Configuration

Parameter Parameter type Description

PI_APP_MODE Importing Set to true (“X”) when the exit has
been called from the BC Fiori Task
App.

8.1.1.1.4 Display class

As display class for the data of a work object, you can either use the standard class /
OTX/PF03_CL_DATA_VIEWER_ALV, which displays the work objects in an ALV grid.
The standard class can be customized widely. But you can also implement your
custom class for displaying work objects. OpenText recommends that you use
class /OTX/PF03_CL_DATA_VIEWER_ALV.

The custom class must implement the /OTX/PF03_IF_UI_DATA_VIEW interface with

the following methods:

Methods of the /OTX/PF03_IF_UI_DATA_VIEW interface

GET_INSTANCE
This method returns an instance of the data viewer class. The workplace main
application will then use this instance.

Parameter Parameter type Description

PIH_DATA_CONTAINER Importing Container for data pane
PIH_DETAILS_CONTAINER Importing Container for detail pane
PI_DISPLAY_CLASS_NAME Importing Name of display class
PRO_INSTANCE Returning Instance of display class

SET_WOBJ_TYPE
This method sets the work object type of the currently selected node.

Parameter Parameter type Description

PIS_WOBJ_TYPE Importing Work object type

DISPLAY_DATA
This method is called by the framework when a node for this work object type
has been selected and the data for this node should be displayed. The structure
of the PIS_WOBJ_TYPE parameter contains the information about the actions that
are possible for this data. These actions should be made available by the data
viewer.

276 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.1. Work object types

Parameter Parameter Description

type
PIS_WOBJ_TYPE Importing Work object type
customizing
PIS_NODE_INFO Importing Node information
PIH_DATA_CONTAINER Importing Container for data pane
PIH_DETAILS_CONTAINER Importing Container for detail pane
PIT_DATA Importing Data
PIS_WPLACE Importing Work center
PI_MAX_HITS Importing Maximum number of hits
to be displayed
PIT_ORDER_BY Importing Order by criteria (data
should be displayed sorted
this way)
PI_SEL_SCREEN_PARA_APPLIED Importing Data selection restricted by
parameters of selection
screen
PIT_ACTION_RESTRICTIONS Importing Action restrictions on node
level
PIT_FIELD_RESTRICTIONS Importing Fields that should not be
displayed
PI_UI_CONTROLLER_CHANGED Importing UI controller has changed.
If the display class is used
for different work object
types, a refresh is probably
required.

FREE
This method destroys all objects of the data viewer and the instance.
DETAILS_AVAILABLE
The workplace main program checks with this method if the detail pane is
available. If the display class returns in the DETAILS_AVAILABLE method that the
detail pane is not available, the main program will, for example, not offer the
function Display Detail Pane. The standard implementation, for example, sets
the detail pane to not available if no plug-ins are customized for this work object
type.

Parameter Parameter type Description

PR_DETAILS_AVAILABLE Returning Flag if details are available

The /OTX/PF03_IF_UI_DATA_VIEW interface also provides the following events to

react on user inputs.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 277

Chapter 8 Workplace Configuration

USER_COMMAND
Use this event to trigger an action for a work object.

Parameter Description
PI_ACTION Action ID
PI_WOBJ_ID Work object ID

CHANGE_NUMBER_OF_HITS
If the user requires a different number of hits, use this event to send the new
number of hits to the workplace main program. The node is then refreshed with
the new number of hits.

Parameter Description
PI_HITS Number of hits

8.1.1.1.5 Class: Change ALV

You can use this user exit to change the layout of the ALV grid that is generated by
the /OTX/PF03_CL_DATA_VIEWER_ALV class (field Display class in work object type
customizing).

This user exit is called by the /OTX/PF03_CL_DATA_VIEWER_ALV class. It allows to

change the overall appearance of the ALV grid containing the work object types. The
class for this user exit needs to implement the /OTX/PF03_IF_CHANGE_ALV interface.

Methods of the /OTX/PF03_IF_CHANGE_ALV interface

CHANGE_EXCLUDES
Change the excluded functions.

Parameter Parameter type Description

PIS_WOBJ_TYPE Importing Work object type
PIS_NODE_INFO Importing Current node
PIT_DATA Importing Data that will be displayed in the
ALV grid
PIS_WORKPLACE Importing Current work center
PCT_EXCLUDES Changing Functions that will be excluded.
Functions added to this table will not
be available in the ALV grid.

CHANGE_FCAT
Change the field catalog of the ALV grid, for example remove or add fields.

278 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.1. Work object types

Parameter Parameter type Description

PIS_WOBJ_TYPE Importing Work object type
PIS_NODE_INFO Importing Current node
PIT_DATA Importing Data that will be displayed in the
ALV grid
PIS_WORKPLACE Importing Current work center
PCT_FCAT Changing Field catalog of the ALV grid

CHANGE_VARIANT
Change settings for variant usage.

Parameter Parameter type Description

PIS_WOBJ_TYPE Importing Work object type
PIS_NODE_INFO Importing Current node
PIT_DATA Importing Data that will be displayed in the
ALV grid
PIS_WORKPLACE Importing Current work center
PCS_VARIANT Changing Variant settings

CHANGE_LAYOUT
Change layout settings.

Parameter Parameter type Description

PIS_WOBJ_TYPE Importing Work object type
PIS_NODE_INFO Importing Current node
PIT_DATA Importing Data that will be displayed in the
ALV grid
PIS_WORKPLACE Importing Current work center
PCS_LAYOUT Changing Layout settings

CHANGE_TITLE
Change the ALV grid title. The default ALV grid title is the node description.

Parameter Parameter type Description

PIS_WOBJ_TYPE Importing Work object type
PIS_NODE_INFO Importing Current node
PIT_DATA Importing Data that will be displayed in the
ALV grid
PIS_WORKPLACE Importing Current work center

VIM200405-CGF-EN-02 Configuration Guide for Foundation 279

Chapter 8 Workplace Configuration

Parameter Parameter type Description

PC_TITLE Changing ALV grid title

CHANGE_FIELD_VALUES
Change or add field values. All fields available in the display structure of the
work object type will be prefilled with the selection result of the work object
handler.

Note: Use this exit only for ALV grid specific fields. For adding texts and
other general data, use the Selection Exit (interface /OTX/PF03_IF_
CHANGE_SELECT).

Parameter Parameter type Description

PIS_WOBJ_TYPE Importing Work object type
PIS_NODE_INFO Importing Current node
PCS_FIELDS Changing Display structure of work object type

8.1.1.1.6 Report ID screen

This report provides solution or customer specific selection screens for work object
types.

A selection screen allows the user to restrict the objects of a node by further selection
criteria. Selection criteria of the node cannot be overwritten. This means it is only
possible to restrict the selection by further criteria but not to disable selection criteria
defined for the node.

You need a custom program and screen that contain the selection criteria and
parameters.

Tip: A dynpro with several subscreen areas enables you to show select options
and parameters in parallel. Check sample report /OTX/PF32_IDF_SEL_SCREEN
with screen 100.

In the PBO and PAI modules of this selection screen (check sample screen 100 of
the /OTX/PF32_IDF_SEL_SCREEN report), you also must handle the logic for the
following purposes:

• to transfer the selection criteria used by the workplace main program to your
selection screen
• to transfer the selection criteria entered by the user on the selection screen to the
workplace main program

For this communication, the /OTX/PF03_CL_UI_SEL_SCREEN class is used.

280 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.1. Work object types

Methods of the /OTX/PF03_CL_UI_SEL_SCREEN class

GET_CURRENT_INSTANCE
This method returns an instance of the class. This instance contains information
about the selection criteria of the currently selected node and previously added
parameters.

Parameter Parameter type Description

PRH_INSTANCE Returning Class instance

SET_SELECTION_CRITERIA
Use this method to make the selection criteria entered in the selection screen
known to the /OTX/PF03_CL_UI_SEL_SCREEN class. The workplace main
program uses this method to set the initial selection criteria of the current node.

Parameter Parameter type Description

PIT_SEL_CRITERIA Importing Selection criteria
PI_APPLIED Importing Selection is applied

GET_SELECTION_CRITERIA
With this method, you can get the currently used selection criteria. With the first
call, this is only the selection criteria of the current node. With later calls, these
are the selection criteria of the node with additional criteria from the selection
screen.
The selection criteria can contain criteria for selection parameters available on
the screen. In this case, these values should be set in this criteria. The selection
criteria originally defined for the current node can not be overwritten. Therefore,
these selection criteria should additionally be set to not editable.

Parameter Parameter type Description

PRT_SEL_CRITERIA Returning Selection criteria

EXECUTE_USER_ACTION
This method raises an event, which is handled by the workplace main program.

Parameter Parameter type Description

PI_ACTION Importing ID of the event that should be raised.
Currently only the ID SEARCH is available.

PARAMETER_TO_SELOPT
This method converts the select option from external format (entered in the
selection screen) to the internal format, which can be used for data selection. All
selection criteria that you are transferring via the SET_SELECTION_CRITERIA
method must have the internal format.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 281

Chapter 8 Workplace Configuration

Parameter Parameter type Description

PIS_PARAM Importing Select option/parameter
PI_ATTRIBUTE Importing Attribute name
PRS_SEL Returning Selection criteria

SELOPT_TO_PARAMETER
This method transfers a selection criteria to the format of a select option or
parameter.

Parameter Parameter type Description

PIS_SEL Importing Selection criteria
PES_PARAM Exporting Select option/parameter

GET_NODE_SEL_CRITERIA
This method returns the original selection criteria of the current node.

Parameter Parameter type Description

PRT_SEL_CRITERIA Returning Selection criteria

General logic Before the call of your selection screen, the workplace main program transfers the
currently used selection criteria to the instance of the /OTX/PF03_CL_UI_SEL_
SCREEN class. The workplace main program also sets the selection criteria of the
current node.

The workplace main program ignores any changes to the selection criteria of the
current node. This means you can only restrict the result list for the current node but
you cannot select other objects as originally customized for this node. For this
reason, make sure to prevent the change of the node selection criteria at the selection
screen. In the AT-SELECTION-SCREEN section, the select-options that are used in the
selection criteria of the current node (GET_NODE_SEL_CRITERIA method) can be read,
and these select-options can either be disabled or hidden.

In the PBO module, you must set the currently used selection criteria.

• GET_SELECTION_CRITERIA method to get them

• SELOPT_TO_PARAMETER method to transfer them to the select option format

In the PAI module, you must handle the customer actions, for example the execution
of the search. You must make the selection criteria from the selection screen known
to the /OTX/PF03_CL_UI_SEL_SCREEN class:

• PARAMETER_TO_SELOPT method to transfer the selection criteria to the correct

format
• SET_SELECTION_CRITERIA method to set the selection criteria

282 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.1. Work object types

Then you raise the SEARCH action using the EXECUTE_USER_ACTION method.

8.1.1.2 Defining actions for a work object type

In this step, you define actions that are available for a work object type. Actions are
functions that can be performed on a work object while the work object is displayed
using the display class.

To define actions for a work object type:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Workplace
Configuration > Work object types > Work object types.
3. In the Work Object Types Overview screen, mark a work object type, and then
double-click Actions in the Dialog Structure.

4. In the Actions Overview screen, define actions, using the following parameters:

Action
Enter the ID of the action.
Button type
Define the display of the action in the ALV grid. Possible values:

• Button in ALV toolbar

• Button in ALV row
Field must have type CHAR50 (character with length 50).
• Hyperlink in ALV row

Button column
Enter the column in which the action should be displayed as hyperlink or
inline button.
Type
Define the action type. Possible values:

VIM200405-CGF-EN-02 Configuration Guide for Foundation 283

Chapter 8 Workplace Configuration

• Standard
• Bulk
• Emphasized Bulk: most important bulk actions, with a separate button
in the ALV grid control
• Object independent: Allows execution of actions without selected item

Action class
Enter the action class, implementing class interface /OTX/PF03_IF_ACTION.
For more information, see “Interface /OTX/PF03_IF_ACTION” on page 285.
Default
Select this check box to mark the action as default action. If the /OTX/PF03_
CL_DATA_VIEWER_ALV class is used as display class, this action will be
performed at a double-click on the ALV grid line.
Icon ID
Enter the icon for the action.
Icon text
Enter the text for the action.
Position
Define the sort order of the available actions of type Button in ALV
toolbar. The buttons are sorted in the ALV toolbar by their position value.

The display class of the work object type must provide the actions to the user.
Therefore, it depends on the implementation of the display class if and how the
actions are provided.
The /OTX/PF03_CL_DATA_VIEWER_ALV class automatically considers this
customizing.

To define message fields for bulk actions:

1. In the Actions Overview screen, mark an action, and then double-click Message
fields for bulk actions in the Dialog Structure.

2. In the Message fields for bulk actions Overview screen, enter one or more field
names (of the display structure) that are relevant for the end user in the context
of bulk action messages. The entered fields are displayed in success or error
messages that users get when performing bulk actions.

Example: You can enter the registration ID of the incoming document or the customer
name to be displayed in messages.

284 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.1. Work object types

8.1.1.2.1 Interface /OTX/PF03_IF_ACTION

EXECUTE_ACTION method
Called at the execution of single and bulk actions.

Parameter Parameter type Description

PI_BULK Importing Action is a bulk action
PI_ACTION Importing Action of application
PIS_WOBJ_TYPE Importing Work object type
PE_EXECUTE_REFRESH Exporting Refresh object list
PCT_ACTIONS Changing Messages for the executed actions

Exception /OTX/CX_PF03_EXCEPTION can be raised. The message of this

exception is then displayed.

EXECUTE_OBJ_IND_ACTION method
Called at the execution of single and bulk actions.

Parameter Parameter type Description

PI_BULK Importing Action is a bulk action
PI_ACTION Importing Action of application
PIS_WOBJ_TYPE Importing Work object type
PE_EXECUTE_REFRESH Exporting Refresh object list
PCT_ACTIONS Changing Messages for the executed actions

CHANGE_MESSAGE_DISPLAY method
Called for object independent actions. The /OTX/CX_PF03_EXCEPTION
exception can be raised with a message for this exception.

Parameter Parameter type Description

PI_ACTION Importing Action of application
PIS_WOBJ_TYPE Importing Work object type
PE_EXECUTE_REFRESH Exporting Refresh object list
PES_MSG Exporting Message for the executed action

VIM200405-CGF-EN-02 Configuration Guide for Foundation 285

Chapter 8 Workplace Configuration

8.1.1.3 Defining functions for a work object type

In this step, you define the functions that are available for a work object type.

Functions are global actions that are not related to one specific work object type
using the display class. A function allows to access transactions, reports, or jobs that
are related to the work object type as a whole. For example for Sales Orders, call the
VKM1 transaction to display all blocked sales orders.

To define functions for a work object type:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Workplace

Configuration > Work object types > Work object types.

3. In the Work Object Types Overview screen, mark a work object type, and then
double-click Functions in the Dialog Structure.

4. In the Functions Overview screen, define functions, using the following

parameters:

Function ID
ID of the function
Function Module
Enter a function module that implements the functionality of the function.
The interface of the function module has no parameters.
Description
Enter a description for the function.

8.1.1.4 Defining ALV grid field settings

In this step, you define the display of fields in the ALV grid, display class /OTX/
PF03_CL_DATA_VIEWER_ALV.

To define ALV grid field settings:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Workplace

Configuration > Work object types > Work object types.

3. In the Work Object Types Overview screen, mark a work object type, and then
double-click ALV Grid Field Settings in the Dialog Structure.

4. In the ALV Grid Field Settings Overview screen, define the settings, using the
following parameters:

Field Name
Name of the field in the display structure

286 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.1. Work object types

Key Field
Select this check box to mark the field as key field. The field will be
highlighted in the ALV display as key field, and the column will be fixed.
Style
Define the field style. Possible values:

• None
• Hyperlink
• Icon
• Checkbox

Status
Define the field status. Possible values:

• Display
• Hide
• Available

Column width
Enter the column width.
This parameter defines the width of the column in the ALV table control
layout for display.
Column no.
Enter the column position.
This parameter defines the default position of the column in the ALV table
control layout for display.
The display class of the work object type must provide the field settings.
The /OTX/PF03_CL_DATA_VIEWER_ALV class automatically considers this
customizing.
Name of the column
Enter the column name.
If you do not enter a specific name, the related information of the data
element is used.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 287

Chapter 8 Workplace Configuration

8.1.1.5 Defining the number of hits for the ALV grid

In this step, you define custom settings for the number of hits list. This is only used
if the standard ALV grid class /OTX/PF03_CL_DATA_VIEWER_ALV is used as the
display class of the work object type. If you do not maintain the customizing, the
standard configuration is used.

To define the number of hits for the ALV grid:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Workplace
Configuration > Work object types > Work object types.

3. In the Work Object Types Overview screen, mark a work object type, and then
double-click ALV Grid - Number of hits in the Dialog Structure.

4. In the ALV Grid - Number of hits Overview screen, define the settings for the
number of hits using the following parameters:

ID for number of hit entry

ID for an entry in the number of hits list.
Default number of hits
Enter the default number of the entry.
Text
Enter the text that is displayed for the entry in the number of hits list.
Note: The number of hits within the workplace is stored for each user
after his selection. To reset the number of hits and to use the default,
run the /OTX/PF03_WP_ADMIN transaction for the related user(s).

8.1.2 Defining dynamic data selection

In this step, you define the data selection (join) for the data handler class /OTX/
PF03_CL_DATA_HANDLER_DYN.

To define dynamic data selection:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Workplace

Configuration > Work object types > Dynamic data selection.

288 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.1. Work object types

3. Basic Settings
In the Work Object Type Overview screen, mark a work object type, and then
double-click Basic Settings in the Dialog Structure.

4. In the Basic Settings Details screen, refine the dynamic data selection and
counting, using the following parameters.

Use ‘DISTINCT’
To determine that the selection will be executed with DISTINCT statement,
select this check box. This means that entries which have the same values in
all selected fields are only displayed once.

Counting field
The counting of entries will only count entries that have different values in
this field. For the counting, this provides the same logic as the DISTINCT
statement for the data selection.

Example: Process steps might be assigned to several users. If you want to show personal
tasks (process steps) for a user, you must include the table with the user assignment in
the dynamic data selection definitions. However, for nodes that are not restricted for a
user, this would mean that a process step is displayed several times (for each user
assignment). You can handle this case by activating the DISTINCT statement and using,
for example, the process step ID as counting field.

5. CDS Views
[In SAP S/4HANA systems]: In the Work Object Type Overview screen, mark a
work object type, and then double-click CDS Views in the Dialog Structure.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 289

Chapter 8 Workplace Configuration

If a CDS view is defined, the table related settings are ignored and only the CDS
view is used for the dynamic data selection.
The display structure of the work object has still to be a DDIC structure. Only
fields of the display structure that fit to the element names of the CDS views
will be filled.

6. Logical Systems
In this setting, the logical system from where data is selected is maintained. If
no logical system is maintained, the data is selected from the LOCAL system. If
the data is selected from a logical and a local system, both systems should be
maintained in the settings.

7. Tables
In the Work Object Type Overview screen, mark a work object type, and then
double-click Tables in the Dialog Structure.

8. Enter all tables that are used for data selection, using the following parameters.

Table name
Enter the name of the table.
Alias
Enter the table alias. Each table must have a unique alias, for example A, B,
or C.

9. Table joins
In the Work Object Type Overview screen, mark a work object type, and then
double-click Table joins in the Dialog Structure.

10. Define how tables are joined, using the following parameters.

Left table
Enter the table that should be joined.
Right table
Enter the table that joins.
Outer join
Select this check box to achieve that an outer join is used if possible. This
means that the fields of the right table are not used in the selection criteria.

11. Join conditions

In the Table joins Overview screen, select an entry, and then double-click Join
conditions in the Dialog Structure.

12. Define the join conditions for the table join, using the following parameters.

Left table
Table that should be joined

290 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.1. Work object types

Right table
Table that joins
Field of left table
Field of the table that should be joined
Field of right table
Enter the field of the table that joins.

13. Table fields

In the Work Object Type Overview screen, mark a work object type, and then
double-click Table fields in the Dialog Structure.
14. Define the table fields to be selected, using the following parameters.

Table Name
Name of the table
Field Name
Name of the field
Is descriptive
Marks this field if you want to use the content of this field to describe the
object in system messages.

8.1.3 Defining the work object type association

In this step, you define the relationships between work object types. For example,
you can use an association to define the relationship between a header object and its
line items. In the data binding for view view.item.AdvLineItems of the Fiori Task
App, this association can then be used to display these line items. For more
information, see “Configuring advanced line items binding in the Perspective
Editor” on page 415.

To define the association of work object types:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Workplace
Configuration > Work object types > Work Object Type Association.
3. On the Work Object Type Association screen, define the work object type
association, using the following parameters:

Association Name
ID of the association
Workobject type
Parent work object type
Associated work object type
Associated work object type

VIM200405-CGF-EN-02 Configuration Guide for Foundation 291

Chapter 8 Workplace Configuration

Card.
Cardinality of the relationship (1:1 or 1:N )

4. Association Constraints
Mark an association, and then double-click Association Constraints in the
Dialog Structure.

5. On the Association Constraints Details screen, define the field relationships of

the selection structures of the 2 work object types. These definitions are used to
select the associated work objects for a parent work object. Use the following
parameters:

Field Name
Field name of the parent work object type

Associated Field
Field name of the associated work object type

6. Additional Constraints
Double-click Additional Constraints in the Dialog Structure

7. On the Additional Constraints screen, configure additional constraints to

restrict the associated work objects, using the following parameters:

ID
Criteria ID. Provide a unique ID for each criteria.

Attribute
Attribute of the associated work object type. Enter the field of the Data
selection structure of this work object type.

Sign
Enter I or E for an (I)nclude or (E)xclude condition.

Option
Enter the option of the condition (EQ, BT, NE, …)

Value low
Enter the lower selection value.

Value high
Enter the higher selection value.

Exit for dynamic filter criteria

Enter a user exit that allows adjusting the filter criterion dynamically at
runtime or replacing the filter criterion by one or more filter criteria. This
enables you to consider the current user or date in the filter criteria. This
exit must implement /OTX/PF03_IF_SEL_CRITERIA. For more information,
see “Exit for dynamic filter criteria” on page 293.

292 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.2. Exit for dynamic filter criteria

8.1.4 Checking the configuration of work object types

You can check the configuration of selected work object types with the transaction /
OTX/PF63_CHECK.

Select the WorkObjectType on the selection screen.

The report checks for the selected work object types and displays the results in a list.

When executed, this report checks the J_6NPF_ADM authorization object, J_6NPF_
COM (Component) field, for the value 4 (Web UI).

8.2 Exit for dynamic filter criteria

Sometimes you must define nodes that have selection criteria that can fully be
determined at runtime; for example, a node that shows only tasks assigned to the
current user or tasks that were created within the last 30 days. For this reason, the
Exit for dynamic filter criteria is available. This exit is called before the data
selection of the node. It allows to change the selection criteria so that system
parameters like user name or current date can be considered in these criteria.

This exit implements the /OTX/PF03_IF_SEL_CRITERIA interface, which contains

the CHANGE_SEL_CRITERIA method with the following parameters.

Parameter Description
PIS_WOBJ_TYPE Work object type customizing
PIS_NODE Configuration of current node
PI_SEL_CRITERIA_TYPE Type of selection criteria:
NORM: Normal entries
PIS_DYNAMIC_NODE Dynamic node configuration - only filled if the exit is
called in the context of a dynamic node
PCT_SEL Selection criteria of the node. Prefilled with the
customized selection criteria.

8.3 Navigation
The navigation defines the particular queues and folders in the VIM Central
Workplace. Within the VIM Central Workplace, the navigation defines the specific
data selection within a queue. It also defines the hierarchical levels and the global
structure of the VIM Central Workplace. Nodes are also used in the Fiori Task App.

Customizing the navigation comprises the following steps:

• “Defining nodes” on page 294

• “Defining the navigation structure” on page 298
• “Defining work centers” on page 302

VIM200405-CGF-EN-02 Configuration Guide for Foundation 293

Chapter 8 Workplace Configuration

8.3.1 Defining nodes

In this step, you define the nodes that can be used in a navigation structure. Further
customizing is necessary for filter criteria, order by, action restrictions, and field
restrictions, which are described in subsections.

To define nodes:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Workplace
Configuration > Navigation > Nodes.

3. Define nodes, using the following parameters.

Node ID
Unique ID of the node
Workobject type
Work object type that is processed by the node if data access is available.
Structural nodes without work object types are possible, as well.
Active
Select this check box to activate a node in order to display it in the VIM
Central Workplace. Clear the check box to deactivate the node.
Node description
Enter the text that is displayed in the structure for the node.
Userexit for dynamic nodes
Enter the user exit that allows to add one or more nodes at runtime. In a
navigation structure, this node replaces the current node. This exit must
implement the /OTX/PF03_IF_DYNAMIC_NODE interface. For more
information, see “User exit for dynamic nodes” on page 297.

The detailed configuration of the nodes for restrictions, filter, and order criteria
are implemented in the delivered handler class /OTX/PF03_CL_DATA_HANDLER_

294 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.3. Navigation

DYN and display class /OTX/PF03_CL_DATA_VIEWER_ALV. A custom data handler

or display handler must implement corresponding logic to use all additional
settings.

8.3.1.1 Defining filter criteria

In this step, you define filter criteria that define which data should be displayed for a
node.

To define filter criteria:

1. In the Nodes Overview screen, select a line, and then double-click Filter criteria
in the Dialog Structure.

2. In the Filter criteria Overview screen, define the filter criteria, using the
following parameters.

ID
Criteria ID. Enter the ID of the filter condition (values: 00 to 99)
Each entry is taken into account with an OR connection. For different
attributes, an AND connection is used.
Attribute
Enter the field of the Data selection structure of this work object type.
Sign
Enter I or E for an (I)nclude or (E)xclude condition.
Option
Enter the option of the condition (EQ, BT, NE, …)
Value low
Enter the lower selection value.
Value high
Enter the higher selection value.
Exit for dynamic filter criteria
Enter a user exit that allows adjusting the filter criterion dynamically at
runtime or replacing the filter criterion by one or more filter criteria. This
enables you to consider the current user or date in the filter criteria. This
exit must implement /OTX/PF03_IF_SEL_CRITERIA. For more information,
see “Exit for dynamic filter criteria” on page 293.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 295

Chapter 8 Workplace Configuration

8.3.1.2 Defining the order

In this step, you define field and direction by which the data is ordered at data
selection and dynpro.

To define the order:

1. In the Nodes Overview screen, select a line, and then double-click Order by in
the Dialog Structure.

2. In the Order by Overview screen, define Order by, using the following
parameters.

Priority
Order priority
Table Name
Name of the table from which the field is selected
Field Name
Name of the selected field
Asc./Desc.
Select the sort order: Descending or Ascending

8.3.1.3 Defining action restrictions

In this step, you define actions that are generally available for the work object type
but should not be available at this node.

To define action restrictions:

1. In the Nodes Overview screen, select a line, and then double-click Action
restrictions in the Dialog Structure.

2. In the Action restrictions Overview screen, define the actions that should not
be available, using the following parameter.

Action
ID of the action that should be excluded

296 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.3. Navigation

8.3.1.4 Defining field restrictions

In this step, you define fields of the display structure that should not be displayed at
this node. For the /OTX/PF03_CL_DATA_VIEWER_ALV display class, this refers to
fields that are defined as visible in the ALV Grid Field Settings customizing.

To define field restrictions:

1. In the Nodes Overview screen, select a line, and then double-click Field
restrictions in the Dialog Structure.

2. Define field restrictions, using the following parameter.

Field Name
Name of the field that should be excluded

8.3.1.5 User exit for dynamic nodes

Dynamic nodes enable you to add and change nodes at runtime. You just need a
class which uses the /OTX/PF03_IF_DYNAMIC_NODE interface. In the SET_DYNAMIC_
NODES method, you must implement the logic how the node should be changed and
which nodes should be added.

The following table shows the parameters of the SET_DYNAMIC_NODES method.

Parameter Parameter type Description

PIS_TOP_NODE Importing Customizing of the top node
PIS_NODE Importing Customizing of the current node
(which has the dynamic node exit)
PRT_DYNAMIC_NODES Returning Dynamic nodes that you want to
add to the navigation tree

The import parameter PIS_TOP_NODE provides all available information about the
top node under which your dynamic nodes will be added. This enables you to
determine the positions of the nodes in the tree. With parameter PIS_NODE, you get
the customizing of your dynamic node because it is customized in the navigation
structure. You must transfer the complete customizing that should be used for the
dynamic nodes to the PRT_DYNAMIC_NODES parameter. Only the content of this
parameter defines the dynamic nodes. Nevertheless OpenText recommends that you
define the node in the customizing as detailed as possible so that you can simply
copy these parts to the dynamic nodes.

The PRT_DYNAMIC_NODES parameter is a table with the following structure.

Parameter Description
DISPLAY_POS Position which this node should have (in relation to the
other added nodes)

VIM200405-CGF-EN-02 Configuration Guide for Foundation 297

Chapter 8 Workplace Configuration

Parameter Description
WOBJ_TYPE Work object type
DISPLAY_NUMBERS Indicator if number entries are displayed next to the
folder in the tree. Possible vales:
CURR: number of entries of current node
SUB: number of entries for all sub nodes which have
option CURR
<space>: number of entries is not displayed
DESCRIPTION Text of the node
NODE_ICON Icon to be shown in front of the node
DEF_SEL_SCREEN Selection screen is displayed by default.
DISPLAY_DATA Display data for this node
DEFAULT_NODE This node is a default node. At the initial display of the
navigation tree, this will be marked and the data will be
displayed.
DISP_NODE_WO_DAT Show node also if no data is available for this node or
any of its sub-nodes.
DOWN_CRIT Inherit selection criteria of this node to all of its sub
nodes.
SEL_CRITERIA Selection criteria for data of this node
ORDER_BY Criteria for ordering the data of this node. Data will also
be selected in this order.
FIELD_RESTRICTIONS Field restriction. Define which fields, that normally
available for this work object type, should not be
displayed at this node.
ACTION_RESTRICTIONS Define the work object type actions which are not
available for this node.

8.3.2 Defining the navigation structure

In this step, you define the order of nodes within a structure. You can optionally
map the nodes of the first and second structure level by filter options. A structure
can have a maximum depth of 5 levels.

To define the navigation structure:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Workplace

Configuration > Navigation > Navigation structure.

298 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.3. Navigation

3. In the Configuration Overview screen, define the navigation structure, using

the following parameters.

Configuration ID
ID of the structure
Configuration description
Enter description text.
Type
Select the filter type. The following options are available.
<Empty> (no value)
Default option. No filter is displayed.
Filter for work object types
This setting activates the 1st filter option for the work object types of the
top level node (nodes of level 0). The filter offers the work object types
of the nodes of level 0.

Example: If you have different work object types (for example Sales Order or
Quotation), you will get these work objects as filter criteria for your work
center.

Filter on node level

This setting activates the 1st filter option for the top level nodes (nodes
of level 0). The filter offers the nodes of level 0.

Example: If you have different nodes on top level 0 to show different

information (for example vendor or customer) you can use all nodes of level 0
as filter criteria for your work center.

2nd filter
Select this check box to activate the 2nd filter option.

• The 1st filter option is set to Filter for work object types. In this
case, the 2nd filter offers those nodes on level 1 that are assigned to the
work object type chosen in the 1st filter.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 299

Chapter 8 Workplace Configuration

• The 1st filter option is set to Filter on node level. In this case, the 2nd
filter offers those nodes on level 2 that have the node chosen in the 1st
filter as top node.

Selecting this check box without selecting a Type has no effect.

Filter Label
Enter text for the label of filter option at node level 1.

8.3.2.1 Defining top nodes on level 0

In this step, you define the top level of the structure.

To define top nodes:

1. In the Configuration Overview screen, select a line, and then double-click Top
nodes - level 0 in the Dialog Structure.

2. Define top nodes on level 0, using the following parameters.

Position
Position of the node on level 0. Nodes are displayed in the structure/filter
according to this position.

Sequence
The defined nodes are sorted first by the Sequence value, and then by the
Position value.

Node ID
Enter the ID of the node to be displayed.

Workobject type
Enter the work object type.

Icon ID
Enter the icon that should be displayed. The default icon is folder or file. If a
folder has sub-nodes, it will always display the folder icon.

Numbers
Specify if the number of entries is displayed next to the node text in the
structure. The following options are available:

Cumulate numbers of all subordinated nodes

The number of entries of all subordinated nodes for which the Display
only numbers of current nodes option is set is displayed.

Display only numbers of current nodes

The number of entries according to the filter criteria of the current node
is displayed.

Do not display numbers

The number of entries is not displayed.

300 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.3. Navigation

Select scr
Select this check box to automatically display the selection screen when the
node is opened. Thereby it is possible to restrict hits. A selection screen
must be defined for the work object type of the node.
Empt. node
Select this check box to display the node even if there are no entries for the
node and all subordinated nodes.
Displ. dat
Select this check box to display the entries according to the filter criteria of
the node when the node is opened.
Down crit.
Select this check box to pass on the filter criteria of the node to subordinated
nodes.
2nd Filter Label
Enter the label for the 2nd filter option. This is only used if the first filter is
of type Filter on node level.
If the first filter is for work object type, you must configure the label; see
“Defining filter labels for work object types” on page 302.
Def. node
Select this check box to define the node as default node. It is automatically
selected at the first display of the structure.

8.3.2.2 Defining sub nodes on level 1 to 4

In this step, you define levels 1 to 4 of the structure.

To define sub nodes:

1. In the Configuration Overview screen, select a line, and then double-click Sub
nodes - level <x> in the Dialog Structure where <x> is a number from 1 to 4.
2. Define sub nodes on the chosen level, using the following parameters.

Position sub node

Position of the actual node
, Sequence, Node ID, Workobject type, Icon ID, Numbers, Critical, Select scr,
Empt. node, Displ. dat, Down crit., Def. node
For the description, see “Defining top nodes on level 0” on page 300.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 301

Chapter 8 Workplace Configuration

8.3.2.3 Defining filter labels for work object types

In this step, you define labels for the second filter. This is only relevant when you
use the Filter for work object types filter type.

To define filter labels for work object types:

1. In the Configuration Overview screen, select a line, and then double-click Filter
labels for work object types in the Dialog Structure.

2. Define labels for the second filter, using the following parameters.

Workobject type
Work object type.
2nd Filter Label
Enter the label for the 2nd filter option. This is only used if the first filter is
of type Filter for work object types.

8.3.3 Defining work centers

In this step, you define the work centers that can be selected in the navigation bar. A
work center can include a single work object or many work objects to access data in
a structured way and also according to authority.

To define work centers:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Workplace

Configuration > Navigation > Work Center.

3. In the Work Center Overview screen, define work centers, using the following
parameters.

Work Center ID
ID of the work center
Active
Select this check box to define the work center as active.
Work Center text
Enter a description.
Priority
Enter a priority number (possible values 00 to 99). Work centers are sorted
according to this priority.
Configuration ID
Enter the ID of the navigation structure that shall be displayed in the work
center.

302 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.4. Authorization objects

Icon ID
Enter the icon for the work center.
Entries
Select this check box to display the number of hits in the navigation
structure next to the work center text.

8.4 Authorization objects

The following authorization objects are available for the VIM Central Workplace.
They limit access and also processing according to work object type, node, and work
center level.

J_6NPF_WTY - OpenText Business Center for SAP Solutions - Work Object Types
This authorization object provides the following fields.

• J_6NPF_WTY - Work object type

• J_6NPF_ACT - Action of application
• J_6NPF_FCT - Work center function ID
• J_6NPF_NOD - Node ID

Users need authorization for work object types, actions, functions and nodes to
see and perform them in the VIM Central Workplace. The authorization for
nodes is also checked in the web application.
J_6NPF_NAV - OpenText Business Center for SAP Solutions - Work center
This authorization object provides the following field.

• J_6NPF_PLA - Work center ID

Users need this authorization to access work centers in the VIM Central
Workplace.
J_6NPF_ADM - OpenText Business Center for SAP Solutions - Authorization object
for administrative tasks
This authorization object provides the following field.

• J_6NPF_COM with the following components

0. Basis
1. Inbound
2. Process
3. Workplace
4. Workplace

This authorization object is checked in all administrative reports, transactions,

and programs.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 303

Chapter 8 Workplace Configuration

J_6NPF_RFC - OpenText Business Center for SAP Solutions - Authorization object

for general execution of RFC functions and reports
This authorization object provides the following field.

• ACTIVITY with the values 02 (change) and 03 (display)

This authorization object is checked in all RFC functions and executable

programs. Each user must have this authorization with the full authority.

Example 8-1: Authorizations necessary to monitor the Inbound

Configuration

Authorization object VIM Foundation component

J_6NPF_NAV VIM Central Workplace
J_6NPF_PLA Work Center ID
WP_IDF
J_6NPF_WTY Work object type
J_6NPF_WTY Work object type
PF32_MON_IDF
J_6NPF_ACT Action of application
Work object type Action
PF32_MON_IDF CHANGE_STATUS
PF32_MON_IDF DISCARD
PF32_MON_IDF DISPLAY_IDOC
PF32_MON_IDF DISPLAY_MAIL
PF32_MON_IDF DISPLAY_VALAG
PF32_MON_IDF RESET_RETRY
PF32_MON_IDF TRIGGER
PF32_MON_IDF TRIGGER
J_6NPF_FCT Work Center function ID
IDF_ARCHIVE_DOCUMENT
IDF_ARCHIVE_MON
J_6NPF_NOD Node ID
Node ID Work object type
PF32_IDF PF32_MON_IDF Inbound
Documents
PF32_IDF_END PF32_MON_IDF
Processed

304 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 8.4. Authorization objects

Authorization object VIM Foundation component

PF32_IDF_ERROR PF32_MON_IDF Error
PF32_IDF_PROC PF32_MON_IDF
Processing
PF32_IDF_REJECT PF32_MON_IDF
Rejected
PF32_IDF_WAIT PF32_MON_IDF
Waiting
J_6NPF_ADM VIM Administration
J_6NPF_COM Components
1 Inbound (only this is needed)
2 Process
3 Workplace
4 Web UI

VIM200405-CGF-EN-02 Configuration Guide for Foundation 305

Chapter 9
Fiori Task App

The following sections give you detailed information about the landscape,
customizing options and the interface of the Fiori Task App and the underlying
technical concept of Web Services, which are both a part of VIM Foundation.

The Fiori Task App is a light-weight web application following the Fiori design
principles. It represents an inbox showing the items that have been assigned to the
logged-in user. The user then is able to complete items by performing dedicated
actions, entering comments, and editing the data.

You configure the complete content of the Fiori Task App by customizing and
implementing interfaces of the Web Services. Therefore no extension points for the
Fiori Task App are offered and enhancements of the Fiori Task App or the VIM
Foundation OData services are not supported.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 307

Chapter 9 Fiori Task App

9.1 Application modes

9.1.1 Full screen with work center as entry point
This application mode displays a workplace and the assigned nodes. You can switch
between the nodes by clicking the different tabs. The data of the nodes are then
displayed in a table below the tabs. You can use filter, search, and sort criteria to
restrict the displayed data. Additionally, the displayed columns can be customized.
These settings can be saved in variants.

Each item in the table can have several actions. By default, actions are available in
the action menu in the last column. Alternatively, links can be displayed as icons or
links in table cells. Other actions can be displayed as icons in table cells.

A table can be bulk enabled. In this case, a button is a available to switch to the bulk
mode. In the bulk mode you can select several items and choose a bulk action for
these items. Available bulk actions are displayed in the table footer.

Value
Parameter name Description
specification
Mandatory
Sets the mode of the application.

Note: Full screen application

appMode FS
mode is supported only for
Desktop and Combi device
types.
workplaceId (mandatory
<value> The workplace to show.
parameter)
Optional
Alias of the backend system to which
the OData service establishes a
connection. If the parameter is not set,
system <value>
the Fiori Task App tries to connect to a
system with the SAP System Alias
LOCAL.
systemAlias <value> Alternative to parameter system
If parameter is set to false, the
complete surface of the screen is used
letterBox (only applicable
<true|false> for the app. Otherwise, there is some
in Launchpad)
free space on the left and the right.
Default value is true.

308 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.1. Application modes

Value
Parameter name Description
specification
If parameter is set to false, fields
with configured semantic object
semanticNavEnabled (only
<true|false> navigation are not active. Use the
applicable in Launchpad)
parameter if target applications are not
installed. Default value is true.

Figure 9-1: Layout and Data View Composition of main screen

9.1.2 Full screen with node as entry point

This application mode generally has the same capabilities as “Full screen mode with
work-center as entry point”. The difference is that it displays only one specific node
without the option to switch between the other nodes of the specified work center.
Use it if your work center contains only one node, or access to the other nodes of the
work center is not wanted for a certain solution application.

Value
Parameter name Description
specification
Mandatory
Sets the mode of the application.

Note: Full screen application

appMode FS
mode is supported only for
Desktop and Combi device
types.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 309

Chapter 9 Fiori Task App

Value
Parameter name Description
specification
The workplace to which the specified
workplaceId <value>
node is assigned to.
The work object type from which the
wobjType <value>
node has been created.
The node specifying a specific object
nodeId <value>
selection in the backend.
Optional
Alias of the backend system to which
the OData service establishes a
connection. If the parameter is not set,
system <value>
the Fiori Task App tries to connect to a
system with the SAP System Alias
LOCAL.
systemAlias <value> Alternative to parameter system
If parameter is set to false, the
complete surface of the screen is used
letterBox (only applicable
<true|false> for the app. Otherwise, there is some
in Launchpad)
free space on the left and the right.
Default value is true.
If parameter is set to false, fields
with configured semantic object
semanticNavEnabled (only
<true|false> navigation are not active. Use the
applicable in Launchpad)
parameter if target applications are not
installed. Default value is true.
Initially applied filter that can be
revoked by the user (must match
existing filter categories and values).

Note: The parameter is only

filter <url_encoded_value>
valid if the facet filter is used
instead of the filter bar. For the
filter bar, the functionality is
replaced by the variant
management.

310 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.1. Application modes

Value
Parameter name Description
specification
Works in combination
with searchValue - initially applied
search that can be revoked by the user
(must match existing search
categories).
searchField <value>
Note: The parameter is only
valid if the facet filter is used
instead of the filter bar. For the
filter bar, the functionality is
replaced by the variant
management.
Works in combination
with searchField - initially applied
search that can be revoked by the user
(must match existing search
categories).
searchValue <url_encoded_value>
Note: The parameter is only
valid if the facet filter is used
instead of the filter bar. For the
filter bar, the functionality is
replaced by the variant
management.
Works in combination
with sortDirection - initially
applied sorting that can be revoked by
the user (must match existing sort
options).
sortOption <value>
Note: The parameter is only
valid if the facet filter is used
instead of the filter bar. For the
filter bar, the functionality is
replaced by the variant
management.
Works in combination
with sortOption - initially applied
sorting that can be revoked by the user
(must match existing sort options).

sortDirection <asc|desc> Note: The parameter is only

valid if the facet filter is used
instead of the filter bar. For the
filter bar, the functionality is
replaced by the variant
management.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 311

Chapter 9 Fiori Task App

9.1.3 Object
This application mode displays the data of an item. The display structure is defined
within an item perspective and uses the complete screen. You can specify the item in
one of the following ways:

• Using a concrete webId, typically used when coming from a semantic object
navigation.

Note: In this case all keys necessary to build the webId for the target
application must also be part of the keys specified for the source
application.

• Using an alias where the keys are explicitly maintained. For more information,
see “Defining aliases for a work object” on page 376.

Value
Parameter name Description
specification
Mandatory
Sets the mode of the application.

appMode OBJ Note: You can use the mode for

desktop, combi, phone, and
tablet device types.
The workplace to which the specified
workplaceId <value>
node is assigned to.
The work object type from which the
wobjType <value>
node has been created.
The node specifying a specific object
nodeId <value>
selection in the backend.
The webId or webIdAlias specifying
webId | webIdAlias <value>
the concrete item.
Optional
Alias of the backend system to which
the OData service establishes a
connection. If the parameter is not set,
system <value>
the Fiori Task App tries to connect to a
system with the SAP System Alias
LOCAL.
systemAlias <value> Alternative to parameter system
If parameter is set to false, the
complete surface of the screen is used
letterBox (only applicable
<true|false> for the app. Otherwise, there is some
in Launchpad)
free space on the left and the right.
Default value is true.

312 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.1. Application modes

Value
Parameter name Description
specification
If parameter is set to false, fields with
semanticNavEnabled configured semantic object navigation
(only applicable in <true|false> are not active. Use the parameter if
Launchpad) target applications are not installed.
Default value is true.
The parameter can be added with a
different value for each scenario when
the same perspective and work object
type with the same advanced line item
variantKey <value>
views is used in different scenarios.
This allows the maintenance of
different variants for the advanced line
item table views.

Figure 9-2: Layout and Data View Composition of main screen

The structure consists of specific Fiori Task App specific views like attribute lists and
tables, but also standard SAP UI5 controls. These different views are arranged in
page sections and the user can easily navigate to one of them by clicking on the
section name in the Anchor Bar.

Actions that do not finish the display of the item are displayed within this
perspective (Save, Check, Add Comment…) whereas finalizing actions are displayed
at the right bottom of the detail area (Submit, Refer…).

The main page usually contains a document list, whereas the documents are usually
displayed in a document viewer in an extra column. This column can be closed,
enlarged, or displayed in full screen size. If the document was closed it can be
displayed again by clicking it in the document list.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 313

Chapter 9 Fiori Task App

Warnings and errors for the current item are display with the message button. By
clicking it a message with more details appears. Erroneous fields and cells in the
table and attribute list views are additionally marked with a red border.

9.1.4 Split app mode

This application mode uses a split app layout to display one node of a certain work
center.

On the left side you see a list of items assigned to this node. The items can be sorted
and additionally restricted by filter and search criteria. After switching to the bulk
mode you can chose several items in the list and execute a bulk action for them.

The detail view on the right side of the screen shows the details of the selected item.
The structure of this detail area is defined in an item perspective like the one used in
the object mode.

Value
Parameter name Description
specification
Mandatory
The workplace to which the specified
workplaceId <value>
node is assigned to.
The work object type from which the
wobjType <value>
node has been created.
The node specifying a specific object
nodeId <value>
selection in the backend.
Optional
The App is called in master detail
mode. Master detail mode is also the
default mode if the appMode
parameter is not specified in the URL.
appMode MD
Note: You can use the mode for
desktop, combi, phone, and
tablet device types.
Alias of the backend system to which
the OData service establishes a
connection. If the parameter is not set,
system <value>
the Fiori Task App tries to connect to a
system with the SAP System Alias
LOCAL.
systemAlias <value> Alternative to parameter system
If parameter is set to false, the
complete surface of the screen is used
letterBox (only applicable
<true|false> for the app. Otherwise, there is some
in Launchpad)
free space on the left and the right.
Default value is true.

314 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.1. Application modes

Value
Parameter name Description
specification
If parameter is set to false, fields
with configured semantic object
semanticNavEnabled (only
<true|false> navigation are not active. Use the
applicable in Launchpad)
parameter if target applications are not
installed. Default value is true.
If this parameter is set, the Master area
is hidden initially both in portrait and
landscape. The Master area can be
opened by clicking on the top left
splitAppMode HideMode
corner button or swiping right. Swipe
is only enabled on mobile devices.
Master will keep the open state when
changing the orientation of the device.
Initially applied filter that can be
filter <url_encoded_value> revoked by the user (must match
existing filter categories and values).
Works in combination
with searchValue - initially applied
searchField <value> search that can be revoked by the user
(must match existing search
categories).
Works in combination
with searchField - initially applied
searchValue <url_encoded_value> search that can be revoked by the user
(must match existing search
categories).
Works in combination
with sortDirection - initially
sortOption <value> applied sorting that can be revoked by
the user (must match existing sort
options).
Works in combination
with sortOption - initially applied
sortDirection <asc|desc>
sorting that can be revoked by the user
(must match existing sort options).
The parameter can be added with a
different value for each scenario when
the same perspective and work object
type with the same advanced line item
variantKey <value>
views is used in different scenarios.
This allows the maintenance of
different variants for the advanced line
item table views.

The search, filter, and sort can use criteria that are defined in the node
customizing: OpenText Vendor Invoice Management Foundation > Web
Services > Workplace > Nodes – Search Fields, Sort Fields, Filter fields.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 315

Chapter 9 Fiori Task App

Alternatively, the search, filter, and sort can use criteria that is defined in the
implementation of the node exit: interface /OTX/PF62_IF_NODE, for example
method CHANGE_NODE_FILTER_FIELDS. For more information,
see “CHANGE_NODE_FILTER_FIELDS” on page 446.

Figure 9-3: Layout and Data View Composition of main screen

9.2 Fiori Task App Launchpad integration

You can run the Fiori Task App in several ways:

• integrated into Fiori Launchpad

• standalone

Note: The Fiori Task App makes use of launchpad features for navigation and
others features. Therefore the standalone mode can only be used with
limitations.

Fiori Task App running scenarios differ depending on the place of integration. This
section describes on-premises integration and integration on SAP Business
Technology Platform, Neo environment in separate subsections.

316 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.2. Fiori Task App Launchpad integration

9.2.1 On-premises integration

9.2.1.1 Integrating Fiori Task App into Fiori Launchpad
For more details and further information about the Fiori Launchpad, check the SAP
Help Portal..

To integrate Fiori Task App into Fiori Launchpad:

1. Assign catalogs to role.

You can download the launchpad catalogs from the Launchpad Content in the
patches area.
For a description how to assign tile catalogs to roles, see the SAP
documentation.
The delivered catalogs are the following:

Solution/Purpose Catalog ID
Vendor Invoice Management Foundation /OTBCWUI/PF07_BC_FOUNDATION
(for cross solution apps):
• Store Documents

Note: Do not use the Store

Documents app to mass-upload
documents. For mass processing
you must use dedicated scanning
and pipeline tools.
• Capture Validation Workplace
Delivery Note /OTBCWUI/
PF07_BC_SOL_DELIVERY_NOTE
Sales Order /OTBCWUI/
PF07_BC_SOL_SALES_ORDER
HR Documents /OTBCWUI/
PF07_BC_SOL_HR_DOCUMENT
Remittance Advice /OTBCWUI/
PF07_BC_SOL_REMITTANCE_ADV
Order Confirmation /OTBCWUI/
PF07_BC_SOL_ORDER_CONF
Quotations /OTBCWUI/PF07_BC_SOL_QUOTATION
Vendor Invoice Management Foundation /OTBCWUI/PF07_BC_ADMIN
Administration (for solution
implementers):
• Maintain Perspectives

VIM200405-CGF-EN-02 Configuration Guide for Foundation 317

Chapter 9 Fiori Task App

2. Personalize the Launchpad.

Users can now access the Launchpad with the relative URL /sap/bc/ui5_ui5/
ui2/ushell/shells/abap/Fiorilaunchpad.html.
To add tiles to the home page, users must click the profile icon and then Edit
Home Page. From there they can search in the assigned catalogs and use the
plus icon to add the wanted solution tiles directly to the home page or organize
them in groups.

318 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.2. Fiori Task App Launchpad integration

9.2.1.2 Creating a custom solution tile

To create a custom solution tile:

1. Open the Launchpad designer using the following relative URL:

https://<host>:<port>/sap/bc/ui5_ui5/sap/arsrvc_upb_admn/main.
html

2. To create a new catalog, click Add on the lower left.

3. Search for the Vendor Invoice Management Administration catalog.

4. Select a target mapping from the Target Mappings tab, and then click Create
Reference. From the catalog list in the dialog box, select the previously created
catalog.

5. Go back to your newly created catalog.

6. Click the Tiles tab, and then click Create.

7. Choose between a dynamic or static tile.

8. Enter the necessary data in the dialog as shown in the following:

General

Title
Enter a title of your choice.
Subtitle
Enter a subtitle of your choice.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 319

Chapter 9 Fiori Task App

Dynamic Data

Service URL
Optionally you can maintain a service URL for displaying the number of
tasks in a node at the tile. This service URL has the following syntax:
/sap/opu/odata/OTX/PF05_DATA;mo;v=3/Nodes(<Node parameter>)/
Objects/$count, where <Node parameter> is described in the following list:

<Node parameter>
A node is defined by the following parameters:
SAP__Origin: System alias of backend system.
deviceType: Device type. Leave empty for $count request.
nodeId: ID of the node.
wobjType: Work object type of the node.
workplaceId: Workplace ID.

Example: /sap/opu/odata/OTX/PF05_DATA;mo;v=3/Nodes(SAP_
_Origin='OTBCWUI_BACKEND',deviceType='',nodeId='PS01_DELIVERY_
INBOX', wobjType='PS01_PRC_DELIV',workplaceId='WP_INBOX')/
Objects/$count

Navigation

Use semantic object navigation

Select this check box.
Semantic Object
Enter OTBCWUI_PF07_BC_SEMOBJ. Starting with 16.3 SP4 enter
otbcwuipf07bc.

Action
If the used solution perspectives can only be shown properly on desktop,
enter action display or displayDesktop.
Parameters
Enter an appropriate combination of parameters with values depending on
the chosen Application Mode. For more information, see “Application
modes” on page 308.

320 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.2. Fiori Task App Launchpad integration

9.2.1.3 Running the Fiori Task App standalone

You can run the Fiori Task App also without Fiori Launchpad. Use the following
URL:

http://<host>:<port>/sap/bc/ui5_ui5/otbcwui/pf07_bc_ui_03/index.html?
<parameters>

where you replace the <parameters> variable with an appropriate combination of

parameters with values depending on the chosen Application Mode. For more
information, see “Application modes” on page 308.

Example for the http://<host>:<port>/sap/bc/ui5_ui5/otbcwui/pf07_bc_ui_03/index.html?

Sales Order nodeId=PS02_ORDER_INBOX&system=OTBCWUI_BACKEND&wobjType=PS02_PRC_
solution
ORDER&workplaceId=WP_INBOX

9.2.2 SAP Business Technology Platform, Cloud Foundry

environment integration
9.2.2.1 Integrating the Fiori Task App into the Cloud Foundry Portal or
Launchpad service

To integrate the Fiori Task App into the launchpad service logon to your
subaccount where the app has been deployed:

1. Start the launchpad or portal service.

2. Navigate to the site directory.

3. Import the sites for the VIM Fiori apps.

With the import of the sites the site, catalogs, groups, roles, and apps of the
uploaded site are added to your Content Manager.
The sites are available in the patches area from the launchpad content folder.
They comprise the following component and solutions:

• Vendor Invoice Management - Foundation Component

• Vendor Invoice Management - Order Confirmation Solution

• Vendor Invoice Management - Quotation Solution

• Vendor Invoice Management - Sales Order Solution

• Vendor Invoice Management - Delivery Note Solution

• Vendor Invoice Management - Remittance Advice Solution

4. In the subaccount, assign the role collections included in the sites to the end
users.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 321

Chapter 9 Fiori Task App

9.2.2.2 Creating a custom solution tile

To create a custom solution tile:

1. Start the launchpad or portal service.

2. Navigate to the Content Manager and create a new app.

3. In the PROPERTIES tab, maintain the following settings:

System
otbcwuiapprouter

App UI Technology
Dynamic URl

Relative Path to App

/otbcwui/index.html

Add intent and default SAP parameters to URL

Clear this check box.
Use intent parameters as URL parameters
Select this check box.

Set the other parameters as required.

4. In the NAVIGATION tab, define a Semantic Object and Action and set the
parameters.

322 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.2. Fiori Task App Launchpad integration

5. In the VISUALIZATION tab, set the properties as required.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 323

Chapter 9 Fiori Task App

6. If you are using Visualization Type Dynamic App Launcher, maintain the
following parameters:

System
otbcwuibackend

Odata Service URL

sap/opu/odata/OTX/PF05_DATA;v=3;mo/Nodes(SAP__Origin='OTBCWUI_
BACKEND',deviceType='',nodeId='<your nodeID>',wobjType='<your
work object type>',workplaceId='<your workplace ID>')/Objects/
$count

7. Save the app.

8. Create a catalog, group, and role (or enhance existing ones) to which you assign
this app.

9. Assign the app to the site where you want to display it.

10. Assign your role collection to the end users.

324 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.2. Fiori Task App Launchpad integration

9.2.2.3 Runinng the Fiori Task App standalone

To configure the Fiori Task App to run standalone:

1. Navigate to the space where the application router has been deployed.

2. Click the app name.

3. On the Overview screen, click the URL in the Application Routes box. /index.
html is appended to the displayed route and Not Found is the result.

4. Change the /index.html part in the URL to /otbcwui/index.html? and add

the additional parameters to the app. For more information about the
parameters, see “Application modes” on page 308.

9.2.3 SAP Business Technology Platform, Neo environment

integration
9.2.3.1 Integrating Fiori Task App into an SAP Cloud Portal service Fiori
Launchpad site
To integrate Fiori Task App into an SAP Cloud Portal service Fiori Launchpad
site:

1. On the SAP BTP cockpit Neo environment, on the menu on the left, open the
Services node.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 325

Chapter 9 Fiori Task App

2. In the content pane on the right, click the Portal tile.

Note: For this action, the service must be enabled.

3. On the main navigation on top of the screen, click Configure Portal.

In the menu on the left, click Roles. Create roles reflecting your business needs.
As a simple sample for this description, a role with name BC_ROLE is assumed.

Assign the role to appropriate users/groups.

326 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.2. Fiori Task App Launchpad integration

4. To go back to the overview, click Portal on the main navigation. Then click the
Go to service action.

Create a new Fiori Launchpad Site or choose an existing one.

5. On the menu, click Services and Tools.

Open the Transport Manager tile. Click the tab Import and select the required
content archive.

6. Assign the imported catalogs to the created roles.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 327

Chapter 9 Fiori Task App

7. Set the appropriate UI5 version for the Launchpad under Settings.

Note: The UI5 version must be supported by the current release. See the
Release Notes for details.

8. Finally publish the site to make it available for your users.

The content archives can be downloaded in the patches area from the Launchpad
Content folder. They comprise:

• Vendor Invoice Management - Foundation

• Vendor Invoice Management - Administration
• Vendor Invoice Management - Solution Order Confirmation
• Vendor Invoice Management - Quotation
• Vendor Invoice Management - Solution Sales Order
• Vendor Invoice Management - Solution Delivery Note
• Vendor Invoice Management - Remittance Advice

9.2.3.2 Creating a custom solution tile

To create a custom solution tile:

1. On the SAP BTP cockpit Neo environment, click Apps on the menu on the left.
From the SAP BTP cockpit Neo environment, access the Portal Service. In the
Portal, choose an existing Fiori Launchpad Site or create a new one. In the site
administration, click Applications on the left.

328 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.2. Fiori Task App Launchpad integration

2. Search for the App Resource otbcwuipf07bc.

Important
If you keep the default semantic object otbcwuipf07bc, the action for your
set of parameters must be unique.

3. Enter the parameters as needed, depending on the chosen application mode. For
more information, see “Application modes” on page 308.

Note: Do not flag the parameters as mandatory.

4. Dynamic Tile Settings

When referring to the PF05_DATA service for count information, construct the
URL in the following way:

Example:
/destinations/PF05_DATA/
Nodes(SAP__Origin='OTBCWUI_BACKEND',deviceType='',nodeId='PS01_DELIVERY_INBOX',wobjTy
pe='PS01_PRC_DELIV',workplaceId='WP_INBOX')/Objects/$count

5. Assign the tile to the required catalogs and/or groups.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 329

Chapter 9 Fiori Task App

9.2.3.3 Running the Fiori Task App standalone

You can run the Fiori Task App on SAP Business Technology Platform, Neo
environment without a Fiori Launchpad Site in the SAP Cloud Portal service. The
URL is constructed in the following way:

<applicationUrl>/?<parameters>

• To get the <applicationUrl>, click the application. Under section Active Version,
you find the Application URL.
• Replace the <parameters> variable with an appropriate combination of parameters
with values depending on the chosen Application Mode. For more information,
see “Application modes” on page 308.

Example for the Sales Order solution:

https://pf07bcneoui03-a9e96cfa0.dispatcher.hana.ondemand.com/?nodeId=
PS02_ORDER_INBOX&system=OTBCWUI_BACKEND&wobjType=PS02_PRC_
ORDER&workplaceId=WP_INBOX

Important
Certain features, for example semantic object navigation, require launchpad
services and cannot be used in the standalone mode.

9.3 Fiori Task App essentials

The following sections explain how you can retrieve the necessary information and
what are relevant settings and exits for the app modes.

9.3.1 Full screen list (URL parameter appMode=FS)

9.3.1.1 Workplaces and node assignment
In the full screen list mode, you see a workplace and the nodes or one of the nodes
assigned this workplace. The ID of the workplace is defined by the URL parameter
workplaceId. In case only one node is displayed then this node is defined in the
URL parameter nodeId. In case several nodes are available or the parameter nodeId
is not available, you can always find out the Id of the displayed node in the console
log of your browser: Log entry "Initialize node ‘<node ID>’.".

Workplaces are defined in the backend system transaction /OTX/PF00_IMG > Web
Services > Workplace > Work Center. For a detailed description, see “Defining work
centers” on page 387.

The assignment of nodes to a work center is maintained in Web Services >

Workplace > Assignment of Nodes to Work Center. In this setting, you also see the
work object type assigned to the nodes. For a detailed description, see “Assigning
nodes to work centers” on page 398.

330 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.3. Fiori Task App essentials

9.3.1.2 Nodes and work object types

A node is always connected to a work object type. The work object type defines the
selection and structure of the displayed data. Also, the available actions are defined
and implemented for a work object type. Each table line represents an instance of a
work object.

The basic work objects type settings are defined in the backend system transaction /
OTX/PF00_IMG > Workplace Configuration > Work object types > Work object
types. In this customizing activity the common settings used in the VIM Central
Workplace and the Fiori Task App, but also VIM Central Workplace only settings,
are defined.

Settings relevant for the Fiori Task App are:

• Display structure – Defines available fields.

• Selection structure – Defines fields that can be used for filter and sorting.
• Handler class – Defines class that is used for data selection. When empty,
dynamic data selection is used.
• Selection Exit – Exit that can be implemented to change data selection criteria or
results at runtime; only used with dynamic data selection.

For more details on these settings see “Defining work object types” on page 266.

Instead of implementing an own handler class, many solutions use the dynamic data
selection class (/OTX/PF03_CL_DATA_HANDLER_DYN), the default class when no
handler class is maintained. In this case the tables and selection conditions for the
data selection must be maintained in /OTX/PF00_IMG > Workplace Configuration >
Work object types > Dynamic data selection. For more details, see “Defining
dynamic data selection” on page 288

Work object types defined in the Workplace Configuration must be enabled for the
use in the Fiori Task App. This is done in /OTX/PF00_IMG > Web Services > Work
Object Type > Work Object Type.

Mandatory customizing for a work object type is the key definition. In this setting,
the fields defining a unique key for the work object type must be maintained.
Because the Fiori Task App is a generic application, handling any type of business
object the OData service and the app use a generic key – webId - to identify the work
object instances. The OData service generates for each work object instance a webId
and connects it with the values of the fields defined in the key definition. For the
communication between OData service and solution implementation these field
values are used. For more details, see “Defining keys for the work object type”
on page 375.

All actions available for this work object type must be defined in the Actions node.
You find detailed information about the different action types and their
configuration in “Defining item related actions” on page 380.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 331

Chapter 9 Fiori Task App

Like the work object types also the nodes have a general customizing that is used for
the VIM Central Workplace and the Fiori Task App. This customizing is in /OTX/
PF00_IMG > Workplace Configuration > Navigation > Nodes.

A node used in the context of the Fiori Task App consists always of a node ID and a
work object type. By default, a node shows all entries returned by the data selection
of the assigned work object type. This can be restricted by defining additional filter
criteria. The filter criteria defined in this setting will always be applied for this node.
Filter criteria set by the user in the Fiori Task App will be added as additional filter
criteria but cannot overwrite or replace the filter criteria defined in this setting.

As the full screen list app shows a maximum of 100 entries per page it can be useful
to define an order by criteria. The dynamic data selection will use this order by
criteria in the data selection statement. Sorting criteria applied by the user in the
Fiori Task App will only be added to the defined order by criteria with a lower
priority and cannot replace this setting.

More details on these settings are available in “Defining nodes” on page 294.

9.3.1.3 Full screen list settings

To use a node in the full screen list, this node must be activated for the use in the
OData service. This is done in transaction /OTX/PF00_IMG > Web Services >
Workplace > Nodes.

In this configuration, you can also define which fields of the selection structure of
the work object should be available as search, sort, and filter fields.

Note: With SAP UI5 version 1.84 and higher the Fiori Task App uses the filter
bar in the full screen list. In previous versions the facet filter is used. In the
filter bar no explicit search field is available, but the search fields are added to
the filter fields. Therefore, instead of defining search fields, the filter fields
should be used with these SAP UI5 versions.

For detailed descriptions of these settings, see “Adding fields for searching, sorting,
and filtering to a node” on page 390.

The full screen list itself is defined in the Full Screen List node. The settings can be
made device specific. In sub node Full Screen List – Columns, you can choose the
fields of the display structure that should be available in the full screen list. In Full
Screen List – Actions you can assign the work object type actions that should be
available in the full screen list. Only actions defined in the work object type
configuration can be used.

For details, see “Customizing a full screen list” on page 394.

332 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.3. Fiori Task App essentials

9.3.1.4 Changes at runtime and debugging the full screen list

In case your customizing changes are not considered, or the displayed data is not as
expected, there are several options to influence the full screen list at runtime.

Configuration issues
The configuration and displayed data of the full screen list can be changed using
the Exit for node in the node customizing /OTX/PF00_IMG > Web Services >
Workplace > Nodes. With this exit any customizing settings could be changed at
runtime.
Data selection issues
In case of issues with the data selection, the Handler Class or the Data Selection
Exit class in the work object type definition are the objects to start the
investigation. In the data handler class, the method /OTX/PF03_IF_WOBJ_
HANDLER~SELECT_DATA is the most relevant method.
In the data selection exit class, the methods /OTX/PF03_IF_CHANGE_
SELECT~CHANGE_DYNAMIC_SELECTION and /OTX/PF03_IF_CHANGE_
SELECT~CHANGE_SELECTION_CRITERIA are the most important.
The selected data can additionally be changed in the Exit for node class.
Tip: In case of dynamic data selection, do not forget to check this
configuration, especially the table joins and conditions. Maybe an outer
join flag has been forgotten. Also consider that using a field of an outer join
table as select condition will change the outer join to an inner join.
Actions
In case of an Action Dialog the action dialog class customized in the work object
type actions is the most important one. Method /OTX/PF62_IF_ACTION_
DIALOG~GET_ACTION_DIALOG is the method which is first called and, in case a
dialog was displayed, method /OTX/PF62_IF_ACTION_DIALOG~EXECUTE_
ACTION will finish the action.
For bulk actions the method /OTX/PF62_IF_ACTION_DIALOG~CHANGE_BULK_
OBJECTS is additionally called to check if all selected objects can be processed.

9.3.2 Object mode (URL parameter appMode=OBJ)

9.3.2.1 Perspective ID
The used item perspective is written to the browser log when the perspective is
loaded: Log entry "Applying perspective: <item perspective ID>". The related
work object type is defined in the URL parameter wobjType, the node with URL
parameter nodeId.

Which perspective is used is defined in the node customizing, transaction /OTX/

PF00_IMG > Web Services > Workplace > Nodes field: Perspective ID item. At
runtime, this configuration can be changed in web handler class method /OTX/PF62_
IF_ITEM_HANDLER~ CHANGE_OBJECT. The web handler class is defined in the work
object type customizing.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 333

Chapter 9 Fiori Task App

9.3.2.2 Root work object type and associated work object types
Item perspectives are connected to a work object type, which is the root work object
type of this perspective. The perspective can also display data of associated work
object type. This association must be defined in /OTX/PF00_IMG > Workplace
Configuration > Work object types > Work Object Type Association. For details,
see “Defining the work object type association” on page 291.

9.3.2.3 Perspectives and data binding

The data binding for attribute lists and tables in for the item perspective are defined
in transaction /OTX/PF00_IMG > Web Services > Perspectives > Data Binding.
Attribute lists can either show fields of the display structure of the root work object
type or an associated work object type. Tables always show data of associated work
object types with cardinality 1:N.

For details on this configuration, see “Configuring the data binding of perspectives”
on page 401.

The perspective can be displayed using the perspective editor: /OTX/PF00_IMG >
Web Services > Perspectives > Maintain Perspectives (Perspective Editor on SAP
Fiori Launchpad).

For details, see “Editing perspectives and layouts” on page 427.

9.3.2.4 Changes at runtime and debugging

At runtime the perspective class can be used to change the content of the
perspective. The perspective class is defined in /OTX/PF00_IMG > Web Services >
Perspectives > Data Binding field: Perspective Class .

Main methods are:

• /OTX/PF62_IF_PERSPECTIVE_CLASS~CHANGE_CUSTOMIZING: Change
configuration of attribute lists, tables and other views
• /OTX/PF62_IF_PERSPECTIVE_CLASS~CHANGE_DATA: Set data for attribute lists,
tables and other views
• /OTX/PF62_IF_PERSPECTIVE_CLASS~CHECK_SAVE_DATA: Save routine called
when user clicks Save or Check, or executes an action that includes a save.

All methods are described in detail in “Interface /OTX/

PF62_IF_PERSPECTIVE_CLASS” on page 486.

334 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.4. Displaying documents in the Fiori Task App

9.3.3 Split app mode (URL parameter appMode=MD)

The work object type and node settings described in “Nodes and work object types”
on page 331 apply also for the split app mode. The layout and configuration of the
list objects is described in “Configuring the data binding for the master list”
on page 393.

At runtime the list objects can be changed in method /OTX/PF62_IF_ITEM_

HANDLER~CHANGE_OBJECT of the web handler class, see “Work object type”
on page 375.

The configuration and runtime behavior of the item perspective in the details area is
the same as described in “Object mode (URL parameter appMode=OBJ)”
on page 333.

9.4 Displaying documents in the Fiori Task App

By default, the solutions generate an URL for the display of the main documents and
attachments. This URL can point to the archive or a web viewer. This URL is defined
by the standard SAP customizing. OpenText recommends that you point the URL to
a proxy service instead of directly using the archive. For details, see “Accessing
archived documents using a proxy service” on page 335.

In case you are only displaying PDF documents in the Fiori Task, OpenText
recommends that you activate the streaming of the documents. The VIM OData
service will read the document from the archive and the Fiori Task App will receive
it as a stream and display it in the SAP UI5 PDFViewer. To activate the streaming,
you need to activate the document streaming in the basic settings, see “Configuring
basic settings” on page 372.

9.4.1 Accessing archived documents using a proxy service

On Fiori applications, the following URLs to display archived documents are
available.

URL to the archive system

If you do not use a viewer, the Fiori applications by now use a URL that directly
points to the archive system for displaying documents. Therefore, you must put
the Archive Server (URL) into the Demilitarized Zone (DMZ) if you want to
access the image on the Fiori Task App outside the intranet domain.
URL to viewer application
As an alternative to a URL to the archive system, this kind of URL points to the
Web Viewer or to Brava! View. Therefore, it points to the archive only indirectly.
Documents are displayed using the viewer.
URL requested from the Fiori Task App
You can define a fixed external location that is used at the URL generation for a
document if the URL is requested from the Fiori Task App. You can use the
General Settings parameter EXTSDOKLOC (Location for Document URL

VIM200405-CGF-EN-02 Configuration Guide for Foundation 335

Chapter 9 Fiori Task App

generation for Fiori App). For more information, see “Configuring general
settings” on page 19.

To generate document URLs used by the Fiori Task App, SAP standard function
modules (for example SCMS_URL_GENERATE) are used. To make these URLs point to
a proxy service rather than directly to the archive, you can use the Content Server
alias customizing. For more information on how to do this, see “Changing document
URLs with Content Server aliasing” on page 336.

The configuration of Content Server aliases is described in detail in section 5 “Cache

Server customizing in the Content Management Service (BC-SRV-KPR-CMS)” of the
SAP Scenarios with OpenText Archive Cache Server - White Paper, available on My
Support.

For the calculation of the Location (see section 5.3.2 “Defining additional locations
for Content Server aliases” in the White Paper), VIM Foundation calls the SAP
standard modules in a way that user profile parameter LCA is used. If parameter LCA
is not maintained in the user profile, then the current IP is used. For the correct IP
calculation, installing SAP note 1833702 might be necessary.

The configuration of a proxy service in a SAP Web Dispatcher is described in the

SAP documentation.

Proxy for WebUI and ODATA

wdisp/system_0 = SID=D5O, NR=01, MSHOST=<Fiori server>, MSPORT=8101,
SRCSRV=*:*, SRCURL=/sap/opu/odata;/sap/bc

Proxy for Archive

wdisp/system_2 = SID=ARC, EXTSRV=<archive>:<port>, SRCSRV=*:*,
SRCURL=/archive

Note: SAP also recommends using SAP Web Dispatcher. For more
information, see SAP Web Dispatcher for SAP NetWeaver, available on the
SAP Help portal.

9.4.1.1 Changing document URLs with Content Server aliasing

You can use the EXTSDOKLOC setting to change your document URL from a direct
archive URL to a web dispatcher or application router URL. Follow the steps below
in the backend system where the OTBCBAS component is installed.

To change a document URL:

1. In the SAP IMG hierarchy, go to SAP NetWeaver > Application Server > Basis
Services > Knowledge Provider > Content Management Service > Distribution
> Define Locations. Alternatively, you can call transaction OALO.
Define a location that you want to use, for example VIMAPP.
2. In the SAP IMG hierarchy, go to SAP NetWeaver > Application Server > Basis
Services > Knowledge Provider > Content Management Service > Distribution
> Define Host and Properties. Alternatively, you can call transaction SCMSHO.

336 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.4. Displaying documents in the Fiori Task App

• Create a new entry with either your web dispatcher host name or the URL of
the application router, and assign the location that you created in step 1.
• Create a second entry with the host name of your archive (as maintained in
transaction OAC0).

3. In the SAP IMG hierarchy, go to SAP NetWeaver > Application Server > Basis
Services > Knowledge Provider > Content Management Service > Distribution
> Define Content Server Alias. Configure the following parameters for your
web dispatcher or application router.

Content Server Alias

The web dispatcher host name or application router URL.
CS Alias Port Number
The HTTP port of the web dispatcher. This option is not available for
application routers.
CS Alias SSL Port
The HTTPS port of the web dispatcher. For application routers, this is
usually 843 or 443; see https://launchpad.support.sap.com/#/notes/2377425
for further details.
CS Alias HTTP Script
Set to archive.

Configure the following parameters for your archive, as maintained in

transaction OAC0.

HTTP Server
Your archive server.
Port Number
The HTTP port for your archive server.
SSL Port Number
The HTTPS port for your archive server.
HTTP Script
Your archive as defined in transaction OAC0.

4. Call transaction /OTX/PF00_IMG and navigate to General Settings > General

Settings. For the setting Location for Document URL generation for Fiori App
(EXTSDOKLOC), configure the location that you defined in step 1.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 337

Chapter 9 Fiori Task App

9.4.2 Enabling inplace document viewing for iPhone and iPad

By default, the Fiori Task App uses the native iOS Document Viewer. It is opened in
a new browser tab. However, this approach implies limitations regarding certain
integration scenarios.

The inplace document viewing mode allows you to overcome these limitations but it
requires the installation of Brava! View. For installation instructions, see OpenText
Brava! View for SAP Solutions - Installation and Configuration Guide (BRWEBV-IGD).

To enable the inplace document viewing:

1. After installing Brava! View, run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Basic Settings > Basic Settings.

3. Enable the Web Viewer setting for Device Types Smart phone and Tablet.

4. Open the Perspective Editor from the Launchpad by clicking the Perspectives
Maintenance tile.

5. Choose the perspective you want to change and open it in the Perspective
Editor.

6. Drag the [ot_bc_app_namespace].view.item.AttachmentsInplace view

into the same Aggregation container as the [ot_bc_app_namespace].view.
item.AttachmentsNewTab view.

7. Remember the ID of the [ot_bc_app_namespace].view.item.

AttachmentsNewTab view if it is not generic.

8. Delete the [ot_bc_app_namespace].view.item.AttachmentsNewTab view

from the perspective (Delete function in the context menu).

9. Rename the ID of the [ot_bc_app_namespace].view.item.

AttachmentsInplace view with the ID of the [ot_bc_app_namespace].view.
item.AttachmentsNewTab view.

10. Save the perspective.

338 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.5. Actions

9.5 Actions
Actions are defined for a work object type and can be used wherever the work object
type is used:

• As root work object type action in the object mode or split app mode when the
work object type is the root work object type of the used perspective.
• As line item action in the advanced line item table when the work object type is
the associated work object type of the advanced line item table.
• As bulk action in the list of the split app mode, when the work object type is
used for the wobjType parameter.
• As action or bulk action for a full screen list item when the work object type is
assigned to the currently selected node.

Additional to the general action definition, a specific customizing might be required

for the usage in a full screen list and advanced line item table.

Following types of actions are available:

Action type Description Can be used for

Action Dialog Executes an action either • Root work object type
after displaying a popup or action
immediately without • Advanced line item action
displaying a popup. Also
used for bulk actions. • Bulk action in split app
mode
• Full screen list item action
(also as bulk action)
• Node action
Save & Action dialog Changes in the perspective Root work object type action
are saved before the Action
dialog is executed.
Semantic object navigation Navigates to a different app. • Root work object type
(new tab / new window) The called app is opened in action
same tab / new tab / new
window. • Advanced line item action

Requires SAP Launchpad. • Full screen list item action

Save Triggers Root work object type action

CHECK_SAVE_DATA
method in perspective class
with changes done in the
object mode

VIM200405-CGF-EN-02 Configuration Guide for Foundation 339

Chapter 9 Fiori Task App

Action type Description Can be used for

Check Triggers Root work object type action
CHECK_SAVE_DATA
method in perspective class
with check only flag in
perspective class with
changes done in the object
mode
Refresh views in perspective Refreshes specific views in Root work object type action
the perspective without
reloading the complete
perspective
Change page in flexible Loads a new page in a Root work object type action
column layout column of the flexible
column layout
Bulk action Opens the selected items in Full screen list item action
object mode (bulk)

9.5.1 Action dialog

The Action dialog box allows you to define own popup windows with completely
free definable structure using the Action dialog perspectives. After the user
confirmed the Action dialog box, the values entered in the Action dialog box will be
available at the action execution. Also, for freely defined action without any popup
the Action Dialog action type must be used.

Note: You can also use the Action dialog box for bulk actions.

The Action dialog box provides the following features:

• You can use various input field variants (for example MultiCombo,
ValueHelpInput, TextArea) in an arbitrary count.

• You can implement custom fields (views).

• You can model and handle dependent fields in the backend.
• You can freely define layout.
• Several messages with different type can be displayed.
• Validation can be performed on field level.

The following graphic shows an example of an Action dialog box:

340 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.5. Actions

Action dialog box - architecture

• The content area of the Action dialog box is filled with a new kind of perspective:
an Action dialog box perspective.
• An Action dialog box perspective generally works like an Item perspective. The
difference is that the Action dialog box perspective can include only views in the
namespace ot.approve.requests.view.dialogPart.*. The reason for this lies
in the view interface, which is specific for any type of perspective.
• You can use DialogPart views multiple times in an Action dialog box
perspective. An item view is only allowed to be used once. The following
DialogPart views are available:
DialogPart input views

– MultiComboInput

– TextAreaInput
– ValueHelpInput
– Table
– DialogButton

DialogPart read-only views

– DescriptiveText
– ActionMessages

VIM200405-CGF-EN-02 Configuration Guide for Foundation 341

Chapter 9 Fiori Task App

9.5.1.1 Assigning a data collection to a work object type

Action dialog boxes require a data collection. Data collections are used to store and
administer data for a limited time, for example during the editing of a task or the
execution of an Action dialog box. In the context of the Fiori Task App, you can
define data collections for a work object type. For data collections, you must
implement the interface /OTX/PF62_IF_DATA_COLLECTION.

To assign a data collection to a work object type:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Work Object Type > Work Object Type.

3. In the Work Object Type Overview screen, mark a work object type, and then
double-click Data Collections in the Dialog Structure.

4. Assign the data collection to the work object type using the following
parameters:

Data Coll. Scope

Data Collection Scope. Each data collection has a unique scope for which it
is used. In the list, click Action Dialog.

Data Collection
Enter the data collection for the work object type.

9.5.1.1.1 /OTX/PF62_IF_DATA_COLLECTION interface

The interface comprises the following methods:

/OTX/PF00_IF_DATA_COLLECTION~GET_INSTANCE
Returns data collection instance.
Parameters:

Parameter Type Description

PI_COLLECTION_ID Importing Data collection ID
PIT_KEYS Importing Object key
PI_CLASSNAME Importing Data collection class
PRH_INSTANCE Returning Data collection

/OTX/PF00_IF_DATA_COLLECTION~CREATE_COLLECTION
Creates data collection. You can use this method for initially collecting the data.
Parameters:

342 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.5. Actions

Parameter Type Description

PIS_DATA_COLLECTION Importing Data collection information

Structure of PIS_DATA_COLLECTION:

Field name Description

ID Data collection ID
SCOPE Scope
CLASS Data collection class

/OTX/PF00_IF_DATA_COLLECTION~REMOVE_COLLECTION
Implement this method to remove the collected data. This method does not have
any parameters.

/OTX/PF62_IF_DATA_COLLECTION~SET_ADDITIONAL_INFORMATION
This method provides additional information in the context of the Fiori Task
App.
Parameter:

Parameter Type Description

PI_LAST_CHANGED Importing Timestamp of the last change
made to the current object.

9.5.1.2 Customizing action dialog boxes

To customize action dialog boxes:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Work Object Type > Work Object Type.

3. In the Work object type Overview screen, mark a work object type, and then
double-click Actions in the Dialog Structure.
For more information, see “Defining and assigning node actions” on page 392.

4. Customize action dialog boxes using the following parameters:

• Actions of type Action dialog require a Perspective ID and an Action

dialog class implementing the /OTX/PF62_IF_ACTION_DIALOG interface.

For more information, see “Editing perspectives and layouts” on page 427.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 343

Chapter 9 Fiori Task App

9.5.1.3 Example: an Action dialog box layout

This example is based on an Action dialog box with error and warning messages, an
input field, a button, a table that displays some information, and a comment field.
See the following graphic and the description:

This action dialog box requires the following customizing:

Perspective

Perspective ID Z_EXAMPLE
Perspective type ACTION_DLG (Perspective for action dialog)
BSP Application [ot_bc_app]
BSP Module [ot_bc_app_namespace]
Template ID [ot_bc_app_namespace].templates.ActionDialogForm
Perspective name Example

Perspective views:

Error messages

• Perspective View ID: PF63_AM_ERROR

• Parent ID: vLayoutBefore
• Position in container: 0
• BSP application:
• BSP module:
• BSP view: ot.approve.requests.view.dialogPart.ActionMessages

344 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.5. Actions

• Description: Error messages

• Web Icon:
• CSS class: ot_actionDialogForm_displayNoBlock
• Label position
• Label Parent ID
• Description position
• Desc. Parent ID

Warning messages

• Perspective View ID: PF63_AM_WARN

• Parent ID: vLayoutBefore
• Position in container: 1
• BSP application:
• BSP module:
• BSP view: ot.approve.requests.view.dialogPart.ActionMessages
• Description: Warning messages
• Web Icon:
• CSS class: ot_actionDialogForm_displayNoBlock
• Label position
• Label parent ID
• Description position
• Desc. Parent ID

Input field

• Perspective View ID: VHI_INPUT

• Parent ID: matrixLayout
• Position in container: 1,0
• BSP view: ot.approve.requests.view.dialogPart.ValueHelpInput
• Description: Input field
• Label position: 0,0
• Label parent ID: matrixLayout

Button

• Perspective View ID: B_BUTTON

• Parent ID: matrixLayout

VIM200405-CGF-EN-02 Configuration Guide for Foundation 345

Chapter 9 Fiori Task App

• Position in container: 2,0

• BSP view: ot.approve.requests.view.dialogPart.DialogButton
• Description: Example button

Information table

• Perspective View ID: T_INFORMATION

• Parent ID: vLayoutAfter
• Position in container: 0
• BSP view: ot.approve.requests.view.dialogPart.Table
• Description: Table with information

Comment field

• Perspective View ID: TAI_COMMENT

• Parent ID: vLayoutAfter
• Position in container: 1
• BSP view: ot.approve.requests.view.dialogPart.TextAreaInput
• Description: Field for comments
• CSS class: ot_actionDialogForm_stretch_textarea

9.5.1.4 /OTX/PF62_IF_ACTION_DIALOG interface

The following attributes are available for the interface:

M_CLASSNAME
Name of the currently used class.
M_PLTT
Life time token of the perspective from which the action is called.
M_PERSPECTIVE
The perspective that is used in the action dialog.
M_IS_A_BULK_ACTION
Flag if the current action is executed as bulk action.
MH_ACTION_DIALOG_INFO
This class gives access to additional information.
Methods are:

• GET_ROOT_WOBJ: Returns root work object of the item perspective from

which the action has been triggered
• GET_PARENT_WOBJ: Returns parent work object of the current item

346 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.5. Actions

• GET_PLTT_DATA_COLLECTION: Returns data collection with PLTT scope of the

item perspective from which the action is triggered
• GET_FSLIST_FILTER: Returns full screen filter and sort criteria

The /OTX/PF62_IF_ACTION_DIALOG interface comprises the following methods:

• “CHANGE_BULK_OBJECTS” on page 347

• “GET_ACTION_DIALOG” on page 348
• “GET_TEXT_AREA” on page 349
• “GET_MSG_CONTAINER” on page 350
• “GET_MESSAGES” on page 351
• “GET_INPUT_FIELD” on page 352
• “GET_TEXT_AREA_INPUT” on page 354
• “GET_DROP_DOWN” on page 355
• “GET_BUTTON” on page 357
• “GET_TABLE” on page 358
• “GET_FILE_UPLOAD” on page 360
• “SET_MESSAGE” on page 361
• “CREATE_ACTION” on page 362
• “EXECUTE_ACTION” on page 362
• “EXECUTE_LINE_ITEM_ACTION” on page 364
• “UPDATE_DIALOG” on page 365

9.5.1.4.1 CHANGE_BULK_OBJECTS

This method is called before the GET_ACTION_DIALOG method is called. The selected
objects, that could be locked, are contained in parameter PIT_BULK_OBJECTS.

Parameter Type Description

PI_ACTION_ID Importing Action ID
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PIH_DATA_COLLECTION Importing Data collection instance

VIM200405-CGF-EN-02 Configuration Guide for Foundation 347

Chapter 9 Fiori Task App

Parameter Type Description

PIT_BULK_OBJECTS Importing Set the title for each object using the
SET_TITLE method.
Use the EXCLUDE_OBJECT method to
exclude objects from this list. When
calling the method, you can set the
message that is displayed in the
overview of the selected objects.
Method SET_SEMANTIC_OBJ_NAV_
TARGET can be used to set the semantic
object navigation target in the explicit
bulk mode.

9.5.1.4.2 GET_ACTION_DIALOG

This method returns main information for the Action dialog box.

Parameter Type Description

PIT_KEYS Importing Object keys
PIT_ACTION_OBJECT Importing Contains instances of the selected work
objects.
Also contains the work object in case of
a single action.
Importing parameter PIT_KEYS is not
set in case of bulk actions.
PI_WOBJ_TYPE Importing Work object type
PI_ACTION_ID Importing Action ID
PI_LOGSYS Importing Logical system
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PIH_DATA_COLLECTION Importing Data collection instance

PES_ACTION_DIALOG Exporting Action dialog box information
PET_RETURN Exporting Messages
PE_ERROR_TYPE Exporting Error type

Structure of the PES_ACTION_DIALOG parameter:

Field name Description

TITLE Dialog title.
ICON Icon.

348 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.5. Actions

Field name Description

BUTTON_TITLE Title of action button.
BUTTON_ICON Icon for action button.
BUTTON_TOOLTIP Tooltip for the action button.
EXPAND_ON_PHONE Dialog box should be expanded on smartphone.
CONTENT_WIDTH Width of dialog box.
PERSPECTIVE_ID Use to change the perspective for the dialog.
MSG_TEXT Message text. For details, see STATUS (following row)
STATUS Possible values:
DIALOG: opens the dialog box (default value).
MSG_SUCC: displays a success messsage in the
MSG_TEXT field without showing the dialog box.
MSG_ERROR: displays an error message in the
MSG_TEXT field without showing the dialog box.
MSG_EXIT_HANDLING Defines the behavior of the application after the message
has been displayed. Possible values:
REFR_COMPL: Refresh the complete app.
REFR_ITM: Refresh the current item.
REMOVE_ITM: Remove the current item from the
master list and display the details of the next item.
DIALOG_STATE You can configure a state for an action dialog. The action
dialog is colored according to the DIALOG_STATE
value.
Possible values:
ERROR
NONE
SUCCESS
WARNING
Default value is NONE.

9.5.1.4.3 GET_TEXT_AREA

This method returns the definition of a text area.

Parameter Type Description

PI_ACTION_ID Importing Action ID
PI_VIEW_ID Importing Perspective View ID
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_WOBJ_TYPE Importing Work object type

VIM200405-CGF-EN-02 Configuration Guide for Foundation 349

Chapter 9 Fiori Task App

Parameter Type Description

PI_LOGSYS Importing Logical system
PIT_KEYS Importing Object keys
PIT_ACTION_OBJECT Importing Contains instances of the selected work
objects.
Also contains the work object in case of
a single action.
Importing parameter PIT_KEYS is not
set in case of bulk actions.
PIH_DATA_COLLECTION Importing Data collection instance
PET_RETURN Exporting Messages
PE_ERROR_TYPE Exporting Error type
PES_TEXT_AREA Exporting Text area definition

Structure of the PES_TEXT_AREA parameter:

Field name Description

UPDATE_ON_VALUE_CHANGE Set this flag if the view should be re-read after the
UPDATE_DIALOG method has been called.
UPDATED Text has been changed and field update is required.
TEXT Displayed text.
DO_NOT_SHOW Default value is <space>, meaning the object is
displayed.

9.5.1.4.4 GET_MSG_CONTAINER

This method returns a container for messages.

Parameter Type Description

PI_WOBJ_TYPE Importing Work object type
PI_LOGSYS Importing Logical system
PIT_KEYS Importing Object keys
PIT_ACTION_OBJECT Importing Contains instances of the selected work
objects.
Also contains the work object in case of
a single action.
Importing parameter PIT_KEYS is not
set in case of bulk actions.
PI_ACTION_ID Importing Action ID

350 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.5. Actions

Parameter Type Description

PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_VIEW_ID Importing View ID

PIH_DATA_COLLECTION Importing Data collection instance
PES_MSG_CNT Exporting Message container definition
PET_RETURN Exporting Messages
PE_ERROR_TYPE Exporting Error type

Structure of the PES_MSG_CNT parameter:

Field name Description

UPDATE_ON_VALUE_CHANGE Set this flag if the view should be re-read after the
UPDATE_DIALOG method has been called.
UPDATED Messages have been changed and update is required.
DESCRIPTION Description for messages.
ICON Message icon.
IS_EXPANDED Expand container for additional messages.
STATE Container state:
00 - None
01 - Error
02 - Information
03 - Success
04 - Warning
MORE Additional messages are available.
VISIBLE Container box is visible.

9.5.1.4.5 GET_MESSAGES

This method returns messages for a message container.

Parameter Type Description

PI_WOBJ_TYPE Importing Work object type
PI_LOGSYS Importing Logical system
PIT_KEYS Importing Object keys

VIM200405-CGF-EN-02 Configuration Guide for Foundation 351

Chapter 9 Fiori Task App

Parameter Type Description

PIT_ACTION_OBJECT Importing Contains instances of the selected work
objects.
Also contains the work object in case of
a single action.
Importing parameter PIT_KEYS is not
set in case of bulk actions.
PI_ACTION_ID Importing Action ID
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_VIEW_ID Importing View ID

PIH_DATA_COLLECTION Importing Data collection instance
PET_MESSAGES Exporting Messages
PET_RETURN Exporting Error messages
PE_ERROR_TYPE Exporting Error type

Structure of the PET_MESSAGES parameter:

Field name Description

MESSAGE_ID ID of the message
TEXT Message text
ICON UI5 icon displayed in front of the message
STATE Possible values:
None
01 Error
02 Information
03 Success
04 Warning

9.5.1.4.6 GET_INPUT_FIELD

This method returns the definition of an input field.

Parameter Type Description

PI_WOBJ_TYPE Importing Work object type
PI_LOGSYS Importing Logical system
PIT_KEYS Importing Object keys

352 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.5. Actions

Parameter Type Description

PIT_ACTION_OBJECT Importing Contains instances of the selected work
objects.
Also contains the work object in case of
a single action.
Importing parameter PIT_KEYS is not
set in case of bulk actions.
PI_ACTION_ID Importing Action ID
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_VIEW_ID Importing View ID

PIH_DATA_COLLECTION Importing Data collection instance
PES_INPUT_FIELD Exporting Input field definition
PET_RETURN Exporting Error messages
PE_ERROR_TYPE Exporting Error type

Structure of the PES_INPUT_FIELD parameter:

Field name Description

TYPE ABAP data type.
LENGTH Length.
LABEL Label text.
VALUE Field value.
HAS_VALUE_DESC The value description is available.
VALUE_DESCRIPTION Value description.
UPDATE_ON_VALUE_CHANGE Trigger update if field value changes.
UPDATE_REQUIRED Set this flag if the view should be re-read after the
UPDATE_DIALOG method has been called.
REQUIRED Mark field as required.
SHOW_VALUE_HELP Display value help.
VALUE_HELP_ID Value help ID.
VALUE_HELP_VAR Help variant:
01 - F4 help only
02 - F4 help with suggestions
04 - Suggestions
05 - F4 help with input field

VIM200405-CGF-EN-02 Configuration Guide for Foundation 353

Chapter 9 Fiori Task App

Field name Description

VALUE_HELP_MASTER_FIELD Master field of the value help. This is the field in the
value help whose value should be transferred into
the input field.
READ_ONLY Field is read only.
CHECKBOX Display field as check box.
VALUE_STATE Value state:
• ERROR
• NONE
• SUCCESS
• WARNING

VALUE_STATE_TEXT Text for value state.

DO_NOT_SHOW Default value is <space>, meaning the object is
displayed.

9.5.1.4.7 GET_TEXT_AREA_INPUT

This method returns the definition for the text area input field.

Parameter Type Description

PI_ACTION_ID Importing Action ID
PI_VIEW_ID Importing View ID
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_WOBJ_TYPE Importing Work object type

PI_LOGSYS Importing Logical system
PIT_KEYS Importing Object keys
PIT_ACTION_OBJECT Importing Contains instances of the selected work
objects.
Also contains the work object in case of
a single action.
Importing parameter PIT_KEYS is not
set in case of bulk actions.
PIH_DATA_COLLECTION Importing Data collection instance
PET_RETURN Exporting Error messages
PE_ERROR_TYPE Exporting Error type
PES_TEXT_AREA_INPUT Exporting Text area definition

354 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.5. Actions

Structure of the PES_TEXT_AREA_INPUT parameter:

Field name Description

LABEL Label text.
VALUE Field value.
UPDATE_ON_VALUE_CHANGE Trigger update if field value changes.
UPDATE_REQUIRED Set this flag if the view should be re-read after the
UPDATE_DIALOG method has been called.
REQUIRED Mark field as required.
READ_ONLY Field is read only.
VALUE_STATE Value state:
• ERROR
• NONE
• SUCCESS
• WARNING

VALUE_STATE_TEXT Text for value state.

VALUE_PLACE_HOLDER Placeholder text. It is displayed before the user starts
to edit the field.
DO_NOT_SHOW Default value is <space>, meaning the object is
displayed.

9.5.1.4.8 GET_DROP_DOWN

This method returns the definition of the drop-down list (MultiComboInput view).

Parameter Type Description

PI_ACTION_ID Importing Action ID
PI_VIEW_ID Importing View ID
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_WOBJ_TYPE Importing Work object type

PI_LOGSYS Importing Logical system
PIT_KEYS Importing Object keys

VIM200405-CGF-EN-02 Configuration Guide for Foundation 355

Chapter 9 Fiori Task App

Parameter Type Description

PIT_ACTION_OBJECT Importing Contains instances of the selected work
objects.
Also contains the work object in case of
a single action.
Importing parameter PIT_KEYS is not
set in case of bulk actions.
PIH_DATA_COLLECTION Importing Data collection instance
PET_RETURN Exporting Error messages
PE_ERROR_TYPE Exporting Error type
PES_DROP_DOWN Exporting Drop-down definition

Structure of the PES_DROP_DOWN parameter:

Field name Description

LABEL Label text.
VALUE Selected value.
UPDATE_ON_VALUE_CHANGE Trigger update if field value changes.
UPDATE_REQUIRED Set this flag if the view should be re-read after the
UPDATE_DIALOG method has been called.
REQUIRED Mark field as required.
READ_ONLY Field is read only.
VALUE_STATE Value state:
• ERROR
• NONE
• SUCCESS
• WARNING

VALUE_STATE_TEXT Text for value state.

MULTI_SELECT Set this flag if multiple values can be selected.
ENTRIES Available entries.
DO_NOT_SHOW Default value is <space>, meaning the object is
displayed.

356 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.5. Actions

9.5.1.4.9 GET_BUTTON

This method returns the definition of a button.

Parameter Type Description

PI_ACTION_ID Importing Action ID
PI_VIEW_ID Importing View ID
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_WOBJ_TYPE Importing Work object type

PI_LOGSYS Importing Logical system
PIT_KEYS Importing Object keys
PIT_ACTION_OBJECT Importing Contains instances of the selected work
objects.
Also contains the work object in case of
a single action.
Importing parameter PIT_KEYS is not
set in case of bulk actions.
PIH_DATA_COLLECTION Importing Data collection instance
PET_RETURN Exporting Error messages
PE_ERROR_TYPE Exporting Error type
PES_BUTTON Exporting Button definition

Structure of the PES_BUTTON parameter:

Field name Description

UPDATE_ON_VALUE_CHANGE Trigger update if field value changes.
UPDATE_REQUIRED Set this flag if the view should be re-read after the
UPDATE_DIALOG method has been called.
ICON Button icon.
TOOLTIP Button tooltip.
TEXT Button text.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 357

Chapter 9 Fiori Task App

Field name Description

BUTTON_TYPE Button type:
ACCEPT - Accept type (blue button)
DEFAULT - Default type (no special styling)
EMPHASIZED - Emphasized type
REJECT - Reject style (red button)
TRANSPARNT - Transparent type
UNSTYLED - Unstyled type (no styling)
ENABLED Set this flag if the button is active.
DO_NOT_SHOW Default value is <space>, meaning the object is
displayed.

9.5.1.4.10 GET_TABLE

This method returns the table definition.

Parameter Type Description

PI_ACTION_ID Importing Action ID
PI_VIEW_ID Importing View ID
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_WOBJ_TYPE Importing Work object type

PI_LOGSYS Importing Logical system
PIT_KEYS Importing Object keys
PIT_ACTION_OBJECT Importing Contains instances of the selected work
objects.
Also contains the work object in case of
a single action.
Importing parameter PIT_KEYS is not
set in case of bulk actions.
PIH_DATA_COLLECTION Importing Data collection instance
PET_RETURN Exporting Error messages
PE_ERROR_TYPE Exporting Error type
PES_TABLE Exporting Table definition

Structure of the PES_TABLE parameter:

Field name Description

UPDATE_ON_VALUE_CHANGE Trigger update if field value changes.

358 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.5. Actions

Field name Description

UPDATE_REQUIRED Set this flag if the view should be re-read after the
UPDATE_DIALOG method has been called.
LABEL Label for table.
REQUIRED Table content must be selected or set. With this flag,
the table will be marked as required.
SELECT_MODE Select mode for table entries:
SINGLE - Single selection
MULTI - Multi selection
DELETABLE - Entry can be deleted.
NONE - No selection
READ_ONLY Set this flag if the table content is read-only and
cannot be changed.
COLUMNS Columns definition.
ITEMS Table items.
DO_NOT_SHOW Default value is <space>, meaning the object is
displayed.

Structure of the COLUMNS field:

Field name Description

COLUMN_ID Column ID.
TITLE Column title.
READ_ONLY Column is read-only.
PRIO_MOBILE Set this flag if this field should be displayed on a
smartphone with priority. It will still be displayed as
columns, other fields can be displayed as a list.
HELP_ID Value help ID.
HELP_VARIANT Value help variant:
01 - F4 help only
02 - F4 help with suggestions
04 - Suggestions
05- F4 help with input field
HELP_MASTER_FIELD Master field of the value help.
DATA_TYPE ABAP data type.
DATA_LENGTH Field length.
DO_NOT_SHOW Default value is <space>, meaning the object is
displayed.

Structure of the ITEMS field:

VIM200405-CGF-EN-02 Configuration Guide for Foundation 359

Chapter 9 Fiori Task App

Field name Description

ITEM_ID Item ID.
SELECTED Item is selected.
VALUE_01 Value of column 01
VALUE_02 Value of column 02
VALUE_03 Value of column 03
VALUE_04 Value of column 04
VALUE_05 Value of column 05
DO_NOT_SHOW Default value is <space>, meaning the object is
displayed.

9.5.1.4.11 GET_FILE_UPLOAD

This method defines the layout of the upload control. Called at initial load of Action
Dialog box and after Dialog updates.

Parameter Type Description

PI_WOBJ_TYPE Importing Work object type
PI_ACTION_ID Importing Action ID
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PIT_KEYS Importing Object key

PIT_ACTION_OBJECT Importing Contains instances of the selected work
objects.
Also contains the work object in case of
a single action.
Importing parameter PIT_KEYS is not
set in case of bulk actions.
PI_VIEW_ID Importing View ID
PI_LOGSYS Importing Logical system
PIH_DATA_COLLECTION Importing Data collection
PES_FILE_UPLOAD Exporting File upload control information
PET_RETURN Exporting Error messages
PE_ERROR_TYPE Exporting Error type

Structure of parameter PES_FILE_UPLOAD:

360 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.5. Actions

Field name Description

DO_NOT_SHOW Control is not displayed
VALUE_STATE Value state of upload field
VALUE_STATE_TEXT Message displayed
UPDATE_ON_VALUE_CHANGE Value change of upload field triggers update of
ActionDialog.
UPDATE_REQUIRED Control needs to be refreshed by the UI.
BUTTON_ICON Icon on button
BUTTON_TITLE Button title
BUTTON_TYPE Button type
LABEL Label text
PLACE_HOLDER_TEXT Placeholder text in upload field
REQUIRED Upload is required.
MAX_FILE_SIZE Maximum file size in byte
ALLOWED_DOC_CLASSES Allowed document classes (as customized in
V_TOADD)
MULTIPLE Enables the upload of multiple files

Before uploading the file, the VIM Foundation checks if the file fits to the defined file
size and if the mime type fits to the mime type of one of the allowed document
classes. Only the content of documents matching these criteria will be saved in the
system. Error messages of these checks are transferred to the ActionDialog
implementation by calls of method SET_MESSAGE. For more information, see
“SET_MESSAGE” on page 361

9.5.1.4.12 SET_MESSAGE

This method transfers messages of the VIM Foundation, for example errors
occurring during the file upload, to the ActionDialog implementation. The
ActionDialog implementation has to take care that these messages are displayed.
Class /OTX/PF63_CL_ACTION_DIALOG already provides a logic for handling these
messages.

Parameter Type Description

PI_MESSAGE_TYPE Importing Message type
PI_MESSAGE_TEXT Importing Message text
PIH_DATA_COLLECTION Importing Data collection

VIM200405-CGF-EN-02 Configuration Guide for Foundation 361

Chapter 9 Fiori Task App

9.5.1.4.13 CREATE_ACTION

This method is called at the execution of create actions.

Parameter Type Description

PIS_ACTION_EXECUTE Importing Execute Action dialog action
PIH_DATA_COLLECTION Importing Data collection
PET_RETURN Exporting Return parameter table
PE_ERROR_TYPE Exporting Error type
PES_RESULT Exporting Action dialog result
PCT_KEYS Changing Values for a key

The structure of parameter PIS_ACTION_EXECUTE is explained in detail in method

EXECUTE_ACTION. For more information, see “EXECUTE_ACTION” on page 362.
PCT_KEYS contain the key values as they can be defined by the VIM Foundation. The
solution implementation must take care to set the complete key for the new object.

9.5.1.4.14 EXECUTE_ACTION

This method is called at the execution of the action.

Parameter Type Description

PIS_ACTION_EXECUTE Importing Action information
PIH_DATA_COLLECTION Importing Data collection instance
PIT_BULK_RESULTS Importing Contains the selected object instances.
For each object, the result needs to be
set using the SET_STATE method.
Possible values are:
UPDATE > Object data is updated in
master list.
REMOVE > Object is removed from
master list.
ERROR > Object processing is
considered as erroneous.
PET_RETURN Exporting Error messages
PE_ERROR_TYPE Exporting Error type
PE_ERROR_HANDLING Exporting Error handling
PES_RESULT Exporting Action result

Structure of the PIS_ACTION_EXECUTE parameter:

Field name Description

WOBJ_TYPE Work object type

362 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.5. Actions

Field name Description

LOGSYS Logical system
VIEW_ID View ID
KEYS Object keys
ACTION_ID Action ID
UPDATE_INPUT_FIELDS Input fields with current values
UPDATE_TEXT_AREAS Text areas with current values
UPDATE_SELECTED_ENTRIES Selected entries in drop-down list
UPDATE_TABLE_ITEMS Current table items
UPLOAD_DOCUMENTS File Upload
UPL_DOC_JSON_STRUC Contains table content when a CSV document is
uploaded. The table content has the following
structure:

INDEX
Row index
FIELDNAME
Column name
FIELDVALUE
Cell content

Use the TABLE_DATA_UNPACK_STR method of /

OTX/PF00_CL_UTILITIES class to transfer content
into a solution specific table structure. For more
information, see “/OTX/
PF00_CL_UTILITIES=>TABLE_DATA_UNPACK”
on page 531.

Structure of the PES_RESULT parameter:

Field name Description

MSG Message text

VIM200405-CGF-EN-02 Configuration Guide for Foundation 363

Chapter 9 Fiori Task App

Field name Description

STATUS Dialog status:

DLG_ERROR
Show error in dialog
GEN_ERROR
Show general action error
DLG_ERROR and GEN_ERROR can also be used in
a bulk scenario.
UPDATE
Update object details
REMOVE
Remove object from master list
DO_NAV
Navigate to next object
Use the STATUS_PARAMETER field to set the
semantic object navigation target.

STATUS_PARAMETER Sets additional STATUS field parameters. For

example, when STATUS has the value DO_NAV, this
field must contain the semantic object navigation
target.

9.5.1.4.15 EXECUTE_LINE_ITEM_ACTION
This method is called at the execution of an ActionDialog action started from an item
in the AdvLineItem table.

Parameter Type Description

PIS_ACTION_EXECUTE Importing Execute Action dialog action
PIH_DATA_COLLECTION Importing Data collection
PIH_TABLE Importing Table information and change
operations
PIH_ITEM Importing Item information and change
operations
PES_RESULT Exporting Action result
PET_RETURN Exporting Error messages for exceptions
PE_ERROR_TYPE Exporting Exception type

Parameters PIS_ACTION_EXECUTE and PES_RESULT are explained in detail for

method EXECUTE_ACTION. For more information, see “EXECUTE_ACTION”
on page 362. Parameter PIH_TABLE provides all information about the table and its
items. With the methods ADD_ROW, DELETE_ROW and SET_ROW_POSITIONS, the table
can be changed. Parameter PIH_ITEM provides all information about the item and
allows changes to this item. Parameter PES_RESULT defines the overall result of the
action.

364 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.5. Actions

For information about the structure of PES_RESULT, see “EXECUTE_ACTION”

on page 362.

9.5.1.4.16 UPDATE_DIALOG

This method is called when a value changes in fields for which the UPDATE_ON_
VALUE_CHANGE flag is set.

The parameters are almost the same as in the EXECUTE_ACTION method, plus the
parameter in the following table. Additionally, EXECUTE_ACTION has the PIT_BULK_
RESULTS parameter. For more information, see “EXECUTE_ACTION” on page 362.

Parameter Type Description

PIT_ACTION_OBJECT Importing Contains instances of the selected work
objects.
Also contains the work object in case of
a single action.
Importing parameter PIT_KEYS is not
set in case of bulk actions.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 365

Chapter 9 Fiori Task App

9.5.1.5 Communication flow of an Action dialog box with bulk actions

366 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.5. Actions

Figure 9-4: Communication flow of an Action dialog box with bulk actions

VIM200405-CGF-EN-02 Configuration Guide for Foundation 367

Chapter 9 Fiori Task App

1. Request PrepareActionDialogForBulk (only for bulk actions)

When the user runs a bulk action that is linked with an Action dialog box, the
Fiori Task App sends the request PrepareActionDialogForBulk. In the
backend system, the VIM Foundation tries to lock the selected objects and start a
DataCollection for the action. It returns to the Fiori app which objects can be
processed and additional information if an object cannot be processed. The Fiori
Task App displays an overview of the objects and the additional information in a
dialog box.
Solutions can influence the locking of work objects in general with
implementations for BAdI /OTX/PF00_LOCK. You can implement bulk action
specific logics to allow/disallow the processing of single objects in method /OTX/
PF62_IF_ACTION_DIALOG~CHANGE_BULK_OBJECTS. You can also set the object
titles using this method. In full screen mode, the Fiori app is not able to calculate
these object titles automatically. Therefore they must be set by the solutions. At
the start of the DataCollection, the solutions can implement additional logics
in the methods /OTX/PF00_IF_DATA_COLLECTION~CREATE_COLLECTION and /
OTX/PF62_IF_DATA_COLLECTION~SET_ADDITIONAL_INFORMATION of the used
class.

Note: In case of a single action, the object key of the current object is
defined in all methods of interface /OTX/PF62_IF_ACTION_DIALOG by the
import parameters PIT_KEYS, PI_LOGSYS, and PI_WOBJ_TYPE. The
parameters PIT_KEYS and PI_LOGSYS cannot be set in case of bulk actions.
Therefore, the methods of interface /OTX/PF62_IF_ACTION_DIALOG have
now the additional parameter PIT_ACTION_OBJECT which contains
instances of the processed objects. In method EXECUTE_ACTION, this
parameter is replaced by parameter PIT_BULK_RESULTS.
2. Request SetLock (only for single actions)
When the user runs an action, the Fiori Task App sends a SetLock request for
the current object. In the backend system, the VIM Foundation tries to lock this
object.
Solutions can use BAdI /OTX/PF00_LOCK to influence the locking for a work
object.
3. Request StartDataCollection (only for single actions)
After a successful lock, the Fiori Task App sends the request
StartDataCollection. The VIM Foundation in the backend creates the data
collection. At creation of the DataCollection, the methods /OTX/PF00_IF_
DATA_COLLECTION~CREATE_COLLECTION and /OTX/PF62_IF_DATA_
COLLECTION~SET_ADDITIONAL_INFORMATION are called. These methods belong
to the data collection class of the current work object type. Therefore, data
necessary for the Action dialog box can be collected.
4. Requests Perspective and ActionDialog
In this step, the Fiori Task App requests the perspective for the ActionDialog
and general information for the ActionDialog window. The perspective
information is returned as it has been defined in the PerspectiveManager. If

368 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.5. Actions

DataBindings are used, the values for the DataBinding are read now. For the
ActionDialog information, method /OTX/PF62_IF_ACTION_DIALOG~GET_
ACTION_DIALOG is called. This method must be implemented by the solutions.
In case of a single action processing, this is the first time when the action ID is
known in the backend system. Depending on the action ID, add data to the data
collection the first time this method is called.
5. Requests for ActionDialog UI elements (ActionDlg* requests)
The Fiori Task App requests the data for all views of the perspective
customizing of the Action dialog box. These data must be set in the /OTX/PF62_
IF_ACTION_DIALOG~GET* methods. Each method gets an instance of the data
collection class as an import parameter. Therefore, the data of the data collection
can easily be accessed.
6. TransferActionDlg* and UpdateActionDialog requests
After changing an input field where the UPDATE_ON_VALUE_CHANGE flag is set,
the Fiori Task App transfers the current dialog values to the backend and
requests information how the dialog should be updated. The VIM Foundation in
the backend collects the current values of the dialog and calls method /OTX/
PF62_IF_ACTION_DIALOG~UPDATE_DIALOG. This method contains the view ID of
the field that triggered the update and contains the current data of the Action
dialog box. Therefore, the data in the data collection class can be updated and
checks can be performed.
After each update, the GET_* methods for the views that require an update
(UPDATE_REQUIRED flag) are called. Additionally, the Action dialog box is
updated.
Request flows 6 and 5 are repeated each time the user does a change that triggers
an update.
7. TransferActionDlg* and ExecuteActionDialog requests
When the user clicks the action button in the Action dialog box, the Fiori Task
App transfers the current information to the backend and requests the execution
of the action. In the backend, the VIM Foundation collects the transferred
information and calls method /OTX/PF62_IF_ACTION_DIALOG~EXECUTE_
ACTION for the execution of the action. The parameters of this method contain all
data available in the Action dialog box. The result of the execution is set in
parameter PES_RESULT, field STATUS and MSG. For details on these parameters,
see “EXECUTE_ACTION” on page 362.
For the bulk actions, the status of each object must be set in parameter PIT_
BULK_RESULTS.
In case of a single action, the Fiori Task App either displays the message and
update the object as requested or returns to the dialog. In case of a bulk action, it
will only do this for the statuses GEN_ERROR and DLG_ERROR.
8. Request FinishActionDialogForBulk (only bulk action)
When the ExecuteActionDialog did not return an error status, the Fiori Task
App sends the FinishActionDialogForBulk request to retrieve the results for
the objects from the backend. At this call, the VIM Foundation returns the results

VIM200405-CGF-EN-02 Configuration Guide for Foundation 369

Chapter 9 Fiori Task App

it got in the previous call of method /OTX/PF62_IF_ACTION_DIALOG~EXECUTE_

ACTION. It also removes the DataCollections (method /OTX/PF00_IF_DATA_
COLLECTION~REMOVE_COLLECTION) and removes the locks for all objects (BAdI /
OTX/PF00_LOCK).

9. Request RemoveDataCollection (only for single actions)

When the action has been executed (successfully or with error), the Fiori Task
App sends request RemoveDataCollection to remove the DATACollection of
the ActionDialog. The VIM Foundation calls method /OTX/PF00_IF_DATA_
COLLECTION~REMOVE_COLLECTION of the data collection class. The
implementation of this method should delete all collected data.
10. Request RemoveLock (only for single actions)
Finally, the Fiori Task App requests the removal of the lock. The VIM
Foundation removes the lock in the backend system (BAdI /OTX/PF00_LOCK).

The /OTX/PF63_CL_DACO_WOBJ class is an example data collection, which handles

messages occurring during an Action dialog box. The Action dialog box logic for
these messages is implemented in the /OTX/PF63_CL_ACTION_DIALOG class. /OTX/
PF63_CL_ACTION_DIALOG handles the logic for the action messages views PF63_AM_
ERROR (error messages), PF63_AM_WARN (warning messages) and PF63_AM_INFO
(information messages).

Messages for these views can be set using the /OTX/PF63_UPDATE_MESSAGES

method. Additionally, this class allows you to check required fields and to set value
state information for input fields. Field information can be set by calling the /OTX/
PF63_SET_FIELD_INFO method.

To check the required fields, call the /OTX/PF63_CHECK_FIELDS or /OTX/PF63_

CHECK_REQ_FIELDS methods in the /OTX/PF62_IF_ACTION_DIALOG~EXECUTE_
ACTION and /OTX/PF62_IF_ACTION_DIALOG~UPDATE_DIALOG methods. If you want
to use the features of the /OTX/PF63_CL_DACO_WOBJ class, you have to inherit your
action dialog class from the /OTX/PF63_CL_ACTION_DIALOG class and the data
collection class from class /OTX/PF63_CL_DACO_WOBJ. In the perspective
customizing, maintain the views as needed.

9.5.2 Semantic object navigation

The Fiori Task App supports intent-based navigation to another Launchpad app or
Fiori Task App instance from the following data views:

Customizing
You can configure the navigation using VIM Foundation customizing (see “Semantic
object navigation in the Fiori Task App” on page 384). In this case, the framework
will at runtime calculate the navigation target with the values of the selected work
object. OpenText recommends that you use this configuration.

For simple use cases you can also define the semantic object navigation target in the
customizing of the work object type action in field Link parameter. But as this is a

370 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.5. Actions

static setting used for all items of this work object type, this will in most cases not be
sufficient.

Alternatively, you can implement you own logic to calculate the semantic object
navigation target. Method /OTX/PF62_CL_UTILITIES > GET_JSON_FOR_LINK_PARA
can be called to create the necessary JSON structure.

The JSON data must match the following structure:

{
"target": {
"semanticObject": <semantic object>,
"action": <action>
},
"params": {
<optional parameters>
}
}

The following piece of code is an example. The parameters depend on the

application mode. See the parameters reference in the corresponding application
mode.

Note: The value of the filter and searchValue parameters must be URL-
encoded.

{
"target": {
"semanticObject": "Z_OTX_BC",
"action": "display"
},
"params": {
"nodeId": "PS02_ORDER_INBOX",
"wobjType": "PS02_PRC_ORDER",
"workplaceId": "WP_INBOX",
"filter": "VKORG%20EQ%201000%20AND
%20VT_WEG%20EQ%2001",
"searchField": "KUNNR",
"searchValue": "1000",
"sortOption": "WI_PRIO",
"sortDirection": "ASC"
}
}

Depending on where the semantic object navigation action is integrated, this JSON
data must be provided:

Action in Provide JSON structure in

Root work object type Web handler (interface /OTX/PF62_IF_ITEM_HANDLER)
method CHANGE_ACTIONS parameter PCT_ACTIONS field
NAV_PARAMETER

or Perspective class (interface /OTX/PF62_IF_PERSPECTIVE_

CLASS) method CHANGE_DATA parameter PCS_OBJECT_
ACTIONS field ACTIONS- NAV_PARAMETER

VIM200405-CGF-EN-02 Configuration Guide for Foundation 371

Chapter 9 Fiori Task App

Action in Provide JSON structure in

Advanced line item Perspective class (interface /OTX/PF62_IF_PERSPECTIVE_
CLASS) method CHANGE_ACTION_PARAMETER parameter PC_
PARAMETER
Full screen list item Node exit class (interface /OTX/PF63_IF_FS_LIST) method
CHANGE_DATA parameter PIH_FS_LIST_CHANGE method /
OTX/PF62_IF_FC_FSL_CHANGE~ADD_ROW parameter PIT_
CELL_VALUES field CELL_VALUE_EXT

9.6 Configuration
9.6.1 Basic settings
The basic settings allow general settings for the display of documents and the
definition of the keys for the work object types, displayed in the Fiori Task App.

To customize the basic Web Services settings in the IMG:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services
3. Click the setting that you want to maintain:

• Basic Settings
• Launchpad Setting Actions

9.6.1.1 Configuring basic settings

To configure basic settings:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Basic Settings > Basic Settings.
3. In the Basic Settings Overview screen, configure basic settings using the
following parameters.

Device type
Device type. You can define the settings for each device type: Tablet,
Desktop, Smart phone, Hybrid devices, All devices.

Setting
Use web viewer (if available) for desktop document view.
X (use WebViewer or Brava! View if available).
Maximum file size upload dialog (default 10 MB)
Define size in bytes.
Default system alias

372 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

Specify the system alias used for asynchronous data preparation.

Stream document
X (Document streams through Odata service. Only PDF documents are
displayed).
Value
Define the appropriate value for each Setting you configure.

General document viewing notes

• Web Viewer or Brava! View can only be switched off (or is not
mandatory) if the archive delivers the documents as PDFs. In that case,
the native PDF viewer of the client is launched to display the document.
On iOS devices, the native viewer is launched in a separate browser tab
when touching the first page image.
• If you use the SAP Business Technology Platform deployment option,
do not activate Web Viewer, as it is not supported within this
deployment option.

9.6.1.2 Configuring the integration of standard or solution specific Apps

into the user menu
The Fiori App allows to integrate standard or solution specific Apps into the user
menu.

Whenever the Fiori App is called in the SAP Fiori Launchpad, the App checks how
the Launchpad is customized and adds the defined Apps to the user menu.

You define the object navigation to other Apps in the Launchpad Setting Actions.
Your settings are restricted by the workplace, the optional node and by an action ID.

Note: You have to authorize the users to the action ID in the J_6NPF_WTY
object.

To configure the integration of Apps into the user menu:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Basic Settings > Launchpad Setting Actions.

3. Click New Entries.

4. In the New Entries: Overview of Added Entries screen, configure basic settings
using the following parameters.
Entries to define the app or node that contains additions in in the User menu

Work Center ID
Unique ID of the work center.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 373

Chapter 9 Fiori Task App

Node ID
Unique ID of the node. For information about defining nodes, see “Defining
nodes” on page 294.
Workobject type
Work object type which contains the Apps in the user menu.
Action ID
ID of the action.
Device type
Device type. Possible values:

• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

Entries to define the standard or solution specific Apps that are shown the User
menu

Web Icon
Add the icon that is shown for the app.
Semantic Object Action
Add the action that is performed for a bundle of applications that form the
semantic object.
ShellHash
Add the routing path of the part of the app that you want to show.
Action Text
Add the text that displays for your users.
Tooltip
Add the text that displays when you mouse-over.

5. Optional If you want to deactivate an App in the User menu, select the Inactive
check-box

374 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

9.6.2 Work object type

Work object types maintained in the /n/OTX/PF00_IMG transaction > OpenText
Vendor Invoice Management Foundation > Workplace Configuration > Work
object types > Work object types (see “Defining work object types” on page 266) are
automatically available in this maintenance view.

If you create a new work object type in this view, you also need to maintain the
settings in OpenText Vendor Invoice Management Foundation > Workplace
Configuration > Work object types > Work object types for the new work object
type.

To enable a work object type for the Fiori Task App:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Work Object Type > Work Object Type.

3. In the Work Object Type Overview screen, enable work object types for the
Fiori Task App, using the following parameters.

Work object type

Work object type to be enabled for the Fiori Task App.
Web/Mobile item handler class
Enter the exit to change or enable the displayed web content for objects of
this work object type and to define and run actions for this work object
type. Interface: /OTX/PF62_IF_ITEM_HANDLER. For more information, see
“Web handler” on page 451.
For work object types based on a process configuration, use the default
implementation /OTX/PF31_CL_BPF_WI_WEB_HANDLE. With this class, all
settings in the process configuration related to the mobile UI are
automatically considered.

9.6.2.1 Defining keys for the work object type

In this step, you configure the definition of the key for a work object type based on
the fields of the display structure. Web Services select the work object with this key
using the handler class of the work object type.

Note: Ensure that all key fields are available in display and selection structure
of the work object type.

To define keys for the work object type:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Work Object Type > Work Object Type.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 375

Chapter 9 Fiori Task App

3. In the Work Object Type Overview screen, mark a work object type, and then
double-click Key definition in the Dialog Structure.

4. In the Key Definition Overview screen, define keys for the work object type,
using the following parameters.

Key pos.
Key position. Define the position of the field in the key. 16 position values
are available.
Field Name
Enter the name of the field.
Log. Sys.
Logical System. Select this check box to define that the content of this field
contains the logical system.

Important
The overall length of the key fields must not exceed 117 characters.

9.6.2.2 Defining aliases for a work object

For each work object type, you can define aliases for the web ID. You can use this
alias for the app mode OBJ for the webIdAlias parameter . Compared to the
generated webIds this alias is stable, whereas the generated webIds are temporary,

To define an alias for a work object:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Work Object Type > Work Object Type.

3. In the Work Object Type Overview screen, mark a work object type, and then
double-click Alias in the Dialog Structure.

4. In the Alias Overview screen, define aliases for the work object type, using the
following parameters:

Alias for Web ID

Enter the alias that you want to create for the work object.

5. Mark an alias, and then double-click Alias Object - Key Values in the Dialog
Structure.

6. In the Alias Object - Key Values Overview screen, enter key values for the alias
object, using the following parameters:

Field Name
Choose the key fields and set the values of the work object. You must
maintain values for all key fields.

376 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

Value
Enter the corresponding value.

9.6.2.3 Defining a related business object for a work object type

For each work object type, you can define a related business object. This business
object can be used, for example, to open a related Extended ECM for SAP Solutions
workspace.

To define a related business object for a work object type:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Work Object Type > Work Object Type.

3. In the Work Object Type Overview screen, mark a work object type, and then
double-click Related business object in the Dialog Structure.

4. In the Related Business Object Details screen, configure the related business
object using the following parameters.

Work object type

Work object type that the business object relates to.
Object Type
Enter the SAP business object type.

Example: For the Sales Order solution (OTBCSL02), this can be the object
type KNA1 (customer) with the key field KUNNR (customer number).

Field List (Key)

Enter key fields of the business object in a comma-separated list. Use fields
of the display structure of the work object type.
Use the CHANGE_RELATED_BUS_OBJECT method of the web handler interface
to change the customized business object at runtime.

9.6.2.4 Maintaining Data Collections

In the Fiori Task App, you can use Data Collections to temporarily store data during
a certain process step for the currently used work object. This allows, for example,
an implementation of the web handler interface to access information processed in a
previous call.

Additionally the /OTX/PF62_IF_PERSPECTIVE_CLASS interface has the MH_

PERSPECTIVE_INFO attribute. This attribute is a instance of the /OTX/PF62_IF_
PERS_INFO interface . Use the GET_PERSPECTIVE_VIEWS and GET_PERSPECTIVE_INF
methods to get information about the currently used perspective. GET_ATTRIBUTE_
LISTS and GET_TABLES methods offer read access to attribute lists and tables.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 377

Chapter 9 Fiori Task App

To maintain Data Collections:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Work Object Type > Work Object Type.

3. In the Work Object Type Overview screen, mark a work object type, and then
double-click Data Collections in the Dialog Structure.

4. In the Data Coll. Scope (Data Collections Scope) field, select the scope (process
step) for which this data collection should be used. Possible values:

Action Dialog
Data Collection starts before an action dialog box opens and is finished
when the action dialog box closes.
Perspective Life Time Token
Data Collection starts when a item perspective is loaded and ends when the
user leaves this item perspective.

5. In the Data Collection field, maintain an implementation of the interface /OTX/

PF62_IF_DATA_COLLECTION. This implementation contains the read and write
logic for the information save in the Data Collection.

9.6.2.4.1 Interface /OTX/PF62_IF_DATA_COLLECTION

Attributes:

Attribute /OTX/ Level Type Description

PF62_IF_PERSPEC
TIVE_CLASS.
/OTX/ Instance Attribute /OTX/ Data Collection ID
PF00_IF_DATA_COL PF00_E_DATA_COL
LECTION~M_COLL LECTION_ID
ECTION_ID
/OTX/ Instance Attribute /OTX/ Data Collection Scope
PF00_IF_DATA_COL PF00_E_DATA_COL
LECTION~M_SCOPE L_SCOPE
/OTX/ Instance Attribute /OTX/ Valid until
PF00_IF_DATA_COL PF00_E_VALID_UN
LECTION~M_VALID TIL
_UNTIL
/OTX/ Instance Attribute /OTX/ Key values
PF00_IF_DATA_COL PF00_TT_KEY_VAL
LECTION~MT_KEY_ UES
VALUES
M_LAST_CHANGE Instance Attribute /OTX/ Timestamp for last
D PF00_E_LAST_CHA change
NGED

378 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

Methods:

/OTX/PF00_IF_DATA_COLLECTION~GET_INSTANCE

This method returns the instance of the data collection class.

Parameter Type Associated Type Description

PI_COLLECTION_ID Importing /OTX/ Data Collection ID
PF00_E_DATA_COL
LECTION_ID
PIT_KEYS Importing /OTX/ Values for a key
PF00_TT_KEY_VAL
UES
PI_CLASSNAME Importing /OTX/ Data Collection class
PF00_E_DATA_COL
L_CLASS
PRH_INSTANCE Returning /OTX/ Data collection
PF00_IF_DATA_COL instance
LECTION

/OTX/PF00_IF_DATA_COLLECTION~CREATE_COLLECTION

This method is called when the data collection is started.

Parameter Type Associated Type Description

PIS_DATA_COLLEC Importing /OTX/ Data Collection
TION PF00_S_DATA_COL Information
L_ADMIN

Structure of PIS_DATA_COLLECTION:

Fieldname Type Description

ID /OTX/ Data Collection ID
PF00_E_DATA_COLLECTIO
N_ID
SCOPE /OTX/ Data Collection Scope
PF00_E_DATA_COLL_SCOP
E
CLASS /OTX/ Data Collection class
PF00_E_DATA_COLL_CLAS
S
VALID_UNTIL /OTX/ Valid until
PF00_E_VALID_UNTIL

/OTX/PF00_IF_DATA_COLLECTION~REMOVE_COLLECTION

VIM200405-CGF-EN-02 Configuration Guide for Foundation 379

Chapter 9 Fiori Task App

This method is called when data collection is finished or deleted by an

administrative program. In this method all temporarily saved data for this data
collection should be cleaned up.

This method does not have any parameters.

SET_ADDITIONAL_INFORMATION

This method is called after call of method /OTX/PF00_IF_DATA_

COLLECTION~CREATE_COLLECTION to set additional web service specific information.

Parameter Type Associated Type Description

PI_LAST_CHANGE Importing /OTX/ Last changed
D PF00_E_LAST_CHA timestamp of work
NGED object

9.6.2.5 Defining item related actions

In this step, you define which actions are available in the Fiori Task App for a work
object type. You also define how the buttons for these actions are displayed.

You can change the settings of this customizing by implementing the

method CHANGE_ACTIONS of the web handler class. For more information, see
“CHANGE_ACTIONS” on page 452 and “HANDLE_ACTIONS_BULK”
on page 459.

To customize actions for the Fiori Task App:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Work Object Type > Work Object Type.

3. In the Work object type Overview screen, mark a work object type and click
Actions in the Dialog Structure.

4. In the Actions Overview screen, customize the action using the following
parameters:

Workobject type
Work object type for which actions should be made available.
Action ID
ID for the action.
Action order
Define the order of actions. The action with the lowest number is displayed
to the left.
Action type
Select the action type from the list. The following types are available:

380 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

Action type Perspectiv Action Description

e required? dialog
class
required?
Confirm dialog No No Opens the
(deprecated – use Action confirmation dialog
dialog) box.
Save No No Calls CHECK* and
HANDLE_UPDATE_
BULK methods of the
web handler.
Check No No Calls the CHECK*
methods of the web
handler.
Save & Confirm dialog No No Runs a Save and
(deprecated – use Save & afterwards calls the
Action dialog) confirmation dialog
box.
Action dialog Yes Yes Opens the action
dialog box with
customized
perspective ID calling
the customized action
dialog class.
Save & Action dialog Yes Yes Runs a Save and
afterwards calls the
action dialog.
Semantic object No No Performs a semantic
navigation object navigation.
Enter the link in the
Link parameter field.
Semantic object No No Performs a semantic
navigation - New Tab object navigation,
opens the target in a
new tab. Enter the
link in the Link
parameter field.
Semantic object No No Performs a semantic
navigation - New Window object navigation,
opens the target in a
new window. Enter
the link in the Link
parameter field.
Further Details Inplace Yes No Calls the perspective
(deprecated – use semantic in inplace mode.
object navigation)

VIM200405-CGF-EN-02 Configuration Guide for Foundation 381

Chapter 9 Fiori Task App

Action type Perspectiv Action Description

e required? dialog
class
required?
Further Details Full Yes No Calls the perspective
Screen (deprecated – use in full screen mode.
semantic object navigation)
Cancel (deprecated – can No No Cancels changes done
only be used with deprecated after last Save action.
Edit mode)
Refresh views in No No Refreshes specific
perspective views in the
perspective, without
reloading the
complete perspective.
Change page in flexible No No Loads a new page in a
column layout column of the flexible
column layout.
Bulk acton No No Opens the selected
items in object mode.

Perspective ID
Enter the perspective ID, which is used for Edit actions.
Link parameter
Enter the link for the semantic object navigation.
Action dialog class
Enter a class with logic for the Action dialog box. The class must implement
the /OTX/PF62_IF_ACTION_DIALOG interface.
Web Icon
Enter the icon that is displayed on the action button.
Tip: All available icons are defined in the “SAP UI5 Icon Explorer”:
https://openui5.hana.ondemand.com/iconExplorer.html. The URL can
be subject to changes.
UI 5 button type
Enter the SAP UI5 button type. Choose one of the following types:

• Accept type (blue button)

• Default type (no special styling)
• Emphasized type
• Reject style (red button)
• Transparent type
• Unstyled type (no styling)

382 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

Perspective view ID
Enter this parameter to set the location of the action. If no perspective view
ID is maintained, the action is not shown.
You can place actions in the footer toolbar by setting the property
itemActionsViewId of the root element in the Item perspective using the
Perspective Editor. The chosen ID must be unique and the linkage happens
by specifying the same ID as Perspective view ID in the action.
You can place actions anywhere on the page by using UI5 controls which
are designed to contain action buttons.
The Perspective view ID must then match the control ID.

Action text
Enter the text that is displayed on the button.

Tooltip
Enter the tooltip that is shown for the button.
This setting can be overwritten at runtime using the CHANGE_ACTIONS
method of interface /OTX/PF62_IF_ITEM_HANDLER. For more information,
see “CHANGE_ACTIONS” on page 452.

Bulk action
Select this check box to define the action as a bulk action.
Notes

• Bulk is only available in the Fiori Task App if there is no paging in

the inbox.

• Bulk is only available in the Confirm dialog box, not in the Action
dialog box.

Transport type
Choose one of the following options:

• No transport required (default)

• Customizing request

• Workbench request

Aggregation Name
Aggregation of the UI5 control to which the control action is assigned to.
The Aggregation of the UI5 control is specified in Perspective view ID. By
default the contentRight aggregation is used.

SAP UI5 Button Class

SAP UI5 control that is used to display the action. By default sap.m.Button
is used.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 383

Chapter 9 Fiori Task App

9.6.2.5.1 Semantic object navigation in the Fiori Task App

Define the parameters of the work object type actions which are semantic object
navigation actions (SEMANTIC action type) in the Semantic Object Navigation setting
of the work object type

To define the parameters of the work object type

1. Run the /OTX/PF00_IMG transaction.

2. Click Web Services > Work Object Type> Work Object Type.
3. Select a Workobject type, and then click Semantic Object Navigation

4. Open an existing entry or create a new Semantic Object entry.

In this setting you define device specific:

• the semantic object

• the object action
• Optional: an exit class. Enter a class that has implemented the /OTX/PF63_
IF_SEM_OBJ_NAV interface, which allows to change parameters at runtime.
For more information, see /OTX/PF63_IF_SEM_OBJ_NAV interface:
on page 385.

5. To define further parameters, select the Semantic Object entry, and then
double-click Parameters sub-settings.

6. To add the field values, double click a Parameter.

384 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

Parameter:
Name of the parameter. You find the parameters for the BC Fiori App via
search help.

Value:
Maintains the values for the parameter.

Work Object Type Field

Defines the fields from the display structure of the work object type. The BC
framework calculates and sets this value at runtime.
The framework provides the following fields:

• PF62_ACTION_ID

• PF62_DEVICE

• PF62_WEBID

• PF62_WOBJ_TYPE

• PF62_NODE_ID (only in FullScreenList)

• PF62_SAP_ORIGIN

Exit Class
Defines an exit class. For changing the parameter at runtime enter a class
implementing the /OTX/PF63_IF_CONV_PARAM_VALUES interface. The value
of the parameter is changed in the CHANGE_PARAMETER_VALUE . For more
information, see /OTX/PF63_IF_CONV_PARAM_VALUES interface :
on page 386.

The BC framework calculates the semantic object navigation target based on this
customizing at runtime.

/OTX/PF63_IF_SEM_OBJ_NAV interface:

GET_INSTANCE method:
Returns a class instance. Parameters:

VIM200405-CGF-EN-02 Configuration Guide for Foundation 385

Chapter 9 Fiori Task App

Parameter Type Descritpion

PIH_WOBJ_TYPE Importing Work Object Type
PRH_INSTANCE Returning Instance

When the implementation class inherits the /OTX/PF63_CL_SEM_OBJ_NAV class,

then the handling for the GET_INSTANCE method is already implemented and
you only need to define the CHANGE_PARAMETER method.

CHANGE_PARAMETER method :
Allows to change customized parameters and values at runtime. Parameters:

Parameter Type Description

PI_ACTION_ID Importing Action ID
PI_SEMANTIC_OBJECT Importing Semantic Object
PI_SEMANTIC_ACTION Importing Semantic Object action
PIH_WOBJ Importing Work Object
PI_WEBID Importing Web ID
PI_DEVICE Importing Device type
PCT_PARAMETER Changing Calculated Link parameter
PI_SAP_ORIGIN Importing System alias (only set in
FullScreenList and Advanced
LineItems)
PI_NODE_ID Importing Node ID (only set in
FullScreenList)

/OTX/PF63_IF_CONV_PARAM_VALUES interface :

CHANGE_PARAMETER_VALUE method
Allows to change the value of a single parameter, when a this parameter is
calculated.

Parameter Type Description

PI_NAME Importing Parameter name
PI_FIELDNAME Importing Field name of the work object type
PIH_WOBJ Importing Work object instance
PC_VALUE Changing Parameter value

386 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

9.6.2.5.2 Refreshing views for work object type actions

You can maintain work object type actions that require the refresh of views in the
item perspective in the Refresh Views dialog of the work object type. A refresh is
urrently possible for the REFRESH, ACTION and SAVE_ACTN action types .

In the setting you define which views are refreshed in an item perspective when this
action is executed.

At runtime these views can be changed with implementation of method CHANGE_

VIEWS_FOR_REFRESH of interface /OTX/PF62_IF_PERSPECTIVE_CLASS. For more
information, see “CHANGE_VIEWS_FOR_REFRESH” on page 504.

9.6.3 Workplace
In this step, you define which nodes of the Workplace Configuration are available
for the Web Services and the relationship between nodes and work centers.

9.6.3.1 Defining work centers

In this step, you define work centers that are available for Web Services. These work
centers are independent from work centers defined in the Workplace Configuration.

To define work centers:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Workplace > Work Center.
3. In the Work Center for Webservice Overview screen, define work centers using
the following parameters:

Work Center ID
Unique ID of the work center.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 387

Chapter 9 Fiori Task App

Work Center Text

Enter a meaningful description of the work center.

9.6.3.2 Enabling nodes for Web Services

In this step, you enable nodes, which are defined in the Workplace Configuration,
for Web Services. For more information, see “Defining nodes” on page 294. You can
also assign an item perspective to the node. For more information, see “Editing
perspectives and layouts” on page 427.

To enable nodes for Web Services:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Workplace > Nodes.

3. In the Nodes Overview screen, enable nodes for Web Services using the
following parameters.

Node ID
Unique ID of the node. For information about defining nodes, see “Defining
nodes” on page 294.

Workobject type
Work object type of the node.
Each node is connected to a work object type. When the user selects a node,
the work object type is automatically filled.

Active
Select this check box to activate the node in order to display it in the VIM
Central Workplace.

Exit for node

Enter a user exit for the node. This exit requires a class with implementation
of the /OTX/PF62_IF_NODE interface. Using this exit, you can change the
node at runtime. For more information, see “Interface /OTX/
PF62_IF_NODE” on page 444.

Perspective ID item
Enter the ID of the item perspective. This perspective is used when the
items of the node are displayed with appMode MD (master detail).

Node description
Enter a meaningful description of the node. The description is displayed at
the top of the inbox in the Fiori Task App.

Page size - desktop, Page size - tablets, Page size - mobiles

Define page sizes for the node depending on the device. The default size for
all device types is 50 tasks.

388 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

The page size determines how many tasks are shown on one page in
appMode MD. If more tasks are available, you find buttons in the bottom
action bar to go to the next or the previous page.
Full Scr. List Exit
Full screen list exit. Enter a user exit for the full screen list. For more
information, see “/OTX/PF63_IF_FS_LIST interface” on page 511.
Icon ID UI5
Enter the UI5 icon that should be displayed.
Value state
Define in which status the node is displayed in the workplace view.
Possible values are the following:

• Error
• None
• Success
• Warning

None is the default value. In the workplace view (Full screen with work
center as entry point) the icon and the node text are displayed in a color
according to their status.
Bulk activ
Bulk actions active. Select this check box to indicate that at least one bulk
action for this node is available. Therefore, the Edit button at the top of the
master list in the Fiori Task App is available.

Note: Bulk is only available in the Fiori Task App if there is no paging
in the inbox.
Counter Inactive
When the app is started as Full screen with work center as entry
point, the entries for all nodes of this workplace are counted. The number
of entries for each node is displayed below the node icon. If you do not
want to have this counter for the node, select Counter Inactive.
Max. List Desktop, Max. List Tablet, Max. List Smartphone

Note: This setting is only considered in the old node list view. To use
the old view, activate Use Node List View check box.

Enter the maximum list sizes for this node, depending on the device.
Default values for smart phones and tablets is 100, for desktop 500.
The list size defines how many items can be displayed in the node list
maximally. When configuring this value, consider the capabilities (memory
and CPU) of the device because all objects are loaded in the Document
Object Model (DOM) of the HTML page. If you choose the number too high,
it can happen that the application becomes very slow or unresponsive.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 389

Chapter 9 Fiori Task App

Export enabled
Select this check box to configure that all columns visible for the user can be
downloaded to a Microsoft Excel file, using a Download button. By hiding
columns, users can restrict the downloaded columns.
Use Node List View
Select this check box to configure that the user interface uses the
deprecated node list view. The framework uses the same customizing and
exits as in previous version.
Note: This setting is deprecated and can only be maintained using
transaction /OTX/PF62_IMG_OLD.
Perspective ID
If you want to use the Flexible Column layout for this node in the Master
Detail pattern, enter the corresponding perspective.

9.6.3.2.1 Adding fields for searching, sorting, and filtering to a node

In this step, you define fields that can be used for a text search, for sorting the item
list, and for additional filtering. All fields of the data selection structure of the work
object type are available. For more information, see “Defining work object types”
on page 266.

To add fields for searching, sorting, and filtering to a node:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Workplace > Nodes.

3. In the Nodes Overview, mark an entry, and then double-click one of the
following entries in the Dialog Structure:

• Search fields: Following search fields are available:

– Fieldname: Select a field of the selection structure of the work object or

enter a name for an abstract field.
– Position: Order of search fields.
– Medium Field Label: Set the description that should be displayed. If this
text is not maintained, then the label of the maintained data element or
fieldname is used.
– Data element: The UI uses this data element (filter bar only). If it is not
maintained, then the data element from the selection structure is used.
• Sort fields: Following sort fields are available:

– Fieldname: Select a field of the selection structure of the work object or

enter a name for an abstract field.
– Position: Order of search fields.

390 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

– Medium Field Label: Set the description that should be displayed. In

case this text is not maintained, then the label of the maintained data
element or fieldname will be used.
• Filter fields: Following filter fields are available:

– Fieldname: Select a field of the selection structure of the work object or

enter a name for an abstract field.
– Position: Order of search fields.
– No multi: Only a single value can be selected.
– Timestamp: Filter bar offers a Data range selection control.
– Boolean: Field is displayed as check box in the facet filter.

4. In the Search fields overview, Sort fields overview, or Filter fields overview
screen, enter the respective fields that you want to use for a text search, for
sorting, or for filtering in Field Name.
In the Position field, define the order of the values, in which they are sorted and
displayed.
In Medium Field Label, enter the name of the field. If you do not enter a
specific name, the related information of the data element is used.
In Search fields, the Object ID field is always added as the last field.
In Sort fields, the Default field is always displayed as the first field.
In Filter fields, check the No multi (No multi select) check box to limit the filter
selection to one value.

You can change the fields in the following methods of the node exit interface (/OTX/
PF62_IF_NODE). For more information, see “Interface /OTX/PF62_IF_NODE”
on page 444.

• CHANGE_NODE_SEARCH_FIELDS
• CHANGE_NODE_SORT_FIELDS
• CHANGE_NODE_FILTER_FIELDS

Filter fields can be connected to domains with fixed values. In this case, the fixed
values are automatically provided. You can also define or change values in the
CHANGE_NODE_FILTER_VALUES method of the node exit interface (/OTX/PF62_IF_
NODE).

VIM200405-CGF-EN-02 Configuration Guide for Foundation 391

Chapter 9 Fiori Task App

9.6.3.2.2 Defining and assigning node actions

In this step, you define general actions for a node and assign actions to a node.

To define general node actions:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Workplace > Nodes.

3. In the Nodes Overview, double-click Node actions in the Dialog Structure.

4. In the Node actions Details screen, define general actions for the Action ID,
using the following parameters:

• Action dialog class: Enter a class with logic for the action. The class must
implement the /OTX/PF62_IF_ACTION_DIALOG interface.
• Perspective ID
• Transport type: Choose one of the following options:

– No transport required (default)

– Customizing request
– Workbench request

To assign actions to an individual node:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Workplace > Nodes.

3. In the Nodes Overview, mark an entry, and then double-click Assign node
actions in the Dialog Structure.

4. In the Assign node actions Details screen, configure actions for the node, using
the following parameters:

• Action ID: Enter the ID for the action.

• UI 5 button type: Choose one of the following types:

– Accept type (blue button)

– Default type (no special styling)
– Emphasized type
– Reject style (red button)
– Transparent type
– Unstyled type (no styling)

392 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

• Web Icon: Enter the icon that is displayed on the action button.
• Action text: Enter the text that is displayed on the button.

9.6.3.2.3 Configuring the data binding for the master list

In this step, you configure the display of a work object in the master list. Objects in
the master list have the following layout.

Note: You can change the settings of this customizing by an implementation of

method CHANGE_OBJECT of the web handler class (see “CHANGE_OBJECT”
on page 474).

Figure 9-5: Layout of the master list

To configure the master list:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Workplace > Nodes.

3. In the Nodes Overview screen, mark a node, and then double-click Master List
- Data Binding in the Dialog Structure.

4. Configure the layout of the item list using the following parameters. For an
example, see Figure 9-5.
In all fields, you can use the field content of the display structure of the work
object by using the pattern <field name>.

Example: 2nd attribute: by <CREATOR_NAME>

VIM200405-CGF-EN-02 Configuration Guide for Foundation 393

Chapter 9 Fiori Task App

• Work object type: Work object type for which this list layout is used
• Node ID
• Icon ID UI5: Define a UI5 icon that should be displayed.
• Mark as flagged: The flag icon is displayed.
• Mark favorite: The favorite icon is displayed.
• Intro text
• Item title
• Number
• Number state: The fields 1st Status and 2nd Status will be colored according
to the status value: Error - red, Warning - yellow, Success - green, None -
black ).
• Unit text
• 1st Attribute
• 2nd Attribute
• 1st Status
• 2nd Status
• Bulk actions active: If this check box is selected, all objects displayed in the
master list can be used for bulk actions. If the availability of bulks actions
needs to be calculated for each object, implement this in method CHANGE_
OBJECT of interface /OTX/PF62_IF_ITEM_HANDLER.

9.6.3.2.4 Customizing a full screen list

The full screen list pattern gathers all information about processes in a table
structure on a single page.

To customize a full screen list:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Workplace > Nodes.
3. In the Nodes Overview screen, mark a node, and then double-click Full Screen
List in the Dialog Structure.
4. In the Full Screen List Overview screen, customize the full screen list’s device
specific settings, using the following parameters:

Device typ
The following settings are available:

• Tablet
• Desktop

394 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

• Smart Phone
• All Devices
• Hybrid Devices

Exp. field
If you select the option, advanced line items and full screen lists download
an Excel sheet with technical field names as column headers. If it is not
selected, the label description is used as column header.
You can use FSList (node) and Perspective exits to redefine settings at
runtime.

Export
Select this check box to enable download of the displayed table content into
Microsoft Excel.

Paging
Select this check box to enable paging of the displayed table. The page size
of the node is only considered if paging is disabled.

Actions
Select this check box to display the Action menu for row actions.

No Setting
Select this check box to disable table settings.

Fac. Filter
Select this check box to define that the facet filter should be used for the
FullScreenList even if the filter bar is available.

5. To search, sort, or filter fields, mark a node in the Nodes Overview screen, and
then double-click Search fields, Sort fields, or Filter fields in the Dialog
Structure. For more information, see “Adding fields for searching, sorting, and
filtering to a node” on page 390.
You can change the fields in the following methods of the node exit interface (/
OTX/PF62_IF_NODE). For more information, see “Interface /OTX/
PF62_IF_NODE” on page 444.

• CHANGE_NODE_SEARCH_FIELDS
• CHANGE_NODE_SORT_FIELDS
• CHANGE_NODE_FILTER_FIELDS
• CHANGE_NODE_FILTER_VALUES

6. In the Full Screen List Overview screen, mark a device type, and then double-
click Full Screen List - Actions in the Dialog Structure.

7. In the Full Screen List - Actions Overview screen, customize actions, using the
following parameters:

VIM200405-CGF-EN-02 Configuration Guide for Foundation 395

Chapter 9 Fiori Task App

Action Type
The following action types are available:

• Show popup
• Show inplace
• Navigate to semantic object
• Call action dialog
• No link

Description
Defines the text that is displayed in the ActionSheet.

Action ID
ID of the action to be performed in the row.
Position
Specify with sequential numbering, where the action is positioned on the
screen.
Web Icon
Enter the icon that is displayed on the action button.
Nav. link parameter
Enter the navigation link parameter. It depends on the settings in Row
Action Type.
Transport type
Choose one of the following options:

• No transport required (default)

• Customizing request
• Workbench request

Not In Action Sheet

Not in Action Sheet. Select this check box to specify that the action is not
displayed in the action sheet of the row.
Tooltip
Enter the tooltip that is shown for the action button.
No Lock Required
Select this check box when the Fiori app should not set a lock for the current
object before executing the action.

8. Double-click Full Screen List - Columns in the Dialog Structure.

9. In the Full Screen List - Columns screen, customize columns, using the
following parameters:

396 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

Field Name
Name of the attribute field. You can use all fields available in the display
structure of the work object type. The values for these fields are
automatically set by the framework. You can define additional fields, the
values for these fields must be set in the implementation of the Full Scr. List
Exit.
Position
Define the sequence of the columns.
Width
Enter the width of the column as a valid CSS size. For more information, see
the SAP UI5 API Reference: https://sapui5.hana.ondemand.com/#/api/
sap.ui.core.CSSSize.
Column type
The following values are available: DEFAULT | MANDATORY | AVAILABLE |
HIDDEN.

Action ID
Enter the ID of the action to be performed in the column.
Display Type
The following values are available:

• Standard field (default)

• Display as checkbox
• Amount field. Define currency in field EXT_VALUE
• Display as switch
• Display as icon
• Object Identifier
• Time stamp
• Time
• Date

Note: The display types Time stamp, Time and Date must have a
timestamp for the field value .
Description
Enter a meaningful description of the column.
Tooltip
Enter a tooltip for the column.
Value Ext. Field
(Value in External Field): The value of this field is set in an external value
field. Currently only used for display type Amount field to set the
currency.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 397

Chapter 9 Fiori Task App

Default Value
The value of this field is used for display type Display as icon if no other
value has been selected for this field. This allows to define a default icon.
You can overwrite the value in the full screen list exit method /otx/pf63_
if_fs_list~change_data.

9.6.3.3 Assigning nodes to work centers

To assign nodes to work centers:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Workplace > Assignment of Nodes to Work Center.

3. In the Assignment of nodes to Work Center Overview screen, assign nodes to

work centers using the following parameters:

Work Center ID
Unique ID of the work center.
Node ID
Unique ID of the node.
Work object type
The node is defined by the Node ID and the work object type. Therefore,
you enter the work object type of the Node ID or the work object type
assigned to the Node ID. The actual work object type has already been
defined in the node customizing. For more information, see “Defining
nodes” on page 294.
Node pos.
Node position. Define the sequence of the nodes.
Separator
Select the separator of the tabs in the Tab Bar of the Fiori Task App.
Agg. Count
Aggregated count. Select this check box to show the node as aggregated
count. Nodes with aggregated count are highlighted and contain all objects
that are shown in the nodes of the work center.

398 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

9.6.4 Search helps

You can customize input helps for editable fields in the header data area and in the
detail area of the Fiori Task App using the Web Services customizing. You can also
customize collective input helps by collecting several input helps in one.

9.6.4.1 Input helps

Note: Input helps can be set for item fields or header details. For item fields,
see “Configuring line item details” on page 424. For header details, see
“Configuring the item header details” on page 421. If no input help IDs are set
for editable fields in these customizing settings, then the header or item
structure is checked if an SAP help (F4 help or domain values) is assigned to
this field. The assigned help is then automatically used in the web service.

The input helps can display a maximum number of 100 domain values or results of
SAP search helps. You can also use the /OTX/PF62_BADI_INPUT_HELP user exit to
change or set the values and the structure of the input helps.

To customize input helps:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Input helps > Input helps.
3. In the Input Helps Overview screen, customize input helps using the following
parameters.

Search help ID
Unique ID of the search help that corresponds with the input help.
Value type
Select the value type from the list. The following value types are available.

• Domain values: fixed values of a domain.

• Search helps: results of SAP search helps.
• Only user exit (BAdI /OTX/PF62_BADI_INPUT_HELP).

Type Name
Enter the technical name of the domain or search help.
Description
Enter a meaningful description of the input help.

4. Optional To customize related fields for the input help, mark an entry in the Input
Helps Overview screen, and then double-click Related fields in the Dialog
Structure.
Related fields are passed to the search query along with the field that you
search for. They limit the number of search results. As a prerequisite, related

VIM200405-CGF-EN-02 Configuration Guide for Foundation 399

Chapter 9 Fiori Task App

fields must contain values that are shown in the header data area and in the
detail area.

5. Optional In the Related Fields Overview screen, enter a Field Name according to
the Search Help ID.

At the first call of an input help in the Fiori Task App, the framework generates
additional information for this input help. After each change to the settings of an
input help or the used search help, these data needs to be deleted. You can do this in
the /OTX/PF62_ADMIN transaction, option Clean Up Search Helps. For more
information, see OpenText Vendor Invoice Management for SAP Solutions -
Administration Guide (VIM-AGD).

The /OTX/PF62_BADI_INPUT_HELP BAdI implements the /OTX/PF62_IF_BAPI_HELP

interface. The following interface methods are available:

• CHANGE_HELP_COLUMNS
• CHANGE_HELP_ROWS
• CHANGE_FILTER_OPTIONS

For more information, see “BAdI /OTX/PF62_BADI_INPUT_HELP” on page 508.

9.6.4.2 Collective input helps

With collective input helps, you collect several input helps in one. You can assign
collective input helps to fields the same way as normal input helps. When a
collective input help is called, each input help assigned to the collective input help is
displayed on a separated tab in the help dialog.

To customize collective input helps:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Input Helps > Collective Input Helps.

3. To maintain the collective input help, specify an Collective Help ID and

maintain a Description text, which is displayed as the title of the Help dialog.

4. In the sub folder Input Help Tab, define the tabs. The single input helps must
be defined in Input Helps: Before you can use them in the collective help,
maintain the input help, as described in “Input helps” on page 399.
Define an order of the tabs and the text. The text will be the tab title.

400 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

9.6.5 Configuring the data binding of perspectives

Perspectives are maintained using the Perspective Editor. For more information, see
“Editing perspectives and layouts” on page 427.

On the top level, you can enter the perspective class. This class needs to implement
the /OTX/PF62_IF_PERSPECTIVE_CLASS interface. The actual contents of
perspectives are configured in the VIM Foundation IMG . This includes:

• Attribute list view, table view setting and DataBinding

• Property bindings

This section describes the necessary steps.

9.6.5.1 Configuring the attribute list view

The attribute list view always displays the customized attributes in a vertical layout,
showing one attribute at each line. For each attribute a label, the value and a value
description can be displayed.

To configure the attribute list view:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Perspectives > Data Binding.

3. On the Perspective Overview screen, mark a perspective, and then double-click

Attribute List View in the Dialog Structure.

4. On the Attribute List View Overview screen, choose one of the available
Perspective view IDs that you want to use for the perspective.

5. To define attribute view settings, mark a perspective view ID, and then double-
click Attribute View Settings in the Dialog Structure.

6. On the Attribute View Settings Details screen, define attribute view settings,
using the following parameters:

Editable
To allow the view to be edited in general, select this check box.
Selection Listener
To configure that the data of this view can be changed at runtime, select this
check box. This refers to method /OTX/PF62_IF_PERSPECTIVE_
CLASS~CHANGE_DATA of the perspective class. If an association for this view
is maintained and the table changes the parent item, the data for this view is
automatically selected if a selection event is raised.
Association Name
Enter the association name.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 401

Chapter 9 Fiori Task App

An attribute list can either show the data of the root work object type or, if
the association is maintained, an associated work object type.
By setting the association, the fields of the associated work object type are
available for the customizing, and the data of the associated work object
type is selected. For more information, see “Defining the work object type
association” on page 291.
If choosing a not-associated work object type, the attributes of the root work
object type can be used.
No Data Preselection
Select this check box to achieve that the framework does not preselect any
data. All data must be set in the perspective class.

7. Save your changes before you navigate down in the folder structure.

8. Double-click Attributes in the Dialog Structure.

9. On the Attributes Details screen, define attributes, using the following

parameters:

Field Name
Name of the attribute field. Values can be selected from search help or
entered manually. Also field names that do not exist in the display structure
can be entered. In this case, the data element has to be maintained in the
new option Data Element. For more information, see Data Element
on page 404.
Position
Define the sequence of the attributes.
Display Type
Configure the way the attribute is displayed. The following values are
available:

• Standard field (default)

• Display as checkbox (requires boolean)
• Amount field. Define currency in field EXT_VALUE
• Display a switch
• Display as icon: The value of this field is considered as icon name

Value description
Select this check box to display a description behind the value field.
The value description is not automatically set, but has to be implemented in
the /OTX/PF62_IF_PERSPECTIVE_CLAS~CHANGE_DATA method of the
perspective class.
The /OTX/PF62_IF_PERSPECTIVE_CLAS~UPDATE_ATTRIBUTES method
enables you to change the value description after the value has changed.

402 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

Update on change
Select this check box to trigger the UPDATE_ATTRIBUTES method of the /
OTX/PF62_IF_PERSPECTIVE_CLASS if the value of the field is changed. For
more information, see “UPDATE_ATTRIBUTES” on page 498.
Editable
To allow the attribute to be edited, select this check box. This setting is only
considered if the complete view is set to editable. For more information, see
“Configuring the header view” on page 420.
Required
To set the attribute as required, select this check box.
Search help ID
Unique ID of the search help that corresponds with the attribute.
Help variant
Select the type of help. The following types are available.

• F4 help only: Users can only select and enter values using a search
help.
• F4 help with suggestions: Users can directly enter values. When the
user enters a value which fits for one or several values of the search
help, these values are displayed as suggestions. The user can select
them. Alternatively, the user can select the values using a search help.
• Drop-down list: Users can select values in a drop-down list.
• Suggestions: When the user starts to enter a value suggestion, suitable
values from the search help are displayed, which the user can select.
• F4 help with input field: Users can either directly enter values for
this field or select them using a search help.

Help Dialog Height, Help Dialog Width

These parameters are available to define the height and width of the help
dialog. Set the values either in percentage of the total screen size (for
example 50%) or in pixels (for example 250px).
Used Help Field
Define the field in the help structure whose value should be written to the
attribute view field. You only need to specify this if the field name in the
help structure is not equal to the field name in the attribute view.
Link type
This field defines the type of the link for semantic object navigation.
Possible values:

• No link
• Semantic object navigation

For more information, see “Semantic object navigation” on page 370.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 403

Chapter 9 Fiori Task App

Link parameter
This field contains the JSON with the link parameters. For more
information, see “Semantic object navigation” on page 370. The JSON data
must match the following structure:
{
"target": {
"semanticObject": <semantic object>,
"action": <action>
},
"params": {
<optional parameters>
}
}

Description
Enter a meaningful description of the attribute.
Data Element
For fields that are not included in the display structure of the work object
type, use this data element.

10. Double-click Related fields under Attribute View Settings in the Dialog
Structure.
11. On the Related fields Overview screen, define related fields for the attribute.
You can use the related fields to react on value changes in fields of other
attribute views. For this, set the Update on change check box of the related
attribute field to true and enter the field in the related fields settings of the
attribute list that wants to react on these value changes. In case of a value
change, you can update the attribute in method /OTX/PF62_IF_PERSPECTIVE_
CLAS~UPDATE_AFTER_REL_ATTR_LIST_CHG of the perspective class.
Use the following parameters:

Perspective view ID
Enter the view ID.
Field Name
Enter the field name.

9.6.5.2 Configuring the table view

Define the contents of the tables that you want to use in a perspective.

Each view represents one table. The columns display as customized. You can give
the user the possibility to change the displayed columns. Depending on the screen
size the rows are displayed in horizontal or vertical layout.

To configure the table view:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Perspectives > Data Binding.

404 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

3. On the Perspective Overview screen, mark a perspective, and then double-click

Table View in the Dialog Structure.

4. On the Table View Overview screen, mark a perspective view ID, and then
double-click Header View in the Dialog Structure.

5. On the Header View Details screen, define the content for the header, using the
following parameters:

Association Name
Enter the association name.
Objects of the associated work object type are selected according to the
constraints defined in the association settings. For more information, see
“Defining the work object type association” on page 291.
Editable
To define that the table can be edited in general, select this check box.
Grouping Fieldname
Define the field for grouping. The entries of the table are grouped by their
values of the defined field.
Grouping Title Field
Field containing the text that is displayed as the grouping title.
Row Action Available
Select this check box to make the action sheet in the rows available.
Paging Is Active
Select this check box to activate paging. If this check box is cleared, all
entries are displayed at once.
Rearrange Is Active
Select this check box to allow changing the order of the table entries.
Selection Mode
Define if an entry of the table can be selected or not. The following options
are available:

• Single entry
• No selection

Selection Event
Select this check box to let the table raise an event when the user selects a
different table entry. Attribute and table views listening to the selection
event are then updated (data selection for associations and method /OTX/
PF62_IF_PERSPECTIVE_CLAS~CHANGE_DATA of perspective class).

Selection Listener
Select this check box to specify that the table listens to selection events of
other tables of this perspective.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 405

Chapter 9 Fiori Task App

Compare Is Available
Select this check box to define that the Compare button is available. This
button allows the user to undo actions.
Row Icon
Enter a SAP UI 5 icon that is displayed in front of the row title.
Row State
State of the row title state. Possible values:

• ERROR
• NONE
• SUCCESS
• WARNING

Is Expandable
Select this check box to set that the table can be expanded. This is only
relevant for views view.item.AdvLineItemsVertical and view.item.
AdvLineItemsResponsive.

Is Expanded
Select this check box to set that the table is initially displayed in expanded
mode. This applies only if Is Expandable is selected.
No Settings
Select this check box to set that the layout of the table is fix. No settings
button is displayed for user specific settings.
Export enabled
Select this check box to configure that all columns visible for the user can be
downloaded to a Microsoft Excel file, using a Download button. By hiding
columns, users can restrict the downloaded columns.
Export Fieldname
If you select the option, advanced line items and full screen lists download
an Excel sheet with technical fieldnames as column headers. If it is not
selected, the label description is used as column header.Y
You can use FSList (node) and Perspective exits to redefine settings at
runtime.
Table Title
Text displayed as table title.
Row Title
Define the row title that is shown in vertical tables on top of each row. You
can enter placeholders (<field name>) to use field contents of the rows.
Example: Item Number <ITEM_NR> - Material <MATNR>

Row Description
Text is displayed above row. Only displayed at AdvLineItemsVertical.

406 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

No Data Preselection
Select this check box to achieve that the framework does not preselect any
data. All data must be set in the perspective class.

6. Double-click Columns in the Dialog Structure, and then double-click a column,

or add a new column.

7. On the Columns Details screen, configure the column, using the following
parameters:

Field Name
Values can be selected from search help or entered manually. Also field
names that do not exist in the display structure can be entered. In this case,
the data element has to be maintained in the new option Data Element.

Data Element
For fields that are not included in the display structure of the work object
type, use this data element.

Filter Mode
The following options are available:

• No filter option
• Filter with selectable values
• Search with string

Position
Define the sequence of the columns.

Description
Enter a meaningful description of the column.

Editable
To allow the field to be edited, select this check box.

Required
To set the column as required, select this check box.

Action ID
Enter the ID of the action to be performed in the column.

Column type
Choose the column type to define the display behavior of the columns. The
following values are available:

Default
Column is automatically displayed, the user can hide it.

Mandatory
Columns of this type are always displayed.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 407

Chapter 9 Fiori Task App

Available
Column is not automatically displayed, the user can switch it on.
Hidden
Column is included in table, but is not displayed, the user cannot
switch it on.

Display Type
Configure the way the column is displayed. The following values are
available:

• Standard field (default)

• Display as checkbox (requires boolean)
• Amount field. Define currency in field EXT_VALUE
• Display as switch
• Display as icon
• Object Identifier
In a column of this type, the value in field VALUE is displayed as a
heading and the value in field VALUE_EXT is displayed as a subheading.
• Time stamp
• Time
• Date
• Display types

Width
Enter the width of the column as a valid CSS size. For more information, see
the SAP UI5 API Reference: https://sapui5.hana.ondemand.com/#/api/
sap.ui.core.CSSSize.
Copy Value
Select this check box to specify that the value of the column is transferred to
a new row at copy action.
Update on change
Select this check box to trigger the UPDATE_ROW_VALUES method of the /
OTX/PF62_IF_PERSPECTIVE_CLASS if the value of the field is changed. For
more information, see “UPDATE_ROW_VALUES” on page 496.
Search help ID
Unique ID of the search help that corresponds with the column.
Used Help Field
Define the field in the help structure whose value should be written to the
attribute view field. You only need to specify this if the field name in the
help structure is not equal to the field name in the attribute view.

408 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

Help variant
Select the type of help. The following types are available.

• F4 help only: Users can only select and enter values using a search
help.
• F4 help with suggestions: Users can directly enter values. When the
user enters a value which fits for one or several values of the search
help, these values are displayed as suggestions. The user can select
them. Alternatively, the user can select the values using a search help.
• Suggestions: When the user starts to enter a value suggestion, suitable
values from the search help are displayed, which the user can select.
• F4 help with input field: Users can either directly enter values for
this field or select them using a search help.

Help Dialog Height, Help Dialog Width

These parameters are available to define the height and width of the help
dialog. Set the values either in percentage of the total screen size (for
example 50%) or in pixels (for example 250px).

8. Double click Related fields under Header in the Dialog Structure.

9. On the Related fields Overview screen, define related fields for the column,
using the following parameters:

Perspective view ID
Enter the unique ID of the perspective view.
Field Name
Enter the field name of the display structure of the work object type.

10. Mark an perspective view ID, and then double-click Row Actions - Default in
the Dialog Structure.
11. On the Row Actions - Default Details screen, configure default row actions for
the table, using the following parameters:

Add (PF62 ADD)

Select this check box to configure an Add action to the table row.
Copy (PF62 COPY)
Select this check box to configure a Copy action to the table row.
Delete (PF62 DEL)
Select this check box to configure a Delete action to the table row.
Up (PF62 UP)
Select this check box to configure an Up action to the table row.
Up (PF62 DOWN)
Select this check box to configure a Down action to the table row.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 409

Chapter 9 Fiori Task App

12. Double-click Row Actions - Custom in the Dialog Structure.

13. On the Row Actions - Custom Details screen, configure custom row actions for
the table, using the following parameters:

Action ID
ID of the action to be performed in the row.
Type
Specify the Row Action Type. In this list, click one of the following action
types:

• Add
• Copy
• Delete
• Up
• Down
• Action Dialog ( Set ActionDialog class in Nav. link param. )
• Semantic Navigation (Set Nav. link parameter): For more
information, see “Semantic object navigation” on page 370
• Semantic Navigation - new Window (Set Nav. link parameter): For
more information, see “Semantic object navigation” on page 370.
• Semantic Navigation - new Tab (Set Nav. link parameter): For
more information, see “Semantic object navigation” on page 370.
• Field Popup ( Set Perspective Id in Nav. link parameter )
• Change page in flexible column layout (parameter = page id)

Position
Specify with sequential numbering, where the action is positioned on the
screen.
Action dialog class
Enter the action dialog class.
Web Icon
Enter the icon that is displayed on the action button.
Nav. link parameter
Enter the navigation link parameter. It depends on the settings in Row
Action Type.
Transport type
Choose one of the following options:

• No transport required (default)

• Customizing request

410 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

• Workbench request

Not In Action Sheet

Not in Action Sheet. Select this check box to specify that the action is not
displayed in the action sheet of the row.
Action text
Enter the text that is displayed on the action button.
Tooltip
Enter the tooltip that is shown for the action button.
No Lock Required
Select this check box when the Fiori app should not set a lock for the current
object before executing the action.

9.6.5.3 Configuring the data binding of AttributeList and

AdvancedLineItems views
You can maintain the attribute list view and table view in the customizing IMG.
Alternatively, you can maintain them using the Perspective Editor. For more
information, see “Editing perspectives and layouts” on page 427. This section
describes the configuration using the Perspective Editor.

To configure the data binding of views AttributeList and AdvancedLineItems:

1. Open the context menu on the tree node where you want to maintain the
binding.

2. To add a binding, click Add Binding.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 411

Chapter 9 Fiori Task App

a. In the Select a Work Object Type Association dialog box, select a valid
Work Object Type (Association) for the view.
The available associations depend on the view:

• For an AttributeList, you can select the Root Work Object Type or
any other 1:1 association.
• For an AdvancedLineItems view, you can select only 1:N associations.
b. When you have selected the association, confirm Save Changes.

Note: You cannot change the selected association for the binding later
on. In case of a wrong association, delete the binding and create a new
one.
3. To edit a binding, click Edit Binding:
The Binding maintenance application for the specific view is launched.
4. To remove a binding, click Remove Binding
The binding is removed.

412 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

Note: Unless all views - for which a data binding is necessary - are bound,
the perspective does not run correctly and the Perspective Editor shows a
warning.

9.6.5.3.1 Configuring attribute list binding in the Perspective Editor

In this step, you configure the binding of the attribute list, depending on the
perspective. You can perform this configuration using the Perspective Editor. Before,
this configuration could only be performed using the customizing IMG. For more
information, see “Configuring the attribute list view” on page 401.

To configure attribute list binding:

1. To open the Perspective Editor from the Launchpad, click the Maintain
Perspectives tile.

2. Click the Perspective ID.

3. In the Edit Perspective view, right-click a view of type view.item.

AttributeList.

4. To open the Attribute List Binding Data View Maintenance, click Edit Binding.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 413

Chapter 9 Fiori Task App

5. On the GENERAL SETTINGS tab, define attribute view settings, using the
following parameters:

Association Name
Enter the association name.
An attribute list can either show the data of the root work object type or, if
the association is maintained, an associated work object type.
By setting the association, the fields of the associated work object type are
available for the customizing, and the data of the associated work object
type is selected. For more information, see “Defining the work object type
association” on page 291.
If choosing a not-associated work object type, the attributes of the root work
object type can be used.
Editable
To allow the view to be edited in general, select this check box.
Listens To Selection Event
To configure that the data of this view can be changed at runtime, select this
check box. This refers to method /OTX/PF62_IF_PERSPECTIVE_
CLASS~CHANGE_DATA of the perspective class. If an association for this view
is maintained and the table changes the parent item, the data for this view is
automatically selected if a selection event is raised.

6. On the ATTRIBUTES tab, define attributes, using the following parameters:

Field Name
Name of the attribute field.

414 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

Display Type
Configure the way the attribute is displayed. The following values are
available:

• Standard field (default)

• Display as checkbox (requires boolean)
• Amount field. Define currency in field EXT_VALUE
• Display as switch
• Display as icon: The value of this field is considered as icon name

Editable
To allow the attribute to be edited, select this check box. This setting is only
considered if the complete view is set to editable.

7. On the RELATED FIELDS tabs, define related fields for the attribute.
You can use the related fields to react on value changes in fields of other
attribute views.
For this, set the Update on change check box of the related attribute field to true
and enter the field in the related fields settings of the attribute list that wants to
react on these value changes. In case of a value change, you can update the
attribute in method /OTX/PF62_IF_PERSPECTIVE_CLAS~UPDATE_AFTER_REL_
ATTR_LIST_CHG of the perspective class.
Use the following parameters:

Perspective view ID
Enter the view ID.
Field Name
Enter the field name.

9.6.5.3.2 Configuring advanced line items binding in the Perspective Editor

In this step, you configure the binding of advanced line items, depending on the
perspective. You can perform this configuration using the Perspective Editor. Before,
this configuration could only be performed using the customizing IMG. For more
information, see “Configuring the table view” on page 404.

To configure advanced line items binding:

1. To open the Perspective Editor from the Launchpad, click the Maintain
Perspectives tile.

2. Click the Perspective ID.

3. In the Edit Perspective view, right-click a view of type view.item.

AdvLineItems, and then click Edit Binding.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 415

Chapter 9 Fiori Task App

4. On the GENERAL SETTINGS tab, define advanced line items settings, using
the following parameters:

Association Name
Enter the association name.
Objects of the associated work object type are selected according to the
constraints defined in the association settings. For more information, see
“Defining the work object type association” on page 291.
Editable
To allow the view to be edited in general, select this check box.
Is Expandable
Select this check box to define that the table can be expanded or collapsed
by the user.
Is Expanded
Select this check box to define that the table is initially displayed expanded
(only relevant if the Is Expandable check box is set).
Table Title
Define the overall title of the line item table.
Grouping Fieldname
Define the field name for grouping. The entries of the table are grouped by
their values.

416 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

Grouping Title Field

Define the title of the group. If you do not add a value for the Grouping
Title Field, the content of the Grouping Fieldname is used as title of the
group.
Compare Action Is Available
Select this check box to define that the Compare button is available. This
button allows the user to undo actions.
Selection Event Is Active
Select this check box to let the table raise an event when the user selects a
different table entry. Attribute and table views listening to the selection
event are then updated (data selection for associations and method /OTX/
PF62_IF_PERSPECTIVE_CLAS~CHANGE_DATA of perspective class).

Listens To Selection Event

Select this check box to specify that the table listens to selection events of
other tables of this perspective.
Settings are not displayed
Select this check box to define that the settings option is not available for the
user.
Paging Is Active
Select this check box to activate paging. If this check box is cleared, all
entries are displayed at once.
Rearrange Is Active
Select this check box to allow changing the order of the table entries.
Row title
Enter the title of the row. The title is displayed above the cell values of the
row.
Row Icon
Enter the icon that displays in front of the row title.
Row Description
Enter the description of the line, which is displayed below the row title.
Row Actions Are Available
Select this check box to make the action sheet in the rows available.
Selection Mode
Define if an entry of the table can be selected or not. The following options
are available:

• Single entry
• No selection

Row State
Define the row state. The row is highlighted in the color of the state.
Available states are:

VIM200405-CGF-EN-02 Configuration Guide for Foundation 417

Chapter 9 Fiori Task App

• None (default)
• Success
• Warning
• Error
• Information

5. On the COLUMNS tab, configure advanced line item columns, using the
following parameters:

Field Name
Name of the column.
Column Type
Select one of the following types: Default, Mandatory, Available, Hidden.
Display Type
Configure the way the column is displayed. The following values are
available:

• Standard field (default)

• Display as checkbox (requires boolean)
• Amount field. Define currency in field EXT_VALUE
• Display as switch
• Display as icon: The value of this field is considered as icon name
• Object: Object Identifier

Editable
To allow the attribute to be edited, select this check box. This setting is only
considered if the complete view is set to editable.

6. On the RELATED FIELDS tab, define related fields for the column, using the
following parameters:

Perspective view ID
Enter the view ID.
Field Name
Enter the field name.

7. On the DEFAULT ROW ACTIONS tab, configure default row actions for the
table, using the following parameters:

Defaut Action Add (PF62 ADD)

Select this check box to configure an Add action to the table row.

418 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

Defaut Action Copy (PF62 COPY)

Select this check box to configure a Copy action to the table row.
Defaut Action Delete (PF62 DEL)
Select this check box to configure a Delete action to the table row.
Defaut Action Up (PF62 UP)
Select this check box to configure an Up action to the table row.
Defaut Action Down (PF62 DOWN)
Select this check box to configure a Down action to the table row.

8. On the CUSTOM ROW ACTIONS tab, configure custom row actions for the
advanced line items, using the following parameters:

Action ID
Enter the ID of the action to be performed in the row.
Row Action Type
In this list, click one of the following action types:

• Add
• Copy
• Delete
• Up
• Down
• Action Dialog (Set ActionDialog class in Nav. link param.)
• Semantic Navigation (Set Nav. link parameter)
• Field Popup (Set Perspective Id in Nav. link parameter)

Nav. link parameter

Enter the navigation link parameter. It depends on the settings in Row
Action Type on page 419.

9.6.6 Configuring deprecated views

This section describes the customizing of deprecated views. These views cannot be
used in new item perspectives but they are still displayed in already existing item
perspectives. The following sections describe how you can change the configuration
for these views.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 419

Chapter 9 Fiori Task App

9.6.6.1 Configuring the header view

In this step, you configure the header view of a perspective.

To configure the header view:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Perspectives > Data Binding.
3. On the Perspective Overview screen, mark a perspective, and then double-click
Header View in the Dialog Structure.
4. On the Header View Details screen, enter the field descriptions, using the
following parameters:

• Workobject type: Work object type for which this layout is used
• Perspective ID Item
• Intro text
• Title
• Mark favorite: The favorite icon is displayed.
• Mark as flagged: The flag icon is displayed.
• Number state: The fields 1st Status and 2nd Status are colored according to
the status value: Error - red, Warning - yellow, Success - green, None -
black ).
• Number
• Unit Text
• Link type
This field defines the type of the link for semantic object navigation. Possible
values:

– No link

420 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

– Semantic object navigation

For more information, see “Semantic object navigation” on page 370.

• Link parameter
This field contains the JSON with the link parameters. For more information,
see “Semantic object navigation” on page 370. The JSON data must match
the following structure:
{
"target": {
"semanticObject": <semantic object>,
"action": <action>
},
"params": {
<optional parameters>
}
}

• 1st Attribute
• 2nd Attribute
• 1st Status
• 2nd Status

Notes

• The Link type and Link parameter fields are only available in the item
header customizing and not in the master list customizing. For more
information, see “Configuring the item header details” on page 421.
• You can change the settings of this customizing by implementing the
method CHANGE_OBJECT_HEADER of the web handler class. For more
information, see “CHANGE_OBJECT_HEADER” on page 476.

9.6.6.2 Configuring the item header details

In this step, you define the field values displayed in the Detail view ot.approve.
requests.view.ItemDetails. You can define up to 20 attributes that should be
displayed. Each attribute must be a field of the display structure.

You can change the settings of this customizing by implementing the

method CHANGE_HEADER_DETAILS of the web handler class. For more information,
see “CHANGE_HEADER_DETAILS” on page 469.

You can set item header detail fields to editable and required. You can also link
input helps to the fields. A field can be set to editable, and no input help is linked. In
this case, the Web Services automatically check if the field in the header structure is
linked to a SAP search help or a domain with values. For more information, see
“Input helps” on page 399. The Web Services use this information to generate an
input help in the Fiori Task App for this field.

To configure the item header details:

1. Run the /n/OTX/PF62_IMG_OLD transaction.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 421

Chapter 9 Fiori Task App

2. Click Business Center - Web Services - Deprecated Activities > Items > Item
Header Details.

3. In the Header details Overview screen, configure object header details using
the following parameters:

Work object type

Work object type for which the item header details are configured.
Perspective ID Item
For more information, see “Enabling nodes for Web Services” on page 388.
Perspective view ID
Unique ID of the perspective view.
Position
Sequence of the item header details.
Field Name
Enter the field name of the display structure of the work object type.
Editable
To allow the field to be edited, select this check box.
Required
To set the field as required, select this check box.
Checkbox
To display the field as a check box, select this check box.
The field must be of type CHAR with length 1. Valid values are: X = true
and <blank> = false.
Search Help ID
Enter the unique ID of the search help for the field. For more information,
see “Input helps” on page 399.
Help Variant
Select the type of help. The following types are available.

• F4 help only: Users can only select and enter values using a search
help.
• F4 help with suggestions: Users can directly enter values. When the
user enters a value which fits for one or several values of the search
help, these values are displayed as suggestions. The user can select
them. Alternatively, the user can select the values using a search help.
• Drop-down list: Users can select values in a drop-down list.
• Suggestions: When the user starts to enter a value suggestion, suitable
values from the search help are displayed, which the user can select.
• F4 help with input field: Users can either directly enter values for
this field or select them using a search help.

422 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

Value Description
Select this check box to display a description behind the value field.
The value description is not automatically set, but has to be implemented in
the CHANGE_HEADER_DETAILS method of the web handler.
The ON_VALUE_UPDATE_HEADER_DETAIL method enables you to change the
value description after the value has changed.
Update on change
Select this check box to trigger the ON_VALUE_UPDATE_HEADER_DETAIL
method of the web handler if the value of the field is changed. For more
information, see “ON_VALUE_UPDATE_HEADER_DETAIL” on page 471.
Link type
This field defines the type of the link for semantic object navigation.
Possible values:

• No link
• Semantic object navigation

For more information, see “Semantic object navigation” on page 370.

Link parameter
This field contains the JSON with the link parameters. For more
information, see “Semantic object navigation” on page 370. The JSON data
must match the following structure:
{
"target": {
"semanticObject": <semantic object>,
"action": <action>
},
"params": {
<optional parameters>
}
}

9.6.6.3 Configuring the item list title

In this step, you define the title of the item list for a work object type.

You can change the settings of this customizing by implementing the

method CHANGE_ITEM_LIST_TITLE of the web handler class. For more information,
see “CHANGE_ITEM_LIST_TITLE” on page 480.

To configure the item list title:

1. Run the /n/OTX/PF62_IMG_OLD transaction.

2. Click Business Center - Web Services - Deprecated Activities > Line Items >
Line Item List Title.

3. In the Titles of item list Overview screen, configure the line item list titles
using the following parameters:

VIM200405-CGF-EN-02 Configuration Guide for Foundation 423

Chapter 9 Fiori Task App

Work object type

Work object type for which the item list title is configured.

Perspective ID - Item
ID of the item perspective.

Language
Language of the title.

Title
Enter the title text. You can use {n} to integrate the number of items in the
title.

9.6.6.4 Configuring line item details

In this step, you configure the structure of the item list. You must set the item data in
method GET_ITEMS of the web handler class.

You can change the settings of this customizing by implementing the

method CHANGE_ITEM_STRUC of the web handler class (see
“CHANGE_ITEM_STRUC” on page 467).

To configure line item details:

1. Run the /n/OTX/PF62_IMG_OLD transaction.

2. Click Business Center - Web Services - Deprecated Activities > Line Items >
Line Item Details.

3. In the Line Items Overview screen, configure line item details using the
following parameters:

Work object type

Work object type for which the item details are configured.

Perspective ID - Item
ID of the item perspective.

Column ID
Define in which columns the field should be displayed. You can define a
maximum of 10 columns.

Field Name
Enter the field name in the item structure. This structure must be defined in
the web handler implementation. For more information, see “Web handler”
on page 451.

Search Help ID
Enter the unique ID of the search help for the field. For more information,
see “Input helps” on page 399.

424 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.6. Configuration

Mobile
Select this check box to set the priority for mobile devices. If only a reduced
number of columns is displayed on mobile devices, these columns are
displayed with priority.
Editable
Select this check box to mark the column as editable.
Checkbox
Select this check box to display the field as a check box.
The field must be of type CHAR with length 1. Valid values are: X = true
and <blank> = false.
Is Unit
Select this check box to mark the values of the column as units of a
previously defined column.
Update
Select this check box to trigger the ON_VALUE_UPDATE_ITEM method of the
web handler if the value of the field is changed. For more information, see
“ON_VALUE_UPDATE_ITEM” on page 468.
Link type
This field defines the type of the link for semantic object navigation.
Possible values:

• No link
• Semantic object navigation

For more information, see “Semantic object navigation” on page 370.

9.6.6.5 Configuring the data binding for a full screen list

In this step, you configure the display of a work object in the full screen list. You
define the structure of the node list as a table with columns.

Example 9-1: Full screen list

VIM200405-CGF-EN-02 Configuration Guide for Foundation 425

Chapter 9 Fiori Task App

To configure the data binding of a full screen list:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Workplace > Nodes.
3. In the Nodes Overview screen, mark a node, and then double-click Full Screen
List - Data Binding in the Dialog Structure.
4. In the Full Screen List - Data Binding Overview screen, double-click an entry.
5. In the Full Screen List - Data Binding Details screen, configure the data
binding using the following parameters:

• Column Id: Use this numeric field to define the order of columns.
• Field Name
• Width (CSS)
• Display style: Choose one of the following options:

– Normal text field

– Display as icon
– Display as checkbox (requires boolean)
• Navigation type: Choose one of the following options:

– Show popup
– Show inplace
– Navigate to semantic object
– Navigate to edit view
– Call action dialog
– No link
• Nav. link parameter (Navigation link parameter)
• Action ID
• Visibility on phones
• Visibility tablets
• Visibility desktops
• Vis. Combi Device (Visibility Combi Device)

Note: SAP provides the following definition of the device type

“combi”:

426 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.7. Editing perspectives and layouts

If this flag is set to true, the device is recognized as a combination of a

desktop system and tablet. Furthermore, a CSS class sap-combi is
added to the document root element.
For more information, see https://openui5.hana.ondemand.com/#/api/
sap.ui.Device.system/properties.

For phones, tablets, desktops, and combi device, choose one of the following
visibility options:

– Display as normal column

– Do not display
– Display as Popin
• Export enabled
Select this check box to add the content of the current column to a
spreadsheet that can be downloaded as a Microsoft® Excel® file. By hiding
columns, users can restrict the downloaded columns. If one of the node list
columns is export enabled, a Download button is available.
• Transport type: Choose one of the following options:

– No transport required (default)

– Customizing request

– Workbench request

• Medium Fld Labl (Medium field label)

• Default value
• Tooltip: Enter tooltip for the node list column.
This setting can be overwritten using the CHANGE_NODE_LIST_COLUMNS
method of interface /OTX/PF62_IF_NODE. For more information, see
“CHANGE_NODE_LIST_COLUMNS” on page 449.

9.7 Editing perspectives and layouts

Perspectives define which item related data is displayed in the Fiori Task App and
where. They define the content and visual appearance of items for a specific area of
the screen in the Fiori Task App. Only one perspective is shown at the same time in
the Fiori Task App.

Perspective views are delivered using the following BSP applications which reside
on the frontend server:

• PF07_BC_UI_03,
• PS30_VIM_UI_03 (and custom BSPs).

VIM200405-CGF-EN-02 Configuration Guide for Foundation 427

Chapter 9 Fiori Task App

Perspective A perspective has a 1:1 relation to a perspective layout. Therefore you can modify
Layouts the layout without influencing other perspectives. You can maintain dedicated
perspective layouts separately as drafts for perspectives. You can create a
perspective from an existing perspective or perspective layout. When the
perspective is saved, it is always independent to any used draft object (either
perspective layout or another perspective).

Perspective Business Center 16.3 introduces the Perspective Editor, a maintenance tool that
Editor allows you to perform all configuration tasks on perspectives and their elements.
You can start the Perspective Editor from the Launchpad by clicking the
Perspectives Maintenance tile.

Note: To see this tile, the Perspective Editor must be configured. The tile
configuration is delivered with a transport: Administration - /OTBCWUI/PF07_
BC_ADMIN - Perspective Manager. For more information , see Section 12.4.3.1.1
“Transports” in OpenText Vendor Invoice Management for SAP Solutions -
Installation Guide (VIM-IGD). You only need to configure the backend
connection of this tile.

“Old” templates Perspective templates (that were used in Business Center versions earlier than 16.3)
are stored in BSPs as UI5 XMLS Views. They are available for backward
compatibility. When you modify a perspective with a template in the Perspective
Editor and save it, the template is converted into a UI5 JSON View Perspective
Layout that is stored in a backend table. You must manually convert any inline CSS
data. Also localized texts must be converted manually.

The perspective customizing for manual maintenance is deprecated with Business

Center 16 Update 2. The customizing only allows to configure perspectives
leveraging old templates. Now you can only modify the perspective layout using the
new Perspective Editor.

9.7.1 Available Fiori App views

428 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.7. Editing perspectives and layouts

Table 9-1: Fiori App views

Related
Perspective Control/ Related
View name Description Interface
Type Purpose Customizing
methods
“CHANGE_
CUSTOMIZI
NG”
on page 487
“CHANGE_
DATA”
on page 489
“UPDATE_R
OW_VALUE
“Configuring S”
item.
the table on page 496
Item Table AdvLineIte Table view
view” “UPDATE_A
ms
on page 404 FTER_REL_A
TTR_LIST_C
HG”
on page 501
“UPDATE_N
EW_ROW”
on page 503
“CHECK_SA
VE_DATA”
on page 493
“CHANGE_
CUSTOMIZI
NG”
on page 487
“CHANGE_
DATA”
on page 489
“UPDATE_R
OW_VALUE
Table view item. “Configuring S”
with AdvLineIte the table on page 496
Item Table view
responsive msResponsi view” “UPDATE_A
behavior ve on page 404 FTER_REL_A
TTR_LIST_C
HG”
on page 501
“UPDATE_N
EW_ROW”
on page 503
“CHECK_SA
VE_DATA”
on page 493

VIM200405-CGF-EN-02 Configuration Guide for Foundation 429

Chapter 9 Fiori Task App

Related
Perspective Control/ Related
View name Description Interface
Type Purpose Customizing
methods
“CHANGE_
CUSTOMIZI
NG”
on page 487
“CHANGE_
DATA”
on page 489
“UPDATE_R
OW_VALUE
Table view,
“Configuring S”
line cells are item.
the table on page 496
Item displayed AdvLineIte Table view
view” “UPDATE_A
vertical in a msVertical
on page 404 FTER_REL_A
single column
TTR_LIST_C
HG”
on page 501
“UPDATE_N
EW_ROW”
on page 503
“CHECK_SA
VE_DATA”
on page 493
“CHANGE_
CUSTOMIZI
NG”
on page 487
“CHANGE_
Displays
DATA”
fields in a
on page 489
single
“Configuring “UPDATE_A
item. column. A
the attribute TTRIBUTES”
Item Input Fields AttributeL field consists
list view” on page 498
ist of a label,
on page 401 “UPDATE_A
input field
FTER_REL_A
and
TTR_LIST_C
description.
HG”
on page 501
“CHECK_SA
VE_DATA”
on page 493
“CHANGE_
Displays DATA”
content using on page 489
item.
Item Comments control Not available “TRANSLAT
Comment
sap.m.FeedLi E_COMMEN
stItem TS”
on page 492

430 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.7. Editing perspectives and layouts

Related
Perspective Control/ Related
View name Description Interface
Type Purpose Customizing
methods
List with
documents.
Selected
document is
item. displayed in “CHANGE_
Item Document list Attachment the item. Not available DATA”
sInplace Document/ on page 489
item.Widget
view in the
same
perspective
List with
documents.
item.
Selected
Item Document list Attachment Not available
document is
sNewTab
displayed in
new tab.
List with
documents.
Selected
document is
displayed in
item.Docume
item.
nt / item.
Item Document list Attachment Not available
Widget view
sSplit
in same
perspective in
different
flexible
column or
split screen
Displays the
main
document or “CHANGE_
Document item.
Item the document Not available DATA”
view Document
selected in an on page 489
item.Attachm
ents views

VIM200405-CGF-EN-02 Configuration Guide for Foundation 431

Chapter 9 Fiori Task App

Related
Perspective Control/ Related
View name Description Interface
Type Purpose Customizing
methods
Displays the
main
document or
the document
selected in
item.
Document
Attachments “CHANGE_
view with item.
Item views. Offers Not available DATA”
data Widget
features to on page 489
validation
move data
from a
document to
attribute list
fields and
table cells
“GET_MSG_
CONTAINER
” on page 350
dialogPart
“GET_MESS
. Displays
Action Dialog Messages Not available AGES”
ActionMess messages
on page 351
ages
“SET_MESSA
GE”
on page 361
dialogPart
“GET_TEXT_
. Text area,
Action Dialog Display text Not available AREA”
Descriptiv display only
on page 349
eText
dialogPart
“GET_BUTT
.
Action Dialog Button Button Not available ON”
DialogButt
on page 357
on
“EXECUTE_
ACTION”
on page 362
“GET_FILE_
UPLOAD”
dialogPart on page 360
Control to
Action Dialog File Upload . Not available “EXECUTE_L
upload files
FileUpload INE_ITEM_A
CTION”
on page 364
“CREATE_A
CTION”
on page 362

432 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.7. Editing perspectives and layouts

Related
Perspective Control/ Related
View name Description Interface
Type Purpose Customizing
methods
“GET_DROP
_DOWN”
on page 355
“EXECUTE_
ACTION”
dialogPart
on page 362
. Drop down
Action Dialog Drop down Not available “EXECUTE_L
MultiCombo list
INE_ITEM_A
Input
CTION”
on page 364
“CREATE_A
CTION”
on page 362
“GET_TABLE
” on page 358
“EXECUTE_
ACTION”
on page 362
dialogPart “EXECUTE_L
Action Dialog Table Table Not available
.Table INE_ITEM_A
CTION”
on page 364
“CREATE_A
CTION”
on page 362
“GET_TEXT_
AREA_INPU
T”
on page 354
“EXECUTE_
dialogPart ACTION”
. Text area, on page 362
Action Dialog Enter text Not available
TextAreaIn edit “EXECUTE_L
put INE_ITEM_A
CTION”
on page 364
“CREATE_A
CTION”
on page 362

VIM200405-CGF-EN-02 Configuration Guide for Foundation 433

Chapter 9 Fiori Task App

Related
Perspective Control/ Related
View name Description Interface
Type Purpose Customizing
methods
“GET_INPUT
_FIELD”
on page 352
“EXECUTE_
Field to
ACTION”
dialogPart display or
on page 362
. maintain
Action Dialog Input field Not available “EXECUTE_L
ValueHelpI data.
INE_ITEM_A
nput Optional with
CTION”
search help
on page 364
“CREATE_A
CTION”
on page 362

9.7.2 Maintaining perspectives and layouts

On the start page of the Perspective Editor, you have access to all available
perspectives and layouts.

To switch between Perspectives and Layout, click the corresponding icon on the
toolbar on the top.

The way how you work with perspectives and layouts is similar, the procedure is
therefore described only once.

In the search and filter bar below the toolbar, you can perform the following actions:

• “To search the list:“ on page 435

• “To filter the list:“ on page 435

In the list, you can perform the following actions:

• “To enable a bulk action“ on page 435

• “To open the details page:“ on page 435

• “To delete the ID:“ on page 435

• “To create a new perspective or layout:“ on page 436

• “To rename a perspective:“ on page 437

• “To transport a perspective“ on page 437

• “To activate or deactivate a perspective:“ on page 437

• “To activate or deactivate a perspective:“ on page 437

434 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.7. Editing perspectives and layouts

To enable a bulk action

1. Use the search or filter function to reduce the displayed perspectives to a

number that displays without switching the page.

2. In the footer, click the Multi Select button .

3. Select the items on the check-box that gets available and perform the action.

To search the list:

1. In the search box on the very left, enter a case-sensitive search term.

2. Optional To define where the term is searched, click the down icon to the right of
the search box.
Available are:

• Perspective ID
• Description
• Changed By
• Object ID

3. Press RETURN or click the search icon.

4. To clear the search term, click the cross icon in the search box.

To filter the list:

There are two ways to filter a list.

1. To filter the list, using the filters that are displayed on top of the list:

a. Click the available filter. For example, Perspective Type.

b. In the dialog box, select one or more criteria that is used for filtering.

2. To filter the list, using the Filter icon:

a. Click the Filter icon.

b. Click the Filter.
c. Select one or more criteria that is used for filtering.

3. To remove the filter and return to the original view, click the Reset icon.

To open the details page:

• Click the perspective ID (layout ID).

To delete the ID:

• In the perspective list, click More Actions > Delete for the perspective
that you want to delete.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 435

Chapter 9 Fiori Task App

To create a new perspective or layout:

1. Click Create Perspective on the toolbar at the bottom of the page.

2. In the Create Perspective dialog box, create a perspective in the following steps:

a. Choose a creation approach:

In this list you can choose between a creation from an existing perspective,
an existing layout, or start with an empty perspective.
b. Specify parameters.
Depending on the chosen creation approach, the mandatory parameters
vary.

Perspective Type
Choose Item, Action Dialog, or Field from the list.
Perspective ID
Mandatory. Enter a meaningful ID for the perspective.
The ending of the ID defines the device type:

• _S
Smartphone
• _M
Tablet
• _H
Hybrid
• without ending
If you do not define a device type, the systems only uses this
perspective if no other perspective is available.
If a perspectives for device types exist, the first perspective with
device type is used.
The order of the checks is:
Smartphone > tablet > hybrid > desktop.
This allows, for example, to specify one perspective which fits for
smartphone and tablet if you only define a perspective with device
type _M.

Root Work Object Type

Select a work object type from the list to which the perspective should
be bound. The root work object type determines which fields and
associations are available for property bindings and data views.

Note: You cannot change this setting later on.

436 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.7. Editing perspectives and layouts

Seeting a root work object type is mandatory for all perspective

types but not for ACTION_DLG perspective type.
Select Perspective
Mandatory unless you have chosen Do Not Use A Template in Step 2.a
on page 436. Click in the field to open the Select Perspective dialog box
and choose a perspective from the list.
Enter description
Enter a description for the new perspective.

3. Click Create.

To rename a perspective:

1. In the perspective list, click More Actions > Rename button for the
perspective that you want to rename.
2. In the Rename Perspective dialog box, enter the new name for the perspective,
using the following parameters:

Perspective ID
Enter the new name.
Description
Enter a description of the perspective.

3. Click Rename.
The selected perspective is copied to the new perspective ID. The old
perspective is deleted. All customizing entries related to the old perspective are
copied/changed to the new perspective ID.

To transport a perspective

Note: The action is also available as bulk action. For more information, see“To
enable a bulk action“ on page 435.

1. In the perspective list, click More Actions > Add To Transport

button, for the perspective that you want to transport.
2. In the Select Customizing Request dialog box, select a request, and then click
OK.
The content of the perspective is written to the customizing transport.

To activate or deactivate a perspective:

1. In the perspective list, click More Actions .

2. To deactivate a perspective, click the Set inactive button for an active
perspective .
You cannot use a deactivated perspective in an application anymore. It is also
not possible to maintain deactivated perspectives in the perspective editor.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 437

Chapter 9 Fiori Task App

3. To activate a perspective, click the Activate button for an inactive

perspective .

The Changed at and Changed by columns in the perspective list are relevant for
perspectives that are changed using one of the following actions:

• Rename
• Activate
• Deactivate
• Edit

If a perspective is changed, the user and timestamp are logged. The information is
displayed in the Changed by and Changed atcolumns.

Device specific To maintain a device specific perspective, you must append the general perspective
perspective ID with a specific suffix. During perspective retrieval, the system first tries to get a
device specific perspective. If no such perspective exists, the standard perspective is
used.

Perspective ID Device Type

<pSample> Desktop (and other device types for which no dedicated types are
maintained)
<pSample>_S Smartphone
<pSample>_M Tablet
<pSample>_C Combi devices

9.7.3 Editing perspective and layout details

The detail page of a perspective (or layout) enables you to perform all actions to
configure the perspective to your needs.

Note: When speaking of “perspectives” in this section, “layouts” are meant as

well.

438 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.7. Editing perspectives and layouts

Tree area The tree area on the left lists all perspective elements in a cascading structure. In
detail, a perspective comprises the following elements:
Layout root element.

Layout container. SAP UI5 control representing a specific layout, for example a
vertical layout. If the icon is green on the right side, a CSS class is assigned to
the layout container.
To see all available layouts, open the Layouts palette.
Aggregation. An aggregation is a special relation between two UI element
types. It is used to define the parent-child relationship within the tree
, structure. The parent end of the aggregation has cardinality 0..1, while the
child end may have 0..1 (empty triangle) or 0..* (filled triangle). Examples are
table rows and cells, or the content of a table cell.
Data view. A data view acts as dynamic part of a perspective. It displays data
according to the data binding defined in the customizing. A green label on the
right side of a data view indicates that a CSS class has been assigned. Each
view type can be inserted multiple times in a perspective.
Note: The History and Attachments views will always display the same
data. They cannot be configured on view instance level. So it makes sense
to include them only one time.
LayoutData. For some layouts (for example grid), you can attach specific
LayoutData to the children of the layout. LayoutData steers where and how the

VIM200405-CGF-EN-02 Configuration Guide for Foundation 439

Chapter 9 Fiori Task App

child is displayed in the container if the container supports this flexibility.

Examples are column span of an element or alignment.

To edit a perspective:

1. On the start page, click the perspective or the corresponding pencil icon.

2. In the Select Customizing Request dialog box, select a request, and then click
OK.

3. Arrange the elements in the tree structure.

a. Move elements up or down or delete them using the context menu.

b. In the Palettes area on the upper right of the detail page, open the Views,
Layout Containers, and Layout Data lists. You can expand single Layout
Containers to see the respective aggregation.

Notes

• Depending on the perspective type, only suitable views are

displayed.
• You can place views and controls in aggregations where the type
matches. If the type is not suitable, the Perspective Editor does not
allow to drop the element.
c. From the Palettes area, drag elements to the tree structure to integrate them
into the perspective. You can place the elements in the tree only on valid
locations. This means, the type of aggregation must match.

4. Optional In the Description field, add a description of the perspective. It is

displayed on the start page.

5. Optional To add a scroll bar to the whole page at runtime, if necessary, select the
Scrolling of page enabled check box.

6. For elements under Layout Containers, and Layout Data in the Palettes area,
click SAP API Information from the context menu to display the corresponding
page of the SAP Help.

7. Optional To add further UI5 layout containers, click Add UI5 Control on the
context menu of Layout Containers.
To add custom data views, click Add Module Views on the context menu of
Views.

8. To edit the properties of an element, click the element in the tree structure. In
the Properties area, make the required changes.
For Layout Containers, the properties are read from the control metadata. They
rely on the UI5 toolkit version.
For properties with <string>, you can maintain a localization key:

a. Enter the text key in the field in upper case and angle brackets.

440 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.7. Editing perspectives and layouts

b. Click the globe icon.

c. In the Localization dialog box, enter the value corresponding to the text
key.

Note: The translation is done with regular ABAP translation

mechanisms.

9. Optional To assign a custom CSS class to an element, maintain the CSS class in the
CSS area. In the Properties area, enter the CSS class name in the cssClass
<string> field.
The CSS area collects the CSS code for the whole perspective.

Note: OpenText recommends that you use the standard SAP UI theme
designer primarily regarding CSS. Only in very special cases the usage of
the CSS in the CSS area of your perspective is needed. Make sure that your
changes are compliant across all SAPUI5 versions and all standard SAP
themes.

10. To perform a check of your changes, click Check on the toolbar at the bottom of
the page.
The check ensures that all IDs are unique and that referenced CSS classes are
also defined in the CSS data.

9.7.3.1 Configuring property bindings

Property bindings have the following major purposes:

• Change the perspective at runtime, for example make some areas visible or
invisible depending on computation in the backend. In such a scenario you
would bind the “visible” property of one or more layout containers.
• Arrange an arbitrary number of sap.m.ObjectAttribute and/or sap.m.
ObjectStatus in any of the available layouts to be presented somewhere on the
page, typically in the headerContent of the sap.uxap.ObjectPageLayout.

To add a binding to a certain property:

1. Click the property to open the binding action sheet.

2. To open the Work Object Type Fields dialog box, click the Add Binding action.

3. Select one of the fields.

Available fields for binding:

• Fields of the display structure of the root work object type or its associated
work object types.
• PF62_IS_LOCKED: Lock icon for a field.
• PF62_LOCKED_BY_USER: User who locks the field.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 441

Chapter 9 Fiori Task App

PF62_IS_LOCKED and PF62_LOCKED_BY_USER are calculated by the framework

checking the locking information of the root work object type.
Whenever a layout control has at least one binding, you can detect it in the tree
by the orange triangle on the upper left edge of the icon. See the following
screenshot.

You can change or delete an existing binding with the corresponding actions in
the binding action sheet, which is always opened when you click the property.

9.7.3.2 Support of FlexibleColumnLayout in perspectives

The Fiori Task App supports toggling and closing of the mid and end column of the
FlexibleColumnLayout control.

In the perspective editor you can assign the predefined controller methods to the
press event of the corresponding buttons of your pages used in the
FlexibleColumnLayout.

The following predefined controller methods are available for the press event:

• onToggleMidColumnFullScreen
• onCloseMidColumn
• onToggleEndColumnFullScreen
• onCloseEndColumn

The Fiori Task App:

• Automatically shows or hides the buttons at runtime according to the state of the
FlexibleColumnLayout control

442 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.7. Editing perspectives and layouts

• Changes the layout as defined.

To trigger the display of a page in the FlexibleColumnLayout control, you can use
the action type Change page in flexible column layout (parameter = page id)
(FLEX_PAGE) in the action customizing row of the FullScreenList or
AdvancedLineItems.

9.7.4 Maintaining perspective texts

With Business Center 16.3 and later, perspectives are maintained using the
Perspective Editor.

One exception is the maintenance and translation of perspective texts, which is still
done in the Business Center IMG.

To maintain perspective texts:

1. Run the /n/OTX/PF00_IMG transaction.

2. Click OpenText Vendor Invoice Management Foundation > Web Services >
Perspectives > Perspective texts.

3. In the Perspective Overview screen, maintain perspective texts, using the

following parameters:

Perspective ID
Unique ID of the perspective.
Pers. Type
Select the perspective type. Choose Item, Action Dialog, Node, or Field
from the list.
Description
Description of the perspective.

4. To maintain texts for a perspective, mark the perspective, and then double-click
Texts in the Dialog Structure.

5. In the Texts Overview screen, maintain texts using the following parameters:

Text Id
Unique ID of the text.
Text
Enter the text for the perspective. For translation, click Translation on the
Goto menu.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 443

Chapter 9 Fiori Task App

9.8 Interfaces and exits

This section describes interfaces and exits that are relevant for the Web Services.

Note: The parameter naming in VIM follows the following rules:

1st Character
P fix, indicates a parameter.

2nd character
I (Importing) or C (Changing) or E (Exporting).

3rd character
<empty> (variable) or S (structure) or T (table).

9.8.1 Interface /OTX/PF62_IF_NODE

Customizing user exits for nodes in the Workplace requires a class with
implementation of the /OTX/PF62_IF_NODE interface.

This interface has the following methods:

• “CHANGE_NODE” on page 444

• “CHANGE_NODE_SEARCH_FIELDS” on page 445
• “CHANGE_NODE_SORT_FIELDS” on page 446
• “CHANGE_NODE_FILTER_FIELDS” on page 446
• “CHANGE_NODE_FILTER_VALUES” on page 447
• “CHANGE_NODE_LIST” on page 448
• “CHANGE_NODE_LIST_COLUMNS” on page 449
• “CHANGE_NODE_ACTIONS” on page 450

9.8.1.1 CHANGE_NODE
This method is called when the nodes are loaded and allows to change the state of
the node.

Tip: The implementing class of the interface /OTX/PF62_IF_NODE has to be

maintained in the field NODE_EXIT of the node customization. For more
information, see “Enabling nodes for Web Services” on page 388.

Parameter Type Description

PIS_WOBJ_TYPE Importing Work object type
PI_NODE_ID Importing Node ID

444 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Parameter Type Description

PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_WORKPLACE Importing Importing Workplace ID

PET_RETURN Exporting Messages
PE_ERROR_TYPE Exporting Error type
PE_BUS_ERROR_HANDLING Exporting Error handling
PCS_NODE_SETTINGS Changing Node settings that can be changed. The
field VALUE_STATE allows to change the
values state of a node.

9.8.1.2 CHANGE_NODE_SEARCH_FIELDS
This method allows changing the customized field for the object search at runtime.

Parameter Type Description

PIS_WOBJ_TYPE Importing Work object type
PI_NODE_ID Importing Node ID
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_SOFT_STATE Importing Soft state active?

PET_RETURN Exporting Messages
PE_ERROR_TYPE Exporting Error type
PCT_SEARCH_NAMES Changing Fields available for search

Structure of parameter PCT_SEARCH_NAMES:

Field name Description

ID Field ID
TITLE Displayed title
POS Position

VIM200405-CGF-EN-02 Configuration Guide for Foundation 445

Chapter 9 Fiori Task App

9.8.1.3 CHANGE_NODE_SORT_FIELDS
This method allows changing the sort fields available for this node at runtime.

Parameter Type Description

PIS_WOBJ_TYPE Importing Work object type
PI_NODE_ID Importing Node ID
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_SOFT_STATE Importing Soft state active?

PET_RETURN Exporting Messages
PE_ERROR_TYPE Exporting Error type
PCT_SORT_NAMES Changing Fields available for sorting

Structure of parameter PCT_SORT_NAMES:

Field name Description

ID Field ID
TITLE Displayed title
POS Position

9.8.1.4 CHANGE_NODE_FILTER_FIELDS
This method allows changing the filter fields available for this node at runtime.

Parameter Type Description

PIS_WOBJ_TYPE Importing Work object type
PI_NODE_ID Importing Node ID
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_SOFT_STATE Importing Soft state active?

PET_RETURN Exporting Messages
PE_ERROR_TYPE Exporting Error type

446 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Parameter Type Description

PCT_FILTER_NAMES Changing Fields available for filtering

Structure of parameter PCT_FILTER_NAMES:

Field name Description

ID Field ID
TITLE Displayed title
COUNT Number of entries found for this criteria
SEARCHABLE Values of this filter criteria are searchable
CASE_SENSITIVE Case sensitive search for values of this filter criteria
POS Position
NO_MULTI_SELECT Limits the filter selection to one value.

9.8.1.5 CHANGE_NODE_FILTER_VALUES
This method allows changing the filter values available for the current filter at
runtime.

Parameter Type Description

PIS_WOBJ_TYPE Importing Work object type
PI_NODE_ID Importing Node ID
PI_FILTER_NAME Importing Filter name
PI_SOFT_STATE Importing Soft state active?
PET_RETURN Exporting Messages
PE_ERROR_TYPE Exporting Error type
PCT_FILTER_VALUES Changing Values available as filter criteria

Structure of parameter PCT_FILTER_VALUES:

Field name Description

ID Filter ID
VALUE Value ID
TITLE Value title
COUNT Number of objects available for this filter value

VIM200405-CGF-EN-02 Configuration Guide for Foundation 447

Chapter 9 Fiori Task App

9.8.1.6 CHANGE_NODE_LIST
This method allows changing the displayed data of a full screen list at runtime.

Parameter Type Description

PIS_WOBJ_TYPE Importing Work object type
PI_NODE_ID Importing Node ID
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_SELECT_MODE Importing Required data selection mode of the

request. Possible values:
• COUNT: Only count entries,
return no data
• DATA: Only return data
PIT_NODE_LIST_COLUMNS Importing Columns of full screen list
PET_RETURN Exporting Messages
PE_ERROR_TYPE Exporting Error type
PE_BUS_ERROR_HANDLING Exporting Error handling
PCT_NODE_LIST_ROW Changing Node list data
PC_ENTRIES Changing Number of entries

Structure of parameter PCT_NODE_LIST_ROW:

Field name Description

ROW_ID Row number
TASK_TITLE Title of task (displayed in detail mode)
TITLE Obsolete
Value 01-10 Value of the cell
ITEM_PERSPECTIVE_ID Perspective that is used to display the details view of the
row

448 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

9.8.1.7 CHANGE_NODE_LIST_COLUMNS
This method allows changing the columns of a full screen list at runtime.

Parameter Type Description

PIS_WOBJ_TYPE Importing Work object type
PI_NODE_ID Importing Node ID
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PET_RETURN Exporting Messages

PE_ERROR_TYPE Exporting Error type
PCT_NODE_LIST_COLUMNS Changing Columns settings

Structure of parameter PCT_NODE_LIST_COLUMNS:

Field name Description

COLUMN_ID Column ID
TYPE Type (ABAP data type)
DESCRIPTION Column description
DISPLAY_TYPE Display type (TEXT | ICON | CHECKBOX )
NAVIGATION_TYPE Navigation type. Possible values:
• POPUP: Show popup
• INPLACE: Show inplace
• SEMANTIC: Navigate to semantic object
• EDIT: Navigate to edit view
• ACTION_DLG: Call action dialog
• NONE: No link

ACTION_ID Action ID - only used with navigation type

ACTION_DLG
VISIBILITY_PHONE Column is visible at phone devices.
VISIBILITY_TABLET Column is visible at tablet devices.
VISIBILITY_DESKTOP Column is visible at desktops.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 449

Chapter 9 Fiori Task App

Field name Description

VISIBILITY_COMBI Column is visible at combi devices, a combination of
desktop and tablet.
For the VISIBILITY_* fields, the following values are
possible:
• DEFAULT: Display as normal column
• NONE: Do not display
• POPIN: Display as Popin
FIELDNAME Fieldname
COLUMN_WIDTH Width of column
EXPORT_ENABLED Export function

9.8.1.8 CHANGE_NODE_ACTIONS
This method allows changing general actions available for a node in full screen list
mode at runtime.

Parameter Type Description

PIS_WOBJ_TYPE Importing Work object type
PI_NODE_ID Importing Node ID
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PET_RETURN Exporting Messages

PE_ERROR_HANDLING Exporting Error handling
PCT_NODE_ACTIONS Changing Node actions

Structure of PCT_NODE_ACTIONS:

Field name Description

NODE_ID Node ID
WOBJ_TYPE Work object type
ACTION_ID Action ID
DEVICE Device
PERSPECTIVE_ID Perspective ID (used for Action dialog)
TEXT Button text

450 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Field name Description

BUTTON_TYPE Button style:
• ACCEPT: Accept type (blue button)
• DEFAULT: Default type (no special styling)
• EMPHASIZED: Emphasized type
• REJECT: Reject type (red button)
• TRANSPARNT: Transparent type
• UNSTYLED: Unstyled type (no styling)

ICON Icon displayed on button

TRANSPORT_REQMNT Defines the kind of transport request for the action.
Possible values:
• NONE: No transport required (default)
• CUSTOM: Customizing request
• WORKBENCH: Workbench request

9.8.2 Web handler

The web handler defines the data that is transferred by the web service for a specific
work object type. The web handler implements the /OTX/PF62_IF_ITEM_HANDLER
interface.

This interface has the following methods:

• “GET_ACTIONS” on page 452

• “CHANGE_ACTIONS” on page 452
• “GET_ACTION_REASONS” on page 454
• “GET_ACTION_VALIDAT_MSG” on page 455
• “CHANGE_ACTION_VALIDATION” on page 456
• “GET_ACTION_AGENTS” on page 458
• “EXECUTE_ACTION” on page 459
• “HANDLE_ACTIONS_BULK” on page 459
• “HANDLE_UPDATES_BULK” on page 460
• “CHECK_FIELDS” on page 461
• “CHECK_LINE_ITEM_FIELDS” on page 462
• “GET_ITEMS” on page 462
• “GET_DOCUMENTS” on page 464
• “GET_DOCUMENT_ATTRIBUTES” on page 465
• “DELETE_DOCUMENT” on page 466

VIM200405-CGF-EN-02 Configuration Guide for Foundation 451

Chapter 9 Fiori Task App

• “CHANGE_ITEM_STRUC” on page 467

• “ON_VALUE_UPDATE_ITEM” on page 468
• “CHANGE_HEADER_DETAILS” on page 469
• “ON_VALUE_UPDATE_HEADER_DETAIL” on page 471
• “GET_ITEM_STRUC” on page 472
• “GET_ITEM_LINKS” on page 473
• “CHANGE_OBJECT” on page 474
• “CHANGE_OBJECT_HEADER” on page 476
• “CHANGE_OBJECT_FUNCTIONS” on page 477
• “GET_TIMELINES” on page 477
• “GET_EXCEPTIONS” on page 479
• “CHANGE_ITEM_LIST_TITLE” on page 480
• “CHANGE_RELATED_BUS_OBJECT” on page 481
• “CHANGE_NODELIST_NAV_LINK” on page 482
• “RESOLVE_URL_PARAMS” on page 483
• “GET_IMAGE_CTRL_PAGES” on page 483
• “GET_IMAGE_CTRL_FULLTEXT” on page 485

9.8.2.1 GET_ACTIONS
This method is deprecated in Business Center 10.0 SP1 and later. It is replaced by the
CHANGE_ACTIONS method. For more information, see “CHANGE_ACTIONS”
on page 452.

9.8.2.2 CHANGE_ACTIONS
This method changes the available actions for the current item. In Business Center
10.0 SP1 and later, it replaces the GET_ACTIONS method.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PI_WOBJ_TYPE Importing Work object type.
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the item.
PI_LOGSYS Importing Logical system. Is only filled if one of
the key fields is marked as logical
system field.

452 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Parameter Type Description

PI_ACTION_ID Importing Required action ID. Initial if all actions
for the item are required.
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PCT_ACTIONS Changing Available actions.

PCT_RETURN Changing Error messages.
PC_ERROR_TYPE Changing Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message in
PCT_RETURN.
PC_BUS_ERROR_HANDLING Changing Allows to define the UI behavior in case
a business error occurs (pe_error_type =
1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

Structure of parameter PCT_ACTIONS:

Field name Description

ACTION_ORDER Order of actions.
ACTION_ID Action ID.
ACTION_CLASS Action class for action dialog (action type confirm).
Action class has to implement interface /OTX/
PF62_IF_ACTION_DIALOG
ICON SAP UI5 Icon. Will be displayed at the button.
TEXT Action text. Will be displayed at the button.
BUTTON_TYPE SAP UI5 button type. The following types are available:
• ACCEPT: Accept type (blue button)
• DEFAULT: Default type
• EMPHASIZED: Emphasized type
• REJECT: Reject style (red button)
• TRANSPARNT: Transparent style
• UNSTYLED: Without a style

VIM200405-CGF-EN-02 Configuration Guide for Foundation 453

Chapter 9 Fiori Task App

Field name Description

ACTION_TYPE Action type, which defines the behavior of the action.
The following types are available:
• EDIT: Perspective defined in field PERSPECTIVE_ID
is called. Use this type to change from display to edit
mode.
• CONFIRM: The Confirm dialog box (action
validation) opens.
• SAVE: Save is triggered.
• CHECK: Check is triggered.
• SAVE_CONFM: Save with Confirmation dialog box.
• ACTION: Action dialog box.
• SAVE_ACTN: Save with Action dialog box.
• SEMANTIC: Semantic object navigation.
• DETAIL_IN: Opens new Detail screen inplace.
• DETAIL_FUL: Opens new details screen - full screen
mode.
BULK_ACTION Action can be used as a bulk action.
PERSPECTIVE_ID Perspective that is called at action type EDIT.
VIEW_ID Perspective view ID. Can be used to overwrite the
customized value at runtime.
NAV_PARAMETER Link parameter field for action type Semantic object
navigation. Can be used to overwrite the customized
value at runtime.
TRANSPORT_REQMNT Transport requirement. Possible values:
NONE - No transport required (default)
CUSTOM - Customizing request
WORKBENCH - Workbench request

9.8.2.3 GET_ACTION_REASONS
This method returns possible reasons that can be selected in the confirmation dialog
box before the execution of an action.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PI_WOBJ_TYPE Importing Work object type.
PI_ACTION_ID Importing Action ID.
PI_LOGSYS Importing Logical system. Will only be populated
if one of the key fields is marked as
logical system field.
PI_REASON_ID Importing Reason ID.

454 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Parameter Type Description

PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the object.
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PET_ACTION_REASONS Exporting Possible reasons.

PET_RETURN Exporting Error messages.
PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message of
PET_RETURN.
PE_BUS_ERROR_HANDLING Exporting Allows you to define the UI behavior in
case a business error occurs
(pe_error_type = 1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

9.8.2.4 GET_ACTION_VALIDAT_MSG
This method returns messages that are either displayed in the validation screen or in
an extra dialog box.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PI_WOBJ_TYPE Importing Work object type.
PI_ACTION_ID Importing Action ID.
PI_LOGSYS Importing Logical system. Will only be filled if
one of the key fields is marked as
logical system field.
PIT_REASONS Importing Selected reasons.
PIT_AGENTS Importing Selected agents.
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the object.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 455

Chapter 9 Fiori Task App

Parameter Type Description

PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PET_ACTION_VALIDAT_MSG Exporting Messages.

PET_RETURN Exporting Error messages.
PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message of
PET_RETURN.
PE_BUS_ERROR_HANDLING Exporting Allows you to define the UI behavior
in case a business error occurs
(pe_error_type = 1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

9.8.2.5 CHANGE_ACTION_VALIDATION
This method defines the layout of the validation screen.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PI_WOBJ_TYPE Importing Work object type.
PI_ACTION_ID Importing Action ID.
PI_LOGSYS Importing Logical system. Will only be filled if one
of the key fields is marked as logical
system field.
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the object.
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PCS_ACTION_VALIDATION Changing Layout of the validation screen.

456 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Parameter Type Description

PET_RETURN Exporting Error messages.
PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message of
PET_RETURN.
PE_BUS_ERROR_HANDLING Exporting Allows you to define the UI behavior in
case a business error occurs
(pe_error_type = 1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

Structure of PCS_ACTION_VALIDATION:

Field name Description

DIALOG_TYPE Type of the dialog box. Possible values:
• confirm - Confirmation dialog box is displayed.
• error - Error messages are displayed without
confirmation dialog box.
TITLE dialog box title.
TASK_DESC Description of the task in the confirmation dialog box.
COMMENT_DESC Initial text in the comment box.
COMMENT_MANDATORY Flag marking the comment as mandatory.
REASONS_ACTIVE Sets selection box for reasons active.
AGENTS_ACTIVE Sets selection box for agents active.
TITLE_REASONS Title of selection box for reasons.
AGENT_TITLE Title of selection box for agents.
REASON_OPTION Select option for reasons. Possible values:
• single - Only one reason can be selected.
• multiple - Multiple reasons can be selected.
AGENT_OPTION Select option for agents. Possible values:
• single - Only one agent can be selected.
• multiple - Multiple agents can be selected.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 457

Chapter 9 Fiori Task App

9.8.2.6 GET_ACTION_AGENTS
This method returns possible agents that can be selected in the confirmation dialog
box.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PI_WOBJ_TYPE Importing Work object type.
PI_ACTION_ID Importing Action ID.
PI_LOGSYS Importing Logical system. Will only be filled if one
of the key fields is marked as logical
system field.
PI_FIRST_NAME Importing First name.
PI_LAST_NAME Importing Last name.
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the object.
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PET_ACTION_AGENTS Exporting Possible agents.

PET_RETURN Exporting Error messages.
PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message of
PET_RETURN.
PE_BUS_ERROR_HANDLING Exporting Allows you to define the UI behavior in
case a business error occurs
(pe_error_type = 1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

458 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

9.8.2.7 EXECUTE_ACTION
This method is deprecated. It is replaced by the HANDLE_ACTIONS_BULK method. For
more information, see “HANDLE_ACTIONS_BULK” on page 459.

9.8.2.8 HANDLE_ACTIONS_BULK
This method executes actions for one or more items. It replaces the EXECUTE_ACTION
method.

Parameter Type Description

PIT_ACTIONS_BULK Importing Actions to be executed.
PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will
be raised with the error message of
PET_RETURN.
PET_RETURN Exporting Error messages.
PET_BULK_ACTION_RESULT Exporting Action results.
PE_BUS_ERROR_HANDLING Exporting Allows you to define the UI behavior
in case a business error occurs
(pe_error_type = 1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

Structure of parameter PIT_ACTIONS_BULK:

Field name Description

OP_NUMBER Operation number
WOBJ_TYPE Work object type
KEYS Key fields for this item
LOGSYS Logical system
ACTION_ID Action to be executed
COMMENT Entered comment
REASONS Selected reasons
AGENTS Selected agents
CHANGED_AT Timestamp of the last change made to the item.
TRANSPORT_REQUEST Selected transport request

Structure of parameter PET_BULK_ACTION_RESULT:

VIM200405-CGF-EN-02 Configuration Guide for Foundation 459

Chapter 9 Fiori Task App

Field name Description

OP_NUMBER Operation number.
MSG Message text.
STATUS Action status:
• CONF_ERROR: Message is displayed as an error in the
confirmation dialog box. The user can change inputs in the
confirmation dialog box and execute the action again.
• GEN_ERROR: Message is displayed as error and confirmation
dialog box is closed.
• UPDATE: Object is updated and still selected. Message fades in.
• REMOVE: Object is removed from the master list and the next
object in the list is selected. Message fades in.

9.8.2.9 HANDLE_UPDATES_BULK
This method executes updates for header details and line items fields.

Parameter Type Description

PIT_UPDATES_BULK Importing Contains update information.
PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will
be raised with the error message of
PET_RETURN.
PET_RETURN Exporting Error messages.
PE_RESULT Exporting Result of update:
• SUCCESS: Update successful.
• ERROR: Update error.
PE_MSG Exporting Message text.
PE_BUS_ERROR_HANDLING Exporting Allows to define the UI behavior in
case a business error occurs
(pe_error_type = 1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

Structure of parameter PIT_UPDATES_BULK:

Field name Description

OP_NUMBER Operation number.
WOBJ_TYPE Work object type.

460 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Field name Description

ID Item ID.
KEYS Key fields for this item.
ITEM_ID Line item ID.
LOGSYS Logical system.
UPDATE_TYPE Update type. Possible values:
• HEAD: Header update
• ITEM: Line item update
FIELDS Field values. Table which contains field names and values.
CHANGED_AT Timestamp of the last change made to the item.
TRANSPORT_REQUEST Number of transport request used for this action

9.8.2.10 CHECK_FIELDS
This method checks values of header detail fields.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current
work object.
PI_WOBJ_TYPE Importing Work object type.
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the item.
PI_LOGSYS Importing Logical system. Is only filled if one of
the key fields is marked as a logical
system field.
PIT_FIELD_VALUES Importing Field values.
PET_MSG Returning Messages.

Structure of parameter PET_MSG:

Field name Description

FIELDNAME Name of the checked field
TYPE Message type:
• Error
• Warning
• Success
• None

MSG Message text.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 461

Chapter 9 Fiori Task App

9.8.2.11 CHECK_LINE_ITEM_FIELDS
This method checks values of line item fields.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PI_WOBJ_TYPE Importing Work object type.
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to the
item.
PI_LOGSYS Importing Logical system. Is only filled if one of the
key fields is marked as a logical system
field.
PI_ITEM_ID Importing ID of the line item.
PIT_FIELD_VALUES Importing Field values.
PET_MSG Returning Messages.

Structure of parameter PET_MSG:

Field name Description

FIELDNAME Name of the checked field
TYPE Message type:
• Error
• Warning
• Success
• None

MSG Message text

9.8.2.12 GET_ITEMS
This method returns items that should be displayed in the item list.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PI_WOBJ_TYPE Importing Work object type.
PIT_ITEM_DETAILS Importing Customized columns with metadata
from structure.
PI_LOGSYS Importing Logical system. Will only be filled if one
of the key fields is marked as logical
system field.

462 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Parameter Type Description

PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the object.
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_ITEM_PERSPECTIVE_ID Importing Item perspective ID.

PI_MAX_HITS Importing Maximum number of hits
PET_DATA Exporting Item data.
PET_RETURN Exporting Error messages.
PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message of
PET_RETURN.
PE_BUS_ERROR_HANDLING Exporting Allows to define the UI behavior in case
a business error occurs (pe_error_type =
1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

Structure of parameter PET_DATA:

Field name Description

ITEM_ID Item ID. This must be set by web handler
implementation.
VALUE_01 - VALUE_10 Values for columns 01 to 10.
EDITABLE Sets a list item as editable.

Note: The field values must be in external format. For transferring the field
values from internal to external format, you can use method /OTX/PF00_CL_
UTILITIES=>STRUCTURE_FIELD_VALUE_CONVERT. For more information, see “/
OTX/PF00_CL_UTILITIES=>STRUCTURE_FIELD_VALUE_CONVERT”
on page 531.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 463

Chapter 9 Fiori Task App

9.8.2.13 GET_DOCUMENTS
This method returns documents that are displayed with the function Documents.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PI_WOBJ_TYPE Importing Work object type.
PI_USE_WEB_VIEWER Importing Web Viewer or Brava! View should be
used.
PI_DEVICE Importing Defines the device on which the Fiori
Task App is running. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_LOGSYS Importing Logical system. This is only populated

if one of the key fields is marked as a
logical system field.
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the object.
PI_ITEM_PERSPECTIVE_ID Importing Item perspective ID.
PET_DOCUMENTS Exporting Document.
PET_RETURN Exporting Error messages.
PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message of
PET_RETURN.
PE_BUS_ERROR_HANDLING Exporting Allows to define the UI behavior in case
a business error occurs (pe_error_type =
1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

Structure of parameter PET_DOCUMENTS:

Field name Description

ARCHIVE_ID Archive ID
ARCDOC_ID Document ID

464 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Field name Description

MAIN_DOC Flag that marks the document as main document
OBJECTTEXT Document type
URI Document URL
DOC_CLASS Document class
LENGTH Document size in bytes
ARCHIVE_TIMESTAMP Archiving time stamp
ICON Icon
HAS_ATTRIBUTES Defines if a document has additional attributes. By
default no additional attributes are displayed.
DELETABLE Defines if a document can be deleted. By default the
Delete button is not visible.

9.8.2.14 GET_DOCUMENT_ATTRIBUTES
This method is called for one document when the user opens the panel for the
attributes.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PI_WOBJ_TYPE Importing Work object type.
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the object.
PI_DEVICE Importing Defines the device on which the Fiori
Task App is running. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_LOGSYS Importing Logical system. This is only populated

if one of the key fields is marked as a
logical system field.
PI_ITEM_PERSPECTIVE_ID Importing Item perspective ID.
PI_ARC_DOC_ID Importing Archive document ID.
PI_ARCHIVE_ID Importing Archive ID
PET_ATTRIBUTES Exporting Attributes that should be displayed.
PET_RETURN Exporting Error messages.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 465

Chapter 9 Fiori Task App

Parameter Type Description

PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message of
PET_RETURN.
PE_BUS_ERROR_HANDLING Exporting Allows to define the UI behavior in case
a business error occurs (pe_error_type =
1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

Structure of parameter PET_ATTRIBUTES:

Field name Description

ATTRIBUTE_NAME Unique ID of the attribute.
LABEL Label
VALUE Attribute value
VALUE_DESC Value description - displayed behind attribute value

9.8.2.15 DELETE_DOCUMENT
This method is called when the deletion of a document is triggered from view view.
item.Document. Parameters PI_ARC_DOC_ID and PI_ARCHIVE_ID define the
document that should be deleted. Deletion must be implemented in this method.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PI_LOGSYS Importing Logical system
PI_WOBJ_TYPE Importing Work object type.
PI_ARC_DOC_ID Importing Archive document ID.
PI_ARCHIVE_ID Importing Archive ID
PI_ITEM_PERSPECTIVE_ID Importing Item perspective ID.
PET_RETURN Exporting Error messages.
PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message of
PET_RETURN.

466 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Parameter Type Description

PE_BUS_ERROR_HANDLING Exporting Allows to define the UI behavior in case
a business error occurs (pe_error_type =
1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

9.8.2.16 CHANGE_ITEM_STRUC
This method changes the item structure for the item list.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PI_WOBJ_TYPE Importing Work object type.
PI_LOGSYS Importing Logical system. This is only populated
if one of the key fields is marked as a
logical system field.
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the object.
PI_ITEM_PERSPECTIVE_ID Importing Item perspective ID.
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PCT_ITEM_STRUCTURE Changing Structure of the item list. Prefilled

according to customizing, can be
changed.
PET_RETURN Exporting Error messages.
PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message of
PET_RETURN.
PE_BUS_ERROR_HANDLING Exporting Allows to define the UI behavior in
case a business error occurs
(pe_error_type = 1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

VIM200405-CGF-EN-02 Configuration Guide for Foundation 467

Chapter 9 Fiori Task App

Structure of parameter PCT_ITEM_STRUCTURE:

Field name Description

COLUMN_ID Column ID.
FIELD_NAME Field name.
MOBILE_PRIO Marks column as priority column for mobile
devices.
TYPE Data type of column.
LENGTH Length of column.
DESCRIPTION Column label.
DECIMALS Number of decimal places.
IS_ICON Display column value as icon.
IS_UNIT Column is unit for value in previous column.
EDITABLE Column is editable.
REQUIRED Values in column must be maintained.
CHECKBOX Field is displayed as a check box.
HELP_ID ID for search help.
HELP_VARIANT Variant how search help is displayed.
REL_FIELDS Related fields for search help.
LINKTYPE Type of the link for semantic object
navigation.
UPDATE_ON_VALUE_CHANGED This field defines the following: At a change
of the value of the field, should method
ON_VALUE_UPDATE_ITEM of the item
handler be called to react on this value
change?

9.8.2.17 ON_VALUE_UPDATE_ITEM
This method is triggered if the value of a line item detail field is changed and the
Update on Change check box in the line item details is selected.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current
work object.
PI_WOBJ_TYPE Importing Work object type.
PI_LOGSYS Importing Logical system. This is only populated
if one of the key fields is marked as a
logical system field.

468 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Parameter Type Description

PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_ITEM_PERSPECTIVE_ID Importing Item perspective ID.

PI_COLUMN_ID Importing Column ID that has been changed.
PI_ITEM_ID Importing ID of the item that has been changed.
PCS_ITEM_VALUES Changing Current values displayed in the Fiori
Task App. Changed values are
displayed.
PET_RETURN Exporting Error messages.
PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will
be raised with the error message in
PET_RETURN.
PE_BUS_ERROR_HANDLING Exporting Allows to define the UI behavior in
case a business error occurs
(pe_error_type = 1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

The parameter PCS_ITEM_VALUES contains the current field values of the item. It has
the following structure.

Field name Description

VALUE 01 - 10 Value displayed in column 01 - 10

9.8.2.18 CHANGE_HEADER_DETAILS
This method changes data for header details.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PI_WOBJ_TYPE Importing Work object type.
PI_LOGSYS Importing Logical system. This is only populated
if one of the key fields is marked as a
logical system field.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 469

Chapter 9 Fiori Task App

Parameter Type Description

PI_DEVICE Importing Defines the device on which the Fiori
Task App is running. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_VIEW_ID Importing Perspective View ID of the Header

Details View
PIS_DISPLAY_ATTRIBUTES Importing Attributes of the work object. Uses
Display structure of work object
type.
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the object.
PI_ITEM_PERSPECTIVE_ID Importing Item perspective ID.
PCT_HEADER_DETAILS Changing Header details. Prefilled with
customized fields.
PET_RETURN Exporting Error messages.
PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message of
PET_RETURN.
PE_BUS_ERROR_HANDLING Exporting Allows to define the UI behavior in case
a business error occurs (pe_error_type =
1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

Structure of parameter PCT_HEADER_DETAILS:

Field name Description

POS Position (1 – 20).
TYPE Data type.
LENGTH Maximum length of the field value.
DESCRIPTION Label.
VALUE Field value.
FIELDNAME Technical field name.
DECIMALS Number of decimal places.

470 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Field name Description

EDITABLE Column is editable.
REQUIRED Values in column must be maintained.
CHECKBOX Field is displayed as a check box.
HELP_ID ID for search help.
HELP_VARIANT Variant how search help is displayed.
REL_FIELDS Related fields for search help.
HAS_VALUE_DESC Display value description.
UPD_ON_VALUE_CHG Update is triggered when this field value changes.
VALUE_DESCRIPTION Description behind field for the current value.
LINKTYPE Type of the link for semantic object navigation.
LINK_PARAMETER JSON with the link parameters for semantic object
navigation.

9.8.2.19 ON_VALUE_UPDATE_HEADER_DETAIL
The update is triggered for fields in header details that were changed and that are
flagged for an update (field UPD_ON_VALUE_CHG).

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PI_WOBJ_TYPE Importing Work object type.
PI_LOGSYS Importing Logical system. This is only populated
if one of the key fields is marked as a
logical system field.
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_ITEM_PERSPECTIVE_ID Importing Item perspective ID.

PI_UPDATED_FIELD Importing Field which has been updated.
PI_VIEW_ID Importing View ID for which the update has to be
performed.
PCT_VALUES Changing The field values when the update was
made. Values and value description
changes are displayed in the UI.
PET_RETURN Exporting Error messages.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 471

Chapter 9 Fiori Task App

Parameter Type Description

PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message in
PET_RETURN.
PE_BUS_ERROR_HANDLING Exporting Allows to define the UI behavior in
case a business error occurs
(pe_error_type = 1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

Parameter PCT_VALUES contains the current field values. It has the following
structure.

Field name Description

FIELDNAME Field name.
VALUE Field value.
VALUE_DESCRIPTION Description text behind field value. The current text is
not imported, it must be changed if the field value is
changed.
UPDATE_REQUIRED Values of the fields VALUE and VALUE_DESCRIPTION
are only set in the Fiori Task App if this flag is marked.

9.8.2.20 GET_ITEM_STRUC
This method returns the structure for the item list.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PI_WOBJ_TYPE Importing Work object type.
PI_LOGSYS Importing Logical system. This is only populated
if one of the key fields is marked as a
logical system field.
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the object.
PI_ITEM_PERSPECTIVE_ID Importing Item perspective ID.

472 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Parameter Type Description

PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PE_ITEM_STRUCTURE Exporting Technical name of the item structure.

PET_RETURN Exporting Error messages.
PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message in
PET_RETURN.
PE_BUS_ERROR_HANDLING Exporting Allows to define the UI behavior in
case a business error occurs
(pe_error_type = 1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

9.8.2.21 GET_ITEM_LINKS
This method allows the definition of the link parameter of single line items in the
context of semantic object navigation. It will be called when the user clicks a link in
one of the line items.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PI_WOBJ_TYPE Importing Work object type.
PI_LOGSYS Importing Logical system. This is only populated
if one of the key fields is marked as a
logical system field.
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_ITEM_ID Importing Item ID.

PI_COLUMN_ID Importing Column for which the link is required.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 473

Chapter 9 Fiori Task App

Parameter Type Description

PET_ITEM_LINK Exporting Link parameter for item.
PET_RETURN Exporting Error messages.
PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message in
PET_RETURN.
PE_BUS_ERROR_HANDLING Exporting Allows to define the UI behavior in
case a business error occurs
(pe_error_type = 1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

Structure of parameter PET_ITEM_LINK:

Field name Description

COLUMN_ID Column ID
LINK_PARAMETER Link Parameter

9.8.2.22 CHANGE_OBJECT
This method offers the possibility to change the object list.

Parameter Type Description

PIS_DISPLAY_ATTRIBUTES Importing Work object data. Uses the structure
Display structure as defined in the
work object type.
PIS_WOBJ_TYPE Importing Work object type customizing.
PI_LOGSYS Importing Logical system. This is only populated
if one of the key fields is marked as a
logical system field.
PI_DEVICE Importing Defines the device on which the Fiori
Task App is running. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to

the object.
PI_ITEM_PERSPECTIVE_ID Importing Item perspective ID.

474 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PCS_OBJECT Changing Work object.
PET_RETURN Exporting Error messages.
PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message in
PET_RETURN.
PE_BUS_ERROR_HANDLING Exporting Allows to define the UI behavior in case
a business error occurs (pe_error_type =
1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

Structure of parameter PCS_OBJECT:

Field name Description

NODE_ID Node ID. This is populated automatically by the
framework.
INTRO Fields as described in “Configuring the data binding for
the master list” on page 393.
TASK_TITLE
TITLE
NUMBER
NUMBERSTATE
NUMBERUNIT
MARKFLAGGED
MARKFAVORITE
ATTRIBUTES0
ATTRIBUTES1
FIRSTSTATUS
SECONDSTATUS
ITEM_PERSPECTIVE_ID Item perspective ID.
HAS_A_BULK_ACTION Object has at least one bulk action.
ICON Icon.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 475

Chapter 9 Fiori Task App

Note: To remove the object from the object list, clear the structure PCS_OBJECT.

9.8.2.23 CHANGE_OBJECT_HEADER
This method offers the possibility to change the object header.

Parameter Type Description

PIS_DISPLAY_ATTRIBUTES Importing Work object data. Uses the structure
Display structure as defined in
the work object type.
PIS_WOBJ_TYPE Importing Work object type customizing.
PI_LOGSYS Importing Logical system. This is only populated
if one of the key fields is marked as a
logical system field.
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the object.
PI_ITEM_PERSPECTIVE_ID Importing Item perspective ID.
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PIT_KEYS Importing Contains key fields of the current

work object.
PCS_OBJECT Changing Object header.
PET_RETURN Exporting Error messages.
PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will
be raised with the error message in
PET_RETURN.
PE_BUS_ERROR_HANDLING Exporting Allows to define the UI behavior in
case a business error occurs
(pe_error_type = 1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

Structure of parameter PCS_OBJECT:

476 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Field name Description

ICON UI5 icon
MARKFAVORITE Show favorite flag
MARKFLAGGED Mark as flagged
TASK_TITLE Task title
TITLE Title
NUMBER Number field
NUMBERUNIT Unit of number
NUMBERSTATE State of number:
• Error
• Warning
• Success
• None

ATTRIBUTES0 Attributes
ATTRIBUTES1 Attributes
INTRO Introduction text
FIRSTSTATUS First status
SECONDSTATUS Second status
LINKTYPE Type of the link for semantic object navigation
LINK_PARAMETER JSON with the link parameters for semantic object
navigation

9.8.2.24 CHANGE_OBJECT_FUNCTIONS
This method is deprecated. The functionality is now part of the perspectives concept.
For more information, see “Editing perspectives and layouts” on page 427.

9.8.2.25 GET_TIMELINES
This method returns history entries and comments.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PI_WOBJ_TYPE Importing Work object type.
PI_LOGSYS Importing Logical system. This is only populated
if one of the key fields is marked as a
logical system field.
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the object.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 477

Chapter 9 Fiori Task App

Parameter Type Description

PI_ITEM_PERSPECTIVE_ID Importing Item perspective ID.
PI_DEVICE Importing Defines the device on which the Fiori
Task App is running. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_SKIP Importing Number of entries that have to be

skipped
PI_MAX_HITS Importing Maximum number of entries that
should be returned
PI_MODE Importing Selection mode:
• COUNT - Only count entries, return
no data
• DATA - Only return data
PET_TIMELINES Exporting Timeline entries
PET_RETURN Exporting Error messages
PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message in
PET_RETURN.
PE_BUS_ERROR_HANDLING Exporting Allows to define the UI behavior in
case a business error occurs
(pe_error_type = 1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item
PE_ENTRIES Exporting Number of entries.
If PI_MODE = COUNT, only
PE_ENTRIES needs to be set.
PET_TIMELINES can be empty.
If PI_MODE = DATA, PE_ENTRIES can
stay empty. Only PET_TIMELINES
needs to be set.

Structure of parameter PET_TIMELINES:

Field name Description

HIST_KEY Key of history entry.
CMNT_KEY Key of comment.

478 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Field name Description

ACTIONICON Icon symbolizing the action of this entry.
USERNAME User name.
USERID User ID.
USERDETAILSAVAILABLE User details are available.
ACTIONTITLE Text for the action.
TIMESTAMP Time stamp.
COMMENT Comment text.
STEP Step description.
MSG_AVAILABLE Further messages are available.

9.8.2.26 GET_EXCEPTIONS
This method returns error messages that are displayed as detail for an object header
field.

This method is deprecated. Future implementations should only implement CHECK_

SAVE_DATA and return the exceptions in the implementation of this method. For
more information, see “CHECK_SAVE_DATA” on page 493.

Existing implementations use CHECK_SAVE_DATA to check and save the data, but
return the exceptions via method GET_EXCEPTIONS. This is still working due to
downward compatibility.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PI_WOBJ_TYPE Importing Work object type.
PI_LOGSYS Importing Logical system. This is only populated
if one of the key fields is marked as a
logical system field.
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the item.
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PET_EXCEPTIONS Exporting Exceptions.

PET_RETURN Exporting Error messages.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 479

Chapter 9 Fiori Task App

Parameter Type Description

PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message in
PET_RETURN.
PE_BUS_ERROR_HANDLING Exporting Allows to define the UI behavior in
case a business error occurs
(pe_error_type = 1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

Structure of parameter PET_EXCEPTIONS:

Field name Description

EXCEPTION_ID Exception ID
TYPE Exception type. Values:
• S - Success
• I - Information
• W - Warning
• E - Error

COUNTER Message counter

EXCEPTION_DESC Short description
MESSAGE Message text

9.8.2.27 CHANGE_ITEM_LIST_TITLE
This method changes the title of the item list.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PI_WOBJ_TYPE Importing Work object type.
PI_LOGSYS Importing Logical system. This is only populated if
one of the key fields is marked as a
logical system field.
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the item.
PI_ITEM_PERSPECTIVE_ID Importing Item perspective ID.

480 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Parameter Type Description

PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PC_ITEM_LIST_TITLE Changing Item list title.

PET_RETURN Exporting Error messages.
PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message in
PET_RETURN.
PE_BUS_ERROR_HANDLING Exporting Allows to define the UI behavior in case
a business error occurs (pe_error_type =
1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

9.8.2.28 CHANGE_RELATED_BUS_OBJECT
This method allows you to change the customizing for the related business object at
runtime. For more information, see “Defining a related business object for a work
object type” on page 377.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work
object.
PET_RETURN Exporting Error messages.
PE_ERROR_TYPE Exporting Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message in
PET_RETURN.
PE_BUS_ERROR_HANDLING Exporting Allows to define the UI behavior in case
a business error occurs (pe_error_type =
1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

VIM200405-CGF-EN-02 Configuration Guide for Foundation 481

Chapter 9 Fiori Task App

Parameter Type Description

PCS_RELATED_BUS_OBJECT Changing Related business object.

Structure of parameter PCS_RELATED_BUS_OBJECT:

Field name Description

OBJTYPE Object type
OBJID Object ID

9.8.2.29 CHANGE_NODELIST_NAV_LINK
This method allows to change the navigation links in the node list at runtime. The
method is called before the link is executed.

Parameter Type Description

PI_NODE_ID Importing Node ID
PIS_WOBJ_TYPE Importing Work object type
PIT_KEYS Importing Work object key values
PI_LOGSYS Importing Logical system
PI_COLUMN_ID Importing Column ID
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PET_RETURN Exporting Messages for exceptions

PE_ERROR_TYPE Exporting Exception type
PE_BUS_ERROR_HANDLING Exporting Error handling
PC_NAV_PARAMETER Changing Navigation parameter
PC_TRANSPORT_REQMNT Changing Transport type:
• No transport required
(default)
• Customizing request
• Workbench request

482 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

9.8.2.30 RESOLVE_URL_PARAMS
This method is called when:

• the Fiori Task App is called with parameter resolveParamsAtBackend=true

or
• the URL contains at least one parameter that is unknown to the Fiori Task App.

The PIT_URL_PARAMETERS parameter contains all parameters of the URL.

This method is able to calculate the key values for the work object type with these
values and returns them in the PRT_KEYS parameter. All key values must be set.

When implemented, the Fiori Task App only selects this work object.

Parameter Type Description

PI_DEVICE Importing Device type
PI_NODE_ID Importing Node ID
PIT_URL_PARAMETERS Importing Parameters (includes all unresolved
parameters).
PRT_KEYS Returning Key information for web ID calculation
(all key fields of work object type must
be set)

9.8.2.31 GET_IMAGE_CTRL_PAGES
This method returns the images and thumbnails for each page of the document that
should be displayed in the Image Control.

Parameter Type Description

PIT_KEYS Importing Contains key fields of the
current work object.
PI_WOBJ_TYPE Importing Work object type
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change
made to the object.
PI_LOGSYS Importing Logical system. This is only
populated if one of the key
fields is marked as a logical
system field.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 483

Chapter 9 Fiori Task App

Parameter Type Description

PI_DEVICE Importing Defines the device on which
the Fiori Task App is
running. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI
PI_ARCHIVE_ID Importing Archive ID
PI_ARC_DOC_ID Importing Document ID
PI_ITEM_PERSPECTIVE_ID Importing Item perspective ID.
PET_PAGES Exporting Pages for ImageControl.
PET_RETURN Exporting Error messages.
PE_ERROR_TYPE Exporting Error type.

Available types are:

1 - Business error

2 - Technical error

In case of an error, an
exception is raised with the
error message of PET_
RETURN.
PE_BUS_ERROR_HANDLIN Exporting Allows to define the UI
G behavior in case a business
error occurs (pe_error_
type = 1).

Possible values:
• 1 - No update
• 2 - Complete refresh
• 3 - Item refresh
• 4 - Remove item

Line structure of parameter PET_PAGES:

Field name Description

PAGE_NUMBER Page number
PAGE_IMAGE Main image of page (byte format)
PAGE_THUMBNAIL Image of page used for thumbnail ( byte format)
CTYPE_IMAGE Content type/mime type of image

484 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Field name Description

CTYPE_THUMBNAIL Content type/mime type of thumbnail

9.8.2.32 GET_IMAGE_CTRL_FULLTEXT

Parameter Type Description

PIT_KEYS Importing Contains key fields of the current work object.
PI_WOBJ_TYPE Importing Work object type
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to the object.
PI_LOGSYS Importing Logical system. This is only populated if one of the key
PI_DEVICE Importing Defines the device on which the Fiori Task App is runni
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PI_ARCHIVE_ID Importing Archive ID

PI_ARC_DOC_ID Importing Document ID
PI_ITEM_PERSPECTIVE_ID Importing Item perspective ID.
PET_FULLTEXT Exporting Pages for ImageControl
PET_RETURN Exporting Error messages.
PE_ERROR_TYPE Exporting Error type.

Available types are:

1 - Business error

2 - Technical error

In case of an error, an exception will be raised with the e

PE_BUS_ERROR_HANDLING Exporting Allows to define the UI behavior in case a business erro

Possible values:

1 - No update

2 - Complete refresh

3 - Item refresh

4 - Remove item

Line structure of parameter PET_PAGES:

VIM200405-CGF-EN-02 Configuration Guide for Foundation 485

Chapter 9 Fiori Task App

Field name Description

PAGE_NUMBER Page number
PAGE_FULLTEXT Full text used by ImageControl

9.8.3 Interface /OTX/PF62_IF_PERSPECTIVE_CLASS

In general, this implementation allows the change of data in views of the perspective
at runtime. OpenText recommends that you derive the class from /OTX/PF62_CL_
PERSPECTIVE_CLASS. In this interface, the management of instances is already
implemented.

This section comprises the methods of the /OTX/PF62_CL_PERSPECTIVE_CLASS

interfaces.

Table 9-2: Attributes of /OTX/PF62_IF_PERSPECTIVE_CLASS

Attribute Description
M_PLTT Perspective life time token for the current
perspective
MH_PLTT_DATA_COLL Data collection of the perspective life time
token. For more information, see
“Maintaining Data Collections” on page 377.
MH_PERSPECTIVE_INFO Access to general information about the
perspective.

9.8.3.1 SET_ROOT_OBJECT_KEYS
This method is called at the creation of the perspective class instance and gives the
instance key information about the root object of the perspective. This method is
implemented in class /OTX/PF62_CL_PERSPECTIVE_CLASS and does not need to be
changed.

Parameter Type Description

PIT_ROOT_KEYS Importing Keys of root work object
PI_ROOT_LOGSYS Importing Logical system of the root work
object
PI_ROOT_CHANGED_AT Importing Last changed time stamp of the
root work object
PIH_ROOT_WOBJ_TYPE Importing Work object type of the root work
object

486 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

9.8.3.2 GET_INSTANCE (static method)

This method returns the class instance.

Parameter Type Description

PI_CLASSNAME Importing Name of perspective class
PIH_ROOT_WOBJ_TYPE Importing Work object type
PIT_ROOT_WOBJ_KEYS Importing Keys
PI_ROOT_WOBJ_LOGSYS Importing Logical system
PI_ROOT_WOBJ_CHANGED_AT Importing Last changed timestamp
PI_PLTT Importing Perspective Life Time Token
PRH_INSTANCE Returning Instance of perspective class

9.8.3.3 CHANGE_CUSTOMIZING
This method allows changing the customizing settings for the attribute list views
and table views of the current perspective at runtime.

Parameter Type Description

PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PIT_ATTRIBUTE_LIST_CUST Importing Customizing instances for the

attribute list views
PIT_TABLES_CUSTOMIZING Importing Customizing instances for the table
views
PI_LOCKED Importing Flag to indicate that the object is
locked
PI_LOCKED_BY Importing SAP User name of the user who
locked the object
PI_LOCKED_CHECK_VALUE Importing Contains lock check value
provided by class /OTX/PF00_
CL_LOCK in case of existing lock by
current user.
PIT_COMMENT_VIEW_CUST Importing Customizes the comment view
which is based on the standard
SAP feed list item (sap.m.
FeedListItem). The setting
defines the languages for
translation.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 487

Chapter 9 Fiori Task App

Line structure of PIT_ATTRIBUTE_LIST_CUST:

Field name Description

ROOT_WOBJ_TYPE Work object type of perspective
WOBJ_TYPE Work object type of current attribute list view
PERSPECTIVE_ID Perspective ID
VIEW_ID View ID
KEYS Keys of displayed object
LOGSYS Logical system
CHANGED_AT Last changed timestamp of displayed object
ATTRIBUTE_LIST_CUSTOMIZING Instance of class /OTX/
PF62_CL_FC_AT_CUST_CHG. The following
methods allow changes to the customizing:
SET_SETTINGS
SET_RELATED_FIELDS
SET_ATTRIBUTES_CUST
LOCKED Marked if item is locked
LOCKED_BY User who locks the item

Line structure of PIT_TABLES_CUSTOMIZING:

Field name Description

WOBJ_TYPE Work object type of current table view
DEVICE Device type
ITEM_PERSPECTIVE_ID Perspective ID
VIEW_ID View ID
KEYS Keys of object for which associated items are
displayed
LOGSYS Logical system
CHANGED_AT Last changed timestamp of root object
TABLE_CUSTOMIZING Instance of class /OTX/
PF62_CL_FC_LI_CST_CHNG. The following
methods allow changes to the customizing:
SET_HEADER_SETTING
SET_COLUMN_SETTING
SET_DEFAULT_ACTIONS
SET_CUSTOM_ACTIONS

Line structure of PIT_COMMENT_VIEW_CUST:

488 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Field name Description

WOBJ_TYPE Work object type of current table view
PERSPECTIVE_ID Perspective ID
VIEW_ID View ID
KEYS Keys of object for which associated items are
displayed
LOGSYS Logical system
COMMENT_SETTING_CHG Use method SET_SETTINGS to change languages
for translation

9.8.3.4 CHANGE_DATA
This method allows changing the data of the attribute list views and table views of
the current perspective at runtime.

Parameter Type Description

PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PIT_CHANGE_ATTRIBUTE_LIST Importing Data instances for the attribute list

views
PIT_CHANGE_TABLES Importing Data instances for the table views
PI_LOCKED Importing Flag to indicate that the object is
locked
PI_LOCKED_BY Importing SAP User name of the user who
locked the object
PI_LOCKED_CHECK_VALUE Importing Contains lock check value
provided by class /OTX/PF00_
CL_LOCK in case of existing lock by
current user.
PIT_PROPERTY_BINDING Importing Data instances for control
properties with binding.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 489

Chapter 9 Fiori Task App

Parameter Type Description

PIT_CHANGE_COMMENTS Importing Comment views.

Use the /OTX/PF62_IF_FC_CMT_

CHG~SET_COMMENTS method of
COMMENT_CHG (/OTX/PF62_CL_
FC_CMT_CHG) class to set the
comments that should be
displayed. For details, see “Line
structure of the PIT_COMMENTS
parameter of the /OTX/
PF62_IF_FC_CMT_CHG~SET_CO
MMENTS methods:”.

Line structure of PIT_CHANGE_ATTRIBUTE_LIST:

Field name Description

WOBJ Displayed object
WOBJ_TYPE Work object type of current attribute list view
PERSPECTIVE_ID Perspective ID
VIEW_ID View ID
KEYS Keys of displayed object
LOGSYS Logical system
ATTRIBUTE_LIST Instance of class /OTX/
PF62_CL_FC_ATTRLST_CHG. The following
methods allow changes to the data:
SET_SETTINGS
SET_RELATED_FIELDS
SET_ATTRIBUTES
IS_LOCKED Indicator if item is locked
LOCKED_BY User who locks the item

Line structure of PIT_CHANGE_TABLES:

Field name Description

WOBJ_TYPE Work object type of current table view
PERSPECTIVE_ID Perspective ID
VIEW_ID View ID
KEYS Keys of object for which associated items are
displayed
LOGSYS Logical system
ASSOCIATED_WOBJ_TYPE Work object type of items

490 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Field name Description

TABLE Instance of class /OTX/
PF62_CL_FC_LI_CHANGE. The following
methods allow changes to the displayed items:
ADD_ROW
DELETE_ROW
SET_ROW_POSITIONS

Line structure of PIT_PROPERTY_BINDING:

Field name Description

CONTROL_ID ID of the control in the perspective
PROPERTY Property of the control that is bound
BINDING Instance of /OTX/PF62_CL_FC_PROP_BIND_
SET class. It has the method SET_VALUE to set a
new value. You can read the original bound
value and other information via GET methods.

Line structure of the PIT_COMMENTS parameter of the /OTX/PF62_IF_FC_CMT_

CHG~SET_COMMENTS methods:

Field name Description

COMMENT_ID ID of comment. The ID is used as key, and thus,
must be unique
SENDER Sender information
ICON Icon displayed in front of comment. If empty, the
initials are displayed
USERID Technical user ID. The ID us used for pop-ups
with user details
INITIALS Initials are displayed if no icon is maintained
INFO Info text. The text is displayed below comments
TIMESTAMP Timestamp. The timestamp is displayed below
comments.
TEXT Comment.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 491

Chapter 9 Fiori Task App

9.8.3.5 TRANSLATE_COMMENTS
This method is called when the user selects a language in the drop-down list of the
translation languages. The implementation of this methods returns the translations
of the comments.

Interface:

Parameter Type Description

PI_DEVICE Importing Device type
PIH_WOBJ_TYPE Importing Workobject type
PIT_KEYS Importing Key values
PI_LOGSYS Importing Logical system
PI_PERSPECTIVE_ID Importing Current perspective
PI_VIEW_ID Importing Comment View Id
PI_TARGET_LANGUAGE Importing Requested language
PIH_TRANSLATION_CHG Importing /OTX/PF62_CL_FC_CMT_
TRANS_CHG class, contains
the displayed comments.
Translations must be set in
this class.

Methods of PIH_TRANSLATION_CHG parameter(/OTX/PF62_CL_FC_CMT_TRANS_CHG

class ):

Method Description
/OTX/PF62_IF_FC_CMT_CUST_ Get settings of comment view
GET~GET_SETTINGS
/OTX/PF62_IF_FC_CMT_GET~GET_ Get currently displayed comments
COMMENTS
/OTX/PF62_IF_FC_CMT_TRANS_ Get currently displayed translations
GET~GET_TRANSLATIONS
/OTX/PF62_IF_FC_CMT_TRANS_ Add additional translations
CHG~ADD_TRANSLATIONS

/OTX/PF62_IF_FC_CMT_TRANS_CHG~ADD_TRANSLATIONS method has the following

importing parameters:

• PI_LANGUAGE_KEY to define the language of the translations

• PIT_TRANSLATIONS for the translation texts

The structure of PIT_TRANSLATIONS has following fields:

492 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Field name Description

COMMENT_ID Has to be the same as the one of the related
comment
TRANSLATED_INFO Translation of the info text
TRANSLATED_TEXT Translation of the comment text
COMMENT Comment information. Must only be set when
the translation is for a comment that has not been
displayed yet

9.8.3.6 CHECK_SAVE_DATA
This method allows setting field messages of the attribute list views and table views
of the current perspective. It is called when checking or saving the changed data is
required.

Parameter Type Description

PI_CHECK_ONLY Importing Only check is required.
PI_DEVICE Importing Device type. Possible
values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PIT_CHECK_SAVE_ATTRIBUTE_LISTS Importing Attribute lists

PIT_CHECK_SAVE_TABLE Importing Tables
PI_TRANSPORT_REQUEST Importing Transport Request Number
PET_EXCEPTIONS Exporting Exceptions
PES_SAVE_RESULT Exporting Save result
PI_LOCKED Importing Flag to indicate that the
object is locked
PI_LOCKED_BY Importing SAP User name of the user
who locked the object
PI_ACTION_ID Importing Action that triggers the
check or save. It is set only
when an action is triggered
by a user.

Line structure of PIT_CHECK_SAVE_ATTRIBUTE_LISTS:

Field name Description

WOBJ_TYPE Work object type of current attribute list view

VIM200405-CGF-EN-02 Configuration Guide for Foundation 493

Chapter 9 Fiori Task App

Field name Description

PERSPECTIVE_ID Perspective ID
VIEW_ID View ID
KEYS Keys of displayed object
LOGSYS Logical system
ATTRIBUTE_LIST Instance of class /OTX/
PF62_CL_FC_ATTRLST_CHS. The following
methods allow setting messages:
SET_FIELD_MESSAGES
ADD_FIELD_MESSAGE
ASSOCIATED_WOBJ_TYPE Associated work object type
WOBJ Instance of work object

Line structure of PIT_CHECK_SAVE_TABLE:

Field name Description

WOBJ_TYPE Work object type of current table view
PERSPECTIVE_ID Perspective ID
VIEW_ID View ID
KEYS Keys of object for which associated items are
displayed
LOGSYS Logical system
TABLE Instance of class /OTX/
PF62_CL_FC_LI_CHANGE. You can access the
items displayed in the table using the following
methods:
• GET_ITEMS_WITH_POSITIONS
• GET_ADDED_ITEMS
• GET_CHANGED_ITEMS
• GET_DELETED_ITEMS
These items have the
methods SET_FIELD_MESSAGES and
ADD_SINGLE_FIELD_MESSAGE, which allow
the setting of messages for fields of these items.
ASSOCIATED_WOBJ_TYPE Work object type of items

Structure of parameter PET_EXCEPTIONS:

Field name Description

EXCEPTION_ID Exception ID

494 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Field name Description

TYPE Exception type. Values:
• S - Success
• I - Information
• W - Warning
• E - Error

COUNTER Message counter

EXCEPTION_DESC Short description
MESSAGE Message text

Structure of PES_SAVE_RESULT:

Field name Description

MSG Message text
STATUS SUCCESS: Update successful
ERROR: Update error

9.8.3.7 CHANGE_PERSPECTIVE_VIEWS
This method changes the views of an item perspective at the initial load of the
perspective.

Parameter Type Description

PIT_VIEWS Importing Views of the perspective
PI_DEVICE Importing Device type
PIH_WOBJ_TYPE Importing Work Object Type
PIT_KEYS Importing Keys of the root object
PI_LOGSYS Importing Logical system
PI_PERSPECTIVE_ID Importing Perspective Id

Structure of PIT_VIEWS:

Field name Description

VIEW_ID View ID
VIEW_NAME Technical view name as displayed in the
perspective editor
VIEW View object. You change the view name and
technical details of the view via /OTX/PF62_IF_
PERS_VIEW_CHG~SET_VIEW method

VIM200405-CGF-EN-02 Configuration Guide for Foundation 495

Chapter 9 Fiori Task App

9.8.3.8 UPDATE_ROW_VALUES
This method allows changing data of a line item after change of a line item cell.

Parameter Type Description

PI_DEVICE Importing Device type. Possible
values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PIH_WOBJ_TYPE Importing Work object type

PIT_KEYS Importing Keys
PI_LOGSYS Importing Logical system
PI_PERSPECTIVE_ID Importing Perspective ID
PI_VIEW_ID Importing View ID
PIH_UPDATE_ITEM Importing Updated line item.
Instance of /OTX/
PF62_CL_FC_LI_LINO
BJ_UPD. Method
SET_CELL_VALUES
allows changing the
cell values.
PIH_ASSOCIATED_WOBJ_TYPE Importing Associated work object
type

496 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Parameter Type Description

PIH_GET_VIEWS Importing The parameter PIH_
GET_VIEWS is of
type /OTX/PF62_CL_
GET_VIEWS. This
class has the following
methods which return
all attribute lists /
advanced line item
tables of a perspective:
• GET_ATTRIBUTE_
LISTS
Returns all
attribute lists of a
perspective.
• GET_ATTRIBUTE_
LIST_BY_NAME
The method
returns the
attribute list (/
OTX/PF62_CL_
FC_ATTRLST_
GET) of a view.
• GET_ADV_LINE_
ITEM_TABLES
Returns all tables of
a perspective
• GET_TABLE_BY_
NAME
The method
returns the
advanced line item
table (/OTX/PF62_
CL_FC_LI_GET) of
a view

Tip: Due to
performance
reasons, use the
GET_
ATTRIBUTE_
LIST_BY_NAME
and GET_
TABLE_BY_
NAME methods
whenever
possible.
PI_LOCKED Importing Flag to indicate that
the object is locked

VIM200405-CGF-EN-02 Configuration Guide for Foundation 497

Chapter 9 Fiori Task App

Parameter Type Description

PI_LOCKED_BY Importing SAP User name of the
user who locked the
object
PIS_PREV_CELL_VALUE Importing Contains the values of
the cell that triggered
an update, before it
was changed by the
user

9.8.3.9 UPDATE_ATTRIBUTES
This method allows updating the attribute values after a value change of an
attribute.

Parameter Type Description

PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PIH_WOBJ_TYPE Importing Work object type

PIT_KEYS Importing Keys
PI_LOGSYS Importing Logical system
PI_PERSPECTIVE_ID Importing Perspective ID
PI_VIEW_ID Importing View ID
PIH_ATTRIBUTE_LIST_UPD Importing Instance of /OTX/
PF62_CL_FC_ATTRLST_UPD.
Method SET_ATTRIBUTES allows
changing the attribute values.
PI_UPDATED_ATTRIBUTE Importing Name of updated attribute that
triggered the update.

498 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Parameter Type Description

PIH_GET_VIEWS Importing The parameter PIH_GET_VIEWS is
of type /OTX/PF62_CL_GET_
VIEWS. This class has the
following methods which return all
attribute lists /advanced line item
tables of a perspective:
• GET_ATTRIBUTE_LISTS
Returns all attribute lists of a
perspective.
• GET_ATTRIBUTE_LIST_BY_
NAME
The method returns the
attribute list (/OTX/PF62_CL_
FC_ATTRLST_GET) of a view.
• GET_ADV_LINE_ITEM_
TABLES
Returns all tables of a
perspective
• GET_TABLE_BY_NAME
The method returns the
advanced line item table (/
OTX/PF62_CL_FC_LI_GET) of
a view

Tip: Due to performance

reasons, use the GET_
ATTRIBUTE_LIST_BY_
NAME and GET_TABLE_BY_
NAME methods whenever
possible.
PI_LOCKED Importing Flag to indicate that the object is
locked
PI_LOCKED_BY Importing SAP User name of the user who
locked the object
PIS_PREV_CELL_VALUE Importing Contains the values of the cell that
triggered an update, before it was
changed by the user

VIM200405-CGF-EN-02 Configuration Guide for Foundation 499

Chapter 9 Fiori Task App

9.8.3.10 CHANGE_ACTION_PARAMETER
This method allows changing the parameter of a table action before the action is
performed.

Parameter Type Description

PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PIH_WOBJ_TYPE Importing Work object type

PIT_KEYS Importing Keys
PI_LOGSYS Importing Logical system
PI_PERSPECTIVE_ID Importing Perspective ID
PI_VIEW_ID Importing View ID
PIH_ITEM Importing Line item for which the action is
performed.
PIH_TABLE Importing Table
PI_ACTION_ID Importing Action ID
PC_PARAMETER Changing Parameter

500 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Parameter Type Description

PIH_GET_VIEWS Importing The parameter PIH_GET_VIEWS is
of type /OTX/PF62_CL_GET_
VIEWS. This class has the
following methods which return all
attribute lists /advanced line item
tables of a perspective:
• GET_ATTRIBUTE_LISTS
Returns all attribute lists of a
perspective.
• GET_ATTRIBUTE_LIST_BY_
NAME
The method returns the
attribute list (/OTX/PF62_CL_
FC_ATTRLST_GET) of a view.
• GET_ADV_LINE_ITEM_
TABLES
Returns all tables of a
perspective
• GET_TABLE_BY_NAME
The method returns the
advanced line item table (/
OTX/PF62_CL_FC_LI_GET) of
a view

Tip: Due to performance

reasons, use the GET_
ATTRIBUTE_LIST_BY_
NAME and GET_TABLE_BY_
NAME methods whenever
possible.
PI_LOCKED Importing Flag to indicate that the object is
locked
PI_LOCKED_BY Importing SAP User name of the user who
locked the object

9.8.3.11 UPDATE_AFTER_REL_ATTR_LIST_CHG
This method is called after the change of a value in a related attribute list. The
method allows changing data in attribute lists and table views that have a relation to
the changed attribute list.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 501

Chapter 9 Fiori Task App

Parameter Type Description

PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PIS_UPDATED_ATTRIBUTE_LIST Importing Updated Attribute List

PIT_UPDATE_ATTRIBUTE_LIST Importing Related attribute lists that can be
updated
PIT_UPDATE_TABLES Importing Related table that can be updated
PI_LOCKED Importing Flag to indicate that the object is
locked
PI_LOCKED_BY Importing SAP User name of the user who
locked the object

Structure of PIS_UPDATED_ATTRIBUTE_LIST:

Field name Description

WOBJ_TYPE Work object type
WOBJ Work object
PERSPECTIVE_ID Perspective ID
VIEW_ID View ID
KEYS Keys
LOGSYS Logical system
ATTRIBUTE_LIST Attribute list instance of class /OTX/
PF62_CL_FC_ATTRLST_GET
UPDATED_ATTRIBUTE Updated attribute
PREVIOUS_ATTRIBUTE_VALUES Contains the values of the attribute that triggered
the update, before it was changed by the user

Structure of PIT_UPDATE_ATTRIBUTE_LIST:

Field name Description

WOBJ_TYPE Work object type
WOBJ Work object
PERSPECTIVE_ID Perspective ID
VIEW_ID View ID
KEYS Keys
LOGSYS Logical system

502 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Field name Description

ATTRIBUTE_LIST Attribute list instance of class /OTX/
PF62_CL_FC_ATTRLST_UPD. Method
SET_ATTRIBUTES allows changing the attribute
list values.

Structure of PIT_UPDATE_TABLES:

Field name Description

WOBJ_TYPE Work object type
PERSPECTIVE_ID Perspective ID
VIEW_ID View ID
TABLE Table that can be updated. Instance of class /OTX/
PF62_CL_FC_LI_UPDATE. The following
methods allow changing the data of the table:
ADD_ROW
DELETE_ROW
SET_ROW_POSITIONS
ASSOCIATED_WOBJ_TYPE Associated work object type

9.8.3.12 UPDATE_NEW_ROW
This method allows to read the data of an item that has been added to an advanced
line item table by a user. With method SET_CELL_VALUES of parameter PIH_NEW_
ITEM, the values of this object can be changed.

Parameter Type Description

PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PIH_WOBJ_TYPE Importing Work object type

PIT_KEYS Importing Work object key values
PI_LOGSYS Importing Logical system
PI_PERSPECTIVE_ID Importing Perspective ID
PI_VIEW_ID Importing View ID
PIH_NEW_ITEM Importing New object
PIH_ASSOCIATED_WOBJ_TYPE Importing Instance of associated work object
type

VIM200405-CGF-EN-02 Configuration Guide for Foundation 503

Chapter 9 Fiori Task App

Parameter Type Description

PIH_GET_VIEWS Importing The parameter PIH_GET_VIEWS is
of type /OTX/PF62_CL_GET_
VIEWS. This class has the
following methods which return all
attribute lists /advanced line item
tables of a perspective:
• GET_ATTRIBUTE_LISTS
Returns all attribute lists of a
perspective.
• GET_ATTRIBUTE_LIST_BY_
NAME
The method returns the
attribute list (/OTX/PF62_CL_
FC_ATTRLST_GET) of a view.
• GET_ADV_LINE_ITEM_
TABLES
Returns all tables of a
perspective
• GET_TABLE_BY_NAME
The method returns the
advanced line item table (/
OTX/PF62_CL_FC_LI_GET) of
a view

Tip: Due to performance

reasons, use the GET_
ATTRIBUTE_LIST_BY_
NAME and GET_TABLE_BY_
NAME methods whenever
possible.
PI_LOCKED Importing Flag to indicate that the object is
locked
PI_LOCKED_BY Importing SAP User name of the user who
locked the object

9.8.3.13 CHANGE_VIEWS_FOR_REFRESH
This method defines the views that are refreshed during run time.

Parameter Type Description

PI__ACTION_ID Importing Action ID
PCT_VIEWS Changing View IDs. Contains only the view
ID of the currently used item
perspective.

504 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Parameter Type Description

PI_LOCKED Importing Flag to indicate that the object is
locked
PI_LOCKED_BY Importing SAP User name of the user who
locked the object

9.8.3.14 GET_PREPARED_DATA
This method is called before the data of the current item perspective is loaded. The
implementation can provide a data collection prepared with class /OTX/PF62_CL_
UTILITIES method /OTX/PF62_IF_PREP_ITM_PERS_DAT~PREPARE_ITEM_PERS_DATA
with return parameter PR_DATA_COLLECTION_ID. In this case only data from this
data collection will be used and no data will be calculated at runtime.

Parameter Type Description

PIT_KEYS Importing Values for a key
PI_LOGSYS Importing Logical system
PI_PERSPECTIVE_ID Importing Perspective ID
PIH_WOBJ_TYPE Importing Work object
PI_IS_LOCKED Importing Flag to indicate that the object is
locked
PI_LOCKED_BY Importing SAP User name of the user who
locked the object
PR_DATA_COLLECTION_ID Returning Data Collection ID

9.8.3.15 CHANGE_PREPARED_DATA
This method allows doing minor changes to the prepared data at runtime.

Parameter Type Description

PIT_KEYS Importing Values for a key
PI_LOGSYS Importing Logical system
PI_PERSPECTIVE_ID Importing Perspective ID
PIH_WOBJ_TYPE Importing Work object
PI_IS_LOCKED Importing Flag to indicate that the object is
locked
PI_LOCKED_BY Importing SAP User name of the user who
locked the object

VIM200405-CGF-EN-02 Configuration Guide for Foundation 505

Chapter 9 Fiori Task App

Parameter Type Description

PIH_CHANGE_DATA Importing Provides methods to access and
change the prepared data.
Available methods:
• GET_ACTIONS
Returns prepared object actions
• REMOVE_ACTIONS
Can be used to remove
prepared actions

9.8.3.16 GET_DOCUMENT_ATTRIBUTES
This method can be used to define additional attributes for documents displayed in
the attachment list.

Parameter Type Description

PI_ARC_DOC_ID Importing Archive Document ID
PI_ARCHIVE_ID Importing Archive ID
PI_DEVICE Importing Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI

PET_ATTRIBUTES Exporting Additional attributes that should

be displayed

9.8.3.17 DELETE_DOCUMENT
This method is called when a user clicks the Delete button for a document in the
attachment list.

Parameter Type Description

PIT_KEYS Importing Values for a key
PI_LOGSYS Importing Logical system
PIH_WOBJ_TYPE Importing Work object type
PI_ARC_DOC_ID Importing Archive Document ID
PI_ARCHIVE_ID Importing Archive ID

506 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

9.8.4 BAdI /OTX/PF62_SERVICE_HANDLER

This BAdI provides the feature to change content that does not depend on a work
object type. It implements the /OTX/PF62_IF_BAPI_SERV_HANDLER interface, which
provides the following methods:

9.8.4.1 CHANGE_USER_DETAILS
This method provides the feature to change information for users. This function is
called for the user details in the history view.

Parameter Type Description

PI_USER_ID Importing User ID.
PCS_USER_DETAILS Changing User details.
PCT_RETURN Changing Error messages.
PC_ERROR_TYPE Changing Error type. Available types are:
1 - Business error
2 - Technical error
In case of an error, an exception will be
raised with the error message in
PCT_RETURN.
PE_BUS_ERROR_HANDLING Changing Allows to define the UI behavior in
case a business error occurs
(pe_error_type = 1). Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item

Structure of parameter PCS_USER_DETAILS:

Field name Description

USERID User ID
USERNAME User name
ATTRIBUTE1 User attributes
ATTRIBUTE2
ATTRIBUTE3
PHONE Phone number
EMAIL Email address
PICTURE_URL URL for user photo

VIM200405-CGF-EN-02 Configuration Guide for Foundation 507

Chapter 9 Fiori Task App

9.8.4.2 CHANGE_PERSPECTIVES
This method is deprecated. The interface still exists but the method is not called any
longer.

9.8.4.3 CHANGE_PERSPECTIVE_VIEWS
This method is deprecated. The interface still exists but the method is not called any
longer.

9.8.5 BAdI /OTX/PF62_BADI_INPUT_HELP

The /OTX/PF62_BADI_INPUT_HELP BAdI implements the /OTX/PF62_IF_BAPI_HELP
interface. The following interface methods are available:

“CHANGE_HELP_COLUMNS” on page 508

“CHANGE_HELP_ROWS” on page 509

“CHANGE_FILTER_OPTIONS” on page 510

9.8.5.1 CHANGE_HELP_COLUMNS
The VIM Foundation calculates the input help structure and then calls this method.
You can change the structure of the input help or define a new structure as an input
help type Only user exit (BAdI /OTX/PF62_BADI_INPUT_HELP. You must also
consider these changes in the implementation of the CHANGE_HELP_ROWS method.

Parameter Type Description

PI_HELP_ID Importing ID for search help
PI_MASTER_FIELDNAME Importing Field name for which this input
help is called
PIH_DATA_COLLECTION_ACTION_D Importing DataCollection of ActionDialog the
LG search help is called from
PIH_DATA_COLLECTION_ITEM Importing DataCollection of item perspective
the search help is called from
PIH_ITEM_PERSPECTIVE_INFO Importing Additional information about
current item perspective
PIH_WOBJ Importing Work object instance which
contains the field the search help
has been called for
PIS_ADD_HELP_INFO Importing Additional information about view
and field the search help is called
from
PCT_HELP_COLUMNS Changing Definition for columns of search
help

508 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Parameter Type Description

PCT_RETURN Changing Return parameter table (error
messages)
PC_ERROR_TYPE Changing Error type

Structure of PCT_HELP_COLUMNS:

Field name Description

COLUMN_ID Column ID for items.
COLUMN_TITLE Long field label.
TYPE ABAP data type.
LENGTH Field length.
FIELDNAME Contains the technical name of the search help field.
IN_SEARCH_MASK Include in the search mask.
IN_RESULT Include the column in the result list.
IS_MASTER_COLUMN Column is used as master column. The value is returned
to the field for which the F4 help is called.
IS_DESCRIPTION Column is a description field. In drop-down helps, only
the values of these fields are displayed. Internally, the
value of field IS_MASTER_COLUMN is used.

You can set the fields IS_MASTER_COLUMN and IS_DESCRIPTION to true in a

structure only once. A maximum of 10 columns is allowed.

9.8.5.2 CHANGE_HELP_ROWS
The VIM Foundation calculates the input help values and then calls this method. If
you have changed the columns in the CHANGE_HELP_COLUMNS method, you must
adapt the values of these columns accordingly.

Parameter Type Description

PI_HELP_ID Importing ID for search help
PI_MASTER_FIELDNAME Importing Field name for which this input help is
called
PIH_DATA_COLLECTION_ACT Importing DataCollection of ActionDialog the search
ION_DLG help is called from
PIH_DATA_COLLECTION_ITE Importing DataCollection of item perspective the
M search help is called from
PIH_ITEM_PERSPECTIVE_INFO Importing Additional information about current item
perspective
PIH_WOBJ Importing Work object instance which contains the
field the search help has been called for

VIM200405-CGF-EN-02 Configuration Guide for Foundation 509

Chapter 9 Fiori Task App

Parameter Type Description

PIS_ADD_HELP_INFO Importing Additional information about view and
field the search help is called from
PIT_FILTER_OPTIONS Importing Filter options for the search help values
PCT_HELP_ROWS Changing Search help values
PCT_RETURN Changing Return parameter table (error messages)
PC_ERROR_TYPE Changing Error type

Structure of PCT_HELP_ROWS:

Field name Description

ROW_ID Unique row ID
COLUMN_ID01_VALUE Value of column 01 for the current row
COLUMN_ID02_VALUE - Value of column 02 and further
COLUMN_ID10_VALUE corresponding columns for the current row

9.8.5.3 CHANGE_FILTER_OPTIONS
This method is called before calling the search help exit. It allows you to change the
filter options.

Parameter Type Description

PI_HELP_ID Importing ID for search help.
PI_MASTER_FIELDNAME Importing Field name for which this input help is
called.
PIT_KEYS Importing Contains key fields of the current work
object.
PI_WOBJ_TYPE Importing Work object type.
PI_LOGSYS Importing Logical system.
PI_OBJECT_KEY Importing Object key.
PIH_DATA_COLLECTION_ACT Importing DataCollection of ActionDialog the search
ION_DLG help is called from
PIH_DATA_COLLECTION_ITE Importing DataCollection of item perspective the
M search help is called from
PIH_ITEM_PERSPECTIVE_INFO Importing Additional information about current item
perspective
PIH_WOBJ Importing Work object instance which contains the
field the search help has been called for
PIS_ADD_HELP_INFO Importing Additional information about view and
field the search help is called from

510 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.8. Interfaces and exits

Parameter Type Description

PCT_FILTER_OPTIONS Changing Filter options.

Structure of PCT_FILTER_OPTIONS:

Field name Description

ATTRIBUTE Attribute
SIGN I or E for an (I)nclude or (E)xclude condition
OPTION Option of the condition (EQ, BT, NE, …)
LOW Lower filter value
HIGH Higher filter value

9.8.6 BAdI /OTX/PF63_MSG

For changing messages provided by the VIM Foundation, you can implement the
BAdI /OTX/PF63_MSG. You can filter the implementations by work object types. The
implements use the /OTX/PF63_IF_BADI_MESSAGE interface and have the following
methods:

CHANGE_MESSAGE - Option to change the message texts

Messages generated by VIM Foundation can be changed in this method.

Parameter Type Description

PI_MESSAGE_ID Importing Message ID. All messages that can be changed have a
unique ID. See domain values for details.
PI_WOBJ_TYPE Importing Current work object type
PIT_KEYS Importing Object keys
PCS_MESSAGE Changing Message

9.8.7 /OTX/PF63_IF_FS_LIST interface

The full screen list interface /OTX/PF63_IF_FS_LIST comprises the following
methods:

VIM200405-CGF-EN-02 Configuration Guide for Foundation 511

Chapter 9 Fiori Task App

9.8.7.1 CHANGE_CUSTOMIZING

Tip: Values that you enter here are not changed by the VIM Foundation later.
Use the /OTX/PF62_CL_UTILITIES method to change for example the
calculation of the correct perspective ID for the device type.

Parameter Type Description

PIH_FS_LIST_CUSTOMIZING Importing Parameter PIH_FS_LIST_
CUSTOMIZING is an instance of class /
OTX/PF62_CL_FC_FSL_CUST_CHG.
PIH_FS_LIST_CUSTOMIZING has
methods to get all relevant
information of the fullScreenList.
Additionally it has methods for
changing the columns, actions and
general settings of the
FullScreenList.

9.8.7.2 CHANGE_DATA

Parameter Type Description

PIH_FS_LIST_CHANGE Importing Parameter PIH_FS_LIST_CHANGE is
an instance of class /OTX/PF62_CL_
FC_FSL_CHANGE. This class offers
GET methods for all relevant
information.

Rows can be added and deleted. For

changing existing rows method /
OTX/PF62_IF_FC_FSL_
CHANGE~GET_ROWS returns for each
row an instance of class /OTX/PF62_
CL_FC_FSL_ROW_CHG. This class
allows to change the cell values,
actions and to highlight a row.

9.9 Helper classes for exit methods: /OTX/

PF62_CL_UTILITIES
Class /OTX/PF62_CL_UTILITIES provides functions for exit implementations.

512 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.9. Helper classes for exit methods: /OTX/PF62_CL_UTILITIES

9.9.1 Method GET_WEBID_FOR_OBJECT_KEYS

This method returns the web ID for a work object. This is for example needed for the
semantic object navigation when the item details should be displayed in the object
mode using a different work object than in the full screen list or master detail mode.
In this case, the original web ID cannot be reused, but an ID for the other work
object type needs to be calculated.

Parameter Type Description

PI_WOBJ_TYPE Importing Work object type
PIT_KEYS Importing Key values
PE_WEBID Exporting Web ID

9.9.2 Calculating the JSON of the link parameter

Use the auxiliary method GET_JSON_FOR_LINK_PARA of the /OTX/PF62_CL_
UTILITIES class, to calculate the JSON of the link parameter.

Table 9-3: Parameters of GET_JSON_FOR_LINK_PARA method

Parameter Type Description

PI_SEMANTIC_OBJECT Importing Semantic object
PI_ACTION Importing Action of semantic object
PI_NODE_ID Importing Node ID
PI_WOBJ_TYPE Importing Work object type
PI_WORKPLACE_ID Importing Workplace ID
PI_SYSTEM Importing System Alias
PI_FILTER Importing Filter (value will be URL-encoded in
the method)
PI_SEARCH_FIELD Importing Search field
PI_SEARCH_VALUE Importing Search value (value will be URL-
encoded in the method)
PI_SORT_OPTION Importing Sort option
PI_SORT_DIRECTION Importing Sort direction
PIT_OTHER_PARAMETERS Importing Generic Parameters, can be used for
calculation links to other apps
PI_APP_MODE Importing Sets the appMode parameter of the BC
Fiori App

VIM200405-CGF-EN-02 Configuration Guide for Foundation 513

Chapter 9 Fiori Task App

Parameter Type Description

PI_DEACTIVATE_LETTERBOX Importing Deactivates the letter box.

If the PI_DEACTIVATE_LETTERBOX
parameter is set to X, then the
letterBox app parameter is set to
the value false.
PI_DEACTIVATE_SEM_NAV Importing Deactivates the semantic object
navigation

If the PI_DEACTIVATE_SEM_NAV
parameter is set to X, then the
semanticNavEnabled parameter is
set to false.
PI_SPLIT_APP_MODE Importing Sets the split app mode to active

If the PI_SPLITT_APP_MODE
parameter is set to X. then
splitAppMode app parameter is set
to true.
PI_WEBID Importing ID used in the web UI.

The value of the PI_WEBID parameter

is used for the webId app parameter.
PI_WEBID_ALIAS Importing Alias of the Web ID

The value of the PI_WEBID_ALIAS

parameter is used for the
webIdAlias app parameter.
PR_JSON Returning JSON for link parameter

To calculate the JSON for a link pointing to the Fiori Task App, set the following
parameters:

• PI_SEMANTIC_OBJECT
• PI_ACTION
• PI_NODE_ID
• PI_WOBJ_TYPE
• PI_WORKPLACE_ID
• PI_SYSTEM

If one of the parameters PI_NODE_ID, PI_WOBJ_TYPE or PI_WORKPLACE_ID is not set,

only the parameters in PIT_OTHER_PARAMETERS are considered.

To calculate the link parameters for other applications than the Fiori Task App, use
the parameters PI_SEMANTIC_OBJECT, PI_ACTION, and PIT_OTHER_PARAMETERS
only.

514 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.9. Helper classes for exit methods: /OTX/PF62_CL_UTILITIES

9.9.3 Calculating the ID for the device type

Use the GET_PERS_ID_FOR_DEVICE method of the /OTX/PF62_CL_UTILITIES class
to calculate the perspective ID for the device type that is used.

Table 9-4: Parameters of GET_PERS_ID_FOR_DEVICE method

Parameter Type Description

PI_PERSPECTIVE_IDT Importing Perspective ID
PI_PERSPECTIVE_TYPE Importing Perspective type
PI_DEVICE Importing Device type
PR_PERSPECTIVE_ID Returning Perspective ID

9.9.4 Preparing item perspective data

Use the /OTX/PF62_IF_PREP_ITM_PERS_DAT~PREPARE_ITEM_PERS_DATA method to
trigger the calculation of the data displayed in an item perspective asynchronously.
The calculated data is stored in a data collection, and the ID of this collection is
returned when calling the method. When the data in this collection ID is required, it
must be provided in the GET_PREPARED_DATA method of the /OTX/PF62_IF_
PERSPECTIVE_CLASS interface.

Table 9-5: Parameters of PREPARE_ITEM_PERS_DATA method

Parameter Type Description

PIT_KEYS Importing Values for a key
PI_WOBJ_TYPE Importing Work object type
PI_PERSPECTIVE_ID Importing Perspective ID
PR_DATA_COLLECTION_ID Returning Data Collection ID

Method /OTX/PF62_IF_PREP_ITM_PERS_DAT~REMOVE_ITEM_PERS_DATA can be used

to delete this data collection.

Table 9-6: Parameters of REMOVE_ITEM_PERS_DATA method

Parameter Type Description

PI_DATA_COLLECTION_ID Importing Data Collection ID

VIM200405-CGF-EN-02 Configuration Guide for Foundation 515

Chapter 9 Fiori Task App

9.9.5 Method /OTX/

PF62_IF_UTILITIES~GET_PF62_WOBJ_FOR_WEBID
This method returns an instance of the work object for the web ID. All work object
data can be accessed using this instance.

Parameter Type Description

PI_WEBID Importing ID used in web UI (optional: either PI_WEBID or
PIT_KEYS must be provided)
PIT_KEYS Importing Key values (optional: either PI_WEBID or PIT_KEYS
must be provided)
PI_WOBJ_TYPE Importing Work object type
PI_PLTT Importing Perspective Life Time Token
PRH_WOBJ Returning Work object instance

9.9.6 Method /OTX/

PF62_IF_UTILITIES~GET_WORK_OBJECT_TYPE
This method returns an instance of the work object type. All settings related to the
work object type can be accessed using this instance.

Parameter Type Description

PI_WOBJ_TYPE Importing Work object type
PRH_WOBJ_TYPE Returning Work object type instance

9.9.7 Method LOG_MESSAGE

This method logs messages in the application log using object /OTX/PF00 and sub-
object /OTX/PF62.

Parameter Type Description

PIS_BAPIRET2 Importing Message

516 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 9.10. Integrating UI5 widgets for Extended ECM or Document Access

9.9.8 Method REMOVE_WEBID

This method deletes a web ID and all related temporary information.

Parameter Type Description

PI_WEBID Importing ID used in web user interface
PI_LOCK_WEBID Importing Flag to define that the object is locked during the
deletion process (default)

9.10 Integrating UI5 widgets for Extended ECM or

Document Access
You can integrate UI5 widgets for Extended ECM for SAP Solutions (xECM) or for
Archiving and Document Access for SAP Solutions (ADA). To integrate UI5 widgets
for Extended ECM for SAP Solutions or for DocuLink, you can use the perspective
mechanism like for any other custom view. For more information, see “Editing
perspectives and layouts” on page 427.

To integrate Extended ECM or DocuLink UI5 widgets:

1. Open the Perspective Editor from the Launchpad by clicking the Perspectives
Maintenance tile.

2. To copy the wanted perspective, use the Create function of the Perspective
Editor.

3. Add the views in the following table to the Perspective Editor. Therefore, use
the context menu of folder views.

4. Add the following views for Extended ECM.

BSP Application BSP View Web icon

/OTX/RMF_BWS4BC_02 otx.ecmlink.bws4otbcwui02. customer
view.item.BusinessWorkSpace:
This view renders the business
workspace by opening the integration
widget from OpenText™ Content Server.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 517

Chapter 9 Fiori Task App

BSP Application BSP View Web icon

/OTX/ALF_DOCS4BC_02 otx.alplus.doc4otbcwui02.view. customer-
item.BusinessDocuments: order-entry
This view renders the list of business
documents. A click on a document opens
it in an overlay over the existing web
page.
/OTX/ALF_DOCS4BC_02 otx.alplus.doc4otbcwui02.view. customer-
item.BusinessDocumentsSplit order-entry
otx.alplus.doc4otbcwui02.view.
item.DocumentDisplay
Use these views together for a split. The
view BusinessDocumentsSplit
renders the list of business documents. A
click on a document opens the document
display in the view DocumentDisplay.

5. Drag the views to the perspective that you want to change.

6. Click OpenText Vendor Invoice Management Foundation > Web Services >
Workplace > Nodes.

7. Double-click the node for which you want to add the UI5 widgets. Maintain the
ID of the copied perspective in the Perspective ID for an item column.

8. Click OpenText Vendor Invoice Management Foundation > Web Services >
Work Object Type > Work Object Type.

9. Maintain the related business object. For more information, see “Defining a
related business object for a work object type” on page 377.

518 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

Chapter 10
Fiori Monitoring and Analytics reports

Analytics component of Vendor Invoice Management for SAP Solutions deliver

OData enabled Core Data Services (CDS) views with UI annotations to generate
reports based on FIORI elements. You can, for example, create an Analytical List
Page (ALP) report by using Fiori elements in the SAP Cloud development tools SAP
Web IDE or SAP Business Application Studio (SAP BAS).

For more information how to create reports, see “Generating reports in Web IDE”
on page 520 and “Generating reports in SAP Business Application Studio (SAP
BAS)” on page 522.

The available CDS views are optimized for the generation of a specific SAP Fiori
elements template.

• For the technical information how to generate a Fiori Analytics report for each
solution, see Analytics for SAP S/4HANA in the solution specific chapter of
OpenText Vendor Invoice Management for SAP Solutions - Configuration Guide for
Solutions Beyond Invoice (BOCP-CCS).
• For the steps how you generate and configure reports, see “Generation and
configuration” on page 520.
• For the options how you extend these reports, see “Custom Extensions”
on page 528.

Prerequisites

• SAP Business Technology Platform (SAP BTP) is connected to the respective on-
premises systems (backend and frontend) via SAP Cloud Connector.
• Access to SAP WebIDE or SAP Business Application Studio (BAS) is enabled for
backend and frontend system.
• The backend system should have the highest possible SP of the SAP_BW
component.
• SAP Notes 2767228 must be fully implemented on the backend system.

For details, how to connect to SAP BTP, and how to enable WebIDE or SAP Business
Application Studio, see the SAP Help.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 519

Chapter 10 Fiori Monitoring and Analytics reports

10.1 Generation and configuration

• “Activating services on the backend system” on page 520
• “Generating reports in Web IDE” on page 520
• “Generating reports in SAP Business Application Studio (SAP BAS)”
on page 522
• “Adding local annotations” on page 524
• “Deploying reports on the frontend system” on page 525
• “Setting up a launchpad tile” on page 526
• “Custom Extensions” on page 528

10.1.1 Activating services on the backend system

To activate services on the backend system

1. On the backend system, go to transaction /IWFND/MAINT_SERVICE.

2. Set up the OData service as described in the solution-specific Technical Details

table. For more information, see OpenText Vendor Invoice Management for SAP
Solutions - Configuration Guide for Solutions Beyond Invoice (BOCP-CCS).

3. For details how to activate ODATA services, see SAP Help Portal (https://
help.sap.com).

10.1.2 Generating reports in Web IDE

To generate reports in Web IDE

1. Log in to Web IDE.

2. Click File > New > Project from Template.

3. Follow the wizard and enter the requested input.

The following table shows the general input for all kind of reports. For solution-
specific details refer to Technical Details table in OpenText Vendor Invoice
Management for SAP Solutions - Configuration Guide for Solutions Beyond Invoice
(BOCP-CCS).

520 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 10.1. Generation and configuration

Table 10-1: Input for Project from Template wizard

Step Input
Template Selection • SAPUI5 Version
UI version of your frontend server.
• Template:
Choose the recommended template according the table.
For example, the List Report Application template for the
Monitoring report and the Analytical List Page template
for the Analytics report.
Basic Information Fill the required fields, marked with *. If necessary, provide a
namespace on your system:
• Project Name
• Titel
• Namespace
• Description
Data Connection Select the backend system and the OData service.
Annotation Selection Select all annotation files that display.
If you use the Add Annotation Files action with Add From
Service, select the Generic Annotation Provider check box, to
see all delivered annotation files.

Template Customization OData Collection

The OData collection. If the collection has parameters,
choose the one with the ending Results.
For example, xOTXxPS02xALL_DOC_QUERYResults.
OData Navigation
If available, choose OData navigation.
OData Sub Navigation
For the List Report select Template features, like Smart
Variantsor Flexible Column Layout.
For example, SAP Help Portal (https://help.sap.com/)
Qualifier (content area) - only for Analytical List Page:
Default
Table Type:
Analytical (for Analytical List Page)

4. Click Finish.
The new project is available in the Web IDE

5. Optional For OData projects without parameters, click Run for a first sandbox
test.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 521

Chapter 10 Fiori Monitoring and Analytics reports

6. Optional For some of the available Analytics List Page, the navigation from ALP
to the object page (the arrow at the end of each line in the table) is not necessary.
To remove the navigation:

a. In your IDE project, navigate to \webapp\ , double-click manifest.json

file .
b. Open the Code Editor tab in the footer of the Editor and delete the lines for
ObjectPage:

"pages": {

"ObjectPage|ZOTX_PS02H_ALL_PROC_QUERYResults": {

"entitySet": "ZOTX_PS02H_ALL_PROC_QUERYResults",

"component": {

"name": "sap.suite.ui.generic.template.ObjectPage"

10.1.3 Generating reports in SAP Business Application Studio

(SAP BAS)
To generate reports in SAP Business Application Studio:

1. Log in to SAP BAS.

2. Start an existing Dev Space or create a Dev Space of type SAP Fiori.

3. In the running Dev Space open the PROJECTS workplace.

4. On the Welcome page, click Start from Template.

5. Select the SAP Fiori Application folder and click Start.

6. Follow the wizard and enter the required information.

The following table shows the input for all types of reports. For solution specific
informations, see OpenText Vendor Invoice Management for SAP Solutions -
Configuration Guide for Solutions Beyond Invoice (BOCP-CCS).

522 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 10.1. Generation and configuration

Step Input
Floorplan • Application Type: SAP Fiori elements.
• Type of SAP Fiori elements Apps:
Choose the recommended template.
For example, List Report Application
template for the Monitoring report and
Analytical List Page template for the
Analytics report.
Data Source and Service Selection • Data source: A SAP System
• System: Backend system maintained in
Destinations of the SAP Foundry
Subaccount.
• Services: OData from backend system
Entity Selection • Main entity: The OData collection. If
the collection has parameters, the one
with the ending Results. For
example,
xOTXxPS02xALL_DOC_QUERYResul
ts.
• Navigation entity: If available, OData
navigation.
• Qualifier:: Default (for Analytical List
Page)
• Table Type: Analytical (for Analytical
List Page)
Project Attributes Required fields are marked with *. If
necessary, add a namespace on your
system:
• Module name
• Application title
• Application namespace
• Description

To remove the navigation to the Object Page:

The Analytics List Page, provides a navigation to the Object Page at the end of each
line in the table. This link can be removed if it is not needed.

1. In your project, navigate to \webapp\, and then double-click manifest.json

file .

2. Open the Code Editor tab in the footer of the editor and delete the following
lines:
c. "pages": {
"ObjectPage|ZOTX_PS02H_ALL_PROC_QUERYResults": {
"entitySet": "ZOTX_PS02H_ALL_PROC_QUERYResults",
"component": {
"name": "sap.suite.ui.generic.template.ObjectPage"

VIM200405-CGF-EN-02 Configuration Guide for Foundation 523

Chapter 10 Fiori Monitoring and Analytics reports

}
}
}

To run the new project and test your Fiori Application:

1. In the Explorer select the created project, and then in the context menue click
Open in Terminal.

2. In the Terminal enter: npm install.

3. In the Terminal enter: npm run build.

4. In the Explorer click on Run Configurations.

5. In the Run Configurations windows, click on the arrow next to your project.
The application runs in a new tab.

10.1.4 Adding local annotations

You can use local annotations to enter the default values for OData with input
parameters. You can also use local annotations to optimize the output of the report..

Each report comes with a local annotation.xml as example that you can customize.
You can find the name of the annotation.xml file in the technical details table of the
solution.

To import an example annotation XML

1. In Web IDE, select your project

2. Navigate to \webapp\annotations\ and open the annotations.xml in an

editor (for example, NotePad).

3. Open the annotations.xml that is delivered for the respective report.

4. Copy the content.

5. Go to the Code Editor.

6. Replace the generated content of the annotations.xml with the delivered XML
template.

7. Click Save.

To import the example translation files

For some reports, an example i18n file (internationalization file) is delivered to

display English standard texts. You can use the file for translation into further
languages.

1. Navigate to \webapp\i18n\ .

2. Open the i18n.properties file.

524 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 10.1. Generation and configuration

3. Paste the content of the delivered i18n file, to replace the generated file.

4. Click Save.

5. Optional Click Run to check the results.

You find new facets.

10.1.5 Deploying reports on the frontend system

You can now deploy the report that you created in SAP Web IDE or in SAP Business
Application Studio (SAP BAS). Deploy, either to the SAP Business Technology
Platform or to an on-premises frontend server.

The deployment process is described in detail on the SAP Help Portal (https://
help.sap.com).

The following procedure is an example of relevant activities to deploy to an on-

premises frontend server:

To deploy to from SAP Web IDE to an on-premises frontend server:

1. In Web IDE click the Deploy button.

2. Deploy to the SAP UI5 ABAP repository

3. Enter a name for the BSP application.

4. Select a development package for the application.

5. Select a transport.
After the deployment, the BSP application for your report is available in the
selected package.

6. If needed, go to SICF transaction and activate the service for the created
application (Service Name = Name of the BSP application).

To deploy from SAP BAS to an on-premises frontend server

1. In SAP BAS, in the Explorer, select the created project. and then in the Context
Menu click Open in Terminal.

2. In the Terminal enter: npm install.

3. In the Terminal enter: npm run build.

4. In the Terminal enter: abap-deploy.

5. Enter the required data.

Project name (starting with ZZ1), package, transport request.
After the deployment, the Business Server Page (BSP) application is available
for your report in the selected package.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 525

Chapter 10 Fiori Monitoring and Analytics reports

6. Optional If needed, go to SICF transaction and activate the service for the created
application.
The service name is the name of the BSP application.

10.1.6 Setting up a launchpad tile

To set up a launchpad designer:

1. Open the Launchpad Designer.

2. Select or create a catalog to add the report.

3. To create a target mapping, click the Target Mappings node.

Keep all fields that are not mentioned here, either empty or with their default
values.

Semantic Enter a name for the semantic object. For example ZPS08.
Object:
Action: Choose or define an action. For example display.
Application Choose SAPUI5 Fiori App.
Type
Title Enter a title.
ID Enter the ID of the app.
You find the ID in the Component.jsof the App. The string
before .Component is the ID of the App. You can look up this file in
the Web IDE or in SE80.

4. To create a tile, click the Tiles node:

a. In the General area, enter the title and subtitle.

b. In Navigationin Semantic Object field and Action field, enter the data that
was defined for the target mapping.

10.1.7 Enabling the semantic navigation

CDS views are using @SemanticObject annotation to define navigation links to
several targets.

For each report, you find the default semantic objects in the detail section. The
semantic object definition uses SAP standard objects, like SupplierInvoice and
Supplier to navigate to the respective SAP FI App.

• By Default, the report displays all navigation intents for a given semantic object.
• To reduce the number of available navigation intents, change the semantic object
that is used in the report to a custom semantic object. Change the semantic object
in the metadata extensions. For more information, see “Changing the appearance
with Metadata Extensions” on page 528.

526 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 10.1. Generation and configuration

• If you change the semantic object to a custom semantic object, also configure the
custom target mappings and the tile configurations for the SAP standard apps.

For navigation to VIM Foundation based Fiori Apps, you need to create an
additional target mapping with a semantic object that is defined in the respective
CDS view.

The values display in the detail section of the reports. You can also change the
standard semantic object by using the metadata extensions.

To enable the navigation to VIM Foundation based apps:

1. Open the Launchpad Designer.

2. Select or create a catalog.

3. In the Target Mappings tab, click Create Target mapping button.

4. Enter data in the Intent area:

Semantic Object:
For details, see detail page of the report (table entry: Semantic Navigation).
Action:
Display.

5. Enter data in the Target area:

Application Type:
SAPUI5 Fiori App
Title:
Add a title
URL:
/sap/bc/ui5_ui5/otbcwui/pf07_bc_ui_03

ID:
ot.approve.requests03

6. In Parameters area, enter the solution specific parameters.

The parameters are listed in technical details table of the solution. Check the
Semantic Navigation row. The table is available in the Analytics chapter of
each solution. For more information, seeOpenText Vendor Invoice Management for
SAP Solutions - Configuration Guide for Solutions Beyond Invoice (BOCP-CCS).

7. Click Save.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 527

Chapter 10 Fiori Monitoring and Analytics reports

10.2 Custom Extensions

You can copy the provided CDS views and extend them with custom functionality.
Use the Metadata Extension (MDE) Concept for CDS views for minor UI related
changes in the appearance..

With the FIORI Elements templates you can perform modifications based on local
annotations in the WebIDE. For more information, see SAP Help (https://
help.sap.com).

10.2.1 Changing the appearance with Metadata Extensions

CDS Metadata Extensions (MDE) provide the UI annotations of the CDS views.
Here, you maintain UI related aspects, like the displayed fields, positioning or
grouping.

The MDE concepts allow to overwrite the standard annotations with custom specific
annotations without modifying the original objects.

To provide custom specific annotations:

1. Open the SAP ADT tools in Eclipse and connect to the backend system

2. Create a new Metadata Extension in the z namespace (your specific namespace)

and refer to the /OTX/-CDS view you want to enhance

3. Set the @Metadata.layer annotation to #CUSTOMER or to #PARTNER for

implementation partners.

4. Change the annotations to fulfill your requirements.

Changes are visible on the frontend immediately after you change the
annotations.

Example 10-1: MDE changed for the standard annotations of CDS view /
OTX/PS08_VC_A_INVBPF

The position of the Invoicing Party and Process ID fields is changed and the
semantic object reference for Invoicing Partyis removed.

528 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 10.2. Custom Extensions

VIM200405-CGF-EN-02 Configuration Guide for Foundation 529

Chapter 11
Useful methods

This chapter lists methods that can be useful in a global context.

11.1 /OTX/
PF00_CL_UTILITIES=>STRUCTURE_FIELD_VAL
UE_CONVERT
You can use this method in custom web handler implementations. The method
converts internal field values to an external output format. The reason for this is that
the standard SAP GUI conversions are not considered automatically.

11.2 /OTX/
PF00_CL_UTILITIES=>FIELD_VALUE_CONVERT
_STRUCTURE
You can use this method in custom web handler implementations. The method
converts external field values to an internal format. The reason for this is that the
standard SAP GUI conversions are not considered automatically.

11.3 /OTX/PF00_CL_UTILITIES=>TABLE_DATA_PACK
You can use this method whenever needed to transform structured internal table
data to a field value table format.

11.4 /OTX/
PF00_CL_UTILITIES=>TABLE_DATA_UNPACK
You can use this method whenever needed to transform a field value table to a
structured internal table data format. You can use the optional import parameter PI_
CONVERT_TO_INTERNAL if the data values should also be formatted to an internal
database format.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 531

Chapter 11 Useful methods

11.5 /OTX/
PF00_CL_UTILITIES=>STRUCTURE_DATA_PAC
K
You can use this method whenever needed to transform a data structure to a field
value table format.

11.6 /OTX/
PF00_CL_UTILITIES=>STRUCTURE_DATA_UNP
ACK
You can use this method whenever needed to transform a field value table to a data
structure format. You can use the optional import parameter PI_CONVERT_TO_
INTERNAL if the data values should also be formatted to an internal database format.

532 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

Chapter 12
Document classification

This chapter describes automatic and manual document classification functions,

which are available from the VIM Foundation. Document classification determines
the correct document types and corresponding business processes for incoming
documents.

The following technical components are involved in a complete end-to-end

classification scenario as shown in Figure 12-1: “Document classification
components” on page 533:

Figure 12-1: Document classification components

Inbound Configuration - Capture

Classification
Automatic document classification by Information Extraction Service (IES): IES
usually classifies documents. You have to configure a classification profile.
Within this profile a custom field with class type is required. The
corresponding classification ID must refer to a scenario classification within the

VIM200405-CGF-EN-02 Configuration Guide for Foundation 533

Chapter 12 Document classification

inbound configuration where you assing document types for classification. For
more information, see “Creating scenario classifications” on page 64
Automatic document classification by Business Center Capture: For more
information, see Section 4.6 “Supported function types for custom fields in a
non-invoice application” in OpenText Business Center Capture for SAP Solutions -
Customization Guide (CPBC-CGD) and Section 4.7 “Configuring a Classification
function” in OpenText Business Center Capture for SAP Solutions - Customization
Guide (CPBC-CGD).
Classification Validation
Manual document classification within the classification validation. The
classification validation is triggered if the automatic document classification was
not possible.
To process the recognition correctly, do not skip the validation classification
within the validation assignment settings of the Inbound Configuration.
Recognition
In this step, only data extraction for the current classification takes place, no
classification functionality is involved.
Recognition Validation
In this step, only data validation takes place. If required, you can add a field
representing the current classification value. As soon as the classification field
value is changed, a new recognition step is triggered for the changed
classification. In general, you can skip the Recognition Validation by using the
validation assignment settings of the Inbound Configuration. For more
information, see “Customizing validation” on page 182.

Document Processing

Workplace
Manual reclassification in the VIM Central Workplace if required. A restart of
the Capture process might result from this in special cases.
Processing Screen
Manual reclassification in the Processing Screen if required. A restart of the
Capture process might result from this in special cases.
Fiori Task App
Manual reclassification within the Fiori Task App if required. A restart of the
Capture process might result from this in special cases.

You can use a complete end-to-end classification scenario if different incoming

documents are not manually presorted before system input through scanning, email,
or other input channels. Presorting in this context means sorting incoming
documents by specific business scenarios, for example Sales or Human Resources,
and corresponding target document types, for example Employment Contract or
Employee Address Change Letter.

In general, distinguish between the following classification scenarios.

534 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 12.1. Document type handling

Classification across different business scenarios

Incoming documents are not presorted in any way. Their classification can result
in routing them to completely different business scenarios.
Classification within specific business scenarios
Incoming documents are already presorted by business scenarios. Their
classification only results in triggering different business processes for the
classified target document types in the specific business scenario.

Note: When the Classification and/or Classification Validation are finished,

you already must have set up a specific classification to continue processing.
Otherwise you must provide a special classification handling within the
business processes. If incoming documents are fully presorted already, the
Classification and Classification Validation will be skipped. In both cases,
specific classification or special classification handling, you can still perform a
reclassification in a later processing phase if required. For more information,
see “Creating scenario classifications” on page 64.

12.1 Document type handling

The document type customizing determines the classification options. For more
information, see “Assigning document types to classifications” on page 65.

All classification options are directly based on SAP ArchiveLink document types.
They are defined in the Inbound Configuration for the corresponding registration
type and channel. For more information, see “Customizing registration types”
on page 71.

Link each document type to the following SAP Business Object types. Linked
document types are available for classification in the OAC3 transaction. The Business
Object types represent the different involved components of the VIM Foundation.

/OTX/PF01
Inbound Registration Object
/OTX/PF02
Process Object

If you create or post SAP document during the business process, additional entries
for standard SAP business objects can be required. Thus, you attach the incoming
documents to the rarget SAP business objects.

You can change the classification type at any time. This also changes the SAP
ArchiveLink document type which results in adjusting the related ArchiveLink
connection entries. If the content repository must be changed to, re-archiving is
performed.

Note: Additionally offer an ArchiveLink document type for an unclassified

incoming document. This document is validated if no special classification

VIM200405-CGF-EN-02 Configuration Guide for Foundation 535

Chapter 12 Document classification

handling is provided within the business processes. The validation happens in

the validation assignment settings of the Inbound Configuration. The
connected Business Center Capture application of the document determines
whether a document type is considered as classified. Assign an unclassified
document type to a custom classification application. Assign all classified
document types to the corresponding scenario profiles.

12.2 Processing impacts

This section describes classification related dependencies between the VIM
Foundation components Inbound Configuration and Process Configuration. This
section also describes the special processing impacts when changing the
classification within a business process.

During inbound processing, all incoming documents are classified using specific
ArchiveLink document types as maintained in the Inbound Configuration. Each
document type is linked to a Scenario Classification profile. This profile is further
linked to a Process Foundation profile. The Process Foundation profile is
represented by a suitable business data model and one or more connected Process
Configuration profiles containing the business processes.

When you change a classification at any point within a business process, the
following logic is processed:

1. The corresponding inbound channel and its connected registration type is

determined.
2. Document types that are maintained as classification document types in the
scenario classification (see “Assigning document types to classifications”
on page 65) are determined as classification options.
For Information Extraction Service, document types are mandatory.
If you do not set document types for Business Center Capture integration, all
document types that are defined for the combination of channel and registration
type are determined as classification options.
3. ArchiveLink connection entries are adjusted, or a re-archiving is run.
4. The processing impact is determined. This means it is checked if the
classification change leads to one of the following results.

• a switch of the Scenario Classification/Process Configuration profile (business

scenario change)
• only a switch of the connected Process Configuration profile

Note: Only inbound channels based on the registration types Early Archiving,
Incoming Mail and Custom/Others are supported for classification. The reason
for this is that only these channels can provide a Business Center Capture or
Information Extraction integration.

536 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 12.2. Processing impacts

Figure 12-2: “Processing impacts” on page 537 shows the connection between the
different involved components and the processing impacts that are considered when
technically handling a classification change:

Figure 12-2: Processing impacts

Processing Impact A: Switch characteristic configuration

A classification change does not lead to a change of the business scenario and/or
the connected Process Configuration profile. You can use the characteristic
configuration to fulfill different processing requirements by maintaining
classification document types as characteristic values. For more information, see
“Configuring characteristics” on page 242.

Processing Impact B: Switch Process Configuration profile

A classification change does not lead to a change of the business scenario but
requires changing the connected Process Configuration profile. A process restart
is run. During the process restart, a redetermination of the Process
Configuration profile takes place. You can use the classification document types
as dynamic determination criteria. For more information, see “Profile
assignment” on page 259.

Processing Impact C (business scenario change): Finish process and restart

inbound processing
A classification change leads to a change of the business scenario itself. The
current process is set to obsolete and the inbound processing is restarted. During
inbound processing, the capture steps are performed again. The new scenario
classification is evaluated. The linked Process Foundation profile is used to

VIM200405-CGF-EN-02 Configuration Guide for Foundation 537

Chapter 12 Document classification

determine a connected Process Configuration profile. This offers a suitable

business process to fulfill the processing requirements.

12.3 Classification integration

Integrating classification into business processes uses some predefined configuration
settings and ABAP classes.

Workplace integration
Using the /OTX/PF31_CL_ACTION_CLASSI class, define a standard toolbar
button action for work object types where a classification should be available if it
is not already defined.

Processing screen integration

Assign the predefined action ACT_CLASSI to SAP GUI process steps and roles
where a classification should be available if it is not already assigned. If the
predefined action ACT_CLASSI is not available in your corresponding Process
Configuration profile, create it as a dialog action using the /OTX/PF41_CL_
ACTION_CLASSI class.

Fiori Task App integration

Assign the predefined action FRM_WP_CLASSI to web process steps and roles
where a classification should be available if it is not already assigned. If the
predefined action FRM_WP_CLASSI is not available in your corresponding Process
Configuration profile, create it as dialog action using the /OTX/PF41_CL_
ACTION_CLASSI_EXT class.

12.4 BAdI /OTX/PF40_CLASSIFICATION

The /OTX/PF40_CLASSIFICATION BAdI implements the /OTX/PF40_IF_BADI_
CLASSI interface. The following interface method is available:

CHANGE_CLASSI_OPTIONS
This method allows to change the proposed classification options. It is called when
processing the classification action from the SAP GUI processing screen, the SAP
GUI workplace, or the Fiori Task App.

Parameter Type Description

PIS_PLH Importing Process ledger header data
PIT_PLI Importing Process ledger item data
PIS_CLASSI_CURRENT Importing Current Classification
PCT_CLASSI_OPTIONS Changing Classification options

Structure of PCT_CLASSI_OPTIONS:

538 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 12.4. BAdI /OTX/PF40_CLASSIFICATION

Field name Description

CLASSI_ID Classification option ID
CLASSI_DESC Classification description

VIM200405-CGF-EN-02 Configuration Guide for Foundation 539

Chapter 13
Troubleshooting

13.1 Fiori Monitoring and Analytics reports

You cannot use the delivered OData query if you create Analytical reports with SAP
S/4HANA backend with SAP_BW below SAP_BW 751 SP4. This is caused by
limitations of prior SAP S/4HANA versions. The workarounds are described here.

13.1.1 Backend SAP S/4HANA with SAP_BW below 751 SP4

You cannot use the delivered OData query if your SAP S/4HANA backend system
has a SAP_BW version below 751 SP4. The workaround is described here.

To create a custom CDS view in the Z namespace:

1. In ADT (ABAP Development Tool) in Eclipse, copy the OpenText CDS view
and its metadata extension to a package with Z namespace.

2. Activate the custom CDS view.

Custom CDS view is activated and OData is created.
SADL automatically generates a class with the prefix ZCL_ in the package to
which the custom CDS view is copied.

3. In the generated class with the prefix ZCL_, search for method DEFINE and
redefine it.

4. In the redefined method, insert the following code lines, replace the entity name
in variable iv_entity_name with the custom entity name which ends with
“Parameters”:
DATA: lo_entity_type TYPE REF TO /iwbep/if_mgw_odata_entity_typ,

lo_property TYPE REF TO /iwbep/cl_mgw_odata_property,

lo_annotation TYPE REF TO /iwbep/if_mgw_odata_annotation.

super->define( ). "Ensure you call the parent metadata

lo_entity_type = model-

>get_entity_type( iv_entity_name = 'ZOTX_PS02H_ALL_PROC_QUERYParameters').

lo_property ?= lo_entity_type-

>get_property( iv_property_name = 'P_FromDate').

CALL METHOD lo_property->/iwbep/if_mgw_odata_annotatabl~create_annotation

EXPORTING

iv_annotation_namespace = /iwbep/if_mgw_med_odata_types=>gc_sap_namespace

VIM200405-CGF-EN-02 Configuration Guide for Foundation 541

Chapter 13 Troubleshooting

RECEIVING ro_annotation = lo_annotation.

lo_annotation->add( iv_key = 'display-format' iv_value = 'Date' ).

lo_annotation->add( iv_key = 'label' iv_value = 'From Date' ).

5. Activate the method.

You must redo the step after each activation of the custom CDS view.

6. Activate the service on the backend system. For more information, see
“Activating services on the backend system” on page 520.

To manually change the local annotations for OData created from CDS:

In case the used OData is created for the CDS view in the Z namespace, instead of
Adding Local Annotations, do the following manual changes in the local
annotations file:

1. For OData with input parameters, for example the OData for Sales orders, keep
the default values for the parameters:

a. Navigate to /webapp/annotations.
b. Double-click the local annotations file annothations.xml.
c. In the annotation modeler, click the Select Targets button.
d. Select all entity types which contain the word parameters at the end.
e. In Properties select all parameters that do not contain the word text:

• P_ExchangeRateType,
• P_DisplayCurrency,
• P_FromDate
f. Click OK.
g. Check that the default values are set for all parameters:
In the Local Annotations of the different properties, add the expression
type and value.

Properties P_ExchangeRateType:
Common.FilterDefaultValue:

• Expression Type: String

• Value: M

Property P_DisplayCurrency:
Common.FilterDefaultValue:

• Expression Type: String

• Value: USD

542 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02

 13.1. Fiori Monitoring and Analytics reports

Property P_FromDate:
Common.FilterDefaultValue:

• Expression Type: DateValue.

Date that is appropriate for your purpose

2. If you want to provide virtual filters in the report, do the following changes:

a. Navigate to /webapp/annotations.
b. Double-click the local annotations file annothations.xml.
c. In the annotation modeler, click the Select Targets button.
d. Select all entity types which contain the word result at the end.
e. In the Properties list, select the properties, that are used for virtual filters:

• ChannelID
• StartCanendarYear
• ProcessFinished
f. Click OK.
g. In the annotation modeler, set the default qualifier in the ValueList of each
property, that is used for virutal filters:

i. In the Local Annotations node add the Common.ValueList subnode.

ii. For the CollectionPath node enter:

• Expression Type: String

• Value :: The Entity with ending Results. For example,
xOTXxPS02H_ALL_PROC_QUERYResults.

iii. In the Common.ValueList node add the

PresentationVariantQualifier subnode.

iv. For the PresentationVariantQualifier subnode enter:

• Expression Type: String

• Value :: For details, see data in Virtual Filter row in the Technical
Details table of your solution - OpenText Vendor Invoice Management
for SAP Solutions - Configuration Guide for Solutions Beyond Invoice
(BOCP-CCS).

3. Click Save.

4. Optional Click Run to test the report.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 543

Glossary
ArchiveLink
Service integrated in the SAP NetWeaver Application Server ABAP for linking
archived documents and the application documents entered in the SAP ERP
system.

Business Center Capture (BCC)

OpenText Business Center Capture for SAP Solutions. Optical character
recognition (OCR) component of Business Center.

Business Center
OpenText Business Center for SAP Solutions. A former standalone OpenText
product that is now part of Vendor Invoice Management.

Data View (View)

Dynamic part of a perspective. A set of views is shown in the template at specific
locations at runtime. For each perspective, you can define which view appears at
which location in its template. You can insert each view only once in each
perspective.

Fiori Task App

Light-weight web application following the design principles of SAP Fiori. It
provides an inbox showing the items that have been assigned to the logged-in
user. The user then is able to complete items by performing dedicated actions,
entering comments, and editing the data.

Inbound Configuration
Connection to various inbound channels, for example scanned paper documents,
fax, email, or IDoc, and the corresponding configuration.

Perspective
Web Services element that defines which item related data is displayed in the
Fiori Task App and where. A perspective defines the content and visual
appearance of items for a specific area of the screen in the Fiori Task App. The
Fiori Task App displays only one perspective at the same time.

Process Configuration
Easy and technically simplified configuration of complex business scenario
aspects. Process Configuration covers profile configuration, profile assignment,
and authorizations.

Process Foundation
Flexible framework to configure and run processes. It utilizes generic workflow
definitions, which are processed by the SAP Business Workflow engine.

VIM200405-CGF-EN-02 Configuration Guide for Foundation 545

Glossary

Vendor Invoice Management (VIM)

Packaged business solution that solves a business problem – paying correct
amount to vendors on-time and with the lowest cost. VIM delivers not technology
but best-practice business processes. VIM provides values to customers in process
efficiency, visibility and compliance. VIM is tightly integrated with Business
Center. For example, VIM uses the Business Center Inbound Configuration
mandatorily and provides a couple of Fiori apps that are based on Business
Center.

VIM Beyond Invoice Solution

Preconfigured business scenario that ensures a fast implementation phase. The
following solutions are available: Solution for Incoming Sales Orders, Solution for
Incoming Quotations, Solution for Incoming Delivery Notes, Solution for
Incoming Order Confirmations, Solution for Incoming Remittance Advices,
Monitor for Purchase Orders and Purchase Requisitions.

VIM Central Workplace

Central tool to process work objects. It provides an inbox with personal and
shared work item lists to the user. It also provides access to different business
objects and status information for all objects in process. The user can switch
between work centers and navigate in a process-dependent tree.

VIM Foundation
Central VIM unit that serves to import, capture, dispatch, process, and consume
business objects. It comprises Inbound Configuration, Process Foundation, Process
Configuration, VIM Central Workplace, and Fiori Task App.

Web Services
Underlying technical concept of the Fiori Task App interface. You configure the
complete content of the Fiori Task App either by customizing or by implementing
an interface for the Web Services.

Work object type

Processing object in the VIM Central Workplace. It can represent a process object,
a SAP business object, or information from any SAP tables.

546 OpenText™ Vendor Invoice Management for SAP® Solutions VIM200405-CGF-EN-02