Tip #35: Managing users and the administrator and manager accounts

When version 2.6 of the OpenX ad server was released, the OpenX Team introduced a whole new user and account management system.

The new system gives OpenX ad server administrators two important tools for managing who can log into an OpenX installation, and what a user can do once they have logged in: Users, and Accounts.

Users

OpenX allows every person who needs to log into an OpenX installation to have their own username and password. This means that you can do away with sharing one username and password — this is obviously better for security, makes life much easier if you need to remove a user’s access to the installation, and means that the information in the user log is much more useful!

If you’ve got multiple people logging into your OpenX ad server installation, and you’re still sharing a single username and password, now is the time to add some new users to your setup — more on how to do that below…

Accounts

In OpenX, there are four types of accounts:

  • The Administrator account;
  • Manager accounts;
  • Advertiser accounts; and
  • Website accounts.

For most OpenX ad server users, the two most important and widely used accounts are the Administrator account, and Manager accounts.

The Administrator account

An OpenX ad server installation has one, and only one, Administrator account. The Administrator account is the account that can do everything — if your user is linked to the Administrator account, then you can not only access the Configuration tab (and the Plugins tab, in OpenX 2.8) to manage the OpenX installation’s configuration settings, but you can also “act” as any Manager account as well, which allows you to manage all of the advertisers, campaigns, banners, websites and zones in the entire installation.

Working as the Administrator account

To “act” as the Administrator account, so that you can access the Administrator account specific tabs, simply use the Working as dropdown menu, and change to the Administrator account1.

The "Working as" dropdown menu.

The "Working as" dropdown menu.

Trafficking as a Manager

As stated above, if your user is linked to the Administrator account, then you can act as any Manager account in an OpenX installation, allowing to you manage any advertiser, campaign, bannner, website and zone in an OpenX installation.

However, in order to carry out this management, you need to “act” as the appropriate Manager account. To do this, you can either select the appropriate Manager account from the Working as dropdown menu, or you can use the appropriate Switch to this account link on the Inventory tab.

Linking a user to the Administrator account

To link a new or existing user to the Administrator account, first of all, ensure that you are Working as the Administrator account yourself. Then go to Inventory > Admin Access.

Here, click on the Actions button, and select Add user. (This is true even if you simply want to link an existing user to the Administrator account.) Enter the username of the new or existing user you would like to link to the Administrator account, and click Add user.

If you have entered a new username, then you will be asked to enter the new user’s details — their password, name, email address and default OpenX UI language. Enter these details, and click Add user.

Creating a new user.

Creating a new user.

That’s it! The user will have been created (if required), and linked to the Administrator account.

Removing a user from the Administrator account

To remove a user from the Administrator account, first of all, ensure that you are Working as the Administrator account yourself. Then go to Inventory > Admin Access.

Here, simply locate the user that you would like to remove from the Administrator account, and click on the appropriate Remove link2.

Manager accounts

In OpenX, a Manager account “owns” a complete set of advertisers, campaigns, banners, websites and zones. These sets are independent of one another — so, Manager accounts are a great way of dividing up a single OpenX installation, if you have a number of different groups of advertisers and websites.

Creating a new Manager account

To create a new Manager account, you will first of all need to be Working as the Administrator account. Then go to Inventory > Account Management.

Here, click on the Actions button, and select Add new account. Enter the name, contact name and email address for the new Manager account, and click Save Changes.

Creating a new Manager account.

Creating a new Manager account.

Working as a Manager account

To “act” as a Manager account, simply use the Working as dropdown menu, and change to the appropriate Manager account. You will only see another Manager account in the dropdown menu if more than one Manager account exists in your OpenX installation, and your user is linked to more than one Manager account (or, your user is linked to the Administrator account, in which case you will automatically have access to all Manager accounts in your system).

Linking a user to a Manager account

To link a new or existing user to a Manager account, first of all, ensure that you are Working as the appropriate Manager account yourself. Then go to Inventory > User Access.

Here, the process of linking a new or existing user to the Manager account is the same as for the Administrator account, with one difference — there is an option to set a permission for the user, called “Allow this user to create new accounts.” This is a misleading permission name, as in fact, this permission allows the user to link new or existing users to the Manager account, and has nothing to do with creating new accounts3! If you want to ensure that the new or existing user you are linking to the Manager account does not have permission to link other new or existing users to the account, then disable the option before you link the user to the account.

Removing a user from a Manager account

To remove a user from a Manager account, first of all, ensure that you are Working as the appropriate Manager account yourself. Then go to Inventory > User Access.

As with removing a user from the Administrator account, simply locate the user that you would like to remove from the Manager account, and click on the appropriate Remove link.

  1. Of course, the user you are logged in as will need to be linked to the Administrator account to be able to this! []
  2. If the user will not be linked to any accounts once they have been removed from the Administrator account, then the user will be deleted. OpenX will prompt you to ensure that you are happy to delete the user if this is the case. []
  3. You need your username to be linked to the Administrator account, and be Working as the Administrator account, to be able to create a new Manager account. []

Tip #34: The user log

Did you know that the OpenX ad server has a user log, which provides an audit trail of the changes made to the advertisers, campaigns, banners, websites and zones in your OpenX installation?

This can be an incredibly useful tool in diagnosing who changed what, when for larger users of OpenX, where you might have more than one person performing your ad server trafficking.

You can find the audit trail under the My Account > User Log tab.

The User Log

The User Log

Tip #33: Avoiding duplicate ads

If you have more than one banner on a website page, it’s easy to ensure that you never show the same banner twice with the OpenX ad server.

Provided you are using Single Page Call, or the Javascript zone tag, the Local Mode zone tag or the XML-RPC zone tag, then under Tag Settings on the Invocation Code tab, you can set the “Don’t show the banner again on the same page” option, and OpenX will ensure that the same banner is not shown more than once on a page.

The "Don't show the banner again on the same page" option.

The "Don't show the banner again on the same page" option.

There is also the “Don’t show a banner from the same campaign again on the same page” option for Single Page Call and these three zone tags, which can be used to ensure that every banner on a page will be from a different campaign.

Of course, you can use both options if you want to ensure that not only is every banner on a page from a different campaign, but also that there are no duplicate banners.

Tip #32: Enabling banner types

OpenX supports a number of different banner types. However, as banner types can be disabled in OpenX, it may be that the banner type you want to use is not present when you go to create a banner.

If this is the case, then you may need to enable the banner type.

OpenX 2.4

While logged in as the administrator account, go to Settings > Main Settings > Banner Settings. Here, you will find the Allowed Banner Types section, where you can select which of the banner types are enabled.

OpenX 2.6

While Working as the Administrator account, go to My Account > Global Settings > Banner Storage Settings. Here, you will find the Allowed Banner Types section, where you can select which of the banner types are enabled.

OpenX 2.8

While Working as the Administrator account, go to Configuration > Global Settings > Banner Storage Settings. Here, you will find the Allowed Banner Types section, where you can select which of the banner types are enabled.

The Allowed Banner Types in OpenX.

The Allowed Banner Types in OpenX.

Tip #31: The banner must match the zone dimensions and type

This week’s tip is something that seems to trip up a lot of new OpenX ad server users. If you can’t seem to link a banner to a zone, this tip is for you.

OpenX will not let you link a banner to a zone unless the banner dimensions match the zone dimensions and the banner type matches the zone type.

Banner types

There are only three different types of banners in OpenX:

  • SQL / Webserver / External banners: These are all image or Flash-based banners; they simply have different storage locations1.
  • HTML banners: These are banners based on HTML and/or JavaScript code.
  • Text banners: These are banners based on plain text (that is, no HTML markup).

Which type of banner you are using will have an impact on both how the dimensions of the banner are determined, and which zone type you can link the banner to.

Banner dimensions and zone dimensions

SQL and Webserver banners are image or Flash-based banners that you upload into OpenX (which are then stored either in the OpenX database, or are stored on your local web server’s directory). As a result of the fact that OpenX is able to inspect the image or Flash file when it is uploaded, OpenX can automatically determine the banner’s dimensions.

However, External banners cannot be inspected by OpenX; similarly, although HTML banners are stored in the OpenX database, OpenX cannot determine what the dimensions of your HTML/JavaScript code are. As a result, you need to specify the dimensions of all External and HTML banners in OpenX when you create them2.

Setting the banner dimensions for an HTML banner.

Setting the banner dimensions for an HTML banner.

Zones also have dimensions. Whenever you create a Banner, Button or Rectangle zone, an Interstitial or Floating DHTML zone, a Popup zone or an Email/Newsletter zone, you can select from a set of standard IAB banner dimensions, or you can enter your own dimensions.

Setting the zone dimensions.

Setting the zone dimensions.

In order to link a banner to a zone, the banner dimensions must be exactly the same as the zone dimensions. OpenX will not allow you to link a banner to a zone if the dimensions are not equal. This is a feature of OpenX, which means not only will OpenX ensure that you do not accidentally link, for example, a skyscraper banner into a rectangle zone (which would look rather odd on your site!), but also means that you can set up campaigns containing multiple banners of many different sizes, and then simply link the campaign to zones, and OpenX will figure out which banners to put into which zones.

The exception to the rule of banner and zone dimensions

Text banners and text zones are the exception to the rule, as they have no dimensions. Text banners and zones are used for displaying plain text banners, which are intended to be inserted into normal paragraphs of text on your site. As a result, there is no need for dimensions to be set at either the banner or zone level — the zone and banner will simply be as “high” and as “wide” as the text itself.

Wildcard zones dimensions

Sometimes, you know better than OpenX, and you need to link banners of different dimensions to a single zone. OpenX will let you do this, by using an asterisk as a “wildcard” when setting up a zone with custom dimensions.

You can use the wildcard for the height, the width, or both, depending on your needs.

A zone with "wildcard" width, and fixed height.

A zone with "wildcard" width, and fixed height.

Banner type and zone type

To link a banner to a zone, the banner type must be suitable for the zone type (and vice versa). The following table lists all of OpenX’s banner and zone types, according to which types can be linked to each other.

Banner Type Zone Type
  • SQL Banner
  • Webserver Banner
  • External Banner
  • HTML Banner
  • Banner, Button or Rectangle Zone
  • Interstitial or Floating DHTML Zone
  • Popup Zone
  • Email/Newsletter Zone
  • Text Banner
  • Text Zone

As you can see, text banners and text zones are the odd types out; all other banner/zone combination are fine.

Happy banner/zone linking!

  1. That is, SQL banners store the image or Flash-file data in the OpenX database; Webserver banners store the image or Flash data in a file in a directory on your web server; and External banners are where the image or Flash file is stored on some external system, and you simply provide the URL that the file can be loaded from. []
  2. OpenX 2.8 now, fortunately, requires these fields be filled in, so that you do not forget. However, older versions of OpenX did not have this requirement — so if you forgot to fill in the banner’s dimensions, if would often take frustrating minutes to figure out why it was not possible to link the banner to the zone. []