Install and Set up the Requirements

This section provides further details about installing and setting up some specific mandatory system requirements.

Note: To load your 3D documents into the 3D cloud-hosted service, you can ignore the steps in this section relating to 3DVis OnPrem.

User Privileges

• AIM authenticates with your Microsoft Windows logon details.

• You must have administrator privileges and logged in as an administrator, to carry out the installation, deployment and configuration.

Configure IIS and Web Deploy

For details on installing IIS, refer to IIS 10 installation on Windows Server 2019 or Windows Server 2022.

When installing IIS, ensure that the following options are included:

• Security - Windows Authentication

• Application Development - ASP.NET 4.5

You must install Web Deploy using either the Web Deploy installer or the Web Platform Installer. After installing Web Deploy, start Web Deployment Agent Service.

User Authentication in IIS

AIM Dashboard uses Windows Authentication to verify the identity of users. This means that, in IIS, Anonymous Authentication must be disabled and Windows Authentication must be enabled. AIM Dashboard tries to change these settings automatically at the server level using a section in the web.config file (found in the application root directory).

However, by default, web applications are not permitted to alter their authentication mode, and so, accessing the AIM Dashboard in a browser may result in the following error:

This configuration section cannot be used at this path. This happens when the site administrator has locked access to this section using <location allowOverride="false"> from an inherited configuration file.

To prevent this error, perform either of the following two actions:

Change the settings at the server level and allow the AIM Dashboard to alter its authentication mode:

1. Open IIS Manager.

2. Select the server, and then in the Management section, double-click Feature Delegation.

3. Set Anonymous Authentication and Windows Authentication to Read/Write.

Change the settings at the site level:

4. Open IIS Manager.

5. Select the AIM Dashboard application, then in the IIS section, double-click Authentication.

6. Set Anonymous Authentication to Disabled.

7. Set Windows Authentication to Enabled.

8. Open the web.config file and remove the following section:

   <authentication>

   <anonymousAuthentication enabled="false" />

   <windowsAuthentication enabled="true" />

   </authentication>

Install Accusoft PrizmDoc Server and Client

The PrizmDoc Server is a collection of services that helps in conversion of documents from source file to SVG or raster, depending on the source document content, for display in the Viewing Client. The conversion of documents into a common format is the key to viewing many different file types in a single viewer. Content Conversion Services RESTful API enables conversion of content from all supported formats into PDF or TIFF output. Content Conversion Services also enable you to combine documents (or pages within documents) from disparate formats into a new document.

PrizmDoc Application Service (PrizmDoc Client) provides to the viewer application-level logic, such as, enabling document viewing through the PrizmDoc Server, saving and loading of markup, handling opening of documents and creating viewing sessions. This service works as a gateway between the Viewing Client and the PrizmDoc Server.

Notes:

• It is recommended that Microsoft Office Professional Plus 2024 is installed on the Accusoft PrizmDoc Server along with an MSO licence. This results in a more native rendering of Office documents by PrizmDoc and avoids certain formatting issues. To apply the MSO licence, run as administrator the command AVEVA.AIM.Accusoft.Licence.exe MSO at a command prompt. The file AVEVA.AIM.Accusoft.Licence.exe can be found in the zip file for the release in the folder: .\AVEVA AIM Workhub and Dashboard 6.0\Accusoft PrizmDoc 14.4

• If the MSO license has been applied but Office is not going to be installed, then Office documents will not display, so please revert the license back to using the LibreOffice renderer. To apply the LibreOffice licence, run as administrator the command AVEVA.AIM.Accusoft.Licence.exe at a command prompt. The file AVEVA.AIM.Accusoft.Licence.exe can be found in the zip file for the release in the folder: .\AVEVA AIM Workhub and Dashboard 6.0\Accusoft PrizmDoc 14.4

• The Prizm and PrizmDoc Application Watchdog Windows Services are registered during the installation. Both of them are installed with a default configuration and require further steps to ensure that the server is secured.

To install Accusoft PrizmDoc Server and Client:

9. Run the Server installer, provide a logon for the service.

10. Close the licensing tool when it opens.

11. Run the AVEVA Licensing tool, and then start the Prizm Service.

12. Run the Client installer, and provide a logon for the service.

Notes: Re-register is not required. For more information about PrizmDoc Server and PrizmDoc Client, see https://help.accusoft.com/PrizmDoc/v14.4/HTML/prizmdoc-server-sizing-servers.html.

Configuring Windows Authentication

IIS must be configured as a reverse proxy to enforce Windows authentication for the communication channel between the AIM Dashboard web server and the Accusoft PrizmDoc Server and Client. Configuring Windows authentication for Accusoft PrizmDoc is not required if one of the following is true:

• Accusoft PrizmDoc is installed on a separate server, and a firewall has been configured to prevent external access to server and ports.

• Accusoft PrizmDoc is installed on the same server as AIM, and external access to any other ports has been blocked.

Contact your IT administrator regarding the necessary steps required to configure a firewall to secure the PrizmDoc Server and Client. For more information about security, see https://help.accusoft.com/PrizmDoc/v14.4/HTML/prizmdoc-server-sizing-servers.html.

Note: Usually, the PrizmDoc Services should not be exposed publicly, and the web tier (Dashboard) alone should communicate directly with PrizmDoc.

Important: If the Accusoft client viewer is not deployed, the parameter PrizmApplicationServicesPort can be configured during deployment of the AIM Dashboard. For details, see Installing your own Configurations.

To enable Windows authentication:

13. From the Start menu, click Administrative Tools, and then select Internet Information Services (IIS) Manager.

14. In the Connections pane, expand the server node, right-select Sites, and then select AddWebsite.

15. In the Site name field, type PrizmDoc Proxy.

16. For Physical path, type C:\inetpub\wwwroot\PrizmDocProxy.

17. For Port, type 23000, and then select OK.

18. Select the newly created website (that is, PrizmDoc Proxy) and double-click the URL Rewrite icon under the IIS section.

19. From the Actions panel, select Add Rule(s)....

20. Under Inbound and Outbound Rules, double-click Reverse Proxy.

    Note: If prompted to enable proxy functionality in ARR, click OK.

21. For Inbound Rules, type localhost:3000 [this is the server entry point (SEP)], and then select OK.

22. In the right pane, under the IIS section, double-click Authentication.

23. In the Authentication pane:

    1. Right-click Anonymous Authentication, and then select Disable.

    2. Right-click Windows Authentication, and then select Enable.

24. Navigate to the AIM Dashboard website directory.

    For example: C:\inetpub\Dashboard

25. In the pcc.config file, look for the XML element, <PrizmApplicationServicesPort>.

26. Replace the port number 3000 with the new port number 23000.

27. To reset IIS, select Start, and then run IISRESET.

    Note: If you see the following screen after opening a document in AIM, that indicates the above settings are not supported. You must disable Windows Authentication and enable Anonymous Authentication to make it work with PrizmDocProxy site.

    

    The Browser Console may display errors like the following:

    

Prizm and PrizmDoc Application Watchdog Service (Optional)

The Prizm and PrizmDoc Application Watchdog service is a Node.js application that manages and monitors the Prizm Platform Services. The platform services consist of a variety of services, including document conversion, viewing, redactions and text.

During installation of Accusoft PrizmDoc, one of the steps is to provide an account that is used to run the PrizmDoc Application Watchdog Service. By default, Account Name is populated with name of the user running the installation. A user account must be specified from the local system or domain under which the service should run and the account must be given the "log on as a service" permission.

To configure the user account after installation:

28. In Windows, select Start, Administrative Tools, Services.

29. In the Services window, highlight the Prizm Service and the Prizm Application Services.

30. Right-click and select Properties.

31. Select the Log On tab.

32. Enter the credentials of the user account.

33. Select Apply.

    The user is prompted to restart the service for the changes to take effect.

34. Select OK to close the prompt.

35. Select OK to close the Prizm Service and the Prizm Application Services Properties window.

36. With the service still highlighted in the Services window, right-click and select Restart.

Viewing Session Timeout

The viewing session times out after 20 minutes (default).

To keep the session alive, your browser must request the server for information, such as, page navigation, thumbnails and download functionality. If the session times out while you are viewing a file, you must close the tab and reopen the file.

To adjust the viewing session timeout, refer to the Configuring Accusoft PrizmDoc Timeout Settings (Optional) section in Configure Accusoft Rasterization.

Configuring Accusoft Predefined Search

A predefined search enables you to define a set of predefined search terms. These predefined search terms appear in the search UI as search patterns. For example, you can configure email as a search term, enabling the user to search for any email address in the document. To configure predefined search, you must modify the Accusoft JavaScript source files. For more information, refer to https://help.accusoft.com/PrizmDoc/v14.4/HTML/prizmdoc-server-sizing-servers.html.

Important: Configuration of predefined search requires modification of certain Accusoft Client source files. Therefore, Accusoft Client viewer must be deployed.

To configure Accusoft predefined search:

37. Go to the default location for Accusoft Client JavaScript files:

    C:\inetpub\Dashboard\App\custom\Accusoft\src

38. Open the AccusoftConfig.js file.

39. Modify the "_config" variable, by adding the predfinedSearchTerm section:

    

    In this example, Email is added as a search term, using a custom regular expression. When the search pattern is selected in the user interface, it will highlight all instances matching the regular expression, for example, firstname@companyname.com.

40. Save the file.

41. Open the AccusoftViewer.js file.

42. Add the predefined search option as a property to the "pluginOptions" for the viewer:

    predefinedSearch: AccusoftViewerConfig.searchTerms,

    uiElements: {

      fullScreenOnInit: false,

    In this example, the predefined search option is added above the "uiElements" property.

43. Save the changes.

Accuosft Configuration for Long file names

After deploying Accusoft, you must perform the following steps:

44. Stop the two services: Prizm and Prizm Application Services.

45. Go to the Prizm Installation path, which is C:\Prizm\PCCIS\ServiceHost\.

46. Open the host.config file.

47. Update "maxUrlLength" to 1024 and save the file.

48. Restart the two services: Prizm and Prizm Application Services.

Installing SQL Server

To install SQL Server, use the information given in the following link:

https://learn.microsoft.com/en-us/sql/database-engine/install-windows/install-sql-server?redirectedfrom=MSDN&view=sql-server-ver16

Notes:

• The versions of the Workhub SQL database and the Reporting SQL database must be the same.

• During installation, the Full-Text Search feature must be selected in the Feature Selection window.

Collations

Collations in SQL Server provide sorting rules, case and accent sensitivity properties for your data. Collations that are used with character data types, such as char and varchar, dictate the code page and corresponding characters that can be represented for that data type.

Whether you're installing a new instance of SQL Server, restoring a database backup, or connecting server to client databases, it's important to understand the locale requirements, sorting order, and case and accent sensitivity of the data that you're working with.

SQL Server supports the following collation sets:

Windows collations

• Windows collations define rules for storing character data that's based on an associated Windows system locale.

SQL Server collations

• SQL Server collations (SQL_*) provide sort order compatibility with earlier versions of SQL Server. 

• During SQL Server setup, the default installation collation setting is determined by the operating system (OS) locale. You can change the server-level collation either during setup or by changing the OS locale before installation. For backward compatibility reasons, the default collation is set to the oldest available version that's associated with each specific locale. 

• For example, for the OS locale "English (United States)", the default collation during setup is SQL_Latin1_General_CP1_CI_AS, and it can be changed to its closest Windows collation counterpart, Latin1_General_100_CI_AS_SC.

• When you upgrade an English language instance of SQL Server, you can specify SQL Server collations (SQL_*) for compatibility with existing instances of SQL Server. Because the default collation for an instance of SQL Server is defined during setup, make sure that you specify the collation settings carefully.

• While installing a new instance of SQL Server, restoring a database backup, or connecting server to client databases make sure you don’t accidently change the collation, or if you are changing the collation you know which collation you are using.

• The goal is to keep SQL Server instance collation and database collation the same.

  Note: You may see a SQL Server collation error when upgrading the database using the Database Manager, this may happen when the SQL Server collation and the database collation are different. So when populating the new context table it fails due to a mismatch in the temporary database. If this occurs, perform the following steps:

  49. Navigate to Programmability\Stored Procedures in the database and modify trigger_context_tree.

  50. Include collation in full_name column of the temp table (#temp_vnet_context_full_names) as follows (where COLLATE SQL_Latin1_General_CP1_CI_AS is the collation of the database):

      CREATE TABLE #temp_vnet_context_full_names (

      full_name nvarchar(450) COLLATE SQL_Latin1_General_CP1_CI_AS primary key

      );

  51. Execute the stored procedure trigger_context_tree.

Creating a SQL Server Database

Before installing AIM, you must have an empty SQL Server Database and a suitable user. If you require SQL Authentication, then you must enable "mixed-mode authentication".

Note: Before starting the following instructions, log on to your Database Server machine and open SQL Server Management Studio.

To create a new SQL Server database:

52. In Object Explorer, expand an instance of the SQL Server Database Engine.

53. Right-click Databases, and then select New Database…

54. In the New Database window, type WORKHUB01 or another suitable Database Name.

55. Select an Owner if you do not want to use the default.

56. For the primary data file WORKHUB01, increase the Initial Size (MB) value to 10.

57. Under the Options page, ensure the Recovery Model is set to Full. Other models are not supported.

58. Select OK.

    Note: Make sure to note down the database name, as you need to use the same name later.

    The new database is created.

Creating a New User Using SQL Authentication

Note: To create a new database or upgrade an existing database, the SQL Server user requires db_owner privilege. This can be removed after the creation or upgrade activity is completed. For security reasons, it is recommended to configure the SQL Server user to run with a lesser level of privilege during normal operations.

To create a new user using SQL Authentication:

59. In Object Explorer, expand the Security folder.

60. Right-click Logins, then select New Login…

61. On the General page of the Login - New window, type WORKHUB01_User or another suitable User Name.

62. Select SQL Server authentication.

63. Type a password in the Password and Confirm Password boxes.

64. Clear the Enforce password policy check box (or use a strong password).

65. For Default database, select WORKHUB01 (or the name you entered while creating this database).

66. On the User Mapping page, for Users mapped to this login, select WORKHUB01.

67. For Database role membership for WORKHUB01, select db_owner.

68. Select OK.

    The authorized user is created.

Creating a New User Using Windows Authentication

To create a new user using Windows Authentication:

69. In Object Explorer, expand the Security folder.

70. Right-click Logins, and then select New Login.

71. In the General page of the Login – New window, enter the name of the Windows account or user search.

72. Select the Windows Authentication check box.

73. For the Default Database, select WORKHUB01 (or the name you entered while creating this database).

74. In the User Mapping page, for users mapped to this login, select WORKHUB01.

75. For Database role membership for WORKHUB01, select db_owner.

76. Select OK.

Set Licensing Server

77. Run the AVEVA Licensing (ALS Licensing) Client Configuration Tool.

78. To run the Configuration Tool when the UAC is on, you must right-click and select Run as Administrator.

79. You may need to restart IIS Manager to pick up the updated environment variable.