CommunicateWithScheduler

Scheduler Business Functions

Major Business Rule

Object Name: B91300C

Parent DLL: CTOOL

Location: Client/Server

Language: C

1.Functional Description

1.1Purpose
This function sends a message to the Scheduler Server.

1.2Setup Notes and Prerequisites
This function is to be used by the Scheduler Applications only. If another application attempts to
call this function for any reason, the Scheduler Server may become unstable.

1.3Special Logic
• If the Scheduler is running on an enterprise server: This function calls the Scheduler's client side
dispatch function to send a message to the Scheduler kernel via JDENET.
• If the Scheduler is running locally: This function will use inter-process communication to send a
message to the local Scheduler Server that is running inside of a UBE.
• This function has Win32 specific code that is only compiled when the compiler definition, IAMASERVER
is not defined.

^

Data Structure

D91300O - Communicate With Scheduler Server

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szLogicalServerName	DATP	char	REQ	INPUT
The name that identifies the data source.
cMode	EV01	char	REQ	INPUT
1 - Start Scheduler Server. 2 - Re-Set Scheduler Server. 3 - Signal Scheduler that F91320 changed. 4 - Signal Scheduler that F91300 changed. szScheduledJobName must be populated with the job that changed. 5 - Signal Schedule to stop (i.e. to set the idle time to infinite.) 6 - Signal the Control Record has changed. ^
szScheduledJobName	SCHJBNM	char	OPT	INPUT
This must be populated when the parameter, cMode, equals 4. ^
mnReturn	MATH01	MATH_NUMERIC	OPT	OUTPUT
'1' - ER_SUCCESS '2' - ER_ERROR ^

Related Functions

B9800100 Get Audit Information

Related Tables

F91300 Schedule Job Master
F98611 Data Source Master

DispatchToLocalScheduler

Scheduler Business Functions

Major Business Rule

Object Name: B91300C

Parent DLL: CTOOL

Location: Client/Server

Language: C

1.Functional Description

1.1Purpose
This function receives messages sent by CommunicateWithScheduler() for the Local Scheduler Server.

1.2Setup Notes and Prerequisites
This function is to be used by the Local Scheduler UBE (R91320A). If another application attempts to
call this function for any reason, the Scheduler Server may become unstable.

1.3Special Logic
• This function receives messages from CommunicateWithScheduler() through inter-process communication.
• This function has Win32 specific code that is only compiled when the compiler definition, IAMASERVER
is not defined.

^

Data Structure

D91300U - Dispatch Message to Local Scheduler

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
mnMessage	MATH01	MATH_NUMERIC	REQ	INPUT
'1' - Start Scheduler '2' - Reset Scheduler '3' - F91320 changed '4' - Stop Scheduler '5' - F91300 changed '6' - Control Record Changed '7' - Idle ^
szScheduledJobName	SCHJBNM	char	OPT	INPUT
Job Name of the changed header when sending the F91300 change message. ^
mnSleepTime	MATH01	MATH_NUMERIC	REQ	INPUT
Number of seconds to sleep after running the scheduler dispatch function. ^
cReturn	EV01	char	OPT	OUTPUT
Not Used. ^

Related Functions

B9800100 Get Audit Information

Related Tables

F91300 Schedule Job Master
F98611 Data Source Master

LaunchBatchApplication

Scheduler Business Functions

Major Business Rule

Object Name: B91300C

Parent DLL: CTOOL

Location: Client/Server

Language: C

Functional Description
This function launches a UBE from ER.  Unlike Report Interconnect, this launches UBEs with out Report
Interconnect and returns an error status.  However, Report Interconnect cannot be used.

Purpose
To be able to launch UBEs without Report Interconnect from Event Rules and be able to check the
return status of that UBE.

Setup Notes and Prerequisites
If called in synchronous mode, the BSFN will return error if the UBE failed along the way (blow-ups,
spec not found, etc.).  In asynchronous mode, the BSFN will return error only if it failed to launch.

If the data source override is left blank, then OCM will be used to determine where the UBE will run.

Data Structure

D91300T - Launch Batch Application

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szReport	OBNM	char	REQ	INPUT
The name that identifies a system object. J.D. Edwards ERP architecture is object-based. Discrete software objects are the building blocks for all applications, and developers can reuse the objects in multiple applications. The Object Librarian tracks each object. Examples of system objects include: o Batch Applications (such as reports) o Interactive Applications o Business Views o Business Functions o Business Functions Data Structures o Event Rules o Media Object Data Structures
szVersionJDE	JDEVERS	char	REQ	INPUT
The name given to identify a version of the software.
cSynch	EV01	char	REQ	INPUT
1 - Run in synchronous mode 0 - Run in Asynchronous mode.ab ^
cPrintPreview	EV01	char	REQ	INPUT
1 - Print Preview 0 - Send output to printer ^
szDataSourceOverride	DATP	char	OPT	INPUT
If left blank, OCM will be used to determine where the UBE will run. ^
mnServerJobNumber	JOBNBR	MATH_NUMERIC	OPT	OUTPUT
This is only populated if the batch application was launched on a server sucessfully. This is the job number as seen in the Work With Servers application. ^
cReturn	EV01	char	OPT	OUTPUT
0 - Error in launch 1 - Success ^
cJDELogging	JDELOG	char	REQ	INPUT
Indicate whether you want the batch engine to produce a jde.log file for this batch application. 1 - produce a jde.log 0 - do not produce a jde.log ^
cTracing	TRACING	char	REQ	INPUT
Indicate whether you want the batch engine to produce a jdedebug.log file for this batch application. 1 - produce a jdedebug.log 0 - do not produce a jdedebug.log Note: If this selection is switched on, a jde.log file will always be produced. ^
cUBELoggingLevel	UBELOGLVL	char	REQ	INPUT
This is the logging level for the batch application. 0 - 6 where 0 is no logging and 6 is the highest logging level. ^
szJobQueue	JOBQUE	char	REQ	INPUT
Used to override the job queue the UBE will be placed in if run on a server. ^

Related Functions

B9800100 Get Audit Information

Related Tables

F91300 Schedule Job Master
F98611 Data Source Master

RetrievePasswordForAJob

Scheduler Business Functions

Minor Business Rule

Object Name: B91300C

Parent DLL: CTOOL

Location: Client/Server

Language: C

Data Structure

D91300W - The data structure for LDAP in B91300C

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szScheduledJobName	SCHJBNM	char	REQ	NONE
A name that uniquely identifies to the system and the user a scheduled job. Use this name to indicate the job function, such as Monthly Close or Nightly Back Up.
szDecryptedPassword	SCHPASWD	char	OPT	NONE

Related Functions

B9800100 Get Audit Information

Related Tables

F91300 Schedule Job Master
F98611 Data Source Master

UpdateControlRec

Scheduler Business Functions

Major Business Rule

Object Name: B91300C

Parent DLL: CTOOL

Location: Client/Server

Language: C

1.Functional Description

1.1Purpose
This function updates the Scheduler Control record in the F91300.  The Scheduler Control record controls and indicates the status of the Scheduler
Server.  It is identified as the record in the F91300 with a job name = '*SCHEDULER'.

1.2Setup Notes and Prerequisites
This function is to be used by the Scheduler Application (P91300) only.  If another application attempts to call this function for any reason, the Scheduler
Server may become unstable.

1.3Special Logic
This function uses record locking to update the scheduler control record.

^

Data Structure

D91300V - Update Scheduler's Control Record

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szRecordVersion	SCHJBTYP	char	REQ	INPUT
Used to update F91300.sjschjbtyp in the control record. Identifies the format version of the control record.ab ^
szSchedulerServerName	SCHJOBSVR	char	REQ	INPUT
Used to update F91300.sjschjobsvr in the control record. Indicates the Scheduler Server.ab ^
szPortNumber	SCHUSER	char	REQ	INPUT
Used to update F91300.sjschuser in the control record. Indicates the port number for the Scheduler Server.ab ^
szSystemFlags	SCHCTCD01	char	REQ	INPUT
Used to update F91300.sjschstcd01 in the control record. Each char in this field is a flag indicating a server status: 1st - Server up/down 2nd - Launcher up/down 3rd - Monitor up/downab ^
szJobMonitorSleepTime	SCHCTCD02	char	REQ	INPUT
Used to update F91300.sjschstcd02 in the control record. Indicates the number of minutes in between job monitoring.ab ^
szSchedulerSleepTime	SCHCTCD03	char	REQ	INPUT
Used to update F91300.sjschstcd03 in the control record. Indicates the number of seconds the server sleeps in between checks for launching and/or monitoring.ab ^
szProgramMakingChange	PID	char	REQ	INPUT
Used to update F91300.sjpid in the control record. Part of the audit info for the control record.ab ^
cReturn	EV01	char	OPT	OUTPUT
Return values: '1' - Server was up : returned when the server name/port was attempted to be updated but the server was up. The control record was not updated. '2' - Server was down : returned when the launcher/monitor were being paused or activated but the server was down. The control record was updated except for the system flag field (sjschstcd01).ab ^

Related Functions

B9800100 Get Audit Information

Related Tables

F91300 Schedule Job Master
F98611 Data Source Master

UpdatePasswordForAJobInF91300

Scheduler Business Functions

Minor Business Rule

Object Name: B91300C

Parent DLL: CTOOL

Location: Client/Server

Language: C

Data Structure

D91300W - The data structure for LDAP in B91300C

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szScheduledJobName	SCHJBNM	char	REQ	NONE
A name that uniquely identifies to the system and the user a scheduled job. Use this name to indicate the job function, such as Monthly Close or Nightly Back Up.
szDecryptedPassword	SCHPASWD	char	OPT	NONE

Related Functions

B9800100 Get Audit Information

Related Tables

F91300 Schedule Job Master
F98611 Data Source Master

ValidateUserPassword

Scheduler Business Functions

Minor Business Rule

Object Name: B91300C

Parent DLL: CTOOL

Location: Client/Server

Language: C

1.Functional Description

1.1Purpose
This function validates the OneWorld sign-on password for a user.

1.2Setup Notes and Prerequisites
None

1.3Special Logic
This function calls the security API, jdeSecValidateUser(). Will return ER_SUCCESS if this API returns true.

^

Data Structure

D91300C - Validate User Sign-on Password

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szUserId	USER	char	REQ	INPUT
The code that identifies a user profile.
szOneWorldPassword	OWPWD	char	REQ	INPUT
Unencrypted user password that the user entered. ^
szScheduledRole	SCHROLE	char	REQ	INPUT
The role of the user who is submitting the job.

Related Functions

B9800100 Get Audit Information

Related Tables

F91300 Schedule Job Master
F98611 Data Source Master