Hierarchy
BBPCRM (Software Component) BBPCRM⤷
CRM (Application Component) Customer Relationship Management⤷
CRM_APPLICATION (Package) All CRM Components Without Special Structure Packages⤷
NBAS (Package) Appl. development Hospital System master data, catalogs
IMG Activity
| ID | SIMG_ISHCM_GD_CUFO | Create Customer Message Formats |
| Transaction Code | S_KK4_74000161 | IMG Activity: SIMG_ISHCM_GD_CUFO |
| Created on | 19990816 | |
| Customizing Attributes | SIMG_ISHCM_GD_CUFO | Create Customer Message Formats |
| Customizing Activity | SIMG_ISHCM_GD_CUFO | Create Customer Message Formats |
Document
| Document Class | SIMG | Hypertext: Object Class - Class to which a document belongs. |
| Document Name | SIMG_ISHCM_GD_CUFO |
IS-HCM Creating customer-specific message formats
This documentation describes how to create customer-specific message formats with reference to SAP formats within the IS-HCM module.
For this to be possible, the IS-HCM module must obviously be installed. So long as it is not possible to deliver S* formats, there is not point in creating customer-specific formats.
Attention: You should basically not make changes to predefined SAP message formats. Even if the changes you want to make are only slight, always make a copy of the SAP original and make changes only to your private copy. Always use the name ranges Z*, Y*, or X*for your "customer" objects!
Customer-defined message segments without reference to SAP message segments are a case apart. These completely customer-defined formats are created in the customer name space 900-999 of the segment number. This is why they they are known as "nine-hundred" formats.
You have to create all "nine-hundered" formats directly in the format and control table. To do this requires specialized knowledge. Since there is no reference to SAP formats, you cannot do this using the function "Create with Template".
SAP recommends that you check carefully whether it is really necessary to create segments without reference. For instance, if case data is contained in the segment you require you can use a standard segment (the standard case segment, in this example) that only partially meets your requirements and which you then modify accordingly. This is considerably easier than creating your own format from scratch.
If this is of no assistance in dealing with your particular needs, please seek expert advice. If you've no experience in this area, you'll almost certainly need help.
The following documentation describes how to create customer-defined message foramts with reference to SAP formats:
- Define required message format
To make the work in the following steps worthwhile, it is essential to have a clear picture of which format you want to implement. This can be achieved by first creating a paper reference of the required message format based on the corresponding original S* message format.
- Create a customer message type
You start by making a copy of the corresponding S* message type of SAP-HCM (or of another operational reference). When you create a message type, your message type will have a structure identical to that of the reference. Only its names are different.
The following should be taken into consideration as regards the owner code:
- All owner codes which do not start with the letters 'X', 'Y' or 'Z' are reserved for SAP!!!
- All owner codes must start with a letter (upper case only)!!!
Customer message types must be deleted using program RNCUTL11 ('Utilities').
- Maintain a customer message type (TNCT0, TNCT2)
You can change the status and the comment using Maintain message types.
Please do not make any other changes (on the detail screen)!
In general, the required changes consist in adding or deleting message segments. This can be achieved by maintaining the message type-to-segment assignment. Ensure that you only edit the message types with your customer-specific owner code (field OC).
- Create a customer message segment
You start by creating a copy of the corresponding S* message segment of SAP-HCM (or of another operational reference). When you create a message segment, your message segment will have a structure identical to that of the reference. Only its names are different.
The following should be taken into consideration as regards the owner code:
- All formats always are client-independent!!!
- All owner codes which don't begin with the letters 'X', 'Y' or 'Z' are reserved for SAP.
- All owner codes must be capitalized (there is basically only upper case)!!!
Customer message segments must be deleted using program RNCUTL11 ('Utilities').
- Maintain an SAP-HCM customer message segment (TNCS2)
You can change the status and the comment using Maintain message segment.
On the detail screen, you can include you own FORM routines for segment-specific data retrieval, formatting and update in the fields Inbound FORM / Inbound pool or Outbound FORM / Outbound pool respectively. For more information, please refer to the corresponding point below or call up the F1 help on the corresponding fields.
Please do not make any other changes (on the detail screen)!
In general, the required changes consist in adding or deleting message fields. This can be achieved by maintaining the message segment-to-field assignment. Ensure that you only edit the message segments with customer-specific owner code (field OC).
- Customer-specific conversion of HL7 field values (TNHL7)
This step is only relevant for the HL7 standard.
To enable the connection of various communication partners with different HL7 value table definitions, an HL7 customer value conversion has been made possible.
A number of conversions can be specified for each customer-specific HL7 message type and for each HL7 value table. Conversion is carried out separately for incoming and outgoing messages. This table is taken into account for each customer-specific message type.
- Customer-specific filling/conversion of field values
If really necessary, you have to program conversions yourself. Added fields must always be processed in customer-specific program coding: In the case of outbound messages, you have to read the data from the database, and place it in the new message fields. In the case of inbound messages, the new fields have to be written to the database.
This takes place in a separate FORM routine pool. RNCZOUT0 serves as the SAP template for outgoing messages and RNCZIN00 for incoming messages. The procedure is commented in these programs. Please also refer to the program documentation.
It is essential that you create your own pool in the reserved name range (starting with 'Z', 'Y' or 'X').
Important: you have to specify your FORM routine and the pool when maintaining the message segment (see point above).
- Generate customer format
Before you can use your new or changed messages types, you first have to generate the customer structure. You cannot test (use) the new format until the customer structure has been successfully generated.
The status 'S = saved' is automatically set when you create a message type or message segment.
Message types and message segments that were successfully generated are assigned the status 'T = test', i.e. they can now be tested. After the test has completed successfully, you can use the maintenance transactions to manually set this status to 'P = productive'.
If errors occur in the message types when you generate the structures, you have to use type maintenance to check whether your type(s) are involved (status 'F = incorrect'). If this is the case, check the specifications you have made.
If errors occur in the message segments when you generate the structures, you have to use segment maintenance to check whether your segment(s) are involved (status 'F = incorrect'). If this is the case, check the specifications you have made.
- Test, adjust partner agreement
To test/use the new format, you have to enter it in the 'partner agreements' (dispatch and receipt control tables).
If the customer-specific message format is used for message dispatch, you create one (or preferably more) corresponding message(s) in table NC02 and check if their format is correct.
If the customer-specific message format is used at reception, you should take receipt of a number of messages, and check whether the data is correctly formatted in the batch input session.
These checks are time consuming, but necessary.
Business Attributes
| ASAP Roadmap ID | 104 | |
| Mandatory / Optional | 3 | Nonrequired activity |
| Critical / Non-Critical | 2 | Non-critical |
| Country-Dependency | A | Valid for all countries |
Assigned Application Components
| Documentation Object Class | Documentation Object Name | Current line number | Application Component | Application Component Name |
|---|---|---|---|---|
| SIMG | SIMG_ISHCM_GD_CUFO | 0 | I010004207 | Communication |
Maintenance Objects
| Maintenance object type | C | Customizing Object |
| Assigned objects | ||||||
|---|---|---|---|---|---|---|
| Customizing Object | Object Type | Transaction Code | Sub-object | Do not Summarize | Skip Subset Dialog Box | Description for multiple selections |
| NC10 | T - Individual transaction object | NC10 | 2 | Create Message Types | ||
| NC20 | T - Individual transaction object | NC20 | 2 | Create Message Segments | ||
| IMGDUMMY | D - Dummy object | NRCM | 3 | Auxiliary Programs - Display Utilities | ||
| IMGDUMMY | D - Dummy object | ONCH | 2 | Generate Customer Structures | ||
| V_TNCI1 | V - View | SM30 | 3 | Maintain Receipt Control Without Dependency | ||
| V_TNCO1 | V - View | SM30 | 3 | Maintain Dispatch Control Without Dependency | ||
| V_TNCO2 | V - View | SM30 | 3 | Maintain Dispatch Control with Org. Unit Dependency | ||
| V_TNCS0 | V - View | SM30 | 2 | Maintain Message Segments | ||
| V_TNCS2 | V - View | SM30 | 2 | Assign Fields to Message Segments | ||
| V_TNCT0 | V - View | SM30 | 2 | Maintain Message Types | ||
| V_TNCT2 | V - View | SM30 | 2 | Assign Segments to Message Types | ||
| V_TNHL7 | V - View | SM30 | 2 | Convert Customer HL7 Values |
History
| Last changed by/on | SAP | 20021206 |
| SAP Release Created in |
