Skip to main content

Reportilize Installation Guide

Raise a support ticket

DISCLAIMER​

Any advice FYB provide in relation to setting up any FYB App, FYB Add-in, FYB Connector and or advice in relation to opening access to your on-premises or in the cloud systems will be general advice only. This means that the advice is of a general nature and will not consider your network setup, network infrastructure or any security requirements that you may have or in fact need. It is highly advised that you seek advice from internal or external providers to ensure that they are comfortable with what is required prior to going ahead with any deployment, setup, or configuration for external access.

LICENSE DETAILS​

Please contact FYB for a valid license if you are yet to obtain one for your Add-In.

INSTALLATION COMPONENTS​

The following installation components are required to ensure full functionality of the FYB Reportilize:

  • FYB Reportilize Web Application - this is a server-side installation

INSTALLING FYB REPORTILIZE​

LICENSE​

  1. Create a folder to house the license file (.lic) on the IIS Server

  2. Place the license file in this folder

    Note

    You will be asked to enter this location during the installation.

TRUSTED USER ACCOUNT​

Add the account that will run the application pool as a Trusted User Account in Enterprise Studio. Please refer to your Enterprise Studio help file on adding trusted accounts. If using a system account (application pool identity, network service etc) you will be required to enter the details as DOMAIN\Server Name$

If using a dedicated windows service account, you will be required to enter the details as DOMAIN\username.

INSTALLATION​

Warning

Before running the MSI ensure that all prerequisites are complete. Including deploying the .NET 8 SDK and Hosting Bundle.

To deploy the Net Core SDK and Hosting Bundle to the server, follow these steps:

  1. Install the latest .NET 8 SDK (x64) found here

    NET SDK 8.png

  2. Install the latest ASP.NET Core 8 Runtime Hosting Bundle found here

    NET Hosting Bundle 8.png

  3. Once both executables have been installed, complete a full server restart to allow for .NET 8 to bind to IIS. If a server restart is not possible an IIS reset can be completed with the following CMDs from an elevated command prompt.

    • net stop was /y
    • net start w3svc
    • iisreset
    info

    To check to make sure that the SDK has been attached to the hosting bundle, open Command Prompt and type dotnet --info

The FYB Reportilize MSI will:

  • Deploy the installation files.
  • Setup the application pool and application in IIS
  • Setup the temp folder
  • Configure the FYB Reportilize as specified by the user

To install the FYB Reportilize Application, follow these steps:

  1. Run command prompt as an administrator and launch the Reportilize-23x.msi installer

  2. Click on the Next button

    2020-09-23_14-20-55.jpg

  3. On the Web Application Settings screen, select a site to host the application

    Note

    The virtual directory name must remain as Reportilize. It cannot be renamed.

    IIS Directory

    The application must be installed under the dedicated site as an application. It cannot be installed at the site level

    image.png

  4. Click on the Next button

    2021-04-23_8-59-19.jpg  

  5. On the Application Pool Settings screen, enter the domain, username, and password for the application pool identity

    Using Local Accounts

    If there is a requirement to use a local account, leave the domain for the application pool empty.

  6. Click on the Next button

    2020-09-23_14-21-18.jpg

  7. On the Configuration Settings screen, enter the dataset ID, workgroup server, license path, temp folder path and document store name

    Important!

    The workgroup server must always be set to local.

    image.png

    FUNCTIONALITYDESCRIPTION
    Dataset IDThe ID of the Content Manager dataset FYB Reporter will be connected to.
    Workgroup Server NameThe workgroup server name of the Content Manager dataset Reportilize will be connected to.
    Workgroup Server URLThe workgroup server URL of the Content Manager dataset Reportilize will be connected to.
    License PathThe path to a valid license.
    Temp PathThe temp path used for the application. Logs will be stored here.
    Document Store NameThe name of your main document store in Content Manager. For example, Main Document Store
  8. Click on the Next button

  9. If your environment is configured to only allow OpenId authentication (e.g. Azure AD or ADFS) for your Content Manager, you'll receive the following message:

    image.png

  10. Click OK to navigate to the Open Id settings screen and enter the required values.

    image.png

    Note

    Please refer to the below guides on how to configure the Confidential Client App and Trusted User:

    NAMEDESCRIPTION
    Client IdThe Client/App Id of the Open Id application used to secure Content Manager. For ADFS authentication, this will be the username of the Confidential Client app.
    Client SecretThe Client/App Secret of the Open Id application used to secure Content Manager. For ADFS authentication, this will be the password of the Confidential Client app.
    Trusted UserThe Network Login value of the Content Manager Confidential Client app location. For ADFS authentication, this will be the username of the Confidential Client app.
    Note

    A designated CM Location is required to be nominated as the Trusted User. The CM Location will require the following permissions:

    • Record Update Permissions
      • Create Records
      • Modify Records
      • Update Document
      • Modify Record Additional Field Values
    • Miscellaneous
      • Can Save Searches
  11. If you are enabling the Maintenance Dashboards then tick Set Up Maintenance Dashboards and input the maintenance password. If not then leave this un-ticked and proceed with clicking the Next button

    Note

    Only FYB Support members have access to the maintenance dashboards.

    2021-04-19_14-55-16.jpg

  12. On the Report Configuration Settings screen enter the following settings:

    2021-05-14_11-41-26.jpg

    FUNCTIONALITYDESCRIPTION
    Document Store PathThe path to the Content Manager Document Store (Including the dataset ID folder). This path can be a file share path if the Document Store is installed on a different server to Content Manager.
    Soft Deleter Group (URI)The URI of the location Group used to Soft Delete Records. If this is not used, enter 0.
    Legacy Folder (URI)The URI of your legacy folder record type. If this is not used, enter 0
    Server Local Data PathThe path to where Content Manager writes its log files. (Example: C:\Micro Focus Content Manager\ServerLocalData\TRIM\Log).
    Template RecType (URI)The URI of the Record Type that all Reportilize templates will be stored as in Content Manager. (i.e., Document Record Type)
    info

    The Soft Deleter Group and Legacy Folder fields are utilised only as part of the FYB Maintenance. If the maintenance was not set up in the previous window, these values are set to 0.

  13. On the Email Configuration Settings enter the send to, from address, mail host and mail port

    image.png

    FUNCTIONALITYDESCRIPTION
    Event Monitoring ContactsThe email address that receives the email notifications for any event failures that occur within Content Manager such as blockages. To set multiple people as a contact place a ';' between each email address.
    From AddressThe email address that sends the email notifications.
    Mail HostThe mailing host system that sends the email notifications.
    Mail PortThe SMTP mailing protocol port to the Mail Host
    License ContactsThe emails addresses of people to be contacted when the FYB Reporter license is expiring. Multiple email addresses can be used by placing ';' between each email address
    SMTP username (optional)The username used to authenticate with your SMTP server
    SMTP password (optional)The password used to authenticate with your SMTP server
  14. On the Custom Setup screen select the install location

    2020-09-23_14-25-22.jpg

  15. Click on the Next button

  16. From the Confirm Installation window click on the Install button

    2020-09-23_14-25-27.jpg  

  17. The installation will commence

    2020-09-23_14-26-12.jpg

  18. Once the installation is complete click on the Finish button

    2020-09-23_14-26-18.jpg

COMMAND-LINE ARGUMENTS (OPTIONAL)​

The following command-line arguments can be passed to the MSI if required.

ARGUMENTPURPOSE
WEB_APP_POOL_IDENTITY_DOMAINSets the App Pool domain for the application pool
WEB_APP_POOL_IDENTITY_NAMESets the App Pool username for the account running the application pool. Use "" around the username if there are any special characters
WEB_APP_POOL_IDENTITY_PWDSets the App Pool password for the account running the application pool. Use "" around the username if there are any special characters
DBIDSets the Database ID that connects to Content Manager dataset to run the application
WORKGROUP_SERVERSets the Workgroup Server Name that connects to Content Manager dataset to run the application
WORKGROUP_SERVER_URLSets the Workgroup Server URL that connects to Content Manager dataset to run the application
LICENSE_PATHSets the license that connects to the application
TEMP_PATHSets the temp path that connects to the application
DOC_STORESets the document store name from Content Manager
DOCSTOREPATHSets the document store path from Content Manager. This path can be a file share path if the Document Store is installed on a different server to Content Manager.
SOFTDELETESets the URI of the Soft Delete Group location
LEGACYFOLDERSets the URI of the Legacy Folder Record Type
LOCALDATAPATHSets the server local data path
TEMPLATE_URISets URI of the template record type
EVENT_CONTACTSSets the event monitoring contacts
FROM_ADDRESSSets the email address all notification is sent from
MAIL_HOSTSets the mail host for all email notifications
MAIL_PORTSets the mail port
LIC_CONTACTSSets the license expiring contacts

CONFIGURATION​

  1. After the installation process is complete, the following two folders will require modified permissions:

    • C:\Program Files\FYB Pty Ltd\Reportilize\App_Data\
    • C:\Program Files\FYB Pty Ltd\Reportilize\ClientApp\build\Images
  2. Navigate to these two folders and right click > properties > security tab and ensure Users have Read, Write and Modify permissions

    2021-01-18_11-44-33.jpg

  3. In IIS from the Features View go to Authentication and ensure that Windows Authentication is the ONLY authentication type enabled

    image.png 2020-09-09_15-54-17.jpg  

  4. Click on Application Pools

    image.png

  5. Within the application pool listing screen, right click on Reportilize application pool and select Advanced Settings option from the drop-down menu

    2020-09-23_14-34-45.jpg

  6. Within the Advanced Settings window, set the following:

    SETTINGVALUE
    Idle Time-out ActionSuspend
    Idle Time-out Action (Minutes)0
    Start ModeAlways Running

    2021-04-26_11-52-56.jpg

  7. Within the application's basic settings, check the Enable Preload checkbox and click on the OK button

    2021-05-04_13-40-33.jpg

  8. Complete an app pool restart to allow for the changes to initialize

UNINSTALLING FYB REPORTILIZE​

To uninstall FYB Reportilize please follow the steps below:

  1. Navigate to control panel

    image.png

  2. Click on uninstall a program option

    image.png

  3. Locate FYB Reportilize in the list of Programs and feature

  4. Right click on FYB Reportilize and click on the Uninstall button

  5. If a warning Prompt appears, click on the Continue button

  6. The uninstallation process will commence

  7. Open IIS once the uninstallation process is completed

  8. Locate Reportilize in IIS, right click and click on the Remove button

    2021-08-25_15-54-56.jpg