CSharp API Library Setup: Difference between revisions

From RangerMSP Wiki - PSA software for MSPs and IT services providers
Jump to navigation Jump to search
No edit summary
No edit summary
Line 8: Line 8:
The distributed files are plain source files (there are no precompiled files included), so you’ll have to rebuild the whole solution.  
The distributed files are plain source files (there are no precompiled files included), so you’ll have to rebuild the whole solution.  


After everything is compiled, locate the '''Program.cs''' file in the '''Sample1''' project and ensure that '''config.CommitDllFolder''' and '''config.CommitDbFolder''' point to the correct paths on your computer (<your-server>\Commit\ThirdParty\UserDev and <your-server>\Commit\Db  accordingly)..  
After everything is compiled, locate the '''Program.cs''' file in the '''Sample1''' project and ensure that '''config.CommitDllFolder''' and '''config.CommitDbFolder''' point to the correct paths on your computer (<your-server>\CommitCRM\ThirdParty\UserDev and <your-server>\CommitCRM\Db  accordingly)..  


The file has many comments explaining each step, we recommend examining '''Program.cs''' source file before executing the compiled program. In a nutshell, the sample will search for an account (if it doesn’t find it, it will create new one), and then demonstrates adding/searching for a ticket and adding/listing charges.
The file has many comments explaining each step, we recommend examining '''Program.cs''' source file before executing the compiled program. In a nutshell, the sample will search for an account (if it doesn’t find it, it will create new one), and then demonstrates adding/searching for a ticket and adding/listing charges.

Revision as of 13:34, 1 September 2013

Decompress the downloaded archive to a destination folder of your choice. In the root folder CommitCRM-CSharp you’ll find two solution files:

  • CommitCRM-CSharp-2008.sln – for Visual Studio 2008
  • CommitCRM-CSharp-2010.sln – for Visual Studio 2010

Depending of what version is installed on the local computer, open the one or the other solution file.

The distributed files are plain source files (there are no precompiled files included), so you’ll have to rebuild the whole solution.

After everything is compiled, locate the Program.cs file in the Sample1 project and ensure that config.CommitDllFolder and config.CommitDbFolder point to the correct paths on your computer (<your-server>\CommitCRM\ThirdParty\UserDev and <your-server>\CommitCRM\Db accordingly)..

The file has many comments explaining each step, we recommend examining Program.cs source file before executing the compiled program. In a nutshell, the sample will search for an account (if it doesn’t find it, it will create new one), and then demonstrates adding/searching for a ticket and adding/listing charges.

To use the library in your own project you’ll have to reference the CommitLib.dll (the DLL will be created after compiling the source code).

Back to CommitCRM CSharp API Page