Versions Compared

Version Old Version 2 New Version 3
Changes made by

ProNovia

ProNovia

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Version published after converting to the new editor

For the execution of an action, a corresponding handler is needed to implement the technical details. Each handler must be uniquely identified. A handler is mapped by means of a class that implements a special interface. All handler classes available on the system can be selected with the input help.
The following handlers are available:
Handler /PCH/CL_OBJ_NAV_HANDLER
Allows to jump to SAP standard transaction based on ProNovia delivered business objects (transaction SM34, /PCH/OBJ_TYPES).

Parameter

Description

ACTION

Action according to input help

OBJECT_TYPE

Object type according to input help


Class /PCH/CL_OBJ_URL_HANDLER
The handler allows a URL to be launched. The URL is delegated to the frontend for execution, which decides how to handle the URL. For http(s) URLs in the browser, single sign-on and SAP Fiori parameter enrichment are supported. This makes it possible to launch SAP Fiori apps using static application paths, but also external URL.

Parameter

Description

PROTOCOL

Scheme / Protocol
if empty/undefined, https is used primarily

HOST

Host name
if empty/undefined Host of the SAP Application Server

PORT

Port number
if empty/undefined Port number of the SAP Application Server for HTTPS or HTTP

PATH

Address path (without protocol, host and port, starting with /).
Supports the use of further standard parameters by using placeholders <ParameterName> (e.g. <OBJECT_KEY>). The path must be URL-encoded - except for the placeholders.

ADD_LP_PARAMETERS

Adds the Fiori Launchpad parameter for the client and language to the URL

USE_SSO

Starts the URL using single sing-on, so no re-authentication is required. SSO is only supported with Internet Explorer

...

Examples:
Navigating to an application in the Fiori Launchpad on the current system with SigleSignOn.

Parameter

Value

PROTOCOL

<empty> or https

PATH

/sap/bc/ui2/flp#Material-manage&//C_Product(Product='<OBJECT_KEY>',DraftUUID=guid'00000000-0000-0000-0000-000000000000',IsActiveEntity=true)

ADD_LP_PARAMETERS

X

USE_SSO

X


Navigation to a web page with the object key

Parameter

Value

PROTOCOL

<empty> or https

HOST

www.duckduckgo.com

PATH

/?q=<OBJECT_KEY>&ia=web


Navigation to a file in a shared directory

Parameter

Value

PROTOCOL

file

HOST

fileserver (unc-server-name ohne
)

PATH

/daten/Produkte/Product%20Sheets\<OBJECT_KEY>\ProductSheet.pdf


Open a chat with multiple participants and the object key as topic

Parameter

Value

PROTOCOL

msteams

HOST

teams.microsoft.com

PATH

/l/chat/0/0?users=name1@domain.tld,name2@domain.tld&topicName=<OBJECT_KEY>


Class /PCH/CL_OBJ_NAV_HANDLER_TX
The handler allows navigation to a freely definable SAP transaction, where appropriate user parameters can be defined for calling the transaction. It is possible to set parameters before calling the transaction and retrieve parameters after calling the transaction.

Parameter

Description

TRANSACTION_CODE

Transaction code of the transaction to be called

SKIP_FIRST_SCREEN

Skip initial screen (for transactions with initial screen).

NEW_WINDOW

Open the transaction in a new window.

WAIT

Wait for the end of the update program after the transaction has ended.

KEY_TYPE_NAME

Technical type of the key. May be required for structured keys.

<SET/GET Parameter ID>

Specification of the parameter ID to be set (e.g. MAT for material). Short form for E:<SET/GET Parameter ID>.

E:<SET/GET Parameter ID>

Specification of a parameter ID to be set. Can be used to make the parameter flow clearer or to set a parameter with a reserved name.
Supported placeholders:

  • <OBJECT_KEY> or <OBJECT_KEY>-[field name] - Passed object key or, if created, the newly created object key for the return transport.
  • <VALID_FROM> - Valid from (if passed in the call).
  • <VALID_TO> - Valid until (if passed in the call)
  • <CHANGE_NUMBER> - Change number(if passed in the call).
  • <KEY_DATA> or <KEY_DATA>-[field name] - specify key data for the asset (e.g. document type or material number). Only for plant.
  • <REF_OBJECT_KEY> or <REF_OBJECT_KEY>-[field name] - key of the reference or template object. Only when creating with template and if passed when calling.

I:<SET/GET Parameter ID>

Specification of a parameter ID which is to be transported back after the transaction call. Only supported for action "Create" and for the new object key.

...


Examples:
Navigation to the CV03N for a document to be displayed.

Parameter

Value

TRANSACTION_CODE

CV03N

SKIP_FIRST_SCREEN

X

KEY_TYPE_NAME

DMS_DOC_KEY

CV1

<OBJECT_KEY>-DOKNR

CV2

<OBJECT_KEY>-DOKAR

CV3

<OBJECT_KEY>-DOKVR

CV4

<OBJECT_KEY>-DOKTL


Navigation to document creation with template into CV01N

Parameter

Wert

TRANSACTION_CODE

CV01N

SKIP_FIRST_SCREEN

X

KEY_TYPE_NAME

DMS_DOC_KEY

E:CV1

<KEY_DATA>-DOKNR

E:CV2

<REF_OBJECT_KEY>-DOKAR

E:CV3

<KEY_DATA>-DOKVR

E:CV4

<REF_OBJECT_KEY>-DOKTL

E:CV7

<REF_OBJECT_KEY>-DOKNR

E:CV8

<REF_OBJECT_KEY>-DOKTL

E:CV9

<REF_OBJECT_KEY>-DOKVR

I:CV1

<OBJECT_KEY>-DOKNR

I:CV2

<OBJECT_KEY>-DOKAR

I:CV3

<OBJECT_KEY>-DOKVR

I:CV4

<OBJECT_KEY>-DOKTL


Class /PCH/CL_CFW_NAV_HANDLER
Allows you to start a ProFramework based application or a ProFramework action.
The handler enables the start of a concrete ProFramework application. In addition, however, commands intended for this purpose can also be started directly and without applications. Such commands (e.g. most creation or change commands) define an internal standard layout that is used. If an application and a command are combined, it is possible to use a concrete application with all setting options and to execute a direct action.

Parameter

Description

APPLICATION

ProFramework application (optional, if parameter COMMAND is set)

COMMAND

Command to be executed (according to value help). Optional if an application is defined, but mandatory if a specific action (other than displaying an object) is to be performed.
When using a command additional parameters might be maintained. These parameters are provided by the search help for the parameter names and depend on the command.
Actions which create a new object allows the transport of the object type and key back to the calling application. In this case the parameters NEW_OBJECT_TYPE and NEW_OBJECT_KEY have to be provided.

NEW_OBJECT_TYPE

If a command is executed which creates a new object, the object type and key can be transported back to the calling application. Because a command is technically not bound to a certain object type the target object type has to be defined with this parameter.

NEW_OBJECT_KEY

To enable the transport of the new object key the name of the command parameter which stores the new key has to be provided. The search help for the values provides a list of all so called exporting parameters of the command.

TITLE

Optional title of the application

...