Ent Class Methods

This overload of the AddDirectory() method adds a directory to the directories of the current entity. A sequence number is passed to indicate whether the directory is an upload or download directory. The directory is saved in the dir table.

The AddShift() method adds a shift to the entity shift schedule of the current entity if the entity can schedule shifts.

Note: This method is no longer supported. Use the corresponding method in the Stateless API ShiftSchedule class.

The CopyEntityShiftSchedule() method takes a list of entity IDs and a string containing ordered pairs of shifts and copies the shift schedule from the entity defined by this entity object into each entity in the entity list. The shift schedule is copied to a listed entity only if that entity can schedule shifts.

Only those shifts that are identified are copied from the shift ID list. If a shift ID list is not available, all shifts defined for the entity are copied.

Note: This method is no longer supported. Use the corresponding method in the Stateless API ShiftSchedule class.

The DeleteShift() method removes the shift identified by the input parameters from the shift schedule of the entity identified by the entity object.

Note: This method is no longer supported. Use the corresponding method in the Stateless API ShiftSchedule class.

The EndJob() method ends the job that is identified by the input parameters. If the job is a part of a batch, an attempt is made to end all jobs in the batch. Ending a job changes the job state to Completed.

The EntIdFromName() method returns the entity ID of an entity, specified by its name. The entity ID is a unique integer value that represents each entity. If no entity is found, the method returns the value -1.

This overload of the GetDirectories() method retrieves the directories that are configured for the current entity. If a sequence number is specified, only the directory with a matching sequence number is returned.

The GetEntAttributes() method retrieves a DataSet of entity attributes. The DataSet can be filtered by an entity ID and/or an attribute ID.

The GetEntitiesWhichCanCaptureQMData() method retrieves a DataSet of all the entities which can capture qm data

The GetEntityShiftSchedule() method retrieves a DataSet containing all shifts defined for the entity by the entity object.

The GetJobPos() method retrieves the job position of the specified job by determining the job exec for the current entity on which the job is running.

The GetJobString() method retrieves a string containing the job information for the job that is running at the specified job position. The job information includes the job's work order, operation, and sequence.

The GetNumberOfJobsOnEntUserLoggedInto() method returns the number of jobs running on the entity into which the current user is logged.

The GetUsersOnEnt() method retrieves a list of all users who are logged into the current entity.

The PauseJob() method pauses the specified job that is currently running on this entity, or changes the paused state to another paused state. The job status is set to New, Suspended, or On Hold.

The PrepareProductionAttributes() method accepts a set of values for all production attributes and creates a data entry job to support logging utilization against these attributes.

The ProcessJobsBeforeLogoff() method processes the jobs being logged off by the specified user. The method first checks the system parameter to 'prompt for quantities' to see if it is true. If it is true, for each job the user is logging off, the user is prompted to enter production quantities. The method then determines if the user is the only user currently logged into the job and if the job can run without an operator. If it cannot, the job pauses before logging the user off of the job.

This overload of the PromptForQuantities() method prompts the user for production quantities for each running job that the user is logged onto on the entity.

This overload of the SetCurJobExec() method sets the current job exec to the job position on which the specified job is running. This sets the specified job as the current job on which the user is working.

The SetEntAttributes() method sets the value of the specified entity attribute for the given entity.

The StartJob() method starts a specified job on the entity. It searches for the first available job position and starts the job at that position. The entity contains multiple job positions if it can run multiple jobs at one time. A job position is available if no job is currently running on the exec.

The UpdateEntity() method updates the entity that is identified by the entity object with the new values supplied.

The UpdateJobExec() method updates the job exec record for the entity that is identified by this entity object. The method includes a lastEditAt DateTime parameter that can be used for optimistic concurrency control.

The UpdateShift() method updates the shift defined by the input parameters for the entity that is identified by the ent object. The method includes a lastEditAt DateTime parameter that can be used for optimistic concurrency control.

Note: This method is no longer supported. Use the corresponding method in the Stateless API ShiftSchedule class.