API – Integration Hub Customization

Integration Hub Grid View

The API – Integration Hub Customization grid displays the list of jobs, including the Job Name, Schedule, the last time it was run, and when it is due to run next.

The grid should refresh every minute. Click the Refresh button (circled in the screenshot below) to make it refresh immediately.

Next Run messages mean:

• A future time, such as In a few seconds: The scheduled job is about to run.
• Running: Script is currently running.
• Overdue: The scheduled run time has passed but something is blocking the script from running.
• Disabled:
  • Scheduled Jobs: The Enabled toggle switch is off.
  • Automated Jobs: Automated Job is selected.

Enable Automated Jobs using Integration Hub

Enabling automated jobs using Integration Hub allows users to select Integration Hub jobs when adding automated jobs to their System. See Orchestration Using Automated Jobs.

Manage API – Integration Hub Customization:

1. Go to Settings  > Customization > Integrations.
2. Click API – Integration Hub.
3. Click to select the Enable Automated Jobs using Integration Hub checkbox.
   

Manage Global Parameters

Global Parameters can be referenced by every script in Integration Hub. They are a good way of adding authentication credentials or other information that needs to be secure.

See Using Parameters below for how to reference parameters in a script.

To manage Global Parameters:

1. Click Global Parameters.
   
2. Add or edit a parameter:
   
   1. Add: Click + new parameter.
      Edit: Click any field on an existing parameter.
   2. Type the Parameter Name.
   3. Click to select the Type of string:
      1. String: Shows the Value field.
      2. String (Masked): Masks the Value field with a dot for each character. Similar to a password field.

                    

         TIP

          

         Once String (Masked) has been selected and saved on a parameter, the value will never be displayed again. A masked parameter cannot be reverted to an unmasked parameter.

          

                    

   4. Type the Values. This could be a password or clientID.
3. Delete a parameter:
   1. Hover your mouse cursor over the parameter.
   2. Click the red X.
4. Click Save & Close.

Add or Edit Integration Hub Jobs

1. Add or edit a script:
   1. Add: Click + New Job.
      
      Edit: Click a script’s Job Name in the grid.
   2. Type Job Name. (Mandatory field.)
      
   3. Type a Description.
   4. Manage Parameters:

                 

      TIP

      See Using Parameters below for how to reference parameters in a script.

                 

       
      1. Click + parameters.
         
      2. Add or edit a parameter:
         1. Add: Click + new parameter.
            Edit: Click any field on an existing parameter.
         2. Type the Parameter Name.
         3. Click to select the Type of string:
            1. String: Shows the Value field.
            2. String (Masked): Masks the Value field with a dot for each character. Similar to a password field.

                          

               TIP

               Once String (Masked) has been selected and saved on a parameter, the value will never be displayed again. A masked parameter cannot be reverted to an unmasked parameter.

                          

         4. Type the Values. This could be a password or clientID.

                       

            TIP

            Parameter values set here can be changed when using the Integration Hub Automated Job in a TECR or Deployment Plan Activity. .

                       

      3. Delete a parameter:
         1. Hover your mouse cursor over the parameter.
         2. Click the red X.
      4. Click Save & Close.
   5. Upload your script: (Mandatory field.)
      1. Click Upload New File.
      2. Select the script. Only .js files can be used.
      3. Click Open.

                    

         TIP

         There is currently no way to edit a script. You must upload a new script instead.

                    

   6. Download the script by clicking on the download button on the right of the script name.  
   7. Select a Trigger:
      

                 

      TIP

      Jobs running on a schedule can only have one running instance at the same time. Automated jobs can have multiple running instances at the same time. For example, the same job can be triggered from multiple TECRs concurrently.

                 

       
      1. If Scheduled Trigger is selected: Schedule the running of the script:
         1. Select a Frequency: (Mandatory field.)
            • Minute.
            • Hourly.
            • Weekly.
            • Monthly.
         2. Select the time period in Repeat Every. (Mandatory field.)
         3. Select the date the schedule will Start On. (Mandatory field.)
      2. If Automated Job is selected:
         • The script can be:
           • Included in a Build from a System.
           • Run as an Automated Job in a TECR or Deployment Plan Activity.
   8. Click:
      • Run & Close: To immediately run the script and close the pop up.
      • Save: To save information but not close the pop up.
      • Save & Close: To save and close the pop up and let the script run (if it is enabled) when it is scheduled.

                   

        TIP

        After adding automated jobs, see how to use them to orchestrate events.

                   

View Execution History

Click View in the History column to open the script execution history pop up for that job, which contains information about every time the script has run.

Click View in the pop up to open the log file of that run.

Log files open in a new browser tab when clicked. If no log file tab opens, check whether you have pop up blocking software blocking them.

Scripts that have been stopped by clicking a Stop button (a red square which appears when a job is running) will have a message written in their log file.

Stop Jobs

To stop a single instance of a job running:

• Open the job’s History.
  
• Click the red stop button on that running instance.
  

To stop all the running instances of a job at once, click the job’s red stop button on the Integration Hub grid.

Delete Automated Jobs

To delete a job from Integration Hub:

1. Click the job’s Action menu in the grid (three horizontal dots)
   
2. Select Delete.
3. Click Yes to confirm.

Script Syntax

const querystring = require("querystring");
const https = require("https");
const http = require("http");
const fs = require("fs");
const AWS = require("aws-sdk");
const lodash = require("lodash");
const xml2js = require("xml2js");
const xlsx = require("xlsx");
const ssh2 = require("ssh2");
const ldap = require("ldapjs");
const csvtojson = require("csvtojson");
const oauth = require("oauth");
const request = require("request");
const openpgp = require("openpgp");
const axios = require("axios");
const showdown = require ("showdown1");
const jsonwebtoken = require ("jsonwebtoken");
const cryptJs = require ("crypto-js");
const uuidv1 = require("uuid/v1");
const uuidv3 = require("uuid/v3");
const uuidv4 = require("uuid/v4");
const uuidv5 = require("uuid/v5");
const fetch = require("node-fetch");

let run = function(){
     return new Promise(function (resolve, reject) {
      /// Code here
      });
}
module.exports = {
run: run
};

promise.reject(‘this is the fail message’);

promise.resolve(‘this is the success message’);

let run = function (args) {

return new Promise((resolve,reject)=>{

console.log('Starting script');

//Declare variables and assign values passed in from Global parameters
var globalParameter1 = args.globalArguments.globalParameter1;
var globalSecret1 = args.globalArguments.globalSecret1;

console.log('Ending script');
resolve('Done');
    });
};

module.exports = {
    run: run
};

let run = function (args) {

return new Promise((resolve,reject)=>{

console.log('Starting script');

//Declare variables and assign values passed in from Job parameters
var jobParamter1 = args.arguments.jobParamter1;
var jobSecret1 = args.arguments.jobSecret1;

console.log('Ending script');
resolve('Done');
    });
};

module.exports = {
    run: run
};

let run = function (args) {

return new Promise((resolve,reject)=>{

console.log('Starting script');

//Declare variables and assign values passed in from the Automated Job Name field
var jobName = args.plutoraValues.JobName;

console.log('Ending script');
resolve('Done');
    });
};

module.exports = {
    run: run
};

let run = function (args) {

return new Promise((resolve,reject)=>{

console.log('Starting script');

//Declare variables and assign values passed in from the Create Build form
var buildGuid = args.plutoraValues.Build.ID;
var buildNumber = args.plutoraValues.Build.BuildNumber;
var buildTag = args.plutoraValues.Build.BuildTag;
var buildBranch = args.plutoraValues.Build.Branch;
var buildSystemGuid = args.plutoraValues.System.ID;
var buildSystemName = args.plutoraValues.System.Name;
var buildReleaseGuid = args.plutoraValues.Build.Release.ID;
var buildReleaseIdentifier = args.plutoraValues.Build.Release.Identifier;
var buildReleaseName = args.plutoraValues.Build.Release.Name;
var buildChangeGuid = args.plutoraValues.Build.Changes[0].ID;
var buildChangesName = args.plutoraValues.Build.Changes[0].Name;
var buildEnvironmentGuid = args.plutoraValues.Environment.ID;
var buildEnvironmentName = args.plutoraValues.Environment.Name;

console.log('Ending script');
resolve('Done');
    });
};

module.exports = {
    run: run
};

let run = function (args) {

return new Promise((resolve,reject)=>{

console.log('Starting script');

//Declare variables and assign values passed in from the TECR form
var tecrGuid = args.plutoraValues.Tecr.ID;
var tecrTitle = args.plutoraValues.Tecr.Title;
var tecrReleaseGuid = args.plutoraValues.Tecr.Release.ID;
var tecrReleaseName = args.plutoraValues.Tecr.Release.Name;
var tecrNextAvailableStatusGuid = args.plutoraValues.Tecr.Statuses[0].ID;
var tecrNextAvailableStatusValue = args.plutoraValues.Tecr.Statuses[0].Value;
var tecrSystemGuid = args.plutoraValues.System.ID;
var tecrSystemName = args.plutoraValues.System.Name;
var tecrEnvironmentGuid = args.plutoraValues.Environment.ID;
var tecrEnvironmentName = args.plutoraValues.Environment.Name;
var tecrBuildGuid = args.plutoraValues.Build[0].ID;
var tecrBuildNumber = args.plutoraValues.Build[0].BuildNumber;
var tecrBuildTag = args.plutoraValues.Build[0].BuildTag;
var tecrBuildBranch = args.plutoraValues.Build[0].Branch;
var tecrBuildNote = args.plutoraValues.Build[0].BuildNote;
var tecrBuildReleaseGuid = args.plutoraValues.Build[0].Release.ID;
var tecrBuildReleaseIdentifier = args.plutoraValues.Build[0].Release.Identifier;
var tecrBuildReleaseName = args.plutoraValues.Build[0].Release.Name;
var tecrBuildChangeGuid = args.plutoraValues.Build[0].Changes[0].ID;
var tecrBuildChangesName = args.plutoraValues.Build[0].Changes[0].Name;

let run = function (args) {

return new Promise((resolve,reject)=>{

console.log('Starting script');

//Declare variables and assign values passed in from the Deployment Plan Activity form
var deploymentPlanGuid = args.plutoraValues.DeploymentPlan.ID;
var deploymentPlanName = args.plutoraValues.DeploymentPlan.Name;
var deploymentPlanActivityGuid = args.plutoraValues.DeploymentPlanActivity.ID;
var deploymentPlanActivityName = args.plutoraValues.DeploymentPlanActivity.Name;
var deploymentPlanActivitySystemGuid = args.plutoraValues.System.ID;
var deploymentPlanActivitySystemName = args.plutoraValues.System.Name;
var deploymentPlanActivityEnvironmentGuid = args.plutoraValues.Environment.ID;
var deploymentPlanActivityEnvironmentName = args.plutoraValues.Environment.Name;
var deploymentPlanActivityBuildSystemId = args.plutoraValues.Build[0].SystemID;
var deploymentPlanActivityBuildSystemName = args.plutoraValues.Build[0].SystemName;
var deploymentPlanActivityBuildGuid = args.plutoraValues.Build[0].ID;
var deploymentPlanActivityBuildNumber = args.plutoraValues.Build[0].BuildNumber;
var deploymentPlanActivityBuildTag = args.plutoraValues.Build[0].BuildTag;
var deploymentPlanActivityBuildBranch = args.plutoraValues.Build[0].Branch;
var deploymentPlanActivityBuildNote  = args.plutoraValues.Build[0].BuildNote;
var deploymentPlanActivityBuildReleaseGuid = args.plutoraValues.Build[0].Release.ID;
var deploymentPlanActivityBuildReleaseIdentifier = args.plutoraValues.Build[0].Release.Identifier;
var deploymentPlanActivityBuildReleaseName = args.plutoraValues.Build[0].Release.Name;
var deploymentPlanActivityBuildChangeGuid = args.plutoraValues.Build[0].Changes[0].ID;
var deploymentPlanActivityBuildChangesName = args.plutoraValues.Build[0].Changes[0].Name;

console.log('Ending script');
resolve('Done');
    });
};

module.exports = {
    run: run
};

let run = function (args) {

    var LastRunDate = args.lastRunDateUtc;
    var LastSuccessfulRun = args.lastSuccessfulRunDateUtc;

}