How to install Xtraction v13.3?

Document ID : KB000019249
Last Modified Date : 14/02/2018
Show Technical Document Details


How to install Xtraction v13.3


Xtraction Server Requirements

Recommended Hardware

Hard Drive: Xtraction has a very small footprint (150MB). Therefore, 20GB-32GB drive size should be ample.
CPU: There is not a high demand on the CPUs of the Xtraction server. Fortunately, with a virtual machine, you should be able to allocate more or less resources to the virtual machine based on the performance you observe.

Required software

Windows Server (2003 or greater)
Microsoft .NET Framework 4.0
IIS v6 or greater
Oracle Client 8.1.7 or greater if Xtraction is reporting against Oracle databases (64bit Oracle Client if running on Windows x64)

Xtraction Database

Server housing Xtraction SQL database
Can be on same, or different, server as Xtraction
Microsoft SQL Server (2000 or greater)

NOTE: The Xtraction install process needs to run using an Administrator privilege account that has administrative rights on the Xtraction server. This access is only required for installation.

Xtraction Database Setup

  1. Extract the "DB v13.1.sql" file from
  2. Run the "DB v13.1.sql" file on the Xtraction database to create the structure and populate the database

Installing Xtraction

  1. Run the installation program, Xtraction.msi, to being the Xtraction install.

  2. Click NEXT on the Welcome Screen

    Figure 1

  3. Accept the License Agreement and click NEXT

    Figure 2

  4. Choose the Xtraction install directory and click NEXT

    Figure 3

  5. Click INSTALL to begin the Xtraction install

    Figure 4

    Figure 5

Configuring Xtraction

The Xtraction configuration tool will run after the completion of the installer. If the configuration tool is cancelled, Xtraction will not work until configuration is run again and successfully completed. To rerun the configuration, run Tools\XtractionInstaller.exe located in the Xtraction installation folder.

  1. Ensure that 'Setup a new installation' is selected and click NEXT

    Figure 6

  2. Select the appropriate Data Model and click INSTALL

    Figure 7

    You will receive a pop-up message indicating that the Data Model has been installed. Click OK.

    Figure 8

  3. The next screen will required the Xtraction license files - one for Xtraction and the other for the data model editor. Locate the license files using the "..." buttons and then click INSTALL.

    Figure 9

  4. Click FINISH to complete the Xtraction install and proceed with the Settings Editor

    Figure 10

Settings Editor

Figure 11

Database Settings

To configure the connection settings to the Xtraction database created prior to installation, click on the "..." button in the Xtraction Database section. Fill in the following fields:

Server - The name of the database server where the Xtraction database resides. If a non-standard port is used, place a comma (",") after the server name, followed by the port number.
Database - The name of the Xtraction database created as part of the pre-installation steps.
User ID - The User ID that Xtraction should use when connecting to this database. This field is not required if Integrated Security is being used.
Password - The password (displayed as a series of asterisks) for the User ID specified above. This field is not required if Integrated Security is being used.
Integrated Security - If the account used by Xtraction to access the Xtraction database is a Windows account instead of a SQL Server account, select Integrated Security, and leave User ID and Password fields blank.
Additional - Any additional parameters necessary for connecting to the database (usually blank)

Figure 12

After you have entered the database details, use the "Test" button to attempt a database connection to make sure the details provided are correct.

Figure 13

Logon Settings

Application Logon Type - Select one of the two available options:
Windows - The Xtraction user accounts are tied to the corresponding Windows user accounts. User passwords are not maintained within Xtraction. Xtraction verifies the user's identity via IIS.
Local - The Xtraction user accounts are created and maintained within Xtraction. All account information, including passwords, are maintained in Xtraction.
Automatically Create Users - If this option is checked, then Xtraction will automatically create an account for any user who visits Xtraction for the first time.
NOTE: This option is only available if the Windows option is selected for the Application Logon Type
Default Roles - When the "Automatically Create Users" option is checked, any users created will get the roles selected here by default.
Default Features - When the "Automatically Create Users" option is checked, any users created will get the designer features selected here by default.

Time Zone Settings

Xtraction adjusts date/time values to the appropriate time zone. This default time zone setting in the configuration settings will be the default time zone applied to all users unless their accounts have been individually updated to reflect a different time zone. Xtraction automatically adjusts for daylight savings if the selected time zone observes Daylight Savings.

Email Settings

If you want the Xtraction task scheduler to send emails, configure email settings from the Email tab.

Figure 14

Server - The name of the email server
Port - The port to use when sending email to the email server
Username - The username to use to connect to the email server
Password - The password to use to connect to the email server
Sender - The sender to use when sending email from Xtraction. This must be a valid email address
Use SSL - Whether the connection to the email server needs to be made via SSL
Test Email - To test the settings provided, enter an email address in the Test Email section and then click the "Test Email" button

Data Model Settings

Before running Xtraction, you need to setup the data model selected earlier. In the "Tools" folder (i.e. C:\Program Files (x86)\Xtraction Software\Xtraction\Tools), run "DataModelEditor.exe".

Figure 15

Select FILE->OPEN and select the Data Model File (DataModel.Dat). By default this is located in the C:\Program Files (x86)\Xtraction Software\Xtraction\Data\Configuration directory.

Connection Settings

For each data source in your data model, a connection string must be provided so that Xtraction can connect to that data source. Open the connection string editor via Tools > Connection String Editor.

This dialog will display all of the data sources within your data model. To edit a connection string, click the appropriate "Connection" item and then click the "..." button. If your data model contains data sources that connect to the same physical database, after you have setup the first connection string you can copy them by checking the appropriate items, right clicking on the connection to copy and select "Copy to selected" from the context menu.

Figure 16

Target Application URLs

Within Xtraction, when displaying lists of records, you can double-click on a record and launch the associated application's website to display that record in the native application. To update the URLs within the data model, select the Tools > URL Editor menu.

Figure 17

By default the [WEBSERVER] placeholder will be included with the URLs and will need to updated. Use the ?URL Find and Replace? dialog to replace the [WEBSERVER] placeholder with the correct address.

Figure 18

Post Installation Steps

Confirm IIS Settings

Below is a checklist of IIS settings that should be confirmed before running Xtraction for the first time:

These settings only apply if Xtraction is installed on a Windows 2003 server:

  1. Confirm that ASP.NET v4.0.30319 exists under Web Service Extensions and is set to Allowed

    If it does not exist, try running the following command to register ASP.NET

    C:\Windows\Microsoft.NET\Framework\v4.0.30319\aspnet_regiis.exe -I -enable

  2. Confirm settings in the Properties dialog for the Xtraction virtual directory located under the Default Web Site
    1. Home tab: Xtraction should run within its own Application Pool. The "Xtraction" application pool should be created during the installation.
    2. ASP.NET tab: ASP.NET version should be set to 4.0.30319
    3. Directory Security tab: authentication method settings differ based on the Application Login Type selected during configuration
      1. Windows - "Enable anonymous acces" should be disabled and "Integrated Windows authentication" should be enabled
      2. Local - "Enable anonymous access" should be enabled and "Integrated Windows authentication" should be disabled

These settings only apply if Xtraction is installed on a Windows 2008 server:

  1. Confirm Authentication settings for the web site based on the Application Login Type selected during configuration
    1. Basic Settings: Xtraction should run within its own Application Pool. The "Xtraction" application pool should be created during the installation.
    2. Authentication
      1. Windows - "Anonymous Access" should be disabled, "Forms Authentication" should be disabled and "Windows Authentication" should be enabled
      2. Local - "Anonymous Access" should be enabled, "Forms Authentication" should be enabled and "Windows Authentication" should be disabled

Integrated Security Connecting to Xtraction Database

NOTE: This is only required if any of the database connections use Integrated Security

Windows Server 2003

  1. In IIS, locate the "Xtraction" application pool
  2. Right click -> Properties
  3. On the Identity tab, setup the user account used to access the database. The user account needs to be part of the IIS_WPG group and also be included in the "Log on as a service" security policy.

Windows Server 2008

  1. In IIS, locate the "Xtraction" application pool
  2. Open "Advanced Settings"
  3. Change the "Identity" setting to the user account used to access the database.

Xtraction will now execute as the user account specified. This account will need the correct permission to the file system in order to read the Xtraction web files (C:\Program Files\Xtraction Software\Xtraction\Web\Server by default).

Task Scheduler Installation

The Xtraction task scheduler is a Windows Service used to run scheduled exports of Documents and Custom Reports.

  1. Make sure the file is not blocked.
    1. Navigate to the Tools folder (C:\Program Files (x86)\Xtraction Software\Xtraction\Tools)
    2. Locate the Xtraction.SchedulerService.exe file
    3. Right click -> Properties
    4. Check to see if there is an "Unblock" button on the "General" tab (Windows Server 2008 R2)

      Figure 19

    5. Click "Unblock", then "Apply", then "OK"
  2. Open a command prompt
  3. Navigate to the Tools directory (C:\Program Files (x86)\Xtraction Software\Xtraction\Tools)
  4. Run the appropriate command
    1. C:\Windows\Microsoft.NET\Framework\v4.0.30319\InstallUtil.exe Xtraction.SchedulerService.exe
    2. C\Windows\Microsoft.NET\Framework64\v4.0.30319\InstallUtil.exe Xtraction.SchedulerService.exe

      You should see the following messages

      The Commit phase completed successfully. The transacted install has completed.
  5. Open Services manager
  6. Scroll to the bottom where you should see "Xtraction Task Manager"
  7. Setup the appropriate settings
    1. Startup type
    2. Logon
  8. Start the "Xtraction Task Manager" service

iPad Client Access

If you have iPad clients connecting to Xtraction, changes need to be made depending on the authentication method used to connect to Xtraction.

NOTE: Logon details are passed to Xtraction in plain text. It would be best to setup SSL on the Xtraction server and connect iPad clients using HTTPS.

General Settings

  1. Ensure the "Mobile access permitted" checkbox is selected in the Xtraction settings tool.

    Figure 20

Windows Integrated Authentication

  1. Update directory security in IIS allowing anonymous access to the Mobile folder

    Figure 21

  2. Update the web.config file (C:\Program Files (x86)\Xtraction Software\Xtraction\Web\Server) with the following settings:

    <location path="Mobile">     <system.web>           <authorization>               <allow users="*" />          </authorization>      </system.web> </location>

Local Xtraction Authentication

  1. Update the web.config file (C:\Program Files (x86)\Xtraction Software\Xtraction\Web\Server) with the following settings:

    <forms loginUrl="~/Login.aspx" name=".XTRACTION" cookieless="UseCookies" />

Running the Application

After all of the above steps have been completed, you are now ready to run Xtraction by pointing a web browser at:


replacing [SERVER] with the name of the server you installed Xtraction on.

The initial user in Xtraction has administrator and enterprise designer rights. What account is created as the initial user is based on the Application Logon Type selected during configuration.

Windows Integrated - The first person to access Xtraction will have an account automatically created
Local Database - An account with username "admin" and password "password"