Skip to main content
Data model permissions

Learn how to configure permissions in Roles for both standard and internal data models

Carly Hammond avatar
Written by Carly Hammond
Updated this week

Summary

  • "Data model permissions" are a set of permissions within Roles. Roles are how you (as a Planhat admin) can apply different access levels to groups of Users within your Planhat tenant

  • "Data model permissions" cover the standard Planhat data models such as Company and End User, but also other features/aspects such as Snippets and Sections

  • You can separately enable/disable Create, View, Update, Remove and Export permissions for the different data models

  • You also have granular control over individual properties/fields of the models

Who is this article for?

  • All Planhat Users

  • This is particularly relevant for Planhat admins/builders who configure their tenant for their team (e.g. CS Ops)

Article contents


Introduction

As we discuss in our article introducing Roles, restricting access is vital for security and control, as well as improving ease-of-use by streamlining the UI for Users, so each person only sees what's relevant to them.

Roles (which you configure within the "Settings" Global Tool) enable Planhat admins/builders to configure permissions for Users (your colleagues using Planhat).

  • Each Role can be applied to a group of Users, enabling you to efficiently apply a set of permissions to multiple Users at once.

  • Roles are typically based on positions/departments. The default Roles are: Administrator, CSM, Manager and Developer; as well as customizing these, you can also create your own additional custom Roles.

  • Roles do not cover access to individual pieces of content (Pages and Sections) - for those, you can refer to our separate documentation on Home Templates and sharing content.

  • For general information on creating Roles, see here.

In this article, we'll focus specifically on the "data model permissions" tab within Roles.

Click the image to view it enlarged

πŸ“Œ Important to note

Be aware that these permissions also exist on a whole tenant level, not just on a Role level - but the tenant-level permissions can only be viewed and edited by Planhat staff members ("Super Admins"). If you are looking for a specific permission in Roles but can't see/enable it, it's likely not turned on in your tenant - please reach out to your CSM or TAM to request access or discuss further.

So what is included within "data model permissions"? What do these permissions do? We'll go through details of specific permissions within this article, but firstly we'll summarize the basic principles.


What are data model permissions?

You are likely to be familiar with the main data models (similar to "objects" in some other tools) - Company, End User, License, Opportunity, Issue, Conversation, Asset, and so on. In "data model permissions", you can set really granular access levels for each of these models (whether the Role can create/view/update/remove/export records), as well as controlling access to their fields.

Click the image to view it enlarged

However, in addition to this, it's important to note that you'll see some other elements/features (internal models) listed within the "data model permissions", such as Pages, Sections and Snippets.

Click the image to view it enlarged

Remember that this is only one category of permissions in Roles - so if you're looking for a permission for a feature and you can't find it here, check if it's in another part of Roles (likely "workflow permissions - features" - we have a separate article about these here).


Why configure data model permissions?

Setting these permissions - so different Roles have access to different elements within Planhat ...

  • Is super useful for data security - for example, you might have a role for contractors, where you clamp down on the ability to remove or export Company records.

  • Helps keep your tenant tidy - e.g. you can make it so no one but Users with the Administrator or Manager Roles can create new fields or labels.

  • Is a way to tailor the UI for each User, by removing data/functionality that isn't relevant to them.

Having really granular permissions (with separate control for each "action", right down to the field) per model is really powerful - you can define, for example, that a User assigned a specific Role can view Invoices but not export them, or create them but not remove them. This is much more flexible than having one single "all or nothing" permission per model.


Data model permissions in detail

General principles

For each data model listed in the permissions, you use the checkboxes to define what Users (you and your colleagues) with the Role can do in Planhat - you'll be able to choose from some or all of: "Create" (add), "View", "Update" (edit), "Remove" (delete) and "Export". For example, for the Company model, this determines whether you can create Company records (i.e. Companies, such as Intercom or Nissan etc.), and so on.

Under many of the models, you'll see "x Properties" - click on the row to expand this out. For standard data models, these properties are its fields - e.g. Company Address and Company ARR.

Note that the parent model permissions affect the related property/field permissions - for example, if you disable the ability to view the Campaign model, it will also disable the ability to view Campaign fields.

Next in this article, we are going to deep-dive into a selection of the less obvious data model permissions, showing you exactly what features they are referring to, so you can understand the effects of these permissions.

πŸ“š Further reading

In this article, we are not going to describe all the standard Planhat data models - Company, End User, License, Opportunity, Issue, Conversation, etc.

For further details on what these data models represent and are used for, please refer to our separate data model article here.

πŸš€ Tip

If you're unsure what a particular permission does, as well as consulting the information in the article below, you could follow these steps:

  1. Create a test User and apply a test Role only to that.

  2. Have another browser window open that's logged into your Planhat tenant as your test User.

  3. Incrementally change permissions of the Role (using your own normal User), and check the effects in the UI of the test User.

This is a great way to really explore all the details of what each permission controls.

πŸ“Œ Note: You may need to refresh the browser window of your test User, after changing permissions in your main browser window, to get your change to apply.

You can click the images below to view them enlarged.


Activitytag

Definition

This permission controls the ability to edit and create labels (tags) that you can apply to logged activities (Conversations - e.g. Intercom chats and emails) and planned activities (Tasks). Example activity tags are "Bug", "Upsell potential" and "Important".

Use case

Tags are great for organization. You can filter on these tags when you're looking at a Company or End User Profile, and even refer to them in Formula Fields.

To ensure consistency in tagging - e.g. so you don't end up with loads of possible labels/tags, or different variations in spelling - we suggest that this permission is enabled for your Administrator and Manager Roles, but not all your "standard" Users.


Automation

Definition

Automations are a way that you can automatically act on data in Planhat, configuring processes with the general structure of "when this data change occurs, do that".

The "Automation" set of data model permissions enables you to control which Role(s) in your Planhat tenant can do what related to Automation setup.

The "App Center" is where you can create and manage your Automations in upgraded Planhat (ws.planhat.com) - both templated and custom - as well as Integrations.

Use case

It's important for some Roles to have access to configure Automations, because they are a key way you can enhance your productivity using Planhat - for example, you might have all the permissions enabled for the Administrator, Manager and potentially Developer Roles.

However, it's recommended to restrict permissions for other Users. Automations are super powerful and can quickly make widespread changes to your customer data, so you don't want everyone to have access to this in case they trigger unwanted updates.

Further details

The main "View" permission controls whether Users with the Role can see Automations within the App Center - both Automations you have created, and Automation Templates.


Comment

Definition

Using these permissions, you can turn on/off the comments that you'll see throughout Planhat, such as on planned activities (Tasks) and logged activities (Conversations), Company Profiles, and various other places in Planhat.

Use case

Adding comments can be really useful for collaboration, so we suggest you leave this set of permissions enabled for all Roles, especially "View" and "Create". Generally it's fine for everyone to be able to edit/delete comments too.


ConnectionConfig and ConnectionData

Definition

Both of these sets of permissions relate to Connections, which are part of the "App Center" (together with Integrations and Automations) - see screenshot below.

Use case

"Connections" are how you can connect your Planhat tenant to your AI provider (OpenAI, Microsoft Azure OpenAI Service, or Google PaLM 2). You can also configure custom connections.

Generally, only Roles such as Administrator and/or Developer would be involved in setting up connections; general Users shouldn't need access.

Further details

For both ConnectionConfig and ConnectionData, the "View" permission is required to show Connections in the App Center.


CustomField

Definition

These permissions relate to the ability to create/delete/update custom fields in the "Data" Global Tool.

Use case

You'll want your Administrator Role and likely your Manager Role to be able to manage custom fields in this way, but it's recommended that your standard Users don't have access to create new custom fields (to keep things tidy) or delete fields (for security).

Further details

  • This set of permissions is distinct from the ability to view/update data within fields (in Data Table Pages etc.) - that's controlled using the permissions for the relevant data model (e.g. Company).

  • The "Admin Access" workflow permission controls access to the "Data" Global Tool (as well as other features), so Roles with "Admin Access" disabled will not be able to create etc. custom fields anyway. To give access via the more granular "CustomField" data model permissions as discussed here, "Admin Access" would first need to be enabled; you can read more about this permission here.

  • If the "Create" permission for "CustomField" is disabled, this does not remove the "+ New Field" button, but will prevent you from saving a new field.


Email Template

Definition

This set of permissions enables Users to create, edit and organize email templates.

Use case

Email templates are a great way for you to save time and ensure consistency throughout your team. You may want to restrict the ability to manage email templates, so your Administrators and Managers are in control.

Further details

Even if these permissions are disabled, Users will still be able to apply existing email templates to new emails.


HealthProfile

Definition

Use these permissions to control access to "Health" within the "Data" Global Tool (under the Company model), which is where you can configure Health Profiles - the sets of rules that calculate and apply Health Scores.

Use case

With this set of permissions, you can configure whether each Role can create a new Health Profile, or update the conditions of an existing one, and so on. You'll want all these permissions enabled for Administrator and potentially Manager Roles, but not for all Roles.

Further details

  • You can read more about configuring Health Scores in upgraded Planhat (ws.planhat.com) here.

  • Even when a Role has none of these permissions enabled, Users with that Role will still be able to see the actual calculated Company Health Scores for each Company (e.g. in their Company Profiles/Previews and in Data Table Pages).

  • As we discussed earlier in this article for custom fields, the "Admin Access" workflow permission is required to be able to edit fields, and this includes "Health".


Page

Definition

These permissions are related to Pages - both Pages in Sections, and Custom Profile Pages.

Use case

With these permissions, you can limit the ability of some Roles to perform actions such as creating and deleting Pages.

It's important to note that Pages are a fundamental building block in upgraded Planhat (ws.planhat.com), with much wider functionality than original Planhat (app.planhat.com).

Further details

Access to Company Profile Templates and Custom Profile Pages is also affected separate tenant settings.


PhSection

Definition

"PhSection" is a really important permission for upgraded Planhat (ws.planhat.com).

Sections are a key concept in upgraded Planhat. Both within your personal Home and within Libraries, Pages are organized in Sections, which group Pages by themes, such as Customer Success EMEA. Sections can be either public (where multiple Users can have access) or private (just for you).

Use case

It's an important part of using upgraded Planhat to be able to create/edit/delete Sections, even if only private Sections for yourself (plus collaborating and sharing content is also important), so we strongly recommend that you enable all the PhSection permissions for al your Roles.

Further details

Without the "View" permission, Users with that Role won't even be able to access upgraded Planhat - they'll see the message "You don't have access to the new interface yet - please contact your admin."


PhWorkspace

Definition

Similar to "PhSection", discussed above, "PhWorkspace" is an important permission for upgraded Planhat (ws.planhat.com).

PhWorkspace mainly relates to Libraries in Planhat, which are how you can organize Sections into categories (e.g. Sales Resources) and verify content. You can learn more about creating and managing Libraries here.

Use case

Roles must have at least the "View" permission for "PhWorkspace" to be able to access upgraded Planhat (ws.planhat.com) - without it, Users with that Role will see the same message as shown above for PhSection - "You don't have access to the new interface yet - please contact your admin."

In terms of the other permissions, they determine whether Users with that Role can create/update/delete Libraries. As Libraries are designed to be verified content curated by Planhat admins/builders (e.g. CS Ops), you probably don't want to give all your Roles these permissions.


ServiceAccount

Definition

These permissions define access to Service Accounts, which are used to create API access tokens. Note that in upgraded Planhat (ws.planhat.com), Service Accounts have been renamed "Private Apps", and can be found within the "App Center" Global Tool.

Use case

API access tokens can be used to access your Planhat data-model data over the API - for example, to create, update or delete Companies. We recommend that you disable the "ServiceAccount" permissions for Roles such as CSM or Sales, and leave them on for Administrator and Developer.

Further details

  • Be careful with this set of permissions! Roles with the ability to create Service Accounts / Private Apps will be able to assign any permissions to them - even potentially greater permissions than their own Role.

  • If you remove the main "View" permission here, Users won't see the "Private apps" section of the App Center.


Snippet

Definition

Snippets are pieces of templated text that you can use in Tasks and Conversations to save time. In upgraded Planhat (ws.planhat.com), Snippets are configured within the "Settings" Global Tool. Then, when typing in a Description, you use the # symbol to bring up the Snippets to select from.

Use case

With these permissions, you can determine who has access to creating and deleting Snippets, and other Snippet-related actions. It can be useful to restrict access to ensure your Snippets library stays tidy.

Make sure you enable at least the "View" permission for your standard Users (e.g. CSMs), so that they can apply existing Snippets.


StatesLog

Definition

If this permission is enabled, you will be able to access the "StatesLogs" model when building charts in Dashboard and Presentation Pages.

Use case

StatesLog stores changes to list fields, and is particularly used to track/visualize the number of days a Company spends in each phase.


Team

Definition

This set of permissions is related to the "Teams" section of the "Settings" Global Tool.

Use case

Teams can be used to define portfolio access in Roles (we will release an article on portfolio access in future), as well as being a way to filter Companies (see example below). Via the "Team" permissions, you can control whether a Role can do things like add Users to existing Teams, or create new Teams - so you may want to limit these permissions for some Roles.

Further details

Note that the "View" permission is required to be able to filter on Teams, as well as to see the Teams in Settings.


User

Definition

User is the Planhat model for you and your colleagues (i.e. Planhat Users within your tenant).

In upgraded Planhat (ws.planhat.com), you manage Users within the "Settings" Global Tool.

Use case

These permissions enable you to manage the Users of your tenant - adding and activating new Users, etc.

You'll want these permissions enabled for your Administrator and potentially Manager Roles, but you should limit permissions for other Roles.

Further details

  • All Roles should have at least the "View" permission for User, so they can see other Users throughout your Planhat tenant.

  • Be careful with the "Create" permission for User - this enables Users with this Role to add new Users to your tenant and assign them any Role, potentially even with additional permissions compared to their own Role. Therefore, this is one of those permissions where, for better security, we do not recommend that "Create" is enabled for all Roles.


UserRole

Definition

These permissions refer to the Roles within the "Settings" Global Tool - what we're discussing setting permissions for right now! Roles with the "UserRole" set of permissions can create and edit Roles.

Use case

Configure the "UserRole" permissions to determine whether a Role can view, update or create Roles etc. You'll want these permissions enabled for your Administrator and potentially Manager Roles, but you should limit permissions for other Roles.

Further details

Like you just saw for User (above), be careful with the permissions for "UserRole", for data security. We recommend that you restrict access for non-Administrator Roles.


Workflow

Definition

Workflows, formerly called Playbooks, are an easy - yet sophisticated - way to automate a series of actions - tasks and/or email steps. The two main types of Workflow are Projects and Sequences.

In upgraded Planhat (ws.planhat.com), Workflow Templates are configured in the "Workflows" Global Tool (shown in the screenshot below).

Use case

Workflows are an important part of customer/prospect management.

Without the "View" Workflow permission, you won't be able to see/access the "Workflows" Global Tool, or add a Workflow 360 Page, or view Workflows on Company Profiles, so generally, you'll want this enabled for all Roles - although Developers don't necessarily need this ability.

Further details

See below for how Workflow Template permissions also affect access.


WorkflowTemplate

Definition

These permissions control whether Workflow Templates (shown in the above Workflows screenshot) can be created etc.

A Workflow Template is a templated process, defining what actions (tasks and emails) should happen and when. Once designed, you activate your Workflow Template so it can be applied to specific Companies or End Users.

Use case

This set of permissions is for Administrators and Managers designing Workflows.


WorkspaceTemplate

Definition

The "WorkspaceTemplate" permissions (not to be confused with WorkflowTemplate above) relate to the Home Templates feature. Home Templates (which you configure within the "Content Manager" Global Tool are the way a Planhat admin (such as you) can pin Sections to the Homes of specific groups of Users, recommend Sections at their first Home set-up, and/or recommend Pages.

(WorkspaceTemplate permissions also control access to Portal Templates, where they are available in tenants - currently this feature is still under construction.)

Use case

Home Templates enable Planhat admins to carry out a form of top-down personalization, guiding the general Users within the tenant.

It's recommended that only the Administrator and potentially Manager Roles have the "WorkspaceTemplate" permissions turned on, so not everyone can create/edit/delete Home Templates.

Did this answer your question?