Configuration - Service Endpoints

Home > CM4D Configuration > Service Endpoints

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.

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

DataSmith Translator (Manual)

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 (Manual)

An optional service configured to scan files in Upload Portal before files are uploaded to the server for processing into the database.

DataSmith Batch Proxy Agent (Automatic)

Connects a DataSmith Batch service to CM4D applications via the CM4D API. This endpoint is self-registering on successful connection to the CM4D API.

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

Add - Add a new service endpoint.
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 ( Open).


Actions	Click to open the menu of available actions for the selected row. Open - DataSmith.NET Translator and Virus Scanner types only. Opens the Service Endpoint Properties blade. Delete - Deletes the Service Endpoint record. Deleting a Batch Proxy Agent is allowed; proxy is re-added the next time the service is run. Start Service - DataSmith Batch Proxy Agent service only. Starts the DataSmith Batch service; available when the service status is Not Running or Unknown. Stop Service - DataSmith Batch Proxy Agent 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. DataSmith Batch Proxy Agents are self-registering, so there is no configured URL. See the topic DataSmith Batch Proxy Agent for more information.
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. Disconnected - 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. DataSmith Batch - Connects its local DataSmith Batch service within the CM4D Site network, providing real-time communication with the CM4D API hub. This allows for the management of Batch jobs via the CM4D Configuration plugin and operating CM4D Upload Portal. There may be more than one of this type of endpoint if your deployment includes multiple DataSmith Batch clients. See the topic DataSmith Batch Proxy Agent for more details. 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.

Service Endpoint Properties

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

The DataSmith Batch Proxy Agent is self-registering, so it cannot be modified.


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 (https), server name (FQDN) 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 (https://servername.domain.local:4500/).
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.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. When adding a new endpoint, there is no option to select DataSmith Batch Proxy Agent since that service type is self-registering. See the topic DataSmith Batch Proxy Agent for more information.