EPO Consulting Wiki - EPO IDoc Monitor /en

This is an old version of this page. To the new page please click here

Das ist eine alte Version dieser Seite. Zur neuen Seite klicken sie hier

Requirements and installation

All software components listed here are in the namespace / EPO1 /

The software must be installed in the order given here, always the highest available version

Download area "EPO Connector"

1. EPO Connector installation in client 000 with transaction SAINT in every SAP system. Also available as a workbench transport.

2. Current Workbench Transport "EPO Connector SP12"

Download area "EPO IDoc Monitor"

4. Workbench Transport "EPO_IDoc_Monitor_WB"

5. Customizing Transport "EPO_IDoc_Monitor_Cust"

6. Customizing Transport "EPO_IDoc_Monitor_Cust_ZDEV"

Brief instructions afterwards:

• Activate services ( HTML5 and change functions )
• Store trusted user in the service (same services)
• Customizing: Activate monitor (e.g. for ecosio)
• Customizing: add incoming EPO services, operation / EPO1 / IDOC_APP_GET_LONGTEXT (necessary for customizing transport from I01)
• Store user / PW for monitor access

Settings when going live

Trusted User for HTML5 App

!! this setting is not transported and must be made separately on each system !!

The HTML5 app for displaying IDocs is a web application. You must enter the SAP user name and password for this call. To avoid this, a SAP system user should be entered as follows:

Call transaction SICF

Enter service name IDOC and "execute"

Selection of the service IDOC (if necessary, activate the service if it is still displayed in gray)

Enter a SAP system user and the password

Rights for the trusted user

This list may not be complete; check in transaction SU53 which rights are missing.

Authorization object : S_IDOC_DEFT

Authorization field ACTVT - 03

Authorization field EDI_TCT - WE30

Trusted user for IDoc change function

The change function is a web service call to the EPO Connector as an ABAP add-in. You must enter the SAP user name and password for this call. To avoid this, a SAP system user should be entered as follows.

Note 1: Changes to IDocs are still carried out with the SAP user logged into the SAP GUI !

Note 2: The URL cannot be copied.

Call transaction SICF

Select the service name that is entered in IDOC Customizing according to table / EPO1 / IDOC_CUST with the value HTML_EDIT_SERVICE.

In the delivery, this is the idocmontrust service as a sub-service of epo1soa . This service must be activated and the SAP system user entered.

SICF idocmontrust.png

Alternative option:

Create your own Z-branch as shown here. This ensures that a user and password can also be entered in SAP production (since it is in the customer namespace).

Create service node:

new sub- element zzema , independent service

Name 'EPO Mobile Apps'

Create service: zzjsontrust , independent service

Name 'IDOC monitor logon service'

Enter user (of type System) and password

Handler List: Enter the function block / EPO1 / JSONHANDLER here

then activate this service

ClipCapIt-170724-175423.PNG

Enter the "JSON handler"

ClipCapIt-170724-175516.PNG

Enter a SAP system user

ClipCapIt-170724-175647.PNG

Customizing settings

Note: The settings for going live must also be made on development and test systems. See previous chapter.

EPO Service / EPO1 / IdocNotifications

EPO Connector Service - Settings (/ epo1 / exc)

Delivered with the Customizing Transport with the exception of the sy-sysid assignment.

IMPORTANT: The assignment to the SAP system ID is not delivered and must be done manually!

Transaction / EPO1 / ECSIDOUT12 Service assignment via SY-SYSID

EPO IDOC Monitor E-Mail SAP System ID Assignment.png

EPO Service /EPO1/IdocNotifications

Service -EPO1-IdocNotifications.png

Configuration for EPO Client Service / EPO1 / IdocNotifications

IdocNotification EPO Client Configuration.png

IdocNotification EPO Client Configuration 1.png

EPO Service EPOFMJSONIDOCMON

EPO Connector Service - Settings (/ epo1 / exc) Delivered with the Customizing Transport.

field	value
Direction	I = Inbound
Operation mandatory	X
IN: use http header	X
IN: use query string	X
Request URL name	request
Message format	json
Description	EPO GFMC JSON service

Configuration for EPO runtime incoming service

field	value
Service	EPOFMJSONIDOCMON
Operation	/ EPO1 / IDOC_APP_EDIT
NR	object / EPO1 / NOR
Number	Range Number 0
Protocol	0 - HTTP
Processing	Type S - synchronous
Store	My X for incoming and outgoing messages
Compress	X
Processing	FM /EPO1/GFMC_JSON_PROCESSINGFM
Description	EPO GFMC JSON service for the EPO IDoc Monitor

The following operations are to be entered in the EPO Connector Customizing:

/EPO1/IDOC_APP_BULK_CHG_PREP2

/EPO1/IDOC_APP_BULK_CHG_SCOPE

/ EPO1 / IDOC_APP_EDIT

/ EPO1 / IDOC_APP_GET_SEGTYPE

/ EPO1 / IDOC_APP_SEGMENT

/EPO1/IDOC_APP_SEGMENT_ALLOWED

/EPO1/IDOC_APP_SEGMENT_CREATE

/EPO1/IDOC_APP_SEGMENT_DELETE

/ EPO1 / IDOC_APP_SEGMENT_EDIT

/ EPO1 / IDOC_GETDATA

Customizing table / EPO1 / IDOC_CUST

In the customizing table / EPO1 / IDOC_CUST , values ​​for certain key values ​​can be stored that control the behavior of the IDOC monitor. With transaction SM30 , values ​​can be maintained; these must be transported on with a transport request.

IDOC CUST.png

EDIT - Url

key	meaning
HTML_EDIT_SERVICE	URL for the EPO service, call from the HTML editor
Default: / epo1soa / idocmontrust / EPOFMJSONIDOCMON? Operation = / EPO1 / IDOC_APP_EDIT
HTML_HOSTPORT_<sysid>	optional; the host is usually obtained from the ICM, but can be stored here in hard-coded form for each system. The keyword ' {SY-HOST} ' is replaced by the current host name at runtime (important if a production consists of several machines).
MONITOR_ACTIVE	'X' activates the 'Monitor' button (jump to the ecosio monitor, for example)
MONITOR_BTN_ICON	replaces the default icon for the toolbar button
MONITOR_BTN_QUICKINFO	replaces the default tooltip for the toolbar button
MONITOR_BTN_TEXT	replaces the default labeling for the toolbar button
NOAUTHORCHECK	If X, then no authorizations for authorization object / EPO1 / IDOC are checked

HTML Hostport

The composite key ' HTML_HOSTPORT_ ' plus the system ID result in the system-dependent host port. For systems with several application servers, the specific server name must be replaced by the keyword ' {SY-HOST} ', e.g. ' {SY-HOST} .bit.local: 8010 ', so that the respective host name of the current application server is used. Otherwise the interaction between the generated HTML file and the BSP application will not work.

ecosio Monitor

key meaning

MONITOR_ACTIVE Switches the monitor active (if unequally empty)

MONITOR_BTN_ICON Icon for the toolbar button

MONITOR_BTN_QUICKINFO Text for the tooltip (displayed when the mouse is moved over the button)

MONITOR_BTN_TEXT Text for the toolbar button

Column labeling in the ALV

The labeling comes from the table definition, but can be overridden. The name of the key is made up of the prefix ' ALV_TEXT_ ', the field name and optionally ' _ ' + language abbreviation ( e.g. ' _EN ', ' _DE '). Here in the table as an example:

key meaning

ALV_TEXT_DIRECTDESC Default title for the 'DIRECTDESC' column

ALV_TEXT_DIRECTDESC_DE German title for the column 'DIRECTDESC'

ALV_TEXT_DIRECTDESC_EN English title for the column 'DIRECTDESC'

Customizing for IDoc Split

IDocs with more item segments can be divided into IDocs with one item segment each. The function is available via the split button in the ALV list of the EPO IDoc monitor and via the program / EPO1 / IDOC_SPLIT.

Requirements: Entry in tab. / EPO1 / IDOC_CUST with name = SPLIT_ACTIVE and value = X

Entry in tab. / EPO1 / IDOC_SPLIT

Examples:

EPO IDoc Split.png

Settings for authorization and selection

The settings for authorization control are possible as follows.

Requirement: The NOAUTHORCHECK parameter is not set to X.

Authorization for the authorization object S_IDOCDEFT (activity = 03 display, transaction code = WE30, extension = *, basic type = *)

Assign authorizations according to IDOC message type and direction (authorization object S_IDOCMONI)

Authorizations for actions of transaction / EPO1 / IDOC (authorization object / EPO1 / IDOC)

Authorizations according to IDoc content, specifically organizational units via the table / EPO1 / IDOC_AUTH

An example for the assignment of authorizations could look like this:

The transaction code / EPO1 / IDOC must be authorized

Authorization S_IDOCDEFT must be assigned for transaction WE30, activity "Display"

S_IDOCMONI is used to set the permitted messages and directions for each department

With / EPO1 / IDOC everything is authorized once with * and once no action is authorized (read function only)

In the table / EPO1 / IDOC_AUTH, the authorization objects delivered by EPO Consulting are either left and supplemented or removed if no authorization restriction is necessary at organizational unit level (plant, sales, purchasing organization, etc.).

Suggestion for creating roles and assigning authorizations

Roles per IDoc Message type

A role can be created for each message type and direction. Of course, different message types and both directions can also be combined in one role.

Example role ZEPO_IDOC_ORDERS_OUT

This role authorizes the display of IDoc purchase orders (ORDERS IDocs in outbound processing)

ClipCapIt-170921-222532.PNG

Roles for the actions in the EPO IDoc Monitor

One role can be created for each action or one role for all actions.

Example role ZEPO_IDOC_ACTION_ALL

ClipCapIt-170921-222159.PNG

Assignment of permissions

The required IDoc message types are now assigned to the SAP users. In addition, the "EPO IDoc Monitor Action Roles" can be assigned.

ClipCapIt-170921-221709.PNG

Authorization object S_IDOCDEFT

This SAP standard authorization object must be used with the following parameters. The parameters of the authorization object S_IDOCDEFT are:

Authorization field value meaning

ACTVT 03 Activity: Checked for 03 (display)

EDI_CIM * Extension: Is checked for "DUMMY". Can be set to * = full authorization.

EDI_DOC * IDoc basic type: Is checked for "DUMMY". Can be set to * = full authorization.

EDI_TCD WE30 Transaction code: Is checked for "WE30".

Authorization object S_IDOCMONI

This SAP standard authorization object can be used with all specified parameters. The parameters of the authorization object S_IDOCMONI are:

Authorization field value meaning

ACTVT 03 Activity: Checked for 03 (display)

EDI_DIR depending on the role or 1 and 2 IDoc direction (1 = output, 2 = input)

EDI_MES depending on the role IDoc message type, for example ORDERS (purchase orders, sales orders) and ORDRSP (order confirmations, order confirmations)

EDI_PRN depending on the role or * Partner number: The recipient partner is used for outbound IDocs. The sender partner is used for inbound IDocs.

EDI_PRT depending on the role or * Port: The recipient port is used for outbound IDocs. The sender port is used for inbound IDocs.

EDI_TCD depending on the role or * Transaction code, i.e. / EPO1 / IDOC. The sy-tcode is used, which means that authorization can also be assigned separately for Z transactions.

Authorization object / EPO1 / IDOC

The following activities are provided and can be assigned to a user via roles / rights (ID / EPO1 / IDOC , linked to fixed values ​​of the domain / EPO1 / IDOC_ACTIVITY ):

ID	Meaning
EDIT	IDocs edit
PROCESS	IDoc process
MONITOR	Monitor call
STAT_CHG_S	Change IDOC status single
STAT_CHG_M	Change IDOC status of multiple IDocs
EDIT_MASS	Multi-Edit of IDocs
SEGM_DELE	IDoc segment delete
SEGM_CREA	IDoc segment create
SEGM_COPY	IDoc segment copy

IDOC organizational units authorization setting and filter / EPO1 / IDOC_AUTH

A filter function and authorization check can be set for combinations of message type and direction using the following table. According to the field definition, the appropriate value is extracted from the IDoc and checked against the selection values ​​or the authorization check is applied. If the "Authorization object" field is left blank, there is no authorization check.

Incorrect IDocs are not output. The authorization check is applied after the data has been selected. This means that all IDOCs found according to the selection are checked with regard to the authorization for the organizational unit, if a corresponding filter entry (MESTYP / DIRECT) is available. The filter function is used after the data selection and authorization check. This means that all IDOCs found according to the selection are checked if a corresponding filter entry (MESTYP / DIRECT) is available.

Field name meaning

MESTYP Message type (meaning of the message)

DIRECT Direction (1 = outgoing, 2 = incoming)

FILTER_FIELD Field name for the filter function

SEGTYP Segmenttyp

SAGNUM Segment number (optional)

FILTER_FIELDNAME Name of the selection field

QUALF_VALUE Qualifier value (optional)

AUTH_OBJCT Name of the authorization object (optional)

AUTH_FIELD_FOR_SEGFIELD Name of the check field (necessary if AUTH_OBJCT is filled)

AUTH_2ND_FIELD Name of the 2nd test field (optional)

AUTH_2ND_FIELD_VALUE Value of the 2nd test field (optional)

There are segments with the same structure, the meaning of which is only determined by the qualifier (e.g. various partner roles). If a value is stored in the table field ' QUALF_VALUE ', the segment with precisely this qualifier is searched for in the IDOC.

Screenshot: Entries in table / EPO1 / IDOC_AUTH

ClipCapIt-170830-230535.PNG

FILTER_FIELDNAME

Values ​​and their relation to the selection screen (section 'Filter on organizational units')

FILTER_FIELDNAME Selection field designation

BUKRS s_bukrs Company code

KOKRS s_kokrs Controlling area

WORKS s_werks Plant / Plant

EKORG s_ekorg Purchasing organization / Purch. Organization

VKORG s_vkorg Sales organization

LGNUM s_lgnum Warehouse number

PERSA s_persa Personnel area

Other values ​​for FILTER_FIELDNAME lead to an error, IDOCs are not displayed.

Example

Field name value

IDOCTP DELVRY01

MESTYP DESADV (shipping notification)

DIRECT 2 (= incoming)

FILTER_FIELD VKORG

SEGTYP E1ADRM1

SAGNUM

FILTER_FIELDNAME PARTNER_ID

QUALF_VALUE OSO

AUTH_OBJCT V_VBAK_VKO

AUTH_FIELD_FOR_SEGFIELD VKORG

AUTH_2ND_FIELD ACTVT

AUTH_2ND_FIELD_VALUE 03

Explanation: For incoming shipping notifications with the basic type ' DELVRY01 ', the value of the field ' PARTNER_ID ' is extracted from segment ' E1ADRM1 ' (address segment) with qualifier ' OSO ' (address of sales organization) . The segment number is not taken into account in this case.

First, the authorization check for the object ' V_VBAK_VKO ' is carried out with the field ' VKORG ' and the activity ' 03 ' (display). If the user has assigned the display authorization for this VKORG, the IDoc is displayed in the list - otherwise the display is suppressed (ie no display of incoming shipping notifications from 'foreign' sales organizations).

The value of the extracted sales organization is then checked against the selection field ' S_VKORG ' if the select option is filled out. Incorrect IDocs are removed from the internal list:

ClipCapIt-170803-170521.PNG

Note: as soon as at least one selection field in the 'Filter on organizational units' section has been filled in, only those IDOCs will be displayed that have assigned a filter rule for a filled field and whose extracted value corresponds to the selection. The authorization check, however, is also carried out without entering values ​​on the selection screen (provided that an authorization object has been entered).

Example for ORDERS and ORDRSP

The authorization objects M_BEST_EKO and V_VBAK_VKO are checked for purchase orders and order confirmations or sales orders and order confirmations. The display of the IDocs is therefore always reduced to the authorized organizational units.

ClipCapIt-170921-210717.PNG

Setting in table / EPO1 / IDOC_AUTH for message type INVOIC

With INVOIC Idocs, you can select the company code. In the case of incoming invoices from the "Fattura PA for Italy" solution, this segment is added using the VAT number and the table / field T001-STCEG.

IDOC AUTH for INVOIC.png

ecosio monitor or EDI monitor settings

Transaction /EPO1/EC_EB_WSSP12 , enter the following values ​​for each system in the transport path :

SAP-System: <sysid> (dev, test, prod)

Service: sapecosio

To be able to record the entries, the service "sapecosio" must be entered in the transaction / EPO1 / ECSIDOUT12 as follows:

One entry per SAP system ID.

The value sapecosio must be entered in the service. All other columns can remain empty.

Sapecosiomonitor Entry.png

Name meaning

password Password for the monitor

url URL for the monitor (general introduction)

ecosio test: https://monitor.test.ecosio.com/sap-auth

ecosio-Prod: https://monitor.ecosio.com/sap-auth

urldeep URL for the monitor (deep link) with reference to a specific message

ecosio-Test: https://monitor.test.ecosio.com/messages/

ecosio-Prod: https://monitor.ecosio.com/messages/

UserId Username for the ecosio monitor

Customer extension additional selection criteria

The customer extension is delivered in the package ZEPO1_EXC_IDOCMON.

With this extension, additional parameters can be added to the selection screen. The example of the purchasing group is delivered.

Description of the customer extension

The following includes are called by the / EPO1 / IDOCMONITOR program:

ZEPO1_IDOCCUSTOMTOP

ZEPO1_IDOCCUSTOMINITIALIZATION

ZEPO1_IDOCCUSTOMSELECTIONS

ZEPO1_IDOCCUSTOMFILTER

Example implementation ZEPO1_IDOCCUSTOMTOP

" text pool variables used in include ZEPO1_IDOCCUSTOMINITIALIZATION

data gt_text type table of textpool.

data wa_text type textpool.

" selection-screen variables used in include ZEPO1_IDOCCUSTOMSELECTIONS

data t024 type t024.

Example implementation ZEPO1_IDOCCUSTOMINITIALIZATION

" Read the text elements from the Z-program (for translation)

read textpool 'ZEPO1_IDOCCUSTOMPROGRAM' into gt_text language sy-langu.

clear wa_text.

read table gt_text into wa_text with key id = 'I' key = '001'.

zepo1001 = wa_text-entry. "global variable of selection-screen comment

Example implementation ZEPO1_IDOCCUSTOMSELECTIONS

selection-screen begin of block zepo1bl1 with frame title text-007.

selection-screen begin of line.

" Note: zepo1001 is declared automatically as global variable and filled at INITIALIZATION

selection-screen comment 1(28) zepo1001 for field s_ekgrp.

select-options: s_ekgrp for t024-ekgrp.

selection-screen end of line.

selection-screen end of block zepo1bl1.

Example implementation ZEPO1_IDOCCUSTOMFILTER

A logic analogous to the method alv_idoc_read from the program / EPO1 / IDOCMONITOR is implemented here. The authorization is checked here first (if an authorization object is entered in Tab. ZEPO1_IDOC_AUTH) and then the selected IDocs are "filtered out".

In contrast to this, the Customizing table ZEPO1_IDOC_AUTH (not / EPO1 / IDOC_AUTH) is read. In the ZEPO1_IDOC_AUTH table, the FILTER_FIELD field is a key field, meaning that more than 1 entry is possible for the MESTYP / DIRECT combination.

Versions and change log

Version 2.101

Workbench Transport I01K901394 EPO IDoc Monitor Workbench Version 2.101

Customizing Transport I01K901387 200 EPO IDoc Monitor Customizing Version 2.101

Date: July 23, 2017

Version 2.105

Workbench Transport I01K901575 EPO IDoc Monitor Workbench Version 2.105

Customizing Transport I01K901465 200 EPO IDoc Monitor Customizing Version 2.102

optional:

Workbench Transport I01K901577 EPO IDoc Monitor Z-Developement WB Version 2.105

Date: Dec 1, 2017

Version 2,200

Workbench Transport I01K901685 EPO IDoc Monitor Workbench Version 2.200

Recommended, optional: Workbench Transport I01K90 1679 EPO IDoc Monitor Z-Developement WB Version 2.200

Customizing Transport I01K901687 200 EPO IDoc Monitor Customizing Version 2.200

New function: Search in IDoc content with or without specification of a segment type and fields

Internal program structure adjusted: DDIC classes created

IDOC monitor search for content.png

Date: March 14, 2018

Version 3.3.0

Workbench Transport I01K902119 EPO IDoc Monitor Workbench Version 3.3.0

Date: 1. Nov. 2018

New function:

Idoc App is now opened externally in the default browser

Copy, delete and paste segments possible

Extension of the selection option for IDoc content data (relevant for incoming IDocs): If the field you are looking for is not contained in the IDoc, then by specifying the SAP table and field of the SAP document in the customizing table / EPO1 / IDOC_CUST you can specify that this Field is determined via the SAP document. Examples are the purchasing organization and the purchasing group for incoming order confirmations (ORDRSP).

Version 3.3.1

Workbench Transport I01K902174 EPO IDoc Monitor Workbench Version 3.3.1

Workbench Transport I01K902120 EPO IDoc Monitor Workbench ZDEV Version 3.3.0

Customizing Transport I01K902121 EPO IDoc Monitor Customizing Version 3.3.0

Customizing Transport I01K902123 EPO IDoc Monitor Customizing ZDEV Version 3.3.0

Date: 20. Nov. 2018

Bug Fix: Change function segment copy, delete and now also possible without authorization check (entry NOAUTHORCHECK = X set in Tab. / EPO1 / IDOC_CUST)

New: Search help for IDoc number

Version 3.4.2

Workbench Tansport WK1K900389 EPO_IDoc_Monitor_WB_v342

Date: Oct 10, 2019

Bug Fix: Insert segment: wrong check for max. possible segment types

Version 3.4.3

Workbench Tansport WK1K900450 EPO_IDoc_Monitor_WB_v343

Date: Oct 23, 2019

Bug Fix: Insert segment at wrong place

Version 3.4.4

Workbench Tansport WK1K900507 EPO_IDoc_Monitor_WB_v344

Date: 6. Nov 2019

New: Display application log for IDoc status, additional fields: definition per direction (inbound / outbound) possible.

Version 3.4.5

Workbench Tansport WK1K900572 EPO_IDoc_Monitor_WB_v345

Date: 19. Nov 2019

Bug Fix: Application log display was not updated.

Version 3.5.0

Workbench Tansport WK1K900828 EPO_IDoc_Monitor_WB_v350

Date: May 4, 2020

New:

Reading of IDoc contents and display in the ALV list (dynamic structure of the ALV list)

Split IDoc into IDocs with 1 item each

Bug Fix: IDoc mass change when used without the authorization object / EPO1 /

Version 3.5.1

This version doesn't exist yet, but here's a new feature that was previously only delivered to Leitner:

There is an additional button "Show attachments" that enables attachments to IDocs to be displayed. PDFs can be viewed internally. Other extensions (and also PDFs) can be displayed externally if they are in Customizing table / EPO1 / IDOC_CUST with CUST_KEY = "ATTACH_FILE_EXTENSION_OPEN_EXTERNAL" and CUST_VALUE = 'PDF; XLSX "(for example). Files with other extensions are placed in the local temporary directory if necessary and can be processed there. Attention: For this release, a new SP12 release (with changed class / epo1 / cl_file_disp) is required which has also not yet been created.

Version 3.5.2

Workbench Tansport WK1K900950 EPO_IDoc_Monitor_WB_v352

Date: Jun 22, 2020

Version 3.5.3

Workbench Tansport WK1K901254 EPO_IDoc_Monitor_WB_v3.5.3

Date: Oct 16, 2020

Attachments

Mass change for IDocs

Version 3.5.4

Workbench Tansport WK1K901306 EPO Idoc Monitor 3.5.4

Date: 2. Nov 2020

Application log improved

Version 3.5.5

Workbench Tansport WK1K901304 EPO Idoc Monitor 3.5.5

Date: 4. Nov 2020

Cleanup of non-package objects, no functional changes

Version 3.5.6

Workbench Tansport WK1K901350 EPO Idoc Monitor 3.5.6

Date: 9. Nov 2020

Cleanup of non-package objects, no functional changes