Configuring Schedule Parameters

In a schedule for a process (see Schedule a Process on the Data Integration Console), you can reference parameters.

A schedule parameter is input to be applied to the execution of the scheduled process. Schedule parameters override any parameter settings defined within the process and are applied only when the data loading process executes. Using parameter values, you can configure the process to behave differently depending on the circumstances and to manage specific configuration of multiple schedules, such as changing the process to run for each customer on different schedules.

Contents:

Secure Parameters

In addition to regular parameters, you can specify secure parameters in your schedule.

Secure parameters are useful for passing in sensitive data, such as passwords and secret keys. These parameter values are encrypted and do not appear in clear-text form in any GUI or log entries.


Before saving the schedule, use the show value check-box to display the value of a secure parameter for review purposes. When the schedule is saved, secure parameter values are hidden.

Referencing Parameters from Your CloudConnect Project

In CloudConnect Designer, a parameter is a name-value pair that is stored internally in a graph or externally at the project level (in the *.prm files). Through CloudConnect Designer, you can define parameters for your projects, which makes them available for use in Data Integration Console. Parameters that other CloudConnect users can modify must be stored as external parameters. You can create and test your parameters before you apply them to your production data loading processes in the GoodData platform. You can add parameters by file or manually.

For example, you may want to create a parameter that corresponds to the GoodData project identifier. Define the PROJECT_ID parameter in the external parameters as the following:

PROJECT_ID={project_identifier}

where {project_identifier} is the ID for your GoodData project. If you do not know your project ID, see Find the Project ID.


For more information on the uses of parameters in CloudConnect Designer, see CloudConnect - Using Parameters.

Parameters must be defined within one of the CloudConnect Designer graphs used in your process to be available for inclusion in your process schedule. The values specified in the schedule take precedence over any values specified in the graph definition and are applied to all graphs in the process.

Best Practices

  • When defining a process, use parameters to switch between your development, testing, and production environments.
  • Use parameters for deployment of a process across multiple projects.
  • Define and use parameters for credentials and other data that can easily change.
  • Use secure parameters for sensitive data such as passwords.
  • In CloudConnect Designer, define default parameters in the workspace.prm file. As needed, you can override them during execution using the schedule parameters.
  • (For Ruby scripts and the data pipeline bricks only) Configure the detail level of the execution logs (see Execution Logs on Data Integration Console). Use the GDC_LOG_LEVEL parameter and set it to one of the following values depending on how much information you want to be displayed in the log:
    • DEBUG (this is the default for the data pipeline bricks)
    • INFO (this is the default for Ruby scripts)
    • WARN
    • ERROR
    • FATAL