WrkCtrScheduler Class [AX 2012]

The WrkCtrScheduler class implements the base functionality for job scheduling.

Syntax

class WrkCtrScheduler

Run On

Server

Methods

	Method	Description
	addExclusiveJobToSchedule	Adds a job to an exclusive list of jobs of a certain order that should be scheduled.
	addGroupProperties	Adds the required properties to a property map.
	addInfologMessage	Adds an Infolog entry for an order that failed scheduling.
	addInfologMessages	Adds Infolog messages for the orders that failed scheduling and that have not been added to the reschedule queue.
	addJobToOverlapJobList	Adds a job to the overlap job list to be included when emitting the overlap constraint.
	addPropertyAggregations	Adds property aggregations to the scheduling engine.
	addResourceGroupMembership	Adds resource to resource group membership records to the scheduling engine data model.
	addToRescheduleQueue	Adds a WrkCtrParmSchedule record that contains the parameters that are used to schedule an order into the reschedule queue of the engine.
	addToUpdatedOrdersMap	Adds a new order to the map of updated orders.
	addWrkCtrParmSchedule	Adds a WrkCtrParmSchedule record that contains the parameters that are used to schedule an order into the scheduling list of the engine.
	applicableResourceGroupsFromResources	Gets applicable resource groups from list of applicable resources.
	blankRoute	Retrieves a blank route operation record as a Common table buffer.
	calculateResourcePriority	Calculates the resource priority based on the requirements and the priority date.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	canSchedule	Checks if an order can be scheduled.
	capacityRefType	Retrieves the capacity reservation type.
	capacityTypeReservation	Retrieves the type of scheduling being done, job or operation scheduling, for a specific order scheduling parameters record.
	checkSchedulingDirectionChange	Checks whether the scheduling direction was changed during scheduling.
	checkSingleJobSchedApplicableResources	Checks that a resource meets the requirements of an operation in a specified time period when a job is scheduled.
	cleanUpOrder	Cleans up the order data when the scheduling fails.
	clearListWrkCtrParmSchedule	Clears the list that contains all orders to schedule.
	computeJobGoal	Computes the job goal depending on the current bill of materials (BOM) level.
	computeJobTime	Computes the runtime of a job.
	computeJobTimes	Computes the runtime of a job for each resource in a specified list.
	countNumberOfCapabilities	Counts the number of capability requirements.
	createBOMCalcData	Creates an instance of the BOMCalcData class for a given order.
	createEngine	Creates the C# job scheduling engine and the appropriate engine data provider.
	createTmpRoute	Creates a temporary route operation record as a Common table buffer.
	createTmpRouteJob	Creates a temporary job record and returns it as a Common table buffer.
	deleteAllTemporaryJobs	Deletes all of the temporary jobs.
	deleteTemporaryJob	Deletes a temporary job.
	dispose	Disposes of the resources that are held by the scheduling engine.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	findJobWrkCtrParmSchedule	Finds the WrkCtrParmSchedule object for the order that a specific job belongs to.
	findRefId	Finds an order in the master data and returns the order record.
	findWrkCtrParameters	Determines the correct WrkCtrParametersDim for an order.
	fixedJobTimesForResources	Fills a map that contains a fixed job time for each resource in a given resource list.
	flushCachedSaveData	Flushes the saved capacity reservation and the capacity reservation properties records to the database.
	getExclusiveJobList	Gets a set of jobs that should be scheduled for a certain order, if only some of the jobs should be scheduled.
	getProductionUnitAndWarehouse	Retrieves the production unit and warehouse that is assigned to the route.
	getResourceRequirement	Gets the resource ID when the requirements map contains a resource requirement. Otherwise, an empty string is returned.
	getResourceRequirementProperties	Gets a map of requirement properties for the specific resource used by a given job.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	handleCapacityConflicts	Handles the capacity reservation conflicts.
	handleRouteLessOrder	Inserts a placeholder job to enable the engine to schedule orders without routes.
	infologPrefixOprNum	Retrieves the prefix to be displayed in the Infolog based on a specific job ID.
	init	Initializes the engine variables.
	initCache	Clears the scheduling engine caches.
	initCapacityReservationData	Fills the capacity reservation record with the appropriate scheduler data.
	initCapResHandler	Initializes the capacity reservation flags that are used to determine how overbooking checks are performed.
	initNumTypes	Initializes the typically used values for job types.
	initOrderData	Initializes the master data structures.
	initOverlapMaps
	initParallelJobsMap	Initializes the map that tracks the parallel jobs for each job type.
	inputWarehouse	Retrieves the input warehouse ID for a specific operation record.
	insertCalendarResource	Inserts an scheduling engine resource into the scheduling engine.
	insertEmptyJob	Inserts an empty job to enable the engine to schedule jobless operations.
	insertJob	Inserts a job to be scheduled into the engine data pool.
	insertJobAndConstraints	Inserts jobs and constraints to be scheduled into the engine data pool.
	insertJobGoalConstraints	Creates constraints that depend on the scheduling goal for a given job.
	insertLeadTimeJob	Inserts a lead time job to enable the engine to schedule routeless orders.
	insertNotOnSameResConstraints	Emits constraints for jobs that should not be scheduled on the same resource.
	insertOverlapLinks	Inserts the links that are generated by the overlap jobs.
	insertParallelJob	Inserts a parallel job in the internal map that is used to track parallel jobs for each job type.
	insertParallelJobsConstraints	Emits all the constraints for all the parallel jobs of a certain type.
	insertResource	Inserts a resource into the resource list of the scheduling engine.
	insertWrkCtrCapResUsingInsertList	Inserts the given capacity reservation using the internal record insert list.
	keyOrder	Retrieves a value that can be used in maps that have the order ID as their key.
	keyRoute	Computes a key for an operation.
	leadTimeParameters	Computes the lead time parameters for a given order.
	limitCapPO	Specifies whether the capacity reservations that are derived from planned orders will be included in the calculation of available capacity when scheduling is executed.
	limitCapProd	Indicates whether the capacity reservations that are derived from production orders will be included in the calculation of available capacity when it executes scheduling.
	limitCapProject	Specifies whether the reservations that are derived from projects will be included in the calculation of available capacity when executing scheduling.
	limitedCapacity	Computes whether limited capacity should be used when scheduling a certain order and using a specific resource.
	limitedCapacityToDate	Computes the capacity time fence for an order and a specific resource.
	limitMaterialDate	Enforces the rule that an operation cannot start earlier than the materials are available when scheduling with finite materials.
	loadData	Loads the data needed for the engine to schedule a list of production orders.
	loadJobsDetail	Loads the job information for the jobs of one operation into the scheduling engine.
	loadOrder	Loads data for one order that is scheduled.
	loadPreviouslyUsedResources	Loads the previously used resources for each primary operation.
	loadRoute	Loads into the scheduling engine all information needed for scheduling a route for an order.
	mustKeepJobResourceAssignment	Computes a boolean value that indicates whether the current job resource assignment must be kept.
	new	Initializes a new instance of the WrkCtrScheduler class.
	notify	Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
	notifyAll	Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	onSaveJobsDone	Occurs when the save operation for the jobs in the database is finished.
	onSaveJobsStart	Executes before a save operation starts for the scheduled jobs in the database.
	owner	Returns the instance that owns the object. (Inherited from Object.)
	parmCapResHandler	Gets or sets the CapResHandler parameter.
	parmCheckLockingTTSLevel	Gets or sets the CheckLockingTTSLevel parameter.
	parmRefIdField	Gets or sets the RefIdField parameter.
	parmReqPlanVersionRefRecId	Gets or sets the ReqPlanVersionRefRecId parameter.
	parmResetWorkingTimesCacheForEachRun	Gets or sets the ResetWorkingTimesCacheForEachRun parameter.
	parmRouteOprNumField	Gets or sets the RouteOprNumField parameter.
	parmRouteRefIdField	Gets or sets the RouteRefIdField parameter.
	parmSchedulingEngine	Gets or sets the SchedulingEngine parameter.
	parmWrkCtrCapResConflictCheckIntervals	Gets or sets the WrkCtrCapResConflictCheckIntervals parameter.
	parmWrkCtrCapResHandler	Gets or sets the WrkCtrCapResHandler parameter.
	prepareCapacityCheckIntervals	Inserts the conflict check intervals.
	processLastJob	Performs post processing actions on the last inserted job for an order.
	productionUnit	Retrieves the production unit ID assigned to the resource or resource group previously used to schedule a specific operation.
	refLineType	The reference line type that is on the ReqTrans records for the current order.
	requirementsAllowFastSetup	Indicates whether the requirements support a fast setup.
	reset	Resets the scheduler, preparing it for a new scheduling run.
	run	Performs a scheduling run.
	saveData	Saves the data for all the scheduled orders to the AX database.
	saveJobs	Saves job information to the database.
	saveOperation	Saves the scheduling results for an operation to the database.
	saveOrder	Saves the scheduling results for an order.
	saveOrdersAndRelated	Saves order and related data.
	saveRoutes	Saves the route information, or operation information, to the database.
	schedStatus	Retrieves the scheduling status, either Job scheduled or Operation scheduled, based scheduling method requested for a certain order.
	schedulingErrorOccured	Indicates whether any errors occurred during scheduling.
	schedulingProperties	Retrieves the scheduling properties for a given activity requirement set, site and scheduling method.
	setCapacityConflictHandler	Sets the capacity conflict handler that will be used during resource scheduling.
	setResourceRequirementInRequirementMap	Sets the properties map entry for the current operation priority to a specific resource requirement.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	transferBatchTimeToProcessTimeRatio	Determines the ratio between the time that is required to process one transferrable batch and the total time of the specified operation.
	updateRequirementSetAndPropertiesMaps	Updates the maps of the requirements and properties.
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	validateCapacityConflicts	Validates capacity reservation conflicts.
	wait	Pauses a process. (Inherited from Object.)
	writeAllCapacityReservationProperties	Writes all of the properties of an object to the WrkCtrCapResProperty table.
	writeCapacityReservation	Writes a capacity reservation record to the database.
	writeJobCapacityReservations	Writes the capacity reservations for one job to the database.
	writeJobData	Writes the job data to the database.
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::construct	Initializes a new instance of the WrkCtrScheduler class.
	::incrementWrkCtrCapResTimestamp	Increments the timestamp value to be used for capacity reservations timestamps.Holds a lock on WrkCtrSchedulerLock until the transaction is completed.
	::newRefType	Creates a new engine based on the type of order that has to be scheduled.
	::propertyHashtable	Converts a Map object that contains job requirement properties to a System.Collections.Hashtable object.
	::resourceAsList	Creates a list that contains only one resource identifier.

Top

Remarks

This class can be specialized to implement specific job scheduling needs, such as production orders scheduling.

Inheritance Hierarchy

Object Class
  WrkCtrScheduler Class
    WrkCtrScheduler_Prod Class
    WrkCtrScheduler_Proj Class
    WrkCtrScheduler_Req Class