Skip to main content

Custom fields

Add custom fields to your events, defect reports or interventions

You can now create and manage your own custom fields directly in the platform's admin section.

You can check which custom fields have already been created for your company by navigating to "Asset admin", then scrolling down to the "Custom fields" section:

There, click on "View" next to "Field configs" to see the list of custom fields already created:

Create a Custom Field

The first thing to do is to decide the type of your custom field. You can choose between the types of fields listed below:

  • Text: for free texts

  • Int: for numbers

  • Date: for dates

  • Boolean: for yes/no

  • Enum: for drop-down lists

Next, decide where your custom field should be displayed. You can choose between the elements below:

  • Assets/asset: the field will be visible in the admin panel, on the page of the asset

  • Component/measurement (requires the components module): the field will be visible when you add a component measurement for the component(s) of your choice

  • Maintenance/event: the field will be visible in your events. You can choose to display it for preventive and/or corrective events, when the event is opened and/or closed

  • Maintenance/asset restriction: the field will be visible when you create a restriction

  • Maintenance/intervention: the field will be visible when you create an intervention

  • Maintenance/preparation step (requires preparation module): the field will be visible in your preparations

  • Maintenance/hotline call (requires hotline module): the field will be visible when you report a hotline call

You will be able to input your custom field type and related element when creating your "Field config". More explanation is given on that in step n°2 below.

⚠️ Drop-down lists require an extra step compared to other custom field types. If you wish to create such a custom field, please follow the first "optional" step described below.

Please note that custom fields function independently, with no possibility of interdependence.

1. (OPTIONAL, for drop-down lists ONLY) Create a drop-down list/enum group

⚠️ If you only need a simple field (text, number, date, etc.), you can skip this step.

If you want to create a drop-down list, you must first create an Enum group, before going to step n°2:

  • In the "Custom Fields" section, next to "Enum groups", click on “Add”

  • Enter a name (label) for the group. You can choose to translate it into multiple languages

  • Add "Enum Items", which will be the options to choose from in the list. They can also be translated

  • Add a "Value" to your items. Values can be anything (words, numbers) but must be different. They will not be displayed in your list

  • You can restrict the items in your drop-down list to a specific asset class by selecting the class from the "Asset class" list

  • You can also choose the order in which your items appear by clicking on the arrows to move them up and down in the list

Once you have filled all of your "Enum Items", click on "Save".

Once saved, your enum group will be available when creating the custom field.

2. Create the custom field (field config)

For drop-down lists, make sure to have created an "Enum Group" first.

In the "Custom fields" section:

  • In the "Custom fields" section, click on “Add field config”

  • Enter a name (label) for the config. You can choose to translate it into multiple languages

  • Choose a key for this config. We generally recommend using the same as the label. Note: you cannot have blank spaces in this field, use "_" to separate words instead

  • You can choose to add a description to your custom field. It will be visible to all users and can be translated as well

  • Choose the element where your field will be displayed (see element explanation above)

  • Leave the "Permission string" field blank

  • Choose the "Data type" as explained above. If you choose "Enum", you will need to choose the enum group linked to this field

  • Choose the order of display of the field, where 1 will be the first field displayed, 2 will be next, etc

  • Choose whether or not this custom field is "required" or not. Required fields are mandatory, and will be marked by an asterisk "*"

  • Do the same for "private". A private field will only be visible to your company, and will not be displayed to companies to which you share assets

  • Keep "Small" ticked

Updating your Custom Fields

You can always modify your custom fields by going to your "Field configs" and updating the field's content. For example, translations can always be added, edited or removed at a later stage.

You can also always modify your drop-down lists by going to your "Enum groups" and updating the list.

Please note that, if you change the name of one of your custom fields, the name will also be updated in historical events/interventions. If you wish to retain accurate historical data, we therefore recommend simply deactivating the "old" custom field and creating a new one with the updated name

Support

Do you still have questions? Go to the Railnova platform and click "Contact us" for help!

Did this answer your question?