Customize the data model

Table of Contents

1. Create your own custom fields
2. Enable Field History Tracking
3. Customize picklist fields

1. Create your own custom fields

You can create custom fields on the Referral object as on any other Salesforce object in order to match your unique business processes. Carefully read the following considerations before you do.

If you are going to create custom fields on the managed Referral object, do not give them API Names that are exactly the same as the existing managed fields, excluding the managed WorkSpan namespace prefix.

E.g., there is the Account Owner Email field with the workspan__AccountOwnerEmail__c API Name. You should NOT create your own custom field on the workspan__Referral__c object with the AccountOwnerEmail__c API Name. For any custom field you create, please use API names with snake_case (e.g. Account_Owner_Email__c), not CamelCase, and do NOT use one-word API names, especially with standard object names (e.g. do NOT create a field named Lead__c).

Otherwise, you will either break the integration right away (if the packaged field with the same API name already exists) or won’t be future-proof (if a package upgrade introduces a field with an API name that you already use). If you can’t use snake_case for some reason, then please add a short string to your API names to make sure it won’t be matched (e.g. AccountOwnerEmailCF__c or CFAccountOwnerEmail__c).

There is currently no way to sync your custom field values back from WorkSpan into the same custom field. Let’s say you’ve created a custom field Special Treatment Type and configured it to be sent to WorkSpan. Then in WorkSpan, you can: (a) map it to a standard field, e.g., Notes, or (b) map it to a custom field that you’ve created in WorkSpan as well. In the case of (a), WorkSpan will sync the updates back into the packaged Notes field, not your custom field. In the case of (b), WorkSpan will not sync it back at all.

If you are going to create new custom picklist fields on the Referral object, then we strongly advise you to leave the default option of the picklist value label being exactly the same as the picklist value API name. Otherwise, it’ll be harder for you to map this custom field if you want to, see details here.

2. Enable Field History Tracking

WorkSpan keeps the history of edits of the Next Step field. You can do the same in Salesforce if you enable Field History Tracking, which is available for most fields (see the full list of considerations here) on most objects, including the packaged ones.

3. Customize picklist fields

The package comes with multiple picklist fields that you can customize to better fit your business processes:

• Business Unit
• Country
• Industry
• Opportunity Source
• Region
• Sales Stage

All of these picklists are not restricted, which means apex code or API can write new values into it which were not part of the value set (but users can’t). These new values are added as inactive and will not be available from the UI unless an admin activates them from this picklist’s field definition detail page in setup.