Locking and checking out maps

Locking a map prevents anyone from changing the map. Checking out a map allows the person who checked it out to upload changes.

Maps are not modified directly in Configuration Hub. To modify a map, you must check out the map and edit it using the map editor tool that is provided by IBM®. Checking out a map gives you the ability to upload changes to it.

A locked map can always be downloaded as read-only. If a person locks a map and then decides they want to change it, they can click Check out to check out the map without needing to unlock it first. The person who locked the map can also click Unlock it to make it available to be revised, or your company administrator (admin) or IBM Support can unlock it. Only your company administrator (admin) or IBM Support can unlock a map that was locked by someone else.

From the side navigation menu, select Company resources > Mappings. Then, to check out a map, on the Mappings page, click Action items > Check out menu for the map to display the Check out map modal. In the Check out map modal, you can enter comments in Reason for check out to indicate why you are checking out the map. Additionally, you can choose to download MRS document and other resources that are associated with the map when you check out the source map.

A checked out map can also always be downloaded as read-only. If someone checks out a map and then decides they no longer want to upload changes, they can click Undo check out if they did not upload a revised map. When you check out a map and then want to reverse that check out after you already uploaded a revised map, your company administrator (admin) or IBM Support can override the check out. Alternately, you can transfer the check out of the in-progress map to another user in your company. IBM Support can transfer the item to themselves or to another IBM Support to troubleshoot the item.

Locking and unlocking maps

You can lock a map to prevent others from working with it. A locked map needs to be unlocked before it can be revised.

About this task

A locked map can always be downloaded as read-only. If a person locks a map and then decides they want to change it, they can click Check out to check out the map without needing to unlock it first. The person who locked the map can also click Unlock it to make it available to be revised, or your company administrator (admin) or IBM Support can unlock it. Only your company administrator (admin) or IBM Support can unlock a map that was locked by someone else.

Procedure

  1. From the side navigation menu, select Company resources > Mappings. Then, click the Action items menu for the map you want to lock.
  2. From the Action items menu, select Lock. The Lock map modal is displayed.
  3. Optional: In Reason for lock, type a comment to indicate why you are locking the map.
    Important: IBM Support must add a Reason for lock.
  4. For Will you be working on this map in Config Center, click Yes if you are going to update the map externally. Click No when the map is not going to be updated externally.
    Important: If you are going to update the map externally, you must click Yes to avoid a conflict. Additionally, if the map is designated in Config Center as belonging to a Configuration Hub customer, you must lock the map and click Yes for Will you be working on this map in Config Center? to avoid a conflict.
  5. Click Lock to lock the map and prevent others from working with it.
  6. To unlock a currently locked map, in the Mappings page, click Action items > Unlock.
    Important: If you locked the map, you can click Unlock to unlock it. However, if you want to unlock a map that was not locked by you (it was locked by someone else), only your company administrator (admin) or IBM Support can unlock it. If IBM Support locks a map, it cannot be unlocked by a company administrator (admin).

Checking out maps

To modify a map, you must use the Check out function to check out the map and edit it using the map editor tool that is provided by IBM. You can check out a map to upload changes to it.

About this task

You can download a checked-out map as read-only. If you want to cancel a change that you have checked out and uploaded but not yet deployed to CTE, you can click Undo check out to return to the list page.

You can transfer the check out to another user by using the Transfer check out function. You might use the Transfer check out function if a user who checked out and worked on a map that is no longer available. This function transfers the check out to the user that you specify and maintains the progress that you made.

Procedure

  1. From the side navigation menu, select Company resources > Mappings. Then, click the Action items menu for the map you want to check out.
  2. From the Action items menu, select Check out. The Check out map modal is displayed.
  3. Be sure that the Source map checkbox is selected to download the source map.
    The non-collaborative source map is based on the latest version in production. The collaborative source map is based on the version of the map that was primed by IBM Services (version 1.1).
  4. If you want to download the MRS document that is associated with this map, select the MRS document checkbox.
    The MRS document for a non-collaborative map is based on the latest version in production. The MRS document for a collaborative map is based on the version of the map that was primed by IBM Services (version 1.1).
  5. Optional: In Reason for check out, type a comment to indicate why you are checking out the map.
  6. Click Check out to check out the map (and download the source map and associated MRS document, if selected).
    Important: The supported file extension for source map is .mxl. If the source map uses the .map file extension, use the map editor tool to save the map with the .mxl file extension before you upload the map through the user interface. Also, maps with user exits are not supported.
    Important: When you check out a collaborative map, the source map that you can download is the version that was primed by IBM Services.

Undoing map check out

You can now reverse a map that you checked out and uploaded but not yet deployed to CTE. When you check out and upload a map, then decide you no longer want to deploy to CTE, you can click the Undo check out and return to the map list page.

To undo a map checkout, use the Undo check out function.
  1. From the side navigation menu, select Company resources > Mappings. Then, click the Action items menu for the map for which you want to reverse the checkout.
  2. From the Action items menu, select Undo check out. The Confirmation modal is displayed.
  3. Click Undo to undo the checkout. The map is then available for others to work with.
If you want to cancel a change that you have checked out and uploaded, but not yet deployed to CTE, you can now use the Undo check out function to return to the map list page.
Important: All updated files are deleted from Configuration Hub as part of the undo process.

You can transfer the check out to another user by using the Transfer check out function. You might use the Transfer check out function if a user who checked out and worked on a map that is no longer available. This function transfers the check out to the user you specify and maintains the progress you made.