Installing Rich

Download the Rich Agent Flash component

Download Rich Agent v2.4.7.

The agent is compatible with Flash CS3, CS4 and CS5.

Installing the Rich Agent component

You only need to follow these steps once, although we recommend that you make sure that you always use the latest version of the agent, so check back here periodically for updates.

1. Download the agent component by clicking on the link above.
2. Double click on the downloaded file (it should have the extension .MXP), it will be opened in Adobe Extension Manager.
3. Accept the license agreement and follow the on screen instructions. If you update press OK when the application asks you if you want to replace the component.

Updating the Rich Agent component

You’ll need to update your Rich Agent component if your current version is lower than the one indicated above.

1. Download the agent component by clicking on the link above.
2. Double click on the downloaded file (it should have the extension .MXP), it will be opened in Adobe Extension Manager.
3. Accept the license agreement and follow the on screen instructions. If you update press OK when the application asks you if you want to replace the component.

Installing the Rich Agent component in an ad

Follow these instructions for each ad you want to track with Rich after you have installed the component as per the instructions above. If you have more than one ad you can follow steps 1-5 once and then copy and paste the component into the other ads.

1. Start Flash and open an ad.
2. In the Components panel you should see a folder called Rich and inside that a component called Rich Agent. If you don’t, read the troubleshooting-section at the bottom of this page.
3. Drag the component to the stage. We recommend that you place it outside of the visible area.
4. Select the component icon on the stage and open the Component Inspector panel.
5. In the Component Inspector panel enter the name of your ad and the campaign API key. Remember that each campaign has a unique API key, which can be found on the campaign’s page in Rich.
6. Add the code RichAgent.trackEvent("clickThru") to the end of the event handler for the button that triggers click-through. This is needed if you want to track click thru for your campaign. For a detailed description please read here.
7. Publish and test, you’re done. Test that the Rich Agent is configured correctly by clicking Test ads in the top menu.

If this is your first time, read the rest of this manual to see all the things you can do to make sure your reports get as good as you want them to be.

If you have problems installing the component, see the bottom of this page for troubleshooting.

Deploying the ad

For the tracking to work well once deployed the ads need to be allowed script access.

Rich doesn’t require you to do anything special when you deploy your ad. Everything that is needed is included in the component, and it will work with any ad server. The one thing you should do to get high quality data for your reports: make sure the ads are embedded with full script access. Some properties that the Rich Agent collects are only available to JavaScript and not to Flash, for example the URL to the page where the ad is displayed. Ask your media agency or the publisher to see to it that the ads are embedded with the "allowScriptAccess" parameter set to "always".

Testing the ad

Once ready, the ads should always be tested using our testing tool. It will indicate if everything is working and has been implemented correctly. If something is missing the tool will indicate what needs to change.

Things to keep in mind

• The Rich Agent isn’t active when you test your ad in Flash development environment, it’s only active when running inside a web browser. No exposures will be recorded when you create the ad.

• We track a random sample of viewers, so don’t be alarmed if you don’t see any requests to our log servers when you test your ad in a browser. If you want to make sure that the component is correctly installed and configured, test it in our ad testing tool.

• The Rich Agent needs the SWF to be exported with Flash Player Version 8 or later. It wont work with earlier versions.

The longer version

Installation

Download the Rich Agent MXP and install it using Adobe Extension Manager. If the Flash authoring environment is running go to the Components panel and select Reload from the palette menu, otherwise start Flash. A new component called Rich Agent should appear:

Implementation

Once you have installed the Rich Agent component, open up an ad and drag the Rich Agent component from the Components panel to the stage. The component is represented by an icon with the Rich logo. This graphic should not appear when you publish the ad, but it may flash by very quickly in some situations, so we recommend placing it outside the stage area to avoid this.

Configuration

The frst thing you should do is to select the component icon on the stage and then open the Component Inspector panel to change some of the parameters (this can also be done in the Parameters panel). You need to enter the name of the ad (optional, but recommended) and the key that you got when you created the campaign.

The ad name should be something that makes it easy to identify the ad later on.

Troubleshooting

We have received reports that the component does not get installed correctly if the language of the OS and the Flash application are different, for example the English version of Flash installed in a Swedish OS. If you try to install the component and it does not show up, check if the language of your Flash application differs from your OS. If that is the case you can either temporarily change the language of your OS to match that of your Flash application, or you can move the component manually.

If you navigate to this directory

Mac: /Users/username/Library/Application Support/Adobe/Flash CS4

Windows: C:\Documents and Settings\username\Local Settings\Application Data\Adobe\Flash CS4

You should see at least one directory with a two letter abbreviation of the language of either your OS or your Flash application. If you see only one, make sure it matches the language of your Flash application, if there are more than one look inside each and try to find two files called RichAgentAS2.swc and RichAgentAS3.swc. Move these files to the corresponding directory within the directory with the two letter abbreviation of the language of your Flash application. In other words, if you see "en" and "sv" (for Swedish) and your Flash application is in English, look inside the "sv" directory where you should find another directory called "Configuration" and within that one called "Components". Inside the last one you should find the Rich Agent component files. Move these to the "Components" direcotry, within the "Configuration" directory within "en" and restart Flash. Now you should be able to see the component in the components panel.