Toolpack API - Revision history

Luc Morissette at 17:48, 21 June 2022

2022-06-21T17:48:28Z

← Older revision		Revision as of 13:48, 21 June 2022
Line 61:		Line 61:
	== Toolpack API documentation<br> ==		== Toolpack API documentation<br> ==

	Description and documentation of all APIs are available in the '''tb-doc.zip''' ~~package of each software release (see [http://forums.telcobridges.com/viewforum.php?f=23 http://forums.telcobridges.com/viewforum.php?f=23] for available software releases)~~. Once unzipped, please check folder '''tb\doc\toolpack\html\index.html'''<br>		Description and documentation of all APIs are available on demand in the '''tb-doc.zip''' file. <br> Once unzipped, please check folder '''tb\doc\toolpack\html\index.html'''<br>

Cbilodeau: remove 5900 and 7900

2014-02-27T21:11:45Z

remove 5900 and 7900

← Older revision		Revision as of 17:11, 27 February 2014
Line 2:		Line 2:


	The graphic below demonstrates Toolpack and a customer developed application running on an external application server such as one would use with the Tdev [[TMP6400]] or the Tdev [[TMP800~~]]. It is also possible to host the application server locally in the Tdev [[TMP5900]] or the Tdev [[TMP7900~~]].		The graphic below demonstrates Toolpack and a customer developed application running on an external application server such as one would use with the Tdev [[TMP6400]] or the Tdev [[TMP800]].

Luc Morissette: Added Toolpack API link to documentation

2011-11-14T14:45:37Z

Added Toolpack API link to documentation

← Older revision		Revision as of 10:45, 14 November 2011
Line 53:		Line 53:
	* [[CTBCAFCli]]: This module provides a command-line interface that's more convenient that a single shell prompt, by allowing the application to display multiple pages of information, view the application log, and enter commands. It also allows the application to be "remotely controlled" using the ''tbx_cli_tools_remote'' application.		* [[CTBCAFCli]]: This module provides a command-line interface that's more convenient that a single shell prompt, by allowing the application to display multiple pages of information, view the application log, and enter commands. It also allows the application to be "remotely controlled" using the ''tbx_cli_tools_remote'' application.

	== Accessing Toolpack configuration database ==		== Accessing Toolpack configuration database ==
	The Toolpack configuration database is normally configured using the Web Portal. However, some applications may need to query information from that database. When that's the case, TelcoBridges provides a MySql database access class ([[CTBCAFDb]]), along with many DAOs (data access objects) that provide C++ classes that represent all the database tables used by Toolpack.
	For more information on how to access Toolpack configuration database, please refer to the following page:		The Toolpack configuration database is normally configured using the Web Portal. However, some applications may need to query information from that database. When that's the case, TelcoBridges provides a MySql database access class ([[CTBCAFDb]]), along with many DAOs (data access objects) that provide C++ classes that represent all the database tables used by Toolpack. For more information on how to access Toolpack configuration database, please refer to the following page: [[Accessing Toolpack DB]]
	[[~~Accessing_Toolpack_DB~~]]
			<br>

			== Toolpack API documentation<br> ==

			Description and documentation of all APIs are available in the '''tb-doc.zip''' package of each software release (see [http://forums.telcobridges.com/viewforum.php?f=23 http://forums.telcobridges.com/viewforum.php?f=23] for available software releases). Once unzipped, please check folder '''tb\doc\toolpack\html\index.html'''<br>

Abrassard: /* Toolpack OAM APIs */

2011-05-30T18:35:06Z

Toolpack OAM APIs

← Older revision		Revision as of 14:35, 30 May 2011
Line 44:		Line 44:

	=== Toolpack OAM APIs ===		=== Toolpack OAM APIs ===
	In order to integrate with Toolpack OAM, or to get access to the configuration database, an ~~application has to be added to the Toolpack Database list of applications. Please follow the following procedure: [[Toolpack_OAM_add_app\|Add custom application to Toolpack]]~~		In order to integrate with Toolpack OAM, or to get access to the configuration database, an application then needs to initialize the following modules:

	An application then needs to initialize the following modules:
	* [[CTBCAFServiceAlmMgmt]]: This module (Application Launch Management) allows an application to be launched (and monitored for failure through heartbeat) by Toolpack OAM system		* [[CTBCAFServiceAlmMgmt]]: This module (Application Launch Management) allows an application to be launched (and monitored for failure through heartbeat) by Toolpack OAM system
	* [[CTBCAFServiceCmMgmtClient]]: This module (Configuration Management) allows an application to be informed of the current active configuration, and active database connection string		* [[CTBCAFServiceCmMgmtClient]]: This module (Configuration Management) allows an application to be informed of the current active configuration, and active database connection string

Abrassard: /* Toolpack OAM APIs */

2011-05-30T17:25:39Z

Toolpack OAM APIs

← Older revision		Revision as of 13:25, 30 May 2011
Line 44:		Line 44:

	=== Toolpack OAM APIs ===		=== Toolpack OAM APIs ===
	In order to integrate with Toolpack OAM, or to get access to the configuration database, an application needs to initialize the following modules:		In order to integrate with Toolpack OAM, or to get access to the configuration database, an application has to be added to the Toolpack Database list of applications. Please follow the following procedure: [[Toolpack_OAM_add_app\|Add custom application to Toolpack]]

			An application then needs to initialize the following modules:
	* [[CTBCAFServiceAlmMgmt]]: This module (Application Launch Management) allows an application to be launched (and monitored for failure through heartbeat) by Toolpack OAM system		* [[CTBCAFServiceAlmMgmt]]: This module (Application Launch Management) allows an application to be launched (and monitored for failure through heartbeat) by Toolpack OAM system
	* [[CTBCAFServiceCmMgmtClient]]: This module (Configuration Management) allows an application to be informed of the current active configuration, and active database connection string		* [[CTBCAFServiceCmMgmtClient]]: This module (Configuration Management) allows an application to be informed of the current active configuration, and active database connection string

Abrassard: /* Toolpack OAM APIs */

2011-05-30T15:10:12Z

Toolpack OAM APIs

← Older revision		Revision as of 11:10, 30 May 2011
Line 47:		Line 47:
	* [[CTBCAFServiceAlmMgmt]]: This module (Application Launch Management) allows an application to be launched (and monitored for failure through heartbeat) by Toolpack OAM system		* [[CTBCAFServiceAlmMgmt]]: This module (Application Launch Management) allows an application to be launched (and monitored for failure through heartbeat) by Toolpack OAM system
	* [[CTBCAFServiceCmMgmtClient]]: This module (Configuration Management) allows an application to be informed of the current active configuration, and active database connection string		* [[CTBCAFServiceCmMgmtClient]]: This module (Configuration Management) allows an application to be informed of the current active configuration, and active database connection string
	* [[CTBCAFServiceDebugClient]]: This module allows an application to send logs and files to the ''tbdebug'' tool when that tool dumps the debug information on the Toolpack system

	=== Other optional APIs ===		=== Other optional APIs ===

Abrassard: /* Typical Toolpack call handling application components */

2011-05-30T12:36:41Z

Typical Toolpack call handling application components

← Older revision		Revision as of 08:36, 30 May 2011
Line 53:		Line 53:
	* [[CTBCAFLog]]: This module automatically writes calls to "LogTrace" function (which the CAF library itself uses to log useful information) to log files. It also manages log files rotation and zipping.		* [[CTBCAFLog]]: This module automatically writes calls to "LogTrace" function (which the CAF library itself uses to log useful information) to log files. It also manages log files rotation and zipping.
	* [[CTBCAFCli]]: This module provides a command-line interface that's more convenient that a single shell prompt, by allowing the application to display multiple pages of information, view the application log, and enter commands. It also allows the application to be "remotely controlled" using the ''tbx_cli_tools_remote'' application.		* [[CTBCAFCli]]: This module provides a command-line interface that's more convenient that a single shell prompt, by allowing the application to display multiple pages of information, view the application log, and enter commands. It also allows the application to be "remotely controlled" using the ''tbx_cli_tools_remote'' application.

			== Accessing Toolpack configuration database ==
			The Toolpack configuration database is normally configured using the Web Portal. However, some applications may need to query information from that database. When that's the case, TelcoBridges provides a MySql database access class ([[CTBCAFDb]]), along with many DAOs (data access objects) that provide C++ classes that represent all the database tables used by Toolpack.
			For more information on how to access Toolpack configuration database, please refer to the following page:
			[[Accessing_Toolpack_DB]]

Abrassard: Adding section "Typical Toolpack call handling application components "

2011-05-30T12:31:40Z

Adding section "Typical Toolpack call handling application components "

← Older revision		Revision as of 08:31, 30 May 2011
Line 23:		Line 23:
	[[category:Toolpack]]		[[category:Toolpack]]
	[[Category:Tdev_Features\|Toolpack API]]		[[Category:Tdev_Features\|Toolpack API]]


			== Typical Toolpack call handling application components ==
			A Toolpack call handling application is the application, in the Toolpack system, that controls call flows, by connecting and using ''toolpack_engine''. In order to control call flows, the CAF Call API is used. This API hides the communication mechanism with ''toolpack_engine'', so the application code only has to deal with implementing actual call flows.

			The Toolpack call handling application can also use other APIs to integrate with Toolpack OAM (be automatically launched/relaunched/shutdown, receive configuration reload notifications, respond to heart beat, etc.).

			TelcoBridges' own call handling application (the ''gateway'' application) uses all of these APIs.
			Sample application ''simple_call'' also provides simplified examples for using these APIs.

			Below is the list of APIs that the application can use.

			=== Mandatory library ===
			* CAF library: This library contains all the required APIs to handle calls, or integrate with Toolpack OAM.

			=== Mandatory APIs ===
			In order to control calls, an application must at least initialize the following modules:
			* [[CMC_library\|CTBCMCLib]]: This module connects to ''toolpack_engine'', and allows using the CAF API to control call legs and call flows
			* [[CTBCAFComm]]: This library is mandatory for enabling communication with other applications, such as ''toolpack_engine'', or the Toolpack OAM system

			=== Toolpack OAM APIs ===
			In order to integrate with Toolpack OAM, or to get access to the configuration database, an application needs to initialize the following modules:
			* [[CTBCAFServiceAlmMgmt]]: This module (Application Launch Management) allows an application to be launched (and monitored for failure through heartbeat) by Toolpack OAM system
			* [[CTBCAFServiceCmMgmtClient]]: This module (Configuration Management) allows an application to be informed of the current active configuration, and active database connection string
			* [[CTBCAFServiceDebugClient]]: This module allows an application to send logs and files to the ''tbdebug'' tool when that tool dumps the debug information on the Toolpack system

			=== Other optional APIs ===
			The CAF library also implements the following modules, which are convenient for an application to use:
			* [[CTBCAFLog]]: This module automatically writes calls to "LogTrace" function (which the CAF library itself uses to log useful information) to log files. It also manages log files rotation and zipping.
			* [[CTBCAFCli]]: This module provides a command-line interface that's more convenient that a single shell prompt, by allowing the application to display multiple pages of information, view the application log, and enter commands. It also allows the application to be "remotely controlled" using the ''tbx_cli_tools_remote'' application.

Cbilodeau: fix link

2011-02-15T20:43:42Z

fix link

← Older revision		Revision as of 16:43, 15 February 2011
Line 16:		Line 16:
	*[[Customer Application Framework\|Customer Application Framework (CAF)]]		*[[Customer Application Framework\|Customer Application Framework (CAF)]]
	*[[CMC library\|CMC Library]]		*[[CMC library\|CMC Library]]
	*[[Toolpack Engine]]		*[[Toolpack_Application:toolpack_engine\|Toolpack Engine]]
	*[[Toolpack_Application:toolpack_sys_manager\|Toolpack System Manager]]		*[[Toolpack_Application:toolpack_sys_manager\|Toolpack System Manager]]
	*[[TCAP Control Library]]		*[[TCAP Control Library]]

Cbilodeau: fix link

2011-02-15T20:29:16Z

fix link

← Older revision		Revision as of 16:29, 15 February 2011
Line 17:		Line 17:
	*[[CMC library\|CMC Library]]		*[[CMC library\|CMC Library]]
	*[[Toolpack Engine]]		*[[Toolpack Engine]]
	*[[Toolpack System Manager]]		*[[Toolpack_Application:toolpack_sys_manager\|Toolpack System Manager]]
	*[[TCAP Control Library]]		*[[TCAP Control Library]]