About this task
These tasks create an extract of your box office returns for the reporting company Comscore (formerly Rentrak).
The tasks exists in different forms so that you can schedule it at different times with different parameters (in particular, ExcludeFilmMode). Your schedule doesn't need to match the tasks name. For example, you could schedule Rentrak HO Export: 1300 to run in the morning, if you wanted. You can also rename the tasks to suit the schedule you create.
Behaviour
This task extracts your box office returns data based on its task and configuration file parameters. The extract is then delivered using the FTP details specified by its configuration file.
Required?
Not required.
Recommended schedule
Not applicable.
Parameters
These parameters are available in the Vista Schedule Console or Scheduling Wizard.
|
Property |
Type |
Description |
Example |
|
Currency |
String |
The Head Office code of the currency that the extract will assign to your return values. |
USD |
|
CircuitName |
String |
The name that Comscore uses to identify your circuit. Contact Comscore if you're not sure what value to use for this parameter. |
Example Cinemas |
|
CircuitID |
String |
The ID that Comscore uses to identify your circuit. Contact Comscore if you're not sure what value to use for this parameter. |
1234 |
|
ExcludeTicketMode |
String |
The tickets to be excluded from Rentrak extracts. NONE - Do not exclude any tickets; all tickets are reported in the Rentrak extract. ZEROPRICED - Exclude only tickets with a sales value of 0. COMPLIMENTARY - Exclude only complimentary tickets. ZEROPRICEDANDCOMPS - Exclude both complimentary tickets and and zero-value tickets. ZEROPRICEDCOMP - Exclude only complimentary tickets that also have a sales value of 0. Note: This property is only available in the Head Office task. In Cinema, the same feature is available as an INI file setting. |
NONE |
|
FileLocation |
String |
Destination path for the export file. If not specified, this will default to the location where the Rentrak Export program resides on the fileserver, for example: D:\Vista\VistaUtilities |
D:\Vista\ExportFiles\Rentrak |
|
ExcludeFilmMode |
String |
Determines which films' data are excluded from the extract. You can set up film records to be excluded from hourly, daily, or weekly consolidator extracts. This is done by selecting Exclude from Consolidator Feeds on a film's record. ExcludeFilmMode determines whether the extract is considered hourly, daily, or weekly for exclusion purposes. H = Hourly D = Daily W = Weekly If you leave this parameter empty, film data will only be excluded for films that have All selected under When to Exclude. |
H |
|
SiteID |
String |
Enter one or more site codes to report data from those sites. Leave this parameter empty to report data from all your sites. |
1001|1002|1003 |
|
FromDate |
String |
When a FromDate and ToDate are specified, the task will report box office returns within their date range. Otherwise it reports returns from your previous business date. The FromDate is inclusive, and based off your business dates. Use YYYY/MM/DD format. Note: If you enter a FromDate, you must enter a ToDate. |
2019/10/18 |
|
ToDate |
String |
When a FromDate and ToDate are specified, the task will report box office returns within their date range. Otherwise it reports returns from your previous business date. The ToDate is inclusive, and based off your business dates. Use YYYY/MM/DD format. Note: If you enter a ToDate, you must enter a FromDate. |
2019/10/20 |
|
NumberOfAdmits |
String |
Determines whether session and screen admits are included in the extract. Include = admits are included. Exclude = admits are excluded. |
Include |
|
ReportMovieFormatsSeparate |
String |
Determines whether each sessions' movie format is reported. When enabled, the export will include the format of each session. Y = Report session formats. N = Don't report session formats. |
Y |
Comments
0 comments
Please sign in to leave a comment.