Field Syntax
Field Syntax can be defined as a “code” within the Ivinex system that is used to get field data from a specific field in a data module by it’s unique name or unique ID.
Default Record Fields: There are a few fields that are automatically generated for every record. As long as there is at least one record in a module, these fields are always available when using field syntax.
- Created By: [Field: created_by] (The username of the person who created the record.)
- Created Date: [Field: created_date] (The date the record was created.)
- Modified By: [Field: modified_by] (The username of the person who last modified the record.)
- Modified Date: [Field: modified_date] (The date the record was modified.)
- Record ID: [Field: collection_id] (The ID of the record.)
Warning: When referencing the Record ID using field syntax, you must call it "collection_id" [Field: collection_id]. This is especially useful when attempting to set linked fields using a workflow.
The other fields we can access using Field Syntax depend on the data fields that were built into the module we are attempting to pull data from.
Note: When a field is created for a module, the "Display Text" will be used to name the field in the Ivinex system. However, the Ivinex system will modify the field names that are stored in the database in the following ways:
Field Name Modifications: Automatic modifications to field names within the Ivinex system.
- All lowercase.
- Underscores replace spaces.
- All non-letter/number punctuation removed.
- If there are two fields with the same name, the second field will end with a number, starting from 0.
Now that we know how Ivinex modifies field names, we can use the field names or the field ID’s to get data using field syntax.
- Field Name Example: Hello [Field: contact_first_name], today ([Field: contact_birthday]) is your birthday! Here is a coupon code for 10% off your next order.
- Field ID Example: Hello [Field: 14005], today ([Field: 14010]) is your birthday! Here is a coupon code for 10% off your next order.
- Output Example: Hello Joe, today (11/12/2012) is your birthday! Here is a coupon code for 10% off your next order.
Advanced Field Syntax
When using Field Syntax to get data from the “Linked Record” field type, it’s important to note that the field itself is referencing another field in a different module.
