Thursday 8 October 2015

Chapter 15: Oracle E-Business Suite Jobs



Chapter 15: Oracle E-Business Suite Jobs 


Oracle E-Business Suite Jobs 
You can define jobs to run Oracle E-Business Suite workload. 
Note: To run these jobs, your system requires CA WA Agent for UNIX, Linux, or Windows 
and CA WA Agent for Oracle E-Business Suite. 
You can define the following Oracle E-Business Suite jobs: 
Copy Single Request Job 
Copies an existing single request defined on Oracle Applications and runs it under 
the agent. 
Request Set Job 
Runs multiple programs in an Oracle Applications application. 
Single Request Job 
Runs a single program in an Oracle Applications application. 
Define an Oracle E-Business Suite Copy Single Request Job 
You can define an Oracle E-Business Suite Copy Single Request (OACOPY) job to copy an 
existing single request defined on Oracle E-Business Suite and run it under the agent. 
When the job runs, it can override values in the original definition with values specified 
on the agent or in the job definition. The OACOPY job is useful when you want to reuse 
existing job definitions. 
Note: To run these jobs, your system requires CA WA Agent for UNIX, Linux, or Windows 
and CA WA Agent for Oracle E-Business Suite. 
 Define an Oracle E-Business Suite Copy Single Request Job 
Follow these steps: 
1. Insert a job and specify the following attributes in the definition: 
job_type: OACOPY 
Specifies that the job type is Oracle E-Business Suite Copy Single Request. 
machine 
Specifies the name of the machine on which the job runs. 
request_id 
Specifies the request ID of the Oracle E-Business Suite request you want to 
copy. 
2. Do one of the following: 
■ Ensure that a default Oracle E-Business Suite user name and responsibility 
name are defined in the agent's agentparm.txt file using the oa.default.user 
and oa.default.responsibility parameters, respectively. 
■ Add the following attributes to the definition: 
oracle_user 
Specifies the Oracle E-Business Suite user name that the job runs under. 
 Note: This attribute overrides the oa.default.user agent parameter. 
oracle_resp 
Specifies an Oracle E-Business Suite responsibility name. 
 Note: This attribute overrides the oa.default.responsibility agent 
parameter. 
 Define an Oracle E-Business Suite Copy Single Request Job 
Chapter 15: Oracle E-Business Suite Jobs 379 
3. (Optional) Specify optional Oracle E-Business Suite Copy Single Request attributes: 
■ job_class 
■ job_terminator 
■ oracle_custom_property 
■ oracle_mon_children 
■ oracle_mon_children_delay 
■ oracle_notify_display_users 
■ oracle_notify_users 
■ oracle_output_format 
■ oracle_quote_in_default 
■ oracle_template_language 
■ oracle_template_territory 
4. (Optional) Specify common attributes that apply to all jobs. 
The Oracle E-Business Suite Copy Single Request job is defined. 
Notes: 
■ Attributes that have a default value automatically apply to the job definitions; 
therefore, they are optional. For example, jobs with no specified job type are 
defined as command jobs by default. Other optional attributes specify information 
that is not required but affects how or when a job runs, such as attributes that 
specify scheduling conditions. 
■ Some optional attributes are common to all job types but others apply to certain 
jobs types only. Optional attributes that apply to all job types are known as 
common optional attributes. For more information about common optional 
attributes and the values that you can specify for them (including their default 
values when applicable), see the Reference Guide. 
■ For information about required attributes and job type specific optional attributes, 
see the procedure topics that provide instructions for defining jobs. 
■ This guide provides instructions for defining jobs interactively. You also create job 
definitions in script files and then import them using the jil command or use CA 
WCC to define them. For more information about the JIL command and JIL syntax, 
see the Reference Guide. For more information about using CA WCC to define the 
job, see the CA Workload Control Center Workload Scheduling Guide. 
 Define an Oracle E-Business Suite Request Set Job 
380 User Guide 
Example: Copy a Single Request 
Suppose that you want to copy an existing single request defined on Oracle E-Business 
Suite. In this example, the job copies the single request job with request ID 2255470 and 
overrides the Oracle E-Business Suite user name and responsibility name defined in the 
agentparm.txt file. 
insert_job: oacopy_single 
job_type: oacopy 
machine: oaagent 
request_id: 2255470 
oracle_user: SYSADMIN 
oracle_resp: System Administrator 
Define an Oracle E-Business Suite Request Set Job 
You can define an Oracle E-Business Suite Request Set (OASET) job to run a request set 
program. You must get the following information from the original Oracle E-Business 
Suite request set: 
■ Display name or short name of the Oracle E-Business Suite application the request 
set belongs to 
■ Request set short name or display name 
■ User name that the job runs under 
■ Responsibility name 
Note: To run these jobs, your system requires CA WA Agent for UNIX, Linux, or Windows 
and CA WA Agent for Oracle E-Business Suite. 
Follow these steps: 
1. Insert a job and specify the following attributes in the definition: 
job_type: OASET 
Specifies that the job type is Oracle E-Business Suite Request Set. 
machine 
Specifies the name of the machine on which the job runs. 
oracle_appl_name 
Specifies the name of the Oracle E-Business Suite application that the request 
set belongs to. 
oracle_req_set 
Specifies the request set short name or display name depending on the 
oracle_req_set_type attribute. 
 Define an Oracle E-Business Suite Request Set Job 
Chapter 15: Oracle E-Business Suite Jobs 381 
2. Do one of the following: 
■ Ensure that a default Oracle E-Business Suite user name and responsibility 
name are defined in the agent's agentparm.txt file using the oa.default.user 
and oa.default.responsibility parameters, respectively. 
■ Add the following attributes to the definition: 
oracle_user 
Specifies the Oracle E-Business Suite user name that the job runs under. 
 Note: This attribute overrides the oa.default.user agent parameter. 
oracle_resp 
Specifies an Oracle E-Business Suite responsibility name. 
 Note: This attribute overrides the oa.default.responsibility agent 
parameter. 
3. (Optional) Specify optional Oracle E-Business Suite Request Set attributes: 
■ job_class 
■ job_terminator 
■ oracle_appl_name_type 
■ oracle_custom_property 
■ oracle_mon_children 
■ oracle_mon_children_delay 
■ oracle_output_format 
■ oracle_print_copies 
■ oracle_print_style 
■ oracle_printer 
■ oracle_programdata 
■ oracle_quote_in_default 
■ oracle_req_set_type 
■ oracle_save_output 
■ oracle_template_language 
■ oracle_template_territory 
■ oracle_use_arg_def 
■ oracle_use_set_defaults_first 
4. (Optional) Specify common attributes that apply to all job types. 
The Oracle E-Business Suite Request Set job is defined. 
 Define an Oracle E-Business Suite Request Set Job 
382 User Guide 
Notes: 
■ Attributes that have a default value automatically apply to the job definitions; 
therefore, they are optional. For example, jobs with no specified job type are 
defined as command jobs by default. Other optional attributes specify information 
that is not required but affects how or when a job runs, such as attributes that 
specify scheduling conditions. 
■ Some optional attributes are common to all job types but others apply to certain 
jobs types only. Optional attributes that apply to all job types are known as 
common optional attributes. For more information about common optional 
attributes and the values that you can specify for them (including their default 
values when applicable), see the Reference Guide. 
■ For information about required attributes and job type specific optional attributes, 
see the procedure topics that provide instructions for defining jobs. 
■ This guide provides instructions for defining jobs interactively. You also create job 
definitions in script files and then import them using the jil command or use CA 
WCC to define them. For more information about the JIL command and JIL syntax, 
see the Reference Guide. For more information about using CA WCC to define the 
job, see the CA Workload Control Center Workload Scheduling Guide. 
Example: Run a Request Set 
This example runs a request set named FNDRSSUB1310. The request set belongs to the 
application with the short name BIS in Oracle E-Business Suite. The job uses the default 
Oracle E-Business Suite responsibility name and user name defined on the agent. 
insert_job: oaset_resp 
job_type: oaset 
machine: oaagent 
oracle_appl_name_type: SHORT 
oracle_appl_name: BIS 
oracle_req_set: FNDRSSUB1310 Define an Oracle E-Business Suite Request Set Job 
Chapter 15: Oracle E-Business Suite Jobs 383 
Specify Data for an Individual Program in a Request Set 
When you define an Oracle E-Business Suite Request Set (OASET) job, you can specify 
data for an individual program in the request set. This data overrides the arguments and 
print parameters specified for the entire request set. You can specify the following data 
for a program: 
■ Program arguments 
■ Printer 
■ Print style 
■ Number of copies to print 
■ Whether to save the output from the program 
■ List of user names to notify using short or display names 
■ Output format 
■ Template language and template territory 
■ Whether to quote resolved expressions in default values 
Follow these steps: 
1. Define an Oracle E-Business Suite Request Set job (see page 380). 
2. Add the following attribute to the job definition: 
oracle_programdata 
Specifies data for an individual program in an Oracle E-Business Suite request 
set. 
3. Run the job. 
The data is specified for the program. 
Note: For more information about JIL job types and other job definition attributes, the 
values that you can specify for those attributes, and JIL syntax, see the Reference Guide. 
Example: Specify Values for Individual Programs in a Request Set 
Suppose that you want to run an Oracle E-Business Suite request set named EXTRACTS 
on the oaagent agent. The request set belongs to the application with the display name 
Application Object Library in Oracle E-Business Suite. The job definition specifies the 
following default settings for all programs in the request set: 
■ The number of copies to be printed is 1. 
■ The print style is LANDSCAPE. 
■ The printer is \\printer path\Q8. 
 Define an Oracle E-Business Suite Request Set Job 
384 User Guide 
The first oracle_programdata attribute overrides the default values for the first program 
in the request set. The first program uses the arguments T23 and R1 and prints two 
copies using the \\printer path\Q1 printer in PORTRAIT style. 
The second oracle_programdata attribute overrides the default values for the fifth 
program in the request set. The fifth program uses arguments R and R1 and prints three 
copies using the \\printer path\Q2 printer in PORTRAIT style. 
The other programs in the request set use the default values. 
insert_job: oaset_prog 
job_type: oaset 
machine: oaagent 
oracle_appl_name_type: DISPLAY 
oracle_appl_name: Application Object Library 
oracle_req_set: EXTRACTS 
oracle_user: SYSADMIN 
oracle_resp: System Administrator 
oracle_printer: "\\printer path\Q8" 
oracle_print_style: LANDSCAPE 
oracle_print_copies: 1 
oracle_programdata: index=1, args="T23,,R1", printer="\\printer\Q1", 
print_style=PORTRAIT, print_copies=2, saveop=Y 
oracle_programdata: index=5, args="R,R1,", printer="\\printer\Q2", 
print_style=PORTRAIT, print_copies=3, saveop=N 
Suppose that you want to run an Oracle E-Business Suite request set named 
FNDRSSUB1310 on the local host. The request set belongs to the application with the 
short name BIS in Oracle E-Business Suite. The SYSADMIN and ASGUEST users are 
notified when the single request completes on QATEST1. 
The first oracle_programdata attribute overrides the default values for the first program 
in the request set. The first program uses the output format as PDF, the template 
language is English, and template territory is US. 
The second oracle_programdata attribute overrides the default values for the fifth 
program in the request set. The second program uses the output format as EXCEL, the 
template language is English, and template territory is US. 
 Define an Oracle E-Business Suite Request Set Job 
Chapter 15: Oracle E-Business Suite Jobs 385 
The other programs in the request set use the default values. 
delete_job: test_OASET 
insert_job: oaset_fmt 
job_type: OASET 
machine: localhost 
oracle_user: SYSADMIN 
oracle_resp: System Administrator 
oracle_appl_name_type: SHORT 
oracle_appl_name: BIS 
oracle_req_name_type: DISPLAY 
oracle_req_set: FNDRSSUB1310 
oracle_use_arg_def: Y 
oracle_programdata: index=1, output_format=PDF, template_language=en, 
template_territory=US, notify_users="'SYSADMIN','ASGUEST','QATEST1'" 
oracle_programdata: index=2, output_format=EXCEL, template_language=en, 
template_territory=US, notify_users="'SYSADMIN','ASGUEST','QATEST1'" 
group: OA 
Specify Argument Values to Pass to a Program in a Request Set 
You can pass argument values to an individual program in an Oracle E-Business Suite 
Request Set (OASET) job. The job can also use the default values that are defined by the 
registered Oracle Applications Concurrent Manager program. When an argument value 
is defined in both the job definition and as a default, the argument value in the job 
definition overrides the default. 
Follow these steps: 
1. Define an Oracle E-Business Suite Request Set job (see page 380). 
2. Add the following attribute to the job definition: 
oracle_programdata 
Specifies data for an individual program in an Oracle E-Business Suite request 
set. 
3. (Optional) Add the following attribute: 
oracle_use_arg_def 
Specifies whether to use default values for arguments that are not defined 
using the oracle_programdata attribute. 
4. Run the job. 
The argument values are passed to the program in the request set. 
Note: For more information about JIL job types and other job definition attributes, the 
values that you can specify for those attributes, and JIL syntax, see the Reference Guide. 
 Define an Oracle E-Business Suite Single Request Job 
386 User Guide 
Example: Specify Argument Values for a Program in a Request Set 
This example runs an Oracle E-Business Suite Request Set job that uses the argument 
defaults in Oracle E-Business Suite and the argument values defined in the job 
definition. The second program in the request set has four arguments and you want to 
pass T23 as the first value and R1 as the fourth value. The argument string specifies 
placeholders for the second and third arguments, so the job uses the default values for 
those arguments. 
insert_job: oaset_prog 
job_type: oaset 
machine: oaagent 
oracle_appl_name_type: DISPLAY 
oracle_appl_name: Application Object Library 
oracle_req_set: EXTRACTS 
oracle_user: SYSADMIN 
oracle_resp: System Administrator 
oracle_use_arg_def: Y 
oracle_programdata: index=2, args="T23,,R1", printer="\\printer\Q1", 
print_style=PORTRAIT, print_copies=2, saveop=Y 
Define an Oracle E-Business Suite Single Request Job 
You can define an Oracle E-Business Suite Single Request (OASG) job to run a single 
request program. You must get the following information from the original Oracle 
E-Business Suite single request: 
■ Display name or short name of the Oracle E-Business Suite application the single 
request belongs to 
■ Program short name or display name 
■ User name that the job runs under 
■ Responsibility name 
Note: To run these jobs, your system requires CA WA Agent for UNIX, Linux, or Windows 
and CA WA Agent for Oracle E-Business Suite. 
Follow these steps: 
1. Insert a job and specify the following attributes in the definition: 
job_type: OASG 
Specifies that the job type is Oracle E-Business Suite Single Request. 
machine 
Specifies the name of the machine on which the job runs. 
 Define an Oracle E-Business Suite Single Request Job 
Chapter 15: Oracle E-Business Suite Jobs 387 
oracle_appl_name 
Specifies the name of the Oracle E-Business Suite application that the single 
request belongs to. 
oracle_program 
Specifies the single request program short name or display name depending on 
the oracle_program_name_type attribute. 
2. Do one of the following: 
■ Ensure that a default Oracle E-Business Suite user name and responsibility 
name are defined in the agent's agentparm.txt file using the oa.default.user 
and oa.default.responsibility parameters, respectively. 
■ Add the following attributes to the definition: 
oracle_user 
Specifies the Oracle E-Business Suite user name that the job runs under. 
 Note: This attribute overrides the oa.default.user agent parameter. 
oracle_resp 
Specifies an Oracle E-Business Suite responsibility name. 
 Note: This attribute overrides the oa.default.responsibility agent 
parameter. 
3. (Optional) Specify optional Oracle E-Business Suite Single Request attributes: 
■ job_class 
■ job_terminator 
■ oracle_appl_name_type 
■ oracle_args 
■ oracle_custom_property 
■ oracle_desc 
■ oracle_mon_children 
 Define an Oracle E-Business Suite Single Request Job 
388 User Guide 
■ oracle_mon_children_delay 
■ oracle_notify_display_users 
■ oracle_notify_users 
■ oracle_output_format 
■ oracle_print_copies 
■ oracle_print_style 
■ oracle_printer 
■ oracle_program_name_type 
■ oracle_quote_in_default 
■ oracle_save_output 
■ oracle_template_language 
■ oracle_template_territory 
■ oracle_use_arg_def 
4. (Optional) Specify common attributes that apply to all job types. 
The Oracle E-Business Suite Single Request job is defined. 
Notes: 
■ Attributes that have a default value automatically apply to the job definitions; 
therefore, they are optional. For example, jobs with no specified job type are 
defined as command jobs by default. Other optional attributes specify information 
that is not required but affects how or when a job runs, such as attributes that 
specify scheduling conditions. 
■ Some optional attributes are common to all job types but others apply to certain 
jobs types only. Optional attributes that apply to all job types are known as 
common optional attributes. For more information about common optional 
attributes and the values that you can specify for them (including their default 
values when applicable), see the Reference Guide. 
■ For information about required attributes and job type specific optional attributes, 
see the procedure topics that provide instructions for defining jobs. 
■ This guide provides instructions for defining jobs interactively. You also create job 
definitions in script files and then import them using the jil command or use CA 
WCC to define them. For more information about the JIL command and JIL syntax, 
see the Reference Guide. For more information about using CA WCC to define the 
job, see the CA Workload Control Center Workload Scheduling Guide. 
 Define an Oracle E-Business Suite Single Request Job 
Chapter 15: Oracle E-Business Suite Jobs 389 
Example: Run a Single Request 
This example runs a single request program named FNDSCARU. The single request 
belongs to the application with the short name ACCOUNTS in Oracle E-Business Suite. 
The job runs under the SYSADMIN user with System Administrator responsibility. 
insert_job: oasg_short 
job_type: oasg 
machine: oaagent 
oracle_appl_name_type: SHORT 
oracle_appl_name: ACCOUNTS 
oracle_program: FNDSCARU 
oracle_user: SYSADMIN 
oracle_resp: System Administrator 
Specify Argument Values to Pass to a Program in a Single Request 
You can pass argument values to a program in an Oracle E-Business Suite Single Request 
(OASG) job. The job can also use the default values that are defined by the registered 
Oracle Applications Concurrent Manager program. When an argument value is defined 
in both the job definition and as a default, the argument value in the job definition 
overrides the default. 
Follow these steps: 
1. Define an Oracle E-Business Suite Single Request job (see page 386). 
2. Add the following attribute to the job definition: 
oracle_args 
Defines the argument values to pass to an Oracle E-Business Suite single 
request. 
3. (Optional) Add the following attribute: 
oracle_use_arg_def 
Specifies whether to use default values for arguments that are not defined 
using the oracle_args attribute. 
4. Run the job. 
The argument values are passed to the program in the single request. 
Note: For more information about JIL job types and other job definition attributes, the 
values that you can specify for those attributes, and JIL syntax, see the Reference Guide. 
 Attributes with Default Values 
390 User Guide 
Example: Specify Argument Values for a Single Request 
Suppose that you want to pass the argument values, T,DefArg2,X23,,DefArg5, to a single 
request program. The job uses the argument values that are specified in the job 
definition and the default values defined in Oracle E-Business Suite as follows: 
■ The first argument, T, and the third argument, X23, are specified in the job 
definition. 
■ The second argument, DefArg2, and the fifth argument, DefArg5, are defined as 
defaults in Oracle E-Business Suite. 
■ The fourth argument is not specified in the job definition or defined as a default on 
Oracle E-Business Suite, so the agent passes an empty string for that argument. 
insert_job: oasg_args 
job_type: oasg 
machine: oaagent 
oracle_appl_name_type: DISPLAY 
oracle_appl_name: Application Object Library 
oracle_user: SYSADMIN 
oracle_resp: System Administrator 
oracle_program: FNDSCARU 
oracle_use_arg_def: Y 
oracle_args: T,,X23,, 
Attributes with Default Values 
Attributes that have a default value automatically apply to the job definition. Therefore, 
you do not have to specify those attributes in the definition. Your agent administrator 
can define some default values on the agent in the agentparm.txt file. 
If you specify the attribute in a job definition, it overrides the default. 
The following Oracle E-Business Suite job attributes have default values: 
oracle_appl_name_type 
Specifies whether the name of the Oracle E-Business Suite application is the short 
name or the display name. 
Default: SHORT 
oracle_desc (OASG jobs only) 
Defines a description for the Oracle E-Business Suite Single Request job, which is 
displayed in the Oracle Concurrent Manager. 
Default: oa.default.desc agent parameter, if specified 
 Attributes with Default Values 
Chapter 15: Oracle E-Business Suite Jobs 391 
oracle_mon_children 
Specifies whether the children of the Oracle E-Business Suite programs are 
monitored. 
Default: N (The job does not monitor children programs.) 
oracle_output_format 
Specifies the output format for a single request or request set. 
Default: oa.default.outputFormat agent parameter, if specified 
oracle_print_style 
Specifies an Oracle Applications print style. 
Default: oa.default.printStyle agent parameter, if specified 
oracle_printer 
Specifies the name of a printer to be used by Oracle Applications. 
Default: oa.default.printer agent parameter, if specified 
oracle_program_name_type (OASG jobs only) 
Identifies whether the name of the Oracle E-Business Suite program is the short 
name or the display name. 
Default: SHORT 
oracle_quote_in_default 
Specifies whether to quote resolved expressions in default values. 
Default: N (The resolved expressions in default values are not quoted.) 
oracle_req_set_type (OASET jobs only) 
Identifies whether the name of the Oracle E-Business Suite request set is the short 
name or the display name. 
Default: SHORT 
oracle_resp 
Specifies an Oracle Applications responsibility name. You must also specify an 
Oracle Applications user name using the oracle_user attribute or by setting the 
oa.default.user parameter in the agentparm.txt file. 
Default: oa.default.responsibility agent parameter, if specified 
Note: All Oracle Applications jobs require a responsibility name. If you do not 
specify this attribute in the job definition, a default responsibility name must be 
defined in the agent's agentparm.txt file using the oa.default.responsibility 
parameter. Otherwise, the job fails. 
 Attributes with Default Values 
392 User Guide 
oracle_save_output (OASG and OASET jobs only) 
Specifies whether to save the output from an Oracle E-Business Suite Single 
Request or Request Set job. 
Default: N (The job does not save the output.) 
oracle_template_language 
Specifies the template language for a single request or request set. 
Default: oa.default.templateLanguage agent parameter, if specified 
oracle_template_territory 
Specifies the template territory for a single request or request set. 
Default: oa.default.templateTerritory agent parameter, if specified 
oracle_use_arg_def (OASG and OASET jobs only) 
Specifies whether to use default values for arguments that not defined using the 
oracle_args attribute or the oracle_programdata attribute. The default arguments 
are defined in Oracle E-Business Suite. 
Default: N (The job does not use the default values for the arguments.) 
oracle_use_set_defaults_first (OASET job only) 
Specifies whether request set defaults take precedence over concurrent program 
defaults in Oracle Applications. 
Default: N ( The concurrent program defaults take precedence over request set 
defaults.) or oa.default.useSetDefaultsFirst agent parameter, if specified. 
oracle_user 
Specifies an Oracle Applications user name that the job runs under. 
Default: oa.default.user agent parameter, if specified 
Note: All Oracle Applications jobs require a user name. If you do not specify this 
attribute in the job definition, a default user must be defined in the agent's 
agentparm.txt file using the oa.default.user parameter. Otherwise, the job fails. 
Note: For more information about JIL job types and other job definition attributes, the 
values that you can specify for those attributes, and JIL syntax, see the Reference Guide. 
 Attributes with Default Values 
Chapter 15: Oracle E-Business Suite Jobs 393 
Example: Override a Default Value in an OASET Job 
This example overrides the default responsibility name using the oracle_resp attribute. 
The job also overrides the default user that the job runs under using the oracle_user 
attribute. 
insert_job: oaset_resp 
job_type: oaset 
machine: oaagent 
oracle_appl_name_type: SHORT 
oracle_appl_name: BIS 
oracle_req_set: FNDRSSUB1310 
oracle_user: SYSADMIN 
oracle_resp: System Administrator 

No comments:

Post a Comment