API Developers Guide - Revision history

Dina: /* Using RangerMSP API */

2020-07-08T07:13:59Z

Using RangerMSP API

← Older revision		Revision as of 07:13, 8 July 2020
Line 33:		Line 33:
	<br>		<br>

	=Using ~~RangerMSP~~ API=		=Using API=

	==Workflow==		==Workflow==
Line 63:		Line 63:

	<br>		<br>

	=Programming API=		=Programming API=
	The Programming API allows you access the RangerMSP database and perform transactions from within a program (using various programming language). This means you can embed code which accesses the RangerMSP database from within your own application, and add		The Programming API allows you access the RangerMSP database and perform transactions from within a program (using various programming language). This means you can embed code which accesses the RangerMSP database from within your own application, and add

Dina at 07:12, 8 July 2020

2020-07-08T07:12:53Z

Show changes

Dina at 18:48, 18 June 2020

2020-06-18T18:48:30Z

← Older revision		Revision as of 18:48, 18 June 2020
Line 233:		Line 233:

	To install the Advantage ODBC Driver:		To install the Advantage ODBC Driver:
	#Download the ODBC driver version that corresponds with '''your''' Advantage SQL Database Server version from the following links: (The Advantage Version number can be found in the [[Media:ADS_Version.jpg\|Advantage Configuration Utility]] located on the CommitCRM Server)<br> '''[http://{{SERVERNAME}}/downloads/~~commitcrm~~-odbc-11-10-0-10-64bit.exe ODBC Driver Version 11.10 – 64 bit]<br> [http://{{SERVERNAME}}/downloads/~~commitcrm~~-odbc-11-10-0-10.exe ODBC Driver Version 11.10 – 32 bit]<br>[http://{{SERVERNAME}}/downloads/~~commitcrm~~-odbc-10-10-0-28.exe ODBC Driver Version 10.10 – 32 bit]<br> [http://{{SERVERNAME}}/downloads/~~commitcrm~~-odbc-10-0-0-3.exe ODBC Driver Version 10.0 – 32 bit]<br> [http://{{SERVERNAME}}/downloads/~~commitcrm~~-odbc-9-0-0-7.exe ODBC Driver Version 9.0 – 32 bit]<br> [http://{{SERVERNAME}}/downloads/~~commitcrm~~-odbc-8-1-0-26.exe ODBC Driver Version 8.1 – 32 bit] (**Also for systems that do not use the CommitCRM SQL Database)<br> '''		#Download the ODBC driver version that corresponds with '''your''' Advantage SQL Database Server version from the following links: (The Advantage Version number can be found in the [[Media:ADS_Version.jpg\|Advantage Configuration Utility]] located on the CommitCRM Server)<br> '''[http://{{SERVERNAME}}/downloads/crm-odbc-11-10-0-10-64bit.exe ODBC Driver Version 11.10 – 64 bit]<br> [http://{{SERVERNAME}}/downloads/crm-odbc-11-10-0-10.exe ODBC Driver Version 11.10 – 32 bit]<br>[http://{{SERVERNAME}}/downloads/crm-odbc-10-10-0-28.exe ODBC Driver Version 10.10 – 32 bit]<br> [http://{{SERVERNAME}}/downloads/crm-odbc-10-0-0-3.exe ODBC Driver Version 10.0 – 32 bit]<br> [http://{{SERVERNAME}}/downloads/crm-odbc-9-0-0-7.exe ODBC Driver Version 9.0 – 32 bit]<br> [http://{{SERVERNAME}}/downloads/crm-odbc-8-1-0-26.exe ODBC Driver Version 8.1 – 32 bit] (**Also for systems that do not use the CommitCRM SQL Database)<br> '''
	#Run the Setup program.		#Run the Setup program.
	#Proceed through the setup windows to complete installation.		#Proceed through the setup windows to complete installation.

Dina at 18:46, 18 June 2020

2020-06-18T18:46:22Z

← Older revision		Revision as of 18:46, 18 June 2020
Line 233:		Line 233:

	To install the Advantage ODBC Driver:		To install the Advantage ODBC Driver:
	#Download the ODBC driver version that corresponds with '''your''' Advantage SQL Database Server version from the following links: (The Advantage Version number can be found in the [[Media:ADS_Version.jpg\|Advantage Configuration Utility]] located on the CommitCRM Server)<br> '''[http://~~www.commitcrm.com~~/downloads/commitcrm-odbc-11-10-0-10-64bit.exe ODBC Driver Version 11.10 – 64 bit]<br> [http://~~www.commitcrm.com~~/downloads/commitcrm-odbc-11-10-0-10.exe ODBC Driver Version 11.10 – 32 bit]<br>[http://~~www.commitcrm.com~~/downloads/commitcrm-odbc-10-10-0-28.exe ODBC Driver Version 10.10 – 32 bit]<br> [http://~~www.commitcrm.com~~/downloads/commitcrm-odbc-10-0-0-3.exe ODBC Driver Version 10.0 – 32 bit]<br> [http://~~www.commitcrm.com~~/downloads/commitcrm-odbc-9-0-0-7.exe ODBC Driver Version 9.0 – 32 bit]<br> [http://~~www.commitcrm.com~~/downloads/commitcrm-odbc-8-1-0-26.exe ODBC Driver Version 8.1 – 32 bit] (**Also for systems that do not use the CommitCRM SQL Database)<br> '''		#Download the ODBC driver version that corresponds with '''your''' Advantage SQL Database Server version from the following links: (The Advantage Version number can be found in the [[Media:ADS_Version.jpg\|Advantage Configuration Utility]] located on the CommitCRM Server)<br> '''[http://{{SERVERNAME}}/downloads/commitcrm-odbc-11-10-0-10-64bit.exe ODBC Driver Version 11.10 – 64 bit]<br> [http://{{SERVERNAME}}/downloads/commitcrm-odbc-11-10-0-10.exe ODBC Driver Version 11.10 – 32 bit]<br>[http://{{SERVERNAME}}/downloads/commitcrm-odbc-10-10-0-28.exe ODBC Driver Version 10.10 – 32 bit]<br> [http://{{SERVERNAME}}/downloads/commitcrm-odbc-10-0-0-3.exe ODBC Driver Version 10.0 – 32 bit]<br> [http://{{SERVERNAME}}/downloads/commitcrm-odbc-9-0-0-7.exe ODBC Driver Version 9.0 – 32 bit]<br> [http://{{SERVERNAME}}/downloads/commitcrm-odbc-8-1-0-26.exe ODBC Driver Version 8.1 – 32 bit] (**Also for systems that do not use the CommitCRM SQL Database)<br> '''
	#Run the Setup program.		#Run the Setup program.
	#Proceed through the setup windows to complete installation.		#Proceed through the setup windows to complete installation.
Line 372:		Line 372:
	*[[API Code Samples\|Low-Level API Code Samples]]		*[[API Code Samples\|Low-Level API Code Samples]]
	*[[API Reference Manual]]		*[[API Reference Manual]]
	*[http://~~www.commitcrm.com~~/~~sql_database_server.htm~~ CommitCRM SQL Database (CSD)]		*[http://{{SERVERNAME}}/products/sql-database/ CommitCRM SQL Database (CSD)]
	*[[SQL Database Installation Guide \| CommitCRM SQL Database (CSD) Installation Guide]]		*[[SQL Database Installation Guide \| CommitCRM SQL Database (CSD) Installation Guide]]

Dina at 20:14, 21 March 2020

2020-03-21T20:14:18Z

← Older revision		Revision as of 20:14, 21 March 2020
Line 324:		Line 324:
	You should perform the following:		You should perform the following:

	1. [[~~Commit_SQL_Database_Troubleshooting~~#ADS.ini_.E2.80.93_Server_Locator\|Configure the ADS.ini file]]		1. [[SQL_Database_Troubleshooting#ADS.ini_.E2.80.93_Server_Locator\|Configure the ADS.ini file]]

	2. Copy the ADS.ini file you prepared from the CommitCRM server folder into the following folder on each the affected workstation:		2. Copy the ADS.ini file you prepared from the CommitCRM server folder into the following folder on each the affected workstation:

Dina at 20:10, 21 March 2020

2020-03-21T20:10:38Z

← Older revision		Revision as of 20:10, 21 March 2020
Line 373:		Line 373:
	*[[API Reference Manual]]		*[[API Reference Manual]]
	*[http://www.commitcrm.com/sql_database_server.htm CommitCRM SQL Database (CSD)]		*[http://www.commitcrm.com/sql_database_server.htm CommitCRM SQL Database (CSD)]
	*[[~~Commit~~ SQL Database Installation Guide \| CommitCRM SQL Database (CSD) Installation Guide]]		*[[SQL Database Installation Guide \| CommitCRM SQL Database (CSD) Installation Guide]]


	[[Category:User Manuals]]		[[Category:User Manuals]]
	[[Category:Integration]]		[[Category:Integration]]

Dina: Dina moved page Commit API Developers Guide to API Developers Guide

2020-03-21T18:38:29Z

Dina moved page Commit API Developers Guide to API Developers Guide

← Older revision	Revision as of 18:38, 21 March 2020
(No difference)

Dina at 18:17, 21 March 2020

2020-03-21T18:17:46Z

← Older revision		Revision as of 18:17, 21 March 2020
Line 86:		Line 86:

	Note:		Note:
	Retrieving data can be performed either by the API (recommended) or using ODBC when needed. You can read more about it in the [[~~Commit_API_Developers_Guide~~#Data_Retrieval\|Data Retrieval]] section.		Retrieving data can be performed either by the API (recommended) or using ODBC when needed. You can read more about it in the [[API_Developers_Guide#Data_Retrieval\|Data Retrieval]] section.

	==Adding and Updating Data==		==Adding and Updating Data==
Line 110:		Line 110:
	In addition to the Data Retrieval API, there is an option of using ODBC to read data directly from the database. The ODBC link should not be used from programs you develop (you should use the data retrieval API for this purpose). Use the ODBC link only when you need to access the database from an external program, such as external report application (i.e. Crystal reports, or any other application).		In addition to the Data Retrieval API, there is an option of using ODBC to read data directly from the database. The ODBC link should not be used from programs you develop (you should use the data retrieval API for this purpose). Use the ODBC link only when you need to access the database from an external program, such as external report application (i.e. Crystal reports, or any other application).
	<br>		<br>
	* Learn more about [[~~Commit_API_Developers_Guide~~#Data_Retrieval_API\|Data Retrieval API]].		* Learn more about [[API_Developers_Guide#Data_Retrieval_API\|Data Retrieval API]].
	* Learn more about [[~~Commit_API_Developers_Guide~~#ODBC_Data_Retrieval\|Data Retrieval using ODBC Link]].		* Learn more about [[API_Developers_Guide#ODBC_Data_Retrieval\|Data Retrieval using ODBC Link]].
	<br>		<br>

Line 122:		Line 122:
	The API by Email supported only the Data Update API (Data Retrieval API is not supported via emails). The API by Email executes database the transactions using the functions provided by the API dll file which is located in the CommitCRM installation. Both the Programming API and the API by Email use the same dll for performing the transactions.		The API by Email supported only the Data Update API (Data Retrieval API is not supported via emails). The API by Email executes database the transactions using the functions provided by the API dll file which is located in the CommitCRM installation. Both the Programming API and the API by Email use the same dll for performing the transactions.

	Note that the API by Mail is supported only for the Data Update API, allowing you to add and update data. In order to retrieve data, you should use the Data Retrieval Programming API (recommended) or use ODBC, both methods do not support API by Email. You can read more about it in the [[~~Commit_API_Developers_Guide~~#Data_Retrieval\|Data Retrieval]] section.		Note that the API by Mail is supported only for the Data Update API, allowing you to add and update data. In order to retrieve data, you should use the Data Retrieval Programming API (recommended) or use ODBC, both methods do not support API by Email. You can read more about it in the [[API_Developers_Guide#Data_Retrieval\|Data Retrieval]] section.
	<br><br>		<br><br>
	* Learn more about using [[API_by_Email_and_MSP_Integration\|API by Email]].		* Learn more about using [[API_by_Email_and_MSP_Integration\|API by Email]].
Line 153:		Line 153:
	* Find out field properties.		* Find out field properties.

	See low-level programming API information in [[~~Commit_API_Developers_Guide~~#Data_Retrieval\|Low Level API Data Retrieval]].<br>		See low-level programming API information in [[API_Developers_Guide#Data_Retrieval\|Low Level API Data Retrieval]].<br>
	See the [[API_Reference_Manual#Data_Retrieval_API_Functions\|Data Retrieval API Reference Manual]] for detailed usage description.		See the [[API_Reference_Manual#Data_Retrieval_API_Functions\|Data Retrieval API Reference Manual]] for detailed usage description.
	<br><br>		<br><br>
Line 165:		Line 165:
	You can use ODBC Link to read data from the database and integrate it with an external		You can use ODBC Link to read data from the database and integrate it with an external
	system (i.e. Crystal reports, or any other application). You may also use the ODBC Link in		system (i.e. Crystal reports, or any other application). You may also use the ODBC Link in
	order to read the Database Record ID and update existing records (see [[~~Commit_API_Developers_Guide~~#Updating_existing_records\|Updating existing records]]).		order to read the Database Record ID and update existing records (see [[API_Developers_Guide#Updating_existing_records\|Updating existing records]]).

	<u>'''Activation Notes:'''</u>		<u>'''Activation Notes:'''</u>
Line 213:		Line 213:
	\|}		\|}

	For the database fields list, please refer to [[~~Commit_API_Developers_Guide~~#API_Reference_Manual\|API Reference Manual]] section.		For the database fields list, please refer to [[API_Developers_Guide#API_Reference_Manual\|API Reference Manual]] section.
	You can find detailed instructions for using the ODBC Link in the [[~~Commit_API_Developers_Guide~~#Installing_ODBC_Driver\|Installing ODBC Driver]] section.		You can find detailed instructions for using the ODBC Link in the [[API_Developers_Guide#Installing_ODBC_Driver\|Installing ODBC Driver]] section.

Dina at 17:04, 21 March 2020

2020-03-21T17:04:06Z

← Older revision		Revision as of 17:04, 21 March 2020
Line 70:		Line 70:

	See more details and samples about each programming environments in the following links:		See more details and samples about each programming environments in the following links:
	* [[~~CommitCRM_VB~~.NET_API\|VB.Net Programming API]]		* [[VB.NET_API\|VB.Net Programming API]]
	* [[~~CommitCRM_CSharp_API~~\|CSharp Programming API]]		* [[CSharp_API\|CSharp Programming API]]
	* [[~~CommitCRM_C~~%2B%2B_API\|C++ Programming API]]		* [[C%2B%2B_API\|C++ Programming API]]
	<br>		<br>

Line 136:		Line 136:
	<br><br>		<br><br>

	*[[~~CommitCRM_VB~~.NET_API#Remote_Server_.28Web_API.29\|VB.NET]]		*[[VB.NET_API#Remote_Server_.28Web_API.29\|VB.NET]]
	*[[~~CommitCRM_CSharp_API~~#Remote_Server_.28Web_API.29\|CSharp]]		*[[CSharp_API#Remote_Server_.28Web_API.29\|CSharp]]
	*[[~~CommitCRM_C~~%2B%2B_API#Remote_Server_.28Web_API.29\|C++]]		*[[C%2B%2B_API#Remote_Server_.28Web_API.29\|C++]]

	<br>		<br>
Line 349:		Line 349:
	=Samples=		=Samples=
	For basic samples that provide an easy starting point see the following:		For basic samples that provide an easy starting point see the following:
	* [[~~CommitCRM_VB~~.NET_API#Complete_Program_Sample\|VB.NET Code Sample]].		* [[VB.NET_API#Complete_Program_Sample\|VB.NET Code Sample]].
	* [[~~CommitCRM_CSharp_API~~#Complete_Program_Sample\|CSharp Code Sample]].		* [[CSharp_API#Complete_Program_Sample\|CSharp Code Sample]].
	* [[~~CommitCRM_C~~%2B%2B_API#Complete_Program_Sample\|C++ Code Sample]].		* [[C%2B%2B_API#Complete_Program_Sample\|C++ Code Sample]].


Line 364:		Line 364:

	=See Also=		=See Also=
	*[[~~CommitCRM_VB~~.NET_API\|VB.Net Programming API]]		*[[VB.NET_API\|VB.Net Programming API]]
	*[[~~CommitCRM_CSharp_API~~\|CSharp Programming API]]		*[[CSharp_API\|CSharp Programming API]]
	*[[~~CommitCRM_C~~%2B%2B_API\|C++ Programming API]]		*[[C%2B%2B_API\|C++ Programming API]]
	*[[Email Connector\|CommitCRM Email Connector]]		*[[Email Connector\|CommitCRM Email Connector]]
	*[[API by Email and MSP Integration]]		*[[API by Email and MSP Integration]]

Dina: /* Troubleshooting ODBC in 64 Bit Operating Systems */

2018-05-24T10:30:37Z

Troubleshooting ODBC in 64 Bit Operating Systems

@@ Line 315: / Line 315: @@
 | The default is False. If True is specified, trailing spaces in character fields will be removed prior to returning the values to the application.
 |}
 ===Troubleshooting ODBC in 64 Bit Operating Systems===
@@ Line 320: / Line 341: @@
 <br>
 ===Configuring Data Source in 64-Bit Systems===
 When installing the ODBC drivers on 64-bit operating systems, the ODBC drivers may not be displayed in the default ODBC manager in windows control panel. In order to view the 32-bit ODBC manager in a 64-bit operating system, you’ll need to browse to '''%windir%\SysWOW64\odbcad32.exe''' and run the 32 bit ODBC Administrator manually. Once the data source has been configured there, you should be able to select the data source in your 3rd party ODBC programs.