ebs.insertAsync (Deprecated)

(FintechOS Studio 20.2 and later)

IMPORTANT!
This function has been deprecated starting with v24.1. To re-enable it, use the the sys-do-not-allow-client-side-direct-data-updates system parameter.

Asynchronously adds a new record to an entity. The result of the operation is returned in a promise object.

Syntax

Copy

ebs.insertAsync(modifyRequest: IModifyRequest): Promise<any>

Where IModifyRequest has the following syntax:

Copy

{
    EntityName: "<<i>parent_entity</i>>",
    Values: [
        {
            Attribute: "<<i>attribute_name</i>>",
            Value: "<<i>attribute_value</i>>"
        },
        ...
        {
            Attribute: "<<i>attribute_name</i>>",
            Value: "<<i>attribute_value</i>>"
        },
    ]
}

Parameter	Description
`parent_entity`	Name of the entity where you wish to insert the record.
`attribute_name`	Attribute name of the record you wish to insert.
`attribute_value`	The value you wish to insert for the record's attribute.

Result

The promise result is a JSON object containing key-value pairs detailing the insert operation, such as the ones listed below:

Key	Description
`Id`	Unique identifier of the record you inserted.
`Message`	Indicates the outcome of the call.
`IsSuccess`	Indicates if the record insert was successful.

Example result of an ebs.insertAsync operation

Copy


{
    "Id": "ff9eceba-cf74-48f2-9310-2f99499606b4",
    "Message": "Record inserted",
    "IsSuccess": true,
    "ClientScript": null,
    "ErrorCode": 0,
    "Serialized": "{\"Id\":\"ff9eceba-cf74-48f2-9310-2f99499606b4\",\"Message\":\"Record inserted\",\"IsSuccess\":true,\"ClientScript\":null,\"ErrorCode\":0,\"Serialized\":null,\"UIResult\":null,\"AdditionalInfo\":{\"dynamicDefinitionFileTimestamps\":{\"formulaBuiltinFunctions\":\"D82FBF028DAF2407DCC7260CA2BD97547FD18465\",\"formulaArguments\":\"B20C128701FEABDA3B06FF0D5DADCC57ACF9E2A0\",\"formulaCoefficients\":\"B20C128701FEABDA3B06FF0D5DADCC57ACF9E2A0\",\"formulaSteps\":\"B20C128701FEABDA3B06FF0D5DADCC57ACF9E2A0\",\"importedLibraries\":\"DEC83931C8203B7BADA73F3B13EEA3799CA5C5B5\",\"workflowParameters\":\"CDF5A6F8C40D93DAFA63C9676475D625F8E80E48\",\"webApiClientLibraryHeaders\":\"20E61D1496E587A0009ADADE9C84693D814A5F88\",\"nativeLibraries\":\"888EC2F0316C702C006E1F345C30F50065C8C785\",\"webApiClientLibrary\":\"9676CDF38BB6C1F9D717C8DA7AAE2D047EEFD12A\",\"workflowDelegateManager\":\"622B755023A9733853D7C3DD4A15044310848E63\",\"workflowFluentQueryGlobal\":\"C657BF199C56BD61358A20FA03A83E485ED927B0\",\"workflowFluentQueryEntity\":\"7F7605F7F2BE743B01B8D0DDA8270D8BDBDA6658\",\"workflowClientCertificates\":\"3AE488FB4CDC7CDE3C5F88FBF1B736E4FB2B5AAA\",\"workflowTransientData\":\"3AE488FB4CDC7CDE3C5F88FBF1B736E4FB2B5AAA\"}}}",
    "UIResult": null,
    "AdditionalInfo": {
        "dynamicDefinitionFileTimestamps": {
            "formulaBuiltinFunctions": "D82FBF028DAF2407DCC7260CA2BD97547FD18465",
            "formulaArguments": "B20C128701FEABDA3B06FF0D5DADCC57ACF9E2A0",
            "formulaCoefficients": "B20C128701FEABDA3B06FF0D5DADCC57ACF9E2A0",
            "formulaSteps": "B20C128701FEABDA3B06FF0D5DADCC57ACF9E2A0",
            "importedLibraries": "DEC83931C8203B7BADA73F3B13EEA3799CA5C5B5",
            "workflowParameters": "CDF5A6F8C40D93DAFA63C9676475D625F8E80E48",
            "webApiClientLibraryHeaders": "20E61D1496E587A0009ADADE9C84693D814A5F88",
            "nativeLibraries": "888EC2F0316C702C006E1F345C30F50065C8C785",
            "webApiClientLibrary": "9676CDF38BB6C1F9D717C8DA7AAE2D047EEFD12A",
            "workflowDelegateManager": "622B755023A9733853D7C3DD4A15044310848E63",
            "workflowFluentQueryGlobal": "C657BF199C56BD61358A20FA03A83E485ED927B0",
            "workflowFluentQueryEntity": "7F7605F7F2BE743B01B8D0DDA8270D8BDBDA6658",
            "workflowClientCertificates": "3AE488FB4CDC7CDE3C5F88FBF1B736E4FB2B5AAA",
            "workflowTransientData": "3AE488FB4CDC7CDE3C5F88FBF1B736E4FB2B5AAA"
        }
    }
}

Examples

Add a record to the sales pipeline

An insurance company uses FintechOS for sales management. The company has a website which allows users to request information about the products and services. When users complete and submit the form, the ebs.insertAsync method is automatically triggered, creating a new record within the lead pipeline of the sales team.

The entity storing the leads is account.
The name and surname of the inserted lead are Derrick and Rose respectively.
If the insert is successful (IsSuccess: true), we log the Insert Successful message in the browser console. Otherwise, we log the Insert Failed message.

Copy

ebs.insertAsync({
    EntityName: "account",
    Values: [
        {Attribute: "name", Value: "Derrick"},
        {Attribute: "surname", Value: "Rose"}
    ]
})
    .then(function(result) {
        if (result.IsSuccess == true)
            console.log('Insert Successful')
        else
            console.log('Insert Failed')
    })