Code Reference

Introduction

The code samples below describe how to define Control-M objects using JSON notation.

Each Control-M object begins with a "Name" and then a "Type" specifier as the first property. All object names are defined in PascalCase notation with first letters in capital case. In the examples below, the "Name" of the object is "ObjectName" and the "Type" is "ObjectType".

"ObjectName" : {
"Type" : "ObjectType"
}

The following object types are the most basic objects in Control-M job management:

Object type	Description
Folder	A container of jobs. The following types of folders are available: Regular folder — Groups together a collection of jobs and enables you to configure definitions at the folder level and have these definitions inherited by the jobs within the folder. For example, you can set schedules and manage events, resources, and notifications at the Folder level, to be applied to all jobs in the folder. SubFolder — A folder nested within another regular folder or subfolder. Subfolders offer many (but not all) of the capabilities that are offered by regular folders. Simple folder — Groups together a collection of jobs. Folder definitions are not inherited by jobs within the folder. You can use a Flowto define order dependency between jobs in a folder.
Job	A business process that you schedule and run in your enterprise environment
Connection Profile	Access methods and security credentials for a specific application that runs jobs
Defaults	Definitions of default parameter values that you can apply to multiple objects, all at once

Folder

A folder is a container of jobs and subfolders. The default type of folder (as opposed to a simple folder) enables you to configure various settings such as scheduling, event management, adding resources, or adding notifications on the folder level. Folder-level definitions are inherited by the jobs or subfolders within the folder.

For example, you can specify scheduling criteria on the folder level instead of defining the criteria per job in the folder. All jobs in the folder will take on the rules of the folder. This reduces job definition in code.

    "FolderSample": {
       "Type": "Folder",

        "Job1": {
          "Type": "Job:Command",
               "Command": "echo I am a Job",
               "RunAs": "controlm"
        },
        "Job2": {
          "Type": "Job:Command",
               "Command": "echo I am a Job",
               "RunAs": "controlm"
        }
   }

Optional parameters:

    "FolderSampleAll": {
       "Type": "Folder",
       "AdjustEvents": true,
       "ControlmServer": "controlm",
       "SiteStandard": "myStandards",
       "OrderMethod": "Manual",
       "Application": "ApplicationName",
       "SubApplication" : "SubApplicationName",
       "RunAs" : "controlm",
       "When" : {
           "WeekDays": ["SUN"]
       },
       "ActiveRetentionPolicy": "KeepAll",
       "DaysKeepActiveIfNotOk" : "41",
       "mut1" : {
           "Type": "Resource:Mutex",
           "MutexType": "Exclusive"
       },
       "Notify1": {
           "Type": "Notify:ExecutionTime",
           "Criteria": "LessThan",
           "Value": "3",
           "Message": "Less than expected"
       }
   }

AdjustEvents	Whether a job in a folder or subfolder should start running and not wait for an event from a predecessor job that was not scheduled. Values: true \| false Default: false
ControlmServer	Specifies a Control-M Scheduling Server. If more than one Control-M Scheduling Server is configured in the system, you must define the server that the folder belongs to.
SiteStandard	Enforces the defined Site Standard to the folder and all jobs contained within the folder. See Control-M in a nutshell.
OrderMethod	Options are: (Default) Automatic: The folder and its jobs are automatically ordered on days specified in the 'When' property Manual: The 'When' property is ignored. To order such a folder use the "ctm run order" API or Action Type:Run Any other value : See the description of the <user daily> method and other methods in Order Method in the Control-M Online Help.
RunAs	The name of the user responsible for running the jobs in the folder or subfolder. For more details, see RunAs.
When	Defines scheduling for all jobs in the folder or subfolder, using various scheduling parameters or rule-based calendars. For more details, see When.
ActiveRetentionPolicy	The retention policy for jobs in the folder or subfolder, one of the following options: (Default) KeepAll: All jobs wait for the folder or subfolder to complete and are removed at the same time as the folder or subfolder. CleanEndedOK: Jobs in the folder or subfolder are removed automatically from the database.
DaysKeepActiveIfNotOk	Defines the number of days to keep all jobs in the folder active after the folder is set to NOT OK. This parameter is relevant only when ActiveRetentionPolicy=KeepAll. Valid values are 0-99 (where 99 is forever). The default is 0.
Resource:Mutex	See Resource:Mutex for detailed information about the resource.
Notification	Issues notifications for various scenarios that occur before, during, or after the execution of jobs within the folder or subfolder. For more details, see Notification.
If	See Ifand If Actions for detailed information
Job	See Job for detailed information
Events	See Eventsfor detailed information
Flow	See Flowfor detailed information

Folders support the use of the following additional properties and parameters:

Application, SubApplication
CreatedBy
DaysKeepActive
Description
Documentation
EndFolder
Priority
Rerun
RerunLimit
Time Zone
Variables

The following example shows description and time zone for the object Folder8.

"Folder8": {
"Type": "Folder",
"Description": "folder desc",
"Application" : "Billing",
"SubApplication" : "Payable",
"TimeZone":"HAW",
"SimpleCommandJob": {
"Type": "Job:Command",
"Description": "job desc",
"Application" : "BillingJobs",
"SubApplication" : "PayableJobs",
"TimeZone":"MST",
"Host":"agent8",
"RunAs":"owner8",
"Command":"ls"
}
}

Option	Description	Job	Folder	SubFolder
WeekDays	One or more of the following: "SUN","MON","TUE","WED","THU","FRI","SAT" For all days of the week, use "ALL" (the default value).	✅️	✅️	❌️
Months	One or more of the following: "JAN", "FEB", "MAR", "APR","MAY","JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEC" For all months of the year, use "ALL" (the default value).	✅️	✅️	❌️
MonthDays	One or more days in the range of 1 to 31 For all days of the month, use "ALL" (the default value).	✅️	✅️	❌️
FromTime	FromTime specifies that a job will not start before this time Format: HHMM	✅️	✅️	✅️
ToTime	ToTime specifies that a job will not start after this time Format: HHMM To allow the job to be submitted even after its original scheduling date (if it was not submitted on the original date), specify a value of ">".	✅️	✅️	✅️
Schedule	One of the following options: "Everyday" - scheduling is applied every day, provided that the running criteria are met "Never" - no scheduling is defined, and the job must be ordered manually	✅️	✅️	❌️
SpecificDates	Specific dates for running jobs. For each date, use the format "MM/DD" (enclosed in quotes). Separate multiple dates with commas. Note: The SpecificDates option cannot be used in combination with options WeekDays, Months, or MonthDays. However, since the default for these options is "ALL", you must specify these options with a value of "NONE".	✅️	✅️	❌️

MonthDays syntax	Description
1	Day 1 included only if defined in the calendar
+2	Day 2 included regardless of calendar
-3	Day 3 excluded regardless of calendar
>4	Day 4 or next closest calendar working day
<5	Day 5 or previous closest calendar working day
D6	The 6th calendar working day
L7	The 7th from the last calendar working day
D6PA or D6P*	If MonthDaysCalendar is of type periodical, you can use PA or P* to specify a calendar period name such as A,B,C, or you can use * for any period.
-D6 or -L6P*	D and L can also have an exclude specifier

WeekDays syntax	Description
SUN	Sunday included only if defined in the calendar
+MON	Monday included regardless of calendar
-TUE	Tuesday excluded regardless of calendar
>WED	Wednesday or next closest calendar working day
<THU	Thursday or previous closest calendar working day

StartDate	First date that a job can run
EndDate	Last date that a job can run

Date Type	Description
AnyDate	Any scheduled date
NoDate	Not date-specific
OrderDate	Control-M scheduled date. If you do not specify an OrderDate value, this is the default.
PreviousOrderDate	Previous Control-M scheduled date
NextOrderDate	Next Control-M scheduled date
MMDD	Specific date Example: "0511"

Value	Action
NOTOK	When job fails
OK	When job completed successfully
ANY	When the job completed regardless of success or failure
value	When completion status = value Example: value=10
Even	When completion status is an even number
Odd	When completion status is an odd number
">=5", "<=5", "<5", ">5", "!=5"	When the completion status comparison operator is true

Parameter	Description
Code	The string to search for in the output. You can include wildcards in the code — * for any number of characters, and $ or ? for any single character.
Statement	(Optional) Limits the search to a specific statement within the output. If no statement is specified, all statements in the output are searched. You can include wildcards in the statement — * for any number of characters, and $ or ? for any single character.

Parameter	Description
Urgency	Level of urgency of the message — Regular, Urgent, or VeryUrgent. The default is Regular.
Subject	A subject line for the message.
Message	The message text.
To	A list of email recipients to whom the message is directed. Use the semicolon (;) to separate multiple email addresses.
CC	A list of email recipients who receive a copy of the message. Use the semicolon (;) to separate multiple email addresses.
AttachOutput	Whether to include the job output as an email attachment, either true or false. If no value is specified, the default follows the configuration of the Control-M/Server.

Property	Description
ControlmServer	The Control-M Scheduling Server for the run action. By default, the Control-M Scheduling Server for the run action is the same as defined for the folder. You can use this property to specify a different, remote server.
Date	Value to be used as the original scheduling date for the job. The default is OrderDate (that is, the Control-M scheduled date). For any other date, specify the date in the relevant 4-character or 6-character format — mmdd, ddmm, yymmdd, or yyddmm, depending on the site standard.
Variables	If the run action is defined for a remote Control-M Scheduling server, you can define variables for the run action.

Security level	Allowed values	Default value
Permissive	Any user name	ctmdk (an internal user)
Restrictive	User currently logged in	User currently logged in

Parameters	Description
Message	The message to display
Destination (description for each of the options)	The message is sent to one of the following: (Default) Alerts - Control-M Alerts window JobLog - writes to Control-M job log , to get the job log use the run job:log::get Console - operating system console Or Predefined destination values (for example, FinanceGroup)
Urgency	The message urgency is logged as one of the following: (Default) Regular Urgent VeryUrgent

Parameter	Description
Host	Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. In addition, Control-M File Transfer plugin version 8.0.00 or later must be installed.
ConnectionProfileSrc	The connection profile to use as the source
ConnectionProfileDest	The connection profile to use as the destination
ConnectionProfileDualEndpoint	If you need to use a dual-endpoint connection profile that you have set up, specify the name of the dual-endpoint connection profile instead of ConnectionProfileSrc and ConnectionProfileDest. For more information about dual-endpoint connection profiles, see ConnectionProfile:FileTransfer:DualEndPoint.
FileTransfers	A list of file transfers to perform during job execution, each with the following properties:
Src	Full path to the source file
Dest	Full path to the destination file
TransferType	(Optional) FTP transfer mode, either Ascii (for a text file) or Binary (non-textual data file). Ascii mode handles the conversion of line endings within the file, while Binary mode creates a byte-for-byte identical copy of the transferred file. Default: "Binary"
TransferOption	(Optional) The following is a list of the transfer options: SrcToDest - transfer file from source to destination DestToSrc - transfer file from destination to source SrcToDestFileWatcher - watch the file on the source and transfer to destination only when all criteria is met DestToSrcFileWatcher - watch the file on the destination and transfer to source only when all criteria is met FileWatcher - Watch a file. If successful, the succeeding job will run. Default: "SrcToDest"

Path	Path of the file to be detected by the File Watcher You can include wildcards in the path — * for any number of characters, and ? for any single character.
SearchInterval	Interval (in seconds) between successive attempts to detect the creation/deletion of a file
TimeLimit	Maximum time (in minutes) to run the process without detecting the file at its minimum size (for Job:FileWatcher:Create) or detecting its deletion (for Job:FileWatcher:Delete). If the file is not detected/deleted in this specified time frame, the process terminates with an error return code. Default: 0 (no time limit)
StartTime	The time at which to start watching the file The format is yyyymmddHHMM. For example, 201805041535 means that the File Watcher will start watching the file on May 4, 2018 at 3:35 PM. Alternatively, to specify a time on the current date, use the HHMM format.
StopTime	The time at which to stop watching the file. Format: yyyymmddHHMM or HHMM (for the current date)
MinimumSize	Minimum file size to monitor for, when watching a created file Follow the specified number with the unit: B for bytes, KB for kilobytes, MB for megabyes, or GB for gigabytes. If the file name (specified by the Path parameter) contains wildcards, minimum file size is monitored only if you set the Wildcard parameter to true.
Wildcard	Whether to monitor minimum file size of a created file if the file name (specified by the Path parameter) contains wildcards Values: true \| false Default: false
MinimalAge	(Optional) The minimum number of years, months, days, hours, and/or minutes that must have passed since the created file was last modified. For example: 2Y10M3D5H means that 2years, 10 months, 3 days, and 5 hours must pass before the file will be watched. 2H10Min means that 2 hours and 10 minutes must pass before the file will be watched.
MaximalAge	(Optional) The maximum number of years, months, days, hours, and/or minutes that can pass since the created file was last modified. For example: 2Y10M3D5H means that after 2years, 10 months, 3 days, and 5 hours have passed, the file will no longer be watched. 2H10Min means that after 2 hours and 10 minutes have passed, the file will no longer be watched.

Criteria	Value	Description
LessThan	Value in minutes Example: 3	If the job runs less than the defined value, a notification is sent to the defined destination
GreaterThan	Value in minutes Example: 5	If the job runs longer than the defined value, a notification is sent to the defined destination
LessThanAverage	Value in minutes or percentage Example: 10%	If the job runs less than the defined value of the average execution time of the job, a notification is sent to the defined destination
GreaterThanAverage	Value in minutes or percentage Example: 10%	If the job runs longer than the defined value of the average execution time of the job, a notification is sent to the defined destination

Units	One of the following: "Minutes" "Hours" or "Days". The default is "Minutes"
From	One of the following values: Start - next run time is calculated an N Units from the start time of the current run End - next run time is calculated as N Units from the end time of current run Target - run starts every N units The default is "Start".
Times	Number of cycles to run. To run forever, define 0 The default is run forever.

Intervals	The time intervals for job to run again in months, hours, days and minutes
From	One of the following values: Start - next run time is calculated an N Units from the start time of the current run End - next run time is calculated as N Units from the end time of current run Target - run start every N units The default is "Start".

At	One or more time of day in the format HHMM
Tolerance	Maximum delay in minutes permitted for a late submission of a specific time

Script	Full content of the script, up to 64 kilobytes.
Host	Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell. NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.
RunAs	Identifies the operating systems user that will run the job.
FileName	Name of a script file. This property is used for the following purposes: The file extension provides an indication of how to interpret the script. If this is the only purpose of this property, the file does not have to exist. If you specify an alternative script override using the OverridePathjob property, the FileName property indicates the name of the alternative script file.
PreCommand	(Optional) A command to execute before the job is executed.
PostCommand	(Optional) A command to execute after the job is executed.

Host	Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host, as well as Control-M Databases plugin version 9.0.00 or later. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell. NOTE: If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.
Parameters	Parameters are pairs of name and value. Every name that appears in the SQL script will be replaced by its value pair.
Autocommit	(Optional) Commits statements to the database that completes successfully Default: N
OutputExcecutionLog	(Optional) Shows the execution log in the job output Default: Y
OutputSQLOutput	(Optional) Shows the SQL sysout in the job output Default: N
SQLOutputFormat	(Optional) Defines the output format as either Text, XML, CSV, or HTML Default: Text

Host	Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host, as well as Control-M Databases plugin version 9.0.00 or later. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell. NOTE: If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.
StoredProcedure	Name of stored procedure that the job runs
Parameters	A comma-separated list of values and variables for all parameters in the procedure, in the order of their appearence in the procedure. The value that you specify for any specific parameter in the procedure depends on the type of parameter: For an In parameter, specify an input value. For an Out parameter, specify an output variable. For an In/Out parameter, specify a pair of input value + output variable, enclosed in brackets: [value,variable] In the example above, three parameters are listed, in the following order: [In,Out,Inout]
ReturnValue	A variable for the Return parameter (if the procedure contains such a parameter)
Schema	The database schema where the stored procedure resides
Package	(Oracle only) Name of a package in the database where the stored procedure resides The default is "*", that is, any package in the database.
ConnectionProfile	Name of a connection profile that contains the details of the connection to the database
Autocommit	(Optional) Commits statements to the database that completes successfully Default: N
OutputExcecutionLog	(Optional) Shows the execution log in the job output Default: Y
OutputSQLOutput	(Optional) Shows the SQL sysout in the job output Default: N
SQLOutputFormat	(Optional) Defines the output format as either Text, XML, CSV, or HTML Default: Text

ConnectionProfile	See ConnectionProfile:Hadoop
Host	Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell. NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

PreCommands and PostCommands	Allows you to define HDFS commands to perform before and after running the job. For example, you can use them for preparation and cleanup.
FailJobOnCommandFailure	This parameter is used to ignore failure in the pre- or post- commands. The default for PreCommands is *true, that is, the job will fail if any pre-command fails. The default for PostCommands is false,* that is, the job will complete successfully even if any post-command fails.

ConnectionProfile	See Sqoop ConnectionProfile:Hadoop
Host	Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell. NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

Code Reference

Introduction

Folder

SubFolder

Simple Folder

Flow

Job Properties

Type

Application, SubApplication

Comment

When

MonthDay additional parameters

WeekDays additional parameters

Specifying start/end dates of a job run

Relationship between MonthDays and WeekDays

Using rule-based calendars in job scheduling

Events

WaitForEvents

AddEvents

DeleteEvents

If

If:CompletionStatus

If:NumberOfReruns

If:NumberOfFailures

If:JobNotSubmitted

If:JobOutputNotFound

If:NumberOfExecutions

If:Output

If Actions

Action:Mail

Action:Rerun

Action:Set

Action:SetToOK

Action:SetToNotOK

Action:StopCyclicRun

Action:Run

Action:Notify

Event:Add

Event:Delete

Action:Output

Confirm

CreatedBy

Critical

DaysKeepActive

Description

Documentation

EndFolder

Notification

Notify:OK

Notify:NotOK

Notify:DoesNotStart

Notify:ExecutionTime

Notify:DoesNotEnd

Notify:ReRun

OverridePath

Priority

Rerun

RerunIntervals

RerunSpecificTimes

RerunLimit

Resources

Resource:Semaphore

Resource:Mutex

RetroactiveJob

RunAs

RunAsDummy

RunOnAllAgentsInGroup

Time Zone

Variables

Job types

Job:Command

Job:Script

Job:EmbeddedScript

Job:FileTransfer

Job:FileWatcher

Job:Database

Job:Database:SQLScript

Job:Database:StoredProcedure

Job:Hadoop

Job:Hadoop:Spark:Python

ConnectionProfile	See Hive ConnectionProfile:Hadoop
Host	Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell. NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

ConnectionProfile	Name of the SAP connection profile to use for the connection
SapJobName	Name of SAP job to copy
Exec	Type of execution target where the SAP job will run, one of the following: Server — an SAP application server Group — an SAP group
Target	The name of the SAP application server or SAP group (depending on the value specified in the previous parameter)
JobCount	How to define a unique ID number for the SAP job, one of the following options: FirstScheduled (the default) LastScheduled First Last SpecificJob If you specify SpecificJob, you must provide the next parameter.
JobCountSpecificName	A unique SAP job ID number for a specific job (that is, for when JobCount is set to SpecificJob)
NewJobName	Name of the newly created job
StartCondition	Specifies when the job should run, one of the following: ASAP — Job runs as soon as a background work process is available for it in SAP (the default). If the job cannot start immediately, it is transformed in SAP into a time-based job. Immediate — Job runs immediately. If there are no work processes available to run it, the job fails. AfterEvent — Job waits for an event that you specify (in the next two parameters) to be triggered.
AfterEvent	The name of the SAP event that the job waits for (if you set StartCondition to AfterEvent)
AfterEventParameters	Parameters in the SAP event to watch for. Use space characters to separate multiple parameters.
RerunFromPointOfFailure	Whether to rerun the SAP R/3 job from its point of failure, either true of false (the default) Note: If RerunFromPointOfFailure is set to false, use the CopyFromStep parameter to set a specific step from which to rerun.
CopyFromStep	The number of a specific step in the SAP R/3 job from which to rerun or copy The default is step 1 (that is, the beginning of the job). Note: If RerunFromPointOfFailure is set to true, the CopyFromStep parameter is ignored.
PostJobAction	This object groups together several parameters that control post-job actions for the SAP R/3 job.
Spool	How to manage spool output, one of the following options: DoNotCopy (the default) CopyToOutput CopyToFile
SpoolFile	The file to which to copy the job's spool output (if Spool is set to CopyToFile)
SpoolSaveToPDF	Whether to save the job's spool output in PDF format (if Spool is set to CopyToFile)
JobLog	How to manage job log output, one of the following options: DoNotCopy CopyToOutput (the default) CopyToFile
JobLogFile	The file to which to copy the job's log output (if JobLog is set to CopyToFile)
JobCompletionStatusWillDependOnApplicationStatus	Whether job completion status depends on SAP application status, either true or false (the default)
DetectSpawnedJob	This object groups together several parameters that you specify if you want to detect and monitor jobs that are spawned by the current SAP job
DetectAndCreate	How to determine the properties of detected spawned jobs: CurrentJobDefinition — Properties of detected spawned jobs are identical to the current (parent) job properties (the default). SpecificJobDefinition — Properties of detected spawned jobs are derived from a different job that you specify.
JobName	Name of an SAP-type job to use for setting properties in spawned jobs of the current job (if DetectAndCreate is set to SpecificJobDefinition) Note: The specified job must exist in the same folder as the current job, and the connection profile should be the same. BMC recommends that it should have the same Application and Sub Application values.
StartSpawnedJob	Whether to start spawned jobs that have a status of Scheduled (either true or false, where false is the default)
JobEndInControlMOnlyAftreChildJobsCompleteOnSap	Whether to allow the job to end in Control-M only after all child jobs complete in the SAP environment (either true or false, where false is the default)
JobCompletionStatusDependsOnChildJobsStatus	Whether Control-M should wait for all child jobs to complete (either true or false, where false is the default) When set to true, the parent job does not end OK if any child job fails.

Parameter	Description
TargetAgent	The Control-M/Agent to which to deploy the connection profile.
TargetCTM	The Control-M/Server to which to deploy the connection profile. If there is only one Control-M/Server, that is the default.

RunAs	Principal name of the user
KeyTabPath	Keytab file path for the target user

Parameter	Description
Host	Oozie server host
Port	Oozie server port Default: 11000
SslEnabled	true \| false Default: false

Parameter	Description
User	The database user connected to the Sqoop server
Password	A password for the specified user If you are updating an existing connection profile and do not want to change the existing password, enter a string of 5 asterisk characters, "*****".
ConnectionString	JDBC-compliant database: The connection string used to connect to the database
DriverClass	JDBC-compliant database: The driver class for the driver .jar file, which indicates the entry-point to the driver
PasswordFile	(Optional) The full path to a file located on the HDFS that contains the password to the database Note: To use a JCEKS file, include the .jceks file extension.
DatabaseVendor	(Optional) The database vendor of an automatically supported database used with Sqoop, one of the following: MySQL Oracle (SID) Oracle (Service Name) PostgreSQL
DatabaseName	(Optional) Name of an automatically supported database used with Sqoop
DatabaseHost	(Optional) The host server of an automatically supported database used with Sqoop
DatabasePort	(Optional) The port number for an automatically supported database used with Sqoop

Parameter	Description
BinaryPath	Path to the bin directory where tsql utility is located
DatabaseName	Name of the Tajo database
MasterServerName	Host name of the server where the Tajo master is running
MasterServerPort	Tajo master port number

TargetAgent	Which agent computer to deploy the connection profile
TargetCTM	The Control-M/Server to which to deploy the connection profile. When there is only one Control-M/Server, this will be the default.
WorkloadAutomationUsers	(Optional) Users that are allowed to access the connection profile. NOTE : You can use "" as a wildcard. For example, "e" Default: * (all users)
VerifyChecksum	(Optional) Enable or disable error detection on file transfer True \| False Default: False
PrivateKeyName	(Optional) Private key full file path
Passphrase	(Optional) Password for the private key. Use Secrets in code to not expose the password in the code. If you are updating an existing connection profile and do not want to change the existing password, enter a string of 5 asterisk characters, "*****".
Password	(Optional) Password for SFTP Server account. Use Secrets in code to not expose the password in the code. If you are updating an existing connection profile and do not want to change the existing password, enter a string of 5 asterisk characters, "*****".
HomeDirectory	(Optional) User home directory

Parameter	Description
Port	The database port number. If the port is not specified, the following default values are used for each database type: MSSQL - 1433 Oracle - 1521 DB2 - 50000 Sybase - 4100 PostgreSQL - 5432
Password	Password to the database account. Use Secrets in code to not expose the password in the code. If you are updating an existing connection profile and do not want to change the existing password, enter a string of 5 asterisk characters, "*****".
DatabaseName	The name of the database
DatabaseVersion	The version of the database. The following database drivers are supported in Control-M for database V9: MSSQL - 2005, 2008, 2012, 2014 Oracle - 9i, 10g, 11g, 12c DB2 - 9, 10 Sybase - 12, 15 PostgreSQL - 8, 9 The default version for each database is the earliest version listed above.
MaxConcurrentConnections	The maximum number of connections that the database can process at the same time. Allowed values: 1–512 Default value: 100
ConnectionRetryTimeOut	The number of seconds to wait before attempting to connect again. Allowed values: 1–300 Default value: 5 seconds
ConnectionIdleTime	The number of seconds that the database connection profile can remain idle before disconnecting. Default value: 300 seconds
ConnectionRetryNum	The number of times to attempt to reconnect after a connection failure. Allowed values: 1–24 Default value: 5
AuthenticationType	SQL Server Authentication Possible values are: NTLM2 Windows Authentication Windows Authentication SQL Server Authentication

Parmeter	Description
Driver	JDBC driver name as defined in Control-M or as defined using the Driver object