Adaptive Planning Functions

Context Parameter

The Test Connection is provided with 1 parameter, 'context'.

Example

function testConnection(context) {
    // Step 1: Create a https request to send to Intacct API
    var url = 'https://www.intacct.com/ia/xml/xmlgw.phtml';
    var method = 'POST';
    var body = '<request><control><senderid>adaptiveplanning</senderid><password>examplepassword</password><controlid>SomeRandomThingToMatchToResponse</controlid><dtdversion>3.0</dtdversion></control><operation><authentication><login><userid>Julia</userid><companyid>companyplanning-DEV</companyid><password>Welcome1</password></login></authentication></operation></request>';
    var headers = { 'Content-Type': 'x-intacct-xml-request' };



    // Step 2: Send request and receive response
    var response = ai.https.request(url, method, body, headers);



    // Step 3: Interrogate response to see if it was successful. Return true or false depending on the result.
    // Check that http communication was successful
    if (response.getHttpCode() == '200') {
        var body = response.getBody();
        // Parse body and look for a success flag. Body could be xml or json depending on the use case.



        // ******* parsing logic here *******



        return true;
    } else {
        return false;
    }
}

Context Parameter

The Import Structure function is provided with 1 parameter, 'context'.

Example

function importStructure(context) {
    // Step 1: Get the structure builder.
    var builder = context.getStructureBuilder();



    // Step 2: Create and configure tables and columns that represent objects in the external system. In this example, I only created a sample of the GLACCOUNT table columns.
    var table = builder.addTable('GLACCOUNT');
    table.setDisplayName('GLACCOUNT');



    var recordColumn = table.addColumn('RECORDNO');
    recordColumn.setIntegerColumnType();
    recordColumn.setDisplayName('RECORDNO');
    recordColumn.setDisplayOrder('0');
    recordColumn.setIncludeByDefault(true);
    recordColumn.setRemoteColumnType('integer');



    var accountNoColumn = table.addColumn('ACCOUNTNO');
    accountNoColumn.setTextColumnType(96);
    accountNoColumn.setDisplayName('ACCOUNTNO');
    accountNoColumn.setDisplayOrder('1');
    accountNoColumn.setIncludeByDefault(true);
    accountNoColumn.setRemoteColumnType('string');



    var titleColumn = table.addColumn('TITLE');
    titleColumn.setTextColumnType(80);
    titleColumn.setDisplayName('TITLE');
    titleColumn.setDisplayOrder('2');
    titleColumn.setIncludeByDefault(true);
    titleColumn.setRemoteColumnType('string');



    var accountTypeColumn = table.addColumn('ACCOUNTTYPE');
    accountTypeColumn.setTextColumnType(2048);
    accountTypeColumn.setDisplayName('ACCOUNTTYPE');
    accountTypeColumn.setDisplayOrder('3');
    accountTypeColumn.setIncludeByDefault(true);
    accountTypeColumn.setRemoteColumnType('string');
}

Functions

Example

function importStructure(context) {    
    ..........
 
 
    var progressManager = context.getProgressManager();
 
 
    // Set script progress % to 10
    progressManager.setProgress(10);
 
 
    // Increase script progress % to 50
    progressManager.setProgress(50.0);
 
 
    // Set progress to 100 by using value greater than 100
    progressManager.setProgress(230);
    progressManager.getProgress(); // returns 100
 
 
    // Increase progress by 10% based on current progress
    progressManager.setProgress(progressManager.getProgress() + 10);
 
 
 
 
    ..........
    return builder;
 }

Functions

Examples

Provides the ability to define the tables and column structure that will be populated by data.

function importStructure(context) {


   var builder = context.getStructureBuilder();


   var table = builder.addTable('InvoiceTable');
   table.setDisplayName('Invoices');    


   var amountColumn = table.addColumn('Amount');
   amountColumn.setIntegerColumnType();
   amountColumn.setDisplayName('AmountCol');
   amountColumn.setDisplayOrder('2');
   amountColumn.setIncludeByDefault();
   amountColumn.setIncludeInKey();


   var textColumn = table.addColumn('TextValue');
   textColumn.setTextColumnType(99);
   textColumn.setDisplayName('TextColumn');
   textColumn.setDisplayOrder('4');
   textColumn.setRemoteColumnType('string');


   var booleanColumn = table.addColumn('IsTrue2');
   booleanColumn.setBooleanColumnType();
   booleanColumn.setDisplayName('BooleanCol');
   booleanColumn.setDisplayOrder('3');
   booleanColumn.setMandatoryForImports();
   booleanColumn.setRemoteColumnType('bit');


   var invoiceDateColumn = table.addColumn('InvoiceDate');
   invoiceDateColumn.setDateTimeColumnType();
   invoiceDateColumn.setDisplayName('InvoiceDateColumn');
   invoiceDateColumn.setDisplayOrder('1');
   invoiceDateColumn.setIncludeByDefault(true);


   var parameter = table.addParameter('Prompt for Records');
   parameter.setDisplayName('Records to Import');
   parameter.setForDataImport(true);
   parameter.setForStructureImport(true);
   parameter.setTypeInteger();
}

Functions

Functions

Functions

Context Parameter

The Import Data function is provided with 1 parameter, 'context'.

Example

This example assumes that the rowset contains an Integer column and a Text column in order.

function importData(context) {
   var rowset = context.getRowset();


   // Step 1: Get the data via https or a static source
   // In this example, I will create some fake data that matches the known column data types
   var rows = [];
   for (var i = 0; i < 2000; i++) {
       var row = [i, 'hello' + i];
       rows.push(row);
   }


   // Step 2: Add each row to the rowset
   for (var j = 0; j < rows.length; j++) {
       rowset.addRow(rows[i]);
   }
}

Functions

Context Parameter

The Preview Data Function is provided with 1 parameter, 'context'.

Example

Provides the ability to preview data stored in the cloud source.

function previewData(context) {
    // Step 1: Make use of passed in contextual information. Here, I am simply assigning tableId, maxRows and columnNames to variables to be used elsewhere in this script.
    var rowset = context.getRowset();
    var tableId = rowset.getTableId();
    var maxRows = rowset.getMaxRows();
    var columnNames = rowset.getColumnNames();



    // Step 2: Create a https request that will return data - in this case, Intacct will return JSON instead of XML.
    var url = 'https://www.intacct.com/ia/xml/xmlgw.phtml';
    var method = 'POST';
    var body = '<request><control><senderid>adaptiveplanning</senderid><password>examplepassword</password><controlid>SomethingToMapRequestToResponse</controlid><dtdversion>3.0</dtdversion></control><operation><authentication><login><userid>Julia</userid><companyid>companyplanning-DEV</companyid><password>Welcome1</password></login></authentication><content><function controlid="SomethingToMapRequestToResponse"><readByQuery><object>' + tableId + '</object><fields>' + columnNames.join(",") + '</fields><query></query><pagesize>' + maxRows + '</pagesize><returnFormat>json</returnFormat></readByQuery> </function></content></operation></request>';
    var headers = { 'Content-Type': 'x-intacct-xml-request' }



    // Step 3: Send https request and receive response. Normally you would want to check that the response contains a success message first before looking at the rows.
    var response = ai.https.request(url, method, body, headers);



    // Step 4: Since we requested JSON as the response format, we need to parse the https response body into a JSON object for ease of use.
    var rows = JSON.parse(response.getBody());



    // Step 5: Process each row to extract the cell values for each column and add them as an array to the rowset in the expected column order.
    // In this case, each 'row' is represented as a single JSON object, where each property is the name of the column and each value of each property is the cell value for the row's column.
    for (var i = 0; i < rows.length; i++) {
        var cells = [];
        var row = rows[i];
        for (var key in row) {
            cells.push(row[key]);
        }
        rowset.addRow(cells);
    }
}