Configuring Gateway Server

After installing Gateway Servers, you can configure them for your preferences. The configuration procedure is same for both Gateway Server for X-PDM and Gateway Server for X-PDM Connectivity server.

Notes:
  • After the deployment of the Gateway Server, if you modify any of the below configuration files, please restart the Gateway Application Server.
  • All the scripts for configuring Gateway Server are present at scripts\Configuration directory.

This task shows you how to:

Configure 3DEXPERIENCE platform Connection Parameters

Launch Change3DEXPERIENCEPlatformCredentials.sh

  • File modified: config\gateway-config.properties
  • Properties modified: V6ConnectionURL, LoginUserId, LoginPassword and LoginRole.
Note: Only applicable for 3DExperience Gateway Server.

Configure Shadow Directory

Launch ChangeShadowDirectory.sh.

  • File modified: config\gateway-config.properties
  • Properties modified: RootShadowDirPath
Note: The user is notified when the shadow directory folder does not exist.

Configure File Server Parameters

Launch ChangeFileServerCredentials.sh.

  • File modified: config\fsclient-config.properties

  • Properties modified: Protocol, host, port, user, password

    Where,

    • Protocol: Specify the protocol used with File server for data transfer. Currently three protocols are supported:
      • UNC (where, UNC stands for shared directory)
      • FTP
      • sFTP
    • Host: Specify the name or the IP address of the host that is hosting the File server.
    • Port: Specify the port number that is used by File server for communication. This is an optional parameter. If not specified appropriate default value is considered. If protocol is FTP then default value is 21.
    • User & Password: Specify the username for the File server. In case of FTP server, if anonymous connection is allowed then user can be specified as anonymous.
    • IsPwdEncrypted: If the value is set to true then it indicates that password is encrypted and needs decryption before authentication to File server. Default value is true if not specified.

Configure Site ID Information

All site ids and urls in a particular setup are mapped in file config/site-ids-config.xml. The Site Id values are arbitrary, but must be coherently defined in the different X-PDM components. An additional attribute called as self is kept for identifying the site id of the local site. It accepts a boolean value. Default value is false. Format of the file is as follows: 

<Site id="3DExperience Platform" self="true" />
<Site id="XPDM1" url="http://xpdmserver:8080/XPDMGW" self="false"/>
<Site id="XPDM2" url="http://XPDM2:7001/XPDMGW" self="false"/>
<Site id="XPDM3" url="http://XPDM3:5008/XPDMGW" self="false"/>

Configure the Notification Services

The notification service is used by the Gateway Server to send notifications about the event processing failure to the respective users. The notifications are sent via emails.

  1. File: config\notification\notification-config.xml

    This configuration file defines the overall configuration about the service such as details of the NotificationManager, details of various NotificationSenders, the path of the file defining the format of notification message. Modify the following parameters in this file as given below:

    • <Param Name="mail.smtp.host" Value="SMTP_HOST_NAME" />

      Replace the value of SMTP_HOST_NAME with the host name of the machine running the SMTP server.

    • <Param Name="from" Value="GatewayAdmin@3ds.com" />

      Replace the value of the Value attribute (here GatewayAdmin@3ds.com) with the mail address that is used as the From address of the notification emails. Keep the rest of the configurations in the file as the default values.

  2. File: config\notification\mail\mail-id-config.properties

    This is a properties file containing the list of user ids mapped with respective email ids. Every line in this file contains a key value combination having the key as the userid and the value as the email of the user. These email ids are used by notification service to send notifications to the user.

    This file contains one special entry at the top with the key defaultUser. This user is used by notification service to send a notification if a required user is not found in the list of users. This can be the local Gateway admin user.

    Note: The user ids are also known as QueueName in the different APIs to send events.

    Set the email id of the local Gateway administrator against defaultUser.

    Note: If it is required to send notification (only for event-abortion) to additional email id, set OriginalUserEmail event custom parameter in BatchInputTemplate_siteid.xml file. This parameter must contain a valid email address.
    • If the OriginalUserEmail parameter is set in the event, the event-abortion notification email is send to both the OriginalUserEmail and the email computed with the mail-id-config.properties file.
    • If the OriginalUserEmail parameter is not set in the event, the abortion notification is send only to the email computed with the mail-id-config.properties file.

  3. File: config\notification\mail\evt-successful-mail-message-format.xml

    This configuration file is customizable and defines the format or template of the successful notification message.

    This message template contains some key words that are replaced by the notification service before sending the message.

    The description of these parameters is mentioned in the <Description> tag of this file.

  4. File: config\notification\mail\evt-failure-mail-message-format.xml

    This configuration file is customizable and defines the format or template of the failure notification message.

    This message template contains some key words that are replaced by the notification service before sending the message.

    The description of these parameters is mentioned in the <Description> tag of this file.

  5. File: config\notification\mail\evt-abort-mail-message-format.xml

    This configuration file is customizable and defines the format or template to customize the message for event-abortion notification.

    This message template contains some key words that are replaced by the notification service before sending the message.

    The description of these parameters is mentioned in the <Description> tag of this file.

    Note: The email address mentioned as the value of OriginalUserEmail parameter is used only for event-abortion notifications.

  6. File: config\notification\mail\evt-warning-mail-message-format.xml

    This configuration file defines the format or template of the warning notification message.

    This message template contains some key words that are replaced by the notification service before sending the message.

    The description of these parameters is mentioned in the <Description> tag of this file.

  7. File: config\gateway-config.properties

    Set the StartNotificationService property to true in the gateway-config.properties file. This enables the notification service to be started by the local Gateway during the startup.

    By default, StartNotificationService property is set to false.

    Note: During installation, if you select the Activate Notification Service check box, the StartNotificationService property is automatically set to true.

Configure Logging

You can manage logs for both the Gateway Servers through a standard logging system and control log levels. The logback.xml is used for log configuration. The required keys and appenders are present in the logback.xml file.

The logback.xml for Gateway Server is available at <Gateway Installation>\config\logback.xml and all the gateway traces are generated in <Gateway Installation>\logs.

where, <Gateway Installation> is the Gateway Server installation directory.

You can change the default log directory(<Gateway Installation>\logs) using ChangeLogDirectory.sh.

Note: The user is notified when the log directory folder does not exist.

Configure Gateway Administrative Console User

You can modify list of authorized Central Authentication Service (CAS) users who can access Gateway Administrative Console.

  • Launch ChangeCASDetails.sh
    • File modified: config\gateway-config.properties
    • Properties modified: AuthorizedUsers
Note: The list of authorized CAS users who can access Gateway Administrative Console can be different for both the gateways.

Configure Blocking Event in a Queue

In gateway-config.properties file, update the NonBlockingQueues property as per your requirement.

  • Set NonBlockingQueues=true, to auto-archive the failed event (due to Business Processing error) and start processing the next event in the queue.
  • Set NonBlockingQueues=false, to block the associated queue and keep the failed event in the queue.