Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Know the Name of the Service Data Object.

    Code Block
    languagejs
    linenumberstrue
    var getPILQuantityDataObject = "spGetProductInventoryLedgerQuantities";
    
  2. Know the parameters you need and their values.

    Code Block
    languagejs
    linenumberstrue
    var getPILQuantityParams = {
    	"ProductInventoryLedgerID": 1
    };
  3. Define success and error callback functions. Of course, you can define these anonymously in the actual call to executeDataObject(), but that call will be more succinct and readable if you define them separately.

    Code Block
    languagejs
    titleDefine A Success Callback
    linenumberstrue
    function _onGetPILQuantitySuccess(data) {
    	// data.results contains the table produced by the Service Data Object
        // The table is represented as a 0-indexed array of rows.
        // A row is represented as a JavaScript Object with properties 
    	// that have the names of the columns returned by the Service Data Object
    	if (data && data.results.length > 0) {
    		// Handle each row of the table
    	}
    } 
    Code Block
    languagejs
    titleDefine An Error Callback
    linenumberstrue
    function _onGetPILQuantityError(error) {
    	throw ({ type: "internal_error", message: "An error occurred while calling " + getPILQuantityDataObject + " Service Data Object." });
    }
  4. Call Aptify.framework.dataObjects.executeDataObject() to execute the Service Data Object.

    Note

    Best practice is to check that Aptify Web is actually online before making the call, since the Service Data Object is executed on the server side.

    Code Block
    languagejs
    titleExecute A Service Data Object
    linenumberstrue
    if (Aptify.framework.utility.online()) {
    	Aptify.framework.dataObjects.executeDataObject({
    		name: getPILQuantityDataObject,
    		parameters: getPILQuantityParams,
    		successCallback: _onGetPILQuantitySuccess,
    		errorCallback: _onGetPILQuantityError
    	});
    }
    else {
    	// Handle offline condition
    }

 

Related

...

topics

Filter by label (Content by label)
showLabelsfalse
max5
spacesPK55
sortmodified
showSpacefalse
reversetrue
typepage
labelsaptify-javascript-api service-data-object sql nonvisual-javascript-api