How-To - Designer - Create a Design Using CIM

Version 13

    Solution

     

    This document describes how to configure tasks in Workflow Manager to create a design using the Output CIM XML and Process CIM Message subtasks. Further information on this process is available here: WMS Integration Using CIM. Note: An accompanying knowledge base article for creating a work request using CIM is available here: How-To - Designer - Create a Work Request Using CIM

     

    Follow these steps to create a design using CIM:

     

    1. Configure a task to output the design CIM XML

    1. Start the Process Framework Administration Tool and log in.
    2. Select the Node Types tab.
    3. Select the Design Node Type.
    4. Click Add Task.
    5. Type CIM Output Design XML in the Task Name field.
    6. Type a description.
    7. Check the Task Roles that are allowed to run the task.
    8. Double click on Output CIM XML in the Available Subtasks list to send it to Selected Subtasks.
    9. Highlight Output CIM XML in the Selected Subtasks list.
    10. Highlight Output XML Path in the Parameters list.
    11. Provide a path (including the file name) to write the CIM XML to in the Parameter Values field; e.g., c:\temp\DNCIMXML.xml
    12. Click OK.
    13. Select File > Save.

     

    2. Configure a task to create a design using CIM

    1. Start the Process Framework Administration Tool and log in.
    2. Select the Node Types tab.
    3. Select the WorkRequest node type.
    4. Click Add Task.
    5. Type CIM Create Design in the Task Name field.
    6. Type a description in the Task Description field.
    7. Check the Task Roles that are allowed to run the task.
    8. Double-click Process CIM Message in the Available Subtasks list to send it to Selected Subtasks.
    9. Highlight Process CIM Message in the Selected Subtasks list.
    10. Highlight Input XML Path in the Parameters list.
    11. Provide the file path (including the file name) that DNCIMXML.xml was saved to in the Parameter Values field. (C:\temp\DNCIMXML.xml in this example)
    12. Highlight Output XML Path in the Parameters list.
    13. Provide a path to a file (including the file name) to write the results of running the task to in the Parameter Values field. (C:\temp\DNCreateResults.xml in this example)
    14. Click OK.
    15. Select File > Save.

     

    3. Output the CIM XML of a design

    1. Start ArcMap.
    2. Start Workflow Manager and log in.
    3. Create a work request.
    4. Create a design under the work request. A new design is required, otherwise any work locations and CUs in an existing design will be written to the CIM XML file.
    5. Select the design.
    6. Select CIM Output Design XML from the Available Tasks drop-down list and execute it.
    7. Check the output file for errors. (c:\temp\DNCIMXML.xml in this example)

     

    4. Edit the XML file for use in the CIM Create Design task

    1. Edit the file. (c:\temp\DNCIMXML.xml in this example)
    2. Remove the <PROCESS_MESSAGE> tag.
    3. In the <MessageHeader> section, change <mdimsg:Verb>show</mdimsg:Verb> to <mdimsg:Verb>created</mdimsg:Verb>.
    4. Under the <Design> tag, change the following:
      1. Change <cim:aliasName>???</cim:aliasName> to the name of the design. This populates the NAME field in process.MM_WMS_DESIGN.
      2. Change <cim:description>???</cim:description> to a description of the design. This populates the DESCRIPTION field in process.MM_WMS_DESIGN.
      3. Change <cim:name>nnn</cim:name> to a numeric value. This populates the ID field in process.MM_WMS_DESIGN. It must be an ID that doesn't exist yet.
      4. The <ConditionFactor> tags are for Extended Data Management. If they are changed, they must match the CODE in the domain assigned to the field.
      5. Under the <Request> tag, change the following:
        1. Change <cim:aliasName>???</cim:aliasName> to the name of the parent work request of this design. This work request must already exist.
        2. Change <cim:name>nnn</cim:name> to the ID of the parent work request of this design. This work request must already exist. This populates the WORK_REQUEST_ID field in process.MM_WMS_DESIGN.
    5. Under the <Organization.DesignRole> tag, do the following:
      1. Change <cim:name>???</cim:name> to the desired owner of the design. This populates the CURRENT_OWNER_ID field in process.MM_WMS_DESIGN. This must match the USER_NAME field in process.MM_PX_USER.
    6. Save the file.

     

    5. Create a design using the CIM Create Design task

    1. Start ArcMap.
    2. Start Workflow Manager and log in.
    3. Select My Work and create a new work request.
    4. Select the work request.
    5. Select CIM Create Design from the Available Tasks drop-down list and execute it.
    6. Check the results file (c:\temp\DNCreateResults.xml in this example) for the results of running the task. It contains an <ActivityRecord> with a <cim:status> of Succeeded or Failed. If it failed, there will also be a <cim:statusReason> tag with the error.
    7. Refresh My Work to see the new design.