Login
The Pro API installer contains the setup executable for Pro API. There are four steps to installing Pro API on Windows:
Before you begin
Run the data installer from the CD or DVD. To ensure that all datasets are compatible, all data CDs or DVDs for a country must be the same version, and should be installed at the same time.
A set of files is installed for each dataset you need to support. For example, there are four data files installed for Australia: aus.dts, aus.tpx, aus.zlx and aus.zlb.
To install or update data on Windows, follow these steps:
Data Updates
Experian provides periodic updates of datasets as and when updated data is available. These updates are supplied to you on CD-ROM or DVD; follow the instructions in the installation program to replace your existing datasets.
Datasets expire after a certain period of time, at which point you must install an update. The low level API function QA_GetLicensingDetail tells you how many days are left before a dataset expires. By default, a dialog will be displayed when you start Pro, which lists all the datasets that are due to expire soon. You can disable this dialog using the qaattribs_NOLICENSINGDLG flag.
Visit the troubleshooting section to troubleshoot your installation.
There are three steps to installing Pro API on Linux:
administrator privileges
You will need to know the IP address of your machine as well as the number of an unused port (first port) for the primary Pro API Server. If you are using Partner Sourced datasets, you will also require the number of an unused second port for the Partner Sourced Data Server.
To install the Pro API software, follow these steps:
Extract the appropriate files for your platform (i.e. web.800.bin.tar) to a suitable location, for example /opt/qasProWeb/.
In order to view the man pages supplied with Pro API, you must first copy them from the man/man7 directory in the pro installer to the man/man7 directory on your computer. This is usually usr/share/man/man7. Once copied, man pages can be invoked using the man command.
Navigate to your chosen location and, using a text editor such as vim, edit the indicated lines in the following files:
ServerAddress=QATCPIP:
IP address:first portServerWSDLUrn=http:
//IP address:first portExternalServers=
description,QATCPIP:
IP address:second portWhere description is an internal label for the Partner Sourced Data Server. If you are not using the Partner Sourced Data Server it is not necessary to edit the ExternalServers line.
ServerAddress=QATCPIP
:IP address:second portUnlockCode=
license keyWhere each license key is the full text of a Partner Sourced dataset license key as it appears on your despatch note. If you are not using the Partner Sourced Data Server it is not necessary to edit acserver.ini.
ServerAddress=QATCPIP:
IP address:first portAdd your Primary Sourced data license key(s) to separate lines at the end of this file, as they appear on your despatch note.
Data files are installed separately from Pro API but they should be located on the same machine as the Pro API Server. The files installed vary according to the dataset, additional datasets and DataPlus sets you have purchased. For information about a specific dataset see the Data Guide that shipped with your data.
Before you begin the installation process, you should ensure that you have the despatch note that is supplied with Pro API. The despatch note contains all of the license keys for each dataset that you have purchased. When you install data for the first time, you are prompted to insert the license key for each dataset that you want to install.
To install new Primary Sourced data, follow these steps:
Copy the data files to an appropriate location on your system, for example /opt/qasData/.
The first time that you install a dataset, you will need to add the InstalledData
and DataMappings
settings to the qawserve.ini file. Navigate to /opt/qasProWeb/ (or wherever you installed the Pro API Server) and open qawserve.ini in a text editor such as vim.
Under the [QADefault] sections, add an InstalledData line. This setting should contain a list of the datasets you have installed, and their locations:
InstalledData={dataset identifier},{path}
+{dataset identifier},{path}
This setting should point to the data that you just copied. For example, the line might read:
InstalledData=GBR,/opt/qasData/gbr001
If more than one dataset is to be added to this setting, you should use the plus (+) sign at the start of each subseqent line. For example:
InstalledData=GBR,/opt/qasData/gbr001
+USA,/opt/qasData/usa001
Add a new AllInstalledData line beneath this, with the same content:
AllInstalledData=GBR,/opt/qasData/gbr001
+USA,/opt/qasData/usa001
Do not remove any exisiting lines from the AllInstalledData
setting.
InstalledData
In the same section, add a DataMappings
setting. This setting should contain a list of the datasets and groups of additional datasets you want to use:
DataMappings={data mapping identifier},{data mapping name},{dataset list}
+{data mapping identifier},{data mapping name},{dataset list}
In this example, if you had a Names additional dataset, the line might read:
Datamappings=GBR,United Kingdom,GBR
+GBN,United Kingdom With Names,GBR+GBRNAM
To update existing Primary Sourced data, follow these steps:
Copy the data files to an appropriate new location on your system.
Navigate to /opt/qasProWeb/ (or wherever you installed the Pro API Server), and open qawserve.ini in a text editor such as vim.
Under the [QADefault] section, add or edit the NewInstalledData
setting as required. This setting lists the data you have installed, but have not yet activated to work with any products.
The setting is in the same format as the InstalledData
setting:
NewInstalledData={dataset identifier},{path}
This setting has to point to the data that you just copied. For example, the line might read:
NewInstalledData=GBR,/opt/qasData/gbr001
If more than one dataset is to be added to this setting, you should use the plus (+) sign at the start of each subsequent line. For example:
NewInstalledData=GBR,/opt/qasData/gbr001
+AUS,/opt/qasData/aus001
You should also check that the DataMappings
setting is still correct for the data you are updating.
Finally, activate the new data using the Administrator Console or the Command Line Management Utility.
To install new Partner Sourced data, follow these steps:
Stop the Partner Sourced Data Server (qasproglo) if it is running.
If you already have Partner Sourced datasets installed, you must copy the data files from the data DVD to the same location as the existing data on your system. If this is the first time you are installing Partner Sourced datasets, you can choose an appropriate location, such as /opt/qasData/.
Ensure the data filenames are in upper case and in the correct format, for example: ITA5BI.MD, ITA5FC.MD and ITA5GC.MD. The first three characters of the filename are the ISO code of the country whose data is stored in the file.
Datasets can occupy between one and three files, ending in BI, FC or GC (as above). You should copy all files for each dataset you are licensed to use.
Navigate to /opt/qasProWeb/ (or wherever you installed the Pro API Server) and open acserver.ini in a text editor such as vim.
Under the [QADefault] section, locate or create the DataDir
line. This setting should contain the path to which you copied the data files, for example:
DataDir=/opt/qasData/
You can also use the InstalledData setting to specify the location of each dataset separately.
In the same section, locate the DataMappings setting. This setting should contain a complete list of the Partner Sourced datasets you want to use, so you need to add a line for each new dataset you are installing:
DataMappings={data mapping identifier},{description},{ISO}
For example, if you had the Austria and Italy datasets the line might read:
Datamappings=AUT,Austria,AUT
+ITA,Italy,ITA
Start or restart the Partner Sourced Data Server.
DataDir
, InstalledData
and DataMappings
settings in the acserver.ini file (located in /opt/qasProWeb/ or wherever you installed the Pro API Server) are still correct for the data you have updated.If you need to perform a data rollback, follow these steps but copy the data file from your backup location.
You should copy all files. Data files must be in lower case and in the following format: usa.zlx, usa.dts, usagcd.dap.
The first time that you carry out a data update, you will need to add InstalledData
and DataMappings
settings to the qawserve.ini file.
The qawserve.ini file is located in the apps folder. Open the file using a plain text editor such as vi or emacs. Under the [QADefault] section, locate the settings InstalledData
and DataMappings
. These settings contains a list of the datasets you have installed.
Add a line to each setting for each new dataset that you are installing, or update the path for any dataset you are updating.
Data Updates
Experian provides periodic updates of datasets as and when updated data is available. These updates will be sent to you; follow the instructions in the installation program to replace your existing datasets.
Datasets expire after a certain period of time, at which point you must install an update. The low level API function QA_GetLicensingDetail tells you how many days are left before a dataset expires. By default, a dialog will be displayed when you start Pro, which lists all the datasets that are due to expire soon. You can disable this dialog using the qaattribs_NOLICENSINGDLG flag.
Before you start the server you should check the resource limit values.
Depending on whether you want to start the server interactively or via the system's startup scripts, resource limitations may apply. Use the ulimit -a command (or your system's equivalent) to verify that the following requirements are met:
Resource Name | Limitation |
---|---|
time | This needs to be set to unlimited for continuous operation. |
stack(kbytes) | This should be set to a minimum value of 1024KB. |
open files | This should be set to a minimum value of 4 for each concurrent client. If you use DataPlus, the factor can increase up to the number of data files installed for the dataset. For example, if you use all the Australia DataPlus sets then the value should be 8 for each concurrent client. |
The resource names may vary depending on your API operating system. For example, "open files" is called "nofiles (descriptors)" on AIX.
To start the service, follow these steps:
There are three steps to installing Pro API on Aix:
administrator privileges
You will need to know the IP address of your machine as well as the number of an unused port (first port) for the primary Pro API Server. If you are using Partner Sourced datasets, you will also require the number of an unused second port for the Partner Sourced Data Server.
To install the Pro API software, follow these steps:
Extract the appropriate files for your platform (i.e. web.800.bin.tar) to a suitable location, for example /opt/qasProWeb/.
In order to view the man pages supplied with Pro API, you must first copy them from the man/man7 directory in the pro installer to the man/man7 directory on your computer. This is usually usr/share/man/man7. Once copied, man pages can be invoked using the man command.
Navigate to your chosen location and, using a text editor such as vim, edit the indicated lines in the following files:
ServerAddress=QATCPIP:
IP address:first portServerWSDLUrn=http:
//IP address:first portExternalServers=
description,QATCPIP:
IP address:second portWhere description is an internal label for the Partner Sourced Data Server. If you are not using the Partner Sourced Data Server it is not necessary to edit the ExternalServers line.
ServerAddress=QATCPIP
:IP address:second portUnlockCode=
license keyWhere each license key is the full text of a Partner Sourced dataset license key as it appears on your despatch note. If you are not using the Partner Sourced Data Server it is not necessary to edit acserver.ini.
ServerAddress=QATCPIP:
IP address:first portAdd your Primary Sourced data license key(s) to separate lines at the end of this file, as they appear on your despatch note.
Data files are installed separately from Pro API but they should be located on the same machine as the Pro API Server. The files installed vary according to the dataset, additional datasets and DataPlus sets you have purchased. For information about a specific dataset see the Data Guide that shipped with your data.
Before you begin the installation process, you should ensure that you have the despatch note that is supplied with Pro API. The despatch note contains all of the license keys for each dataset that you have purchased. When you install data for the first time, you are prompted to insert the license key for each dataset that you want to install.
To install new Primary Sourced data, follow these steps:
Copy the data files to an appropriate location on your system, for example /opt/qasData/.
The first time that you install a dataset, you will need to add the InstalledData
and DataMappings
settings to the qawserve.ini file. Navigate to /opt/qasProWeb/ (or wherever you installed the Pro API Server) and open qawserve.ini in a text editor such as vim.
Under the [QADefault] sections, add an InstalledData line. This setting should contain a list of the datasets you have installed, and their locations:
InstalledData={dataset identifier},{path}
+{dataset identifier},{path}
This setting should point to the data that you just copied. For example, the line might read:
InstalledData=GBR,/opt/qasData/gbr001
If more than one dataset is to be added to this setting, you should use the plus (+) sign at the start of each subseqent line. For example:
InstalledData=GBR,/opt/qasData/gbr001
+USA,/opt/qasData/usa001
Add a new AllInstalledData line beneath this, with the same content:
AllInstalledData=GBR,/opt/qasData/gbr001
+USA,/opt/qasData/usa001
Do not remove any exisiting lines from the AllInstalledData
setting.
InstalledData
In the same section, add a DataMappings
setting. This setting should contain a list of the datasets and groups of additional datasets you want to use:
DataMappings={data mapping identifier},{data mapping name},{dataset list}
+{data mapping identifier},{data mapping name},{dataset list}
In this example, if you had a Names additional dataset, the line might read:
Datamappings=GBR,United Kingdom,GBR
+GBN,United Kingdom With Names,GBR+GBRNAM
To update existing Primary Sourced data, follow these steps:
Copy the data files to an appropriate new location on your system.
Navigate to /opt/qasProWeb/ (or wherever you installed the Pro API Server), and open qawserve.ini in a text editor such as vim.
Under the [QADefault] section, add or edit the NewInstalledData
setting as required. This setting lists the data you have installed, but have not yet activated to work with any products.
The setting is in the same format as the InstalledData
setting:
NewInstalledData={dataset identifier},{path}
This setting has to point to the data that you just copied. For example, the line might read:
NewInstalledData=GBR,/opt/qasData/gbr001
If more than one dataset is to be added to this setting, you should use the plus (+) sign at the start of each subsequent line. For example:
NewInstalledData=GBR,/opt/qasData/gbr001
+AUS,/opt/qasData/aus001
You should also check that the DataMappings
setting is still correct for the data you are updating.
Finally, activate the new data using the Administrator Console or the Command Line Management Utility.
To install new Partner Sourced data, follow these steps:
Stop the Partner Sourced Data Server (qasproglo) if it is running.
If you already have Partner Sourced datasets installed, you must copy the data files from the data DVD to the same location as the existing data on your system. If this is the first time you are installing Partner Sourced datasets, you can choose an appropriate location, such as /opt/qasData/.
Ensure the data filenames are in upper case and in the correct format, for example: ITA5BI.MD, ITA5FC.MD and ITA5GC.MD. The first three characters of the filename are the ISO code of the country whose data is stored in the file.
Datasets can occupy between one and three files, ending in BI, FC or GC (as above). You should copy all files for each dataset you are licensed to use.
Navigate to /opt/qasProWeb/ (or wherever you installed the Pro API Server) and open acserver.ini in a text editor such as vim.
Under the [QADefault] section, locate or create the DataDir
line. This setting should contain the path to which you copied the data files, for example:
DataDir=/opt/qasData/
You can also use the InstalledData setting to specify the location of each dataset separately.
In the same section, locate the DataMappings setting. This setting should contain a complete list of the Partner Sourced datasets you want to use, so you need to add a line for each new dataset you are installing:
DataMappings={data mapping identifier},{description},{ISO}
For example, if you had the Austria and Italy datasets the line might read:
Datamappings=AUT,Austria,AUT
+ITA,Italy,ITA
Start or restart the Partner Sourced Data Server.
DataDir
, InstalledData
and DataMappings
settings in the acserver.ini file (located in /opt/qasProWeb/ or wherever you installed the Pro API Server) are still correct for the data you have updated.If you need to perform a data rollback, follow these steps but copy the data file from your backup location.
You should copy all files. Data files must be in lower case and in the following format: usa.zlx, usa.dts, usagcd.dap.
The first time that you carry out a data update, you will need to add InstalledData
and DataMappings
settings to the qawserve.ini file.
The qawserve.ini file is located in the apps folder. Open the file using a plain text editor such as vi or emacs. Under the [QADefault] section, locate the settings InstalledData
and DataMappings
. These settings contains a list of the datasets you have installed.
Add a line to each setting for each new dataset that you are installing, or update the path for any dataset you are updating.
Data Updates
Experian provides periodic updates of datasets as and when updated data is available. These updates will be sent to you; follow the instructions in the installation program to replace your existing datasets.
Datasets expire after a certain period of time, at which point you must install an update. The low level API function QA_GetLicensingDetail tells you how many days are left before a dataset expires. By default, a dialog will be displayed when you start Pro, which lists all the datasets that are due to expire soon. You can disable this dialog using the qaattribs_NOLICENSINGDLG flag.
Before you start the server you should check the resource limit values.
Depending on whether you want to start the server interactively or via the system's startup scripts, resource limitations may apply. Use the ulimit -a command (or your system's equivalent) to verify that the following requirements are met:
Resource Name | Limitation |
---|---|
time | This needs to be set to unlimited for continuous operation. |
stack(kbytes) | This should be set to a minimum value of 1024KB. |
open files | This should be set to a minimum value of 4 for each concurrent client. If you use DataPlus, the factor can increase up to the number of data files installed for the dataset. For example, if you use all the Australia DataPlus sets then the value should be 8 for each concurrent client. |
The resource names may vary depending on your API operating system. For example, "open files" is called "nofiles (descriptors)" on AIX.
To start the service, follow these steps:
There are three steps to installing Pro API on Solaris:
administrator privileges
You will need to know the IP address of your machine as well as the number of an unused port (first port) for the primary Pro API Server. If you are using Partner Sourced datasets, you will also require the number of an unused second port for the Partner Sourced Data Server.
To install the Pro API software, follow these steps:
Extract the appropriate files for your platform (i.e. web.800.bin.tar) to a suitable location, for example /opt/qasProWeb/.
In order to view the man pages supplied with Pro API, you must first copy them from the man/man7 directory in the pro installer to the man/man7 directory on your computer. This is usually usr/share/man/man7. Once copied, man pages can be invoked using the man command.
Navigate to your chosen location and, using a text editor such as vim, edit the indicated lines in the following files:
ServerAddress=QATCPIP:
IP address:first portServerWSDLUrn=http:
//IP address:first portExternalServers=
description,QATCPIP:
IP address:second portWhere description is an internal label for the Partner Sourced Data Server. If you are not using the Partner Sourced Data Server it is not necessary to edit the ExternalServers line.
ServerAddress=QATCPIP
:IP address:second portUnlockCode=
license keyWhere each license key is the full text of a Partner Sourced dataset license key as it appears on your despatch note. If you are not using the Partner Sourced Data Server it is not necessary to edit acserver.ini.
ServerAddress=QATCPIP:
IP address:first portAdd your Primary Sourced data license key(s) to separate lines at the end of this file, as they appear on your despatch note.
Data files are installed separately from Pro API but they should be located on the same machine as the Pro API Server. The files installed vary according to the dataset, additional datasets and DataPlus sets you have purchased. For information about a specific dataset see the Data Guide that shipped with your data.
Before you begin the installation process, you should ensure that you have the despatch note that is supplied with Pro API. The despatch note contains all of the license keys for each dataset that you have purchased. When you install data for the first time, you are prompted to insert the license key for each dataset that you want to install.
To install new Primary Sourced data, follow these steps:
Copy the data files to an appropriate location on your system, for example /opt/qasData/.
The first time that you install a dataset, you will need to add the InstalledData
and DataMappings
settings to the qawserve.ini file. Navigate to /opt/qasProWeb/ (or wherever you installed the Pro API Server) and open qawserve.ini in a text editor such as vim.
Under the [QADefault] sections, add an InstalledData line. This setting should contain a list of the datasets you have installed, and their locations:
InstalledData={dataset identifier},{path}
+{dataset identifier},{path}
This setting should point to the data that you just copied. For example, the line might read:
InstalledData=GBR,/opt/qasData/gbr001
If more than one dataset is to be added to this setting, you should use the plus (+) sign at the start of each subseqent line. For example:
InstalledData=GBR,/opt/qasData/gbr001
+USA,/opt/qasData/usa001
Add a new AllInstalledData line beneath this, with the same content:
AllInstalledData=GBR,/opt/qasData/gbr001
+USA,/opt/qasData/usa001
Do not remove any exisiting lines from the AllInstalledData
setting.
InstalledData
In the same section, add a DataMappings
setting. This setting should contain a list of the datasets and groups of additional datasets you want to use:
DataMappings={data mapping identifier},{data mapping name},{dataset list}
+{data mapping identifier},{data mapping name},{dataset list}
In this example, if you had a Names additional dataset, the line might read:
Datamappings=GBR,United Kingdom,GBR
+GBN,United Kingdom With Names,GBR+GBRNAM
To update existing Primary Sourced data, follow these steps:
Copy the data files to an appropriate new location on your system.
Navigate to /opt/qasProWeb/ (or wherever you installed the Pro API Server), and open qawserve.ini in a text editor such as vim.
Under the [QADefault] section, add or edit the NewInstalledData
setting as required. This setting lists the data you have installed, but have not yet activated to work with any products.
The setting is in the same format as the InstalledData
setting:
NewInstalledData={dataset identifier},{path}
This setting has to point to the data that you just copied. For example, the line might read:
NewInstalledData=GBR,/opt/qasData/gbr001
If more than one dataset is to be added to this setting, you should use the plus (+) sign at the start of each subsequent line. For example:
NewInstalledData=GBR,/opt/qasData/gbr001
+AUS,/opt/qasData/aus001
You should also check that the DataMappings
setting is still correct for the data you are updating.
Finally, activate the new data using the Administrator Console or the Command Line Management Utility.
To install new Partner Sourced data, follow these steps:
Stop the Partner Sourced Data Server (qasproglo) if it is running.
If you already have Partner Sourced datasets installed, you must copy the data files from the data DVD to the same location as the existing data on your system. If this is the first time you are installing Partner Sourced datasets, you can choose an appropriate location, such as /opt/qasData/.
Ensure the data filenames are in upper case and in the correct format, for example: ITA5BI.MD, ITA5FC.MD and ITA5GC.MD. The first three characters of the filename are the ISO code of the country whose data is stored in the file.
Datasets can occupy between one and three files, ending in BI, FC or GC (as above). You should copy all files for each dataset you are licensed to use.
Navigate to /opt/qasProWeb/ (or wherever you installed the Pro API Server) and open acserver.ini in a text editor such as vim.
Under the [QADefault] section, locate or create the DataDir
line. This setting should contain the path to which you copied the data files, for example:
DataDir=/opt/qasData/
You can also use the InstalledData setting to specify the location of each dataset separately.
In the same section, locate the DataMappings setting. This setting should contain a complete list of the Partner Sourced datasets you want to use, so you need to add a line for each new dataset you are installing:
DataMappings={data mapping identifier},{description},{ISO}
For example, if you had the Austria and Italy datasets the line might read:
Datamappings=AUT,Austria,AUT
+ITA,Italy,ITA
Start or restart the Partner Sourced Data Server.
DataDir
, InstalledData
and DataMappings
settings in the acserver.ini file (located in /opt/qasProWeb/ or wherever you installed the Pro API Server) are still correct for the data you have updated.If you need to perform a data rollback, follow these steps but copy the data file from your backup location.
You should copy all files. Data files must be in lower case and in the following format: usa.zlx, usa.dts, usagcd.dap.
The first time that you carry out a data update, you will need to add InstalledData
and DataMappings
settings to the qawserve.ini file.
The qawserve.ini file is located in the apps folder. Open the file using a plain text editor such as vi or emacs. Under the [QADefault] section, locate the settings InstalledData
and DataMappings
. These settings contains a list of the datasets you have installed.
Add a line to each setting for each new dataset that you are installing, or update the path for any dataset you are updating.
Data Updates
Experian provides periodic updates of datasets as and when updated data is available. These updates will be sent to you; follow the instructions in the installation program to replace your existing datasets.
Datasets expire after a certain period of time, at which point you must install an update. The low level API function QA_GetLicensingDetail tells you how many days are left before a dataset expires. By default, a dialog will be displayed when you start Pro, which lists all the datasets that are due to expire soon. You can disable this dialog using the qaattribs_NOLICENSINGDLG flag.
Before you start the server you should check the resource limit values.
Depending on whether you want to start the server interactively or via the system's startup scripts, resource limitations may apply. Use the ulimit -a command (or your system's equivalent) to verify that the following requirements are met:
Resource Name | Limitation |
---|---|
time | This needs to be set to unlimited for continuous operation. |
stack(kbytes) | This should be set to a minimum value of 1024KB. |
open files | This should be set to a minimum value of 4 for each concurrent client. If you use DataPlus, the factor can increase up to the number of data files installed for the dataset. For example, if you use all the Australia DataPlus sets then the value should be 8 for each concurrent client. |
The resource names may vary depending on your API operating system. For example, "open files" is called "nofiles (descriptors)" on AIX.
To start the service, follow these steps: