executeLookup

Method Type

JavaScript

Description

Does a lookup.

  • The lookup must exist under the same process group for the app where the eForm runs.
  • The result is returned as an array of objects that match the lookup.

Parameters

The method input is an object with these parameters, and a callback function.

Field NameDefinition

lookupName
Function:
Specifies the lookup for the form control to change.
Type
string
Accepted Values:
The lookup name of your form control.

lookupType
Function:
Specifies the lookup type for the form control to change.
Type
string
Accepted Values:
  • eFormHelper.constants.lookuptype.multicolumn - Changes a multiple column lookup.
  • eFormHelper.constants.lookuptype.namevalue - Changes a name/value lookup.

Output

A result object that gives the status, data, and error details.

Field NameDefinition

isSuccess
Function:
Specifies whether a pop-up shows when the method completes successfully.
Type
bool
Accepted Values:
  • True - The method was successful.
  • False - The method was not successful.

data
Function:
Holds a lookup result.

error
Function:
Specifies an error message if an error occurs.
Type
string
Accepted Values:
The contents of an error message.

Example

var options = {};
options.lookupName = 'GetUserDetails';
options.lookupType = eFormHelper.constants.lookuptype.multicolumn; ('user\\lookupmulticolumn')
// multicolumn:eFormHelper.constants.lookuptype.multicolumn;
// namevalue:eFormHelper.constants.lookuptype.namevalue;
eFormHelper.executeLookup(options, function (result) 
  {
  if (result.isSuccess) 
    {
    console.log(result.data); //logs the data which holds the lookup result
    }
  else 
    {
    console.log(result.error); // logs the hold exception object 
    }    
});

Supported Versions

AgilePoint NX v6.0 and higher

Other Examples

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

  • AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
  • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
  • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.