After setting up the automated task framework and, if desired, creating a custom automated task controller, use the Automated Task Configuration application to schedule, execute, and log automated tasks.

To begin using the Automated Task Configuration application:

1. Within your server's file system, navigate to Ingeniux CMS 10.x.
2. Click Automated Tasks. The Automated Task Configuration application opens.
3. Configure your new automated task by opening each of the following tabs:
   • Tasks: To schedule automated tasks.
   • Settings: To configure email settings.
   • Logging: To view Automated Task log files.

To schedule automated tasks:

1. On the Tasks tab, click New Task. (The other buttons, Open Task and Remove Tasks, open a saved task from the list or remove it, respectively.)

   

2. Configure the following values:
   • Task Name: A friendly name for the automated task.
   • Task URL: The path to the controller where the task is located. This controller must be stored in a child folder of xml\Custom.
   • Execution User: The user (domain\username) who is setting the task. In this case, the user is ATF.
     

     Note: Consider creating a local user in the CMS without a password. This user must be added to the Administrators group. This user only serves to execute automated tasks, so it's easy to find this user's activity in the CSAPI logs.

   • Execution Starting Date: The date on which the task will begin executing.
   • Execution Time: The time at which the task will begin executing.
   • Execution Cycle: How often the task executes. Can be set in minutes, hours, days, or weeks.
   • Script Timeout: If the task takes longer to complete than this time value, the task times out. The default value is 60 minutes.
3. Select the Execute task... option if you want the configured task to execute after a restart if the application were to miss a scheduled cycle.
4. Click Save. Windows Explorer opens.
5. Select a location to save the automated task configuration file.
6. Click Save again. The task displays on the list at the top of the application.

The Automated Tasks Framework sends email notifications if errors occur, so you need to configure email settings.

To configure email settings:

1. Click the Settings tab.
2. Configure the following values:

   

   • Email Server: The email server address (e.g., mail.yourcompany.com).
   • Port: The port used for email transactions. The default port number is 25.
   • Log Switching Cycle: How often the system writes to a new notification log. Can be set in days, or weeks.

     Note: This option helps to limit the size of individual log files.

   • Sender Friendly Name: The sender's name that will be used in the notification email.
   • Sender Address: The sender's email address.
   • Receiver Friendly Name: The name of the receiver of the email who will be used in the notification email.
   • Receiver Address: The receiver's email address.

To view an automated task log files:

1. Click the Logging tab.
2. In the Select Log drop-down list, choose an XML log file by date. Its information populates the table.

   

   Note: Additional information is available in the Details section. More logs can be found in the Dlogs folder at the root of the Automated Tasks Framework. Using WinTail, you can use these logs to get more-detailed information on automated task activity.

3. You can start, stop, and restart the logging service using the corresponding buttons. If you start the service after a scheduled task has passed, the task will occur the next day.

   

Next Steps: To verify that the new automated task functions as expected, see Testing New Tasks.