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 NameData ItemData TypeReq/OptI/O/Both
szLogicalServerNameDATPcharREQINPUT

The name that identifies the data source.

cModeEV01charREQINPUT

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.

^

szScheduledJobNameSCHJBNMcharOPTINPUT

This must be populated when the parameter, cMode, equals 4.
^

mnReturnMATH01MATH_NUMERICOPTOUTPUT

'1' - ER_SUCCESS
'2' - ER_ERROR

^

Related Functions

B9800100 Get Audit Information

Related Tables

F91300 Schedule Job Master
F98611 Data Source Master
DispatchToLocalScheduler

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 NameData ItemData TypeReq/OptI/O/Both
mnMessageMATH01MATH_NUMERICREQINPUT

'1' - Start Scheduler
'2' - Reset Scheduler

'3' - F91320 changed

'4' - Stop Scheduler

'5' - F91300 changed

'6' - Control Record Changed

'7' - Idle

^

szScheduledJobNameSCHJBNMcharOPTINPUT

Job Name of the changed header when sending the F91300 change message.
^

mnSleepTimeMATH01MATH_NUMERICREQINPUT

Number of seconds to sleep after running the scheduler dispatch function.
^

cReturnEV01charOPTOUTPUT

Not Used.
^

Related Functions

B9800100 Get Audit Information

Related Tables

F91300 Schedule Job Master
F98611 Data Source Master
LaunchBatchApplication

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 NameData ItemData TypeReq/OptI/O/Both
szReportOBNMcharREQINPUT

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

szVersionJDEJDEVERScharREQINPUT

The name given to identify a version of the software.

cSynchEV01charREQINPUT

1 - Run in synchronous mode 
0 - Run in Asynchronous  mode.ab 


^

cPrintPreviewEV01charREQINPUT

1 - Print Preview
0 - Send output to printer

^

szDataSourceOverrideDATPcharOPTINPUT

If left blank, OCM will be used to determine where the UBE will run.
^

mnServerJobNumberJOBNBRMATH_NUMERICOPTOUTPUT

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.

^

cReturnEV01charOPTOUTPUT

0 - Error in launch
1 - Success


^

cJDELoggingJDELOGcharREQINPUT

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

^

cTracingTRACINGcharREQINPUT

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.

^

cUBELoggingLevelUBELOGLVLcharREQINPUT

This is the logging level for the batch application. 0 - 6 where 0 is no logging and 6 is the highest 
logging level.

^

szJobQueueJOBQUEcharREQINPUT

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

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 NameData ItemData TypeReq/OptI/O/Both
szScheduledJobNameSCHJBNMcharREQNONE

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.

szDecryptedPasswordSCHPASWDcharOPTNONE

Related Functions

B9800100 Get Audit Information

Related Tables

F91300 Schedule Job Master
F98611 Data Source Master
UpdateControlRec

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 NameData ItemData TypeReq/OptI/O/Both
szRecordVersionSCHJBTYPcharREQINPUT

Used to update F91300.sjschjbtyp in the control record.  Identifies the format version of the control  record.ab 

^

szSchedulerServerNameSCHJOBSVRcharREQINPUT

Used to update F91300.sjschjobsvr in the control record.  Indicates the Scheduler  Server.ab 

^

szPortNumberSCHUSERcharREQINPUT

Used to update F91300.sjschuser in the control record.  Indicates the port number for the Scheduler  Server.ab 

^

szSystemFlagsSCHCTCD01charREQINPUT

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 


^

szJobMonitorSleepTimeSCHCTCD02charREQINPUT

Used to update F91300.sjschstcd02 in the control record.  Indicates the number of minutes in between job  monitoring.ab 

^

szSchedulerSleepTimeSCHCTCD03charREQINPUT

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 


^

szProgramMakingChangePIDcharREQINPUT

Used to update F91300.sjpid in the control record.  Part of the audit info for the control  record.ab 

^

cReturnEV01charOPTOUTPUT

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

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 NameData ItemData TypeReq/OptI/O/Both
szScheduledJobNameSCHJBNMcharREQNONE

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.

szDecryptedPasswordSCHPASWDcharOPTNONE

Related Functions

B9800100 Get Audit Information

Related Tables

F91300 Schedule Job Master
F98611 Data Source Master
ValidateUserPassword

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 NameData ItemData TypeReq/OptI/O/Both
szUserIdUSERcharREQINPUT

The code that identifies a user profile.

szOneWorldPasswordOWPWDcharREQINPUT

Unencrypted user password that the user entered.
^

szScheduledRoleSCHROLEcharREQINPUT

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