Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                

Bocp CGD en

Download as pdf or txt
Download as pdf or txt
You are on page 1of 330

OpenText™ Business Center for SAP®

Solutions

Configuration Guide

This guide describes the configuration tasks for OpenText


Business Center for SAP Solutions.

BOCP160002-CGD-EN-01
OpenText™ Business Center for SAP® Solutions
Configuration Guide
BOCP160002-CGD-EN-01
Rev.: 2017-Apr-28
This documentation has been created for software version 16.0.2.
It is also valid for subsequent software versions as long as no new document version is shipped with the product or is
published at https://knowledge.opentext.com.

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 © 2017 Open Text. All Rights Reserved.


Trademarks owned by Open Text.

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
Part 1 About Business Center 7

1 What is Business Center? ........................................................ 9

2 About this document ............................................................... 15


2.1 Target audience .............................................................................. 16
2.2 Further information sources ............................................................. 16

Part 2 Customizing Business Center 17

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


3.1 Configuring general settings ............................................................ 19
3.2 Configuring logical systems ............................................................. 23
3.3 Configuring plug-in integration ......................................................... 24
3.4 Configuring logging ......................................................................... 29
3.5 Configuring Analytics ....................................................................... 31

4 Inbound Configuration ............................................................ 47


4.1 Customizing basic settings for Inbound Configuration ........................ 48
4.2 Configuring channels ....................................................................... 50
4.3 Creating scenario classifications ...................................................... 51
4.4 Customizing incoming documents through the document handler ....... 53
4.5 Customizing Business Center Capture ............................................. 83

5 Process Foundation ................................................................ 95


5.1 Basic Settings ................................................................................. 97
5.2 Data model configuration ................................................................. 98
5.3 Process Foundation profile ............................................................ 105
5.4 Business data model assignment ................................................... 106

6 Process Configuration .......................................................... 107


6.1 Profile configuration ...................................................................... 107
6.2 Profile assignment ......................................................................... 142
6.3 Authorizations ............................................................................... 143

7 Workplace Configuration ...................................................... 145


7.1 Work object types ......................................................................... 148
7.2 Exit for dynamic filter criteria .......................................................... 170
7.3 Navigation .................................................................................... 171
7.4 Authorization objects ..................................................................... 180

8 Fiori Task App ........................................................................ 183


8.1 System landscape ......................................................................... 184

OpenText Business Center for SAP Solutions – Configuration Guide iii


BOCP160002-CGD-EN-01
Table of Contents

8.2 Basic settings ............................................................................... 186


8.3 Work object type ........................................................................... 187
8.4 Workplace .................................................................................... 189
8.5 Item details ................................................................................... 192
8.6 Input helps .................................................................................... 201
8.7 Perspectives, templates, and views ................................................ 202
8.8 Action dialog box ........................................................................... 206
8.9 Perspectives, templates, and views references ............................... 226
8.10 Enabling inplace document viewing for iPhone and iPad .................. 236
8.11 Semantic navigation with the Fiori Task App ................................... 236
8.12 Integrating UI5 widgets for Extended ECM or DocuLink ................... 241
8.13 Interfaces and exits ....................................................................... 241

9 Fiori Task App running scenarios ....................................... 277


9.1 Integrating Fiori Task App into Fiori Launchpad ............................... 277
9.2 Running the Fiori Task App standalone .......................................... 283
9.3 Parameters reference .................................................................... 283

10 Accessing archived documents using a proxy service ..... 285

11 Useful methods ...................................................................... 287


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

12 Document classification ....................................................... 289


12.1 Document type handling ................................................................ 291
12.2 Processing impacts ....................................................................... 292
12.3 Classification integration ................................................................ 294
12.4 BAdI /OTX/PF40_CLASSIFICATION .............................................. 294

Part 3 Administering Business Center 295

13 Security topics ....................................................................... 297


13.1 Using secure connections .............................................................. 297
13.2 Configuring authorization settings .................................................. 297

14 Batch jobs for Inbound Configuration ................................. 299


14.1 Document handler ......................................................................... 299
14.2 Staging tables for the BCC integration ............................................ 300

iv OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
Table of Contents

14.3 Clean up ....................................................................................... 303

15 License audit .......................................................................... 305


15.1 Auditing using SAP System Measurement ...................................... 305
15.2 Auditing using OpenText Licenses Auditing Services ....................... 306

16 High availability ..................................................................... 309

17 Regular administration tasks ............................................... 311


17.1 Setting up substitutes for workflow processes ................................. 311
17.2 Reassigning work items belonging to another user .......................... 311
17.3 Administering workflows on a regular basis ..................................... 314
17.4 Cleaning up BCC .......................................................................... 314
17.5 Cleaning up search helps and web IDs ........................................... 314
17.6 Running a license report ................................................................ 315

18 Administering workflows ...................................................... 317


18.1 Monitoring alerts ........................................................................... 317
18.2 Using logs and traces .................................................................... 322
18.3 Frequently used SAP workflow administration transactions .............. 322
18.4 Retrieving technical configuration ................................................... 322

19 Troubleshooting .................................................................... 323


19.1 Monitoring activity ......................................................................... 323
19.2 Fiori Task App: detailed error messages ......................................... 323
19.3 Fiori Task App: error messages and log entries ............................... 324
19.4 Issues with the Fiori Launchpad and the Fiori Task App ................... 325
19.5 Document viewing issues .............................................................. 325

20 Customer Support ................................................................. 327

GLS Glossary 329

OpenText Business Center for SAP Solutions – Configuration Guide v


BOCP160002-CGD-EN-01
Part 1
About Business Center
Chapter 1
What is Business Center?

OpenText Business Center for SAP Solutions (Business Center) helps receiving
incoming documents, capturing processes, and filing them within a SAP system.
Business processes like the processing of incoming sales orders from customers or
incoming delivery notes from suppliers are very good use cases for Business Center.
The product provides the one platform to automate any business process that is
tightly integrated into the SAP solution stack.

Business Center can be connected with various inbound channels, be it paper


through scan, fax, email, or iDoc. The incoming documents are stored using SAP
ArchiveLink®.

OpenText™ Business Center Capture for SAP® Solutions (Business Center Capture)
is part of Business Center. It provides, in addition to the established methods, new
automated learning methods based on end user behavior and feedback.

After capturing the documents, the extracted data is validated against a set of
business rules. Though touchless processing is the ultimate goal, user interaction is
required if an exception occurs. Therefore, Business Center provides efficient user
experience within SAP GUI and outside (following the design principles of SAP
Fiori®). Once all exceptions are solved, the data can be posted and saved within the
SAP system.

To define the flow and the assignment of the right forms to the right users, the
product provides a simple configuration interface, which allows creation and
maintenance of process models quite efficiently.

Alongside Business Center, a set of pre-configured scenarios are provided as


solution accelerators. A solution accelerator is a pre-configured business scenario for
selected business objects and business processes. It is a simple approach to demo,
Proof of Concept, and to start implementing a business solution atop.

Business Center introduces the following features:

OpenText Business Center for SAP Solutions – Configuration Guide 9


BOCP160002-CGD-EN-01
Chapter 1 What is Business Center?

Figure 1-1: Business Center features

Solution Accelerators

Preconfigured processes that ensure a fast implementation phase. Currently, the


following solution accelerators are available.

• Incoming sales orders


• Purchase Order / Purchase Requisition dashboard
• Incoming delivery notes
• Incoming HR documents
• Incoming remittance advices
• Incoming order confirmations

You can also process incoming vendor invoices, in combination with OpenText™
Vendor Invoice Management for SAP® Solutions (VIM). For more information, see
OpenText Vendor Invoice Management for SAP Solutions - Installation Guide
(VIM070500-06-IGD) and OpenText Vendor Invoice Management for SAP Solutions -
Configuration Guide (VIM070500-06-CGD). On VIM side, Fiori-based applications are
available for Approval, DP Exceptions, and simple coding.

Business Center Foundation


Import
• Enter incoming electronic documents, for example from email, PDF, fax, or the
OpenText Trading Grid.

10 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
Capture
• Scan and archive incoming paper document.
• OpenText Business Center Capture for SAP Solutions
Automate the capture of paper documents by using OCR to extract document
data. Similar to OpenText™ Invoice Capture Center for SAP® Solutions (ICC).

Dispatch
• Assign incoming documents to the correct target process.
• Classify documents according to the document type.

Process
• Process workflows for documents or objects in a configurable workflow engine.
• Ensure that documents are at the right user at the right time.

Consume
• Browse business objects in the Business Center Workplace in different working
queues.
• Use the Business Center Workplace to access and process workflows.
• Optionally, use the SAP Fiori Task App to access and approve workflows
directly from mobile devices or from the desktop.

SAP Layer
• SAP Business Workflow
• SAP Transactions
• SAP Business Objects
• SAP ArchiveLink
• SAP Fiori
• SAP Gateway

OpenText solutions related to Business Center


OpenText™ Imaging Enterprise Scan
Enterprise Scan is the solution for mass scanning and indexing of documents at
one or more scan stations.
OpenText™ Imaging Web Viewer, OpenText™ Brava!™ View for SAP Solutions
(Brava! View)
Web Viewer is a web application for displaying and printing documents in web-
based scenarios and for appending comments to these documents.
Brava! View is a web application for displaying, exporting and printing
documents as well as for annotating and appending comments to these

OpenText Business Center for SAP Solutions – Configuration Guide 11


BOCP160002-CGD-EN-01
Chapter 1 What is Business Center?

documents stored in OpenText™ Archive Center. Brava! View supersedes Web


Viewer in all scenarios built on top of OpenText™ Archiving and Document
Access for SAP Solutions. The feature parity between Brava! View and Web
Viewer is not accomplished yet. Therefore, Brava! View provides many usability
enhancements compared to Web Viewer like multi-page view or responsive UI.

OpenText Vendor Invoice Management (VIM), OpenText Invoice Capture Center


(ICC)
VIM is a packaged business solution that basically solves a business problem –
paying correct amount to vendors on-time. VIM is an add-on to your SAP ERP
system, the majority of its functions and processes run inside the SAP ERP
system.
As an option for VIM, ICC extends VIM’s capabilities to automate the capture of
machine-printed paper invoices.
VIM can be integrated into Business Center as a “Vendor Invoices” solution
integration.

OpenText™ Archive Center


Archive Center provides a full set of services for content and documents.
You can archive documents that will be processed with Business Center safely
and reliably on Archive Center.

OpenText™ Extended ECM for SAP® Solutions


Extended ECM for SAP Solutions is a combination of a OpenText™ Content
Server module and an SAP package, with which you can integrate Content
Server functionality into SAP business processes.
Extended ECM for SAP Solutions can be integrated in Business Center as a plug-
in. In SAP GUI, Business Center provides a pre-configured plug-in. The Fiori
Task App provides an Extended ECM view that can be integrated. For more
information, see OpenText Extended ECM for SAP Solutions - Customizing Guide
(ERLK-CGD).

OpenText™ Archiving and Document Access for SAP Solutions


Archiving and Document Access for SAP Solutions offers a range of options for
integrating SAP documents and other documents in the different SAP
applications, including emails, faxes, images, and informal correspondence.
Besides archiving documents, it allows you to manage, search, display and edit
them.

OpenText™ DocuLink for SAP Solutions


DocuLink is a fully integrated, cross-module application used for a document-
oriented representation of processes executed with SAP applications.
DocuLink can be integrated in Business Center as a plug-in. Business Center
does not provide a pre-configured plug-in.

Technical system landscape


Figure 1-2 shows the technical architecture of Business Center. For a detailed
description of the components, see “Customizing Business Center” on page 17.

12 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
“System landscape” on page 184 provides another landscape diagram, including the
particular components and their prerequisites and dependencies.

Figure 1-2: Technical architecture

OpenText Business Center for SAP Solutions – Configuration Guide 13


BOCP160002-CGD-EN-01
Chapter 2
About this document

This document describes the configuration of Business Center. It also describes the
various implementation aspects of configuring Business Center to suit the specific
business requirements for any organization. Business Center is designed to be highly
configurable to accommodate varied business scenarios.

Note: This is the documentation for Business Center 16 Update 2.

When it comes to the ABAP add-on modules of Business Center, the version
number is represented as Business Center 16 Support Package 2 (SP2). This tag
is used throughout this technical documentation.

The configuration covers the following components:


• “General settings“ on page 19
• “Inbound Configuration“ on page 47
• “Process Foundation“ on page 95
• “Process Configuration“ on page 107
• “Workplace Configuration“ on page 145
• “Fiori Task App“ on page 183
• “Fiori Task App running scenarios“ on page 277
• “Accessing archived documents using a proxy service“ on page 285
• “Useful methods“ on page 287
• “Document classification“ on page 289

In a separate part, this document also describes the necessary administration tasks of
Business Center:
• “Security topics“ on page 297
• “Batch jobs for Inbound Configuration“ on page 299
• “License audit“ on page 305
• “High availability“ on page 309
• “Regular administration tasks“ on page 311
• “Administering workflows“ on page 317
• “Troubleshooting“ on page 323
• “Customer Support“ on page 327

OpenText Business Center for SAP Solutions – Configuration Guide 15


BOCP160002-CGD-EN-01
Chapter 2 About this document

2.1 Target audience


This document addresses those who participate in the customization and
implementation of Business Center. This includes:
• SAP Basis Administrators
• SAP Workflow Administrators
• SAP Configuration and Development Support

2.2 Further information sources


The product documentation of Business Center comprises the following guides:
• OpenText Business Center for SAP Solutions - Installation Guide (BOCP160002-IGD)
• OpenText Business Center for SAP Solutions - Configuration Guide (BOCP-CGD) (this
guide)
• OpenText Business Center for SAP Solutions - User Guide (BOCP160002-UGD)

Business Center Capture provides the following guides:


• OpenText Business Center Capture for SAP Solutions - Administration Guide (CPBC-
AGD)
• OpenText Business Center Capture for SAP Solutions - Customization Guide (CPBC-
CGD)
• OpenText Business Center Capture for SAP Solutions - User Guide (CPBC-UGD)

For the particular Solution Accelerators, guides are available on OpenText My


Support.

16 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
Part 2
Customizing Business Center
Part 2 Customizing Business Center

Business Center 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.

Customizing Business Center covers the following components:


• “General settings“ on page 19
• “Inbound Configuration“ on page 47
• “Process Foundation“ on page 95
• “Process Configuration“ on page 107
• “Workplace Configuration“ on page 145
• “Fiori Task App“ on page 183
• “Fiori Task App running scenarios“ on page 277
• “Accessing archived documents using a proxy service“ on page 285
• “Useful methods“ on page 287
• “Document classification“ on page 289

18 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
Chapter 3

General settings

The general settings are global settings, which are used in different areas of Business
Center. 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 and navigate to OpenText Business


Center for SAP Solutions > General Settings > General Settings.

2. 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.

OpenText Business Center for SAP Solutions – Configuration Guide 19


BOCP160002-CGD-EN-01
Chapter 3 General settings

Logo is displayed in Workplace and Index Screen


Enter X to display the logo in Business Center 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 Business Center 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 285.

3.1.1 Configuring locking


Business Center has a general locking mechanism for SAP GUI transactions and the
Fiori Task App. This locking mechanism works comprehensively and independently
of solution accelerators.

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 188.

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.

To change the lock validity:

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


Center for SAP Solutions > General Settings > General Settings.
2. 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

20 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
3.1. Configuring general settings

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
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.

OpenText Business Center for SAP Solutions – Configuration Guide 21


BOCP160002-CGD-EN-01
Chapter 3 General settings

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
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.

22 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
3.2. Configuring logical systems

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

3.2 Configuring logical systems


Business Center enables a multiple-system access. The Business Center 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.

On each system running Business Center, an entry with LOCAL as logical system
must exist. For this entry, no RFC destination must be maintained.

To configure logical systems:

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


Center for SAP Solutions > General Settings > Logical Systems.

2. 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.

OpenText Business Center for SAP Solutions – Configuration Guide 23


BOCP160002-CGD-EN-01
Chapter 3 General settings

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.

3.3 Configuring plug-in integration


Different end-user screens (Business Center 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

Business Center 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

24 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
3.3. Configuring plug-in integration

Business Center 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

Business Center 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 Business


Center 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 27) 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

3.3.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 Business


Center for SAP Solutions > 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.

OpenText Business Center for SAP Solutions – Configuration Guide 25


BOCP160002-CGD-EN-01
Chapter 3 General settings

3.3.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 Business


Center for SAP Solutions > 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 26.

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.

26 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
3.3. Configuring plug-in integration

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
PC_TOOLTIP Changing Button tooltip

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


data context.

3.3.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 Business


Center for SAP Solutions > 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:

OpenText Business Center for SAP Solutions – Configuration Guide 27


BOCP160002-CGD-EN-01
Chapter 3 General settings

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.

3.3.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 and navigate to OpenText Business


Center for SAP Solutions > General Settings > Processing Plug-In
Configuration > Assign Plug-In IDs to Business Object.

2. 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.

28 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
3.4. Configuring logging

3.4 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 of Business Center 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 for Business Center 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
• /OTX/PFRM: Extended ECM Integration logs component OTBCRM
• /OTX/PF61: Web Services - Interface logs component OTBCFND / OTBCBAS /
OTBCWSR / OTBCWUI

3.4.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 and navigate to OpenText Business


Center for SAP Solutions > General Settings > Logging > Log Levels.
2. 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

OpenText Business Center for SAP Solutions – Configuration Guide 29


BOCP160002-CGD-EN-01
Chapter 3 General settings

• important

• medium

• Additional information

• Other

3.4.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 29.

To configure log points:

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


Center for SAP Solutions > General Settings > Logging > Log Points.

2. 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)

30 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
3.5. Configuring Analytics

• very important
• important

• medium

• Additional information

• Other

3.5 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 Business Center 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 Business Center 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”. 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. The Analytics database tables comprise prepared
data and several calculated key figures, for example the total duration of the process
and the number of touches per document in case of finished documents. 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 database schema of the Analytics layer for finished documents.
• It describes the available characteristics and key figures of the Analytics database
layer.

OpenText Business Center for SAP Solutions – Configuration Guide 31


BOCP160002-CGD-EN-01
Chapter 3 General settings

3.5.1 Introduction: Analytics Database Schema for finished


documents
Regarding analytic evaluations on finished documents, different requirements may
exist. Finished documents are documents whose process is finished. By
configuration, you can activate Analytics database tables for finished documents.
For more information, see “Configuring the Analytics profile” on page 38. 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 on finished documents.

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


the most important database tables that are available for analytic evaluations on
finished documents.

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
Business Center 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 presses the Edit button in
the Fiori Task App. It ends as soon as the end user leaves the Edit mode, for
example by pressing 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.

32 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
3.5. Configuring Analytics

3.5.2 Available characteristics and key figures for finished


documents
The previous sections describe the basics of the Analytics database layer. Currently,
no UI is provided to display this information. However, a lot of possible tools for
that purpose are available. The target of this section is to provide an overview of the
available data that you can use for the purpose of Analytics, together with 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.

Recognize that the following list can provide only some examples and a slight idea
about what evaluations are possible. A lot more evaluations are possible with the
existing key figures.

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

For better clarity, the examples are grouped by the underlying database table

3.5.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, …

OpenText Business Center for SAP Solutions – Configuration Guide 33


BOCP160002-CGD-EN-01
Chapter 3 General settings

Name of Characteristic Example for usage


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,
END_MONTH, …

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)

Table 3-3: Key Figures - Timings

Name of Key Figure Example for usage


PROC_DURATION_D, Document Cycle Time (Total process time from start in
PROC_DURATION_S Business Center to end)
PROC_DURATION_D, Document Cycle Time when rules failed (Total process time
PROC_DURATION_S, when rules failed)
NO_MOD_FAILED

34 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
3.5. Configuring Analytics

Name of Key Figure Example for usage


ACV_DURATION_M, Document Processing Time (Summarized manual
ACV_DURATION_S processing time)

Note: The manual processing time cannot be


determined if the dialog step is not finished properly.

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.5.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

OpenText Business Center for SAP Solutions – Configuration Guide 35


BOCP160002-CGD-EN-01
Chapter 3 General settings

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_D, Average time it took until users processed the document
WAIT_TIME_S
ACV_DURATION_M, Breakdown between wait time and work time by role
ACV_DURATION_S,
WAIT_TIME_D,
WAIT_TIME_S

3.5.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.

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

36 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
3.5. Configuring Analytics

Name of Characteristic Example for usage


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.5.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.

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’

OpenText Business Center for SAP Solutions – Configuration Guide 37


BOCP160002-CGD-EN-01
Chapter 3 General settings

3.5.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

3.5.3 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 39
• “Learning about data levels” on page 39
• “Defining profiles” on page 40
• “Maintaining data tables” on page 40
• “Assigning the Analytics profile to the Process Configuration profile”
on page 43

38 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
3.5. Configuring Analytics

3.5.3.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 finished
documents. (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 and navigate to General Settings >


Analytics Configuration > Analytics Configuration.

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


Profile Type 1 (Process KPIs to finished documents) is used for writing
Analytics data for finished documents.

3.5.3.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 and navigate to General Settings >


Analytics Configuration > Analytics Configuration.

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

3. In the Levels Overview screen, watch the different levels of Analytics data.
The following hierarchy levels for profile type 1 (Process KPIs to finished
documents) 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.

OpenText Business Center for SAP Solutions – Configuration Guide 39


BOCP160002-CGD-EN-01
Chapter 3 General settings

3.5.3.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 and navigate to General Settings >


Analytics Configuration > Analytics Configuration.

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

3. 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 43.

3.5.3.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-11: Mandatory key fields for the Analytics header tables

Field Name Data Element


MANDT MANDT
LOGSYS LOGSYS

40 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
3.5. Configuring Analytics

Field Name Data Element


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-12: 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.

OpenText Business Center for SAP Solutions – Configuration Guide 41


BOCP160002-CGD-EN-01
Chapter 3 General settings

Table 3-13: 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.

To maintain data tables:

1. In the Profiles Overview screen (see “Defining profiles” on page 40), select a
profile and 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 39.

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

42 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
3.5. Configuring Analytics

3.5.3.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 to
finished documents.

You have maintained Analytics profiles with profile type 1 (Process KPIs to
finished documents). 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 109.

3.5.4 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 40. 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 to finished documents


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 on finished documents and saves the data to the database.

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 40. 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 40. If no database table is
maintained in the configuration, set the name of a default database table.

OpenText Business Center for SAP Solutions – Configuration Guide 43


BOCP160002-CGD-EN-01
Chapter 3 General settings

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 40. 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

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
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

44 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
3.5. Configuring Analytics

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

OpenText Business Center for SAP Solutions – Configuration Guide 45


BOCP160002-CGD-EN-01
Chapter 4
Inbound Configuration

This chapter provides details about the Inbound Configuration. It is part of the
Business Center 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 scenario classification. Scenario


classification registers documents for further processing in Business Center
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 Business Center Inbound that
offers the functionality.

For Inbound Configuration, you define the following:


• Channels 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 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.

OpenText Business Center for SAP Solutions – Configuration Guide 47


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

• Registration types 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 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 automates the capture of paper documents by using
OCR to extract data. Business Center Capture uses 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 7-1, “Authorizations necessary to monitor the Inbound
Configuration” on page 180.

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 and navigate to OpenText Business Center


for SAP Solutions > Inbound Configuration > Basic Settings.

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

ArchiveID for XML


This parameter is mandatory. 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.

Capture Reject Code


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

48 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.1. Customizing basic settings for Inbound Configuration

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)


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


Enter the exit function module to sort documents for extraction. By default,
sorting is done by registration key. 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.

Exit Validation Sorting


Enter the exit function module to sort documents for validation. By default,
sorting is done by registration key. 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.

Retry Counter 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.

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 90.

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 90.

OpenText Business Center for SAP Solutions – Configuration Guide 49


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

Auto-Forward Extraction Retry


You might want to forward the document automatically to the target
application when the extraction retry counter is reached.
In this case, set this value to X. The document is not set to error status within
inbound processing.

Auto-Forward Validation Retry


You might want to forward the document automatically to the target
application when the extraction retry counter is reached.
In this case, set this value to X. The document is not set to error status within
inbound processing.

Limit for Counting Documents in Validation


Enter the maximum number of documents to be retrieved in the validation
client. The limit provides a performance optimization within the validation
client.

HTTP Connection for OCR Service


Intended for future use.

HTTP Callback URL


Intended for future use.

HTTP Repository URL


Intended for future use.

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 56. You can use the channel in solution accelerators to
identify how documents have been imported into the system.

To configure channels:

1. Run the /OTX/PF00_IMG transaction and navigate to OpenText Business Center


for SAP Solutions > Inbound Configuration > Channels.

2. 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 56.

50 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.3. Creating scenario classifications

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 56.

To create a scenario classification:

1. Run the /OTX/PF00_IMG transaction and navigate to OpenText Business Center


for SAP Solutions > Inbound Configuration > Scenario Classification.
2. In the Scenario Classification Overview screen, configure the scenario
classification, using the following parameters:

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 95).
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 105.
Exit Application
Enter the exit function (see template function /OTX/PF01_UTIL_EXIT_APPL)
to start any business application used for the Custom Processing trigger.

OpenText Business Center for SAP Solutions – Configuration Guide 51


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

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 289,
especially “Processing impacts” on page 292.

To assign document types to classifications:

1. Run the /OTX/PF00_IMG transaction and navigate to OpenText Business Center


for SAP Solutions > Inbound Configuration > Scenario Classification.

2. In the Scenario Classification Overview screen, mark a scenario classification


and double-click Classification Document Types in the Dialog Structure.

3. 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

52 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.4. Customizing incoming documents through the document handler

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 “Document handler” on page 299.

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.

In Business Center Capture, for example, the status helps 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.

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.

OpenText Business Center for SAP Solutions – Configuration Guide 53


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

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
Business Center 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
Business Center” on page 17.

To configure the document handler status:

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


Center for SAP Solutions > Inbound Configuration > Document Handler >
Status.

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


parameters:

Status
Enter a unique status number.

Description
Enter a meaningful description.

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 the Business
Center Capture.

To create a document handler:

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


Center for SAP Solutions > Inbound Configuration > Document Handler >
Modules.

2. 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.

54 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.4. Customizing incoming documents through the document handler

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 an exit class that implements the /OTX/PF01_IF_HANDLER
interface. The EXIT_HANDLER_END method allows you to trigger own logic at
the end of the handler processing after the target application is started or in
error case.

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 and navigate to OpenText Business


Center for SAP Solutions > Inbound Configuration > Document Handler >
Modules.

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

3. 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.

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:

OpenText Business Center for SAP Solutions – Configuration Guide 55


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

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.
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.

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
interface. You can use the custom registration type to configure and access
specific settings.

56 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.4. Customizing incoming documents through the document handler

Registration There are possible methods for a custom implementation in the /OTX/
Class PF01_IF_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.

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.

OpenText Business Center for SAP Solutions – Configuration Guide 57


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

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 9.2 “Maintaining
HTTP content repository in the SAP application” 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

58 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.4. Customizing incoming documents through the document handler

• Transfer drctry (Transfer directory)

4. Click .

4.4.2.1.3 Creating the presetting folder for Business Center

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 for Business Center:

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 60.

OpenText Business Center for SAP Solutions – Configuration Guide 59


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

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 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 for Business Center” on page 59. 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 click Continue.

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

60 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.4. Customizing incoming documents through the document handler

5. Object, method and tasks


Enter the following information:

Obj. type
/OTX/PF01REG

Entry

Task
WS00297300

Click Continue.

6. In the Workflow Parameter screen, click Continue.

OpenText Business Center for SAP Solutions – Configuration Guide 61


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

7. Storage system and link table


Click Continue.

62 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.4. Customizing incoming documents through the document handler

8. Selection from available presettings


Select the ID of the delivered presetting folder (available in the Business Center
Foundation BC set) and click Continue.
9. In the Create new presettings screen, click Continue.
10. Details of presettings
Select the Storing for subsequent entry check box and 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.

OpenText Business Center for SAP Solutions – Configuration Guide 63


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

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 58.

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 Accelerator Guides (for
example Sales Order with the related Business Objects for Sales Orders).

64 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.4. Customizing incoming documents through the document handler

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 and navigate to OpenText Business


Center for SAP Solutions > Inbound Configuration > Document Handler >
Registration > Early Archiving.

2. 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 50.

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 53.

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

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.

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.

OpenText Business Center for SAP Solutions – Configuration Guide 65


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

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, for example http://help.sap.de/saphelp_46c/helpdata/en/0b/
2a60ef507d11d18ee90000e8366fc2/content.htm.

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 .

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:

66 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.4. Customizing incoming documents through the document handler

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 .

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 .

OpenText Business Center for SAP Solutions – Configuration Guide 67


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

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.

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.

68 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.4. Customizing incoming documents through the document handler

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 .

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.

OpenText Business Center for SAP Solutions – Configuration Guide 69


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

Partner No.
ID of the partner profile
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 67.
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 and navigate to OpenText Business


Center for SAP Solutions > Inbound Configuration > Document Handler >
Registration > Inbound IDoc.
2. In the Registration IDoc Details screen, configure the registration, using the
following parameters.

70 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.4. Customizing incoming documents through the document handler

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) (http://help.sap.com/
saphelp_46c/helpdata/en/72/c18ee5546a11d182cc0000e829fbfe/content.htm?
current_toc=/en/dc/6b8a4943d711d1893e0000e8323c4f/plain.htm&
show_children=true).

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

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 53.

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

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
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.

OpenText Business Center for SAP Solutions – Configuration Guide 71


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

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 98.

To configure the IDoc mapping:

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


Center for SAP Solutions > Inbound Configuration > Document Handler >
Registration > Inbound IDoc.
2. In the Registration IDoc Details screen, double-click IDoc Mapping in the
Dialog Structure. In the IDoc Mapping Overview screen, double-click an entry.
3. In the IDoc Mapping Details screen, configure the IDoc mapping, 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) (http://help.sap.com/
saphelp_46c/helpdata/en/72/c18ee5546a11d182cc0000e829fbfe/content.htm?
current_toc=/en/dc/6b8a4943d711d1893e0000e8323c4f/plain.htm&
show_children=true).
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)

72 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.4. Customizing incoming documents through the document handler

• 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.

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 98.

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) (http://help.sap.com/
saphelp_46c/helpdata/en/72/c18ee5546a11d182cc0000e829fbfe/content.htm?
current_toc=/en/dc/6b8a4943d711d1893e0000e8323c4f/plain.htm&
show_children=true).

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.

OpenText Business Center for SAP Solutions – Configuration Guide 73


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

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.

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.

74 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.4. Customizing incoming documents through the document handler

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.

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.

OpenText Business Center for SAP Solutions – Configuration Guide 75


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

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.

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 75. If you have only created one client and therefore have not
specified this parameter type, enter 0.

76 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.4. Customizing incoming documents through the document handler

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.

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.

OpenText Business Center for SAP Solutions – Configuration Guide 77


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

• 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 (http://
help.sap.com/saphelp_nw70/helpdata/en/af/73563c1e734f0fe10000000a114084/
content.htm).

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: http://help.sap.com/saphelp_nw70/helpdata/
en/af/73563c1e734f0fe10000000a114084/content.htm.

78 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.4. Customizing incoming documents through the document handler

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 customize the inbound email registration:

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


Center for SAP Solutions > Inbound Configuration > Document Handler >
Registration > Incoming Mail.

2. 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 77.

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

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 53.

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

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
in the OAC2 transaction. To archive any document, you must implement the
Pre Exit Registration.

OpenText Business Center for SAP Solutions – Configuration Guide 79


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

Attach Body
Select this check box to archive the email body. The email body is archived
according to the format configured in the SAPConnect interface (text/html
mail).
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.

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 143.

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:

80 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.4. Customizing incoming documents through the document handler

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 98. 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 98.

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 and navigate to OpenText Business


Center for SAP Solutions > Inbound Configuration > Document Handler >
Registration > Pipeline.

2. 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 50.

Handler
Enter the ID of the document handler that represents the processing steps of
the service modules for this document. For more information, see

OpenText Business Center for SAP Solutions – Configuration Guide 81


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

“Customizing incoming documents through the document handler”


on page 53.

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

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.

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 and navigate to OpenText Business


Center for SAP Solutions > Inbound Configuration > Document Handler >
Registration > Custom / Others.

2. 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 50.

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 53.

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

82 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.5. Customizing Business Center Capture

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.

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 Customizing Business Center Capture


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

The OCR solution OpenText Business Center Capture for SAP Solutions (Business
Center Capture) can be integrated into Business Center. 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

OpenText Business Center for SAP Solutions – Configuration Guide 83


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

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.
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 3 on page 84 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:

84 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.5. Customizing Business Center Capture

• 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 4 on page 84. 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.


• 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.

OpenText Business Center for SAP Solutions – Configuration Guide 85


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

4.5.1 Checking archive settings for XML documents


The component type for the XML document that is created by the BCC 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.

4.5.2 Customizing validation


The validation framework determines whether a document that is created by BCC
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 document created by BCC.

4.5.2.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 and navigate to OpenText Business


Center for SAP Solutions > Inbound Configuration > Business Center
Capture > Validation.
2. In the Capture - Validation Overview screen, configure general validation
settings, using the following parameters.

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 87.
Validation / Agent Determination
Use this function to control when the validation is run, and also to
determine the validator. Use template function /OTX/
PF01_UTIL_EXIT_VAL_DETERM to create a custom logic.

86 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.5. Customizing Business Center Capture

4.5.2.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 and navigate to OpenText Business


Center for SAP Solutions > Inbound Configuration > Business Center
Capture > Validation.

2. In the Capture - Validation Overview screen, mark an entry and double-click


Capture - Validation Check Fields in the Dialog Structure.

3. In the Capture - Validation Check Fields Overview screen, configure check


fields, using the following parameters.

Step ID
Field counter

Field Name
External field name

Note: You must configure the field name in the same way as it is
delivered (case-sensitive).

4.5.2.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 57.

To assign the ArchiveLink document type to the validation ID:

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


Center for SAP Solutions > Inbound Configuration > Business Center
Capture > Validation Assignment.

2. 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 86.

OpenText Business Center for SAP Solutions – Configuration Guide 87


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

4.5.2.4 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.

To assign an agent to an ArchiveLink document type:

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


Center for SAP Solutions > Inbound Configuration > Business Center
Capture > Validation Assignment.

2. In the Capture - Validation DocType Assignment Overview screen, mark an


entry and double-click Capture - Validation Agent Assignment in the Dialog
Structure.

3. 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:

• 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 143.

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.

88 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.5. Customizing Business Center Capture

4.5.3 Customizing feedback


Business Center 16 SP1 introduces the feedback function for BCC. After the inbound
process has been finished, the Business Center process framework returns the
maintained values of a process as a feedback to BCC. BCC then can use the final
values as input for learning.

To activate feedback for BCC:

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


Center for SAP Solutions > Inbound Configuration > Business Center
Capture > Feedback.

2. 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
In the list, click true or false.

The first time BCC extracts a document of a new document type, the
customizing entry for this document type is automatically created, with Active
set to true.

4.5.4 Creating reject reasons


In the BCC validation client, 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 and navigate to OpenText Business


Center for SAP Solutions > Inbound Configuration > Business Center
Capture > Reject Reasons.

2. 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.

OpenText Business Center for SAP Solutions – Configuration Guide 89


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

4.5.5 Customizing look-ups


You customize look-ups to provide the following features in the BCC application:

• Searching for any related SAP information in the validation client


• Enabling the access and download of master data to the BCC database

In Business Center, 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 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

For more information, see “Staging tables for the BCC integration” on page 300.

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 93

To create a look-up:

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


Center for SAP Solutions > Inbound Configuration > Business Center
Capture > Look-up.

2. 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.

90 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.5. Customizing Business Center Capture

Data selection fields


Enter the structure of the fields. These fields are used within the mapping.
They assign the external field name of BCC 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 93.

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.

Handler Class - The following methods are possible for a custom


implementation in the /OTX/PF01_IF_LOOKUP interface.

Note: The parameter naming in Business Center 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 processed from Business
Center application 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

OpenText Business Center for SAP Solutions – Configuration Guide 91


BOCP160002-CGD-EN-01
Chapter 4 Inbound Configuration

Parameter Parameter type Description


PET_RETURN Exporting Return messages
PE_RC Exporting Return error code

LOOKUP_DOWNLOAD_INIT
The LOOKUP_DOWNLOAD_INIT method initializes the download processed
from Business Center application to download data.
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
processed from Business Center application to download data.
This method is used in the BCC API function /OTX/
PF01_IF_LOOKUP_COMPLETE.

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
Business Center Capture validation client.
This method is used in the BCC 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
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

92 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
4.5. Customizing Business Center Capture

To map a look-up field:

1. Run the /OTX/PF00_IMG transaction and navigate to OpenText Business Center


for SAP Solutions > Inbound Configuration > Business Center Capture >
Look-up.

2. In the Look-up Overview screen, mark an entry and double-click Look-up


Fields in the Dialog Structure.

3. 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 application

Field Name
Enter the name of the SAP field of the configured structure. For more
information, see Data selection fields on page 91

Case sensitivity
Select Case-sensitive or Case-invariant from the list.
BCC 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.

OpenText Business Center for SAP Solutions – Configuration Guide 93


BOCP160002-CGD-EN-01
Chapter 5

Process Foundation

This chapter provides details about the Business Center Foundation part 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.

OpenText Business Center for SAP Solutions – Configuration Guide 95


BOCP160002-CGD-EN-01
Chapter 5 Process Foundation

Important
The Process Foundation is reserved for internal use only. Any custom
configurations beside the activities described in this document are not
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
As a prerequisite, the SAP Business Workflow engine must be configured to
run processes based on Process Foundation. Additionally, the following
tasks must be maintained as general tasks in the PFTC transaction:

• Workflow Template 00297300


• Workflow Template 00297330
• Standard Task 00297316
• Standard Task 00297303

The Process Foundation allows controlling running workflow instances from


external applications using some special event type linkages, which must be
maintained in the SWETYPV transaction:

Object Business Object Type


Category
Object Type /OTX/PF04E
Event FINISH_PROCESS
Receiver Type /OTX/PF04
Receiver Call Function Module

96 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
5.1. Basic Settings

Receiver /OTX/PF02_EVENT_RECEIVER
Function
Module

Object Business Object Type


Category
Object Type /OTX/PF04E
Event RUN_ASSIGNMENT
Receiver Type /OTX/PF04
Receiver Call Function Module
Receiver /OTX/PF02_EVENT_RECEIVER
Function
Module

5.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 and navigate to Process Foundation >


Basic Settings.

2. 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
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 105.

OpenText Business Center for SAP Solutions – Configuration Guide 97


BOCP160002-CGD-EN-01
Chapter 5 Process Foundation

5.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.

5.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 and navigate to Process Foundation >


Data Model.

2. 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.

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.

98 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
5.2. Data model configuration

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.

5.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 5-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 5-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

To define levels:

1. In the Data Model Configuration Overview screen (see “Defining a data


model” on page 98), mark an entry and 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)

OpenText Business Center for SAP Solutions – Configuration Guide 99


BOCP160002-CGD-EN-01
Chapter 5 Process Foundation

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.

5.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 99), mark an entry
and 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.

100 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
5.2. Data model configuration

Key is self-managed by the requester


The key field value is managed by custom logic and already provided
when inserting values.

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 Solution Accelerators).

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 5-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.

OpenText Business Center for SAP Solutions – Configuration Guide 101


BOCP160002-CGD-EN-01
Chapter 5 Process Foundation

5.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 intermediately to the relevant business process ledger
header and item table.

1. In the Data Model Configuration Overview screen (see “Defining a data


model” on page 98), mark an entry and 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

102 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
5.2. Data model configuration

Parameter Parameter type Description


PI_UPDATE Importing Flag to indicate that update on database
table is done
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 99)
PI_CURRENCY Importing Currency to map currency fields
PET_RETURN Exporting Return parameters in error case
PET_INTDATA Exporting Mapping result

5.2.5 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 External Data Mapping Overview screen (see “Defining external data
mapping” on page 102), mark an entry and double-click Field Mapping in the
Dialog Structure.

2. In the Field Mapping Overview screen, maintain the field mapping, using the
following parameters.

OpenText Business Center for SAP Solutions – Configuration Guide 103


BOCP160002-CGD-EN-01
Chapter 5 Process Foundation

Data Hierarchy Level


Definition of the hierarchy level to which a data table belongs. The
hierarchy level identifies the corresponding target table (see “Defining
levels” on page 99).
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.

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.
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 105).
System variable
A system variable is assigned to the target field. The value is configured
in the Value field (see Value on page 105).
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.

104 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
5.3. Process Foundation profile

Condense
Select this check box to condense the value.

Value
For field mapping type constant or system variable, assign the related
value.

5.2.6 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 102).

To assign the mapping channel:

1. In the Data Model Configuration Overview screen (see “Defining a data


model” on page 98), mark an entry and 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 50).

Mapping ID
Enter the unique technical ID which identifies the mapping scenario.

5.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.

To generate a Process Foundation profile:

1. Run the /n/OTX/PF00_IMG transaction and navigate to Process Foundation >


Generate Profiles.

Note: To run this activity, authorization for J_6NPF_ADM is needed. For


more information, see “Authorization objects” on page 180.

2. 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 available in the basic settings
of the Process Foundation. To change this parameter, run the /n/OTX/
PF00_IMG transaction and navigate to Process Foundation > Basic

OpenText Business Center for SAP Solutions – Configuration Guide 105


BOCP160002-CGD-EN-01
Chapter 5 Process Foundation

Settings. When leaving the parameter value empty, you can freely choose
any existing Process Foundation profile as a template for the generation of
a new profile.

To add generated profiles to a transport request:

1. Run the /n/OTX/PF00_IMG transaction and navigate to Process Foundation >


Profiles.

2. 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.

5.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 and navigate to Process Foundation >


Profiles.

2. 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.

106 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
Chapter 6
Process Configuration

This chapter provides details about the Business Center Foundation part 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

6.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.

OpenText Business Center for SAP Solutions – Configuration Guide 107


BOCP160002-CGD-EN-01
Chapter 6 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 108


• “Defining a profile version” on page 109
• “Defining actions” on page 118
• “Defining roles” on page 126
• “Configuring characteristics” on page 128
• “Maintaining process steps” on page 129

6.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 and navigate to Process Configuration >


Profiles.

2. 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.

You might want to copy an existing profile and all its dependent settings to a
completely different profile name. In this case, run the /n/OTX/PF00_IMG transaction
and navigate to Process Configuration > Copy Profiles.

Note: To run this activity, authorization for J_6NPF_ADM is needed. For more
information, see “Authorization objects” on page 180.

The copied version will always start with a first profile version again, independent
from the current version counter currently used by the copied profile.

108 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
6.1. Profile configuration

6.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 and navigate to Process Configuration >


Profiles.

2. In the Profile Configuration Overview screen, mark an entry and double-click


Version Definition.

3. In the Version Definition Details screen, define the version using the following
parameter.

Version
Next higher version counter

If you want to generate a new version for an existing profile by reusing all already
available settings (to be changed or enhanced afterwards), run the /n/OTX/
PF00_IMG transaction and navigate to Process Configuration > Create Profile
Versions.

Note: To run this activity, authorization for J_6NPF_ADM is needed. For more
information, see “Authorization objects” on page 180.

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.

6.1.2.1 Maintaining version settings


To maintain version settings:

• In the Version Definition Details screen (see “Defining a profile version”


on page 109), 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.

OpenText Business Center for SAP Solutions – Configuration Guide 109


BOCP160002-CGD-EN-01
Chapter 6 Process Configuration

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 method is 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.

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.
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.

110 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
6.1. 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
to finished documents if you want to trigger the update of Analytics
database tables designed for evaluations on finished documents. For details
how to maintain an Analytics profile, see “Configuring Analytics”
on page 31.

6.1.2.2 Maintaining characteristic settings


To maintain characteristic settings:

• In the Version Definition Details screen (see “Defining a profile version”


on page 109), 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.

6.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:

OpenText Business Center for SAP Solutions – Configuration Guide 111


BOCP160002-CGD-EN-01
Chapter 6 Process Configuration

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
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 118. 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 24.

112 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
6.1. Profile configuration

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 109), 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.

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.

OpenText Business Center for SAP Solutions – Configuration Guide 113


BOCP160002-CGD-EN-01
Chapter 6 Process Configuration

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.

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.

114 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
6.1. Profile configuration

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.

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.

OpenText Business Center for SAP Solutions – Configuration Guide 115


BOCP160002-CGD-EN-01
Chapter 6 Process Configuration

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.
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.

116 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
6.1. Profile configuration

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.

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.

OpenText Business Center for SAP Solutions – Configuration Guide 117


BOCP160002-CGD-EN-01
Chapter 6 Process Configuration

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.

6.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 109), 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.
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.

118 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
6.1. Profile configuration

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_ACTIO
N_ACTIVATE
FRM_HIST_BYPASS Bypass Rule History /OTX/
Action PF41_CL_ACTIO
N_BYPASS
FRM_WP_REASSIGN Reassign Referral /OTX/
Action PF41_CL_ACTIO
N_ASSIGN_EXT
FRM_WP_CLASSI Reclassify Dialog /OTX/
Action PF41_CL_ACTIO
N_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.

OpenText Business Center for SAP Solutions – Configuration Guide 119


BOCP160002-CGD-EN-01
Chapter 6 Process Configuration

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.
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.

120 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
6.1. Profile configuration

Parameter Parameter type Description


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.
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

OpenText Business Center for SAP Solutions – Configuration Guide 121


BOCP160002-CGD-EN-01
Chapter 6 Process Configuration

Parameter Parameter type Description


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
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.
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

122 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
6.1. Profile configuration

Parameter Parameter type Description


PIT_PLI Importing Process ledger item data
that can be used but not
changed by the action
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.

OpenText Business Center for SAP Solutions – Configuration Guide 123


BOCP160002-CGD-EN-01
Chapter 6 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
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.

124 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
6.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
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.

OpenText Business Center for SAP Solutions – Configuration Guide 125


BOCP160002-CGD-EN-01
Chapter 6 Process 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.

Web Icon
Assign a web icon for action visualization in the Fiori 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.

UI 5 Button Type
Select a UI 5 button type from the list. The UI 5 button type controls the
visualization style of action buttons in the Fiori screens.

6.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 109), 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.

126 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
6.1. Profile configuration

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.
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 143.

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.

OpenText Business Center for SAP Solutions – Configuration Guide 127


BOCP160002-CGD-EN-01
Chapter 6 Process Configuration

6.1.5 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 109), 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 111.
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 109.

Note: If no special characteristic configuration is required at all,


configure an empty characteristic value.

Characteristic Description
Enter a meaningful description for the defined characteristic.

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.

128 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
6.1. Profile configuration

6.1.6 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 129
• “Defining business rules” on page 132
• “Assigning process actions” on page 135
• “Maintaining referral settings” on page 137
• “Maintaining simulate settings” on page 139
• “Maintaining bypass rules” on page 139
• “Maintaining field settings” on page 140
• “Maintaining screen settings” on page 141

6.1.6.1 Defining a process step


To define a process step:

1. In the Characteristic Configuration Overview screen (see “Configuring


characteristics” on page 128), mark an entry and 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.

OpenText Business Center for SAP Solutions – Configuration Guide 129


BOCP160002-CGD-EN-01
Chapter 6 Process Configuration

The assignment of a background action ID is mandatory here. See


Action ID on page 131.

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 131.

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.

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.

130 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
6.1. Profile configuration

The following method is 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

Sequence
Define the processing sequence of the process steps within a characteristic
value.

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

OpenText Business Center for SAP Solutions – Configuration Guide 131


BOCP160002-CGD-EN-01
Chapter 6 Process Configuration

6.1.6.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 129), mark an entry and 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.
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.

132 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
6.1. Profile configuration

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
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.

OpenText Business Center for SAP Solutions – Configuration Guide 133


BOCP160002-CGD-EN-01
Chapter 6 Process Configuration

Parameter Parameter type Description


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.
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.

134 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
6.1. Profile configuration

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.

6.1.6.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 129), mark an entry and 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

OpenText Business Center for SAP Solutions – Configuration Guide 135


BOCP160002-CGD-EN-01
Chapter 6 Process Configuration

process node ID will be started next. Similar to the Process Node


Assignment in the process step definition (see Process Node Assignment
on page 130), 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.
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.

136 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
6.1. Profile configuration

Note: The role ID which has been defined as Inquire Role (see
“Maintaining Processing Screen settings” on page 111) 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.

6.1.6.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 129), mark an entry and 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.

OpenText Business Center for SAP Solutions – Configuration Guide 137


BOCP160002-CGD-EN-01
Chapter 6 Process Configuration

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.

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

138 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
6.1. Profile configuration

6.1.6.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 129), mark an entry and double-click Simulate Settings in the Dialog
Structure.

2. In the Simulate Settings Overview screen, maintain simulate settings, using the
following parameters.

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.

6.1.6.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 139), mark an entry and double-click Bypass Rules in the Dialog
Structure.

2. In the Bypass Rules Overview screen, maintain bypass rules, using the
following parameters.

OpenText Business Center for SAP Solutions – Configuration Guide 139


BOCP160002-CGD-EN-01
Chapter 6 Process Configuration

Rule ID
Enter the business rules of the corresponding process step that can be
bypassed if required.
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.

6.1.6.7 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 129), mark an entry and 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.

• 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

140 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
6.1. Profile configuration

• 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.

6.1.6.8 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 129), mark an entry and 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

OpenText Business Center for SAP Solutions – Configuration Guide 141


BOCP160002-CGD-EN-01
Chapter 6 Process Configuration

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.

6.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 and navigate to Process Configuration >


Profile Assignment.

2. 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.

142 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
6.3. Authorizations

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)

6.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

ACTVT
Activity (02 - Change, 03 - Display, 70 - Administer)

OpenText Business Center for SAP Solutions – Configuration Guide 143


BOCP160002-CGD-EN-01
Chapter 7
Workplace Configuration

This chapter provides details about the Business Center Foundation part Business
Center Workplace.

The Business Center 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 24.

OpenText Business Center for SAP Solutions – Configuration Guide 145


BOCP160002-CGD-EN-01
Chapter 7 Workplace Configuration

Areas The following screen areas are available. Together, they form the overall appearance
of the Business Center Workplace screen during runtime:

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 nine different work centers are displayed as navigation


buttons. If a user has authority for more than nine work centers, a drop-
down list will appear.
• 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.

146 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
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 24.

Access To access the Business Center Workplace, run the /n/OTX/PF03_WP transaction. For
a description how to work with the Business Center Workplace as an end user, see
Section 3 “Business Center Workplace” in OpenText Business Center for SAP Solutions
- User Guide (BOCP160002-UGD).

Important
To use Business Center Workplace in a proper way, a minimum screen
resolution of 1600 x 900 is required.

This section provides information how the Business Center Workplace is configured.
This happens in the Workplace Configuration branch of the /n/OTX/PF00_IMG
transaction.

OpenText Business Center for SAP Solutions – Configuration Guide 147


BOCP160002-CGD-EN-01
Chapter 7 Workplace Configuration

7.1 Work object types


A work object type represents a processing object within the Business Center
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.

7.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 and navigate to OpenText Business


Center for SAP Solutions > Workplace Configuration > Work object types >
Work object types.

2. In the Work Object Types Overview screen, double-click a work object type.

3. Define the work object type, using the following parameters:

148 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
7.1. Work object types

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 151.
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 152.

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 155
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 156.
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 159.
Display structure
Enter the display structure to define the fields of the work object.

Important
The display structure must 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.

OpenText Business Center for SAP Solutions – Configuration Guide 149


BOCP160002-CGD-EN-01
Chapter 7 Workplace Configuration

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 161.

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.

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
Business Center 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 24.

Plug-In ID
Enter the plug-in ID that is selected by default.

150 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
7.1. Work object types

7.1.2 Field details in work object type customizing


This section provides details about the fields that are available in work object type
customizing.

7.1.2.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
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
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

OpenText Business Center for SAP Solutions – Configuration Guide 151


BOCP160002-CGD-EN-01
Chapter 7 Workplace Configuration

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.

7.1.2.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 168.

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

152 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
7.1. Work object types

Parameter Parameter type Description


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.

Parameter Parameter type Description


PIT_SEL Importing Selection criteria
PI_LOGSYS Importing Logical system
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

OpenText Business Center for SAP Solutions – Configuration Guide 153


BOCP160002-CGD-EN-01
Chapter 7 Workplace Configuration

Parameter Parameter type Description


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 might


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.
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.

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.

154 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
7.1. Work object types

7.1.2.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

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

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

OpenText Business Center for SAP Solutions – Configuration Guide 155


BOCP160002-CGD-EN-01
Chapter 7 Workplace Configuration

Parameter Parameter type Description


PC_ENTRIES Changing Number of entries

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 Business Center 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

7.1.2.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 workboard main
application will then use this instance.

156 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
7.1. Work object types

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.

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

OpenText Business Center for SAP Solutions – Configuration Guide 157


BOCP160002-CGD-EN-01
Chapter 7 Workplace Configuration

Parameter Parameter Description


type
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 workboard 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.

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 workboard main program. The node is then refreshed with
the new number of hits.

Parameter Description
PI_HITS Number of hits

158 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
7.1. Work object types

7.1.2.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.

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

OpenText Business Center for SAP Solutions – Configuration Guide 159


BOCP160002-CGD-EN-01
Chapter 7 Workplace Configuration

Parameter Parameter type Description


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
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

160 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
7.1. Work object types

7.1.2.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 workboard main program to your
selection screen
• to transfer the selection criteria entered by the user on the selection screen to the
workboard main program

For this communication, the /OTX/PF03_CL_UI_SEL_SCREEN class is used.

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 workboard 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

OpenText Business Center for SAP Solutions – Configuration Guide 161


BOCP160002-CGD-EN-01
Chapter 7 Workplace Configuration

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 workboard 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.

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 workboard main program transfers the
currently used selection criteria to the instance of the /OTX/
PF03_CL_UI_SEL_SCREEN class. The workboard main program also sets the selection
criteria of the current node.

162 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
7.1. Work object types

The workboard 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

Then you raise the SEARCH action using the EXECUTE_USER_ACTION method.

7.1.3 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 and navigate to OpenText Business


Center for SAP Solutions > Workplace Configuration > Work object types >
Work object types.
2. In the Work Object Types Overview screen, mark a work object type and
double-click Actions in the Dialog Structure.

OpenText Business Center for SAP Solutions – Configuration Guide 163


BOCP160002-CGD-EN-01
Chapter 7 Workplace Configuration

3. 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:

• Standard

• Bulk

• Emphasized Bulk: most important bulk actions, with a separate button


in the ALV grid control

Action class
Enter the action class, implementing class interface /OTX/PF03_IF_ACTION.
For more information, see “Interface /OTX/PF03_IF_ACTION” on page 165.

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.

164 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
7.1. Work object types

To define message fields for bulk actions:

1. In the Actions Overview screen, mark an action and 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.

7.1.3.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.

CHANGE_MESSAGE_DISPLAY method
Called before the display of the messages returned in PCT_ACTIONS
(EXECUTE_ACTION method). You can change the display options. Messages are
displayed in an ALV Grid in a dialog box. This dialog box is not displayed for a
success message for a single action.

Parameter Parameter type Description


PIS_WOBJ_TYPE Importing Work object type
PIT_ACTIONS Importing Executed actions with messages
PCT_FCAT Changing Field catalog for the ALV Grid
PCT_DATA Changing Displayed data

OpenText Business Center for SAP Solutions – Configuration Guide 165


BOCP160002-CGD-EN-01
Chapter 7 Workplace Configuration

7.1.4 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 order, 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 and navigate to OpenText Business


Center for SAP Solutions > Workplace Configuration > Work object types >
Work object types.

2. In the Work Object Types Overview screen, mark a work object type and
double-click Functions in the Dialog Structure.

3. 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.

7.1.5 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 and navigate to OpenText Business


Center for SAP Solutions > Workplace Configuration > Work object types >
Work object types.

2. In the Work Object Types Overview screen, mark a work object type and
double-click ALV Grid Field Settings in the Dialog Structure.

3. 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

166 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
7.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

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.

7.1.6 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 and navigate to OpenText Business


Center for SAP Solutions > Workplace Configuration > Work object types >
Work object types.
2. In the Work Object Types Overview screen, mark a work object type and
double-click ALV Grid - Number of hits in the Dialog Structure.
3. In the ALV Grid - Number of hits Overview screen, define the settings for the
number of hits using the following parameters:

OpenText Business Center for SAP Solutions – Configuration Guide 167


BOCP160002-CGD-EN-01
Chapter 7 Workplace Configuration

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.

7.1.7 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 and navigate to OpenText Business


Center for SAP Solutions > Workplace Configuration > Work object types >
Dynamic data selection.

2. Basic Settings
In the Work Object Type Overview screen, mark a work object type and
double-click Basic Settings in the Dialog Structure.

3. In the Basic Settings Details screen, refine the dynamic data selection and
counting, using the following parameters.

168 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
7.1. Work object types

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.

4. Tables
In the Work Object Type Overview screen, mark a work object type and
double-click Tables in the Dialog Structure.

5. 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.

6. Table joins
In the Work Object Type Overview screen, mark a work object type and
double-click Table joins in the Dialog Structure.

7. 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.

8. Join conditions
In the Table joins Overview screen, select an entry and double-click Join
conditions in the Dialog Structure.

9. Define the join conditions for the table join, using the following parameters.

OpenText Business Center for SAP Solutions – Configuration Guide 169


BOCP160002-CGD-EN-01
Chapter 7 Workplace Configuration

Left table
Table that should be joined

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.

10. Table fields


In the Work Object Type Overview screen, mark a work object type and
double-click Table fields in the Dialog Structure.

11. Define the table fields to be selected, using the following parameters.

Table Name
Name of the table

Field Name
Name of the field

7.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.

170 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
7.3. Navigation

7.3 Navigation
The navigation defines the particular queues and folders in the Business Center
Workplace. Within the Business Center Workplace, the navigation defines the
specific data selection within a queue. It also defines the hierarchical levels and the
global structure of the Business Center Workplace.

Customizing the navigation comprises the following steps:

• “Defining nodes” on page 171


• “Defining the navigation structure” on page 175
• “Defining work centers” on page 179

7.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 and navigate to OpenText Business


Center for SAP Solutions > Workplace Configuration > Navigation > Nodes.

2. 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.

OpenText Business Center for SAP Solutions – Configuration Guide 171


BOCP160002-CGD-EN-01
Chapter 7 Workplace Configuration

Active
Select this check box to activate a node in order to display it in the Business
Center 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 174.

The detailed configuration of the nodes for restrictions, filter, and order criteria
are implemented in the delivered handler class /OTX/
PF03_CL_DATA_HANDLER_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.

7.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 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.

172 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
7.3. Navigation

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 170.

7.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 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

7.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 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

OpenText Business Center for SAP Solutions – Configuration Guide 173


BOCP160002-CGD-EN-01
Chapter 7 Workplace Configuration

7.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 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

7.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)
WOBJ_TYPE Work object type

174 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
7.3. Navigation

Parameter Description
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.

7.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 and navigate to OpenText Business


Center for SAP Solutions > Workplace Configuration > Navigation >
Navigation structure.

OpenText Business Center for SAP Solutions – Configuration Guide 175


BOCP160002-CGD-EN-01
Chapter 7 Workplace Configuration

2. 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.
• 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.

176 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
7.3. Navigation

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.

7.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 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.

Node ID
Enter the ID of the node that shall 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.

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.

OpenText Business Center for SAP Solutions – Configuration Guide 177


BOCP160002-CGD-EN-01
Chapter 7 Workplace Configuration

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 178.

Def. node
Select this check box to define the node as default node. It is automatically
selected at the first display of the structure.

7.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 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

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 177.

7.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 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.

178 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
7.3. Navigation

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.

7.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 and navigate to OpenText Business


Center for SAP Solutions > Workplace Configuration > Navigation > Work
Center.

2. 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.

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.

OpenText Business Center for SAP Solutions – Configuration Guide 179


BOCP160002-CGD-EN-01
Chapter 7 Workplace Configuration

7.4 Authorization objects


The following authorization objects are available for the Business Center 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 Business Center 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 Business Center
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
1. Inbound
2. Process
3. Workplace
4. Web UI

This authorization object is checked in all administrative reports, transactions,


and programs.

Example 7-1: Authorizations necessary to monitor the Inbound


Configuration

Authorization object Business Center component


J_6NPF_NAV Business Center Workplace
J_6NPF_PLA Work Center ID
WP_IDF

180 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
7.4. Authorization objects

Authorization object Business Center component


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
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 Business Center Administration
J_6NPF_COM Components
1 Inbound (only this is needed)
2 Process
3 Workplace

OpenText Business Center for SAP Solutions – Configuration Guide 181


BOCP160002-CGD-EN-01
Chapter 7 Workplace Configuration

Authorization object Business Center component


4 Web UI

182 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
Chapter 8
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 Business Center
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 either by customizing or
by implementing an interface for the Web Services.

Note: The Fiori Task App provides an API. If you are interested in using this
API, contact OpenText Customer Support.

OpenText Business Center for SAP Solutions – Configuration Guide 183


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

8.1 System landscape

Figure 8-1: Web Services landscape

The Fiori Task App of Business Center comes with the OpenText Business Center
WebUI (AddOn OTBCWUI). The minimum requirement for this AddOn is the
following:

• User Interface Technology 7.40 (AddOn SAP_UI, version 740)

The WebUI retrieves data from the technical service /OTX/PF05_DATA. The
activation of this service is described in Section 6.3.1 “Enabling OData service” in
OpenText Business Center for SAP Solutions - Installation Guide (BOCP160002-IGD).

The /OTX/PF05_DATA service is part of the OpenText Business Center


Webservices (AddOn OTBCWSR). The prerequisites for this AddOn are the following:

• Backend Event Provider (AddOn IW_BEP) or SAP Gateway Foundation 7.40


(AddOn SAP_GWFND)
• OpenText Business Center Base (AddOn OTBCBAS)

184 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.1. System landscape

OpenText recommends that you install the AddOn OTBCWSR on the same system as
the AddOn OTBCFND as shown in Figure 8-1, but other installation variants are also
possible. However, all systems must be connected using trusted RFCs.

Note: The installation of OTBCWSR on the same system as the OTBCFND


component is recommended because of performance reasons. This variant
reduces the number of RFC connections between the systems. RFC connections
need to be opened for handling requests of the Fiori Task App in the backend.
This variant also allows the solutions to handle several requests of the Fiori
Task App in one call.

OpenText Business Center Inbound Configuration (AddOn OTBCINB) formerly


was part of OpenText Business Center Foundation (AddOn OTBCFND). OTBCINB
has the following prerequisite:

• OpenText Business Center Base (AddOn OTBCBAS)

The customizing and data for the /OTX/PF05_DATA web service is defined in
OTBCFND, which has the following prerequisites:

• OpenText Business Center Base (AddOn OTBCBAS)


• OpenText Business Center Inbound Configuration (AddOn OTBCINB)

The OTBCSL* AddOns represent the solution accelerators and the VIM solution
integration. OTBCRM represents the integration of Extended ECM.

8.1.1 Versioning
To support an improved interoperability between the Fiori apps and OData services,
versioning has been introduced with Business Center 16 SP1. For that reason, two
versions of the Fiori Task App are delivered. Version 01 is compatible with Business
Center backend version 16 without SP. Version 02 is compatible with Business
Center backend version 16 SP1 and onwards until incompatible changes require to
deliver a new UI version. This applies also to the VIM solution.

The VIM solution version must match the Business Center UI version. For more
information, see the table in this section.

Versioning allows you to run multiple backends with different Business Center
component versions against the latest Business Center frontend component on the
Fiori Server.

The following list shows the delivered BSP applications and the corresponding
OData services with their version:

Fiori Task App (OTBCWUI)


• /OTBCWUI/PF07_BC_UI (version 01)
• /OTBCWUI/PF07_BC_UI_02 (version 02)

OpenText Business Center for SAP Solutions – Configuration Guide 185


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

Templates
• /OTBCWUI/PF07_BC_UI_TMPL (version 01)
• /OTBCWUI/PF07_BC_UI_02_T (version 02)

Business Center OData service (OTBCWSR)


• /OTX/PF05_DATA V2 (version 0002)

VIM app containing VIM (sCoding) specific views (OTBCUS03)


• /OTBCWUI/PS30_VIM_UI (version 01)
• /OTBCWUI/PS30_VIM_UI_02 (version 02)

VIM OData service (OTBCSL33)


• PS33_DATA_SRV V2 (version 0002)

Table 8-1: Version compatibility

Fiori Task App Business Center VIM app VIM OData service
(OTBCWUI) OData service containing VIM (OTBCSL33)
(OTBCWSR) (sCoding) specific
views (OTBCUS03)
Version 02 Version 0002 Version 02 Version 0002
Version 01 Version 01 Version 01 Version 01 (VIM 7.5
(Business Center 16 SP4)
without SP)

8.2 Basic settings


The basic settings allow general settings regarding the display of documents and the
definition of the keys for the work object types, displayed in the Fiori Task App.

You can perform the customizing of basic Web Services settings in the Business
Center IMG.

Run the /n/OTX/PF00_IMG transaction and navigate to OpenText Business Center


for SAP Solutions > Web Services > Basic Settings.

186 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.3. Work object type

8.2.1 Configuring basic settings


To configure basic settings:

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


Center for SAP Solutions > Web Services > Basic Settings > Basic Settings.

2. In the Basic Settings Overview screen, configure basic settings using the
following parameters.

Setting
Use web viewer (if available) for desktop document view

Value
Enter X to determine that OpenText Imaging Web Viewer (Web Viewer) or
OpenText Brava! View for SAP Solutions (Brava! View) is used to display
documents if possible.

General document viewing note


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.

8.3 Work object type


To enable a work object type for the Fiori Task App:

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


Center for SAP Solutions > Web Services > Work Object Type > Work Object
Type.

2. 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. Interface: /OTX/PF62_IF_ITEM_HANDLER. For more
information, see “Web handler” on page 244.
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.

OpenText Business Center for SAP Solutions – Configuration Guide 187


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

8.3.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.

To define keys for the work object type:

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


Center for SAP Solutions > Web Services > Work Object Type > Work Object
Type.

2. In the Work Object Type Overview screen, mark a work object type and
double-click Key definition in the Dialog Structure.

3. 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.

8.3.2 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 and navigate to OpenText Business


Center for SAP Solutions > Web Services > Work Object Type > Work Object
Type.

2. In the Work Object Type Overview screen, mark a work object type and
double-click Related business object in the Dialog Structure.

3. In the Related Business Object Details screen, configure the related business
object using the following parameters.

188 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.4. Workplace

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.

8.4 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.

8.4.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 and navigate to OpenText Business


Center for SAP Solutions > Web Services > Workplace > Work Center.

2. In the Work Center for Webservice Overview screen, define work centers using
the following parameters:

Work Center ID
Unique ID of the work center.

Position
Define the sequence of the work centers.

Work Center Text


Enter a meaningful description of the work center.

OpenText Business Center for SAP Solutions – Configuration Guide 189


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

8.4.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 171. You can
also assign an item perspective to the node. For more information, see “Perspectives,
templates, and views” on page 202.

To enable nodes for Web Services:

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


Center for SAP Solutions > Web Services > Workplace > Nodes.

2. 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 171.

Work object 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
Business Center Workplace.

Perspective ID for an item


Enter the ID of the item perspective.

Node description
Enter a meaningful description of the node. The description is displayed at
the top of the inbox in the Fiori Task App.

Task Title
Enter the task title. It is displayed at the top of the detail area in the Fiori
Task App.

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 242.

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.
When data is selected, the page size is used to calculate the maximum
number of hits.

190 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.4. Workplace

Icon ID UI5
Enter the UI5 icon that should be displayed.
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.

8.4.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 148.

To add fields for searching, sorting, and filtering to a node:

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


Center for SAP Solutions > Web Services > Workplace > Nodes.
2. In the Nodes Overview, mark an entry and double-click one of the following
entries in the Dialog Structure:

• Search fields
• Sort fields
• Filter fields
3. 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, which is introduced with Business Center 16 SP1, define
the order of the values, in which they are sorted and displayed.
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.

You can change the fields in the following methods of the web handler interface (/
OTX/PF62_IF_ITEM_HANDLER). For more information, see “Interface /OTX/
PF62_IF_NODE” on page 242.
• 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 web handler interface.

OpenText Business Center for SAP Solutions – Configuration Guide 191


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

8.4.3 Assigning nodes to work centers


To assign nodes to work centers:

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


Center for SAP Solutions > Web Services > Workplace > Assignment of Nodes
to Work Center.

2. 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 171.

Node position
Define the sequence of the nodes.

8.5 Item details


By configuring item details, you define the behavior of the work objects of a work
object type.

8.5.1 Configuring the item 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 264).

192 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.5. Item details

Figure 8-2: Layout of the master list

To configure the item list:

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


Center for SAP Solutions > Web Services > Items > Item List.

2. In the Items Overview screen, configure the layout of the item list using the
following parameters. For an example, see Figure 8-2.
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>

• Work object type: Work object type for which this list layout is used
• Perspective ID - Node
• Icon ID UI5: Define a UI5 icon that should be displayed.
• 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
• Mark flagged: The flag icon is displayed.
• Mark as favorite: The favorite icon is displayed.
• Intro text
• Inbox list item title
• Number

OpenText Business Center for SAP Solutions – Configuration Guide 193


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

Note: For this field, only numeric values can be used.

• 1st Attribute
• 2nd Attribute
• 1st Status
• 2nd Status

8.5.2 Configuring the item header


In this step, you define the information displayed in the header of the items. This has
the same layout and customizing options as the item list.

Use the field descriptions as in “Configuring the item list” on page 192. The fields
Icon ID UI5 and Intro text are not available, field Inbox list item title is called Title.
Exceptions are displayed in a specific view in the Fiori Task App (below the object
header area).

Business Center 16 SP1 adds the Link type and Link parameter fields to the item
header customizing. These fields are only available in the item header customizing
and not in the item list customizing. For more information, see “Configuring the
item header details” on page 195.

You can change the settings of this customizing by implementing the


method CHANGE_OBJECT_HEADER of the web handler class (see
“CHANGE_OBJECT_HEADER” on page 265).

194 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.5. Item details

8.5.3 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 259.

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 201. 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/PF00_IMG transaction and navigate to OpenText Business


Center for SAP Solutions > Web Services > Items > Item Header Details.

2. 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 190.

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 201.

OpenText Business Center for SAP Solutions – Configuration Guide 195


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

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.

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
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 261.
Link type
This field defines the type of the link for semantic navigation. Possible
values:

• No link
• Semantic object navigation

For more information, see “Semantic navigation with the Fiori Task App”
on page 236.
Link parameter
This field contains the JSON with the link parameters. For more
information, see “Semantic navigation with the Fiori Task App”
on page 236. The JSON data must match the following structure:

{
"target": {
"semanticObject": <semantic object>,
"action": <action>
},
"params": {
<optional parameters>

196 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.5. Item details

}
}

8.5.4 Configuring item 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 246 and “HANDLE_ACTIONS_BULK”
on page 251.

To customize actions for the Fiori Task App:

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


Center for SAP Solutions > Web Services > Items > Item actions.

2. In the Actions Overview screen, customize actions using the following


parameters:

Work object type


Work object type for which actions should be made available.

Action ID
ID for the action.

Order
Define the order of actions. The action with the lowest number is displayed
to the left.

Type
Select the action type from the list. The following types are available:

Action type Perspectiv Action Description


e required? dialog
class
required?
Edit dialog Yes No Opens the detail view for the
selected item with the
customized perspective ID.
Confirm dialog No No Opens the confirmation
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.

OpenText Business Center for SAP Solutions – Configuration Guide 197


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

Action type Perspectiv Action Description


e required? dialog
class
required?
Save & Confirm No No Runs a Save and afterwards
dialog calls the confirmation dialog
box.
Action dialog Yes Yes Opens the action dialog box
with customized perspective
ID calling the customized
action dialog class.
Save & Action Yes Yes Runs a Save and afterwards
dialog calls the action dialog.

Perspective ID
Enter the perspective ID, which is used for Edit actions. It does not affect
the Confirm actions.

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.

Action text
Enter the text that is displayed on the button.

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.

198 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.5. Item details

8.5.5 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 269.

To configure the item list title:

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


Center for SAP Solutions > Web Services > Items > Line Items > Line Item List
Title.
2. In the Titles of item list Overview screen, configure the line item list titles
using the following parameters:

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.

8.5.6 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 257).

To configure line item details:

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


Center for SAP Solutions > Web Services > Items > Line Items > Line Item
Details.
2. 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.

OpenText Business Center for SAP Solutions – Configuration Guide 199


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

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 244.

Search Help ID
Enter the unique ID of the search help for the field. For more information,
see “Input helps” on page 201.

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 258.

Link type
This field defines the type of the link for semantic navigation. Possible
values:

• No link

• Semantic object navigation

For more information, see “Semantic navigation with the Fiori Task App”
on page 236.

200 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.6. Input helps

8.6 Input 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.

Note: Input helps can be set for item fields or header details. For item fields,
see “Configuring line item details” on page 199. For header details, see
“Configuring the item header details” on page 195. 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 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 and navigate to OpenText Business


Center for SAP Solutions > Web Services > Input helps > Input helps.

2. 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.

3. Optional To customize related fields for the input help, mark an entry in the Input
Helps Overview screen, and 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
fields must contain values that are shown in the header data area and in the
detail area.

4. Optional In the Related Fields Overview screen, enter a Field Name according to
the Search Help ID.

OpenText Business Center for SAP Solutions – Configuration Guide 201


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

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 274.

8.7 Perspectives, templates, and views


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. A perspective comprises two parts:

Template
Static part: the template describes the layout of the perspective. You can copy
and adjust templates to your needs. Generally, a template does not include
concrete views. The templates are delivered with the BSP /OTBCWUI/
PF07_BC_UI_02_T.

Views
Dynamic part: a set of views is shown in the template at specific locations at
runtime. For each perspective, you can define which view should appear at
which location in its template. You can insert each view only once in each
perspective.

Placeholders Business Center 16 SP1 introduces placeholders in the perspective customizing.


According to the used version of the BSP application, the placeholders are
interpreted. With an update of the BSP application (this means a new version of the
app), it is not necessary to update the customizing. The following placeholders are
available:

[ot_bc_app_namespace]
Business Center app namespace: ot/approve/requests02 (updated) or ot/
approve/requests

[ot_bc_tmpl_app]
Business Center app for templates: /OTBCWUI/PF07_BC_UI_02_T (updated) or /
OTBCWUI/PF07_BC_UI_TMPL

[ot_bc_app]
Business Center app: /OTBCWUI/PF07_BC_UI_02 (updated) or /OTBCWUI/
PF07_BC_UI

The framework populates empty values of the BSP application and the BSP Module
with the respective placeholders automatically.

Perspectives The following perspectives are available.

202 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.7. Perspectives, templates, and views

• Perspective for simple approval


• Perspective for edit

A perspective for simple approval represents the complete detail area of a process
object in the Fiori Task App to the right of the inbox, as shown in the following
graphic.

A perspective for edit represents the complete detail area of a process object that is
displayed in the Fiori Task App when you click Edit. See the following graphic.

OpenText Business Center for SAP Solutions – Configuration Guide 203


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

• Perspectives for simple approval are used to enable nodes for Web Services. For
more information, see “Enabling nodes for Web Services” on page 190.
Perspectives for simple approval are also used when customizing which fields
are displayed in a header item. For more information, see “Configuring the item
header details” on page 195.
• Perspectives for edit are used to customize actions for the Fiori Task App. For
more information, see “Configuring item actions” on page 197.

To define perspectives:

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


Center for SAP Solutions > Web Services > Perspectives > Perspectives.
2. In the Perspectives Overview screen, define perspectives using the following
parameters:

Perspective ID
Unique ID of the perspective.
Perspective type
Select the perspective type. Currently, only Perspective for items is
available.
BSP application
Enter the Business Center standard application [ot_bc_app] for the
perspective. This setting enables you to use a template of a customer BSP
application or a solution specific BSP application.

204 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.7. Perspectives, templates, and views

BSP Module
Enter the Business Center standard module
[ot_bc_app_namespace].templates for the perspective. For more
information, see BSP application on page 204.

Template ID
Enter the template ID for the perspective, for example
[ot_bc_app_namespace].templates.Edit_NoScroll.

Perspective name
Optional: enter a name for the perspective.

To assign views to a perspective:

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


Center for SAP Solutions > Web Services > Perspectives > Perspectives.

2. In the Perspectives Overview screen, mark an entry and double-click


Perspective views in the Dialog Structure.

3. Define perspective views using the following parameters:

Perspective ID, Perspective type


See “To define perspectives:“ on page 204.

Perspective view ID
Unique ID of the perspective view.

Parent ID
Enter the ID of the container control to which you want to add the view. To
look up this parent ID, open the template that you specified for the
perspective. For the available templates, see “Templates” on page 227.

Position in container
Specify the index at which the view is inserted in the container control
defined by the parent ID. For example, if the parent container is a
VerticalLayout, the index defines whether a view is added before or after
another view. The default value is 0.

BSP application
Enter the BSP application that should be called for the perspective view.
All standard views are implemented in the BSP application /OTBCWUI/
PF07_BC_UI_02.

BSP Module
Enter the BSP module called for the perspective view.
All standard views are implemented in the BSP module ot/approve/
requests02.

BSP View
Enter the BSP view that displays the perspective view. For information
about the standard views, see “Views” on page 226.

OpenText Business Center for SAP Solutions – Configuration Guide 205


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

For more information, see “Perspectives, templates, and views references”


on page 226.

Description
Enter a meaningful description of the perspective view.
The description of a view is shown on the parent control if it supports a title
area for a child. This currently applies only to sap.m.IconTabBar, which is
part of the template HeaderWithTabstrip.view.xml.

Web Icon
Enter an icon for the perspective view.
The icon for a view is shown on the parent control if it supports a title area
for a child. This currently applies only to sap.m.IconTabBar, which is part
of the template HeaderWithTabstrip.view.xml.

CSS class
The CSS class is optional and typically not necessary.

8.8 Action dialog box


Business Center 16 SP1 introduces the Action dialog box, which is a further
development of the Confirm dialog box. The Action dialog box infrastructure runs in
parallel to the existing Confirm dialog box. Unlike the Confirm dialog box, which is
suited for rather simple use cases, the Action dialog box is designed for complex use
cases, with, for example, more than 3 fields and field dependencies, where full
control over the dialog box is necessary. 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:

206 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.8. Action dialog box

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

OpenText Business Center for SAP Solutions – Configuration Guide 207


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

8.8.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 and navigate to OpenText Business


Center for SAP Solutions > Web Services > Work Object Type > Work Object
Type.

2. In the Work Object Type Overview screen, mark a work object type and
double-click Data Collections in the Dialog Structure.

3. 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 or Edit Screen.

Data Collection
Enter the data collection for the work object type.

8.8.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:

Parameter Type Description


PIS_DATA_COLLECTION Importing Data collection information

208 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.8. Action dialog box

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.

8.8.2 Customizing action dialog boxes


To customize action dialog boxes:

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


Center for SAP Solutions > Web Services > Items > Item actions. For more
information, see “Configuring item actions” on page 197.
2. 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.
• Actions of type Action dialog cannot be run as a bulk action.

To define the perspective view:

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


Center for SAP Solutions > Web Services > Perspectives > Perspectives. For
more information, see “To define perspectives:“ on page 204.
For Action dialog boxes, the standard template
[ot_bc_app_namespace].templates.ActionDialogForm is provided, but you
can also use custom templates. The standard template consists of 3 layouts:

vLayoutBefore
This vertical layout is placed at the top of the screen.
matrixLayout
This matrix layout is placed in the middle.

OpenText Business Center for SAP Solutions – Configuration Guide 209


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

vLayoutAfter
This vertical layout is placed at the bottom.

2. Mark a perspective ID and double-click Perspective views in the Dialog


Structure.

3. Define the Perspective views that are displayed in the action dialog box and
their Position in container as described in “Perspectives, templates, and views”
on page 202. For more information, see “Example: an Action dialog box layout”
on page 210.

8.8.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:

210 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.8. Action dialog box

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
• 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

OpenText Business Center for SAP Solutions – Configuration Guide 211


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

• 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
• 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

8.8.4 /OTX/PF62_IF_ACTION_DIALOG interface


The /OTX/PF62_IF_ACTION_DIALOG interface comprises the following methods:
• “GET_ACTION_DIALOG” on page 213
• “GET_TEXT_AREA” on page 214
• “GET_MSG_CONTAINER” on page 214
• “GET_MESSAGES” on page 215
• “GET_INPUT_FIELD” on page 216
• “GET_TEXT_AREA_INPUT” on page 217

212 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.8. Action dialog box

• “GET_DROP_DOWN” on page 218


• “GET_BUTTON” on page 219
• “GET_TABLE” on page 220
• “EXECUTE_ACTION” on page 222
• “UPDATE_DIALOG” on page 223

8.8.4.1 GET_ACTION_DIALOG
This method returns main information for the Action dialog box.

Parameter Type Description


PIT_KEYS Importing Object keys
PI_WOBJ_TYPE Importing Work object type
PI_ACTION_ID Importing Action ID
PI_LOGSYS Importing Logical system
PI_DEVICE Importing Device type
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.
BUTTON_TITLE Title of action button.
BUTTON_ICON Icon for action button.
EXPAND_ON_PHONE Dialog box should be expanded on smartphone.
CONTENT_WIDTH Width of dialog box.

OpenText Business Center for SAP Solutions – Configuration Guide 213


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

8.8.4.2 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
PI_WOBJ_TYPE Importing Work object type
PI_LOGSYS Importing Logical system
PIT_KEYS Importing Object keys
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.

8.8.4.3 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
PI_ACTION_ID Importing Action ID
PI_DEVICE Importing Device type
PI_VIEW_ID Importing View ID
PIH_DATA_COLLECTION Importing Data collection instance
PES_MSG_CNT Exporting Message container definition
PET_RETURN Exporting Messages

214 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.8. Action dialog box

Parameter Type Description


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.

8.8.4.4 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
PI_ACTION_ID Importing Action ID
PI_DEVICE Importing Device type
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:

OpenText Business Center for SAP Solutions – Configuration Guide 215


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

Field name Description


MESSAGE_ID ID of the message
TEXT Message text

8.8.4.5 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
PI_ACTION_ID Importing Action ID
PI_DEVICE Importing Device type
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.

216 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.8. Action dialog box

Field name Description


VALUE_HELP_VAR Help variant:
01 - F4 help only
02 - F4 help with suggestions
04 - Suggestions
05 - F4 help with input field
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.

8.8.4.6 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
PI_WOBJ_TYPE Importing Work object type
PI_LOGSYS Importing Logical system
PIT_KEYS Importing Object keys
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

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.

OpenText Business Center for SAP Solutions – Configuration Guide 217


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

Field name Description


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.

8.8.4.7 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
PI_WOBJ_TYPE Importing Work object type
PI_LOGSYS Importing Logical system
PIT_KEYS Importing Object keys
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.

218 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.8. Action dialog box

Field name Description


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.

8.8.4.8 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
PI_WOBJ_TYPE Importing Work object type
PI_LOGSYS Importing Logical system
PIT_KEYS Importing Object keys
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.
TEXT Button text.

OpenText Business Center for SAP Solutions – Configuration Guide 219


BOCP160002-CGD-EN-01
Chapter 8 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)
TRANSPARENT - Transparent type
UNSTYLED - Unstyled type (no styling)
ENABLED Set this flag if the button is active.

8.8.4.9 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
PI_WOBJ_TYPE Importing Work object type
PI_LOGSYS Importing Logical system
PIT_KEYS Importing Object keys
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.
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
NONE - No selection
READ_ONLY Set this flag if the table content is read-only and
cannot be changed.

220 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.8. Action dialog box

Field name Description


COLUMNS Columns definition.
ITEMS Table items.

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.

Structure of the ITEMS field:

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

OpenText Business Center for SAP Solutions – Configuration Guide 221


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

8.8.4.10 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
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
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

Structure of the PES_RESULT parameter:

Field name Description


MSG Message text
STATUS Dialog status:
DLG_ERROR - Show error in dialog.
GEN_ERROR - Show general action error.
UPDATE - Update object details.
REMOVE - Remove object from master list.

222 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.8. Action dialog box

8.8.4.11 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 the same as in the EXECUTE_ACTION method. For more
information, see “EXECUTE_ACTION” on page 222.

OpenText Business Center for SAP Solutions – Configuration Guide 223


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

8.8.5 Communication flow of an Action dialog box

Figure 8-3: Communication flow of an Action dialog box

1. When the user runs an action that is linked with an Action dialog box, the
system tries to lock the object.
2. After a successful lock, the data collection is created and the methods /OTX/
PF00_IF_DATA_COLLECTION~CREATE_COLLECTION and /OTX/

224 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.8. Action dialog box

PF62_IF_DATA_COLLECTION~SET_ADDITIONAL_INFORMATION of the data


collection class of the current work object type are called. Therefore, data
necessary for the Action dialog box can be collected.
The Fiori Task App also gets the perspective customizing of the Action dialog
box. Therefore, the Fiori Task App can calculate for which views data has to be
requested.
The /OTX/PF62_IF_ACTION_DIALOG~GET_ACTION_DIALOG method is also called
in this step. In this method, the Fiori Task App returns some general information
for the Action dialog box. This is also the first time when the action ID is known
in the SAP ERP backend. Depending on the action ID, data should be added to
the data collection the first time this method is called.
3. The Fiori Task App requests the data for all views of the perspective
customizing of the Action dialog box. 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.
4. After changing an input field where the UPDATE_ON_VALUE_CHANGE flag is set,
the /OTX/PF62_IF_ACTION_DIALOG~UPDATE_DIALOG method is called. 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 also checks can be performed.
5. 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.
4 on page 225 and 5 on page 225 are repeated each time the user does a change
which triggers an update.
6. When the user clicks the action button in the Action dialog box, the action is
executed. For this, the /OTX/PF62_IF_ACTION_DIALOG~EXECUTE_ACTION
method is called. The parameters of this method contain all data available in the
Action dialog box. Depending on the result of the execution, the Action dialog
box can be finished with success or error messages. A problem can occur that
might be solved by changing a value in the Action dialog box. In this case, it is
also possible that the Action dialog box is updated so that the user gets the
feedback and can decide what he wants to do.
7. When the action has been executed (successful or with error), the /OTX/
PF00_IF_DATA_COLLECTION~REMOVE_COLLECTION method is called. In this case,
the collected data of the data collection can be removed.
8. The lock for the current object is removed.

With the /OTX/PF63_CL_DACO_WOBJ class, Business Center delivers 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

OpenText Business Center for SAP Solutions – Configuration Guide 225


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

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.

8.9 Perspectives, templates, and views references


This section lists the available views, templates, and perspectives for the Fiori Task
App user interface. For more information, see “Perspectives, templates, and views”
on page 202.

8.9.1 Views
Table 8-2: Item views (read-only)

Name BSP view


AttachmentsInplace [ot_bc_app_namespace].view.
item.AttachmentsInplace
AttachmentsNewTab [ot_bc_app_namespace].view.
item.AttachmentsNewTab
AttachmentsSplit [ot_bc_app_namespace].view.
item.AttachmentsSplit
Document [ot_bc_app_namespace].view.item.Document
History [ot_bc_app_namespace].view.item.History
ItemDetails [ot_bc_app_namespace].view.item.ItemDetails
ItemDetailsOneColumn [ot_bc_app_namespace].view.
item.ItemDetailsOneColumn
ItemHeader [ot_bc_app_namespace].view.item.ItemHeader
LineItems [ot_bc_app_namespace].view.item.LineItems

Table 8-3: Item views (editable)

Name BSP view


EditItemDetails [ot_bc_app_namespace].view.item.EditItemDetails
EditLineItems [ot_bc_app_namespace].view.item.EditLineItems

226 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.9. Perspectives, templates, and views references

Table 8-4: Action dialog views

Name BSP view


ActionMessages [ot_bc_app_namespace].view.
dialogPart.ActionMessages
DescriptiveText [ot_bc_app_namespace].view.
dialogPart.DescriptiveText
DialogButton [ot_bc_app_namespace].view.
dialogPart.DialogButton
MultiComboInput [ot_bc_app_namespace].view.
dialogPart.MultiComboInput
Table [ot_bc_app_namespace].view.dialogPart.Table
TextAreaInput [ot_bc_app_namespace].view.
dialogPart.TextAreaInput
ValueHelpInput [ot_bc_app_namespace].view.
dialogPart.ValueHelpInput

Notes
• You can place each of the views in “Action dialog views” on page 227
multiple times inside one perspective.
• The BSP module for all views is [ot_bc_app_namespace].
• The BSP application for views is [ot_bc_app].

8.9.2 Templates
The templates are stored in BSP /OTBCWUI/PF07_BC_UI_02_T (/OTBCWUI/
PF07_BC_UI_TMPL for version 01). The BSP is available on the server where the
OTBCWUI add-on is installed (typically the frontend server). Store any modifications
to the original templates as separate templates because changes may be overridden
with the next version.

A Business Center perspective template is a SAP UI5 XML view that only comprises
container controls with the purpose to arrange a certain layout. To find suitable
containers, visit the following SAP UI5 documentation page (restrict to categories
layout and container): https://sapui5.hana.ondemand.com/explored.html.

At runtime, Business Center item views that are configured using the perspectives
customizing are inserted in that layout. The location where a view is placed is
configured with the following parameters:

Parent ID
ID of the container in which you put the child view.
Position in Container
Every UI5 container control offers at least one aggregation, in which you can
insert child controls (in this case: Business Center item views). Technically, an

OpenText Business Center for SAP Solutions – Configuration Guide 227


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

aggregation is an array of UI5 controls and in general a normal control property.


The name of the default aggregation is content.

The parameter Position in Container specifies the index at which a view is


inserted in the aggregation content. If the aggregation for inserting is not
content, you must specify the insertion-method. See the following samples:

0 invokes 'insertContent(<view>,0)'
3 invokes 'insertContent(<view>,3)'
insertItem;2 invokes 'insertItem(<view>,2)'

CSS class
The CSS class parameter is optional. Use it to specify a CSS class that is set to the
view <DIV> element. You must define the CSS class inside a <html:style> tag in
the template.

Scrolling
By default, a perspective gets content of a sap.m.Page that has a vertical scroll
bar. To disable the page scrolling, you must add a suffix _noScroll to the
template name.

228 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.9. Perspectives, templates, and views references

Example 8-1: Template layout

Figure 8-4: Sample

This code sample creates the following layout:

A perspective customizing using that template could look like the following.

Perspective View ID: ZFS_VIEW_1

Parent ID detailsPanel
Position in container 0

OpenText Business Center for SAP Solutions – Configuration Guide 229


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

BSP Application [ot_bc_app]


BSP Module [ot_bc_app_namespace]
BSP View [ot_bc_app_namespace].view.item.ItemDetails
CSS Class sample_header

Perspective View ID: ZFS_VIEW_2

Parent ID attachmPanel
Position in container 0
BSP Application [ot_bc_app]
BSP Module [ot_bc_app_namespace]
BSP View [ot_bc_app_namespace].view.
item.Attachements
CSS Class not applicable

At runtime, the application would look like the following:

230 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.9. Perspectives, templates, and views references

Delivered templates

Figure 8-5: ot.approve.requests.templates.HeaderWithTabstrip

This template is used by the PF07_ITEM perspective.

UI5 control (container) ID ID of parent


sap.ui.layout.VerticalLayout vLayout
sap.m.IconTabBar tabstrip vLayout
sap.m. IconTabFilter firstTab tabstrip

OpenText Business Center for SAP Solutions – Configuration Guide 231


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

Figure 8-6: ot.approve.requests.templates.Edit_NoScroll

This template is used by the PF07_EDIT perspective.

UI5 control (container) ID ID of parent


sap.ui.layout.Splitter splitter
sap.ui.layout.VerticalLayout left splitter
sap.m.Panel detailsPanel left
sap.m.Panel lineItemsPanel left

232 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.9. Perspectives, templates, and views references

Figure 8-7: ot.approve.requests.templates.Edit_m

This template is used by the PF07_EDIT_S and the PF07_EDIT_M perspective.

UI5 control (container) ID ID of parent


sap.ui.layout.VerticalLayout vLayout
sap.m.Panel attachmPanel vLayout
sap.m.Panel detailsPanel vLayout
sap.m.Panel lineItemsPanel vLayout

OpenText Business Center for SAP Solutions – Configuration Guide 233


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

Figure 8-8: ot.approve.requests.templates.EditWoLineItems_NoScroll

This template is used by the PS05_EDIT perspective.

UI5 control (container) ID ID of parent


sap.ui.layout.Splitter splitter
sap.ui.layout.VerticalLayout left splitter
sap.m.Panel detailsPanel left

234 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.9. Perspectives, templates, and views references

Figure 8-9: ot.approve.requests.templates.EditWoLineItems_m

This template is used by the PS05_EDIT_M and PS05_EDIT_S perspectives.

UI5 control (container) ID ID of parent


sap.ui.layout.VerticalLayout vLayout
sap.m.Panel attachmPanel vLayout
sap.m.Panel detailsPanel vLayout

8.9.3 Perspectives
Customizing perspectives is part of the general Business Center customizing, which
is performed on the backend server. Run the /n/OTX/PF00_IMG transaction and
navigate to OpenText Business Center for SAP Solutions > Web Services >
Perspectives > Perspectives. For more information, see “Perspectives, templates,
and views” on page 202.

To maintain a device specific perspective, you must append the general 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)

OpenText Business Center for SAP Solutions – Configuration Guide 235


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

<pSample>_S Smartphone
<pSample>_M Tablet

8.10 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 and


navigate to OpenText Business Center for SAP Solutions > Web Services >
Basic Settings > Basic Settings.

2. Enable the Web Viewer setting for Device Types Smart phone and Tablet.

3. Navigate to OpenText Business Center for SAP Solutions > Web Services >
Perspectives > Perspectives.

4. Mark a perspective, for example for Sales Orders: PF07_ITEM_S, PF07_ITEM_M,


PF07_EDIT_S, PF07_EDIT_M

5. Double-click Perspective views in the Dialog Structure.

6. In the BSP View column, change the entry from


[ot_bc_app_namespace].view.item.AttachmentsNewTab to
[ot_bc_app_namespace].view.item.AttachmentsInplace.

8.11 Semantic navigation with the Fiori Task App


The Fiori Task App supports intent-based navigation to another Launchpad app or
Fiori Task App instance from the following views:

• Item Header
• Item Details
• Line Items

The following screenshot highlights the views that are available for semantic
navigation:

236 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.11. Semantic navigation with the Fiori Task App

The intent-based navigation is a mechanism of the SAP Fiori Launchpad that allows
users to perform actions on semantic objects, without worrying about the UI
technology or the technical implementation of the navigation target.

Business Center customizing


You configure the navigation using Business Center customizing or the “Web
handler” on page 244. The relevant settings are Link type and Link parameter. For
semantic navigation, Link type must be set to Semantic object navigation. Link
parameter must be filled with JSON data describing all necessary intent details. The
concrete structure is explained in the subsequent section.

To customize semantic navigation for Item Header:

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


Center for SAP Solutions > Web Services > Items > Item Header.

2. Double-click an entry in the list.


The following fields are relevant for semantic navigation:

• Link type
• Link parameter

Link type
This field defines the type of the link. Possible values:

OpenText Business Center for SAP Solutions – Configuration Guide 237


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

• No link

• Semantic object navigation

Link parameter
This field contains the JSON with the link parameters. The JSON data must
match the following structure:

{
"target": {
"semanticObject": <semantic object>,
"action": <action>
},
"params": {
<optional parameters>
}
}

To customize semantic navigation for Item Header Details:

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


Center for SAP Solutions > Web Services > Items > Item Header Details.

2. Configure Link type and Link parameter. For more information, see “To
customize semantic navigation for Item Header:“ on page 237.

To customize semantic navigation for Line Item Details:

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


Center for SAP Solutions > Web Services > Items > Line Items > Line Item
Details.

2. Configure Link type. For more information, see “To customize semantic
navigation for Item Header:“ on page 237.

3. To set the parameters for the links, implement the GET_ITEM_LINKS method of
the web handler interface.

Details for Fiori Launchpad apps and Fiori Task App instances
For the necessary details for Fiori Launchpad apps, see the SAP Fiori apps reference
library (https://fioriappslibrary.hana.ondemand.com/sap/fix/externalViewer/
index.html).

For other Fiori Task App instances, see the details about initial configuration of the
semantic object in “Integrating Fiori Task App into Fiori Launchpad” on page 277.

The following piece of code is an example with all available parameters. The nodeId,
wobjType and workplaceId parameters are mandatory.

Note: The value of the filter and searchValue parameters must be URL-
encoded.

238 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.11. Semantic navigation with the Fiori Task App

{
"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"
}
}

The filter, searchField, searchValue, sortOption and sortDirection


parameters are optional. They allow to start the Fiori Task App with already applied
restrictions.

These are only activated restrictions on the UI side, as if the user would do it
manually. The user can revert these restrictions at any time.

The filter can use criteria that is defined in the node customizing: OpenText
Business Center for SAP Solutions > Web Services > Workplace > Nodes – Filter
fields.

Alternatively, the filter can use criteria that is defined in the implementation of the
node exit: interface /OTX/PF62_IF_NODE, method CHANGE_NODE_FILTER_FIELDS.
For more information, see “CHANGE_NODE_FILTER_FIELDS” on page 243.

Performing changes using the web handler interface


You can set or change link types and link parameters using the web handler
interface. For more information, see the links in this section:

Method “CHANGE_OBJECT_HEADER” on page 265


The PCS_OBJECT parameter has the new fields LINKTYPE and LINK_PARAMETER.

Method “CHANGE_HEADER_DETAILS” on page 259


Structure of the PCT_HEADER_DETAILS parameter has the new fields LINKTYPE
and LINK_PARAMETER.

Method “CHANGE_ITEM_STRUC” on page 257


Structure of the PCT_ITEM_STRUCTURE parameter has the new field LINKTYPE.

The new GET_ITEM_LINKS method allows defining the link parameter of single line
items. The method will be called when the user clicks a link in one of the line items.
For more information, see “GET_ITEM_LINKS” on page 263.

OpenText Business Center for SAP Solutions – Configuration Guide 239


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

For calculating the JSON of the link parameter, you can use the auxiliary method
GET_JSON_FOR_LINK_PARA of the /OTX/PF62_CL_UTILITIES class. This method has
the following parameters:

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
PR_JSON Returning JSON for link parameter

To calculate the JSON for a link pointing to the Fiori Task App, you must 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.

240 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.12. Integrating UI5 widgets for Extended ECM or DocuLink

8.12 Integrating UI5 widgets for Extended ECM or


DocuLink
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 “Perspectives, templates, and views” on page 202.

To integrate Extended ECM or DocuLink UI5 widgets:

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


Center for SAP Solutions > Web Services > Perspectives > Perspectives.

2. Copy the PF07_ITEM perspective.

3. Add the following views for Extended ECM.

Parent ID Position BSP Application BSP View Web icon


tabstrip 3 OTX/RMF_BWS4BC otx.ecmlink.bws4otbc customer
wui.view.BusinessWo
rkSpaceTab
tabstrip 4 OTX/ALF_DOCS4BC otx.alplus.docs4otbcw customer-
ui.view.BusinessDocu order-entry
mentsTab

4. Navigate to OpenText Business Center for SAP Solutions > Web Services >
Workplace > Nodes.

5. 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.

6. Navigate to OpenText Business Center for SAP Solutions > Web Services >
Work Object Type > Work Object Type.

7. Maintain the related business object. For more information, see “Defining a
related business object for a work object type” on page 188.

8.13 Interfaces and exits


This section describes interfaces and exits that are relevant for the Web Services.

Note: The parameter naming in Business Center 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)

OpenText Business Center for SAP Solutions – Configuration Guide 241


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

8.13.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_SEARCH_FIELDS” on page 242
• “CHANGE_NODE_SORT_FIELDS” on page 243
• “CHANGE_NODE_FILTER_FIELDS” on page 243
• “CHANGE_NODE_FILTER_VALUES” on page 244

8.13.1.1 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
PI_NODE_PERSPECTIVE_ID Importing Perspective ID
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

242 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.13. Interfaces and exits

8.13.1.2 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
PI_NODE_PERSPECTIVE_ID Importing Perspective ID
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

8.13.1.3 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
PI_NODE_PERSPECTIVE_ID Importing Perspective ID
PI_SOFT_STATE Importing Soft state active?
PET_RETURN Exporting Messages
PE_ERROR_TYPE Exporting Error type
PCT_FILTER_NAMES Changing Fields available for filtering

Structure of parameter PCT_FILTER_NAMES:

Field name Description


ID Field ID

OpenText Business Center for SAP Solutions – Configuration Guide 243


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

Field name Description


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

8.13.1.4 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

8.13.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 245
• “CHANGE_ACTIONS” on page 246
• “GET_ACTION_REASONS” on page 247
• “GET_ACTION_VALIDAT_MSG” on page 248

244 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.13. Interfaces and exits

• “CHANGE_ACTION_VALIDATION” on page 249


• “GET_ACTION_AGENTS” on page 250
• “EXECUTE_ACTION” on page 251
• “HANDLE_ACTIONS_BULK” on page 251
• “HANDLE_UPDATES_BULK” on page 252
• “CHECK_FIELDS” on page 253
• “CHECK_LINE_ITEM_FIELDS” on page 254
• “GET_ITEMS” on page 255
• “GET_DOCUMENTS” on page 256
• “CHANGE_ITEM_STRUC” on page 257
• “ON_VALUE_UPDATE_ITEM” on page 258
• “CHANGE_HEADER_DETAILS” on page 259
• “ON_VALUE_UPDATE_HEADER_DETAIL” on page 261
• “GET_ITEM_STRUC” on page 262
• “GET_ITEM_LINKS” on page 263
• “CHANGE_OBJECT” on page 264
• “CHANGE_OBJECT_HEADER” on page 265
• “CHANGE_OBJECT_FUNCTIONS” on page 267
• “GET_TIMELINES” on page 267
• “GET_EXCEPTIONS” on page 268
• “CHANGE_ITEM_LIST_TITLE” on page 269
• “CHANGE_RELATED_BUS_OBJECT” on page 270

8.13.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 246.

OpenText Business Center for SAP Solutions – Configuration Guide 245


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

8.13.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.
PI_ACTION_ID Importing Required action ID. Initial if all actions
for the item are required.
PI_DEVICE Importing Device type.
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.
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 PCT_ACTIONS:

Field name Description


ACTION_ORDER Order of actions.
ACTION_ID Action ID.
ICON SAP UI5 Icon. Will be displayed at the button.
TEXT Action text. Will be displayed at the button.

246 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.13. Interfaces and exits

Field name Description


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)
• TRANSPARENT: Transparent style
• UNSTYLED: Without a style
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.
BULK_ACTION Action can be used as a bulk action.
PERSPECTIVE_ID Perspective that is called at action type EDIT.

8.13.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.
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the object.
PI_DEVICE Importing Device type.
PET_ACTION_REASONS Exporting Possible reasons.
PET_RETURN Exporting Error messages.

OpenText Business Center for SAP Solutions – Configuration Guide 247


BOCP160002-CGD-EN-01
Chapter 8 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 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

8.13.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.
PI_DEVICE Importing Device type.
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.

248 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.13. Interfaces and exits

Parameter Type Description


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

8.13.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.
PCS_ACTION_VALIDATION Changing Layout of the validation screen.
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:

OpenText Business Center for SAP Solutions – Configuration Guide 249


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

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.

8.13.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.
PET_ACTION_AGENTS Exporting Possible agents.

250 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.13. 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

8.13.2.7 EXECUTE_ACTION
This method is deprecated in Business Center 10.0 SP1 and later. It is replaced by the
HANDLE_ACTIONS_BULK method. For more information, see
“HANDLE_ACTIONS_BULK” on page 251.

8.13.2.8 HANDLE_ACTIONS_BULK
This method executes actions for one or more items. In Business Center 10.0 SP1or
later, 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:

OpenText Business Center for SAP Solutions – Configuration Guide 251


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

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.

Structure of parameter PET_BULK_ACTION_RESULT:

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.

8.13.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.

252 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.13. Interfaces and exits

Parameter Type Description


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.
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.

8.13.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.

OpenText Business Center for SAP Solutions – Configuration Guide 253


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

Parameter Type Description


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.

8.13.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

254 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.13. Interfaces and exits

Field name Description


MSG Message text

8.13.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.
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the object.
PI_DEVICE Importing Device type.
PI_ITEM_PERSPECTIVE_ID Importing Item perspective ID.
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.

OpenText Business Center for SAP Solutions – Configuration Guide 255


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

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 287.

8.13.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:
• MOBILE
• DESKTOP
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:

256 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.13. Interfaces and exits

Field name Description


ARCHIVE_ID Archive ID
ARCDOC_ID Document ID
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

8.13.2.14 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.
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.

OpenText Business Center for SAP Solutions – Configuration Guide 257


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

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

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 navigation.

8.13.2.15 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.

258 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.13. Interfaces and exits

Parameter Type Description


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.
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

8.13.2.16 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.

OpenText Business Center for SAP Solutions – Configuration Guide 259


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

Parameter Type Description


PI_DEVICE Importing Defines the device on which the Fiori
Task App is running. Possible values:
• MOBILE
• DESKTOP
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.
EDITABLE Column is editable.
REQUIRED Values in column must be maintained.
CHECKBOX Field is displayed as a check box.

260 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.13. Interfaces and exits

Field name Description


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 navigation.
LINK_PARAMETER JSON with the link parameters for semantic navigation.

8.13.2.17 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.
PI_ITEM_PERSPECTIVE_ID Importing Item perspective ID.
PI_UPDATED_FIELD Importing Field which has been updated.
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.
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

OpenText Business Center for SAP Solutions – Configuration Guide 261


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

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.

8.13.2.18 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.
PI_DEVICE Importing Device type.
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

262 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.13. Interfaces and exits

8.13.2.19 GET_ITEM_LINKS
This method allows the definition of the link parameter of single line items in the
context of semantic 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.
PI_ITEM_ID Importing Item ID.
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

OpenText Business Center for SAP Solutions – Configuration Guide 263


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

8.13.2.20 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:
• MOBILE
• DESKTOP
PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the object.
PI_ITEM_PERSPECTIVE_ID Importing Item perspective ID.
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 item list”
on page 192.
TASK_TITLE

264 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.13. Interfaces and exits

Field name Description


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.

Note: To remove the object from the object list, clear the structure PCS_OBJECT.

8.13.2.21 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.
PIT_KEYS Importing Contains key fields of the current
work object.
PCS_OBJECT Changing Object header.
PET_RETURN Exporting Error messages.

OpenText Business Center for SAP Solutions – Configuration Guide 265


BOCP160002-CGD-EN-01
Chapter 8 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 PCS_OBJECT:

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 navigation
LINK_PARAMETER JSON with the link parameters for semantic navigation

266 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.13. Interfaces and exits

8.13.2.22 CHANGE_OBJECT_FUNCTIONS
This method is deprecated in Business Center 10.0 SP1 and later. The functionality is
now part of the perspectives concept. For more information, see “Perspectives,
templates, and views” on page 202.

8.13.2.23 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.
PI_ITEM_PERSPECTIVE_ID Importing Item perspective ID.
PI_DEVICE Importing Defines the device on which the Fiori
Task App is running. Possible values:
• MOBILE
• DESKTOP
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.

OpenText Business Center for SAP Solutions – Configuration Guide 267


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

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
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


HST_KEY Key of history entry.
CMNT_KEY Key of comment.
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.

8.13.2.24 GET_EXCEPTIONS
This method returns error messages that are displayed as detail for an object header
field.

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.

268 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.13. Interfaces and exits

Parameter Type Description


PI_WOBJ_CHANGED_AT Importing Timestamp of the last change made to
the item.
PI_DEVICE Importing Device type.
PET_EXCEPTIONS Exporting Exceptions.
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_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

8.13.2.25 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.

OpenText Business Center for SAP Solutions – Configuration Guide 269


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

Parameter Type Description


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.
PI_DEVICE Importing Device type.
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

8.13.2.26 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 188.

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.

270 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.13. 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
PCS_RELATED_BUS_OBJECT Changing Related business object.

Structure of parameter PCS_RELATED_BUS_OBJECT:

Field name Description


OBJTYPE Object type
OBJID Object ID

8.13.3 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:

8.13.3.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:

OpenText Business Center for SAP Solutions – Configuration Guide 271


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

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

8.13.3.2 CHANGE_PERSPECTIVES
This method allows you to change the configuration of a perspective at runtime.

Parameter Type Description


PI_PERSPECTIVE_ID Importing Perspective ID.
PI_PERSPECTIVE_TYPE Importing Perspective type. Possible value:
item: Perspective for items
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 is
raised with the error message in
PCT_RETURN.
PCT_PERSPECTIVES Changing Perspectives.
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 PCT_PERSPECTIVES:

Field name Description


PERSPECTIVE_ID Perspective ID
PERSPECTIVE_TYPE Perspective type
TEMPLATE_ID Template ID
NAME Name of a perspective

272 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.13. Interfaces and exits

8.13.3.3 CHANGE_PERSPECTIVE_VIEWS
This method allows you to change views that are assigned to a perspective at
runtime.

Parameter Type Description


PI_PERSPECTIVE_ID Importing Perspective ID.
PI_PERSPECTIVE_TYPE Importing Perspective type. Possible value:
item: Perspective for items
PI_PERSPECTIVE_VIEW_ID Importing View ID.
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 is
raised with the error message in
PCT_RETURN.
PCT_PERSPECTIVE_VIEWS Changing Perspective views.
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 PCT_PERSPECTIVE_VIEWS:

Field name Description


PERSPECTIVE_ID Perspective ID.
PERSPECTIVE_TYPE Perspective type.
PERS_VIEW_ID Perspective view ID.
ICON UI5 icon that is displayed in the Fiori Task App.

Note: This is only used for certain parent IDs.

VIEW_NAME BSP view.


BSP_MODULE BSP module.
BSP_APPL External name of the BSP application (upper and lower
case).
NAME View description.
PARENT_ID Parent ID. Check the available parent IDs in
“Templates” on page 227.

OpenText Business Center for SAP Solutions – Configuration Guide 273


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

Field name Description


CSS_CLASS CSS class.
CONT_POSITION Position in container.

8.13.4 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 274

“CHANGE_HELP_ROWS” on page 275

“CHANGE_FILTER_OPTIONS” on page 275

8.13.4.1 CHANGE_HELP_COLUMNS
The Business Center 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
PCT_HELP_COLUMNS Changing Definition for columns of search help
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.

274 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
8.13. Interfaces and exits

Field name Description


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.

8.13.4.2 CHANGE_HELP_ROWS
The Business Center 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
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

8.13.4.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.
PIT_KEYS Importing Contains key fields of the current work
object.
PI_WOBJ_TYPE Importing Work object type.
PI_LOGSYS Importing Logical system.

OpenText Business Center for SAP Solutions – Configuration Guide 275


BOCP160002-CGD-EN-01
Chapter 8 Fiori Task App

Parameter Type Description


PI_OBJECT_KEY Importing Object key.
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

276 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
Chapter 9
Fiori Task App running scenarios

You can run the Fiori Task App in several ways:


• integrated into Fiori Launchpad
• standalone

9.1 Integrating Fiori Task App into Fiori Launchpad


This section provides a description how to create a solution specific tile for the SAP
Fiori Launchpad. Every tile is referring to the same Business Center web application
but with different parametrization.

For more details and further information about the Fiori Launchpad, see http://
scn.sap.com/docs/DOC-53178.

Figure 9-1: Overview of involved Fiori Launchpad infrastructure parts

When creating tiles for the Launchpad, there are three different ways how you can
link an application. For a UI5 application that is delivered as component, only the
“Target Mapping SAP UI5 Fiori App” mechanism is recommended.

Direct Link
The tile is directly referring to a relative or absolute URL.

Target Mapping Other SAP Fiori App


The tile is referring to a configured action of a semantic object that is defined as
target mapping through the Launchpad Designer. The target mapping links to a
Launchpad application that has been defined using the LPD_CUST transaction.
Necessary details are the Launchpad role, the Launchpad instance, and the
application alias.

OpenText Business Center for SAP Solutions – Configuration Guide 277


BOCP160002-CGD-EN-01
Chapter 9 Fiori Task App running scenarios

Target Mapping SAP UI5 Fiori App


The tile refers to a configured action of a semantic object that is defined as target
mapping through the Launchpad Designer. In the target mapping, the concrete
UI5 component details are specified.

Figure 9-2: Fiori Launchpad tile setup

Because the Fiori Task App is delivered as a UI5 component, the tile creation
description is referring to “Target Mapping SAP UI5 Fiori App”.

To create a Fiori Launchpad tile:

1. Create a semantic object.


For all Business Center solution tiles, create one semantic object. To do this, run
the /n/UI2/SEMOBJ transaction in SAP GUI. The semantic object is only a
logical placeholder. It does not consist of any specific data.

2. Create a tile catalog.


You use a tile catalog to group tiles and their target mappings. A tile catalog is
later included into the menu tree of a role that holds specific permissions. If you
want to include only a subset of a catalog into the menu of a role, create a tile
group.

278 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
9.1. Integrating Fiori Task App into Fiori Launchpad

You create tile catalogs and also groups using the Launchpad Designer, which
you can access through the relative URL /sap/bc/ui5_ui5/sap/
arsrvc_upb_admn/main.html.

Note: For Business Center solutions, at least one catalog is necessary. If


you plan to enroll the Fiori Launchpad configuration to another Fiori
server, ensure that a customizing request is specified, using the Settings
button.
3. Create a Business Center target mapping.
In the Launchpad Designer, you must create one target mapping to the Fiori
Task App.

a. In the Intent area, choose the Semantic Object you have created in Step 1
on page 278 and specify an Action.
You can freely define the action. You must remember it when creating the
solution tiles. For that string, no value help is provided.
b. In the Target area, click SAP UI5 Fiori App for the Source of Navigation
Target.
c. Enter the parameters exactly as follows.

Title
<A title of your choice>
URL
Semantic objects for backends using Business Center 16 SP1 or higher
use version 02 of the Fiori Task App:

OpenText Business Center for SAP Solutions – Configuration Guide 279


BOCP160002-CGD-EN-01
Chapter 9 Fiori Task App running scenarios

/sap/bc/ui5_ui5/otbcwui/pf07_bc_ui_02
Semantic objects for backends with Business Center 16 use version 01 of
the Fiori Task App:
/sap/bc/ui5_ui5/otbcwui/pf07_bc_ui

Component
Semantic objects for backends using Business Center 16 SP1 or higher
use version 02 of the Fiori Task App:
ot.approve.requests02
Semantic objects for backends with Business Center 16 use version 01 of
the Fiori Task App:
ot.approve.requests

4. Create tiles.
After you have defined the target mapping, you can create the wanted solution
tiles. For this step, you must know the following parameters of the Business
Center customizing:

Parameter Description
nodeId ID of the Workplace node that should be displayed by the Fiori Task App
wobjType Corresponding work object type
workplaceId ID of the Workplace to which the node belongs
system System alias backend

Example 9-1: Tile configuration for Delivery Notes solution


accelerator

280 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
9.1. Integrating Fiori Task App into Fiori Launchpad

General

Title
<A title of your choice>

Subtitle
<A subtitle of your choice>

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;<OData service version>/
Nodes(<Node parameter>)/Objects/$count where <OData service
version> and <Node parameter> are described in the following list:

<OData service version>


Defines which version of the Business Center OData service is
used.
In tiles for backends using Business Center 16 SP1 or higher, use
version 2 of the Business Center OData service: v=2
In tiles for backends using Business Center 16, use version 1 of
the Business Center OData service: v=1

<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.
nodePerspectiveId: Perspective ID connected to node. Leave
empty for $count request.
wobjType: Work object type of the node.
workplaceId: Workplace ID
For example:
SAP__Origin='T9L',deviceType='',nodeId='PS01_DELIVER
Y_INBOX',nodePerspectiveId='',wobjType='PS01_PRC_DEL
IV',workplaceId='WP_INBOX'
Example for backend with Business Center 16 SP1:
/sap/opu/odata/OTX/PF05_DATA;mo;v=2/
Nodes(SAP__Origin='BACKEND_1',deviceType='',nodeId='PS0
1_DELIVERY_INBOX',nodePerspectiveId='',wobjType='PS01_P
RC_DELIV',workplaceId='WP_INBOX')/Objects/$count

OpenText Business Center for SAP Solutions – Configuration Guide 281


BOCP160002-CGD-EN-01
Chapter 9 Fiori Task App running scenarios

Navigation

Use semantic object navigation


Select this check box.

Semantic Object
Enter the object that you have created in Step 1 on page 278.

Action
Enter the action that you have defined in Step 3 on page 279.

Parameters
Enter nodeId=PS02_ORDER_INBOX&wobjType=PS02_PRC_ORDER&wor
kplaceId=WP_INBOX&system=BACKEND_1.

5. Assign catalog to role.


To provide the Business Center catalog to your users, you must create one or
more roles. This depends on your business roles. Then, you must add the
created catalog to the role menu tree. Make sure that you properly assign the
role to your user groups. For this, use the SAP GUI transaction PFCG.

6. Personalize the Launchpad.


Users can now access the Launchpad with the relative URL /sap/bc/ui5_ui5/
ui2/ushell/shells/abap/Fiorilaunchpad.html.

On the menu on the right, users must click Personalize Homepage. Then, they
can search for the created Business Center catalog and add one or more tiles
from it to the Home Page.

282 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
9.2. Running the Fiori Task App standalone

9.2 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_02/index.html?
&nodeId=<node_id>&wobjType=<wobj_type>&workplaceId=<workplace_id>

Replace the placeholders (<name>) with the appropriate values according to your
system landscape scenario. For more information, see “Parameters reference”
on page 283.

9.3 Parameters reference


Parameter name Value specification Description
nodeId <value> The node specifying a specific object
(mandatory parameter) selection in the backend.
wobjType <value> The work object type from which the
(mandatory parameter) node has been created.
workplaceId <value> The workplace to which the specified
(mandatory parameter) node is assigned to.
filter <url_encoded_value> Initially applied filter that can be
revoked by the user (must match
existing filter categories and values).
searchField <value> Works in combination with
searchValue - initially applied
search that can be revoked by the user
(must match existing search
categories).
searchValue <url_encoded_value> Works in combination with
searchField - initially applied
search that can be revoked by the user
(must match existing search
categories).
sortOption <value> Works in combination with
sortDirection - initially applied
sorting that can be revoked by the user
(must match existing sort options).
sortDirection <asc|desc> Works in combination with
sortOption - initially applied sorting
that can be revoked by the user (must
match existing sort options).
system <value> Alias of the backend system to which
the OData service establishes a
connection.

OpenText Business Center for SAP Solutions – Configuration Guide 283


BOCP160002-CGD-EN-01
Chapter 9 Fiori Task App running scenarios

Parameter name Value specification Description


letterBox <true|false> If parameter is set to false, the
(only applicable in complete surface of the screen is used
Launchpad) for the app. Otherwise, there is some
free space on the left and the right.
Default value is true.
semanticNavEnabled <true|false> If parameter is set to false, fields
(only applicable in with configured semantic navigation
Launchpad) are not active. Use the parameter if
target applications are not installed.
Default value is true.

284 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
Chapter 10
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


Starting with Business Center 16 SP1, an option is available to define a fix
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 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 achieve that these URLs do
not directly point to the archive but to a proxy service, you can use the Content
Server alias customizing.

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 (https://knowledge.opentext.com/knowledge/cs.dll/fetch/2001/3551166/
27085941/14272488/15050695/16643454/15770872/15774847/15777136/
WhitePaper_SAP_Scenarios_with_OpenText_Archive_Cache_Server.pdf?
nodeid=58613067&vernum=-2).

For the calculation of the Location (see section 5.3.2 “Defining additional locations
for Content Server aliases” in the White Paper), Business Center 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.

OpenText Business Center for SAP Solutions – Configuration Guide 285


BOCP160002-CGD-EN-01
Chapter 10 Accessing archived documents using a proxy service

The configuration of a proxy service in a SAP Web Dispatcher is described in the


SAP documentation (https://help.sap.com/saphelp_nw73/helpdata/en/1b/
b0fd8a12344c4ca89b7a1c5d1d7310/content.htm).

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, for example, section 3.1 “Deployment Options” in UI
Technology Guide for S/4HANA, on-premise edition 1511 (paragraph about
“Internet-Facing Deployment”), available in the SAP Help (https://
uacp.hana.ondemand.com/http.svc/rc/PRODUCTION/
pdffee10356f3b43a35e10000000a44538d/1511%20000/en-US/
UITECH_OP1511.pdf)

286 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
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.

OpenText Business Center for SAP Solutions – Configuration Guide 287


BOCP160002-CGD-EN-01
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.

288 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
Chapter 12
Document classification

This chapter describes automatic and manual document classification functions,


which are available from the Business Center 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 289:

Figure 12-1: Document classification components

Inbound Configuration - Capture

Classification
Automatic document classification by Business Center Capture. For more
information, see Section 4.6 “Function types for custom fields” 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).

OpenText Business Center for SAP Solutions – Configuration Guide 289


BOCP160002-CGD-EN-01
Chapter 12 Document classification

Classification Validation
Manual document classification within the Business Center Capture
Classification Validation, 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 86.

Document Processing

Workplace
Manual reclassification in the Business Center Workplace if required. A restart
of the Capture process might result from this in special cases.

Processing Screen
Manual reclassification in the Business Center 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.

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.

290 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
12.1. Document type handling

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 51.

12.1 Document type handling


The classification options are determined from the classification document type
customizing now. For more information, see “Assigning document types to
classifications” on page 52. If nothing is maintained there, the following “old”
statement is valid.

All classification options are directly based on SAP ArchiveLink document types as
defined in the Inbound Configuration for the corresponding registration type and
channel. For more information, see “Customizing registration types” on page 56.

You must link each document type that should be available for classification in the
OAC3 transaction to the following SAP Business Object Types. The Business Object
Types represent the different involved components of the Business Center
Foundation.

/OTX/PF01
Inbound Registration Object

/OTX/PF02
Process Object

After creating or posting SAP documents during the business process, additional
entries for Standard SAP Business Objects might be required to attach the incoming
documents to the target SAP Business Objects.

You can change the classification and therefore the currently set SAP ArchiveLink
document type at any time. This change results in adjusting the related ArchiveLink
connection entries or in re-archiving if also the content repository must be changed.

Note: Keep in mind to also offer an ArchiveLink document type representing


an unclassified incoming document. Maintain this document to be always
validated if no special classification handling is provided within the business
processes. This validation happens in the validation assignment settings of the
Inbound Configuration. Whether a document type can be considered as
classified or not is determined by its connected Business Center Capture
application. Assign an unclassified document type to a classification
application. Assign all classified document types to recognition applications.

OpenText Business Center for SAP Solutions – Configuration Guide 291


BOCP160002-CGD-EN-01
Chapter 12 Document classification

12.2 Processing impacts


This section describes classification-related dependencies between the Business
Center 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 52) are determined as classification options.
If no settings are found in the scenario classification, 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
integration.

Figure 12-2: “Processing impacts” on page 293 shows the connection between the
different involved components and the processing impacts that are considered when
technically handling a classification change:

292 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
12.2. Processing impacts

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 128.

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 142.

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
determine a connected Process Configuration profile. This offers a suitable
business process to fulfill the processing requirements.

OpenText Business Center for SAP Solutions – Configuration Guide 293


BOCP160002-CGD-EN-01
Chapter 12 Document classification

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:

Field name Description


CLASSI_ID Classification option ID
CLASSI_DESC Classification description

294 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
Part 3
Administering Business Center
Part 3 Administering Business Center

Besides the configuration of Business Center, you must also take some
administrative tasks into account. There are one-time administrative tasks like
scheduling jobs. There are also regular administrative tasks like the administration
of the SAP Business Workflow runtime engine. Workflow runtime administration
covers several transactions that you can use to monitor and control execution of
workflows like the following.
• Customizing workflow runtime
• Error monitoring for work items
• Monitoring work item rules
• Reorganizing work items
• Processing work items as administrator
• Maintaining substitutes

For details how to administrate the SAP Business Workflow runtime, see the SAP
Help (http://help.sap.com/saphelp_nw70ehp2/helpdata/en/95/
4b45b4b04211d2a5f80060087a79ea/content.htm?frameset=/en/88/
8be338b46c4950e10000000a11405a/frameset.htm&current_toc=/en/a5/
172437130e0d09e10000009b38f839/plain.htm&node_id=569&show_children=false).

296 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
Chapter 13

Security topics

This section provides an overview of security-related topics in Business Center.


Where applicable, this section adds links to more detailed descriptions.

Important
This section does not replace any basic SAP or company specific security
requirements. It also does not provide a detailed security concept. Additional
security aspects of SAP and also specific security aspects of the company
implementing Business Center must be taken in account additionally.

13.1 Using secure connections


To connect Business Center to systems like Business Center Capture, SAP systems,
or Archive Center, OpenText recommends that you always use a secure connection,
for example a trusted RFC destination between SAP ERP systems. For more
information about the customization of logical systems that are needed for trusted
RFC connections, see “Configuring logical systems” on page 23.

For Web Services connection settings, see “System landscape” on page 184.

13.2 Configuring authorization settings


Business Center is delivered with new authorization objects. The SAP authorization
object SAP_ALL must be re-generated to apply the authorizations to this object.

Business Center delivers the following general authorization objects.

Authorization Description Usage


object
J_6NPF_NAV Checks navigation in workplace according to Business Center
workplace ID. For more information, see Workplace
“Authorization objects” on page 180.
J_6NPF_WTY Checks work object type with related actions, Business Center
functions, and nodes. For more information, see Workplace
“Authorization objects” on page 180.
J_6NPF_PRF Checks the process configuration profile with Processing Screen
profile ID, characteristic attribute, and process Business Process
step. For more information, see “Authorizations”
on page 143.

OpenText Business Center for SAP Solutions – Configuration Guide 297


BOCP160002-CGD-EN-01
Chapter 13 Security topics

Authorization Description Usage


object
J_6NPF_ADM Is checked in all administrative reports, Administration
transactions, and programs. For more
information, see “Authorization objects”
on page 180.

For further details, see “Maintaining version settings” on page 109


(AUTH_CHECK_DATA method) and “Authorization Exit” on page 151.

298 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
Chapter 14

Batch jobs for Inbound Configuration

As mentioned in “Customizing incoming documents through the document


handler” on page 53, periodic jobs are necessary to set up the inbound processing
infrastructure completely. The following jobs are used to automate the inbound
processing.

• The status based document handler queue is managed with the document
handler job.
• Business Center Capture (BCC) in combination with look-up processing requires
download to staging tables.
• No longer used temporary data is deleted with the clean-up processing.

14.1 Document handler


Configure the /OTX/PF01_P_IDF_TRIGGER program as a job running every minute.
When running the IDF trigger job, the report picks up all items that have been
registered to the framework and that also have finished after the last run. So every
item will go through all steps defined in the customizing.

To configure a batch job for the document handler:

1. Run the /OTX/PF01_P_IDF_TRIGGER program.

2. In the Inbound Processing - Trigger Handler screen, configure the batch job for
the document handler, using the following parameters.

Registration ID
Enter the specific registration ID from the /OTX/PF01_T_1REG table.

Classification Profile
To run the report only for specific business scenario, enter the classification
profile.

Module Handler
To run the report only for a specific Handler ID, enter the Handler ID.

Document Type
To run the report only for a specific ArchiveLink document type, enter the
document type.

Number of items to process per run


To avoid an overflow, enter the number of entries that must be processed
per run.

OpenText Business Center for SAP Solutions – Configuration Guide 299


BOCP160002-CGD-EN-01
Chapter 14 Batch jobs for Inbound Configuration

Test mode
Select this check box to run the report in test mode. Test mode displays
results without any modification on the database.

Result
Select this check box to write the result to the batch job log or to display the
result in dialog processing.

14.2 Staging tables for the BCC integration


The download programs are only relevant if OpenText Business Center Capture for
SAP Solutions (BCC) is integrated with your installation. For detailed information
on BCC, see OpenText Business Center Capture for SAP Solutions - Administration Guide
(CPBC-AGD).

The download programs are used to provide data for look-up tables that are used by
BCC. The following download programs are available:
• Downloading the vendor database from SAP ERP
• Downloading the customer database from SAP ERP
• Downloading the company code database from SAP ERP

Note: Schedule the download programs as batch jobs. The job logs provide
information about the status.

14.2.1 Vendor database


You can download the vendor database from SAP ERP to the staging table /OTX/
PS00_T_STG1. To download the vendor database, run the /OTX/PS00_P_IDF_VENDOR
program.

300 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
14.2. Staging tables for the BCC integration

14.2.2 Customer database


You can download the customer database from SAP ERP to the staging table /OTX/
PS00_T_STG2. To download the customer database, run the /OTX/
PS00_P_IDF_CUSTOMER program.

OpenText Business Center for SAP Solutions – Configuration Guide 301


BOCP160002-CGD-EN-01
Chapter 14 Batch jobs for Inbound Configuration

14.2.3 Company code database


You can download the company code database from SAP ERP to the staging table /
OTX/PS00_T_STG3. To download the company code database, run the /OTX/
PS00_P_IDF_COMP_CODE program.

302 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
14.3. Clean up

14.3 Clean up
You can run the /OTX/PF01_P_IDF_CLEANUP program and schedule it in
background to clean up temporary data. This kind of data has been created by the
BCC dispatcher but is not needed afterwards.

Note: To run the /OTX/PF01_P_IDF_CLEANUP program, authorization for


J_6NPF_ADM is needed. For more information, see “Authorization objects”
on page 180.

OpenText recommends that you schedule the program once per month and that you
delete data older than 12 months.

To clean up temporary data:

1. Run the /OTX/PF01_P_IDF_CLEANUP program.

2. In the Inbound Processing - Clean-up Tables screen, configure the clean up,
using the following parameters.

XML Files tab


Deletes the XML documents in the archive storage.

Application Logs tab


Deletes the application log related information for the inbound processing.

Agent Table tab


Cleans the /OTX/PF01_T_VALA table for documents that are not waiting to
be validated.

OpenText Business Center for SAP Solutions – Configuration Guide 303


BOCP160002-CGD-EN-01
Chapter 14 Batch jobs for Inbound Configuration

Result Table tab


Cleans the /OTX/PF01_T_1EXT table for documents that have left the BCC
dispatcher.

Capture Center tab


Cleans inactive applications in tables /OTX/PF01_T_CFGV and /OTX/
PF01_T_CFGD.
To delete active applications from tables /OTX/PF01_T_CFGV and /OTX/
PF01_T_CFGD, run the /OTX/PF01_P_IDF_CLEANUP_APPL report.
To run the /OTX/PF01_P_IDF_CLEANUP_APPL report, authorization for
J_6NPF_ADM is needed. For more information, see “Authorization objects”
on page 180.

Feedback Pool tab


Sets the feedback indicator FEEDB_LEARN for documents in /OTX/
PF01_T_1REG to Obsolete. With this setting, the documents are not used for
feedback any more.

Month count
Indicates the minimum age of the entries to be deleted.

Active
Select this check box to activate cleaning for the selected tab.
If the check box is cleared, the tab is skipped. The green icon disappears
from the tab title.

In the Global settings area, you can select the following check boxes:

• Test run (count only)


• Skip dialogs that skips the dialogs before the deletion
If the program is run in background, Skip dialogs is selected automatically.

Additional options - The Application Logs tab and the Result Table tab
include additional options.
Application Logs includes the Delete IDOC entries as well check box. Select it
to specify that log entries with subobject IDOC are deleted as well.
Result Table includes the Delete lines w/o values only check box. Select it to
specify that only lines without values are deleted. Due to the implementation of
the Business Center Capture interface, 80 % of the lines are empty. If empty
lines are deleted, the table will be much smaller, and the results can still be
found in the table.

304 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
Chapter 15
License audit

If you are responsible for licenses, you must run a license audit report once a year.
This will indicate how many process instances in Business Center Process
Foundation have been started and completed in the observation period (one year).
You must send the output of the report to SAP or OpenText.

15.1 Auditing using SAP System Measurement


For the auditing purpose, you can use SAP System Measurement.

To update your system for SAP System Measurement:

1. Run the SM30 transaction and open the /OTX/PF00_T_LIC table.


2. Enter the following values (if not yet available):

Application
1166 for both entries.

Unit
1167 for Business Center - Capture
1166 for Business Center - Process.

3. Run the SM30 transaction and open the TUAPP table.


4. Enter the following value:

Application
1166 - SAP Digital Content Processing by OpenText

The SAP defined application ID with function module for Business Center
license measurement should look like the following screenshot:

OpenText Business Center for SAP Solutions – Configuration Guide 305


BOCP160002-CGD-EN-01
Chapter 15 License audit

5. Run the SM30 transaction and open the TUUNT table.


6. Enter the following values:

Unit
1166 for Process and Capture
1167 for Capture w/o Process

The entries should look like in the following screenshot:

After you have checked the system, trigger SAP System Measurement. For more
information, see the SAP Documentation (https://support.sap.com/keys-systems-
installations/measurement/information/Documentation.html). BCC and Business
Center are counted separately.

15.2 Auditing using OpenText Licenses Auditing


Services
To check your system for the auditing:

1. Run the SM30 transaction and open the /OTX/PF00_T_LIC table.

Note: The Business Center package contains two entries, one for Business
Center Capture and one for Business Center Process.

2. Check the existence of the entries.


Application is 1166 for both entries.
Unit is 1167 for Business Center - Capture and 1166 for Business Center -
Process.

306 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
15.2. Auditing using OpenText Licenses Auditing Services

To process the auditing:

1. After you have checked the system, trigger the system measurement using the /
OTX/PF00_P_LIC report.

2. On the License Audit selection screen, specify the period (one year). Also
specify the related systems according to your system landscape.
You might not have a multiple system environment or you might not want to
include all available systems of your multiple system environment. In these
cases, run the report on each system where Business Center is installed.

3. Send the result of the license audit to OpenText.

OpenText Business Center for SAP Solutions – Configuration Guide 307


BOCP160002-CGD-EN-01
Chapter 16
High availability

Business Center supports the standard SAP high availability concept. For detailed
information, refer to the documentation provided under http://help.sap.com/
saphelp_nw70/helpdata/DE/3a/9659c492818e468ddf0cc0391c03b1/content.htm.

OpenText Business Center for SAP Solutions – Configuration Guide 309


BOCP160002-CGD-EN-01
Chapter 17
Regular administration tasks

This part covers administration tasks that must be carried out regularly. These tasks
are not executed on a daily basis by an agent, but must be carried out by a
responsible to keep the business process running.

17.1 Setting up substitutes for workflow processes


Substitutes can be set up for the SAP inbox. If a work item owner is on vacation or
leaves the company, the substitute can “adopt” the work items owned by the
substituted user.

For the SAP inbox substitution, see the SAP Help: http://help.sap.com/
saphelp_erp60_sp/helpdata/en/8d/25f558454311d189430000e829fbbd/frameset.htm.

17.2 Reassigning work items belonging to another


user
OpenText recommends all workflow users setting up a substitute; see “Setting up
substitutes for workflow processes” on page 311. If a work item owner is on vacation
or leaves the company, the substitute can “adopt” the work items owned by the
substituted user. However, situations might occur when a user has not set up a
substitute and the work items needs immediate attention. As a Business Center
workflow administrator, you can reassign such work items to one or more other
user(s).

17.2.1 Retrieving open SAP work items of a specific user


You can retrieve open work items belonging to a specific user through the SAP
standard Workload Analysis report. Each work item has a Work Item ID which is a
unique number identifying the work item.

To retrieve open SAP work items of a specific user:

1. To access the Workload Analysis report, run the SWI5 transaction.

OpenText Business Center for SAP Solutions – Configuration Guide 311


BOCP160002-CGD-EN-01
Chapter 17 Regular administration tasks

2. Enter the following information in the selection screen:

Type
US

ID
SAP user ID of the specific user

Click To be processed by.

3. To run the report, click .


The report shows all SAP work items belonging to the user, regardless of
whether they are Business Center work items or not.
4. Click the icon to view the work item IDs.
With the work item IDs, you can assign the work items to a different user; see
“Reassigning open SAP work items to a different user” on page 313.

312 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
17.2. Reassigning work items belonging to another user

17.2.2 Reassigning open SAP work items to a different user


After you have identified the work item IDs, you can reassign them through the SAP
standard transaction Execute work items without agent check.

To reassign a work item to a different user:

1. To access the Execute work items without agent check screen, run the SWIA
transaction.

2. Enter the work item ID retrieved in “Retrieving open SAP work items of a
specific user” on page 311 and click to execute.
Before you can reassign, you must be an owner of the work item.
3. To own the work item, select it and click the Without check button in the
application tool bar.
This action leads you to the Processing Screen.
4. Click to return to the Execute work items without agent check screen.
5. Click in the application tool bar to display the work item.
6. Click in the application tool bar to forward the work item.

7. Enter the SAP user ID of the receiver of the work item and click to execute.

OpenText Business Center for SAP Solutions – Configuration Guide 313


BOCP160002-CGD-EN-01
Chapter 17 Regular administration tasks

At the bottom of the screen, a confirmation message is displayed: Forwarding


carried out.

17.3 Administering workflows on a regular basis


17.3.1 Backup
The configuration of Business Center is stored inside SAP ERP, in the OpenText
product tables. A backup of the underlying SAP ERP system ensures the backup of
the appropriate configuration, runtime and persistent data. In addition, system
transports store any configuration changes that are made.

17.3.2 Data archiving


You can archive old data using the SAP archiving object WORKITEM and others.
Before removing any old data, consider carefully the business requirements about
data availability. Specially, since the business objects in scope of the Business Center
processes are financial in nature, local regulations need to be considered in making
such decisions. OpenText generally recommends that such initiatives are performed
as a part of an overall data archiving initiative.

17.4 Cleaning up BCC


For information how to clean up temporary data in BCC, see “Clean up”
on page 303.

17.5 Cleaning up search helps and web IDs


Additional information for search helps are automatically generated at the first time
the search help is used by a field in the display structure or item structure. The
additional information is saved in table /OTX/PF62_T_AIHL. After changing the
display structure or item structure of a work object type, you must delete (clean up)
the additional information.

Web IDs are automatically generated the first time an object is displayed in the Fiori
Task App. To avoid a continuous growth of table /OTX/PF62_T_ID, you must delete
(clean up) older web IDs periodically.

Note: Deleting web IDs includes the deletion of data collections that have been
created for these web IDs.

To clean up search helps and web IDs:

1. Run the /OTX/PF62_ADMIN transaction.

2. In the Web UI Administration screen, perform the clean up, using the
following parameters.

314 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
17.6. Running a license report

Search helps

Clean Up search helps


To enable cleaning up, select this check box.

Search help ID
Enter the search help ID to be deleted.

Work Object Type


Enter the work object type (range) for which you want to delete search
helps.

Web ID

Clean Up Web IDs


To enable cleaning up, select this check box.

Only Web IDs older than (days)


Enter number of days.

Work Object Type


Enter the work object type (range) for which you want to delete web IDs.

Data Collections

Clean Up Data Collections


To trigger the deletion of existing data collections, select this check box.
There are no further restrictions available.

Note: The deletion of data collections is included in the deletion of


web IDs. Therefore, it is not necessary to schedule this task as a
regular job.

You can schedule the report in background or run it directly. When the report is run,
authorization object J_6NPF_ADM, field J_6NPF_COM (Component) is checked for
value 4 Web UI. For more information, see “Authorization objects” on page 180.

17.6 Running a license report


For information how to run a license report, see “License audit“ on page 305.

OpenText Business Center for SAP Solutions – Configuration Guide 315


BOCP160002-CGD-EN-01
Chapter 18
Administering workflows

This chapter covers general activities for checking the system status of Business
Center.

18.1 Monitoring alerts


System availability and performance depend on the availability of the underlying
SAP ERP system.
• You can conduct system performance checks using the SAP standard tools. The
SE30 transaction, for example, provides a runtime analysis of projects and
components.
• Resource consumption information can be monitored using the SM50 transaction
and other SAP administration utilities that are part of the SAP Computing Center
Management System (CCMS).
Business Center does not provide MTE classes together with the ABAP Add-Ons
OTBCBAS, OTBCFND, OTBCRM, OTBCWSR and OTBCWUI.
• You can use all the SAP standard logs and other infrastructure like the SM13 and
SM21 transactions for monitoring.

The following sections describe how to use the SAP Standard CCMS functionality
for alert monitoring.

For more information, see the SAP NetWeaver Administrator’s Guide (https://
help.sap.com/saphelp_nwesrce/helpdata/en/45/2bdafff14003c3e10000000a1553f6/
frameset.htm).

18.1.1 Setting up central alert monitoring


Business Center is completely embedded inside the SAP ERP system. Hence, you
can use the entire general alert monitoring infrastructure for checking the health of
the system and Business Center.

Business Center does not need a separate Central Monitoring System (CEN) system.
To monitor Business Center, use the existing CEN system that is connected to the
SAP ERP system on which Business Center is installed. For configuring the CEN, see
the SAP online help: http://help.sap.com/saphelp_nw70/helpdata/EN/9d/
df1241c738f423e10000000a155106/frameset.htm

OpenText Business Center for SAP Solutions – Configuration Guide 317


BOCP160002-CGD-EN-01
Chapter 18 Administering workflows

18.1.2 Registering a CCMS agent


Business Center is an ABAP Add-On and all the functionality is embedded in the
SAP ERP ABAP system. The standard CCMS agent SAPCCM4X can be used. If the
underlying SAP ERP system is already registered in a CEN, you do not need to
register anything. See the SAP online help for registering a CCMS agent: http://
help.sap.com/saphelp_nw70/helpdata/EN/ca/118110ff542640b7c86b570cc61ae3/
frameset.htm.

18.1.3 Monitoring using CCMS templates


Various monitors based on CCMS templates are available for system checking
purposes. You can use the following SAP CCMS Monitor Templates monitor sets:

Notes

• Depending on your SAP ERP system, some of the templates might not be
available.

Monitor Usage
Availability: Availability monitoring of selected systems and their application servers
Selected
Systems
Background Background processing of the SAP ERP systems and their application
Processing servers
Buffers The various SAP buffers, their hit rates, and swap rates
Change & Transports for a system
Transport
System
Communicatio Data transfers (SAPconnect, SAP Gateway, Application Link Enabling,
ns LDAP, RFC)
Data Archiving Monitored data archiving sessions
Database Database (such as table status, performance, backups, data consistency)
Dialog Overview of the dialog system, broken down by performance attributes
Overview
Enqueue Enqueue service. This service allows ABAP applications to lock data so
that only they can use it. The locking of the data avoids parallel changes to
the data, which would lead to data inconsistency.
Entire System Entire system (including detailed information about SAP services)
Operating Operating system data for any application servers and host systems
System
Security Security Audit Log and security-relevant messages in the system log
Spool System Spool system of the SAP ERP system and the individual output servers

318 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
18.1. Monitoring alerts

Syslog System log broken down by application servers and individual topic areas
System Number of logged-on users and configuration settings of application
Configuration servers

You can copy these monitors and change them. See the SAP online help for more
details: http://help.sap.com/saphelp_nw70/helpdata/en/28/
83493b6b82e908e10000000a11402f/content.htm.

To start a CCMS templates based monitor:

1. Run the RZ20 transaction and select the menu option Extras > Activate
maintenance function.
In the CCMS Monitor Sets screen, expand the SAP CCMS Monitor Templates
menu.

OpenText Business Center for SAP Solutions – Configuration Guide 319


BOCP160002-CGD-EN-01
Chapter 18 Administering workflows

2. Double-click a monitoring tree element (MTE), for example Background


Processing.

3. Double click on a line item, for example AbortedJobs, to see details.

4. Return to the SAP CCMS Monitor Templates screen.


Click on a line item, for example Utilisation, and click the Properties button in
the application tool bar.
The Monitoring: Properties and Methods screen displays other settings like
methods used and threshold values set.

320 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
18.1. Monitoring alerts

As CCMS is a standard monitoring tool from SAP, Business Center does not
require specific values for the property thresholds. SAP basis needs to decide
the level and to set the thresholds for this.

To set threshold values:

a. In the Monitoring: Properties and Methods screen, click .


b. Enter the threshold values and save.

OpenText Business Center for SAP Solutions – Configuration Guide 321


BOCP160002-CGD-EN-01
Chapter 18 Administering workflows

18.2 Using logs and traces


Business Center uses the SAP Workflow Engine to realize the process setup of the
business processes. Hence, you can activate and use traces to check specific sets of
activities as a part of problem analysis.

SAP workflow logs are written for every activity of the process and therefore are
always available.

In addition to the standard system logs, you can use the SM21 transaction to check
system activities. See “Frequently used SAP workflow administration transactions”
on page 322 for transactions you can use for activity logging and traces.

Business Center also writes log to the standard system log infrastructure. See
“Configuring logging” on page 29 for details.

18.3 Frequently used SAP workflow administration


transactions
There are a couple of SAP workflow administration transactions that you can use to
administer Business Center workflows:

SWIA: Execute work items without agent check


To reassign open SAP work items to a different user, run the SWIA transaction.

SWI1: Selection Report for Work Items


To display all work items (workflow template, dialog task, wait step,
background task) based on a custom selection, run the SWI1 transaction.

SWE2: Event Type Linkages


To display or change event type linkages for Business Center workflows, run the
SWE2 transaction.

SWEL: Display Event Trace


To display lists of events published during a specific duration, run the SWEL
transaction.

18.4 Retrieving technical configuration


It can be necessary to know how to retrieve the component specific technical
configuration settings, for example, if an unexpected crash happens. Business Center
provides the following tools for that purpose.

• The /OTX/PF00_IMG transaction provides access to the complete configuration


and customizing.
• BC Sets of all components can be activated. For more information, see Section 6.2
“Activating BC sets” in OpenText Business Center for SAP Solutions - Installation
Guide (BOCP160002-IGD).

322 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
Chapter 19

Troubleshooting

This chapter collects information how to fix errors that can arise when working with
Business Center.

19.1 Monitoring activity


Business Center uses the SAP Workflow Engine to realize the process setup of the
business processes. You can effectively use the workflow runtime and
administration tools to monitor the activity and resources as the business processes
are proceeding. For activity monitoring purposes, see “Frequently used SAP
workflow administration transactions” on page 322 and SAP Business Workflow
Administration (http://help.sap.com/saphelp_erp60_sp/helpdata/en/95/
4b45b4b04211d2a5f80060087a79ea/content.htm).

19.2 Fiori Task App: detailed error messages


The Fiori Task App might stop working due to an unrecoverable error. In this case,
the Fiori Task App shows a general error message. Click Show details to get
detailed information (Support Info) about the following:

• the place where the processing failed


• the view that caused the issue
• the invoked OData entity with parameters

When contacting OpenText Customer Support, provide the Support Info. Click
Download Support Info. The Support Info is mandatory for solving the issue that
occurred in your environment.

OpenText Business Center for SAP Solutions – Configuration Guide 323


BOCP160002-CGD-EN-01
Chapter 19 Troubleshooting

19.3 Fiori Task App: error messages and log entries


In case of an error message in the Fiori Task App, you get a log entry in the /IWFND/
ERROR_LOG transaction on the SAP NetWeaver® Gateway.

The ERROR_INFO field shows error messages raised by the backend system. The
REQUEST_URI field shows the call which caused this error.

To display details of the error:

1. If parts of the URI are hidden due to the secure log level, change the error log
level in the /IWFND/TRACES transaction.

2. Reproduce the error and check the /IWFND/ERROR_LOG transaction again.


The new error log displays all details of the request URI.
The Fiori Task App often uses $batch calls for retrieving data from the service.

3. To display details for these calls, click Request Data.

4. To test single calls, run the /IWFND/MAINT_SERVICE transaction.


Depending on the error type, additional log entries might be written in the SAP
application log of the backend server.

324 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
19.4. Issues with the Fiori Launchpad and the Fiori Task App

19.4 Issues with the Fiori Launchpad and the Fiori


Task App
This section gives some general hints for problem analysis. It is helpful to use the
Chrome Browser and its rich developer toolset. You can switch it on by pressing F12.
Alternatively, on the menu, click More tools > Developer tools.
• The developer tools are organized in different tabs. To display Log-Output, click
the Console tab.
• On the Network tab, you can record all requests that were sent.

Note: All $batch requests are OData services calls that the Fiori Task App
performs to get the necessary data from the backend.

19.5 Document viewing issues


The following issues can occur in connection with document viewing.

Problem: Sign-in screen is shown when returning to Fiori Task App from
Document View on iPhone or iPad.

Explanation
This happens if the Fiori Task App is launched from the home screen and
inplace document viewing is not configured.
Solutions
• Configure inplace document viewing. For more information, see “Enabling
inplace document viewing for iPhone and iPad” on page 236.
• Launch the Fiori Task App as a “normal” browser bookmark.

Problem: Cannot return to Fiori Task App after viewing a document on iPhone
or iPad using Fiori Client App.

Explanation
This happens if no inplace document viewing is configured, and the native iOS
Viewer is opened in a new tab. This viewing mode is not supported inside the
Fiori Client App.
Solution
• Configure inplace document viewing. For more information, see “Enabling
inplace document viewing for iPhone and iPad” on page 236.

Problem: Instead of the document, an empty page is displayed.

Explanation
This happens if Fiori Task App (Launchpad) is served with a different protocol
then the configured archive or viewing system. A mixture of HTTP and HTTPS
is not allowed.

OpenText Business Center for SAP Solutions – Configuration Guide 325


BOCP160002-CGD-EN-01
Chapter 19 Troubleshooting

Solution
• Configure the same protocol for all involved systems.

326 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01
Chapter 20
Customer Support

You can contact the OpenText Customer Support team with the contact information
available at http://support.opentext.com. Alternatively, if you bought the solution
from SAP, you can open a message in the SAP Service Marketplace for component
XX-PART-OPT-DCPSAP (SAP Digital Content Processing by OpenText).

Important note for SAP Reseller Customers

For information about all OpenText products resold by SAP (including


Business Center), check SAP Marketplace Note 1791874: SAP Products by
OpenText - Software and Support Lifecycle. This note provides detailed
information about software life cycle, access to Support Packages, access to
latest documentation, language packages, and other patches, as well as
Support ticket handling.

Remote support is possible through the SAP solution manager with CSS message.
You must open the connection to the system and provide appropriate
authorizations.

To view logs, Business Center provides the read-only transactions /OTX/PF03_WP


(Business Center Workplace) and /OTX/PF02_PROC_LOG (Process Foundation Log).

OpenText Business Center for SAP Solutions – Configuration Guide 327


BOCP160002-CGD-EN-01
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 Foundation

Central Business Center unit that serves to import, capture, dispatch, process, and
consume business objects. It comprises Inbound Configuration, Process Foundation,
Process Configuration, Business Center Workplace, and Fiori Task App.

Business Center 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.

Business Center

OpenText Business Center for SAP Solutions. OpenText product that helps
receiving incoming documents, capturing processes, and filing them within a SAP
system.

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. Business Center
Inbound Configuration is also used in VIM.

Perspective 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.

OpenText Business Center for SAP Solutions – Configuration Guide 329


BOCP160002-CGD-EN-01
Glossary

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.

Solution Accelerator

Preconfigured business scenario that ensures a fast implementation phase. The


following solution accelerators are available: incoming sales orders, purchase
order / purchase requisition, incoming delivery notes, incoming HR documents,
incoming remittance advices, and incoming order confirmations.

Template

Static part of a perspective. The template describes the layout of the perspective.
You can copy and adjust templates to your needs. A template does not include
concrete views.

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. Business Center is tightly integrated with
VIM.

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 Business Center Workplace. It can represent a process


object, a SAP business object, or information from any SAP tables.

330 OpenText Business Center for SAP Solutions – Configuration Guide


BOCP160002-CGD-EN-01

You might also like