Difference between revisions of "AJAX - Function - Append"
From All n One's bxp software Wixi
Philip Lacey (talk | contribs) (Created page with "= Overview = Under construction AJAX_-_Start_Here Category:Topic:JavaScript Category:Topic:AJAX") |
Philip Lacey (talk | contribs) |
||
Line 1: | Line 1: | ||
− | = | + | = Primary Function = |
+ | |||
+ | |||
+ | Retrieves data from a form and appends it to fields on the current page. | ||
+ | |||
+ | |||
+ | |||
+ | = Example uses = | ||
+ | |||
+ | |||
+ | * Quick population of an order form with company details from another form | ||
+ | * Quick population of a contact record with details of an account from another form | ||
+ | |||
+ | |||
+ | |||
+ | = Code = | ||
+ | |||
+ | |||
+ | <syntaxhighlight lang="javascript"> | ||
+ | |||
+ | /****************************************************************************************************** | ||
+ | Application: This function ............ | ||
+ | Version [1.0] Date [2016-08-29] Author [PJ] | ||
+ | ******************************************************************************************************/ | ||
+ | function fn_FunctionName(){ | ||
+ | if (typeof aryAjax_Settings=='undefined') { alert('Library did not load'); } | ||
+ | else { | ||
+ | // Clear all settings | ||
+ | fn_Ajax_bxp_ResetSettings(); | ||
+ | |||
+ | // Security Settings | ||
+ | aryAjax_Settings[0] = 'client_demo'; | ||
+ | aryAjax_Settings[22] = document.getElementById('intSystemGenerated_CompanyId').value; //Auto Login - System | ||
+ | aryAjax_Settings[23] = document.getElementById('intSystemGenerated_UserId').value; //Auto Login - User | ||
+ | aryAjax_Settings[24] = document.getElementById('intSystemGenerated_LoginKey').value; //Auto Login - SessionId | ||
+ | |||
+ | // Retrieval Settings | ||
+ | aryAjax_Settings[16] = 'Append'; //Engine to use | ||
+ | aryAjax_Settings[3] = 1; //The form with the data | ||
+ | aryAjax_Settings[4] = 'intCDA_1_Id'; //The Id field to match on | ||
+ | aryAjax_Settings[5] = document.getElementById('strCDA_2_field_0_0').value; //The Id of the CDA record with the data | ||
+ | aryAjax_Settings[13] = '-1' //Limit response | ||
+ | aryAjax_Settings[40] = "500"; //Retrieval limit if applicable | ||
+ | |||
+ | //Error management | ||
+ | aryAjax_Settings[15] = 'divWarning'; //Where to draw error messages if any | ||
+ | |||
+ | //Common Functional settings | ||
+ | aryAjax_Settings[6] = 'intCDA_1_Id,strCDA_1_field_0_1'; //The data fields to retrieve | ||
+ | aryAjax_Settings[12] = 'id,Name of cust'; //Headings for xml troubleshooting | ||
+ | aryAjax_Settings[17] = 'strCDA_2_field_0_1,strCDA_2_field_0_2'; //The fields to append the data to | ||
+ | aryAjax_Settings[28] = ''; //Function to be executed after retrieval | ||
+ | |||
+ | //Function specific settings | ||
+ | //... | ||
+ | |||
+ | //Execute | ||
+ | fn_Ajax_bxp_Process(); //The main execution of the AJAX | ||
+ | |||
+ | //Write URL out (Comment out after testing) | ||
+ | if (document.getElementById('divURL')){ | ||
+ | document.getElementById('divURL').innerHTML = "<a href='" + aryAjax_Settings[7] + "' target='_blank'>Constructed AJAX URL</a>"; | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | |||
+ | </syntaxhighlight> | ||
+ | |||
+ | |||
+ | |||
+ | = Troubleshooting = | ||
+ | |||
+ | |||
+ | For any errors messages and troubleshooting AJAX please read here [[AJAX_-_Error_messages_and_troubleshooting]] | ||
+ | |||
+ | |||
+ | |||
+ | = Associated reading = | ||
+ | |||
+ | |||
+ | For all our custom AJAX functions please read here [[AJAX_-_Start_Here]] | ||
+ | |||
+ | |||
+ | For the full array of all possible parameters please read here [[AJAX_-_Full_Array_of_Parameters]] | ||
+ | |||
+ | |||
+ | For how the security engine of AJAX works [[AJAX_-_Security_engine]] | ||
+ | |||
− | |||
[[Category:Topic:JavaScript]] | [[Category:Topic:JavaScript]] | ||
[[Category:Topic:AJAX]] | [[Category:Topic:AJAX]] |
Latest revision as of 09:03, 31 August 2016
1 Primary Function
Retrieves data from a form and appends it to fields on the current page.
2 Example uses
- Quick population of an order form with company details from another form
- Quick population of a contact record with details of an account from another form
3 Code
/******************************************************************************************************
Application: This function ............
Version [1.0] Date [2016-08-29] Author [PJ]
******************************************************************************************************/
function fn_FunctionName(){
if (typeof aryAjax_Settings=='undefined') { alert('Library did not load'); }
else {
// Clear all settings
fn_Ajax_bxp_ResetSettings();
// Security Settings
aryAjax_Settings[0] = 'client_demo';
aryAjax_Settings[22] = document.getElementById('intSystemGenerated_CompanyId').value; //Auto Login - System
aryAjax_Settings[23] = document.getElementById('intSystemGenerated_UserId').value; //Auto Login - User
aryAjax_Settings[24] = document.getElementById('intSystemGenerated_LoginKey').value; //Auto Login - SessionId
// Retrieval Settings
aryAjax_Settings[16] = 'Append'; //Engine to use
aryAjax_Settings[3] = 1; //The form with the data
aryAjax_Settings[4] = 'intCDA_1_Id'; //The Id field to match on
aryAjax_Settings[5] = document.getElementById('strCDA_2_field_0_0').value; //The Id of the CDA record with the data
aryAjax_Settings[13] = '-1' //Limit response
aryAjax_Settings[40] = "500"; //Retrieval limit if applicable
//Error management
aryAjax_Settings[15] = 'divWarning'; //Where to draw error messages if any
//Common Functional settings
aryAjax_Settings[6] = 'intCDA_1_Id,strCDA_1_field_0_1'; //The data fields to retrieve
aryAjax_Settings[12] = 'id,Name of cust'; //Headings for xml troubleshooting
aryAjax_Settings[17] = 'strCDA_2_field_0_1,strCDA_2_field_0_2'; //The fields to append the data to
aryAjax_Settings[28] = ''; //Function to be executed after retrieval
//Function specific settings
//...
//Execute
fn_Ajax_bxp_Process(); //The main execution of the AJAX
//Write URL out (Comment out after testing)
if (document.getElementById('divURL')){
document.getElementById('divURL').innerHTML = "<a href='" + aryAjax_Settings[7] + "' target='_blank'>Constructed AJAX URL</a>";
}
}
}
4 Troubleshooting
For any errors messages and troubleshooting AJAX please read here AJAX_-_Error_messages_and_troubleshooting
5 Associated reading
For all our custom AJAX functions please read here AJAX_-_Start_Here
For the full array of all possible parameters please read here AJAX_-_Full_Array_of_Parameters
For how the security engine of AJAX works AJAX_-_Security_engine