Difference between revisions of "Tasks"
From sbv.wiki
(Created page with "Set up tasks on your server to perform operations like polling punches and backing up the database. Use the Windows Task Scheduler pointing to either the Ta.WinAdmin.exe execu...") |
m |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | Below is a list of tasks that can be automated to run on a schedule: | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
* ? – will show you the available command line arguments. | * ? – will show you the available command line arguments. | ||
| + | * A - calculates the accruals. | ||
| + | * AD1 - recalculate all accruals from Day One. | ||
| + | * B - backup the database to the default location of \application folder\database\backup. | ||
| + | * DI - defragment the database indexes. | ||
| + | * DP - sets the default printer. Second parameter is the name or share name of the printer. | ||
| + | * DST - update DST information in the software then sends the configuration settings to the handpunches. | ||
| + | * EM - send employee messages to the time clocks. Optional next parameter of time clock key (PkTimeClockID) | ||
| + | * ERROR - Generates error to test automatic emailing of error messages. | ||
| + | * I - Import. Second parameter is the name of the file. | ||
| + | * L - Releases all locks (for lock troubleshooting only). | ||
| + | * LOG - as the last parameter, it will log the messages displayed in the tasks form. | ||
| + | * LP - Lists the printers (use to troubleshoot issues that a record is not going to a particular printer). | ||
| + | * OFF - Update Ta.config file offline setting value to true. | ||
| + | * ON - Update Ta.config file offline setting value to false. | ||
* P – polling and processing of active employees. This is the same as selecting Poll and All Employees in the Tools / [ Processing] screen. This gets all the punches from the time clocks, processes them and then performs all the calculations for the previous (if open), current and next pay periods regardless of whether or not the employee punches. This includes building schedules, checking holidays, checking auto punches as well as calculating hours for any punches. This is recommended as a daily task, especially if you have auto punching or auto hours employees. | * P – polling and processing of active employees. This is the same as selecting Poll and All Employees in the Tools / [ Processing] screen. This gets all the punches from the time clocks, processes them and then performs all the calculations for the previous (if open), current and next pay periods regardless of whether or not the employee punches. This includes building schedules, checking holidays, checking auto punches as well as calculating hours for any punches. This is recommended as a daily task, especially if you have auto punching or auto hours employees. | ||
| + | * PA - Processing of all employees (without polling). | ||
* PP – polling and processing of employees with punches. This is the same as selecting Poll and Employees With Punches in the Tools / Processing screen. It is recommended that this be done at least every hour and is typically run every few minutes if you are using Ethernet communications. If you are using modem communications and paying for each phone call, then you will want to limit the number of times you poll per day. | * PP – polling and processing of employees with punches. This is the same as selecting Poll and Employees With Punches in the Tools / Processing screen. It is recommended that this be done at least every hour and is typically run every few minutes if you are using Ethernet communications. If you are using modem communications and paying for each phone call, then you will want to limit the number of times you poll per day. | ||
* PO – polling only. This is the same as selecting Poll and No Processing in the Tools / Processing screen. If the computer doing the polling is used by an employee, then this is the least intrusive method. However, punches will not show in the time cards until the processing is done through the P or PP task or from the Tools/ Processing screen. | * PO – polling only. This is the same as selecting Poll and No Processing in the Tools / Processing screen. If the computer doing the polling is used by an employee, then this is the least intrusive method. However, punches will not show in the time cards until the processing is done through the P or PP task or from the Tools/ Processing screen. | ||
| + | * PZ - Send punching zones to the time clocks. Optional next parameter of time clock key (PkTimeClockID). | ||
| + | * PZH - Send punching zones to the time clocks once an hour. Optional next parameter of time clock key (PkTimeClockID). | ||
* QS – quick synch. This synchronizes the hand templates in the same manner as Synch Users (see below), but not to any HandPunches marked as “No Quick Task Synching.” | * QS – quick synch. This synchronizes the hand templates in the same manner as Synch Users (see below), but not to any HandPunches marked as “No Quick Task Synching.” | ||
| + | * QSH - Synchronizes once an hour the employees in the HandPunches that are not marked as "No Quick Task Synching". | ||
* S – synch users. This synchronizes the hand templates in the best possible manner. New templates will be distributed, existing templates will be updated, and employees no longer required to be punching will be removed. Recommended as a daily task, and more frequently if using multiple HandPunches. | * S – synch users. This synchronizes the hand templates in the best possible manner. New templates will be distributed, existing templates will be updated, and employees no longer required to be punching will be removed. Recommended as a daily task, and more frequently if using multiple HandPunches. | ||
| − | * | + | * SH - Synchronizes the employees in all HandPunches once an hour. |
| + | * SL - SmartLinx integration query (current and next week). | ||
| + | * SLP - SmarLinx integration query (previous day). | ||
* R – report. The report ID/Name is the second argument, with an optional third argument: | * R – report. The report ID/Name is the second argument, with an optional third argument: | ||
| − | ** VIEWER will open the report on screen. This | + | ** VIEWER will open the report on screen. This allows a user who does not directly use the software to be given a shortcut to run and view a report “live”. |
** PRINTER will send the report directly to the default printer. An optional fourth argument allows the printer name to be provided. | ** PRINTER will send the report directly to the default printer. An optional fourth argument allows the printer name to be provided. | ||
** EMAIL will have the report emailed as an attachment to the list of email recipients supplied on the Schedule tab, when the saved report was created. | ** EMAIL will have the report emailed as an attachment to the list of email recipients supplied on the Schedule tab, when the saved report was created. | ||
| Line 21: | Line 35: | ||
** A path and file name will have the report saved to disk. A “\” in the third argument is the identifier that this is a path and file name. | ** A path and file name will have the report saved to disk. A “\” in the third argument is the identifier that this is a path and file name. | ||
** If the third argument is not specified, then it will default to EMAIL. | ** If the third argument is not specified, then it will default to EMAIL. | ||
| − | * | + | * T – set time (if successfully updated from NIST). If the computer successfully connects to the NIST atomic clock service, then this time will be sent to all time clocks as well as setting the time on the computer. Recommended as a daily task. |
| − | * US – update the employee settings based on the current date. This primarily inactivates employees once the pay period in which they were made inactive | + | * TH - Sets the time once per hour on all HandPunches if the computer time is successfully updated from NIST (atomic clock) and updates the system time. |
| − | * | + | * TO - Set the time on all HandPunches if the computer time is successfully updated from NIST (atomic clock). This is done WITHOUT updating the system time. |
| + | * TOH - Set the time once per hour on all Handpunches if the computer time is successfully updated from NIST (atomic clock). This is done WITHOUT updating the system time. | ||
| + | * TCA - Assigns the HandPunches to each employee based on the assignments between labor levels and timeclocks. | ||
| + | * TCAH - Once an hour it assigns the HandPunches to each employee based on the assignments between labor levels and timeclocks. | ||
| + | * TS - Updates Team Support system with information. | ||
| + | * US – update the employee settings based on the current date. This primarily inactivates employees once the pay period in which they were made inactive has been processed and paid but also determines the current employee settings for the date based settings provided as part of the employee’s history. Recommended as a daily task. | ||
| + | * X - issues the exit application message to all users. | ||
| + | * XO - issues the exit application message to all users including when the application is offline. | ||
| + | |||
| − | + | ==See Also== | |
| + | *[[System Configuration]] | ||
| − | * | + | *[[Installation]] |
| − | + | ||
Latest revision as of 18:04, 30 October 2023
Below is a list of tasks that can be automated to run on a schedule:
- ? – will show you the available command line arguments.
- A - calculates the accruals.
- AD1 - recalculate all accruals from Day One.
- B - backup the database to the default location of \application folder\database\backup.
- DI - defragment the database indexes.
- DP - sets the default printer. Second parameter is the name or share name of the printer.
- DST - update DST information in the software then sends the configuration settings to the handpunches.
- EM - send employee messages to the time clocks. Optional next parameter of time clock key (PkTimeClockID)
- ERROR - Generates error to test automatic emailing of error messages.
- I - Import. Second parameter is the name of the file.
- L - Releases all locks (for lock troubleshooting only).
- LOG - as the last parameter, it will log the messages displayed in the tasks form.
- LP - Lists the printers (use to troubleshoot issues that a record is not going to a particular printer).
- OFF - Update Ta.config file offline setting value to true.
- ON - Update Ta.config file offline setting value to false.
- P – polling and processing of active employees. This is the same as selecting Poll and All Employees in the Tools / [ Processing] screen. This gets all the punches from the time clocks, processes them and then performs all the calculations for the previous (if open), current and next pay periods regardless of whether or not the employee punches. This includes building schedules, checking holidays, checking auto punches as well as calculating hours for any punches. This is recommended as a daily task, especially if you have auto punching or auto hours employees.
- PA - Processing of all employees (without polling).
- PP – polling and processing of employees with punches. This is the same as selecting Poll and Employees With Punches in the Tools / Processing screen. It is recommended that this be done at least every hour and is typically run every few minutes if you are using Ethernet communications. If you are using modem communications and paying for each phone call, then you will want to limit the number of times you poll per day.
- PO – polling only. This is the same as selecting Poll and No Processing in the Tools / Processing screen. If the computer doing the polling is used by an employee, then this is the least intrusive method. However, punches will not show in the time cards until the processing is done through the P or PP task or from the Tools/ Processing screen.
- PZ - Send punching zones to the time clocks. Optional next parameter of time clock key (PkTimeClockID).
- PZH - Send punching zones to the time clocks once an hour. Optional next parameter of time clock key (PkTimeClockID).
- QS – quick synch. This synchronizes the hand templates in the same manner as Synch Users (see below), but not to any HandPunches marked as “No Quick Task Synching.”
- QSH - Synchronizes once an hour the employees in the HandPunches that are not marked as "No Quick Task Synching".
- S – synch users. This synchronizes the hand templates in the best possible manner. New templates will be distributed, existing templates will be updated, and employees no longer required to be punching will be removed. Recommended as a daily task, and more frequently if using multiple HandPunches.
- SH - Synchronizes the employees in all HandPunches once an hour.
- SL - SmartLinx integration query (current and next week).
- SLP - SmarLinx integration query (previous day).
- R – report. The report ID/Name is the second argument, with an optional third argument:
- VIEWER will open the report on screen. This allows a user who does not directly use the software to be given a shortcut to run and view a report “live”.
- PRINTER will send the report directly to the default printer. An optional fourth argument allows the printer name to be provided.
- EMAIL will have the report emailed as an attachment to the list of email recipients supplied on the Schedule tab, when the saved report was created.
- A list of email addresses will have the report emailed as an attachment. An “@” in the third argument is the identifier that this as a list of email address.
- A path and file name will have the report saved to disk. A “\” in the third argument is the identifier that this is a path and file name.
- If the third argument is not specified, then it will default to EMAIL.
- T – set time (if successfully updated from NIST). If the computer successfully connects to the NIST atomic clock service, then this time will be sent to all time clocks as well as setting the time on the computer. Recommended as a daily task.
- TH - Sets the time once per hour on all HandPunches if the computer time is successfully updated from NIST (atomic clock) and updates the system time.
- TO - Set the time on all HandPunches if the computer time is successfully updated from NIST (atomic clock). This is done WITHOUT updating the system time.
- TOH - Set the time once per hour on all Handpunches if the computer time is successfully updated from NIST (atomic clock). This is done WITHOUT updating the system time.
- TCA - Assigns the HandPunches to each employee based on the assignments between labor levels and timeclocks.
- TCAH - Once an hour it assigns the HandPunches to each employee based on the assignments between labor levels and timeclocks.
- TS - Updates Team Support system with information.
- US – update the employee settings based on the current date. This primarily inactivates employees once the pay period in which they were made inactive has been processed and paid but also determines the current employee settings for the date based settings provided as part of the employee’s history. Recommended as a daily task.
- X - issues the exit application message to all users.
- XO - issues the exit application message to all users including when the application is offline.
