Versions Compared

Old Version 11

changes.mady.by.user Denis Zolotarev

Saved on

compared with

New Version Current

changes.mady.by.user Denis Zolotarev

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Document History

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

Table of Contents

About This Guide

...

In 3Keys Kazakhstan 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

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

...

  • 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

...

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.

...

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

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

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

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

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

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

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

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

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

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

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

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

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

REP

no value

for example: SUCCESS

Maintain Country Communication Settings

...

  • 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.

...

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

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

...