Component endpoint configuration
The following component endpoint configuration properties are available:
Property | Description |
alias | Required. Specifies the logical name for the host, for example: <Endpoint alias="${logicalName}">. |
Host | Required. Specifies the host name of the correlator or data server for a specified alias. |
Port | Required. Specifies the port of the correlator or data server. |
type | Required. Specifies the type of endpoint configuration. |
isRaw | Specifies whether to use the raw channel for communication. Valid values are: true false The default value is false. This property applies only to the correlator endpoint type. |
When you create a new endpoint configuration instance, you must use COMMON-COMPONENT-ENDPOINTS as the configuration type ID.
When you update or delete an endpoint configuration instance, you must use the following configuration instance ID:
COMMON-COMPONENT-ENDPOINTS-endpointtype-alias
Examples when executing on Command Central
To create the endpoint configuration instance for a display server instance:
sagcc create configuration data local Apama-displayServer-myDisplayServer
COMMON-COMPONENT-ENDPOINTS -i AddDisplayServerEndpoint.xml
To update the endpoint configuration instance for a display server instance for endpoint type
correlator:
sagcc update configuration data local Apama-displayServer-myDisplayServer
COMMON-COMPONENT-ENDPOINTS-correlator-alias1
-i UpdateDisplayServerEndpoint.xml
To update the endpoint configuration instance for a display server instance for endpoint type
dataserver:
sagcc update configuration data local Apama-displayServer-myDisplayServer
COMMON-COMPONENT-ENDPOINTS-dataserver-alias1
-i UpdateDisplayServerEndpoint.xml
To delete the endpoint configuration instance for a display server instance for endpoint type
correlator:
sagcc delete configuration data local Apama-displayServer-myDisplayServer
COMMON-COMPONENT-ENDPOINTS-correlator-alias1
To delete the endpoint configuration instance for a display server instance for endpoint type
dataserver:
sagcc delete configuration data local Apama-displayServer-myDisplayServer
COMMON-COMPONENT-ENDPOINTS-dataserver-alias1
To create the endpoint configuration instance for a data server instance:
sagcc create configuration data local Apama-dataserver-myDataServer
COMMON-COMPONENT-ENDPOINTS -i AddDataServerEndpoint.xml
To update the endpoint configuration instance for a data server instance for endpoint type
correlator:
sagcc update configuration data local Apama-dataserver-myDataServer
COMMON-COMPONENT-ENDPOINTS-correlator-alias1 -i UpdateDataServerEndpoint.xml
To update the endpoint configuration instance for a data server instance for endpoint type
dataserver:
sagcc update configuration data local Apama-dataserver-myDataServer
COMMON-COMPONENT-ENDPOINTS-dataserver-alias1 -i UpdateDataServerEndpoint.xml
To delete the endpoint configuration instance for a data server instance for endpoint type
correlator:
sagcc delete configuration data local Apama-dataserver-myDataServer
COMMON-COMPONENT-ENDPOINTS-correlator-alias1
To delete the endpoint configuration instance for a data server instance for endpoint type
dataserver:
sagcc delete configuration data local Apama-dataserver-myDataServer
COMMON-COMPONENT-ENDPOINTS-dataserver-alias1
Note:
You cannot update alias and endpoint type.
Example format of the XML file for correlator type endpoint for the instance ID COMMON-COMPONENT-ENDPOINTS-correlator-alias1:
<Endpoint alias="alias1">
<Transport>
<Host>localhost</Host>
<Port>15903</Port>
</Transport>
<Auth/>
<ExtendedProperties>
<Property name="isRaw">true</Property>
<Property name="type">correlator</Property>
</ExtendedProperties>
</Endpoint>
Example format of the XML file for dataserver type endpoint for the instance ID COMMON-COMPONENT-ENDPOINTS-dataserver-alias1:
<Endpoint alias="alias1">
<Transport>
<Host>localhost</Host>
<Port>2888</Port>
</Transport>
<Auth/>
<ExtendedProperties>
<Property name="type">dataserver</Property>
</ExtendedProperties>
</Endpoint>