create-scheduled-jobs

Creates scheduled Automation Services jobs from a JSON file created by the user.

create-scheduled-jobs 
[-b value | --bootstrap-config=value] 
[-t value | --tool-password=value] 
[-k value | --keystore-file=value] 
<-p value | --local-file-path=value> 
[-e <true|false> | --enabled=<true|false>]
[-s value | --site-name=value]

Overview

Use this command to create scheduled Automation Services jobs from a local JSON file that is created by the user. At least one Spotfire Server instance must be running.

Options

Option Optional or Required Default Value Description
-b value
--bootstrap-config=value
Optional none The path to the bootstrap configuration file. See Bootstrap.xml file for more information about this file.
-t value
--tool-password=value
Optional none The configuration tool password used to decrypt the database password in the bootstrap.xml file. If the tool password is omitted, the command will prompt the end-user for it on the console. See Bootstrap.xml file for more information.
-k value
--keystore-file=value
Optional none The location of the keystore containing the certificates used for securing internal communication.
-p value
--local-file-path=value
Required none Full path to the local JSON file that the user created. This file contains the path of the Automation Services job to be scheduled and the schedule details. For the required structure of this file, see the example below this table.
-e <true|false>
--enabled=<true|false>
Optional false Optional flag to specify whether the scheduled jobs are enabled when created.
-s value
--site-name=value
Optional none The name of the site for which the scheduled jobs should be created. If no site is given, the scheduled jobs are created for the default site.

JSON file for scheduling Automation Services jobs

A JSON file conforming to the following structure must be created and saved locally before running the create-scheduled-job command. This example contains two schedules for the Automation Services job, but you may add as many as necessary.
[ { "libraryItemPath" : "/asjob/job1", 
"ruleType" : "asjob", 
"schedules" : [ 
{ 
"startTime" : "17:00:00", 
"daysOfTheWeek" : [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ], 
"timeZone" : "America/Los_Angeles" 
},{ 
"startTime" : "01:00:00", 
"daysOfTheWeek" : [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ], 
"timeZone" : "America/Los_Angeles"
 } ] 
Parameters for JSON file
Parameter Description
libraryItemPath The path to the Automation Services job to be scheduled.
ruleType "asjob", for Automation Services job, is currently the only option.
startTime The time, in the format HH:MM:SS, that the job should run.
daysOfTheWeek The days of the week that the job should run (at the time specified in the previous parameter).
timeZone Time zone, in the Area/City format, for the times that the job should run. Use the time zone names that are listed in the iana (Internet Assigned Numbers Authority) Time Zone Database at https://www.iana.org/time-zones.

Command example

config create-scheduled-jobs --local-file-path=C:\tibco\Scheduled_AS_jobs\WeeklySalesReport.json --enabled=true --site-name=West Coast