getSystemData

Method Type

JavaScript

Description

Gets the value of a specified system data variable.

The value is returned as an array of objects.

Parameters

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

Field NameDefinition

tokenNames

Function:
Specifies the name of the system data variable whose value to retrieve.
Type
string
Accepted Values:
A system data variable name specified for the application.

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 an empty object.

error

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

Example

var options = {};
  options.tokenNames = ["HomeDirectory", "SystemUserName"]; 
  // (or) options.tokenNames="HomeDirectory";
  //If only 1 token name, specify tokenNames as a string. If more than one token name, 
             specify tokenNames as an array. 
  eFormHelper.getSystemData(options, function (result) { 
  if (result.isSuccess) //Checks if the method completes successfully and 
                             returns a response.
    { 
      console.log (result.data); //Logs the data and displays an array of 
                                   variable names and values.
    }
  else 
    {
      console.log(result.error); //Logs the error and error description, if any.
    }
});

Supported Versions

AgilePoint NX v7.0 Software Update 2 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.