Setting Up User Attributes

You want to record your own information on your Katapult Pro users, like the team someone belongs to, and see it right on the Admin page.

What is this?

A user attribute is an attribute you build in your default job model that can be added to the people in your company instead of to nodes, connections, or jobs. Once the attribute exists, you choose whether it shows up in the user info panel (where you fill in each person's value) and whether it shows up as a column in the Admin page user list (where you can read every value at a glance).

User attributes are informational. They record and display details about your users. They do not grant or restrict anything, so access is still controlled by Read Permission, Licensed, Write Permission, and the Roles options covered in our Admin Page Overview.

When would I use it?

• Your company runs multiple teams or crews in Katapult Pro and you want to see which team each user belongs to without keeping a separate spreadsheet.
• You are onboarding a batch of new users and want to record something the platform does not track on its own, like a certification level, a market, an office location, or an employee ID.

How do I use it?

Turn on Enable User Attributes

Open the App Tray in the top right corner of the page and select Project Management. In the left navigation, expand Admin and click Company Options. Scroll to the Experimental Features section and turn on the toggle for Enable User Attributes so it appears blue. 

Open your company's default model

Go back to the App Tray and select Model Editor, or go straight to katapultpro.com/model-editor. At the Choose Your Model prompt, search for and open your company's default model. The name is usually your company name followed by "Default Model," though yours may be named something else.

Create the attribute

In the Attributes section of the Model Editor, click the blue + button and give your attribute a name. Fill out the attribute steps the same way you would for any attribute. Two of them do the real work here.

• Attribute Input Type. Choose how you want the value formatted. Single Line Text is a good fit for something typed in freely. Choose Dropdown instead when you want everyone picking from the same short list of teams or locations, which keeps your values consistent and your Admin page readable.
• Attribute may be added to. Check User. This is the step that turns an ordinary attribute into a user attribute, and it is the one people miss.

The remaining steps behave exactly as described in our Model Editor Manual, and which steps you see depends on the input type you picked. When you are finished, scroll to the bottom and click Finish Creating Attribute.

Put the attribute in use on the Admin page

Open the App Tray and select Admin, or go to https://katapultpro.com/admin/. Click the gear icon in the top toolbar to open Admin Settings. Under User Attribute Settings you will see the prompt "Choose user attributes to display in the user panel:" with an Available User Attributes input beneath it. Select your new attribute there to move it into the Attributes In Use list, then click Done.

If the input tells you, "There are no available user attributes to add. You can add more in the Model Editor in your Default Model," then the model side is not finished yet. Go back and confirm that User is checked on your attribute and that the attribute lives in your default model.

Each row in Attributes In Use gives you three controls plus a handle.

• Grab handle. Drag the six-dot handle on the left to set the order your attributes appear in.
• Person icon. Check this to add the attribute to the user info panel on the right side of the Admin page. This is where you fill in each person's value, so keep it checked for any attribute you plan to populate.
• Eye icon. Check this to add the attribute as a column in the user list, to the right of the email address, so you can read every value at a glance.
• Trash can. Removes the attribute from use. This takes it off the Admin page but leaves the attribute itself in your model.

On the Admin page, click a user to open their info panel on the right. Your attribute appears in the panel below the reset password option. Enter the value, then go to the bottom of the panel and select Okay to save your changes along with any other edits you made to that user.

Repeat for each user. If you checked the eye icon, the values fill in across the user list as you go.

Tips and troubleshooting

• Nothing shows up in Available User Attributes. The most common cause is an attribute built in a job model other than your default model. Verify the attribute exists in the correct model. 
• You cannot see the gear icon or the Company Options page. Both pages are limited to company admins. Ask a company admin at your company to turn the feature on or to add the attribute for you.
• Use a dropdown when you want clean values. Free-typed text drifts fast across a long user list. "Data Collection," "data collection," and "DataCollection" all read as different values, which makes the column harder to scan.
• Removing the attribute from use does not delete anyone's values. The trash can in Admin Settings takes the attribute off the Admin page. Deleting the attribute itself happens in the Model Editor.
• This is not a permissions tool. Adding a Team attribute does not limit what that person can open or edit. Use Roles and the permission toggles on the Admin page for access, as described in the Admin Page Overview.