C++ API - Revision history

Dina at 08:00, 8 July 2020

2020-07-08T08:00:29Z

Dina at 18:29, 21 March 2020

2020-03-21T18:29:26Z

← Older revision		Revision as of 18:29, 21 March 2020
Line 5,504:		Line 5,504:

	= See Also =		= See Also =
	*[[~~Commit~~ API Developers Guide]]		*[[API Developers Guide]]
	*[[API Reference Manual]]		*[[API Reference Manual]]
	[[Category:User Manuals]]		[[Category:User Manuals]]
	[[Category:Integration]]		[[Category:Integration]]

Dina: Dina moved page CommitCRM C++ API to C++ API

2020-03-21T17:05:33Z

Dina moved page CommitCRM C++ API to C++ API

← Older revision	Revision as of 17:05, 21 March 2020
(No difference)

Dina at 17:05, 21 March 2020

2020-03-21T17:05:06Z

← Older revision		Revision as of 17:05, 21 March 2020
Line 159:		Line 159:
	</font>		</font>

	Тhe first parameter to the '''AddCriteria''' method is either a static object instance of '''CommitCRM::CmtField''' class representing the field we want to look in or the internal API field name. Refer to the '''API Field Name''' column in the [[~~CommitCRM_C~~%2B%2B_API#Account_Class\|Account Class]]		Тhe first parameter to the '''AddCriteria''' method is either a static object instance of '''CommitCRM::CmtField''' class representing the field we want to look in or the internal API field name. Refer to the '''API Field Name''' column in the [[C%2B%2B_API#Account_Class\|Account Class]]
	table for a complete list of the available fields for the '''CommitCRM::Account''' class.		table for a complete list of the available fields for the '''CommitCRM::Account''' class.

Line 243:		Line 243:
	</font>		</font>

	All internal field names are listed in [[~~CommitCRM_C~~%2B%2B_API#Classes_and_Objects\|Classes and Objects]] below.		All internal field names are listed in [[C%2B%2B_API#Classes_and_Objects\|Classes and Objects]] below.

	= Exception Handling =		= Exception Handling =

Goran: /* ObjectQuery Class */

2015-03-20T08:43:39Z

ObjectQuery Class

@@ Line 5,343: / Line 5,343: @@
   CommitCRM::ObjectQuery<CommitCRM::Ticket>::COLLECTION tickets = ticketSearch.FetchObjects();
   <span style="color: #66AD3A;">//tickets now contains all CommitCRM::Ticket objects that satisfy the above criteria.</span>
 </font>

Goran: /* Task Class */

2014-04-17T10:21:54Z

Task Class

@@ Line 2,480: / Line 2,480: @@
 | (const std::string& val)
 | FLDEVTFROMTIME
 | N/A
 |-

Goran: /* Calendar Class */

2014-04-16T15:37:01Z

Calendar Class

Show changes

Robert at 13:06, 1 September 2013

2013-09-01T13:06:26Z

← Older revision		Revision as of 13:06, 1 September 2013
Line 43:		Line 43:
	* '''CommitDllFolder'''		* '''CommitDllFolder'''
	: Behind the scenes the library uses the two CommitCRM API dlls: '''CmtDbEng.dll''' and '''CmtDbQry.dll'''.		: Behind the scenes the library uses the two CommitCRM API dlls: '''CmtDbEng.dll''' and '''CmtDbQry.dll'''.
	: In the default CommitCRM installation you'll find these files in <span style="color: #963A46;">'C:\\~~Commit~~\\ThirdParty\\UserDev'</span>.		: In the default CommitCRM installation you'll find these files in <span style="color: #963A46;">'C:\\CommitCRM\\ThirdParty\\UserDev'</span>.
	: '''Important Note''': Always point to this folder and do '''not''' copy the dll files elsewhere. This is because when the CommitCRM version upgrade runs it also upgrades the dll files stored in this folder. This verifies that you will always be using the latest release.		: '''Important Note''': Always point to this folder and do '''not''' copy the dll files elsewhere. This is because when the CommitCRM version upgrade runs it also upgrades the dll files stored in this folder. This verifies that you will always be using the latest release.

	* '''CommitDbFolder'''		* '''CommitDbFolder'''
	: Path to the CommitCRM database, default is <span style="color: #963A46;">'C:\\~~Commit~~\\db'</span>.		: Path to the CommitCRM database, default is <span style="color: #963A46;">'C:\\CommitCRM\\db'</span>.

	Assuming these default values, we can configure the '''CommitCRM::Config''' object like this:		Assuming these default values, we can configure the '''CommitCRM::Config''' object like this:
Line 53:		Line 53:
	CommitCRM::Config config;		CommitCRM::Config config;
	config.AppName = <span style="color: #963A46;">"C++ Demo"</span>;		config.AppName = <span style="color: #963A46;">"C++ Demo"</span>;
	config.CommitDllFolder = <span style="color: #963A46;">"C:\\~~Commit~~\\ThirdParty\\UserDev"</span>;		config.CommitDllFolder = <span style="color: #963A46;">"C:\\CommitCRM\\ThirdParty\\UserDev"</span>;
	config.CommitDbFolder = <span style="color: #963A46;">"C:\\~~Commit~~\\db"</span>;		config.CommitDbFolder = <span style="color: #963A46;">"C:\\CommitCRM\\db"</span>;
	</font>		</font>

Line 112:		Line 112:
	CommitCRM::Config config;		CommitCRM::Config config;
	config.AppName = <span style="color: #963A46;">"C++ Demo"</span>;		config.AppName = <span style="color: #963A46;">"C++ Demo"</span>;
	config.CommitDllFolder = <span style="color: #963A46;">"C:\\~~Commit~~\\ThirdParty\\UserDev"</span>;		config.CommitDllFolder = <span style="color: #963A46;">"C:\\CommitCRM\\ThirdParty\\UserDev"</span>;
	config.CommitDbFolder = <span style="color: #963A46;">"C:\\~~Commit~~\\db"</span>;		config.CommitDbFolder = <span style="color: #963A46;">"C:\\CommitCRM\\db"</span>;

	CommitCRM::Application::Initialize(config);		CommitCRM::Application::Initialize(config);
Line 250:		Line 250:
	We recommend enclosing all calls to the CommitCRM library in a '''try/catch''' block.		We recommend enclosing all calls to the CommitCRM library in a '''try/catch''' block.

	To find out more about the exact error that ~~ocured~~ when an exception is thrown, you can use the '''CommitCRM::Exception::Status''' method that returns the last CommitCRM '''Status''' value,		To find out more about the exact error that occurred when an exception is thrown, you can use the '''CommitCRM::Exception::Status''' method that returns the last CommitCRM '''Status''' value,
	or use the '''CommitCRM::Exception.Codes''' method to return the list of last codes (if any). Please refer to [[API_Reference_Manual#Error_Codes_Description\|Error Codes Description]] for the description of these values.		or use the '''CommitCRM::Exception.Codes''' method to return the list of last codes (if any). Please refer to [[API_Reference_Manual#Error_Codes_Description\|Error Codes Description]] for the description of these values.

Line 4,894:		Line 4,894:
	\| '''CommitDllFolder'''		\| '''CommitDllFolder'''
	\| '''Yes'''		\| '''Yes'''
	\| Exact path to the folder where CommitCRM API DLLs are located ('''CmtDbEng.dll''' and '''CmtDbQry.dll''', usually '''"C:\\~~Commit~~\\ThirdParty\\UserDev"''').		\| Exact path to the folder where CommitCRM API DLLs are located ('''CmtDbEng.dll''' and '''CmtDbQry.dll''', usually '''"C:\\CommitCRM\\ThirdParty\\UserDev"''').
	\|-		\|-
	\| std::string		\| std::string
	\| '''CommitDbFolder'''		\| '''CommitDbFolder'''
	\| '''Yes'''		\| '''Yes'''
	\| Exact path to the folder where CommitCRM database is located (usually '''"C:\\~~Commit~~\\db"''').		\| Exact path to the folder where CommitCRM database is located (usually '''"C:\\CommitCRM\\db"''').
	\|-		\|-
	\| bool		\| bool
Line 5,203:		Line 5,203:
	CommitCRM.Config config;		CommitCRM.Config config;
	config.AppName = <span style="color: #963A46;">"C++ Demo"</span>;		config.AppName = <span style="color: #963A46;">"C++ Demo"</span>;
	config.CommitDllFolder = <span style="color: #963A46;">"C:\\~~Commit~~\\ThirdParty\\UserDev"</span>;		config.CommitDllFolder = <span style="color: #963A46;">"C:\\CommitCRM\\ThirdParty\\UserDev"</span>;
	config.CommitDbFolder = <span style="color: #963A46;">"C:\\~~Commit~~\\db"</span>;		config.CommitDbFolder = <span style="color: #963A46;">"C:\\CommitCRM\\db"</span>;
	config.RaiseExceptionIfDatabaseFieldTruncated = <span style="color: #3A3AFF;">true</span>;<span style="color: #66AD3A;">//the setting is ON now</span>		config.RaiseExceptionIfDatabaseFieldTruncated = <span style="color: #3A3AFF;">true</span>;<span style="color: #66AD3A;">//the setting is ON now</span>

Sheli: /* Remote Server (Web API) */

2012-09-19T05:35:11Z

Remote Server (Web API)

← Older revision		Revision as of 05:35, 19 September 2012
Line 66:		Line 66:

	* '''WebAPIUrl'''		* '''WebAPIUrl'''
	: Url to the CommitCRM server running the Web API, either local or remote. Valid examples include http://localhost:4964/ and https://webapi.mycommitcrmserver.com/.		: Url to the CommitCRM server running the Web API, either local or remote. <br>Url '''must include''' the http:// or https:// prefix, otherwise the API will not be able to connect.<br>Valid examples include http://localhost:4964/ and https://webapi.mycommitcrmserver.com/.

	* '''Password'''		* '''Password'''
Line 82:		Line 82:
	config.UseWebAPI = <span style="color: #3A3AFF;">true</span>;		config.UseWebAPI = <span style="color: #3A3AFF;">true</span>;
	</font>		</font>

	===Initialization===		===Initialization===
	The configuration settings explained above are the only differences between connecting to a local CommitCRM server or remote CommitCRM server running the Web API.		The configuration settings explained above are the only differences between connecting to a local CommitCRM server or remote CommitCRM server running the Web API.

Sheli: /* Start Basic Program */

2012-09-09T08:40:57Z

Start Basic Program

← Older revision		Revision as of 08:40, 9 September 2012
Line 29:		Line 29:
	Initialization method requires that you pass an object instance of '''CommitCRM::Config''' class.		Initialization method requires that you pass an object instance of '''CommitCRM::Config''' class.

			Connecting to the CommitCRM database can be done in two ways:
			# Using a Local Server - run your program on the same server where the CommitCRM Server runs.
			# Using Web API - run your program anywhere and connect to a remote CommitCRM server over Web services interface.

			Connection parameters vary between these options. See the variations below:

	===Local Server===		===Local Server===
	For connections to a local CommitCRM server configure the following settings:		For connections to a local CommitCRM server configure the following settings:
Line 53:		Line 59:
	You should of course ensure these paths are correct on your disk and modify the values accordingly.		You should of course ensure these paths are correct on your disk and modify the values accordingly.

	===Web API===		===Remote Server (Web API)===
	To connect to a remote CommitCRM server with the Web API, configure the following settings:		To connect to a remote CommitCRM server with the Web API, configure the following settings: