Configuration - Service Endpoints

  bookmark Home > CM4D Configuration > Service Endpoints

  list The Service Endpoints tab contains the connection details for the services which support CM4D applications. The endpoint services must be added and/or connect successfully in order to access any information obtained from those endpoints.

If a connection to a DataSmith Batch Proxy Agent cannot be established, the DataSmith Batch Job properties from that system cannot be displayed.

There are three types of services for which endpoints can be created:

  • DataSmith Batch Proxy - Connects a DataSmith Batch service to CM4D applications via the CM4D Configuration.
  • DataSmith Translator - Opens the DataSmith translator assigned to a DataSmith Batch job that validates and previews the data file before it is uploaded for processing.
  • Virus Scanner - An optional service configured to scan files in Upload Portal before files are uploaded to the server for processing into the database.

For example, CM4D Upload Portal clients utilize the DataSmith Batch Proxy and DataSmith Translator services via the Endpoint addresses saved in the CM4D Configuration to process data files from the web application.

  • plus Add - Add a new service endpoint.
  • refresh-ccw Refresh - Reloads the grid to show any updates to the current status of the contents.
  • Properties - Click on a grid row to modify the properties, or use the Action menu more-vertical ( check-circle Open).
Actions Click more-vertical to open the menu of available actions for the selected row.
  • check-circle Open - Opens the Service Endpoint Properties blade.
  • trash Delete - Deletes the Service Endpoint record.
  • play-circle Start Service - DataSmith Batch Proxy service only. Starts the DataSmith Batch service; available when the service status is Not Running or Unknown.
  • stop-circle Stop Service - DataSmith Batch Proxy service only. Stops the DataSmith Batch service; available when the service status is Running.
Service Endpoint The server URL for the service, including server name and port.
Service Name The label assigned to the service endpoint. This label is used to identify the server hosting the DataSmith Batch service and jobs.
Status The current state of the service:
  • Not Running - The endpoint is connected but is not started.
  • Running - The endpoint is connected and is currently running.
  • Unknown - The endpoint cannot be contacted to make a connection.
Type The type of service for the endpoint connection - DataSmith Batch, DataSmith.NET Translator or Virus Scanner.

Service Endpoint Properties

The service endpoint properties is where you enter the service connection information, including the server name, port and type.

Check Connection Click to test the endpoint information to confirm that it connects successfully.

If on save/check connection the endpoint fails to connect, try the following suggestions:

Check the endpoint URL for accuracy - connection type (http or https), server name and port.

Check the CM4D API service on the endpoint - if stopped, start the CM4D API service and then check the Service Endpoint connection again.
Service Endpoint URL Enter the URL for the service, including the port (http://servername:3200/).
Service Name Enter a name for the service. This is the label that appears in the Jobs grid in the 'Endpoint' column.
Type Select the endpoint service type:
  • DataSmith Batch - Connect to the machine running the DataSmith Batch and DataSmith Batch proxy services. There may be more than one of this type of endpoint if your deployment includes multiple DataSmith Batch clients.
  • DataSmith.NET Translator - Connect to the machine running the DataSmith Translator service.
  • Virus Scanner - Optional; only configure if you have a virus scanner installed that will scan files before this files are uploaded to the server for processing. For ClamAV, the port must be set to 3310.

See the topic Virus Scanner for more details.

 

Can we improve this topic?