Custom fields are used to provide additional information to records that are not found on the standard create tab.
An example would be if the user wanted to add DOB for members' records. The user would do this by creating a custom field for this information to be entered.


The information on this page provides an overview of how to create a custom field. To access the API for custom fields, please click here. 


  • To create a Custom Field from the ZIQNI dashboard, scroll down to settings and click.



  • Using the menu on the left-hand side, click on Custom Fields.


    

This will load the search/ create page. From here the following actions can be performed.

  • If there is data that can be searched for, the screen below will appear. Search for a custom field that has been created and saved previously.  Custom fields can be searched by using keywords and phrases.




This page also allows the user to filter the fields being displayed, view, edit and delete the data that has been entered. 

  • Click on the funnel icon. This allows the data to be searched using only the specific fields that are chosen.





To filter data using specific headings the cog icon is used. 

  • Click on the cog icon to filter the data that is being displayed.
  • Uncheck the boxes from the drop-down menu to filter the data being displayed.



 

All previously created data can be viewed, edited, and deleted. 

  • Under the Action heading for each set of data entered, there is an ellipsis.
  • Click on the ellipsis and the Action menu will appear.
  • View, edit or delete the data that has been checked



If no data has previously been entered, when you click on custom fields from the settings page, you will be taken to the page below.



  • Click on Action and the Create page will load.



A custom field can be created in a few simple steps. 


  • Choose if the field is public. If marked as public then this field will be visable in member api, otherwise the field is only accessible in admin api.
  • Name the custom field - this is mandatory and is restricted to 100 characters.
  • Create a key that is unique to identify the custom field. The key is case-sensitive and restricted to 100 characters. Once the key is created it cannot be edited.
  • Describe the custom field, this is for reference only.
  • Include the field type. Field type determines how the data should be handled and rendered when received by the system. It is a mandatory field and cannot be edited once created. If there is an error with the field type data, it must be deleted and recreated.
  • Select the entity the custom field will apply to, using the drop-down menu.
  • Click create and a custom field has been created. 
  • A preview page will load to display the data the user has entered.
  • From this page, the information can be edited or deleted using the Action button.