Install and Configure the FMx Reporting Components Docs... · 2 Install and Configure the FMx...
Transcript of Install and Configure the FMx Reporting Components Docs... · 2 Install and Configure the FMx...
Install and Configure the FMx Reporting Components Document Release Date: Last Document Update Date: 6/27/2016
i Install and Configure the FMx Reporting Components
Legal Notices
Copyright Notices
© Copyright 1994-2016 FM:Systems, Inc.
All rights reserved.
Confidential computer software.
Valid license from FM:Systems required for possession, use or copying.
Warranty
The only warranties for FM:Systems products and services are set forth in the express warranty statements
accompanying such products and services.
Nothing herein should be construed as constituting an additional warranty.
FM: Systems shall not be liable for technical or editorial errors or omissions contained herein.
The information contained herein is subject to change without notice.
Trademark Notices
FM:Systems® is a registered trademark of FM:Systems, Inc.
FM:Interact® is a registered trademark of FM:Systems, Inc.
FM:CAD® is a registered trademark of FM:Systems, Inc.
FM:Mobile™ is a trademark of FM:Systems, Inc.
AutoCAD® and Revit® Architectural Suite are registered trademarks of Autodesk, Inc.
LEED® is a registered trademark of the U.S. Green Building Council.
Green Globes™ is a trademark of ECD Energy and Environment Canada.
iPad® ,iPhone®, and Safari® are registered trademarks of Apple, Inc.
Firefox® is a registered trademark of Mozilla.
Blackberry® is a registered trademark of Research In Motion.
Adobe®, Adobe logo®, Acrobat® and Acrobat Logo® are trademarks of Adobe Systems Incorporated.
Microsoft®,Windows®,Windows NT®,Windows® XP,Windows Mobile® and Windows Vista are U.S. registered trademarks of Microsoft Corporation.
Oracle® is a registered trademark of Oracle Corporation and/or its affiliates.
All other brand names, product names or trademarks belong to their respective holders. Published By: FM:Systems 2301 Sugar Bush Rd. Suite 500 Raleigh, NC 27612, USA
1 Install and Configure the FMx Reporting Components
Overview
Introduction
This guide walks through how to install and configure the components that support the FMx Reporting solution, available in FM:Interact 8.5+.
The FMx Reporting solution enables users to create and generate reports on the fly from within FM:Interact as opposed to needing access to a
report server to create reports.
Who Needs to Install the FMx Reporting Components?
Clients who want end users to be able to create and run their own reports should install the FMx Reporting components. SSRS and Crystal
reports are still supported, but FMx Reporting gives FM:Interact users front-end access to creating new reports.
Note: FM:Interact 8.5+ is required.
Assumptions
This document assumes that FM:Interact 8.5 has been installed previously and that the FM:Interact web.config file has been populated with the
appropriate values.
Installed Components
The FMx Reporting solution includes the installation of five components, which are outlined below:
FMx Reporting App: the FMx Reporting application which allows end users to create and manage reports
Note: It is recommended that this be installed on the same server as FM:Interact, however this must be installed on the same server
where the FMx Report App WebAPI web service is installed.
FMx Report App WebApi Web Service: the API used to by FM:Interact to communicate with the FMx Reporting application
Note: It is recommended that this be installed on the same server as FM:Interact, however this must be installed on the same server
where the FMx Reporting App is installed.
FMx Report Repository Web Service: the web service that allows the reporting app to talk to the FM:Interact database
Note: This can be installed on a separate server from FM:Interact as long as this server has access to the database.
2 Install and Configure the FMx Reporting Components
FMx Reporting Scheduler Queue Web Service: This component allows FM:Interact to create and manage the scheduled report queue as
well as allowing the FMx Reporting Remote Scheduler service to access and update the scheduled report queue. This component is only
required if reports will be scheduled or executed remotely.
Note: This can be installed on a separate server from FM:Interact as long as this server has access to the database.
FMx Reporting Remote Scheduler: the scheduling and remote execution component that executes scheduled reports and/or remotely
executes reports. This component is only required if reports will be scheduled or executed remotely.
Note: This component runs as a Windows service and can be installed on a separate server from FM:Interact as long as this server has
access to the database.
3 Install and Configure the FMx Reporting Components
Install the FMx Reporting
Components
Introduction
This procedure outlines how to install the
FMx Reporting components on a single
server.
Procedure
1. Double-click on the FMx Reporting Setup
xXX.exe installation file that matches the
version of FM:Interact installed.
2. Click next and accept the License
Agreement.
3. Enter your username and organization
(optional) and click next.
4. Accept or update the destination folder
for the web services and click next. Note
this will set the default Instance Name for
the FMx Reporting components.
NOTE: Only one instance of the Reporting
components is required per client.
4 Install and Configure the FMx Reporting Components
5. On the Setup Type screen, select Custom
installation, and click Next.
6. On the Custom Setup screen, ensure
that FMx Reporting, FMx Reporting API
Web Service, FMx Report Repository
Web Service are enabled. If you intend
to schedule report execution enable
FMx Reporting Scheduler Queue
Service, and FMx Reporting Remote
Scheduler.
7. Choose which website and Application
Pool in IIS you would like the FMx
Reporting to run under.
8. Accept or modify the Site Name for each
FMx Reporting item. The default naming
may be kept; however, if you are
installing a new instance of FMx
Reporting, please give the web services
unique names.
9. Complete the rest of the install wizard.
5 Install and Configure the FMx Reporting Components
10. In IIS Manager, check the Application
Pool Identity of the FMx Reporting
Application Pool. You may set this to be
the same as the Application Pool
Identity for FM:Interact.
11. Navigate to the directory where the
Reporting App was installed.
Default: C:\inetpub\wwwroot\FMx
Reporting\FMxReportingApp
12. Set the permissions on the Config and
Temp folders to allow Modify for the
user that is set as the Application Pool
Identity for the FMx Reporting web
services. Note: use the user “iis_iusrs” if
the Application Pool Identity is set to
“ApplicationPoolIdentity”.
13. Navigate to the directory where the
Reporting App Scheduler Queue Service
was installed.
Default: C:\inetpub\wwwroot\FMx
Reporting\FMxReportingSchQueueWeb
Service
14. Set the permissions on the Log folder to
allow Modify for the user that is set as
the Application Pool Identity for the FMx
Reporting web services. Note: use the
user “iis_iusrs” if the Application Pool
Identity is set to
“ApplicationPoolIdentity”.
6 Install and Configure the FMx Reporting Components
Configuring the FMx Reporting
Components
Configuring the FMx Reporting
Remote Scheduler Service for
scheduled reports
The FMx Reporting Remote Scheduler Service
is used for two purposes. 1. To execute
scheduled reports. 2. To execute reports
remotely, i.e. on a server other than where the
FMx Reporting App is installed.
The following example demonstrates allowing
scheduled reports on the local server.
NOTE: These steps are only needed if you
intend to allow reports to run on a schedule or
want to executes reports on a remote server.
1. Use the FM Support Tool 8.5.x to edit the
settings for the FMx Reporting Remote
Scheduler.
(System Configuration FMx Report
Settings eWebReportsSheduler.xml)
7 Install and Configure the FMx Reporting Components
2. Select the instance used when installing the
FMx Reporting services (default: FMx
Reporting), or browse to the config file and
click “Connect”.
Default C:\Program
Files\FMSystems\FMxReportingRemoteSche
duler\eWebReportsScheduler.xml
3. To deliver scheduled reports via e-mail
complete the following settings:
Smtp Server – Mail relay server
Enable SSL – Is SSL required
Username – User with rights to
send email
Password – Password for user
From Name – Name report e-mails
we be “From”
From E-mail – E-mail address report
e-mails will appear to come from
Error Report to – E-mail address to
send error reports to
4. Configure the following settings which are
used to control what protocol and port the
scheduler service will listen on:
Channel Type: tcp or http (default:
tcp)
Port: any valid, unused port #
(default 2001)
5. Check “Enable Custom Scheduler Queue
Service”
6. Populate the “Custom Scheduler Queue
Service” text box with the URL to the FMx
Reporting Scheduler Queue Web Service.
8 Install and Configure the FMx Reporting Components
7. Use the FM Support Tool 8.5.x to edit
the settings for the FMx Reporting App.
(System Configuration FMx Report
Settings WebReports.xml)
8. Select the instance used when installing
the FMx Reporting services (default:
FMx Reporting), or browse to the config
file and click “Connect”.
Default: C:\inetpub\wwwroot\FMx
Reporting\FMxReportingApp\Config\We
bReports.xml
9. Check the box for:
Show Report Scheduling Option
Show Schedule Reports
Manager
Show Email Report Options
10. Leave “Enable Remote Report
Execution” and “Enable Access to Data
Sources Remotely” unchecked.
11. Leave “Remove Execution Remoting
Host” and “Schedule Remoting Host”
blank.
12. Check “Enable Custom Scheduler Queue
Service”
13. Populate the “Custom Scheduler Queue
Service” text box with the URL to the
FMx Reporting Scheduler Queue Web
Service.
9 Install and Configure the FMx Reporting Components
14. Navigate to the Windows Administrator
Tools
15. Open the Windows Services manager
and set the “FMx Reporting Remote
Scheduler” service “Startup Type:” to
Automatic.
16. Start the “FMx Reporting Remote
Scheduler” service.
10 Install and Configure the FMx Reporting Components
Updating the “web.config” files…
At this time there are two updates to
configuration files not made by the
installer that need to be made manually
for report scheduling or remote report
execution to function.
Setting the connection string for the
scheduler queue web service…
1. Open the FMx Reporting Scheduler
Queue web service config file using
Notepad or another appropriate text
editor:
Default: “C:\inetpub\wwwroot\FMx
Reporting\FMxReportingSchQueueWe
bService\web.config”
2. Update the “CconnectionStrings” key
with the information to connect to the
FM:Interact database:
Data Source: SQL server name
Initial Catalog: FM:Interact
database name
User ID: SQL user name with
access to the FM:Interact
database
Password: Password for the
SQL user
3. Save the file.
11 Install and Configure the FMx Reporting Components
Copy the “BlackoutTimeSecureKey” to the
FM:Interact config file…
1. Open the FMx Reporting Schedule r
Queue web service config file using
Notepad or another appropriate text
editor:
Default: “C:\inetpub\wwwroot\FMx
Reporting\FMxReportingSchQueueWe
bService\web.config”
2. Copy the line… <add
key="BlackoutTimeSecureKey"
value=”…” />
Note the key value is omitted above,
but should be copied.
3. Open the FM:Interact config file using
Notepad or another appropriate text
editor:
Example:
“C:\inetpub\wwwroot\FMInteract
8\FMInteract\web.config”
4. Search for the text “</appSettings>”
5. Paste the copied key
“BlackoutTimeSecureKey” into the
“appSettings” section (just before the
line containing “</appSettings>”.
6. Save the file.
12 Install and Configure the FMx Reporting Components
Configuring the FMx Reporting
Remote Scheduler Service for
remote report execution
To enable the FMx Reporting Remote
Scheduler Service for remote report
execution complete the following:
1. Follow the step listed in the section
above “Install the FMx Reporting
Components” to install the FM:Interact
8.5.x Support Tool and the FMx
Reporting Remote Scheduler Service on
the remote server you wish to execute
reports on.
2. Follow the steps listed in the section
above “Configuring the FMx Reporting
Remote Scheduler Service for scheduled
reports” to configure the Remote
Scheduler Service on the remote host.
In addition, complete the following steps
when configuring the FMx Reporting App in
the Support Tool:
1. Check “Enable Remote Report
Execution” and “Enable Access to
Data Sources Remotely”
2. For both the “Remote Execution
Remoting Host” and the “Schedule
Remoting Host” enter connection
information to the remote service.
Format: protocol://ipaddress:port Example: tcp//127.0.0.1:2001 To enable the scheduler to access multiple machines, comma separate values in these fields. Note: the protocol and port specified above should match the settings used when configuring the Remote Scheduler Service in the Support Tool on the remote server.
13 Install and Configure the FMx Reporting Components
Define FMx Report Settings in
FM:Interact In FM:Interact, there are a few paths that
must be set for the Reporting tool to work.
Note: Permission to the FMx Reporting
setting domain is required in order to
complete this task.
1. Login to FM:Interact as Administrator
2. Navigate to: System
Administration>Modify System
Settings>Configure FM Settings
3. From the FMSetting domain list, select
“FMx Reporting”
4. In the FMx Reporting App File Path field,
enter the file path to the location of the
installed reporting app.
Default: C:\inetpub\wwwroot\FMx
Reporting\FMxReportingApp
Note the following URLs can be found by
browsing to the sites from IIS Manager.
5. Enter the “FMx Report App WebApi
URL”
6. Enter the “FMx Reporting Web URL”
7. Enter the “FMx Report Repository Web
Service URL”
8. Click “Save”