diff --git a/docs/_sources/notebooks/jobtypes.ipynb.txt b/docs/_sources/notebooks/jobtypes.ipynb.txt index 1e6716f..9c789da 100644 --- a/docs/_sources/notebooks/jobtypes.ipynb.txt +++ b/docs/_sources/notebooks/jobtypes.ipynb.txt @@ -9,7 +9,7 @@ }, { "cell_type": "code", - "execution_count": 40, + "execution_count": 1, "metadata": {}, "outputs": [], "source": [ @@ -35,7 +35,7 @@ }, { "cell_type": "code", - "execution_count": 41, + "execution_count": 2, "metadata": {}, "outputs": [], "source": [ @@ -44,7 +44,7 @@ }, { "cell_type": "code", - "execution_count": 42, + "execution_count": 3, "metadata": {}, "outputs": [], "source": [ @@ -81,7 +81,7 @@ }, { "cell_type": "code", - "execution_count": 43, + "execution_count": 4, "metadata": {}, "outputs": [], "source": [ @@ -90,7 +90,7 @@ }, { "cell_type": "code", - "execution_count": 44, + "execution_count": 5, "metadata": {}, "outputs": [], "source": [ @@ -122,7 +122,7 @@ }, { "cell_type": "code", - "execution_count": 45, + "execution_count": 6, "metadata": {}, "outputs": [], "source": [ @@ -160,7 +160,7 @@ }, { "cell_type": "code", - "execution_count": 46, + "execution_count": 7, "metadata": {}, "outputs": [], "source": [ @@ -180,7 +180,7 @@ }, { "cell_type": "code", - "execution_count": 47, + "execution_count": 8, "metadata": {}, "outputs": [], "source": [ @@ -206,7 +206,7 @@ }, { "cell_type": "code", - "execution_count": 48, + "execution_count": 9, "metadata": {}, "outputs": [], "source": [ @@ -235,7 +235,7 @@ }, { "cell_type": "code", - "execution_count": 49, + "execution_count": 10, "metadata": {}, "outputs": [], "source": [ @@ -275,7 +275,7 @@ }, { "cell_type": "code", - "execution_count": 50, + "execution_count": 11, "metadata": {}, "outputs": [], "source": [ @@ -313,7 +313,7 @@ }, { "cell_type": "code", - "execution_count": 51, + "execution_count": 12, "metadata": {}, "outputs": [], "source": [ @@ -348,7 +348,7 @@ }, { "cell_type": "code", - "execution_count": 52, + "execution_count": 13, "metadata": {}, "outputs": [], "source": [ @@ -383,7 +383,7 @@ }, { "cell_type": "code", - "execution_count": 53, + "execution_count": 14, "metadata": {}, "outputs": [], "source": [ @@ -420,7 +420,7 @@ }, { "cell_type": "code", - "execution_count": 54, + "execution_count": 15, "metadata": {}, "outputs": [], "source": [ @@ -465,7 +465,7 @@ }, { "cell_type": "code", - "execution_count": 55, + "execution_count": 16, "metadata": {}, "outputs": [], "source": [ @@ -476,7 +476,7 @@ }, { "cell_type": "code", - "execution_count": 56, + "execution_count": 17, "metadata": {}, "outputs": [], "source": [ @@ -504,7 +504,7 @@ }, { "cell_type": "code", - "execution_count": 57, + "execution_count": 18, "metadata": {}, "outputs": [], "source": [ @@ -527,7 +527,7 @@ }, { "cell_type": "code", - "execution_count": 58, + "execution_count": 19, "metadata": {}, "outputs": [], "source": [ @@ -549,7 +549,7 @@ }, { "cell_type": "code", - "execution_count": 59, + "execution_count": 20, "metadata": {}, "outputs": [], "source": [ @@ -575,7 +575,7 @@ }, { "cell_type": "code", - "execution_count": 60, + "execution_count": 21, "metadata": {}, "outputs": [], "source": [ @@ -598,7 +598,7 @@ }, { "cell_type": "code", - "execution_count": 61, + "execution_count": 22, "metadata": {}, "outputs": [], "source": [ @@ -623,7 +623,7 @@ }, { "cell_type": "code", - "execution_count": 62, + "execution_count": 23, "metadata": {}, "outputs": [], "source": [ @@ -646,7 +646,7 @@ }, { "cell_type": "code", - "execution_count": 63, + "execution_count": 24, "metadata": {}, "outputs": [], "source": [ @@ -670,7 +670,7 @@ }, { "cell_type": "code", - "execution_count": 64, + "execution_count": 25, "metadata": {}, "outputs": [], "source": [ @@ -694,7 +694,7 @@ }, { "cell_type": "code", - "execution_count": 65, + "execution_count": 26, "metadata": {}, "outputs": [], "source": [ @@ -720,7 +720,7 @@ }, { "cell_type": "code", - "execution_count": 66, + "execution_count": 27, "metadata": {}, "outputs": [], "source": [ @@ -749,7 +749,7 @@ }, { "cell_type": "code", - "execution_count": 67, + "execution_count": 28, "metadata": {}, "outputs": [], "source": [ @@ -775,7 +775,7 @@ }, { "cell_type": "code", - "execution_count": 68, + "execution_count": 29, "metadata": {}, "outputs": [], "source": [ @@ -810,7 +810,7 @@ }, { "cell_type": "code", - "execution_count": 69, + "execution_count": 30, "metadata": {}, "outputs": [], "source": [ @@ -853,7 +853,7 @@ }, { "cell_type": "code", - "execution_count": 70, + "execution_count": 31, "metadata": {}, "outputs": [], "source": [ @@ -894,7 +894,7 @@ }, { "cell_type": "code", - "execution_count": 71, + "execution_count": 32, "metadata": {}, "outputs": [], "source": [ @@ -931,7 +931,7 @@ }, { "cell_type": "code", - "execution_count": 72, + "execution_count": 33, "metadata": {}, "outputs": [], "source": [ @@ -976,7 +976,7 @@ }, { "cell_type": "code", - "execution_count": 73, + "execution_count": 34, "metadata": {}, "outputs": [], "source": [ @@ -1023,7 +1023,7 @@ }, { "cell_type": "code", - "execution_count": 74, + "execution_count": 35, "metadata": {}, "outputs": [], "source": [ @@ -1061,15 +1061,15 @@ }, { "cell_type": "code", - "execution_count": 75, + "execution_count": 36, "metadata": {}, "outputs": [], "source": [ "job = JobAzureLogicApps('JobAzureLogicAppsSample',\n", " connection_profile='CPAZURE',\n", - " logic_app_name='logic_app',\n", - " request_body='{\"name\":\"value\"}',\n", - " append_log=True)" + " workflow='workflow_app',\n", + " parameters='{\"name\":\"value\"}'\n", + " )" ] }, { @@ -1098,7 +1098,7 @@ }, { "cell_type": "code", - "execution_count": 76, + "execution_count": 37, "metadata": {}, "outputs": [], "source": [ @@ -1131,7 +1131,7 @@ }, { "cell_type": "code", - "execution_count": 77, + "execution_count": 38, "metadata": {}, "outputs": [], "source": [ @@ -1196,7 +1196,7 @@ }, { "cell_type": "code", - "execution_count": 78, + "execution_count": 39, "metadata": {}, "outputs": [], "source": [ @@ -1212,6 +1212,45 @@ " units=JobSLAManagement.AverageRunTimeTolerance.Units.Minutes\n", " ))\n" ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## JobZOS\n", + "\n", + "[AutomationAPI Documentation](https://documents.bmc.com/supportu/API/Monthly/en-US/Documentation/API_CodeRef_JobTypes_zOS.htm?Highlight=zos)" + ] + }, + { + "cell_type": "code", + "execution_count": 40, + "metadata": {}, + "outputs": [], + "source": [ + "job = JobZOSMember('JobZOSMemberSample', \n", + " member_library='IOAQ.AAPI#AU.JCL',\n", + " archiving=JobZOS.Archiving(archive_sys_data=True),\n", + " must_end=JobZOS.MustEnd(hours='1', minutes='15', days=1),\n", + " run_on_all_agents_in_group=True\n", + " )\n" + ] + }, + { + "cell_type": "code", + "execution_count": 41, + "metadata": {}, + "outputs": [], + "source": [ + "job = JobZOSInStreamJCL('JobZOInStreamJCLSample', \n", + " member_library='IOAQ.AAPI#AU.JCL',\n", + " jcl=\"//AUTEST0 JOB ,ASM,CLASS=A,REGION=0M\\\\n// JCLLIB ORDER=IOAQ.AAPI#AU.PROCLIB\\\\n// INCLUDE MEMBER=IOASET\\\\n//S1 EXEC IOATEST,PARM='TERM=C0000'\",\n", + " archiving=JobZOS.Archiving(archive_sys_data=True),\n", + " run_on_all_agents_in_group=True,\n", + " created_by='workbench',\n", + " run_as='workbench'\n", + " )" + ] } ], "metadata": { @@ -1233,7 +1272,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.10.4" + "version": "3.8.9" }, "orig_nbformat": 4 }, diff --git a/docs/index.html b/docs/index.html index 691fe7d..5842bec 100644 --- a/docs/index.html +++ b/docs/index.html @@ -341,6 +341,7 @@

Control-M Python Client DocumentationJobAzureBatchAccount
  • JobWebServices
  • JobSLAManagement
  • +
  • JobZOS
  • Job and Folder Properties
  • -
    [54]:
    +
    [15]:
     
    job = JobDatabaseMSSQL_SSIS('JobDatabaseMSSQL_SSISSample',
    @@ -641,7 +641,7 @@ 

    JobHadoopSparkPython

    spark_options: The options to be passed to the script

    -
    [55]:
    +
    [16]:
     
    -
    [56]:
    +
    [17]:
     
    job = JobHadoopSparkPython('JobHadoopSparkPythonSample',
    @@ -672,7 +672,7 @@ 

    JobHadoopSparkPythonJobHadoopSparkScalaJava

    AutomationAPI Documentation

    -
    [57]:
    +
    [18]:
     
    job = JobHadoopSparkScalaJava('JobHadoopSparkScalaJavaSample',
    @@ -688,7 +688,7 @@ 

    JobHadoopSparkScalaJavaJobHadoopPig

    AutomationAPI Documentation

    -
    [58]:
    +
    [19]:
     
    job = JobHadoopPig('JobHadoopPigSample',
    @@ -703,7 +703,7 @@ 

    JobHadoopPig

    AutomationAPI Documentation

    -
    [59]:
    +
    [20]:
     
    job = JobHadoopSqoop('JobHadoopSqoopSample',
    @@ -722,7 +722,7 @@ 

    JobHadoopSqoop

    AutomationAPI Documentation

    -
    [60]:
    +
    [21]:
     
    job = JobHadoopHive('JobHadoopHiveSample',
    @@ -738,7 +738,7 @@ 

    JobHadoopHive

    AutomationAPI Documentation

    -
    [61]:
    +
    [22]:
     
    job = JobHadoopDistCp('JobHadoopDistCpSample',
    @@ -755,7 +755,7 @@ 

    JobHadoopDistCp

    AutomationAPI Documentation

    -
    [62]:
    +
    [23]:
     
    job = JobHadoopHDFSCommands('JobHadoopHDFSCommandsSample',
    @@ -771,7 +771,7 @@ 

    JobHadoopHDFSCommandsJobHadoopHDFSFileWatcher

    AutomationAPI Documentation

    -
    [63]:
    +
    [24]:
     
    job = JobHadoopHDFSFileWatcher('JobHadoopHDFSFileWatcherSample',
    @@ -788,7 +788,7 @@ 

    JobHadoopHDFSFileWatcher

    AutomationAPI Documentation

    -
    [64]:
    +
    [25]:
     
    job = JobHadoopOozie('JobHadoopOozieSample',
    @@ -805,7 +805,7 @@ 

    JobHadoopOozie

    AutomationAPI Documentation

    -
    [65]:
    +
    [26]:
     
    job = JobHadoopMapReduce('JobHadoopMapReduceSample',
    @@ -824,7 +824,7 @@ 

    JobHadoopMapReduce

    AutomationAPI Documentation

    -
    [66]:
    +
    [27]:
     
    job = JobHadoopMapredStreaming('JobHadoopMapredStreamingSample',
    @@ -846,7 +846,7 @@ 

    JobHadoopMapredStreaming

    AutomationAPI Documentation

    -
    [67]:
    +
    [28]:
     
    job = JobHadoopTajoInputFile('JobHadoopTajoInputFileSample',
    @@ -865,7 +865,7 @@ 

    JobHadoopTajoInputFileJobHadoopTajoQuery

    AutomationAPI Documentation

    -
    [68]:
    +
    [29]:
     
    job = JobHadoopTajoQuery('JobHadoopTajoQuerySample',
    @@ -893,7 +893,7 @@ 

    JobPeopleSoft -
    [69]:
    +
    [30]:
     
    job = JobPeopleSoft('JobPeopleSoftSample',
    @@ -929,7 +929,7 @@ 

    JobInformatica -
    [70]:
    +
    [31]:
     
    job = JobInformatica('JobInformaticaSample',
    @@ -963,7 +963,7 @@ 

    JobAWSLambda -
    [71]:
    +
    [32]:
     
    job = JobAWSLambda('JobAWSLambdaSample',
    @@ -993,7 +993,7 @@ 

    JobAWSStepFunction -
    [72]:
    +
    [33]:
     
    job = JobAWSStepFunction('JobAWSStepFunctionSample',
    @@ -1031,7 +1031,7 @@ 

    JobAWSBatch -
    [73]:
    +
    [34]:
     
    job = JobAWSBatch('JobAWSBatchSample',
    @@ -1071,7 +1071,7 @@ 

    JobAzureFunction -
    [74]:
    +
    [35]:
     
    job = JobAzureFunction('JobAzureFunctionSample',
    @@ -1102,14 +1102,14 @@ 

    JobAzureLogicApps -
    [75]:
    +
    [36]:
     
    job = JobAzureLogicApps('JobAzureLogicAppsSample',
                             connection_profile='CPAZURE',
    -                        logic_app_name='logic_app',
    -                        request_body='{"name":"value"}',
    -                        append_log=True)
    +                        workflow='workflow_app',
    +                        parameters='{"name":"value"}'
    +                        )
     
    @@ -1132,7 +1132,7 @@

    JobAzureBatchAccount

    append_log: File retention period for the batch job. If you do not include this parameter, the default is an unlimited retention period.

    -
    [76]:
    +
    [37]:
     
    job = JobAzureBatchAccount('JobAzureBatchAccountSample',
    @@ -1157,7 +1157,7 @@ 

    JobWebServices -
    [77]:
    +
    [38]:
     
    job = JobWebServices('JobWebServicesSample',
    @@ -1216,7 +1216,7 @@ 

    JobWebServices

    AutomationAPI Documentation

    -
    [78]:
    +
    [39]:
     
    job = JobSLAManagement('JobSLAManagementSample',
    @@ -1234,6 +1234,38 @@ 

    JobSLAManagement +

    JobZOS

    +

    AutomationAPI Documentation

    +
    +
    [40]:
    +
    +
    +
    job = JobZOSMember('JobZOSMemberSample',
    +                   member_library='IOAQ.AAPI#AU.JCL',
    +                   archiving=JobZOS.Archiving(archive_sys_data=True),
    +                   must_end=JobZOS.MustEnd(hours='1', minutes='15', days=1),
    +                   run_on_all_agents_in_group=True
    +                  )
    +
    +
    +
    +
    +
    [41]:
    +
    +
    +
    job = JobZOSInStreamJCL('JobZOInStreamJCLSample',
    +                   member_library='IOAQ.AAPI#AU.JCL',
    +                   jcl="//AUTEST0 JOB ,ASM,CLASS=A,REGION=0M\\n// JCLLIB ORDER=IOAQ.AAPI#AU.PROCLIB\\n// INCLUDE MEMBER=IOASET\\n//S1 EXEC IOATEST,PARM='TERM=C0000'",
    +                   archiving=JobZOS.Archiving(archive_sys_data=True),
    +                   run_on_all_agents_in_group=True,
    +                   created_by='workbench',
    +                   run_as='workbench'
    +                  )
    +
    +
    +
    + @@ -1326,6 +1358,7 @@

    JobSLAManagementJobAzureBatchAccount
  • JobWebServices
  • JobSLAManagement
  • +
  • JobZOS
  • diff --git a/docs/notebooks/jobtypes.ipynb b/docs/notebooks/jobtypes.ipynb index d77fff5..bd6d417 100644 --- a/docs/notebooks/jobtypes.ipynb +++ b/docs/notebooks/jobtypes.ipynb @@ -9,7 +9,7 @@ }, { "cell_type": "code", - "execution_count": 40, + "execution_count": 1, "metadata": {}, "outputs": [], "source": [ @@ -35,7 +35,7 @@ }, { "cell_type": "code", - "execution_count": 41, + "execution_count": 2, "metadata": {}, "outputs": [], "source": [ @@ -44,7 +44,7 @@ }, { "cell_type": "code", - "execution_count": 42, + "execution_count": 3, "metadata": {}, "outputs": [], "source": [ @@ -81,7 +81,7 @@ }, { "cell_type": "code", - "execution_count": 43, + "execution_count": 4, "metadata": {}, "outputs": [], "source": [ @@ -90,7 +90,7 @@ }, { "cell_type": "code", - "execution_count": 44, + "execution_count": 5, "metadata": {}, "outputs": [], "source": [ @@ -122,7 +122,7 @@ }, { "cell_type": "code", - "execution_count": 45, + "execution_count": 6, "metadata": {}, "outputs": [], "source": [ @@ -160,7 +160,7 @@ }, { "cell_type": "code", - "execution_count": 46, + "execution_count": 7, "metadata": {}, "outputs": [], "source": [ @@ -180,7 +180,7 @@ }, { "cell_type": "code", - "execution_count": 47, + "execution_count": 8, "metadata": {}, "outputs": [], "source": [ @@ -206,7 +206,7 @@ }, { "cell_type": "code", - "execution_count": 48, + "execution_count": 9, "metadata": {}, "outputs": [], "source": [ @@ -235,7 +235,7 @@ }, { "cell_type": "code", - "execution_count": 49, + "execution_count": 10, "metadata": {}, "outputs": [], "source": [ @@ -275,7 +275,7 @@ }, { "cell_type": "code", - "execution_count": 50, + "execution_count": 11, "metadata": {}, "outputs": [], "source": [ @@ -313,7 +313,7 @@ }, { "cell_type": "code", - "execution_count": 51, + "execution_count": 12, "metadata": {}, "outputs": [], "source": [ @@ -348,7 +348,7 @@ }, { "cell_type": "code", - "execution_count": 52, + "execution_count": 13, "metadata": {}, "outputs": [], "source": [ @@ -383,7 +383,7 @@ }, { "cell_type": "code", - "execution_count": 53, + "execution_count": 14, "metadata": {}, "outputs": [], "source": [ @@ -420,7 +420,7 @@ }, { "cell_type": "code", - "execution_count": 54, + "execution_count": 15, "metadata": {}, "outputs": [], "source": [ @@ -465,7 +465,7 @@ }, { "cell_type": "code", - "execution_count": 55, + "execution_count": 16, "metadata": {}, "outputs": [], "source": [ @@ -476,7 +476,7 @@ }, { "cell_type": "code", - "execution_count": 56, + "execution_count": 17, "metadata": {}, "outputs": [], "source": [ @@ -504,7 +504,7 @@ }, { "cell_type": "code", - "execution_count": 57, + "execution_count": 18, "metadata": {}, "outputs": [], "source": [ @@ -527,7 +527,7 @@ }, { "cell_type": "code", - "execution_count": 58, + "execution_count": 19, "metadata": {}, "outputs": [], "source": [ @@ -549,7 +549,7 @@ }, { "cell_type": "code", - "execution_count": 59, + "execution_count": 20, "metadata": {}, "outputs": [], "source": [ @@ -575,7 +575,7 @@ }, { "cell_type": "code", - "execution_count": 60, + "execution_count": 21, "metadata": {}, "outputs": [], "source": [ @@ -598,7 +598,7 @@ }, { "cell_type": "code", - "execution_count": 61, + "execution_count": 22, "metadata": {}, "outputs": [], "source": [ @@ -623,7 +623,7 @@ }, { "cell_type": "code", - "execution_count": 62, + "execution_count": 23, "metadata": {}, "outputs": [], "source": [ @@ -646,7 +646,7 @@ }, { "cell_type": "code", - "execution_count": 63, + "execution_count": 24, "metadata": {}, "outputs": [], "source": [ @@ -670,7 +670,7 @@ }, { "cell_type": "code", - "execution_count": 64, + "execution_count": 25, "metadata": {}, "outputs": [], "source": [ @@ -694,7 +694,7 @@ }, { "cell_type": "code", - "execution_count": 65, + "execution_count": 26, "metadata": {}, "outputs": [], "source": [ @@ -720,7 +720,7 @@ }, { "cell_type": "code", - "execution_count": 66, + "execution_count": 27, "metadata": {}, "outputs": [], "source": [ @@ -749,7 +749,7 @@ }, { "cell_type": "code", - "execution_count": 67, + "execution_count": 28, "metadata": {}, "outputs": [], "source": [ @@ -775,7 +775,7 @@ }, { "cell_type": "code", - "execution_count": 68, + "execution_count": 29, "metadata": {}, "outputs": [], "source": [ @@ -810,7 +810,7 @@ }, { "cell_type": "code", - "execution_count": 69, + "execution_count": 30, "metadata": {}, "outputs": [], "source": [ @@ -853,7 +853,7 @@ }, { "cell_type": "code", - "execution_count": 70, + "execution_count": 31, "metadata": {}, "outputs": [], "source": [ @@ -894,7 +894,7 @@ }, { "cell_type": "code", - "execution_count": 71, + "execution_count": 32, "metadata": {}, "outputs": [], "source": [ @@ -931,7 +931,7 @@ }, { "cell_type": "code", - "execution_count": 72, + "execution_count": 33, "metadata": {}, "outputs": [], "source": [ @@ -976,7 +976,7 @@ }, { "cell_type": "code", - "execution_count": 73, + "execution_count": 34, "metadata": {}, "outputs": [], "source": [ @@ -1023,7 +1023,7 @@ }, { "cell_type": "code", - "execution_count": 74, + "execution_count": 35, "metadata": {}, "outputs": [], "source": [ @@ -1061,15 +1061,15 @@ }, { "cell_type": "code", - "execution_count": 75, + "execution_count": 36, "metadata": {}, "outputs": [], "source": [ "job = JobAzureLogicApps('JobAzureLogicAppsSample',\n", " connection_profile='CPAZURE',\n", - " logic_app_name='logic_app',\n", - " request_body='{\"name\":\"value\"}',\n", - " append_log=True)" + " workflow='workflow_app',\n", + " parameters='{\"name\":\"value\"}'\n", + " )" ] }, { @@ -1098,7 +1098,7 @@ }, { "cell_type": "code", - "execution_count": 76, + "execution_count": 37, "metadata": {}, "outputs": [], "source": [ @@ -1131,7 +1131,7 @@ }, { "cell_type": "code", - "execution_count": 77, + "execution_count": 38, "metadata": {}, "outputs": [], "source": [ @@ -1196,7 +1196,7 @@ }, { "cell_type": "code", - "execution_count": 78, + "execution_count": 39, "metadata": {}, "outputs": [], "source": [ @@ -1212,6 +1212,45 @@ " units=JobSLAManagement.AverageRunTimeTolerance.Units.Minutes\n", " ))\n" ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## JobZOS\n", + "\n", + "[AutomationAPI Documentation](https://documents.bmc.com/supportu/API/Monthly/en-US/Documentation/API_CodeRef_JobTypes_zOS.htm?Highlight=zos)" + ] + }, + { + "cell_type": "code", + "execution_count": 40, + "metadata": {}, + "outputs": [], + "source": [ + "job = JobZOSMember('JobZOSMemberSample', \n", + " member_library='IOAQ.AAPI#AU.JCL',\n", + " archiving=JobZOS.Archiving(archive_sys_data=True),\n", + " must_end=JobZOS.MustEnd(hours='1', minutes='15', days=1),\n", + " run_on_all_agents_in_group=True\n", + " )\n" + ] + }, + { + "cell_type": "code", + "execution_count": 41, + "metadata": {}, + "outputs": [], + "source": [ + "job = JobZOSInStreamJCL('JobZOInStreamJCLSample', \n", + " member_library='IOAQ.AAPI#AU.JCL',\n", + " jcl=\"//AUTEST0 JOB ,ASM,CLASS=A,REGION=0M\\\\n// JCLLIB ORDER=IOAQ.AAPI#AU.PROCLIB\\\\n// INCLUDE MEMBER=IOASET\\\\n//S1 EXEC IOATEST,PARM='TERM=C0000'\",\n", + " archiving=JobZOS.Archiving(archive_sys_data=True),\n", + " run_on_all_agents_in_group=True,\n", + " created_by='workbench',\n", + " run_as='workbench'\n", + " )" + ] } ], "metadata": { @@ -1233,7 +1272,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.10.4" + "version": "3.8.9" } }, "nbformat": 4, diff --git a/docs/objects.inv b/docs/objects.inv index 4e57a76..751e59e 100644 Binary files a/docs/objects.inv and b/docs/objects.inv differ diff --git a/docs/searchindex.js b/docs/searchindex.js index 330b0c1..6d0bfea 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["aapi", "aapi.integration_factory", "beyond", "ctm_python_client", "ctm_python_client.core", "ctm_python_client.ext", "gettingstarted", "index", "notebooks/ai", "notebooks/authentication", "notebooks/autogen", "notebooks/connectionprofiles", "notebooks/folders", "notebooks/hello", "notebooks/jobproperties", "notebooks/jobtypes", "notebooks/monitoring", "tutorials"], "filenames": ["aapi.rst", "aapi.integration_factory.rst", "beyond.md", "ctm_python_client.rst", "ctm_python_client.core.rst", "ctm_python_client.ext.rst", "gettingstarted.md", "index.rst", "notebooks\\ai.ipynb", "notebooks\\authentication.ipynb", "notebooks\\autogen.ipynb", "notebooks\\connectionprofiles.ipynb", "notebooks\\folders.ipynb", "notebooks\\hello.ipynb", "notebooks\\jobproperties.ipynb", "notebooks\\jobtypes.ipynb", "notebooks\\monitoring.ipynb", "tutorials.rst"], "titles": ["aapi package", "aapi.integration_factory package", "Going Forward", "ctm_python_client package", "ctm_python_client.core package", "ctm_python_client.ext package", "Getting Started", "Control-M Python Client Documentation", "Working with Application Integrator", "Authentication", "Auto generation of AI Plugins with Control-M Workbench", "Connection Profiles", "Folders", "Getting Started with Control-M Python Client", "Job and Folder Properties", "Job types", "Monitoring Flows with Control-M Python Client", "Tutorials"], "terms": {"integration_factori": 0, "connection_profil": [0, 8, 10, 15], "after": [2, 8, 10, 13, 14, 15, 16], "you": [2, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "complet": [2, 10, 13, 14, 15, 16], "tutori": [2, 6, 7, 9, 16], "": [2, 6, 8, 13, 15, 16], "time": [2, 10, 12, 13, 14, 15, 16], "write": 2, "your": [2, 4, 6, 7, 8, 9, 10, 13, 15, 16], "own": [2, 8, 9, 13], "workflow": [2, 3, 6, 7, 8, 9, 10, 15, 17], "workbench": [2, 3, 4, 6, 7, 9, 13, 14, 16, 17], "which": [2, 4, 8, 9, 11, 13, 14, 15, 16], "i": [2, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "free": [2, 6], "backend": [2, 9], "develop": [2, 6, 7, 9], "environ": [2, 3, 4, 7, 8, 10, 13, 14, 15, 16, 17], "learn": [2, 13, 16], "how": [2, 6, 13, 14, 16], "creat": [2, 4, 6, 8, 9, 10, 11, 14, 15, 16, 17], "more": [2, 4, 9, 12, 13, 14, 16], "complex": 2, "from": [2, 4, 8, 9, 10, 11, 12, 13, 14, 15, 16], "resourc": [2, 7, 12], "below": [2, 8, 14], "The": [2, 4, 6, 9, 11, 12, 13, 14, 15, 16], "provis": 2, "servic": [2, 5, 9, 15], "autom": [2, 8, 9, 11, 13, 15, 16], "api": [2, 8, 9, 11, 12, 13, 15, 16], "enabl": [2, 7, 8, 12, 13, 14, 15, 16], "easili": [2, 8], "instal": [2, 7, 9, 13, 14, 15, 16], "agent": [2, 8, 11, 13, 14, 16], "document": [2, 9, 11, 14, 15], "helix": [2, 4, 9], "an": [2, 4, 6, 8, 9, 13, 14, 15, 16], "applic": [2, 4, 7, 10, 11, 12, 14, 16, 17], "integr": [2, 7, 10, 15, 17], "deriv": [2, 8], "its": [2, 4, 9, 12, 13, 14, 15, 16], "abstract": [2, 4, 9], "class": [2, 4, 5, 8, 9, 10], "exist": [2, 13, 15, 16], "implement": [2, 9], "sinc": [2, 9, 13, 14], "open": 2, "sourc": [2, 15], "code": [2, 8, 9, 10, 12, 13, 14, 16], "feel": 2, "extens": 2, "can": [2, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16], "commun": 2, "pull": 2, "request": 2, "we": [2, 6, 8, 9, 10, 13, 14, 16], "ar": [2, 4, 8, 9, 11, 12, 13, 14, 15], "happi": 2, "review": 2, "core": [3, 7, 8, 9, 10, 13, 16], "submodul": 3, "comm": [3, 8, 9, 13, 16], "aapiclientrespons": [3, 4], "is_ok": [3, 4, 13], "abstractaapicli": [3, 4], "authent": [3, 4, 7, 17], "create_onprem": [3, 4, 9], "create_saa": [3, 4, 9], "create_workbench": [3, 4, 9, 13, 16], "environmentmod": [3, 4, 9], "onprem": [3, 4, 9], "saa": [3, 4, 9], "onpremaapicli": [3, 4], "saasaapicli": [3, 4], "credenti": [3, 11, 17], "abstractcredenti": [3, 4, 5, 9], "get_password": [3, 4, 5, 9], "get_usernam": [3, 4, 5, 9], "inputpasswordcredenti": [3, 4, 9], "simplecredenti": [3, 4, 9], "monitor": [3, 7, 17], "confirm_job": [3, 4], "delete_job": [3, 4], "get_log": [3, 4, 16], "get_output": [3, 4, 10, 13, 16], "get_status": [3, 4], "hold_job": [3, 4], "kill_job": [3, 4], "release_job": [3, 4], "rerun_job": [3, 4], "set_to_ok": [3, 4], "runmonitor": [3, 4, 13, 16], "get_jobid": [3, 4], "get_statu": [3, 4, 16], "open_in_brows": [3, 4], "print_output": [3, 4, 13, 16], "print_status": [3, 4, 16], "ext": [3, 7, 9, 10, 13, 16], "keyringcredenti": [3, 5, 9], "viz": [3, 13, 16], "success": [4, 15], "bool": 4, "result": 4, "ani": [4, 8, 9, 13, 14, 15], "none": [4, 13, 14, 15, 16], "error": [4, 14, 17], "list": [4, 12, 13, 14, 15], "base": [4, 5, 8, 9, 14], "object": [4, 9, 10, 13, 14, 15, 16], "abc": [4, 15], "classmethod": 4, "endpoint": [4, 9, 15], "str": [4, 5], "usernam": [4, 5, 9, 11], "password": [4, 9, 10, 11], "api_kei": [4, 9], "mode": [4, 9, 15], "static": [4, 9], "host": [4, 9, 11, 13, 15, 16], "port": [4, 9, 11, 15], "8443": [4, 9, 16], "localhost": [4, 9, 11, 16], "valu": [4, 9, 10, 12, 14, 15], "enum": 4, "enumer": 4, "control": [4, 6, 8, 9, 11, 12, 14, 15, 17], "m": [4, 6, 8, 9, 11, 12, 14, 15, 17], "us": [4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "custom": [4, 9, 15, 17], "advanc": [4, 16], "case": [4, 8, 9], "aapicli": 4, "job_id": [4, 15, 16], "confirm": [4, 12, 14], "job": [4, 6, 7, 10, 11, 12, 17], "thi": [4, 8, 9, 10, 11, 12, 13, 14, 15, 16], "onli": [4, 9, 11, 13, 15, 16], "appli": [4, 14, 15], "where": [4, 9, 13, 14, 15], "defin": [4, 8, 9, 10, 11, 12, 13, 14, 15], "true": [4, 10, 11, 12, 13, 14, 15, 16], "try": [4, 13, 16], "t": [4, 6, 13, 14, 15], "wa": [4, 13, 14, 16], "alreadi": 4, "delet": [4, 14, 15, 16], "get": [4, 7, 9, 15, 17], "log": [4, 15, 16], "describ": 4, "all": [4, 8, 10, 11, 12, 13, 14, 15, 16], "action": [4, 7, 12, 15, 16], "regard": 4, "execut": [4, 9, 10, 13, 14, 15, 16], "run_numb": 4, "int": 4, "0": [4, 10, 11, 14, 15], "run_id": 4, "filter": 4, "dict": 4, "hold": 4, "kill": 4, "releas": 4, "held": [4, 16], "rerun": [4, 7, 12, 16], "set": [4, 9, 12, 14, 15, 16], "ok": [4, 8, 14, 16], "monitor_page_uri": 4, "allow": [4, 8, 9, 10, 14], "basic": 4, "function": [4, 8, 15, 16], "similar": [4, 8], "wai": [4, 6, 9, 13, 16], "found": [4, 14, 16], "web": [4, 8, 15, 16], "interfac": [4, 8], "job_nam": [4, 10, 11, 15], "id": [4, 6, 11, 15], "name": [4, 8, 10, 11, 13, 14, 15, 16], "without": [4, 8, 9, 14, 16], "path": [4, 13, 15, 16], "If": [4, 6, 7, 9, 10, 11, 12, 13, 15, 16], "multipl": [4, 9, 11, 13, 14], "same": [4, 8, 9, 13, 14, 15, 16], "determin": [4, 15], "accord": [4, 13, 16], "given": 4, "undefin": 4, "behavior": 4, "exampl": [4, 8, 9, 10, 13, 14, 15, 16], "myjob": [4, 11, 13], "myfold": [4, 12, 13], "subfolder1": 4, "subfolder2": 4, "output": [4, 14, 15, 16, 17], "return": [4, 13, 14, 15, 16], "statu": [4, 13, 14, 17], "run": [4, 6, 7, 9, 10, 11, 12, 14, 15, 17], "print": [4, 8, 10, 11, 13, 14, 16], "kwarg": 4, "pretti": 4, "full": 4, "pass": [4, 9, 11, 13, 14, 15, 16], "printer": 4, "specifi": [4, 9, 12, 13, 14, 15], "pritner": 4, "accept": [4, 8, 15], "one": [4, 8, 11, 12, 13, 14], "argument": [4, 7, 8, 11, 13, 14, 15], "status": [4, 16], "best": [6, 9], "know": [6, 13], "python": [6, 8, 9, 10, 15, 17], "client": [6, 8, 9, 10, 17], "follow": [6, 9, 10, 11, 13, 14], "guid": 6, "through": [6, 8], "first": [6, 13], "step": [6, 10, 15], "build": [6, 17], "see": [6, 8, 12, 14, 16], "To": [6, 8, 11, 12, 13, 14, 15, 16], "deploi": [6, 8, 11, 14, 17], "need": [6, 8, 9, 13, 15, 16], "access": [6, 11, 13, 14, 15], "activ": [6, 15], "don": [6, 13], "have": [6, 9, 10, 13, 15], "want": [6, 9, 10, 13, 15], "test": [6, 13, 15, 16], "some": [6, 9, 10, 13, 16], "cost": 6, "platform": [6, 8], "suggest": 6, "download": [6, 13, 16], "requir": [6, 9, 13, 14, 15], "version": [6, 10, 14, 15], "3": [6, 12, 14, 15], "7": [6, 14, 15, 16], "higher": 6, "recommend": [6, 14], "virtual": 6, "here": [6, 13, 14], "unix": [6, 11], "venv": 6, "bin": [6, 11, 15], "window": 6, "script": [6, 12, 15], "bat": 6, "note": [6, 8, 9, 11, 13, 14, 15, 16], "git": 6, "ctm": [6, 12, 15, 16], "clone": 6, "http": [6, 9, 11, 13, 15, 16], "github": [6, 7], "com": [6, 11, 14, 15], "controlm": [6, 12, 14], "librari": [7, 9], "design": 7, "schedul": [7, 12, 13, 14], "programmat": 7, "built": [7, 13], "data": [7, 13, 15], "scientist": 7, "who": [7, 14], "prefer": [7, 16], "approach": 7, "orchestr": 7, "repo": 7, "start": [7, 10, 14, 15, 16, 17], "flow": [7, 10, 17], "work": [7, 9, 13, 14, 17], "auto": [7, 15, 17], "gener": [7, 14, 17], "ai": [7, 8, 17], "plugin": [7, 13, 17], "folder": [7, 8, 13, 15], "subfold": [7, 13, 14, 16], "type": [7, 9, 10, 11, 12, 13, 14, 16, 17], "jobcommand": [7, 12, 13, 14, 16], "jobscript": [7, 12], "jobembeddedscript": 7, "jobfiletransf": [7, 13], "jobfilewatchercr": 7, "jobfilewatcherdelet": 7, "jobdatabaseembeddedqueri": 7, "jobdatabasesqlscript": 7, "jobdatabasestoredprocedur": 7, "jobdatabasemssqlagentjob": 7, "jobdatabasemssql_ssi": 7, "jobhadoopsparkpython": 7, "jobhadoopsparkscalajava": 7, "jobhadooppig": 7, "jobhadoopsqoop": 7, "jobhadooph": 7, "jobhadoopdistcp": 7, "jobhadoophdfscommand": 7, "jobhadoophdfsfilewatch": 7, "jobhadoopoozi": 7, "jobhadoopmapreduc": 7, "jobhadoopmapredstream": 7, "jobhadooptajoinputfil": 7, "jobhadooptajoqueri": 7, "jobpeoplesoft": 7, "jobinformatica": 7, "jobawslambda": 7, "jobawsstepfunct": 7, "jobawsbatch": 7, "jobazurefunct": 7, "jobazurelogicapp": 7, "jobazurebatchaccount": 7, "jobwebservic": 7, "jobslamanag": 7, "properti": [7, 10, 12, 15], "when": [7, 9, 11, 12, 13, 15, 16], "notifi": 7, "variabl": [7, 8, 12, 15], "event": [7, 12, 16], "connect": [7, 8, 10, 15], "profil": [7, 8, 10, 15], "connectionprofilehadoop": 7, "connectionprofilefiletransf": 7, "connectionprofiledatabas": 7, "connectionprofilesap": 7, "connectionprofileinformatica": 7, "connectionprofileaw": 7, "connectionprofileazur": 7, "go": 7, "forward": 7, "link": 7, "extend": 7, "aapi": [7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "packag": [7, 9, 15], "ctm_python_cli": [7, 8, 9, 10, 13, 16], "These": 8, "manag": [8, 12, 14, 15], "alongsid": 8, "premis": 8, "multi": 8, "cloud": 8, "commerci": 8, "home": [8, 11, 12, 14, 15, 16], "grown": 8, "singl": [8, 15], "provid": [8, 9, 14, 16], "other": [8, 12, 13, 14], "palett": 8, "plan": 8, "domain": [8, 11, 16], "new": [8, 10, 13, 15], "jobtyp": 8, "made": 8, "easi": 8, "serv": [8, 9], "necessari": [8, 9], "make": [8, 9, 13, 14], "valid": [8, 13, 14], "definit": [8, 10, 11, 12, 13, 14, 15], "let": [8, 13, 16], "simpl": [8, 12, 13], "call": [8, 9, 10, 13], "sshcommand": 8, "It": [8, 9, 13], "two": [8, 9, 14, 15], "paramat": 8, "command": [8, 10, 12, 13, 14, 15, 16], "flag": 8, "addit": [8, 14, 15], "cannot": [8, 13, 14, 16], "add": [8, 10, 13, 14, 15], "edit": [8, 15, 16], "must": [8, 11, 12, 13, 14, 15], "them": [8, 13], "1": [8, 10, 11, 14, 15, 16], "import": [8, 9, 10, 11, 12, 13, 14, 15, 16], "attr": [8, 10], "decor": 8, "aijobsshcommand": 8, "_type": [8, 10], "type_field": [8, 10], "field": [8, 10, 12], "would": [8, 9, 16], "should": [8, 13, 14, 15, 16], "match": 8, "seen": 8, "section": [8, 14], "lower": 8, "field_opt": [8, 10], "option": [8, 14, 15], "mandatori": 8, "2": [8, 10, 11, 12, 13, 14, 15, 16], "check": [8, 17], "json": [8, 15], "baseworkflow": 8, "mysshcommand": 8, "hostcp": 8, "l": [8, 14, 15, 16], "q": 8, "inpath": [8, 10, 13, 16], "aifold": 8, "dumps_json": 8, "indent": [8, 11, 14, 16], "34": [8, 10, 11, 13, 14], "applicationintegr": 8, "connectionprofil": [8, 10], "5": [8, 10, 14, 15, 16], "In": [9, 13, 14, 15, 16], "previou": [9, 14, 16], "focus": 9, "issu": [9, 14, 16], "real": [9, 13], "essenti": 9, "practic": 9, "prevent": 9, "leak": 9, "sensit": 9, "inform": [9, 10, 13, 16], "done": [9, 13], "default": [9, 10, 11, 12, 13, 14, 15, 16], "creation": 9, "skip": [9, 13], "initi": [9, 15], "intent": [9, 13], "immedi": 9, "dure": [9, 14, 15], "construct": 9, "ehich": 9, "em": 9, "There": [9, 13, 16], "method": [9, 11, 12, 13, 16], "kei": [9, 11, 14], "either": [9, 13, 15, 16], "combin": [9, 14], "indic": 9, "slightli": 9, "differ": [9, 14, 15], "constructor": 9, "my_environ": 9, "mymachin": 9, "user": [9, 10, 11, 12, 13, 14, 15, 16], "anoth": [9, 12, 13, 14], "mysaa": 9, "myapikei": 9, "wokrbench": 9, "remot": 9, "machin": [9, 13, 15], "map": 9, "instanc": [9, 13, 14, 15], "contain": [9, 11, 12, 15, 16], "8444": 9, "ha": [9, 13, 14], "those": [9, 14], "via": 9, "directli": [9, 13], "least": [9, 14], "secur": [9, 11], "written": [9, 15], "plain": 9, "text": [9, 14, 15], "input": [9, 15], "disrupt": 9, "process": [9, 15, 16], "intervent": 9, "keyr": 9, "leverag": 9, "oper": [9, 10, 14, 15], "system": [9, 12, 15], "store": [9, 11, 15], "imposs": 9, "everi": [9, 12, 13, 14, 15], "mai": [9, 13, 14], "vault": 9, "specif": [9, 11, 13, 14, 15], "compani": [9, 12, 14], "polici": [9, 12], "easiest": 9, "mhyhost": 9, "myuser": [9, 11], "token": 9, "sure": 9, "pip": 9, "termin": 9, "servicenam": [9, 11], "distinguish": 9, "between": [9, 15], "product": [9, 16], "also": [9, 12, 13], "do": [9, 11, 13, 14, 15, 16], "set_password": 9, "so": [9, 13, 16], "put": 9, "seem": 9, "signific": 9, "tokenadmin": 9, "9": [10, 11, 14, 15, 16], "21": [10, 11, 13, 14, 15], "100": [10, 11, 15], "abov": 10, "autogen": 10, "modul": 10, "along": 10, "file": [10, 11, 15], "autogener": 10, "generatedplugin": 10, "py": [10, 15], "generate_ai_plugins_class": 10, "output_fil": 10, "aijobexampleplugin": 10, "aijob": [10, 17], "39": [10, 13, 16], "examplefield": 10, "examplewithdefault": 10, "examplefieldwithdefault": 10, "connectionprofileaiexampleplugin": 10, "aiconnectionprofil": 10, "examplepassword": 10, "now": [10, 13], "With": 10, "our": [10, 16], "6": [10, 14, 15, 16], "cp": [10, 15], "testcp": 10, "central": [10, 11], "myexamplejob": 10, "my": 10, "4": [10, 14, 16], "w": 10, "testapplicationintegr": 10, "scope": 10, "unnam": 10, "line": [10, 14, 15, 16], "echo": [10, 12, 13, 14, 15, 16], "exit": 10, "statist": 10, "20230213085531": 10, "end": [10, 14, 16], "20230213085532": 10, "elaps": 10, "71": [10, 15], "messag": [10, 14, 15, 16], "normal": 10, "automationapi": [11, 14, 15], "thei": [11, 16], "referenc": 11, "befor": [11, 14, 16], "relev": 11, "For": [11, 12, 14, 15, 16], "most": 11, "except": 11, "transfer": [11, 15], "charact": [11, 15], "uppercas": 11, "letter": 11, "number": [11, 14, 15, 16], "hyphen": 11, "underscor": 11, "up": [11, 14, 15], "30": [11, 13, 14], "target_ctm": 11, "fals": [11, 13, 15, 16], "server": [11, 12, 15], "target_ag": 11, "descript": [11, 12, 14, 16], "avail": [11, 14, 15], "20": [11, 13, 14, 15], "000": [11, 15], "whether": [11, 14, 15], "databas": [11, 13, 15], "apach": 11, "spark": [11, 15], "cp_spark": 11, "spark_connection_profil": 11, "docker": [11, 15], "hadoop": [11, 15], "custom_path": 11, "oozi": 11, "cp_ooz": 11, "oozie_connection_profil": 11, "ssl_enabl": 11, "hdp": 11, "cento": 11, "11000": 11, "extraction_rul": 11, "extractrul": 11, "rule_nam": 11, "rule1": 11, "work_flow_nam": 11, "wf1": [11, 15], "work_flow_user_nam": 11, "user1": [11, 15], "folder_nam": 11, "fname1": 11, "jname1": 11, "rule2": 11, "wf2": 11, "user2": 11, "fname2": 11, "jname2": 11, "sqoop": 11, "cp_sqoop": 11, "sqoop_connection_profil": 11, "mypass": 11, "connection_str": 11, "jdbc": 11, "mysql": 11, "driver_class": 11, "driver": 11, "tajo": 11, "cp_tajo": 11, "tajo_cp": 11, "binary_path": 11, "tajo_hom": 11, "database_nam": 11, "master_server_nam": 11, "mytajoserv": 11, "master_server_port": 11, "26001": 11, "hive": [11, 15], "cp_hive": 11, "hive_connection_profil": 11, "hivehost": 11, "10000": 11, "db": 11, "ftcon": 11, "ftpconn": 11, "ctmserver": [11, 12, 14], "host_nam": 11, "ftpserver": 11, "ftpuser": 11, "ftp_pass": 11, "additional_paramet": 11, "packageparam": 11, "param1": [11, 15], "param2": [11, 15], "home_directori": 11, "os_typ": 11, "sftpconn": 11, "sftpserver": 11, "sftpuser": 11, "private_key_nam": 11, "passphras": 11, "ssh_compress": 11, "ftpsconn": 11, "ssl_implicit": 11, "clear_command_channel": 11, "clear_data_channel": 11, "ssl_level": 11, "ssllevel": 11, "clientserverauthent": 11, "localconn": 11, "testamazon": 11, "access_kei": 11, "secret_access_kei": 11, "secretaccess": 11, "verify_destin": 11, "testcompat": 11, "rest_end_point": 11, "as2_conn_1": 11, "workload_automation_group": 11, "noai": 11, "partner_as2_id": 11, "partner": 11, "partner_destination_url": 11, "dest": [11, 15], "partner_certificate_alia": 11, "alia": 11, "cpdb": [11, 15], "db2_connection_profil": 11, "db2host": 11, "50000": 11, "db2": 11, "jdbc_connection_profil": 11, "pgdrv": 11, "mssql_connection_profil": 11, "database_vers": 11, "2005": 11, "max_concurrent_connect": 11, "connection_retry_time_out": 11, "connection_idle_tim": 11, "45": [11, 15], "oracle_connection_profil": 11, "sid": 11, "orcl": 11, "service_nam": [11, 15], "1521": 11, "postgresql_connection_profil": 11, "postgr": 11, "sybase_connection_profil": 11, "cpsap": 11, "sapcon": 11, "sap_client": 11, "languag": 11, "xbp_version": 11, "xbp3": 11, "app_vers": 11, "r3": 11, "application_server_logon": 11, "applicationserverlogon": 11, "system_numb": 11, "12": [11, 14, 16], "secured_network_connect": 11, "securednetworkconnect": 11, "snc_lib": 11, "snc_partner_nam": 11, "quality_of_protect": 11, "snc_my_nam": 11, "sap_response_time_out": 11, "180": 11, "use_extend": 11, "solution_manager_connection_profil": 11, "ip4": 11, "group": [11, 12], "is_solution_manager_connection_profil": 11, "dumps_aapi": [11, 14], "cpinf": 11, "informatica_connect": 11, "inf": 11, "power_center_domain": 11, "repositori": [11, 15], "rep": 11, "integration_servic": 11, "security_domain": 11, "nativ": 11, "connection_typ": 11, "connectiontyp": 11, "cpaw": [11, 15], "aws_connection_iamrol": 11, "iam_rol": 11, "myrol": 11, "region": 11, "ap": 11, "northeast": 11, "proxy_set": 11, "proxyset": 11, "12345": 11, "cpazur": [11, 15], "azure_connect": 11, "active_directory_domain_nam": 11, "subscription_id": 11, "application_id": 11, "batch": [11, 15], "batch_account_nam": 11, "mybatch": 11, "batch_account_kei": 11, "locat": [11, 15], "centralu": 11, "oppos": 12, "configur": [12, 15], "variou": [12, 14], "ad": [12, 14, 17], "notif": [12, 14], "level": [12, 14], "inherit": [12, 15], "within": [12, 14], "criteria": [12, 14], "instead": 12, "per": 12, "take": [12, 16], "rule": 12, "reduc": [12, 15], "sample_fold": 12, "job_list": [12, 13, 14], "job1": [12, 13, 14], "am": [12, 16], "job2": [12, 13, 14], "jobdummi": [12, 13], "job3": [12, 13], "controlm_serv": [12, 14], "site_standard": [12, 14], "mysitestandard": 12, "business_field": [12, 14], "depart": [12, 14], "hr": [12, 14], "bmc": [12, 14, 15], "order_method": [12, 14], "ordermethod": [12, 14], "manual": [12, 14], "A": [12, 13, 14, 15, 16], "parent": 12, "next": [12, 14, 15, 16], "offer": [12, 13], "mani": 12, "capabl": [12, 14], "regular": [12, 13, 14], "folderwithsubfold": 12, "sub_folder_list": [12, 14], "firstsubfold": 12, "file_nam": [12, 15], "sh": [12, 14, 15], "file_path": [12, 15], "secondsubfold": 12, "dummyjob": 12, "than": [12, 14], "belong": 12, "enforc": 12, "site": 12, "standard": [12, 15], "busi": 12, "order": [12, 14, 15, 16], "automat": 12, "dai": [12, 13, 14, 15], "ignor": 12, "active_retention_polici": [12, 14], "retent": [12, 15], "share": [12, 13, 14, 15], "notebook": 12, "samplefold": [12, 14], "sitestd": [12, 14], "applicationnam": [12, 14], "sub_appl": [12, 14, 16], "subappl": [12, 14], "run_a": [12, 13, 14, 15, 16], "week_dai": [12, 14], "sun": [12, 14], "activeretentionpolici": [12, 14], "keepal": [12, 14], "days_keep_act": [12, 14], "41": [12, 14, 15], "created_bi": [12, 14], "foldersampl": [12, 14], "lot": [12, 14], "prioriti": [12, 14], "high": [12, 14], "rerun_limit": [12, 14], "rerunlimit": [12, 14], "time_zon": [12, 14], "haw": [12, 14], "var1": [12, 14, 15], "val": [12, 14], "var2": [12, 14], "val2": [12, 14, 15], "organ": 13, "pc": 13, "18": [13, 14, 16], "workflowdefault": [13, 16], "19": [13, 14, 15], "task": [13, 15, 16], "includ": [13, 14, 15], "worbench": 13, "each": [13, 14, 15], "purpos": 13, "o": [13, 14], "hello": [13, 14, 15, 16], "world": 13, "myfirstjob": [13, 14], "could": 13, "posit": 13, "mean": [13, 14], "although": 13, "yet": 13, "root": [13, 14, 15], "insid": 13, "simplefold": 13, "myfirstfold": 13, "equival": 13, "everyth": 13, "22": [13, 14, 15], "still": 13, "overwrit": 13, "reciev": 13, "warn": 13, "23": [13, 14], "perform": [13, 15], "choos": 13, "anytim": 13, "24": [13, 14], "25": [13, 14], "exisit": 13, "exisitng": 13, "Then": 13, "final": 13, "sequenc": 13, "26": [13, 14], "clear": 13, "clear_al": [13, 16], "firstjob": 13, "come": 13, "secondjob": 13, "mysecondjob": 13, "second": [13, 14, 15, 16], "visus": 13, "graphviz": 13, "org": [13, 15], "forget": 13, "binari": [13, 15], "prompt": 13, "visual": 13, "represent": 13, "27": [13, 14], "get_graph": [13, 16], "28": [13, 14], "f": [13, 15], "29": [13, 14], "inconvenint": 13, "syntact": 13, "sugar": 13, "mythirdjob": 13, "third": 13, "chainedjob": 13, "trigger": [13, 14, 16], "job4": 13, "wait": [13, 14, 16], "both": [13, 14, 16], "32": [13, 14], "def": 13, "chain_job": 13, "hello1": 13, "hello2": 13, "hello3": 13, "hello4": 13, "job_chain": 13, "scenario": [13, 14, 16], "separ": [13, 14, 15], "33": [13, 14], "doe": [13, 14, 16], "noth": 13, "paramet": [13, 14, 15], "mark": [13, 14, 16], "again": [13, 14, 16], "myjob1": 13, "myjob2": 13, "testjobdummi": 13, "sleep": [13, 16], "give": [13, 16], "finish": [13, 15, 16], "No": 13, "assert": 13, "35": 13, "receiv": [13, 14], "relat": 14, "respons": 14, "By": [14, 16], "account": [14, 15], "difer": 14, "keep": 14, "did": 14, "date": 14, "kept": 14, "until": [14, 16], "maximum": [14, 15], "dayskeepact": 14, "retriev": 14, "th": 14, "over": 14, "run_as_dummi": [14, 16, 17], "boolean": 14, "dummi": [14, 15, 16, 17], "retroactive_ord": 14, "retroact": 14, "down": 14, "due": 14, "hardwar": 14, "soon": 14, "inact": 14, "zone": 14, "48": [14, 15], "hour": [14, 15], "intend": 14, "format": [14, 15], "if_list": 14, "notify_list": 14, "append": [14, 15], "mysubfolder1": 14, "otherjob": 14, "goodscenario": 14, "completion_statu": 14, "on_list": 14, "sendmail": 14, "ran": [14, 16], "successfulli": [14, 15], "team": 14, "comp": 14, "subject": 14, "badscenario": 14, "nok": 14, "runcorrectivejob": 14, "remedy_fold": 14, "remedyjob": 14, "alertifnok": 14, "destin": [14, 15], "alert": 14, "alertifjobisstuck": 14, "1200": 14, "didnt": 14, "calendar": 14, "sever": 14, "under": 14, "refer": 14, "previous": 14, "constant": 14, "hoc": 14, "manner": 14, "onc": 14, "constraint": 14, "obei": 14, "Not": [14, 16], "support": 14, "One": 14, "mon": 14, "tue": 14, "wed": 14, "thu": 14, "fri": 14, "sat": 14, "week": 14, "month": 14, "ddaywn": 14, "dmonw2": 14, "mondai": 14, "2nd": 14, "n": [14, 15], "jan": 14, "feb": 14, "mar": 14, "apr": 14, "jun": [14, 16], "jul": 14, "aug": 14, "sep": 14, "oct": 14, "nov": 14, "dec": 14, "year": 14, "month_dai": 14, "rang": [14, 15], "31": 14, "from_tim": 14, "fromtim": 14, "hhmm": 14, "to_tim": 14, "totim": 14, "submit": [14, 15, 16], "even": 14, "origin": 14, "everydai": 14, "met": 14, "never": 14, "specific_d": 14, "mm": 14, "dd": 14, "enclos": 14, "quot": 14, "comma": [14, 15], "specificd": 14, "weekdai": 14, "monthdai": 14, "howev": 14, "11": [14, 16], "1500": 14, "1800": 14, "03": 14, "10": [14, 15, 16], "01": [14, 15, 16], "statement": [14, 15], "fulfil": 14, "fail": [14, 16], "unsuccessfulli": 14, "send": [14, 15], "email": 14, "action_if_failur": 14, "notok": [14, 16], "mailtoteam": 14, "jobnam": 14, "myteam": 14, "mail": 14, "foldernam": 14, "actionbynumberofrerun": 14, "number_of_rerun": 14, "runjob": 14, "folder1": 14, "failur": [14, 15, 16], "actionbynumberoffailur": 14, "number_of_failur": 14, "actionbyjobnotsubmit": 14, "8": [14, 16], "actionbyoutputnotfound": 14, "actionbynumberexecut": 14, "number_of_execut": 14, "string": [14, 15], "outputfound": 14, "myfil": 14, "featur": 14, "enterpris": 14, "logic": [14, 15], "condit": [14, 16], "variablevalu": 14, "variable_nam": 14, "ipaddress": 14, "variable_valu": 14, "endwith": 14, "do_list": 14, "runjob1": 14, "variablenam": 14, "e": 14, "urgenc": 14, "recipi": 14, "semicolon": 14, "cc": 14, "copi": 14, "attach_output": 14, "attach": 14, "urgent": 14, "just": [14, 16], "13": [14, 16], "rerunact": 14, "14": [14, 16], "setvari": 14, "15": [14, 16], "settook": 14, "16": [14, 16], "settonotok": 14, "disabl": 14, "cyclic": [14, 16], "attribut": 14, "17": 14, "correctivejob": 14, "010218": 14, "cvar1": 14, "val1": [14, 15], "cvar2": 14, "run_as_independent_flow": 14, "notifyact": 14, "joblog": 14, "veryurg": 14, "remedi": 14, "ticket": 14, "remedyticket": 14, "summari": 14, "node": 14, "nodeid": 14, "compstat": 14, "runcount": 14, "low": 14, "copyoutput": 14, "copyher": 14, "documentaion": 14, "certain": 14, "notify1": 14, "NOT": 14, "1510": 14, "consol": [14, 15], "expect": [14, 15], "didn": 14, "less": 14, "minut": [14, 15], "lessthan": 14, "12h20": 14, "1220": 14, "reran": 14, "subsequ": 14, "submiss": 14, "late": 14, "pool": 14, "known": 14, "quantit": 14, "semaphor": 14, "concurr": 14, "resourcesampl": 14, "resource_list": 14, "semaphore1": 14, "quantiti": 14, "lock": 14, "mutex": 14, "exclus": 14, "lock1": 14, "lock_typ": 14, "locktyp": 14, "frequenc": 14, "express": 14, "whole": 14, "unit": [14, 15], "from_": 14, "calcul": [14, 15], "current": 14, "target": [14, 15], "cycl": 14, "forev": 14, "usag": 14, "anyd": 14, "orderd": 14, "previousorderd": 14, "nextorderd": 14, "mmdd": 14, "0511": 14, "show": [14, 15, 16], "waitforeventlist": 14, "e1": 14, "e2": 14, "e3": 14, "event_list": 14, "addeventlistobject": 14, "eventoutadd": 14, "e4": 14, "nodat": 14, "remov": 14, "deleteeventlistobject": 14, "eventoutdelet": 14, "e5": 14, "40": 15, "object_nam": 15, "jobcommandsampl": 15, "42": 15, "mycommand": 15, "myhost": 15, "pre_command": 15, "precommand": 15, "post_command": 15, "arrai": 15, "43": 15, "jobscriptsampl": 15, "44": 15, "jobscriptsam": 15, "arg1": 15, "arg2": 15, "itself": [15, 16], "escap": 15, "jobembeddedscriptsampl": 15, "filenam": 15, "r": 15, "bash": 15, "necho": 15, "bye": [15, 16], "file_transf": 15, "filetransf": 15, "dual": 15, "connection_profile_dual_endpoint": 15, "connection_profile_src": 15, "connection_profile_dest": 15, "number_of_retri": 15, "attempt": 15, "99": 15, "s3_bucket_nam": 15, "local": 15, "filesystem": 15, "amazon": 15, "s3": 15, "compat": 15, "storag": 15, "bucket": 15, "s3_bucket_name_src": 15, "s3_bucket_name_dest": 15, "46": 15, "jobfiletransfersampl": 15, "cp1": 15, "cp2": 15, "src": 15, "file1": 15, "cmt": 15, "file2": 15, "transfer_typ": 15, "transfertyp": 15, "transfer_opt": 15, "transferopt": 15, "srctodest": 15, "47": 15, "transer": 15, "transfers3toloc": 15, "amazoncp": 15, "localcp": 15, "empti": 15, "detect": 15, "jobfilewatchercreatesampl": 15, "c": 15, "txt": 15, "search_interv": 15, "time_limit": 15, "start_tim": [15, 16], "201705041535": 15, "stop_tim": 15, "201805041535": 15, "minimum_s": 15, "10b": 15, "wildcard": 15, "minimal_ag": 15, "1y": 15, "maximal_ag": 15, "1d2h4min": 15, "49": 15, "jobfilewatcherdeletesampl": 15, "embed": 15, "queri": [15, 16], "sql": 15, "replac": 15, "row": 15, "long": 15, "delimit": 15, "tab": 15, "autocommit": 15, "commit": 15, "output_execution_log": 15, "output_sql_output": 15, "sysout": [15, 16], "sql_output_format": 15, "xml": 15, "csv": 15, "html": 15, "50": 15, "jobembeddedquerysampl": 15, "select": 15, "firstparamnam": 15, "AS": 15, "BY": [15, 16], "desc": 15, "y": 15, "sql_script": 15, "dictionari": 15, "appear": [15, 16], "pair": 15, "51": 15, "jobdatabasesqlscriptsampl": 15, "program": 15, "stored_procedur": 15, "schema": 15, "procedur": 15, "resid": 15, "return_valu": 15, "oracl": 15, "52": 15, "jobdatabasestoredproceduresampl": 15, "public": 15, "rv": 15, "210": 15, "categori": 15, "53": 15, "jobdatabasemssqlagentjobsampl": 15, "get_vers": 15, "collector": 15, "ssi": 15, "220": 15, "package_sourc": 15, "package_nam": 15, "catalog_env": 15, "config_fil": 15, "54": 15, "jobdatabasemssql_ssissampl": 15, "packagesourc": 15, "ssis_catalog": 15, "sqltracecollect": 15, "env_nam": 15, "dbauser": 15, "desktop": 15, "dtsconfig": 15, "test2": 15, "propertynam": 15, "propertyvalu": 15, "propertyname2": 15, "propertyvalue2": 15, "spark_script": 15, "spark_opt": 15, "55": 15, "jobhadoopsparkpythonsampl": 15, "56": 15, "1000": 15, "120": 15, "master": 15, "yarn": 15, "num": 15, "executor": 15, "57": 15, "jobhadoopsparkscalajavasampl": 15, "program_jar": 15, "scalaprogram": 15, "jar": 15, "main_class": 15, "mycomp": 15, "sparkscalaprogramnam": 15, "mainclassnam": 15, "58": 15, "jobhadooppigsampl": 15, "pig_script": 15, "pg": 15, "59": 15, "jobhadoopsqoopsampl": 15, "sqoop_command": 15, "tabl": 15, "foo": [15, 16], "dir": 15, "dest_dir": 15, "sqoop_opt": 15, "warehous": 15, "latin1": 15, "60": 15, "jobhadoophivesampl": 15, "hive_script": 15, "amount": 15, "topic": 15, "food": 15, "hive_opt": 15, "logger": 15, "info": 15, "61": 15, "jobhadoopdistcpsampl": 15, "target_path": 15, "hdf": 15, "nns2": 15, "8020": 15, "bar": 15, "source_path": 15, "nns1": 15, "distcp_opt": 15, "filelimit": 15, "62": 15, "jobhadoophdfscommandssampl": 15, "nn": 15, "localfil": 15, "rm": 15, "emptydir": 15, "63": 15, "jobhadoophdfsfilewatchersampl": 15, "hdfs_file_path": 15, "min_detected_s": 15, "max_wait_tim": 15, "64": [15, 16], "jobhadoopooziesampl": 15, "job_properties_fil": 15, "oozie_opt": 15, "inputdir": 15, "usr": 15, "tucu": 15, "outputdir": 15, "65": 15, "jobhadoopmapreducesampl": 15, "mapreduc": 15, "66": 15, "jobhadoopmapredstreamingsampl": 15, "input_path": 15, "output_path": 15, "tmp": 15, "mapper_command": 15, "mapper": 15, "reducer_command": 15, "general_opt": 15, "d": 15, "permiss": 15, "umask": 15, "stream": 15, "67": 15, "jobhadooptajoinputfilesampl": 15, "full_file_path": 15, "tajo_command": 15, "tajo_opt": 15, "volum": 15, "68": 15, "jobhadooptajoquerysampl": 15, "open_queri": 15, "peoplesoft": 15, "control_id": 15, "runtim": [15, 16], "process_typ": 15, "author": 15, "process_nam": 15, "append_to_output": 15, "bind_vari": 15, "userdef": 15, "69": 15, "jobpeoplesoftsampl": 15, "cp_p": 15, "ps_user": 15, "controlid": 15, "server_nam": 15, "ptype": 15, "pname": 15, "supportu": 15, "monthli": 15, "en": 15, "u": 15, "api_coderef_jobtypes_dataintegr": 15, "htm": 15, "informatica": 15, "repository_fold": 15, "instance_nam": 15, "os_profil": 15, "workflow_execution_mod": 15, "workflow_restart_mod": 15, "suspend": 15, "satu": 15, "restart_from_task": 15, "workflowexecutionmod": 15, "startfromtask": 15, "run_single_task": 15, "runsingletask": 15, "workflow_parameters_fil": 15, "70": 15, "jobinformaticasampl": 15, "cp_inf": 15, "poc": 15, "wf_test": 15, "myinstanc": 15, "osprofil": 15, "workflowrestartmod": 15, "forcerestartfromspecifictask": 15, "s_maptest_success": 15, "opt": 15, "prop": 15, "aw": 15, "lambda": 15, "function_nam": 15, "latest": 15, "payload": 15, "append_log": 15, "jobawslambdasampl": 15, "fname": 15, "myvar": 15, "value1": 15, "othervar": 15, "value2": 15, "state_machin": 15, "state": [15, 16], "execution_nam": 15, "72": 15, "jobawsstepfunctionsampl": 15, "smach1": 15, "exec1": 15, "var": 15, "job_definit": 15, "job_definition_revis": 15, "revis": 15, "job_queu": 15, "queue": 15, "aws_job_typ": 15, "array_s": 15, "size": 15, "item": 15, "depends_on": 15, "depend": [15, 16], "overrid": 15, "imag": 15, "memori": 15, "megabyt": 15, "reserv": 15, "v_cpu": 15, "vcpu": 15, "job_attempt": 15, "retri": 15, "execution_timeout": 15, "timeout": 15, "durat": 15, "73": 15, "jobawsbatchsampl": 15, "batchjob": 15, "jobdef": 15, "queue1": 15, "awsjobtyp": 15, "dependson": 15, "dependency_typ": 15, "dependencytyp": 15, "job_depends_on": 15, "job5": 15, "azur": 15, "function_app": 15, "app": 15, "74": 15, "jobazurefunctionsampl": 15, "azurefunct": 15, "funcapp": 15, "firstparamvalu": 15, "secondparamnam": 15, "secondparamvalu": 15, "logic_app_nam": 15, "request_bodi": 15, "75": 15, "jobazurelogicappssampl": 15, "logic_app": 15, "command_lin": 15, "wallclock": 15, "limit": 15, "max_tri": 15, "period": 15, "unlimit": 15, "76": 15, "jobazurebatchaccountsampl": 15, "azurejob": 15, "maxtri": 15, "count": 15, "servlet": 15, "rest": 15, "java": 15, "wjm": 15, "plug": 15, "77": 15, "jobwebservicessampl": 15, "cp_w": 15, "www": 15, "dneonlin": 15, "asmx": 15, "wsdl": 15, "soap_header_fil": 15, "myhead": 15, "calculatorsoap": 15, "request_typ": 15, "requesttyp": 15, "override_url_endpoint": 15, "myoverridehost": 15, "override_content_typ": 15, "http_connection_timeout": 15, "2345": 15, "preemptive_http_authent": 15, "include_title_in_output": 15, "exclude_job_output": 15, "output_paramet": 15, "element": 15, "addrespons": 15, "addresult": 15, "httpcode": 15, "testresultadd": 15, "input_paramet": 15, "inta": 15, "97": 15, "intb": 15, "345": 15, "encod": 15, "header": 15, "soap_request": 15, "soapenv": 15, "envelop": 15, "xmln": 15, "xmlsoap": 15, "soap": 15, "tem": 15, "tempuri": 15, "bodi": 15, "98978": 15, "75675": 15, "input_fil": 15, "78": 15, "jobslamanagementsampl": 15, "sla": 15, "service_prior": 15, "job_runs_deviations_toler": 15, "complete_in": 15, "completein": 15, "00": [15, 16], "complete_bi": 15, "completebi": 15, "average_run_time_toler": 15, "averageruntimetoler": 15, "average_run_tim": 15, "chain": 16, "helloworld": 16, "countfil": 16, "wc": 16, "testmonitor": 16, "probabl": 16, "satisfi": 16, "print_statu": 16, "printout": 16, "heirarchi": 16, "aggreg": 16, "few": 16, "enough": 16, "entir": 16, "end_tim": 16, "2022": 16, "estimated_end_tim": 16, "estimated_start_tim": 16, "folder_id": 16, "0001g": 16, "0001i": 16, "job_json": 16, "log_uri": 16, "number_of_run": 16, "order_d": 16, "output_uri": 16, "runobject": 16, "121": 16, "785": 16, "were": 16, "therefor": 16, "becaus": 16, "indenpend": 16, "detail": 16, "desir": 16, "forc": 16, "continu": 16, "daili": 16, "odat": 16, "20220614": 16, "5065": 16, "freed": 16, "5402": 16, "TO": 16, "5105": 16, "AT": 16, "20220614110115": 16, "ON": 16, "5101": 16, "chang": 16, "5120": 16, "20220614110116": 16, "oscompstat": 16, "127": 16, "runcnt": 16, "5100": 16, "cmd": 16, "log_00001k_00001": 16, "5169": 16, "OF": 16, "5134": 16, "analyz": 16, "post": 16, "0000001k_001": 16, "notic": 16, "tri": 16, "caus": 16, "possibl": 16, "forgot": 16, "typo": 16, "troubleshoot": 17}, "objects": {"": [[3, 0, 0, "-", "ctm_python_client"]], "ctm_python_client": [[4, 0, 0, "-", "core"], [5, 0, 0, "-", "ext"]], "ctm_python_client.core": [[4, 0, 0, "-", "comm"], [4, 0, 0, "-", "credential"], [4, 0, 0, "-", "monitoring"]], "ctm_python_client.core.comm": [[4, 1, 1, "", "AAPIClientResponse"], [4, 1, 1, "", "AbstractAAPIClient"], [4, 1, 1, "", "Environment"], [4, 1, 1, "", "EnvironmentMode"], [4, 1, 1, "", "OnPremAAPIClient"], [4, 1, 1, "", "SaasAAPIClient"]], "ctm_python_client.core.comm.AAPIClientResponse": [[4, 2, 1, "", "is_ok"]], "ctm_python_client.core.comm.AbstractAAPIClient": [[4, 2, 1, "", "authenticate"]], "ctm_python_client.core.comm.Environment": [[4, 2, 1, "", "create_onprem"], [4, 2, 1, "", "create_saas"], [4, 2, 1, "", "create_workbench"]], "ctm_python_client.core.comm.EnvironmentMode": [[4, 3, 1, "", "ONPREM"], [4, 3, 1, "", "SAAS"], [4, 3, 1, "", "WORKBENCH"]], "ctm_python_client.core.comm.OnPremAAPIClient": [[4, 2, 1, "", "authenticate"]], "ctm_python_client.core.comm.SaasAAPIClient": [[4, 2, 1, "", "authenticate"]], "ctm_python_client.core.credential": [[4, 1, 1, "", "AbstractCredentials"], [4, 1, 1, "", "InputPasswordCredentials"], [4, 1, 1, "", "SimpleCredentials"]], "ctm_python_client.core.credential.AbstractCredentials": [[4, 2, 1, "", "get_password"], [4, 2, 1, "", "get_username"]], "ctm_python_client.core.credential.InputPasswordCredentials": [[4, 2, 1, "", "get_password"], [4, 2, 1, "", "get_username"]], "ctm_python_client.core.credential.SimpleCredentials": [[4, 2, 1, "", "get_password"], [4, 2, 1, "", "get_username"]], "ctm_python_client.core.monitoring": [[4, 1, 1, "", "Monitor"], [4, 1, 1, "", "RunMonitor"]], "ctm_python_client.core.monitoring.Monitor": [[4, 2, 1, "", "confirm_job"], [4, 2, 1, "", "delete_job"], [4, 2, 1, "", "get_log"], [4, 2, 1, "", "get_output"], [4, 2, 1, "", "get_statuses"], [4, 2, 1, "", "hold_job"], [4, 2, 1, "", "kill_job"], [4, 2, 1, "", "release_job"], [4, 2, 1, "", "rerun_job"], [4, 2, 1, "", "set_to_ok"]], "ctm_python_client.core.monitoring.RunMonitor": [[4, 2, 1, "", "confirm_job"], [4, 2, 1, "", "delete_job"], [4, 2, 1, "", "get_jobid"], [4, 2, 1, "", "get_log"], [4, 2, 1, "", "get_output"], [4, 2, 1, "", "get_status"], [4, 2, 1, "", "get_statuses"], [4, 2, 1, "", "hold_job"], [4, 2, 1, "", "kill_job"], [4, 2, 1, "", "open_in_browser"], [4, 2, 1, "", "print_output"], [4, 2, 1, "", "print_statuses"], [4, 2, 1, "", "release_job"], [4, 2, 1, "", "rerun_job"], [4, 2, 1, "", "set_to_ok"]], "ctm_python_client.ext": [[5, 0, 0, "-", "credential"]], "ctm_python_client.ext.credential": [[5, 1, 1, "", "KeyringCredentials"]], "ctm_python_client.ext.credential.KeyringCredentials": [[5, 2, 1, "", "get_password"], [5, 2, 1, "", "get_username"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"]}, "titleterms": {"aapi": [0, 1], "packag": [0, 1, 3, 4, 5], "subpackag": [0, 3], "submodul": [0, 1, 4, 5], "action": [0, 14], "modul": [0, 1, 3, 4, 5], "addev": [0, 14], "ai": [0, 10], "basefold": 0, "base": 0, "businessfield": 0, "businessparamet": 0, "calendar": 0, "calendarfield": 0, "calendarkei": 0, "captureoutput": 0, "condit": 0, "config": 0, "connectionprofil": 0, "ctbruledata": 0, "date": 0, "definitionitemdetail": 0, "deleteev": [0, 14], "disallowedopt": 0, "do": 0, "donotifi": 0, "driver": 0, "endpoint": 0, "event": [0, 14], "extractrul": 0, "filetransf": 0, "filetransfergroup": 0, "flow_": 0, "folderclientdata": 0, "folderjobbas": 0, "hostfiletransf": 0, "hostmap": 0, "if_": 0, "ifbas": 0, "ifcollect": 0, "ifrerun": 0, "internalrul": 0, "iteminfo": 0, "job": [0, 1, 8, 13, 14, 15, 16], "jobsfilt": 0, "jobtag": 0, "mail": 0, "notifi": [0, 14], "output": [0, 13], "packageparam": 0, "period": 0, "possibleopt": 0, "propertycondit": 0, "rbcdetail": 0, "remedi": 0, "resourc": [0, 14], "resourcepool": [0, 14], "run": [0, 13, 16], "runningjob": 0, "set_": 0, "sitestandard": 0, "sitestandarddata": 0, "sitestandardoperatorvalueopt": 0, "sitestandardpolici": 0, "sitestandardpolicydata": 0, "sitestandardpossiblevalu": 0, "sitestandardrestrict": 0, "steprang": 0, "tag": 0, "time": 0, "variabl": [0, 14], "waitforev": [0, 14], "workloadflat": 0, "workloadpolici": 0, "wpperiod": 0, "year": 0, "content": [0, 1, 3, 4, 5, 7], "integration_factori": 1, "connection_profil": 1, "go": 2, "forward": 2, "us": 2, "link": 2, "extend": 2, "control": [2, 7, 10, 13, 16], "m": [2, 7, 10, 13, 16], "python": [2, 7, 13, 16], "client": [2, 7, 13, 16], "ctm_python_cli": [3, 4, 5], "core": 4, "comm": 4, "credenti": [4, 5, 9], "monitor": [4, 16], "workflow": [4, 13, 16], "ext": 5, "viz": 5, "get": [6, 13, 16], "start": [6, 13], "environ": [6, 9], "instal": 6, "via": 6, "pip": 6, "from": 6, "sourc": 6, "document": 7, "refer": 7, "work": 8, "applic": 8, "integr": 8, "build": [8, 13], "custom": 8, "type": [8, 15], "aijob": 8, "authent": 9, "auto": 10, "gener": 10, "plugin": 10, "workbench": 10, "connect": [11, 13], "profil": 11, "connectionprofilehadoop": 11, "connectionprofilefiletransf": 11, "connectionprofilefiletransferftp": 11, "connectionprofilefiletransfersftp": 11, "connectionprofilefiletransferloc": 11, "connectionprofilefiletransfers3amazon": 11, "connectionprofilefiletransfers3compat": 11, "connectionprofilefiletransferas2": 11, "connectionprofiledatabas": 11, "connectionprofiledatabasedb2": 11, "connectionprofiledatabasejdbc": 11, "connectionprofiledatabasemssql": 11, "connectionprofiledatabaseoraclesid": 11, "connectionprofiledatabaseoracleservicenam": 11, "connectionprofiledatabaseoracleconnectionstr": 11, "connectionprofiledatabasepostgresql": 11, "connectionprofiledatabasesybas": 11, "connectionprofilesap": 11, "connectionprofileinformatica": 11, "connectionprofileaw": 11, "connectionprofileazur": 11, "folder": [12, 14, 16], "exampl": 12, "subfold": 12, "argument": 12, "creat": 13, "ad": 13, "deploi": 13, "check": [13, 16], "flow": [13, 16], "without": 13, "two": 13, "chain": 13, "dummi": 13, "run_as_dummi": 13, "properti": 14, "when": 14, "If": 14, "ifcompletionstatu": 14, "ifnumberofrerun": 14, "ifnumberoffailur": 14, "ifjobnotsubmit": 14, "ifjoboutputnotfound": 14, "ifnumberofexecut": 14, "ifoutput": 14, "ifvariablevalu": 14, "actionmail": 14, "actionrerun": 14, "actionset": 14, "actionsettook": 14, "actionsettonotok": 14, "actionstopcyclicrun": 14, "actionrun": 14, "actionnotifi": 14, "actionremedi": 14, "actionoutput": 14, "notifyok": 14, "notifynotok": 14, "notifydoesnotstart": 14, "notifyexecutiontim": 14, "notifydoesnotend": 14, "notifyrerun": 14, "notifylatecyclicsubmit": 14, "resourcelock": 14, "rerun": 14, "jobcommand": 15, "jobscript": 15, "jobembeddedscript": 15, "jobfiletransf": 15, "jobfilewatchercr": 15, "jobfilewatcherdelet": 15, "jobdatabaseembeddedqueri": 15, "jobdatabasesqlscript": 15, "jobdatabasestoredprocedur": 15, "jobdatabasemssqlagentjob": 15, "jobdatabasemssql_ssi": 15, "jobhadoopsparkpython": 15, "jobhadoopsparkscalajava": 15, "jobhadooppig": 15, "jobhadoopsqoop": 15, "jobhadooph": 15, "jobhadoopdistcp": 15, "jobhadoophdfscommand": 15, "jobhadoophdfsfilewatch": 15, "jobhadoopoozi": 15, "jobhadoopmapreduc": 15, "jobhadoopmapredstream": 15, "jobhadooptajoinputfil": 15, "jobhadooptajoqueri": 15, "jobpeoplesoft": 15, "jobinformatica": 15, "jobawslambda": 15, "jobawsstepfunct": 15, "jobawsbatch": 15, "jobazurefunct": 15, "jobazurelogicapp": 15, "jobazurebatchaccount": 15, "jobwebservic": 15, "jobslamanag": 15, "statu": 16, "specif": 16, "error": 16, "troubleshoot": 16, "tutori": 17, "notebook": 17}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"aapi package": [[0, "aapi-package"]], "Subpackages": [[0, "subpackages"], [3, "subpackages"]], "Submodules": [[0, "submodules"], [1, "submodules"], [4, "submodules"], [5, "submodules"]], "aapi.action module": [[0, "aapi-action-module"]], "aapi.addevents module": [[0, "aapi-addevents-module"]], "aapi.ai module": [[0, "aapi-ai-module"]], "aapi.basefolder module": [[0, "aapi-basefolder-module"]], "aapi.bases module": [[0, "aapi-bases-module"]], "aapi.businessfield module": [[0, "aapi-businessfield-module"]], "aapi.businessparameter module": [[0, "aapi-businessparameter-module"]], "aapi.calendar module": [[0, "aapi-calendar-module"]], "aapi.calendarfields module": [[0, "aapi-calendarfields-module"]], "aapi.calendarkey module": [[0, "aapi-calendarkey-module"]], "aapi.captureoutput module": [[0, "aapi-captureoutput-module"]], "aapi.condition module": [[0, "aapi-condition-module"]], "aapi.config module": [[0, "aapi-config-module"]], "aapi.connectionprofile module": [[0, "aapi-connectionprofile-module"]], "aapi.ctbruledata module": [[0, "aapi-ctbruledata-module"]], "aapi.date module": [[0, "aapi-date-module"]], "aapi.definitionitemdetails module": [[0, "aapi-definitionitemdetails-module"]], "aapi.deleteevents module": [[0, "aapi-deleteevents-module"]], "aapi.disallowedoptions module": [[0, "aapi-disallowedoptions-module"]], "aapi.do module": [[0, "aapi-do-module"]], "aapi.donotify module": [[0, "aapi-donotify-module"]], "aapi.driver module": [[0, "aapi-driver-module"]], "aapi.endpoint module": [[0, "aapi-endpoint-module"]], "aapi.event module": [[0, "aapi-event-module"]], "aapi.extractrule module": [[0, "aapi-extractrule-module"]], "aapi.filetransfer module": [[0, "aapi-filetransfer-module"]], "aapi.filetransfergroup module": [[0, "aapi-filetransfergroup-module"]], "aapi.flow_ module": [[0, "aapi-flow-module"]], "aapi.folderclientdata module": [[0, "aapi-folderclientdata-module"]], "aapi.folderjobbase module": [[0, "aapi-folderjobbase-module"]], "aapi.hostfiletransfer module": [[0, "aapi-hostfiletransfer-module"]], "aapi.hostmapping module": [[0, "aapi-hostmapping-module"]], "aapi.if_ module": [[0, "aapi-if-module"]], "aapi.ifbase module": [[0, "aapi-ifbase-module"]], "aapi.ifcollection module": [[0, "aapi-ifcollection-module"]], "aapi.ifrerun module": [[0, "aapi-ifrerun-module"]], "aapi.internalrule module": [[0, "aapi-internalrule-module"]], "aapi.iteminfo module": [[0, "aapi-iteminfo-module"]], "aapi.job module": [[0, "aapi-job-module"]], "aapi.jobsfilter module": [[0, "aapi-jobsfilter-module"]], "aapi.jobtag module": [[0, "aapi-jobtag-module"]], "aapi.mail module": [[0, "aapi-mail-module"]], "aapi.notify module": [[0, "aapi-notify-module"]], "aapi.on module": [[0, "aapi-on-module"]], "aapi.output module": [[0, "aapi-output-module"]], "aapi.package module": [[0, "aapi-package-module"]], "aapi.packageparams module": [[0, "aapi-packageparams-module"]], "aapi.period module": [[0, "aapi-period-module"]], "aapi.possibleoptions module": [[0, "aapi-possibleoptions-module"]], "aapi.propertycondition module": [[0, "aapi-propertycondition-module"]], "aapi.rbcdetails module": [[0, "aapi-rbcdetails-module"]], "aapi.remedy module": [[0, "aapi-remedy-module"]], "aapi.resource module": [[0, "aapi-resource-module"]], "aapi.resourcepools module": [[0, "aapi-resourcepools-module"]], "aapi.run module": [[0, "aapi-run-module"]], "aapi.runningjobs module": [[0, "aapi-runningjobs-module"]], "aapi.set_ module": [[0, "aapi-set-module"]], "aapi.sitestandard module": [[0, "aapi-sitestandard-module"]], "aapi.sitestandarddata module": [[0, "aapi-sitestandarddata-module"]], "aapi.sitestandardoperatorvalueoptions module": [[0, "aapi-sitestandardoperatorvalueoptions-module"]], "aapi.sitestandardpolicy module": [[0, "aapi-sitestandardpolicy-module"]], "aapi.sitestandardpolicydata module": [[0, "aapi-sitestandardpolicydata-module"]], "aapi.sitestandardpossiblevalue module": [[0, "aapi-sitestandardpossiblevalue-module"]], "aapi.sitestandardrestriction module": [[0, "aapi-sitestandardrestriction-module"]], "aapi.steprange module": [[0, "aapi-steprange-module"]], "aapi.tag module": [[0, "aapi-tag-module"]], "aapi.time module": [[0, "aapi-time-module"]], "aapi.variable module": [[0, "aapi-variable-module"]], "aapi.waitforevents module": [[0, "aapi-waitforevents-module"]], "aapi.workloadflat module": [[0, "aapi-workloadflat-module"]], "aapi.workloadpolicy module": [[0, "aapi-workloadpolicy-module"]], "aapi.wpperiod module": [[0, "aapi-wpperiod-module"]], "aapi.year module": [[0, "aapi-year-module"]], "Module contents": [[0, "module-contents"], [1, "module-contents"], [3, "module-ctm_python_client"], [4, "module-ctm_python_client.core"], [5, "module-ctm_python_client.ext"]], "aapi.integration_factory package": [[1, "aapi-integration-factory-package"]], "aapi.integration_factory.connection_profiles module": [[1, "aapi-integration-factory-connection-profiles-module"]], "aapi.integration_factory.jobs module": [[1, "aapi-integration-factory-jobs-module"]], "Going Forward": [[2, "going-forward"]], "Useful Links": [[2, "useful-links"]], "Extending Control-M Python Client": [[2, "extending-control-m-python-client"]], "ctm_python_client package": [[3, "ctm-python-client-package"]], "ctm_python_client.core package": [[4, "ctm-python-client-core-package"]], "ctm_python_client.core.comm module": [[4, "module-ctm_python_client.core.comm"]], "ctm_python_client.core.credential module": [[4, "module-ctm_python_client.core.credential"]], "ctm_python_client.core.monitoring module": [[4, "module-ctm_python_client.core.monitoring"]], "ctm_python_client.core.workflow module": [[4, "ctm-python-client-core-workflow-module"]], "ctm_python_client.ext package": [[5, "ctm-python-client-ext-package"]], "ctm_python_client.ext.credential module": [[5, "module-ctm_python_client.ext.credential"]], "ctm_python_client.ext.viz module": [[5, "ctm-python-client-ext-viz-module"]], "Getting Started": [[6, "getting-started"]], "Environment": [[6, "environment"]], "Installation": [[6, "installation"]], "Installing via pip": [[6, "installing-via-pip"]], "Installing from source": [[6, "installing-from-source"]], "Control-M Python Client Documentation": [[7, "control-m-python-client-documentation"]], "Contents:": [[7, null]], "References:": [[7, null]], "Working with Application Integrator": [[8, "Working-with-Application-Integrator"]], "Building Custom Application Integrator Job Types with AIJob": [[8, "Building-Custom-Application-Integrator-Job-Types-with-AIJob"]], "Authentication": [[9, "Authentication"]], "Environments": [[9, "Environments"]], "Credentials": [[9, "Credentials"]], "Auto generation of AI Plugins with Control-M Workbench": [[10, "Auto-generation-of-AI-Plugins-with-Control-M-Workbench"]], "Connection Profiles": [[11, "Connection-Profiles"]], "ConnectionProfileHadoop": [[11, "ConnectionProfileHadoop"]], "ConnectionProfileFileTransfer": [[11, "ConnectionProfileFileTransfer"]], "ConnectionProfileFileTransferFTP": [[11, "ConnectionProfileFileTransferFTP"]], "ConnectionProfileFileTransferSFTP": [[11, "ConnectionProfileFileTransferSFTP"]], "ConnectionProfileFileTransferFTPS": [[11, "ConnectionProfileFileTransferFTPS"]], "ConnectionProfileFileTransferLocal": [[11, "ConnectionProfileFileTransferLocal"]], "ConnectionProfileFileTransferS3Amazon": [[11, "ConnectionProfileFileTransferS3Amazon"]], "ConnectionProfileFileTransferS3Compatible": [[11, "ConnectionProfileFileTransferS3Compatible"]], "ConnectionProfileFileTransferAS2": [[11, "ConnectionProfileFileTransferAS2"]], "ConnectionProfileDatabase": [[11, "ConnectionProfileDatabase"]], "ConnectionProfileDatabaseDB2": [[11, "ConnectionProfileDatabaseDB2"]], "ConnectionProfileDatabaseJDBC": [[11, "ConnectionProfileDatabaseJDBC"]], "ConnectionProfileDatabaseMSSql": [[11, "ConnectionProfileDatabaseMSSql"]], "ConnectionProfileDatabaseOracleSID": [[11, "ConnectionProfileDatabaseOracleSID"]], "ConnectionProfileDatabaseOracleServiceName": [[11, "ConnectionProfileDatabaseOracleServiceName"]], "ConnectionProfileDatabaseOracleConnectionString": [[11, "ConnectionProfileDatabaseOracleConnectionString"]], "ConnectionProfileDatabasePostgreSql": [[11, "ConnectionProfileDatabasePostgreSql"]], "ConnectionProfileDatabaseSybase": [[11, "ConnectionProfileDatabaseSybase"]], "ConnectionProfileSAP": [[11, "ConnectionProfileSAP"]], "ConnectionProfileInformatica": [[11, "ConnectionProfileInformatica"]], "ConnectionProfileAWS": [[11, "ConnectionProfileAWS"]], "ConnectionProfileAzure": [[11, "ConnectionProfileAzure"]], "Folders": [[12, "Folders"]], "Folder": [[12, "Folder"]], "Examples": [[12, "Examples"], [12, "id1"]], "SubFolder": [[12, "SubFolder"]], "Arguments": [[12, "Arguments"]], "Getting Started with Control-M Python Client": [[13, "Getting-Started-with-Control-M-Python-Client"]], "Creating a Workflow": [[13, "Creating-a-Workflow"]], "Adding Jobs in the Workflow": [[13, "Adding-Jobs-in-the-Workflow"]], "Building and Deploying": [[13, "Building-and-Deploying"]], "Running and checking the output": [[13, "Running-and-checking-the-output"]], "Flows": [[13, "Flows"]], "Adding jobs without connection": [[13, "Adding-jobs-without-connection"]], "Connecting two Jobs": [[13, "Connecting-two-Jobs"]], "Chaining Jobs": [[13, "Chaining-Jobs"]], "Dummy Jobs and run_as_dummy": [[13, "Dummy-Jobs-and-run_as_dummy"]], "Job and Folder Properties": [[14, "Job-and-Folder-Properties"]], "When": [[14, "When"]], "If": [[14, "If"]], "IfCompletionStatus": [[14, "IfCompletionStatus"]], "IfNumberOfReruns": [[14, "IfNumberOfReruns"]], "IfNumberOfFailures": [[14, "IfNumberOfFailures"]], "IfJobNotSubmitted": [[14, "IfJobNotSubmitted"]], "IfJobOutputNotFound": [[14, "IfJobOutputNotFound"]], "IfNumberOfExecutions": [[14, "IfNumberOfExecutions"]], "IfOutput": [[14, "IfOutput"]], "IfVariableValue": [[14, "IfVariableValue"]], "If Actions": [[14, "If-Actions"]], "ActionMail": [[14, "ActionMail"]], "ActionRerun": [[14, "ActionRerun"]], "ActionSet": [[14, "ActionSet"]], "ActionSetToOk": [[14, "ActionSetToOk"]], "ActionSetToNotOK": [[14, "ActionSetToNotOK"]], "ActionStopCyclicRun": [[14, "ActionStopCyclicRun"]], "ActionRun": [[14, "ActionRun"]], "ActionNotify": [[14, "ActionNotify"]], "ActionRemedy": [[14, "ActionRemedy"]], "ActionOutput": [[14, "ActionOutput"]], "Notify": [[14, "Notify"]], "NotifyOk": [[14, "NotifyOk"]], "NotifyNotOk": [[14, "NotifyNotOk"]], "NotifyDoesNotStart": [[14, "NotifyDoesNotStart"]], "NotifyExecutionTime": [[14, "NotifyExecutionTime"]], "NotifyDoesNotEnd": [[14, "NotifyDoesNotEnd"]], "NotifyReRun": [[14, "NotifyReRun"]], "NotifyLateCyclicSubmit": [[14, "NotifyLateCyclicSubmit"]], "Resources": [[14, "Resources"]], "ResourcePool": [[14, "ResourcePool"]], "ResourceLock": [[14, "ResourceLock"]], "Rerun": [[14, "Rerun"]], "Variables": [[14, "Variables"]], "Events": [[14, "Events"]], "WaitForEvents": [[14, "WaitForEvents"]], "AddEvents": [[14, "AddEvents"]], "DeleteEvents": [[14, "DeleteEvents"]], "Job types": [[15, "Job-types"]], "JobCommand": [[15, "JobCommand"]], "JobScript": [[15, "JobScript"]], "JobEmbeddedScript": [[15, "JobEmbeddedScript"]], "JobFileTransfer": [[15, "JobFileTransfer"]], "JobFileWatcherCreate": [[15, "JobFileWatcherCreate"]], "JobFileWatcherDelete": [[15, "JobFileWatcherDelete"]], "JobDatabaseEmbeddedQuery": [[15, "JobDatabaseEmbeddedQuery"]], "JobDatabaseSQLScript": [[15, "JobDatabaseSQLScript"]], "JobDatabaseStoredProcedure": [[15, "JobDatabaseStoredProcedure"]], "JobDatabaseMSSQLAgentJob": [[15, "JobDatabaseMSSQLAgentJob"]], "JobDatabaseMSSQL_SSIS": [[15, "JobDatabaseMSSQL_SSIS"]], "JobHadoopSparkPython": [[15, "JobHadoopSparkPython"]], "JobHadoopSparkScalaJava": [[15, "JobHadoopSparkScalaJava"]], "JobHadoopPig": [[15, "JobHadoopPig"]], "JobHadoopSqoop": [[15, "JobHadoopSqoop"]], "JobHadoopHive": [[15, "JobHadoopHive"]], "JobHadoopDistCp": [[15, "JobHadoopDistCp"]], "JobHadoopHDFSCommands": [[15, "JobHadoopHDFSCommands"]], "JobHadoopHDFSFileWatcher": [[15, "JobHadoopHDFSFileWatcher"]], "JobHadoopOozie": [[15, "JobHadoopOozie"]], "JobHadoopMapReduce": [[15, "JobHadoopMapReduce"]], "JobHadoopMapredStreaming": [[15, "JobHadoopMapredStreaming"]], "JobHadoopTajoInputFile": [[15, "JobHadoopTajoInputFile"]], "JobHadoopTajoQuery": [[15, "JobHadoopTajoQuery"]], "JobPeopleSoft": [[15, "JobPeopleSoft"]], "JobInformatica": [[15, "JobInformatica"]], "JobAWSLambda": [[15, "JobAWSLambda"]], "JobAWSStepFunction": [[15, "JobAWSStepFunction"]], "JobAWSBatch": [[15, "JobAWSBatch"]], "JobAzureFunction": [[15, "JobAzureFunction"]], "JobAzureLogicApps": [[15, "JobAzureLogicApps"]], "JobAzureBatchAccount": [[15, "JobAzureBatchAccount"]], "JobWebServices": [[15, "JobWebServices"]], "JobSLAManagement": [[15, "JobSLAManagement"]], "Monitoring Flows with Control-M Python Client": [[16, "Monitoring-Flows-with-Control-M-Python-Client"]], "Running a Workflow": [[16, "Running-a-Workflow"]], "Checking the Status": [[16, "Checking-the-Status"]], "Getting the Status of a Specific Job or Folder": [[16, "Getting-the-Status-of-a-Specific-Job-or-Folder"]], "Errors and Troubleshooting": [[16, "Errors-and-Troubleshooting"]], "Tutorials": [[17, "tutorials"]], "Notebooks:": [[17, null]]}, "indexentries": {"ctm_python_client": [[3, "module-ctm_python_client"]], "module": [[3, "module-ctm_python_client"], [4, "module-ctm_python_client.core"], [4, "module-ctm_python_client.core.comm"], [4, "module-ctm_python_client.core.credential"], [4, "module-ctm_python_client.core.monitoring"], [5, "module-ctm_python_client.ext"], [5, "module-ctm_python_client.ext.credential"]], "aapiclientresponse (class in ctm_python_client.core.comm)": [[4, "ctm_python_client.core.comm.AAPIClientResponse"]], "abstractaapiclient (class in ctm_python_client.core.comm)": [[4, "ctm_python_client.core.comm.AbstractAAPIClient"]], "abstractcredentials (class in ctm_python_client.core.credential)": [[4, "ctm_python_client.core.credential.AbstractCredentials"]], "environment (class in ctm_python_client.core.comm)": [[4, "ctm_python_client.core.comm.Environment"]], "environmentmode (class in ctm_python_client.core.comm)": [[4, "ctm_python_client.core.comm.EnvironmentMode"]], "inputpasswordcredentials (class in ctm_python_client.core.credential)": [[4, "ctm_python_client.core.credential.InputPasswordCredentials"]], "monitor (class in ctm_python_client.core.monitoring)": [[4, "ctm_python_client.core.monitoring.Monitor"]], "onprem (ctm_python_client.core.comm.environmentmode attribute)": [[4, "ctm_python_client.core.comm.EnvironmentMode.ONPREM"]], "onpremaapiclient (class in ctm_python_client.core.comm)": [[4, "ctm_python_client.core.comm.OnPremAAPIClient"]], "runmonitor (class in ctm_python_client.core.monitoring)": [[4, "ctm_python_client.core.monitoring.RunMonitor"]], "saas (ctm_python_client.core.comm.environmentmode attribute)": [[4, "ctm_python_client.core.comm.EnvironmentMode.SAAS"]], "saasaapiclient (class in ctm_python_client.core.comm)": [[4, "ctm_python_client.core.comm.SaasAAPIClient"]], "simplecredentials (class in ctm_python_client.core.credential)": [[4, "ctm_python_client.core.credential.SimpleCredentials"]], "workbench (ctm_python_client.core.comm.environmentmode attribute)": [[4, "ctm_python_client.core.comm.EnvironmentMode.WORKBENCH"]], "authenticate() (ctm_python_client.core.comm.abstractaapiclient class method)": [[4, "ctm_python_client.core.comm.AbstractAAPIClient.authenticate"]], "authenticate() (ctm_python_client.core.comm.onpremaapiclient method)": [[4, "ctm_python_client.core.comm.OnPremAAPIClient.authenticate"]], "authenticate() (ctm_python_client.core.comm.saasaapiclient method)": [[4, "ctm_python_client.core.comm.SaasAAPIClient.authenticate"]], "confirm_job() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.confirm_job"]], "confirm_job() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.confirm_job"]], "create_onprem() (ctm_python_client.core.comm.environment static method)": [[4, "ctm_python_client.core.comm.Environment.create_onprem"]], "create_saas() (ctm_python_client.core.comm.environment static method)": [[4, "ctm_python_client.core.comm.Environment.create_saas"]], "create_workbench() (ctm_python_client.core.comm.environment static method)": [[4, "ctm_python_client.core.comm.Environment.create_workbench"]], "ctm_python_client.core": [[4, "module-ctm_python_client.core"]], "ctm_python_client.core.comm": [[4, "module-ctm_python_client.core.comm"]], "ctm_python_client.core.credential": [[4, "module-ctm_python_client.core.credential"]], "ctm_python_client.core.monitoring": [[4, "module-ctm_python_client.core.monitoring"]], "delete_job() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.delete_job"]], "delete_job() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.delete_job"]], "get_jobid() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.get_jobid"]], "get_log() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.get_log"]], "get_log() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.get_log"]], "get_output() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.get_output"]], "get_output() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.get_output"]], "get_password() (ctm_python_client.core.credential.abstractcredentials class method)": [[4, "ctm_python_client.core.credential.AbstractCredentials.get_password"]], "get_password() (ctm_python_client.core.credential.inputpasswordcredentials method)": [[4, "ctm_python_client.core.credential.InputPasswordCredentials.get_password"]], "get_password() (ctm_python_client.core.credential.simplecredentials method)": [[4, "ctm_python_client.core.credential.SimpleCredentials.get_password"]], "get_status() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.get_status"]], "get_statuses() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.get_statuses"]], "get_statuses() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.get_statuses"]], "get_username() (ctm_python_client.core.credential.abstractcredentials class method)": [[4, "ctm_python_client.core.credential.AbstractCredentials.get_username"]], "get_username() (ctm_python_client.core.credential.inputpasswordcredentials method)": [[4, "ctm_python_client.core.credential.InputPasswordCredentials.get_username"]], "get_username() (ctm_python_client.core.credential.simplecredentials method)": [[4, "ctm_python_client.core.credential.SimpleCredentials.get_username"]], "hold_job() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.hold_job"]], "hold_job() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.hold_job"]], "is_ok() (ctm_python_client.core.comm.aapiclientresponse method)": [[4, "ctm_python_client.core.comm.AAPIClientResponse.is_ok"]], "kill_job() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.kill_job"]], "kill_job() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.kill_job"]], "open_in_browser() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.open_in_browser"]], "print_output() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.print_output"]], "print_statuses() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.print_statuses"]], "release_job() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.release_job"]], "release_job() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.release_job"]], "rerun_job() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.rerun_job"]], "rerun_job() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.rerun_job"]], "set_to_ok() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.set_to_ok"]], "set_to_ok() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.set_to_ok"]], "keyringcredentials (class in ctm_python_client.ext.credential)": [[5, "ctm_python_client.ext.credential.KeyringCredentials"]], "ctm_python_client.ext": [[5, "module-ctm_python_client.ext"]], "ctm_python_client.ext.credential": [[5, "module-ctm_python_client.ext.credential"]], "get_password() (ctm_python_client.ext.credential.keyringcredentials method)": [[5, "ctm_python_client.ext.credential.KeyringCredentials.get_password"]], "get_username() (ctm_python_client.ext.credential.keyringcredentials method)": [[5, "ctm_python_client.ext.credential.KeyringCredentials.get_username"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["aapi", "aapi.integration_factory", "beyond", "ctm_python_client", "ctm_python_client.core", "ctm_python_client.ext", "gettingstarted", "index", "notebooks/ai", "notebooks/authentication", "notebooks/autogen", "notebooks/connectionprofiles", "notebooks/folders", "notebooks/hello", "notebooks/jobproperties", "notebooks/jobtypes", "notebooks/monitoring", "tutorials"], "filenames": ["aapi.rst", "aapi.integration_factory.rst", "beyond.md", "ctm_python_client.rst", "ctm_python_client.core.rst", "ctm_python_client.ext.rst", "gettingstarted.md", "index.rst", "notebooks\\ai.ipynb", "notebooks\\authentication.ipynb", "notebooks\\autogen.ipynb", "notebooks\\connectionprofiles.ipynb", "notebooks\\folders.ipynb", "notebooks\\hello.ipynb", "notebooks\\jobproperties.ipynb", "notebooks\\jobtypes.ipynb", "notebooks\\monitoring.ipynb", "tutorials.rst"], "titles": ["aapi package", "aapi.integration_factory package", "Going Forward", "ctm_python_client package", "ctm_python_client.core package", "ctm_python_client.ext package", "Getting Started", "Control-M Python Client Documentation", "Working with Application Integrator", "Authentication", "Auto generation of AI Plugins with Control-M Workbench", "Connection Profiles", "Folders", "Getting Started with Control-M Python Client", "Job and Folder Properties", "Job types", "Monitoring Flows with Control-M Python Client", "Tutorials"], "terms": {"integration_factori": 0, "connection_profil": [0, 8, 10, 15], "after": [2, 8, 10, 13, 14, 15, 16], "you": [2, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "complet": [2, 10, 13, 14, 15, 16], "tutori": [2, 6, 7, 9, 16], "": [2, 6, 8, 13, 15, 16], "time": [2, 10, 12, 13, 14, 15, 16], "write": 2, "your": [2, 4, 6, 7, 8, 9, 10, 13, 15, 16], "own": [2, 8, 9, 13], "workflow": [2, 3, 6, 7, 8, 9, 10, 15, 17], "workbench": [2, 3, 4, 6, 7, 9, 13, 14, 15, 16, 17], "which": [2, 4, 8, 9, 11, 13, 14, 15, 16], "i": [2, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "free": [2, 6], "backend": [2, 9], "develop": [2, 6, 7, 9], "environ": [2, 3, 4, 7, 8, 10, 13, 14, 15, 16, 17], "learn": [2, 13, 16], "how": [2, 6, 13, 14, 16], "creat": [2, 4, 6, 8, 9, 10, 11, 14, 15, 16, 17], "more": [2, 4, 9, 12, 13, 14, 16], "complex": 2, "from": [2, 4, 8, 9, 10, 11, 12, 13, 14, 15, 16], "resourc": [2, 7, 12], "below": [2, 8, 14], "The": [2, 4, 6, 9, 11, 12, 13, 14, 15, 16], "provis": 2, "servic": [2, 5, 9, 15], "autom": [2, 8, 9, 11, 13, 15, 16], "api": [2, 8, 9, 11, 12, 13, 15, 16], "enabl": [2, 7, 8, 12, 13, 14, 15, 16], "easili": [2, 8], "instal": [2, 7, 9, 13, 14, 15, 16], "agent": [2, 8, 11, 13, 14, 16], "document": [2, 9, 11, 14, 15], "helix": [2, 4, 9], "an": [2, 4, 6, 8, 9, 13, 14, 15, 16], "applic": [2, 4, 7, 10, 11, 12, 14, 16, 17], "integr": [2, 7, 10, 15, 17], "deriv": [2, 8], "its": [2, 4, 9, 12, 13, 14, 15, 16], "abstract": [2, 4, 9], "class": [2, 4, 5, 8, 9, 10, 15], "exist": [2, 13, 15, 16], "implement": [2, 9], "sinc": [2, 9, 13, 14], "open": 2, "sourc": [2, 15], "code": [2, 8, 9, 10, 12, 13, 14, 16], "feel": 2, "extens": 2, "can": [2, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16], "commun": 2, "pull": 2, "request": 2, "we": [2, 6, 8, 9, 10, 13, 14, 16], "ar": [2, 4, 8, 9, 11, 12, 13, 14, 15], "happi": 2, "review": 2, "core": [3, 7, 8, 9, 10, 13, 16], "submodul": 3, "comm": [3, 8, 9, 13, 16], "aapiclientrespons": [3, 4], "is_ok": [3, 4, 13], "abstractaapicli": [3, 4], "authent": [3, 4, 7, 17], "create_onprem": [3, 4, 9], "create_saa": [3, 4, 9], "create_workbench": [3, 4, 9, 13, 16], "environmentmod": [3, 4, 9], "onprem": [3, 4, 9], "saa": [3, 4, 9], "onpremaapicli": [3, 4], "saasaapicli": [3, 4], "credenti": [3, 11, 17], "abstractcredenti": [3, 4, 5, 9], "get_password": [3, 4, 5, 9], "get_usernam": [3, 4, 5, 9], "inputpasswordcredenti": [3, 4, 9], "simplecredenti": [3, 4, 9], "monitor": [3, 7, 17], "confirm_job": [3, 4], "delete_job": [3, 4], "get_log": [3, 4, 16], "get_output": [3, 4, 10, 13, 16], "get_status": [3, 4], "hold_job": [3, 4], "kill_job": [3, 4], "release_job": [3, 4], "rerun_job": [3, 4], "set_to_ok": [3, 4], "runmonitor": [3, 4, 13, 16], "get_jobid": [3, 4], "get_statu": [3, 4, 16], "open_in_brows": [3, 4], "print_output": [3, 4, 13, 16], "print_status": [3, 4, 16], "ext": [3, 7, 9, 10, 13, 16], "keyringcredenti": [3, 5, 9], "viz": [3, 13, 16], "success": [4, 15], "bool": 4, "result": 4, "ani": [4, 8, 9, 13, 14, 15], "none": [4, 13, 14, 15, 16], "error": [4, 14, 17], "list": [4, 12, 13, 14, 15], "base": [4, 5, 8, 9, 14], "object": [4, 9, 10, 13, 14, 15, 16], "abc": [4, 15], "classmethod": 4, "endpoint": [4, 9, 15], "str": [4, 5], "usernam": [4, 5, 9, 11], "password": [4, 9, 10, 11], "api_kei": [4, 9], "mode": [4, 9, 15], "static": [4, 9], "host": [4, 9, 11, 13, 15, 16], "port": [4, 9, 11, 15], "8443": [4, 9, 16], "localhost": [4, 9, 11, 16], "valu": [4, 9, 10, 12, 14, 15], "enum": 4, "enumer": 4, "control": [4, 6, 8, 9, 11, 12, 14, 15, 17], "m": [4, 6, 8, 9, 11, 12, 14, 15, 17], "us": [4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "custom": [4, 9, 15, 17], "advanc": [4, 16], "case": [4, 8, 9], "aapicli": 4, "job_id": [4, 15, 16], "confirm": [4, 12, 14], "job": [4, 6, 7, 10, 11, 12, 17], "thi": [4, 8, 9, 10, 11, 12, 13, 14, 15, 16], "onli": [4, 9, 11, 13, 15, 16], "appli": [4, 14, 15], "where": [4, 9, 13, 14, 15], "defin": [4, 8, 9, 10, 11, 12, 13, 14, 15], "true": [4, 10, 11, 12, 13, 14, 15, 16], "try": [4, 13, 16], "t": [4, 6, 13, 14, 15], "wa": [4, 13, 14, 16], "alreadi": 4, "delet": [4, 14, 15, 16], "get": [4, 7, 9, 15, 17], "log": [4, 15, 16], "describ": 4, "all": [4, 8, 10, 11, 12, 13, 14, 15, 16], "action": [4, 7, 12, 15, 16], "regard": 4, "execut": [4, 9, 10, 13, 14, 15, 16], "run_numb": 4, "int": 4, "0": [4, 10, 11, 14, 15], "run_id": 4, "filter": 4, "dict": 4, "hold": 4, "kill": 4, "releas": 4, "held": [4, 16], "rerun": [4, 7, 12, 16], "set": [4, 9, 12, 14, 15, 16], "ok": [4, 8, 14, 16], "monitor_page_uri": 4, "allow": [4, 8, 9, 10, 14], "basic": 4, "function": [4, 8, 15, 16], "similar": [4, 8], "wai": [4, 6, 9, 13, 16], "found": [4, 14, 16], "web": [4, 8, 15, 16], "interfac": [4, 8], "job_nam": [4, 10, 11, 15], "id": [4, 6, 11, 15], "name": [4, 8, 10, 11, 13, 14, 15, 16], "without": [4, 8, 9, 14, 16], "path": [4, 13, 15, 16], "If": [4, 6, 7, 9, 10, 11, 12, 13, 15, 16], "multipl": [4, 9, 11, 13, 14], "same": [4, 8, 9, 13, 14, 15, 16], "determin": [4, 15], "accord": [4, 13, 16], "given": 4, "undefin": 4, "behavior": 4, "exampl": [4, 8, 9, 10, 13, 14, 15, 16], "myjob": [4, 11, 13], "myfold": [4, 12, 13], "subfolder1": 4, "subfolder2": 4, "output": [4, 14, 15, 16, 17], "return": [4, 13, 14, 15, 16], "statu": [4, 13, 14, 17], "run": [4, 6, 7, 9, 10, 11, 12, 14, 15, 17], "print": [4, 8, 10, 11, 13, 14, 16], "kwarg": 4, "pretti": 4, "full": 4, "pass": [4, 9, 11, 13, 14, 15, 16], "printer": 4, "specifi": [4, 9, 12, 13, 14, 15], "pritner": 4, "accept": [4, 8, 15], "one": [4, 8, 11, 12, 13, 14], "argument": [4, 7, 8, 11, 13, 14, 15], "status": [4, 16], "best": [6, 9], "know": [6, 13], "python": [6, 8, 9, 10, 15, 17], "client": [6, 8, 9, 10, 17], "follow": [6, 9, 10, 11, 13, 14], "guid": 6, "through": [6, 8], "first": [6, 13], "step": [6, 10, 15], "build": [6, 17], "see": [6, 8, 12, 14, 16], "To": [6, 8, 11, 12, 13, 14, 15, 16], "deploi": [6, 8, 11, 14, 17], "need": [6, 8, 9, 13, 15, 16], "access": [6, 11, 13, 14, 15], "activ": [6, 15], "don": [6, 13], "have": [6, 9, 10, 13, 15], "want": [6, 9, 10, 13, 15], "test": [6, 13, 15, 16], "some": [6, 9, 10, 13, 16], "cost": 6, "platform": [6, 8], "suggest": 6, "download": [6, 13, 16], "requir": [6, 9, 13, 14, 15], "version": [6, 10, 14, 15], "3": [6, 12, 14, 15], "7": [6, 14, 15, 16], "higher": 6, "recommend": [6, 14], "virtual": 6, "here": [6, 13, 14], "unix": [6, 11], "venv": 6, "bin": [6, 11, 15], "window": 6, "script": [6, 12, 15], "bat": 6, "note": [6, 8, 9, 11, 13, 14, 15, 16], "git": 6, "ctm": [6, 12, 15, 16], "clone": 6, "http": [6, 9, 11, 13, 15, 16], "github": [6, 7], "com": [6, 11, 14, 15], "controlm": [6, 12, 14], "librari": [7, 9], "design": 7, "schedul": [7, 12, 13, 14], "programmat": 7, "built": [7, 13], "data": [7, 13, 15], "scientist": 7, "who": [7, 14], "prefer": [7, 16], "approach": 7, "orchestr": 7, "repo": 7, "start": [7, 10, 14, 15, 16, 17], "flow": [7, 10, 17], "work": [7, 9, 13, 14, 17], "auto": [7, 15, 17], "gener": [7, 14, 17], "ai": [7, 8, 17], "plugin": [7, 13, 17], "folder": [7, 8, 13, 15], "subfold": [7, 13, 14, 16], "type": [7, 9, 10, 11, 12, 13, 14, 16, 17], "jobcommand": [7, 12, 13, 14, 16], "jobscript": [7, 12], "jobembeddedscript": 7, "jobfiletransf": [7, 13], "jobfilewatchercr": 7, "jobfilewatcherdelet": 7, "jobdatabaseembeddedqueri": 7, "jobdatabasesqlscript": 7, "jobdatabasestoredprocedur": 7, "jobdatabasemssqlagentjob": 7, "jobdatabasemssql_ssi": 7, "jobhadoopsparkpython": 7, "jobhadoopsparkscalajava": 7, "jobhadooppig": 7, "jobhadoopsqoop": 7, "jobhadooph": 7, "jobhadoopdistcp": 7, "jobhadoophdfscommand": 7, "jobhadoophdfsfilewatch": 7, "jobhadoopoozi": 7, "jobhadoopmapreduc": 7, "jobhadoopmapredstream": 7, "jobhadooptajoinputfil": 7, "jobhadooptajoqueri": 7, "jobpeoplesoft": 7, "jobinformatica": 7, "jobawslambda": 7, "jobawsstepfunct": 7, "jobawsbatch": 7, "jobazurefunct": 7, "jobazurelogicapp": 7, "jobazurebatchaccount": 7, "jobwebservic": 7, "jobslamanag": 7, "jobzo": 7, "properti": [7, 10, 12, 15], "when": [7, 9, 11, 12, 13, 15, 16], "notifi": 7, "variabl": [7, 8, 12, 15], "event": [7, 12, 16], "connect": [7, 8, 10, 15], "profil": [7, 8, 10, 15], "connectionprofilehadoop": 7, "connectionprofilefiletransf": 7, "connectionprofiledatabas": 7, "connectionprofilesap": 7, "connectionprofileinformatica": 7, "connectionprofileaw": 7, "connectionprofileazur": 7, "go": 7, "forward": 7, "link": 7, "extend": 7, "aapi": [7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "packag": [7, 9, 15], "ctm_python_cli": [7, 8, 9, 10, 13, 16], "These": 8, "manag": [8, 12, 14, 15], "alongsid": 8, "premis": 8, "multi": 8, "cloud": 8, "commerci": 8, "home": [8, 11, 12, 14, 15, 16], "grown": 8, "singl": [8, 15], "provid": [8, 9, 14, 16], "other": [8, 12, 13, 14], "palett": 8, "plan": 8, "domain": [8, 11, 16], "new": [8, 10, 13, 15], "jobtyp": 8, "made": 8, "easi": 8, "serv": [8, 9], "necessari": [8, 9], "make": [8, 9, 13, 14], "valid": [8, 13, 14], "definit": [8, 10, 11, 12, 13, 14, 15], "let": [8, 13, 16], "simpl": [8, 12, 13], "call": [8, 9, 10, 13], "sshcommand": 8, "It": [8, 9, 13], "two": [8, 9, 14, 15], "paramat": 8, "command": [8, 10, 12, 13, 14, 15, 16], "flag": 8, "addit": [8, 14, 15], "cannot": [8, 13, 14, 16], "add": [8, 10, 13, 14, 15], "edit": [8, 15, 16], "must": [8, 11, 12, 13, 14, 15], "them": [8, 13], "1": [8, 10, 11, 14, 15, 16], "import": [8, 9, 10, 11, 12, 13, 14, 15, 16], "attr": [8, 10], "decor": 8, "aijobsshcommand": 8, "_type": [8, 10], "type_field": [8, 10], "field": [8, 10, 12], "would": [8, 9, 16], "should": [8, 13, 14, 15, 16], "match": 8, "seen": 8, "section": [8, 14], "lower": 8, "field_opt": [8, 10], "option": [8, 14, 15], "mandatori": 8, "2": [8, 10, 11, 12, 13, 14, 15, 16], "check": [8, 17], "json": [8, 15], "baseworkflow": 8, "mysshcommand": 8, "hostcp": 8, "l": [8, 14, 15, 16], "q": 8, "inpath": [8, 10, 13, 16], "aifold": 8, "dumps_json": 8, "indent": [8, 11, 14, 16], "34": [8, 10, 11, 13, 14, 15], "applicationintegr": 8, "connectionprofil": [8, 10], "5": [8, 10, 14, 15, 16], "In": [9, 13, 14, 15, 16], "previou": [9, 14, 16], "focus": 9, "issu": [9, 14, 16], "real": [9, 13], "essenti": 9, "practic": 9, "prevent": 9, "leak": 9, "sensit": 9, "inform": [9, 10, 13, 16], "done": [9, 13], "default": [9, 10, 11, 12, 13, 14, 15, 16], "creation": 9, "skip": [9, 13], "initi": [9, 15], "intent": [9, 13], "immedi": 9, "dure": [9, 14, 15], "construct": 9, "ehich": 9, "em": 9, "There": [9, 13, 16], "method": [9, 11, 12, 13, 16], "kei": [9, 11, 14], "either": [9, 13, 15, 16], "combin": [9, 14], "indic": 9, "slightli": 9, "differ": [9, 14, 15], "constructor": 9, "my_environ": 9, "mymachin": 9, "user": [9, 10, 11, 12, 13, 14, 15, 16], "anoth": [9, 12, 13, 14], "mysaa": 9, "myapikei": 9, "wokrbench": 9, "remot": 9, "machin": [9, 13, 15], "map": 9, "instanc": [9, 13, 14, 15], "contain": [9, 11, 12, 15, 16], "8444": 9, "ha": [9, 13, 14], "those": [9, 14], "via": 9, "directli": [9, 13], "least": [9, 14], "secur": [9, 11], "written": [9, 15], "plain": 9, "text": [9, 14, 15], "input": [9, 15], "disrupt": 9, "process": [9, 15, 16], "intervent": 9, "keyr": 9, "leverag": 9, "oper": [9, 10, 14, 15], "system": [9, 12, 15], "store": [9, 11, 15], "imposs": 9, "everi": [9, 12, 13, 14, 15], "mai": [9, 13, 14], "vault": 9, "specif": [9, 11, 13, 14, 15], "compani": [9, 12, 14], "polici": [9, 12], "easiest": 9, "mhyhost": 9, "myuser": [9, 11], "token": 9, "sure": 9, "pip": 9, "termin": 9, "servicenam": [9, 11], "distinguish": 9, "between": [9, 15], "product": [9, 16], "also": [9, 12, 13], "do": [9, 11, 13, 14, 15, 16], "set_password": 9, "so": [9, 13, 16], "put": 9, "seem": 9, "signific": 9, "tokenadmin": 9, "9": [10, 11, 14, 15, 16], "21": [10, 11, 13, 14, 15], "100": [10, 11, 15], "abov": 10, "autogen": 10, "modul": 10, "along": 10, "file": [10, 11, 15], "autogener": 10, "generatedplugin": 10, "py": [10, 15], "generate_ai_plugins_class": 10, "output_fil": 10, "aijobexampleplugin": 10, "aijob": [10, 17], "39": [10, 13, 15, 16], "examplefield": 10, "examplewithdefault": 10, "examplefieldwithdefault": 10, "connectionprofileaiexampleplugin": 10, "aiconnectionprofil": 10, "examplepassword": 10, "now": [10, 13], "With": 10, "our": [10, 16], "6": [10, 14, 15, 16], "cp": [10, 15], "testcp": 10, "central": [10, 11], "myexamplejob": 10, "my": 10, "4": [10, 14, 15, 16], "w": 10, "testapplicationintegr": 10, "scope": 10, "unnam": 10, "line": [10, 14, 15, 16], "echo": [10, 12, 13, 14, 15, 16], "exit": 10, "statist": 10, "20230213085531": 10, "end": [10, 14, 16], "20230213085532": 10, "elaps": 10, "71": 10, "messag": [10, 14, 15, 16], "normal": 10, "automationapi": [11, 14, 15], "thei": [11, 16], "referenc": 11, "befor": [11, 14, 16], "relev": 11, "For": [11, 12, 14, 15, 16], "most": 11, "except": 11, "transfer": [11, 15], "charact": [11, 15], "uppercas": 11, "letter": 11, "number": [11, 14, 15, 16], "hyphen": 11, "underscor": 11, "up": [11, 14, 15], "30": [11, 13, 14, 15], "target_ctm": 11, "fals": [11, 13, 15, 16], "server": [11, 12, 15], "target_ag": 11, "descript": [11, 12, 14, 16], "avail": [11, 14, 15], "20": [11, 13, 14, 15], "000": [11, 15], "whether": [11, 14, 15], "databas": [11, 13, 15], "apach": 11, "spark": [11, 15], "cp_spark": 11, "spark_connection_profil": 11, "docker": [11, 15], "hadoop": [11, 15], "custom_path": 11, "oozi": 11, "cp_ooz": 11, "oozie_connection_profil": 11, "ssl_enabl": 11, "hdp": 11, "cento": 11, "11000": 11, "extraction_rul": 11, "extractrul": 11, "rule_nam": 11, "rule1": 11, "work_flow_nam": 11, "wf1": [11, 15], "work_flow_user_nam": 11, "user1": [11, 15], "folder_nam": 11, "fname1": 11, "jname1": 11, "rule2": 11, "wf2": 11, "user2": 11, "fname2": 11, "jname2": 11, "sqoop": 11, "cp_sqoop": 11, "sqoop_connection_profil": 11, "mypass": 11, "connection_str": 11, "jdbc": 11, "mysql": 11, "driver_class": 11, "driver": 11, "tajo": 11, "cp_tajo": 11, "tajo_cp": 11, "binary_path": 11, "tajo_hom": 11, "database_nam": 11, "master_server_nam": 11, "mytajoserv": 11, "master_server_port": 11, "26001": 11, "hive": [11, 15], "cp_hive": 11, "hive_connection_profil": 11, "hivehost": 11, "10000": 11, "db": 11, "ftcon": 11, "ftpconn": 11, "ctmserver": [11, 12, 14], "host_nam": 11, "ftpserver": 11, "ftpuser": 11, "ftp_pass": 11, "additional_paramet": 11, "packageparam": 11, "param1": [11, 15], "param2": [11, 15], "home_directori": 11, "os_typ": 11, "sftpconn": 11, "sftpserver": 11, "sftpuser": 11, "private_key_nam": 11, "passphras": 11, "ssh_compress": 11, "ftpsconn": 11, "ssl_implicit": 11, "clear_command_channel": 11, "clear_data_channel": 11, "ssl_level": 11, "ssllevel": 11, "clientserverauthent": 11, "localconn": 11, "testamazon": 11, "access_kei": 11, "secret_access_kei": 11, "secretaccess": 11, "verify_destin": 11, "testcompat": 11, "rest_end_point": 11, "as2_conn_1": 11, "workload_automation_group": 11, "noai": 11, "partner_as2_id": 11, "partner": 11, "partner_destination_url": 11, "dest": [11, 15], "partner_certificate_alia": 11, "alia": 11, "cpdb": [11, 15], "db2_connection_profil": 11, "db2host": 11, "50000": 11, "db2": 11, "jdbc_connection_profil": 11, "pgdrv": 11, "mssql_connection_profil": 11, "database_vers": 11, "2005": 11, "max_concurrent_connect": 11, "connection_retry_time_out": 11, "connection_idle_tim": 11, "45": [11, 15], "oracle_connection_profil": 11, "sid": 11, "orcl": 11, "service_nam": [11, 15], "1521": 11, "postgresql_connection_profil": 11, "postgr": 11, "sybase_connection_profil": 11, "cpsap": 11, "sapcon": 11, "sap_client": 11, "languag": 11, "xbp_version": 11, "xbp3": 11, "app_vers": 11, "r3": 11, "application_server_logon": 11, "applicationserverlogon": 11, "system_numb": 11, "12": [11, 14, 15, 16], "secured_network_connect": 11, "securednetworkconnect": 11, "snc_lib": 11, "snc_partner_nam": 11, "quality_of_protect": 11, "snc_my_nam": 11, "sap_response_time_out": 11, "180": 11, "use_extend": 11, "solution_manager_connection_profil": 11, "ip4": 11, "group": [11, 12], "is_solution_manager_connection_profil": 11, "dumps_aapi": [11, 14], "cpinf": 11, "informatica_connect": 11, "inf": 11, "power_center_domain": 11, "repositori": [11, 15], "rep": 11, "integration_servic": 11, "security_domain": 11, "nativ": 11, "connection_typ": 11, "connectiontyp": 11, "cpaw": [11, 15], "aws_connection_iamrol": 11, "iam_rol": 11, "myrol": 11, "region": [11, 15], "ap": 11, "northeast": 11, "proxy_set": 11, "proxyset": 11, "12345": 11, "cpazur": [11, 15], "azure_connect": 11, "active_directory_domain_nam": 11, "subscription_id": 11, "application_id": 11, "batch": [11, 15], "batch_account_nam": 11, "mybatch": 11, "batch_account_kei": 11, "locat": [11, 15], "centralu": 11, "oppos": 12, "configur": [12, 15], "variou": [12, 14], "ad": [12, 14, 17], "notif": [12, 14], "level": [12, 14], "inherit": [12, 15], "within": [12, 14], "criteria": [12, 14], "instead": 12, "per": 12, "take": [12, 16], "rule": 12, "reduc": [12, 15], "sample_fold": 12, "job_list": [12, 13, 14], "job1": [12, 13, 14], "am": [12, 16], "job2": [12, 13, 14], "jobdummi": [12, 13], "job3": [12, 13], "controlm_serv": [12, 14], "site_standard": [12, 14], "mysitestandard": 12, "business_field": [12, 14], "depart": [12, 14], "hr": [12, 14], "bmc": [12, 14, 15], "order_method": [12, 14], "ordermethod": [12, 14], "manual": [12, 14], "A": [12, 13, 14, 15, 16], "parent": 12, "next": [12, 14, 15, 16], "offer": [12, 13], "mani": 12, "capabl": [12, 14], "regular": [12, 13, 14], "folderwithsubfold": 12, "sub_folder_list": [12, 14], "firstsubfold": 12, "file_nam": [12, 15], "sh": [12, 14, 15], "file_path": [12, 15], "secondsubfold": 12, "dummyjob": 12, "than": [12, 14], "belong": 12, "enforc": 12, "site": 12, "standard": [12, 15], "busi": 12, "order": [12, 14, 15, 16], "automat": 12, "dai": [12, 13, 14, 15], "ignor": 12, "active_retention_polici": [12, 14], "retent": [12, 15], "share": [12, 13, 14, 15], "notebook": 12, "samplefold": [12, 14], "sitestd": [12, 14], "applicationnam": [12, 14], "sub_appl": [12, 14, 16], "subappl": [12, 14], "run_a": [12, 13, 14, 15, 16], "week_dai": [12, 14], "sun": [12, 14], "activeretentionpolici": [12, 14], "keepal": [12, 14], "days_keep_act": [12, 14], "41": [12, 14, 15], "created_bi": [12, 14, 15], "foldersampl": [12, 14], "lot": [12, 14], "prioriti": [12, 14], "high": [12, 14], "rerun_limit": [12, 14], "rerunlimit": [12, 14], "time_zon": [12, 14], "haw": [12, 14], "var1": [12, 14, 15], "val": [12, 14], "var2": [12, 14], "val2": [12, 14, 15], "organ": 13, "pc": 13, "18": [13, 14, 15, 16], "workflowdefault": [13, 16], "19": [13, 14, 15], "task": [13, 15, 16], "includ": [13, 14, 15], "worbench": 13, "each": [13, 14, 15], "purpos": 13, "o": [13, 14], "hello": [13, 14, 15, 16], "world": 13, "myfirstjob": [13, 14], "could": 13, "posit": 13, "mean": [13, 14], "although": 13, "yet": 13, "root": [13, 14, 15], "insid": 13, "simplefold": 13, "myfirstfold": 13, "equival": 13, "everyth": 13, "22": [13, 14, 15], "still": 13, "overwrit": 13, "reciev": 13, "warn": 13, "23": [13, 14, 15], "perform": [13, 15], "choos": 13, "anytim": 13, "24": [13, 14, 15], "25": [13, 14, 15], "exisit": 13, "exisitng": 13, "Then": 13, "final": 13, "sequenc": 13, "26": [13, 14, 15], "clear": 13, "clear_al": [13, 16], "firstjob": 13, "come": 13, "secondjob": 13, "mysecondjob": 13, "second": [13, 14, 15, 16], "visus": 13, "graphviz": 13, "org": [13, 15], "forget": 13, "binari": [13, 15], "prompt": 13, "visual": 13, "represent": 13, "27": [13, 14, 15], "get_graph": [13, 16], "28": [13, 14, 15], "f": [13, 15], "29": [13, 14, 15], "inconvenint": 13, "syntact": 13, "sugar": 13, "mythirdjob": 13, "third": 13, "chainedjob": 13, "trigger": [13, 14, 16], "job4": 13, "wait": [13, 14, 16], "both": [13, 14, 16], "32": [13, 14, 15], "def": 13, "chain_job": 13, "hello1": 13, "hello2": 13, "hello3": 13, "hello4": 13, "job_chain": 13, "scenario": [13, 14, 16], "separ": [13, 14, 15], "33": [13, 14, 15], "doe": [13, 14, 16], "noth": 13, "paramet": [13, 14, 15], "mark": [13, 14, 16], "again": [13, 14, 16], "myjob1": 13, "myjob2": 13, "testjobdummi": 13, "sleep": [13, 16], "give": [13, 16], "finish": [13, 15, 16], "No": 13, "assert": 13, "35": [13, 15], "receiv": [13, 14], "relat": 14, "respons": 14, "By": [14, 16], "account": [14, 15], "difer": 14, "keep": 14, "did": 14, "date": 14, "kept": 14, "until": [14, 16], "maximum": [14, 15], "dayskeepact": 14, "retriev": 14, "th": 14, "over": 14, "run_as_dummi": [14, 16, 17], "boolean": 14, "dummi": [14, 15, 16, 17], "retroactive_ord": 14, "retroact": 14, "down": 14, "due": 14, "hardwar": 14, "soon": 14, "inact": 14, "zone": 14, "48": 14, "hour": [14, 15], "intend": 14, "format": [14, 15], "if_list": 14, "notify_list": 14, "append": [14, 15], "mysubfolder1": 14, "otherjob": 14, "goodscenario": 14, "completion_statu": 14, "on_list": 14, "sendmail": 14, "ran": [14, 16], "successfulli": [14, 15], "team": 14, "comp": 14, "subject": 14, "badscenario": 14, "nok": 14, "runcorrectivejob": 14, "remedy_fold": 14, "remedyjob": 14, "alertifnok": 14, "destin": [14, 15], "alert": 14, "alertifjobisstuck": 14, "1200": 14, "didnt": 14, "calendar": 14, "sever": 14, "under": 14, "refer": 14, "previous": 14, "constant": 14, "hoc": 14, "manner": 14, "onc": 14, "constraint": 14, "obei": 14, "Not": [14, 16], "support": 14, "One": 14, "mon": 14, "tue": 14, "wed": 14, "thu": 14, "fri": 14, "sat": 14, "week": 14, "month": 14, "ddaywn": 14, "dmonw2": 14, "mondai": 14, "2nd": 14, "n": [14, 15], "jan": 14, "feb": 14, "mar": 14, "apr": 14, "jun": [14, 16], "jul": 14, "aug": 14, "sep": 14, "oct": 14, "nov": 14, "dec": 14, "year": 14, "month_dai": 14, "rang": [14, 15], "31": [14, 15], "from_tim": 14, "fromtim": 14, "hhmm": 14, "to_tim": 14, "totim": 14, "submit": [14, 15, 16], "even": 14, "origin": 14, "everydai": 14, "met": 14, "never": 14, "specific_d": 14, "mm": 14, "dd": 14, "enclos": 14, "quot": 14, "comma": [14, 15], "specificd": 14, "weekdai": 14, "monthdai": 14, "howev": 14, "11": [14, 15, 16], "1500": 14, "1800": 14, "03": 14, "10": [14, 15, 16], "01": [14, 15, 16], "statement": [14, 15], "fulfil": 14, "fail": [14, 16], "unsuccessfulli": 14, "send": [14, 15], "email": 14, "action_if_failur": 14, "notok": [14, 16], "mailtoteam": 14, "jobnam": 14, "myteam": 14, "mail": 14, "foldernam": 14, "actionbynumberofrerun": 14, "number_of_rerun": 14, "runjob": 14, "folder1": 14, "failur": [14, 15, 16], "actionbynumberoffailur": 14, "number_of_failur": 14, "actionbyjobnotsubmit": 14, "8": [14, 15, 16], "actionbyoutputnotfound": 14, "actionbynumberexecut": 14, "number_of_execut": 14, "string": [14, 15], "outputfound": 14, "myfil": 14, "featur": 14, "enterpris": 14, "logic": [14, 15], "condit": [14, 16], "variablevalu": 14, "variable_nam": 14, "ipaddress": 14, "variable_valu": 14, "endwith": 14, "do_list": 14, "runjob1": 14, "variablenam": 14, "e": 14, "urgenc": 14, "recipi": 14, "semicolon": 14, "cc": 14, "copi": 14, "attach_output": 14, "attach": 14, "urgent": 14, "just": [14, 16], "13": [14, 15, 16], "rerunact": 14, "14": [14, 15, 16], "setvari": 14, "15": [14, 15, 16], "settook": 14, "16": [14, 15, 16], "settonotok": 14, "disabl": 14, "cyclic": [14, 16], "attribut": 14, "17": [14, 15], "correctivejob": 14, "010218": 14, "cvar1": 14, "val1": [14, 15], "cvar2": 14, "run_as_independent_flow": 14, "notifyact": 14, "joblog": 14, "veryurg": 14, "remedi": 14, "ticket": 14, "remedyticket": 14, "summari": 14, "node": 14, "nodeid": 14, "compstat": 14, "runcount": 14, "low": 14, "copyoutput": 14, "copyher": 14, "documentaion": 14, "certain": 14, "notify1": 14, "NOT": 14, "1510": 14, "consol": [14, 15], "expect": [14, 15], "didn": 14, "less": 14, "minut": [14, 15], "lessthan": 14, "12h20": 14, "1220": 14, "reran": 14, "subsequ": 14, "submiss": 14, "late": 14, "pool": 14, "known": 14, "quantit": 14, "semaphor": 14, "concurr": 14, "resourcesampl": 14, "resource_list": 14, "semaphore1": 14, "quantiti": 14, "lock": 14, "mutex": 14, "exclus": 14, "lock1": 14, "lock_typ": 14, "locktyp": 14, "frequenc": 14, "express": 14, "whole": 14, "unit": [14, 15], "from_": 14, "calcul": [14, 15], "current": 14, "target": [14, 15], "cycl": 14, "forev": 14, "usag": 14, "anyd": 14, "orderd": 14, "previousorderd": 14, "nextorderd": 14, "mmdd": 14, "0511": 14, "show": [14, 15, 16], "waitforeventlist": 14, "e1": 14, "e2": 14, "e3": 14, "event_list": 14, "addeventlistobject": 14, "eventoutadd": 14, "e4": 14, "nodat": 14, "remov": 14, "deleteeventlistobject": 14, "eventoutdelet": 14, "e5": 14, "object_nam": 15, "jobcommandsampl": 15, "mycommand": 15, "myhost": 15, "pre_command": 15, "precommand": 15, "post_command": 15, "arrai": 15, "jobscriptsampl": 15, "jobscriptsam": 15, "arg1": 15, "arg2": 15, "itself": [15, 16], "escap": 15, "jobembeddedscriptsampl": 15, "filenam": 15, "r": 15, "bash": 15, "necho": 15, "bye": [15, 16], "file_transf": 15, "filetransf": 15, "dual": 15, "connection_profile_dual_endpoint": 15, "connection_profile_src": 15, "connection_profile_dest": 15, "number_of_retri": 15, "attempt": 15, "99": 15, "s3_bucket_nam": 15, "local": 15, "filesystem": 15, "amazon": 15, "s3": 15, "compat": 15, "storag": 15, "bucket": 15, "s3_bucket_name_src": 15, "s3_bucket_name_dest": 15, "jobfiletransfersampl": 15, "cp1": 15, "cp2": 15, "src": 15, "file1": 15, "cmt": 15, "file2": 15, "transfer_typ": 15, "transfertyp": 15, "transfer_opt": 15, "transferopt": 15, "srctodest": 15, "transer": 15, "transfers3toloc": 15, "amazoncp": 15, "localcp": 15, "empti": 15, "detect": 15, "jobfilewatchercreatesampl": 15, "c": 15, "txt": 15, "search_interv": 15, "time_limit": 15, "start_tim": [15, 16], "201705041535": 15, "stop_tim": 15, "201805041535": 15, "minimum_s": 15, "10b": 15, "wildcard": 15, "minimal_ag": 15, "1y": 15, "maximal_ag": 15, "1d2h4min": 15, "jobfilewatcherdeletesampl": 15, "embed": 15, "queri": [15, 16], "sql": 15, "replac": 15, "row": 15, "long": 15, "delimit": 15, "tab": 15, "autocommit": 15, "commit": 15, "output_execution_log": 15, "output_sql_output": 15, "sysout": [15, 16], "sql_output_format": 15, "xml": 15, "csv": 15, "html": 15, "jobembeddedquerysampl": 15, "select": 15, "firstparamnam": 15, "AS": 15, "BY": [15, 16], "desc": 15, "y": 15, "sql_script": 15, "dictionari": 15, "appear": [15, 16], "pair": 15, "jobdatabasesqlscriptsampl": 15, "program": 15, "stored_procedur": 15, "schema": 15, "procedur": 15, "resid": 15, "return_valu": 15, "oracl": 15, "jobdatabasestoredproceduresampl": 15, "public": 15, "rv": 15, "210": 15, "categori": 15, "jobdatabasemssqlagentjobsampl": 15, "get_vers": 15, "collector": 15, "ssi": 15, "220": 15, "package_sourc": 15, "package_nam": 15, "catalog_env": 15, "config_fil": 15, "jobdatabasemssql_ssissampl": 15, "packagesourc": 15, "ssis_catalog": 15, "sqltracecollect": 15, "env_nam": 15, "dbauser": 15, "desktop": 15, "dtsconfig": 15, "test2": 15, "propertynam": 15, "propertyvalu": 15, "propertyname2": 15, "propertyvalue2": 15, "spark_script": 15, "spark_opt": 15, "jobhadoopsparkpythonsampl": 15, "1000": 15, "120": 15, "master": 15, "yarn": 15, "num": 15, "executor": 15, "50": 15, "jobhadoopsparkscalajavasampl": 15, "program_jar": 15, "scalaprogram": 15, "jar": 15, "main_class": 15, "mycomp": 15, "sparkscalaprogramnam": 15, "mainclassnam": 15, "jobhadooppigsampl": 15, "pig_script": 15, "pg": 15, "jobhadoopsqoopsampl": 15, "sqoop_command": 15, "tabl": 15, "foo": [15, 16], "dir": 15, "dest_dir": 15, "sqoop_opt": 15, "warehous": 15, "latin1": 15, "jobhadoophivesampl": 15, "hive_script": 15, "amount": 15, "topic": 15, "food": 15, "hive_opt": 15, "logger": 15, "info": 15, "jobhadoopdistcpsampl": 15, "target_path": 15, "hdf": 15, "nns2": 15, "8020": 15, "bar": 15, "source_path": 15, "nns1": 15, "distcp_opt": 15, "filelimit": 15, "jobhadoophdfscommandssampl": 15, "nn": 15, "localfil": 15, "rm": 15, "emptydir": 15, "jobhadoophdfsfilewatchersampl": 15, "hdfs_file_path": 15, "min_detected_s": 15, "max_wait_tim": 15, "jobhadoopooziesampl": 15, "job_properties_fil": 15, "oozie_opt": 15, "inputdir": 15, "usr": 15, "tucu": 15, "outputdir": 15, "jobhadoopmapreducesampl": 15, "mapreduc": 15, "jobhadoopmapredstreamingsampl": 15, "input_path": 15, "output_path": 15, "tmp": 15, "mapper_command": 15, "mapper": 15, "reducer_command": 15, "general_opt": 15, "d": 15, "permiss": 15, "umask": 15, "stream": 15, "jobhadooptajoinputfilesampl": 15, "full_file_path": 15, "tajo_command": 15, "tajo_opt": 15, "volum": 15, "jobhadooptajoquerysampl": 15, "open_queri": 15, "peoplesoft": 15, "control_id": 15, "runtim": [15, 16], "process_typ": 15, "author": 15, "process_nam": 15, "append_to_output": 15, "bind_vari": 15, "userdef": 15, "jobpeoplesoftsampl": 15, "cp_p": 15, "ps_user": 15, "controlid": 15, "server_nam": 15, "ptype": 15, "pname": 15, "supportu": 15, "monthli": 15, "en": 15, "u": 15, "api_coderef_jobtypes_dataintegr": 15, "htm": 15, "informatica": 15, "repository_fold": 15, "instance_nam": 15, "os_profil": 15, "workflow_execution_mod": 15, "workflow_restart_mod": 15, "suspend": 15, "satu": 15, "restart_from_task": 15, "workflowexecutionmod": 15, "startfromtask": 15, "run_single_task": 15, "runsingletask": 15, "workflow_parameters_fil": 15, "jobinformaticasampl": 15, "cp_inf": 15, "poc": 15, "wf_test": 15, "myinstanc": 15, "osprofil": 15, "workflowrestartmod": 15, "forcerestartfromspecifictask": 15, "s_maptest_success": 15, "opt": 15, "prop": 15, "aw": 15, "lambda": 15, "function_nam": 15, "latest": 15, "payload": 15, "append_log": 15, "jobawslambdasampl": 15, "fname": 15, "myvar": 15, "value1": 15, "othervar": 15, "value2": 15, "state_machin": 15, "state": [15, 16], "execution_nam": 15, "jobawsstepfunctionsampl": 15, "smach1": 15, "exec1": 15, "var": 15, "job_definit": 15, "job_definition_revis": 15, "revis": 15, "job_queu": 15, "queue": 15, "aws_job_typ": 15, "array_s": 15, "size": 15, "item": 15, "depends_on": 15, "depend": [15, 16], "overrid": 15, "imag": 15, "memori": 15, "megabyt": 15, "reserv": 15, "v_cpu": 15, "vcpu": 15, "job_attempt": 15, "retri": 15, "execution_timeout": 15, "timeout": 15, "durat": 15, "jobawsbatchsampl": 15, "batchjob": 15, "jobdef": 15, "queue1": 15, "awsjobtyp": 15, "dependson": 15, "dependency_typ": 15, "dependencytyp": 15, "job_depends_on": 15, "job5": 15, "60": 15, "azur": 15, "function_app": 15, "app": 15, "jobazurefunctionsampl": 15, "azurefunct": 15, "funcapp": 15, "firstparamvalu": 15, "secondparamnam": 15, "secondparamvalu": 15, "logic_app_nam": 15, "request_bodi": 15, "36": 15, "jobazurelogicappssampl": 15, "workflow_app": 15, "command_lin": 15, "wallclock": 15, "limit": 15, "max_tri": 15, "period": 15, "unlimit": 15, "37": 15, "jobazurebatchaccountsampl": 15, "azurejob": 15, "70": 15, "maxtri": 15, "count": 15, "servlet": 15, "rest": 15, "java": 15, "wjm": 15, "plug": 15, "38": 15, "jobwebservicessampl": 15, "cp_w": 15, "www": 15, "dneonlin": 15, "asmx": 15, "wsdl": 15, "soap_header_fil": 15, "myhead": 15, "calculatorsoap": 15, "request_typ": 15, "requesttyp": 15, "override_url_endpoint": 15, "myoverridehost": 15, "override_content_typ": 15, "http_connection_timeout": 15, "2345": 15, "preemptive_http_authent": 15, "include_title_in_output": 15, "exclude_job_output": 15, "output_paramet": 15, "element": 15, "addrespons": 15, "addresult": 15, "httpcode": 15, "testresultadd": 15, "input_paramet": 15, "inta": 15, "97": 15, "intb": 15, "345": 15, "encod": 15, "header": 15, "soap_request": 15, "soapenv": 15, "envelop": 15, "xmln": 15, "xmlsoap": 15, "soap": 15, "tem": 15, "tempuri": 15, "bodi": 15, "98978": 15, "75675": 15, "input_fil": 15, "jobslamanagementsampl": 15, "sla": 15, "service_prior": 15, "job_runs_deviations_toler": 15, "complete_in": 15, "completein": 15, "00": [15, 16], "complete_bi": 15, "completebi": 15, "40": 15, "average_run_time_toler": 15, "averageruntimetoler": 15, "average_run_tim": 15, "jobzosmemb": 15, "jobzosmembersampl": 15, "member_librari": 15, "ioaq": 15, "au": 15, "jcl": 15, "archiv": 15, "archive_sys_data": 15, "must_end": 15, "mustend": 15, "run_on_all_agents_in_group": 15, "jobzosinstreamjcl": 15, "jobzoinstreamjclsampl": 15, "autest0": 15, "asm": 15, "0m": 15, "jcllib": 15, "proclib": 15, "member": 15, "ioaset": 15, "s1": 15, "exec": 15, "ioatest": 15, "parm": 15, "term": 15, "c0000": 15, "chain": 16, "helloworld": 16, "countfil": 16, "wc": 16, "testmonitor": 16, "probabl": 16, "satisfi": 16, "print_statu": 16, "printout": 16, "heirarchi": 16, "aggreg": 16, "few": 16, "enough": 16, "entir": 16, "end_tim": 16, "2022": 16, "estimated_end_tim": 16, "estimated_start_tim": 16, "folder_id": 16, "0001g": 16, "0001i": 16, "job_json": 16, "log_uri": 16, "number_of_run": 16, "order_d": 16, "output_uri": 16, "runobject": 16, "121": 16, "785": 16, "were": 16, "therefor": 16, "becaus": 16, "indenpend": 16, "detail": 16, "desir": 16, "forc": 16, "continu": 16, "64": 16, "daili": 16, "odat": 16, "20220614": 16, "5065": 16, "freed": 16, "5402": 16, "TO": 16, "5105": 16, "AT": 16, "20220614110115": 16, "ON": 16, "5101": 16, "chang": 16, "5120": 16, "20220614110116": 16, "oscompstat": 16, "127": 16, "runcnt": 16, "5100": 16, "cmd": 16, "log_00001k_00001": 16, "5169": 16, "OF": 16, "5134": 16, "analyz": 16, "post": 16, "0000001k_001": 16, "notic": 16, "tri": 16, "caus": 16, "possibl": 16, "forgot": 16, "typo": 16, "troubleshoot": 17}, "objects": {"": [[3, 0, 0, "-", "ctm_python_client"]], "ctm_python_client": [[4, 0, 0, "-", "core"], [5, 0, 0, "-", "ext"]], "ctm_python_client.core": [[4, 0, 0, "-", "comm"], [4, 0, 0, "-", "credential"], [4, 0, 0, "-", "monitoring"]], "ctm_python_client.core.comm": [[4, 1, 1, "", "AAPIClientResponse"], [4, 1, 1, "", "AbstractAAPIClient"], [4, 1, 1, "", "Environment"], [4, 1, 1, "", "EnvironmentMode"], [4, 1, 1, "", "OnPremAAPIClient"], [4, 1, 1, "", "SaasAAPIClient"]], "ctm_python_client.core.comm.AAPIClientResponse": [[4, 2, 1, "", "is_ok"]], "ctm_python_client.core.comm.AbstractAAPIClient": [[4, 2, 1, "", "authenticate"]], "ctm_python_client.core.comm.Environment": [[4, 2, 1, "", "create_onprem"], [4, 2, 1, "", "create_saas"], [4, 2, 1, "", "create_workbench"]], "ctm_python_client.core.comm.EnvironmentMode": [[4, 3, 1, "", "ONPREM"], [4, 3, 1, "", "SAAS"], [4, 3, 1, "", "WORKBENCH"]], "ctm_python_client.core.comm.OnPremAAPIClient": [[4, 2, 1, "", "authenticate"]], "ctm_python_client.core.comm.SaasAAPIClient": [[4, 2, 1, "", "authenticate"]], "ctm_python_client.core.credential": [[4, 1, 1, "", "AbstractCredentials"], [4, 1, 1, "", "InputPasswordCredentials"], [4, 1, 1, "", "SimpleCredentials"]], "ctm_python_client.core.credential.AbstractCredentials": [[4, 2, 1, "", "get_password"], [4, 2, 1, "", "get_username"]], "ctm_python_client.core.credential.InputPasswordCredentials": [[4, 2, 1, "", "get_password"], [4, 2, 1, "", "get_username"]], "ctm_python_client.core.credential.SimpleCredentials": [[4, 2, 1, "", "get_password"], [4, 2, 1, "", "get_username"]], "ctm_python_client.core.monitoring": [[4, 1, 1, "", "Monitor"], [4, 1, 1, "", "RunMonitor"]], "ctm_python_client.core.monitoring.Monitor": [[4, 2, 1, "", "confirm_job"], [4, 2, 1, "", "delete_job"], [4, 2, 1, "", "get_log"], [4, 2, 1, "", "get_output"], [4, 2, 1, "", "get_statuses"], [4, 2, 1, "", "hold_job"], [4, 2, 1, "", "kill_job"], [4, 2, 1, "", "release_job"], [4, 2, 1, "", "rerun_job"], [4, 2, 1, "", "set_to_ok"]], "ctm_python_client.core.monitoring.RunMonitor": [[4, 2, 1, "", "confirm_job"], [4, 2, 1, "", "delete_job"], [4, 2, 1, "", "get_jobid"], [4, 2, 1, "", "get_log"], [4, 2, 1, "", "get_output"], [4, 2, 1, "", "get_status"], [4, 2, 1, "", "get_statuses"], [4, 2, 1, "", "hold_job"], [4, 2, 1, "", "kill_job"], [4, 2, 1, "", "open_in_browser"], [4, 2, 1, "", "print_output"], [4, 2, 1, "", "print_statuses"], [4, 2, 1, "", "release_job"], [4, 2, 1, "", "rerun_job"], [4, 2, 1, "", "set_to_ok"]], "ctm_python_client.ext": [[5, 0, 0, "-", "credential"]], "ctm_python_client.ext.credential": [[5, 1, 1, "", "KeyringCredentials"]], "ctm_python_client.ext.credential.KeyringCredentials": [[5, 2, 1, "", "get_password"], [5, 2, 1, "", "get_username"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"]}, "titleterms": {"aapi": [0, 1], "packag": [0, 1, 3, 4, 5], "subpackag": [0, 3], "submodul": [0, 1, 4, 5], "action": [0, 14], "modul": [0, 1, 3, 4, 5], "addev": [0, 14], "ai": [0, 10], "basefold": 0, "base": 0, "businessfield": 0, "businessparamet": 0, "calendar": 0, "calendarfield": 0, "calendarkei": 0, "captureoutput": 0, "condit": 0, "config": 0, "connectionprofil": 0, "ctbruledata": 0, "date": 0, "definitionitemdetail": 0, "deleteev": [0, 14], "disallowedopt": 0, "do": 0, "donotifi": 0, "driver": 0, "endpoint": 0, "event": [0, 14], "extractrul": 0, "filetransf": 0, "filetransfergroup": 0, "flow_": 0, "folderclientdata": 0, "folderjobbas": 0, "hostfiletransf": 0, "hostmap": 0, "if_": 0, "ifbas": 0, "ifcollect": 0, "ifrerun": 0, "internalrul": 0, "iteminfo": 0, "job": [0, 1, 8, 13, 14, 15, 16], "jobsfilt": 0, "jobtag": 0, "mail": 0, "notifi": [0, 14], "output": [0, 13], "packageparam": 0, "period": 0, "possibleopt": 0, "propertycondit": 0, "rbcdetail": 0, "remedi": 0, "resourc": [0, 14], "resourcepool": [0, 14], "run": [0, 13, 16], "runningjob": 0, "set_": 0, "sitestandard": 0, "sitestandarddata": 0, "sitestandardoperatorvalueopt": 0, "sitestandardpolici": 0, "sitestandardpolicydata": 0, "sitestandardpossiblevalu": 0, "sitestandardrestrict": 0, "steprang": 0, "tag": 0, "time": 0, "variabl": [0, 14], "waitforev": [0, 14], "workloadflat": 0, "workloadpolici": 0, "wpperiod": 0, "year": 0, "content": [0, 1, 3, 4, 5, 7], "integration_factori": 1, "connection_profil": 1, "go": 2, "forward": 2, "us": 2, "link": 2, "extend": 2, "control": [2, 7, 10, 13, 16], "m": [2, 7, 10, 13, 16], "python": [2, 7, 13, 16], "client": [2, 7, 13, 16], "ctm_python_cli": [3, 4, 5], "core": 4, "comm": 4, "credenti": [4, 5, 9], "monitor": [4, 16], "workflow": [4, 13, 16], "ext": 5, "viz": 5, "get": [6, 13, 16], "start": [6, 13], "environ": [6, 9], "instal": 6, "via": 6, "pip": 6, "from": 6, "sourc": 6, "document": 7, "refer": 7, "work": 8, "applic": 8, "integr": 8, "build": [8, 13], "custom": 8, "type": [8, 15], "aijob": 8, "authent": 9, "auto": 10, "gener": 10, "plugin": 10, "workbench": 10, "connect": [11, 13], "profil": 11, "connectionprofilehadoop": 11, "connectionprofilefiletransf": 11, "connectionprofilefiletransferftp": 11, "connectionprofilefiletransfersftp": 11, "connectionprofilefiletransferloc": 11, "connectionprofilefiletransfers3amazon": 11, "connectionprofilefiletransfers3compat": 11, "connectionprofilefiletransferas2": 11, "connectionprofiledatabas": 11, "connectionprofiledatabasedb2": 11, "connectionprofiledatabasejdbc": 11, "connectionprofiledatabasemssql": 11, "connectionprofiledatabaseoraclesid": 11, "connectionprofiledatabaseoracleservicenam": 11, "connectionprofiledatabaseoracleconnectionstr": 11, "connectionprofiledatabasepostgresql": 11, "connectionprofiledatabasesybas": 11, "connectionprofilesap": 11, "connectionprofileinformatica": 11, "connectionprofileaw": 11, "connectionprofileazur": 11, "folder": [12, 14, 16], "exampl": 12, "subfold": 12, "argument": 12, "creat": 13, "ad": 13, "deploi": 13, "check": [13, 16], "flow": [13, 16], "without": 13, "two": 13, "chain": 13, "dummi": 13, "run_as_dummi": 13, "properti": 14, "when": 14, "If": 14, "ifcompletionstatu": 14, "ifnumberofrerun": 14, "ifnumberoffailur": 14, "ifjobnotsubmit": 14, "ifjoboutputnotfound": 14, "ifnumberofexecut": 14, "ifoutput": 14, "ifvariablevalu": 14, "actionmail": 14, "actionrerun": 14, "actionset": 14, "actionsettook": 14, "actionsettonotok": 14, "actionstopcyclicrun": 14, "actionrun": 14, "actionnotifi": 14, "actionremedi": 14, "actionoutput": 14, "notifyok": 14, "notifynotok": 14, "notifydoesnotstart": 14, "notifyexecutiontim": 14, "notifydoesnotend": 14, "notifyrerun": 14, "notifylatecyclicsubmit": 14, "resourcelock": 14, "rerun": 14, "jobcommand": 15, "jobscript": 15, "jobembeddedscript": 15, "jobfiletransf": 15, "jobfilewatchercr": 15, "jobfilewatcherdelet": 15, "jobdatabaseembeddedqueri": 15, "jobdatabasesqlscript": 15, "jobdatabasestoredprocedur": 15, "jobdatabasemssqlagentjob": 15, "jobdatabasemssql_ssi": 15, "jobhadoopsparkpython": 15, "jobhadoopsparkscalajava": 15, "jobhadooppig": 15, "jobhadoopsqoop": 15, "jobhadooph": 15, "jobhadoopdistcp": 15, "jobhadoophdfscommand": 15, "jobhadoophdfsfilewatch": 15, "jobhadoopoozi": 15, "jobhadoopmapreduc": 15, "jobhadoopmapredstream": 15, "jobhadooptajoinputfil": 15, "jobhadooptajoqueri": 15, "jobpeoplesoft": 15, "jobinformatica": 15, "jobawslambda": 15, "jobawsstepfunct": 15, "jobawsbatch": 15, "jobazurefunct": 15, "jobazurelogicapp": 15, "jobazurebatchaccount": 15, "jobwebservic": 15, "jobslamanag": 15, "jobzo": 15, "statu": 16, "specif": 16, "error": 16, "troubleshoot": 16, "tutori": 17, "notebook": 17}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"aapi package": [[0, "aapi-package"]], "Subpackages": [[0, "subpackages"], [3, "subpackages"]], "Submodules": [[0, "submodules"], [1, "submodules"], [4, "submodules"], [5, "submodules"]], "aapi.action module": [[0, "aapi-action-module"]], "aapi.addevents module": [[0, "aapi-addevents-module"]], "aapi.ai module": [[0, "aapi-ai-module"]], "aapi.basefolder module": [[0, "aapi-basefolder-module"]], "aapi.bases module": [[0, "aapi-bases-module"]], "aapi.businessfield module": [[0, "aapi-businessfield-module"]], "aapi.businessparameter module": [[0, "aapi-businessparameter-module"]], "aapi.calendar module": [[0, "aapi-calendar-module"]], "aapi.calendarfields module": [[0, "aapi-calendarfields-module"]], "aapi.calendarkey module": [[0, "aapi-calendarkey-module"]], "aapi.captureoutput module": [[0, "aapi-captureoutput-module"]], "aapi.condition module": [[0, "aapi-condition-module"]], "aapi.config module": [[0, "aapi-config-module"]], "aapi.connectionprofile module": [[0, "aapi-connectionprofile-module"]], "aapi.ctbruledata module": [[0, "aapi-ctbruledata-module"]], "aapi.date module": [[0, "aapi-date-module"]], "aapi.definitionitemdetails module": [[0, "aapi-definitionitemdetails-module"]], "aapi.deleteevents module": [[0, "aapi-deleteevents-module"]], "aapi.disallowedoptions module": [[0, "aapi-disallowedoptions-module"]], "aapi.do module": [[0, "aapi-do-module"]], "aapi.donotify module": [[0, "aapi-donotify-module"]], "aapi.driver module": [[0, "aapi-driver-module"]], "aapi.endpoint module": [[0, "aapi-endpoint-module"]], "aapi.event module": [[0, "aapi-event-module"]], "aapi.extractrule module": [[0, "aapi-extractrule-module"]], "aapi.filetransfer module": [[0, "aapi-filetransfer-module"]], "aapi.filetransfergroup module": [[0, "aapi-filetransfergroup-module"]], "aapi.flow_ module": [[0, "aapi-flow-module"]], "aapi.folderclientdata module": [[0, "aapi-folderclientdata-module"]], "aapi.folderjobbase module": [[0, "aapi-folderjobbase-module"]], "aapi.hostfiletransfer module": [[0, "aapi-hostfiletransfer-module"]], "aapi.hostmapping module": [[0, "aapi-hostmapping-module"]], "aapi.if_ module": [[0, "aapi-if-module"]], "aapi.ifbase module": [[0, "aapi-ifbase-module"]], "aapi.ifcollection module": [[0, "aapi-ifcollection-module"]], "aapi.ifrerun module": [[0, "aapi-ifrerun-module"]], "aapi.internalrule module": [[0, "aapi-internalrule-module"]], "aapi.iteminfo module": [[0, "aapi-iteminfo-module"]], "aapi.job module": [[0, "aapi-job-module"]], "aapi.jobsfilter module": [[0, "aapi-jobsfilter-module"]], "aapi.jobtag module": [[0, "aapi-jobtag-module"]], "aapi.mail module": [[0, "aapi-mail-module"]], "aapi.notify module": [[0, "aapi-notify-module"]], "aapi.on module": [[0, "aapi-on-module"]], "aapi.output module": [[0, "aapi-output-module"]], "aapi.package module": [[0, "aapi-package-module"]], "aapi.packageparams module": [[0, "aapi-packageparams-module"]], "aapi.period module": [[0, "aapi-period-module"]], "aapi.possibleoptions module": [[0, "aapi-possibleoptions-module"]], "aapi.propertycondition module": [[0, "aapi-propertycondition-module"]], "aapi.rbcdetails module": [[0, "aapi-rbcdetails-module"]], "aapi.remedy module": [[0, "aapi-remedy-module"]], "aapi.resource module": [[0, "aapi-resource-module"]], "aapi.resourcepools module": [[0, "aapi-resourcepools-module"]], "aapi.run module": [[0, "aapi-run-module"]], "aapi.runningjobs module": [[0, "aapi-runningjobs-module"]], "aapi.set_ module": [[0, "aapi-set-module"]], "aapi.sitestandard module": [[0, "aapi-sitestandard-module"]], "aapi.sitestandarddata module": [[0, "aapi-sitestandarddata-module"]], "aapi.sitestandardoperatorvalueoptions module": [[0, "aapi-sitestandardoperatorvalueoptions-module"]], "aapi.sitestandardpolicy module": [[0, "aapi-sitestandardpolicy-module"]], "aapi.sitestandardpolicydata module": [[0, "aapi-sitestandardpolicydata-module"]], "aapi.sitestandardpossiblevalue module": [[0, "aapi-sitestandardpossiblevalue-module"]], "aapi.sitestandardrestriction module": [[0, "aapi-sitestandardrestriction-module"]], "aapi.steprange module": [[0, "aapi-steprange-module"]], "aapi.tag module": [[0, "aapi-tag-module"]], "aapi.time module": [[0, "aapi-time-module"]], "aapi.variable module": [[0, "aapi-variable-module"]], "aapi.waitforevents module": [[0, "aapi-waitforevents-module"]], "aapi.workloadflat module": [[0, "aapi-workloadflat-module"]], "aapi.workloadpolicy module": [[0, "aapi-workloadpolicy-module"]], "aapi.wpperiod module": [[0, "aapi-wpperiod-module"]], "aapi.year module": [[0, "aapi-year-module"]], "Module contents": [[0, "module-contents"], [1, "module-contents"], [3, "module-ctm_python_client"], [4, "module-ctm_python_client.core"], [5, "module-ctm_python_client.ext"]], "aapi.integration_factory package": [[1, "aapi-integration-factory-package"]], "aapi.integration_factory.connection_profiles module": [[1, "aapi-integration-factory-connection-profiles-module"]], "aapi.integration_factory.jobs module": [[1, "aapi-integration-factory-jobs-module"]], "Going Forward": [[2, "going-forward"]], "Useful Links": [[2, "useful-links"]], "Extending Control-M Python Client": [[2, "extending-control-m-python-client"]], "ctm_python_client package": [[3, "ctm-python-client-package"]], "ctm_python_client.core package": [[4, "ctm-python-client-core-package"]], "ctm_python_client.core.comm module": [[4, "module-ctm_python_client.core.comm"]], "ctm_python_client.core.credential module": [[4, "module-ctm_python_client.core.credential"]], "ctm_python_client.core.monitoring module": [[4, "module-ctm_python_client.core.monitoring"]], "ctm_python_client.core.workflow module": [[4, "ctm-python-client-core-workflow-module"]], "ctm_python_client.ext package": [[5, "ctm-python-client-ext-package"]], "ctm_python_client.ext.credential module": [[5, "module-ctm_python_client.ext.credential"]], "ctm_python_client.ext.viz module": [[5, "ctm-python-client-ext-viz-module"]], "Getting Started": [[6, "getting-started"]], "Environment": [[6, "environment"]], "Installation": [[6, "installation"]], "Installing via pip": [[6, "installing-via-pip"]], "Installing from source": [[6, "installing-from-source"]], "Control-M Python Client Documentation": [[7, "control-m-python-client-documentation"]], "Contents:": [[7, null]], "References:": [[7, null]], "Working with Application Integrator": [[8, "Working-with-Application-Integrator"]], "Building Custom Application Integrator Job Types with AIJob": [[8, "Building-Custom-Application-Integrator-Job-Types-with-AIJob"]], "Authentication": [[9, "Authentication"]], "Environments": [[9, "Environments"]], "Credentials": [[9, "Credentials"]], "Auto generation of AI Plugins with Control-M Workbench": [[10, "Auto-generation-of-AI-Plugins-with-Control-M-Workbench"]], "Connection Profiles": [[11, "Connection-Profiles"]], "ConnectionProfileHadoop": [[11, "ConnectionProfileHadoop"]], "ConnectionProfileFileTransfer": [[11, "ConnectionProfileFileTransfer"]], "ConnectionProfileFileTransferFTP": [[11, "ConnectionProfileFileTransferFTP"]], "ConnectionProfileFileTransferSFTP": [[11, "ConnectionProfileFileTransferSFTP"]], "ConnectionProfileFileTransferFTPS": [[11, "ConnectionProfileFileTransferFTPS"]], "ConnectionProfileFileTransferLocal": [[11, "ConnectionProfileFileTransferLocal"]], "ConnectionProfileFileTransferS3Amazon": [[11, "ConnectionProfileFileTransferS3Amazon"]], "ConnectionProfileFileTransferS3Compatible": [[11, "ConnectionProfileFileTransferS3Compatible"]], "ConnectionProfileFileTransferAS2": [[11, "ConnectionProfileFileTransferAS2"]], "ConnectionProfileDatabase": [[11, "ConnectionProfileDatabase"]], "ConnectionProfileDatabaseDB2": [[11, "ConnectionProfileDatabaseDB2"]], "ConnectionProfileDatabaseJDBC": [[11, "ConnectionProfileDatabaseJDBC"]], "ConnectionProfileDatabaseMSSql": [[11, "ConnectionProfileDatabaseMSSql"]], "ConnectionProfileDatabaseOracleSID": [[11, "ConnectionProfileDatabaseOracleSID"]], "ConnectionProfileDatabaseOracleServiceName": [[11, "ConnectionProfileDatabaseOracleServiceName"]], "ConnectionProfileDatabaseOracleConnectionString": [[11, "ConnectionProfileDatabaseOracleConnectionString"]], "ConnectionProfileDatabasePostgreSql": [[11, "ConnectionProfileDatabasePostgreSql"]], "ConnectionProfileDatabaseSybase": [[11, "ConnectionProfileDatabaseSybase"]], "ConnectionProfileSAP": [[11, "ConnectionProfileSAP"]], "ConnectionProfileInformatica": [[11, "ConnectionProfileInformatica"]], "ConnectionProfileAWS": [[11, "ConnectionProfileAWS"]], "ConnectionProfileAzure": [[11, "ConnectionProfileAzure"]], "Folders": [[12, "Folders"]], "Folder": [[12, "Folder"]], "Examples": [[12, "Examples"], [12, "id1"]], "SubFolder": [[12, "SubFolder"]], "Arguments": [[12, "Arguments"]], "Getting Started with Control-M Python Client": [[13, "Getting-Started-with-Control-M-Python-Client"]], "Creating a Workflow": [[13, "Creating-a-Workflow"]], "Adding Jobs in the Workflow": [[13, "Adding-Jobs-in-the-Workflow"]], "Building and Deploying": [[13, "Building-and-Deploying"]], "Running and checking the output": [[13, "Running-and-checking-the-output"]], "Flows": [[13, "Flows"]], "Adding jobs without connection": [[13, "Adding-jobs-without-connection"]], "Connecting two Jobs": [[13, "Connecting-two-Jobs"]], "Chaining Jobs": [[13, "Chaining-Jobs"]], "Dummy Jobs and run_as_dummy": [[13, "Dummy-Jobs-and-run_as_dummy"]], "Job and Folder Properties": [[14, "Job-and-Folder-Properties"]], "When": [[14, "When"]], "If": [[14, "If"]], "IfCompletionStatus": [[14, "IfCompletionStatus"]], "IfNumberOfReruns": [[14, "IfNumberOfReruns"]], "IfNumberOfFailures": [[14, "IfNumberOfFailures"]], "IfJobNotSubmitted": [[14, "IfJobNotSubmitted"]], "IfJobOutputNotFound": [[14, "IfJobOutputNotFound"]], "IfNumberOfExecutions": [[14, "IfNumberOfExecutions"]], "IfOutput": [[14, "IfOutput"]], "IfVariableValue": [[14, "IfVariableValue"]], "If Actions": [[14, "If-Actions"]], "ActionMail": [[14, "ActionMail"]], "ActionRerun": [[14, "ActionRerun"]], "ActionSet": [[14, "ActionSet"]], "ActionSetToOk": [[14, "ActionSetToOk"]], "ActionSetToNotOK": [[14, "ActionSetToNotOK"]], "ActionStopCyclicRun": [[14, "ActionStopCyclicRun"]], "ActionRun": [[14, "ActionRun"]], "ActionNotify": [[14, "ActionNotify"]], "ActionRemedy": [[14, "ActionRemedy"]], "ActionOutput": [[14, "ActionOutput"]], "Notify": [[14, "Notify"]], "NotifyOk": [[14, "NotifyOk"]], "NotifyNotOk": [[14, "NotifyNotOk"]], "NotifyDoesNotStart": [[14, "NotifyDoesNotStart"]], "NotifyExecutionTime": [[14, "NotifyExecutionTime"]], "NotifyDoesNotEnd": [[14, "NotifyDoesNotEnd"]], "NotifyReRun": [[14, "NotifyReRun"]], "NotifyLateCyclicSubmit": [[14, "NotifyLateCyclicSubmit"]], "Resources": [[14, "Resources"]], "ResourcePool": [[14, "ResourcePool"]], "ResourceLock": [[14, "ResourceLock"]], "Rerun": [[14, "Rerun"]], "Variables": [[14, "Variables"]], "Events": [[14, "Events"]], "WaitForEvents": [[14, "WaitForEvents"]], "AddEvents": [[14, "AddEvents"]], "DeleteEvents": [[14, "DeleteEvents"]], "Job types": [[15, "Job-types"]], "JobCommand": [[15, "JobCommand"]], "JobScript": [[15, "JobScript"]], "JobEmbeddedScript": [[15, "JobEmbeddedScript"]], "JobFileTransfer": [[15, "JobFileTransfer"]], "JobFileWatcherCreate": [[15, "JobFileWatcherCreate"]], "JobFileWatcherDelete": [[15, "JobFileWatcherDelete"]], "JobDatabaseEmbeddedQuery": [[15, "JobDatabaseEmbeddedQuery"]], "JobDatabaseSQLScript": [[15, "JobDatabaseSQLScript"]], "JobDatabaseStoredProcedure": [[15, "JobDatabaseStoredProcedure"]], "JobDatabaseMSSQLAgentJob": [[15, "JobDatabaseMSSQLAgentJob"]], "JobDatabaseMSSQL_SSIS": [[15, "JobDatabaseMSSQL_SSIS"]], "JobHadoopSparkPython": [[15, "JobHadoopSparkPython"]], "JobHadoopSparkScalaJava": [[15, "JobHadoopSparkScalaJava"]], "JobHadoopPig": [[15, "JobHadoopPig"]], "JobHadoopSqoop": [[15, "JobHadoopSqoop"]], "JobHadoopHive": [[15, "JobHadoopHive"]], "JobHadoopDistCp": [[15, "JobHadoopDistCp"]], "JobHadoopHDFSCommands": [[15, "JobHadoopHDFSCommands"]], "JobHadoopHDFSFileWatcher": [[15, "JobHadoopHDFSFileWatcher"]], "JobHadoopOozie": [[15, "JobHadoopOozie"]], "JobHadoopMapReduce": [[15, "JobHadoopMapReduce"]], "JobHadoopMapredStreaming": [[15, "JobHadoopMapredStreaming"]], "JobHadoopTajoInputFile": [[15, "JobHadoopTajoInputFile"]], "JobHadoopTajoQuery": [[15, "JobHadoopTajoQuery"]], "JobPeopleSoft": [[15, "JobPeopleSoft"]], "JobInformatica": [[15, "JobInformatica"]], "JobAWSLambda": [[15, "JobAWSLambda"]], "JobAWSStepFunction": [[15, "JobAWSStepFunction"]], "JobAWSBatch": [[15, "JobAWSBatch"]], "JobAzureFunction": [[15, "JobAzureFunction"]], "JobAzureLogicApps": [[15, "JobAzureLogicApps"]], "JobAzureBatchAccount": [[15, "JobAzureBatchAccount"]], "JobWebServices": [[15, "JobWebServices"]], "JobSLAManagement": [[15, "JobSLAManagement"]], "JobZOS": [[15, "JobZOS"]], "Monitoring Flows with Control-M Python Client": [[16, "Monitoring-Flows-with-Control-M-Python-Client"]], "Running a Workflow": [[16, "Running-a-Workflow"]], "Checking the Status": [[16, "Checking-the-Status"]], "Getting the Status of a Specific Job or Folder": [[16, "Getting-the-Status-of-a-Specific-Job-or-Folder"]], "Errors and Troubleshooting": [[16, "Errors-and-Troubleshooting"]], "Tutorials": [[17, "tutorials"]], "Notebooks:": [[17, null]]}, "indexentries": {"ctm_python_client": [[3, "module-ctm_python_client"]], "module": [[3, "module-ctm_python_client"], [4, "module-ctm_python_client.core"], [4, "module-ctm_python_client.core.comm"], [4, "module-ctm_python_client.core.credential"], [4, "module-ctm_python_client.core.monitoring"], [5, "module-ctm_python_client.ext"], [5, "module-ctm_python_client.ext.credential"]], "aapiclientresponse (class in ctm_python_client.core.comm)": [[4, "ctm_python_client.core.comm.AAPIClientResponse"]], "abstractaapiclient (class in ctm_python_client.core.comm)": [[4, "ctm_python_client.core.comm.AbstractAAPIClient"]], "abstractcredentials (class in ctm_python_client.core.credential)": [[4, "ctm_python_client.core.credential.AbstractCredentials"]], "environment (class in ctm_python_client.core.comm)": [[4, "ctm_python_client.core.comm.Environment"]], "environmentmode (class in ctm_python_client.core.comm)": [[4, "ctm_python_client.core.comm.EnvironmentMode"]], "inputpasswordcredentials (class in ctm_python_client.core.credential)": [[4, "ctm_python_client.core.credential.InputPasswordCredentials"]], "monitor (class in ctm_python_client.core.monitoring)": [[4, "ctm_python_client.core.monitoring.Monitor"]], "onprem (ctm_python_client.core.comm.environmentmode attribute)": [[4, "ctm_python_client.core.comm.EnvironmentMode.ONPREM"]], "onpremaapiclient (class in ctm_python_client.core.comm)": [[4, "ctm_python_client.core.comm.OnPremAAPIClient"]], "runmonitor (class in ctm_python_client.core.monitoring)": [[4, "ctm_python_client.core.monitoring.RunMonitor"]], "saas (ctm_python_client.core.comm.environmentmode attribute)": [[4, "ctm_python_client.core.comm.EnvironmentMode.SAAS"]], "saasaapiclient (class in ctm_python_client.core.comm)": [[4, "ctm_python_client.core.comm.SaasAAPIClient"]], "simplecredentials (class in ctm_python_client.core.credential)": [[4, "ctm_python_client.core.credential.SimpleCredentials"]], "workbench (ctm_python_client.core.comm.environmentmode attribute)": [[4, "ctm_python_client.core.comm.EnvironmentMode.WORKBENCH"]], "authenticate() (ctm_python_client.core.comm.abstractaapiclient class method)": [[4, "ctm_python_client.core.comm.AbstractAAPIClient.authenticate"]], "authenticate() (ctm_python_client.core.comm.onpremaapiclient method)": [[4, "ctm_python_client.core.comm.OnPremAAPIClient.authenticate"]], "authenticate() (ctm_python_client.core.comm.saasaapiclient method)": [[4, "ctm_python_client.core.comm.SaasAAPIClient.authenticate"]], "confirm_job() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.confirm_job"]], "confirm_job() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.confirm_job"]], "create_onprem() (ctm_python_client.core.comm.environment static method)": [[4, "ctm_python_client.core.comm.Environment.create_onprem"]], "create_saas() (ctm_python_client.core.comm.environment static method)": [[4, "ctm_python_client.core.comm.Environment.create_saas"]], "create_workbench() (ctm_python_client.core.comm.environment static method)": [[4, "ctm_python_client.core.comm.Environment.create_workbench"]], "ctm_python_client.core": [[4, "module-ctm_python_client.core"]], "ctm_python_client.core.comm": [[4, "module-ctm_python_client.core.comm"]], "ctm_python_client.core.credential": [[4, "module-ctm_python_client.core.credential"]], "ctm_python_client.core.monitoring": [[4, "module-ctm_python_client.core.monitoring"]], "delete_job() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.delete_job"]], "delete_job() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.delete_job"]], "get_jobid() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.get_jobid"]], "get_log() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.get_log"]], "get_log() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.get_log"]], "get_output() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.get_output"]], "get_output() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.get_output"]], "get_password() (ctm_python_client.core.credential.abstractcredentials class method)": [[4, "ctm_python_client.core.credential.AbstractCredentials.get_password"]], "get_password() (ctm_python_client.core.credential.inputpasswordcredentials method)": [[4, "ctm_python_client.core.credential.InputPasswordCredentials.get_password"]], "get_password() (ctm_python_client.core.credential.simplecredentials method)": [[4, "ctm_python_client.core.credential.SimpleCredentials.get_password"]], "get_status() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.get_status"]], "get_statuses() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.get_statuses"]], "get_statuses() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.get_statuses"]], "get_username() (ctm_python_client.core.credential.abstractcredentials class method)": [[4, "ctm_python_client.core.credential.AbstractCredentials.get_username"]], "get_username() (ctm_python_client.core.credential.inputpasswordcredentials method)": [[4, "ctm_python_client.core.credential.InputPasswordCredentials.get_username"]], "get_username() (ctm_python_client.core.credential.simplecredentials method)": [[4, "ctm_python_client.core.credential.SimpleCredentials.get_username"]], "hold_job() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.hold_job"]], "hold_job() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.hold_job"]], "is_ok() (ctm_python_client.core.comm.aapiclientresponse method)": [[4, "ctm_python_client.core.comm.AAPIClientResponse.is_ok"]], "kill_job() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.kill_job"]], "kill_job() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.kill_job"]], "open_in_browser() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.open_in_browser"]], "print_output() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.print_output"]], "print_statuses() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.print_statuses"]], "release_job() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.release_job"]], "release_job() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.release_job"]], "rerun_job() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.rerun_job"]], "rerun_job() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.rerun_job"]], "set_to_ok() (ctm_python_client.core.monitoring.monitor method)": [[4, "ctm_python_client.core.monitoring.Monitor.set_to_ok"]], "set_to_ok() (ctm_python_client.core.monitoring.runmonitor method)": [[4, "ctm_python_client.core.monitoring.RunMonitor.set_to_ok"]], "keyringcredentials (class in ctm_python_client.ext.credential)": [[5, "ctm_python_client.ext.credential.KeyringCredentials"]], "ctm_python_client.ext": [[5, "module-ctm_python_client.ext"]], "ctm_python_client.ext.credential": [[5, "module-ctm_python_client.ext.credential"]], "get_password() (ctm_python_client.ext.credential.keyringcredentials method)": [[5, "ctm_python_client.ext.credential.KeyringCredentials.get_password"]], "get_username() (ctm_python_client.ext.credential.keyringcredentials method)": [[5, "ctm_python_client.ext.credential.KeyringCredentials.get_username"]]}}) \ No newline at end of file diff --git a/docs_source/source/notebooks/jobtypes.ipynb b/docs_source/source/notebooks/jobtypes.ipynb index 1e6716f..9c789da 100644 --- a/docs_source/source/notebooks/jobtypes.ipynb +++ b/docs_source/source/notebooks/jobtypes.ipynb @@ -9,7 +9,7 @@ }, { "cell_type": "code", - "execution_count": 40, + "execution_count": 1, "metadata": {}, "outputs": [], "source": [ @@ -35,7 +35,7 @@ }, { "cell_type": "code", - "execution_count": 41, + "execution_count": 2, "metadata": {}, "outputs": [], "source": [ @@ -44,7 +44,7 @@ }, { "cell_type": "code", - "execution_count": 42, + "execution_count": 3, "metadata": {}, "outputs": [], "source": [ @@ -81,7 +81,7 @@ }, { "cell_type": "code", - "execution_count": 43, + "execution_count": 4, "metadata": {}, "outputs": [], "source": [ @@ -90,7 +90,7 @@ }, { "cell_type": "code", - "execution_count": 44, + "execution_count": 5, "metadata": {}, "outputs": [], "source": [ @@ -122,7 +122,7 @@ }, { "cell_type": "code", - "execution_count": 45, + "execution_count": 6, "metadata": {}, "outputs": [], "source": [ @@ -160,7 +160,7 @@ }, { "cell_type": "code", - "execution_count": 46, + "execution_count": 7, "metadata": {}, "outputs": [], "source": [ @@ -180,7 +180,7 @@ }, { "cell_type": "code", - "execution_count": 47, + "execution_count": 8, "metadata": {}, "outputs": [], "source": [ @@ -206,7 +206,7 @@ }, { "cell_type": "code", - "execution_count": 48, + "execution_count": 9, "metadata": {}, "outputs": [], "source": [ @@ -235,7 +235,7 @@ }, { "cell_type": "code", - "execution_count": 49, + "execution_count": 10, "metadata": {}, "outputs": [], "source": [ @@ -275,7 +275,7 @@ }, { "cell_type": "code", - "execution_count": 50, + "execution_count": 11, "metadata": {}, "outputs": [], "source": [ @@ -313,7 +313,7 @@ }, { "cell_type": "code", - "execution_count": 51, + "execution_count": 12, "metadata": {}, "outputs": [], "source": [ @@ -348,7 +348,7 @@ }, { "cell_type": "code", - "execution_count": 52, + "execution_count": 13, "metadata": {}, "outputs": [], "source": [ @@ -383,7 +383,7 @@ }, { "cell_type": "code", - "execution_count": 53, + "execution_count": 14, "metadata": {}, "outputs": [], "source": [ @@ -420,7 +420,7 @@ }, { "cell_type": "code", - "execution_count": 54, + "execution_count": 15, "metadata": {}, "outputs": [], "source": [ @@ -465,7 +465,7 @@ }, { "cell_type": "code", - "execution_count": 55, + "execution_count": 16, "metadata": {}, "outputs": [], "source": [ @@ -476,7 +476,7 @@ }, { "cell_type": "code", - "execution_count": 56, + "execution_count": 17, "metadata": {}, "outputs": [], "source": [ @@ -504,7 +504,7 @@ }, { "cell_type": "code", - "execution_count": 57, + "execution_count": 18, "metadata": {}, "outputs": [], "source": [ @@ -527,7 +527,7 @@ }, { "cell_type": "code", - "execution_count": 58, + "execution_count": 19, "metadata": {}, "outputs": [], "source": [ @@ -549,7 +549,7 @@ }, { "cell_type": "code", - "execution_count": 59, + "execution_count": 20, "metadata": {}, "outputs": [], "source": [ @@ -575,7 +575,7 @@ }, { "cell_type": "code", - "execution_count": 60, + "execution_count": 21, "metadata": {}, "outputs": [], "source": [ @@ -598,7 +598,7 @@ }, { "cell_type": "code", - "execution_count": 61, + "execution_count": 22, "metadata": {}, "outputs": [], "source": [ @@ -623,7 +623,7 @@ }, { "cell_type": "code", - "execution_count": 62, + "execution_count": 23, "metadata": {}, "outputs": [], "source": [ @@ -646,7 +646,7 @@ }, { "cell_type": "code", - "execution_count": 63, + "execution_count": 24, "metadata": {}, "outputs": [], "source": [ @@ -670,7 +670,7 @@ }, { "cell_type": "code", - "execution_count": 64, + "execution_count": 25, "metadata": {}, "outputs": [], "source": [ @@ -694,7 +694,7 @@ }, { "cell_type": "code", - "execution_count": 65, + "execution_count": 26, "metadata": {}, "outputs": [], "source": [ @@ -720,7 +720,7 @@ }, { "cell_type": "code", - "execution_count": 66, + "execution_count": 27, "metadata": {}, "outputs": [], "source": [ @@ -749,7 +749,7 @@ }, { "cell_type": "code", - "execution_count": 67, + "execution_count": 28, "metadata": {}, "outputs": [], "source": [ @@ -775,7 +775,7 @@ }, { "cell_type": "code", - "execution_count": 68, + "execution_count": 29, "metadata": {}, "outputs": [], "source": [ @@ -810,7 +810,7 @@ }, { "cell_type": "code", - "execution_count": 69, + "execution_count": 30, "metadata": {}, "outputs": [], "source": [ @@ -853,7 +853,7 @@ }, { "cell_type": "code", - "execution_count": 70, + "execution_count": 31, "metadata": {}, "outputs": [], "source": [ @@ -894,7 +894,7 @@ }, { "cell_type": "code", - "execution_count": 71, + "execution_count": 32, "metadata": {}, "outputs": [], "source": [ @@ -931,7 +931,7 @@ }, { "cell_type": "code", - "execution_count": 72, + "execution_count": 33, "metadata": {}, "outputs": [], "source": [ @@ -976,7 +976,7 @@ }, { "cell_type": "code", - "execution_count": 73, + "execution_count": 34, "metadata": {}, "outputs": [], "source": [ @@ -1023,7 +1023,7 @@ }, { "cell_type": "code", - "execution_count": 74, + "execution_count": 35, "metadata": {}, "outputs": [], "source": [ @@ -1061,15 +1061,15 @@ }, { "cell_type": "code", - "execution_count": 75, + "execution_count": 36, "metadata": {}, "outputs": [], "source": [ "job = JobAzureLogicApps('JobAzureLogicAppsSample',\n", " connection_profile='CPAZURE',\n", - " logic_app_name='logic_app',\n", - " request_body='{\"name\":\"value\"}',\n", - " append_log=True)" + " workflow='workflow_app',\n", + " parameters='{\"name\":\"value\"}'\n", + " )" ] }, { @@ -1098,7 +1098,7 @@ }, { "cell_type": "code", - "execution_count": 76, + "execution_count": 37, "metadata": {}, "outputs": [], "source": [ @@ -1131,7 +1131,7 @@ }, { "cell_type": "code", - "execution_count": 77, + "execution_count": 38, "metadata": {}, "outputs": [], "source": [ @@ -1196,7 +1196,7 @@ }, { "cell_type": "code", - "execution_count": 78, + "execution_count": 39, "metadata": {}, "outputs": [], "source": [ @@ -1212,6 +1212,45 @@ " units=JobSLAManagement.AverageRunTimeTolerance.Units.Minutes\n", " ))\n" ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## JobZOS\n", + "\n", + "[AutomationAPI Documentation](https://documents.bmc.com/supportu/API/Monthly/en-US/Documentation/API_CodeRef_JobTypes_zOS.htm?Highlight=zos)" + ] + }, + { + "cell_type": "code", + "execution_count": 40, + "metadata": {}, + "outputs": [], + "source": [ + "job = JobZOSMember('JobZOSMemberSample', \n", + " member_library='IOAQ.AAPI#AU.JCL',\n", + " archiving=JobZOS.Archiving(archive_sys_data=True),\n", + " must_end=JobZOS.MustEnd(hours='1', minutes='15', days=1),\n", + " run_on_all_agents_in_group=True\n", + " )\n" + ] + }, + { + "cell_type": "code", + "execution_count": 41, + "metadata": {}, + "outputs": [], + "source": [ + "job = JobZOSInStreamJCL('JobZOInStreamJCLSample', \n", + " member_library='IOAQ.AAPI#AU.JCL',\n", + " jcl=\"//AUTEST0 JOB ,ASM,CLASS=A,REGION=0M\\\\n// JCLLIB ORDER=IOAQ.AAPI#AU.PROCLIB\\\\n// INCLUDE MEMBER=IOASET\\\\n//S1 EXEC IOATEST,PARM='TERM=C0000'\",\n", + " archiving=JobZOS.Archiving(archive_sys_data=True),\n", + " run_on_all_agents_in_group=True,\n", + " created_by='workbench',\n", + " run_as='workbench'\n", + " )" + ] } ], "metadata": { @@ -1233,7 +1272,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.10.4" + "version": "3.8.9" }, "orig_nbformat": 4 },