How to install AWR

How to register my Advanced Web Ranking license

After purchasing the application, you have two options for registering your license key:

When launching the application, you can click on the Register button, from the dialog that lets you know how many days are left from your trial period, and enter the license key that you have received in the purchase confirmation email.

The purchase confirmation email, may also be found in Spam folder of your email address.

If you already are using the application and in this dialog you have chosen "Continue Trial", you do not have to close the application and open it again in order to register. Just click on the question mark located in the upper right corner of the app and use the Help -> Register -> Register option and enter your license key.

How to find details about my Advanced Web Ranking license

Click on the question mark located in the upper right corner of the app and choose About -> About Advanced Web Ranking. You will find information on:

  • The AWR version you are currently using
  • License registration details
  • Maintenance Plan expiration date

The link on your Maintenance Plan details, at the bottom of this dialog, will direct you to your Customer Licensing Information where you will be able to also see your license key.

How to check my system properties

You can access the list of your system properties by pressing the question mark located in the upper right corner of the app Help -> Support -> System Properties.

How to find the history of my logged events

You can access your logged events history by pressing on the question mark located in the upper right corner of the app Help -> Support -> Event Log Viewer.

The Event Logger will tell you exactly what happened, at what time, and whether everything went fine or not. It can even send you an email automatically when certain event types occur.

These are the actions that can be tracked in the list:

  • Scheduled Updates
  • Multiple Scheduled Updates
  • Single Project Update
  • Sending Emails
  • FTP Uploads
  • Generating Reports
  • Application Errors

There are four types of logs available:

  • Error -This usually means something wrong has happened and needs your immediate attention.
  • Warning -This may be a possible problem, or a setting that has been set incorrectly.
  • Information -This is used for notification of an action that has been done.
  • Project

If you wish to have your logs sent to you by email, just check the Send log events by email checkbox and then click on the Edit button to select which event types you wish to receive.

How to send an error report

You can send an error report from the app, simply by pressing the question mark located in the upper right corner of the application and ​using the Help -> Support -> Report Error option.

How to quickly find help in Advanced Web Ranking

If you are interested in only one type of information regarding the application, you can do a quick search from the application and find related topics from both the application and website.

For example, if you need more information about reporting with Advanced Web Ranking, click on the Help button from the top let corner (the application logo) and type in in the search box the word "reports".

In this case there are available three types of results:

  • How-to - 4 results from all articles and user guide containing your term
  • Videos - 2 video tutorials about reports
  • Application - 26 various tools from the application according to your term

Also, if you wish tips and suggestions to be displayed throughout the application you can enable, disable or reset them from here, by choosing the Help menu.

After one tip is displayed, it is automatically removed from the list of tips you will further see. The Reset option reruns all tips, regardless of whether you saw them or not.

How to install AWR Server Edition on Windows

When installing Advanced Web Ranking Server Edition, you need choose the "Custom" install option and then select AWR Server. This way, the Advanced Web Ranking server will be installed too. It will be automatically registered as a service and started by the installation package. There is no action required from you to start the service.

Once you finish setting up the server use the following instructions to connect your client license to the server: Connect Advanced Web Ranking client to server.

How to install AWR Server Edition on Mac OS X

The Advanced Web Ranking installation package contains three options: the Advanced Web Ranking client, the Advanced Web Ranking server and Advanced Link Manager. To install the server make sure that option is checked in the installation wizard.

If the Advanced Web Ranking server is installed, it will be automatically registered as a service and started by the installation package. There is no action required from you to start the service.

Once you finish setting up the server use the following instructions to connect your client license to the server: Connect Advanced Web Ranking client to server.

How to install AWR Server Edition on Linux

The installation of Advanced Web Ranking on Linux requires root privileges. You need to either run the installation script using sudo or switch to root using the su command before you install it.

The Advanced Web Ranking Linux distribution comes with an installation script that allows you to select the features you would like to install:

sudo ./install.sh

To install the Server edition please run the installation script and choose option 4 Complete. This will install and start the Advanced Web Ranking server automatically.

By default the application creates a new user called "awr" and installs the application in /usr/local/awr. The server data folder is located in the home directory of the "awr" user and is called AWRUserData.

How to configure AWR Server

There are two ways to configure the Advanced Web Ranking Server, one using the AWR Server interface and the second one by editing the server.xml file.

The server.xml file can be found under the AWR User Data directory.

By default server.xml looks like this:

<?xml version="1.0" encoding="UTF-8"?>
<CONFIG>
  <HOST>Host IP adress</HOST>
  <PORT>7777</PORT>
  <LOG_FILE_LEVEL>INFO</LOG_FILE_LEVEL>
  <PERMISSIONS/>
</CONFIG>

From this file you can set the IP address of your server as the host, the listen port and the log file level.

If you later need to start/stop the service manually, or change any of its configuration properties, here is what you need to do:

  • Windows - Go to Program Files -> Caphyon -> Advanced Web Ranking and click on the Server Configuration shortcut. From the same shortcut, you can configure the Server port and the location of the Server data folder.

The service will automatically restart when you change any of the configuration parameters.

  • Mac OS X - Go to Applications -> Advanced Web Ranking Server Management and click on the "Server Configuration" application.

You need to run the "restart.command" every time you change the server settings using the "Server Configuration".

The "uninstall.command" is used to remove the Advanced Web Ranking server from your services list, so that it will no longer start when the system starts up.

  • Linux - Go to the folder where you installed Advanced Web Ranking and run the AWRServerConfig.sh shell script to launch the Server Configuration application.

You need to restart the awrserver service in order for the changes to take effect:

/etc/init.d/awrserver restart

Once you finish setting up the server use the following instructions to connect your client license to the server: Connect Advanced Web Ranking client to server.

How to connect AWR clients to server

To connect the Advanced Web Ranking client to the server, open the client application and go to Settings -> Application and select the Database Location. Here, select "Remote Connection" and enter the server name or IP address of the server and click on OK to connect. If this is the first time you connect to this server, use Administrator with no password when prompted to log in.

Each new user that will need to connect to the Server database, needs to do the same steps (go to Settings -> Application menu, Database Location tab and select the "Remote connection" option). Also, each additional user will require an additional license.

What is the Java Runtime Environment and why do I need it?

The Java Runtime Environment (in short JRE) is the platform that enables Advanced Web Ranking to run on almost any platform that exists today. You can thus use Advanced Web Ranking on the operating system that you enjoy most.

Advanced Web Ranking requires the JRE version 1.6 . For MAC OS X, if you have a previous version, please download the latest version for your operating system: "http://support.apple.com/kb/DL1572" (for Mac OS X)

Do I still need to install the JRE if I download the Windows version that comes bundled with it?

No. The "Windows (bundled with JRE)" distribution comes bundled with the Java Runtime Environment so you don't need to download and install JRE separately. However, if you wish to run other Java enabled applications, you may need to download it.

How do I install Advanced Web Ranking on Mac OS X

Please follow the steps below to install AWR on Mac OS X:

Open the awr.dmg file that you downloaded by double clicking on it. This will open a new window that contains the actual installation package.

To install Advanced Web Ranking on your computer, double click on the Advanced Web Ranking icon to start the installation process.

The installation package contains two features: the client and the server. To install both the client and the server, you need to make sure both "Advanced Web Ranking" and "Advanced Web Ranking Server" options are enabled.

How do I upgrade Advanced Web Ranking on MAC OS X?

Please follow the steps below to upgrade AWR to a new version on Mac OS X:

Open the awr.dmg file that you downloaded by double clicking on it. This will open a new window that contains the actual installation package.

To upgrade Advanced Web Ranking on your computer, double click on the Advanced Web Ranking icon to start the installation process.

The installation package contains two features: the client and the server. To upgrade both the client and the server, you need to make sure both "Advanced Web Ranking" and "Advanced Web Ranking Server" options are enabled.

How to copy the data gathered so far from Mac to PC and vice versa

All you need to do is use the Backup and Restore features of Advanced Web Ranking, under the Data menu.

The backup files are created in a folder called "backup" within the data folder. See the Settings -> Global settings -> Application menu for the location of the data folder.

If we have the server edition of the software, would we need anything higher than the Standard version to act as clients for the server?

It depends on what you need to do with your client application. If you just want to update the projects and see the results in the user interface, the Standard version is enough. If you need to generate printable reports you need at least the Professional version. And if you need advanced features like User Profiles, Triggers, Export Rank Data, Proxy per Project, you need an Enterprise edition.

Note that the Server license comes with 2, 5 or 10 Enterprise client licenses.