Creating Message Implementation Guidelines (MIGs)

Objectives
After completing this lesson, you will be able to:

After completing this lesson, you will be able to:

  • Create a source MIG (OData) and a target MIG (SOAP)

Create Message Implementation Guidelines: Exercise Overview

Scenario

Currently, the data eCarHero provides to its supplier is in OData format. But the supplier requires a SOAP message format to easily work with the PO data. In order to accommodate the different structures of interfaces in the source and target system, you will now leverage the SAP Integration Advisor capability within SAP Integration Suite.

You will start with the definition of the source and target message implementation guidelines (MIGs) in preparation for creating the actual mapping guideline (MAG) in the following lesson. A MIG is a functional specification based on a message definition of a type system describing the (source or target) structure of a customized interface​.

Task Flow

In this exercise, you will perform the following tasks:

  • Create a source message implementation guide (MIG).
  • Enhance the source MIG.
  • Create a target MIG.
  • Enhance the target MIG.

Prerequisites

You have a running iFlow which consumes the Purchase Order API.

Create Message Implementation Guidelines

Task 1: Create Message Implementation Guidelines

Steps

  1. Create a source MIG.

    1. Access the SAP Integration Advisor via your trial account by selecting the IA capability.

    2. Choose the Library of Type Systems icon in the left navigation bar.

      A list of all type systems is displayed here. Currently, 18 are available.

    3. As the source message will have an OData format, search for OData in the search bar located on the top right. Then select the suggested SAP S/4HANA Cloud OData type system.

    4. Select the Messages tab in the top navigation bar.

    5. Search for PurchaseOrder and expand the A_PurchaseOrder result.

    6. Start creating a new MIG by choosing the bottom-left icon in the expanded A_PurchaseOrder result.

    7. Choose Skip instead of providing a sample XML file.

    8. Enter a name for the MIG. Even though you are free in your naming choice, it is recommended to use a short, meaningful name that is easily understood in the future.

      Choose Out as the direction as the source MIG describes a message that you send to a Business Partner.

      Add a short Summary.

      You can provide your business and business partner context by choosing the + icons located on the right side of the screen.

    9. Provide the following business context of eCarHero to help IA make accurate proposals:

      • Add Motor vehicles and Vehicle bodies and trailers as product classification.
      • Add Automotive as Industry Classification.
      • Add Germany as Country/Role.
      • Add Buyer as Business ProcessRole.
      • Add Create Order and Request Order as Business Process.

    10. Provide the following business partner context for eCarHero's supplier to help IA make accurate proposals:

      • Add Hand Tools and Paints and primers and finishes as product classification.
      • Add Industrial Machinery and Components as Industry Classification.
      • Add United States as Country/Role.
      • Add Supplier as Business ProcessRole.
      • Add Create Order and Request Order as Business Process.
    11. Choose Create on the bottom right.

      You will receive a success notification and be guided to an overview of the MIG you have just created.

    12. Navigate to the Structure tab in the top navigation bar to get an overview of the default nodes.

    13. Select the two top node A_PurchaseOrder and right-click to choose Select all to include every potential node for the proposal.

    14. Select Get proposal to get a recommendation on which nodes are likely to be of interest.

      The confidence score will now be available in the UI. Please note that the proposal values you receive might differ from the following screenshots as the knowledge graph is constantly being trained.

    15. Please be aware that you are free to make your own choice here or follow the example provided. For this, leave all of the nodes selected except for the following:

      • PurchasingDocumentDeletionCode
      • CreatedByUser
      • LastChangeDateTime
      • PurchasingDocumentOrigin
      • SupplyingPlant
      • ReleaseIsNotCompleted
      • PurchasingCompletenessStatus
      • IsEndOfPurposeBlocked
      • to_PurchaseOrderItem* and its sub-nodes

      Note that even though the to_PurchaseOrderItem has a high confidence and would ordinarily be selected, you should not follow the recommendation in this case as the data you are calling from the SAP API Business Hub does not include any POItem information. Therefore, mapping it makes little sense for this specific scenario.

      Generally, it should be noted that the more precise the MIGs are, the faster the creation of the subsequent MAG will be.

    16. Choose Save in the top right corner to secure your progress.

  2. Enhance the source MIG.

    You can also optionally enhance your MIG with additional information.

    1. Locate and double-click the Language node. Navigate to Codelist.

    2. Choose the + icon to add a codelist.

    3. Select From Type SystemISO → ISO 639-1 - Language code (Alpha-2 code) Code Values: 185.

    4. As we have a German car manufacturer and an American supplier, only German and English must be supported as languages. Deselect all code values and search for de and eng to select these language codes.

    5. You can view your selection by emptying the Search bar and rearranging the sequence the codes are displayed in.

    6. Repeat the steps a-e for the AddressCorrespondenceLanguage.

    7. You can also create a currency codelist in the same manner as described above for the node DocumentCurrency.

    8. Choose Save to secure your progress.

  3. Create a target MIG.

    Note
    You will now follow an alternative route to create the target MIG for demonstration purposes.
    1. Navigate to the MIG icon on the left side menu. You will be able to see the source MIG you just created here. Choose Add.

    2. You will now see all of the available Type Systems you previously viewed via the Library of Type Systems directly in your editor. As the target message will have a SOAP format, search for SOAP in the search bar located on the top right.

    3. Select the S/4HANA Cloud SOAP type system.

    4. Search for order and choose the OrderRequest message.

    5. Select the available version 1905.

    6. Skip providing an XML file.

    7. As before, enter a name for the MIG.

      Choose In as the direction from which your system receives and processes the incoming payloads.

      Add a short Summary.

      Provide your business and business partner context by choosing the + icons located on the right side of the screen. Be sure to reverse the information on the business and business partner context in comparison to the target MIG as the you are now looking at the target system.

      Provide the following business context as the supplier to help IA make accurate proposals:

      • Add Hand Tools and Paints and primers and finishes and trailers as product classification.
      • Add Industrial Machinery and Components as Industry Classification.
      • Add United States as Country/Role.
      • Add Supplier as Business ProcessRole.
      • Add Create Order and Request Order as Business Process.

      Provide the following business partner context for eCarHero to help IA make accurate proposals:

      • Add Motor vehicles and Vehicle bodies and trailers as product classification.
      • Add Automotive as Industry Classification.
      • Add Germany as Country/Role.
      • Add Buyer as Business ProcessRole.
      • Add Create Order and Request Order as Business Process.
    8. Choose Create on the bottom right. You will receive a success notification and be guided to an overview of the MIG you have just created.

    9. Navigate to Structure in the top navigation bar to get an overview of the default nodes.

    10. Select the top node OrderRequest and right-click to choose Select all to include every potential node for the proposal.

    11. Select Get proposal to get a recommendation on which nodes are likely to be of interest.

      The confidence score will be available in the UI again. Even though the confidence score is an excellent indicator for relevant information, it is meant to be just that – an indicator. As mentioned before, you do not have to abide by it and can select all information that is important to your scenario.

      Please also note again that the proposal values you receive might differ from the provided screenshots as the knowledge graph is constantly being trained.

    12. Make your own choice concerning the selection of information elements or follow the provided example. The chosen nodes based mainly on confidence can be seen here:

    13. Choose Save to secure your progress.

  4. Enhance the target MIG.

    Note
    You can again optionally enhance your target MIG with additional information. A common approach is to group logically related information into data segments and then use a so-called qualifier field that gives business meaning to the rest of the data in that segment. In other words, qualification means to explicitly model the precise semantic meaning of a generic node in a message structure. A good example is the Party node.
    1. Navigate to the MIG Codelists tab from the top menu. Choose Add.

    2. Enter CL_PARTYTYPE as ID and Codelist for Party types as Name and choose Save to save your work. Select your entry and switch to the Code Values tab in the configuration view. Choose Add.

    3. You can enter whatever values are needed for a particular scenario. For demonstration purposes, enter the following four Code Values:

      Alternatively, it is also possible to add values via an Excel spreadsheet.

    4. Choose Save and navigate back to the Structure tab. Find the data element OrderRequestOrderParty and expand it by selecting the arrow on the left.

    5. Double-click PartyType and select Codelist and then the + icon.

    6. Choose the CL_PARTYTYPE codelist you just created.

    7. Navigate to the Details tab and choose the + icon to add a qualifier to describe the group node Party more closely by creating qualified instances.

    8. You can now see that a qualifier marker has been created.

    9. Right-click on Party and select Qualify Node → SoldTo → Add.

    10. Right-click on Party again and select Duplicate Qualified Node → BillTo → Add.

      Repeat this step for the ShipTo and ShipFrom information. You can now see that the Party node is available four times.

    11. Choose Save to secure your progress.

      Another possibility for refining the message implementation guideline is to directly upload a payload, for example, to automatically select optional segments and fields in the MIG based on their use in the payload.

      Additionally, the IA offers the option to review the MIGs before moving on the MAG creation through simulating the MIG by using example data in order to review the properties of a node, selected qualifiers, and selected code values or setting a review status to describe the editing status of a node regarding its properties. Alternatively, you can compare the structure, documentation, properties, code values, status, and example values of MIGs.

Summary of the Lesson: Creating Message Implementation Guidelines (MIGs)

Summary

In this lesson you created and enhanced source and target MIGs in preparation for the MAG creation in the upcoming lesson.

Further Reading

You can find additional information about MIG creation in the following blog: https://blogs.sap.com/2018/07/13/integration-content-advisor-create-a-customized-interface-using-mig-editor/ as well as on the SAP help site: https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/enUS/9d1c1df6ab184841a3be60e46560da66.html

Please note that the choices concerning the interface specification were made with demonstration purposes in mind to show you how to model and enhance. In a productive setting, this modelling process should be performed carefully as a well-formed MIG can greatly simplify the MAG creation.

In practice, additional tools are used, such as simulating the MIG with data as well as activating the MIG to push the customized structure into the central knowledge base in an anonymized manner to train the knowledge graph.

Save progress to your learning plan by logging in or creating an account