TABLE OF CONTENTS
- Adding/Editing Metadata
- Accessing Metadata in Your App
- Using Metadata for Common Keys Across Company Accounts (useful for Vendors)
There is often a need to have persistent data values stored against a user or organization account – e.g., a user's payroll ID, phone number or other user-specific information that you want to have available in your Screen designs. Similarly, if you are a vendor working across multiple company accounts, then you may wish access the same core value via a consistent key. The good news is that you can associate key/value metadata on both the Company/Organization and User level using our platform. This enables you to record additional information against these entities, and then access this data in Forms and other areas of the system via our META() formula functions.
Adding/Editing Metadata
To get started with adding or editing metadata, simply head over to the “Edit User” and “Organization Setup” pages on the online platform. There you will see a new “Metadata” field, which lets you add key/value sets of information.
Don’t forget to hit the Save button to persist your changes.
NOTE: These metadata values are also available on our Company and User APIs so you can programmatically get/set metadata values as desired.
Accessing Metadata in Your App
To make use of the metadata you have loaded, we provide two formula functions:
- ORGMETA(‘keyname’)
- USERMETA(‘keyname’)
Both the above functions will get you the value for the given key name at Organization and User level respectively. As this is part of our formula engine, you can make use of these functions anywhere formulae are supported – Form screens, data templates, conditions etc.