Professional Documents
Culture Documents
OpenText Vendor Invoice Management for SAP Solutions 20.4 - Configuration Guide for Foundation English (BOCP200400-CGD-EN-06) (1)
OpenText Vendor Invoice Management for SAP Solutions 20.4 - Configuration Guide for Foundation English (BOCP200400-CGD-EN-06) (1)
BOCP200400-CGD-EN-06
OpenText™ Vendor Invoice Management for SAP® Solutions
Configuration Guide for Foundation
BOCP200400-CGD-EN-06
Rev.: 2021-Feb-22
This documentation has been created for OpenText™ Vendor Invoice Management for SAP® Solutions 20.4.
It is also valid for subsequent software releases unless OpenText has made newer documentation available with the product,
on an OpenText website, or by any other means.
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
One or more patents may cover this product. For more information, please visit https://www.opentext.com/patents.
Disclaimer
Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the
accuracy of this publication.
Table of Contents
1 About Vendor Invoice Management for SAP Solutions ......... 7
1.1 Architectural Overview ....................................................................... 9
1.2 About this document ........................................................................ 10
Part 1 Customizing 17
OpenText Vendor Invoice Management for SAP Solutions (VIM) is an ABAP add-on
solution to SAP ECC and SAP S/4HANA.
If no business rules fail, the document is posted in SAP without human intervention.
Although a straight through, no-touch process is the ultimate objective, VIM also
supports the fast and efficient handling and resolution of exceptions.
Exceptions are routed via workflow to the relevant user or user group based on the
role assigned to the exception.
• Invoice Solution
– Order Confirmation
– Delivery Note
– Quotation
– Sales Order
– Remittance Advice
Since VIM resides inside SAP, enrichments and business rules have direct access to
SAP master and transactional data, which avoids complex interfaces and the
replication and duplication of data.
Each solution offers a Workplace used by end-users and managers to manage and
monitor outstanding and completed work items. Each solution includes a
preconfigured set of analytical measures tailored for the specific document scenario.
Solutions can be enhanced to support company-specific business requirements.
VIM Solutions use features offered by its powerful feature rich Foundation.
• Inbound
• Process
• Workplace
• Analytics
VIM also supports custom solutions where a preconfigured solution is not available
for a specific, less common business process.
VIM offers a simple and intuitive user interface for end-users, managers and
administrators.
Users can choose between the classic SAP GUI or the modern SAP Fiori interface.
SAP Fiori offers a responsive web-based user interface that supports desktop and
mobile devices.
VIM supports various input channels including scan, fax¸ e-mail and web services.
It also supports various input formats, including paper, PDF, TIFF, IDoc and XML.
Document Access for SAP Solutions or OpenText Core Archive for SAP Solutions for
the storage of documents.
VIM integrates seamlessly via its Inbound component with OpenText Intelligent
Capture for SAP Solutions and OpenText Core Capture for SAP Solutions, which
uses advanced machine learning algorithms to extract metadata from imaged-based
documents like PDF and TIFF.
VIM also offers integration with OpenText Extended ECM for SAP Solutions and
OpenText Document Presentment for SAP Solutions.
Beside the components of this graphic, VIM offers additional components such as
SAP NetWeaver Business Warehouse or BW/4Hana for specific solutions which are
not shown in this basis architectural overview.
• OpenText Vendor Invoice Management for SAP Solutions - User Guide for Invoice
Solution (VIM200400-UGD)
• OpenText Vendor Invoice Management for SAP Solutions - Configuration Guide for
Invoice Solution (VIM200400-CGD)
• OpenText Vendor Invoice Management for SAP Solutions - Administration Guide
(VIM200400-AGD)
• OpenText Vendor Invoice Management for SAP Solutions - Reference Guide for Invoice
Solution (VIM200400-RGD)
• OpenText Vendor Invoice Management for SAP Solutions - Scenario Guide for Invoice
Solution (VIM200400-CCS)
• OpenText Vendor Invoice Management for SAP Solutions - Security Guide
(VIM200400-GSM)
• OpenText Vendor Invoice Management for SAP Solutions - Security Guide
(VIM200400-GSM)
• OpenText Vendor Invoice Management for SAP Solutions - Configuration Guide for
Foundation (BOCP200400-CGD)
• OpenText Vendor Invoice Management for SAP Solutions - Configuration Guide for
Solutions Beyond Invoice (BOCP200400-CCS)
• OpenText Vendor Invoice Management for SAP Solutions - User Guide for Solutions
Beyond Invoice (BOCP200400-UGD)
The Release Notes are updated continuously . The latest version of the Business
Center Release Notes is available on OpenText My Support (https://
knowledge.opentext.com/knowledge/cs.dll/Open/10151494).
Before you start with installation and detailed configuration, make sure that the
following actions have been performed:
• Install and configure an archiving system that supports the SAP HTTP Content
Server interface.
• Create User IDs with appropriate developer and configuration authorizations.
Authorizations need to include developer as well as workflow administrator
authorizations.
• Make sure that the SAP Business Workflow Runtime Engine is configured.
The configuration steps describe the basic mandatory customizing. This customizing
must be done with every installation and for every used solution. For the solution
specific customizing, see the respective parts in this document.
Important
• For the following procedure, you must sign in in English to avoid problems
with the activation of the BC sets.
• You must activate all BC sets using Expert Mode.
• When you activate the BC sets, you might get dialog boxes, for example a
message about an error in Object Editing. Just confirm them with Copy
Values or OK.
Activate the BC sets only for English language. Other languages are delivered with
specific language packs. You find the language packs on OpenText My Support.
To activate BC sets:
Important
After updating the backend versions and activating the BC sets, you must
execute the transaction /OTX/PF62_ADMIN in this backend system and clean up
WebIds, search helps and DataCollections.
With the Foundation component of Vendor Invoice Management for SAP Solutions,
the following general authorization objects are delivered:
On each system running VIM Foundation, there must be an entry with LOCAL as
logical system. For every system that needs to be connected, an additional entry is
required. For more information, see Section 3.2 “Configuring logical systems” in
OpenText Vendor Invoice Management for SAP Solutions - Configuration Guide for
Foundation (BOCP200400-CGD).
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.
The general settings are global settings, which are used in different areas.
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 299.
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.
The Fiori Task App can request a change for a lock entry. In this case, a check value
checks if the change applies to the same lock entry that was originally requested by
this instance of the Fiori Task App. This check value is generated and returned to the
requestor at the set of lock entries. You must use the check value as import
parameter for all further changes that are requested for this lock entry.
You can implement additional lock operations using the /OTX/PF00_LOCK BAdI.
This BAdI has the following interface.
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.
Caution
On each system running VIM Foundation, an entry with LOCAL as logical
system must exist. For this entry, no RFC destination must be maintained.
2. Click OpenText Business Center for SAP Solutions > General Settings >
Logical Systems.
3. In the Logical Systems Overview screen, configure logical systems, using the
following parameters.
Logical system
Name of the logical system. See the SAP documentation on how to set up a
logical system.
Description
Enter a description of the system.
RFC for System Communication
Enter the RFC destination for communicating to the system. OpenText
recommends that you use this RFC destination with system or
communication users, not with dialog users. See the SM59 transaction to
create an RFC destination.
RFC for Dialog Communication
Enter the RFC destination for communicating by active dialog screen.
OpenText recommends that you use a trusted RFC destination in this case.
See the SAP documentation on how to set up trusted connections between
SAP ERP systems.
Processing Screen
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.
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.
FREE – You must use this method to reset the corresponding plug-in SAP GUI
control and any used data or class attributes.
2. In the Plug-In Type Mapping Overview screen, assign plug-in IDs to plug-in
types, using the following parameters:
Plug-In Type
Unique ID of the plug-in type definition.
Plug-In ID
Unique ID of the plug-in definition.
Plug-In Sequence
Define the order of the buttons for the plug-in.
Handle
Define a unique ID of the Handle.
For one plug-in type you can assign different plug-in definitions that
implement an ALV table control (for example History, Actual Agent or Line
Items). For each ALV table control, you can store an individual layout. To
provide this functionality if there are several plug-in definitions assigned to
one plug-in type, the Handle must be different for the plug-in IDs that
implement an ALV table control.
Note: Special number ranges are used for Handle values, any custom
plug-ins must use the Handle number range 8000 - 9999.
PI Active
Select this check box to activate the plug-in on the screen.
2. Click OpenText Business Center for SAP Solutions > General Settings >
Processing Plug-In Configuration > Assign Plug-In IDs to Business Object.
3. In the Plug-In Business Object Relation Overview screen, assign plug-in IDs to
business objects, using the following parameters.
Plug-In ID
Unique ID of the plug-in definition.
Object Type
Enter the SAP business object type used by the plug-in.
Field List (Key)
Enter key fields of the business object in a comma-separated list. The key
fields are used in the data context provider of the plug-in class to get the
related information.
To view the application log, run the SLG1 transaction. You can access the whole
application log in the /OTX/PF00 object. To access a specific component of the log,
you can use the related sub-objects.
Sub-objects of /OTX/PF00
2. Click OpenText Business Center for SAP Solutions > General Settings >
Logging > Log Levels.
3. In the Log Levels Overview screen, configure log levels, using the following
parameters.
Object
Name of the log object
Subobject
Name of the detailed log-subobject
Loglevel
Enter the level at which issue types should be logged (this level and higher)
• very important
• important
• medium
• Additional information
• Other
Days to expiry
Number of days until the created log entries expire. This setting is only
used if no detailed setting is found on log point level. If both values are not
maintained a default value of 90 days is used.
2. Click OpenText Business Center for SAP Solutions > General Settings >
Logging > Log Points.
3. In the Log Points Overview screen, configure log points, using the following
parameters.
Log Point
Unique log point
Short Text
Enter a description of the log point.
Program Name
Enter the name of the program or the part name of the program where the
log entry is written
Object
Enter the name of the log object
Subobject
Enter the name of the detailed log-subobject
Loglevel
Enter the level at which issue types should be logged (this level and higher)
• very important
• important
• medium
• Additional information
• Other
Days to expiry
Number of days until the created log entries expire. If no value is
maintained the log level setting is used. If both values are not maintained, a
default value of 90 days is used.
Language:
SAP language key
Language Key:
Language key used within the translation service
Enhancement spot
/OTX/PF00_ES_SRV_TRANSLATION
BADI
/OTX/PF00_BADI_TRANSLATION
You must implement the following methods. The methods in the example class
maintained in the enhancement spot contain further instructions.
GET_AVAILABLE_LANGUAGES
This method returns the allowed target languages for translations. Required are
the language key in the format for the translation service and the corresponding
SAP language key with the description.
The /OTX/PF00_CL_TRANSLATION_FALL example class B provides logic to read
the available languages from the language configuration. Copy the example
class during your BAdI implementation.
CALL_TRANSLATION_SERVICE
In this method, you can implement the call to the external translation service.
You find examples how to call the web service in the API description of the
chosen service provider.
You must send the input string (PIV_INPUT) to the external service. You must
export the translated string in export parameter PEV_TRANSLATED_STRING. The
requested language is imported in parameter PIV_LANGUAGE.
Note: As the source language of the comment string cannot be safely
determined from ABAP side, an additional call to a language
determination service might be necessary. Some translation services
include this determination when calling the translation service.
IS_ACTIVE
This method returns whether the Translate action should be displayed in the
Fiori apps. To activate this functionality globally, you can set the export
parameter PEV_ACTIVE to true (X) without any further logic.
The method provides several import parameters for more complex activation
logic, for example to build activation logic based on authorizations.
SAP provides a lot of different tools to create analytic reports, for example SAP
Smart Business, SAP Lumira, SAP BW, SAP Business Objects, or the classic SAP GUI
ALV.
Due to this variety of tools and due to the fact that all customers have different
reporting requirements, OpenText does not provide an Analytics report.
What OpenText provides is a layer with a lot of data, prepared for evaluations. This
data may serve as a base for end user reports, which you can create using your
preferred reporting tool.
You can perform analytic evaluations on database tables that are written throughout
the process. These database tables contain the transactional data.
However, key figures may need to be transformed into different formats or they
need to be calculated “on the fly”.
In these cases, the runtime of analytic reports may decrease very quickly when the
amount of documents is growing. This is the reason, why OpenText decided to
introduce a further set of database tables, especially designed for the purpose of
Analytics. Let us call them Analytics database tables, being part of an Analytics
layer. You can configure whether these Analytics database tables are written or not.
This section describes this and other settings regarding the Analytics layer:
Rule Log
This database table comprises snapshots of the rules that failed, passed
successfully, or that were inactive, skipped, or bypassed.
This section gives an overview of the available data of the inbound process which
can be used for analytics of business processes.
Fields which are not described here are either technical fields or not relevant for
business processes. Some fields are reserved for future use.
Name Description
INB_SYS Inbound Logical System
CHANNEL_ID Inbound Channel ID
REGID Inbound Registration ID
HANDLE_ID Inbound Handle ID
CLASSIFY Inbound Classify
ORIGIN_TIME Inbound Origin Time
ORIGIN_USER Inbound User
EDI_DOCNUM Inbound IDOC Number
EXTRACTION_IND Indicator that extraction is applied
VALIDATION_IND Indicator that validation is applied
EXTRACTION_TYPE Technical field:
• “CLOUD”: IES-API is applied.
• “”: BCC is applied.
CLOUD_EXTRACTION Technical field:
• “x”: IES Cloud is applied.
• “”: IES on Premise is applied.
PROC_FINISHED Indicator that the inbound process is finished
LOGSYS Logical system of the solution system
PROJECT_ID Profile ID of the solution
PLKEY Process ledger key of the solution
START_DATE Start date of the inbound process
START_TIME Start date of the inbound process
START_<...> Start week, month, quarter or year
depending on the <...> name
Name Description
END_DATE End date of inbound process
END_TIME End time of inbound process
END_<...> End week, month, quarter or year depending
on the <...> name
CHANGE_DATE Technical field: Date of the update of the log
entry
CHANGE_TIME Technical field: Time of the update of the log
entry
Name Description
TSP_REGISTER Timestamp for the document registration in
the inbound process
TSP_CHANGE Timestamp for an entry change in /OTX/
PF01_T_1REG table.
TSP_FINISH Timestamp for the completion of the
inbound process
TSP_UPDATE Timestamp for an entry update in /OTX/
PF08_T_REGA table
START_DATE Start date of the inbound process
START_TIME Start date of the inbound process
START_<...> Start week, month, quarter or year
depending on the <...> name
END_DATE End date of inbound process
END_TIME End time of inbound process
END_<...> End week, month, quarter or year depending
on the <...> name
CHANGE_DATE Technical field: Date of the update of the log
entry
CHANGE_TIME Technical field: Time of the update of the log
entry
Name Description
DOC_COUNTER The dummy document number is 1. When
cumulated it provides the number of
documents for a certain filtering.
PROC_DURATION_S The total inbound process time in seconds.
PROC_DURATION_M The total inbound process time in minutes.
PROC_DURATION_H The total inbound process time in hours.
PROC_DURATION_D The total inbound process time in days.
• Key figures are numeric values or quantities, such as Per Unit Sales Price,
Quantity Sold, and Order Placement Cycle Time in days.
Note: The guide can only provide some examples to give an idea about
possible evaluations. You can create a lot more evaluations with the existing
key figures.
Time characteristics are calculated using the UTC time zone. Use the available
timestamps in the tables to calculate user-specific time characteristics.
Additionally, you can enhance the Analytics class (see “Analytics class”
on page 48) to provide additional custom or solution specific key figures.
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.
Note: If a business process is still running, the duration key figures are not
populated.
PROC_DURATION_S,
PROC_DURATION_H,
PROC_DURATION_M
PROC_DURATION_D, Document Cycle Time when rules failed (Total process time
PROC_DURATION_S, when rules failed)
NO_MOD_FAILED
ACV_DURATION_M, Document Processing Time (Summarized manual
processing time)
ACV_DURATION_D,
Note: The manual processing time cannot be
ACV_DURATION_H,
determined if the dialog step is not finished properly.
ACV_DURATION_S
Example: An end user started editing a document on
his notebook. The user does not close the application
by clicking Save or Cancel but closes the notebook or
terminates the process with operation system means.
In this case, the processing time from the start of the
editing to closing the notebook or terminating the
process is 0.
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.
WAIT_TIME_D,
WAIT_TIME_H,
WAIT_TIME_S
ACV_DURATION_M, Breakdown between wait time and work time by role
ACV_DURATION_D,
ACV_DURATION_H
ACV_DURATION_S,
WAIT_TIME_D,
WAIT_TIME_S
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.
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.
With this table, you can design evaluations providing information about failed or
bypassed rules.
The supported scenarios, respectively the profile types, are predefined. Adding new
profile types or deleting existing profile types is not supported.
• 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?
To define a profile:
3. In the Profile Types Overview screen, mark a profile type, and then double-
click Profiles in the Dialog Structure.
4. In the Profiles Overview screen, define the profile using the following
parameters.
Profile ID
Define the profile with a unique ID.
Active
To set the profile to active, select this check box. If the profile is inactive, no
data is prepared and updated for the purpose of Analytics.
Prof. Desc.
Profile Description. Enter a meaningful profile description.
Analytics Class
Enter the class that is responsible for the preparation of data for Analytic
evaluations. For more information, see “Analytics class” on page 48.
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-14: Mandatory key fields for the Analytics header tables
• /OTX/PF08_S_PLH_ANALYTIC_DATA
Table 3-15: Mandatory key fields for the Analytics activity tables
• /OTX/PF08_S_ACV_ANALYTIC_DATA
Table 3-16: Mandatory key fields for the Analytics history tables
• /OTX/PF08_S_HIST_ANALYTIC_DATA
1. In the Profiles Overview screen (see “Defining profiles” on page 45), select a
profile, and then double-click Data Tables in the Dialog Structure.
2. In the Data Tables Overview screen, define the data tables using the following
parameters.
You have maintained Analytics profiles with profile type 1 (Process KPIs). Assign
these Analytics profiles to the Analytics Profile field in all relevant Process
Configuration profile versions. For more information how to maintain version
settings and especially the Analytics Profile field, see “Maintaining version
settings” on page 178.
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.
This chapter provides details about the Inbound Configuration. It is part of the
Foundation.
Each document runs through defined process steps, which are indicated by the
inbound handler process. Each process step comprises several service modules.
These service modules are integrated components of Inbound that offer the
functionality.
• Channels that define the way how a document is imported into the system. This
can be, for example, paper through scan, fax, email, or IDoc. To configure a
channel, you need the registration type.
• Scenario classifications that identify the different types of business scenarios for
incoming documents. They also define the corresponding target application and
target system that are triggered at the end of the incoming document process.
• Registration types that define the scenario which is used to import documents.
The import can happen, for example, by email, IDoc or Document Pipeline.
Depending on the registration type, standard SAP customizing is needed, for
example, for ArchiveLink or SMTP.
• Document handlers and service modules that route the incoming document
through the incoming documents process. You must customize them to
sequentially process the document, based on the respective document status.
Some authorizations are needed to monitor the Inbound Configuration. For more
information, see Example 8-1, “Authorizations necessary to monitor the Inbound
Configuration” on page 266.
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Basic Settings.
3. In the Basic Settings Overview screen, configure settings, using the following
parameters:
To configure channels:
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Channels.
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 62.
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.
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Scenario Classification.
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:
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 172.
Exit Application
Enter the exit function to start any business application used for the Custom
Processing trigger. See template function /OTX/PF01_UTIL_EXIT_APPL.
Logical System
Enter the target system where the business application is started.
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Scenario Classification.
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
Basis for the document handler is a status queueing engine. You must plan the /
OTX/PF01_P_IDF_TRIGGER report as a periodic job to trigger the service modules
accordingly. For more information, see OpenText Vendor Invoice Management for SAP
Solutions - Administration Guide (VIM200400-AGD).
Status When a service module finishes its step, it assigns a status to the document. This
status then triggers the next step in the processing sequence.
The status helps, for example, to identify documents that are ready for validation or
need to get extracted.
Important
• The delivered status must not be changed. For custom service modules, use
a new status in the corresponding customer namespace and number range.
• Do not change the delivered customizing entries of BC Sets but create new
profiles and new settings.
• New configuration must have the prefix Z_ or 9xx according to the data
element.
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.
Important
Do not change the delivered status! If you need to configure an own status, use
a number starting with 900. For more information, see “Customizing”
on page 17.
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Document Handler > Status.
Status
Enter a unique status number.
Description
Enter a meaningful description.
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Document Handler > Modules.
3. In the Handler Overview screen, configure the document handler, using the
following parameters.
Handler
Technical ID of the document handler
Description
Enter the description of the document handler.
Start Handle
Enter the start status of the document handler process.
The start status identifies the status when the document handler is triggered
and processed.
End Handle
Enter the end status of the document handler process.
The end status identifies the status when the whole document handler
process is finished.
Handle Class
Optional: Enter 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.
To configure a module:
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Document Handler > Modules.
3. In the Handler Overview screen, mark a row, and then double-click Modules in
the Dialog Structure.
4. In the Modules Overview screen, configure the modules, using the following
parameters.
Module ID
Technical ID of the module
Sequence
Define the sequence how the modules are processed.
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.
Transformation
Optional: Enter an XSLT transformation program to process an XML
transformation within the module class.
End Status
Enter the status of the module that is set at the end of a module.
The end status must be unique. Do not use status 99. It is reserved for the
business application start.
Start Stat
Enter the start status. You can configure it for modules that must be
triggered only when the start status is set. It is, for example, used in the
communication with Business Center Capture to route documents to the
correct steps, or when steps must be skipped. For example, validation can
be skipped in some cases.
Error Stat
Enter the error status, which is set in error case.
Time limit
Enter the maximum time limit (in seconds) for a module to finish its
processing. If the time limit is reached, the module is set into error status.
The time limit is only taken into account if the document handler is globally
in processing status. Also the No.ofRetry setting is not relevant because the
module is set into error status immediately after the time is reached.
A module waiting for the extraction result of a Business Center Capture
integration should have a time limit of 7200. A module waiting for the
validation result of a Business Center Capture integration should have a
time limit of 3600.
No.ofRetry
Enter the number of retry attempts for a service module in error case. When
the number is reached, the processing handler or document flow is set into
error status.
• 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.
Registration There are possible methods for a custom implementation in the /OTX/PF01_IF_
Class REGISTRATION interface:
REGISTER
This method registers a document in the /OTX/PF01_T_1REG table and sets the
status in the /OTX/PF01_T_STA table.
This method is called in the available registration classes:
• Incoming Mail/OTX/PF01_CL_REGISTER_MAIL
All incoming documents are registered within the /OTX/PF01_T_1REG table. The
registration uses a SAP number range object.
The early archiving registration type is also used when documents are uploaded and
archived with the Fiori App Store Documents, which is available in the /OTBCWUI/
PF07_BC_FOUNDATION tile catalog. For more information, see “Integrating Fiori Task
App into Fiori Launchpad” on page 449.
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.
Incoming paper documents are scanned and archived, using the early archiving
registration type.
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
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.
Note: For more details on the parameters, see Section 7.2 “Maintaining an
HTTP content repository in the SAP system” in OpenText Archiving and
Document Access for SAP Solutions - Scenario Guide (ER-CCS).
4. Click .
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:
The scenario “Storing for subsequent entry”, for example, consists of assigning the
document type and processing the work item.
2. In the Default setting: Overview screen, click New Entries in the application
tool bar.
Pr
Enter the presetting folder name.
Long text
Enter a description of the new folder.
4. Click .
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 66.
Tip: With the Business Center Foundation BC set, the presetting folder /OTX -
Business Center Inbound is already available.
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.
In this step, you create an ArchiveLink document type, for example /OTX/SO4, and
store it in the presetting folder created before. For more information, see “Creating
the presetting folder” on page 64. 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.
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.
4. Document class
Enter Doc. class PDF ,and then click Continue.
Obj. type
/OTX/PF01R
Entry
Task
WS00297300
Click Continue.
To know where to store the incoming document , you must maintain the links, as
described in this section.
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 64.
Link
Enter TOA01
4. Click .
You can also link the document to the relevant SAP target business object. To do
this, continue as described in this section for any SAP business object that you want
to link to the document. For details about the related settings and the supported
business objects, see the description in the related solution guides (for example Sales
Order with the related Business Objects for Sales Orders).
For the registration of documents, the ArchiveLink document type is linked to the
document handler, to a channel, and to the classification profile.
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Document Handler > Registration > Early Archiving.
3. In the Registration - Early Archiving Overview screen, configure the
registration, using the following parameters.
Document Type
ArchiveLink document type used for the registration
Channel
Enter the Channel ID used for this registration type. For more information,
see “Configuring channels” on page 55.
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 58.
Classify
Enter the Classification ID of the incoming document. For more
information, see “Creating scenario classifications” on page 56.
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.
Register synchron
Activate register synchron in order to trigger the inbound handler for the
registered document synchronously
Example: The structure of an SAP application document and the structure of the
corresponding EDI message under the UN/EDIFACT standard
Note: For further details about inbound IDoc processing, see the SAP
documentation.
In this step, you choose the input type for the IDocs.
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:
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 .
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.
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 .
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 .
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.
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 74.
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.
Partner Number, Partner Type, Partner Role, Message Type, Message Code,
Message Function, Test
For these parameters, see the SAP documentation: IDoc Interface /
Electronic Data Interchange (BC-SRV-EDI).
Channel
Enter the Channel ID used for this registration type. For more information,
see “Configuring channels” on page 55.
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 58.
Classification
Enter the Classification ID of the incoming document. For more
information, see “Creating scenario classifications” on page 56.
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
Register synchron
Activate register synchron in order to trigger the inbound handler for the
registered document synchronously
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 163.
Note: To handle the scenario for the processing of IDOC with an invoice type
that is set to INVO, CRME, SUBC, SUBD, do the following:
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Document Handler > Registration > Inbound IDoc.
4. 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).
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:
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.
1. In the IDoc Mapping Details screen, double-click IDoc Hierarchy Item in the
Dialog Structure.
2. In the IDoc Hierarchy Item Details screen, customize the IDoc hierarchy item,
using the following parameters.
Partner Number, Partner Type, Partner Role, Message Type, Message Code,
Message Function, Test
For these parameters, see the SAP documentation: IDoc Interface /
Electronic Data Interchange (BC-SRV-EDI).
Object Name
Development object name: the IDoc type, for example ORDERS01
Segment Type
Segment type in IDoc type which represents an item segment (only one item
segment supported)
External Field Name
Enter the intermediate table field name.
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
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.
1. To check the customizing of the SMTP service, run the SMICM transaction.
3. If the port is not set to 25, select the SMTP service. In the Service menu, click
Change.
If you want to use the SMTP function, you must adjust the system profile of the SAP
ERP system.
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.
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.
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.
1. Run the SICF transaction and open the Virtual Host SAPCONNECT.
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 81. If you have only created one client and therefore have not
specified this parameter type, enter 0.
Logon Data
Enter the logon data of the system user that you created for the incoming
emails.
Handler List
At position 1, enter CL_SMTP_EXT_SAPCONNECT.
Note: You must activate each SMTP server (Service/Virt. Host > Activate)
after creating or changing it. Inactive servers appear dimmed.
You must configure SAPconnect settings for every client that is used for send
processes.
To administer SAPconnect:
3. Default Domain
Define the domain of the SAP ERP system client.
This action has the following consequences:
• The SMTP plug-in logs on to the email server using this domain as the ID.
• The message ID of the outbound emails is assembled with this domain.
• An SAP user might not have an Internet email address. If such a user sends
an email, a sender address consisting of the SAP user name and this domain
is generated.
Each client has an SMTP node. This node is created by the SAP ERP system and
cannot be deleted.
4. Nodes
Enter the specific customizing data like output format for SAP documents and
other types of documents. See details in the SAPconnect documentation.
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.
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.
For a more detailed description of how to enable the Simple Mail Transfer Protocol
Service in SAP ERP, see the SAP Help.
For the registration of documents, the email address is assigned to the handler
process, a channel, and the classification profile.
To attach an email as PDF document, you must fill the following attributes:
• recipient mail,
• channel,
• handler,
• classify,
• document type,
• attach body = X,
• render to PDF = X
• preregistration exit.
The conversion of HTML email document to PDF covers a limited range of special
characters and formatting. Depending on functionality of standard SAP method
cl_crm_email_utility (convert_html_to_plain_text). The PDF document can look
different to the HTML or TXT document
Recipient Mail
Email address that receives the email. This address is configured within the
SCOT transaction. For more information, see “Administering SAPconnect”
on page 84.
Channel
Enter the ID of the channel that is used for this registration type. For more
information, see “Configuring channels” on page 55.
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 58.
Classify
Enter the Classification ID of the incoming document. For more
information, see “Creating scenario classifications” on page 56.
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.
Attach Body
If this option is selected and the Render to PDF option is not selected, then
the body of the email is archived according to the format configured in the
SAPConnect interface (text/html mail).|
Render to PDF
If this option is selected, then a basic PDF rendition is created that contains
the email body text and the selected email properties (sender, recipient,
subject and others). This feature does not create an exact PDF rendition of
the entire e-mail and is therefore not suitable for OCR purposes. This
feature may not function correctly for all emails, in particular highly
formatted emails with embedded HTML content. This feature requires a
Unicode SAP system. Installation of Adobe Reader Font Packs may be
required to open the PDF document.
Pre Exit Registration
Enter a function that is executed before the document is registered in
Inbound Configuration. Use the /OTX/PF01_UTIL_EXIT_REG_BEFORE
template. For the email processing function, /OTX/PF01_UTIL_EXIT_REG_
MAIL is delivered to process the relevant archiving of the various documents
(leading document / attachments / mail body). The /OTX/PF01_UTIL_EXIT_
REG_MAIL function archives the leading documents according to the mime
type assigned to the ArchiveLink document type. If more than one
document with the mime type of the leading document exists, each
document is registered of its own.
Past Exit Registration
Enter a function that is executed after the document is registered in Inbound
Configuration. Use the /OTX/PF01_UTIL_EXIT_REG_AFTER template.
Register synchron
Activate register synchron in order to trigger the inbound handler for the
registered document synchronously
Note: The email addresses might be different across the system landscape.
Therefore, the /OTX/PF01_ADM_SMAI transaction is available to adjust the
values in test and production systems. In general, production systems do not
allow any configuration changes. The transaction is protected against a special
administration authorization. For more information, see “Authorizations”
on page 224.
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).
Add a new entry to the J_6NGTE26 table with the following values:
RFC_Mode
8
FUNCNAME
/OTX/PF01_UTIL_PIPELINE_INPUT
The Document Pipeline typically requires one COMMANDS and one IXATTR file in
addition to the actual image file (for example image.pdf) and the LOG file. See the
following example:
COMMANDS
R3_CLIENT 800
R3_DESTINATION DW3
USE_VR4WFL 8
DOCTYPE PDF
COMP data PDF image.pdf
ARCHIVID Y4
IXATTR
NEWDOC
ATTRIBUTES /OTX/PS01_T_PLH|MANDT|CC|800|
ATTRIBUTES /OTX/PS01_T_PLH|BLDAT|DD|20141010|
ATTRIBUTES /OTX/PS01_T_PLH|BUKRS|CC|1000|
ATTRIBUTES /OTX/PS01_T_PLH|BUDAT|DD|20141010|
ATTRIBUTES TOAV0|MANDT|CC|800|/OTX/PS01_T_PLH|
ATTRIBUTES TOAV0|AR_OBJECT|CC|/OTX/DN2|/OTX/PS01_T_PLH|
ATTRIBUTES TOAV0|SAP_OBJECT|CC|/OTX/1REG|/OTX/PS01_T_PLH|
ARCHIVIDATTR TOAV0|ARCHIV_ID|CC|%s|/OTX/PS01_T_PLH|
DOCIDATTR TOAV0|ARC_DOC_ID|CC|%s|/OTX/PS01_T_PLH|
The 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 163.
For the registration of documents, the ArchiveLink document type is assigned to the
handler process, a channel, and the classification profile.
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Document Handler > Registration > Pipeline.
3. In the Registration - Pipeline Overview screen, customize the Document
Pipeline registration, using the following parameters.
Document Type
ArchiveLink document type that is used for the registration
Channel
Enter the ID of the channel that is used for this registration type. For more
information, see “Configuring channels” on page 55.
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 58.
Classify
Enter the Classification ID of the incoming document. For more
information, see “Creating scenario classifications” on page 56.
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.
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Document Handler > Registration > Custom / Others.
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 55.
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 58.
Classification
Enter the classification ID of the incoming document. For more information,
see “Creating scenario classifications” on page 56.
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.
Available services:
• /OTBCINB/PF01_REGIST_DOC
• /OTX/PF01_REGISTER
4.5.1 /OTBCINB/PF01_REGIST_DOC
The service registers the document as customized for the archive object and
document type.
• register_document_request
• document
• metadata
The first part register_document_request is a XML structure and contains the key
information for the document.
Element Description
Scan date.
scan_date The format for the scan date is YYYY-MM-DD in the time zone of the
SAP system.
Scan time.
scan_time
The format is hh:mm:ss in the time zone of the SAP system.
scan_user Scan user
ar_object Document type
doc_type Document class
Element Description
Document ID in Archive (only in case the document has already been
arc_doc_id
archived)
archive_id Archive ID
Version of the API that is called. Current version is version 1. If version
version
is not provided in call, then the latest version will be used.
The second part document contains the document and is of type binary. If the
document has already been archived and the parameters ARC_DOC_ID and ARCHIV_
ID have been provided in the first part, you can leave this part empty.
The third part metadata is an XML structure and can contain information from an
extraction service. The provided data is mapped to the structure of the process data
as defined in the data model of the process. This part is only processed if the
document was also provided in the second part. It contains an array with the
following structure:
Element Description
extindex External index of field
Additional field information (for example row information in case of
fieldinfo
line items)
extfield External field name
extvalue Value
Element Description
regid Registration ID of the document
Running the service requires the authorization OTBCINB for authorization object S_
ICF.
4.5.2 /OTX/PF01_REGISTER
You can implement additional logic using the /OTX/PF01_REGISTER BAdI. This
BAdI has the following interface.
PROC- This method is called at the beginning of the API. It allows you to access the
ESS_PRE_RE metadata to process own logic. It is also possible to skip the whole standard logic to
GISTER
method –
register the document
PROC- This method is called at the end of the API when the document was registered. It
ESS_PAST_RE allows you to access the metadata and the response (with the registration ID).
GISTER
method –
Parameter Type Description
PIT_MULTIPART IMPORTING Multipart content
PIS_RESPONSE IMPORTING Response information which
is sent with multipart
The BAdl allows to add additional logic to the following standard actions that are
available in the Inbound Administration work center of the Business Center
Workplace:
• Change Status
• Reject
• Reset Retry Counters
• Reset Training
• Submit Handler
For more information, see Section 2.1 “Navigating the Business Center Workplace”
in OpenText Vendor Invoice Management for SAP Solutions - User Guide for Solutions
Beyond Invoice (BOCP200400-UGD).
In some scenarios you will receive a Microsoft Office document and not the PDF
document that you need for processing. This PDF can get processed in the further
processing steps.
Sequence
Define the sequence how the modules are processed. The Render and archive
image module should be processed before the document is sent to the extraction
service
Module Class
Implement processing logic in /OTX/PF01_CL_MODULE_RENDER class.
Redefine this class to your need.
End Status
Enter the status 35 “Document rendered and archived”.
For more information see “Customizing basic settings for Inbound Configuration”
on page 52.
Business Center Capture automates the capture of paper documents by using OCR
to extract the data. Business Center Capture uses SAP ERP as backend to store and
retrieve image information through the inbound process.
Using service modules of Inbound Configuration, you can control all tasks that are
related to the following actions of Business Center Capture:
• Storing documents
• Retrieving documents
• Extracting documents
• Validating documents
Steps from the paper invoice to document registration with Business Center
Capture (BCC)
1. SAP ERP calls the scan client through the Early Archiving registration type,
using the OAWD transaction.
2. The scan client deposits the image to the content repository (Archive).
The OAWD transaction creates a registration entry in SAP ERP using the
registration interface class implementation /OTX/PF01_CL_REGISTER_OAWD.
The registration method inserts an entry to tables /OTX/PF01_T_1REG and /OTX/
PF01_T_1IMG and sets status Registered.
Alternative: Incoming email is used for registration of a new document.
3. The document handler (periodic job for report /OTX/PF01_P_IDF_TRIGGER)
processes the required service modules in SAP ERP and sets the status
accordingly.
4. The BCC Extraction service calls the API function /OTX/PF01_IF_GET_NEW_DOC_
LIST using a scheduled batch job on BCC side and gets new documents for
processing:
• Gets all documents in status Ready for OCR extraction along with secure
URL for image and XML document, which will be created by the BCC
Extraction service.
• Updates the document status to Sent to OCR.
5. The BCC Extraction service picks the documents from step 3 and imports the
corresponding images from the archive.
6. The Export module of the BCC Extraction service calls the API function /OTX/
PF01_IF_OCR_DATA_UPDATE_N with call point EX:
• Updates the status and OCR data appropriately. This API exports the data to
SAP ERP after completion of the extraction phase. Table /OTX/PF01_T_1EXT
will be updated with extracted data.
• Updates the document status to Extraction Completed.
7. The BCC Extraction service sends the detailed results XML file of the exported
data to the Archive using the URL retrieved from SAP ERP in step 4. The BCC
Validation engine uses the XML file.
Results for each data exported to SAP ERP are stored in an XML file and
archived.
8. The document handler picks up the registered items with status Wait for
Extraction completed and checks the time elapsed. If it exceeds the configured
time, the status is set to Error.
9. The document handler picks up the registered items with status Extraction
Completed. The document handler checks if validation is required or not. If
validation is required, the status is set to Ready for Validation. If validation is
not required, the document handler will process the corresponding service
modules and trigger the target application.
10. The BCC Validation service calls the /OTX/PF01_IF_GET_VAL_DOC_LIST API
and gets a list of documents for validation:
• 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.
Information Extraction Service API provides three services which are called from
SAP:
The Learning Service processes the feedback data and stores machine learning data
in its repository:
• Intelligent Capture for SAP® Solutions uses the SAP database as repository.
• Core Capture for SAP® Solutions uses the OT2 public cloud as repository.
Profile configu- A profile is a specific configuration of a scenario and allows the following
ration customizing:
To use document capture with IES, you must configure at least one profile for the
used scenario. In a scenario, standard extraction fields and extraction parameters are
defined for one type of document.
The number of profiles per scenario and the overall number of profiles is not limited.
The following graphic illustrates the relation between a scenario and a profile:
All settings in the customizing activity “Profile maintenance” are transportable. This
means that they are maintained in a customizing client and then transported to a test
or production system.
All scenarios are based on intelligent field types which incorporate the knowledge
about identification and interpretation of typical data found in business documents:
dates, amounts, table items and so on.
For all fields of preconfigured scenarios, data transfer and mapping to the fields of
the corresponding VIM scenarios are part of the product.
Preconfigured scenarios and custom scenarios can be extended by custom fields. For
custom fields the following field types are available:
• Amount
• Currency
• Classification
• Date
• Decimal
• Stringlist
• Lookup
• Partner
• String
• Table
Description
Description
Description is a field type which is specialized to extract text spanning over
multiple lines and columns.
Learning supported
Yes
Layout dependent
Yes
Use case
Extract complex item description text, for example material description from
tables.
Parameters
No parameters
Header/table supported
Table
Amount
Description
The amount field is a specialized decimal field which is limited to two
decimals. The amount field intepretes data with regards to the settings of
the format interpretation list, which defines the correct interpretation of
thousand and decimal separators.
Learning supported
Yes
Layout dependent
No
Use case
Item amount, total amount
Parameters
Format interpretation list
Header/table supported
Header/table
Classification
Description
Classification is a string field and learns to determine different classes for
different document types.
Learning supported
Yes
Layout dependent
Yes
Use case
Classification of specific document types (transportation invoices, leasing
invoices), for example for routing to specific VIM workflows.
Parameters
Class name
Header/table supported
Header/table
Currency
Description
Currency is a specialized string field which identifies supported currencies
and currency symbols on the document and normalizes it to ISO names for
supported currencies.
Learning supported
Yes
Layout dependent
No
Use case
Document currency, amount currency
Parameters
No parameters
Header/table supported
Header/table
Date
Description
A date field is a strucured field which suppports typical date structures
(ddmmyyyy, mmddyyyy, month in letters and so on) for the supported
languages, depending on the settings of the format interpretation list. The
field is learned across layouts, considering typical surrounding keywords,
text and data structure.
Learning supported
Yes
Layout dependent
No
Use case
Document date, delivery date and so on
Parameters
Format interpretation list
Header/table supported
Header/table
Decimal
Description
The decimal field supports up to 4 decimals. The decimal field intepretes
data with regards to the settings of the format interpretation list, which
defines the correct interpretation of thousand and decimal separators (“.” or
“,”). The field is learned across layouts, considering typical surrounding
keywords, text and data structure.
Learning supported
Yes
Layout dependent
No
Use case
Quantity, unit price
Parameters
Format interpretation list
Header/table supported
Header/table
Partner
Description
The partner field is determining the business partner. The partner field
learns an ID for the partner related to the document layout. The partner field
can also learn multiple IDs related to one layout. The partner field is
connected to a staging table, which is used by the validation user for
retrieving the partner ID with F9.
Learning supported
Yes
Layout dependent
Yes
Use case
Supplier, customer
Parameters
Staging table
Header/table supported
Header
String
Description
The string field does not have any normalization but learns a string as it is.
Learning supported
Yes
Layout dependent
No
Use case
Text, numbers
Parameters
No parameters
Header/table supported
Header/table
Stringlist
Description
The stringlist is a list of strings. The user picks values with SCE and the field
type will then learn to extract all relevant strings of the same structure.
Learning supported
Yes
Layout dependent
Yes
Use case
PO list, DN list
Parameters
No parameters
Header/table supported
Header
Table
Description
One profile supports multiple tables. A table is a structure consisting of lines
and columns. For every custom table column a field type needs to be
defined. A table will be learned related to a specific layout.
Learning supported
Yes
Layout dependent
Yes
Use case
Invoice table, sales order table
Parameters
Define field types for columns
Header/table supported
Table
For more information about recognition and processing details for the fields of
invoice applications, see Section 9 “Field references for IES” in OpenText Vendor
Invoice Management for SAP Solutions - Scenario Guide for Invoice Solution (VIM200400-
CCS), “Defining custom fields” on page 141, and “Defining custom table fields”
on page 144.
• Layout based algorithms, for example business partner determination, and item
table recognition. These work based on the layout. Layout based learning means
that internally a model is computed per document layout. Layout definition is
mostly text based and also considers geometry of the data located on a
document. So typically a document related to a business partner may be
considered as a layout. But in reality multiple business partners are sharing the
same layout, the learning algorithm is also able to handle sublayouts.
Layout based algorithms learn very fast, providing automatic recognition result
from the second pass of the same layout. For complex tables more passes may be
necessary.
• Layout independent algorithms, for example data, such as amounts, dates and
document references. These algorithms identify relevant data structures and
keywords and learn to extract it also on documents with an entirely different
layout.
Layout independent algorithms take more time to learn data structures, related
keywords and surrounding text. What has been learned by this algorithm type
will also be applied to completely unknown documents containing the same data
structures, keywords and surrounding text. With this technique, the data entry
effort diminishes more and more, and the longer the system is in production it
learns more document layouts.
Learning Before using Information Extraction Service, the user manually entered data from
system business documents. With Information Extraction Service, the user continues to do
his daily work, and with this he provides feedback data to the learning service,
which learns to capture the data automatically starting from the second pass of a
document with either the same layout or showing the same data type, for example
date field with the same format and key word.
For invoices the user starts from a higher level, because he will get “out of the box”
recognition results from the invoice knowledge base where applicable. A user will
only need to enter data for additional fields that are not supported by the invoice
knowledge base, for example a material number, or fields that could not be extracted
by the invoice knowledge base for some reason, for example complex invoice line
items.
In general customers want to prepare the system for business users by applying
preparative learning before business users are using the system. For comfortable
optimization of the system before going live, following features are available:
• Validation Client for SAP Solutions: A Microsoft Windows based workplace for
correcting and completing IES result data with Single Click Entry (SCE). In this
worplace the optimal learning data are created including geometry coordinates
of the catured data. When submitting a document in the Validation Client,
feedback data are sent to the learning service, if configured accordingly for the
profile (feedback after validation). Learning service can apply best learning from
feedback data with geometrical information.
• Pre-learning based on historical validated extraction result data from Invoice
Capture Center (ICC) or Business Center Capture (BCC). This feature addresses
customers switching from OpenText Invoice Capture Center / OpenText Business
Center Capture to Information Extraction Service. For more information, see
Section 2.3 “Pre-learning of IES Profiles” in OpenText Vendor Invoice Management
for SAP Solutions - Administration Guide (VIM200400-AGD).
• Creating snapshots of learning data for transporting it between profiles and SAP
systems. This feature allows to, for example reuse learning data from
preproduction system in production system. It also allows to reuse learning data
acquired in a profile version 1, in a profile version 2.
• Validation determination rule. Implementing and adjusting validation
determination rules allows to define which documents go to the Validation
Client. In the starting phase, it is recommended to check every document in the
Validation Client and to apply corrections for creating feedback data for the
• Storing documents
• Retrieving documents
• Extracting documents
• Validating documents
1. The document handler processes the required service modules and sends the
image along with parameters for extraction and business data to Information
Extraction Service.
3. The document handler picks the registered items with status Extraction
Completed and checks if validation is required.
4. The validation service calls the /OTX/PF11_VAL_GET_DATA API and gets the next
document for validation:
• For this document, it gets the extraction result, which is used by the
Validation Client.
7. The document handler picks the registered items with status Validation
Completed, processes the corresponding service modules, and triggers the target
application.
The following parameters for request time-out, retry of requests, and waiting period
in case of temporary connection problems are set for communication of SAP and
Information Extraction Service:
The IES Request handler must be scheduled to monitor timeouts and initiate
automatic retries of requests. For more information, see Section 2.2.4 “IES request
handler” in OpenText Vendor Invoice Management for SAP Solutions - Administration
Guide (VIM200400-AGD).
Note: Configure the relevant HTTP or HTTPS settings within the Information
Extraction Service. For more information, see Section 6.10.1 “Intelligent
Capture for SAP (on-premises)” in OpenText Vendor Invoice Management for SAP
Solutions - Administration Guide (VIM200400-AGD).
RFC Destination
Technical ID of the connection
Connection Type
Choose type G.
Description
Enter a description for the connection.
Target Host
Full qualified host name of the IES service
Service No.
Port of IES service which should be used to retrieve requests. For HTTP
connections, this is usually 8080.
RFC Destination
Technical ID of the connection
Connection Type
Choose type G.
Description
Enter a description for the connection.
Target Host
Full qualified host name of the IES service
Service No.
Port of IES service which is used to retrieve requests. For HTTPS port, this is
usually 443.
Note: To trust the IES server certificate, add its intermediate and root
CA certificates to the certificate list of the SSL client PSE of the SAP
system. For details, see SAP Note 510007.
SSL
Select Active.
SSL Certificate
Select the appropriate SSL Client Identity (PSE) which does not use the SSL
client certificate, typically SSL Client (Anonymous). Run a connection test
using the corresponding button in the application toolbar. The test result
should include status HTTP response 200.
Notes
• The IES requires the subject name field (CN) of the SSL client certificate
of the SAP system to contain the fully qualified host name of the SAP
system. The default SSL client certificate does not meet this requirement
and therefore must be replaced.
• By default, the SSL client certificate is provided via client PSE SSL client
SSL Client (Standard).
• To trust the IES server certificate, add its intermediate and root CA
certificates to the certificate list of the SSL client PSE of the SAP system.
• For details, see SAP Note 510007.
SSL
Select Active.
SSL Certificate
Select the appropriate SSL Client Identity (PSE) containing the SSL client
certificate, typically SSL Client (Standard).
3. Run a connection test using the corresponding button in the application toolbar.
The test result should include status HTTP response 200.
1. Run the PFCG transaction to create a role for processing inbound requests from
IES.
a. Define authorization for object S_ICF (Authorization Check for ICF Access)
with the following values:
• ICF_FIELD: 'SERVICE'
• ICF_VALUE: 'OTBCINB'
b. Add the authorization for the J_6NPF_RFC object (BC RFC calls) with the
values: ACTVT: '03'.
c. Save and generate the role.
2. Run the SU01 transaction to create a user of type Service for processing
inbound requests from IES and assign the authorization role defined in Step 1
on page 114.
3. Run the SICF transaction to create services for processing inbound requests
from IES.
Caution
Do not change any values on the selection screen and press the execute
button to get to the service maintenance screen.
Services are created below a virtual host. For example, default_host.
Align with your SAP basis administrator where to create the services
for inbound requests from IES.
4. Create a new service for repository requests of type Independent Service. For
example, zpf12_repo.
a. On the detail screen of the service, open the Service Data tab and define the
SAP authorization OTBCINB.
b. Switch to the Logon Data tab and set the procedure to Required with
Logon Data. In the logon data section, define the user name and the
password of the service user created in Step 2 on page 114.
c. Switch to the Handler List tab and define class /OTX/PF12_CL_SERVICE_
HNDL_REPO as handler with order number 1.
d. Activate the service and test it. When testing the service, an HTTP 400 error
with message ‘“Failed to load resource: the server responded with a status
of 400 (Request method GET not allowed)” should be displayed in a
browser window. This is the correct reaction because the handler class
blocks HTTP GET requests. If this message is visible, the configuration of
the service is correct, and the handler class is invoked.
5. Create a new service for result requests of type Independent Service. For
example, zpf11_result.
a. On the detail screen of the service, open the Service Data tab and define the
SAP authorization OTBCINB.
b. Switch to the Logon Data tab and set the procedure to Required with
Logon Data. In the logon data section, define the user name and the
password of the service user created in Step 2 on page 114.
c. Switch to the Handler List tab and define class /OTX/PF11_CL_SERVICE_
HNDL_RSLT as handler with order number 1.
d. Activate the service and test it. When testing the service, an HTTP 400 error
with message ‘“Failed to load resource: the server responded with a status
of 400 (Request method GET not allowed)” should be displayed in a
browser window. This is the correct reaction because the handler class
blocks HTTP GET requests. If this message is visible, the configuration of
the service is correct, and the handler class is invoked.
1. Run the PFCG transaction to create a role for processing inbound requests from
IES.
a. Define authorization for object S_ICF (Authorization Check for ICF Access)
with the following values:
• ICF_FIELD: 'SERVICE'
• ICF_VALUE: 'OTBCINB'
b. Add the authorization for the J_6NPF_RFC object (BC RFC calls) with the
values: ACTVT: '03'.
c. Save and generate the role.
2. Run the SU01 transaction to create a user of type Service for processing
inbound requests from IES and assign the authorization role defined in Step 1
on page 115.
3. Run the SICF transaction to create services for processing inbound requests
from IES.
Caution
Do not change any values on the selection screen and press the execute
button to get to the service maintenance screen.
Services are created below a virtual host. For example, default_host.
Align with your SAP basis administrator where to create the services
for inbound requests from IES.
4. Create a new service for repository requests of type Independent Service. For
example, zpf12_repo.
a. On the detail screen of the service, open the Service Data tab and define the
SAP authorization OTBCINB.
b. Switch to the Logon Data tab and set the procedure to Required with
Logon Data. In the logon data section, define the user name and the
password of the service user created in Step 2 on page 115.
c. Switch to the Handler List tab and define class /OTX/PF12_CL_SERVICE_
HNDL_REPO as handler with order number 1.
d. Activate the service and test it. When testing the service, an HTTP 400 error
with message ‘“Failed to load resource: the server responded with a status
of 400 (Request method GET not allowed)” should be displayed in a
browser window. This is the correct reaction because the handler class
blocks HTTP GET requests. If this message is visible, the configuration of
the service is correct, and the handler class is invoked.
5. Create a new service for result requests of type Independent Service. For
example, zpf11_result.
a. On the detail screen of the service, open the Service Data tab and define the
SAP authorization OTBCINB.
b. Switch to the Logon Data tab and set the procedure to Required with
Logon Data. In the logon data section, define the user name and the
password of the service user created in Step 2 on page 115.
c. Switch to the Handler List tab and define class /OTX/PF11_CL_SERVICE_
HNDL_RSLT as handler with order number 1.
d. Activate the service and test it. When testing the service, an HTTP 400 error
with message ‘“Failed to load resource: the server responded with a status
of 400 (Request method GET not allowed)” should be displayed in a
browser window. This is the correct reaction because the handler class
blocks HTTP GET requests. If this message is visible, the configuration of
the service is correct, and the handler class is invoked.
1. Perform the first two steps of scenario 1 (“To configure the inbound
communication using HTTP:“ on page 114).
Notes
• To trust the IES SSL client certificate, add its intermediate and root CA
certificates to the certificate list of the server PSE of the SAP system.
• By default, the server certificate is provided via server PSE SSL server
Standard.
2. Instead of creating two new services for inbound communication, you may
leverage the two provided services /otbcinb/pf11_result and /otbcinb/
pf12_repository as they are. Activate these services if they are not yet active.
3. Run the SM30 transaction to assign IES’s SSL client certificate to the service user
created in Step 1 on page 116 for processing inbound requests from IES, using
the following parameters:
Table/View
Enter VUSREXTID, and then click Maintain.
External ID type
Select DN and continue.
a. Export the IES SSL client certificate into a file with suffix .cer.
b. To obtain the External ID from the .cer file, click the import button.
c. Select the service user for inbound communication created during Step 1
on page 116.
d. Enable the Activated flag.
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Capture > Information Extraction Service > Connection parameters.
Not needed if the outbound communication to IES uses https with client
certificates. In this case, the host name is extracted from the CN attribute of
the SAP SSL client certificate used for the HTTPS communication from SAP
to IES.
Port for inbound requests (http)
Port of the SAP system which should be used to process http requests from
the IES service. Default is 8000.
Just needed if inbound communication with http is used.
Port for inbound requests (https)
Port of the SAP system which should be used to process https requests from
the IES service. Default is 8443.
Just needed if inbound communication with https is used.
Connection ID
Technical ID of the connection to IES
Destination
Technical ID of the RFC destination to IES created in “On-Premises:
Outbound communication” on page 111.
SSL Enabled
Select this check box if SSL should be used for the request sent from IES to
SAP.
URL Path Repository
Enter the path to the service for inbound repository requests configured in
“On-Premises: Inbound communication” on page 113.
Note: Do not forget to start the path with a leading slash (/).
Note: Do not forget to start the path with a leading slash (/).
7. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Capture > Information Extraction Service > Connection test.
8. Execute a connection test for the connection ID that you created in the previous
steps.
The result screen should show that the connection test for all 3 services was
successful.
Tip: Before you start the configuration in SAP, obtain the client ID and the
client secret for accessing capture services.
Note: To trust the IES SSL server certificate, add its intermediate and root CA
certificates to the certificate list of the SSL client PSE (Anonymous) of the SAP
system.
To retrieve details regarding the SSL server certificate call the respective
services URL in the browser, and then click the security button in the address
bar. The certificate details show for example the certificate chain up to the root
certificate. You can also export/download certificates from there.
RFC Destination
Technical ID of the connection. For example IES_CAPTURE.
Connection Type
Type G (HTTP Connection to External Server)
Description
A description for the connection.
Technical Settings tab
Tip: Write down the URL of the OAuth2 token service for the configuration
of the RFC destination to the OAuth2 token service.
You find the URL in the Response Body tab of the test result.
4. Create a new RFC destination for the connection to the OAuth2 token service.
Use the following settings:
RFC Destination
Technical ID of the connection. For example IES_TOKEN.
Connection Type
Type G (HTTP Connection to External Server)
Description
A description for the connection.
Technical Settings tab
• Target Host: Full qualified host name of the OAuth2 token service.
• Path Prefix: Path to the OAuth2 token service . For example /
authserver/oauth/token.
5. Click Save.
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Capture > Information Extraction Service > Connection parameters.
Connection ID
Technical ID of the connection to IES.
Destination IES
Technical ID of the RFC destination for the capture services. For
example IES_CAPTURE.
The ID is created in the Outbound communication. For more information,
see “Cloud Edition: Outbound communication” on page 119.
Destination Token
Technical ID of the RFC destination for the OAuth2 token service. For
example IES_TOKEN.
The ID is created in the Outbound communication. For more information,
see “Cloud Edition: Outbound communication” on page 119.
6. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Capture > Information Extraction Service > Connection test.
7. Execute a connection test for the connection ID that you created in the previous
steps.
The result screen should show that the connection test for all 3 services was
successful.
This connection test verifies, that all the connection settings are correct and that the
end-to-end communication is working.
In contrast to a simple ping to the RFC destination this connection test verifies:
• The credentials that are used to obtain the access tokens (just relevant for cloud
edition).
• The inbound connection (just relevant for on-premises).
• The IES server processing.
Connection ID
Technical ID of the connection to IES
4. Click Execute.
5. Verify if the connection test was successful.
5.2.3 Customizing
The following mandatory configurations, set up a best practice default to capture
information.
1. Reuse existing document handler or create your own module handler. Use:
4. Assign the ArchiveLink document type which is used for your registration type
to the profile. For more information, see “Assigning an ArchiveLink document
type” on page 146.
5. Activate the profile and specify the IES connection. For more information, see
“Activating and updating a profile” on page 147.
As learning is one of the central features of Information Extraction Service make sure
that feedback is provided in an optimal way as described in the Best practice
learning strategy. For more information, see “Customizing feedback” on page 154.
To enable validation, see the dedicated configuration. For more information, see
“Customizing validation” on page 150.
Example:
• Order
– Ship-to party
– Sold-to party
• Invoice
– Supplier/Vendor
– Company code
Various data (business entity attribute fields) which can appear on business
documents is used to determine business entity candidates in SAP.
Attribute fields which are extracted from a document belong either to the master
data of the business entity, for example name, address, bank details, tax number or
they are related to some transaction data (to a reference document, for example,
purchase order).
Extracted attribute fields are used in SAP to look up possible business entity
candidates. In an additional extraction step, the determined business entity
candidates are matched with a specific confidence against further available
information on the document.
In the past, IES used solely a learning-based method to determine business entities.
This requires some training.
To use business entity determination with IES, you must configure at least one
profile with the new version 2 scenario for the used scenario. For more information,
see “Scenario 2: Communication using HTTPS w/o SSL client certificate
authentication” on page 112.
In a scenario, standard attribute fields and extraction parameters are defined for the
specific scenario version. The pre-configured attribute fields are used in the business
entity determination configuration which provides a best practice implementation to
determine the business entity. Custom attribute fields to determine the business
entity candidates can also be added to the profile configuration.
The look up of possible business entity candidates from extracted attribute fields is
processed from the staging tables. You must therefore schedule the corresponding
reports to fill the staging tables. For more information, see OpenText Vendor Invoice
Management for SAP Solutions - Administration Guide (VIM200400-AGD).
5.2.3.1.2 Migration
• Create a snapshot of your active profile which you want to migrate. For more
information, see Section 4.1 “Creating a snapshot” in OpenText Vendor Invoice
Management for SAP Solutions - Administration Guide (VIM200400-AGD).
Copy the profile that you want to migrate to a new profile, and then specify
version 2. For more information, see “Copying a profile” on page 132.
• Activate the newly created profile with restore of snapshot. For more
information, see Section 4.3 “Restoring a snapshot” in OpenText Vendor Invoice
Management for SAP Solutions - Administration Guide (VIM200400-AGD).
• Execute pre-learning for business entity determination operators. For more
information, see Section 2.3.5.2 “Initiating pre-learning of a selection variant for
The determination definition is pre-delivered and used within a scenario for the
corresponding business entity fields. An own determination definition can be used,
which is assigned within the profile maintenance to the corresponding entity field.
For more information, see “Assigning an entity determination” on page 137.
To define a determination:
Determination ID
Technical ID of the determination.
Description
Description of the determination.
Confidence
The minimum confidence to select the business entity (integer value
describing a percentage between 0 and 100). If the confidence is not
maintained the business entity with the highest confidence is automatically
used if there does not exist an additional business entity with the same
confidence.
Distance
Distance between matching confidences of different business partners to
select a business entity (integer value). If the distance is not maintained the
highest confidence is used.
Matcher field
Assign the entity matcher field which is used to extract and match the
business entity with additional information on the document with a specific
confidence.
Scenario related matcher
For delivered entity matcher scenario fields (not custom fields) the
checkbox must be selected.
You have to maintain the LookUp condition for each extracted attribute field which is
used to determine the business entity candidates in SAP.
Attribute field
Select a scenario-related or a custom attribute field that is used to extract the
information on the document. For more information, see “Assigning an
entity determination field” on page 136.
Scenario related
For pre-delivered attribute scenario fields (not custom fields) the checkbox
must be selected.
LookUp table
Enter the table which is used to look up the values.
LookUp field name
Enter the table field which is used to look up the values.
LookUp entity key field
Enter the table field which is selected and which defines the business entity.
External field name (path)
For extracted attribute fields with a deep structure (for example, fields of
type address) enter the field path of the related field.
Normalize
Mark this checkbox to normalize the extracted value of the attribute field.
This processes the lookup against a value which was normalized in the
same way. The normalization of the value is processed within /OTX/PF11_
CL_UTILITIES=> NORMALIZE_LOOKUP_VALUE method which should be
reused for your own lookup fields.
3. On the Profile Overview screen, create a new entry, using the following
parameters:
Profile ID
Technical ID of the profile.
Profile Description
Enter the description of the profile.
Scenario
Assign the scenario.
Version
Assign version of scenario.
PROCESS_VALIDATION_RESULT
Provides the validation result. The method is called for each extraction
step.
Parameter Type
PI_REGID Importing
PI_PROFILE_ID Importing
PI_SCENARIO_ID Importing
PI_VERSION Importing
PI_STEP Importing
PIT_EXTRACTION_RESULT Importing
FORMAT_EXTRACTION_VALUE
Formats the extraction value for each field. The method is called for
each extraction step for each field of type string, date and decimal. You
can change the VALUE of one field (defined with its ID) within the PCS_
EXTRACTION_RESULT structure and access all relevant information of the
whole extraction result within PIT_EXTRACTION_RESULT.
FORMAT_VALIDATION_VALUE
Formats the extraction value for each field. The method is called for
each validation step for each field of type string, date and decimal. You
can change the VALUE of one field (defined with its ID) within the PCS_
Caution
• Only the VALUE field of PCS_EXTRACTION_RESULT structure
is processed.
• The value can only be reformatted. A new value no matter
if it is with or without relation to the document and the
extracted raw value is not learned.
should get extracted. By default this parameter is not active and full text
recognition is done for all pages and also relevant data fields are extracted
on these pages.
Use PDF e-Text
Uses the e-text from a searchable PDF. The following options are available:
• Ignore (OCR from image):: PDF files are transformed to tiff, regardless
if they are a searchable PDF or not. OCR recognition extracts the data
only from the image, without using e-text.
• Consider (OCR from image voted with e-text): PDF files are
transformed to tiff. e-text is preserved. OCR recognition extracts the data
from the image. The extraction result is rated with e-text. The priority is
OCR data, e-text is just used for supporting OCR.
• Prefer (OCR from e-text or image): PDF files are analyzed page by page:
for pages where e-text is available, OCR recognition is skipped and e-
text is used. Only for pages where no e-text exists, a tif is created and
OCR recognition extracts data from image.
Attribute field
Technical ID of the attribute extraction input field.
Description
Enter a description of the custom field.
Type
Select the field type from the list. The following values are possible:
○ Name1
○ Name2
○ Street
○ House number
○ ZIPCode
○ POBox
○ City
○ Region
○ Country
– email: Extracts a list of all available email addresses.
– iban_number: Extracts a list of all iban numbers of a specific format
with checksum processing.
– range: Extracts a list of all numbers within the provided range.
5. On the Entity Determination Field Assignment screen, assign a field using the
following parameters:
Step
Extraction step when the field is used. It is usually set to step 1. only for the
fields of entity_matcher type step 2 setting is used.
Attribute field
Select the custom attribute field which is used in the scenario.
Note: You cannot update an activated profile if you change the type of a
field.
Update an activated profile, if you add or delete existing entity
determination fields. The changes take effect after the update.
Entity field
Select the business entity field which is available in the related search help
(scenario or custom field of business_entity type).
Determination ID
Select the configured determination ID which is available in the related
search help. For more information, see “Information Extraction Service”
on page 99.
The configuration of the format interpretation list allows to change the classifier.
Note: When changing character sets, a profile reset is necessary, which means
that learning data will get lost.
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Capture > Information Extraction Service > Profile maintenance.
3. On the Profile Overview screen, mark an entry, and then double-click Format
interpretation list in the Dialog Structure.
4. On the Format interpretation list Overview screen, rank the preferred format
interpretation keys, using the following parameters:
Int. key
Interpretation key. Key for format interpretation, for example de-DE.
Sequence
Use the sequence to rank format interpretation. The format interpretation
with the lowest sequence number has highest priority.
Note: The value help for the interpretation key also shows the default
sequence for format interpretation. If no format interpretation is defined
for a profile, this default ranking is used.
If you change format interpretation after a profile is activated, you must
update the profile for the changes to take effect.
The attribute classification can get configured for a custom field or a custom table
field. For the attribute classification values are configured. These classification
values are available within the windows Validation Cient for the custom field. IES
learns the classification after a user validated the document. An attribute of an
document for a classification can for example be the priority or special qualification
of a single line item for example for an invoice where a line represents the freight
costs.
To configure a classification:
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Capture > Information Extraction Service > Profile maintenance.
Classification ID
ID of the classification.
Classification Profile
The classification profile ID is only relevant for document classification. It
represents the ID of the scenario classification. For more information, see
“Creating scenario classifications” on page 56 and “Document
classification“ on page 471.
Document classification does not require classification values as the
assigned document types of the scenario classification are used. For more
information, see “Assigning document types to classifications” on page 57.
Value
Value of the classification.
Description
Description of the classification value.
If an attribute is not defined for a field (description, field status, field sequence) the
default attribute value is used.
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Capture > Information Extraction Service > Profile maintenance.
4. On the Validation field settings Overview screen, define validation fields that
should appear in the Validation Cient, using the following parameters.
Note: If you change validation field settings you have to close the
application in validation and open it again for the changes to take effect.
Validation Fieldname
Select the validation field name from the list of available fields.
Description
Enter a description for the field. This text is used as label for the field in the
Validation Cient.
Fld. stat.
Field status. Select the field status from the list. The following values are
possible:
Display Only
Field is not editable.
Hide
Field is not displayed.
Input
Field is editable.
Required
Field is editable and indicated as required.
Fld. Sequ.
Validation Field sequence. Enter the sequence in which the fields are
displayed in the Validation Cient. The standard scenario fields always have
a sequence with 10 (10, 20, 30). Therefore, you can place custom fields in
between.
Sum Check Field
Enter the fieldname of the header field to do a sum check. The Validation
Cient will sum up the related item field and check against the sum field.
When the item sum does not match the sum field an error is shown in the
Validation Cient.Use the search field to select the sum check fieldname. You
can configure a scenario or a custom field. The sum check is only processed
in the windows Validation Cient.
Note: Make sure that you only configure fields where a sum check
makes sense (for example, amount fields). Also ensure that you assign
a header field to the Sum Check field and not an item field (sum check
field is always the related total field). Incorrect configuration result in
a wrong calculation on the Validation Cient.
Name
Technical ID of the custom field. The technical ID should not contain any
special characters and no blanks.
Description
Enter a description of the custom field. This text is used as label for the field
in the Validation Client.
Type
Select the field type from the list. The following values are possible:
date
Structured field, which supports typical date structures for the
supported languages. The structure depends on the settings of the
barcode
Field which is used to maintain the barcode type. It contains a list of
barcodes of the same type.
The following barcodes are supported:
• A2of5
• Aztec
• BCC32
• Codabar
• Code128
• Code2of5
• Code3of9
• Code3of9Extended
• Code3ofNOSS
• Code93
• CodeQR
• DataMatrix
• EAN13
• EAN8
• FourState
• I2of5
• Matrix2of5
• PDF417
• Patch
• Planet
• Postnet
• UCC128
• UPCA
• UPCE
Fld. stat.
Validation Field Status. Select the field status for the Validation Cient from
the list. The following values are possible:
Display Only
Field is not editable.
Hide
Field is not displayed.
Input
Field is editable.
Required
Field is editable and indicated as required.
Classification ID
Select the classification ID for the field type class which configure when you
maintain classifications. For more information, see:
LookUp ID
Select the look-up ID for the field type class which you configured. The
related look-up is used within the Validation Cient to search for the
business entity.
Fld. Sequ.
Validation Field Sequence. Enter the sequence in which the fields are
displayed in the Validation Cient. The standard scenario fields always have
a sequence with 10 (10, 20, 30). Therefore, you can place custom fields in
between.
Barcode Type
Select the barcode type for the field type barcode which you configured.
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Capture > Information Extraction Service > Profile maintenance.
3. On the Table for custom fields Overview screen, select the table you want to
enhance with custom fields, and then in the Dialog Structure, double-
click Custom field definition.
Important
Only choose a table which is provided with the search help.
4. On the Custom table field definition: Overview screen, define custom fields,
using the following parameters:
Name
Technical ID of the custom field. The technical ID should not contain any
special characters and no blanks.
Description
Enter a description of the custom field. This text is used as label for the field
in the Validation Client.
Type
Select the field type from the list. The following values are possible:
date
Structured field, which supports typical date structures for the
supported languages. The structure depends on the settings of the
format interpretation list. For example, ddmmyyyy, mmddyyyy or
month in letters.
decimal
Field which supports up to 4 decimals, and which interprets data in
regards to the settings of the format interpretation list. The format
interpretation list defines the correct interpretation of thousand and
decimal separators (“.” or “,” ).
string
Field which has no normalization.
amount
Special decimal field which is limited to two decimals. It interprets data
in regards to the settings of the format interpretation list. The format
inperpretation list defines the correct interpretation of thousand and
decimal separators.
class
Field which is used to process the document classification or to classify
a field with a specific attribute which is not available on the document.
Document classification is only possible on header level. For more
information, see “Document classification“ on page 471.
description
Field which has no normalization. Provides the best capture result for
longer description texts within a column.
Fld. stat.
Validation Field Status. Select the field status for the Validation Cient from
the list. The following values are possible:
Display Only
Field is not editable.
Hide
Field is not displayed.
Input
Field is editable.
Required
Field is editable and indicated as required.
Classification ID
Select the classification ID for the field type class which configure when you
maintain classifications. For more information, see “Maintaining
classifications” on page 139.
LookUp ID
Select the look-up ID for the field type class which you configured when
you maintain classifications. For more information, see “Maintaining
classifications” on page 139.
Fld. Sequ.
Validation Field Sequence. Enter the sequence in which the fields are
displayed in the Validation Cient. The standard scenario fields always have
a sequence with 10 (10, 20, 30). Therefore, you can place custom fields in
between.
Sum Check Field
Enter the fieldname of the header field to do a sum check. The Validation
Cient will sum up the related item field and check against the sum field.
When the item sum does not match the sum field an error is shown in the
Validation Cient. Use the search field to select the sum check fieldname.
You can configure a scenario or a custom field. The sum check is only
processed in the Microsoft Windows Validation Cient.
Note: Make sure that you only configure fields where a sum check
makes sense, for example amount fields. Also ensure that you assign a
header field to the Sum Check field and not an item field (sum check
field is always the related total field). Incorrect configuration result in
a wrong calculation on the Validation Cient.
Doc. type
ArchiveLink document type
Profile Id
Enter the technical ID of a profile which should be used for extraction.
The option to update a profile is only available if the settings of a profile that is
configured using Profile maintenance activity changed since the last profile
update or profile activation.
To delete a profile setting and all its learning data from the IES repository, you can
reset a profile.
You are only allowed to reset the profile if there are no active sessions for this
profile. You can check for active sessions using the Extraction node in the IES
Administration Work Center in the Business Center Workplace. Furthermore all
processes for inbound documents which are using this profile have to be finished or
cancelled before resetting the profile.
Note: The profile activation and update is processed within the IES
Administration workcenter of the Business Center Workplace. In order to
process this task the relevant authorization for the workplace is required. For
more information, see “Authorization objects” on page 265.
To activate a profile:
4. Select the corresponding connection ID. For more information, see “On-
Premises: Connection parameters” on page 117. You must assign a dedicated
IES server to a profile.
After initiating the activation, the profile is in status Activation in process.
Profile activation usually takes a few seconds.
5. To check if the activation is completed, click the Refresh button in the
application toolbar. The status is Active. If a problem occurred during
activation, the status is Error.
In this case, you can display details about the problem by showing the Error
Log in the Detail pane.
To update a profile:
Notes
• To get a list with all activities for a profile, display the Detail pane and show
the Activity Log.
• In case of errors, check the log for details in the detail pane and solve the root
cause. After that you can reset the profile using the Reset profile button
and try to activate again.
• You change the connection ID of an active profile using the Change
Connection button in the toolbar.
To reset a profile:
5. Optional To check if the reset is completed, click the Refresh button in the
application toolbar.
The status switches to Reset.
If a problem occurs, the status is Error. In this case, you can display details
about the problem by showing the Error Log in the Detail pane.
You find various exits and enhancement options withing Inbound Configuration or
Process Configuration of SAP.
• With Single Click Entry (SCE), you can pick the data directly from the image into
the data fields. You do not need to type the data. This avoids errors due to typos.
• With Table Auto Completion (TAC), you only need to pick the data of the first
item line with Single Click Entry (SCE). Table Auto Completion (TAC)
automatically captures the data of all remaining line items.
The image view highlights all data that has been recognized automatically and the
user can see at first glance if data is missing, for example line items.
To create a validation:
Validation ID
Technical ID of the validation settings
Description
Enter the description of the validation setting.
Validation Determination
Select the determination from the list. The following values are possible:
Validate always
Validation is always active.
Validate never
Validation is not active.
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Capture > Validation.
3. In the Capture - Validation Overview screen, mark an entry, and then double-
click Capture - Validation Check Fields in the Dialog Structure.
Step ID
Field counter
Note: You must configure the field name in the same way as it is
delivered (case-sensitive).
Note: You must configure the field names and full paths in the same
way as it is delivered (case-sensitive).
The result of a configuration can look as shown below. The fields that are
defined as check fields display the extracted values.
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Capture > Validation Assignment.
Document type
ArchiveLink document type of registration
Validation ID
Enter the validation ID for processing. For more information, see
Validation ID on page 150.
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Capture > Validation Assignment.
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 224.
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.
Document Type
Document type for which feedback shall be activated.
Step
Point of time when feedback should be provided. Possible values:
Validation
Feedback is sent directly after validation is finished.
For IES, it is required to set the feedback after validation, to get best
feedback results. Feedback at process end might not deliver all relevant
information (for example coordinates) required for the best feedback for
IES.
Caution
You must set the feedback after validation, for IES to get best
feedback results. Feedback at process end does not deliver all
relevant information (for example coordinates) that is required
for the best feedback for IES.
Process end
Feedback is sent after the business process is finished.
Active
Select this check box to activate feedback.
2. Click OpenText Business Center for SAP Solutions > Inbound Configuration
> Capture > Reject Reasons.
Reject Reason
Reason code of the rejection
Description
Enter the description of the reject reason.
• Searching for any related SAP information in the Validation Cient. If IES is used
only custom fields of business_entity type can be defined with a look-up. For
more information, see “Defining custom fields” on page 141.
• Enabling the access and download of master data to the BCC or IES database. If
IES is used, only access, no download is enabled.
The look-up for business partners is done on staging tables. A staging table collects
all relevant information of vendor, customer, or company code. A staging table can
also collect information from multiple systems, when BCC or IES is connected to one
SAP ERP system as single point of contact.
The staging tables are filled with corresponding reports, which can be planned as
periodic job on SAP ERP side.
/OTX/PS00_P_IDF_COMP_CODE
Report to fill staging table for company codes
/OTX/PS00_P_IDF_CUSTOMER
Report to fill staging table for customers
/OTX/PS00_P_IDF_VENDOR
Report to fill staging table for vendors
For more information, see OpenText Vendor Invoice Management for SAP Solutions -
Administration Guide (VIM200400-AGD).
For more information from BCC side, see Section 4.10 “Configuring a Partner
function” in OpenText Business Center Capture for SAP Solutions - Customization Guide
(CPBC-CGD) and Section 4.12 “Configuring a LookupList function” in OpenText
Business Center Capture for SAP Solutions - Customization Guide (CPBC-CGD).
Look-up fields are used to map the SAP fields of the related data selection fields
structure to the external field names used in the Business Center Capture
application. For more information, see “To map a look-up field:“ on page 158.
To create a look-up:
LookUp ID
Describes the technical identification of data search and retrieval in SAP
ERP.
Description
Enter a description of the look-up.
Data selection fields
Enter the structure of the fields. These fields are used within the mapping.
They assign the external field name of BCC or IES to the internal SAP field
name of the corresponding database table or database view. For more
information about the mapping, see “To map a look-up field:“ on page 158.
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.
1st Character
P fix, indicates a parameter.
2nd character
I (Importing) or C (Changing) or E (Exporting).
3rd character
<empty> (variable) or S (structure) or T (table).
LOOKUP_DOWNLOAD
The LOOKUP_DOWNLOAD method provides a look-up to download data.
This method is used in the BCC API function /OTX/PF01_IF_LOOKUP_
DOWNLOAD.
LOOKUP_DOWNLOAD_INIT
The LOOKUP_DOWNLOAD_INIT method initializes the download.
This method is used in the BCC API function /OTX/PF01_IF_LOOKUP_INIT.
LOOKUP_DOWNLOAD_COMPLETE
The LOOKUP_DOWNLOAD_COMPLETE method completes the download.
This method is used in the BCC API function /OTX/PF01_IF_LOOKUP_
COMPLETE.
LOOKUP_VALIDATION
The LOOKUP_VALIDATION method provides a look-up processed from the
Validation Cient.
This method is used in the BCC / IES API function /OTX/PF01_IF_LOOKUP_
VAL.
Case sens.
Case sensitivity. Select Case-sensitive or Case-invariant from the list.
BCC or IES already provides a search operation for a specific field. For
example, the user can enter search options in the Validation Client. You can
configure how this search is processed. Either the search is case-sensitive or
the search is case-invariant.
Tip: A case-invariant search is the slower search option.
Row number
Enter the column number to identify the related field in BCC or IES.
Index
Mark the index field of the look-up which identifies the business partner/
business entity.
Sort
Define the fields with sort criteria which show the details of the selected
business partner/business entity in the Validation Cient.
Element Name:
Field name of the mapped entity determination fields of the entity matcher
data structure. For more information, see “Defining custom entity
determination fields” on page 133.
The technical concept assumes that every task in the process will end with a result.
These possible results are defined by the content of single task modules. Linking one
task to another, depending on the result of the previous one, allows to create a
complete process flow.
How a single task of the process flow appears is determined by task types, for
example dialog or background task. You can further control the appearance by usual
concepts like requested start or end conditions and event handling capabilities.
Therefore, the Process Foundation allows an easy configuration of processes without
the need for complex development.
Per design, the Process Foundation does not contain any business data context or
business data processing logic. It expects that these are implemented by each
business scenario using suitable data models and processing modules, which are
executed during runtime. Therefore, the Process Foundation has to be considered as
a pure technical platform to simplify the use of SAP Business Workflow.
Important
The Process Foundation is reserved for internal use only. Any custom
configurations beside the activities described in this document are not
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:
Important
You must configure the SAP Business Workflow engine to run processes based
on Process Foundation as prerequisite. Additionally, maintain the following
tasks as general tasks in the PFTC transaction:
3. In the Basic Settings Overview screen, configure basic settings, using the
following parameters.
Default Language
Enter the default language.
The default language is used to read description texts in some customizing
views. This applies if no description texts are found in the current logon
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.
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.
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.
Before you can define the levels, you must create the business scenario related data
tables. They must fulfill the following mandatory conditions:
• /OTX/PF02_S_PLH_DATA
• /OTX/PF04_S_BCF_DATA
Note: When creating work object types based on data tables, always make
sure to include the key fields PROJECT_ID, PLKEY and (in case of item tables)
ITEM_NR in the table field list of the corresponding dynamic data selection.
Also make sure to include the non-key field EXTINDEX. For more information,
see “Defining dynamic data selection” on page 251.
To define levels:
2. In the Levels Overview screen, define levels using the following parameters.
Note: Only the hierarchy levels 1 and 2 are supported by the product
standard. Higher hierarchy levels are generally possible using the
standard configuration. However, they are not provided anywhere in
the standard delivery.
Description
Enter a meaningful description for the data hierarchy level.
Table Name
Enter the name of the corresponding process ledger table to be used in the
hierarchy level.
External Field Name
Enter an external alias for the table used by external applications that send
data to the system. The external field name is required to determine the
internal SAP table name.
Note: This setting has been replaced by the level mapping
configuration. For more information, see “Maintaining level mapping”
on page 169. But the setting remains available for downward
compatibility reasons. As a consequence, no further evaluation of the
level mapping configuration takes place as long as any value is
maintained in the level definition setting.
1. In the Levels Overview screen (see “Defining levels” on page 164), mark an
entry, and then double-click Fields in the Dialog Structure.
2. In the Fields Overview screen, maintain the level key fields, using the following
parameters.
Field Name
Name of the key field of the process ledger table where data of the
corresponding hierarchy level is hold.
Key type
This parameter defines how the value of the key field is determined when
inserting new data entries. Select one of the possible values from the list:
Create key by number range object
The key field value is retrieved from a number range object. This only
makes sense within data hierarchy level 1 to generate the next unique
process ledger key.
Automatic indexing
The key field value is populated by sequential numbering using the
logic defined with the index parameter fields. This only makes sense for
numeric data types.
Timestamp
The key field value is determined by a timestamp. The field must be of
data type TIMESTAMP or TIMESTAMPL.
Key is self-managed by the requester
The key field value is managed by custom logic and already provided
when inserting values.
Object
Enter the name of the number range object used for the key field in case of
key type Create key by number range object.
Number range number
Enter the number range interval used for the key field in case of key type
Create key by number range object.
Important
The number range interval must be configured in the SNUM transaction
for number range object /OTX/PF02L (not delivered in BC set).
Maintain the number range 01 with the range 1 to 999999999999.
This number range object is used within the DEFAULT Data Model (also
used within solutions).
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.
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.
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.
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.
PROCESS_MAPPING
This method is used for process mapping. It is called inside mapping class.
1. In the External Data Mapping Overview screen (see “Defining external data
mapping” on page 167), mark an entry, and then double-click Level Mapping
in the Dialog Structure.
2. In the Level Mapping Overview screen, maintain the level mapping, using the
following parameters.
Note: You must configure the external field name for the level in the
same way as it is delivered (case-sensitive).
1. In the Level Mapping Overview screen (see “Defining external data mapping”
on page 167), mark an entry, and then double-click Field Mapping in the
Dialog Structure.
2. In the Field Mapping Overview screen, maintain the field mapping, using the
following parameters.
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.
System variable
A system variable is assigned to the target field. The value is configured
in the Value field (see Value on page 171).
Ignore Character
Enter characters that are deleted in an extra step before mapping continues.
This is useful, for example, if there are apostrophes in a Reference Number.
The field can contain up to 6 characters.
Condense
Select this check box to condense the value.
Value
For field mapping type constant or system variable, assign the related
value.
CAPTURE
Mapping for Business Center Capture application created before Business
Center Capture 16.5
CAPT_BCC
Mapping for Business Center Capture application created with Business Center
Capture 16.5 and later
CAPT_IES
Mapping for Information Extraction Service
Channel
Incoming channel in which the document has been processed. For more
information, see “Configuring channels” on page 55).
Mapping ID
Enter the unique technical ID which identifies the mapping scenario.
4. To change the the Default Profile parameter available in the basic settings of
the Process Foundation:
3. Select the profile that you want to transport. Click Table View > Transport from
the menu and include all corresponding configuration settings in a transport
request.
Note: You must always manually add profile entries in the tables /OTX/
PF02_T_TBWD and /OTX/PF02_T_TBWT to a transport from the SE16
transaction.
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.
Process Configuration
• Profile configuration
• Profile assignment
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.
To define a profile:
3. In the Profile Configuration Overview screen, define the profile using the
following parameters:
Profile ID
Define the profile with a unique ID.
Profile Description
Enter a meaningful profile description.
User
Enter the responsible person or creator for the profile.
To copy an existing profile and all its dependent settings to a different profile
name:
The copied version will always start with a first profile version again,
independent from the current version counter currently used by the copied
profile.
3. In the Profile Configuration Overview screen, mark an entry, and then double-
click Version Definition.
4. In the Version Definition Details screen, define the version using the following
parameter.
Version
Next higher version counter
This will set the old version to inactive and copy all current settings to a new
active profile version automatically.
Version Description
Enter a meaningful description of the current profile version.
Active
Select this check box to set the version to active. Clear the check box to set
the version to inactive.
Creation Date
Enter the date when the version has been created.
Created by
Enter the responsible person or creator for the profile version.
Profile Class
Enter the profile class. The profile class contains the highest level profile
related processing logic that is required to execute a profile configuration
during runtime. If no class is maintained, the standard class /OTX/PF04_CL_
PROFILE is always used.
Default value: <Empty>
If the standard logic has to be changed for any reasons, the class /OTX/
PF04_CL_PROFILE must be inherited, redefined as needed, and entered as
custom profile class.
The following methods are supposed to be redefined if needed. OpenText
recommends that you do not change any other method.
AUTH_CHECK_DATA
This method implements custom authorization checks based on the
current characteristic value, process step, and process ledger data.
When executing dialog work items, the method is called for the
activities 02 - Change and 03 - Display.
If any authorization check fails, the exception /OTX/CX_PF04_
EXCEPTION has to be raised passing a suitable error message.
FINALIZE_PROCESSING
You can use this method to implement any finalization or data cleanup
activities at the end of the overall business process.
Data Class
Enter the data class. The data class is used during profile processing. It
handles read and write database accesses to the corresponding process
ledger header and item data tables. It also handles the determination of the
characteristic value. If no class is maintained, the standard class /OTX/
PF04_CL_DATA is always used.
Analyt. Prof.
Analytics Profile. For analytic evaluations, data may need to be prepared on
the database. Enter the Analytics profile with profile type 1 - Process KPIs ,
if you want to trigger the update of Analytics database tables designed for
business processes. For details how to maintain an Analytics profile, see
“Configuring Analytics” on page 33.
You can control the basic technical functionality of the Processing Screen and its
different screen areas by maintaining the Processing Screen settings described in this
section.
Important
To use the Processing Screen in a proper way, a minimum screen resolution of
1600 x 900 is required.
The following screen areas are available and together form the overall appearance of
the Processing Screen during runtime:
Action Pane
The action pane integrates all process actions that have been configured for an
agent role. These process actions are available for a combination of the current
characteristic value (if applicable) and the process step. Each process action is
represented by a separate action button.
A maximum of 20 process actions is allowed. They are displayed by 5 action
button rows consisting of 4 action buttons each. The arrangement of the buttons
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 186. 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.
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.
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.
• MS_HEAD
• MT_ITEM
• MS_ITEM
• MT_ITEM_TCTRL
• MS_ITEM_TCTRL
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.
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.
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.
To define actions:
Action ID
Define the action using a 15 character unique action ID.
Note: Every action ID that is relevant for processing on Fiori side also
needs to be maintained as a corresponding work object type action
using the same action ID. For more information, see “Defining and
assigning node actions” on page 314.
Action Title
Enter the action title. It will be displayed as button text for the created
process action button in the action pane area of the Processing Screen.
Action Description
Enter a description of the action. The description will be displayed as tooltip
when the pointer is moved over the process action button.
Action Type
Select the action type from the list. The action type determines how a
defined action is handled during processing. It also determines whether the
action needs to be displayed in the action pane area of the Processing Screen
or not. The following action types are available:
Background Action
All actions of this type are not displayed in the action pane area of the
Processing Screen. However, these actions can be assigned to process
steps that are executed in background.
Dialog Action
For every dialog action, which is assigned to a process step, current
characteristic value, and agent role, an executable process action button
is created in the action pane area of the Processing Screen.
History Action
A history action is some kind of “dummy” action. It is nor available
from an Processing Screen process action button or within a
background process step. It can be used from anywhere in the process
to create a history entry for any purpose.
Referral Action
This action type is a special dialog action which is used to refer process
steps to other agent roles and/or users. It is displayed as an action
button in the action pane area of the Processing Screen.
Important
The following actions are framework actions that must be available in
all profile definitions:
Action Class
Enter the action class. The action class contains the logic that is processed
when executing an action during runtime. If no class is maintained, the
standard class /OTX/PF04_CL_ACTION is always used.
Default value: <Empty>
If the standard logic must be changed for any reasons, the class /OTX/PF04_
CL_ACTION must be inherited, redefined as needed, and entered as custom
action class.
The following methods are supposed to be redefined if needed. OpenText
recommends that you do not change any other method.
ACTION_LOGIC
This method provides logic that is executed for action of type Dialog
Action and Referral Action.
The method is called by the Processing Screen action pane when
pressing a process action button.
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.
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.
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.
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.
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.
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.
ACTION_REASONS_GET
This method allows to offer action reasons to be selected when
executing actions from the Fiori Task App.
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
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.
Action Icon
For dialog and referral actions, assign an icon symbol, which is displayed
on the created process action button in the action pane area of the
Processing Screen.
Timeline Icon
Assign an icon for visualization in the Fiori history screens.
Tip: All available icons are defined in the “SAP UI5 Icon Explorer”:
https://openui5.hana.ondemand.com/iconExplorer.html. The URL
might be object to changes.
To define roles:
Role ID
Define the role using a 15 character unique role ID.
Role Description
Enter a meaningful role description.
Role Type
Select the role type from the list. Based on the defined role type, the system
determines how the role has to be resolved. You can select one of the
following role types:
Organizational Object Assignment
You can assign a fixed organizational object type and ID to the role, for
example work center.
Role Resolution Logic
You can program a dynamic role resolution logic, which will be used
for the role resolution. For this role type, the assignment of a custom
role class is mandatory.
Role Class
Enter a custom role class if necessary. It contains all required logic to
resolve the assigned role users during runtime. If no class is maintained the
standard class /OTX/PF04_CL_ROLE is always used.
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.
• Rules based data enrichment, for example setting different Sales Order document
types.
• Document content based data enrichment, for example setting a high processing
priority if the document full text contains the “urgent” keyword .
• Master data based data enrichment, for example setting the material number
from the material master info record using the customer material number.
• Learning based data enrichment, for example setting payment terms from
learned index data in combination with provided document keywords or
descriptions.
1. Determine a target field value based on values learned from previous processes
with the same source field value.
2. Determine one or more target field values using logic implemented by a data
enrichment exit interface.
Data Enrichment ID
Define the data enrichment using a 16 character unique ID.
Data Enrichment Description
Enter a meaningful description.
Enrichment Type
The enrichment type reflects the two different technical data enrichment
configuration options.
Note: If you select this enrichment type the field type, learning
target field, and learning source fieldparameters are not
applicable anymore.
Field Type
The field type controls on which process ledger hierarchy level the data
enrichment is done. Select the field type from the list.
The following field types are available:
• Header Field
• Item Field
Active
Select the check box to set the data enrichment to active. Clear the check box
to set the data enrichment to inactive.
Note: Data enrichment learning keys are only applicable for learning based
data enrichments.
Sequence
Define the sequence that processes the data enrichment key fields to form
the corresponding data enrichment key.
Example: Material numbers should be determined in a two step approach. First from the
material master using a customer material number. If no result can be found then the material
number should be determined by learned user inputs as a fail safe option. If no data
enrichment logic target fields are maintained for the logic based data enrichment, the learning
based data enrichment can learn from the previous logic based data enrichment result instead
of user data inputs.
Note: Data enrichment logic target fields are only applicable for logic based
data enrichments.
3. On the Data Enrichment Logic Target Fields Overview screen, maintain data
enrichment keys. Use the following parameters:
Field Type:
The field type reflects on which process ledger hierarchy level the data
enrichment is done. Select the field type from the list.
The following field types are available:
• Header Field
• Item Field
• Logic Target Field: Define the target process ledger field which is
populated by the data enrichment.
DATA_ENRICH_LOGIC
You can define any data enrichment logic within this method.
DATA_ENRICH_CHECK
You can implement any custom logic that checks if the result of a business rule
that checks the correctness of the data enrichment result fails or succeeds.
You must additionally set the following process configurations to handle the
assigned data enrichments.
For more information, see “Maintaining process steps” on page 209 and “Assigning
process actions” on page 215.
Process Step Step Type Step Description Rule Rule Rule Class
Type
ENRICH_DAT Background Data enrichment ENRICH_D Change /OTX/PF41_CL_RULE_CHG_
AT DE_EXEC
ENRICH_MIS Dialog Data enrichment [Data Check /OTX/PF41_CL_RULE_CHK_
mismatch Enrichment DE_RSLT
ID]
Note: OpenText recommends to define one check rule per defined data
enrichment. This allows bypassing each failed data enrichment result check
separately.
Data Enrichment ID
Enter data enrichment IDs that are processed for the current characteristic
value.
Sequence
Maintain the sequence in which the assigned data enrichments is processed.
Enrichment Step
Enter the background process step which executes data enrichments.
Check Mismatch Step
Enter the dialog process step which executes all checks if the determined
data enrichment results are valid or not.
Check Mismatch Rule
Enter the check rule which checks if the determined data enrichment result
is valid or not.
When splitting business processes, the following technical assumptions are made:
1. After successfully splitting a business process into several target processes, the
source process is immediately finished.
2. Each target process is linked to the source process by writing the source process
ledger key to the target header ledger data table.
3. The started target process is not linked to any inbound process anymore.
4. The archived images connected to the source process will also be linked to the
target processes without rearchiving these images.
5. If the first target process workflow start fails, the process split is stopped
immediately without taking further action.
6. If the first target process workflow has been started successfully but any other
workflow start fails, the process split writes error log entries. They can be
accessed and reprocessed using a dedicated work center at any point of time.
Automatic reprocessing of workflow start errors is also possible by scheduling
the ABAP report /OTX/PF04_P_PTEL_REPROCESS.
Split ID
Process Split ID. Define the process split using a 16 character unique ID.
Process Split Desc.
Process Split Description. Enter a meaningful description.
Process Split Type
Select the process split type from the list. Based on the defined process split
type, the system determines how the process split must be determined and
processed. Currently only one process split type is available:
Process split based on line item grouping
You can maintain line item grouping fields that are used as process split
criteria, as described in “Maintaining line item grouping” on page 205.
With this split type the system uses the maintained line item grouping
fields to determine the corresponding line item groups. For each of the
determined line item groups a separate new business process is started.
In the following graphic, each row of empty gray boxes represents a line
item.
1. On the Process Split Configuration Overview screen (see “To configure the
process split functionality:“ on page 203), mark an entry, and then double-click
Line item grouping in the Dialog Structure.
2. On the Line item grouping Overview screen, maintain line item grouping fields
using the following parameter.
Field Name
From the process ledger item data table, select a line item field that is used
by the system to group line items for process splitting. You can maintain
multiple field names if needed.
PROC_SPLIT_REQUIRED_CHECK
Within this method, you can implement the logic if a process split is required or
not. It is called in the business rule class /OTX/PF41_CL_RULE_CHK_PS used for
the business rule Process split required.
PROC_SPLIT_GROUPS_DETERMINE
Within this method, you can implement the logic to define into how many
different target processes a process must be splitted and which index data is
assigned to each target process. It is called in the standard process split action
classes /OTX/PF41_CL_ACTION_PS_BGR, /OTX/PF41_CL_ACTION_PS_DIA and /
OTX/PF41_CL_ACTION_PS_EXT depending on if the process split takes place in
background or dialog and based on which user interface.
PROC_SPLIT_RESULT_CONFIRM
This method allows you to add a dedicated SAP GUI user confirmation dialog
before processing the determined process split result. It is called in the standard
SAP GUI process split action class /OTX/PF41_CL_ACTION_PS_DIA during dialog
processing.
PROC_SPLIT_DATA_HEAD_SET
You can use this method to influence the header index data used for the target
processes. It is called during the process split result determination. By default,
the same header index data is used as in the source process.
Note: To map data to the target ledger data tables, the system uses the
default field mapping ID. For more information, see “Defining external
data mapping” on page 167.
PROC_SPLIT_DATA_ITEM_SET
You can use this method to influence the item index data used for the target
processes. It is called during the process split result determination. By default,
no item index data is set because this can depend strongly on the process split
logic itself.
Note: For the process split type Process split based on line item
grouping, the standard class /OTX/PF41_CL_PROC_SPLIT_LG already
provides a logic to assign the line items to the target processes that
correspond to the maintained line item grouping fields.
PROC_SPLIT_CRITERIA_OUTPUT_GET
Within this method, you can format the used process split criteria for output in
the corresponding process split result confirmation dialog.
PROC_SPLIT_MSG_ERROR_ADD
This method allows adding custom error messages to the process history if any
of the target process starts fail.
PROC_SPLIT_MSG_SUCCESS_ADD
This method allows adding custom success messages to the process history in
case of a successfully started target process.
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:
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 179.
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 178.
Characteristic Description
Enter a meaningful description for the defined characteristic.
Process Split ID
Enter a process split configuration which is used to split a business process
for the current characteristic value if required. If you do not assign any
process split configuration, the process split functionality is considered as
inactive.
• “Maintaining rules that are excluded from simulation in the Info pane and Check
messages popup” on page 220
Process Step ID
Define the process step using a 10 character unique ID.
Process Step Description
Enter a meaningful process step description.
Step Type
Select the process step type from the list. The process step type controls how
a process step is determined and executed. The following process step types
are available.
Background Processing Only
Use this step type to execute background actions. It can be executed
only a fixed number of times. Otherwise, it would result in an endless
processing loop if the background processing fails over and over again.
The assignment of a background action ID is mandatory here. See
Action ID on page 211.
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 211.
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.
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
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.
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.
MODULE_EXEC_CHANGE
This method defines business rule change logic for the rule type Change
Data.
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).
Note: For check rules which should always fail by default without
further check requirements, you can use the /OTX/PF41_CL_RULE_
CHK_FAILED class without the need to create similar classes for every
rule check over and over again.
Sequence
Define in which sequence the business rules are executed within a process
step.
Frequency
Define how often a business rule is executed within a process step. The
following values are available.
Always
This means that a business rule will always be executed.
Custom
For this frequency, you must define a fixed number.
Note: For business rules that are assigned to process step type
Background Processing Only, you must restrict the number of
executions to prevent endless loops.
Frequency Count
If a Custom frequency is assigned, define how often a business rule is
executed.
Dialog
Select this check box to skip processing the corresponding background
action and to directly force dialog processing. This setting is only available
for process steps of type Background Processing with Dialog (Dialog on
Fail).
Active
Select this check box to set the business rule to active. Clear the check box to
set the business rule to inactive.
UI Type
Select the UI type from the list. The following values are available.
• SAP GUI
• Web
Role ID
Enter the role ID. With this field, you can define to which role the
corresponding actions are assigned. The assigned actions will be available
in the action pane of the Processing Screen and within the Fiori screens,
depending on the chosen UI type.
Note: If not all roles should have a special action assignment, it is also
possible to leave the Role ID field empty. This simplifies the
configuration. This general setting will then be used for roles that do
not have a dedicated action assignment. However, as soon as a role
specific setting is made, the general settings will not be considered for
this special role anymore.
Action ID
Assign the action ID, which should be available for execution.
Sequence
Define the sequence. It determines the order in which the action buttons are
created in the action pane area of the Processing Screen.
Process Node ID
Enter the process node ID. This setting allows assigning a process node ID
defined in the Process Foundation. When executing an action, the assigned
process node ID will be started next. Similar to the Process Node
Assignment in the process step definition (see Process Node Assignment
on page 211), 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.
Note: The role ID which has been defined as Inquire Role (see
“Maintaining Processing Screen settings” on page 180) 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.
2. In the Referral Settings Overview screen, maintain referral settings, using the
following parameters.
UI Type
Select the UI type from the list. The following values are available.
• SAP GUI
• Web
Note: Referral settings for the Fiori screens are intended for future
use only. They are not evaluated so far.
Action ID
Enter the action ID. If multiple different referral actions have been defined
in a business scenario, you can use this setting to refine the referral settings
for these different referral actions.
If the referral settings should be used for all referral actions in the same
way, leave the field empty.
Role ID
Enter the role for which the referral settings should be relevant.
Note: You might want to configure that not all roles should have
special referral settings. In this case, it is possible to leave the Role ID
field empty. This simplifies the configuration. This general setting will
then be used for roles that do not have a dedicated referral setting.
However, as soon as a role specific setting is made, the general
settings will not be considered for this special role anymore.
Refer to Role
Maintain which referral roles should be available. The maintained referral
roles will be available when executing a referral option. As soon as one of
the offered referral roles is selected in the refer action dialog box, all
corresponding users will be resolved accordingly.
Sequence
Define the sequence in which the possible referral roles should be offered in
the refer action dialog box.
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:
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.
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.
2. In the Bypass Rules Overview screen, maintain bypass rules, using the
following parameters.
Rule ID
Enter the business rules of the corresponding process step that can be
bypassed if required.
Comment Required
Select this check box to determine that a comment is required before
bypassing or reactivating a business rule.
Active
Select this check box to set the bypassing of a business rule to active. Clear
the check box to set the bypassing to inactive.
7.1.8.7 Maintaining rules that are excluded from simulation in the Info
pane and Check messages popup
You can exclude one or multiple business rules from the simulation in the info pane
of the SAP GUI processing screen as well as from the Fiori task app check
messages popup.
The screen and the popup are updated regularly during data indexing.
If you frequently process business rules with complex logic, performance can be
reduced significantly. For example, by calling BAPI functions to simulate document
postings. Therefore, it can be necessary to exclude business rules in certain
constellations and notify the end user that a corresponding business rule is
excluded.
Note: Business rules that are excluded, are still available in the simulate rules
process action. The Simulate process action is executed explicitly. Therefore, it
is not having an ongoing performance impact during data indexing.
1. In the Simulate Settings Overview screen mark an entry. For more information,
see “Maintaining simulate settings” on page 219.
2. In the dialog structure double-click Exclude Rule Simulation from Info Pane.
3. In the Exclude Rules Simulation from Info Pane Overview screen, maintain
excluded rules.
Use the following parameter:
Rule ID
Enter the business rules of the excluded process step.
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
• 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.
UI Type
Select the UI type from the list. The following values are available.
• SAP GUI
• Web
Note: Screen settings for the Fiori screens are intended for future
use only. They are not evaluated so far.
Role ID
Enter the role for which the screen settings should be relevant.
Note: If not all roles should have special screen settings, you can leave
the Role ID field empty. This simplifies the configuration. This
general setting will then be used for roles that do not have dedicated
screen settings. However, as soon as a role specific setting is made, the
general settings will not be considered for this special role anymore.
Initial Tab
Select the initial tab from the list. This defines which tab of the tab strip
containing the index data fields is the starting point when opening a process
step. You can select from of a maximum of 6 available tabs.
Allow Changes
Select this check box to determine that an agent role is allowed to change
data.
As soon as a role is not allowed to perform changes, the screen field settings
Input, Required, and Display Only are not relevant anymore.
Display Image
Select this check box to determine that the scanned image is automatically
opened and closed in a separate window when executing a process step.
This is independent form the currently chosen detail pane plug-in, which
could be Display Image at the same time as well.
• 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.
PF Profile
Enter the name of the corresponding Process Foundation profile, which
covers the technical SAP Business Workflow aspects.
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_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.
7.3 Authorizations
During processing of dialog work items, the standard authorization object J_6NPF_
PRF is checked. Therefore, it must be implemented using suitable authorization roles
or profiles. The /OTX/PF04_ADM_ROLE transaction also uses the authorization object
to check if administration authorizations are available.
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)
The Business Center Workplace is the central tool to process work objects in
Business Center.
Areas The following screen areas are available. Together, they form the overall appearance
of the Business Center Workplace screen during runtime:
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 2 “Business Center Workplace” in OpenText Vendor Invoice Management for
SAP Solutions - User Guide for Solutions Beyond Invoice (BOCP200400-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.
A work object is defined by the data selection, by the display of the data, and by
actions and functions.
3. In the Work Object Types Overview screen, double-click a work object type.
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 233.
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 235.
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 237
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 239.
Display structure
Enter the display structure to define the fields of the work object.
Important
The display structure must have the following fields:
Item structure
Define the display structure of the items.
Variant handle
Enter the identification number (Handle ID). If the same display class is
used in several work object types, this number allows to save work object
type specific variants for ALV grids.
If you use the /OTX/PF03_CL_DATA_VIEWER_ALV display class, set this
parameter. It must be unique.
Report ID screen
Enter the report that contains the selection screen. For more information, see
“Report ID screen” on page 244.
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.
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.
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:
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:
CHECK_NODE
This methods checks the authorization for a node which is related to the work
object type. This check is performed when the navigation tree contains nodes
which are related to a work object type. It is also called for nodes requested by
web services. Nodes that the user is not authorized for are not displayed.
The following table shows the parameters that are available:
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:
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 251.
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:
GET_INSTANCE
This method returns the instance of the handler class.
GET_NUMBER_OF_ENTRIES
This method returns the number of entries for display in the navigation tree.
SELECT_DATA
This method returns data objects.
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.
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.
GET_SELECTION_FMODULE
This method returns the name of the function module that is used for the data
selection. The standard implementation of class /OTX/PF03_CL_DATA_HANDLER_
DYN uses function module /OTX/PF03_DATA_SELECT_DYNAMIC for the data
selection. You can copy this function module and implement your own data
selection method.
Important
Do not change the parameters of the function module.
GET_LOGSYS
This method returns the logical systems that are used for the data selection. The
standard implementation of class /OTX/PF03_CL_DATA_HANDLER_DYN returns all
logical systems defined for the VIM Foundation. For more information, see
“Configuring logical systems” on page 23. If you want to restrict the logical
systems for a specific work object type, you can redefine this method and restrict
the logical systems.
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.
CHANGE_SELECTION_CRITERIA
This method allows to change the selection criteria before the data selection is
performed.
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).
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.
CHANGE_DYNAMIC_SELECTION
This method is only called if the /OTX/PF03_CL_DATA_HANDLER_DYN class is
used as data handler. It is called in function module /OTX/PF03_DATA_SELECT_
DYN_RFC, which performs the data selection for this data handler. When you
select data from a remote system, this exit allows you to perform a check of the
selected data in the remote system before the data is transferred to the system
from which the call was started.
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.
GET_INSTANCE
This method returns an instance of the data viewer class. The workplace main
application will then use this instance.
SET_WOBJ_TYPE
This method sets the work object type of the currently selected node.
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.
FREE
This method destroys all objects of the data viewer and the instance.
DETAILS_AVAILABLE
The workplace main program checks with this method if the detail pane is
available. If the display class returns in the DETAILS_AVAILABLE method that the
detail pane is not available, the main program will, for example, not offer the
function Display Detail Pane. The standard implementation, for example, sets
the detail pane to not available if no plug-ins are customized for this work object
type.
USER_COMMAND
Use this event to trigger an action for a work object.
Parameter Description
PI_ACTION Action ID
PI_WOBJ_ID Work object ID
CHANGE_NUMBER_OF_HITS
If the user requires a different number of hits, use this event to send the new
number of hits to the workplace main program. The node is then refreshed with
the new number of hits.
Parameter Description
PI_HITS Number of hits
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).
CHANGE_EXCLUDES
Change the excluded functions.
CHANGE_FCAT
Change the field catalog of the ALV grid, for example remove or add fields.
CHANGE_VARIANT
Change settings for variant usage.
CHANGE_LAYOUT
Change layout settings.
CHANGE_TITLE
Change the ALV grid title. The default ALV grid title is the node description.
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).
This report provides solution or customer specific selection screens for work object
types.
A selection screen allows the user to restrict the objects of a node by further selection
criteria. Selection criteria of the node cannot be overwritten. This means it is only
possible to restrict the selection by further criteria but not to disable selection criteria
defined for the node.
You need a custom program and screen that contain the selection criteria and
parameters.
Tip: A dynpro with several subscreen areas enables you to show select options
and parameters in parallel. Check sample report /OTX/PF32_IDF_SEL_SCREEN
with screen 100.
In the PBO and PAI modules of this selection screen (check sample screen 100 of
the /OTX/PF32_IDF_SEL_SCREEN report), you also must handle the logic for the
following purposes:
• to transfer the selection criteria used by the workplace main program to your
selection screen
• to transfer the selection criteria entered by the user on the selection screen to the
workplace main program
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.
SET_SELECTION_CRITERIA
Use this method to make the selection criteria entered in the selection screen
known to the /OTX/PF03_CL_UI_SEL_SCREEN class. The workplace main
program uses this method to set the initial selection criteria of the current node.
GET_SELECTION_CRITERIA
With this method, you can get the currently used selection criteria. With the first
call, this is only the selection criteria of the current node. With later calls, these
are the selection criteria of the node with additional criteria from the selection
screen.
The selection criteria can contain criteria for selection parameters available on
the screen. In this case, these values should be set in this criteria. The selection
criteria originally defined for the current node can not be overwritten. Therefore,
these selection criteria should additionally be set to not editable.
EXECUTE_USER_ACTION
This method raises an event, which is handled by the workplace main program.
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.
SELOPT_TO_PARAMETER
This method transfers a selection criteria to the format of a select option or
parameter.
GET_NODE_SEL_CRITERIA
This method returns the original selection criteria of the current node.
General logic Before the call of your selection screen, the workplace main program transfers the
currently used selection criteria to the instance of the /OTX/PF03_CL_UI_SEL_
SCREEN class. The workplace main program also sets the selection criteria of the
current node.
The workplace main program ignores any changes to the selection criteria of the
current node. This means you can only restrict the result list for the current node but
you cannot select other objects as originally customized for this node. For this
reason, make sure to prevent the change of the node selection criteria at the selection
screen. In the AT-SELECTION-SCREEN section, the select-options that are used in the
selection criteria of the current node (GET_NODE_SEL_CRITERIA method) can be read,
and these select-options can either be disabled or hidden.
In the PBO module, you must set the currently used selection criteria.
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:
Then you raise the SEARCH action using the EXECUTE_USER_ACTION method.
3. In the Work Object Types Overview screen, mark a work object type, and then
double-click Actions in the Dialog Structure.
4. In the Actions Overview screen, define actions, using the following parameters:
Action
Enter the ID of the action.
Button type
Define the display of the action in the ALV grid. Possible values:
Button 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 248.
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.
1. In the Actions Overview screen, mark an action, and then double-click Message
fields for bulk actions in the Dialog Structure.
2. In the Message fields for bulk actions Overview screen, enter one or more field
names (of the display structure) that are relevant for the end user in the context
of bulk action messages. The entered fields are displayed in success or error
messages that users get when performing bulk actions.
Example: You can enter the registration ID of the incoming document or the customer
name to be displayed in messages.
EXECUTE_ACTION method
Called at the execution of single and bulk actions.
Functions are global actions that are not related to one specific work object type
using the display class. A function allows to access transactions, reports, or jobs that
are related to the work object type as a whole. For example for Sales Orders, call the
VKM1 transaction to display all blocked sales orders.
3. In the Work Object Types Overview screen, mark a work object type, and then
double-click Functions in the Dialog Structure.
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.
Field Name
Name of the field in the display structure
Key Field
Select this check box to mark the field as key field. The field will be
highlighted in the ALV display as key field, and the column will be fixed.
Style
Define the field style. Possible values:
• None
• Hyperlink
• Icon
• Checkbox
Status
Define the field status. Possible values:
• Display
• Hide
• Available
Column width
Enter the column width.
This parameter defines the width of the column in the ALV table control
layout for display.
Column no.
Enter the column position.
This parameter defines the default position of the column in the ALV table
control layout for display.
The display class of the work object type must provide the field settings.
The /OTX/PF03_CL_DATA_VIEWER_ALV class automatically considers this
customizing.
3. In the Work Object Types Overview screen, mark a work object type, and then
double-click ALV Grid - Number of hits in the Dialog Structure.
4. In the ALV Grid - Number of hits Overview screen, define the settings for the
number of hits using the following parameters:
3. Basic Settings
In the Work Object Type Overview screen, mark a work object type, and then
double-click Basic Settings in the Dialog Structure.
4. In the Basic Settings Details screen, refine the dynamic data selection and
counting, using the following parameters.
Use ‘DISTINCT’
To determine that the selection will be executed with DISTINCT statement,
select this check box. This means that entries which have the same values in
all selected fields are only displayed once.
Counting field
The counting of entries will only count entries that have different values in
this field. For the counting, this provides the same logic as the DISTINCT
statement for the data selection.
Example: Process steps might be assigned to several users. If you want to show personal
tasks (process steps) for a user, you must include the table with the user assignment in
the dynamic data selection definitions. However, for nodes that are not restricted for a
user, this would mean that a process step is displayed several times (for each user
assignment). You can handle this case by activating the DISTINCT statement and using,
for example, the process step ID as counting field.
5. Tables
In the Work Object Type Overview screen, mark a work object type, and then
double-click Tables in the Dialog Structure.
6. 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.
7. Table joins
In the Work Object Type Overview screen, mark a work object type, and then
double-click Table joins in the Dialog Structure.
8. 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.
9. Join conditions
In the Table joins Overview screen, select an entry, and then double-click Join
conditions in the Dialog Structure.
10. Define the join conditions for the table join, using the following parameters.
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.
Table Name
Name of the table
Field Name
Name of the field
3. On the Work Object Type Association screen, define the work object type
association, using the following parameters:
Association Name
ID of the association
Workobject type
Parent work object type
Associated work object type
Associated work object type
Card.
Cardinality of the relationship (1:1 or 1:N )
4. Association Constraints
Mark an association, and then double-click Association Constraints in the
Dialog Structure.
Field Name
Field name of the parent work object type
Associated Field
Field name of the associated work object type
6. Additional Constraints
Double-click Additional Constraints in the Dialog Structure
ID
Criteria ID. Provide a unique ID for each criteria.
Attribute
Attribute of the associated work object type. Enter the field of the Data
selection structure of this work object type.
Sign
Enter I or E for an (I)nclude or (E)xclude condition.
Option
Enter the option of the condition (EQ, BT, NE, …)
Value low
Enter the lower selection value.
Value high
Enter the higher selection value.
The report checks for the selected work object types and displays the results in a list.
When executed, this report checks the J_6NPF_ADM authorization object, J_6NPF_
COM (Component) field, for the value 4 (Web UI).
Parameter Description
PIS_WOBJ_TYPE Work object type customizing
PIS_NODE Configuration of current node
PI_SEL_CRITERIA_TYPE Type of selection criteria:
NORM: Normal entries
PIS_DYNAMIC_NODE Dynamic node configuration - only filled if the exit is
called in the context of a dynamic node
PCT_SEL Selection criteria of the node. Prefilled with the
customized selection criteria.
8.3 Navigation
The navigation defines the particular queues and folders in the 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. Nodes are also used in the Fiori
Task App.
To define nodes:
Node ID
Unique ID of the node
Workobject type
Work object type that is processed by the node if data access is available.
Structural nodes without work object types are possible, as well.
Active
Select this check box to activate a node in order to display it in the 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 260.
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.
1. In the Nodes Overview screen, select a line, and then double-click Filter criteria
in the Dialog Structure.
2. In the Filter criteria Overview screen, define the filter criteria, using the
following parameters.
ID
Criteria ID. Enter the ID of the filter condition (values: 00 to 99)
Each entry is taken into account with an OR connection. For different
attributes, an AND connection is used.
Attribute
Enter the field of the Data selection structure of this work object type.
Sign
Enter I or E for an (I)nclude or (E)xclude condition.
Option
Enter the option of the condition (EQ, BT, NE, …)
Value low
Enter the lower selection value.
Value high
Enter the higher selection value.
Exit for dynamic filter criteria
Enter a user exit that allows adjusting the filter criterion dynamically at
runtime or replacing the filter criterion by one or more filter criteria. This
enables you to consider the current user or date in the filter criteria. This
exit must implement /OTX/PF03_IF_SEL_CRITERIA. For more information,
see “Exit for dynamic filter criteria” on page 255.
1. In the Nodes Overview screen, select a line, and then double-click Order by in
the Dialog Structure.
2. In the Order by Overview screen, define Order by, using the following
parameters.
Priority
Order priority
Table Name
Name of the table from which the field is selected
Field Name
Name of the selected field
Asc./Desc.
Select the sort order: Descending or Ascending
1. In the Nodes Overview screen, select a line, and then double-click Action
restrictions in the Dialog Structure.
2. In the Action restrictions Overview screen, define the actions that should not
be available, using the following parameter.
Action
ID of the action that should be excluded
1. In the Nodes Overview screen, select a line, and then double-click Field
restrictions in the Dialog Structure.
Field Name
Name of the field that should be excluded
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.
Parameter Description
DISPLAY_POS Position which this node should have (in relation to the
other added nodes)
WOBJ_TYPE Work object type
DISPLAY_NUMBERS Indicator if number entries are displayed next to the
folder in the tree. Possible vales:
CURR: number of entries of current node
SUB: number of entries for all sub nodes which have
option CURR
<space>: number of entries is not displayed
DESCRIPTION Text of the node
NODE_ICON Icon to be shown in front of the node
DEF_SEL_SCREEN Selection screen is displayed by default.
DISPLAY_DATA Display data for this node
DEFAULT_NODE This node is a default node. At the initial display of the
navigation tree, this will be marked and the data will be
displayed.
Parameter Description
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.
Configuration ID
ID of the structure
Configuration description
Enter description text.
Type
Select the filter type. The following options are available.
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.
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.
Filter Label
Enter text for the label of filter option at node level 1.
1. In the Configuration Overview screen, select a line, and then double-click Top
nodes - level 0 in the Dialog Structure.
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:
Select scr
Select this check box to automatically display the selection screen when the
node is opened. Thereby it is possible to restrict hits. A selection screen
must be defined for the work object type of the node.
Empt. node
Select this check box to display the node even if there are no entries for the
node and all subordinated nodes.
Displ. dat
Select this check box to display the entries according to the filter criteria of
the node when the node is opened.
Down crit.
Select this check box to pass on the filter criteria of the node to subordinated
nodes.
Def. node
Select this check box to define the node as default node. It is automatically
selected at the first display of the structure.
1. In the Configuration Overview screen, select a line, and then double-click Sub
nodes - level <x> in the Dialog Structure where <x> is a number from 1 to 4.
2. Define sub nodes on the chosen level, using the following parameters.
1. In the Configuration Overview screen, select a line, and then double-click Filter
labels for work object types in the Dialog Structure.
2. Define labels for the second filter, using the following parameters.
Workobject type
Work object type.
2nd Filter Label
Enter the label for the 2nd filter option. This is only used if the first filter is
of type Filter for work object types.
3. In the Work Center Overview screen, define work centers, using the following
parameters.
Work Center ID
ID of the work center
Active
Select this check box to define the work center as active.
Work Center text
Enter a description.
Priority
Enter a priority number (possible values 00 to 99). Work centers are sorted
according to this priority.
Configuration ID
Enter the ID of the navigation structure that shall be displayed in the work
center.
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.
J_6NPF_WTY - OpenText Business Center for SAP Solutions - Work Object Types
This authorization object provides the following fields.
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.
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.
The following sections give you detailed information about the landscape,
customizing options and the interface of the Fiori Task App and the underlying
technical concept of Web Services, which are both a part of VIM Foundation.
The Fiori Task App is a light-weight web application following the Fiori design
principles. It represents an inbox showing the items that have been assigned to the
logged-in user. The user then is able to complete items by performing dedicated
actions, entering comments, and editing the data.
You configure the complete content of the Fiori Task App by customizing and
implementing interfaces of the Web Services. Therefore no extension points for the
Fiori Task App are offered and enhancements of the Fiori Task App or the VIM
Foundation OData services are not supported.
If a navigation option is set, the UI renders (instead of a plain text cell) a link or icon
that the user can click in order to trigger the navigation. The navigation link
parameter must contain a perspective ID of an existing item or action dialog
perspective depending on the chosen navigation type. In case of semantic
navigation, a JSON construct as described in “Semantic object navigation with the
Fiori Task App” on page 279 is expected. Using the navigation mechanism you can
display further item details (using an item perspective) or can trigger a semantic
object navigation to another app.
Value
Parameter name Description
specification
Mandatory
appMode FS Sets the mode of the application.
workplaceId (mandatory
<value> The workplace to show.
parameter)
Optional
Alias of the backend system to which
the OData service establishes a
connection. If the parameter is not set,
system <value>
the Fiori Task App tries to connect to a
system with the SAP System Alias
LOCAL.
systemAlias <value> Alternative to parameter system
If parameter is set to false, the
complete surface of the screen is used
letterBox (only applicable
<true|false> for the app. Otherwise, there is some
in Launchpad)
free space on the left and the right.
Default value is true.
If parameter is set to false, fields
with configured semantic object
semanticNavEnabled (only
<true|false> navigation are not active. Use the
applicable in Launchpad)
parameter if target applications are not
installed. Default value is true.
Sample Item Perspective that is displayed when the user clicks on a cell
(independent of the row) in the Process Key column.
Figure 9-2: Layout and Data View Composition of a detail screen (Item
Perspective)
Value
Parameter name Description
specification
Mandatory
appMode FS Sets the mode of the application.
The workplace to which the specified
workplaceId <value>
node is assigned to.
The work object type from which the
wobjType <value>
node has been created.
The node specifying a specific object
nodeId <value>
selection in the backend.
Optional
Alias of the backend system to which
the OData service establishes a
connection. If the parameter is not set,
system <value>
the Fiori Task App tries to connect to a
system with the SAP System Alias
LOCAL.
systemAlias <value> Alternative to parameter system
If parameter is set to false, the
complete surface of the screen is used
letterBox (only applicable
<true|false> for the app. Otherwise, there is some
in Launchpad)
free space on the left and the right.
Default value is true.
If parameter is set to false, fields
with configured semantic object
semanticNavEnabled (only
<true|false> navigation are not active. Use the
applicable in Launchpad)
parameter if target applications are not
installed. Default value is true.
Initially applied filter that can be
filter <url_encoded_value> revoked by the user (must match
existing filter categories and values).
Works in combination
with searchValue - initially applied
searchField <value> search that can be revoked by the user
(must match existing search
categories).
Value
Parameter name Description
specification
Works in combination
with searchField - initially applied
searchValue <url_encoded_value> search that can be revoked by the user
(must match existing search
categories).
Works in combination
with sortDirection - initially
sortOption <value> applied sorting that can be revoked by
the user (must match existing sort
options).
Works in combination
with sortOption - initially applied
sortDirection <asc|desc>
sorting that can be revoked by the user
(must match existing sort options).
The data selection of the node is shown on the left in the master area. Which data
fields are shown in each list item, is configured using the data binding of the master
list. For more information, see “Configuring the data binding for the master list”
on page 315.
Whenever a list item is clicked, the detail area loads the item perspective of the node.
For more information, see “Enabling nodes for Web Services” on page 311:
Perspective ID item. Then, the detail area fills the data views by requesting detail
data for the selected item. Therefore ensure that for each data view in the
Further item navigation options are maintained under the Work Object Type. For
more information, see “Defining item related actions” on page 304. The available
options for the master detail mode are described in “Navigation capabilities”
on page 278. After an action has been defined by its type, parameter, and some
other details, you must decide where the action should occur on the detail area page.
There are two places:
• First place is in the footer toolbar. Put there every action with a transacted
behavior regarding the item.
• The other place is on top of the page in an InplaceItemAction Data View or
BcCustomObjectPageHeader control. Specify the place by filling the Perspective
view ID parameter of an action.
Note: If this parameter is not filled, the action does not occur on the screen.
Value
Parameter name Description
specification
Mandatory
The workplace to which the specified
workplaceId <value>
node is assigned to.
The work object type from which the
wobjType <value>
node has been created.
The node specifying a specific object
nodeId <value>
selection in the backend.
Optional
The App is called in master detail
mode. Master detail mode is also the
appMode <MD>
default mode if the appMode
parameter is not specified in the URL.
Alias of the backend system to which
the OData service establishes a
connection. If the parameter is not set,
system <value>
the Fiori Task App tries to connect to a
system with the SAP System Alias
LOCAL.
systemAlias <value> Alternative to parameter system
If parameter is set to false, the
complete surface of the screen is used
letterBox (only applicable
<true|false> for the app. Otherwise, there is some
in Launchpad)
free space on the left and the right.
Default value is true.
Value
Parameter name Description
specification
If parameter is set to false, fields
with configured semantic object
semanticNavEnabled (only
<true|false> navigation are not active. Use the
applicable in Launchpad)
parameter if target applications are not
installed. Default value is true.
If this parameter is set, the Master area
is hidden initially both in portrait and
landscape. The Master area can be
opened by clicking on the top left
splitAppMode HideMode
corner button or swiping right. Swipe
is only enabled on mobile devices.
Master will keep the open state when
changing the orientation of the device.
Initially applied filter that can be
filter <url_encoded_value> revoked by the user (must match
existing filter categories and values).
Works in combination
with searchValue - initially applied
searchField <value> search that can be revoked by the user
(must match existing search
categories).
Works in combination
with searchField - initially applied
searchValue <url_encoded_value> search that can be revoked by the user
(must match existing search
categories).
Works in combination
with sortDirection - initially
sortOption <value> applied sorting that can be revoked by
the user (must match existing sort
options).
Works in combination
with sortOption - initially applied
sortDirection <asc|desc>
sorting that can be revoked by the user
(must match existing sort options).
The search, filter, and sort can use criteria that are defined in the node
customizing: OpenText Business Center for SAP Solutions > Web
Services > Workplace > Nodes – Search Fields, Sort Fields, Filter fields.
Alternatively, the search, filter, and sort can use criteria that is defined in the
implementation of the node exit: interface /OTX/PF62_IF_NODE, for example
method CHANGE_NODE_FILTER_FIELDS. For more information,
see “CHANGE_NODE_FILTER_FIELDS” on page 375.
• Using a concrete webId, typically used when coming from a semantic object
navigation.
Note: In this case all keys necessary to build the webId for the target
application must also be part of the keys specified for the source
application.
• Using an alias where the keys are explicitly maintained. For more information,
see “Defining aliases for a work object” on page 299.
Value
Parameter name Description
specification
Mandatory
appMode OBJ Sets the mode of the application.
The workplace to which the specified
workplaceId <value>
node is assigned to.
The work object type from which the
wobjType <value>
node has been created.
The node specifying a specific object
nodeId <value>
selection in the backend.
Value
Parameter name Description
specification
The webId or webIdAlias specifying
webId | webIdAlias <value>
the concrete item.
Optional
Alias of the backend system to which
the OData service establishes a
connection. If the parameter is not set,
system <value>
the Fiori Task App tries to connect to a
system with the SAP System Alias
LOCAL.
systemAlias <value> Alternative to parameter system
If parameter is set to false, the
complete surface of the screen is used
letterBox (only applicable
<true|false> for the app. Otherwise, there is some
in Launchpad)
free space on the left and the right.
Default value is true.
If parameter is set to false, fields with
semanticNavEnabled configured semantic object navigation
(only applicable in <true|false> are not active. Use the parameter if
Launchpad) target applications are not installed.
Default value is true.
Customizing
You configure the navigation using VIM Foundation customizing or by
implementing the interfaces of the Web handler (see“Web handler” on page 380) or
the Perspective class /OTX/PF62_IF_PERSPECTIVE_CLASS (see “Interface /OTX/
PF62_IF_PERSPECTIVE_CLASS” on page 415). The relevant settings are Link type
and Link parameter. For semantic object 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
following.
Link type
This field defines the type of the link. Possible values:
• 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>
}
}
Note: The value of the filter and searchValue parameters must be URL-
encoded.
{
"target": {
"semanticObject": "Z_OTX_BC",
"action": "display"
},
"params": {
"nodeId": "PS02_ORDER_INBOX",
"wobjType": "PS02_PRC_ORDER",
"workplaceId": "WP_INBOX",
"filter": "VKORG%20EQ%201000%20AND
%20VT_WEG%20EQ%2001",
"searchField": "KUNNR",
"searchValue": "1000",
"sortOption": "WI_PRIO",
"sortDirection": "ASC"
}
}
You can set or change link types and link parameters using the web handler
interface. For more information, see the links in this section:
The new GET_ITEM_LINKS method allows defining the link parameter of single line
items. The method is called when the user clicks a link in one of the line items. For
more information, see “GET_ITEM_LINKS” on page 402.
Perspective views are delivered using the following BSP applications which reside
on the frontend server:
• PF07_BC_UI_03,
• PS30_VIM_UI_03 (and custom BSPs).
Perspective A perspective has a 1:1 relation to a perspective layout. Therefore you can modify
Layouts the layout without influencing other perspectives. You can maintain dedicated
perspective layouts separately as drafts for perspectives. You can create a
perspective from an existing perspective or perspective layout. When the
perspective is saved, it is always independent to any used draft object (either
perspective layout or another perspective).
Perspective Business Center 16.3 introduces the Perspective Editor, a maintenance tool that
Editor allows you to perform all configuration tasks on perspectives and their elements.
You can start the Perspective Editor from the Launchpad by clicking the
Perspectives Maintenance tile.
Note: To see this tile, the Perspective Editor must be configured. The tile
configuration is delivered with a transport: Administration - /OTBCWUI/PF07_
BC_ADMIN - Perspective Manager. For more information , see Section 11.4.3.1.1
“Transports” in OpenText Vendor Invoice Management for SAP Solutions -
Installation Guide (VIM200400-IGD). You only need to configure the backend
connection of this tile.
“Old” templates Perspective templates (that were used in Business Center versions earlier than 16.3)
are stored in BSPs as UI5 XMLS Views. They are available for backward
compatibility. When you modify a perspective with a template in the Perspective
Editor and save it, the template is converted into a UI5 JSON View Perspective
Layout that is stored in a backend table. You must manually convert any inline CSS
data. Also localized texts must be converted manually.
To switch between Perspectives and Layout, click the corresponding icon on the
toolbar on the top.
The way how you work with perspectives and layouts is similar, the procedure is
therefore described only once.
In the search and filter bar below the toolbar, you can perform the following actions:
3. Select the items on the check-box that gets available and perform the action.
1. In the search box on the very left, enter a case-sensitive search term.
2. Optional To define where the term is searched, click the down icon to the right of
the search box.
Available are:
• Perspective ID
• Description
• Changed By
• Object ID
4. To clear the search term, click the cross icon in the search box.
1. To filter the list, using the filters that are displayed on top of the list:
• In the perspective list, click More Actions > Delete for the perspective
that you want to delete.
Perspective Type
Choose Item, Action Dialog, or Field from the list.
Perspective ID
Mandatory. Enter a meaningful ID for the perspective.
The ending of the ID defines the device type:
• _S
Smartphone
• _M
Tablet
• _H
Hybrid
• without ending
If you do not define a device type, the systems only uses this
perspective if no other perspective is available.
If a perspectives for device types exist, the first perspective with
device type is used.
The order of the checks is:
Smartphone > tablet > hybrid > desktop.
This allows, for example, to specify one perspective which fits for
smartphone and tablet if you only define a perspective with device
type _M.
3. Click Create.
To rename a perspective:
1. In the perspective list, click More Actions > Rename button for the
perspective that you want to rename.
2. In the Rename Perspective dialog box, enter the new name for the perspective,
using the following parameters:
Perspective ID
Enter the new name.
Description
Enter a description of the perspective.
3. Click Rename.
The selected perspective is copied to the new perspective ID. The old
perspective is deleted. All customizing entries related to the old perspective are
copied/changed to the new perspective ID.
To transport a perspective
Note: The action is also available as bulk action. For more information, see“To
enable a bulk action“ on page 287.
The Changed at and Changed by columns in the perspective list are relevant for
perspectives that are changed using one of the following actions:
• Rename
• Activate
• Deactivate
• Edit
If a perspective is changed, the user and timestamp are logged. The information is
displayed in the Changed by and Changed atcolumns.
Device specific To maintain a device specific perspective, you must append the general perspective
perspective ID with a specific suffix. During perspective retrieval, the system first tries to get a
device specific perspective. If no such perspective exists, the standard perspective is
used.
Tree area The tree area on the left lists all perspective elements in a cascading structure. In
detail, a perspective comprises the following elements:
Layout root element.
Layout container. SAP UI5 control representing a specific layout, for example a
vertical layout. If the icon is green on the right side, a CSS class is assigned to
the layout container.
To see all available layouts, open the Layouts palette.
Aggregation. An aggregation is a special relation between two UI element
types. It is used to define the parent-child relationship within the tree
, structure. The parent end of the aggregation has cardinality 0..1, while the
child end may have 0..1 (empty triangle) or 0..* (filled triangle). Examples are
table rows and cells, or the content of a table cell.
Data view. A data view acts as dynamic part of a perspective. It displays data
according to the data binding defined in the customizing. A green label on the
right side of a data view indicates that a CSS class has been assigned. Each
view type can be inserted multiple times in a perspective.
Note: The History and Attachments views will always display the same
data. They cannot be configured on view instance level. So it makes sense
to include them only one time.
LayoutData. For some layouts (for example grid), you can attach specific
LayoutData to the children of the layout. LayoutData steers where and how the
child is displayed in the container if the container supports this flexibility.
Examples are column span of an element or alignment.
To edit a perspective:
1. On the start page, click the perspective or the corresponding pencil icon.
2. In the Select Customizing Request dialog box, select a request, and then click
OK.
Notes
5. Optional To add a scroll bar to the whole page at runtime, if necessary, select the
Scrolling of page enabled check box.
6. For elements under Layout Containers, and Layout Data in the Palettes area,
click SAP API Information from the context menu to display the corresponding
page of the SAP Help.
7. Optional To add further UI5 layout containers, click Add UI5 Control on the
context menu of Layout Containers.
To add custom data views, click Add Module Views on the context menu of
Views.
8. To edit the properties of an element, click the element in the tree structure. In
the Properties area, make the required changes.
For Layout Containers, the properties are read from the control metadata. They
rely on the UI5 toolkit version.
For properties with <string>, you can maintain a localization key:
a. Enter the text key in the field in upper case and angle brackets.
b. Click the globe icon.
c. In the Localization dialog box, enter the value corresponding to the text
key.
• Change the perspective at runtime, for example make some areas visible or
invisible depending on computation in the backend. In such a scenario you
would bind the “visible” property of one or more layout containers.
• Arrange an arbitrary number of sap.m.ObjectAttribute and/or sap.m.
ObjectStatus in any of the available layouts to be presented somewhere on the
page, typically in the headerContent of the sap.uxap.ObjectPageLayout.
• Fields of the display structure of the root work object type or its associated
work object types.
• PF62_IS_LOCKED: Lock icon for a field.
• PF62_LOCKED_BY_USER: User who locks the field.
You can change or delete an existing binding with the corresponding actions in
the binding action sheet, which is always opened when you click the property.
In the perspective editor you can assign the predefined controller methods to the
press event of the corresponding buttons of your pages used in the
FlexibleColumnLayout.
The following predefined controller methods are available for the press event:
• onToggleMidColumnFullScreen
• onCloseMidColumn
• onToggleEndColumnFullScreen
• onCloseEndColumn
• Automatically shows or hides the buttons at runtime according to the state of the
FlexibleColumnLayout control
To trigger the display of a page in the FlexibleColumnLayout control, you can use
the action type Change page in flexible column layout (parameter = page id)
(FLEX_PAGE) in the action customizing row of the FullScreenList or
AdvancedLineItems.
One exception is the maintenance and translation of perspective texts, which is still
done in the Business Center IMG.
2. Click OpenText Business Center for SAP Solutions > Web Services >
Perspectives > Perspective texts.
Perspective ID
Unique ID of the perspective.
Pers. Type
Select the perspective type. Choose Item, Action Dialog, Node, or Field
from the list.
Description
Description of the perspective.
4. To maintain texts for a perspective, mark the perspective, and then double-click
Texts in the Dialog Structure.
5. In the Texts Overview screen, maintain texts using the following parameters:
Text Id
Unique ID of the text.
Text
Enter the text for the perspective. For translation, click Translation on the
Goto menu.
2. Click OpenText Business Center for SAP Solutions > Web Services
• Basic Settings
• Launchpad Setting Actions
2. Click OpenText Business Center for SAP Solutions > Web Services > Basic
Settings > Basic Settings.
3. In the Basic Settings Overview screen, configure basic settings using the
following parameters.
Device typ
Device type. You can define the settings for each device type: Tablet,
Desktop, Smart phone, Hybrid devices, All devices.
Setting
Use web viewer (if available) for desktop document view.
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.
• Web Viewer or Brava! View can only be switched off (or is not
mandatory) if the archive delivers the documents as PDFs. In that case,
the native PDF viewer of the client is launched to display the document.
On iOS devices, the native viewer is launched in a separate browser tab
when touching the first page image.
• If you use the SAP Cloud Platform deployment option, Web Viewer
must not be activated. It is not supported within this deployment
option.
Whenever the Fiori App is called in the SAP Fiori Launchpad, the App checks how
the Launchpad is customized and adds the defined Apps to the user menu.
You define the object navigation to other Apps in the Launchpad Setting Actions.
Your settings are restricted by the workplace, the optional node and by an action ID.
Note: You have to authorize the users to the action ID in the J_6NPF_WTY
object.
2. Click OpenText Business Center for SAP Solutions > Web Services > Basic
Settings > Launchpad Setting Actions.
4. In the New Entries: Overview of Added Entries screen, configure basic settings
using the following parameters.
Entries to define the app or node that contains additions in in the User menu
Work Center ID
Unique ID of the work center.
Node ID
Unique ID of the node. For information about defining nodes, see “Defining
nodes” on page 256.
Workobject type
Work object type which contains the Apps in the user menu.
Action ID
ID of the action.
Device type
Device type. Possible values:
• SMARTPHONE
• MOBILE
• DESKTOP
• COMBI
Entries to define the standard or solution specific Apps that are shown the User
menu
Web Icon
Add the icon that is shown for the app.
Semantic Object Action
Add the action that is performed for a bundle of applications that form the
semantic object.
ShellHash
Add the routing path of the part of the app that you want to show.
Action Text
Add the text that displays for your users.
Tooltip
Add the text that displays when you mouse-over.
5. Optional If you want to deactivate an App in the User menu, select the Inactive
check-box
If you create a new work object type in this view, you also need to maintain the
settings in OpenText Business Center for SAP Solutions > Workplace
Configuration > Work object types > Work object types for the new work object
type.
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.
2. Click OpenText Business Center for SAP Solutions > Web Services > Work
Object Type > Work Object Type.
3. In the Work Object Type Overview screen, mark a work object type, and then
double-click Key definition in the Dialog Structure.
4. In the Key Definition Overview screen, define keys for the work object type,
using the following parameters.
Key pos.
Key position. Define the position of the field in the key. 16 position values
are available.
Field Name
Enter the name of the field.
Log. Sys.
Logical System. Select this check box to define that the content of this field
contains the logical system.
Important
The overall length of the key fields must not exceed 117 characters.
2. Click OpenText Business Center for SAP Solutions > Web Services > Work
Object Type > Work Object Type.
3. In the Work Object Type Overview screen, mark a work object type, and then
double-click Alias in the Dialog Structure.
4. In the Alias Overview screen, define aliases for the work object type, using the
following parameters:
5. Mark an alias, and then double-click Alias Object - Key Values in the Dialog
Structure.
6. In the Alias Object - Key Values Overview screen, enter key values for the alias
object, using the following parameters:
Field Name
Choose the key fields and set the values of the work object. You must
maintain values for all key fields.
Value
Enter the corresponding value.
2. Click OpenText Business Center for SAP Solutions > Web Services > Work
Object Type > Work Object Type.
3. In the Work Object Type Overview screen, mark a work object type, and then
double-click Related business object in the Dialog Structure.
4. In the Related Business Object Details screen, configure the related business
object using the following parameters.
Example: For the Sales Order solution (OTBCSL02), this can be the object
type KNA1 (customer) with the key field KUNNR (customer number).
2. Click OpenText Business Center for SAP Solutions > Web Services > Work
Object Type > Work Object Type.
3. In the Work Object Type Overview screen, mark a work object type, and then
double-click Data Collections in the Dialog Structure.
4. In the Data Coll. Scope (Data Collections Scope) field, select the scope (process
step) for which this data collection should be used. Possible values:
Action Dialog
Data Collection starts before an action dialog box opens and is finished
when the action dialog box closes.
Perspective Life Time Token
Data Collection starts when a item perspective is loaded and ends when the
user leaves this item perspective.
Methods:
/OTX/PF00_IF_DATA_COLLECTION~GET_INSTANCE
/OTX/PF00_IF_DATA_COLLECTION~CREATE_COLLECTION
Structure of PIS_DATA_COLLECTION:
/OTX/PF00_IF_DATA_COLLECTION~REMOVE_COLLECTION
SET_ADDITIONAL_INFORMATION
2. Click OpenText Business Center for SAP Solutions > Web Services > Work
Object Type > Work Object Type.
3. In the Work object type Overview screen, mark a work object type Actions in
the Dialog Structure.
4. Double-click an action.
5. In the Actions Details screen, customize the action using the following
parameters:
Workobject type
Work object type for which actions should be made available.
Action ID
ID for the action.
Action order
Define the order of actions. The action with the lowest number is displayed
to the left.
Action type
Select the action type from the list. The following types are available:
Perspective ID
Enter the perspective ID, which is used for Edit actions.
Link parameter
Enter the link for the semantic object navigation.
Action dialog class
Enter a class with logic for the Action dialog box. The class must implement
the /OTX/PF62_IF_ACTION_DIALOG interface.
Web Icon
Enter the icon that is displayed on the action button.
Tip: All available icons are defined in the “SAP UI5 Icon Explorer”:
https://openui5.hana.ondemand.com/iconExplorer.html. The URL can
be subject to changes.
UI 5 button type
Enter the SAP UI5 button type. Choose one of the following types:
• Transparent type
• Unstyled type (no styling)
Perspective view ID
Enter this parameter to set the location of the action. If no perspective view
ID is maintained, the action is not shown.
You can place actions in the footer toolbar by setting the property
itemActionsViewId of the root element in the Item perspective using the
Perspective Editor. The chosen ID must be unique and the linkage happens
by specifying the same ID as Perspective view ID in the action.
You can place actions anywhere on the page by using UI5 controls which
are designed to contain action buttons.
The Perspective view ID must then match the control ID.
Action text
Enter the text that is displayed on the button.
Tooltip
Enter the tooltip that is shown for the button.
This setting can be overwritten at runtime using the CHANGE_ACTIONS
method of interface /OTX/PF62_IF_ITEM_HANDLER. For more information,
see “CHANGE_ACTIONS” on page 381.
Bulk action
Select this check box to define the action as a bulk action.
Notes
Aggregation Name
Aggregation of the UI5 control to which the control action is assigned to.
The Aggregation of the UI5 control is specified in Perspective view ID. By
default the contentRight aggregation is used.
SAP UI5 Button Class
SAP UI5 control that is used to display the action. By default sap.m.Button
is used.
2. Click Web Services > Work Object Type> Work Object Type.
3. Select a Workobject type, and then click Semantic Object Navigation
5. To define further parameters, select the Semantic Object entry, and then
double-click Parameters sub-settings.
Parameter:
Name of the parameter. You find the parameters for the BC Fiori App via
search help.
Value:
Maintains the values for the parameter.
• PF62_ACTION_ID
• PF62_DEVICE
• PF62_WEBID
• PF62_WOBJ_TYPE
• PF62_SAP_ORIGIN
Exit Class
Defines an exit class. For changing the parameter at runtime enter a class
implementing the /OTX/PF63_IF_CONV_PARAM_VALUES interface. The value
of the parameter is changed in the CHANGE_PARAMETER_VALUE . For more
information, see /OTX/PF63_IF_CONV_PARAM_VALUES interface :
on page 309.
The BC framework calculates the semantic object navigation target based on this
customizing at runtime.
/OTX/PF63_IF_SEM_OBJ_NAV interface:
GET_INSTANCE method:
Returns a class instance. Parameters:
CHANGE_PARAMETER method :
Allows to change customized parameters and values at runtime. Parameters:
/OTX/PF63_IF_CONV_PARAM_VALUES interface :
CHANGE_PARAMETER_VALUE method
Allows to change the value of a single parameter, when a this parameter is
calculated.
In the setting you define which views are refreshed in an item perspective when this
action is executed.
9.6 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.
2. Click OpenText Business Center for SAP Solutions > Web Services >
Workplace > Work Center.
3. In the Work Center for Webservice Overview screen, define work centers using
the following parameters:
Work Center ID
Unique ID of the work center.
2. Click OpenText Business Center for SAP Solutions > Web Services >
Workplace > Nodes.
3. In the Nodes Overview screen, enable nodes for Web Services using the
following parameters.
Node ID
Unique ID of the node. For information about defining nodes, see “Defining
nodes” on page 256.
Workobject type
Work object type of the node.
Each node is connected to a work object type. When the user selects a node,
the work object type is automatically filled.
Active
Select this check box to activate the node in order to display it in the
Business Center Workplace.
Perspective ID item
Enter the ID of the item perspective. This perspective is used when the
items of the node are displayed with appMode MD (master detail).
Node description
Enter a meaningful description of the node. The description is displayed at
the top of the inbox in the Fiori Task App.
• Error
• None
• Success
• Warning
None is the default value. In the workplace view (Full screen with work
center as entry point) the icon and the node text are displayed in a color
according to their status.
Bulk activ
Bulk actions active. Select this check box to indicate that at least one bulk
action for this node is available. Therefore, the Edit button at the top of the
master list in the Fiori Task App is available.
Note: Bulk is only available in the Fiori Task App if there is no paging
in the inbox.
Counter Inactive
When the app is started as Full screen with work center as entry
point, the entries for all nodes of this workplace are counted. The number
of entries for each node is displayed below the node icon. If you do not
want to have this counter for the node, select Counter Inactive.
Max. List Desktop, Max. List Tablet, Max. List Smartphone
Note: This setting is only considered in the old node list view. To use
the old view, activate Use Node List View checkbox.
Enter the maximum list sizes for this node, depending on the device.
Default values for smart phones and tablets is 100, for desktop 500.
The list size defines how many items can be displayed in the node list
maximally. When configuring this value, consider the capabilities (memory
and CPU) of the device because all objects are loaded in the Document
Object Model (DOM) of the HTML page. If you choose the number too high,
it can happen that the application becomes very slow or unresponsive.
Export enabled
Select this check box to configure that all columns visible for the user can be
downloaded to a Microsoft Excel file, using a Download button. By hiding
columns, users can restrict the downloaded columns.
Perspective ID
If you want to use the Flexible Column layout for this node in the Master
Detail pattern, enter the corresponding perspective.
2. Click OpenText Business Center for SAP Solutions > Web Services >
Workplace > Nodes.
3. In the Nodes Overview, mark an entry, and then double-click one of the
following entries in the Dialog Structure:
• Search fields
• Sort fields
• Filter fields
4. In the Search fields overview, Sort fields overview, or Filter fields overview
screen, enter the respective fields that you want to use for a text search, for
sorting, or for filtering in Field Name.
In the Position field, define the order of the values, in which they are sorted and
displayed.
In Search fields, the Object ID field is always added as the last field.
In Sort fields, the Default field is always displayed as the first field.
In Filter fields, check the No multi (No multi select) check box to limit the filter
selection to one value.
You can change the fields in the following methods of the node exit interface (/OTX/
PF62_IF_NODE). For more information, see “Interface /OTX/PF62_IF_NODE”
on page 373.
• CHANGE_NODE_SEARCH_FIELDS
• CHANGE_NODE_SORT_FIELDS
• CHANGE_NODE_FILTER_FIELDS
Filter fields can be connected to domains with fixed values. In this case, the fixed
values are automatically provided. You can also define or change values in the
CHANGE_NODE_FILTER_VALUES method of the node exit interface (/OTX/PF62_IF_
NODE).
• Action dialog class: Enter a class with logic for the action. The class must
implement the /OTX/PF62_IF_ACTION_DIALOG interface.
• Perspective ID
• Transport type: Choose one of the following options:
• Web Icon: Enter the icon that is displayed on the action button.
• Action text: Enter the text that is displayed on the button.
2. Click OpenText Business Center for SAP Solutions > Web Services >
Workplace > Nodes.
3. In the Nodes Overview screen, mark a node, and then double-click Master List
- Data Binding in the Dialog Structure.
4. Configure the layout of the item list using the following parameters. For an
example, see Figure 9-8.
In all fields, you can use the field content of the display structure of the work
object by using the pattern <field name>.
• Work object type: Work object type for which this list layout is used
• Node ID
• Icon ID UI5: Define a UI5 icon that should be displayed.
• Mark as flagged: The flag icon is displayed.
• Mark favorite: The favorite icon is displayed.
• Intro text
• Item title
• Number
• Number state: The fields 1st Status and 2nd Status will be colored according
to the status value: Error - red, Warning - yellow, Success - green, None -
black ).
• Unit text
• 1st Attribute
• 2nd Attribute
• 1st Status
• 2nd Status
• Bulk actions active: If this check box is selected, all objects displayed in the
master list can be used for bulk actions. If the availability of bulks actions
needs to be calculated for each object, implement this in method CHANGE_
OBJECT of interface /OTX/PF62_IF_ITEM_HANDLER.
Device typ
The following settings are available:
• Tablet
• Desktop
• Smart Phone
• All Devices
• Hybrid Devices
Exp. field
If you select the option, advanced line items and full screen lists download
an Excel sheet with technical fieldnames as column headers. If it is not
selected, the label description is used as column header.Y
You can use FSList (node) and Perspective exits to redefine settings at
runtime.
Export
Select this check box to enable download of the displayed table content into
Microsoft Excel.
Paging
Select this check box to enable paging of the displayed table. The page size
of the node is only considered if paging is disabled.
Actions
Select this check box to display the Action menu for row actions.
No Setting
Select this check box to disable table settings.
5. To search, sort, or filter fields, mark a node in the Nodes Overview screen, and
then double-click Search fields, Sort fields, or Filter fields in the Dialog
Structure. For more information, see “Adding fields for searching, sorting, and
filtering to a node” on page 313.
You can change the fields in the following methods of the node exit interface (/
OTX/PF62_IF_NODE). For more information, see “Interface /OTX/
PF62_IF_NODE” on page 373.
• CHANGE_NODE_SEARCH_FIELDS
• CHANGE_NODE_SORT_FIELDS
• CHANGE_NODE_FILTER_FIELDS
• CHANGE_NODE_FILTER_VALUES
6. In the Full Screen List Overview screen, mark a device type, and then double-
click Full Screen List - Actions in the Dialog Structure.
7. In the Full Screen List - Actions Overview screen, customize actions, using the
following parameters:
Action Type
The following action types are available:
• Show popup
• Show inplace
• Navigate to semantic object
• Call action dialog
• No link
Description
Defines the text that is displayed in the ActionSheet.
Action ID
ID of the action to be performed in the row.
Type
Specify the Row Action Type. In this list, click one of the following action
types:
• Add
• Copy
• Delete
• Up
• Down
• Action Dialog ( Set ActionDialog class in Nav. link param. )
Position
Specify with sequential numbering, where the action is positioned on the
screen.
Action dialog class
Enter the action dialog class.
Web Icon
Enter the icon that is displayed on the action button.
Nav. link parameter
Enter the navigation link parameter. It depends on the settings in Row
Action Type.
Transport type
Choose one of the following options:
Field Name
Name of the attribute field. You can use all fields available in the display
structure of the work object type. The values for these fields are
automatically set by the framework. You can define additional fields, the
values for these fields must be set in the implementation of the Full Scr. List
Exit.
Position
Define the sequence of the columns.
Width
Enter the width of the column as a valid CSS size. For more information, see
the SAP UI5 API Reference: https://sapui5.hana.ondemand.com/#/api/
sap.ui.core.CSSSize.
Column type
The following values are available: DEFAULT | MANDATORY | AVAILABLE |
HIDDEN.
Action ID
Enter the ID of the action to be performed in the column.
Display Type
The following values are available:
Description
Enter a meaningful description of the column.
Tooltip
Enter a tooltip for the column.
Value Ext. Field
(Value in External Field): The value of this field is set in an external value
field. Currently only used for display type Amount field to set the
currency.
Default Value
The value of this field is used for display type Display as icon if no other
value has been selected for this field. This allows to define a default icon.
You can overwrite the value in the full screen list exit method /otx/pf63_
if_fs_list~change_data.
2. Click OpenText Business Center for SAP Solutions > Web Services >
Workplace > Assignment of Nodes to Work Center.
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 256.
Node pos.
Node position. Define the sequence of the nodes.
Separator
Select the separator of the tabs in the Tab Bar of the Fiori Task App.
Agg. Count
Aggregated count. Select this check box to show the node as aggregated
count. Nodes with aggregated count are highlighted and contain all objects
that are shown in the nodes of the work center.
On the top level, you can enter the perspective class. This class needs to implement
the /OTX/PF62_IF_PERSPECTIVE_CLASS interface. The actual contents of
perspectives are configured in the Business Center IMG. This includes:
Editable
To allow the view to be edited in general, select this check box.
Selection Listener
To configure that the data of this view can be changed at runtime, select this
check box. This refers to method /OTX/PF62_IF_PERSPECTIVE_
CLASS~CHANGE_DATA of the perspective class. If an association for this view
is maintained and the table changes the parent item, the data for this view is
automatically selected if a selection event is raised.
Association Name
Enter the association name.
An attribute list can either show the data of the root work object type or, if
the association is maintained, an associated work object type.
By setting the association, the fields of the associated work object type are
available for the customizing, and the data of the associated work object
type is selected. For more information, see “Defining the work object type
association” on page 254.
If choosing a not-associated work object type, the attributes of the root work
object type can be used.
7. Save your changes before you navigate down in the folder structure.
8. Double-click Attributes in the Dialog Structure.
9. On the Attributes Details screen, define attributes, using the following
parameters:
Field Name
Name of the attribute field.
Position
Define the sequence of the attributes.
Display Type
Configure the way the attribute is displayed. The following values are
available:
Value description
Select this check box to display a description behind the value field.
The value description is not automatically set, but has to be implemented in
the /OTX/PF62_IF_PERSPECTIVE_CLAS~CHANGE_DATA method of the
perspective class.
The /OTX/PF62_IF_PERSPECTIVE_CLAS~UPDATE_ATTRIBUTES method
enables you to change the value description after the value has changed.
Update on change
Select this check box to trigger the UPDATE_ATTRIBUTES method of the /
OTX/PF62_IF_PERSPECTIVE_CLASS if the value of the field is changed. For
more information, see “UPDATE_ATTRIBUTES” on page 427.
Editable
To allow the attribute to be edited, select this check box. This setting is only
considered if the complete view is set to editable. For more information, see
“Configuring the header view” on page 441.
Required
To set the attribute as required, select this check box.
Search help ID
Unique ID of the search help that corresponds with the attribute.
Help variant
Select the type of help. The following types are available.
• F4 help only: Users can only select and enter values using a search
help.
• F4 help with suggestions: Users can directly enter values. When the
user enters a value which fits for one or several values of the search
help, these values are displayed as suggestions. The user can select
them. Alternatively, the user can select the values using a search help.
• F4 help with input field: Users can either directly enter values for
this field or select them using a search help.
Link type
This field defines the type of the link for semantic object navigation.
Possible values:
• No link
For more information, see “Semantic object navigation with the Fiori Task
App” on page 279.
Link parameter
This field contains the JSON with the link parameters. For more
information, see “Semantic object navigation with the Fiori Task App”
on page 279. The JSON data must match the following structure:
{
"target": {
"semanticObject": <semantic object>,
"action": <action>
},
"params": {
<optional parameters>
}
}
Description
Enter a meaningful description of the attribute.
10. Double-click Related fields under Attribute View Settings in the Dialog
Structure.
11. On the Related fields Overview screen, define related fields for the attribute.
You can use the related fields to react on value changes in fields of other
attribute views. For this, set the Update on change check box of the related
attribute field to true and enter the field in the related fields settings of the
attribute list that wants to react on these value changes. In case of a value
change, you can update the attribute in method /OTX/PF62_IF_PERSPECTIVE_
CLAS~UPDATE_AFTER_REL_ATTR_LIST_CHG of the perspective class.
Perspective view ID
Enter the view ID.
Field Name
Enter the field name.
Each view represents one table. The columns display as customized. You can give
the user the possibility to change the displayed columns. Depending on the screen
size the rows are displayed in horizontal or vertical layout.
2. Click OpenText Business Center for SAP Solutions > Web Services >
Perspectives > Data Binding.
4. On the Table View Overview screen, mark a perspective view ID, and then
double-click Header View in the Dialog Structure.
5. On the Header View Details screen, define the content for the header, using the
following parameters:
Association Name
Enter the association name.
Objects of the associated work object type are selected according to the
constraints defined in the association settings. For more information, see
“Defining the work object type association” on page 254.
Editable
To define that the table can be edited in general, select this check box.
Grouping Fieldname
Define the field for grouping. The entries of the table are grouped by their
values of the defined field.
Grouping Title Field
Field containing the text that is displayed as the grouping title.
Row Action Available
Select this check box to make the action sheet in the rows available.
Paging Is Active
Select this check box to activate paging. If this check box is cleared, all
entries are displayed at once.
Rearrange Is Active
Select this check box to allow changing the order of the table entries.
Selection Mode
Define if an entry of the table can be selected or not. The following options
are available:
• Single entry
• No selection
Selection Event
Select this check box to let the table raise an event when the user selects a
different table entry. Attribute and table views listening to the selection
event are then updated (data selection for associations and method /OTX/
PF62_IF_PERSPECTIVE_CLAS~CHANGE_DATA of perspective class).
Selection Listener
Select this check box to specify that the table listens to selection events of
other tables of this perspective.
Compare Is Available
Select this check box to define that the Compare button is available. This
button allows the user to undo actions.
Row Icon
Enter a SAP UI 5 icon that is displayed in front of the row title.
Row State
State of the row title state. Possible values:
• ERROR
• NONE
• SUCCESS
• WARNING
Is Expandable
Select this check box to set that the table can be expanded. This is only
relevant for views view.item.AdvLineItemsVertical and view.item.
AdvLineItemsResponsive.
Is Expanded
Select this check box to set that the table is initially displayed in expanded
mode. This applies only if Is Expandable is selected.
No Settings
Select this check box to set that the layout of the table is fix. No settings
button is displayed for user specific settings.
Export enabled
Select this check box to configure that all columns visible for the user can be
downloaded to a Microsoft Excel file, using a Download button. By hiding
columns, users can restrict the downloaded columns.
Export Fieldname
If you select the option, advanced line items and full screen lists download
an Excel sheet with technical fieldnames as column headers. If it is not
selected, the label description is used as column header.Y
You can use FSList (node) and Perspective exits to redefine settings at
runtime.
Table Title
Text displayed as table title.
Row Title
Define the row title that is shown in vertical tables on top of each row. You
can enter placeholders (<field name>) to use field contents of the rows.
Example: Item Number <ITEM_NR> - Material <MATNR>
Row Description
Text is displayed above row. Only displayed at AdvLineItemsVertical.
Field Name
Field name
Filter Mode
The following options are available:
• No filter option
• Filter with selectable values
• Search with string
Position
Define the sequence of the columns.
Description
Enter a meaningful description of the column.
Editable
To allow the field to be edited, select this check box.
Required
To set the column as required, select this check box.
Action ID
Enter the ID of the action to be performed in the column.
Column type
Choose the column type to define the display behavior of the columns. The
following values are available:
Default
Column is automatically displayed, the user can hide it.
Mandatory
Columns of this type are always displayed.
Available
Column is not automatically displayed, the user can switch it on.
Hidden
Column is included in table, but is not displayed, the user cannot
switch it on.
Display Type
Configure the way the column is displayed. The following values are
available:
Width
Enter the width of the column as a valid CSS size. For more information, see
the SAP UI5 API Reference: https://sapui5.hana.ondemand.com/#/api/
sap.ui.core.CSSSize.
Copy Value
Select this check box to specify that the value of the column is transferred to
a new row at copy action.
Update on change
Select this check box to trigger the UPDATE_ROW_VALUES method of the /
OTX/PF62_IF_PERSPECTIVE_CLASS if the value of the field is changed. For
more information, see “UPDATE_ROW_VALUES” on page 424.
Search help ID
Unique ID of the search help that corresponds with the column.
• F4 help only: Users can only select and enter values using a search
help.
• F4 help with suggestions: Users can directly enter values. When the
user enters a value which fits for one or several values of the search
help, these values are displayed as suggestions. The user can select
them. Alternatively, the user can select the values using a search help.
• Suggestions: When the user starts to enter a value suggestion, suitable
values from the search help are displayed, which the user can select.
• F4 help with input field: Users can either directly enter values for
this field or select them using a search help.
Perspective view ID
Enter the unique ID of the perspective view.
Field Name
Enter the field name of the display structure of the work object type.
10. Mark an perspective view ID, and then double-click Row Actions - Default in
the Dialog Structure.
11. On the Row Actions - Default Details screen, configure default row actions for
the table, using the following parameters:
13. On the Row Actions - Custom Details screen, configure custom row actions for
the table, using the following parameters:
Action ID
ID of the action to be performed in the row.
Type
Specify the Row Action Type. In this list, click one of the following action
types:
• Add
• Copy
• Delete
• Up
• Down
• Action Dialog ( Set ActionDialog class in Nav. link param. )
• Semantic Navigation (Set Nav. link parameter ): For more
information, see “Semantic object navigation with the Fiori Task App”
on page 279
• Field Popup ( Set Perspective Id in Nav. link parameter )
• Change page in flexible column layout (parameter = page id)
Position
Specify with sequential numbering, where the action is positioned on the
screen.
Web Icon
Enter the icon that is displayed on the action button.
Transport type
Choose one of the following options:
1. Open the context menu on the tree node where you want to maintain the
binding.
a. In the Select a Work Object Type Association dialog box, select a valid
Work Object Type (Association) for the view.
The available associations depend on the view:
• For an AttributeList, you can select the Root Work Object Type or
any other 1:1 association.
• For an AdvancedLineItems view, you can select only 1:N associations.
b. When you have selected the association, confirm Save Changes.
Note: You cannot change the selected association for the binding later
on. In case of a wrong association, delete the binding and create a new
one.
3. To edit a binding, click Edit Binding:
The Binding maintenance application for the specific view is launched.
4. To remove a binding, click Remove Binding
The binding is removed.
Note: Unless all views - for which a data binding is necessary - are bound,
the perspective does not run correctly and the Perspective Editor shows a
warning.
1. To open the Perspective Editor from the Launchpad, click the Maintain
Perspectives tile.
4. To open the Attribute List Binding Data View Maintenance, click Edit Binding.
5. On the GENERAL SETTINGS tab, define attribute view settings, using the
following parameters:
Association Name
Enter the association name.
An attribute list can either show the data of the root work object type or, if
the association is maintained, an associated work object type.
By setting the association, the fields of the associated work object type are
available for the customizing, and the data of the associated work object
type is selected. For more information, see “Defining the work object type
association” on page 254.
If choosing a not-associated work object type, the attributes of the root work
object type can be used.
Editable
To allow the view to be edited in general, select this check box.
Listens To Selection Event
To configure that the data of this view can be changed at runtime, select this
check box. This refers to method /OTX/PF62_IF_PERSPECTIVE_
CLASS~CHANGE_DATA of the perspective class. If an association for this view
is maintained and the table changes the parent item, the data for this view is
automatically selected if a selection event is raised.
Field Name
Name of the attribute field.
Display Type
Configure the way the attribute is displayed. The following values are
available:
Editable
To allow the attribute to be edited, select this check box. This setting is only
considered if the complete view is set to editable.
7. On the RELATED FIELDS tabs, define related fields for the attribute.
You can use the related fields to react on value changes in fields of other
attribute views.
For this, set the Update on change check box of the related attribute field to true
and enter the field in the related fields settings of the attribute list that wants to
react on these value changes. In case of a value change, you can update the
attribute in method /OTX/PF62_IF_PERSPECTIVE_CLAS~UPDATE_AFTER_REL_
ATTR_LIST_CHG of the perspective class.
Use the following parameters:
Perspective view ID
Enter the view ID.
Field Name
Enter the field name.
1. To open the Perspective Editor from the Launchpad, click the Maintain
Perspectives tile.
4. On the GENERAL SETTINGS tab, define advanced line items settings, using
the following parameters:
Association Name
Enter the association name.
Objects of the associated work object type are selected according to the
constraints defined in the association settings. For more information, see
“Defining the work object type association” on page 254.
Editable
To allow the view to be edited in general, select this check box.
Is Expandable
Select this check box to define that the table can be expanded or collapsed
by the user.
Is Expanded
Select this check box to define that the table is initially displayed expanded
(only relevant if the Is Expandable check box is set).
Table Title
Define the overall title of the line item table.
Grouping Fieldname
Define the field name for grouping. The entries of the table are grouped by
their values.
• Single entry
• No selection
Row State
Define the row state. The row is highlighted in the color of the state.
Available states are:
• None (default)
• Success
• Warning
• Error
• Information
5. On the COLUMNS tab, configure advanced line item columns, using the
following parameters:
Field Name
Name of the column.
Column Type
Select one of the following types: Default, Mandatory, Available, Hidden.
Display Type
Configure the way the column is displayed. The following values are
available:
Editable
To allow the attribute to be edited, select this check box. This setting is only
considered if the complete view is set to editable.
6. On the RELATED FIELDS tab, define related fields for the column, using the
following parameters:
Perspective view ID
Enter the view ID.
Field Name
Enter the field name.
7. On the DEFAULT ROW ACTIONS tab, configure default row actions for the
table, using the following parameters:
8. On the CUSTOM ROW ACTIONS tab, configure custom row actions for the
advanced line items, using the following parameters:
Action ID
Enter the ID of the action to be performed in the row.
Row Action Type
In this list, click one of the following action types:
• Add
• Copy
• Delete
• Up
• Down
• Action Dialog (Set ActionDialog class in Nav. link param.)
• Semantic Navigation (Set Nav. link parameter)
• Field Popup (Set Perspective Id in Nav. link parameter)
Note: Input helps can be set for item fields or header details. For item fields,
see “Configuring line item details” on page 445. For header details, see
“Configuring the item header details” on page 442. If no input help IDs are set
for editable fields in these customizing settings, then the header or item
structure is checked if an SAP help (F4 help or domain values) is assigned to
this field. The assigned help is then automatically used in the web service.
The input helps can display a maximum number of 100 domain values or results of
SAP search helps. You can also use the /OTX/PF62_BADI_INPUT_HELP user exit to
change or set the values and the structure of the input helps.
2. Click OpenText Business Center for SAP Solutions > Web Services > Input
helps > Input helps.
3. In the Input Helps Overview screen, customize input helps using the following
parameters.
Search help ID
Unique ID of the search help that corresponds with the input help.
Value type
Select the value type from the list. The following value types are available.
Type Name
Enter the technical name of the domain or search help.
Description
Enter a meaningful description of the input help.
4. Optional To customize related fields for the input help, mark an entry in the Input
Helps Overview screen, and then double-click Related fields in the Dialog
Structure.
Related fields are passed to the search query along with the field that you
search for. They limit the number of search results. As a prerequisite, related
fields must contain values that are shown in the header data area and in the
detail area.
5. Optional In the Related Fields Overview screen, enter a Field Name according to
the Search Help ID.
At the first call of an input help in the Fiori Task App, the framework generates
additional information for this input help. After each change to the settings of an
input help or the used search help, these data needs to be deleted. You can do this in
the /OTX/PF62_ADMIN transaction, option Clean Up Search Helps. For more
information, see OpenText Vendor Invoice Management for SAP Solutions -
Administration Guide (VIM200400-AGD).
• CHANGE_HELP_COLUMNS
• CHANGE_HELP_ROWS
• CHANGE_FILTER_OPTIONS
Note: Starting with Business Center 16.3.2, you can also use the Action dialog
box for bulk actions.
• You can use various input field variants (for example MultiCombo,
ValueHelpInput, TextArea) in an arbitrary count.
• 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
– DescriptiveText
– ActionMessages
2. Click OpenText Business Center for SAP Solutions > Web Services > Work
Object Type > Work Object Type.
3. In the Work Object Type Overview screen, mark a work object type, and then
double-click Data Collections in the Dialog Structure.
4. Assign the data collection to the work object type using the following
parameters:
Data Collection
Enter the data collection for the work object type.
/OTX/PF00_IF_DATA_COLLECTION~GET_INSTANCE
Returns data collection instance.
Parameters:
/OTX/PF00_IF_DATA_COLLECTION~CREATE_COLLECTION
Creates data collection. You can use this method for initially collecting the data.
Parameters:
Structure of PIS_DATA_COLLECTION:
/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:
2. Click OpenText Business Center for SAP Solutions > Web Services > Work
Object Type > Work Object Type.
3. In the Work object type Overview screen, mark a work object type, and then
double-click Actions in the Dialog Structure.
For more information, see “Defining and assigning node actions” on page 314.
For more information, see “Editing perspectives and layouts” on page 281.
Perspective
Perspective ID Z_EXAMPLE
Perspective type ACTION_DLG (Perspective for action dialog)
BSP Application [ot_bc_app]
BSP Module [ot_bc_app_namespace]
Template ID [ot_bc_app_namespace].templates.ActionDialogForm
Perspective name Example
Perspective views:
Error messages
Warning messages
Input field
Button
Information table
Comment field
M_CLASSNAME
Name of the currently used class.
M_PLTT
Life time token of the perspective from which the action is called.
M_PERSPECTIVE
The perspective that is used in the action dialog.
M_IS_A_BULK_ACTION
Flag if the current action is executed as bulk action.
9.9.4.1 CHANGE_BULK_OBJECTS
This method is called before the GET_ACTION_DIALOG method is called. The selected
objects, that could be locked, are contained in parameter PIT_BULK_OBJECTS.
9.9.4.2 GET_ACTION_DIALOG
This method returns main information for the Action dialog box.
9.9.4.3 GET_TEXT_AREA
This method returns the definition of a text area.
9.9.4.4 GET_MSG_CONTAINER
This method returns a container for messages.
9.9.4.5 GET_MESSAGES
This method returns messages for a message container.
9.9.4.6 GET_INPUT_FIELD
This method returns the definition of an input field.
9.9.4.7 GET_TEXT_AREA_INPUT
This method returns the definition for the text area input field.
9.9.4.8 GET_DROP_DOWN
This method returns the definition of the drop-down list (MultiComboInput view).
9.9.4.9 GET_BUTTON
This method returns the definition of a button.
9.9.4.10 GET_TABLE
This method returns the table definition.
9.9.4.11 GET_FILE_UPLOAD
This method defines the layout of the upload control. Called at initial load of Action
Dialog box and after Dialog updates.
Before uploading the file, the VIM Foundation checks if the file fits to the defined file
size and if the mime type fits to the mime type of one of the allowed document
classes. Only the content of documents matching these criteria will be saved in the
system. Error messages of these checks are transferred to the ActionDialog
implementation by calls of method SET_MESSAGE. For more information, see
“SET_MESSAGE” on page 362
9.9.4.12 SET_MESSAGE
This method transfers messages of the VIM Foundation, for example errors
occurring during the file upload, to the ActionDialog implementation. The
ActionDialog implementation has to take care that these messages are displayed.
Class /OTX/PF63_CL_ACTION_DIALOG already provides a logic for handling these
messages.
9.9.4.13 CREATE_ACTION
This method is called at the execution of create actions.
PCT_KEYS contain the key values as they can be defined by the VIM Foundation. The
solution implementation must take care to set the complete key for the new object.
9.9.4.14 EXECUTE_ACTION
This method is called at the execution of the action.
INDEX
Row index
FIELDNAME
Column name
FIELDVALUE
Cell content
9.9.4.15 EXECUTE_LINE_ITEM_ACTION
This method is called at the execution of an ActionDialog action started from an item
in the AdvLineItem table.
9.9.4.16 UPDATE_DIALOG
This method is called when a value changes in fields for which the UPDATE_ON_
VALUE_CHANGE flag is set.
The parameters are almost the same as in the EXECUTE_ACTION method, plus the
parameter in the following table. Additionally, EXECUTE_ACTION has the PIT_BULK_
RESULTS parameter. For more information, see “EXECUTE_ACTION” on page 363.
Figure 9-9: Communication flow of an Action dialog box with bulk actions
Note: In case of a single action, the object key of the current object is
defined in all methods of interface /OTX/PF62_IF_ACTION_DIALOG by the
import parameters PIT_KEYS, PI_LOGSYS, and PI_WOBJ_TYPE. The
parameters PIT_KEYS and PI_LOGSYS cannot be set in case of bulk actions.
Therefore, the methods of interface /OTX/PF62_IF_ACTION_DIALOG have
now the additional parameter PIT_ACTION_OBJECT which contains
instances of the processed objects. In method EXECUTE_ACTION, this
parameter is replaced by parameter PIT_BULK_RESULTS.
2. Request SetLock (only for single actions)
When the user runs an action, the Fiori Task App sends a SetLock request for
the current object. In the backend system, the VIM Foundation tries to lock this
object.
Solutions can use BAdI /OTX/PF00_LOCK to influence the locking for a work
object.
3. Request StartDataCollection (only for single actions)
After a successful lock, the Fiori Task App sends the request
StartDataCollection. The VIM Foundation in the backend creates the data
collection. At creation of the DataCollection, the methods /OTX/PF00_IF_
DATA_COLLECTION~CREATE_COLLECTION and /OTX/PF62_IF_DATA_
COLLECTION~SET_ADDITIONAL_INFORMATION are called. These methods belong
to the data collection class of the current work object type. Therefore, data
necessary for the Action dialog box can be collected.
4. Requests Perspective and ActionDialog
In this step, the Fiori Task App requests the perspective for the ActionDialog
and general information for the ActionDialog window. The perspective
information is returned as it has been defined in the PerspectiveManager. If
DataBindings are used, the values for the DataBinding are read now. For the
ActionDialog information, method /OTX/PF62_IF_ACTION_DIALOG~GET_
ACTION_DIALOG is called. This method must be implemented by the solutions.
In case of a single action processing, this is the first time when the action ID is
known in the backend system. Depending on the action ID, add data to the data
collection the first time this method is called.
5. Requests for ActionDialog UI elements (ActionDlg* requests)
The Fiori Task App requests the data for all views of the perspective
customizing of the Action dialog box. These data must be set in the /OTX/PF62_
IF_ACTION_DIALOG~GET* methods. Each method gets an instance of the data
collection class as an import parameter. Therefore, the data of the data collection
can easily be accessed.
6. TransferActionDlg* and UpdateActionDialog requests
After changing an input field where the UPDATE_ON_VALUE_CHANGE flag is set,
the Fiori Task App transfers the current dialog values to the backend and
requests information how the dialog should be updated. The VIM Foundation in
the backend collects the current values of the dialog and calls method /OTX/
PF62_IF_ACTION_DIALOG~UPDATE_DIALOG. This method contains the view ID of
the field that triggered the update and contains the current data of the Action
dialog box. Therefore, the data in the data collection class can be updated and
checks can be performed.
After each update, the GET_* methods for the views that require an update
(UPDATE_REQUIRED flag) are called. Additionally, the Action dialog box is
updated.
Request flows 6 and 5 are repeated each time the user does a change that triggers
an update.
7. TransferActionDlg* and ExecuteActionDialog requests
When the user clicks the action button in the Action dialog box, the Fiori Task
App transfers the current information to the backend and requests the execution
of the action. In the backend, the VIM Foundation collects the transferred
information and calls method /OTX/PF62_IF_ACTION_DIALOG~EXECUTE_
ACTION for the execution of the action. The parameters of this method contain all
data available in the Action dialog box. The result of the execution is set in
parameter PES_RESULT, field STATUS and MSG. For details on these parameters,
see “EXECUTE_ACTION” on page 363.
For the bulk actions, the status of each object must be set in parameter PIT_
BULK_RESULTS.
In case of a single action, the Fiori Task App either displays the message and
update the object as requested or returns to the dialog. In case of a bulk action, it
will only do this for the statuses GEN_ERROR and DLG_ERROR.
8. Request FinishActionDialogForBulk (only bulk action)
When the ExecuteActionDialog did not return an error status, the Fiori Task
App sends the FinishActionDialogForBulk request to retrieve the results for
the objects from the backend. At this call, the VIM Foundation returns the results
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).
2. Click OpenText Business Center for SAP Solutions > Web Services > Basic
Settings > Basic Settings.
3. Enable the Web Viewer setting for Device Types Smart phone and Tablet.
4. Open the Perspective Editor from the Launchpad by clicking the Perspectives
Maintenance tile.
5. Choose the perspective you want to change and open it in the Perspective
Editor.
1. Open the Perspective Editor from the Launchpad by clicking the Perspectives
Maintenance tile.
2. To copy the wanted perspective, use the Create function of the Perspective
Editor.
3. Add the views in the following table to the Perspective Editor. Therefore, use
the context menu of folder views.
6. Click OpenText Business Center for SAP Solutions > Web Services >
Workplace > Nodes.
7. Double-click the node for which you want to add the UI5 widgets. Maintain the
ID of the copied perspective in the Perspective ID for an item column.
8. Click OpenText Business Center for SAP Solutions > Web Services > Work
Object Type > Work Object Type.
9. Maintain the related business object. For more information, see “Defining a
related business object for a work object type” on page 300.
1st Character
P fix, indicates a parameter.
2nd character
I (Importing) or C (Changing) or E (Exporting).
3rd character
<empty> (variable) or S (structure) or T (table).
9.12.1.1 CHANGE_NODE
This method is called when the nodes are loaded and allows to change the state of
the node.
9.12.1.2 CHANGE_NODE_SEARCH_FIELDS
This method allows changing the customized field for the object search at runtime.
9.12.1.3 CHANGE_NODE_SORT_FIELDS
This method allows changing the sort fields available for this node at runtime.
9.12.1.4 CHANGE_NODE_FILTER_FIELDS
This method allows changing the filter fields available for this node at runtime.
9.12.1.5 CHANGE_NODE_FILTER_VALUES
This method allows changing the filter values available for the current filter at
runtime.
9.12.1.6 CHANGE_NODE_LIST
This method allows changing the displayed data of a full screen list at runtime.
9.12.1.7 CHANGE_NODE_LIST_COLUMNS
This method allows changing the columns of a full screen list at runtime.
9.12.1.8 CHANGE_NODE_ACTIONS
This method allows changing general actions available for a node in full screen list
mode at runtime.
Structure of PCT_NODE_ACTIONS:
9.12.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 381.
9.12.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.
9.12.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.
9.12.2.4 GET_ACTION_VALIDAT_MSG
This method returns messages that are either displayed in the validation screen or in
an extra dialog box.
9.12.2.5 CHANGE_ACTION_VALIDATION
This method defines the layout of the validation screen.
Structure of PCS_ACTION_VALIDATION:
9.12.2.6 GET_ACTION_AGENTS
This method returns possible agents that can be selected in the confirmation dialog
box.
9.12.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 388.
9.12.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.
9.12.2.9 HANDLE_UPDATES_BULK
This method executes updates for header details and line items fields.
9.12.2.10 CHECK_FIELDS
This method checks values of header detail fields.
9.12.2.11 CHECK_LINE_ITEM_FIELDS
This method checks values of line item fields.
9.12.2.12 GET_ITEMS
This method returns items that should be displayed in the item list.
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 469.
9.12.2.13 GET_DOCUMENTS
This method returns documents that are displayed with the function Documents.
9.12.2.14 GET_DOCUMENT_ATTRIBUTES
This method is called for one document when the user opens the panel for the
attributes.
9.12.2.15 DELETE_DOCUMENT
This method is called when the deletion of a document is triggered from view view.
item.Document. Parameters PI_ARC_DOC_ID and PI_ARCHIVE_ID define the
document that should be deleted. Deletion must be implemented in this method.
9.12.2.16 CHANGE_ITEM_STRUC
This method changes the item structure for the item list.
9.12.2.17 ON_VALUE_UPDATE_ITEM
This method is triggered if the value of a line item detail field is changed and the
Update on Change check box in the line item details is selected.
The parameter PCS_ITEM_VALUES contains the current field values of the item. It has
the following structure.
9.12.2.18 CHANGE_HEADER_DETAILS
This method changes data for header details.
9.12.2.19 ON_VALUE_UPDATE_HEADER_DETAIL
The update is triggered for fields in header details that were changed and that are
flagged for an update (field UPD_ON_VALUE_CHG).
Parameter PCT_VALUES contains the current field values. It has the following
structure.
9.12.2.20 GET_ITEM_STRUC
This method returns the structure for the item list.
9.12.2.21 GET_ITEM_LINKS
This method allows the definition of the link parameter of single line items in the
context of semantic object navigation. It will be called when the user clicks a link in
one of the line items.
9.12.2.22 CHANGE_OBJECT
This method offers the possibility to change the object list.
Note: To remove the object from the object list, clear the structure PCS_OBJECT.
9.12.2.23 CHANGE_OBJECT_HEADER
This method offers the possibility to change the object header.
ATTRIBUTES0 Attributes
ATTRIBUTES1 Attributes
INTRO Introduction text
FIRSTSTATUS First status
SECONDSTATUS Second status
LINKTYPE Type of the link for semantic object navigation
LINK_PARAMETER JSON with the link parameters for semantic object
navigation
9.12.2.24 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 “Editing
perspectives and layouts” on page 281.
9.12.2.25 GET_TIMELINES
This method returns history entries and comments.
9.12.2.26 GET_EXCEPTIONS
This method returns error messages that are displayed as detail for an object header
field.
Existing implementations use CHECK_SAVE_DATA to check and save the data, but
return the exceptions via method GET_EXCEPTIONS. This is still working due to
downward compatibility.
9.12.2.27 CHANGE_ITEM_LIST_TITLE
This method changes the title of the item list.
9.12.2.28 CHANGE_RELATED_BUS_OBJECT
This method allows you to change the customizing for the related business object at
runtime. For more information, see “Defining a related business object for a work
object type” on page 300.
9.12.2.29 CHANGE_NODELIST_NAV_LINK
This method allows to change the navigation links in the node list at runtime. The
method is called before the link is executed.
9.12.2.30 RESOLVE_URL_PARAMS
This method is called when:
This method is able to calculate the key values for the work object type with these
values and returns them in the PRT_KEYS parameter. All key values must be set.
When implemented, the Fiori Task App only selects this work object.
9.12.2.31 GET_IMAGE_CTRL_PAGES
This method returns the images and thumbnails for each page of the document that
should be displayed in the Image Control.
1 - Business error
2 - Technical error
In case of an error, an
exception is raised with the
error message of PET_
RETURN.
PE_BUS_ERROR_HANDLIN Exporting Allows to define the UI
G behavior in case a business
error occurs (pe_error_
type = 1).
Possible values:
• 1 - No update
• 2 - Complete refresh
• 3 - Item refresh
• 4 - Remove item
9.12.2.32 GET_IMAGE_CTRL_FULLTEXT
1 - Business error
2 - Technical error
Possible values:
1 - No update
2 - Complete refresh
3 - Item refresh
4 - Remove item
Attribute Description
M_PLTT Perspective life time token for the current
perspective
MH_PLTT_DATA_COLL Data collection of the perspective life time
token. For more information, see
“Maintaining Data Collections” on page 301.
MH_PERSPECTIVE_INFO Access to general information about the
perspective.
9.12.3.1 SET_ROOT_OBJECT_KEYS
This method is called at the creation of the perspective class instance and gives the
instance key information about the root object of the perspective. This method is
implemented in class /OTX/PF62_CL_PERSPECTIVE_CLASS and does not need to be
changed.
9.12.3.3 CHANGE_CUSTOMIZING
This method allows changing the customizing settings for the attribute list views
and table views of the current perspective at runtime.
9.12.3.4 CHANGE_DATA
This method allows changing the data of the attribute list views and table views of
the current perspective at runtime.
9.12.3.5 TRANSLATE_COMMENTS
This method is called when the user selects a language in the drop-down list of the
translation languages. The implementation of this methods returns the translations
of the comments.
Interface:
Method Description
/OTX/PF62_IF_FC_CMT_CUST_ Get settings of comment view
GET~GET_SETTINGS
/OTX/PF62_IF_FC_CMT_GET~GET_ Get currently displayed comments
COMMENTS
/OTX/PF62_IF_FC_CMT_TRANS_ Get currently displayed translations
GET~GET_TRANSLATIONS
/OTX/PF62_IF_FC_CMT_TRANS_ Add additional translations
CHG~ADD_TRANSLATIONS
9.12.3.6 CHECK_SAVE_DATA
This method allows setting field messages of the attribute list views and table views
of the current perspective. It is called when checking or saving the changed data is
required.
Structure of PES_SAVE_RESULT:
9.12.3.7 CHANGE_PERSPECTIVE_VIEWS
This method changes the views of an item perspective at the initial load of the
perspective.
Structure of PIT_VIEWS:
9.12.3.8 UPDATE_ROW_VALUES
This method allows changing data of a line item after change of a line item cell.
Tip: Due to
performance
reasons, use the
GET_
ATTRIBUTE_
LIST_BY_NAME
and GET_
TABLE_BY_
NAME methods
whenever
possible.
PI_LOCKED Importing Flag to indicate that
the object is locked
9.12.3.9 UPDATE_ATTRIBUTES
This method allows updating the attribute values after a value change of an
attribute.
9.12.3.10 CHANGE_ACTION_PARAMETER
This method allows changing the parameter of a table action before the action is
performed.
9.12.3.11 UPDATE_AFTER_REL_ATTR_LIST_CHG
This method is called after the change of a value in a related attribute list. The
method allows changing data in attribute lists and table views that have a relation to
the changed attribute list.
Structure of PIS_UPDATED_ATTRIBUTE_LIST:
Structure of PIT_UPDATE_ATTRIBUTE_LIST:
Structure of PIT_UPDATE_TABLES:
9.12.3.12 UPDATE_NEW_ROW
This method allows to read the data of an item that has been added to an advanced
line item table by a user. With method SET_CELL_VALUES of parameter PIH_NEW_
ITEM, the values of this object can be changed.
9.12.3.13 CHANGE_VIEWS_FOR_REFRESH
This method defines the views that are refreshed during run time.
9.12.4.1 CHANGE_USER_DETAILS
This method provides the feature to change information for users. This function is
called for the user details in the history view.
9.12.4.2 CHANGE_PERSPECTIVES
This method is obsolete with Business Center 16.3. The interface still exists but the
method is not called any longer.
9.12.4.3 CHANGE_PERSPECTIVE_VIEWS
This method is obsolete with Business Center 16.3. The interface still exists but the
method is not called any longer.
9.12.5.1 CHANGE_HELP_COLUMNS
The VIM Foundation calculates the input help structure and then calls this method.
You can change the structure of the input help or define a new structure as an input
help type Only user exit (BAdI /OTX/PF62_BADI_INPUT_HELP. You must also
consider these changes in the implementation of the CHANGE_HELP_ROWS method.
Structure of PCT_HELP_COLUMNS:
9.12.5.2 CHANGE_HELP_ROWS
The VIM Foundation calculates the input help values and then calls this method. If
you have changed the columns in the CHANGE_HELP_COLUMNS method, you must
adapt the values of these columns accordingly.
Structure of PCT_HELP_ROWS:
9.12.5.3 CHANGE_FILTER_OPTIONS
This method is called before calling the search help exit. It allows you to change the
filter options.
Structure of PCT_FILTER_OPTIONS:
9.12.6.1 CHANGE_CUSTOMIZING
Tip: Values that you enter here are not changed by the VIM Foundation later.
Use the /OTX/PF62_CL_UTILITIES method to change for example the
calculation of the correct perspective ID for the device type.
9.12.6.2 CHANGE_DATA
If the PI_DEACTIVATE_LETTERBOX
parameter is set to X, then the
letterBox app parameter is set to
the value false.
PI_DEACTIVATE_SEM_NAV Importing Deactivates the semantic object
navigation
If the PI_DEACTIVATE_SEM_NAV
parameter is set to X, then the
semanticNavEnabled parameter is
set to false.
PI_SPLIT_APP_MODE Importing Sets the Split App Mode to active
If the PI_SPLITT_APP_MODE
parameter is set to X. then
splitAppMode app parameter is set
to true.
PI_WEBID Importing ID used in the web UI.
To calculate the JSON for a link pointing to the Fiori Task App, set the following
parameters:
• PI_SEMANTIC_OBJECT
• PI_ACTION
• PI_NODE_ID
• PI_WOBJ_TYPE
• PI_WORKPLACE_ID
• PI_SYSTEM
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.
2. Click OpenText Business Center for SAP Solutions > Web Services >
Perspectives > Data Binding.
4. On the Header View Details screen, enter the field descriptions, using the
following parameters:
• Workobject type: Work object type for which this layout is used
• Perspective ID Item
• Intro text
• Title
• Mark favorite: The favorite icon is displayed.
• Mark as flagged: The flag icon is displayed.
• Number state: The fields 1st Status and 2nd Status are colored according to
the status value: Error - red, Warning - yellow, Success - green, None -
black ).
• Number
• Unit Text
• Link type
This field defines the type of the link for semantic object navigation. Possible
values:
– No link
– Semantic object navigation
For more information, see “Semantic object navigation with the Fiori Task
App” on page 279.
• Link parameter
This field contains the JSON with the link parameters. For more information,
see “Semantic object navigation with the Fiori Task App” on page 279. The
JSON data must match the following structure:
{
"target": {
"semanticObject": <semantic object>,
"action": <action>
},
"params": {
<optional parameters>
}
}
• 1st Attribute
• 2nd Attribute
• 1st Status
• 2nd Status
Notes
• Business Center 16 Update 1 has added 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 master list customizing. For more
information, see “Configuring the item header details” on page 442.
• You can change the settings of this customizing by implementing the
method CHANGE_OBJECT_HEADER of the web handler class. For more
information, see “CHANGE_OBJECT_HEADER” on page 405.
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 339. The Web Services use this information to generate an
input help in the Fiori Task App for this field.
• 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 on change
Select this check box to trigger the ON_VALUE_UPDATE_HEADER_DETAIL
method of the web handler if the value of the field is changed. For more
information, see “ON_VALUE_UPDATE_HEADER_DETAIL” on page 400.
Link type
This field defines the type of the link for semantic object navigation.
Possible values:
• No link
• Semantic object navigation
For more information, see “Semantic object navigation with the Fiori Task
App” on page 279.
Link parameter
This field contains the JSON with the link parameters. For more
information, see “Semantic object navigation with the Fiori Task App”
on page 279. The JSON data must match the following structure:
{
"target": {
"semanticObject": <semantic object>,
"action": <action>
},
"params": {
<optional parameters>
}
}
2. Click Business Center - Web Services - Deprecated Activities > Line Items >
Line Item List Title.
3. In the Titles of item list Overview screen, configure the line item list titles
using the following parameters:
2. Click Business Center - Web Services - Deprecated Activities > Line Items >
Line Item Details.
3. In the Line Items Overview screen, configure line item details using the
following parameters:
Search Help ID
Enter the unique ID of the search help for the field. For more information,
see “Input helps” on page 339.
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 397.
Link type
This field defines the type of the link for semantic object navigation.
Possible values:
• No link
• Semantic object navigation
For more information, see “Semantic object navigation with the Fiori Task
App” on page 279.
2. Click OpenText Business Center for SAP Solutions > Web Services >
Workplace > Nodes.
3. In the Nodes Overview screen, mark a node, and then double-click Full Screen
List - Data Binding in the Dialog Structure.
4. In the Full Screen List - Data Binding Overview screen, double-click an entry.
5. In the Full Screen List - Data Binding Details screen, configure the data
binding using the following parameters:
• Column Id: Use this numeric field to define the order of columns.
• Field Name
• Width (CSS)
• Display style: Choose one of the following options:
– Show popup
– Show inplace
For phones, tablets, desktops, and combi device, choose one of the following
visibility options:
• Export enabled
Select this check box to add the content of the current column to a
spreadsheet that can be downloaded as a Microsoft® Excel® file. By hiding
columns, users can restrict the downloaded columns. If one of the node list
columns is export enabled, a Download button is available.
• Transport type: Choose one of the following options:
– Customizing request
– Workbench request
• Medium Fld Labl (Medium field label)
• Default value
• Tooltip: Enter tooltip for the node list column.
This setting can be overwritten using the CHANGE_NODE_LIST_COLUMNS
method of interface /OTX/PF62_IF_NODE. For more information, see
“CHANGE_NODE_LIST_COLUMNS” on page 378.
Fiori Task App running scenarios differ depending on the place of integration. This
section describes on-premises integration and integration on SAP Cloud Platform in
separate subsections.
The description in this section applies to Launchpad tiles using a Business Center
16.3 backend. If you are using the OTBCWUI 16.3 add-on in combination with a
Business Center 16 SP2 backend, see Section 9.1 “Integrating Fiori Task App into
Fiori Launchpad” in OpenText Business Center for SAP Solutions - Configuration Guide
(BOCP160002-CGD) (documentation Business Center 16 SP2).
Solution/Purpose Catalog ID
VIM Foundation (for cross /OTBCWUI/PF07_BC_FOUNDATION
solution apps)
Delivery Note /OTBCWUI/PF07_BC_SOL_DELIVERY_NOTE
Sales Order /OTBCWUI/PF07_BC_SOL_SALES_ORDER
HR Documents /OTBCWUI/PF07_BC_SOL_HR_DOCUMENT
Remittance Advice /OTBCWUI/PF07_BC_SOL_REMITTANCE_ADV
Solution/Purpose Catalog ID
Order Confirmation /OTBCWUI/PF07_BC_SOL_ORDER_CONF
Quotations /OTBCWUI/PF07_BC_SOL_QUOTATION
VIM Foundation Administration /OTBCWUI/PF07_BC_ADMIN
(for solution implementers)
4. Select a target mapping from the Target Mappings tab, and then click Create
Reference. From the catalog list in the dialog box, select the previously created
catalog.
General
Title
Enter a title of your choice.
Subtitle
Enter 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;v=3/Nodes(<Node parameter>)/
Objects/$count, where <Node parameter> is described in the following list:
<Node parameter>
A node is defined by the following parameters:
SAP__Origin: System alias of backend system.
deviceType: Device type. Leave empty for $count request.
nodeId: ID of the node.
wobjType: Work object type of the node.
workplaceId: Workplace ID.
Example: /sap/opu/odata/OTX/PF05_DATA;mo;v=3/Nodes(SAP_
_Origin='OTBCWUI_BACKEND',deviceType='',nodeId='PS01_DELIVERY_
INBOX', wobjType='PS01_PRC_DELIV',workplaceId='WP_INBOX')/
Objects/$count
Navigation
Action
If the used solution perspectives can only be shown properly on desktop,
enter action display or displayDesktop.
Parameters
Enter an appropriate combination of parameters with values depending on
the chosen Application Mode. For more information, see “Application
modes” on page 270.
http://<host>:<port>/sap/bc/ui5_ui5/otbcwui/pf07_bc_ui_03/index.html?
<parameters>
1. On the Cloud Platform Cockpit, on the menu on the left, open the Services
node.
4. To go back to the overview, click Portal on the main navigation. Then click the
Go to service action.
Open the Transport Manager tile. Click the tab Import and select the required
content archive.
7. Set the appropriate UI5 version for the Launchpad under Settings.
Note: The UI5 version must be supported by the current release. See the
Release Notes for details.
The content archives can be downloaded in the patches area from the Launchpad
Content folder. They comprise:
1. On the Cloud Platform Cockpit, click Apps on the menu on the left.
From the Cloud Platform Cockpit, access the Portal Service. In the Portal,
choose an existing Fiori Launchpad Site or create a new one. In the site
administration, click Applications on the left.
Important
If you keep the default semantic object otbcwuipf07bc, the action for your
set of parameters must be unique.
3. Enter the parameters as needed, depending on the chosen application mode. For
more information, see “Application modes” on page 270.
Example:
/destinations/PF05_DATA/
Nodes(SAP__Origin='OTBCWUI_BACKEND',deviceType='',nodeId='PS01_DELIVERY_INBOX',wobjTy
pe='PS01_PRC_DELIV',workplaceId='WP_INBOX')/Objects/$count
<applicationUrl>/?<parameters>
• To get the <applicationUrl>, click the application. Under section Active Version,
you find the Application URL.
• Replace the <parameters> variable with an appropriate combination of parameters
with values depending on the chosen Application Mode. For more information,
see “Application modes” on page 270.
https://pf07bcneoui03-a9e96cfa0.dispatcher.hana.ondemand.com/?nodeId=
PS02_ORDER_INBOX&system=OTBCWUI_BACKEND&wobjType=PS02_PRC_
ORDER&workplaceId=WP_INBOX
The available CDS views are optimized for the generation of a specific SAP Fiori
elements template.
• For the technical information how to generate a Fiori template based on the
annotated CDS view, see Section 8 “Sales Order Analytics” in OpenText Vendor
Invoice Management for SAP Solutions - Configuration Guide for Solutions Beyond
Invoice (BOCP200400-CCS).
• For the steps how you generate and configure reports, see “Generation and
configuration” on page 459.
• For the options how you extend these reports, see “Custom Extensions”
on page 465.
Prerequisites
• The backend system should have the highest possible SP of the SAP_BW
component.
For details, how to connect to SCP, and how to enable WebIDE, see the SAP Help.
3. For details how to activate ODATA services, see SAP Help Portal (https://
help.sap.com).
Step Input
Template Selection • SAPUI5 Version
UI version of your frontend server.
• Template:
Choose the recommended template according the table.
For example, the List Report Application template for the
Monitoring report and the Analytical List Page template
for the Analytics report.
Basic Information Fill the required fields, marked with *. If necessary, provide a
namespace on your system:
• Project Name
• Titel
• Namespace
• Description
Data Connection Select the backend system and the OData service.
Step Input
Annotation Selection Select all annotation files that display.
If you use the Add Annotation Files action with Add From
Service, select the Generic Annotation Provider checkbox, to
see all delivered annotation files.
4. Click Finish.
The new project is available in the Web IDE
5. Optional For OData projects without parameters, click Run for a first sandbox
test.
6. Optional For some of the available Analytics List Page, the navigation from ALP
to the object page (the arrow at the end of each line in the table) is not necessary.
To remove the navigation:
"ObjectPage|ZOTX_PS02H_ALL_PROC_QUERYResults": {
"entitySet": "ZOTX_PS02H_ALL_PROC_QUERYResults",
"component": {
"name":
"sap.suite.ui.generic.template.ObjectPage"
Each report comes with a local annotation.xml as example that you can customize.
You can find the name of the annotation.xml file in the technical details table of the
solution.
6. Replace the generated content of the annotations.xml with the delivered XML
template.
7. Click Save.
1. Navigate to \webapp\i18n\ .
3. Paste the content of the delivered i18n file, to replace the generated file.
4. Click Save.
The deployment process is described in detail on the SAP Help Portal (https://
help.sap.com).
5. Select a transport.
After the deployment, the BSP application for your report is available in the
selected package.
6. If needed, go to SICF transaction and activate the service for the created
application (Service Name = Name of the BSP application).
Semantic Enter a name for the semantic object. For example ZPS08.
Object:
Action: Choose or define an action. For example display.
Application Choose SAPUI5 Fiori App.
Type
Title Enter a title.
For each report, you find the default semantic objects in the detail section. The
semantic object definition uses SAP standard objects, like SupplierInvoice and
Supplier to navigate to the respective SAP FI App.
• By Default, the report displays all navigation intents for a given semantic object.
• To reduce the number of available navigation intents, change the semantic object
that is used in the report to a custom semantic object. Change the semantic object
in the metadata extensions. For more information, see “Changing the appearance
with Metadata Extensions” on page 465.
• If you change the semantic object to a custom semantic object, also configure the
custom target mappings and the tile configurations for the SAP standard apps.
For navigation to VIM Foundation based Fiori Apps, you need to create an
additional target mapping with a semantic object that is defined in the respective
CDS view.
The values display in the detail section of the reports. You can also change the
standard semantic object by using the metadata extensions.
Semantic Object:
For details, see detail page of the report (table entry: Semantic Navigation).
Action:
Display.
Application Type:
SAPUI5 Fiori App
Title:
Add a title
URL:
/sap/bc/ui5_ui5/otbcwui/pf07_bc_ui_03
ID:
ot.approve.requests03
7. Click Save.
With the FIORI Elements templates you can perform modifications based on local
annotations in the WebIDE. For more information, see SAP Help (https://
help.sap.com).
The MDE concepts allow to overwrite the standard annotations with custom specific
annotations without modifying the original objects.
1. Open the SAP ADT tools in Eclipse and connect to the backend system
Example 11-1: MDE changed for the standard annotations of CDS view /
OTX/PS08_VC_A_INVBPF
The position of the Invoicing Party and Process ID fields is changed and the
semantic object reference for Invoicing Partyis removed.
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.
For the calculation of the Location (see section 5.3.2 “Defining additional locations
for Content Server aliases” in the White Paper), VIM Foundation calls the SAP
standard modules in a way that user profile parameter LCA is used. If parameter LCA
is not maintained in the user profile, then the current IP is used. For the correct IP
calculation, installing SAP note 1833702 might be necessary.
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)
13.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.
13.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.
13.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.
13.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.
13.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.
13.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.
Classification
Automatic document classification by Information Extraction Service (IES): IES
usually classifies documents. You have to configure a classification profile.
Within this profile a custom field with class type is required. The
corresponding classification ID must refer to a scenario classification within the
inbound configuration where you assing document types for classification. For
more information, see “Creating scenario classifications” on page 56
Automatic document classification by Business Center Capture: For more
information, see Section 4.6 “Supported function types for custom fields in a
non-invoice application” in OpenText Business Center Capture for SAP Solutions -
Customization Guide (CPBC-CGD) and Section 4.7 “Configuring a Classification
function” in OpenText Business Center Capture for SAP Solutions - Customization
Guide (CPBC-CGD).
Classification Validation
Manual document classification within the classification validation. The
classification validation is triggered if the automatic document classification was
not possible.
To process the recognition correctly, do not skip the validation classification
within the validation assignment settings of the Inbound Configuration.
Recognition
In this step, only data extraction for the current classification takes place, no
classification functionality is involved.
Recognition Validation
In this step, only data validation takes place. If required, you can add a field
representing the current classification value. As soon as the classification field
value is changed, a new recognition step is triggered for the changed
classification. In general, you can skip the Recognition Validation by using the
validation assignment settings of the Inbound Configuration. For more
information, see “Customizing validation” on page 150.
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 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.
All classification options are directly based on SAP ArchiveLink document types.
They are defined in the Inbound Configuration for the corresponding registration
type and channel. For more information, see “Customizing registration types”
on page 62.
Link each document type to the following SAP Business Object types. Linked
document types are available for classification in the OAC3 transaction. The Business
Object types represent the different involved components of the VIM Foundation.
/OTX/PF01
Inbound Registration Object
/OTX/PF02
Process Object
If you create or post SAP document during the business process, additional entries
for standard SAP business objects can be required. Thus, you attach the incoming
documents to the rarget SAP business objects.
You can change the classification type at any time. This also changes the SAP
ArchiveLink document type which results in adjusting the related ArchiveLink
connection entries. If the content repository must be changed to, re-archiving is
performed.
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:
Note: Only inbound channels based on the registration types Early Archiving,
Incoming Mail and Custom/Others are supported for classification. The reason
for this is that only these channels can provide a Business Center Capture or
Information Extraction integration.
Figure 14-2: “Processing impacts” on page 475 shows the connection between the
different involved components and the processing impacts that are considered when
technically handling a classification change:
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.
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.
Structure of PCT_CLASSI_OPTIONS:
1. In ADT (ABAP Development Tool) in Eclipse, copy the OpenText CDS view
and its metadata extension to a package with Z namespace.
3. In the generated class with the prefix ZCL_, search for method DEFINE and
redefine it.
4. In the redefined method, insert the following code lines, replace the entity name
in variable iv_entity_name with the custom entity name which ends with
“Parameters”:
DATA: lo_entity_type TYPE REF TO /iwbep/if_mgw_odata_entity_typ,
lo_entity_type = model-
lo_property ?= lo_entity_type-
EXPORTING
iv_annotation_namespace = /iwbep/if_mgw_med_odata_types=>gc_sap_namespace
6. Activate the service on the backend system. For more information, see
“Activating services on the backend system” on page 460.
To manually change the local annotations for OData created from CDS:
In case the used OData is created for the CDS view in the Z namespace, instead of
Adding Local Annotations, do the following manual changes in the local
annotations file:
1. For OData with input parameters, for example the OData for Sales orders, keep
the default values for the parameters:
a. Navigate to /webapp/annotations.
b. Double-click the local annotations file annothations.xml.
c. In the annotation modeler, click the Select Targets button.
d. Select all entity types which contain the word parameters at the end.
e. In Properties select all parameters that do not contain the word text:
• P_ExchangeRateType,
• P_DisplayCurrency,
• P_FromDate
f. Click OK.
g. Check that the default values are set for all parameters:
In the Local Annotations of the different properties, add the expression
type and value.
Properties P_ExchangeRateType:
Common.FilterDefaultValue:
Property P_DisplayCurrency:
Common.FilterDefaultValue:
Property P_FromDate:
Common.FilterDefaultValue:
2. If you want to provide virtual filters in the report, do the following changes:
a. Navigate to /webapp/annotations.
b. Double-click the local annotations file annothations.xml.
c. In the annotation modeler, click the Select Targets button.
d. Select all entity types which contain the word result at the end.
e. In the Properties list, select the properties, that are used for virtual filters:
• ChannelID
• StartCanendarYear
• ProcessFinished
f. Click OK.
g. In the annotation modeler, set the default qualifier in the ValueList of each
property, that is used for virutal filters:
3. Click Save.
Business Center
OpenText Business Center for SAP Solutions. OpenText product that helps
receiving incoming documents, capturing processes, and filing them within a SAP
system.
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
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.
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.