Create Custom Cloud Loaders

Basic Steps

Enter data source settings.
Define parameters.
Write JavaScript using the CCDS APIs in the ai Namespace.
Define business rules.
Run or schedule the loader.

Prerequisites

Verify that you have the Integration Developer permission.
Verify that
Adaptive Planning
plan data you want to export already exists in a staging table.
Create an OAuth credential for your external system, or obtain credentials you can explicitly include in your JavaScript.
Know what parameters you need to pass to your external system, and what defaults the external system expects.
Understand how to write to the external system's endpoint.

Navigation

From the nav menu, go to

Integration

Design Integrations

Enter Data Source Settings

Create a new Custom Cloud Loader

Access the Data Designer by going to
Integration > Design Integrations
.
In the Loaders folder in the Component Library select
Create New Loader
.
Select
Custom Cloud Loader
as the loader type and enter a name.
If you don't see Custom Cloud Loader as an option, it isn't enabled for this instance or you don't have the Integration Developer permission needed to access it.
Select
Create
.

Select the Source Table, Credential, and Log Level

Enter the Custom Cloud Loader's information:
Source Table:
Select a staging table containing
Adaptive Planning
planning data you want to export.
Require Credential:
Select if the external system requires OAuth and you require a user with Integration Operator permission to select the appropriate OAuth credential.
Credential:
Select a preexisting OAuth credential.
Log Level:
Select how much detail to log when the loader runs:
Error
:
Only logs errors.
Info
:
Logs all basic information, such as when the data source was updated.
Verbose
:
Provides very detailed information about all phases and actions. Used primarily for debugging or auditing, as it may produce more log information than practical for typical use.
Click
Save
in the actions menu.

Define Parameters

Select
Designer Settings.
Drag Parameterized or Static setting items from the
Settings Component
pane into
Designer Settings.
Parameterized setting values entered here become loader defaults if you don't provide another one at loader run time.
Static settings you enter here get used every time the loader runs and don't require input at run time.
Boolean: A value represented as one or zero.
Dimension: A dimension from the dimension admin within
Adaptive Planning
.
Integer: A non-negative whole number.
Password: A password. This value cannot be viewed once it is saved.
Period Range: A time period range from within
Adaptive Planning
.
Text: An alphanumeric value.
Double click a parameter item to enter a name and change its value.
Drag in as many items as you need to reference in your JavaScript.
Save the loader.
Use a parameter's name in your JavaScript to reference it.

Write JavaScript

Select
Script
.
Select the preexisting template and change it or select
New Script
to make your own.
Write the javaScript you want the loader to execute using the CCDS APIs in the ai Namespace.
Verify the script includes the required:
testConnection
function to create an https request to post to your external system
exportData
function to export data from
Adaptive Planning
. See Export Data Function (Custom Cloud Loader Only) in the Adaptive Planning Functions topic.
Reference any parameters you created in the Designer Settings by their name.
Save the script.

Use OAuth in Custom Cloud Loader Scripts

Select
Request Authorization
before running the loader.
Provide any additional authorization details, such as scope, needed for the external system endpoint.
Select
Test Connection
to verify the OAuth credentials passed successfully to the endpoint.
Note the authorization date and user ID in the Authorization Status. Authorization expiration dates vary from one external system to another. Select Reset Authorization in the Actions pane to reauthorize when needed.

Define Business Rules

Select the
Business Rules
tab.
Select
Edit
.
Enter an SQL expression. You can click an item in Available Columns to bring that column into the SQL expression instead of typing it.
Select
Apply
to check your syntax. Errors turn the border around the expression red. Hover the expression to see syntax error information.
Correct any errors in your syntax and select
Apply
. Only staging rows that match the SQL expression will load.

Include the Custom Cloud Loader in an Integration Task

Sample CCL Script

Set up a spreadsheet data source.
Create a new Custom Cloud Loader in the
Loaders
pane.
Navigate to the
Data Source Settings
tab and select your spreadsheet Data Source in the
Source Table
field.
Copy the below sample script in the
Scripts
tab.
 // Manually invoke this method via 'Test connection'
function testConnection(context) {
    return true;
}
// Manually invoke this method via 'Run manually'
function exportData(context) {
   //"xxx" is the name of your Amazon S3 bucket. 
    var bucketName = 'xxx';
    //Name of the sample CSV file to which data from your spreadsheet data source is exported
    var key = 'exampleTest.csv';
    //"xxxx" is the access key for your AWS S3 bucket.
    var awsAccessKey = 'xxxx';
    //"xxxx" is the secret key of your AWS S3 bucket. 
    var awsSecretKey = 'xxxx';
    var region = 'us-west-1';
    // Step 1: Get the data
    var reader = context.createTableReader();
    // Step 2: Process and export the data
    var result = "Column,Heading,Names\n";
    var row = null;
    while ((row = reader.readRow()) !== null) {
       // remove meta columns we don't need
       row.length = row.length - 2;
       result += row.join() + '\n';
   }
    ai.awss3.putFile(bucketName, key, result, region, awsAccessKey, awsSecretKey);
} 
Select
Save
in the
Actions
pane.
To execute the script, select
Run Manually
in the
Actions
pane.