Tutorial: Executing tools in ModelBuilder
This tutorial takes you step-by-step through creating a model and executing tools in ModelBuilder. You start by adding a tool to ModelBuilder and supplying values for the tool's parameters. This constructs a process. A model is built by connecting processes.
This tutorial builds a very simple model that identifies the vegetation types near proposed roads. In the model, the roads are first buffered using values from a distance field in the roads attribute table. The output from the Buffer tool is used to clip the vegetation data to create a dataset of vegetation types within the buffer polygons.
The tutorial is composed of six broad steps:
- Copy tutorial data
- Open the map document
- Create a new model
- Add tools and data to the model
- Fill in the tool parameters
- Run the model
- Save the model
1—Copying tutorial data
It is assumed that you have installed ArcGIS for Desktop (ArcGIS for Desktop Basic, Standard, or Advanced) before you begin this tutorial. The data required for this tutorial (included on the ArcGIS for Desktop CD) by default is installed in C:\arcgis\ArcTutor. The tutorial scenario is fictitious, and the original data has been adapted for the tutorial.
- To avoid corrupting the original data, copy the ModelBuilder folder from C:\arcgis\ArcTutor to the C drive on your computer. If you are copying the data to another drive or location, make sure to use that location for all the steps below.
2—Opening the map document
Browse to the C:\ModelBuilder folder in Windows Explorer and double click the Extract Vegetation.mxd. This will start ArcMap and open the map document, or
- Start ArcMap by clicking Start > All Programs > ArcGIS > ArcMap 10.2.2.
On the ArcMap - Getting Started dialog box, click Existing Maps > Browse for more.
The Open ArcMap Document dialog box appears.
- Browse to C:\ModelBuilder folder, select Extract Vegetation.mxd, and click Open.
This opens the Extract Vegetation.mxd.
3—Creating a new model
Click the ModelBuilder button on the ArcMap Standard toolbar.
This opens the ModelBuilder window for editing.
4—Adding tools and data to a model
Now that the model is open for editing, you will add two tools using the Search window:
- In ArcMap, click Geoprocessing > Search For Tools.
This opens a Search window that you can dock anywhere in ArcMap.
- On the Search window, type Buffer, then click the Search button .
The Buffer tool is listed along with other search items.
- Drag the search item Buffer (Analysis) (which represents the Buffer tool found in the Analysis toolbox) onto the ModelBuilder canvas in the white space.
This adds the tool and the output data variable to the model. The output variable is connected to the tool by a connector. Both the tool and output data are empty (without color) as none of the tool parameters have been supplied.
- Search for and add the Clip tool in the Analysis toolbox in a similar manner. If the two tools overlap, click the Auto Layout button on the ModelBuilder toolbar to arrange the tools.
- In the Catalog window, navigate to Toolboxes > System Toolboxes > Analysis Tools > Proximity. You can select Buffer and drag the tool onto the ModelBuilder canvas in the white space.
- On the ModelBuilder Standard toolbar you can click the Add Data or Tool button , and navigate to Toolboxes > System Toolboxes > Analysis Tools > Proximity. Select the Buffer tool and click Add.
5—Filling in tool parameters
Now that the tools are added to the model, you will fill in the tool parameters.
- In ModelBuilder, double-click the Buffer tool to open its tool dialog box.
- For the Input Features parameter, click the browse button and navigate to the input geodatabase (C:\ModelBuilder\ToolData\Input.gdb).
- Choose the PlanA_Roads feature class and click Add.
- Once you fill in the input features, the Output Feature Class parameter is automatically generated and filled in for you. Replace this autogenerated output name by clicking the Browse button for the Output Feature Class parameter. Navigate to the output geodatabase in the ModelBuilder folder (C:\ModelBuilder\Scratch\Output.gdb), type BufferedFC for the output name, then click Save.
- For the Distance parameter, choose the Field option and choose the Distance field from the drop-down list.
Click OK. (You don't need to fill in any other parameters.)
The input data is added as a variable to the model (the blue oval in the above illustration) and is automatically connected to the Buffer. The input variable (the blue oval), the tool (the yellow rectangle), and the output variable (the green oval) change colors to indicate that all parameter values have been supplied and the tool is ready to run. Note that clicking OK on the tool dialog box does not execute the tool in ModelBuilder.
When data or tools are added to a model, they are referred to as model elements. There are three basic types of elements: variables (such as datasets), tools, and connectors.
- Now double-click Clip to open its tool dialog box.
- For the Input Features parameter, click the Browse button and navigate to the input geodatabase (C:\ModelBuilder\ToolData\Input.gdb).
- Choose the vegtype feature class and click Add.
- For the Clip Feature parameter, click the arrow and choose BufferedFC from the drop down list. The blue recycle symbol means that BufferedFC is a variable in the model. This variable was created in the model when you added the Buffer tool.
- Click the browse button for the Output Feature Class parameter, navigate to the output geodatabase (C:\ModelBuilder\Scratch\Output.gdb), type ClippedFC for the dataset name, then click Save.
Click OK on the Clip tool dialog box.
The output variable of the Buffer tool is automatically connected (using a connector) as an input to Clip, as illustrated below.
6—Running the model
After all the parameters of the tools have been filled in, the model is ready to run.
- Before you run the model, select the ClippedFC variable, right-click, then click the Add To Display option. Setting this option ensures that when the model is run from ModelBuilder, the output ClippedFC will be added to the display in ArcMap for quick viewing of the results.
From the ModelBuilder menu, click Model > Run Entire Model.
The model runs and the output is added to the display. After the model has finished running, both the tools (the yellow rectangles) and output variables (the green ovals) show a drop shadow around them indicating that these tools have been run.
Running the model on different roads
To run the model on different roads (such as PlanB or PlanC feature classes), you have two choices:
- Double-click Buffer and navigate to another feature class, or
- Drag the data from the Catalog window onto the ModelBuilder canvas to create a new data variable, then connect this variable to Buffer. Follow the steps below to see how this works.
- On the ArcMap menu, select Geoprocessing > Geoprocessing Options.
- Ensure that the check box next to When connecting elements, display valid parameters when more than one is available is checked.
- Click OK.
- Navigate to the input geodatabase in the Catalog window.
- Choose the PlanB_Roads feature class and drag it onto the ModelBuilder canvas.
- Click the Connect button , then do the following:
- Click the PlanB_Roads variable element.
- Click the Buffer tool element. A shortcut menu appears containing the choices of available parameters for the tool.
- Choose the Input Features parameter from the list.
This connects the PlanB_Roads variable to Buffer and automatically disconnects the PlanA_Roads variable that was previously connected to the tool. The model elements lose their drop shadow, signifying that the model has not been run with the new variable you added.
- Double-click Buffer and choose the correct distance field from the PlanB_Roads feature class.
- Run the model with Model > Run Entire Model. The model runs and the output is added to the display. After the model has finished running, both the tools and output variables show a drop shadow around them indicating that these tools have been run. The existing output ClippedFC layer (from the previous run with PlanA_Roads) in the ArcMap table of contents is updated with the results from PlanB_Roads.
7—Saving a model
Saving is the last step for this tutorial. You will use the saved model in the Creating tools with ModelBuilder tutorial.
- Click the Save tool on the ModelBuilder toolbar and navigate to C:\ModelBuilder.
- A model can only be saved in a toolbox. Click the New Toolbox icon on the navigation window.
A toolbox with a default name is added in the workspace.
- Change the name to MyTools.tbx.
- Select MyTools.tbx and click Save to save the model with the default name (Model).
If you want to do some analysis with the model, you can add the Summary Statistics tool to get a summary table of affected area by vegetation type within the buffer polygons around the proposed roads.
- Use PlanA_Roads as input in the Buffer tool for this analysis.
- Find the Summary Statistics tool in the Search window.
- Drag the tool into the model.
- Double-click the Summary Statistics element to open the tool dialog box.
- For the Input Table parameter, click the arrow and choose ClippedFC with a blue recycle icon next to it from the drop down list. This recycle icon means it is a variable in the model.
- For the Output Table parameter, browse to the output geodatabase (C:\ModelBuilder\Scratch\Output.gdb), type AffectedVegetation for the name, then click Save.
- For the Statistic Field(s) parameter, choose Shape_Area from the list.
- Click the cell next to Shape_Area under Statistic Type and choose SUM from the drop down list.
- For the Case field parameter, choose VEG_TYPE from the list.
The completed Summary Statistics dialog box is illustrated below.
- Click OK.
- Confirm that the Add to Display option is checked for ClippedFC by right clicking it.
- Right click and check the Add to Display option for the AffectedVegetation variable. This will add the ouput to the display after the model runs.
- Run the model.
The output ClippedFC and the AffectedVagetation table is added to display in the ArcMap table of contents.
- Open the table by right-clicking and clicking Open.
The table shows a summary of area by vegetation type within the buffer polygons that will be affected by the proposed roads for plan A.