Skip to main content

PRONI Exporter 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 have yet to obtain one for your Add-In.

INSTALLATION COMPONENTS​

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

  • FYB Proni Exporter web application, this is a server-side installation.

INSTALLING FYB PRONI EXPORTER​

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 6 SDK and Hosting Bundle.

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

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

    2023-06-06_15-09-43.png

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

    2023-06-06_15-11-14.png

  3. Once both executables have been installed, complete a full server restart to allow for .NET 6 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
    Note

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

    2022-06-03_17-02-10.png

The FYB PRONI Exporter MSI will:

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

Installation can be completed by running the MSI or using the command line arguments to prefill most data. To install the FYB PRONI Exporter application, follow these steps:

  1. Run command prompt as an administrator and launch the proniexporter-xxx.msi installer

  2. Click on the Next button

    2022-05-02_11-52-44.png

  3. On the Web Application Settings screen select the site to host the application. Click Next

    2022-05-02_11-53-07.png

    Note

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

  4. On the Application Pool Settings screen, enter the domain, username, and password for the Application Pool identity. Click Next

    2022-05-02_11-53-59.png

  5. On the Configuration Settings screen enter the required information. Further details are in the table below. Click Next

    2022-05-05_10-03-31.png

    FIELDDESCRIPTION
    Dataset IDContent Manager two-character dataset identifier
    Workgroup ServerContent Manager workgroup server name. This should generally be set to local
    License PathLocal path to the PRONI Exporter license file
    Temp PathLocal temporary directory used by the application to cache documents
    Export PathThe path that records will be exported to. This should be a network share path.
    PRONI Group URIThe URI of the CM location group for PRONI users. Only members of this group will be able to use the application. See the CONTENT MANAGER ADDITIONAL FIELDS section for further details.
    Export Reference URIThe URI of the additional field used to store the folder path of a container after it has been exported. See the CONTENT MANAGER ADDITIONAL FIELDS section for further details.
  6. On the Email Configuration screen input the relevant email server details. Click Next

    2022-05-02_11-57-15.png

    FIELDDESCRIPTION
    License ContactRecipient of the license expiry notification.
    From AddressAddress that any emails will be sent from (e.g. donotreply@domain.com
    Mail HostSMTP email server address (e.g. domain.mail.protection.outlook.com)
    Mail PortSMTP email server port (e.g. 25)
  7. Confirm the install location and click on the Next button

    2022-05-02_11-58-03.png

  8. Click on the Install button

    2022-05-02_11-58-55.png

  9. Once the installation is complete click Finish

    2022-05-02_11-59-53.png

COMMAND-LINE ARGUMENTS​

Note

Use "" around values that contain special characters (non-alphanumeric characters)

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
WEB_APP_POOL_IDENTITY_PWDSets the App Pool password for the account running the application pool
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
LICENSE_PATHSets the license for the application
TEMP_PATHSets the temp path that connects to the application

CONFIGURATION​

IIS CONFIGURATION​

  1. After the installation process is complete, you will be able to locate the application installed within the site selected during the installation

  2. From the Features View double click on Authentication and ensure that only Windows Authentication is enabled

    2021-08-02_17-05-40.png

  3. Right-click the application in IIS and select explore

    app.jpg

  4. Right-click the app data folder and select properties

    prop.jpg

  5. Navigate to the security tab and ensure users have read, write and modify permissions

    permiss.jpg

CONTENT MANAGER ADDITIONAL FIELDS​

The following additional fields are required on all record types used with PRONI Exporter.

NameSearch ClauseData FormatDescriptionRecord Types
Access DecisionAccessDecisionStringDetermines whether or not the Access decision permits the digital object to be viewed by the publicContainer
Closure Reason including PITClosureReasonIncludingPITTextFree text field describing reasons for decisions to closeContainer
Date ApprovedDateApprovedDateTimeDate approved by Departmental Information ManagerContainer
Date ReviewedDateReviewedDateTimeDate file was reviewedContainer
Departmental Information ManagerDepartmentalInformationManagerLocationName of Departmental Information Manager approving decisionContainer
Exported To ProniExportedToProniBooleanUsed to identify which Records have already been exported to the serverContainer and Document
PRONI Export RefPRONIExportRefStringUsed to identify the location the records were exported to on the serverContainer and Document
Next ActionNextActionStringNext Action for record, either Open or ReviewContainer
Next Action DateNextActionDateDateTimeThe date on which the next action on the record will occurContainer and Document
Branch ReviewerBranchReviewerLocationName of person that reviewed fileContainer
s.23 Security matters (PIT)S23SecurityMattersPITBooleanContainer
s.24 National Security (PIT)S24NationalSecurityPITBooleanContainer
s.26 DefenceS26DefenceBooleanContainer
s.27 International Relations (PIT)S27InternationalRelationsPITBooleanContainer
s.29 The Economy (PIT)S29TheEconomyPITBooleanContainer
s.30(2) Investigations (Confidential Sources)(PIT)S302InvestigationsConfidentialSourcesPITBooleanContainer
s.31 Law Enforcement (PIT)S31LawEnforcementPITBooleanContainer
s.34 Parliamentary PrivilegeS34ParliamentaryPrivilegeBooleanContainer
s.36 Conduct Of Public Affairs (PIT)S36ConductOfPublicAffairsPITBooleanContainer
s.37 Royal Family And HonoursS37RoyalFamilyAndHonoursBooleanContainer
s.38 Health And Safety (PIT)S38HealthAndSafetyPITBooleanContainer
s.39 Environmental InformationS39EnvironmentalInformationBooleanContainer
s.40 Data ProtectionS40DataProtectionBooleanContainer
s.41 Info Provided In ConfidenceS41InfoProvidedInConfidenceBooleanContainer
s.43 Commercial Interests (PIT)S43CommercialInterestsPITBooleanContainer
s.44 Prohibition On DisclosureS44ProhibitionOnDisclosureBooleanContainer

Once the application has been installed an external link will need to be registered in Content Manager.

  1. Open Content Manager and click on Tools > Administration > External Links

  2. Right-click and select New External Link

  3. From the external link type list, select External executable, click OK

  4. Enter the Link Name as FYB PRONI Exporter

  5. Under Folder or Subfolder input the location of your default internet browser (e.g. Chrome would be google\chrome\application)

  6. Under Executable File Name browse to and select the Chrome.exe (different exe if a different browser is chosen)

  7. Check Link supports tagged processing

  8. Under Command line parameters when doing tagged processing enter PRONI Exporters's URL followed by /exportview?uris=^!Urilist^. For example, https://domain-name/proniexporter/exportview?uris=^!Urilist^

  9. Check Use tagged command line format for single selection

  10. The completed setup should look like the below

    2022-05-02_13-23-42.png

  11. On the Usage (Record) tab, tag each of the appropriate record types

    external2.jpg

  12. Click on the OK button

Note

Note that the external link for Content Manager v9.4 and below requires an additional PRONI Launcher tool to be deployed to the server.

  1. Create an FYB Add-ins folder on the appropriate server that the PRONI Exporter tool has been installed on. For Example: ‘D:\FYB Addins\

  2. Right-click on the FYB Addins folder > Properties > click on the Sharing tab

  3. If the Network Path is set to ‘Not Shared’

    image.png

  4. Click on the Advanced Sharing button

    image.png

  5. In the Advanced Sharing window, tick ‘Share this folder’ and remove the space between FYB and Addins, then add a ‘$’ sign which will keep the folder hidden

    image.png

  6. Click on the Permissions button

  7. Give ‘Everyone’ the ‘Read’ permission

    image.png

  8. A Network Path will now be available (this path is needed during the settings setup)

  9. Right-click the FYB Add-ins folder and select Security > Users > Edit and ensure the Write permission is enabled

    image.png

  10. Obtain a copy of the PELauncher zip files

    2022-05-02_13-26-03.png

  11. Create a folder within the FYB AddIns folder called PELauncher

  12. Paste the files extracted from the PELauncher.zip into this folder

    2022-05-02_13-27-48.png

  13. Open the PELauncher.exe.config file in the text editor of your choice and update the URL value with the PRONI Exporter URL (e.g. https://example.com.au/proniexporter/), ensure to include the trailing slash ('/')

    2022-05-02_13-29-33.png

  14. In Content Manager click on Tools > Administration > External Links

    image.png

  15. Right Click and select New executable

    image.png

  16. Enter the Link Name as PELauncher

    2022-05-02_13-31-00.png

  17. Under ‘Folder or Subfolder’, enter the Network Location of the FYB Addins\PELauncher\ folder created earlier in this guide

    2022-05-02_13-31-54.png

  18. Under Executable File Name browse to the FYB PELauncher folder and select PELauncher.exe

  19. Tick Link supports tagged processing. The completed setup should look like the below

pelauncher.jpg

  1. Click OK

  2. Right click on the FYB PELauncher external link > Properties

    2022-02-17_16-32-54.png  

  3. Click the “Used By” tab.

    2022-02-17_16-35-13.png

  4. Select all the appropriate record types. For each selected record type, enter the parameter field %URI%.

    2022-02-17_16-36-29.png

  5. Click OK

  6. The external link will now be accessible via the right click menu

UNINSTALLING PRONI EXPORTER​

To uninstall the PRONI Exporter manually please follow the steps below:

  1. Navigate to control panel

    image.png

  2. Click on uninstall a program

    image.png

  3. Locate PRONI Exporter in the list of Programs and feature

    control panel.jpg

  4. Right click on PRONI Exporter and click on Uninstall

    uninstall.jpg

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

    image.png

  6. The uninstallation process will commence

    image.png

  7. Open IIS once the uninstallation process is completed

  8. Locate PRONI Exporter in IIS, right click and press the Remove button

    iis remove.jpg

  9. Navigate to Content Manager > External Links under the Administration tab

  10. Right click PRONI Exporter and select Delete

    cm delete.jpg