Custom properties allow you to create your own additional fields on just about anything in Fluid.
To set up Custom Properties, navigate to the Administration Console. Note that only Application Administrators can set up custom properties.
Select Custom Properties under Data Administration Settings.
You can create any custom properties you want - they are an opportunity to 'tag' content in Fluid with any defined fields you want to allow you more granular reporting on your Fluid data. Because of this flexibility it is important to remember that, regardless of the Data Type you define for you Custom Properties, they are considered ‘free text’ fields that do not carry any logic at all in Fluid! This means that workflow and other logic cannot be applied to these fields.
Adding a custom property
Custom properties can be added to almost any element in Fluid. The image below lists all the elements you can add custom properties to.
To add a new property, select the type you want to add a property to.
Click on Add Property to open the dialog to create a new custom property (to edit an existing property, click on the pencil icon next the property name).
You will be presented with a dialog with the following fields.
- You can select the custom property type from the below list. You can find more about custom property types in the next section of this article. Note that this field value is mandatory when creating a new custom property.
- Text: Single line of free text
- Option: Drop down list
- Text Area: Free text box
- YesNo: Yes/No flag
- Hyperlink: Url link
- ValuedOption: Numbers (weighted value)
- The name of the custom property. The name can only contain letters, numbers, underscores and space. This field is mandatory.
- This field is optional. If a value is set, the label value will be used instead of the property name when displaying the property. Labels can be used to give a more user friendly name to the property if the name represents a technical term for instance. Labels can also use a wider range of characters than names.
- You can group custom properties by category. You can create new categories or select an existing one.
- Set the switch to Yes if a value for this custom property is required.
- Set the switch to Yes if the custom property should be included in Excel reports when pulling bulk content - or in the case of a project custom property, if it should be surfaced as a reporting filter in the dashboard reporting.
- Admin locked custom properties can only be edited by administrators. The administrator role required to be able to edit the property depends on the type of the element the property is added to.
- Project Administrator role is required in order to be able to edit admin locked custom properties added to Project, Impact, Schedule, Status Report, Community Plan, Financials, Benefits and Ongoing Costs.
- User Administrator role is required in order to be able to edit admin locked custom properties added to Person.
- Application Administrator role is required in order to be able to edit admin locked custom properties added to Action, Board, Meeting and Workhub.
Depending on the Data Type value selected, additional fields will be displayed so that you can set up a default value or enter the list of options.
Custom property data types
The following table explains the difference between the various types.
|Text data type provides a single line of free text. |
|Use this data type if you want to restrict the custom property value to numbers.|
|Use this data type if you want to limit the custom property value to percentages.|
|Date||Use this type if the custom property represents a date.|
|Person||A Person custom property type allows you to set a user as a value.|
|Project||A Project custom property type allows you to set a project as a value.|
|Select this type if the value should be a free text box.|
|YesNo custom properties are represented by a switch.|
|Hyperlink||Custom properties of type hyperlink are shown with two fields: the url field and the text for the link.|
The valued option type is similar to the Option type, the only difference being that you can associate a weight to each option.
Where to find the custom properties once they have been created...
|Action||On the Action dialog box|
|Benefit||On the dialog when adding or editing a project Benefit|
|Board||Under the settings for a board|
|Community Plan||On the 'Add Resource' dialog when adding a resource to a project community|
|Financial||On the dialog when adding or editing a new entry for forecasts or actuals on a project|
|Impact||On the dialog for adding or editing a project impact|
|Meeting||Under the settings for a meeting|
|Ongoing Cost||On the dialog when adding an Ongoing Cost to a project|
|Person||Additional properties for Fluid User Accounts|
|Project||Under the settings for a project|
|Schedule||On the dialog when adding or editing schedule/gantt items|
|StatusReport||On the dialog when adding or editing status reports to projects|
|Workhub||Under the settings for a Workhub|