Overview
The Virtuous CRM integration provides a ready-made function you can call when building mappings. It reads a value from a record's custom fields by name, so you do not have to write that logic yourself in a formula.
Where you can use these functions
These functions are available anywhere you write a formula for the Virtuous CRM integration:
Dynamic Formula mappings: where a destination field's value is produced by a formula rather than mapped directly from a source field.
Mapping collection filters: where a formula decides whether a record should be processed.
Error filters: a mapping collection's error filter, which sits alongside its collection filter. When the error filter's formula resolves to true, the transfer raises an error that is held in the Error Logs for review and is not retried automatically.
Translation collections: where a translation entry uses a formula as its source value.
How to use them
Call a function by name and pass the values it needs in parentheses, for example:
GetValueFromCustomField(CustomFields, "Active_Web_User").Each function's signature shows its name, the parameters it accepts (with their types), and the type of value it returns. Use it as the reference for exactly how to call the function.
Function names and formula syntax are case-sensitive, so type each name exactly as shown. Whether the values a function matches are treated as case-sensitive varies by function, and is called out in the relevant parameter's description.
This function is synchronous, so you call it directly (no
awaitis required).The function runs at sync time, against the data in your connected Virtuous CRM account and your iPaaS.com subscription.
The functions are grouped below by the area of the integration they support.
Custom Fields
GetValueFromCustomField
What it does: Reads the value of a named custom field from a custom-field object.
Signature: object GetValueFromCustomField(object customFieldObj, object textFieldName)
How to call it: GetValueFromCustomField(customFieldObj, textFieldName)
Parameter | Type | Required | Default | Description |
|
| Yes | N/A | The object that holds the custom fields, typically a set of key/value properties. |
|
| Yes | N/A | The name of the custom field to read. |
Returns: object. The value of the named custom field, in its original type (for example a string or a number), or null if the field is missing or has no value.
Example: GetValueFromCustomField(AdditionalProperties, "Active_Web_User") returns the value stored under Active_Web_User, for example "Yes".
When to use it: Use this to pull a single custom-field value into a mapping by its field name.