Custom fields in iPaaS.com allow you to create text fields that aren't natively supported in the platform. These fields can be associated with a data model and populated with data from an integration subscription or custom API integration. Custom fields exist at both the data model level and all child levels.
This article relates to iPaaS.com custom fields only. Custom fields from subscriptions are handled in Subscriptions Management.
iPaaS.com custom fields allow you to create text fields not supported natively in iPaaS.com, associate that field with a data model, and populate it with data from an integration subscription (or custom API integration). Custom fields exist at both the data model level and all child levels.
If custom fields are used in default mapping collections, they are added when you add the subscription.
Important Considerations
Custom fields are only available on edit screens, not create screens. If custom fields are used in default mapping collections, they are automatically added when you add the subscription.
CAUTION: If you delete an individual custom field value, the deletion is permanent and cannot be restored unless another transfer repopulates it.
Example Use Cases
Refrigeration Requirements: A merchant selling goods that require specific refrigeration temperatures can create a custom product field to store that temperature data.
Employee Skills Tracking: A company that needs to track certain employee skill levels can create a custom employee field for this purpose.
Specialized Order Options: A merchant offering engraving can create a custom transaction field to hold this data.
Creating New Custom Fields
You can add new custom fields to make them available to iPaaS.com.
To create a new Custom Field:
Click Data Management > Custom Fields.
On the Custom Fields screen, click Add Custom Field.
In the Add New Custom Field dialog box, add the Name and Module (both required), a Description, and choose a Data Type.
You can add multiple custom fields for a single Module, but the Name must be unique.
Click Save. The new Custom Field is available for use.
Modules
Here is a list of modules you can choose to add a new custom field:
Address | Error | Product Category Assignment | Transaction Address |
Alternate Id Type | Gift Card | Product Inventory | Transaction Comment |
Bulk Price | Gift Card Activity | Product Option | Transaction Discount |
Category Set | Image | Product Option Value | Transaction Line |
Category Set Category Assignment | Kit | Product Unit | Transaction Line Discount |
Company, Address | Kit Component | Product Variant | Transaction Payment |
Company Category Assignment | Location | Product Variant Alternate Id | Transaction Tax |
Company Relationship | Location Address | Product Variant Category Assignment | Transaction Tracking |
Customer | Location Group | Product Variant Inventory | Variant Kit |
Customer Category | Location Group Location Assignment | Product Variant Option | Variant Kit Component |
Customer Category Assignment | Message | Related Product | Variant Related Product |
Customer Company | Payment Method | Shipping Method |
|
Customer Relationship | Product | Timesheet |
|
Employee | Product Alternate Id | Timesheet Entry |
|
Employee Address | Product Category | Transaction |
|
Data Type
After selecting a module, select a Data Type.
None | Encrypted |
String | Password |
Number | Enum |
Bool | Date |
Guid | Datetime |
Adding Custom Fields to a Data Model
While each custom field can hold different information, adding a field is the same for all data models.
To add a Custom Field:
Click Data Management and choose a data model. For example, choose Customers.
Select a customer in the list. You can also use the filter and search fields or search by External ID.
In the Custom Fields section, click Add.
In the Add Custom Field dialog, select a Key and a Value.
Click Apply, and the information is added to the record.
NOTE: iPaaS.com does not validate the Value you entered.
Editing Custom Fields
You can edit a custom field to update the Key or Value.
To edit a custom field:
On the edit screen, select the field from the list and click the edit icon.
In the Edit Custom Field dialog, make changes to the Key and Value. Click Apply, and your changes are saved.