Configuration Guide Kazakhstan OMS Connector

Document History

Version

Changes

Effective Data

Version

Changes

Effective Data

1.0

First approved version

01-Apr-2022

2.0

Release RN_2023_02

01-May-2023

3.0

Release RN_2023_03

01-Aug-2023

4.0

Release RN_2024_04

01-Nov-2024

About This Guide

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

Solution overview

The 3Keys Kazakhstan Add-On OMS provides the solution to generate OMS message content, automate the communication and message transfer to Kazakhstan 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

Solution scope

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

Rule

Notification

Rule

Notification

BR_CRYPTO_COMM

Bus. Rule: Commissioning for Crypto Codes

BR_CRYPTO_DECOMM

Bus. Rule: Decommissioning for Crypto Codes

Z3KKZ_OMS_AGGR

Aggregation report to OMS based on aggregation event in ATTP

Z3KKZ_OMS_AGGR_MPCK

Aggregation report to OMS based on object event in ATTP

Constraints, Assumptions, Prerequisites and Dependencies

ATTP version 3.0 or higher with installed 3Keys Kazakhstan OMS Add-On and activated BC-Set as it is described in the Administration guide.

Setting up the Solution

Prerequisites

The Internet Security Research Group Root X1 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 Kazakhstan OMS.

HTTP Destination to Kazakhstan OMS

Call transaction SM59

Create a new destination:

  • RFC Destination name (for example OMS_KZ)

  • Connection Type: G – HTTP Connection to External Server

On the tab Technical Settings

  • Target Host: suzcloud.stage.ismet.kz (for sandbox OMS) or omscloud.ismet.kz (for Production OMS)

  • Service No.: 443

  • Path Prefix: no value

  • Set the HTTP Proxy Options if it is required in your organization network

On tab Logon & Security, set following:

  • Do Not Use a User: true

  • Do Not Send Logon Ticket: true

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

On the tab Special Options, set 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 Kazakhstan 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.

Maintain service paths

Maintain the service paths in the view /STTP/V_RSRVPATH via transaction SM30 (only the REST Path shall be maintained all other fields will be maintained by activating the BC-Set)

Industry Identifier

RU System

RU System Revision

REST Operation

REST Path

20 (Pharma KZ)

OMS System

283

GET_AGG_INFO

/api/v2/pharma/aggregation/info

20 (Pharma KZ)

OMS System

283

GET_CONNECTION_ID

/api/v2/integration/connection

20 (Pharma KZ)

OMS System

283

GET_EMISSION_ORDERS

/api/v2/pharma/orders

20 (Pharma KZ)

OMS System

283

GET_OMS_VERSION

/api/v2/pharma/version

20 (Pharma KZ)

OMS System

283

GET_REPORT_STATUS

/api/v2/pharma/report/info

20 (Pharma KZ)

OMS System

283

PING

/api/v2/pharma/ping

20 (Pharma KZ)

OMS System

283

SEND_AGGREGATION

/api/v2/pharma/aggregation

20 (Pharma KZ)

OMS System

283

SEND_CLOSE_ARRAY

/api/v2/pharma/buffer/close

20 (Pharma KZ)

OMS System

283

SEND_DROPOUT

/api/v2/pharma/dropout

20 (Pharma KZ)

OMS System

283

SEND_IC_ORDER

/api/v2/pharma/orders

20 (Pharma KZ)

OMS System

283

SEND_IC_RETRIEVAL

/api/v2/pharma/codes

20 (Pharma KZ)

OMS System

283

SEND_IC_STATUS

/api/v2/pharma/buffer/status

20 (Pharma KZ)

OMS System

283

SEND_USAGE

/api/v2/pharma/utilisation

20 (Pharma KZ)

OMS System

283

UPLOAD_LOGS

/api/v2/pharma/logs/upload

General Customizing

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

Parameter RR_CRYPTO_RELEV

Crypto Code relevance for all Products in this Country. This parameter is recommended to be maintained

Component

Parameter Option

Parameter Value

Component

Parameter Option

Parameter Value

SNR

KZ - for Kazakhstan

X

Parameter key RR_RU_OMS_PING

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

Component

Parameter Option

Parameter Value

Component

Parameter Option

Parameter Value

REP

20 - for Pharma

X

Parameter RR_RU_OMS_REV

OMS revision for the industry. This parameter is mandatory to be maintained

Component

Parameter Option

Parameter Value

Component

Parameter Option

Parameter Value

REP

20 - for Pharma

283

Parameter RR_RU_OMS_SAVE_RESP

Save response in AIF. This parameter is recommended to be maintained

Component

Parameter Option

Parameter Value

Component

Parameter Option

Parameter Value

REP

20 - for Pharma

X

Parameter Z3KKZ_OMS_ACTIVE

Activate 3Keys Kazakhstan OMS Add-On. This parameter is mandatory to be maintained

Component

Parameter Option

Parameter Value

Component

Parameter Option

Parameter Value

REP

no value

X

Parameter Z3KKZ_AG_MAXOBJPACK

Maximum amount of objects in one aggregation report (default value is 250 000). This parameter is optional.

Component

Parameter Option

Parameter Value

Component

Parameter Option

Parameter Value

REP

no value

amount of objects (for example 100000)

Parameter Z3KKZ_SKIP_CC_CNFCHK

Skip crypto code confirmation check during the sequence check. This parameter is optional.

Component

Parameter Option

Parameter Value

Component

Parameter Option

Parameter Value

REP

no value

X

Parameter Z3KKZ_SKIP_OM_ONLCHK

Skip online aggregation check in OMS during the sequence check. This parameter is recommended to be maintained.

Component

Parameter Option

Parameter Value

Component

Parameter Option

Parameter Value

REP

no value

X

Parameter Z3KKZ_MAX_LOG_ROWS

Maximum errors on sequence check predecessor for one report (default 10). This parameter is optional.

Component

Parameter Option

Parameter Value

Component

Parameter Option

Parameter Value

REP

no value

amount of error messages (for example 80)

Parameter Z3KKZ_OMS_PRDLINE_ID

Default production line name in the emission order and aggregation report. This parameter is optional.

Component

Parameter Option

Parameter Value

Component

Parameter Option

Parameter Value

REP

20 - for Pharma

for example: Line 1

Parameter Z3KKZ_OMS_LOCK_TRIES

The number of 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.

Component

Parameter Option

Parameter Value

Component

Parameter Option

Parameter Value

REP

no value

for example: 30

Parameter Z3KKZ_OMS_DROPREASON

Default Dropout reason in the dropout report. This parameter is optional.

Component

Parameter Option

Parameter Value

Component

Parameter Option

Parameter Value

REP

20 - for Pharma

for example: DESTRUCTION

Parameter Z3KKZ_OMS_SUBS_SC_ST

Substitute positive Response status to new value. Relevant in case OMS 3.0 is activated. This parameter is optional.

Component

Parameter Option

Parameter Value

Component

Parameter Option

Parameter Value

REP

no value

for example: SUCCESS

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

KZ_20_OMS

OMS URL Type (Pharmaceuticals KZ)

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

Save the created entry.

Serial number profile

Maintain serial number profile with transaction /STTP/C_SERPRFL - Maintain Serialization Profiles and assign to the country KZ - Kazakhstan

Country/Region groups

Maintain country/region group (for example ZR_KZ) via transaction /STTP/CUST_CTR_GRP and assign to the country KZ - Kazakhstan

Product / GTIN properties

The following product / GTIN properties can be maintained for trade items.

Property

Value

 

Description

Property

Value

 

Description

ZKZ_OMS_RMT

IMPORT - in case of import to Kazakhstan

PRODUCTION – in case of manufacturing in Kazakhstan

Optional

Release method type (optional parameter)

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

GTIN_INDUSTRY

20 - for Pharma

Mandatory

GTIN industry

BR_OWNER_GLN

<GLN>

Mandatory

Business partner GLN with company registration type ZKZ_PARTIC maintained

RR_CRYPTO_RELEV

X

Optional

GTIN is relevant for Crypto Codes. It is mandatory if parameter RR_CRYPTO_RELEV not maintained

RR_RU_PRODLINE_ID

<free text>

Optional

Production Line Identifier. It is mandatory if parameter Z3KKZ_OMS_PRDLINE_ID not maintained

RR_RU_PRODUCT_CODE

<free text>

Optional

Product Code in emission order

RR_RU_FACTORY_GLN

<GLN>

Mandatory

Business partner GLN with maintained address country code

Business partner company registrations

The following company registrations shall be maintained for the business partners for sending aggregation report to OMS system.

Property

Description

Value

ZKZ_OMSRMT

Release method type (optional)

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

IMPORT - in case of import to Kazakhstan

PRODUCTION – in case of manufacturing in Kazakhstan

ZKZ_PARTIC

Ident. Number of Taxpayer KZ OMS (mandatory)

 

Create OMS system in ATTP

Create a system (type O, system group SAP_KZ_20, business partner with maintained parameter ZKZ_PARTIC, RFC Destination created before) using transaction /STTP/COCKPIT in ATTP if the transaction Safe storage will be using the systems for maintaining OMS ID and OMS token, otherwise the system is not needed.

Safe storage transaction /STTP/RU_SAFESTORAGE for OMS parameters

Store parameter value OMSID – OMS Identifier and CLIENTTOKEN – OMS Client Token for OMS system or Industry by choosing the select options “by System” or “by Industry”. The “Life Time in Minutes” is not required and shall have empty value.

Rule processing

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

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.

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 /K3TKZ/OMS_DISPATCHER.

Background job needs to be planned for the report /K3TKZ/OMS_DISPATCHER. The sequence check results are stored as application log transaction SLG1, Object /STTP/, Sub object DM, External ID /K3TKZ/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”.

Report to get aggregation information from OMS

The report /K3TKZ/OMS_AGGR_INFO (transaction /K3TKZ/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 data 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.

Background jobs for report processing

OMS Report sending

The report /K3TKZ/OMS_DISPATCHER (could be planned as background job or run manually via transaction /K3TKZ/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 /K3TKZ/OMS_SEND

Response processing

ATTP 3.0

The report /K3TKZ/OMS_RESPONSE (could be planned as background job or run manually via transaction /K3TKZ/OMS_RESPONSE) to check the processing status in Kazakhstan 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 Kazakhstan 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