ebs.getFormEntity

Retrieves the current record's attributes from a displayed form.

NOTE  
ebs.getFormEntity reads the corresponding record's attributes' values from the databse, not from the currently displayed form fields.
Also see formData.model.

Syntax

Copy 
function getFormEntity(htmlId: any): any;
 
Parameter Type Description
htmlId any ID of the form's HTML element. Also see formData.name.

Retun Value

Returns a JSON object containing key-value pairs for all the corresponding record's attribute names and attribute values, including attributes that are not currently displayed on the form, for example:

Copy 
{
    aLookup1_name: "Newbie"
    aLookup2_name: "root"
    aLookup3_userName: "host"
    aLookup4_name: "Active"
    aLookup5_userName: "host"
    aLookup6_Name: "Bucharest"
    aLookup7_name: null
    aLookup8_name: null
    aLookup9_userName: "host"
    businessStatusId: "480b5d57-8360-411d-9af4-a2ee19ed5cff"
    businessStatusId_displayname: "Newbie"
    businessUnitId: "a3d2909b-df67-49d6-b7e0-2dc912c12484"
    businessUnitId_displayname: "root"
    createdByUserId: "4afdc8a9-eb91-4359-81d6-c3a462fae866"
    createdByUserId_displayname: "host"
    createdOn: "2020-10-23T10:41:35Z"
    entityStatusId: "faccc388-151a-4c83-8953-cbac7d6c442a"
    entityStatusId_displayname: "Active"
    firstName: "Johnathan"
    lastName: "Doe"
    modifiedByUserId: "4afdc8a9-eb91-4359-81d6-c3a462fae866"
    modifiedByUserId_displayname: "host"
    modifiedOn: "2020-10-27T11:47:44Z"
    myCity: "55d4c9b4-2400-40ff-9025-ef6903c3e2c8"
    myCity_displayname: "Bucharest"
    name: "mrJDoe"
    nextBusinessStatusId: null
    nextBusinessStatusId_displayname: null
    previousBSId: null
    previousBSId_displayname: null
    primaryattributedisplayname: "mrJDoe"
    score_score: "B++"
    sdkEntity_myLookup: "one of the first"
    sdkTestid: "ff41b9bf-1506-42b4-a518-1121b9d0250a"
    userId: "4afdc8a9-eb91-4359-81d6-c3a462fae866"
    userId_displayname: "host"
}

Examples

In this example:

  • We save the date and time when the current record was created in the registrationDate variable.
  • We use the formData.name method to retrieve the ID of the form's HTML element.
  • The creation date is stored in the record's createdOn system attribute (which is not displayed on the current form).
Copy 
var registrationDate = ebs.getFormEntity(formData.name).createdOn