Configuration Guide Uzbekistan OMS Connector

Document History

Version

Changes

Effective Date

1.0

First approved version

3Keys Uzbekistan Add-On release 3.1

01-Apr-2022

2.0

Release RN_2023_03

01-Aug-2023

3.0

Release RN_2023_04

01-Nov-2023

 

1.    About This Guide

This document describes configuration steps that are required, or are optionally possible, to configure 3Keys Uzbekistan Add-On OMS in SAP ATTP system.

2.   Solution overview

The 3Keys Uzbekistan Add-On OMS provides the solution to generate OMS message content, automate the communication and message transfer to Uzbekistan OMS system, visualize the message processing status with SAP ATTP transaction.

SAP ATTP connect to OMS directly (or using proxy if required) with static token stored at SAP ATTP

2.1    Solution scope

In 3Keys Uzbekistan Add-On OMS, the following notifications are supported:

Rule

Notification

BR_CRYPTO_COMM

Bus. Rule: Commissioning for Crypto Codes

BR_CRYPTO_DECOMM

Bus. Rule: Decommissioning for Crypto Codes

Z3KUZ_OMS_AGGR

Aggregation report to OMS

Z3KKZ_OMS_AGGR_MPCK

Aggregation report to OMS based on object event in ATTP

3.    Constraints, Assumptions, Prerequisites and Dependencies

The 3Keys Uzbekistan Add-On OMS successfully installed in SAP ATTP.

4.    Setting up the Solution

4.1    Prerequisites

The DigiCert Global Root CA certificate should be added to the SSL client (Anonymous) in the transaction STRUST.

Parameter icm/HTTPS/client_sni_enabled with value TRUE shall be set in transaction RZ10

The corporate firewall, proxy, gateway, etc. should allow outbound HTTPS connection from ATTP to the Uzbekistan OMS.

4.2    HTTP Destination to Uzbekistan OMS

Call transaction SM59

Create a new destination:

o   RFC Destination name (for example OMS_UZ)

o   Connection Type: G – HTTP Connection to External Server

On the tab Technical Settings, maintain the URL in the fields Target Host, Service No

o   For example, the URL https://omscloud.aslbelgisi.uz (or https://omscloud.stage.aslbelgisi.uz - test system) results into:

Set the HTTP Proxy Options as required in your organizations network

On tab Logon & Security, set following:

o   Do Not Use a User: true

o   Do Not Send Logon Ticket: true

o   SSL: active, Select the SSL Certificate: ANONYM SSL Client(Anonymous)

On the tab Special Options, set following:

o   HTTP Version: HTTP 1.1

o   Compression: Inactive

o   Compressed Response: Yes

o   Accept Cookies: No

Save the destination.

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

4.3    Maintain Country Communication Settings

Maintain Country communication customizing if the transaction Safe storage will be using industry for maintaining OMS ID and OMS token, do the following

  1. Call the transaction /STTP/C_CTY_URL

  2. Create an entry for each industry you need to support as follows:

URL Type: Choose one of the following URL types:

URL Type

Description

UZ_10_OMS

OMS URL Type (Pharmaceuticals UZ)

Logical Port Name: Maintain the destination name created in SM59.

3. Save the created entry.

In order for the URL type UZ_10_OMS to be displayed via search help check parameter Z3KUZ_OMS_ACTIVE is activated (see chapter 4.9.2 General Customizing)

4.4    Create a system in ATTP

Create a system in ATTP if the transaction Safe storage will be using systems for maintaining OMS ID and OMS token, otherwise the system is not needed, do the following:

  1. Call transaction /STTP/COCKPIT

  2. 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: 

a.      System name (for example OMS_UZ)

b.     System Type: O - OMS

c.      System Group: SAP_UZ_10

d.     Business partner: Choose the business Partner which needs to retrieve the crypto codes

e.     Communication Type: 0 – Not Specified

f.       RFC Destination: Maintain the destination name created in SM59

4.5    Safe storage OMS parameters

4.5.1    By industry

To save OMS Identifier do the following: 

  1. Call transaction /STTP/RU_SAFESTORAGE.

  2. Select radio button 

By Industry.

  1. Select the URL type for which the OMS Identifier needs to be updated. 

  2. Select the 

Parameter OMSID – OMS Identifier.

Choose the option 

Set Value to be stored and type in the OMS ID into the Value field.

Choose 

Execute (F8).

To save existing client token do the following: 

  1. Call transaction /STTP/RU_SAFESTORAGE.

  2. Select radio button 

By Industry.

Select the URL type for which the client token needs to be updated. 

Select the 

Parameter CLIENTTOKEN – OMS Client Token.

Choose the option 

Set Value to be stored and type in the client token into the Value field.

Choose 

Execute (F8).

4.5.2    By system

Do the following: 

  1. Call transaction /STTP/RU_SAFESTORAGE.

  2. Select radio button 

By system.

Select the system name for which the OMS Identifier needs to be updated. 

Select the 

Parameter OMSID – OMS Identifier.

Choose the option 

Set Value to be stored and type in the OMS ID into the Value field.

Choose 

Execute (F8).

To save existing client token do the following: 

  1. Call transaction /STTP/RU_SAFESTORAGE.

  2. Select radio button 

By system.

Select the system name for which the client token needs to be updated. 

Select the 

Parameter CLIENTTOKEN – OMS Client Token.

Choose the option 

Set Value to be stored and type in the client token into the Value field.

Choose 

Execute (F8).

4.6    Product / GTIN parameters

The profile relevant country UZ, flag Crypto Code Relevant shall be set on GTIN level.

The production line property RR_RU_PRODLINE_ID could be set to send the same aggregation with new report with updated request content.

4.7    Additional attributes / Product properties

The following product properties for can be maintained for trade items for sending crypto code order request to OMS system.

Property

Description

Value

ZUZ_OMS_RMT

Release method type (optional parameter)

The default value IMPORT is used in case product property is not maintained

IMPORT - in case of import to Uzbekistan

PRODUCTION – in case of manufacturing in Uzbekistan

GTIN_INDUSTRY

GTIN industry

10  - Pharma Uzbekistan

BR_OWNER_GLN

Business partner GLN with company registration types maintained

 

RR_CRYPTO_RELEV

GTIN is relevant for Crypto Codes

X

4.8    Company registration types

The following company registration types can be used by business partners for sending aggregation report to OMS system. Maintain following company registration types

Property

Description

Value

ZUZ_OMSRMT

Release method type (optional)

The default value IMPORT is used in case product property is not maintained

IMPORT - in case of import to Uzbekistan

PRODUCTION – in case of manufacturing in Uzbekistan

ZUZ_PARTIC

Ident. Number of Taxpayer UZ OMS (mandatory)

 

4.9    Customizing the solution

4.9.1    Maintain service paths

Maintain the service paths in the view /STTP/V_RSRVPATH via transaction SM30.

Industry

Identifier

RU System

RU System Revision

REST Operation

REST Path

10 (Pharma UZ)

OMS (Order Management System)

283

GET_AGG_INFO

/api/v2/pharma/aggregation/info

10 (Pharma UZ)

OMS (Order Management System)

283

GET_CONNECTION_ID

/api/v2/integration/connection

10 (Pharma UZ)

OMS (Order Management System)

283

GET_EMISSION_ORDERS

/api/v2/pharma/orders

10 (Pharma UZ)

OMS (Order Management System)

283

GET_OMS_VERSION

/api/v2/pharma/version

 

10 (Pharma UZ)

OMS (Order Management System)

283

GET_REPORT_STATUS

/api/v2/pharma/report/info

10 (Pharma UZ)

OMS (Order Management System)

283

PING

/api/v2/pharma/ping

10 (Pharma UZ)

OMS (Order Management System)

283

SEND_AGGREGATION

/api/v2/pharma/aggregation

10 (Pharma UZ)

OMS (Order Management System)

283

SEND_CLOSE_ARRAY

/api/v2/pharma/buffer/close

10 (Pharma UZ)

OMS (Order Management System)

283

SEND_DROPOUT

/api/v2/pharma/dropout

10 (Pharma UZ)

OMS (Order Management System)

283

SEND_IC_ORDER

/api/v2/pharma/orders

10 (Pharma UZ)

OMS (Order Management System)

283

SEND_IC_RETRIEVAL

/api/v2/pharma/codes

10 (Pharma UZ)

OMS (Order Management System)

283

SEND_IC_STATUS

/api/v2/pharma/buffer/status

10 (Pharma UZ)

OMS (Order Management System)

283

UPLOAD_LOGS

/api/v2/pharma/logs/upload

4.9.2    General Customizing

The transaction /STTP/CUSTGEN contains parameters to influence the 3Keys Uzbekistan OMS Add-On. The settings will require a customizing transport.

Component

Parameter key

Parameter Option

Parameter Value

Description

SNR

CC_AUTO_CNF_COMM

10

X

Auto Confirm for Pharma UZ. This parameter prevents sending utilization report for specified industry and sets confirmed flag for crypto codes after BR_CRYPTO_COMM rule execution

Need to be inactive at Test system

Need to be active at Production system

REP

RR_RU_OMS_PING

10

 

Execute ping before each OMS method call. Trigger application error if ping is not successful

REP

RR_RU_OMS_REV

10

283

OMS revision for UZ Pharma industry

REP

RR_RU_OMS_SAVE_RESP

10

X

Save response

REP

Z3KUZ_OMS_ACTIVE

 

X

Activate 3Keys Uzbekistan OMS Add-On

REP

Z3KUZ_AG_MAXOBJPACK

 

 

Maximum object number in aggregation report

REP

Z3KUZ_SKIP_CC_CNFCHK

<GLN>

 

Skip crypto code confirmed check on sequence check

REP

Z3KUZ_SKIP_OM_ONLCHK

<GLN>

 

Skip online aggregation check on sequence check

This parameter is mandatory.

REP

Z3KUZ_MAX_LOG_ROWS

 

 

Maximum errors on sequence check predecessor check for one report

REP

Z3KUZ_OMS_PRDLINE_ID

 

 

Production line value for aggregation report sending. Can be used to send the same aggregation with changed report request body

REP

Z3KUZ_OMS_LOCK_TRIES

 

20

Maximum OMS lock tries before OMS interaction operation (except aggregation report sending). After each lock attempt delay system wait for delay 2 seconds. In case parameter is not maintained default value 20 is used. This parameter is optional.

REP

Z3KUZ_OMS_EVT_PRDDT

10

Example: Z_MANUF_DATE

Event property name from commissioning event for Utilization report “Production Date” field

4.10    Customizing for Reports

4.10.1    Country/Region groups

Maintain country/region groups via transaction /STTP/CUST_CTR_GRP.

The following values are recommended

Node

Description, Values

Define country group

Country/Reg group:

  • ZR_UZ

Country/Reg group Short description:

  • Reg. Rep.: Country group UZ

Country group Country assignment

Country:

  • UZ

Name:

  • Uzbekistan

 

This country group will be used to restrict rule execution at rule customizing.

4.11    Rule processing

The following rule types shall be assigned in the transaction /STTP/CUST_RULES for location groups related for the Uzbekistan reporting:

  • BR_CRYPTO_COMM for business step commissioning

  • Z3KUZ_OMS_AGGR can be maintained for aggregation event with action ADD

  • Z3KUZ_OMS_AGGR_MPCK can be maintained for object event with action OBSERVE

  • BR_CRYPTO_DECOMM for business step Decommissioning

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)

4.12    Message approval

Every aggregation report to OMS system is checked by sequence check before sending. If the report sequence is wrong user approval flag is set for aggregation report with status “Waiting” and message sending is stopped.

4.13    Sequence check

The sequence check is active for aggregation reports to OMS system. The sequence check is triggered during the message creation, sending report to OMS via report /K3TUZ/OMS_DISPATCHER.

Background job needs to be planned for the report /K3TUZ/OMS_DISPATCHER. The sequence check results are stored as application log transaction SLG1, Object /STTP/, Sub object DM, External ID /K3TUZ/OMS_SEND

The logic of the sequence check:

  1. Check crypto codes utilization is confirmed

  2. Check predecessor: there is no report with the same objects earlier than the current message without response (or in status Error Acknowledged)

  3. For aggregation messages of SSCC to SSCC, the child SSCCs checked in OMS with online call. Child SSCC must contain at least 1 object

The sequence check can be skipped/ignored by user in the transaction /STTP/COCKPIT with button “User Approval” - “Approve and send”.

4.14    Report to get aggregation information from OMS

The report /K3TUZ/OMS_AGGR_INFO (transaction /K3TUZ/OMS_AGGR_INFO) allows you to select aggregation information for object code from OMS system.

Report supports OMS selection logic based on:

  • ATT system determination (read GTIN or first object GTIN of SSCC and determine OMS by GTIN industry)

  • Selection screen values (request object fata from selection screen for object not existing at ATT system)

Object code from selection screen is converted into format expected by OMS system.

Report supports the following output options:

  • ALV grid (each aggregation level is presented as separate line at ALV table. Object from selection screen is highlighted with yellow color. Aggregation info request is repeated for each child SSCC object)

  • Display as JSON (display response for aggregation info request without any correction)

If ALV grid output is active, it is possible to use option Full hierarchy. This option allows to identify top-level object at ATT system (for SGTIN object for example) and request aggregation information from OMS system for top-level object and receive output with full object hierarchy.

4.15    Background jobs for report processing

4.15.1    Report sending

The report /K3TUZ/OMS_DISPATCHER (could be planned as background job or run manually via transaction /K3TUZ/OMS_DISP) collects created reports with status “Waiting”, perform sequence check and send report to OMS system and update data:

  • Reporting event sending status

  • Reporting event external ID

Program works as single instance (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 DM, External ID /K3TUZ/OMS_SEND

4.15.2    Response processing

ATTP 3.0

The report /K3TUZ/OMS_RESPONSE (could be planned as background job or run manually via transaction /K3TKZ/OMS_RESPONSE) to check the processing status in Uzbekistan OMS.

ATTP 3.1 and higher

The report /STTP/SNR_CRYPTO_GET_CONF_STAT (could be planned as background job or run manually via transaction /STTP/SNR_CRYPTO_CST) to check the processing status in Uzbekistan OMS.

The report run results are stored as application log transaction SLG1, Object /STTP/, Sub object SNR, External ID /STTP/SNR_CRYPTO_GET_CONF_STAT