CONTENTS
The Model Editor is a powerful tool to help your team customize and configure your Models to meet your clients’ or markets’ needs. Understanding how to use the Model Editor will streamline your workflows and put your team in a position to deliver a superior product to your competitors.
*Restricting edit access to your Model so that only company admins have edit access can be configured under "Model Options" in the Model Editor with the toggle for "Only Allow Admins to Edit This Model."
*Editing restrictions for specific users can be done in the Admin Page under the user's "Other Permissions."

You can access the Model Editor anytime from the App Tray at the upper right corner of your screen. Clicking Model Editor will open the page in a new tab. You can also access it at katapultpro.com/model-editor.
Models

When you open up the Model Editor, you can choose an existing Model or create a new one. If you choose to create a new one, you will need to enter a name and then choose between a guided or manual setup. When you choose “guided” (recommended), you will be prompted to enter relevant information and upload files such as pole loading Client Files and Catalogs if applicable.

Once you have created a new job model or have selected an existing one, you can then begin editing your model.
You can copy an existing model into a new model by clicking “Import From Catalog" in the upper right corner, and then scroll down to select an existing model, denoted by a circular icon with three dots.
There are also Katapult Pro catalogs available to import any combination of data that your model may need. For example, the Data Collection catalog provides different attributes, tools, toolsets, photo inputs, photo toolsets, quality control modules, and model options to assist with data collection. You can import the entire catalog or include a single piece (such as including just a particular attribute) by clicking on the plus sign ("+") next to it. We'll explore each component of the Model Editor (attributes, tools, toolsets, etc.), so keep reading!
Attributes

The first section of the Model Editor is Attributes. Attributes are pieces of information which determine the properties of a field in your database. Here, you can search for or create a new attribute, or view your entire list of Attributes for this Model. The red lock icon indicates a locked attribute which cannot be edited manually, and the “list+” icon (as seen to the left of the "Cable Type" attribute in the above screenshot) indicates an attribute with a picklist. Click any attribute to edit its existing structure, or the plus ("+") button to create a new attribute. (Any attribute with a lock icon, like "Bearing" in the above screenshot, are attributes that are locked down and cannot be edited.)

Attributes can be many different types:
Single Line Text - One-line text field where text values can be entered.
Single Line Text with Commit - Same as single line text, but includes an option to confirm or delete text entered.
Multi-Line Text - Multiple lines of text values can be entered.
Checkbox - True or False field, editable by checking or unchecking a box
Dropdown - Picklist that enables the correct value to be chosen from a list of options
Multi-Select Dropdown - Picklist that enables multiple values to be chosen from a list of options
Group - Groups attributes together at once so that adding one attribute to a node, section, or otherwise will add multiple values (i.e. Birthmark attribute adds Pole Height, Pole Class, and Pole Species to a node).
Table - Allows for multiple attributes to exist under one attribute, and have a subset of data within a table.
*If you selected any kind of text input as your attribute input type (i.e. single line text, single line text with commit, or multi-line text), you'll see the Placeholder Text step next. Whatever text you enter here will appear in gray in the input area when you add the attribute and don't have a value for it yet. This step is optional. Then you'll see the step for selecting what the attribute can be added to.

After selecting which type of attribute you would like to create (or entering the Placeholder Text if your attribute is a text input), select which items the Attribute can be added to. This could be Nodes (such as poles, anchors, crossovers, references, etc.) or Connections (such as aerial cables, overhead guys, slack spans, etc.) or Sections. You could also add the attribute to Photo Annotations, so it would appear on the Marker tab on a wire or insulator or equipment during data processing in the Photos view while Cable Tracing. This could also be added at the Job level, where the attribute will be shown in the Job Settings panel. You can select any combination of these entities for your new attribute to be added to.

Next you'll have the option to choose an Attribute Group - a specific category located within the Node, Connection, or Section Info panel or Job Settings panel. You can choose existing groups, create your own, or skip this step altogether.

In the fourth step, you can choose whether the attribute will be read-only or not by clicking the checkbox or clicking on "Yes" or "No." This means even users with write permissions won't be able to edit the attribute. For example, if you're importing external data into Katapult Pro that shouldn't be edited within the Maps page, you may want to make it a read-only attribute.

Answer the same way to whether or not the Attribute should be hidden when the job is in read-only mode (when the lock icon turns red and looks locked). This will hide the attribute from any external users with whom you share the job with read-only access.

Choose the priority the attribute should have when it comes to ordering it in the info panel or skip this step. The smaller the number, the higher the priority (i.e. 1 would be higher on the list than 2 or so). This step is optional.
*For single line text attributes, after the Attribute Sort Priority, you'll reach a step called Mobile Assessment Validation Options. These options allow you to specify restrictions for the text input when entered via Mobile Assessments. The Numeric Input Only option, when checked, will apply the rule that only number can be entered when setting the attribute via mobile assessment. You can also specify the maximum number of characters that can be entered. Or, you can specify the exact number of characters that should be entered. The Regex Expression field is automatically filled based on your input for the previous options, so you don't have to worry about filling this out. However, it does exist as an advanced option should you have a specific Regex Expression for validating the attribute's input. Finally, the custom error message is what will be displayed if the fielder enters input that violates the validation you just set.
*If you chose for your attribute to be a dropdown (whether dropdown or multi-select dropdown), after the Attribute Sort Priority, you will see a step called Picklists. This is where you can enter the available options for users to choose the attribute's value from. You can categorize the values into several different picklists (i.e. for Node Type, 'new anchor' and 'existing anchor' options are held under the "Anchor" list, while options like 'pole,' 'building attachment,' and 'reference' are stored under the "Osp" picklist). This is not only to organize values, but in instances such as allowing a fielder to set the value for a dropdown attribute, you can limit their options to a specific picklist of values.
Click "ADD PICKLIST +" to get started. Once you've named the picklist, click "Create Picklist." Once you have at least one picklist, the "ADD PICKLIST+" button can be found at the end of the list of existing picklist(s).
*For multi-select dropdown attributes specifically, there is an Allow Duplicate Selections option followed by the Always Display Vertically (Sortable) option. Allow Duplicate Selections, when checked, will allow the user to select a value more than once. For example, the default Sizes of Dn Guys attribute allows you to select a size (i.e. 6.6M) more than once in the case that there are several down guys with the same size.
For Always Display Vertically (Sortable), this option, when checked, will show the user's selected values in a vertical list where they can sort the order of values within the list. When this is not checked, the order of values selected won't be editable and the values will be listed horizontally and start a new row when that list gets too long.
*If you chose to create or edit a group attribute, you will have a step for deciding which attributes get added to this group. Here you can add as many attributes as you like. However, adding another group attribute here won't work. You'll have to individually add all the attributes that appear in the other group attribute in order for all of them to be added by this group attribute you are creating/editing. For example, we wouldn't be able to add the "Birthmark" group attribute to this "Pole Default Attributes" group attribute. We'd have to add "Pole Height," "Pole Class," and "Pole Species" individually to this "Pole Default Attributes" group attribute. When adding attributes to the group attribute, you can specify a default value for the attribute as well.
*For table attributes, there will be a Table Details step after the Attribute Sort Priority step. First, you'll see a checklist of options: Show Option to Duplicate, Show Option to Duplicate and Increment, Combine Similar Rows, Hide Header Rows, Hide Add New Rows, and Allow Horizontal Scroll.
Show Option to Duplicate
Details:
Checking the box for this option will display a "Duplicate" option. When the user clicks the pencil icon next to a row of the table to edit the item, an "Edit [Attribute]" window will open, and in the corner is a vertical three-dot menu from which this option can be selected.
When selected, the row will be duplicated, and the "Edit [Attribute]" window will display the data for that row in case any information needs to be changed slightly. (In this example, the Telco row is being copied and the wire spec is changed.) When all the information is correct, the user can click "Save."
Show Option to Duplicate and Increment
Details:
Similar yet different from the "Duplicate" option, when checking this option, you'll notice an additional column next to "Required" that says "+1." When checked, this means the attribute can be selected to be incremented. (In this example, the attribute that can be incremented by one is the "Position On Pole" attribute.)
As stated previously, when the user clicks the pencil icon next to a row of the table to edit the item, an "Edit [Attribute]" window will open, and in the corner is a vertical three-dot menu from which this option can be selected.
The user will be prompted to choose a field to increment and enter how many times they want to duplicate the rows.
At least one attribute must be checked in the "+1" column in order for the "Duplicate and Increment" option to work. (Checkbox attributes are not a valid candidate for incrementation.)
Note: numeric attributes are the best candidates for incrementation. For attributes with a purely numeric value, it will be incremented by 1. If it is purely alphabetic, it will take the last character and "increment" it by one (it'll replace it with the next character in terms of their ASCII codes).
Combine Similar Rows
Details:
The software will look for the same pieces of data so that duplicate results are not added, or so you do not have to worry about having to look for multiple attributes to get a total value. In the Model Editor, you will be prompted to add an attribute to hold the counter for the amount of duplicates for that row.
Note: I suggest creating a "Number of Duplicates" attribute of sorts similar to the one shown in the screenshot below to be used as the 'Quantity Counter Attribute.' (If you set the Editability Restriction to "May Not Edit," once you save, you will NOT be able to make changes to this attribute.)
Hide Header Rows
Details:
When checked, the headers of the table attribute (that contain the included attribute names) will be hidden.
Hide Add New Rows
Details:
When checked, the "Add Row +" button will be hidden from the table attribute, limiting the table to one row. The purpose of this option is to mimic the format of the Pole Tag attribute for your custom attribute.
Note: If you also check Hide Header Rows, it'll further mimic the Pole Tag format. In the above example, "Cable Type," "Company," and "Wire Spec" would be hidden.
Allow Horizontal Scroll
Details:
When checked, if you have several attributes you've included in the table, this option will allow you to scroll through your table horizontally to see all the attributes so that the table is not too compressed.
When this option is selected, you'll be asked to provide the table width (in pixels) between 400 pixels and 3000 pixels. This will set the maximum width that the table will take up. (In the above screenshot, I added 6 attributes to the table. When I set the maximum table width to 3000 pixels, the table is horizontally scrollable. When I set the maximum table width to 400 pixels, the whole table is able to fit within the Node Info window and doesn't get a horizontal scrollbar.)
After this checklist of options, you'll see a table where you can add attributes, select a default value for the attribute if desired (or you can leave it blank), a checkbox under "Display" (when checked, the attribute will be displayed in the table; otherwise it is hidden), and a checkbox under "Required" (when checked, the "Add Row +" button on the table in the Maps page will be disabled until that attribute is filled out).
There are six dots to the left that act as a handle to move the attributes to their desired order. A trash can icon is at the very right to remove that attribute from the table.

Finally, choose whether the attribute settings should be able to be edited within the Model Editor by leaving it blank and skipping the step so anyone with edit access to the Model Editor can edit it, or by selecting "May Not Edit."
*Note: if you choose "May Not Edit," no one will be able to edit the attribute, including you. This also means you won't be able to delete the attribute.
If the attribute is a dropdown or multi-select dropdown attribute, then you'll have an added option of "May Only Edit Picklist Items." This is the same as "May Not Edit," except the Picklist step is editable.
Remember, Attributes can be very helpful when delivering information to clients, changing Map Styles, and organizing data at later stages of the process.
Contact us at support@katapultengineering.com if you have any questions!
Attribute Sets

Next along the Model Editor are Attribute Sets. Attribute Sets differ from Attribute Groups. Attribute Sets are used in KMZ downloads to filter by sets of attributes (when you choose an Attribute Set to filter the KMZ download, it'll only show those attributes in the Attribute Set chosen, ordered by priority, which can be edited). To get started with Attribute Sets, click the blue plus icon and name it.

In this example, we've named the Attribute Set 'Field Collection Data.' Use the "ADD ATTRIBUTE +" option to add as many attributes to the Attribute Set as you would like. The "X" is to easily replace the attribute with a different one, while the trash can icon is to remove the attribute from the Attribute Set. Finally, the blue "Finish Creating Attribute Set" is to finalize the Attribute Set you've just created.
Tools

The next section of the Model Editor deals with Map Tools. Map Tools are incredibly powerful for design both on desktop and mobile, and most Models also include custom functions and power tools that cannot be edited. You will also find Mobile Assessment Tools here. Click the blue “+” to create a new Tool.

After entering your new Tool name, you can add an icon and color, select a Tool action (see below for more details), and select a drawing action (see below for more details). Then depending on which actions you chose, you can set Node and Connection Attributes, prompt users to enter information for any attributes, and pick which Toolset(s) the new Tool should belong in. Remember, Tools can use Attributes and Map Styles to be a powerful design option for your team.
Tool Actions
Draw Node - Draws a node onto the map with no connection
Draw Connection - Draws a connection between two existing nodes on the map
Draw Node and Connection - Draws a new node and connection on the map
Break & Insert - Breaks an already existing connection and inserts a node, then rejoins the connections to that node
Insert Section - Inserts a section along an existing connection
Run QC Modules - Runs a custom QC module when clicked. See Configurable QC section for more details.
Drawing Actions
Disconnected spans - Draws spans from the same starting node
Connected spans - Draws spans from the newly drawn node
Connected multi-point (polyline) spans - Allows you to draw a span that changes directions by clicking a pivoting point, drawing the straight edge, selecting another pivoting point, etc., until you're done drawing the span and click "Esc." (Would typically be used for drawing underground.)
Toolsets

You can use the Toolsets section of the Model Editor to view existing or create new Toolsets, reorder tools in the toolset (by dragging and dropping), delete tools within your Toolset, and add shortcuts to your tools. A tool can be an option in multiple Toolsets; it's not limited to exist within only one toolset. We usually create Toolsets based on workflow and then order the tools by frequency of use or in order of a sequential step of the workflow.
Photo Element Editor
Photo Elements are the smallest building blocks for marking up photos, and they are either Points (commonly referred to as Markers) or Photo Chips. Many of the defaults that are necessary for the software's functionality are locked down. You can create new Markers and Chips yourself. Think of Markers as any height you're collecting on poles or midspans, and think of Chips as 'labels' or 'categories' of the types of photos your field technicians will be collecting. Remember, whatever you name your Chip or Marker will be shown on the Chip or Marker.

For Chips, once they're named, you can choose the color of the Chip and the color of the Letter displayed on the Chip (the outline will remain white). The "Additional Information" section is simply for a description of the Chip.

For Markers, once they're named, you can choose the color of the Marker. The "Additional Information" section is simply for a description of the Marker, which will be displayed in a toast message towards the bottom left corner of the screen when the Marker is used in a Photo Routine. (This is not the case with Chips.) "Allowed Children" is where you will list any other Markers that are allowed to nest inside this Marker. For example, Equipment Markers, Insulator Markers, Wire Markers, and Messenger Markers are all valid Markers to nest inside this Arm Marker (shown in the screenshot above). Even if the marker may not be directly nested inside the Marker, (but rather nested inside another Marker being nested in this Marker, like a Wire nesting inside an insulator to be nested inside an arm,) be sure to include it in the list.
If you want to be able to place Markers and/or Chips on photos, make sure to add them to a Photo Routine. If you want to add them with specific attributes, those attributes should be added to the Marker and/or Chip in the Photo Routines Editor as well.
Photo Routines Editor
You can use the Photo Routine Editor section of the Model Editor to create and edit different combinations for placing height markers, photo chips, and other metadata on photos. These are the options that appear in the One-Click Menu while annotating photos. The Routines can have any number of Photo Elements, and you can add specific attributes (whether those are prefilled or blank) that will be set on the Marker or Chip included in the Routine.

You can create a routine by clicking on the blue plus button, naming the routine, and then clicking on the placeholder photo to open the One-Click Menu and add your Marker(s) and/or Chip(s) you want to include in the routine. In the above example, we're placing a primary wire (leaving the company blank to be filled in when this routine is chosen) inside a dead-end insulator for any dead-end primaries that appear in a job.
Once you have your Photo Routines built, choose which Photo Toolset each Routine is available under. In the above example, we chose the "Measure" photo toolset, where most of our height annotations/routines are kept.
There's also an option to add a description to the Photo Routine and add an example image.
To finalize all these changes, click on the “Finish Creating Photo Input.”
Photo Toolsets

Photo Toolsets are groups of Photo Routines for marking up photos. This section of the Model Editor allows you to edit your existing Photo Toolsets and create new Photo Toolsets. You can also edit the keyboard shortcuts for Photo Inputs in that specific Photo Toolset. For example, the "Classify" Photo Toolset usually contains Photo Chips and calibration routines used during the classifying process. You can build Photo Toolsets based on workflows or particular markets.
Make Ready
If you're a Make Ready Engineering subscriber, you'll find the different configurable aspects of Make Ready data under the Make Ready section. The Attributes and Tools sections found here are a filtered list of attributes and tools that pertain to Make Ready. Underneath those two sections is the Clearance Rules section.
Clearance Rules
You can edit your Make Ready Clearance rules from the Model Editor. These clearances that are programmed into the software automatically calculate violations during the make ready process.

When you first click on "Clearance Rules" in the side menu of the Model Editor, a list of wires and equipment that have rulesets set up in the software will be displayed. Right-clicking on any item in the list will give you the options to rename the clearance rules for that wire/equipment, duplicate (or copy) the ruleset, or delete the ruleset. If you're looking for a specific ruleset, you can use the search bar to filter the list.

Once you find the ruleset you're looking for, click it to open up the Clearance Rules Details view. This shows the clearances for the wire or equipment at the pole and midspan.

The Rule Requirements section contains the Marker Type and Required Marker Attributes or Required Trace Attributes. Here we see the Marker Type is set to "Wire." If we want this to apply to a Fiber Com, then we need to set this under the Required Trace Attributes.

By clicking "ADD ATTRIBUTE +," we can search for the Cable Type attribute. Under the "Value" column, a picklist with Cable Type values will pop up, and we'll choose the "Fiber" option.
*Helpful Reminder:
Marker Attributes - Attributes that exist on one particular marker in Photos. An example of this is diameter. If this value changes, it only affects that one, specific marker in your job.
Trace Attributes - Attributes that exist throughout a cable's trace. Examples of this are Cable Type and Company. If these are changed, the software will propagate the change throughout the job anywhere the cable is traced.
Under the Required Marker Attributes and Required Trace Attributes, clicking the "ALL" button, which applies "AND" logic to all attributes listed, allows you to toggle it to "ANY." This gives you the opportunity to set flexible "OR" logic for markers with attributes such as "grounded=true" or "proposed_ground=true."

The Rule Exceptions section is where you can add a description of an exception to the rule to help propagate understanding of niche or complicated specification and standards rules throughout your team. You'll enter a text string, explaining the exception, and then that text is shown on the marker when it's in violation so that users performing make ready engineering can determine if the violation can be ignored or not.
In the above example, the streetlight drip loop will have an exception if other markers are in violation with it, as seen below.

When you click on the "i" in the yellow circle on the left-hand marker, underneath the violations ("S/L drip loop must be: 12" away from catv," etc.), there is a section for '* Exceptions: S/L drip loop" and the exception(s) will show there.

Back under the "Rule Requirements" section of the Clearance Rules Details view, If the "Marker Type" is set to "Wire" or "Equipment," there will be a section to edit or add Pole Clearances.
The "X" will remove the value (for example, under "Direction," it'll remove the direction that's specified)
The Distance is in inches
Direction can be set to Below, Above, or From
"Clearance Rule" is what the rule should be applied to in the software
You can check the checkbox if you want to ignore existing violations to a certain item listed
Scrolling to the bottom will show the "ADD CLEARANCE +" option to add a make ready clearance. A row
will be added to the bottom where you can fill in the distance, direction, and clearance rule, as well as mark if the existing violations should be ignored.

Midspan Clearances set the clearance rules for the midspan. In the above example, it shows that the Fiber needs to be 30 inches below an open secondary in the midspan, and this rule needs to be applied in both proposed and existing conditions. This Midspan Clearances section can be toggled on or off.
*Note - For Midspan Clearances, you can set distances between wires, and you can set distances that wires need to be over certain types of midspans. For the above example, the Fiber needs to be 186in Above the Sidewalk.
Some helpful hints with using the Clearance Rules in the Model Editor would be to remember that order matters within your Make Ready Clearance rules. For example, a more specific kind of wire or equipment will need to be placed above a less specific wire or equipment of the same type. For example, if you have a rule for a street light and a rule for a grounded street light, the "grounded" version will have that extra attribute, making it more specific, so that ruleset will need to be placed above the non-grounded ruleset.

You can move rulesets using the "Edit Clearance Rule Order" button, which gives each ruleset a 6-dot handle that you can use to click, drag, and drop rules in the order you want them to appear. Then you can "Save Clearance Rule Order" in the top right corner of the screen or choose to "Cancel."
Proposed Cable Logic
Your market may require complex logic for inserting proposed cables, using several rules for placing them. Custom proposed cable logic modules are available for making inserting proposed cables simple and determining make ready calls more quickly, simply, and effectively. Reach out to our support team if you want to take advantage of this feature.

Under "Proposed Cable Logic" is where you can choose between the "Basic" logic (which is the default for the software), or the cable logic m