Report Exec Enterprise Update Guide Exec Enterprise Update Guide.pdfAll of the necessary install...

13

Transcript of Report Exec Enterprise Update Guide Exec Enterprise Update Guide.pdfAll of the necessary install...

Page 1: Report Exec Enterprise Update Guide Exec Enterprise Update Guide.pdfAll of the necessary install files for Report Exec Enterprise can be obtained from the Online Support Center. The
Page 2: Report Exec Enterprise Update Guide Exec Enterprise Update Guide.pdfAll of the necessary install files for Report Exec Enterprise can be obtained from the Online Support Center. The

1

VERSION 11.08

Contents

Technical Support ......................................................................................................................................................... 2

Download ...................................................................................................................................................................... 2

Windows Block Feature..................................................................................................................................................................... 2

Preparing the SQL Server .............................................................................................................................................. 3

Backup the Database ............................................................................................................................................................................. 3

Clear Previous Install/Update Directory ................................................................................................................................................ 3

What does it all mean? .......................................................................................................................................................................... 3

SQL Database Update ................................................................................................................................................... 3

What does the SQL installer do? ........................................................................................................................................................... 6

General Steps of the SQL installer ..................................................................................................................................................... 6

Confirming a Successful Database Update ............................................................................................................................................ 6

Verify SQL Database Version ............................................................................................................................................................. 6

Preparing the IIS Server ................................................................................................................................................ 7

What needs to be considered? .............................................................................................................................................................. 7

Clear Existing Website Folders of Non-Essential Files ........................................................................................................................... 7

User Website (CESIReportExec) ........................................................................................................................................................ 7

360 Website (CESIReportExec360) .................................................................................................................................................... 8

Admin Website (CESIReportExecAdmin) ........................................................................................................................................... 8

Signal R Application (CESIReportExecSignalR) ................................................................................................................................... 8

Report Exec Web Api (CESIReportExecWebApi) ............................................................................................................................... 8

Ready to update IIS? .............................................................................................................................................................................. 8

IIS Website Update ....................................................................................................................................................... 9

Additional Notes .................................................................................................................................................................................. 11

Confirming a Successful Installation ........................................................................................................................... 12

Verify Application Readiness ............................................................................................................................................................... 12

Post-Installation Checklist ................................................................................................................................................................... 12

Page 3: Report Exec Enterprise Update Guide Exec Enterprise Update Guide.pdfAll of the necessary install files for Report Exec Enterprise can be obtained from the Online Support Center. The

2

VERSION 11.08

Overview

Technical Support

Technical Support is available from 8am – 4pm Central Time, Monday – Friday, if there are error messages or issues that cannot be

figured out or resolved by an I.T. Professional. Report Exec Technical Support can be reached by emailing [email protected]

or by call calling (414) 423-9800 option 2.

Download

All of the necessary install files for Report Exec Enterprise can be obtained from the Online Support Center. The username and

password supplied at the time of purchase, found on the licensing certificate, are required to enter the site. If the login information

has been misplaced then please feel free to contact Technical Support.

The Report Exec Online Support Center is

accessed at http://www.reportexec.com/login/.

Sign in with the provided username and

password and select Enterprise Version Update.

Under the Server Installation/Update File

section are the two files needed to the

complete the main installation of the program.

Crystal Reports 2011 will automatically

download and install during the IIS installation.

If your server does not have access to the

internet then you can download that file from

the Support page.

Download each file and be sure to first

SAVE them to the server or a workstation

that can access the server. The SQL

installation file can be executed remotely

by a user that has access to the SQL server

to do database installations. The IIS

installation file must be executed locally on

the IIS server itself.

Windows Block Feature

By default, Windows will put a block on files downloaded

from a location outside of the organization’s network. It is

extremely important to make sure that the install files are not

blocked. To do so, right click each of the downloaded files in

turn and select Properties. On the General tab, click the

Unblock button and Apply the changes. If the Unblock

button does not exist then this step can be disregarded.

The installers cannot be guaranteed to work when they are executed with the Windows “block” enabled.

Page 4: Report Exec Enterprise Update Guide Exec Enterprise Update Guide.pdfAll of the necessary install files for Report Exec Enterprise can be obtained from the Online Support Center. The

3

VERSION 11.08

Installation

Preparing the SQL Server

Backup the Database

It is imperative to back-up the Report Exec database on the SQL Server (as-well-as the IIS web directories on the IIS Server) before

performing an update. Backups are crucial for disaster recovery in the event of a problem during the update process. Report Exec

only maintains the data of their hosted customers and are not responsible for data loss that occurs from lack of backups for agencies

which host their own data.

Clear Previous Install/Update Directory

During the initial installation of the Report Exec Enterprise application, or during a previous update to the program, a directory was

created where files pertaining to the database update are placed which are used to update the REX database. These files should be

deleted before an update is performed in order to make sure that fresh copies of the new update files are created. Sometimes,

depending on security policies of the network, Windows will not let the files overwrite as expected resulting in oddities during the

update. It is best to first remove these files.

The default SQL install/update directory is C:\Program Files\Competitive Edge Software Inc\Report Exec Database Updater\ on 32-

bit servers or C:\Program Files (x86)\Competitive Edge Software Inc\Report Exec Database Updater\ on 64-bit servers. It is

recommended to keep the directory folder that the install files are dumped into, as any future Report Exec update will also need a

temporary directory, and to delete all the files contained within said directory.

What does it all mean?

Verify that any temporary Report Exec directories have been cleared of old update files before running the SQL update file.

Backup the Report Exec database (default name REX) before running the update file.

SQL Database Update

The SQL installer can be executed from the IIS server. The workstation that is being used to update Report Exec Enterprise can be

any machine on the network with access to the SQL server in question, including the server itself, as long as the Windows User

Account has rights to create databases and users in SQL.

If the SQL installer is executed on the SQL server, or some other workstation, then Microsoft .NET Framework 4.5 is also needed on

the SQL server.

1. Locate and run the Report Exec Enterprise SQL.exe

installation file that should already be saved to a

directory that has access to the SQL server.

2. The installation file will want to know the destination

folder to extract all of the contained update files. It is

recommended to keep the default directory of

C:\Program Files (x86)\Competitive Edge Software

Inc\Report Exec Database Updater\ and simply click

Next.

Page 5: Report Exec Enterprise Update Guide Exec Enterprise Update Guide.pdfAll of the necessary install files for Report Exec Enterprise can be obtained from the Online Support Center. The

4

VERSION 11.08

3. The installer will then request the name of the

database server where the Report Exec database is

installed to and the credentials for the Windows User

Account that will be performing the installation. The

Windows User Account that is performing the

installation will need sysadmin (SA) rights in SQL. The

default name of the Report Exec database is REX. Click

Next to continue with the installation.

4. The installer should now have enough information to

extract the support files needed to complete the database

installation and update. If ready, click Continue to begin the

update which will now extract the files needed for the update

to proceed. The files will be extracted to the directory

previously specified at this time.

5. Next, the installer will now update the Report Exec

database to the latest version of Report Exec. When the

Update Report Exec Database button is clicked the

REX_SCHEMA_Data.mdf and REX_SCHEMA_Log.ldf file will be

installed to the main SQL Data directory.

Page 6: Report Exec Enterprise Update Guide Exec Enterprise Update Guide.pdfAll of the necessary install files for Report Exec Enterprise can be obtained from the Online Support Center. The

5

VERSION 11.08

6. If files for an existing rex_schema already exist then the

updater will confirm that you want to remove those

files, otherwise the installer will detect that no

rex_schema exists and proceed with the installation.

7. Either way, the installer should now

proceed with installing the rex_schema database

and finish successfully. Refreshing SQL

Management Studio at this time will reveal that

rex_schema has been attached.

8. The installer will now

launch the database

update program and begin

the steps necessary to

update the Report Exec

database to the latest

version. A RedGate

compare is done which

will produce a script that

will run to make all of the

necessary changes which

sync the Report Exec

database with the

updated Report Exec

schema. Once the update

is complete a Close button

will appear.

Page 7: Report Exec Enterprise Update Guide Exec Enterprise Update Guide.pdfAll of the necessary install files for Report Exec Enterprise can be obtained from the Online Support Center. The

6

VERSION 11.08

What does the SQL installer do?

General Steps of the SQL installer

Run Report_Exec_DB_Schema_Install.exe.

Check for an existing REX_SCHEMA database and delete if present.

Create updated REX_SCHEMA .mdf and .ldf files in the main SQL data and log folders.

Run ReportExecDataUpdate.exe.

Runs a database compare between the current version of the ReportExec database and the updated Rex_Schema.

The compare program then produces a script that will run to make all of the necessary changes which sync the

ReportExec database with the updated ReportExec Schema. During this entire process only the ReportExec

database is targeted. The Rex_Schema and all temporary files can be disposed of, if needed, once the updater has

completed successfully.

The SQL installer touches nothing else and only deals with relevant temporary files concerning the Report Exec application and does

nothing else to any general system files, server files, or anything globally for SQL that would conflict with other applications or

databases.

Confirming a Successful Database Update

Verify SQL Database Version

Executing the following query in SQL Management Studio against the Report Exec database will display the current version number

which should confirm if the database update went successfully.

Simply copy and paste the following SQL query into a query window within SQL Management Studio.

/**************** Display Current Report Exec Database Version ****************/ SELECT * FROM dbo.[Data] WHERE [Datatype] IN ('DBVersion','DBVersionDisplay') /******************************************************************************/

Page 8: Report Exec Enterprise Update Guide Exec Enterprise Update Guide.pdfAll of the necessary install files for Report Exec Enterprise can be obtained from the Online Support Center. The

7

VERSION 11.08

Preparing the IIS Server

What needs to be considered?

Legacy versions of Report Exec Enterprise website before version 11.06 are not archived. Always be sure to backup the web

directories before performing the update to Report Exec in the event that disaster recovery is needed.

It is important to know the name of the SQL server when removing these files so that the web.config file is able to be easily

recreated when the update is done.

Report Exec Technical Support highly recommends that you Clear Existing Website Folders of Non-Essential Files.

Custom work files delivered from Development, such as custom Crystal Report templates, or a CesiODBC.dll, must be

preserved during this process.

CesiODBC.dll would be in CESIReportExec/bin if the organization has purchased the ODBC module.

Custom Crystal Report templates delivered by Report Exec are typically found in a folder named Custom which is in

the Crystal Reports folder within CESIReportExec.

Additional Note: If custom Crystal Report work was done outside of Report Exec Development, that replaced any

of the default templates of the program, those templates will need to be preserved during this process or they will

be overwritten. Report Exec is not responsible for custom data loss that occurs for not taking these steps into

consideration.

Clear Existing Website Folders of Non-Essential Files

In order to ensure that the newest copies of the website files are successfully installed to the IIS Server it is highly recommended by

Report Exec Tech Support to delete all of the non-essential files out of the website folders before executing the update files. The IIS

website files are located in the following directories by default:

C:\inetpub\wwwroot\CESIReportExec

C:\inetpub\wwwroot\CESIReportExec3601

C:\inetpub\wwwroot\CESIReportExecAdmin

C:\inetpub\wwwroot\CESIReportExecSignalR2

C:\inetpub\wwwroot\CESIReportExecWebApi3

User Website (CESIReportExec)

Within the CESIReportExec folder only three folders need to be preserved: Data4, FileUploaderTemp, and Images. There may also

be a custom dictionary file that should be preserved.

Custom Spelling Dictionary File

Version 11.07 and lower: The custom dictionary file is tored in the root of the CESIReportExec folder and is named user.dict.

Version 11.08 and higher: The custom dictionary file is stored in the CESIReportExec\AppData\RadSpell directory and will be

named en-US-Custom.txt.

Move the custom dictionary files somewhere else for now and move them back to where they need to be once the update is done.

1 The CESIReportExec360 folder does not exist in older versions of the program. If it does not exist then you can disregard that directory for now. 2 The CESIReportExecSignalR folder does not exist in older versions of the program. If it does not exist then you can disregard that directory for now. 3 The CESIReportExecWebApi folder does not exist in older versions of the program. If it does not exist then you can disregard that directory for now. 4 The Data folder within the CESIReportExec folder is arguably the most important folder to preserve. This folder contains ALL of the digital media entered into the Report Exec system and absolutely needs to be preserved.

Page 9: Report Exec Enterprise Update Guide Exec Enterprise Update Guide.pdfAll of the necessary install files for Report Exec Enterprise can be obtained from the Online Support Center. The

8

VERSION 11.08

Note: The old User.dict file, if it exists, can be opened in notepad and have any needed custom spelling items copied and pasted

into the new custom dictionary file en-US-Custom.txt.

User Site File Clear

Use CTRL + A on the keyboard to select all items in the CESIReportExec folder. While holding

CTRL, de-select the Data, FileUploaderTemp, and Images folders.

Once the important folders have been de-selected everything else may be deleted.

Sometimes a folder will say it is still in use and not able to be deleted. Click the Skip button so that anything that is not locked will

delete. Then, after everything else deletes, the files that did not previously delete are able to be removed. Once all the non-

essential files are removed, the CESIReportExec folder should then be ready to receive an update.

360 Website (CESIReportExec360)

Delete all items from inside the CESIReportExec360 folder.

Admin Website (CESIReportExecAdmin)

Within the CESIReportExecAdmin folder only one folder needs to be preserved: Images.

Admin Site File Clear

Use CTRL + A on the keyboard to select all items in the CESIReportExecAdmin folder. While holding CTRL,

de-select the Images folder.

Once the important folder has been de-selected everything else may be deleted. Once the files are removed, the

CESIReportExecAdmin folder should then be ready to receive an update.

Signal R Application (CESIReportExecSignalR)

Delete all items from inside the CESIReportExecSignalR folder.

Report Exec Web Api (CESIReportExecWebApi)

Delete all items from inside the CESIReportExecWebApi folder.

Ready to update IIS?

When the following steps have been confirmed to have been completed, the update to the Report Exec Enterprise websites can

begin:

Backup the web-directories by copying the files somewhere else, or sending them to a compressed folder.

Confirm that any custom work files have been preserved. Disregard if no custom work has been done.

Delete non-essential files from CESIReportExec.

Delete non-essential files from CESIReportExec360.

Delete non-essential files from CESIReportExecAdmin.

Delete non-essential files from CESIReportExecSignalR.

Delete non-essential files from CESIReportExecWebApi.

Page 10: Report Exec Enterprise Update Guide Exec Enterprise Update Guide.pdfAll of the necessary install files for Report Exec Enterprise can be obtained from the Online Support Center. The

9

VERSION 11.08

IIS Website Update

The IIS sites should be updated after the SQL database update has been completed and confirmed to be displaying the new version

of the program. The websites will now be re-installed and then pointed back to the Report Exec database.

1. Locate the Report Exec Enterprise IIS Install.exe that

should already be saved to a local directory (such as

the desktop) on the IIS Server and unblocked. When

the installer is launched the welcome screen is

presented. Click Next to continue.

2. The default location for the user website is

C:\Inetpub\wwwroot\. The default install location can be

changed as needed with the Change button. Be sure to point

this to whichever directory holds the website site folders;

CESIReportExec and CESIReportExecAdmin. Once the

destination folder has been confirmed, click Next to proceed

to the next step of the installation.

3. The installer should now have the information it needs

to continue with installing the website files to the

server. If the settings need to be reviewed at this point

click the Back button. When ready, click Install to

continue with the installation.

Page 11: Report Exec Enterprise Update Guide Exec Enterprise Update Guide.pdfAll of the necessary install files for Report Exec Enterprise can be obtained from the Online Support Center. The

10

VERSION 11.08

4. A progress bar indicating where the installation

progress is at will be displayed.

5. When all of the website files have been installed to

the chosen directory the completion screen will be

displayed. Click Complete Configuration to install

Crystal Reports and launch the CESI ReportExec

Configuration App which will create the web.config

file that holds the connection string.

6. The installer will now verify whether Crystal Reports 2011 is

installed on the server or not. If it is not installed a message will be

displayed providing the option to download and install the file

automatically if there is an internet connection. Clicking Yes will open

a window to choose where to save the installer. Clicking No will give

the opportunity to copy the URL5 to the clipboard so that the file can

be manually downloaded from a different workstation. Crystal

Reports 2011 will now be installed.

Note: Version 11.08.15072.1 of Report Exec contains an update for Crystal Reports 2011. Even if you have Crystal Reports 2011

installed on your server, you will be required to download and update version 13.0.13.

5 Crystal Reports Runtime 13.0.13: http://downloads.businessobjects.com/akdlm/crnetruntime/clickonce/CRRuntime_32bit_13_0_13.msi

Page 12: Report Exec Enterprise Update Guide Exec Enterprise Update Guide.pdfAll of the necessary install files for Report Exec Enterprise can be obtained from the Online Support Center. The

11

VERSION 11.08

7. The CESI ReportExec Configuration

App will now launch twice, in

succession, to create the connection

strings, once for the User website,

once for the Admin website. It is

recommended to not use (local), but

instead use the name of the server

itself comma SQL port number i.e.

servername,1433. Enter the name of

the Report Exec database in the

Database field. The default database

name is REX. If the password for the

cesi_user and cesi_admin account in

SQL has not been changed then the

Test button will produce a login

success message when it tries to

connect to the database. Click Finish

to close the config app once there is a successful test.

a. The ASP.NET Session Settings should be left with the default selection of In Process. The SQL State Database and

the IIS State Server settings are for specific configurations and are generally never used.

8. Once the CESI ReportExec Configuration App is

closed a message indicating a successful installation will be

displayed. Click OK.

Additional Notes

This consideration is for ONLY IF

CRYSTAL REPORTS REQUIRED

AN UPDATE. If the Report Exec

websites are installed on a

different partition/volume other

than the C:\ drive, then the

aspnet_client folder found in

C:\inetpub\wwwroot will need

to be copied over to the IIS

directory on the other

partition/volume.

Page 13: Report Exec Enterprise Update Guide Exec Enterprise Update Guide.pdfAll of the necessary install files for Report Exec Enterprise can be obtained from the Online Support Center. The

12

VERSION 11.08

Confirming a Successful Installation

Verify Application Readiness

Prior to letting users back into the program, it is a good idea to take a couple of steps to ensure that the program performs exactly as

expected.

1. Access the Report Exec and Report Exec Admin login pages.

a. The first time the Admin and User login pages are accessed they will take slightly longer to load.

i. Obtain the website URL from

one of the end-users’

shortcut links if the URL is

unknown.

ii. Only one link is needed. Each

login page has a link to the

other login page. Click the

CESI Report Exec link at the

bottom of the login page to

switch.

2. Login into the User side of the program

after both the Admin and User login

pages have loaded for the first time.

3. Navigate to Searches > Reports and click Search.

a. The first time a search is invoked after an update the server will do a few things which takes a few moments. After

this first search, every other search will work at normal speed.

4. Log out of the User side of the program, switch to the Admin side and login.

5. Navigate to System Wide Setup > System Settings. When this page loads up

Post-Installation Checklist

SQL database updated to the latest version of the application.

Report Exec User Website successfully updated on the IIS Server and pointed to the REX database.

Report Exec Admin Website successfully updated on the IIS Server and pointed to the REX database.

Crystal Reports successfully updated on the IIS Server (only if prompted that the update was required).

Report Exec 360 Website successfully installed/updated on the IIS server.