Analytics Manager > Customizing Analytics Manager > Working with Analysis Routers > Using the Default Router Template
Using the Default Router Template
Analytics Manager packages the basic round robin router template with session and queueing support. By default, the TW.AnalysisServices.RouterTemplate router template is available with Analytics Manager.
The following property is available with the TW.AnalysisServices.RouterTemplate router template:
Property
Base Type
Description
queueSize
Integer
Specifies the number of jobs that can be queued on each client instance. By default, no jobs are queued on the client, and the default value is 1.
Set the value of this property to more than 1 to run multiple simulation jobs for an analysis provider.
The following services are available with the TW.AnalysisServices.RouterTemplate router template:
Service
Input Parameters
Result
Parameter Name
Base Type
Description
GetClients
—
—
—
Returns the list of clients on the router in the form of a JSON object. The JSON object is an array of client objects.
AddClient
client
JSON
Specifies the analysis client to be added to the list.
Adds a new registered client to the list.
RemoveClient
clientId
STRING
Specifies the ID of the analysis client to be removed from the list.
Removes a client to be disconnected from the list of clients.
GetNextClient
modelName
STRING
Specifies the name of the model for which the router must review the list of clients and query the client health to select an available client to process the next job.
Selects an available client to process the next job.
GetClientToDisconnect
—
—
—
Reviews the list of clients to determine which client has the lowest queue length and returns the name of the clients that can be disconnected.
DecrementJobCount
clientId
STRING
Specifies the ID of the analysis client for which the router decrements the job queue.
Decrements the number of jobs queued on the client.
IncrementJobCount
clientId
STRING
Specifies the ID of the analysis client for which the router increments the job queue.
Increments the number of jobs queued on the client.
clearSessionFromClient
—
—
—
Clears session information from the client.
If you want to create a custom router template to use with your connector, ensure that you use the default template and then modify the services. For more information, see Create a Custom Router Template.
Was this helpful?