Configure the Deployer

Use the AVEVA Application deployment tool to configure the deployment parameters.

There are three sets of parameters:

• Host Parameters: Common between both AVEVA NET Gatekeeper and AVEVA Change Manager (and EDW Pre-Processor, if installed), including installation paths to the shared components.

• Application Parameters: Specific to the application being installed.

• EDW Pre-Processor Parameters: Specific to EDW Pre-Processor, if installed.

  Notes:

  - The following configuration files pre-filled with best practice values will be delivered with the installer. These configuration files should be updated with the correct server names and other implementation specific details:

  - ChangeManager.Parameters.xml

  - Gatekeeper.Parameters.xml

  - Host.Parameters.xml

  - The AVEVA Application deployment tool uses three blank parameter XML files (one for each set of parameters) for a new configuration - these contain all the required parameters with blank values.

  - The three sets of parameters must be configured before deployment can start.

To configure the parameters:

1. Open the AVEVA Application deployment tool, double-click Deployer.exe, which can be found in the installation folder.

2. Complete one of the following steps:

   • To create a new configuration, click New.

   • To edit an existing configuration, click Edit.

3. Select a parameter, and then click Edit Value.

4. Change the Value, see Configure the Deployer, Configure the Deployer or Change EDW Pre-Processor Feature Installation.

5. Click OK.

6. On the File menu, click Save.

7. If prompted, select a location, enter a File name, and then click Save.

   Note: Do not overwrite either of the blank parameter XML files.

Encrypting Parameters

Parameter values can be encrypted if required.

To encrypt the parameter values:

8. In Application Deployment Tool, go to the username field.

9. Click Edit Value and ensure that the Can be encrypted check box is selected for the Name field.

10. In the Value field, enter a value that you wish to encrypt.

11. Select the Encrypt value check box.

12. Repeat steps 2 to 5 to create and encrypt the value for the password.

The parameter values are encrypted.

Additionally, the Can be encrypted option is disabled for all parameters by default. This is to prevent accidental encrypting of parameters that would cause the deployment to fail.

To enable the Can be encrypted option for a parameter:

13. If open, close the Edit Parameter Value window.

14. Select the parameter, and then click Edit Definition.

Configure the Host Parameters

Paths to the extracted installer files:

Application Details

Active Directory Details

Enterprise Integration Adapter (EIA)

Notes:

• If the avevaEiaNetworkCredentialsPassword field is blank, provide password in this field.

• If the Class Library versions in AVEVA NET Gatekeeper or AVEVA Change Manager and AVEVA NET Workhub and Dashboard are different, data synchronisation may fail. To correctly synchronise the data, change the version number to match in either AVEVA NET Workhub and Dashboard or NET Gatekeeper and AVEVA Change Manager. To correct the version in AVEVA NET Workhub and Dashboard, access the corresponding Class Library file in the following folder: C:\Program Files\AVEVA\AVEVA NET\Import\Server\Bootstrap. Alternatively, to change the version in AVEVA NET Gatekeeper or AVEVA Change Manager, access the corresponding Class Library file in the following folder: C:\WDA.Applications\TechInfo Manager\<VersionNumber>\<Gatekeeper or Change Manager>\Customer\Website\Class Library\Definitions.

• For information on configuring the EIA services, and integrating them with AVEVA NET Gatekeeper and AVEVA Change Manager, refer to the AVEVA NET Workhub and Dashboard Installation Guide.

  AVEVA NET Dashboard and Workhub Details

  Parameter Name	Example value
  avevaPortalUrl	http://myportalserver/
  avevaPortalId	MyPortalInstance

  Document Management System Details

  Parameter Name	Example value
  dmsBasePath	C:\DocumentManager
  bulkUploadHistoricalPath	C:\DocumentManager\BulkUpload\Historical
  bulkUploadPath	C:\DocumentManager\BulkUpload\Queue
  emailFromAddress	myInstallation@myDomain.com
  eventLogSource	TechInfo Manager
  fileLocationStorageBase	C:\WDA.Applications\TechInfo Manager \FileStore
  fileLocationStorageUrlAveva
  fileLocationStorageUrlBase	http://myServer/TIM.Document.FileStore
  fileLocationStorageUrlDMS	http://myServer/DocumentManager
  outboundEventConsumer
  predefinedTekNumberBaseUrl
  smtpServer	smtp.myDomain.com
  smtpPort	25
  enableSSL	false
  smtpNetworkCredentialsDomain	myDomain.com
  smtpNetworkCredentialsUserName
  smtpNetworkCredentialsPassword
  temporaryAttachmentFolder	Put the temporary files for email attachment. If not specified, or empty, the Environment Variable "TEMP" will be used. Note: It is required that the executing user (usually, NT AUTHORITY\NETWORK SERVICE) has full rights to this folder.
  The following values should be left empty: WDA.DataUpdateProviders.SMTP.Port WDA.DataUpdateProviders.SMTP.EnableSSL WDA.DataUpdateProviders.SMTP.NetworkCredentials.Domain WDA.DataUpdateProviders.SMTP.NetworkCredentials.UserName WDA.DataUpdateProviders.SMTP.NetworkCredentials.Password	For example: <Service name="Email.Update"> ... <Property name="WDA.DataUpdateProviders.SMTP.Port" value="" /> <Property name="WDA.DataUpdateProviders.SMTP.EnableSSL" value="false"/> <Property name="WDA.DataUpdateProviders.SMTP.NetworkCredentials.Domain" value=""/> <Property name="WDA.DataUpdateProviders.SMTP.NetworkCredentials.UserName" value=""/> <Property name="WDA.DataUpdateProviders.SMTP.NetworkCredentials.Password" value=""/> ... </Service>

  Notes:

  - The folder for fileLocationStorageBase must exist before installing (C:\WDA.Applications\TechInfo Manager\FileStore).

  - The default location for the drop folder is C:\DocumentManager.TIM\Export.

  System Application Details

  Parameter Name	Example value	Notes
  systemApplicationConfigPath	C:\WDA.Applications\SystemApplicationConfig	Directory where the WDA System Application configuration will be placed.
  eventSourceReceiver	adminUser@myDomain.com	The admin user who will receive event log emails.
  systemApplicationUserName	user ID
  systemApplicationPassword	password
  systemApplicationNetworkUserName	user ID
  systemApplicationNetworkPassword	password
  systemApplicationNetworkDomain
  systemApplicationReceiver	adminUser@myDomain.com
  systemApplicationSender	myInstallation@myDomain.com

  Naming-and-Numbering Database Connection Parameters

  Parameter Name	Example value	Notes
  nanDatabaseDataSource	myDatabaseServer	Database source (server) containing the Naming-and-Numbering database.
  nanDatabaseInitialCatalog	NandN	Name of the Naming-and-Numbering database to be used by AVEVA NET Gatekeeper or AVEVA Change Manager.
  nanDatabaseUserID	nanDBUserID	User name to use to connect to the Naming-and-Numbering database. For details, see Create a SQL Server Database and Login.
  nanDatabasePassword	nanDBUserPassword	Password to use to connect to the Naming-and-Numbering database. For details, see Create a SQL Server Database and Login.

Configure the Application Parameters

For AVEVA NET Gatekeeper

For AVEVA Change Manager

Creating Separate Websites on the Same Web Server

In environments that run both AVEVA NET Gatekeeper and AVEVA Change Manager, you can optionally create and host separate websites for the applications on the same web server. As part of the prerequisites, enable IIS on the server and HTTP Redirect.

To create separate websites on the same web server:

15. Access Internet Information Services (IIS) Manager in Control Panel, and navigate to Sites.

16. Right-click Sites, and select Add Web Site.

17. Enter the site name, physical path (for example, C:\inetpub\wwwroot\<Application>\), and port in the respective fields.

18. To create a separate website for each of the applications, repeat Step 2.

19. To add an application to the App virtual directory, right-click on the site and select Add Virtual Directory. In the Physical path field, browse for the application's physical path. For example, C:\WDA.Applications\TechInfo Manager\5.0.11\ChangeManager\Customer\Website. In the Alias field, provide an intuitive name for the application. Repeat this step for all added sites. Right-click App, and select Convert to Application.

Now, you can browse the website. The URL may look like http://<hostname>:<port>/<Virtual directory alias>.

To automatically append the virtual directory name at the end of the website URL, refer to the following information. This enables you to access the website using only http://<hostname>:<port>:

20. Create a configuration file named web.config under the website physical path.

21. Add the following configuration setting to the file under <system.webserver>:

    <?xml version="1.0" encoding="UTF-8"?>

    <configuration>

    <system.webServer>

    <httpRedirect enabled="true" destination="">

    <add wildcard="/" destination="/App/Tim.aspx" />

    </httpRedirect>

    </system.webServer>

    </configuration>

Configure EDW Pre-Processor Parameters

For Configuring EDW Pre-Processor

Creating EDW Pre-Processor Data Sources

The view of the EDW Pre-Processor Parameter Window differs from the view of the other Windows as it provides extra functionality to support creation of EDW Pre-Processor Data Sources (the tables intended for storing customer specific data in an applicable for further import to AVEVA NET Gatekeeper and AVEVA Change Manager format). Only the Window is available if the feature EDW Pre-Processor Database is installed because the EDW Pre-Processor Database creation SQL script is used as the source of the Window.

To configure EDW Pre-Processor Data Sources:

22. Double-click Deployer.exe from the installation folder.

23. Do one of the following:

    1. To create a configuration, click New, then click Add.

    2. rtyu765tesdtu7t6y5etrdgfdhrftyjmo8uvraTo modify an existing configuration, click Edit, then in the data source click Edit Value.

24. Provide a name for the data source.

25. Select the concept, either FUNCTIONAL or DOCUMENT.

    Specify the attributes of the data source. Some mandatory attributes, such as Facility, TagNumber or DocNumber may already be provided by the application.
    

26. Click OK.

27. To include the Data Sources specified into the EDW Pre-Processor Database creation script, click Update Script.

28. Optionally, click Open Script to open the updated script.

29. Click File, then click Save.

To remove all the Data Sources from the script, remove them from the parameter file and update the script.