Custom Fields

Use custom fields to capture and display information significant to your business. This article runs you through the basics of creating custom fields and how they can be used.

Projectworks allows you to create your own fields for projects, people, companies, timecodes and budgets. Information captured in custom fields can appear on lists screens, CSV downloads, and on the entity itself.

Let's get started!

Creating a custom field

The Projectworks administrator is able to create custom fields in Settings > System > Custom Fields by clicking the blue + button in the top right of the screen. The following fields can be entered:

  • Field Name

    • This is the name of the field as it appears to users.

  • Field is required

    • By ticking this option your custom field will need to be filled in in order for someone to complete the action that it shows up on.

    • NB: If you're creating a "Checkbox" field type this option is not applicable.

  • Field Type

    • Choose the field type that best matches the kind of information you wish to capture, e.g. choose ‘Number’ if you only want users to be able to enter an integer.

  • Select Dropdown

    • If the custom field is either a ‘Select’ or a ‘Multiselect’ the options in the field’s dropdown need to be entered.

    • These can be ordered alphabetically or manually, and you can specify a grouping for related options if this makes it easier for people to use. Grouping is not required, so just leave these fields blank if you want a straight list to pick from.

  • Entity

    • This is the entity the field will be against: projects, people, companies, budgets, and timecodes.

    • Depending on which entity is selected there will be additional options, like status, or the specific area it should appear to users. This means for example you can have a “Probability” percentage custom field for projects with the status “Unsigned (opportunity)” but no other statuses.

  • Field Group

    • This is the title that sits above your custom fields. It's not mandatory to include a group name, and if you choose to keep it blank an "Additional Details" heading will be put in its place.

  • Field Order

    • By default custom fields are ordered alphabetically. You can specify a different order by entering a number (e.g. 1, 2, 3, and so on). If some of your custom fields do not have an order number they will appear at the top of the list, so for complete control it is advised that you enter an order number to all custom fields.

    • Ordering will apply to fields per group if you are grouping them.

2023-06-14_12-03-49 (1)

Allow custom fields to appear on list screens

It’s possible to allow some custom fields to appear on the list screens as filters, group, and column options. You may not want every custom field available like this, so this is an opt-in setting on the custom field itself. This option is available for custom fields on the following entities only:

  • Project

  • User (Person)

  • Timecode

The Projectworks administrator can set a custom field to show on the project, invoice, time entries, timesheets, and people lists screens by doing the following:

  1. In Settings > Custom Fields click in the custom field you wish to use

  2. Scroll to the bottom section where the entity is specified (selected as either ‘Project’, ‘User’, or ‘Timecode’) and tick “This field can show on list screens as a column / filter / group”.

  3. Select the screens you want the custom field to appear on

  4. Click Save

image-20230726-182407

IMPORTANT: All users who can access these screens will be able see this custom field and it’s values, so be mindful of fields containing sensitive information.


See below for how these are used on list screens →

Entering custom field information

Projects, companies, & people

Navigate to the project, company, or person to get to their workbench and go to the Settings tab, then Additional to edit custom fields.

Project:

image-20230614-023755


Company:

image-20230614-024310

Person:

image-20231003-203706

To edit a project’s custom fields you will need the following permissions enabled in your Access Level:

  • Project Settings > Settings > Can view & Can maintain 

To edit a company’s custom fields you will need the following permissions enabled in your Access Level:

  • More Options > Client.Detail.View

  • More Options > Client.Detail.Edit

To edit a person’s custom fields you will need the following permissions enabled in your Access Level:

  • To edit Profile custom fields:

    • People > Profile > Can View & Can Edit

  • To edit Detail custom fields:

    • More Options > Person.Details.View

    • More Options > Person.Details.View.Self / All / Minions

    • More Options > Person.Details.Edit.Self / All / Minions

  • To edit Leave custom fields:

    • Global.IsHRAdmin

  • To edit Cost custom fields:

    • More Options > Person.Cost.View

    • More Options > Person.Cost.View.Self / All / Minions

    • More Options > Person.Cost.Edit.Self / All / Minions

People

For people, click on the person to get to their workbench and go to the Details tab, then click Edit Detail Fields to edit custom fields.

image-20230615-041254


image-20230615-041328

To edit a person’s custom fields you will need the following permissions enabled in your Access Level:

  • More Options > Person.Details.View

  • More Options > Person.Details.View.All

  • More Options > Person.Details.Edit.All

Timecodes

For timecodes, click on the relevant project to get to it's workbench and go to the Timecodes tab, then click on the timecode to see and edit custom fields in the Settings tab and / or Config.

image-20230614-032424


image-20230615-040440

To edit a timecode’s custom fields you will need the following permissions enabled in your Access Level:

  • Can go to Projects

  • Project Settings > Timecodes

    • Can view

    • Can maintain

    • Can edit config

Budgets

For budgets, click on the relevant project to get to it's workbench and go to the Settings tab, then Budget, then the More link on each budget line to see and edit their custom fields.

image-20230614-232012

image-20230615-222750

To edit a budget’s custom fields you will need the following permissions enabled in your Access Level:

  • Can go to Projects

  • Project Settings > Settings

    • Can view

    • Can maintain

 

If a field is required it will also appear as a mandatory field when creating a new project, person, timecode, or company.

Viewing custom field information

There are a few ways a custom field can appear throughout Projectworks:

  • As a filter, group and column options on some list screens

  • In the CSV downloads from the list screens

  • As a filter when adding a resource to a project

  • On the entity itself

Custom fields that have been configured to show on list screens can be found by clicking on the Hide/show/group of specified list screens to show their columns.

image-20230615-025634


Custom field checkboxes, selects, and multiselects that been configured to show on list screens can also be found by clicking on the + Filters button on applicable screens. The list of filters to show on screen will be a mixture of standard system filters and these custom fields. Users have the flexibility to choose which filters they want to see, and there is an option to have a filter’s previous selection remembered - leave this box unticked if you want to the filter to be blank by default.

image-20230615-020036

These custom fields will also be available as a group option (select and checkbox field types only). These can be found by clicking on the Hide/show/group control.

All custom fields are present in the CSV downloads from list screens.

image-20230615-015252

If the custom field is for a person and has been enabled for the “Add resource to project (person search)” it will show as a filter if you click Filter by team, role, etc… in the add resource pop-up.

image-20230615-031019

image-20230615-031106

Users who don’t have edit permissions for custom fields can view them on projects, companies, and people. Click on the project, company, or person to get to their workbench and go to the Details tab, to see custom field information. Fields that have not been entered will not show here.

image-20230615-033056

image-20230615-032206

image-20230615-033703

To view a project’s custom fields you will need the following permissions enabled in your Access Level:

  • Project Settings > Details > Can view

To view a company’s custom fields you will need the following permissions enabled in your Access Level:

  • More Options > Client.Detail.View

To view a person’s custom fields you will need the following permissions enabled in your Access Level:

  • To view Profile custom fields:

    • People > Profile > Can View

  • To view Detail custom fields:

    • More Options > Person.Details.View

    • More Options > Person.Details.View.Self / All / Minions

  • To view Leave custom fields:

    • Leave > Can view

  • To view Cost custom fields:

    • More Options > Person.Cost.View

    • More Options > Person.Cost.View.Self / All / Minions