Jobs Class Methods

The AddConsDirect() method adds consumption information directly for an item, not necessarily through a job that has run on an entity. This means that consumption can be added to the item even if there is no job that produces this identified item.

The AddConsPostExec() overload method adds consumption data for the specified job after the job has run on the specified entity passing null to sublot_no.

The AddJobEvent() method adds a job event to the specified job. Job events include certification sign-off, adding production, adding consumption, reclassifying production, reclassifying consumption, completing a step, changing job specifications, and changing a job state.

The AddProd() method adds an amount of production to the specified entity with the specified reason code.

The AddProdPostExec() method adds production data for the specified job after the job has run on the specified entity.

The EndAllJobs() method attempts to end all jobs that are currently running on the specified entity. Any failure to end a job results in an error message being added to the end of the return string. All error messages in this return string are separated by a semi-colon (;) and contain the job information (work order, operation, sequence) and any message returned by the Middleware.

The EndJob() method ends the specified job. If the job is part of a batch, an attempt is made to end all jobs in the batch. Ending a job puts the job state into a Completed state.

The GetAllJobStates() method returns a DataSet containing the job states defined. A job state is the production state of a job. Examples include: Running, Paused, Completed, and Canceled.

The GetConfirmation() method prompts the user to confirm the selected job state, and returns the prompt response. Permitted actions are Starting, Pausing, and Ending jobs. Status notes are passed by reference in case the user modifies them when changing the job state.

The GetDownstreamOperations() method retrieves the downstream operations for the specified job and returns a DataSet containing the work order, operation, and sequence number of these downstream operations. Downstream operations are those operations of the job that occur in the same job route as the specified job.

The GetDownstreamProduction() method retrieves a DataSet of item_prod records for the specified job. Optionally, the item_prod records can be filtered to those that have the produced item as part of a specified lot and/or sublot.

The GetJob() method retrieves all of the job data for the specified job. Job data includes the current job state, the job priority, the required finish time, and quantity produced. The job is specified by a work order, an operation, and a sequence number.

This overload of the GetJobAttrs() method retrieves all defined attributes for the specified job from the database.

The GetJobBomAvailSubst() method retrieves a DataView containing all available substitute items for consumption. Available substitute items are defined as those items that are the intersection of the substitutes for the current job, and the union of the substitutes of all the upstream jobs that produce the same item as the current one at the job's BOM position 0.

The GetJobBOMData() method retrieves the BOM data for the specified job. The job is specified by a work order ID, an operation ID, and an operation sequence number. If a BOM position is specified, only the BOM data for that item is returned.

The GetJobBOMProducibles() method retrieves a DataView containing all the items that can be produced at the specified operation. The producible items are the items produced at BOM position 0 and any of its substitutes, along with all by-products and their substitutes. If a substitute is being produced, the column current_subst in the returned DataView contains an integer value identifying which alternative item is being produced. Otherwise, the current_subst column contains a null.

The GetJobBomSubst() method retrieves a DataView containing all substitute items for a job at the BOM position specified.

The GetJobBomSubstitutesForSerializedItem() method retrieves a DataView containing serialized item substitutes for all of the consumable BOM items of the specified job. A DataView is used to filter the data to contain only records in which the item of the job is a serialized item.

The GetJobBOMWithSubData() method retrieves BOM data, including substitute information for the specified job. The job is specified by a work order ID, an operation ID, and an operation sequence number. If a BOM position is specified, only the BOM data and BOM substitute data for that item are returned.

The GetJobEvents() method retrieves a DataSet containing all job event data for the specified job. Job events include a certification sign-off, adding production, adding consumption, reclassifying production, reclassifying consumption, completing a step, changing job specifications, and changing a job state. The data can be optionally filtered by step number and/or lot number.

The GetJobExecData() method retrieves all information for the specified job position and entity. This method is used to retrieve job exec information when there is no current entity and/or the job is not running. An entity contains a job exec object for each job position. Job-based login uses this to read the SuppressStartSomeQtyPrompt, AllowZeroQtySplit, and AutoAllocateQtyToRunningJob flags.

The GetJobQueue() method retrieves the queued jobs for the specified work order. The queue list can be further filtered by an item ID.

The GetJobsByWo() method retrieves a DataSet of all job information for jobs related to the specified work order.

The GetJobStateData() method retrieves a DataSet of all the Job State data (descriptions and colors) from the database.

The GetNextWoId() method retrieves the next available work order ID, assuming they are automatically generated.

The GetQueue() method retrieves a DataSet containing the job queue for the specified entity. The job queue consists of all jobs queued to the entity. Optionally, the jobs can be filtered by job state, the required-by date, and/or job priority. Pass the DataSet to populate by reference so the existing instance can continually be refreshed.

The GetScheduledJobForWo() method retrieves the first job sequence, which is the scheduled job, for the specified work order and operation.

The GetStartQtyOfItemInWO() method retrieves the start quantity of the specified item in the specified work order.

The GetWO() method retrieves a DataSet containing the work order data for the specified work order from the database. This data includes the description of the work order, the ID of the process that this work order uses, and the item ID of the item this work order produces.

The GetWoForSerializedItems() method retrieves all work orders that produce serialized items. Optional work order and item filters can be used to retrieve only the work order data for that work order and/or item.

The GetWORouteData() method retrieves all job routes related to the specified work order.

The IsFirstJob() method returns true if the operation specified is the first job of the work order, or false if it is not. If no work order, operation, or item ID is supplied, then true is returned if any of the operations of the job are for a first job.

The ItemConsSplit() method splits the specified amount of consumption off the specified row in the Item_Cons table and reallocates it to a new job if one is specified. This might result in a new row, or it might result in the increase of consumption quantity in another row.

The JobStateDesc() method returns the job state description for the job state specified.

The PopupCreateJobDialog() method opens a dialog prompting the user to select an item shortage on the specified entity. After the selection is made, the method opens a form for creating the work order that is needed to create the item.

The PopupJobBOMDlg() method opens a dialog to show the BOM components for the specified job. The dialog is read-only and contains a grid showing the information for each BOM component of the job. The job is specified by a work order ID, an operation ID, and an operation sequence number.

The PopupJobEventDlg() method opens the Job Event dialog for the specified job. A job is specified by a work order ID, an operation ID, and an operation sequence number. The Job Event dialog lists all job events recorded for the specified job and allows the user to edit the values recorded for the event. Events include certification sign-off, adding production, adding consumption, reclassifying production, reclassifying consumption, completing a step, changing a job specification, and changing a job state.

The PopupJobSplit() method opens the Job Split dialog to split the specified quantity of the job into a new job. The dialog allows for the entity on which the new job should be queued to be selected. Also, the quantity of the current job that is to be split off to the new job is specified. The new job is then created and queued to the specified entity with a start quantity equal to the quantity specified. The amount split to the new job is subtracted from the start quantity of the job from which the new job is being split.

The PopupSelectPausesStateDlg() method opens the dialog for selecting in which paused state to put the job. The three paused states are Suspended, OnHold, and New.

This overload of the PopupStartSomeDlg() method opens the Start Some dialog to split the specified job and start the new job on the current entity. The Start Some dialog allows the user to specify the start quantity of the new job created by the split and the required quantity. The start quantity cannot exceed the quantity available to split from the specified job. A new job is created with the quantity that is split from the specified job, and the new job is started on the current entity on which the user is working. The start quantity split to the new job is subtracted from the quantity left to produce of the specified job.

The SetJobConcurrentLink() method updates the current link value for the specified job. The link value is the value that links this job to other jobs in a batch. Jobs in a batch are processed together as a whole. If the concurrent link value is less than or equal to zero, the job is not part of a batch.

The SetJobQueue() method sets the new job state of the job. This method is used when changing from one paused state to another.

The SetProdProcessedFlag() method marks the specified row of the item_prod table as processed.

The SplitJob() method calls the Middleware to split the specified job into two jobs based on the split quantity. The new job is given a start quantity of the split quantity specified. This quantity is removed from the start quantity of the specified job.

The StartSome() method calls the Middleware to split the specified job into two jobs based on the split quantity and then start the new job created from the split on the specified entity. The new job is given a start quantity of the split quantity specified. This quantity is removed from the start quantity of the specified job.