EZ Service Component Installation

This section describes the steps required to install the EZ Service component. The EZ Service component is a separate component from EZ Gateway and requires execution of a separate script to install. EZ Service must be installed on each machine that hosts EZ Config Packages and Packets and/or EZ Config Default Data.

The release media includes a directory containing the files necessary for the EZ Service installation.

Note: Before running the EZ Service install script, you must have Powershell 5 installed on each machine for which you intend to run the scripts. The install script must be run as administrator.
  1. Locate the powershell script Deploy.ps1 on the release media and copy the entire set of contents in the directory to each machine hosting Packages and Packets and/or Default Data.
  2. Before running the script, edit the values of the parameters within the script. Parameters are at the top of the script within a param block. Parameters in bold MUST be edited.
    Parameter Description
    $installDirectory The directory where the program files will be placed by the install script. The default value is "C:\Program Files\WKFS\EzService\Service" which will place the files alongside the other WKFS program files.
    $displayName The name of the service that displays in the services window. The default value is "EzService" but can be changed without affecting the execution of the service.

    However, if changed you must also change the queue name transform property in both Packages and Packets and Default Data, as both applications send messages to the queue where the repost service looks for them.
    $stsHostName This is the fully-qualified hostname of the STS server being used by the applications.

    This parameter value must be edited.
    $stsClientId The id of the client created in STSAdministration for use of the integration APIs.

    No default exists for this value because it differs for each instance of STS.
    $stsClientSecret This is the base64 encoded certificate for the client above that was created in STSAdministration.

    No default exists for this value.
    $stsClientScopes A space-delimited list of the scopes assigned to the client created above. The repost service must have one of the DGS core scopes (likely, the super user scope as there are multiple accounts at play per request) in order to work. If the integration client does not already have that scope, it must be added.
    $sqlServerHostName The hostname of the SQL server hosting the Packages and Packets and Default Data databases.

    This parameter value must be edited.
    $defaultDataDb The name of the Default Data database. The default value is DefaultDataDB and should be changed only if the database has a different name.
    $pkgPktDb The name of the Packages and Packet databases. The default value is PackageAndPacketDb and should be changed only if the database has a different name.
    $integratedSecurity A Boolean indicating if the database connections support integrated security. The default is true (use integrated security).

    Change this value to false if the connection requires a username and password.
    $sqlUserName If using integrated security (as indicated by the Boolean above), enter the username here.

    If not using integrated security, this value does not need to be updated.

    Note: The Username and Password will also be used to connect with the Packages and Packets database.
    $sqlPassword The password for the user in the previous bullet.

    If not using integrated security, this value does not need to be updated.

    Note: The Username and Password will also be used to connect with the Packages and Packets database.
    $rabbitMQHost The hostname of the RabbitMQ server. Leave this value as localhost unless it was changed when RabbitMQ was installed as part of the DGS install.
    $queueName The name of the Rabbit queue used for reposts.

    The default value is reposts and does not need to be changed.

    If changed, you must also change the queue name transform property in both Packages and Packets and Default Data, as both applications send messages to the queue where the repost service is looking for them.
    $expereUrl The URL for the Expere endpoint. The default is http///localhost/8080/Common/WSEndpoint and should only need to be changed if they modified it during the Expere/DGS install.
    $dgsHostName The fully qualified hostname for the servers where DGS Core is installed (or the load balancer).

    This parameter should not include the protocol at the beginning (https).
    $healthCheckUrl
  3. Run the deploy.ps1 script at each location. The script must be run as administrator.
    Note: The install script must be executed at the same directory as all the other files within the script directory.
  4. Executing the script moves the application files to the Install directory and then creates and starts the Windows service that hosts the EZ Service.

To Uninstall or Remove the Service

  • Run the script, but with the "-uninstall" switch added to the end of the command:
    .\deploy.ps1 -uninstall