W o r kl o a d A u t o m a ti o n o n Cl o u d Ov e rvi e w · 2020-05-19 · Defining a job ..... . 9 Scheduling and submitting jobs and job str eams . . 9 ... Cloud job statuses

Workload Automation on Cloud Overview

IBM

ii Workload Automation on Cloud Overview

Contents

Chapter 1. Introducing WorkloadAutomation on Cloud . . . . . . . . . 1

Chapter 2. Workload Automation onCloud user interfaces . . . . . . . . . 3

Chapter 3. Hybrid schedulingenvironment . . . . . . . . . . . . . 5

Chapter 4. Automate businessprocesses . . . . . . . . . . . . . . 7Defining a job . . . . . . . . . . . . . . 9Scheduling and submitting jobs and job streams . . 9Monitoring Workload Automation on Cloud jobs . . 10Analyzing the job log . . . . . . . . . . . 10Return codes . . . . . . . . . . . . . . 11Remote command jobs. . . . . . . . . . . 12IBM i jobs . . . . . . . . . . . . . . . 12Executable jobs . . . . . . . . . . . . . 14SAP jobs . . . . . . . . . . . . . . . 15

Creating SAP Standard R/3 jobs from theDynamic Workload Console . . . . . . . . 15Setting the SAP data connection . . . . . . 19Managing SAP variants using the DynamicWorkload Console . . . . . . . . . . . 20Editing a standard SAP job . . . . . . . . 23Task string to define SAP jobs . . . . . . . 24Defining SAP jobs dynamically . . . . . . . 32Managing SAP R/3 Business WarehouseInfoPackages and process chains . . . . . . 46Configuring the tracing utility . . . . . . . 58

SAP Process Integration (PI) Channel jobs . . . . 58Business scenario . . . . . . . . . . . 58Prerequisites . . . . . . . . . . . . . 59Job definition for SAP PI Channel jobs . . . . 60Submitting Workload Automation on Cloud jobstreams for SAP PI Channel jobs . . . . . . 60Mapping between IBM Workload Scheduler andSAP PI Channel job statuses . . . . . . . . 60Job log output . . . . . . . . . . . . 60

Oracle E-Business Suite jobs . . . . . . . . . 61Business scenario . . . . . . . . . . . 62Defining Workload Automation on Cloud jobs torun Oracle E-Business Suite jobs by using theDynamic Workload Console . . . . . . . . 62Scheduling and submitting job streams for OracleE-Business Suite jobs . . . . . . . . . . 63Customizing Workload Automation on Cloud torun Oracle E-Business Suite jobs . . . . . . 64Mapping between Workload Automation onCloud job statuses and Oracle E-Business Suiteapplication statuses . . . . . . . . . . . 65Job log output . . . . . . . . . . . . 66

Analyzing the Oracle E-Business Suite jobproperties . . . . . . . . . . . . . . 67

Access method jobs. . . . . . . . . . . . 67SAP BusinessObjects BI jobs . . . . . . . . . 67Salesforce jobs . . . . . . . . . . . . . 72OpenWhisk jobs . . . . . . . . . . . . . 77Prerequisite steps to create Provisioning jobs . . . 79

IBM SmartCloud Provisioning jobs . . . . . 79Shadow jobs . . . . . . . . . . . . . . 80File transfer jobs . . . . . . . . . . . . . 81IBM Sterling Connect:Direct jobs . . . . . . . 83

Business scenario . . . . . . . . . . . 88Hadoop Distributed File System jobs . . . . . . 89OSLC Automation and OSLC Provisioning jobs . . 91Database jobs . . . . . . . . . . . . . . 91IBM WebSphere MQ jobs . . . . . . . . . . 92

Business scenario . . . . . . . . . . . 94Web services jobs . . . . . . . . . . . . 95RESTful Web Services jobs . . . . . . . . . 96Java jobs . . . . . . . . . . . . . . . 98J2EE jobs . . . . . . . . . . . . . . . 98JSR 352 Java Batch . . . . . . . . . . . . 99MQTT . . . . . . . . . . . . . . . . 100IBM InfoSphere DataStage jobs . . . . . . . 101

Business scenario . . . . . . . . . . . 101Defining Workload Automation on Cloud jobsto run IBM InfoSphere DataStage jobs by usingthe Dynamic Workload Console . . . . . . 102Customizing Workload Automation on Cloud torun IBM InfoSphere DataStage jobs . . . . . 103Mapping between Workload Automation onCloud and IBM InfoSphere DataStage jobstatuses . . . . . . . . . . . . . . 104Job log output . . . . . . . . . . . . 105Analyzing the InfoSphere DataStage jobproperties . . . . . . . . . . . . . 106

IBM Cognos jobs . . . . . . . . . . . . 107Business scenario . . . . . . . . . . . 107Defining jobs by using the Dynamic WorkloadConsole . . . . . . . . . . . . . . 107Scheduling and submitting job streams for IBMCognos reports . . . . . . . . . . . . 110Customizing Workload Automation on Cloud torun IBM Cognos reports . . . . . . . . . 110Configuring the agent to use Cognos in SSL . . 112Mapping between job statuses and IBM Cognosreport statuses . . . . . . . . . . . . 114Job log output . . . . . . . . . . . . 114

Informatica PowerCenter jobs . . . . . . . . 116Defining Workload Automation on Cloud jobsto schedule Informatica PowerCenter workflowswith the Dynamic Workload Console . . . . 116Customizing Workload Automation on Cloud torun Informatica PowerCenter jobs . . . . . 118Configuring the agent for SSL . . . . . . . 119

iii

Scheduling and submitting job streams forPowerCenter jobs . . . . . . . . . . . 120Monitoring Workload Automation on Cloudjobs that run Informatica PowerCenterworkflows . . . . . . . . . . . . . 120Known problems and workarounds . . . . . 122

Hadoop Map Reduce jobs . . . . . . . . . 123Apache Oozie jobs. . . . . . . . . . . . 125Apache Spark jobs. . . . . . . . . . . . 127Amazon EC2 jobs . . . . . . . . . . . . 129IBM SoftLayer jobs . . . . . . . . . . . 132

Microsoft Azure jobs . . . . . . . . . . . 134IBM BigInsights jobs . . . . . . . . . . . 137IBM Cloudant jobs . . . . . . . . . . . 139Variable Table jobs. . . . . . . . . . . . 141Job Management jobs. . . . . . . . . . . 142Job Stream Submission jobs. . . . . . . . . 143Driving Workload Automation on Cloud withREST API . . . . . . . . . . . . . . 144

Index . . . . . . . . . . . . . . . 145

iv Workload Automation on Cloud Overview

Chapter 1. Introducing Workload Automation on Cloud

IBM Workload Automation automates, monitors and controls workflow throughoutthe enterprise IT infrastructure. This leading software automation tool can managehundreds of thousands of workloads a day from a single point of control. It helpsyou better align IT with business objectives to improve performance and reducecosts.

Establish an enterprise workload automation backbone by driving compositeworkloads with pre-packaged applications

Workload Automation on Cloud is a complete solution for workloadautomation hosted in the cloud. Use it to gain flexibility to drive workloadon hosted servers, seamlessly with no cost of ownership for your centralserver. Interfaces dedicated to persons with different business focus, likeapplication developers and operators, provide power and autonomywithout having to delve into complicated details. At the same time, tohandle complicated cases and deeply customized processes, they canexploit all the power and flexibility of the complete IBM WorkloadAutomation family. Granular security rights and mobile presentationinterfaces help improve the relationship between application teams andbusiness operations as they work through different interfaces on the samemodel. Use Workload Automation on Cloud to:v Shift investment to innovation by lowering total cost of ownership.v Deliver faster access to service management solutions.v Increase speed and efficiency with instant and ongoing scalability on the

hosting platform, SoftLayer.

1

A solution for youWorkload Automation on Cloud exploits the cloud infrastructure to helpyou to learn by viewing screenshots and in-depth capability videos, toexplore by exercising specific scenarios by using live demos, and to try theofferings with user data through a free trial. The Cloud offering containssimple starter applications to cover immediate customer needs. Thesestarter applications provide you with business value and do not requireyou to learn concepts from workload automation, such as the flow ofexecution or the writing of conditions. You can create and handle suchapplications with dedicated trimmed down interfaces. As your needsbecome more complex, you can learn the powerful concepts of workloadautomation to write business processes directly into the product. UseWorkload Automation on Cloud to address complexity challenges withoutany substantial up-front investment. Workload Automation on Cloud is thesolution for:v Agile divisions inside large Fortune 500 companies that have the

autonomy to choose their solution for automation and efficiencyoptimizations.

v Customers wanting to move out of a competitive solution but who areworried about the IT investment.

v Companies with a high awareness of the value-generating part of theirbusiness that want to keep only that value-generating part, trim downall other expenses, and receive them as a service.

The value you gainUse Workload Automation on Cloud to have:v Immediate access to default applications to solve common problems and

learn more advanced uses.v No up-front CAPEX investment on hardware and software licenses and

no installation and upgrade costs. Low, predictable, flat-cost model withno up-front software acquisition charges.

v Lower skill requirements because IBM assumes the infrastructuresupport role.

v Lower total cost of ownership (TCO) due to reduced deployment,administration, training, and integration costs.

v Ability to achieve flexibility and risk mitigation by utilizing the Cloudmodel as a simple trial option before moving to full on-premiseadoption.

v Enhanced time to value with a single installation and maintenanceprocess.

v Reduced complexity and increased convenience. IBM takes care ofupkeep, patches, and upgrades, allowing clients to focus on other workand maintain a lean IT organization.

v Faster time to value through preconfigured, rapidly deployable instancesand quick start content and capabilities, as well as predefined, fixed costimplementation packages.

2 Workload Automation on Cloud Overview

Chapter 2. Workload Automation on Cloud user interfaces

A combination of graphical and command-line and API interface programs areprovided to work with IBM Workload Scheduler. In particular, the command-lineinterface is available for certain advanced features which are not available in thegraphical user interface. The available Workload Automation on Cloud userinterface programs are:

Single Entry PointSingle Entry Point is a web-based page to access all the user interfaces:v Dynamic Workload Consolev Self Service UIs (Self-Service Catalog and Self-Service Dashboards)v Application Lab

Single Entry Point is a role-based interface that you can access from anycomputer in your environment by using a web browser through the secureHTTPS.

Single Entry Point provides quick links to the most important DynamicWorkload Console tasks: connect your engines, design your workload,monitor your workload, and dashboard. With Single Entry Point you canaccess the mobile applications, the Self-Service Catalog and the Self-ServiceDashboards, through the link or the Qrcode. To access the Application Labyou must add configuration settings to define your engine and yourenvironment ID. The environment ID is defined by the Administratorswhen they configure access to the Application Lab in the security file andit is identified by a two-letter prefix.

Dynamic Workload ConsoleA Web-based user interface available for viewing and controllingscheduling activities in production on both the IBM Workload Schedulerdistributed and z/OS environments. With the Dynamic Workload Consoleyou can use any supported browser to access the Workload Automation onCloud environment from any location in your network.

You can use the Dynamic Workload Console to:v Define scheduling objects in the Workload Automation on Cloud

databasev Browse and manage scheduling objects involved in current plan

activitiesv Create and control connections to Workload Automation on Cloud

environmentsv Submit jobs and job streams in productionv Set user preferencesv Create and manage event rulesv Define and manage mission-critical jobs

Dynamic Workload Console must be installed on a server that can reachthe IBM Workload Scheduler nodes using network connections. See theIBM Workload Scheduler: Planning and Installation for information.

Application LabA Web-based user interface available for creating, running, and monitoringa set of simple business processes. It connects to an existing Dynamic

3

Workload Console distributed engine that is either shared or configured insingle sign-on. This interface is easy-to-use and is dedicated to applicationdevelopers who require control and autonomy when driving workloads,but that are not required to handle complex workload automationconcepts. It uses simplified terminology to express concepts like jobs, jobstreams, and run cycles. Application developers create their processes whichare made up of one or more steps. The processes can be scheduled to run(on dynamic agents only) according to the triggers defined for them. Youcan use any supported browser to access the Workload Automation onCloud environment from any location in your network through the secureHTTPS protocol. An administrator must enable users to access ApplicationLab through the definition of a working environment

You can use the Application Lab to:v Define a process to run any number of steps, where steps can perform

simple operations or integrate with external application to perform morecomplex operations. See the overview section in theIBM WorkloadAutomation: Application Lab User's Guide for more detailed informationabout the types of operations supported.

v Import existing crontab files or Windows Task Scheduler tasks andbenefit from the full set of IBM Workload Scheduler capabilities.

v Set up processes to run according to a scheduler.v Publish processes to the Self-Service Catalog and submit them to run on

demand from a mobile device.v Move your processes to the Dynamic Workload Console to run it with

more complex scheduling conditions.v Monitor the progress and status of processes.

Application Lab is not an installable component. It is accessed through aURL that connects to an existing Dynamic Workload Console engine. Anadministrator must perform some preparatory steps before applicationdevelopers can access and use Application Lab. See the IBM WorkloadAutomation: Application Lab User's Guide for information.


Chapter 3. Hybrid scheduling environment

Hybrid Workload Automation allows you to use a common User Interface tomanage both on premises and on Cloud engines. Manage Workload Automationon Cloud or On premises, or choose a mixture of both. You can monitor and runactions in plan on the following objects: job, critical job, workstation, resource,prompt, job stream, file, and domain.

A solution for youThe same workload efficiently managed in an on premises environmentcan be scheduled to run in a cloud environment. Workload Automation onCloud reduces IT infrastructure costs and is a solution for using resourcesonly when you have a business need to run your workload. You cantransfer your workload from your on premises environment to yourWorkload Automation on Cloud by using a simple import procedure. Theworkload is instantly reproduced and is ready to be employed on youragents. Handling your workload in a cloud environment is a more costeffective way of using resources in the cloud only when you need themwithout relying on an on premises infrastructure.

How to work with hybrid scheduling environmentTo work with the on Cloud engine from the on premises environment,define the engine connection in the Dynamic Workload Console by usingport 443. This setting allows you to work with the REST APIs needed formanaging Hybrid Workload Automation.

To transfer your on premises workload to the Workload Automation onCloud environment, complete the following steps:v Create a workload application template.v Export the workload application template.v Import the workload application template into the Workload Automation

on Cloud environment.

Create a workload application template containing the job streams that youwant to transfer and define some general information about the template,such as a name and description. Select the job streams, each containing oneor more jobs, that you want to add to your template. Select the exportaction and save the template in a compressed file format. The compressedfile contains all the files and information required to enable the workloadto run in the new cloud environment with some minimal customization toadapt the workload to the cloud environment.From the Workload Automation on Cloud dashboard, add the template toyour on Cloud environment by selecting Import a custom applicationaccess point and sign in with your IBM ID. Upload the compressedworkload application template file and select the agent on which to importit. You need only adjust two objects to adapt the workload to cloudenvironment: the prompt definition and the variable table. You mustrename both of these objects by prefixing their names with your WorkloadAutomation subscription environment ID. When the import processcompletes, the workload application is ready to be used in the on Cloudenvironment.

5

Chapter 4. Automate business processes

Automate your business processes by mapping them to Workload Automation onCloud steps, processes, jobs, and job streams.

Whether it be Application Lab steps and processes or Dynamic Workload Consolejobs and job streams, Workload Automation on Cloud provides you with dedicatedinterfaces to quickly connect your business applications and build connections toother tools and applications more easily through open integration. The job typesavailable can be used to accomplish a number of business tasks or to facilitateWorkload Automation on Cloud operations. They can be defined in steps inApplication Lab or in job definitions in the Dynamic Workload Console.

Tip: Many of the IBM Workload Scheduler job plug-ins are illustrated in helpful,how-to demonstrations videos available on the Workload Automation YouTubechannel.

In addition to job plug-ins, Workload Automation on Cloud provides a REST APIto help you easily integrate workload scheduling capabilities with externalproducts and solutions. See “Driving Workload Automation on Cloud with RESTAPI” on page 144 for more details.

The following job plug-ins or adapters are supported and can be defined in stepsand jobs:

This table shows the job typesCategory Job Type Description

Native Windows Jobs that run on Windows operating systems.

UNIX Jobs that run on UNIX platforms.

Other Jobs that run on extended agents. See Scheduling Applications with IBMWorkload Automation for information about customized task types forsupported vendor acquired applications.

Remote Command Jobs that run on remote computers the do not require an installation of theWorkload Automation on Cloud agent.

IBM® i Jobs that run a command on IBM i systems.

Executable Jobs that run scripts or commands with advanced options, such as redirectingstandard input and standard output to a file.

ERP SAP Job on XA Workstations Jobs that run on an SAP extended agent. This includes the three types of SAPR/3 job definitions:

v Standard R/3 job

v BW Process Chain job

v BW InfoPackage job

SAP Job on Dynamic Workstations Jobs that run on dynamic agent workstations, pools, dynamic pools, andz-centric agents. The following types of SAP job definition are available:

v Standard R/3 job

v BW Process Chain job

v BW InfoPackage job

Access Method Jobs that extend Workload Automation on Cloud environment. schedulingfunctions to other systems and applications using access methods. The accessmethods communicate with the external system to launch the job and returnthe status of the job. The following access methods are available:

v PeopleSoft

v SAP

v z/OS®

v Unixssh

v Custom methods

SAP PI Channel Jobs that run SAP Process Integration (PI) Channel jobs to controlcommunication channels between the Process Integrator and a backend SAPR/3 system.

7

https://www.youtube.com/user/workloadautomation2https://www.youtube.com/user/workloadautomation2

This table shows the job typesCategory Job Type Description

Cloud Workload Broker Jobs that manage the lifecycle of a dynamic workload broker job. Refer to IBMWorkload Scheduler Scheduling Workload Dynamically for information abouthow to use dynamic workload broker.

Provisioning Jobs that span physical computers, virtual machines, and private and publiccloud environments creating an on-demand environment. This job typeintegrates with IBM SmartCloud® Provisioning.

Salesforce Jobs that enable automation, monitor and control of Salesforce activities anddata. See Scheduling Applications with IBM Workload Automation forinformation

OpenWhisk Jobs that run an OpenWhisk operation, either an action or a trigger.

Apache Spark Jobs that enable automation, monitor and control of Apache Spark activitiesand data. See Scheduling Applications with IBM Workload Automation forinformation

Amazon EC2 Jobs that enable automation, monitor and control of Amazon EC2 activities.See Scheduling Applications with IBM Workload Automation for information

IBM SoftLayer Jobs that enable automation, monitor and control of IBM SoftLayer activities.See Scheduling Applications with IBM Workload Automation for information

Microsoft Azure Jobs that enable automation, monitor and control of Microsoft Azure activities.See Scheduling Applications with IBM Workload Automation for information

File Transfer andCoordination

Shadow Distributed Jobs that run locally and map other jobs running in remote WorkloadAutomation on Cloud environments.

File Transfer Jobs that run programs to transfer files to and from a server reachable usingFTP, SSH, or other protocols.

IBM Sterling Connect:Direct Jobs that run IBM Sterling Connect:Direct programs to transfer one or morefiles from one primary node to a secondary node.

Hadoop Distributed File System Jobs that define, schedule, monitor, and manage file transfer programsbetween your workstation and the Hadoop Distributed File System server.

OSLC OSLC Automation Jobs that invoke any OSLC provider that is implementing the OSLCAutomation Specification. Automation resources define automation plans,automation requests and automation results of the software development, testand deployment lifecycle.

OSLC Provisioning Jobs that invoke any OSLC provider, such as IBM Workload Scheduler andIBM SmartCloud Orchestrator, that is implementing the OSLC ProvisioningSpecification. Provisioning resources define provisioning plans, provisioningrequests and provisioning results of the software development, test anddeployment lifecycle.

Database andIntegrations

Database Jobs that run queries, SQL statements, and jobs on a number of databases,including custom databases. You can also create and run stored proceduresonDB2®, Oracle, and Microsoft SQL Server, Netezza® , Hive, BigSQLdatabases.

IBM Cloudant Jobs that run actions on the IBM Cloudant database, on its documents, orattachments.

MS SQL Jobs that run a Microsoft SQL Server job.

IBM WebSphere MQ Jobs that enable communications among applications that run in differentdistributed environment at different times. Communications are based on thefollowing message exchange patterns:

v Request/Response.

v Publish on queues or topics.

Web Services Jobs that run a web service.

RESTful Web Services Jobs that send requests via HTTP methods (PUT, POST, GET, HEAD) to Webresources.

Java™ Jobs that run a Java class.

J2EE Jobs that allow Java applications in the same network to send and receivemessages from and to a JMS destination.

JSR 352 Java Batch Jobs that run Java Batch applications that implement the JSR 352 standardprogramming specification.

MQTT Jobs that run publish and subscribe actions on topics managed by an MQTTmessage broker.

Business Analytics Cognos® Reports Jobs that run IBM Cognos reports, interactive reports, query, and report views.

InfoSphere® DataStage® Jobs that run IBM InfoSphere DataStage jobs.

Informatica PowerCenter Jobs that schedule Informatica PowerCenter workflows and track theiroutcome from theDynamic Workload Console.

Hadoop Map Reduce Jobs that define, schedule, monitor, and manage the execution of Hadoop MapReduce .jar files.

Apache Oozie Jobs that define, schedule, monitor, and manage the execution of ApacheOozie workflows and of the following Hadoop jobs:

v MapReduce

v Pig

v Hive

v Sqoop

IBM BigInsights Jobs that define, schedule, monitor, and manage IBM BigInsights Workbookdata sheets or Applications.

Automation Utilities

Jobs that facilitatespecific WorkloadAutomation on Cloudoperations

Centralized agent update Jobs that schedule the centralized update of multiple agent instances.

Variable Table Jobs that add or modify a variable in a specified variable table. The VariableTable jobs enable variable passing from one job to another, in the same jobstream or in a different job stream.

Job Management Jobs that run actions on a job in a job stream.

Job Stream Submission Jobs that submit a job stream for processing.


http://www-01.ibm.com/support/knowledgecenter/SSGSPN_9.4.0/com.ibm.tivoli.itws.doc_9.4/distr/src_swd/awsbrmst_welcome.htmlhttp://www-01.ibm.com/support/knowledgecenter/SSGSPN_9.4.0/com.ibm.tivoli.itws.doc_9.4/distr/src_swd/awsbrmst_welcome.html

For information about the job plug-in versions supported by the product, generatethe Data Integration report from the IBM software Product Compatibility Reportsweb site, and select the Supported Software tab.

Defining a jobDefine Workload Automation on Cloud jobs to run business tasks and processesdefined in an external application.

Define an Workload Automation on Cloud job to run tasks or processes you havedefined in external applications. Using the Workload Automation on Cloud jobplug-in for your external application, you can define, schedule and run jobs toautomate your business.

Define a job by using the Dynamic Workload Console or by using Application Lab.

How to define a job using the Dynamic Workload ConsoleFor details about defining jobs from the Dynamic Workload Console, seethe section about creating job definitions in Dynamic Workload ConsoleUser's Guide.

How to define a step (job) inside a process (job stream) using Application LabFor details about defining a step (job) inside a process (job stream) usingApplication Lab see the section about creating a process in Application LabUser's Guide.

For some jobs a properties file can be generated and used to provide the values forsome of the properties defined in the job definition.

The properties file is automatically generated either when you perform a "TestConnection" from the Dynamic Workload Console in the job definition panels, orwhen you submit the job to run the first time. Once the file has been created, youcan customize it. This is especially useful when you need to schedule several jobsof the same type. You can specify the values in the properties file and avoidhaving to provide information such as credentials and other information, for eachjob. You can override the values in the properties files by defining different valuesat job definition time.

Scheduling and submitting jobs and job streamsYou schedule Workload Automation on Cloud jobs by defining them in jobstreams.

For distributed environments, use the Dynamic Workload Console, Application Labor the conman command line.

After you define an Workload Automation on Cloud job, add it to a job streamwith all the necessary scheduling arguments and submit it to run. Aftersubmission, when the job is running (EXEC status), you can kill the WorkloadAutomation on Cloud job if necessary. For some job plug-ins, this action isconverted into corresponding action in the plug-in application. Refer to the specificplug-in section for details about what effect the kill action has in the application.

How to submit a job stream using the Dynamic Workload ConsoleTo submit a job or job stream to run according to the schedule defined, seethe section about submitting workload on request in production in

Chapter 4. Automate business processes 9

https://www.ibm.com/software/reports/compatibility/clarity-reports/report/html/softwareReqsForProduct?deliverableId=196702D00EBC11E58BF1AF9D8B1D437A&osPlatforms=AIX|HP|IBM%20i|Linux|Solaris|Windows|z/OS&duComponentIds=S002|S001|A005|A003|A004&mandatoryCapIds=30|9|13|121|25|26&optionalCapIds=130|132

Dynamic Workload Console User's Guide. For distributed environments only,see also the section about quick submit of jobs and job streams in DynamicWorkload Console User's Guide.

How to submit a process (job stream) using Application LabTo submit a process to run according to the schedule defined for it, see thesection about running a process in Application Lab User's Guide.

Monitoring Workload Automation on Cloud jobsMonitor Workload Automation on Cloud jobs by using the Dynamic WorkloadConsole or Application Lab.

You monitor jobs by using the Dynamic Workload Console or Application Lab.

How to monitor jobs by using the Dynamic Workload ConsoleSee the online help or the section about creating a task to monitor jobs inthe Dynamic Workload Console User's Guide.

How to monitor jobs by using Application LabSee the section about monitoring your process in Application Lab User'sGuide.

Analyzing the job logWhen a job runs Workload Automation on Cloud creates a job log that you cananalyze to verify the job status.

About this task

For distributed jobs, you analyze the job log by using the Dynamic WorkloadConsole, Application Lab or the conman command line.

You analyze the job log by using the Dynamic Workload Console or ApplicationLab.

While the job is running, you can track the status of the job and analyze theproperties of the job. In particular, in the Extra Information section, if the jobcontains variables, you can verify the value passed to the variable from the remotesystem. Some job streams use the variable passing feature, for example, the valueof a variable specified in job 1, contained in job stream A, is required by job 2 inorder to run in the same job stream.

For more information about passing variables between jobs, see the related sectionin the IBM Workload Scheduler on-premises online product documentation in IBMKnowledge Center.

How to analyze the job log using the Dynamic Workload ConsoleBefore you can access the job log for an individual job, you need to run aquery and list the jobs for which you want to analyze the job log. See theonline help or the section about creating a task to monitor jobs in DynamicWorkload Console User's Guide. From the list of jobs resulting from thequery, you can either download the job log, or view the job log in the jobproperties view. Select the job for which you want to analyze the job logand click More Actions > Download Job Log or More Actions >Properties from the toolbar.


How to analyze the job log using Application LabIn Application Lab, a process is the equivalent of a job stream. From thelist of processes displayed for the selected process library, select a processand then click the History tab. A run history for the process is displayed.Select a run instance and click Details. A list of steps defined in theprocess is displayed. Each step is the equivalent of a job. To view the logfor a step or download the log, select a step and click View Log orDownload Log, as needed.

For more information about Application Lab, see Application Lab User'sGuide.

Return codesThe following is a list of the return codes for job types with advanced optionsDatabase jobs:RC = 0 -> Job completed successfullyRC = -1 -> SQL statement was run with an exit code different from 1RC = -2 -> MSSQL Job errorRC = -3 -> SQL statement did not run because of an error in the statement

File transfer jobs:RC = 0 -> The file transfer completed successfully

RC = -1 -> The file transfer is not performed. The job fails with the followingerror code: AWKFTE007E

Explanation: An error occured during the file transfer operation

Possible reasons: Remote file not found or permission denied

RC = -2 -> The file transfer is not performed. The job fails with the followingerror code: AWKFTE020E

Explanation: Only for SSH or Windows protocols. An error was returnedwhile attempting to convert the code page

Possible reasons: For SSH or Windows protocols, the code page isautomatically detected and converted. In this case, there is an error in thecode page of the file to be transferred, which is not compliant with thecode page of the local system

RC = -3 -> The file transfer is not performed.The job fails with the followingerror code: AWKFTE015E

Explanation: An error occurred during the file transfer operation

Possible reasons: Local file is not found

RC = -4 -> The file transfer is performed with the default code page. The jobfails with the following error code: AWKFTE023E

Explanation: The specified codepage conversion has not been performed.File transfer has been performed with default code pages

Possible reasons: The specified code page is not available

IBM i jobs:Return code = user return code when retrievedReturn code = 0 -> job completed successfullyReturn code > -1 -> job completed unsuccessfully

Java jobs:RC = 0 -> Job completed successfullyRC = -1 -> The Java application launched by the job failed due to an exception


Web services jobs:RC = 0 -> Job completed successfullyRC = -1 -> The server hostname contained in the Web Service URL is unknownRC = -2 -> Web Service invocation error

When the user return code is retrieved, the IBM i Agent Monitor assigns a priorityto it.

Remote command jobsA remote command job runs on remote computers that are not required to havethe Workload Automation on Cloud agent installed.

To read a common real-life scenario that achieves business goals, including theimplementation of a remote command job, see remote command in the IBMWorkload Scheduler on-premises online product documentation in IBM KnowledgeCenter.

A description of the job properties and valid values are detailed in thecontext-sensitive help in the Dynamic Workload Console by clicking the questionmark (?) icon in the top-right corner of the properties pane.

Note: On Windows systems, the RemoteCommand plug-in has a hardcodedtimeout set to 5 minutes (300 seconds). It might happen that this timeout isreached when a job is still running, causing its abnormal ending. To prevent this, anew property file, RemoteCommandExecutor.properties, has been added to theplug-in, having the attribute timeout that can be set to a different amount ofseconds to give more time to run to the job. The attribute format is as follows:timeout=sec, where sec is the amount of time in seconds. Restart the agent to makethis change effective.

See also

From the Dynamic Workload Console you can perform the same task as describedin

the Dynamic Workload Console User's Guide, section about Creating job definitions.

For more information about how to create and edit scheduling objects, see

the Dynamic Workload Console User's Guide, section about Designing your Workload.

IBM i jobsAn IBM i job runs the command you specify on an IBM i system (formerly knownas AS/400 and i5 OS).

This section describes the required and optional attributes for IBM i jobs. Each jobdefinition has the following format and arguments:

Table 1. Required and optional attributes for the definition of an IBM i job.

Attribute Description/value Required

application name ibmi U

otherCommandType The generic command to be runon the IBM i system.

Required forgeneric type

command


Table 1. Required and optional attributes for the definition of an IBM i job. (continued)


SBMJOBType The SBMJOB command to be runon the IBM i system.

Required forSBMJOB type

command

jobName The name of the job that isassociated with the submitted jobwhile it is being processed by thesystem.

jobDescription The job description used tosubmit jobs for batch processing.

jobDescriptionLibrary The library that qualifies the jobdescription.

jobQueue The qualified name of the jobqueue on which the job is placed.

jobQueueLibrary The library that qualifies the jobqueue.

jobPriority The scheduling priority for thesubmitted job.

outputPriority The output priority for spooledfiles that are produced by thesubmitted job.

outputQueue The qualified name of the outputqueue used for spooled files.

outputQueueLibrary The library that qualifies theoutput queue.

printDevice The qualified name of the defaultprinter device for the submittedjob.

systemLibraryList The system portion of the initiallibrary list that is used by thesubmitted job.

currentLibrary The name of the current libraryassociated with the submitted job.

initialLibraryList The initial user part of the librarylist that is used to search for anyobject names that were specifiedwithout a library qualifier.


Table 1. Required and optional attributes for the definition of an IBM i job. (continued)


msgReplyList The list of messages for whichyou want to define an automatedreply. For each message, specify:

msgReply

msgId The messageidentifier.

msgCmpDtaThe messagetext.

msgRpyThe automatedreply that youwant to define.

Message Max RepliesThe maximumnumber ofautomatedreplies acceptedfor the message.Valid range isfrom 0 to 100.Default value is10. If 0 isspecified, theautomated replyto the messageis disabled.

For more information about how to define the Submit Job (SBMJOB) commandparameters, see IBM i product documentation.

See also





Executable jobsAn executable job runs scripts or commands with advanced options, such asredirecting standard input and standard output to a file.

A description of the job properties and valid values are detailed in thecontext-sensitive help in the Dynamic Workload Console by clicking the questionmark (?) icon in the top-right corner of the properties pane.


See also





SAP jobsYou must define some jobs to be able to run jobs on an SAP workstation fromWorkload Automation on Cloud.

To define and manage jobs on an SAP workstation from Workload Automation onCloud, you must define the following:

Jobs in SAP that you want to run under Workload Automation on Cloud controlYou can define these jobs using standard SAP tools or using the DynamicWorkload Console.

Jobs in Workload Automation on Cloud that correspond to the jobs in SAPThe Workload Automation on Cloud job definitions are used in schedulingand defining dependencies, but the SAP jobs are actually run.

You can define SAP job definitions from the Dynamic Workload Console and thenhave Workload Automation on Cloud launch the jobs in SAP R/3 using jobsdefined on the following workstations that support the r3batch access method:v A dynamic agent workstation.

You can define SAP job definitions from the Dynamic Workload Console and thenhave Workload Automation on Cloud launch the jobs in SAP R/3 using jobsdefined on dynamic agent workstations that support the r3batch access method.

The SAP job definitions can reference the following types of SAP jobs:v Standard R/3v Business Warehouse Process Chainsv Business Warehouse InfoPackages

Creating SAP Standard R/3 jobs from the Dynamic WorkloadConsole

How to create and manage an SAP job that is associated to an WorkloadAutomation on Cloud job that manages it.

About this task

You can easily create and manage Standard R/3 jobs on a remote SAP systementirely from the Dynamic Workload Console, and then continue to manage theremote SAP job from Workload Automation on Cloud.


To create a new SAP Standard R/3 job on a remote SAP system that maps to anWorkload Automation on Cloud job definition, you have to associate your SAPStandard R/3 jobs to Workload Automation on Cloud jobs and you can do it ineither of the following ways:v Starting from an SAP job: “Create an SAP job and associate it to an Workload

Automation on Cloud job” orv Starting from an Workload Automation on Cloud job (“Create an Workload

Automation on Cloud job and associate it to an SAP job” on page 17)v Alternatively, you can simply create an SAP job on a remote SAP system,

without having it managed by Workload Automation on Cloud: “Creating anSAP job from the Dynamic Workload Console” on page 19.

When performing operations that require a connection to a remote SAP system,you must configure the SAP connection data. The connection is made through anWorkload Automation on Cloud workstation with the r3batch access methodinstalled. Each workstation can have one or more options files that can be used tocustomize the behavior of the r3batch access method, except for extended agentworkstations, where only one options file can be defined and therefore a selectionis not required. For information about setting the SAP connection data, see “Settingthe SAP data connection” on page 19.

Create an SAP job and associate it to an Workload Automationon Cloud jobHow to create a new SAP job that is associated to an Workload Automation onCloud job that manages it.

Before you begin

To be able to save your SAP job on a remote SAP system, you must specify theconnection details. See “Setting the SAP data connection” on page 19.

About this task

To create a new SAP job and then associate it to a new Workload Automation onCloud job, perform the following steps:

Procedure1. Click Administration > Workload Design > Manage Workload Definitions.2. Select an engine. The Workload Designer window is displayed.3. From the Working List pane, click New > Remote SAP R/3 Job:


4. In the Properties pane, specify the properties for the SAP job definition you arecreating using the tabs available. The tabs for each type of SAP job definitionare similar, but there are some differences depending on the type of engine youselected and the type of workstation on which the job runs. For more detailedinformation about the UI elements on each tab, see the Dynamic WorkloadConsole online help.

5. In the Details view, right-click the new job to add ABAP, External command orExternal program steps to it. It is mandatory to add at least one job step to thejob before you can save the job:

6. Right-click the SAP job and click Create SAP Job Definition to create a newWorkload Automation on Cloud job associated to the new job on SAP. Selectthe job definition in accordance with the engine and type of agent on which thejob runs.

SAP Job on Dynamic WorkstationsThis job definition can run on dynamic agent workstations.

SAP Job on XA WorkstationsThis job definition can run on extended agent workstations, which areworkstations hosted by fault-tolerant agents or master workstations.

7. Right-click the steps to move them and change their sequence.8. The Workload Automation on Cloud job definition opens in Workload

Designer. Some fields in the Properties pane already contain informationrelating to the associated SAP job. Specify the remaining properties using thetabs available. The tabs for each type of SAP job definition are similar, but thereare some differences depending on the type of engine you selected and thetype of workstation on which the job runs. For more detailed information aboutthe UI elements on each tab, see the Dynamic Workload Console online help.

9. Click

to save the SAP job definition in the Workload Automation onCloud database.

Create an Workload Automation on Cloud job and associate it toan SAP jobCreate an Workload Automation on Cloud job definition and map it to a new orexisting SAP job to manage it.

About this task

To create a new Workload Automation on Cloud job and then associate it to a newSAP job, follow these steps:


Procedure1. Click Administration > Workload Design > Manage Workload Definitions.2. Select an engine. The Workload Designer window is displayed.3. From the Working List pane,v Click: New >Job Definition > ERP > SAP Job on...., choosing the type of

workstation on which it is going to run:

SAP Job on Dynamic WorkstationsThis job definition can run on dynamic agent workstations.

SAP Job on XA WorkstationsThis job definition can run on extended agent workstations, whichare workstations hosted by fault-tolerant agents or masterworkstations.

4. In the Properties pane, specify the properties for the SAP job definition youare creating using the tabs available. The tabs for each type of SAP jobdefinition are similar, but there are some differences depending on the type ofengine you selected and the type of workstation on which the job runs. Formore detailed information about the UI elements on each tab, see theDynamic Workload Console online help.

5. In the Task tab, specify the Workload Automation on Cloud job that you wantto associate to the SAP job. If this job already exists, specify it in the Job namefield, otherwise, click New to create it from new and specify its properties inthe Properties pane.

6. In the Details view, right-click the new job to add ABAP, External commandor External program steps to it. It is mandatory to add at least one job step tothe job before you can save the job:

7. Save the job.


8. After you have saved the SAP job, close the SAP job definition view or selectthe Workload Automation on Cloud job definition to assign the SAP job to it.

9. In the Task pane, enter the details of the SAP job created before or use thepicklist to retrieve the SAP job details from SAP

10. Click

to save the SAP job definition in the Workload Automation onCloud database.

Creating an SAP job from the Dynamic Workload ConsoleHow to create an SAP job definition on a remote SAP system from the DynamicWorkload Console.

About this task

You can also create and save SAP Standard R/3 jobs directly on the remote SAPsystem from Workload Automation on Cloud, as you would from the SAPgraphical user interface. To create Standard R/3 jobs on the SAP system from theDynamic Workload Console, perform the following steps:

Procedure1. Click Administration > Workload Design > Manage Jobs on SAP.2. In the Filter, select Standard R/3 Job and specify the workstation name. This

parameter is mandatory because it identifies the remote SAP system.3. Specify the workstation where the SAP job runs. This is the workstation with

the r3batch access method that communicates with the remote SAP system.4. If the workstation is not an extended agent workstation, you must also specify

the options file to be used.5. Click Display to view a list of the Standard R/3 jobs for the specified

workstation.6. Click New to create a new Standard R/3 job and enter the required information

in the R/3 Job Definition and R/3 steps tabs.7. Click OK to save the job on the SAP system.

What to do next

After creating the new SAP job on the SAP from the Dynamic Workload Console,you must reference it in an Workload Automation on Cloud SAP Standard R/3 jobif you want to manage the job from within Workload Automation on Cloud asexplained in “Create an Workload Automation on Cloud job and associate it to anSAP job” on page 17.

Setting the SAP data connectionYou can configure a default connection to be used when performing actions thataccess the remote SAP system.

About this task

There are several operations you can perform which require connection details toestablish a link to a remote SAP system. The connection is made through anWorkload Automation on Cloud workstation with the r3batch access methodinstalled used to communicate with the SAP system. Each workstation can haveone or more options files that can be used to customize the behavior of the r3batch


access method, except for extended agent workstations, where only one options filecan be defined and therefore a selection is not required.

For example, you can use Workload Designer to create Workload Automation onCloud job definitions that reference remote SAP jobs, or you can create a SAP jobon a remote SAP system. You can also search for SAP jobs on the remote systemfrom the Working List and Quick Open panes.

Workload Designer enables you to configure a default connection that isautomatically referenced when performing these types of operations. You canchange the default configuration at any time, or you can overwrite the defaultconfiguration when performing these operations.

To configure a default SAP data connection to be used when creating objects withWorkload Design that require a SAP connection, perform the following steps:

Procedure

1. In the Workload Designer window, click

from the toolbar of the Detailsview.

2. In Workstation, enter the name of the workstation that communicates with theSAP system or use the pick tool to search for and select one.

3. In Options file, enter the options file to be used or use the pick tool to searchfor options files that reside on the specified workstation and select one.

4. Click OK.

Results

A default SAP connection is now configured. It will be used each time an objectthat requires access to a SAP system is defined.

Managing SAP variants using the Dynamic Workload ConsoleManaging variants using the Dynamic Workload Console.

About this task

This section describes how to manage variants using the Dynamic WorkloadConsole:

Procedure1. Click Administration > Workload Design > Manage Jobs on SAP from the

portfolio.2. Specify an engine connection.3. In Workstation name, type the name of the workstation where the SAP job

runs. This is the workstation with the r3batch access method thatcommunicates with the remote SAP system. If you do not know the name ofthe workstation, click (...) browse to enter your filter criteria and click Search.If you enter a string representing part of the workstation name, it must befollowed by the asterisk (*) wildcard character. Both the question mark (?) andasterisk (*) are supported as wildcards. You can also simply use the asteriskwildcard character (*) to display all workstations. Optionally, specify any ofthe other search criteria available and click Search. From the results displayed,select the workstation and click OK.


4. In Options file, specify an options file that resides on the specifiedworkstation. Each workstation can have one or more options files that can beused to customize the behavior of the r3batch access method, except forextended agent workstations, where only one options file can exist andtherefore does not need to be specified. For the workstation specified, enterthe file name of the options file or click the browse (...) button to search foroptions files that reside on the specified workstation and select one.

5. Click Display. The list of available jobs on the remote SAP system for thespecified engine is displayed.

6. A list of SAP jobs on the remote SAP system are displayed.7. Select a SAP job from the list and click Edit.8. On the R/3 Steps page, select a program of type ABAP from the list and click

Edit. The properties for the ABAP program are displayed.9. In the Variant field, click the ellipsis (...) icon to display the Variant List panel.

This panel lists all the variants associated with the ABAP specified in theName field.

10. From this panel, you can take the following actions:

Refresh To refresh the content of the variant list with the informationcontained in the SAP database.

New To create a new variant as described in “Creating or editing a variant”on page 22.

View To display information on an existing variant.

Edit To modify information on an existing variant as described in“Creating or editing a variant” on page 22.

Delete To delete a variant.

Set To associate the value chosen from the list to the ABAP.

Figure 1. The Variant List panel


Creating or editing a variantAbout this task

You can create or edit a variant from the Variant List panel. To display the VariantList panel, see “Managing SAP variants using the Dynamic Workload Console” onpage 20.

Procedure1. In the Variant List panel, click New or Edit. The Variant Information page is

displayed by default. If you are editing an existing variant, the fields andselections are not empty.

2. The panel consists of the following pages:v Variant Information:

a. Enter or modify the variant name and description.b. Optionally, check a Properties box:

BackgroundThe variant can only be used in background processing.

ProtectedThe variant is protected against being changed by other users.

InvisibleThe variant will not be displayed in the F4 value list on the SAPGUI. Not available for the BC-XBP 3.0 interface.

ExtendedAllows for the use of placeholders and counters as variant values.If you check this box, Counter becomes available.

For extended variants, you can use placeholders and counters thateliminate the error-prone task of adjusting values and therefore minimizethe effort for variant maintenance. Placeholders and counters are

Figure 2. The Variant Information page of the Variant List panel


preprocessed by Workload Automation on Cloud and the values areautomatically adjusted when the job is launched. Supported placeholdersand counters are:

Table 2. Placeholders and counters for extended variants

Symbol Meaning Syntax

$S Timestamp YYYYMMDDHHMM

$D Day of the month DD

$_D Date YYYYMMDD

$M Month MM

$Y Year YY

$_Y Year YYYY

$H Hour HH

$T Minute MM

$_T Time HHMMSS

$Nx Counters 10 counters: $N0 - $N9 ($N = $N0)

$(date expression) Date expression Like the datecalc command. Enclosedwithin $( and ).

$[arithmetic expression] Arithmetic expression Arithmetic expressions allowing for +,-, *, and / operations betweenintegers and counters.

v Variant Values:In the Variant Values page, the fields and values are dynamically builtthrough r3batch depending on the characteristics of the variant or step andare identical to the ones in the equivalent SAP panel.

Editing a standard SAP jobBefore you begin

You can edit SAP Standard R/3 jobs in two different ways in WorkloadAutomation on Cloud.v The Dynamic Workload Console contains the Manage Jobs on SAP entry in the

portfolio for creating and editing SAP Standard R/3 jobs on remote SAPsystems.

v The Workload Designerwindow in the Dynamic Workload Console allows you tocreate and edit remote SAP jobs. See “Creating SAP Standard R/3 jobs from theDynamic Workload Console” on page 15.

About this task

To edit a SAP standard R/3 job, follow these steps:

Procedure1. Click Administration > Workload Design > Manage Jobs on SAP.2. Select the name of the engine connection from which you want to work with

SAP jobs.3. Leave the default setting in the SAP Job Type section to Standard R/3 Job.4. In Workstation name, type the name of the workstation where the SAP job

runs. This is the workstation with the r3batch access method that


communicates with the remote SAP system. If you do not know the name ofthe workstation, click (...) browse to enter your filter criteria and click Search. Ifyou enter a string representing part of the workstation name, it must befollowed by the asterisk (*) wildcard character. Both the question mark (?) andasterisk (*) are supported as wildcards. You can also simply use the asteriskwildcard character (*) to display all workstations. Optionally, specify any of theother search criteria available and click Search. From the results displayed,select the workstation and click OK.

5. In Options file, specify an options file that resides on the specified workstation.Each workstation can have one or more options files that can be used tocustomize the behavior of the r3batch access method, except for extended agentworkstations, where only one options file can exist and therefore does not needto be specified. For the workstation specified, enter the file name of the optionsfile or click the browse (...) button to search for options files that reside on thespecified workstation and select one.

6. Click Display. The list of available jobs on the remote SAP system for thespecified engine is displayed.

7. Select the job you want to modify in the list and click Edit. The List Jobs onSAP panel is displayed.

8. Edit the properties on the R/3 Job Definition and R/3 Steps pages asappropriate. Refer to the contextual online help available for more detailedinformation about the UI elements available on each page.

Note:

v On the R/3 Job Definition page, when you modify the Job Class, TargetHost, or Server Group and click OK, the Job ID is maintained and remainssynchronized with the one associated to the current job. Instead, when youmodify the Job Name and click OK, the Job ID is automatically replacedwith the one associated to the new job name.

v On the R/3 Steps page, for each step you modify, the new step information issaved in the SAP database. For each step you add or delete, the Job ID ismaintained and remains synchronized with the one associated to themodified step.

9. Click OK to save your changes.

Task string to define SAP jobsThis section describes the task string parameters that define and control therunning of SAP jobs. You can specify them in the following places when youdefine their associated Workload Automation on Cloud jobs:v In the R/3 Command Line section of the Task page of the Submit Ad Hoc Jobs

action from the Dynamic Workload Console.v In the R3 Command Line field of the More Options page of the SAP job

definition, if you use the Dynamic Workload Console and selected a SAP jobdefinition.

The string syntax is the following:

Job definition syntax

►► -job job_name-i job_ID-id

-user user_name►


►-host host_name-ts

-sg server_group►

►-client source_client -exec_client target_client

►

►-rfc_client rfc_logon_client -c class_value

►

►-bdc_job_status_failed bdc_processing -nobdc

-nobdcwait

►

►high

-bapi_sync_level mediumlow

-s starting_step_number►

► ▼

-sStep_number attribute_name=attribute_value

►

►-vStep_number variant_name -vtxtStep_number variant_description

►

►-vparStep_number name=variant_value

►

►-vselStep_number name= i #operation#lowest

e #highest

►

►-vtempStep_number -recipient R/3_login_name

►


►-rectype recipient_type -flag reccp

recbl-flag recex

►

►-flag recnf -flag im

immed-flag enable_applinfo

disable_applinfo

►

►-flag enable_appl_rc

disable_appl_rc-flag enable_joblog

disable_joblog

►

►-flag enable_job_interceptable

disable_job_interceptable-flag enable_spoollist

disable_spoollist

►

►-flag pc_launch -debug -tracelvl 1

23

-rfctrace►◄

Table 3 on page 27 describes the parameters for the task string to define SAP jobs.

Note:

1. You can specify both -i or -id and -user in the same job definition, but theuser name is ignored.

2. When you specify the job ID, both -client and -exec_client are ignoredbecause the ID is unique for the entire SAP system.

3. Typically, the -debug and -trace options are for debugging the extended agentand should not be used in standard production.


Table 3. Task string parameters for SAP jobs. The following are the task string parameters for the SAP jobs

Section Parameters DescriptionGUI

Support

JOB -job job_name The name of the job to run. This parameter ismandatory.

U

-i job_ID-id job_ID

The unique SAP job ID. Specify this parameter if youare submitting a job that refers to a predefined jobtemplate stored in the SAP database for which youwant to change a parameter.

U

-user user_name The SAP user who owns the target job. Use thisparameter when the target SAP system has only onejob with the specified name for the specified user. Thisparameter has no effect if a job ID is specified in thejob definition.

U

-host host_name-ts host_name

The name of the SAP workstation where the job is tobe run. host_name has the formathostname_SAPsystemname_SAPsystemnumber.

For example, the name of a host might beamss80a0_gs7_90

These parameters are mutually exclusive with -sg.

U

-sg server_group The name of the SAP server group where the job is tobe run. Use this parameter to run the job on anapplication server that belongs to the group. Theserver group must exist on the SAP system, otherwisean error code is returned and the job is not launched.

This parameter is case-sensitive and can be up to 20characters. It is mutually exclusive with -host and -ts.

U


Table 3. Task string parameters for SAP jobs (continued). The following are the task string parameters for the SAPjobs


Support

JOB -client source_client The number that identifies the SAP client where thejob definition is to be found, regardless of the clientnumber defined by the r3client keyword in theoptions file. This parameter has no effect if a job ID isspecified in the job definition.

-exec_client target_client The number that identifies the SAP client where thejob is to be run, regardless of the client numberdefined by the r3client keyword in the options file.This parameter has no effect if a job ID is specified inthe job definition.

-rfc_client rfc_logon_client The number that identifies the SAP client to be usedfor RFC logon. This value overwrites the valuespecified by the r3client keyword in the correspondingr3batch options file.

-c class_value The priority with which the job runs in the SAPsystem. Possible values are:A High priorityB Medium priorityC Low priority. This is the default value.

U

-bdc_job_status_failed bdc_processing How Workload Automation on Cloud sets thecompletion status of a job running BDC sessions,according to a possible BDC processing failure. Theallowed values are:n If at least n BDC sessions failed (where n is

an integer greater than 0), WorkloadAutomation on Cloud sets the job completionstatus as failed.

all If all the BDC sessions failed, WorkloadAutomation on Cloud sets the job completionstatus as failed.

ignore When all the BDC sessions complete,regardless of their status, WorkloadAutomation on Cloud sets the job completionstatus as successful. This is the default.

If -nobdc or -nobdcwait is set, this option is ignored.

U

-nobdc-nobdcwait

Disables the BDC Wait option (enabled by default) tohave the job considered as completed even if not allits BDC sessions have ended.

U

-bapi_sync_level Specifies the synchronization level between the SAPfunction modules BAPI_XBP_JOB_COPY andBAPI_XBP_JOB_START_ASAP. Allowed values are:

high All RFC calls betweenBAPI_XBP_JOB_START_ASAP andBAPI_XBP_JOB_COPY are synchronized. Thisis the default.

mediumThe RFC calls toBAPI_XBP_JOB_START_ASAP aresynchronized.

low The RFC calls are not synchronized.




Support

STEP -s starting_step_number The number of the starting step. U

-sStep_numberattribute_name=attribute_value

The step number and its attributes, where:

step_numberThe number of the step being defined. Eachstep is identified by a sequential number (1,2, 3, ...n) using the step number

attribute_nameThe name of the attribute.

attribute_valueThe value of the attribute. It is optional forsome attributes.

Attributes can be defined in any order, but cannot berepeated for the same step. Attribute validation isperformed before the job is created in the SAP system.If the validation fails, the Workload Automation onCloud job goes into the ABEND state. For a detaileddescription of each attribute and its value, see“Defining attributes for ABAP steps” on page 41 and“Defining attributes for external programs andexternal commands steps” on page 43.

For example, the following step (step 8) is an ABAPmodule running the report MYPGM and has twoattributes, only one of which has a value.

-s8 type=A -s8 program=MYPGM-s8 pr_cover="My title" -s8 pr_immed

U




Support

VARIANT -vstep_number name The variant name for the specified step number. U

-vtxtstep_number variant_description The textual description of the variant, in the WorkloadAutomation on Cloud logon language (customizablewith the TWSXA_LANG option of r3batch). Themaximum length is 30 characters.

U

-vparstep_number name=value For ABAP modules only. The value for a variantparameter for the specified step number. Thisparameter is mandatory when creating a new variant.See “Defining attributes for ABAP steps” on page 41for a complete list of the supported attributes forABAP steps.

U

-vselstep_numbername=sign#operation#lowest[#highest]

For ABAP modules only. The value for a variantselection option for the specified step number.

sign Sign of the operation. Possible values are:I IncludeE Exclude

operationPossible values are:EQ EqualsNE Not equal toBT BetweenNB Not betweenLT Less thanLE Less than or equal toGT Greater thanGE Greater than or equal toCP Contains patternNP Does not contain pattern

lowest Low value of the selection. You can use up to45 characters.

highest High value of the selection. You can use upto 45 characters. This attribute is optional.

For a complete list of the supported attributes forABAP steps, see“Defining attributes for ABAP steps”on page 41.

U

-vtempstep_number For ABAP modules only. Specifies to assign atemporary variant to the specified step number.Temporary variants are created ad-hoc by the SAPsystem and assigned to the job instance when it isrun. The lifecycle of the temporary variant isdetermined by the SAP system. If the job is deleted bySAP, then the temporary variant is deleted. See“Examples: Dynamically defining and updating SAPjobs” on page 45 to refer to examples that demonstratethe behavior of temporary variants.




Support

SPOOL -recipient name The login name of an SAP user.

-flag {reccp|recbl} Specifies how the spool list is sent to the recipient.Possible values are:reccp The spool list is sent as a copy.recbl The spool list is sent as a blind copy.

-flag recex Specifies that the spool list is sent as an expressmessage to the recipient.

-flag recnf Specifies that the recipient is not allowed to forwardthe spool list.

-rectype type Specifies the recipient type. Possible values are:' ' SAP user (default value)'B' SAP user'C' Shared distribution list'D' X.500 address'G' Organization object/ID'H' Organization unit'I' SAP object'L' Telex number'O' SAPoffice user'P' Private distribution list'R' SAP user in another SAP system'U' Internet address'1' Other recipient type

FLAGS -flag im-flag immed

Specifies to launch job immediately, meaning that ifthere are no spare work processes, the job fails.

U

-flag enable_applinfo-flag disable_applinfo

Enables or disables the retrieval and appending of theSAP application log to the stdlist of WorkloadAutomation on Cloud.

U

-flag enable_appl_rc-flag disable_appl_rc

Enables or disables the mapping of the SAPapplication return code to the Workload Automationon Cloud return code.

The SAP application return code is mapped only if-flag enable_applinfo is set and the application logcontains the application return code.

-flag enable_joblog-flag disable_joblog

Enables or disables retrieval of the joblog. U

-flag enable_job_interceptable-flag disable_job_interceptable

Enables or disables the job launched by r3batch to beintercepted by SAP. If enabled, when r3batch launchesa job and the SAP job interception feature is enabled,the job can be intercepted if it matches previouslydefined criteria. If disabled, the job launched byr3batch cannot be intercepted by SAP. This settingoverwrites the setting in the common options file.

U

-flag enable_spoollist-flag disable_spoollist

Enables or disables retrieval of the spool lists of thejob.

U




Support

-flagpc_launch

Specifies to launch child jobs thatare in scheduled state.ON The product launches child

jobs that are in scheduledstate.

OFF The product does notlaunch child jobs that arein scheduled state. This isthe default value.

Note: You can use this option onlyif you activated the parent-childfeature on the SAP system. On theXBP 2.0 (or later)SAP system youcan activate this feature using theINITXBP2 ABAP report

TRACING -debug Enables maximum trace level. U

-tracelvl 1|2|3 Specifies the trace setting for the job. Possible valuesare:1 Only error messages are written in the trace

file. This is the default.2 Informational messages and warnings are

also written in the trace file.3 A most verbose debug output is written in

the trace file.For detailed information, refer to “Configuring thetracing utility” on page 58.

U

-rfctrace-trace

Enables RFC trace.

The following is an example for an SAP job named BVTTEST with ID 03102401 anduser myuser:-job BVTTEST –i 03102401 -user myuser -debug

Defining SAP jobs dynamicallyThis section describes how to create and submit SAP jobs dynamically withoutcreating or referencing predefined job templates.

When you launch a job created as described in “Creating SAP Standard R/3 jobsfrom the Dynamic Workload Console” on page 15 and “Task string to define SAPjobs” on page 24, IBM Workload Scheduler makes a copy of the predefined job(also known as a template job) and runs the copy. If you want to run the job onseveral SAP systems, you must manually create the template job on each system.

To create and submit SAP jobs dynamically, without creating or referencingpredefined job templates, submit:v In the SAP system, a job that does not reference an existing template in the SAP

R/3 database.v A job that references a predefined job template stored in the SAP R/3 database

for which you want to change a parameter.


To take full advantage of this feature, make sure that you have XBP version 2.0 orlater installed, because earlier versions of XBP do not support the full set of printand archive parameters, or provide a way to set the job class or the spool listrecipient.

Task string to define SAP jobs dynamicallyThis section describes the task string that controls the running of SAP jobs. You canbuild an entire job definition by using the six main sections concerning SAP jobparameters. These sections are grouped in Table 4 on page 35 and are related tothe:v Jobv Job stepsv Variants associated with the steps (for ABAP modules only)v Spool list recipients associated with the jobv Flags associated with the jobv Tracing specifications for the job

You can specify them in the following places when you define their associated IBMWorkload Scheduler jobs:v In the R/3 Command Line section of the Task page of the Submit Ad Hoc Jobs

action from the Dynamic Workload Console.v In the R3 Command Line field of the More Options page of the SAP job

definition, if you use the Dynamic Workload Console and selected a SAP jobdefinition.

v As arguments of the scriptname keyword in the job definition statement, if youuse the IBM Workload Scheduler command line.

v As arguments of the JOBCMD keyword in the JOBREC statement in the SCRIPTLIB ofIBM Workload Scheduler for z/OS, if you are scheduling in an end-to-endenvironment. The following is an example of a JOBREC statement:JOBREC

JOBCMD(’/-job job_name -user user_name -i job_ID -c class_value’)JOBUSR(TWS_user_name)

To define and submit an SAP R/3 job dynamically, use the following syntax:

Job definition syntax

►► -job job_name-i job_ID-id

-flag type=exec-host host_name-ts

►

►-sg server_group -client source_client -exec_client target_client

►

►-rfc_client rfc_logon_client -c class_value

►

►-bdc_job_status_failed bdc_processing

►


►-nobdc-nobdcwait high -s starting_step_number

-bapi_sync_level mediumlow

►

► ▼

-sStep_number attribute_name=attribute_value

►

►-vStep_number variant_name -vtxtStep_number variant_description

►

►-vparStep_number name=variant_value

►

►-vselStep_number name= i #operation#lowest

e #highest-vtempStep_number

►

►-recipient R/3_login_name -rectype recipient_type -flag reccp

recbl

►

►-flag recex -flag recnf -flag im

immed

►

►-flag enable_applinfo

disable_applinfo-flag enable_appl_rc

disable_appl_rc

►

►-flag enable_joblog

disable_joblog-flag enable_job_interceptable

disable_job_interceptable

►

►-flag enable_spoollist

disable_spoollist-flag pc_launch -debug

►

►-tracelvl 1

23

-rfctrace -rfc_client rfc_logon_client►◄

The following is an example of a definition for the SAPTEST job:-job SAPTEST -C A -s1 program=BTCTEST -s1 type=A -s1 pr_release-s2 report=BTCTEST -s2 variant=BVT –s2 type=A -flag type=exec-vpar2 TESTNAME=test -vtxt2 Test


Table 4 describes the parameters for the task string to define SAP jobs dynamically.

Note: The parameter values are case sensitive.

Table 4. Task string parameters for SAP jobs (dynamic definition). This table shows Task string parameters for Sapjobs

Section Parameters Description

JOB -job job_name The name of the job to be run. This parameter ismandatory.

-i job_ID-id job_ID

The unique SAP job ID. Specify this parameter if you aresubmitting a job that refers to a predefined job templatestored in the SAP database for which you want tochange a parameter.

-host host_name-ts host_name

The name of the SAP workstation where the job is to berun. host_name has the formathostname_SAPsystemname_SAPsystemnumber.

For example, the name of a host might beamss80a0_gs7_90

These parameters are mutually exclusive with -sg.

-sg server_group The name of the SAP server group where the job is to berun. Use this parameter to run the job on an applicationserver that belongs to the group. The server group mustexist on the SAP system, otherwise an error code isreturned and the job is not launched.

This parameter is case-sensitive and can be up to 20characters. It is mutually exclusive with -host and -ts.

-client source_client The number that identifies the SAP client where the jobdefinition is to be found, regardless of the client numberdefined by the r3client key in the options file. Thisparameter has no effect if a job ID is specified in the jobdefinition.

-exec_client target_client The number that identifies the SAP client where the jobis to be run, regardless of the client number defined bythe r3client key in the options file. This parameterrequires that the client-dependent data (such as the username and report variants) exists on both the source andtarget clients.

This parameter has no effect if a job ID is specified in thejob definition.

-rfc_client rfc_logon_client The number that identifies the SAP client to be used forRFC logon. This value overwrites the value specified bythe r3client keyword in the corresponding r3batchoptions file.

-c class_value The priority with which the job runs in the SAP system.Possible values are:A High priorityB Medium priorityC Low priority. This is the default value.

-flag type=exec Specify this parameter to enable the dynamic definitionof the SAP job. This parameter is mandatory.


Table 4. Task string parameters for SAP jobs (dynamic definition) (continued). This table shows Task stringparameters for Sap jobs


JOB -bdc_job_status_failed bdc_processing How IBM Workload Scheduler sets the completion statusof a job running BDC sessions, according to a possibleBDC processing failure. The allowed values are:n If at least n BDC sessions failed (where n is an

integer greater than 0), IBM Workload Schedulersets the job completion status as failed.

all If all the BDC sessions failed, IBM WorkloadScheduler sets the job completion status asfailed.

ignore When all the BDC sessions complete, regardlessof their status, IBM Workload Scheduler sets thejob completion status as successful. This is thedefault value.

If -nobdc or -nobdcwait is set, this option is ignored.

-nobdc-nobdcwait

Disables the BDC Wait option (enabled by default) tohave the job considered as completed even if not all itsBDC sessions have ended.

-bapi_sync_level Specifies the synchronization level between the SAPfunction modules BAPI_XBP_JOB_COPY andBAPI_XBP_JOB_START_ASAP. Allowed values are:

high All RFC calls betweenBAPI_XBP_JOB_START_ASAP andBAPI_XBP_JOB_COPY are synchronized. This isthe default.

mediumThe RFC calls to BAPI_XBP_JOB_START_ASAPare synchronized.

low The RFC calls are not synchronized.




STEP -s starting_step_number The number of the starting step.

-sstep_number attribute_name=attribute_value The step number and its attributes, where:

step_numberThe number of the step being defined. Eachstep is identified by a sequential number (1, 2,3, ...n) using the step number.

attribute_nameThe name of the attribute.

attribute_valueThe value of the attribute. It is optional forsome attributes.

Attributes can be defined in any order, but cannot berepeated for the same step. Attribute validation isperformed before the job is created in the SAP system. Ifthe validation fails, the IBM Workload Scheduler jobgoes into the ABEND state. For a detailed description ofeach attribute and its values, see “Defining attributes forABAP steps” on page 41 and “Defining attributes forexternal programs and external commands steps” onpage 43.

For example, the following step (step 8) is an ABAPmodule running the report "MYPGM" and has twoattributes, only one of which has a value.

-s8 type=A -s8 program=MYPGM-s8 pr_cover="My title" -s8 pr_immed




VARIANT1 -vstep_number name The variant name for the specified step number.

-vtxtstep_number variant_description The textual description of the variant, in the IBMWorkload Scheduler logon language (customizable withthe TWSXA_LANG option of r3batch). The maximum lengthis 30 characters. Not valid for temporary variants.

-vparstep_number name=value For ABAP modules only. The value for a variantparameter for the specified step number. This parameteris mandatory when creating a new variant. For acomplete list of the supported attributes for ABAP steps,see “Defining attributes for ABAP steps” on page 41.

-vselstep_numbername=sign#operation#lowest[#highest]

For ABAP modules only. The value for a variantselection option for the specified step number.

sign Sign of the operation. Possible values are:I IncludeE Exclude

operationPossible values are:EQ EqualsNE Not equal toBT BetweenNB Not betweenLT Less thanLE Less than or equal toGT Greater thanGE Greater than or equal toCP Contains patternNP Does not contain pattern

lowest Low value of the selection. You can use up to 45characters.

highest High value of the selection. You can use up to45 characters. This attribute is optional.

For a complete list of the supported attributes for ABAPsteps, see “Defining attributes for ABAP steps” on page41.

-vtempstep_number For ABAP modules only. Specifies to assign a temporaryvariant to the specified step number. Temporary variantsare created ad-hoc by the SAP system and assigned tothe job instance when it is run. The lifecycle of thetemporary variant is determined by the SAP system. Ifthe job is deleted by SAP, then the temporary variant isdeleted. See “Examples: Dynamically defining andupdating SAP jobs” on page 45 to refer to examples thatdemonstrate the behavior of temporary variants.




SPOOL -recipient name The login name of an SAP user.

-flag {reccp|recbl} Specifies how the spool list is sent to the recipient.Possible values are:reccp The spool list is sent as a copy.recbl The spool list is sent as a blind copy.

-flag recex Specifies that the spool list is sent as an express messageto the recipient.

-flag recnf Specifies that the recipient is not allowed to forward thespool list.

-rectype type Specifies the recipient type. Possible values are:blank SAP user (default value)B SAP userC Shared distribution listD X.500 addressG Organization object/IDH Organization unitI SAP objectL Telex numberO SAPoffice userP Private distribution listR SAP user in another SAP systemU Internet address1 Other recipient type

FLAGS -flag im-flag immed

Specifies to launch the job immediately, meaning that ifthere are no spare work processes, the job fails.

-flag enable_applinfo-flag disable_applinfo

Enables or disables the retrieval and appending of theSAP application log to the stdlist of IBM WorkloadScheduler.

-flag enable_appl_rc-flag disable_appl_rc

Enables or disables the mapping of the SAP applicationreturn code to the IBM Workload Scheduler return code.

The SAP application return code is mapped only if -flagenable_applinfo is set and the application log containsthe application return code.


Enables or disables retrieval of the joblog.


Enables or disables retrieval of the joblog.

-flag enable_job_interceptable-flag disable_job_interceptable

Enables or disables the job launched by r3batch to beintercepted by SAP. If enabled, when r3batch launches ajob and the SAP job interception feature is enabled, thejob can be intercepted if it matches previously definedcriteria. If disabled, the job launched by r3batch cannotbe intercepted by SAP. This setting overwrites the settingin the common options file.




-flagpc_launch

Specifies to launch child jobs that are inscheduled state.ON The product launches child jobs

that are in scheduled state.OFF The product does not launch child

jobs that are in scheduled state.This is the default value.

Note: You can use this option only if youactivated the parent-child feature on theSAP system. On the XBP 2.0 (or later) SAPsystem, you activate this feature by usingthe INITXBP2 ABAP report.

TRACING -debug Enables maximum trace level.

-tracelvl 1|2|3 Specifies the trace setting for the job. Possible values are:

1 Only error messages are written in the trace file.This is the default.

2 Informational messages and warnings are alsowritten in the trace file.

3 A most verbose debug output is written in thetrace file.

For more details, refer to “Configuring the tracingutility” on page 58.

-rfctrace-trace

Enables RFC trace.

Note: See “Examples: Dynamically defining and updating SAP jobs” on page 45 torefer to examples that demonstrate the behavior of variants and temporaryvariants.1. The following rules apply when you create or update SAP jobs dynamically:v To create or reference a variant within an ABAP step, you can use one of the

following equivalent syntaxes:– -s1 Variant=Var1– -s1 Parameter=Var1– -v1 Var1

v If a variant does not exist, it is created with the parameters specified in thejob definition statement. In this case, all the required attributes of the variantmust be given a value. You cannot create empty variants. For example, if youspecify -vtemp1, with no value assigned, an empty temporary variant iserroneously created.

v If a variant is already present in the SAP system, its values are modifiedaccording to the command line

Documents

W o r kl o a d A u t o m a ti o n o n Cl o u d Ov e rvi e w · 2020-05-19 · Defining a job ..... . 9 Scheduling and submitting jobs and job str eams . . 9 ... Cloud job statuses