Configure the Remote Publish Engine

The Remote Publish Engine is a 32-bit Windows service that can process remote jobs that are submitted through Datamaker, Test Data On Demand, and other TDoD service clients like ard. The Remote Publish Engine installation supports 64-bit OS versions of Windows (7 Professional, 8 Professional, 2008 R2 and 2012).
tdm49
The Remote Publish Engine is a 32-bit Windows service that can process remote jobs that are submitted through Datamaker, Test Data On Demand, and other TDoD service clients like
CA Agile Requirements Designer
. The Remote Publish Engine installation supports 64-bit OS versions of Windows (7 Professional, 8 Professional, 2008 R2 and 2012).
If you kick off a publish from Datamaker without a setting of immediate or kick off publish activities from other tools, the Remote Publish Engine executes the jobs. Jobs are picked up in such a manner that their
authorization
status and their
dependency on other jobs
is respected.
Introduction
Currently, the Remote Publish Engine supports processing the following job types:
  • PUBLISH (Regular and Subset)
  • TESTMATCH
  • ALM job types
  • Group jobs which can be a combination of PUBLISH, TESTMATCH, and ALM job types
Each type of job has its own executor. For example, Datamaker executes PUBLISH jobs, and Test Matching executes TESTMATCH jobs. When a job completes or triggers errors, a notification email containing a zip file is sent to the user who submitted the job. The zip file contains the job xml, logs and job output files.                                           
Configure the Remote Publish Engine
The Remote Publish Engine ships with a configuration editor where you configure all required settings.
The Remote Publish Engine Windows Service must be configured to run under a real user account instead of a local system account. For Windows, to configure the Remote Publish Engine to run under a real user account, navigate to
Control Panel
,
Administrative Tools
,
Services
,
CA Remote Publish
,
Properties
,
Log On
. Specify a user account and password and restart the service.
Follow these steps:
  1. Launch the Configuration Editor from C:\Grid-Tools\RemotePublish\RemotePublish_ConfigEditor\RemotePublishConfiguration.exe.
    If not populated by default, use the
    Browse
    button in the Configuration Editor to open the remote engine configuration file at C:\Grid-Tools\RemotePublish\DMBatch.exe.config.
    image2016-3-18 18:38:57.png
  2. Populate the settings in the Configure tab as follows:
    • Datamaker Directory
      This setting stores the path of the Datamaker directory. If the path listed is incorrect, click the
      Browse
      button to navigate and store the correct path.
    • Email Protocol
      A list of email protocols that can be used for the mailing of notifications. The selection determines if there will be a tab after
      Job Executor
      labeled
      SMTP Settings
      or
      Exchange Settings
      .
    • Email Support Enabled
      This setting enables email notifications when checked. If not, email notifications are stored at C:Grid-Tools\RemotePublish\emails.
    • Group Email Address
      This is an email address that also receives email notifications in addition to the email address supplied for the published jobs. Also, for awareness, notifications are sent to this email address when the CA Remote Publish service has been started or stopped.
    • Thread Name
      The thread name is used as an identifier by the engine. Thread name can be a comma (,) separated list, The Remote Publish Engine launches one executor per thread name and all jobs having the same thread name are executed by executor for that thread. Jobs with thread name
      ANY
      are picked by any executor.
    • AD Domain
      This field is populated with the Active Directory name, only, when the Datamaker license was issued for an Active Directory.
    • Job Check Frequency
      Enter a value in this field to check for the new jobs at specified interval in milliseconds.
  3. Populate the settings in the
    Connection String
    tab as follows:
    • Database Type
      You have the option of either Oracle or SQL Server. Your selection is based on where the repository database was installed.
    • Data Source
      If the repository database is installed on SQL Server, then this is set to the fully qualified SQL Server instance name.
      If the repository database is installed on Oracle, this is set to the TNS_ALIAS specified in the tnsnames.ora file.
    • User ID
      A user that can connect to the repository database.
    • Password
      The password of the specified user.
    • Verify
      Used to verify the supplied connection details.
    ORACLE EXAMPLE
    image2016-3-20 16:11:16.png
    SQL SERVER EXAMPLE
    image2016-3-20 16:10:56.png
  4. Populate the settings in the
    Job Executors
    tab as follows:
    • Enabled
      Allows the option of enabling or disabling jobs from executing.
    • Name
      The name that is shown in both the logs and email notifications.
    • Directory
      Stores the full path of where the
      Job Executor
      executable is located.
      Example:
      C:\Program Files (x86)\Grid-Tools\GTDatamaker for gtdatamaker.exe                  
    • ExeName
      The name of the executable file.
      Example:
      gtdatamaker.exe, testmatch.exe                                                                              
    • JobName
      The name of the Job.
      Example:
      PUBLISH, TESTMATCH, ALM
    • Verify
      Used to verify any corrections or changes that are made to listed jobs.
  5. Populate the settings in the
    SMTP Settings
    tab as follows:
    • Host
      SMTP Host.
    • Port
      SMTP Port.
    • Enable SSL
      Check this setting if SSL is enabled on the host.
    • Username
      Depending on the configuration of the SMTP server, this setting is the authentication email address.
      If you are using a gmail account, the following settings prevent the error message "The SMTP server requires a secure connection or the client was not authenticated. The server response was: 5.5.1 Authentication Required".
      Follow these steps:
      • Login to the Google account.
      • Go to My Account page.
      • Click Sign-in & security.
      • Go to the Connected apps & sites section.
      • Turn on the Allow less secure apps setting.
    • Password
      The authentication email account password.
    • Auth Domain
      The Domain which authentication is performed.
    • Use Default Credentials
      Choose this if using local IIS.
    • From Address
      Depending on the configuration of the SMTP server, this field can be configured in one of two ways. If the SMTP server requires a username/password, this field can remain blank. If the SMTP server does not require a username/password, this is populated with an email address who is viewed as the sender.
    • Display Name
      See
      From Address
      on whether this is populated with the name of the sender.
    • Reply To Name
      Username that is associated to the reply email.
    • Reply To Address
      Email address that is used to reply to.
    • Timeout
      This value is the duration that the program tries to send an email before exiting.
    • Verify
      Used to verify the supplied email details. A test email is sent for confirmation.
  6. Populate the settings in the
    Exchange Settings
    tab as follows:
    • Domain
      An optional parameter to specify the domain name.
    • Username
      The email address from which the email notification is sent from.
    • Password
      The email account password.
    • Auto Discover URL
      Select this checkbox if the Exchange server supports Auto URL Discovery.
    • Exchange Service URL
      If the Exchange server does not support Auto URL Discovery and you have not selected the
      Auto Discover URL
      checkbox, provide the Exchange asmx service URL.
    • Verify
      Used to verify the supplied email details. A test email is sent for confirmation.
  7. Do any of the following to complete the configuration:
    • Click Verify All to verify all changes that you made.
    • Click Save to save the configuration
    • (Optional) Click Backup to create a backup of the most currently saved configuration.
Migrate Configuration Settings
To import a backup of your Remote Publish Engine settings, click the
Browse
button and navigate to the location where the backup is stored. This usually can be found at C:\Grid-Tools\RemotePublish\DMBatch.exe.config.bak.
After selecting the appropriate file, click the
Open
button from the file browser dialog box. The settings have been loaded into the editor for review. If the settings are correct, click the
Save
button found in the
Configure
tab.
Manage Service Status
From the
Status
tab in the Configuration Editor, you can manage the service as follows:
Get Service Status
Gets Current Service Status whether it is running or stopped.
Stop Service
Stops the Remote Publish Engine Service.
Start Service
Starts the Remote Publish Engine Service.
Restart Service
This setting stops and restarts the Remote Publish Engine Service.
Relevant messages are shown in the message area of the editor before and after completion of the operation performed. If there is no message within 2 minutes, check the logs for any errors at C:\Grid-Tools\RemotePublish\logs\dmbatch.log.
The Remote Publish Engine Windows Service must be configured to run under a real user account rather than a local system account. This configuration can be carried out from Control Panel, Administrative Tools, Services, CA Remote Publish, Properties, Log On. Specifying a user account and password and then restart the service.