State Form Task Scheduler

Last updated
Save as PDF

Use the State Form Task Scheduler to include state form definitions in the System Task Scheduler so they can be generated automatically.

The State Form Task Scheduler allows you to associate Definitions to the System Task Scheduler so they can be generated automatically, thus automating the repetitive task of creating compiles to be done during off hours so they can be worked on during office hours. This allows for a more proactive workflow in catching data-related errors as files can be generated periodically before they are sent to the state so the myAvatar Error report can be reviewed.

Prerequisites:

A state form definition must be created in the State Form Definition form.
The state form definition file path must be defined in the State Form Definition form.

For the Type of definition, select either Single Definition or Batch.
In the Select Batch or Definition field, select the option that goes with the definition type.
In the File Description field, enter the task description.
Result: This description will display in the System Task Scheduler form, Schedule(s) field.
In the Generate Flag On Complete field:

Select Yes to flag each row that is processed during the compile.
Flagged rows are not included in future compiles, unless the flag is removed with the Remove State Form Processing Flags form.
If No is selected, each row will not be flagged and can appear in another scheduled run.

In the Create File field:

Select Yes to create the file on server when the task is run.
Note: A file path and file name must be defined in the State Form Definition form in order to select Yes.
Select No to not create a file when the task is run.

When you have completed all the sections on the form (see below), click Submit.
Result: The file will be available in the System Task Scheduler form, Schedule(s) field.

From Date Setup

Specify criteria for the start date for the scheduled task.

For the Change From Date, select whether the start date should be changed on a daily, monthly, or yearly basis, or should remain static.
- Daily - Enter the Days Prior to Compile Date.
- Monthly - Select the Day of Month and the Months Prior to Compile Date.
- Yearly - Select the Month and the Day of Month.
- Static - Select a month/day/year. Use the T icon (today), the Y icon (yesterday), or scroll up/down arrows to select a date.

Through Date Setup

Enter the end date for the scheduled task.

For the Change Through Date, select whether the through (end) date should be changed on a daily, monthly, or yearly basis, or should remain static.
- Daily - Enter the Days Prior to Compile Date.
- Monthly - Select the Day of Month and the Months Prior to Compile Date.
- Yearly - Select the Month and the Day of Month.
- Static - Select a month/day/year. Use the T icon (today), the Y icon (yesterday), or scroll up/down arrows to select a date.

Entity Inclusion and Exclusion

Select one or more entity lists to include on compile and exclude on compile.

For the include and exclude functionality to work, you must set the Entity ID column of the primary table for each record.

Include Entities

If one or more lists are selected, only entities contained in those lists will be included in the compile.
If the same entity is present in both an include and an exclude list, it will be excluded.

Exclude Entities

If one or more lists are selected, all entities contained in those lists will be excluded from the compile.
If the same entity is present in both an include and an exclude list, it will be excluded.

FTP Setup

Specify the location on the FTP server where files created by the scheduled process will be sent.

Selecting Yes to send the file to the FTP server authorizes any files created by this scheduled process to be sent to the location specified in the FTP Setup.

Select the FTP Type.
Enter the following information:

Server Directory
Server Host Name
Service Port Number
Server Username
Server Password

Once the above fields are filled out, click Test FTP Connection to test the connection to the FTP server to ensure that it is viable.
If the connection test completes successfully, select Yes for Send File to FTP Server.