Your Knowledge Base is moving on 3/25/24! Our new Help Center provides all the articles you know and love (plus so much more) in a one-stop shop. Ask your SPoC for details!

Custom Fields

 

Adding custom dates, bit fields, text fields, number fields, field helps, and even drop-down lists to any page in MinistryPlatform is very straightforward. Access to the SQL Server Management Studio (SSMS) is required.

Resources

During a break-out session at MPUG 2015 Kevin McCord shared this document, which provides a thorough overview of which fields can be added and how: Custom Fields.pdf.

Also available for custom fields are the following Datatypes:

  • Varbinary — This datatype allows for two way encryption. The value is edited in the platform as a text value, but stored as a hashed binary value.
  • dp_Email — This custom datatype will validate the input as an email address.
  • dp_Counter — This custom datatype stores a number that is changed in increments (i.e., editing the field with a value of 5 adds 5 to the existing field value). A Counter field is often used for managing inventory counts. Mass assigning a Counter field will increment the value of the field by the value assigned (not overwrite). Changes to Counter fields are logged in the Audit Log.
  • dp_TimeZone — This custom datatype allows users to select from a list of standard Time Zones.
  • dp_Locale — This custom datatype allows users to select from a list of standard Locales.
  • dp_Separator — This custom datatype displays a separator in the platform. Used to organize other fields.
  • dp_TableName — This custom datatype allows users to select from a list of Tables (and database views) in the dbo schema.

The following Datatypes are unsupported and, if added to the database, will not appear in the user interface:

  • Geometry
  • Geography 
  • Hierarchyid
  • Datetimeoffset
  • Timestamp
  • Variant 
  • XML

Reordering or Resizing Fields

When you add custom fields, you can add them most easily to the very end of the table. If you place them in the middle or reorder other fields, SSMS may display the following warning: Saving changes is not permitted. The change you have made requires the following table to be dropped and re-created. You have either made changes to a table that can't be recreated or enabled the option prevent saving changes that require the table to be re-created.

The reason for this error is that the changes require dropping and recreating the table and relationships to other tables. SSMS can do this all automatically, but the default settings prevent this operation. To enable this, uncheck the following box in Tools > Options. To prevent these sweeping changes in other cases, you may want to re-check the box when you are done.

Read Only Fields

Read only fields are available and can be created by adding an underscore (_) to the beginning of the field name. Any read-only field by definition must allow nulls or have a default value defined. It is also possible to create hidden fields using two underscores before the field name (__). These fields are available to processes and using advanced views. 

Field Help (tooltips)

Field Help is based on the Description which can be set in the extended properties for a Column.

Our future software updates may update these Descriptions for any standard fields. This happens without warning, so changing these for standard Columns is not recommended.