Where: web portal: Secrets vault in your name menu for the key, then Configurations, New configuration and From a Katapult model for the import. Needs: the Org Admin role.
When you finish: your Katapult key is saved, Cloneable has built your configuration from your Katapult model (the object types your crews will see, the fields on each one, how they map to Katapult, and how they look on the map), and you have checked that the connection really works. Allow 30 to 60 minutes, and decide the items under Get ready first.
This article follows the training video, in the same order:
Get ready: what to have before you start.
Save your Katapult key in the Secrets vault.
Load your model from the model list.
Choose what to collect: steps 1 to 3 of the import.
Finish the import: steps 4 to 7, then what to know before your crews head out.
Check the connection: three checks that prove your key works.
Your Katapult model holds far more than you need in Cloneable. The seven import steps decide what comes across: which parts of the model, which details on each, how they match Cloneable's own objects, and how they look on the map. Each step unlocks the next, and each locks once you confirm it, so check a step before confirming rather than after.
Get ready
A Katapult user with API access turned on. Your Katapult admin switches it on for the user under Roles.
That user's API key, from the API widget on their Katapult Home page. It is long, so copy all of it.
The right model. Ask whoever built it which one is current; companies often keep several versions. Make sure someone can still edit it, because every later change starts in Katapult.
An Org Admin login for Cloneable. Otherwise the page says you do not have permission and nothing loads.
Decide these now, because step 1 cannot be changed afterwards:
Decision | Rules |
Configuration name | Letters, numbers and underscores only; spaces become underscores. Must be unused in your organization. It is added to the end of every template this import creates, so name it after the work: Project_Alpha, not Tuesday. |
Measurement unit | Metric, feet and inches, or decimal feet. Your crews see it on their phones. |
Ground line circumference | On if office reviewers need a circumference measuring tool on the pole photo. |
Which types, fields and photos your crews really need | Every field you include is something a crew reads on a phone in the sun. A type can carry sixty. Have a view before you see the whole list. |
Katapult's map style, or your own icons | Use Katapult's map style and icons if your crews already know your Katapult map. Build your own if you want the map to show states Katapult does not, such as measured or exported. You can change your mind later. |
Save your Katapult key
Open your name menu at the bottom left, then Secrets vault.
Choose Create secrets, then Add platform secrets, and pick Katapult.
Paste your key and choose Save all secrets. Cloneable never shows the value again; the list shows KATAPULT_API_KEY with its date.
Your key in the Secrets vault. The pencil (ringed) replaces it.
To replace a key later, use the pencil Edit button on it. Paste the new value and choose Save. Don't add a second key: Cloneable refuses one with the same name, keeps the old one, and the page shows no error.
Edit opens a New value box, with Save and Cancel.
Keys for other systems, and how to delete one: Store the credentials your integrations need.
Load your model
Open Configurations from the dashboard. No jobs yet? Open your name menu, then Configurations.
Choose New configuration, then From a Katapult model.
Open the Model list. It comes straight from Katapult using your saved key, so if your models appear, the key works. Pick the current model.
Choose Load model.
On the Katapult model received screen, choose Create new configuration. That screen saves nothing yet: work through all seven steps below.
New configuration, then From a Katapult model.
The New configuration menu.
Your model picked from the Model list, then Load model.
Katapult model received: choose Create new configuration.
The model list says | What it means |
A model ends in (shared) | Another company shared it with you. Pick the current model from your own. |
This Katapult API key is not allowed to read models | The key's Katapult user doesn't have API access yet. Ask your Katapult admin to turn it on. |
Katapult rejected this API key | The key is wrong, revoked or expired. Make a new one in Katapult, then use Edit on the key in the Secrets vault. |
No Katapult API key is set up yet | No key is saved. Go back to Save your Katapult key. |
Could not reach Katapult | Katapult couldn't be reached, not a key problem. Try again in a moment. |
Step 1. Name your configuration
Enter the Configuration Name. The screen checks it as you type and will not let you past until it is free. If the name is taken, even by a configuration that was deleted, add a version such as v2.
Pick the Measurement Unit.
Tick Enable ground line circumference if you want it.
Tick that you have reviewed the name, then continue.
Step 1 filled in, with Enable ground line circumference ticked.
Get this step right the first time. If you come back later, all three fields show greyed out. The unit and the checkbox can be changed later in the configuration's own settings; the name cannot, because your templates already carry it.
Step 2. Select model elements
Cloneable opens by telling you the size of the model you loaded: so many node types, connection types and pole annotation types. Use the search box; a real model has more types than fit on a screen.
Category | What it holds | Example from a real model |
Node Types | Things at a single point, grouped | Anchor: Existing Anchor, New Anchor, House |
Connection Types | Things that run between points, grouped | Aerial Cable, Overlash, Slack Span, Down Guy, Pushbrace |
Pole Annotations | Things recorded against a pole rather than as their own object | Arm, Equipment, Guying, Insulator, Pole Top, Wire |
Work through each category. Each group shows how many of its types you have picked, and you can take a whole group at once.
Tick only the types your crews use. Fielders can only place, or switch to, the types you tick here. Skip Select all so the lists on the phone stay short.
Confirm.
Ticking only the map types and connection types your crews use.
Lean toward including a type you are unsure about. An unused type is a little clutter. A missing one means coming back through this whole sequence.
Step 3. Select attributes
On screen: Select which attributes to include for each type. Attributes determine which fields appear in the generated templates.
Open the tab for each type you selected. A counter shows how many types have attributes picked so far.
Pick the attributes your crews genuinely fill in. Every one becomes a field on a phone.
Search finds a field fast, but it hides the rest of the list. Clear the search before you look for the next field.
On the pole, skip Katapult's pole height. Cloneable measures it.
On each connection type (Aerial Cable, Overlash), include validated footage and tree trim if your model has them. Choices do not copy from one type to another.
Pick the photo slots your crews are expected to fill. One real anchor type offered 24.
The birthmark photo has its own fields for class, height and species, so don't tick those again as separate attributes.
Turn on Multiple for any photo your crews take more than once.
Open the Span measurement tab too. It is the midspan to-do list, such as what a span crosses.
Confirm.
Search for a field, tick it, clear the search, then find the next one.
Image attachments: the birthmark has its own fields, and Multiple is on for photos taken more than once.
Attribute kind | What it becomes | Read the count |
Pick list | A field with a fixed set of choices | Anchor Was Installed Picklist (2) is a yes or no; Company Picklist (6) is a real choice |
Image attachment | A photo slot | Birthmark, Pole Tag, Groundline Circumference, Height Marker, Upshot |
Put Midspan Height on the span, not the pole. It is a photo slot on the cable connection type (Aerial Cable, Overlash in a real model). Leave it off pole and anchor tabs. New strand often has no midspan to capture; overlash and existing strand do. Fielders capture the reading with Measure a midspan (High Accuracy).
Step 4. Map Katapult nodes
On screen: Map your Katapult node types to standard data objects. Unmapped nodes will be imported as custom data objects.
Cloneable object | What it is for | Cloneable's guess |
Pole | Utility pole with measurements and attachments | A node type called pole or pull |
Span | Cable span between poles | A connection type called aerial cable; you can leave it on None (use defaults) |
Guy Anchor | Guy wire anchor point | Existing anchor, else new anchor. Also asks for an export connection type, down guy in a real configuration |
Check each green confirmation rather than trusting it. Pole, Span and Guy Anchor should each say Mapped to and a Katapult type. If one has no Mapped to line, pick your type from its list, unless you mean to leave Span on defaults. If your model names poles something else, nothing matches and you set it yourself.
Work down the unmapped list. Ticked comes across as a custom object; unticked does not come across at all. Underground routes are here too, and come across as one line per route.
For each ticked point, set a measurement style: none for a marker, pole or midspan for something crews measure. Lines do not get this choice.
If your crews measure reference poles, set the reference type's Measurement to Pole. Left on None, fielders can't measure it.
Tick that you reviewed your mappings, then confirm.
Pole, Span and Guy Anchor each say Mapped to, and the reference is set to measure as a Pole.
Full detail with a worked example: How your Katapult types become Cloneable objects.
Step 5. Configure visualization icons
This step decides how each object type looks on the map, on the web and in the iPhone app.
The quickest route: use Katapult's. For a new configuration, Use Katapult's map style and icons starts on. Cloneable brings across the icons, colours and rules from your Katapult model, so a pole that is a green triangle in Katapult is a green triangle in Cloneable. Underground routes come across too, with Katapult's line style.
Check that Use Katapult's map style and icons is on. It starts on for a new configuration and off when you update one.
Pick a template and check its icons look the way they do in Katapult.
Run the simulator on a rule or two. Imported rules are still rules, and the simulator is still the only place a rule that never fires shows up.
Confirm.
Use Katapult's map style and icons is on for a new configuration.
To build your own instead, turn the switch off:
Pick a template. The list shows how many icons each has; anything at one icon has only its default.
Set the base icon: what an untouched object looks like.
Add rule icons: a label, shape, stroke and fill, and a condition such as measurement_data has a value. Stack conditions if needed.
Order the rules. The first match wins and the base shows only when none match, so put the most specific rule at the top.
Run the simulator on every rule. A rule that never fires looks exactly like one you forgot to write.
Confirm.
Katapult's style shows what Katapult tracks. If you want crews to see something Katapult's icons do not show, such as which poles have been measured in Cloneable, add a rule on top of the imported icons. See Set up your map icons.
More on icons: Set up your map icons.
Step 6. Connect Katapult
On screen: Import and export default to the platform Katapult templates (Import from Katapult and V3 export to Katapult). A Katapult API key is required so they can run. You can override which trigger is used below.
Check the panel says Katapult API key connected. If it does not, the panel shows a Katapult API key field: paste your key and choose Save API key. See Store the credentials your integrations need.
Leave both triggers on their defaults unless we have told you otherwise. Import processes data coming in from Katapult; Export sends your updated data back.
Confirm & Continue.
Katapult API key connected, with the import and export triggers left as they are.
Step 7. Final review & import
Read the summary: configuration name, how many data object templates, how many node mappings, how many workflows.
Check the node mapping count against what you expect. It counts only the objects you mapped, so a Span left on defaults does not appear. A lower number than expected is your last chance to catch a missed match.
Under Map labels, you can pick a field to show beside each pole on the map, such as the SCID. See Show a label beside each pole.
Press Complete import. If you came in to change an existing configuration, the button reads Update config.
The final summary, and Map labels for showing a field beside each pole.
What happens when you save
Saving is not instant. The page names each stage: workflows, custom types, data object templates, the configuration, then a snapshot of your model.
When it finishes it says the import succeeded and takes you to your configurations list.
This does not set everything. Whether crews measure in the field, how guy wires are captured, and which integration exports go to are set next, in Set up your configuration, stage by stage.
Each save stage, then Import successful.
What you can stop doing
Because your crews collect in Cloneable, with a configuration built from your Katapult model, two back-office jobs go away:
No more associating photos. Each photo reaches Katapult on its pole, already labeled, so a birthmark arrives as a birthmark.
No more calibrating photos. Measured photos reach Katapult calibrated, with the measurement photo marked as the pole height photo.
Look at the steps your team used before, and drop the ones you no longer need. Annotation still happens in Katapult, for now.
Change your map icons later
Open your configuration, then Data templates.
Choose Edit on a template, such as your pole. It opens in a new tab.
Choose Edit icons, and set the base icon and the rules. Rules are checked from the top down, and the first match wins.
Choose Update at the top right, or your changes are lost.
More on icons: Set up your map icons.
Before your crews head out
When your Katapult model changes, change it in Katapult first, load it again, and choose Update existing configuration instead of making a new one. New fields aren't ticked for you, so tick them in step 3 and finish with Update config. See Update an existing configuration.
Pole annotations don't go back to Katapult yet, so keep annotating in Katapult.
Fields you add only in Cloneable stay in Cloneable. To send a field back to Katapult, add it to your Katapult model instead.
Check the connection
Step 6's message, Katapult API key connected, only means a key is saved. Cloneable doesn't test it against Katapult. To know it really works, check three things:
Your models load in the Model list (see Load your model).
Your Katapult jobs load when you choose Add job (or Create your first job), then Import from Katapult. Pick a job built on the same model as your configuration; on the next step, configurations made from that model are listed first. See Create a job.
A test export finishes with no issues on the Exports tab. Use a test job, because an export writes to Katapult. See Export your data.
Add job, Import from Katapult, and your Katapult jobs loading. The job list is blurred here for privacy.
One Katapult job ticked, ready to Continue.
If the jobs don't load, the list shows "Katapult jobs couldn't be loaded." with Try again. If it repeats, Katapult isn't accepting the key: make a new one in Katapult, then use Edit on the key in the Secrets vault. See "Error loading jobs" when I import from Katapult.
Changing your selections later
On the configurations list, select your configuration and open its actions menu.
Choose Edit Katapult selections…. The same seven steps reopen with your saved choices.
Acknowledge step 1 (greyed out) and change what you came to change from step 2 onwards, including switching to Katapult's map style at step 5.
New fields in your model are not ticked for you. Tick the ones you want in step 3.
Finish with Update config.
Reopening keeps what you already built. Starting a fresh import gives you a second configuration and two sets of templates to tell apart.
If something goes wrong
You see | What it means | Do this |
The name is already taken | Names must be unique; the page checks as you type | Pick another name |
Configuration is not loaded, wait and try again | The page had not finished loading when you pressed the button | Reload and walk the steps again; your saved selections come back |
The save fails partway | The page names the step and asks whether to keep or delete what it created | Tell us the configuration name and the step it named |
Related