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 |
4.0 | Release RN_2024_04 | 01-Nov-2024 |
| Table of Contents |
|---|
1. About This Guide
...
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
...
o For example, the URL https://omscloud.aslbelgisi.uz (or https://icom-legacy-api.stage.aslbelgisi.uz - test system) results into:
Target Host: omscloud.aslbelgisi.uz
Service No.: 443
Path Prefix: no value
...
Maintain Country communication customizing if the transaction Safe storage will be using industry for maintaining OMS ID and OMS token, do the following
Call the transaction /STTP/C_CTY_URL
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.
...
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:
Call transaction /STTP/COCKPIT
Navigate to
Master Data > Systems and then Choose Display/Edit.
...
To save OMS Identifier do the following:
Call transaction /STTP/RU_SAFESTORAGE.
Select radio button
By Industry.
Select the URL type for which the OMS Identifier needs to be updated.
Select the
Parameter OMSID – OMS Identifier.
...
To save existing client token do the following:
Call transaction /STTP/RU_SAFESTORAGE.
Select radio button
By Industry.
Select the URL type for which the client token needs to be updated.
...
4.5.2 By system
Do the following:
Call transaction /STTP/RU_SAFESTORAGE.
Select radio button
By system.
Select the system name for which the OMS Identifier needs to be updated.
...
To save existing client token do the following:
Call transaction /STTP/RU_SAFESTORAGE.
Select radio button
By system.
Select the system name for which the client token needs to be updated.
...
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
...
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 |
REP
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 |
4.10 Customizing for Reports
4.10.1 Country/Region groups
Maintain country/region groups via transaction /STTP/CUST_CTR_GRP.
...
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 |
REP | Z3KUZ_OMS_AG_SEND_ID | Example: X | Send Aggregation report with Application ID prefix “00”. Use value ““ (blank) to avoid prefix if necessary. In case parameter is not maintained prefix “00” is not used. This parameter is optional. | |
REP | Z3KUZ_OMS_SUBS_SC_ST | Example: SUCCESS | Substitute positive Response status to new value. Relevant in case OMS 3.0 is activated |
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:
Country/Reg group Short description:
|
Country group Country assignment | Country:
Name:
|
This country group will be used to restrict rule execution at rule customizing.
...
BR_CRYPTO_COMM for business step commissioning
Z3KUZ_OMS_AGGR can be maintained for aggregation event with action ADD or 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)
...
The logic of the sequence check:
Check crypto codes utilization is confirmed
Check predecessor: there is no report with the same objects earlier than the current message without response (or in status Error Acknowledged)
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”.
...
The report run results are stored as application log transaction SLG1, Object /STTP/, Sub object DM, External ID /K3TUZ/OMS_SEND
...
/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) collects send reports with status “Send” and rule type Z3KUZ_OMS_AGGR, receives report status from OMS system and updates data:
...
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