AlertServerOnF91320

Scheduler Interactive NER Functions

Minor Business Rule

Object Name: N91300A

Parent DLL: CTOOL

Location: Client/Server

Language: NER

Data Structure

D91300Q - Alert Server on F91320 Change

Parameter NameData ItemData TypeReq/OptI/O/Both
mnAddedUpdatedF91320StartTimeSCHENTIMEMATH_NUMERICOPTINPUT

Specifies the time after which the scheduler will not submit a scheduled job. You can use this field to prohibit the scheduler from submitting a 
job after the specified time. For example, to ensure that a job does not run during normal business hours, you could specify a Last Allowed 
Start Time before the beginning of the business day. Specify the time as a Universal Time Coordinate (UTC), which is the number of seconds 
elapsed since Midnight on January 1, 170 in Greenwich, England. This used to be called Greenwich Mean (GM) Time.

cReturnEV01charOPTOUTPUT

0 - Error Fetching Control Record or communicating to the server.
1 - Passed in time is before next select time and successfully alerted the Scheduler Server.

2 - Passed in time is not before next select time.  Server not notified.

3 - Server is not running.  No checking is necessary.

4 - Scheduler has not been designated.  (i.e. the control record does not exist).

5 - Scheduler Server does not exist in the Data Source Master (F98611).  (i.e. the Scheduler Server 

name in the control record is either blank or contains a logical data source name that does not exist 

in the F98611.)

6 - Client's port number does not match the server's port number stated in the control record.

^

szUpdatedScheduledJobNameSCHJBNMcharOPTINPUT

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.

cModeEV01charREQINPUT

1 - F91320 changed  (mnAddedUpdatedF91320StartTime must be populated)
2 - F91300 changed  (szUpdatedScheduledJobName must be populated)

^

Related Functions

None

Related Tables

None
CommitRecurrencePatternToDB

CommitRecurrencePatternToDB

Scheduler Interactive NER Functions

Minor Business Rule

Object Name: N91300A

Parent DLL: CTOOL

Location: Client/Server

Language: NER

Data Structure

D91300D - Add Recurrence Pattern to database

Parameter NameData ItemData TypeReq/OptI/O/Both
szScheduledJobNameSCHJBNMcharREQINPUT

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.

mnSchedulerStartTimeSCHSTTIMEMATH_NUMERICREQINPUT

The start time of the job based on Universal Time Coordinate (UTC) Time. UTC Time is the number of seconds elapsed since Midnight on 
January 1, 1970 in Greenwich, England. UTC Time used to be called Greenwich Mean (GM) Time.

szRecurrenceTypeSCHRCRTYPcharREQINPUT

The type of interval for which the scheduled job should run, such as daily,weekly, monthly or yearly.

szTimeZonesTIMEZONEScharREQINPUT

Choose the time zone for which you want to view the date and time.

cDaylightSavingsDAYLIGHTSVcharREQINPUT

Indicates whether to adjust the local time for daylight savings time. The U.S. daylight savings standard is used.

mnScheduledMinutesSCHNUMMNSMATH_NUMERICOPTINPUT

Indicates the minutes between which the scheduler submits the job. For example, to schedule a job to run every 30 minutes, enter 30 in this 
field.

mnScheduledHoursSCHNUMHRSMATH_NUMERICOPTINPUT

Indicates the number of hours between which the scheduler submits the job. For example, to schedule a job to run every three hours enter 3 
in this field.

mnScheduleDaysSCHNUMDYMATH_NUMERICOPTINPUT

Indicates the actual number of days that a job should be run if the recurrence type for a job is Daily. If the recurrence type is Monthly or 
Yearly, this field indicates the day of the month on which the job is to be run.

mnScheduledWeeksSCHNUMWKSMATH_NUMERICOPTINPUT

If the recurrence type for a job is weekly, this field indicates the weekly interval for the job. For example, to schedule a job to run every two 
weeks,enter 2 in this field. To schedule a job to run every week, enter 1 in this field. If the recurrence type for a job is monthly, this field indicates 
on which week of the month the job runs. For example, to schedule a job to run on the second Monday of every four months, enter 2 in the 
Scheduled Weeks field

mnScheduledMonthSCHNUMMNMATH_NUMERICOPTINPUT

If the recurrence type for a job is Monthly, this field indicates the monthly interval for the job. For example, to schedule a job to run on the 
second Monday of every four months, enter 4 in this field. If the recurrence type for a job is yearly, this field indicates the numeric value of the 
month in which the job runs. For example, to schedule a job to run on the second Monday of June, enter 6 in this field.

cScheduledDaySCHDAYcharOPTINPUT

Indicates that a scheduled job will run on the day entered.

cWeekdayWEEKDAYcharOPTINPUT

Indicates that a scheduled job will run on every weekday.

cWeekendWEEKENDcharOPTINPUT

Indicates that a scheduled job will run on weekend days.

cMondayMONDAYcharOPTINPUT

Indicates that a scheduled job will run on a Monday.

cTuesdayTUESDAYcharOPTINPUT

Indicates that a scheduled job will run on a Tuesday.

cWednesdayWEDNESDAYcharOPTINPUT

Indicates that a scheduled job will run on a Wednesday.

cThursdayTHURSDAYcharOPTINPUT

Indicates that a scheduled job will run on a Thursday.

cFridayFRIDAYcharOPTINPUT

Indicates that a scheduled job will run on a Friday.

cSaturdaySATURDAYcharOPTINPUT

Indicates that a scheduled job will run on a Saturday.

cSundaySUNDAYcharOPTINPUT

Indicates that a scheduled job will run on a Sunday.

szCompanyCOcharOPTINPUT

A code that identifies a specific organization, fund, or other reporting entity. The company code must already exist in the Company 
Constants table (F0010) and must identify a reporting entity that has a complete balance sheet. At this level, you can have intercompany 
transactions. Note: You can use company 00000 for default values such as dates and automatic accounting instructions. You cannot use company 00000 
for transaction entries.

mnMaxScheduledRecordsMAXSCHRECSMATH_NUMERICOPTINPUT

When the recurrence type for a job has no end date, this number indicates the maximum number of active schedule records a job can have 
at one time. To maintain the number of job records, the scheduler adds a job scheduler record each time it starts this job.

mnSchedulerEndTimeSCHENTIMEMATH_NUMERICOPTINPUT

Specifies the time after which the scheduler will not submit a scheduled job. You can use this field to prohibit the scheduler from submitting a 
job after the specified time. For example, to ensure that a job does not run during normal business hours, you could specify a Last Allowed 
Start Time before the beginning of the business day. Specify the time as a Universal Time Coordinate (UTC), which is the number of seconds 
elapsed since Midnight on January 1, 170 in Greenwich, England. This used to be called Greenwich Mean (GM) Time.

szDaylightSavingsRuleNameDSAVNAMEcharOPTINPUT

Unique name identifying a daylight savings rule. Use daylight savings rules to adjust time for a geographic and political locale.

Related Functions

None

Related Tables

None
FetchUDCValueForDayOfWeek

FetchUDCValueForDayOfWeek

Scheduler Interactive NER Functions

Minor Business Rule

Object Name: N91300A

Parent DLL: CTOOL

Location: Client/Server

Language: NER

Based on the Day of Week parameters, this function will return the corresponding UDC value from 
H91/DW.  The Day of Week parameters come from the F91300 table.  This is used by the Scheduling Application 

to retrieve the UDC value & description.

^

Data Structure

D91300L - Fetch UDC Value From DayOfWeek Fields

Based on the Day of Week parameters, this function will return the corresponding UDC value from 
H91/DW.  The Day of Week parameters can only have one day switched on.  Allowed values for the Day of Week 

parameters are .

^

Parameter NameData ItemData TypeReq/OptI/O/Both
szDayOfWeekUDCValueKYcharREQOUTPUT

See UDC H91/DW for possible return values.
^

cWeekdayWEEKDAYcharREQINPUT

Indicates that a scheduled job will run on every weekday.

cWeekendWEEKENDcharREQINPUT

Indicates that a scheduled job will run on weekend days.

cMondayMONDAYcharREQINPUT

Indicates that a scheduled job will run on a Monday.

cTuesdayTUESDAYcharREQINPUT

Indicates that a scheduled job will run on a Tuesday.

cWednesdayWEDNESDAYcharREQINPUT

Indicates that a scheduled job will run on a Wednesday.

cThursdayTHURSDAYcharREQINPUT

Indicates that a scheduled job will run on a Thursday.

cFridayFRIDAYcharREQINPUT

Indicates that a scheduled job will run on a Friday.

cSaturdaySATURDAYcharREQINPUT

Indicates that a scheduled job will run on a Saturday.

cSundaySUNDAYcharREQINPUT

Indicates that a scheduled job will run on a Sunday.

szDayOfWeekDescriptionDESCcharOPTOUTPUT

A description, remark, name, or address.

cDaySCHDAYcharREQINPUT

Indicates that a scheduled job will run on the day entered.

Related Functions

None

Related Tables

None
MaintainScheduleInstanceRecords

MaintainScheduleInstanceRecords

Scheduler Interactive NER Functions

Minor Business Rule

Object Name: N91300A

Parent DLL: CTOOL

Location: Client/Server

Language: NER

Inserts and deletes schedule instance records (F91320) for a passed in job.  Also, able to toggle a schedule instance from Scheduled '01' to Hold 
'50'.

Data Structure

D91300P - Maintain Schedule Instance Records

If passing in the time as a date & time make sure they are set at Greenwich Mean Time.
^

Parameter NameData ItemData TypeReq/OptI/O/Both
szScheduledJobNameSCHJBNMcharREQINPUT

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.

mnScheduledUTCTimeSCHSTTIMEMATH_NUMERICOPTBOTH

UTC Time.  This is in Greenwich Mean Time format.
^

jdScheduledStartDateSCHJBSTDTJDEDATEOPTINPUT

The next date on which the Scheduler submits the scheduled job to the server for execution.

mnScheduledStartTimeSCHJBSTTMMATH_NUMERICOPTINPUT

The time at which the job will be submitted on the next scheduled start date.

cModeEV01charREQINPUT

1 - Inserts a Schedule Instance Record (F91320).  Either mnSchedulerStartTime or jdScheduledStartDate AND mnScheduledStartTime must be 
populted in addition to the job name.

2 - Deletes a Schedule Instance Record (F91320).  Either mnSchedulerStartTime or jdScheduledStartDate AND mnScheduledStartTime must be 

populted in addition to the job name.  Leaving them blank will delete all F91320 records for a job.

AND mnScheduledStartTime must be populted in addition to the job name.

3 - Toggles the launch status for Scheduler Instance Record between Scheduled (01) and Hold (50).  Returns in error if attempting to change any 

other launch status.


^

cReturnEV01charOPTOUTPUT

An option that specifies the type of processing for an event.

Related Functions

None

Related Tables

None
StoreUDCValueForDayOfWeek

StoreUDCValueForDayOfWeek

Scheduler Interactive NER Functions

Minor Business Rule

Object Name: N91300A

Parent DLL: CTOOL

Location: Client/Server

Language: NER

Based on the passed in UDC value (H91/DW) this function will output the corresponding day of week 
fields found in the F91300 table.

^

Data Structure

D91300M - Store UDC Value in Day Of Week Fields

Output from the Day of Week fields are .
^

Parameter NameData ItemData TypeReq/OptI/O/Both
szDayOfWeekUDCValueKYcharREQINPUT

See UDC H91/DW for allowed values.
^

cDaySCHDAYcharREQOUTPUT

Indicates that a scheduled job will run on the day entered.

cWeekdayWEEKDAYcharREQOUTPUT

Indicates that a scheduled job will run on every weekday.

cWeekendWEEKENDcharREQOUTPUT

Indicates that a scheduled job will run on weekend days.

cSundaySUNDAYcharREQOUTPUT

Indicates that a scheduled job will run on a Sunday.

cMondayMONDAYcharREQOUTPUT

Indicates that a scheduled job will run on a Monday.

cTuesdayTUESDAYcharREQOUTPUT

Indicates that a scheduled job will run on a Tuesday.

cWednesdayWEDNESDAYcharREQOUTPUT

Indicates that a scheduled job will run on a Wednesday.

cThursdayTHURSDAYcharREQOUTPUT

Indicates that a scheduled job will run on a Thursday.

cFridayFRIDAYcharREQOUTPUT

Indicates that a scheduled job will run on a Friday.

cSaturdaySATURDAYcharREQOUTPUT

Indicates that a scheduled job will run on a Saturday.

Related Functions

None

Related Tables

None
ValidateStartDateAndTime

ValidateStartDateAndTime

Scheduler Interactive NER Functions

Minor Business Rule

Object Name: N91300A

Parent DLL: CTOOL

Location: Client/Server

Language: NER

This function checks to see if the passed in date and time are in the past.  It it is, it sets an 
error on the date or time parameters.  The error is data item 096M.

^

Data Structure

D91300G - Validate Start Date and Time

If you are using a formatted string (ex. "12:30:00") then use the szScheduledStartTimeString member.  
If you are using a math numeric time (ex. 123000) then use the mnScheduledStartTime.

^

Parameter NameData ItemData TypeReq/OptI/O/Both
jdScheduledStartDateSCHJBSTDTJDEDATEREQINPUT

The next date on which the Scheduler submits the scheduled job to the server for execution.

szScheduledStartTimeStringSCHJSDSTRcharOPTINPUT

The time at which the job will be submitted on the next scheduled start date. This is in 24-hour format. For example, 03:00 is 3 AM and 18:00 is 
6 PM.

mnScheduledStartTimeSCHJBSTTMMATH_NUMERICOPTINPUT

The time at which the job will be submitted on the next scheduled start date.

cValidatedEV01charOPTOUTPUT

An option that specifies the type of processing for an event.

Related Functions

None

Related Tables

None
ValidateUDCDescription

ValidateUDCDescription

Scheduler Interactive NER Functions

Minor Business Rule

Object Name: N91300A

Parent DLL: CTOOL

Location: Client/Server

Language: NER

Data Structure

D91300N - Validate UDC Description

Parameter NameData ItemData TypeReq/OptI/O/Both
szSystemCodeSYcharREQINPUT

A user defined code (98/SY) that identifies a system. Valid values include: 01 Address Book 03B Accounts Receivable 04 Accounts 
Payable 09 General Accounting 11 Multicurrency

szUserDefinedCodesRTcharREQINPUT

A code that identifies the table that contains user defined codes. The table is also referred to as a UDC type.

szDescription001DL01charREQBOTH

A user defined name or remark.

szDescription01002DL02charOPTBOTH

Future Use.
^

szUserDefinedCodeKYcharOPTOUTPUT

A list of valid codes for a specific user defined code list.

cValidatedEV01charOPTOUTPUT

An option that specifies the type of processing for an event.

Related Functions

None

Related Tables

None