Job Definitions - ResgreenGroup/Botway-Documentation GitHub Wiki

Current Location: Home->Customizing BotWay->Job Definitions

Job Definitions is a new dialogue window that was added in version 2.7.0 of BotWay. This feature separates job creation from the buttons dialogue window for reduced confusion when making jobs. The "Job Defs" dialogue window is used to create jobs. These jobs are assigned in the buttons dialogue window.

Figure 1: Job Definition dialogue window

Figure 1 shows the Job Definitions dialogue window. To get here, log in as admin, click "edit," then click "options," then click "Job Defs." The window is divided in half with the left half showing all created jobs and the right half allowing for creation or modifctaion of jobs. The left half has 4 buttons:

1. "Add" The "Add" button creates a new job and enables interaction with the right half of the window. Click "Save" or "Cancel" to exit job creation.

2. "Remove The remove button deletes an existing job. Select an existing job from the menu on the left half of the dialogue window, then click "Remove." This opens up a confirmation window. Press "Yes" to delete the selected job. Can only delete one job at a time: no multi-select.

3. "Edit / Save" When creating or editing a job, the "Edit" button changes to "Save." To edit a job, select an existing job and click "Edit." When adding or editing a job, click "Save" to save changes.

4. "Cancel" Use cancel to exit job creation or job editing without saving changes. Pressing "Cancel" when attempting to add a job will abort the job creation. Pressing "Cancel" when editing a job will discard any changes made.

To save all changes, click "Done." Changes to Job Definitions are saved when "Done" is pressed. Clicking "Save" or "Cancel" in the map display toolbar does not change anything.

The right half of the window contains the job creation information:

• Queue: dropdown menu that allows for queue selection. Populates with all defined queues. This specifies which queue the job will be placed into when its button is pressed.

• Priority: Dropdown menu with integers from 1 to 10, inclusive. When BotWay adds jobs to a queue, it checks the priority of the job about to be added. Lower numbers equal higher priority. Higher priority jobs are placed above other existing queued jobs with lower priority.

• Type: Specifies how exclusive the job is. Consecutive jobs can have an unlimited number queued, but only one job staged or active for that job definition. Concurrent jobs can have an unlimited number of jobs queued and an unlimited number of jobs staged or active for that job definition. Exclusive jobs can only have one job queued and one job staged or active for that job definition.

• Start Route: This names the route that the robot will change to when it accepts the job. It populates the dropdown menu with all routes from the route table.

• Start Tag: This is obsolete due to the concept of stations in a job queue. Fill this with one of the stations that can distribute this job (one of the stations for the queue that this job will be added to).

• End Route: This field specifies the route that the robot needs to be on in order to complete this job. BotWay will not complete a job until a robot with this job reaches this job's end tag while on this job's end route.

• End Tag: This specifies the tag that the robot needs to be at in order to complete this job. BotWay will not complete a job until a robot with this job reaches this job's end tag while on this job's end route.

• Start Status: This field specifies what status an instance of this job definition should have when it is given to a robot. It can be either "Active" or "Staged." If this status is set to "Active," then the robot will immediately embark on the route when it is given the job. If this is set to "Staged, the robot will change its route to the start route, but it will not go until the job status is set to active by another button.

• Status At End: This field specifies what status the job will change to when the job is completed. This can be either "Staged" or "Complete." If this field is set to "Complete," the job will be completed, and the robot will be eligible to take a new job. If this is "Staged," The job status will be set to staged and the robot will be ineligible to take a new job until another button changes the job status to "Complete."

• Completor ID: This is the name of the device that will complete a staged job. It is a dropdown menu that populates with every button from the buttons dialogue window.

• Stage Time Limit: This is a number of seconds after an instance of this job is staged that, when it elapses, causes BotWay to designate the job as "Late." On the Job Monitor application, the station where this job is staged will turn red.