Use the NE Template editor to define an NE template entity. You can create a connection pool and add communication parameters used to manage the connections to a network element.
You can create the NE Template editor using the NE Template Wizard. In the Studio Projects view, double-click a NE Template entity to open the editor.
When working with the NE Template editor, see the following topics:
Use the Editor tab to define configuration values used to manage the connections to a network element.
| Field | Use |
|---|---|
| Description | Specify a description for the NE Template editor. |
| Vendor, Technology, and Software Load | Displays the vendor, technology, and software load for the NE template entity in the cartridge project. |
When working with the Editor tab, see the following topics:
Use the General tab to define values for a connection pool.
| Field | Use |
|---|---|
| Connection Pool Name | Specify a unique eight-lettered connection pool name. Any connection to the network element is borrowed from this connection pool. |
| Spawn Threshold (AAs) | Select the maximum number of atomic action requests that can be queued to be sent to the network element in ASAP at a given time. As the number of atomic actions waiting to be routed to the network element continues to exceed spawn threshold, ASAP continues to establish new connections to the network element till maximum connections is reached. See ASAP Developer's Guide.
The spawn threshold value is measured in terms of atomic actions. The spawn threshold value must be above the kill threshold value, if multiple connections are required to a specific network element. |
| Retry Count | Select the Retry Count check box to enable the Retry Count box. From the Retry Count box, select the number of attempts that ASAP perform to reestablish the connection to the network element. |
| Retry Interval | Select the Retry Interval check box to enable the Retry Interval box. From the Retry Interval box, select the time interval between each retry attempt by ASAP. |
| Protocol | Select a connection type that the network element will support. |
| Maximum Connections | Select the maximum number of concurrent connections allowed to the host network element. |
| Throughput | Select the Throughput check box to enable the Throughput box. From the Throughput box, select the minimum amount of time a transaction takes to complete for each network element instance. |
| Transactions Per | Select the unit of time required for transactions.
Note: If you want to select a value, select the Throughput check box. |
| Drop Time Out (minutes) | Select the time in which a connection will drop in the absence of an activity. |
| Kill Threshold (AAs) | Select the maximum number of atomic action requests that must be queued in ASAP at a given time for a specific network element, for ASAP to disconnect any auxiliary connection to the network element. See ASAP Developer's Guide.
Note: The kill threshold value should be lower than the spawn threshold value. |
Use the Connections tab to add connections to the connection pool, add predefined communication parameters, and if required override them with local parameters. The local parameters that appear in the Connection Parameter Details area are local to the connection selected in the NE Instance Properties area in the Connections tab. So, every connection in the connection pool can have parameters local to just one specific connection and can also have parameters common to all the connections in the connection pool termed as global parameters.
| Field | Use |
|---|---|
| Connection Name | Specify a name to the connection in the connection pool. |
| Protocol | Displays the protocol selected on the General tab. |
| ASAP System Setting | Select to display whether an ASAP environment is for development or production. |
| Add | Click to add a connection in the connection pool. |
| Remove | Click to clear a connection from the connection pool. |
| Copy | Click to create a copy of a specific connection but with a unique name. |
The global and local communication parameters appear in the Connection Parameter Details area. The global parameters are common across all the connections in a pool and so are editable in the All Communication Parameters tab. See "All Communication Parameters Tab" for more information.
Note:
You can double-click and edit only the local communication parameters as they are local to a connection.| Field | Use |
|---|---|
| Parameter Label | Double-click to specify a parameter name. |
| Connection | Displays the connection name selected in the NE Instance Properties area. |
| Value | Double-click to specify a value. |
| Description | Double-click to specify a description. |
| Add Local | Click to add a new parameter with the connection name as displayed in the row highlighted in the NE Instance Properties area. |
| Remove Local | Click to clear the parameter from the editor. |
| Make Local Copy | Click to create a parameter which is a copy of the global communication parameter. |
Use the All Communication Parameters tab to define the global communication parameters. The global communication parameters are common to all the connections in a connection pool.
The local communication parameters appear in this tab but are not editable. These are the same as can be seen in the Connections tab for a specific connection.
Note:
You can double-click and edit only the global communication parameters.| Field | Use |
|---|---|
| Parameter Label | Displays the name of the communication parameter. You can double-click to rename the parameter label name. |
| Connection | Displays the connection as global or local. If the parameter is local, the connection name of the connection to which the parameter belongs appears. |
| Value | Double-click to specify a value to the global communication parameter. |
| Description | Double-click to specify a description to the global communication parameter. |
| Add Global | Click to add a parameter as global. |
| Remove Global | Click to clear a parameter from the editor. |
Use the Target Network Elements tab to define the target network elements to which you can route atomic actions.
| Field | Use |
|---|---|
| Target Network Element, Atomic Action, and Description | Displays the values configured in the Target NE Details area. |
| Add | Click to add a new target network element. |
| Remove | Click to clear a target network element from the editor. |
| Target NE Name | Specify the name of a target network element to which you can route an atomic action. |
| Select | Click to select an atomic action to be routed through the target network element. Do not select a specific atomic action, if you want all the atomic actions to be routed to one network element. |
| Clear | Click to clear the atomic action for a specific target network element. |
| Description | Specify a description for the target network element. |
Use the Blueprint tab to view the generated documentation for the NE Template entity. This tab is read-only.