Skip to main content
Adaptive Planning
Last Updated: 2023-06-23
Define Parameters in Custom Cloud Data Sources (CCDS)

Define Parameters in Custom Cloud Data Sources (CCDS)

You can add and configure parameterized (dynamic), static, and configuration (SFTP/PGP) parameters to your script via the
Designer settings
tab. Example: Connection URLs, user names, passwords, start and end address for a mapped delivery route, time periods, and other information. See Reference: Parameters for information about the various parameter types.

Before you Begin

  • Required Permissions:
    Integration Developer
    within
    Administration > Permission Set.
  • CCDS Developers must be experienced JavaScript programmers.
  • Determine what type of information the Data Designer should fill in.

Navigation

Compass.png From the nav menu, go to
Integration
Design Integrations

Steps

Add Parameters to Designer Settings
Click on a parameter from the
Settings Component
pane and drag it into the
Designer Settings
tab. You can add as many as you want to be referenced in a script.
Configure Parameter Values from Designer Settings
  1. Select the
    Edit
    icon next to the parameters available in the Designer Settings tab. Set Parameterized variables during run time or set static variables that persist for every run.
  2. You can change the
    Setting Name
    for both Parameterized and Static parameters.
  3. To change a parameterized variable, select
    Edit parameters
    on the
    Edit Parameterized Settings
    window.
    Edit parameters
    link is not available for
    Static
    variables.
Reference the Parameters in Your Script
  1. Select your script from the
    Scripts
    tab.
  2. Double-click the row containing
    SampleCCDSJavaScript
    in the
    Included Scripts
    pane
    .
    SampleCCDSJavaScript
    contains templates for making a HTTPS request, Import Structure, Import Data and Preview Data functions. See
    Adaptive Planning
    Functions
    for a complete script example.
  3. Add parameters you want your script to reference.
Example:
var startAddress = dataSource.getSetting('startAddress').getValue();
var endAddress = dataSource.getSetting('endAddress').getValue();