INSTALLATION & CONFIGURATION GUIDE FOR IRIS-ADX · Installation & Configuration Guide for Iris-ADX...

15
1 INSTALLATION & CONFIGURATION GUIDE FOR IRIS-ADX Date of Publication: 16 Jan-2018

Transcript of INSTALLATION & CONFIGURATION GUIDE FOR IRIS-ADX · Installation & Configuration Guide for Iris-ADX...

Page 1: INSTALLATION & CONFIGURATION GUIDE FOR IRIS-ADX · Installation & Configuration Guide for Iris-ADX Application 3 1. Introduction The purpose of this installation guide is to describe

1

INSTALLATION & CONFIGURATION GUIDE FOR

IRIS-ADX

Date of Publication: 16 Jan-2018

Page 2: INSTALLATION & CONFIGURATION GUIDE FOR IRIS-ADX · Installation & Configuration Guide for Iris-ADX Application 3 1. Introduction The purpose of this installation guide is to describe

Installation & Configuration Guide for Iris-ADX Application 2

1. Table of Contents 1. Introduction ........................................................................................................................................... 3

2. Intended audience ................................................................................................................................. 3

3. Download Iris-ADX Database & Restore: ............................................................................................... 4

4. Download and Install Iris-ADX Application: ........................................................................................... 5

5. Configuring Database Connectivity for Iris-ADX Application: ................................................................ 8

6. Installing and Configuring Iris-ADX Synchronization Service: ................................................................ 9

Page 3: INSTALLATION & CONFIGURATION GUIDE FOR IRIS-ADX · Installation & Configuration Guide for Iris-ADX Application 3 1. Introduction The purpose of this installation guide is to describe

Installation & Configuration Guide for Iris-ADX Application 3

1. Introduction The purpose of this installation guide is to describe the steps necessary to install and deploy “Iris

Asynchronous Data Exchange (ADX)” application and to make it operational. This application is

developed using “.NET”.

2. Intended audience

This document is intended to be used by registered Taxpayers (for Sales Tax), who will be responsible

for the installation and configuration of the application on their own system(s). For any help with the

installation of this application, registered Taxpayers may contact FBR (technical) support staff for

consultation or guidance at [email protected].

2.1. Prerequisites

Before we begin this guide, there are some important steps that are required to be completed prior

to running the setup. Make sure that you are running a system that meets the following minimum

requirements:

2.1.1. System Requirements

Client System Requirements:

• Operating System

Windows 7, Windows 8, Windows 8.1, Windows 10

Microsoft Office Excel 2010

.Net v3.5/ .Net v4.5.2

• Application Memory Requirements

Hard drive 80 Gigabytes (minimum)

Ram 8GB (Recommended) – (Minimum 4GB)

• Application CPU Requirements

Processor: Intel Core i3 and above (such as Intel Core i5, or Intel Core i7)

Wired Networking: Ethernet LAN Port or USB Ethernet Adapter/Dongle (OR)

Wireless Networking: 802.11n

Server System Requirements:

Page 4: INSTALLATION & CONFIGURATION GUIDE FOR IRIS-ADX · Installation & Configuration Guide for Iris-ADX Application 3 1. Introduction The purpose of this installation guide is to describe

Installation & Configuration Guide for Iris-ADX Application 4

• Operating System

Windows 7, Windows 8, Windows 8.1, Windows 10

Microsoft Office Excel 2010

.Net v3.5/ .Net v4.5.2

Availability of 24/7 Internet

• Application Memory Requirements

Hard drive 250 Gigabytes (minimum)

Ram 8GB

• Application CPU Requirements

Processor: 64-bit, four-core, 2.5 GHz minimum per core.

Wired Networking: Ethernet LAN Port or USB Ethernet Adapter/Dongle (OR)

Wireless Networking: 802.11n

Database Requirements:

• MS SQL Server (2005 or later version).

3. Download Iris-ADX Database & Restore:

Download and save the “IrisADXDB2005.zip” file in a location with sufficient space.

Open the folder containing the downloaded zip file and extract the contents.

You will find SQL Server Backup file named as “IRISADX2005.bak”.

You can restore this backup on you SQL Server with Database name as “IRISADX”.

For help on restoration of SQL Server Backup you can refer to Microsoft Knowledgebase or

click the following link for kick-start.

https://msdn.microsoft.com/en-us/library/ms177429(v=sql.90).aspx

For help on SQL Server Installation you can refer to Microsoft Knowledgebase or click the

following link(s).

https://docs.microsoft.com/en-us/sql/database-engine/install-windows/installation-for-sql-

server

https://technet.microsoft.com/en-us/library/ms143516(v=sql.90).aspx

https://technet.microsoft.com/en-us/library/ms143219(v=sql.105)

Note: SQL Server installation process may vary depending on version of SQL Server you are

going to install.

Page 5: INSTALLATION & CONFIGURATION GUIDE FOR IRIS-ADX · Installation & Configuration Guide for Iris-ADX Application 3 1. Introduction The purpose of this installation guide is to describe

Installation & Configuration Guide for Iris-ADX Application 5

IMPORTANT:

While installing SQL Server, please make sure that you choose SQL Server Authentication

Mode as “Mixed Mode (SQL Server Authentication and Windows Authentication)”.

4. Download and Install Iris-ADX Application: • Download and save the “IRIS-ADX Setup.zip” file in a location with sufficient space.

• Open the folder containing the downloaded zip file and extract the contents.

• In the extracted folder, run the “IRIS-ADX Setup.exe” file to start the installation. The

following screen shall appear:

Figure 1

• When visible, click on the “Next” button to continue with the installation as shown in the

figure below.

Page 6: INSTALLATION & CONFIGURATION GUIDE FOR IRIS-ADX · Installation & Configuration Guide for Iris-ADX Application 3 1. Introduction The purpose of this installation guide is to describe

Installation & Configuration Guide for Iris-ADX Application 6

Figure 2

• In order to proceed, print and read the license agreement carefully and select the “I accept

the terms in the license agreement” and click the “Next” button as shown in the figure

below.

Figure 3

• Add your Name and Organization name in the fields as shown in the figure below and click

“Next”.

Page 7: INSTALLATION & CONFIGURATION GUIDE FOR IRIS-ADX · Installation & Configuration Guide for Iris-ADX Application 3 1. Introduction The purpose of this installation guide is to describe

Installation & Configuration Guide for Iris-ADX Application 7

Figure 4

• To install the complete application proceed by clicking the “Next” button as shown in the

figure below.

Figure 5

• In order to start the installation process with the previously provided information, click the

“Install” button as shown in the figure below.

Page 8: INSTALLATION & CONFIGURATION GUIDE FOR IRIS-ADX · Installation & Configuration Guide for Iris-ADX Application 3 1. Introduction The purpose of this installation guide is to describe

Installation & Configuration Guide for Iris-ADX Application 8

Figure 6

• After the installation is complete, click the “Finish” button as shown in the figure below.

Figure 7

• In order to start the application, double click on the “Iris-ADX.exe" shortcut icon on your

desktop. Alternatively, you can find the same under “Federal Board of Revenue” folder in

Programs Menu of Windows.

5. Configuring Database Connectivity for Iris-ADX Application:

Page 9: INSTALLATION & CONFIGURATION GUIDE FOR IRIS-ADX · Installation & Configuration Guide for Iris-ADX Application 3 1. Introduction The purpose of this installation guide is to describe

Installation & Configuration Guide for Iris-ADX Application 9

Open the folder in windows file explorer where you have installed Iris-ADX Application.

In this folder, you will see a file named as “Iris-ADX.exe.config” as shown in image below.

Right-click and open this file in Notepad.

Find the line of code in this file as per image given below:

Please change this line of code as mentioned in below steps:

o Replace the text “SQLServerIP_Instance” with your pre-configured SQL Server IP

Address (and SQL Server Instance Name if any).

o Replace the text “IRISADX” with your SQL Server DB Name (if different from the

one mentioned).

o Replace the User ID with your SQL Server User in place of “SQLServerUserID”.

o Provide the User Password of your SQL Server User in place of

“SQLServerUserPassword”.

Review the changes, Save the File and close Note-pad.

Now the Iris-ADX application is ready for use.

6. Installing and Configuring Iris-ADX Synchronization Service:

Download and save the “IRISADX Sync Service Setup.zip” file in a location with sufficient

space.

Open the folder containing the downloaded zip file and extract the contents.

In the extracted folder, run “IRISADX Service Setup.exe” file to start the installation. The

following screen shall appear:

Page 10: INSTALLATION & CONFIGURATION GUIDE FOR IRIS-ADX · Installation & Configuration Guide for Iris-ADX Application 3 1. Introduction The purpose of this installation guide is to describe

Installation & Configuration Guide for Iris-ADX Application 10

Figure 8

When visible, click on the “Next” button to continue with the installation as shown in the

figure below.

Figure 9

In order to proceed, print and read the license agreement carefully and select “I accept the

terms in the license agreement”, click “Next” button as shown in the figure below.

Page 11: INSTALLATION & CONFIGURATION GUIDE FOR IRIS-ADX · Installation & Configuration Guide for Iris-ADX Application 3 1. Introduction The purpose of this installation guide is to describe

Installation & Configuration Guide for Iris-ADX Application 11

Figure 10

Add your Name and Organization name in the fields as shown in the figure below and click

“Next”.

Figure 11

To install the complete application proceed by clicking the “Next” button as shown in the

figure below.

Page 12: INSTALLATION & CONFIGURATION GUIDE FOR IRIS-ADX · Installation & Configuration Guide for Iris-ADX Application 3 1. Introduction The purpose of this installation guide is to describe

Installation & Configuration Guide for Iris-ADX Application 12

Figure 12

Click “Install” button as shown in the figure below.

Figure 13

Installation of the Synchronization Service shall start. In case, you are prompted for

permission to install the service, please click on “Yes” to continue.

Page 13: INSTALLATION & CONFIGURATION GUIDE FOR IRIS-ADX · Installation & Configuration Guide for Iris-ADX Application 3 1. Introduction The purpose of this installation guide is to describe

Installation & Configuration Guide for Iris-ADX Application 13

Figure 14

When the Installation is successful, you will see the following screen.

Figure 15

Open the folder “C:\Program Files (x86)\Federal Board of Revenue\ IRIS-ADX

Synchronization Service” in windows.

In this folder you will see a file named as “IRISADXSyncService.exe.config” as shown in

image below.

Page 14: INSTALLATION & CONFIGURATION GUIDE FOR IRIS-ADX · Installation & Configuration Guide for Iris-ADX Application 3 1. Introduction The purpose of this installation guide is to describe

Installation & Configuration Guide for Iris-ADX Application 14

Right-click and open this file in Notepad.

Find the line in this file as per image given below:

Please change this line as mentioned in below steps:

o Replace the text “SQLServerIP_Instance” with your SQL Server IP Address (and

SQL Server Instance Name if any).

o Replace the text “IRISADX” with your pre-defined SQL Server DB Name (if

different from the one mentioned).

o Replace the User ID with your SQL Server User in place of “SQLServerUserID”.

o Provide the User Password of your SQL Server User in place of

“SQLServerUserPassword”.

Review the changes, save file and close Note-pad.

It is strongly recommended to “Restart” your System.

After the system restarts, press “Win + R” buttons, following “Run” dialog shall appear.

Figure 16

Type “services.msc” in the “Open” field, system displays a “Services” window as displayed.

Page 15: INSTALLATION & CONFIGURATION GUIDE FOR IRIS-ADX · Installation & Configuration Guide for Iris-ADX Application 3 1. Introduction The purpose of this installation guide is to describe

Installation & Configuration Guide for Iris-ADX Application 15

Figure 16

Find a service with the name “Iris-ADX Synchronization Service” as shown below:

In case, the service status under “Status” column is blank or stopped, start “IRIS-ADX

Synchronization Service” service by clicking (Right Mouse) button, and selecting “Start”

from the options.

The synchronization service shall start and enabled for data synchronization with FBR

Servers.

IMPORTANT: IRIS-ADX Synchronization Service must be installed on the system, where

database server is configured (i.e. only on server computer) and shall be installed only

once. The service may not work as desired in case of multiple installations of IRIS-ADX

Synchronization Service.