Learning Objectivess3.amazonaws.com/VirtualGISClassroom/IntroductionToModelBuilde… · Getting to Know ArcGIS ModelBuilder Book Chapter 1: Introducing ModelBuilder . 2-4 Remember

2-1

2-2

2-3

Learning Objectives Understand what ModelBuilder is

Understand the basic components of a model

Explain the advantages and benefits of ModelBuilder

Learn how to create a custom toolbox for saving and sharing models

Copyright © 2013, eGIS Associates. All rights reserved.

Getting to Know ArcGIS ModelBuilder Book

Chapter 1: Introducing ModelBuilder

2-4

Remember - What is geoprocessing?

Manipulating geospatial data

Converting formats

Analysis

Adding fields

Joining data

Managing Data

More……


2-5

What is ModelBuilder? An interface that allows to you create workflows

that string together geoprocessing tools

The output of one tool can be used as the input to another tool in the workflow

2-6

Why Build or Use Models?

Automate repeated processes

Flowchart Analysis Process

Provide documentation for process

Provide tools others can use to perform analysis

Standardize workflows

2-7

Real World – Gilmer Co, GA Tax Assessors Problem: Two editors maintaining GIS data. Could not

afford ArcSDE.

Solution: Divide GIS data into 3 databases for editing. One North Half, One South Half, and One things that did not change often. Use Model to automate the process of combining into single GIS database for Printing, data sharing and Analysis.

ROI: ArcSDE Implementation Cost at time - $15,000.00. Model development & implementation cost - $2,400.00. Saving $12,600.00

2-8

Model elements

Data Variable Derived Variable

Tool or Script

Value Variable

2-9

Saving a Model

Must be in a Custom Toolbox

Geodatabase

TBX file

Can be shared with others

My Toolboxes

Stored in User Profile

TBX files


2-10

Model Properties

Name = Name Model is saved as

No Special Characters

Label = More descriptive name

Description provides details concerning purpose of model


2-11

Model Process States


Not Ready to run

Ready to run

Has been run

2-12

Adding Elements

Drag & Drop

Toolbox

Catalog

Table of Contents

Add Data or Tools button

From within the tool in the model


2-13

Connecting Components Use the Connect button

Define variables within the tool itself


2-14

Types of Connectors

Data

Precondition

Environment

Feedback


2-15

Preconditions Ensures a process required by another process is

completed

Indicated by dotted connector

Property of a tool/script


2-16

Running a Model in ModelBuilder

Several Ways

Model Menu

Several options

Run Button

Individual Tools or Scripts

Process State will effect some


2-17

Model Menu


2-18

Run & Validate Buttons Run Button –

Validate Entire Model -


2-19

Running Individual Tools or Scripts


2-20

Navigating in a Model

Can be large & complex

Zoom & pan tools like a map

Scroll Bars


2-21

Model Layout


Model drop down>Diagram Properties

2-22

Exercises from Book

Complete Exercises

1 A, B, C, D, E, F, & G

Each exercise takes about 10 minutes

Read each carefully


2-23

2-24

Learning Objectives Learn how to define variables as parameters

Understand Intermediate data

Learn how to run a model so it asks for user input



Chapter 2: Setting up interactive models

2-25

Why make a model interactive?

What are the benefits?

What might be some drawbacks?


2-26

Remember Variables

Input or output associated with a tool or script

Variable Types

Data

Existing

Derived

Value


2-27

What are Model Parameters?

Reference a variable

Allow for user input

Cannot reference a tool or connector


2-28

How to designate a Parameter


2-29

Model Parameter vs. Tool Parameter Model Parameter

Required User input for a Model to run

Provides input for a variable

Can be used with multiple processes

Tool Parameter

User input for a tool

Can be required or optional

Provides input for a single tool

Can be a variable in a model


2-30

Not all variables are visible


Buffer tool has 8

input

output

Distance

Units

Side Type

End type

Dissolve

Dissolve Fields

2-31

Displaying Hidden Variables


2-32

Controlling Parameter Order


2-33

Intermediate Data Temporary

Product of middle process

Normally deleted by Model

Unless run in ModelBuilder


Intermediate Data

2-34

Stand Alone Variables

Use with multiple variables

In-line substitution

%Variable Name%

110 different data types

No connectors shown


2-35

Selecting in the Map

Also called Interactive Selection

Uses Feature Set Variable Data type

Creates temporary features in memory


2-36

In-memory storage

Uses computer RAM

Faster than storing in a Geodatabase or Shapefile

Temporary

Deleted when Model completes

Not all data types supported

Needs to be managed


2-37

How to use In-memory Storage


Use “in-memory” in output path

Remember all data in-memory is deleted

2-38

Adding Results to our Map

If run from inside ModelBuilder

Add to Display

If run from outside ModelBuilder

Must be a model parameter

Enable Add result of Geoprocessing to display

Geoprocessing Options


2-39

Output Symbology


2-40

Exercises from Book

Complete Exercises

2 A, B, C, & D

See notes concerning 2C and 2D


Read each carefully

Turn in Toolbox containing models created


2-41

Exercise 2C Step 12 (10.1 different)


Instead of clicking on Add Feature Button, click on Feature_Set template.

Then draw the line as specified in step 13.

2-42

Exercise 2D Steps 9, 10, & 11


Instead of clicking on Add Feature Button, click on Feature_Set template.

Then draw the line as specified in steps.

2-43

2-44

Learning Objectives Understand the order ModelBuilder uses to run

processes

Understand different methods you can use to control the process order

Introduce Python and ArcPy Module



Chapter 3: Establishing Flow Control

2-45

Why would the order model processes run be important?


2-46

Process Run Order

None connected processes may run randomly


2-47

Control Methods

Preconditions

Model Only Tools

Calculate Value & Stop

Merge Branches

Python Scripts

Else Statements


2-48

Preconditions Revisited

Ensures a process required by another process is completed

Indicated by dotted connector

Property of a tool/script


Precondition Connector

2-49

Branching Evaluates & decides

If-elif-else Statements

Model Only Tools

Python Scripts

Greatly increases Model flexibility

Error Trapping


2-50

Model Only tools

7 of them

Only work in ModelBuilder or Models

Do not export to Python


2-51

Stop – Model Only Tool

Stops a model based on based on Specified Condition

Error Trapping

Branching


2-52

Calculate Value Tool Calculates a value for use as a variable

Returns a value based on a Python Expression

Can be simple such as 3+5 or complicated

Fn(%Variable Name%) followed by python code block


2-53

Parse Path – Model Only Tool

Splits input into one of the following:

File

Path

Name

Extension

Output used an in-line model variable


2-54

Merge Branch – Model Only Tool

Merges results of multiple branches into one variable

Takes value from first completed branch


2-55

Introducing Python

Primary Scripting Language for ArcGIS

Versatile

Extent ArcGIS Functionality

Schedule processes

ArcPy module


2-56

ArcPY Module Grants access to ArcGIS functionality

limited by license level & extensions

Includes several sub modules Mapping

Data Access

Spatial Analyst (must have extension to work)

Geostatistical (must have extension to work)

Network Analyst (must have extension to work)

Time

Most Tools include sample code in Help


2-57

Loading the ArcPy Module


2-58

Python Fundamentals

Use # sign for commenting code

Best practice include general description at beginning

Document purpose of processes & variables

Case sensitive


2-59

Variables in Python Names can include letters, numbers, &

underscore( _ )

Names cannot include special characters

First character must be a letter

Cannot contain Python keywords

Class

If

For

While

return


2-60

Data Paths in Variables

Backslashes ( \ ) reserved character

Must use one of the following:

Double backslash

Input_buf_fc = “c:\\gis\\data\\streams.shp”

Single forward slash

Input_buf_fc = “c:/gis/data/streams.shp”

Single backslash prefixed by r

Input_buf_fc= r“c:\gis\data\streams.shp”


2-61

Making Python Script Accessible

Must be in a toolbox

Copy & paste

Add Script


2-62

Exercises from Book

Complete Exercises

3 A, B, C, & D


Read each carefully

Turn in Toolbox containing models or scripts created


2-63

2-64

Learning Objectives Understand what Environmental settings are

How to control Environmental settings in ModelBuilder

Understand use of relative paths vs. hardcoded paths



Chapter 4: Working within the modeling environment

2-65

Environmental Settings

What are they?

parameters that are entered with the tool

Four Levels

Application

Tool

Model

Model process


2-66

Environments Workspace

Output Coordinates

Processing extent

XY Resolution & Tolerance

M Values

Z Values

Geodatabase

More…


2-67

Application Level

Set through Geoprocessing menu or ArcToolbox


2-68

Tool Level


2-69

Model Level


2-70

Model Process Level


2-71

Workspace Location GIS Data is stored

Folder

Network share

Geodatabase

Scratch

For intermediate data (temporary)

Use as inline variable %scratchworkspace%

Current

For final data

Use as inline variable %currentworkspace%


2-72

Managed Variables

Automatically applies model environment settings

Intermediate data sent to scratch workspace

Final data sent to current workspace


2-73

Relative Path vs. Absolute Path

Models like maps reference data sources

Use paths to reference data location

Absolute

C:\GIS\Trippville.gdb\base\parcels

Relative

..\base\parcels

Relative Paths can make sharing easier

Set under Model Properties


2-74

Set Model to use Relative Path Model Properties


2-75

Ways to share models

Users on our network or with access to it

Share toolbox

Geodatabase

Toolbox (TBX) file

Users working in field or not on our network

Share Geoprocessing Package

Export to Python Script

Custom Toolbox (TBX) file


2-76

Sharing a model via GDB or TBX

Users must be able to physically connect to data source

Users must have permissions to connect

Windows permissions

File Permissions – read, write, execute

Share Permissions – access rights

IF SDE GDB

Database access permissions


2-77

Copying a toolbox Copy and Paste from one GDB to another

Drag and Drop from one GDB to another (moves)

Copy and Paste TBX from one folder to another

Drag and drop TBX from one folder to another (move)

Right click and Save As

Can save to past versions of ArcGIS

Copy and paste individual tools, scripts or models


2-78

Geoprocessor Package GPK File

Introduced at 10.1

Includes data and tools

Tools accessed through Results Window


2-79

Exporting Model to Python

Models can export to Python Scripts

Iterators can't be exported

Model Only Tools can't be exported

2-80

Why export to Python

Easier to share with others outside your organization

Integrate with other Python Scripts

Ability to schedule tasks using Windows Scheduler

Additional functionality


2-81

Exercises from Book

Complete Exercises

4 A, B, C, & D


Read each carefully



2-82

2-83

Learning Objectives Understand difference between batch

processing and iterations

Learn how to allow a model to accept a list of inputs

Learn how to have a model run multiple times using iterations

Learn how to iterate specific processes within a model



Chapter 5: Using Multiple Inputs

Chapter 6: Using Model Iterations

2-84

Batch Processing Available with all

geoprocessing tools

Allows for multiple inputs

Generates multiple outputs


2-85

Batch Processing Grid Window


Cell Batch Grid

Add Row Delete Row

Move Rows Help

Validate Cell Values

2-86

Batch Processing in a Model


Setting to allow in ModelBuilder

What user sees when run from toolbox

2-87

Things to know & consider

At least one variable must be set to accept a list of values to allow Batch Processing

Simply right clicking and choosing Batch will not work

Recommend limiting to one branch in a single model to avoid confusion

Only variables marked as Parameters show up in Batch Processing Grid

Only variables set to accept a list of values allow for multiple inputs.


2-88

Controlling Batch Processing

Can define a list of accepted values

List can be any format ArcGIS reads such as:

Table

CSV

Feature Class

Spread Sheet

Help prevent operator error while still allowing flexibility


2-89

Iterations

Repeats model or process a number of times

Often referred to as a loop

Can be accomplished using

Model Properties

Feedback Connectors

Model Iterators

Python Scripts


2-90

Model Properties


2-91

Get Iteration Count from Variable

Will run the model based on value stored with variable

Variable can be a Model Parameter

Variable can be a calculated value

Number of features selected

Number of records in a table


2-92

Examples


Used as Iteration Count Variable

Used as Iteration Count Variable

2-93

Run Model until False Iteration

Must include a process which generates a True or False value

Boolean

0 or less False

1 or more True

Best to limit total number of iterations

Prevents Infinite or never ending loop

Similar to While or For loops


2-94

Example Model for False Iteration


Allows user to select a starting road in map

Selects other roads within 500 ft of road selected in map

Filters selected roads to only those owned by City and in either Fair or Poor condition

This section is the process to calculate the Boolean value needed to determine when you have reached the 10 mile limit

Generates a table summing the total length of roads selected

Selects all record equal to or less than 10 miles

Gets a Count of records selected

2-95

Using Feedback Variables

Feeds the results of a process as an input to a previous process

Referred to as Feedback Loop

Must limit the number of iterations

Set the number

Allow users to specify number

Calculate a value to stop the loop


2-96

Feedback Example


Parameter allows user to control number of iterations

Parameter allows user to set the buffer distance

Each result is uniquely named based on iteration

Results for Buffer tool is feed back into Buffer to be buffered again creating incremental buffers

2-97

Outputs Outputs must have different name for each

iteration

Easy to use iteration count in output name

%n% System Variable

Can use other variable values via in-line substitution


2-98

Model Iterators Has parameters which can be variables

Disables Iteration control under Model Properties


Can have only one per Model

Symbolized with Hexagon

Will not export to python

2-99

Types 12 Types

For

While

Feature Selection

Row Selection

Field Value

Multivalue

Datasets

Feature Class

Files

Raster

Tables

Workspace


2-100

Feature Class Iteration

Works it multiple data types

Shapefiles

Geodatabase

Single CAD File

Can chose specific feature type

Can use wild cards

*.shp


2-101

Feature Class Iteration Example


Gathers the list of Feature Classes in a feature dataset. Then passes each one individually into the remainder of the model.

Takes each feature class it receives from the Iterator and projects it to the Web Mercator coordinate system.

New projected FC named using in-line substitution of the Name variable from the iterator.

2-102

An even more flexible example


2-103

Iterators similar to Feature Class

Similar

Tables

Files

Rasters

Generates a list of the specified data to iterate


2-104

Multivalue Iterator

Iterates over multiple inputs of same type

Feature Class

Raster

Table

Recommend to use with multivalue variable

Allows user to specify a set of inputs


2-105

Multivalue Iterator Example


2-106

Multivalue Iterator Example


User enters list of Parcel Numbers

Value Variable stores current active Parcel Number which is fed into the model

Expression uses Value Variable via In-line substitution ([PIN] = ‘%Value%’)

Selects parcel based on Expression

Captures selected parcel’s RealKey attribute value

RealKey is precondition for Copy Rows

Selects parcels within 300 feet of selected parcel from Select by Attribute Generates new table containing list

of parcels within 300 feet.

2-107

For Iterator

Provides a starting & Ending value

Increments defined

Similar to Iterate by count or variable


2-108

For Iterator Example


Starting Value for Search Distance

Increment Value for Search Distance

Ending Value for Search Distance

Value passed for Search Distance from Iterator

Parcels selected within the specified distance of the Streams

Creates new feature class from selected Parcels that are within the specified distance of the streams.

2-109

Another For Iterator Example


2-110

While Iterator

Model runs until False condition is reached

Just like While loops in traditional Programming

Replaces Iterate until variable is false under model properties


2-111

While Iterator Example


2-112

Exercises from Book

Complete Exercises

6 A, B, C, D, E, & F


Read each carefully


On page 226 Exercise 6C step 2, it should say to check the Relative Paths box


2-113

Lesson 6 Review Batch processing allows a tool to run multiple

times using multiple inputs and generating multiple outputs. T/F

What can be used in a model to allow it to iterate multiple times?

What two elements which can be added to a model will not export to a python script?

When using iteration in a model, the exact total times a model is to be run can be set using various methods. T/F


2-114

Lesson 6 Review How many types of model iterators are there?

You want to project all the shapefiles located in a single folder to a different coordinate system. Which model iterator would work best in your model?

A. Dataset

B. Multivalue

C. Feature Class

D. Raster

When you add a model iterator to a model, model properties iteration is disabled. T/F


2-115

2-116

Learning Objectives

Understand how naming model elements can help with documentation

Learn how to create Help for you model like that found with traditional geoprocessing tools

Learn how to document processes within the model to help other model builders



Chapter 7: Building Model Documentation

2-117

Why do we want to document our models?


2-118

Types of Documentation

In Model Documentation

Variable Names

Tool Names

Script Names

Labels

Help Messages & Documentation

Model Properties

Item Description


2-119

Names – Variables, Tools & More Names can include spaces, underscores and long

names

Easier to use shorter names for in-line substitution

Parameter, name is what shows up in dialog box when model is run

Provide clue to purpose


2-120

Labels in a model

Can be free standing or linked to an element

Similar to comments found in programming code

Provide further clarification and descriptions


2-121

Label Properties


2-122

Help Documentation

Starts with Model Properties

Label & Description

Item Description for

Tools

Parameters

Variables


2-123

Item Descriptions to enhance


2-124

Item Description becomes Tool Help


2-125

Filling out the Item Description

Put some thought into it

May need graphics

May need Python code

May need Syntax examples

Nothing is specifically required


2-126

Item Description – Basic Parts

Title = Model Label

Summary = Model Description

Syntax = Model Name + Parameters

Parameter List = Model Parameters

Illustration = a graphic

(jpg, png, bmp, or gif)

Tags = Keywords


2-127

Item Description - Usage Provides suggested uses for the model

Many formatting options to create professional looking information

Provide Tips and Tricks for using the model

Provide Warnings if needed


2-128

Item Description - Syntax Provides Description for each parameter

Can include syntax examples

Expressions

Queries


2-129

Item Description – Code Samples

Provides the sample code for scripting

Not limited to only Python


2-130

Item Description – Other items

Credit = Who created the model. Who updated it and so on

Use Limitations = restrictions for use and disclaimer

Tool Sidebar Help Image = Model Graphic


2-131

Exercises from Book

Complete Exercises

7 A, & B


Read each carefully



Documents

Learning Objectivess3.amazonaws.com/VirtualGISClassroom/IntroductionToModelBuilde… · Getting to Know ArcGIS ModelBuilder Book Chapter 1: Introducing ModelBuilder . 2-4 Remember