Map process flow overview

The map process flow describes the interactions between the user, IBM® Services, processes, and the environments to which their actions apply.

A source map (map) specifies how data in one format is transformed into data in another format. Source maps must use the .mxl file extension. Additionally, maps with user exits are not supported. A compiled map provides instructions for the transformation of the data that is specified in the source map.

Map process flow

The following list describes each step of the map process flow for non-collaborative maps.

Prerequisite: Before a user can work with maps and assets, the user must fulfill these requirements:
  1. User: Create a map. For more information, see Creating maps.
  2. User: To edit an existing map, from Configuration Hub, check out the map.
  3. User: In a local environment, edit, compile, and run transformation tests on maps by using the map editor tool. Repeat these steps as necessary until you are satisfied with the map updates.
    Note: The process data values input file, if applicable, is not used when you run the transformation test by using the map editor tool.
  4. User: From Configuration Hub, if the map uses process data download the process data values input template.
  5. User: If the map uses process data, edit the process data values input template to create and upload a process data values input file that is used when the transformation test runs. When you edit the process data values input template, you add the values to the appropriate process data elements.
  6. User: In Configuration Hub, upload the revised map (source and compiled version) and an input file to the map repository.
  7. User: In Configuration Hub, to deploy to the Customer Test Environment (CTE), select Deploy to CTE.
  8. System: Process deploys the map into CTE. Configuration Hub displays a success message after deployment and the user can proceed with document flow testing in CTE.
  9. User: Deploy the map to production.
    1. In Configuration Hub, in the Deploy to production card, add deployment information in Production deployment comments.
      Important: The Production deployment comments for a map must include a successful Process ID from InFlight, in which the map was used in a successful end-to-end test in the Customer Test Environment (CTE).
    2. Click Deploy to production. Wait for the deployment process to complete and ensure that the deployment status is successful.
  10. System: Process deploys the map into production Configuration Hub displays a success message after deployment. The map becomes read-only in Configuration Hub.

Map process flow for collaborative maps

Restriction: With the introduction of the map create feature as part of the general availability (GA), the following process is no longer applicable.

Diagram showing the steps of the collaborative map process flow

The following list describes each step of the map process flow for collaborative maps.

Important: This process is used for only new map creation.
Prerequisite: Before a user can work with maps and assets, the user must fulfill these requirements:
  1. User: From the IBM Support site, create a support case to create new maps and their associated assets. Indicate the map process flow in the support case.
    • Indicate CMD in the support case if you are using a functional map as the starting point in Configuration Hub, including having a workflow in place.
    • Indicate CMC Preview in the support case if you are using a placeholder map as the starting point in Configuration Hub. Additionally, indicate CMC Preview in the support case if you are using a renamed copy of an existing production map that was running in IBM Sterling B2B Integration SaaS Production (HiSPEed).
  2. IBM Services: Develop the initial map:
    • Use the existing PER management process to review and assign tasks to Services team members.
    • Create an initial version of the map.
      • In the CMD flow, create an initial version of the map that meets the requirements of the support case.
      • In the CMC Preview flow, create an initial version of the map, by using a placeholder map as the starting point in Configuration Hub. Alternately, you can use a renamed copy of an existing production map that was running in IBM Sterling B2B Integration SaaS Production (HiSPEed).
    • Deploy the map and any associated assets into CTE.
    • Prime the map repository and transformation test environment with assets for visibility.
    • Update the support case to indicate that IBM is ready for the user's next steps in CTE.
    Important: IBM Services must make non-map updates (for example, code list updates) and coordinate in support of iterations through transformation testing and CTE document flow testing.

    For more information about this process, see Priming the Configuration Hub environment with maps and code lists.

  3. User: From Configuration Hub, check out the map.
  4. User: In a local environment, edit, compile, and run transformation tests on maps by using the map editor tool. If necessary, retrieve the processed file from InFlight in CTE. Repeat these steps as necessary until you are satisfied with the map updates.
    Note: The process data values input file, if applicable, is not used when you run the transformation test by using the map editor tool.
  5. User: From Configuration Hub, if the map uses process data download the process data values input template.
  6. User: If the map uses process data, edit the process data values input template to create and upload a process data values input file that is used when the transformation test runs. When you edit the process data values input template, you add the values to the appropriate process data elements.
  7. User: In Configuration Hub, upload the revised map (source and compiled version) and an input file to the map repository.
  8. User: In Configuration Hub, select Deploy to CTE.

    If you are working on a CMCP map, coordinate with IBM Services to determine when you can expect an end to end document flow that uses your new map to work in CTE.

  9. System: Process deploys the map into CTE. Configuration Hub displays a success message after deployment and the user can proceed with document flow testing in CTE.
  10. User: a. Submit revised map for production readiness review. To be eligible to submit the map for this review, it must be successfully deployed to CTE. While the map is being reviewed by IBM, it is read-only to the user. The result of this review is an approval or rejection for quality; it does not move the map to production.

    Then, b. Update the support case with their request for review.

  11. IBM Services: Reviews the support case, retrieves the modified assets directly from CTE, and downloads the quality report for the map.

    For more information, see Get quality report for specific map.

  12. IBM Services: Complete a production readiness review and approve or reject the review based on performance and stability. A production readiness review is not a function check.
    a. Approved
    Include brief details about the approval information. Your comments are displayed to the user in the user interface.
    b. Rejected
    Include actionable details about the rejection, which are displayed to the user in the user interface. The user can revise the map and rerun tests. The user returns to step 4 in the flow.
    Update the support case with the details of the review.

    For more information about this process, see Approve production readiness or Reject production readiness.

  13. User: Review the results of the production readiness review.
    a. Approved
    • Review any comments provided by IBM Services. Continue to revise the map if you require further changes. Return to step 4 in the flow. Or,
    • Select Submit for production deployment in Configuration Hub.
    b. Rejected
    Review the comments provided by IBM Services. Revise the map and rerun tests. Return to step 4 in the flow.
  14. User: Request to deploy the map to production.
    1. In Configuration Hub, enter comments in Input for production deployment planning for IBM Services to consider when the map is promoted to production.
    2. Click Submit for production deployment. You cannot edit the map while it is submitted for production deployment.
      Important: The Production deployment comments for a map must include a successful Process ID from InFlight, in which the map was used in a successful end-to-end test in the Customer Test Environment (CTE).
    3. From the IBM Support site, update the case to request IBM to deploy to production.

    The map becomes read-only in Configuration Hub.

  15. IBM Services: Extract the most recent version of map from CTE. Proceed with Business as Usual procedure for deploying the map and associated assets into the production environment. Update the support case with deployment success.
  16. IBM Services: Clean up the map repository. The map is removed from the Configuration Hub application.

    For more information about this process, see Post-production deployment cleanup.