Document History

About This Guide

This document describes configuration steps that are required, or are optionally possible, to configure 3Keys Kazakhstan CEDM in SAP ATTP system.

Solution overview

SAP ATTP delivers a solution to generate the reporting messages for Kazakhstan CEDM system. The 3Keys Kazakhstan CEDM Add-On automate the communication and message generation/transfer to Kazakhstan CEDM system, visualize the message processing status with monitoring transaction.

Solution scope

In 3Keys Kazakhstan CEDM, the following notifications are supported:

 The list of supported rule types (notifications) is planned to be enhanced in future 3Keys Kazakhstan CEDM releases. Also, you can enhance supported notification by adding custom rule types (See enhancement section).

Constraints, Assumptions, Prerequisites and Dependencies

The Kazakhstan reporting part for CEDM is configured in SAP ATTP.

Setting up the Solution

Connection to Java part

The connector Java part as SaaS solution supports HTTPS communication using web services.

The Root CA certificate of the certificate which is used to secure the connection from ATTP or middleware system to connector Java part, should be added to the SSL client (Anonymous) in the transaction STRUST.

The corporate firewall, proxy, gateway, etc. should allow outbound HTTPS connection from ATTP or middleware system to the Connector Java part.

Prerequisites

For setting up an online integration to a Kazakhstan reporting system via CEDM connector Java part, do the following:

·       Create an HTTP Destination to CEDM connector.

·       Create a System (master data).

·       Maintain settings.

Create an HTTP Destination to CEDM connector

To create an HTTP connection to the external server, do the following:

Call transaction SM59

Create a new destination as follows:RFC Destination: Maintain a name for the destination (for example CEDM)

• Connection Type: G – HTTP Connection to External Server

• Description: Maintain a description for the destination (for example CEDM via 3Keys Kazakhstan connector)

On the tab Technical Settings, maintain the URL in the fields Target Host, Service No. and Path Prefix.

• For example, the URL: https://[URL provided by 3Keys support]/app/edo/api results into:

  • Target Host: [URL provided by 3Keys support] (or server name in case on-premise installation)

  • Service No.: 443

  • Path Prefix: /app/edo/api

Set the HTTP Proxy Options as required in your organizations network

On tab Logon & Security, do the following:

• Basic Authentication: true

• Input User and password for CEDM Connector

• Do Not Send Logon Ticket: true

• SSL: active, Anonymous

On the tab Special Options, do the following:

• HTTP Version: HTTP 1.1

• Compression: Inactive

• Compressed Response: Yes

• Accept Cookies: No

Save the destination.

Click on Connection Test to test the created destination. If the connector and reporting system is reachable and the destination is set up correctly, the test result shows that the HTTP response value is 200 and Text is OK.

Create the second RFC destination identical to created destination without path prefix (to test True API methods). Maintain a name for the destination (for example CEDM_API).

Create a system for CEDM

To create a system, do the following:

• Call transaction /STTP/COCKPIT

• Navigate to Master Data > Systems and then Choose Display/Edit.

• Choose Create. A popup is displayed. 

• In the popup, define a system name and use following parameters: 

  • System name (for example KAZ_CEDM)

  • System Type: F - Foreign Reporting System

  • Communication Type: 0 – Not Specified

  • RFC Destination: Maintain the destination name created in SM59 with path /app/edo/api

Create a system for CEDM API

To create a system, do the following:

• Call transaction /STTP/COCKPIT

• Navigate to Master Data > Systems and then Choose Display/Edit.

• Choose Create. A popup is displayed. 

• In the popup, define a system name and use following parameters: 

  • System name (for example KAZ_CEDM_API)

  • System Type: F - Foreign Reporting System

  • Communication Type: 0 – Not Specified

  • RFC Destination: Maintain the destination name created in SM59 without path

Technical user and authorization role

One technical user shall be created in ATTP and have authorization to execute web service calls.

Maintain service paths

Check and, if needed, maintain the service paths in the view /STTP/V_RSRVPATH via transaction SM30. Industry 20 is default industry for methods, correct product group depends on industry and added before True API request execution

Event additional properties

The following is a list of expected event properties to compose the notification message. The notification raise error in case the mandatory event properties is not available on the event.

Import from EAEU

Import from 3rd countries

Write off

Return into circulation

Report codes transfer from non-resident

Act of acceptance

Act of acceptance Single distributor

New aggregation out of production

Customizing the solution

In general, customizing is performed with following transactions:

• /K3TKZ/EDO_PARAM - Reporting parameters

• /K3TKZ/EDO_CUST - Reporting customizing

• /K3TKZ/EDO_CONF - Reporting configuration

• /K3TKZ/EDO_ATTR_MAP - Reporting attributes mapping

General Customizing

The transaction /K3TKZ/EDO_PARAM contains parameters to influence the 3Keys Kazakhstan CEDM. The settings will require a customizing transport.

Following the recommended minimum set of parameters

Customizing for Reports

Relevant industry

Maintain relevant industry in the transaction /K3TKZ/EDO_CUST under “Relevant industry”.

These settings are also used for assignment of customer specific industries to product groups

This mapping will be used to identify correct product group (Commodity group) on execution CEDM API request.

Example:

Document type description

Maintain document type description in the transaction /K3TKZ/EDO_CUST under “Document Type”

Mapping attributes

Mapping attributes in the transaction /K3TKZ/EDO_CUST under “Mapping attributes” contains attributes for each report used on notification creation. 3Keys Kazakhstan CEDM connector already contains predefined mapping attributes for delivered rule types:

Product Group

Product group in the transaction /K3TKZ/EDO_CUST under “Product group” contains possible values for product groups at CEDM system. 3Keys Kazakhstan CEDM already contains product groups, maintain additional values in case new product group added:

CEDM Status send from, CEDM Status send to

CEDM status customizing in the transaction /K3TKZ/EDO_CUST under “CEDM Status send from” contains possible status values for message sequence check before sending to CEDM system. Node “CEDM Status change to” contains new status value to be set after receiving successful response for notification. 3Keys Kazakhstan CEDM already contains CEDM status, maintain values in case other status processing logic is required

Reporting message attributes

Participant tax code fields could be filled with value from source or destination fields of the EPCIS event or business transaction in the transaction /K3TKZ/EDO_ATTR_MAP .

The following location data source is supported:

BIZTRANS-SHIPFROM - event business transaction document ship from party
BIZTRANS-SHIPTO - event business transaction document ship to
BIZTRANS-SOLDFROM - event business transaction document sold from party
BIZTRANS-SOLDTO - event business transaction document sold to party
EVT-BIZLOC - event business location
EVT-DST-LOC - event destination location
EVT-DST-OWNR - event destination owning party
EVT-READPOINT - event read point
EVT-SRC-LOC - event source location
EVT-SRC-OWNR - event source owning party

The following fields are available for mapping:

SENDERBIN - Report from non-resident
RECEIVERBIN - Report from non-resident

The list is not final and planned to be enhanced for the future developed reporting message types

Rule processing

The common rule processing scheme:

Open

The rule type Z3KKZ_EDO shall be assigned in the transaction /STTP/CUST_RULES to business steps / location groups related for the CEDM Kazakhstan reporting 

The rule type Z3KKZ_EDO allows to use additional customizing parameters to determine the rule to be executed, determine the approval parameters, and helps with sequence check. In case event triggered rule contains more than one industry rule type Z3KKZ_EDO split objects into several reporting events group by industry.

Maintain the rules in the transaction /K3TKZ/EDO_CONF under “Rule Configuration”

Maintain additional parameters in the transaction /K3TKZ/EDO_CONF under “Rule Configuration” if required skip specific rules using SAP ATTP rule conditions or class-based rule conditions

SAP ATTP rule condition is based on BADI /STTP/BADI_RULE_CONDITIONS with filter = rule condition (Rule processing will stop check if result is skip rule).

Class-based rule condition is maintained via transaction /K3TKZ/EDO_CUST node “Rule condition” and based on class method /K3TKZ/CL_EDO_RULES=>GET_RULE_CONDITION_CLASS. Method is used to get class name from table /K3TKZ/C_EDOCOND, custom class could be assigned as condition processor. Class method /K3TKZ/IF_EDO_3K_RULE_COND~EXECUTE is called. (Rule processing will stop check if result is skip rule). 

Message approval

By default every report is ready for sending. If the explicit waiting of user approval is required activate User Approval check box in the transaction /K3TKZ/EDO_CONF under “Configuration ID” 

Sequence check

The sequence check is active for all outbound notification to CEDM system. The sequence check is triggered during the message approval, check sequence function, sending notification to CEDM via report /K3TKZ/EDO_DISPATCHER.

Background job needs to be planned for the report /K3TKZ/EDO_DISPATCHER. The sequence check results are stored as application log transaction SLG1, Object /STTP/, Sub object REP, External ID /K3TKZ/EDO_SEND

The logic of the sequence check:

1. Call BADI /K3TKZ/BADI_EDO_SEQ_CHECK method BEFORE_CHECK

2. Check objects CEDM status (status found). The CEDM status tracked for every SGTIN in the table /K3TKZ/EDO_STA. The SSCC CEDM status determined based on the first found SGTIN in the current hierarchy

3. Processing status: there is no report with the same objects in status “Send”

4. Check predecessor: there is no report with the same objects earlier than the current message

5. Call BADI /K3TKZ/BADI_EDO_SEQ_CHECK method AFTER_CHECK

The CEDM status could be updated with transaction /K3TKZ/EDO_SN_INFO or program /K3TKZ/EDO_OMS_REP (if SGTIN was send to OMS with BR_CRYPTO_COMM event).

The sequence check can be skipped/ignored by user in the transaction /K3TKZ/EDO_MONITOR with button Approval

Configuration ID determination

The Configuration ID represents the user / certificate for login to the CEDM system and electronic signature of the message in the connector Java part configuration file. 

Multiple Configuration ID are supported.

Maintain Configuration ID in the transaction /K3TKZ/EDO_CONF under “Configuration ID” 

 Maintain Participant Tax code in the transaction /K3TKZ/EDO_CONF under “Participant Tax code” 

Price determination

According to the CEDM system documentation some document types need to maintain price data as separate step of the document sending process.

Price data is determined on the document mapping logic as GTIN attribute ZKZ_PRICE by default and document type specific GTIN attribute ZKZ_PRICE_00XX (for example GTIN attribute ZKZ_PRICE_0003 for “Import from 3rd countries” notification) and store as GTIN/Lot quantity data.

Transaction /K3TKZ/EDO_MONITOR function “Maintain missing data” could be used to set price data manually by user.

If required it is possible to redefine price data using BADI /K3TKZ/BADI_EDO_CHG_AFTER_MAP or /K3TKZ/BADI_EDO_CHG_AFTER_CHK.

Price data is relevant for reporting notifications Act of acceptance, Act of acceptance Single distributor, Import from EAES, Import from third countries, Return into circlulation, Write Off.

Price information for reporting notification is optional. Reporting notification is created without price specification steps by default and could be activated using parameter via transaction /K3TKZ/EDO_PARAM value X (for example parameter PRICE_RELEV_0001)

Background jobs for report processing

Report sending

The report /K3TKZ/EDO_DISPATCHER (could be planned as background job or run manually via transaction /K3TKZ/EDO_DISP) collects created reports with status “Sequence check” and “Ready for sending”, perform sequence check and send report to CEDM system and update data:

• Report header / item

• Reporting event 

Program works as single instance for each selected configuration (based on logical lock).

In case sending failed program updates field “Error text” and leave processing status without change to send report with next run.

The report run results are stored as application log transaction SLG1, Object  /STTP/, Sub object REP, External ID /K3TKZ/EDO_SEND

Response processing

The report /K3TKZ/EDO_RESPONSE (could be planned as background job or run manually via transaction /K3TKZ/EDO_RESPONSE) collects send reports with status “Send”, receives report status from CEDM system and updates data:

• Report header / item

Program works as single instance for each selected configuration (based on logical lock).

First response for report is requested after delay set in the configuration transaction /K3TKZ/EDO_CONF. 

In case no positive response (response http code 200) received for report, program updates:

• field “Error text” with error from JSON

• field “Response code”

• field “Response error counter” - increase value by 1. When response error counter value become more than maximum error counter set in the configuration customizing (table /K3TKZ/C_EDOCNF) report processing status is set to “No response”

• analyze if received HTTP error code is server error (selection screen parameter) during this report run and stop processing if value of screen parameter “Stop after error number” exceeded

• for document types Act or Act Single distributor waiting for accept from other participant analyze wait time from sending date. When waiting time is more than sending time + field “Act Response Wait Time (Days)” report processing status is set to “No response”

The report run results are stored as application log transaction SLG1, Object  /STTP/, Sub object REP, External ID /K3TKZ/EDO_RESPONSE

OMS report processing

The report /K3TKZ/EDO_OMS_REP (could be planned as background job or run manually) collects events with processed BR_CRYPTO_COMM reporting events, checks status at CEDM system for specific number (subset) of SGTINs and updates data:

• Report monitor header

• Report monitor item

• SGTIN status (APPLIED) for sequence check

The following diagram described program work:

Open

The report run results are stored as application log transaction SLG1, Object  /STTP/, Sub object REP, External ID /K3TKZ/EDO_OMS_REPORT

Inbound document processing

The report /K3TKZ/EDO_DOC_IN (could be planned as background job or run manually via program /K3TKZ/EDO_DOC_IN) downloads inbound documents from CEDM system and transfer to SAP ATTP using following steps:

• Download new inbound documents from CEDM system

• Run inbound document processing at SAP ATTP

The message processing executed with AIF functions and visible in the transaction /AIF/ERR. To receive Inbound document from CEDM system program use date time filter calculated as range [ Last Run Date - <overlap in seconds> ; current date time ]. To set <overlap in seconds> maintain Configuration ID via transaction /K3TKZ/EDO_CONF under “Inbound Filter”

To define SAP AIF processing logic maintain processing function module in the transaction /K3TKZ/EDO_CONF under “Inbound Document processing”

In 3Keys Kazakhstan CEDM, provides the list of function modules for processing of inbound documents:

The following diagram described program work:

Enhancements of the Solution

The 3Keys Kazakhstan CEDM connector solution is designed as to be possibly enhance based on customizing and code enhancements. Code enhancements are realized through BAdI implementations.

Enhancing rule determination

3Keys rule configuration includes a possibility to further refine the selection criteria for a rule to be executed. This can be accomplished by using one of the following options:

• Redefine default rule execution class /K3TKZ/CL_EDO_3K_RULE_PROC to custom class using table /K3TKZ/C_EDORTYP and implement own logic with ABAP to skip specific rule after rule configuration reading 

Maintain rule type in the transaction /K3TKZ/EDO_CUST under “Rule Type”

• Implementing a BADI /STTP/BADI_RULE_CONDITIONS with filter = rule condition 

• Implementing 3Keys rule condition class containing interface  /K3TKZ/IF_EDO_3K_RULE_COND. Custom logic needs to be created at method /K3TKZ/IF_EDO_3K_RULE_COND~EXECUTE.

Maintain rule condition in the transaction /K3TKZ/EDO_CUST under “Rule Condition”

Change report content

The report JSON generated by ATTP standard may not fit to the business requirements. Following options for the report JSON changing are available:

Create custom mapping logic

To compose report data, it is possible to use own logic by creating new rule type with own rule type execution class by implementing interface /K3TKZ/IF_EDO_3K_RULE_MAPPING (method EXECUTE).

Based on import parameters (event data, industry, rule key) it is necessary to fill output table with AIF structure to transfer data to AIF and create report monitor header and item.

To assign custom execution class use transaction /K3TKZ/EDO_CUST, node “Mapping Attributes”, column “Mapper Class”.

Change existing mapping logic

To compose report data it is possible to change existing rule type logic by using mapping class redefinition. It is necessary to create own class as child class of /K3TKZ/CL_EDO_0011_MAPPER Collect notification data (or copy of this class) and assign this new class to relevant rule type via transaction /K3TKZ/EDO_CUST, node “Mapping Attributes”, column “Mapper class”.

Change check logic after mapping

Badi /K3TKZ/BADI_EDO_CHG_AFTER_CHK shall be implemented for the rule type and own processing logic needs to be implemented.

Change report after mapping

Badi /K3TKZ/BADI_EDO_CHG_AFTER_MAP shall be implemented for the rule type and own processing logic needs to be implemented.

New custom CEDM report type

The new CEDM reporting type not existing in the 3Keys Kazakhstan Connector CEDM can be created with following steps:

• Create new rule type via transaction /STTP/CUST_RULE_TYPE - Define Rule types

• Create new notification type via transaction /STTP/REP_NOTIF_TYPE - Define Reporting Notification Types

• Create ABAP structures for AIF (use structure /K3TKZ/S_EDO_IMPNRES_AIF as example)

• Create AIF customizing via transaction /AIF/CUST (Namespace /STTC3):

  • Define interface

  • Specify interface engine

  • Define structure mapping

• Create customizing for mapping report content via transaction /K3TKZ/EDO_CUST (“Mapping attributes” node)

• Add logic to extract report data implementing BADI /K3TKZ/BADI_EDO_PARSE

• Create customizing for new rule via transaction /STTP/CUST_RULES (3Keys General rule)

• Create customizing for new rule via transaction /K3TKZ/EDO_CONF (“Rule configuration” node)

• Create logic to parse data by implementing Badi /K3TKZ/BADI_EDO_PARSE

New industry

The new industry not supported by SAP ATTP standard can be created with following steps:

1. Create fixed value append for domain /STTP/D_INDUSTRY (for example ZP – Perfume). Skip this step if industry is supported by 3Keys Kazakhstan Connector for CEDM.

2. Specify relevant industry for reporting (transaction /K3TKZ/EDO_CUST, node “Relevant Industry”) 

3. Add new REST path for created industry (transaction SM30 view /STTP/V_RSRVPATH)

4. Add general customizing parameter RR_RU_NTF_REV for industry using transaction /STTP/CUSTGEN

Create new CEDM API function

The new CEDM API method not existing in the 3Keys Connector CEDM can be created with following steps

1. If base class for API processing does not exist create child class of /K3TKZ/CL_EDO_API_REQ as custom class ZCL_EDO_API_REQ

2. Create method GET_INSTANCE_ATT as copy of GET_INSTANCE at custom class ZCL_EDO_API_REQ

3. Create new constant for rest operation (use constant /K3TKZ/CL_EDO_REST_CONST=>GCS_REST_OPERATION-NOTIFICATION-EDO-GET_CISES_INFO as example)

4. Add new REST path for created REST operation (transaction SM30 view /STTP/V_RSRVPATH)

5. Create processor class (use class /K3TKZ/CL_EDO_API_INFO_KM Get Codes Information as example), for example ZCL_EDO_API_INFO_KM Get Codes Information 2

6. Add processor (class ZCL_EDO_API_INFO_KM) instance creation logic into method GET_INSTANCE_ATT (based on rest operation) of base class ZCL_EDO_API_REQ

7. Implement new created API processing class ZCL_EDO_API_REQ call into custom code

8. Create child / copy /K3TKZ/CL_EDO_REST_CLIENT and implement into ZCL_EDO_API_INFO_KM

Enhancement spot /K3TKZ/ES_EDO

Enhancement for navigation to ATTP cockpit

Add general customizing parameter /K3TKZ/COCKPIT_NAVIG (usage scope Customizing) to enable navigation to ATTP Cockpit from transaction /K3TKZ/EDO_MONITOR using transaction /STTP/CUSTGEN