Support Center

Setting Up Tasks

Last Updated: May 12, 2016 11:59PM PDT
This article shows you how to create a set of tasks that will automatically create monthly storages, import your log file data and generate daily, weekly and monthly reports. It also provides general information about creating tasks, adding actions to tasks, and using date modifier strings. 

The instructions for creating specific tasks are provided as a guide; you may need to customize the tasks to fit your organization.

The following sections provide information on creating the set of tasks:
  • General Information
  • Creating a Monthly Storage
  • Importing Log Data
  • Generating Reports

General Information

Most actions you can perform in Vantage can be set to run automatically as part of a task. Each task consists of a set of information (including the task's name and when it should run) and a number of actions. Actions are the activities that the task will run, such as importing logs or generating reports.

How to create a task
  1. Open Vantage and click the Tasks tab at the top of the screen. This takes you to the tasks dock.
  2. Click the New Task link in the Tasks task pad. This launches the Task Options dialog.
  3. On the General page, enter the name of your task, then click Next.
  4. Select when you would like the task to run. Note: The start times in this article are provided as a guideline and may require alteration. The only requirement for this set of task start times, is to keep the same order; the storage must be created before importing log file data and the reports must be generated after.
  5. On the Authentication page, enter the Windows user name and password that you want the task to run as. (for example 'mydomain\john.citizen')
  6. Clicking OK returns to the Tasks dock.
Tip: You can receive notification each time your task runs, by configuring the task to send results to an email address using the 'Send task results by email' option on the General page.

How to add an action to a task
  1. Select the task you created in the Tasks list.
  2. Click the Add Action button in the right-hand pane and select the action you want to run.
  3. The action will be added to the Actions list and will automatically launch the dialogs required to configure it. 
  4. Once you have added all the actions you want the task to run, and configured them, you can run the task. i.e. Click the Run Task link in the Tasks task pad. This is a good way to test that the task is working as you expect.
  5. Once you are happy with your task, you can leave it to run as scheduled.

Using date modifiers

Date modifiers allow you to select date periods in relation to the current date. The syntax for date modifiers in Vantage is 
%[date parameters, date format], where the date format describes the way you would like the date to appear.

For example:
  • dd-MM-yyyy produces the format 25-09-2008
  • MM-dd-yy produces the format 09-25-08
Date parameters allow you to modify the current date by using subtraction and/or addition for the day, month or year.

For example, if the current date is the 11th of May 2008:
  • -1d corresponds to the 10th of May
  • +3m corresponds to the 11th of August
  • +14d, +4m, -2y corresponds to the 25th of September 2006
View more information on date modifiers

The tasks constructed in this article use date modifier strings that support a specific file name for log files. In order to customize the tasks to fit your organization's log files, you may need to alter the date modifier strings.
 

Creating a Monthly Storage

To automatically create a set of storages that will contain the log files corresponding to a certain month, you will need a task that creates and names a new storage every month.

To create this task:
  1. Create a new task and enter "Create Monthly Storage" as the name.
  2. On the Schedule page, enter a start time (i.e. 00:10:00). This will be the time that the task will run.
  3. Using the 'Recurrence dropdown box, select Monthly, then select Day 1 of the month(s) and then click the checkbox for each month.
  4. On the Authentication page, enter your authentication details and click OK
The task you just created is now set to run on the first day of every month. To create the storage you need to add an action to the new task.

To add the action:
  1. With the task selected, click Add Action and select Import logs into new storage. The Input wizard will be automatically launched.
  2. On the Storages page, enter %[MM-yyyy] Log Storage as the storage name and ensure that the 'Open new storage after it is created' checkbox is selected. Note: %[MM-yyyy] is the date modifier that will insert the current month and year i.e. running this task on the 1st of September 2008 will create a storage named 09-2008 Log Storage.
  3. On the Input Type page, select your input type.
  4. On the Loader Section page, select the format of your log files.
  5. On the Input Selection page, use the Add button and select Add Folder, then select the path of your log file folder/s. For each folder, include a file mask of %[yyyyMM]* then click OK to return to the wizard. Note: The file mask %[yyyyMM] will import the log files that have a file name beginning with the current year followed by the current month.
  6. On the Filters page click Add and select Relative date filter. Select 1 and Month from the 'show past' dropdown boxes. Click the 'Include current period' checkbox and then click OK.
  7. Repeat the process for each of the formats on the Filter page, then click OK.

Now that the setup of the task is complete, you can check the task runs as expected by clicking Run Task.
 

Importing Log Data

To automatically import your log files into the corresponding monthly storage, you will need a task that imports log files into an existing storage every day.

To create this task:
  1. Create a new task and enter "Daily Import of Logs" as the name.
  2. On the Schedule page, enter a start time (i.e. 01:00:00). This will be the time that the task will run.
  3. Using the 'Recurrence dropdown box, select Daily and then ensure that it is set to Every 1 day(s).
  4. On the Authentication page, enter your authentication details and click OK
The task you just created is now set to run every day at 1:00am. To import the logs you need to add an action to the new task.

To add the action:
  1. With the task selected, click Add Action and select Import new hits to existing storage.
  2. Click the %[MM-yyyy] Log Storage radio button. Then click OK.
  3. Now click on the Monthly task and click Add Action and select Import new hits to existing storage.
  4. Click the Add button above the storages list and enter %[-1m, MM-yyyy] Log Storage, then click OK.
Note: Including the storage from the previous month will enable the task to update the previous days logs if it is the 1st day of the month.

Now that the setup of the task is complete, you can check the task runs as expected by clicking Run Task.
 

Generating Reports

Tasks can also be used to automatically generate reports based on the log file data contained in your monthly storages. To create daily, weekly and monthly reports you will require three tasks: one that runs daily, one that runs weekly and one that runs monthly.

Daily Reports

To create a task that generates a report on the log file data from the previous day:
  1. Create a new task and enter "Generate Daily Report" as the name.
  2. On the Schedule page, enter a start time (i.e. 01:30:00). This will be the time that the task will run.
  3. Using the 'Recurrence dropdown box, select Daily and then ensure that it is set to Every 1 day(s).
  4. On the Authentication page, enter your authentication details and click OK
The task you just created is now set to run every day at 1:30am. To generate the report you need to add an action to the new task.

To add the action:
  1. With the task selected, click Add Action and select Run a comparison or analysis reportNote: If you wish to run a trend report than select that option.
  2. Select the type of report you would like to generate, then click OK. The Report Wizard will be automatically launched.
  3. On the Storages page, select the %[MM-yyyy] Log Storage. Click Add and enter %[-1m, MM-yyyy] Log Storage, then click OK. Select both storages for the report. Note: Including the storage from the previous month will enable the task to generate a report based on the previous days logs if it is the 1st day of the month.
  4. On the Formats page, select the document formats for your report.
  5. On the Publish page, enter %[-1d, dd-MM-yyyy] Report in the 'Document Name' text field. Note: The date modifier will prefix your report with the date it corresponds to.
  6. On the Filters page, click Add and select Relative date filter. Select 1 and Day from the 'show past' dropdown boxes. Ensure that the 'Include current period' checkbox is empty and then click OK.
  7. Click OK to finish the wizard.
Now that the setup of the task is complete, you can check the task runs as expected by clicking Run Task.

Weekly Reports

To create a task that generates a report on the log file data from the previous week:
  1. Create a new task and enter "Generate Weekly Report" as the name.
  2. On the Schedule page, enter a start time (i.e. 02:30:00). This will be the time that the task will run.
  3. Using the 'Recurrence dropdown box, select Weekly and then ensure that it is set to Every 1 week(s). Click the 'Monday' checkbox.
  4. On the Authentication page, enter your authentication details and click OK
The task you just created is now set to run every Monday at 2:30am. To generate the report you need to add an action to the new task.

To add the action:
  1. With the task selected, click Add Action and select Run a comparison or analysis reportNote: If you wish to run a trend report than select that option.
  2. Select the type of report you would like to generate, then click OK. The Report wizard will be automatically launched.
  3. On the Storages page, select the %[MM-yyyy] Log Storage. Click Add and enter %[-1m, MM-yyyy] Log Storage, then click OK. Select both storages for the report. Note: Including the storage from the previous month will enable the task to generate a report based on the previous weeks logs if the week is split over two months.
  4. On the Formats page, select the document formats for your report.
  5. On the Publish page, enter %[-7d, dd-MM-yyyy] - %[-1d, dd-MM-yyyy] Report in the 'Document Name' text field. 
  6. Note: The date modifiers will prefix your report with the weeks date range.
  7. On the Filters page, click Add and select Relative date filter. Select 7 and Day from the 'show past' dropdown boxes. Ensure that the 'Include current period' checkbox is empty and then click OK.
  8. Click OK to finish the wizard.
Now that the setup of the task is complete, you can check the task runs as expected by clicking Run Task.

Monthly Reports

To create a task that generates a report on the log file data from the previous month:
  1. Create a new task and enter "Generate Monthly Report" as the name.
  2. On the Schedule page, enter a start time (i.e. 04:00:00). This will be the time that the task will run.
  3. Using the 'Recurrence dropdown box, select Monthly, then select Day 1 of the month(s) and then click the checkbox for each month.
  4. On the Authentication page, enter your authentication details and click OK
The task you just created is now set to run on the first day of every month at 4:00am. To generate the report you need to add an action to the new task.

To add the action:
  1. With the task selected, click Add Action and select Run a comparison or analysis reportNote: If you wish to run a trend report than select that option.
  2. Select the type of report you would like to generate, then click OK. The Report Wizard will be automatically launched.
  3. On the Storages page, click Add and enter %[-1m, MM-yyyy] Log Storage, then click OK. Note: Including the storage from the previous month will enable the task to generate a report based on the previous month on the 1st day of the month.
  4. On the Formats page, select the document formats for your report.
  5. On the Publish page, enter %[-1m, MM-yyyy] Report in the 'Document Name' text field. Note: The date modifiers will prefix your report with the month and year.
  6. On the Filters page, click Add and select Relative date filter. Select 1 and Month from the 'show past' dropdown boxes. Ensure that the 'Include current period' checkbox is empty and then click OK.
  7. Click OK to finish the wizard.
Now that the setup of the task is complete, you can check the task runs as expected by clicking Run Task.

Contact Us

support@fastvue.co
http://assets1.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete