Neptune Configuration

Neptune can be installed on the same server that is hosting the CM Service or on a remote server. Based on where Neptune is installed, appropriate settings need to be configured.

Neptune settings for CM Service

If the Neptune is installed on the same server as CM Service then no further configuration is required. Neptune will be auto-configured to use the local CM Service. To view the Neptune settings for CM Service, open the Neptune administration page from Start menu>Ryarc CampaignManager6>Ryarc Neptune>Admin. This opens up the administrative page for Neptune (http://localhost/neptune/admin.aspx). The CM Service address should be the same as the current server address. By default CM Service address is 127.0.0.1, this works if Neptune is installed on the same machine as the CM Service. Also, this will work if the address of the local machine is entered. In Change Neptune log folder field there is the path for the folder location for logs from Neptune. By default this field has the path “C:\Users\Public\Documents\Ryarc\NeptuneWS\Log”, this path can be changed by copying the path of folder location where you want to save Neptune logs. Click Save on both fields to successfully save changes.

If Neptune is installed on a different machine than CM Service, then Neptune needs to be configured with the remote CM Service address. To configured Neptune with a remote service, enter the name or IP address of the remote CM Service in the administrative page (above image), and click Save.

CM Service settings for Neptune

If Neptune is installed on the same server as CM Service, then CM Service settings are auto-configured with the Neptune address. To view the Neptune settings in CM Service, log in to Realm and open Realm Control Panel>Service Host Addresses.

If Neptune is installed on a different machine than CM Service, then Neptune settings need to be configured for the CM Service. Enter the name or IP address of the remote Neptune server in the field titled Please enter Neptune server address of Realm control panel>Server Host Addresses, and click Save.

A task dialog will inform the user that the save operation was successful.

Domain settings for Neptune

It is possible to use the Neptune server that is configured on the Realm level or use a different Neptune server for a particular domain. To use the existing Neptune server on the Realm level, no changes are required on the domain level. Domain will inherit the Neptune address for all its proof of play settings. To view the Neptune settings on a domain level, log in to domain and open Domain control panel>Proof of Play settings. To use the Realm level Neptune settings, Override realm Neptune address checkbox needs to be unchecked.

To use a different Neptune server for this particular domain than what has been configured on the Realm level, check the checkbox Override realm Neptune address and enter the name or IP address of the remote Neptune server. Click Save. A task dialog will appear informing the user that the settings have been saved successfully.

Player settings for Neptune

Players can be configured to send proof of play logs to Neptune server either on domain level or on the individual player level.

To configure all players under a domain to send proof of play logs to Neptune, check the checkbox Record what has been played in play log and select the appropriate radio button. Select sequential log to save the logs in a sequential format which records each instance of the media playback. On the other hand, select the cumulative log to save logs in a cumulative format which groups together the instances of media per hour. Neptune reports extract relevant data from these records and display it in the proper format. Note that sequential logs will be larger than cumulative logs as it records every instance of the media playback.

Login to Neptune

To log in to Neptune locally, open from Start menu>Ryarc CampaignManager 6>Ryarc Neptune>Ryarc Neptune. This opens the Neptune login page: http://localhost/neptune

To open Neptune from a remote machine, enter http://neptuneservername/neptune in your browser. The same login page should be displayed.

Login to Neptune using your user credentials. If you have permission to view Neptune reports, login should be successful. The page will show that you are successfully logged in.

Permission to view Neptune reports

You can assign users permission to access Neptune reports. To assign them permission, open the relevant roles and in role permission table check or uncheck Report create checkbox. If this checkbox is checked, then the user will be able to log in and generate all forms of reports. If denied report create permission, the user will not be able to successfully login to Neptune.

When generating reports, the user will have access to entities for which there is read permission.

Types of Neptune Reports

Ryarc Neptune provides six types of reports based on the data collected across a range.

  • Campaign report
  • Channel report
  • Media report
  • Device report
  • Player Log report
  • File Retriever Folder
  • Audience Report
  • Screenshot

Campaign report

Campaign report is a report type that shows the proof of play logs for a particular Campaign across different channels. This report is also capable of showing reports based on the different published version on the Campaign playing on the CM player.

Channel report

Channel report is a report type that shows the proof of play logs for a particular channel across all Campaigns that have played on that channel. This report is also capable of showing reports based on the different published version of the Campaigns playing on that channel.

Media report

A media report is a report type that shows the proof of play logs for a particular media across all channels and Campaigns. This report is also capable of showing reports based on the different published version of all Campaigns with that media.

Device report

Channel report is a report type that shows the proof of play logs for a particular device across all channels. This report shows all media that has played on this device. If this device has been configured with different channels at different times, the report will show media impressions for all those channels.

Player Log report

Player log report is a report type that shows the proof of play logs for a particular player across all channels and Campaigns. Player log report will show raw data for sequential play logs. This report generates a raw player play log report page which shows exactly when each media has played.

File Retriever Folder

This report is generated from File Retriever Folder command in CM. In this report are logs from retrieved files from player machine

Audience Report

Demographic report generated from Intel AIM is a report that shows the number of people that look at the screen. This type of reports is generated and divided into different groups, which depend on the characteristics of the humans. This type of reports are divided on

  • Gender: Male or Female
  • Age: Children, Young adults, Senior and Old

There are additional filters for generating reports.

Screenshot

Screenshot report is a report type that shows a screenshot gallery. This gallery has screenshots from devices configured on the CM Service, which are stored locally in ‘C:\Program Files (x86)\Ryarc CampaignManager 6\Ryarc Neptune\Neptune\Images’ folder. In the screenshot section, it is allowed to search by ID and device name. In Screenshot gallery are listed all available screenshots which can be found in Neptune folder, mouse hover on the thumbnail should enlarge the corresponding screenshot.

Generate Campaign Report

To generate a Campaign report, select Campaign report radio button, select a start date/time and end date/time, and click Next. For start and end time, you can select a particular hour on a particular date.

In Campaign report Settings page, select a project and Campaign from that project. All channels on which the Campaign has played appear in the channel list. Select the channel for which you want to generate the Campaign report. You can search for a particular channel or filter a channel by categories using the search button. For Campaign version, either select All versions or select an appropriate version from the dropdown list.

If you select All Versions, then generated report will show a cumulative Campaign report on the selected channels, while a particular version selection will generate a Campaign report for that version only.

Click Generate to generate the report.

Generate Channel Report

To generate a Channel report, select Channel report radio button, select a start date/time and end date/time, and click Next. For start and end time, you can select a particular hour on a particular date.

In Channel report Settings page, select Group by Campaign (version sensitive) if you want the report to show a breakdown of all Campaign versions on that channel or Group by Campaign (version insensitive) if you want a version insensitive report for all Campaigns on that channel. Select the channel for which you want to generate the Channel report. You can search for a particular channel or filter a channel by categories using the search button.

Click Generate to generate the report. The report shows the breakdown of all Campaigns versions that have played on the selected channel.

The following image shows the version insensitive Channel report for the same selected channel.

Generate Media Report

To generate a Media report, select Media report radio button, select a start date/time and end date/time, and click Next. For start and end time, you can select a particular hour on a particular date.

In Media report settings page, select the following as appropriate:

  • Group by Campaign (version sensitive) if you want to generate a report for different versions of all Campaigns containing that media.
  • Group by Campaign (version insensitive) if you want to generate a report for all Campaigns containing that media.
  • Group by Channel if you want to generate a report that shows media impressions on all channels.

Select the media for which you want to generate the Media report. You can search for a particular media or filter a media by categories using the search button.

Click Generate to generate the report. The Media report shows the media impressions for Campaign when Group by Campaigns radio button is selected.

Generate Device Report

To generate a Device report, select Device report radio button, select a start date/time and end date/time, and click Next. For start and end time, you can select a particular hour on a particular date.

In Device report settings select for which device to create a report. You can search for a particular device using the search box.

Click Generate to generate the report. The Device report shows the media impressions for media files played on this device.

Generate Player Log Report

To generate a Player Log report, select Player Log report radio button, select a start date and end date, and click Next.

In Player log report settings from drop-down menu select for which player to create a report. You can search for a particular player using the search box in the drop-down menu. Select the channel for which you want to generate the Player log report.

Click Generate to generate the report. The Player log report shows the media files played on this player. The report shows exactly when each media have played on the selected channel. NOTE: besides Generate link, there is Download CSV File. Selecting this options downloads a CSV file with Player log report information. Player log report in CSV file should be the same as Player log report received from Generate link.

Screenshot section

To access the screenshot gallery, select Screenshot report radio button. There are only next and logout links. Click Next to continue to screenshot gallery, or click logout to log out from Neptune.

In Device screenshot report window, screenshots from the players configured with the CM Service can be seen in Screenshot Gallery section. The name of the player, the unique ID sequence and upload time are shown under every screenshot.

Screenshots can be searched by ID or by Device Name from the search fields in the top of the screenshot report.

Mouse over on the thumbnail should enlarge the corresponding screenshot.

Generate Audience Report

To generate Audience Report you need to follow the pictures:

After you click Next you will get the following window:

At the bottom you have option Export to CSV.

This kind of report can be exported as csv(Excel) file only.

Exporting report to external file

You can export a report to different file formats and save it to your local machine. The report can be exported to Excel, pdf and word format.

To export the report, select Export from the file menu in your report.

Select the appropriate format, the download should start automatically and download the appropriate file in downloads folder on the machine.

Switching Channel/Media

You can search the channels or media by entering a search string and clicking on the search button. This will return the filtered list.

To retrieve the full list of channel or media, remove the search string and click the search button again.

Filter by category

You can filter a channel or media by selecting an appropriate category from the category tree view and clicking the search button. This will return the filtered list.