This article covers the following data field settings:
- Field Type
- In Use
- List Criteria
- Include in List
- Sort Order
The Data Field >> Add and Data Field >> Edit pages show all information related to the data field. Below are explanations of each one of the data field settings in detail.
The caption is the name of the data field and will be the work / phrase shown on the left hand side of each page in PPO.
The caption can be specified from the Data Field >> Edit page using normal text.
The description places the field in context and provides an indication of the information that should be provided. The description can be seen from the front-end of PPO when the mouse pointer hovers over the field caption (tooltip function).
The description for a data field can be specified from the Data Field >> Edit page using normal text.
Categories are used to group data fields together, for example, showing all data fields relating to basic issue information together and those relating to issue classification together.
Categories can be created on the Data Field >> Edit page. To do this, click on the Add Category icon (green plus) next to the category field on the Data Field >> Edit page.
The listed category will disappear and the user will be able to enter a new category.
Once the name of the new category has been entered, click on the Submit Category icon (green plus) to save the new category.
Once a category has been added it will be available in the category drop-down list.
To move a category, rearrange the sort order of the fields on the entity. The categories will keep the fields grouped together but will still maintain the overall sort order of the fields on the entity.
To delete a category, simply move all fields out of the category. Once a category has no fields in it, it will disappear and will no longer be available from the category drop-down list.
PPO allows you to define fields that do not require manual input by a user. These fields can be defined by a calculation or formula, based on other data, within PPO.
If the calculated field is added, a box for the formula will open underneath the calculated check box.
For more information on calculated fields and how to implement them, please access the following knowledge base article.
PPO allows for different types of data to be captured by using different types of data fields.
For more explanations on all the different types of data fields access the following knowledge base article.
The required check box shows whether a field needs to be populated before the user can submit the record or whether the fields may be left blank, in which case they would not be required.
Required fields can be seen as fields with greyed out input boxes on the front end, when a project or project related entity record is edited.
If a user neglects to specify a value for a required field, they will see the following message when they submit, and will not be permitted to continue unless values are specified for the required fields:
Note that certain standard data fields are by default required and cannot be made non-required without the assistance from the PPO Support Team. The reason they are by default required is, because they are used on standard reports and dashboards, and also in certain calculations.
To make a field required, check the Required check box on the Data Fields >> Edit page.
If required, calculated fields can be hidden. This means the field will no longer appear on the front-end of PPO. This can be used where calculated fields are required for event handlers or validation rules.
For a field to become active, available and visible from the front end of PPO, the In Use field must be true. If the In Use field is false, the field will not appear on the front end and will not be able to store any data.
Also note that if a field is taken out of use, all data stored in that field up to date, will be lost.
To take a field out of use, uncheck the In Use check box on the Data Fields >> Edit page.
The List Criteria is available on all the project related entity list pages in order to filter a list page. For example on the Issue >> List page, if a user wants to see only high priority issues on the list page, they can select the high priority Issues, by using the "Priority" drop-down list, within the list criteria. The list will be filtered to only show Issues that conform to the list criteria.
If the List Criteria field is True for a field on the Data Field >> Edit page, the field will be added within the list criteria, at the top of the list page.
Note: the setting above (as set up under Administration) is only to provide a default setting to all users on the PPO instance. The user can set their own list criteria preferences by clicking on the Select / Unselect List Criteria Fields icon.
For more information on the List Criteria, please access the following knowledge base article.
The include in list setting indicates whether the field should appear as a column on the list page.
Note: the setting above (as set up under Administration) is only to provide a default setting to all users on the instance. The user can set their own list preferences by clicking on the Show / Hide list columns icon.
The sort order defines the order in which the fields appear within the entity. The sort order can be specified manually from this field, or by using the Fields Sort Order icon.