Model Editor Manual (Version 6.0 Update)

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. Using an older version of the software? Check out our legacy documentation here.

*Restricting edit access to your Model so that only company admins have edit access can be configured by our support team. Please reach out to support@katapultengineering.com if you have any questions.

You can access the Model Editor anytime from the App Tray at the upper right 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 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, and then selecting an existing Model.

Attributes

The first section of the Model Editor is Attributes. 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 indicates an attribute with a picklist. Click any attribute to edit its existing structure, or the plus button to create a new attribute.

Attributes can be many different types. After selecting which type of attribute you would like to create, select which items the Attribute can be added to, and add it to an Attribute Group if you want it to be a part of a standard grouping. You can also select whether or not you would like the attribute to be hidden in Read-Only Mode.

Some attributes will have different options and mechanics such as adding values to a picklist. Remember, Attributes can be vary helpful when delivering information to clients, changing Map Styles, and organizing data at later stages of the process.

Refer to the legacy Model Editor documentation Attributes, or contact us at support@katapultengineering.com if you have any questions!

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 “+” to create a new Tool.

After entering your new Tool name, you can add an icon and style, select a Tool action, and select a drawing action. 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 the new Tool should belong in. Remember, Tools can use Attributes and Map Styles to be a powerful design option for your team.

Toolsets

You can use the Toolsets section of the model editor to view existing or create new Toolsets, reorder or delete Tools within your Toolset, and add shortcuts to your Tools. We usually create Toolsets based on workflow and order the Tools by frequency of use or in order of a sequential step of the workflow.

Photo Input Editor (6.0 Update)

You can use the Photo Input Editor section of the Model Editor to create and edit Photo Inputs and Routines for placing height markers, photo tags, and other metadata on photos. These Routines are any number of markers and/or tags that populate a photo by selecting the Routine from the one-click menu when annotating.

You can create a routine by clicking on the blue plus button, naming the routine, and then clicking on the placeholder photo to add your marker(s) and/or tag(s) you want to include in the routine.

Once you have your Photo Inputs and Routines built, choose which photo Toolsets each Routine is available under.

To finalize these changes, click on the “FINISH CREATING PHOTO INPUT.”

Clearance Rules

If you’re a Make Ready subscriber, you can edit your Make Ready Clearance rules from the Model Editor.

The Clearance Rules are set up the same way as they were in the previous versions of Katapult Pro with a few exceptions. We’ll discuss the changes, and you can review the legacy documentation here.

You can now click the “ALL” button to toggle to “ANY” under Required Marker and Trace Attributes. This gives you the opportunity to set flexible “or” logic for markers with attributes such as “grounded=true” or “proposed_ground=true".”

You can also add Rule Exception text to help propagate understanding of niche or complicated specification and standards rules throughout your team.

Photo Form Editor

The Photo Form Editor is now found underneath the “EXPORTS” header, where Map Print Templates and Saved View Templates can be renamed and deleted. Remember, you can learn more about the Photo Form Editor in the legacy Model Editor documentation, and you can click the following link to review Map Prints and Saved Views.

Mobile Assessments

The next section of the Model Editor is Mobile Assessments. Mobile Assessments is a Module upgrade for Katapult Pro that allows you to create custom field tools for your team to enter information from the field in a guided, step-by-step fashion. You can check out our legacy documentation for more information.

First, you’ll name your assessment and choose the icon and color for its Tool button. After selecting the proper permissions you’d like this assessment to follow, start adding Assessment Steps. Fill in the various options for the step by expanding the Step row, and then choose the Step Action. You can reorder and adjust Steps and Step Actions as needed.

Once you are finished with your Assessment Steps, click “CONTINUE” to enter you Assessment Actions which determine what happens when you use the Assessment to create a new node, assess an existing node, or complete an Assessment. You can also choose which Toolset your Assessment can be found under.

Reference Layers

Reference Layers allows you to create a reference layer, accessible in any job in the Map view. To create a new reference layer, open up your company’s default model in the Model Editor, then click the blue plus button. This will prompt you to name the new reference layer.

After you’ve named your reference layer and clicked the blue “CONTINUE,” you’ll be prompted to upload a Shapefile or CSV. If you’re uploading a Shapefile, it can be zipped or unzipped; just make sure it includes all .shp, .dbf, and .prj files containing point geometry. If you’re uploading a CSV file, make sure it has “latitude” and “longitude” columns with valid EPSG:4326 coordinates.

Once you’ve uploaded your file, you’ll move on to mapping the Layer Properties. On the left are all the properties in the source file, and displayed to the right of these properties are the attributes in Katapult Pro. You can choose what the properties in the source file will be renamed to in the Katapult Pro platform.

Next, you’ll have an option of selecting a property as a Unique Key from the source file. The unique key will make sure any additional properties added later are mapped to the right attributes on the proper nodes in the reference layer in Katapult Pro. You can skip this step for now by clicking “CONTINUE,” where you’ll continue to Map Styles.

Here under Map Styles, you can define different styles for the nodes based on their attribute values. You can change the color and size of the icon, as well as the icon itself. (You can even change this to a custom icon; uploading your icons is addressed in the next section of this manual, “Custom Icons.”) Once you’re satisfied with your Map Styles, click “CONTINUE.”

After wrapping up your Map Styles, Advanced Settings is the next step. “Max Visible Radius” is the largest radius in which the reference layer will be visible (in meters). The “Minimum Zoom Level” refers to the most zoomed out you can be to see the reference layer, with 0 being zoomed out all the way and about 30 being zoomed in all the way. These two settings are to help limit the view of layers with lots of items when zoomed out so too many features aren’t loaded at once. The final setting, the “Rendering Order,” is the order in which reference layers are rendered. If a reference layer has an order of 1, it will be loaded first, with any following layers being loaded on top of it. (If two or more layers happen to have the same rendering order, they will be rendered in order of how they were uploaded such that the most newly uploaded layer will render last and appear on top.) You can leave these settings as their default values or change them as you see fit.

Once you’re done and click “CONTINUE,” all that’s left to do is Upload the reference layer! The larger the layer you’re uploading, the longer the process will take. Do not navigate away from the window until upload is complete, or else you will lose the upload. You will get a “Saved Successfully” message on your screen when the layer is successfully uploaded and saved. Once the layer is uploaded, you can revisit it in the Model Editor to make any updates.

If you head over to the Map view from the App Tray and open your job, click on the map layers. Under “Imported Layers” if you click on the arrow to expand it, you’ll see “Manage Layers…” and by clicking on that, you’ll open a dialog. From here you’ll be able to choose the reference layer(s) you want to see on your job.

Custom Line Styles (6.0 Update)

The new Custom Line Styles feature can be found in the Model Editor under ‘Map Styles.’ Here you can add a new custom line style by first clicking on the blue plus button and naming the line style.

You can then choose components of the line (a line or a space), specify the length, and make custom combinations of these components to create a custom line style for selection in the Map Styles Editor. Finish your custom line style by clicking “FINISH CREATING CUSTOM LINE STYLE.”

Custom Icons

With our recent 5.1 update, uploading an SVG for your own custom icons to use in the map styles is now possible. This means more options for customizing the look and feel of your project.

Underneath “FILES,” you’ll find the “CUSTOM ICONS” section. To add a new icon, click the blue plus button, and enter a name for the icon.

After clicking the “CONTINUE” prompt, you’ll have the option to upload an SVG file. Make sure this file is under 3KB and is a valid SVG file. If you want control over changing the color of the icon, ensure that the icon has no fill.

Click “Choose File” to navigate to and open your custom icon’s SVG file. After uploading the icon, you can add it to your personalized icon collection.

If you don’t already have any icon collections, you can click on “EDIT ICON COLLECTIONS.”

You’ll then be prompted to create a name for the collection, and click on the blue plus button to add it. Once you’re done adding the Icon Collection(s), you can click on “CLOSE.”

These collections are a way to gather your icons into groups for an easy way to search them later and to provide efficient organization. If you don’t want to leverage the Icon Collections, you can click “SKIP” to skip this process.

To finish creating the custom icon, click “FINISH CREATING CUSTOM ICON.” You’ll get a message letting you know that your icon successfully saved.

Once the new icon is saved to your model, you can find it in the Map Styles under the job settings in the Map view (which you can navigate to via the app tray).

Click on “EDIT MAP STYLES” to open the Map Styles; under “Nodes” or “Sections,” you’ll find the icon for a particular node or section under the style rules (or add a new style if it needs to be created).

Once you click on the icon and click “MORE…,” you can scroll down to the section “Custom Icons,” where you will find your uploaded icon.

If you ever need to delete a custom icon, navigate to it in the Model Editor and select it. Towards the top right corner of your screen, you will find a “DELETE” button that you can use to remove the icon.

Configurable QC (6.0 Update)

Create your own custom quality control modules to help you and your team tackle the toughest and most complicated projects.

In the Model Editor, find the Quality Control option on the left-hand side. Create a new Quality Control module by clicking the blue plus button and naming the Quality Control module.

Then you can add warnings which, if triggered, will display a message of your choice. Type your message in the ‘Warning Text’ area. Click the dropdown arrow to specify the warning type (what part of a job the warning applies to), such as the job itself, nodes, connections, or sections. You can use the logic editor to add a filtering condition so that the warning is applied to specific jobs/nodes/connections/sections. If you’re using a data path, start at whichever entity you chose in the “Warning Type” section (job/node/connection/section). (This step is optional.) Finally, create a “Warn Condition,” which uses the logic editor to set the parameters where the warning will apply to that entity (job/node/connection/section) specified in the “Warning Type” and “Filter” steps.

For example, you can create a warning that a pole is missing a SCID attribute. You may put “Pole is missing SCID attribute” in the “Warning Text” portion. For the “Warning Type” step, you’ll say it applies to “Nodes.” For the “Filter” option, you’ll use the logic editor to say that this warning only applies to nodes with a node type of “pole.”

In the “Warn Condition” step, you’ll write a condition statement using the logic editor that says if the SCID attribute does not exist on the node, give the warning. Then you’ll click the “FINISH CREATING QUALITY CONTROL” button.

Once you have your QC modules built, you can create your own tool to run these modules. To do this, go to the Model Editor and select your model you want to edit. Go to ‘Tools,’ and click on the blue plus button to add a new tool and name it.

For the first step, you’ll be asked to select an icon and color. Then you’ll be prompted to select a Tool Action, in which you’ll choose “Run QC Modules.” Then you’ll select the module(s) you want to run. Finally, choose a Toolset to add the tool to and click on “FINISH CREATING TOOL” at the bottom of the page.

You can then run the tool to run the quality control module, and the ‘Quality Control Results’ will pop up in a window (shown in the screenshot above).

Model Options (6.0 Update)

Set defaults for a job model in the Model Editor under “Model Options.” Here you can save a Map Styles to be the default for your job model so that any job created with the job model has the selected Map Styles by default. You can also set defaults for Map Labels, Mobile Map Labels, and Photo Labels.

Thanks for reading! If you have any questions about the new Model Editor, contact us at support@katapultengineering.com.