Skip to main content
All CollectionsMiscellaneous
System Field Glossary
System Field Glossary

Everything you need to know about system fields

Christian Dreyer avatar
Written by Christian Dreyer
Updated this week

System fields - also known as default fields or standard fields - are fields that have been created automatically by Planhat, as opposed to custom fields that you and your colleagues can create within your Planhat tenant.

There are a wide range of system fields across all the different Planhat data models.

In upgraded Planhat (ws.planhat.com), fields are managed within the "Data" Global Tool. You should select your choice of model from the list on the left-hand side, and then select the "Fields" tab.

Click the image to view it enlarged

On the left-hand side of each field in the list:

  • The cog icon denotes the "system" (default/standard) fields

  • The pencil/ruler icon applies to custom fields

Click the image to view it enlarged

To help you understand what information system fields are displaying and how they're populated, we have created the glossary of some key fields below.


Company

  • Accumulated MRR/ARR ({Currency}): total Annual/Monthly Recurring Revenue accumulated on the Company.

  • Accumulated Sale: total Non-Recurring Revenue accumulated on the Company.

  • Address: a text field that's used to store the Company address.

  • City: a text field that's used to store the city.

  • Co-Owner: a Team Member (User) field that's used to store the Company Co-Owner.

  • Collaborators: a Team Members (Users) field that's used to give Users the ability to access Companies (without receiving Company notifications). For example, if you have an external contractor or partner helping you with specific Companies, you can add them as a Collaborator.

  • Country: a text field that's used to store the country.

  • CSM Score: a rating field that you can use to set a score between 1 and 5. The CSM Score is a manual score that you and your team can set. Many use it to indicate the status of the relationship with the customer Company.

  • Customer Since:

    • a date field that looks at your License data and displays the earliest start date, when setting Set "Customer Since" Field Manually is disabled;

    • with setting "Set "Customer Since" Field Manually" enabled, this field will be editable and it won't get automatically set with the earliest License start date.

  • Customer To: a date field that looks at your License data and displays the latest end date.

  • Customer Status: displays the status of the Company, which is determined by the Company's License information. You can learn all about the different possible statuses, and when they are applied, in our separate article here.

  • Description: a rich text field that's typically used to add a description about the Company.

  • External Id: a text field that is used to store the unique identifier for the Company. This field ensures updates and usage data are all mapped to the correct Company. It's defined by you, and the best practice for this field is to ensure it matches a unique identifier given to Companies in your own internal database.

  • Followers: a Team Members (Users) field. When a User is added to the "Followers" field, they can receive notifications. You can read about how to view and customize notifications in upgraded Planhat here.

  • Group MRR/ARR ({Currency}): this is a number field that displays the MRR/ARR value of the individual Company that's part of a group structure.

  • Last Seen: a field that displays the date that an End User at that Company was last seen in your product. This field takes the date from the most recent user activity in Planhat.

  • Last Touch: this field will display the date of the last Conversation with that Company. Emails, tickets, calls, chats and custom Conversation Types all types of Conversation.
    ​​

  • MR: a number field that stands for "Monthly Revenue" and displays the MRR value plus Sale (NRR) Last 30.

  • MRR/ARR ({Currency}): this field displays the total monthly or annual recurring revenue on the Company. The field sums the values on all Licenses on the Company that have started and haven't ended.

  • Name: a text field that displays the Company name.

  • NPS Score: a number field that takes all of the associated End User NPS scores and calculates the mean, median or mode. In the "Settings" Global Tool, in "Account Setup", there's a setting called "NPS Calculation Base" where can choose if you would like the NPS score to be calculated using the mean, median or mode.

  • Owner: a Team Member (User) field that displays the Company owner.

  • Phone & Phone 2: used to display phone numbers.

  • Phase: a list field that you can use to keep track of each Company's lifecycle. The field is customizable, which means you can add new phases and edit existing phases. Learn more about this field here.

  • Renewal: this field uses the information from the Licenses that are on the Company. There are a few different values that this field can display:

    • Renewal date: this is the end date of the License that's due to end the soonest and has the status set to "ongoing".

    • Lost: the License end date has passed and the status isn't set to "ongoing".

    • Canceled: the License status isn't set to "ongoing" and the License end date is in the future.

    • Open: the License status is set to "ongoing" and it's not fixed term (no end date).

  • Related Domains: email domain(s) related to the Company. For example, at Planhat our domain is planhat.com. This field ensures your customer communications are logged against the correct Company in Planhat (e.g. calendar events, emails, tickets and chats).

    This field enables the automatic creation of new End Users. When you sync user activities, emails or calendar events into Planhat, we can match the email domains of involved End Users with the domains of existing Companies, and create new End Users. Related Domains can be manually added or removed from a Company, and can also be set/updated/removed via our API.

  • Sale Last 30: a number field that displays the total non-recurring revenue (NRR) that has been registered in the past 30 days.

  • SourceId (CRM): the unique identifier for Companies synced with an external CRM system such as HubSpot and Salesforce. This field ensures your Companies in Planhat sync with the correct Companies in your external CRM system.

    When you integrate an external CRM system with Planhat and a new Company is created in Planhat, the Source ID field will automatically populate. If you manually create a Company in Planhat after completing the integration and want to ensure it syncs correctly, you can manually add the Source ID for that Company.

    You can also set this using our API.

    HubSpot = Company ID
    Salesforce = Salesforce ID
    Pipedrive = Organization ID

  • Total Group MRR/ARR ({Currency}): this is a number field that displays the combined MRR/ARR value of all Companies in a group structure.

  • Website: a URL field that enables you to add a website address, and when you click on the address the web page will open - e.g. https://www.planhat.com.

  • Zip: a text field where you can enter the Company's zip (post) code.


End Users

  • Beats: total activities (clicks, logins, downloads etc.) over the past 14 days.

  • Create Date: the date the End User was created in Planhat.

  • Email: the End User's email address.

  • Experience: this looks at End User's total activities since the date tracking usage started; it displays a percentage showing their relative usage compared to all other End Users in your system.

  • ExternalId: a text field that contains the End User unique identifier. This field ensures updates and usage data are all mapped to the correct End User. It's defined by you, and the best practice for this field is to ensure it matches a unique identifier given to End Users in your own internal database.

  • Featured: a checkbox field that's used to mark an End User as featured. This can help you determine who is important to reach out to or get in contact with e.g. for upcoming renewals.

  • First Name: a text field used to store the End User's first name.

  • Last Name: a text field used to store the End User's last name.

  • LinkedIn URL: a text field used to store the End User's LinkedIn profile URL.

  • NPS: this is the NPS score that hasn't yet expired. There could be a more recent NPS score, but if the previous NPS score hasn't expired, then we will display that score. You ca configure your NPS score expiry days within the "Account Setup" section of the "Settings" Global Tool.

  • Phone: you don't have to leave Planhat to be able to call a customer. Just click on the phone icon next to this field on the End User Profile and Planhat will open up the browser's default dialer. If you're using our integration with Aircall, it will open up the Aircall app automatically if you have it downloaded on your desktop.​

  • Position: a text field used to enter the End User's position.

  • Primary: you can use this toggle switch to specify which is the most important End User / Company connection, if the End User is also associated with another Company. You can read more about this here and here.

  • Relevance: a home-grown secret algorithm looking at an End User's Beat, Beat trend and recent Conversations (emails, tickets, meeting attendance etc.) in the context of all your End Users and scoring them out of 100. More points in the algorithm are attributed to more recent engagement in your product or with your team. High relevance means an End User is highly engaged with your product and team relative to all other End Users.

  • Secondary Emails: if the End User has additional emails, then you can list them here. The email sync will include those email addresses when mapping emails.


User (Team Member)

  • Active: a checkbox field that needs to be enabled for that User to access Planhat.

  • Currency: a list field that enables each User to set their own currency. For example, if the base currency is set to USD, the User can set the "Currency" field to GBP, which means when they next create a License, it will appear in GBP by default instead of USD.

  • Default meeting length (minutes): a number field to store the default meeting length. When planning an event, Planhat will set the default meeting length for you using the value in this field.

  • Email: an email field that stores the User's email address.

  • ExternalId: a text field that holds the user's external ID. Typically this will be an ID that you have in your own system, which makes it easy to map the User from your own system to Planhat. If you have this field populated in Planhat, you can use it to update the User.

  • First Name: a text field used to store the User's first name.

  • Last Name: a text field used to store the User's last name.

  • Nick Name: a text field that's used to store the User's nickname. The nickname is visible in the top-right corner of the user's profile.

  • SlackId: a text field that's used to store your SlackId so that you can utilize our Slack bot to retrieve your customer information. To use the Slack bot, you will need to have the Slack integration set up, and this article explains how to do that.

    • Where do I find my SlackID? This is your member ID, which is stored on your Slack profile.

  • Start Page: a list field where you can choose which area of Planhat will open when you log in.


License

  • Auto Renewal: a checkbox field that determines if a License will automatically renew. If you would like a License to automatically renew, it's important to note that you must also have the setting "Automatically Renew Licenses (automaticRenewal)" enabled, which can be configured within the "Revenue" --> "Revenue Setup" part of the "Settings" Global Tool.

  • Currency: a list field that displays a range of different currencies. You can add and manage currencies in the "Revenue" --> "Currency & FX" part of the "Settings" Global Tool.

  • Cycle interval in months: on the "Invoice Cycle" field, if you select "Custom" from the dropdown list, the "Cycle interval in months" field will appear, giving you the option to select a specific invoice cycle (in months).
    ​​

  • Fixed Period: a checkbox field that's used to determine if the License has a specified end date or if it's ongoing for the foreseeable future:

    • Yes: a License end date must be provided.

    • No: the License is ongoing and no end date is required.

  • Invoice Cycle: a list field that displays a range of different Invoice cycle options:

    • All upfront

    • Monthly

    • Quarterly

    • Semi annual

    • Yearly

    • Custom

  • License start date: a date field that displays the License start date.

  • License end date: a date field that displays the License end date.

  • Next term start date: a date field that's used to predetermine a License start date if it gets renewed.

  • Next term length (months): a number field that's used to predetermine the length of a License when it gets renewed.

  • Notice Period: a number field that's used to set a notice period for Licenses that auto-renew e.g. 30 days. You also have the option to include the notice period in the renewal date. You will find the "Include notice period in renewal date (includeNoticeInRenewalDate)" toggle switch in the "Revenue" --> "Revenue Setup" part of the "Settings" Global Tool.

  • Notice Unit: a list field that's used in conjunction with the "Notice Period" field. When you're setting up the notice period, the "Notice Unit" field gives you the option to use display the notice period in "days", "weeks" or "months".

  • Prevent Auto-Invoice: a checkbox field that determines if Invoices are automatically generated when a License automatically renews.

  • Product: a list field that contains the names of your recurring products. You configure this list in the "Settings" Global Tool, in the "Revenue" --> "Product Catalog" section.

  • Renewal ARR: a number field that's used to predetermine the ARR value of a License if it gets renewed.

  • Status: a list field that displays the License status:

    • Ongoing: the License is active

    • Renewed: the License has been renewed (not active)

    • Lost: the License is lost (not active)

  • Value: a number field that's used to store and display the total License value.


Sale (NRR)

  • Currency: a list field where you can select currency.

  • Product: a list field that contains the names of your non-recurring products. You configure this list in the "Settings" Global Tool, in the "Revenue" --> "Product Catalog" section.

  • Sales Date: a date field that stores the date of the Sale.

  • Value: a number field that stores the Sale value.


Invoice

  • Due Date: a date field that contains the invoice due date.

  • Invoice Date: a date field that contains the invoice date.

  • Paid Date: a date field that contains the date that the invoice was paid.

  • Paid: a checkbox field that records whether the invoice has been paid.


Conversation

  • Involved Contacts: stores one or more End Users who were involved in the Conversation.


Task

  • Involved Contacts: an End Users field that's used to display End Users that are involved on the task/event. When an End User is selected, the task/event will appear on the End User's Profile.

  • Main Type: a list field that gives you two options: "Task" and "Event". If you would like to plan a meeting or customer event and push it to Google Calendar then you would use "Event". For everything else, you would use "Task".

  • Repeat Interval: a list field that displays several different repeat options. When you create a task, you can automatically repeat the task in a day, week, month, year etc. by using this field.

  • Repeat Interval (days): if you select "custom" from the list field "Repeat Interval", a number field will appear. For example, if you would like the task to repeat in three days then you would input "3".

  • Shared: a checkbox field that determines if the task can be shared on the Customer Portal.


Project

  • Currency: a list field that gives you the option to select a currency.

  • End Date: a date field that contains the Project end date.

  • External Id: a text field that holds the Project external ID. Typically this will be an ID that you have in your own system, which makes it easy to map the Project from your own system to Planhat.

  • MRR: a number field that displays the Project's MRR.

  • Name: a text field that displays the name of the Project.

  • NRR: a number field that displays the Project's NRR.
    ​​

  • Start Date: a date field that contains the project start date.

  • Source Id: the unique identifier for Projects synced with an external CRM system such as Salesforce. This field ensures your Projects in Planhat sync with the correct Projects in your external CRM system.


Issue

  • Created date: a date field that contains the date the Issue was created.

  • Description: a text field that's used to store the Issue description.

  • Issue Type: a text field that's used to store the type of Issue.

  • Priority: a text field that's used to store the Issue's priority - e.g. low, medium and high.

  • Project Id: a text field that's used to store the Jira project ID.

  • Status: a list field that's used to display an Issue's current status. There are three different options to choose from: "Open", "In Progress" and "Done".

  • Source Key: a text field that stores the Issue key that syncs directly from Jira. Use the Source Key to map data between Jira and Planhat.

  • Source: a text field that stores the source, e.g. Jira.

  • Source Id: the unique identifier for issues synced with Jira. This field ensures your Issues in Planhat sync with the correct issues in Jira.

  • Source Url: a text field that's used to store a link to the issue in Jira.

  • Title: a text field that displays the Issue title.

  • Updated date: a date field that displays the date that the Issue was last updated.


Asset

  • External Id: a text field that holds the Asset externalId. Typically this will be an ID that you have in your own system, which makes it easy to map the Asset from your own system to Planhat.

  • Name: a text field that's used to store the name of the Asset.

  • Source Id: the unique identifier for Assets synced with an external CRM system such as Salesforce. This field ensures your Assets in Planhat sync with the correct assets in your external CRM system.


Workflow

  • Expected Days: a number field that's used to store the number of days expected to complete the Workflow. The field is called "Days to Complete" when you're editing the Workflow template. This can be used to measure the performance of the Workflow.

  • Start Date: a date field that displays the date that the Workflow was applied.


Automation

  • Enabled: a checkbox field that's used to turn the Automation on and off.

Did this answer your question?