This topic relates to the first generation of Integration Rules. Contact your FinancialForce representative for information about the suitability and availability of the next generation of integration rules (ClickLink).
Here is a description of the fields that together make up an integration rule.
Key: R – Read-only in all contexts ; * – Mandatory field; B – Type 2b Rules (Custom Buttons) only
The number indicates the number of characters that are allowed in this text field, where appropriate.
| Field | Description | ||
|---|---|---|---|
| Description | 255 | Description of this integration rule. | |
| Name | * | 80 | Unique name for the integration rule. |
| Show Button Code | R | B | Expander panel that displays the JavaScript code needed to create the custom button on the source object that will be used to create sales invoices or credit notes. |
Key: A – Type 2a, 2b (optional) Type 2c (mandatory); C – Cash Entry only
| Field | Description | ||
|---|---|---|---|
| Document Number | A | Source object field to be updated with the document number for each record which is processed. The selected field must be of type "Lookup Relationship". | |
| Multi-line Cash Entry | C | Indicates that you want to create a single, multi-line cash entry, as opposed to individual cash entries for each record in the custom object. | |
| Processed Indicator | A | Source object field that indicates if a record has been processed. The selected field must be of type "Checkbox". | |
| Source Object | Object from which you want to retrieve data. | ||
| Target Object | FinancialForce object to receive the data, or sales invoice or credit note object on which you want to make custom fields available. |
Key: E – Read access must be enabled as well.
| Field | Description | |
|---|---|---|
| Target Field |
Field which you want to make available for reading, writing or printing. |
|
| For Reading | Indicates that you want to enable read access for the target field on the target object in FinancialForce and for applications that use the API. |
|
| For Writing | E | Indicates that you want to enable write access for the target field on the target object in FinancialForce and for applications that use the API. |
| For Printing | Indicates that you want to show this field and its value on printed sales documents. |
| Field | Description |
|---|---|
| Source Field | Field on the master object from which you want to retrieve the information. |
| Target Field | Field into which you want information inserted. |
| Field | Description |
|---|---|
| Source Detail Object | Object from which you want to retrieve data. |
| Target Detail Object | FinancialForce object to receive the data, or sales invoice or credit note line item object on which you want to make custom fields available. |
Key: E – Read access must be enabled as well.
| Field | Description | |
|---|---|---|
| Target Field | Field which you want to make available for reading, writing or printing. | |
| For Reading | Indicates that you want to enable read access for the target field on the target detail object in FinancialForce and for applications that use the API. |
|
| For Writing | E | Indicates that you want to enable write access for the target field on the target detail object in FinancialForce and for applications that use the API. |
| For Printing | Indicates that you want to show this field and its value on printed sales documents. |
| Field | Description |
|---|---|
| Source Field | Field on the detail object from which you want to retrieve the information. |
| Target Field | Field into which you want information inserted. |
The following buttons are available:
| Button | Description |
|---|---|
New Line |
Adds a new field mapping. |
|
Removes the selected field mapping. |
| Cancel | Cancels the current session without saving. |
| Save | Saves the integration rule. |
Related Concepts
Related Tasks
Creating Integration Rules - Type 1
Creating Integration Rules - Type 2
Automatically Generating Sales Invoices
Automatically Generating Cash Entries
Reference