Action Definition & Connection Settings

In this section you define, what should be executed.

Entries without any details are correct. The details will be inherited from the reference profile.

Please never delete entries. Deactivate them if not needed.

Details on inheritance/deactivation can be found in Create/Update/Copy/Configure Template

Available Actions:

Action

Direction

Description

Action

Direction

Description

Create

inbound/outbound

(push) create a new ticket in SolMan (inbound) or in the external tool (outbound)

Update

inbound/outbound

(push) update a new ticket in SolMan (inbound) or in the external tool (outbound)

JumpIn

inbound/outbound

here you can define the url from the other system to jump to.

E.g. define in JumpIn outbound the URI as “/browse/{IVEXTID}” to get the link to the Jira Cloud ticket visible in SolMan

Read

inbound/outbound

(pull) update from SolMan (inbound) or from external tool (outbound)

Transit

inbound/outbound

Used for Jira to perfom status changes

Attachments

outbound

Used in Jira Cloud to send Attachments from SolMan

Links

outbound

Used in Jira Cloud to send Links from SolMan

If your profile is based on a template, you most likely don’t have to change any configurations.

Action

Action to be performed for inbound or outbound processing.

Use

Currently we are supporting following actions for outbound (SAP Solution Manager to external tool) processing:

C Create

R Read

U Update

A Attachments

L Links

T Transit

J JumpIn

Currently we are supporting following actions for inbound (external tool to SAP Solution Manager) processing:

C Create

U Update

T Transit

J JumpIn

Action J is not a real action sending or receiving and processing data. It is an activity generating a jumpin URL either to jump into the external ticket (outbound) or jump into the SAP Solution Manager ticket (inbound). It can be configured and considered like an action.

Actions C, U, A, L and T are push actions. The external tool is pushing some data to SAP Solution Manager (Inbound) or SAP Solution Manager is pushing some data to the external tool (Outbound). On the other side, action R is a pull action pulling some data from the external tool (Outbound).

For some external tools (like Jira Datacenter using our own Cross ALM API) the single actions A, L and T are not needed because they are integrated into action C and U. But since some external tools (like Jira Cloud using the official Jira API) are using separated endpoints for sending attachments or changing status values, we need standalone actions allowing us to define endpoints with attributes resp. payloads.

In future we might support actions R, A and L for inbound as well. Currently this is not the case.

In future we might support additional actions like

E Event

S Search

. Currently this is not the case.

Dependencies

Which actions are needed is dependent on the used scenario. For instances, if the external tool wants to create a ticket in SAP Solution Manager and SAP Solution Manager wants to send status updates back, you might need at least Create Inbound, Transit outbound, Jump Inbound, Jump Outbound. If SAP Solution Manager wants to update some data additionally to the status, the action Update outbound is needed. If the external tool wants to trigger status changes or update some data, the action Update inbound (and/or transit inbound) is needed additionally.

Example

Since customers are inheriting from our template profiles not defining its configuration profile from scratch, all needed actions are already well-defined. Therefore, it is just needed to add some missing attributes (some custom fields for instances) or to deactivate some unwanted actions (read outbound for instances).

Direction

Direction of the communication.

Use

O Outbound: Communication from SAP Solution Manager to an external tool.

I Inbound: Communication from an external tool to this SAP Solution Manager system.

Dependencies

Please have a look at the documentation of the actions to find out which combinations are supported currently.

Example

For a bidirectional synchronization you need outbound and inbound actions.

RFC Destination

You can find the documentation on the external system level.

Method

HTTP method used on action execution.

Use

Following methods are supported and commonly used:

POST Create

GET Read

PUT Update

Following methods are supported but not commonly used (and therefore not part of the value help):

PATCH Patch

HEAD Head

OPTIONS Options

MERGE Merge

Dependencies

It depends on the API definition, which method has to be used for a certain purpose. For instances some APIs are using POST for update calls as well.

A GET call can never have a request payload. The key attributes have to be part of the URI. of course the response can/should have a payload.

Example

Please keep/use the settings of the templates delivered by Cross ALM.

URL / URI

Use

Endpoint used for outbound action execution.

Dependencies

In this field you have to define the endpoint relative to host, port and prefix defined in the RFC destination. It has to contain placeholders which will automatically be replaced before action execution.

Example

Please keep / use the endpoints delivered by Cross ALM templates.

Please be aware that only one JumpIn link configuration can be maintained per configuration profile. For example, it is not possible to use Normal Changes and Focused Build Requirements within the same configuration profile if the endpoint for the Normal Changes should be SAP Web UI and the endpoint for the Focused Build Requirements should be the Fiori Launchpad. Either both endpoints must be SAP Web UI or the two transaction types must be split into two configuration profiles.

JumpIn Link for Focused Build UI5 apps

The predefined inbound Jumpin URL is pointing to the SAP Web UI. If you want to jump into a UI5 app provided by Focused Build, you have to exchange the Jumpin URI in your profile.

SAP Web UI:

/sap/bc/ags_workcenter/ags_crm_docln?objectid={EVOBJECTID}&proctype={KVPROCESSTYPE}

Focused Build “Requirements Management” App

/sap/bc/ui2/flp?sap-client=001&sap-language=EN#Action-requirementApp&/object/{EVOBJECTGUID},NULL

Example JumpIn inbound URL to Focused Build Requirements Management App

Focused Build “Generic App”

The Focused Build apps “My Requirements”, “My Work Packages” and “My Work Items” are all using the “Generic App” in the background. Depending on which app/transaction type is opened, the URL parameter “configId” differs.

  • My Requirements App: configId=1
    /sap/bc/ui2/flp?sap-client=001&sap-language=EN#Action-genericApp?configId=1&/configId/1/workspace/{EVOBJECTGUID}

  • My Work Package App: configId=2
    /sap/bc/ui2/flp?sap-client=001&sap-language=EN#Action-genericApp?configId=2&/configId/2/workspace/{EVOBJECTGUID}

  • My Work Item App: configId=3
    /sap/bc/ui2/flp?sap-client=001&sap-language=EN#Action-genericApp?configId=3&/configId/3/workspace/{EVOBJECTGUID}

image-20240711-105105.png

URL Configuration:

A new place holder must be defined in the URI, e.g. {IVCONFIGID}:

/sap/bc/ui2/flp?sap-client=001&sap-language=EN#Action-genericApp?configId={IVCONFIGID}&/configId/{IVCONFIGID}/workspace/{EVOBJECTGUID}

Additionally, the following two entries must be maintained in the Attribute Definition & Payload Mapping for the JumpIn/Inbound scenario:

The place holder attribute IVCONFIGID must be filled via the customizing in the Transaction Type, Transaction Field Mapping & Conversion and Transaction Value Mapping nodes.

Disable / Inactive

You can find the documentation on the external system level.