The Task Scheduling Wizard is a dynamic wizard available from Head Office or Cinema Manager maintenance under Task Manager. The Task Scheduling Wizard adds or removes steps depending on the task and options selected.
Task Settings
These fields are available when an extraction task is set up via the Task Scheduling Wizard in Task Manager.
Option | Allowed Values | Description |
Description |
1-50 characters |
The name of the extraction task. |
Instance |
1-10 characters |
Alphanumeric name identifying the computer on the network that runs task services. |
Alert on Failure |
cleared selected |
If this checkbox is selected, an alert is displayed if the extraction task fails to complete. |
Parameter |
n/a |
Each available parameter for the extraction task is displayed. For each parameter, the values can be changed in the Values column. Note: This field is not available if the Numero extract task is selected. |
Value |
Any value parameter value |
For each parameter, specify the required values. Note: This field is not available if the Numero extract task is selected. |
Occurrence, frequency, and duration configuration
Option | Allowed Values | Description |
Enable Task |
cleared selected |
This checkbox determines whether the extraction task will run. |
Occurs every (occurrence) |
Any number of days, weeks, or months |
Determines the time interval at which the extraction task recurs. The time interval can be set to a specific number of days, weeks, or months. For example: A manager enters 12 and selects Day. The task is now set up to run every 12 days. |
Occurs once at |
Any time |
This option sets the extraction task to occur once at a selected time on the specified occurrence day. For example: Having set the task to run every 12 days, the manager selects Occurs once at and enters 6am. The task is now set up to run once at 6am every 12 days. |
Occurs every (frequency) |
Any number of minutes or hours |
If you require the extraction task to run more than once on the specified occurrence day, use this option to specify the time intervals at which the task runs. For example: A manager selects 3 and hours from the dropdown menus. The task now runs every 3 hours on the occurrence day, within the start and end times specified in the Starting at and Ending at fields. |
Starting at |
Any time |
The start time of the occurrence day. |
Ending at |
Any time |
The end time of the occurrence day. |
All Day |
cleared selected |
Select this option to set the extraction task to run for one day (24 hours) from the time set in the Starting at field. Selecting this option auto-populates the Ending at field with the correct time to 24 hours. |
Start date |
Any date |
The date on which the task first runs, from which point the task recurrs until the End date. |
End date |
Any date |
The date after which the task no longer runs. |
No end date |
cleared selected |
Select this option if you require the task to run indefinitely from its Start date onwards. |
Destination server configuration
Note: This window of the Scheduling Wizard is only available if the option Configure file delivery to a remote server location is selected in the Extract Options/Output File Settings window.
Option | Allowed Values | Description |
Connect Type |
None SFTP FTP FTPS |
This dropdown menu allows you to determine the file transfer protocol you wish to use when extracting the output file to the destination server. If None is selected, no other fields are available. Clicking Next takes you to the Summary window. If SFTP is selected, the checkboxes Override SSL Certification and Use implicit TLS over SSL are hidden and unavailable. If either FTP or FTPS is selected, the checkboxes Override SSL Certification and Use implicit TLS over SSL are available. |
URL |
Any FTP URL |
Enter the URL of the destination server that the output file will be extracted to. |
Subfolder |
Any folder name |
The name of the subfolder on the destination server that the output file is extracted to. |
Mode |
User/Pass Key file |
Determines which mode of authentication is used to validate access to the FTP server. Depending on the mode selected, either the User Name and Password or Key File Path and Key File Password fields appear. |
User Name |
Any valid username |
If the User/Pass mode is selected, this field appears. Enter the username that is used for authentication. |
Password |
Any valid password |
If the User/Pass mode is selected, this field appears. Enter the password that is used for authentication. |
Key File Path |
Any valid file path |
If Key File mode is selected, this field appears. Enter the file path of the key file that contains the relevant server-specific keys. |
Key File Password |
Any valid password |
If Key File mode is selected, enter the password for the key file. |
Request Timeout (ms) |
Any number of milliseconds |
The time in milliseconds after which the export is terminated if the server does not respond. |
Port |
Any port number |
The port used when sending the output file to the destination server. |
Use ASCII Encoding |
cleared selected |
If this option is selected, ASCII encoding is used when sending output files to the destination server. |
Override SSL Certification |
cleared selected |
If this option is selected, any invalid or expired SSL certification returned by the server is ignored and the task proceeds as normal. Note: This option is only available if the Connect Type FTP or FTPS is selected. |
Use implicit TLS over SSL |
cleared selected |
If implicit TLS is available, selecting this option uses implicit TLS instead of SSL as the preferred cryptographic protocol. Note: This option is only available if the Connect Type FTP or FTPS is selected. |
Extract options/Output file settings
These fields determine the extraction options for extract and export tasks only.
Option | Allowed Values | Description |
Output File Location |
Any valid file path |
The file path of the location to which the file is extracted. |
Archive File Location |
Any valid file path |
The file path of the location where the extracted file is archived. |
Overwrite Existing File |
cleared selected |
Select this option to overwrite any existing extracted file with the latest file. |
Configure File delivery to a remote server location |
cleared selected |
Selecting this option opens a destination server configuration window in the Scheduling Wizard that allows the connection and delivery details to be set up. |
Configure Extract File Settings |
cleared selected |
Selecting this option opens a file settings configuration window in the Scheduling Wizard that allows the settings for the extract output to be configured. Note: This option is only available if the relevant configuration for the extract task contains the section [FILESETTINGS] |
File settings
This window is only available if the option Configure extract file settings is selected in the Extract Options/Output File Settings window. The available parameters and configurable values are set for the output file generated by the extraction or export task.
Option | Allowed Values | Description |
Parameter |
n/a |
Each available parameter for the settings used for the extract output file is displayed. For each parameter, the values can be changed in the Values column. Note: This field is only available if the option Configure Extract File Settings on the Output File Settings window is selected. |
Value |
Any valid parameter value |
For each parameter, specify the required values. For example: DateAdjustment=-3 TargetFileName=BHN_DAILY_TXN_<Date>.txt Note: This field is only available if the option Configure Extract File Settings on the Output File Settings window is selected. |
MACCS Box Office Return
When a MACCS Box Office Return task is scheduled, an additional step to configure the task parameters is required.
Option | Allowed Values | Description |
RerunDate |
Any past date. Enter in YYYY-MM-DD format. |
Enter a date to override the Mode setting and report returns from a specific date instead. |
ConfigFile |
Any valid file path |
The file path of the configuration file containing parameters for how box office returns are reported to Maccs. |
Mode |
D W |
Determines how many days of returns will be reported to Maccs. D: The most recent complete business day will be reported. W: The most recent complete business week will be reported. |
AssemblyName |
ReportBoxOfficeReturns\Vista.Circuit.BoxOfficeReturnExtract.Task.dll |
This is a default parameter required to run this task. Warning! Do not modify this parameter. Modifying it will cause the task to stop working. |
TaskToExecute |
Vista.Circuit.BoxOfficeReturnExtract.Task.BoxOfficeReturnExtract |
This is a default parameter required to run this task. Warning! Do not modify this parameter. Modifying it will cause the task to stop working. |
AppID |
VISTAHO |
This is a default parameter required to run this task. Warning! Do not modify this parameter. Modifying it will cause the task to stop working. |
Detail |
Y N |
Determines whether the extract generates a detailed output with ticket-type information shown per session, or a summarised output with all ticket-type information condensed. |
Include Alternate Content |
Y N |
Determines whether Films with Exclude From Consolidator Feeds selected are included in the extract. Y: All films are included in the extract. N: Films are excluded from the extract if Exclude From Consolidator Feeds is selected. |
ExcludeZeroValueTickets |
Y N |
Determines whether free admissions (zero value tickets) are omitted from the extract output. |
ExcludeAuditoriums |
Y N |
Determines whether your session's screen name and numbers are reported to Maccs. Enter Y to exclude screen names and numbers from Maccs reports. |
AlternateLanguageTitle |
Y N |
Enter Y to report your film's alternate language title to Maccs instead of the main title. |
UseRentrakCode |
Y N |
Enter Y to report a film's Rentrak Code to Maccs instead of its MACCS Code. Tip! Both codes can be found in the Film form. |
Comments
0 comments
Please sign in to leave a comment.