Configuration Guide Kazakhstan MPT Connector
Document History
Version | Changes | Effective Date |
1.0 | First approved version 3Keys Kazakhstan MPT Add-On release 3.1 | 01-May-2022 |
- 1 1. About This Guide
- 2 2. Solution overview
- 3 3. Constraints, Assumptions, Prerequisites and Dependencies
- 4 4. Setting up the Solution
- 4.1 4.1. Connection to Java part
- 4.2 4.2. Event additional properties
- 4.3 4.3. Customizing the solution
- 4.4 4.4. Rule processing
- 4.5 4.5. Message approval
- 4.6 4.6. Sequence check
- 4.7 4.7. Configuration ID determination
- 4.8 4.8. Inbound Documents processing
- 4.9 4.9. Background jobs for report processing
- 5 5. Enhancements of the Solution
1. About This Guide
This document describes configuration steps that are required, or are optionally possible, to configure 3Keys Kazakhstan MPT in SAP ATTP system.
2. Solution overview
SAP ATTP delivers a solution to generate the reporting messages for Kazakhstan MPT system. The 3Keys Kazakhstan MPT Add-On automate the communication and message generation/transfer to Kazakhstan MPT system, visualize the message processing status with monitoring transaction, download and process the inbound documents in ATTP
2.1. Solution scope
In 3Keys Kazakhstan MPT, the following notifications are supported:
Rule | Notification |
Z3KKZ_MT | Reg.Rep.Kazakhstan MPT - General rule |
Z3KKZ_MT_0004 | Reg.Rep.Kazakhstan MPT - Import EAEU notification (IMPORT_TRANSIT) |
Z3KKZ_MT_0005 | Reg.Rep.Kazakhstan MPT - Act notification (KZ_UPD) |
Z3KKZ_MT_IMP | Reg.Rep.Kazakhstan MPT - Import notification (IMPORT) |
Z3KKZ_MT_INBOUND_MSG | Reg.Rep.Kazakhstan MPT - Inbound message |
Z3KKZ_MT_WRITEOFF | Reg.Rep.Kazakhstan MPT - WriteOff notification (MTTPS_90) |
The list of supported rule types (notifications) is planned to be enhanced in future 3Keys Kazakhstan MPT releases. Also, you can enhance supported notification by adding custom rule types (See enhancement section).
3. Constraints, Assumptions, Prerequisites and Dependencies
The Kazakhstan reporting part for MPT is configured in SAP ATTP.
4. Setting up the Solution
4.1. 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.
4.1.1. Prerequisites
For setting up an online integration to a Kazakhstan reporting system via MPT connector Java part, do the following:
· Create an HTTP Destination to MPT connector.
· Create a System (master data).
· Maintain settings.
4.1.2. Create an HTTP Destination to MPT 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 MPT)
Connection Type: G – HTTP Connection to External Server
Description: Maintain a description for the destination (for example MPT 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]/mpt/api results into:
Target Host: [URL provided by 3Keys support] (or server name in case on-premise installation)
Service No.: 443
Path Prefix: /mpt/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 MPT 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 MPT_API).
4.1.3. Create a system
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:
a. System name (for example MPT)
b. System Type: D - Domestic
c. System Group: <EMPTY>
d. Communication Type: 0 – Not Specified
e. RFC Destination: Maintain the destination name created in SM59
4.1.4. Technical user and authorization role
One technical user shall be created in ATTP and have authorization to execute web service calls. The authorization to post events is needed if inbound electronic document processing shall generate objects or post events in ATTP.
4.1.5. 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
Industry Identifier | RU System | RU System Revision | REST Operation | REST Path |
20 | NTF (Notification System) | 600 | APPROVE_INB_EDI_DOC | /api/v3/true-api/edo-api/incoming-documents/{document_id}/events/approve |
20 | NTF (Notification System) | 600 | CREATE_DOC_FORMAL | /api/v3/true-api/edo-api/outgoing-documents/formal |
20 | NTF (Notification System) | 600 | CREATE_DOC_IMPORT | /api/v3/true-api/documents/transit/import/third_countries |
20 | NTF (Notification System) | 600 | CREATE_DOC_WRITEOFF | /api/v3/true-api/documents/writeOff |
20 | NTF (Notification System) | 600 | GET_CISES_INFO | /api/v3/true-api/cises/info |
20 | NTF (Notification System) | 600 | GET_DOCUMENTS | /api/v3/true-api/doc/listV2 |
20 | NTF (Notification System) | 600 | GET_DOCUMENT_INFO | /api/v3/true-api/documents/{document_id}/info |
20 | NTF (Notification System) | 600 | GET_INB_EDI_DOC | /api/v3/true-api/edo-api/incoming-documents |
20 | NTF (Notification System) | 600 | GET_INB_EDI_DOC_BODY | /api/v3/true-api/edo-api/incoming-documents/{document_id}/base64 |
20 | NTF (Notification System) | 600 | GET_KEY | /api/v3/true-api/auth/key |
20 | NTF (Notification System) | 600 | GET_OUT_EDI_DOC | /api/v3/true-api/edo-api/outgoing-documents |
20 | NTF (Notification System) | 600 | SIGN_IN | /api/v3/true-api/auth/simpleSignIn |
20 | NTF (Notification System) | 600 | SIGN_INB_EDI_DOC | /api/v3/true-api/edo-api/incoming-documents/{document_id}/events/approve/signature |
20 | NTF (Notification System) | 600 | SIGN_OUT_EDI_DOC | /api/v3/true-api/edo-api/outgoing-documents/{document_id}/events/signature |
20 | NTF (Notification System) | 600 | WITHDRAW_OUT_EDI_DOC | /api/v3/true-api/edo-api/outgoing-documents/{document_id}/events/withdraw |
4.2. 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 3rd countries
Property | Description | Mandatory? |
ZR_KZ_CTR_CODE | Country of export according to the directory of countries | Y |
ZR_KZ_DECL_DOCUMENT | Document type: DECLARATION - Declaration of goods; STATEMENT- Application for release of goods before filing a declaration of goods | Y |
ZR_KZ_DECL_NUM | Document registration number | Y |
ZR_KZ_DECL_DATE | Document registration date in YYYY-MM-DD format | Y |
ZR_KZ_DECL_POS | Declaration item number | Y |
ZR_KZ_DECISION_CODE | The code of the decision. Possible values: 10, 11, 12, 13, 14, 20 | Y |
ZR_KZ_DECISION_DATE | Date in YYYY-MMDDThh format:mm:ssZ | Y |
ZR_KZ_CUSTOMS_CODE | Customs authority code. See also Handbook of Customs Codes | Y |
ZR_KZ_CERT_DOCUMENT | Information about the document confirming the conformity of the goods - Document Type | Y |
ZR_KZ_CERT_DOC_NUM | Information about the document confirming the conformity of the goods - Document Number | Y |
ZR_KZ_CERT_DOC_DATE | Information about the document confirming the conformity of the goods - Document Date | Y |
ZR_KZ_IMPORTER_ID | Importer tax code | Y |
ZR_KZ_IMPORTER_NAME | Importer name | Y |
ZR_KZ_PRM_DOC_NUM | Paper Document Number Notice | N |
ZR_KZ_PRM_DOC_DATE | Date of paper document Notifications in the format YYYY-MM-DD | N |
ZR_KZ_TNVED_CODE | TNVED - commodity nomenclature of foreign economic activity of the Eurasian Economic Union | Y |
Import from the EAEU
Property | Description | Mandatory? |
ZR_KZ_CORR_FLAG | Sign of a corrected Notification (new Notification as a correction of the original one)
Default = false | N |
ZR_KZ_CORR_DOC_ID | GUID of the document to which the adjustment is sent | Y - if acceptance or adjustment of the notice |
ZR_KZ_REG_DOC_NUM | Registration document number of the import notice | Y - if acceptance or adjustment of the notice |
ZR_KZ_REG_DOC_DATE | The date of the registration document, in the dd.mm.yyyy format | Y - if acceptance or adjustment of the notice |
ZR_KZ_SUPPL_CTR_CODE | Country of departure.
RU - Russia | Y |
ZR_KZ_SUPPL_ID | Identifier taxpayer (TIN, IIN, BIN and etc.) sender or equivalent | Y |
ZR_KZ_SUPPL_NAME | Name of sender (supplier) | Y |
ZR_KZ_CONS_ID | IIN/BIN of the recipient | Y |
ZR_KZ_CONS_NAME | Name of the recipient (buyer) | N |
ZR_KZ_PRM_DOC_NUM | Primary document number | N |
ZR_KZ_PRM_DOC_DATE | The date of the primary document, in the dd.mm.yyyy format | N |
ZR_KZ_EXCISE_DOC_NUM | Excise duty receipt number | Y |
ZR_KZ_EXCISE_DOC_DAT | The date of the excise duty payment, in the dd.mm.yyyy format | Y |
ZR_KZ_EXCISE_AMOUNT | Excise duty amount. Number with two decimal places | Y |
ZR_KZ_COMPL_DOC_NUM | Compliance document number | N |
ZR_KZ_COMPL_DOC_DATE | The date of the conformance document, in the dd.mm.yyyy format | N |
ZR_KZ_COMPL_DOC_TYPE | Compliance document type | N |
WriteOff
Property | Description | Mandatory? |
ZR_KZ_REASON | The reason for the withdrawal of goods from circulation with values:
(only for TG Pharma)
| Y |
ZR_KZ_PRM_DOC_NAME | Name of the primary document | Y |
ZR_KZ_PRM_DOC_NUM | Primary document number | Y |
ZR_KZ_PRM_DOC_DATE | Y | |
ZR_KZ_PARTIC_ID | Participant tax code | Y |
ZR_KZ_PARTIC_NAME | Participant name | Y |
Act of acceptance and transfer
Property | Description | Mandatory? |
ZR_KZ_CORR_FLAG | Sign of a corrected Act (new Act as a correction of the original one)
Default = false | N |
ZR_KZ_CORR_DOC_ID | GUID of the document to which the adjustment is sent | Y - if a sign of a corrected Act (correctionFlag) = true |
ZR_KZ_OPER_TYPE | Operation type:
| Y |
ZR_KZ_REG_DOC_NUM | Registration number of the document to which the adjustment is transmitted | Y - if a sign of a corrected Act (correctionFlag) = true |
ZR_KZ_REG_DOC_DATE | Date of registration of the document to which the adjustment is transferred | Y - if a sign of a corrected Act (correctionFlag) = true |
ZR_KZ_PRM_DOC_NUM | Primary document number | N |
ZR_KZ_PRM_DOC_DATE | The date of the primary document, in the dd.mm.yyyy format | N |
ZR_KZ_SUPPL_ID | IIN/BIN of the sender (supplier) | Y |
ZR_KZ_SUPPL_NAME | Name of sender (supplier) | N |
ZR_KZ_CONS_ID | IIN/BIN of the recipient (buyer) | Y |
ZR_KZ_CONS_NAME | Name of the recipient (buyer) | N |
4.3. Customizing the solution
In general, customizing is performed with following transactions:
/K3TKZ/PARAM
/K3TKZ/CUST
/K3TKZ/CONF
/K3TKZ/ATTR_MAP
4.3.1. General Customizing
The transaction /K3TKZ/PARAM contains parameters to influence the 3Keys Kazakhstan MPT. The settings will require a customizing transport. The view /K3TKZ/V_PARAM can be used with transaction SM30 for changes without customizing transport
Name | Description, Values |
MPT_SYSTEM | System name at master data for online integration Example: MPT |
MON_NAVIG_ACTIVE | Navigation to ATTP Cockpit is active for transaction /K3TKZ/DOC_MONITOR X - active |
Following the recommended minimum set of parameters
Name | Value |
MPT_SYSTEM | Example: MPT |
4.3.2. Customizing for Reports
4.3.2.1. Relevant industry
Maintain relevant industry in the transaction /K3TKZ/CUST under “Relevant industry”.
These settings are also used for assignment of customer specific industries to product groups
Field | Description, Values |
Industry | Industry relevant for connector operations |
Product group | Product group at MPT system |
Text | Free text used to describe industry |
Inbound document active | Flag to activate inbound document processing |
This mapping will be used to identify correct product group on execution True API request.
Example:
Industry | Product group | Text |
20 | Pharma | Pharmaceuticals |
4.3.2.2. Document type description
Maintain document type description in the transaction /K3TKZ/CUST under “Document Type”
Field | Description, Values |
Doc Type | Internal document type (values are predefined). Example:
|
Document Type Description | Text to be displayed at Report Monitor for document type |
MPT Document Type | TRUE API document type |
4.3.2.3. Mapping attributes
Mapping attributes in the transaction /K3TKZ/CUST under “Mapping attributes” contains attributes for each report used on notification creation. 3Keys Kazakhstan MPT connector already contains predefined mapping attributes for delivered rule types:
Field | Description, Values |
Rule Type | Rule execution type |
Notification Type | Notification type |
NS | AIF namespace. Value is common for 3Keys MPT connector: /STTC3 |
Interface | AIF interface. Unique for each rule type, example: ZKZMPT_IMP |
Version | AIF interface version. 3Keys Kazakhstan MPT connector value: 1 |
Raw Data Structure | AIF request/response structure for notification data Example: /K3TKZ/S_MPT_IMP_AIF |
SAP Data Structure | SAP structure for notification data Example: /K3TKZ/S_MPT_IMP_MSG |
MPT Document Type | Internal document type Example: 1 |
Mapper class | Mapper class to fill notification with data Example: /K3TKZ/CL_IMPORT_MAPPER |
REST Operation | REST service operation used to determine service path Example: CREATE_DOC_IMPORT |
4.3.2.4. Product Group
Product group in the transaction /K3TKZ/CUST under “Product group” contains possible values for product groups at MPT system. 3Keys Kazakhstan MPT already contains product groups, maintain additional values in case new product group added:
Field | Description, Values |
Product group | Product group from True API documentation Example: pharma |
Text | Description (used at search help) Example: Pharma |