AJAX - Function - Populate

From All n One's bxp software Wixi

Jump to: navigation, search

1 Primary Function

This AJAX function allows for dynamic listing of the contents of another form in a drop down lists (<select>) field.

2 Example uses

  • Population of a drop down list from another form, when the limiting criteria ARE NOT know when the form first appears.
  • Product drop down list in Form 2 of all the items in Form 1, but not using the CDA Id
  • Person listing of all the staff in Form 2 associated with the current company in form 1.

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

		// 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] 		= 'Populate';                 										//Engine to use
		aryAjax_Settings[3] 		= 1;																	//The form with the data
		aryAjax_Settings[4] 		= 'strCDA_1_field_0_0'; 												//The field to search on
		aryAjax_Settings[5] 		= document.getElementById('strCDA_2_field_0_0').value; 					//The value to limit by
		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] 		= 'strCDA_1_field_0_1';											//The field in the other campaign to be returned order = value, text
		aryAjax_Settings[12] 		= 'Name of cust';                       									//Headings for xml troubleshooting
		aryAjax_Settings[17] 		= 'strCDA_2_field_0_1';   												//The field in the current campaign into which the products will be inserted.
		aryAjax_Settings[28] 		= '';																	//Function to be executed after retrieval
		//Function specific settings
		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

Warning: When you use this function it will wipe the contents of the drop downlist first.
Try using PopulateNoClear_AltList instead to keep the current list contents.

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