Description:
How to install Xtraction v13.3
Solution:
Recommended Hardware
RAM: 2GB
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.
<Please see attached file for image>
<Please see attached file for image>
<Please see attached file for image>
<Please see attached file for image>
<Please see attached file for image>
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.
<Please see attached file for image>
<Please see attached file for image>
<Please see attached file for image>
<Please see attached file for image>
<Please see attached file for image>
<Please see attached file for image>
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)
<Please see attached file for image>
After you have entered the database details, use the "Test" button to attempt a database connection to make sure the details provided are correct.
<Please see attached file for image>
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.
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.
If you want the Xtraction task scheduler to send emails, configure email settings from the Email tab.
<Please see attached file for image>
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
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".
<Please see attached file for image>
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.
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.
<Please see attached file for image>
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.
<Please see attached file for image>
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.
<Please see attached file for image>
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:
These settings only apply if Xtraction is installed on a Windows 2008 server:
NOTE: This is only required if any of the database connections use Integrated Security
Windows Server 2003
Windows Server 2008
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).
The Xtraction task scheduler is a Windows Service used to run scheduled exports of Documents and Custom Reports.
<Please see attached file for image>
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
<Please see attached file for image>
Windows Integrated Authentication
<Please see attached file for image>
<location path="Mobile"> <system.web> <authorization> <allow users="*" /> </authorization> </system.web> </location>
Local Xtraction Authentication
<forms loginUrl="~/Login.aspx" name=".XTRACTION" cookieless="UseCookies" />
After all of the above steps have been completed, you are now ready to run Xtraction by pointing a web browser at:
http://[SERVER]/xtraction
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"