CeRecordAPI Reference - Revision history

Gcronkright: /* Minimal Configuration */

2025-02-06T19:13:27Z

‎Minimal Configuration

Gcronkright: /* Minimal Configuration */

2025-02-06T19:10:54Z

‎Minimal Configuration

Gcronkright at 17:53, 6 February 2025

2025-02-06T17:53:09Z

Gcronkright: /* updateRecord() */

2025-02-06T17:49:46Z

‎updateRecord()

Gcronkright: /* mdfRecord */

2025-02-06T17:47:42Z

‎mdfRecord

Gcronkright: /* Minimal Configuration Needed */

2025-02-06T17:39:15Z

‎Minimal Configuration Needed

Gcronkright: /* ADF ceRecord API Methods */

2025-02-06T17:38:59Z

‎ADF ceRecord API Methods

Gcronkright: /* convertNewWinParamsToArgs() */

2025-02-06T16:49:38Z

‎convertNewWinParamsToArgs()

Gcronkright: /* convertNewWinParamsToArgs() */

2025-02-06T16:49:21Z

‎convertNewWinParamsToArgs()

Gcronkright: /* convertImageDataValueStr() */

2025-02-06T16:44:22Z

‎convertImageDataValueStr()

@@ Line 4: / Line 4: @@
 The ceRecord API wrapper functions for Global and Local Custom Elements serve as replacements for the CCAPI functions: apiElement.populateCustom() and csContent.populateContent(). Additionally, the ceRecord API includes functions that can be used with Metadata Form Elements and Simple Form Elements.
-===Minimal Configuration===
+===Minimal Configuration for Global Custom Elements===
 Unlike the extra configuration required to set up the CCAPI, the new ceRecordAPI requires minimal to no configuration. Additional CommonSpot configuration is only needed if the script being used allows data modifications of a Global Custom Element by users with permissions lower than those set by the GCE's security permissions. In such cases, registering the script as a CommonSpot [[Privileged Module Configuration|Privileged Module]] would be required.

@@ Line 5: / Line 5: @@
 ===Minimal Configuration===
-Unlike the extra configuration required to set up the CCAPI, the new ceRecordAPI requires minimal to no configuration. Additional CommonSpot permissions configuration is only needed if the script being accessed allows data modifications by users with permissions lower than those set by the element's security. In such cases, registering the script as a CommonSpot [[Privileged Module Configuration|Privileged Module]] would be required.
+Unlike the extra configuration required to set up the CCAPI, the new ceRecordAPI requires minimal to no configuration. Additional CommonSpot configuration is only needed if the script being used allows data modifications of a Global Custom Element by users with permissions lower than those set by the GCE's security permissions. In such cases, registering the script as a CommonSpot [[Privileged Module Configuration|Privileged Module]] would be required.
 For more details on registering Privileged Modules review this page: [[Privileged Module Configuration|Privileged Module Configuration]].

@@ Line 1: / Line 1: @@
 =ADF ceRecord API Methods=
-TThe ADF ceRecord API is a collection of wrapper functions designed for CommonSpot 11's Custom Data API. This Custom Data API allows developers to add and update specific user-defined CommonSpot objects, such as Global Custom Elements, Local Custom Elements, Custom Metadata Forms, and Simple Form Elements.
+TThe ADF ceRecord API is a collection of wrapper functions designed for CommonSpot 11's Custom Data API. This Custom Data API allows developers to add and update specific user-defined CommonSpot objects, such as Global Custom Elements, Local Custom Elements, Metadata Form Elements, and Simple Form Elements.
-The ceRecord API wrapper functions for Global and Local Custom Elements serve as replacements for the CCAPI functions: apiElement.populateCustom() and csContent.populateContent(). Additionally, the ceRecord API includes functions that can be used with Custom Metadata Forms and Simple Form Elements.
+The ceRecord API wrapper functions for Global and Local Custom Elements serve as replacements for the CCAPI functions: apiElement.populateCustom() and csContent.populateContent(). Additionally, the ceRecord API includes functions that can be used with Metadata Form Elements and Simple Form Elements.
 ===Minimal Configuration===
@@ Line 118: / Line 118: @@
 == mdfRecord ==
 === updateRecord() ===
-Updates a metadata form record bound to a page.
+Updates a metadata form element record bound to a page.
 Arguments:
-* '''mdFormName''' - The name of the Custom Metadata From where the specified record will be updated.
+* '''mdFormName''' - The name of the Metadata Form Element where the specified record will be updated.
 * '''pageID''' - The pageID value for the page where the metadata record to be added/updated
 * '''dataValues''' - The fieldname/value pairs structure of the record to be updated

@@ Line 137: / Line 137: @@
 ** error: struct (key added only on error)
-  Note: There is no 'addRecord' function for modifying Metadata Form Elements data because these records are inherently tied to a CommonSpot page. When a new page is created, a corresponding metadata form record is automatically generated. As a result, only an 'updateRecord' function is available 'mdfRecord' ceRecord API Library.
+  Note: There is no 'addRecord' function for modifying Metadata Form Elements data because these records are inherently tied to a CommonSpot page. When a new page is created, a corresponding metadata form record is automatically generated. As a result, only an 'updateRecord' function is offered in the mdfRecord ceRecord API Library.
 == sfsRecord ==

← Older revision		Revision as of 17:47, 6 February 2025
Line 137:		Line 137:
	** error: struct (key added only on error)		** error: struct (key added only on error)

		+	Note: There is no 'addRecord' function for modifying Metadata Form Elements data because these records are inherently tied to a CommonSpot page. When a new page is created, a corresponding metadata form record is automatically generated. As a result, only an 'updateRecord' function is available 'mdfRecord' ceRecord API Library.

	== sfsRecord ==		== sfsRecord ==

@@ Line 420: / Line 420: @@
 ===convertNewWinParamsToArgs()===
-Converts a new window param string to the correct format for the fldRenderer.formatNewWindowParams() function. Utility function for the convertExtendedUrlDataValueToArgs() convert function.
+Converts a new window param string to the correct format for the fldRenderer.formatNewWindowParams() function. Utility function for the convertExtendedUrlDataValueToArgs() convert function. Utility function for the convertExtendedUrlDataValueToArgs() convert function.
 Arguments:
 * '''paramsList''' - string

@@ Line 454: / Line 454: @@
 ** captionText - string
-===convertImageDataValueStr()===
+===convertImageDataValueToStr()===
 An ADF wrapper function for CE Record API formatValue_Image() that returns a CS image formatted string
 Arguments: