WO_TOOL Toolbox Guidelines

Table of Contents

1. Work Order Toolbox Introduction ....................................................................................................... 2

2. WO_TOOL@WO QA_QC .................................................................................................................... 5

3. WO_TOOL@Generate WO Map ......................................................................................................... 7

4. WO_TOOL@Generate OP Map from WO Map ................................................................................ 9

5. WO_TOOL@Add Lines WO Map ....................................................................................................... 9

6. WO_TOOL@Subtract Lines WO Map ............................................................................................. 10

7. WO_TOOL@Add Cloud Buffer WO MAP ....................................................................................... 10

Appendix A: Creating a Work Order in IMS (Citywork) ....................................................................... 12

Appendix B: Step by Step Generating WO using ICMAPPER Tool manually ..................................... 12

Appendix C: Step by Step Generating OP map from current WO map ................................................ 12

History

April 3rd, 2017 ➢ Initiated

April 10th, 2017 ➢ Added new tool WO_TOOL@Generate OP Map from WO MAP
➢ Added the orders of using the tools flow chart
➢ Added appendix header

1
WO_TOOL Toolbox Guidelines

1. Work Order Toolbox Introduction

The work order toolbox is a set of tools which help to accelerate the process of creating the work

order map using ArcMap. Intentionally, the toolbox is for CTV group only. However, the other can

also use it without or with a little bit of modifications. As of now, the toolbox has 6 tools in which 5

tools will serve for creating/modifying a map and the other tool is for doing QA/QC work orders created

in IMS. The details of these tools will be discussed later.

The toolbox can be found at:

Make sure that your ArcMap has established the folder connection to M:\ drive so that you can

fetch the tool. If not, please follow the steps as below:

Step 1: Open Catalog as in the picture below:

Step 2: Click on “Connect to Folder”

2
WO_TOOL Toolbox Guidelines

Step 3: A window is popped up, then simply navigate to the M:\ drive, and click “OK”. It’s done

the folder connection:

Please note that all the tools in this toolbox are still under development and would be updated

frequently. There are some mistakes somewhere or not generate/query information correctly.

Therefore, do the double check your work first to make sure everything perfect before giving a go for

the review.

3
WO_TOOL Toolbox Guidelines

The orders of using the tools from creating Start

work order in IMS to creating the map

Work Order Sheet

Create Work Order in

IMS (Citywork)

Using the tool

WO_TOOL@WO QA_QC
to check work order

Fix the mistake in IMS YES Is there any

(Citywork) Mistake?

NO

Using the tool

WO_TOOL@Generate WO Map
to generate map

Convert labels to annotations of

necessary layers and align the
labels, check other information

Using the tool

WO_TOOL@Generate OP Map from OM Map to
generate overall map

After the review, if any lines need added or removed, then use the tool
WO_TOOL@Add/Subtract lines WO Map accordingly

Done

4
WO_TOOL Toolbox Guidelines

2. WO_TOOL@WO QA_QC

2.1 Function Description

The main purpose of this tool is to check if we entry the correct information in IMS (Cityworks).

Basically, the tool will check a Work Order against the following information: “Submit to”,

“Supervisor”, “Project”, “Shop”, “Status”, “Project Work Order Number”. If there is any incorrect

information, the tool will highlight it in yellow to let user know that the information needs to re-check.

2.2 Usage
Step 1: Open the tool. From ArcMap, navigate to M:\HoangNguyen\WO_Toolbox.tbx. And,

double click on WO_TOOL@WO QA_QC.

Step 2: The tool interface appears. It asks for your first name or last name or full name in IMS.

And, the start/end date you create work orders. Also, if you intend to use the WO_TOOL@Generate

WO Map later, you should check the checkbox “Create File for Map” and fill out the C-Map or P-Map

number. By default, these parameters will be checked. The tool will automatically fill out your name

in the First Name textbox. If not, please let me know I will register you into the tool so that it will find

your name automatically in future. Click OK after all information filled out.

Step 3: After the tool finish running, a confirm message will appear. Just, simply click on

“Close” to close it. And, now navigate to your U:\ drive. A new file named

QC_IMS_REPORT_”NAME”.html will be created. Then, open this file by Internet Explorer (IE).

(Recommend to sign-in in IMS(cityworks) first – optional). All the suspect incorrect information will

5
WO_TOOL Toolbox Guidelines

be highlighted in yellow. If all the information is correct, you can print out all the work orders in “1

click” by clicking on “Click here!”)

6
WO_TOOL Toolbox Guidelines

3. WO_TOOL@Generate WO Map

3.1 Function Description

This tool is to generate a map using the text file created by WO_TOOL@WO QA_QC. If you

choose the option “Create file for MAP” in the previous tool, this tool will automatically find the file

and generate the MAP accordingly. This tool will do most of the works from choosing the lines, creating

buffer, merging, labeling, etc. Your job is just simply to convert the labels into notations and align them

in proper places.

3.2 Usage
Step 1: Open the tool. From ArcMap, navigate to M:\HoangNguyen\WO_Toolbox.tbx. And,

double click on WO_TOOL@Generate WO Map.

Step 2: A window appears. If your file is created by the tool WO_TOOL@ WO QA_QC, then

just need to re-check if it is the file you need. Then, click on “OK” to generate map:

If you don’t use the tool WO_TOOL@ WO QA_QC, you can create the text file MAP easily by

following steps:

Step 2.1: Open the file word Work Order that you are working on, then copy all the work order

numbers in the column “IMS W.O. No.”:

Step 2.2: Open Notepad and paste all the work order into it. Save it in the file name format:

CMAP_NUMBER WO_NUMBER MAIN_BASIN.txt. For example, C1234 WO12 AS063.txt:

7
WO_TOOL Toolbox Guidelines

Step 3: Now, the map is created. Next steps are the same as we usually do. Remembering that

the tool will also automatically fill out the Tile No, Key Map, Quadrant, Work order number,

CMap/PMap number, date, scale, etc. The only thing left is to convert the labels into the notations and

do some alignments for the text.

8
WO_TOOL Toolbox Guidelines

4. WO_TOOL@Generate OP Map from WO Map

4.1 Function Description

This tool will generate the OP map automatically from the WO Map.

4.2 Usage

Step 1: Open the WO Map. Then, open the tool. From ArcMap, navigate to

M:\HoangNguyen\WO_Toolbox.tbx. And, double click on WO_TOOL@Generate OP MAP from

WO MAP:

Step 2: From the pop-up window, just simply click on OK, then the tool will automatically

generate the OP map with the name of current WO map appended with the word “.OP”, and this map

is saved in the same folder as your current WO map. There are several optional options such as adding

a splitter line or generate the MAP in pdf format.

5. WO_TOOL@Add Lines WO Map

5.1 Function Description

Sometimes your map is missing some lines and need to update some lines. This tool will help to

Step 2: Double click on “Input Main Workorder Buffer” and choose the latest Work Order buffer

which you are working on:

9
WO_TOOL Toolbox Guidelines

Step 5: Turn off your previous buffer layer, then you have a new desired buffer layer.

6. WO_TOOL@Subtract Lines WO Map

6.1 Function Description

selectable layer:

Step4: Choose the layer from that layer that you want to eliminate from. Then, go back to model

to click on Save, Validate and Run. After the tool finishes running, turn off previous selected gravity

main and Work Order buffer. We will see the selected lines gone.

7. WO_TOOL@Add Cloud Buffer WO MAP

right click on it, then Edit:

Step2: Double click on “Input Main Workorder Buffer” and choose the latest Work Order buffer

that you are working on:

Step3: Make Gravity Main as the only selectable layer, then choose the line you want to make

the Cloud buffer. Then, go back to model to click on Save, then Validate and Run

Step4: After the tool done running, turn off some unnecessary layers and we are done!

10
WO_TOOL Toolbox Guidelines

11
WO_TOOL Toolbox Guidelines

Appendix A: Creating a Work Order in IMS (Citywork)

TBD

Appendix B: Step by Step Generating WO using ICMAPPER Tool manually

TBD

Appendix C: Step by Step Generating OP map from current WO map

TBD

Appendix D: Step by Step To Automate the whole process

12