RangerMSP Wiki - PSA software for MSPs and IT services providers - User contributions [en]

MediaWiki:Sidebar

2016-03-10T08:50:19Z

CmtWikiAdminSysop:

MediaWiki:Sidebar

2016-03-10T08:49:52Z

CmtWikiAdminSysop:

MediaWiki:Sidebar

2016-03-10T08:48:46Z

CmtWikiAdminSysop:

MediaWiki:Sidebar

2016-03-10T08:47:46Z

CmtWikiAdminSysop:

MediaWiki:Sidebar

2016-03-10T08:47:28Z

CmtWikiAdminSysop:

MediaWiki:Sidebar

2016-03-10T08:47:10Z

CmtWikiAdminSysop:

MediaWiki:Sidebar

2016-03-10T08:45:55Z

CmtWikiAdminSysop:

MediaWiki:Sidebar

2016-03-10T08:45:00Z

CmtWikiAdminSysop:

MediaWiki:Sidebar

2016-03-10T08:44:30Z

CmtWikiAdminSysop:

MediaWiki:Sidebar

2014-11-02T09:32:24Z

CmtWikiAdminSysop:

Main Page

2014-11-02T09:26:39Z

CmtWikiAdminSysop:

{| id="mp-topbanner" style="width:100%; background:#ffffff; margin-top:1.2em; border:1px solid Silver;"
| style="width:56%; color:#000;" |

{| style="width:280px; border:none; background:#ffffff; margin-left:28%"
| style="width:280px; text-align:center; white-space:nowrap; color:#000;" |
<div style="font-size:180%; border:none; margin:0; padding:.1em; color:#000;">Welcome to the CommitCRM Wiki</div>
<div style="top:+0.2em; font-size:120%;">CommitCRM Support Documentation Center.</div>

|}

| style="width:16%; font-size:95%;" |
* [http://www.commitcrm.com/free-trial/free-trial-download/ Download CommitCRM]
* [http://www.commitcrm.com/forum/ Forums]
* [http://www.commitcrm.com/products/why-commitcrm/ Why CommitCRM?]
* [http://www.commitcrm.com/about-us/ About Commit]
|}

{{Col}}
 
=New to CommitCRM?=

*[[Introduction|Introduction to CommitCRM]]
*[[Getting Started|Getting Started]] ([http://www.commitcrm.com/videos/commit_crm_getting_started_tutorial_video.htm Watch Video])
*[[#Setup & Installation|Setup & Installation]] ([[Videos#Installation Guides|Watch Videos]])
*[[Videos|All Videos]]
*[[FAQ]]

 

=Documentation=
*[[#Getting Started|Getting Started]] ([http://www.commitcrm.com/videos/commit_crm_getting_started_tutorial_video.htm Watch Video])
*[[#Setup & Installation|Setup & Installation]] ([[Videos#Installation Guides|Watch Videos]])
*[[#Videos|All Videos]]
*[[#Work Flows|Work Flows]]
*[[#User Manuals|User Manuals]]
*[[#Office Management|Office Management]]
*[[#Service Management|Service Management]]
*[[#Billing|Billing]] ([[Videos#Contracts & Billing|Watch Videos]])
*[[#Import and Export|Import and Export]]
*[[#Customization|Customization]]
*[[#Privileges|Privileges]]
*[[#Integration|Integration]]
*[[#FAQ|FAQ]]
*[[:Category:KB|CommitCRM KB Articles]]

{{Break}}

=Popular Forum Threads=
*[http://www.commitcrm.com/support/version-update/ New CommitCRM 8 Release!]
*[http://www.commitcrm.com/forum/showthread.php?t=1208 Running an IT Services Business Forum ]
*[http://www.commitcrm.com/forum/showthread.php?t=1037 The IT Toolbox – Community Based Resources for IT Professionals]
 

=Recent KB Articles=
*[[KB:_Keeping_Your_Customers_In_Touch_With_You|Keeping Your Customers In Touch With You]]
*[[KB:_Integrating_CommitCRM_Wiki_Search_Into_Your_Browser|Integrating CommitCRM WIki Search Into Your Browser]]
*[[KB:_Web_Interface_Free_Text_Fields|Web Interface Free Text Fields]]
*[[KB:_How_To_Rename_Fields|How To Rename Fields]]
*[[KB:_Setting_up_CommitCRM_with_Terminal_Services|Setting Up CommitCRM with Terminal Services]]
*[[KB:_How_To_Create_Tickets_On_Behalf_of_Your_Customers_Using_Emails|How To Create Tickets On Behalf of Your Customers Using Emails]]
{{Colend}}


==[[Getting_Started|Getting Started]]==

*[[Introduction|Introduction to CommitCRM]]
*[[CommitCRM Installation|Installing CommitCRM]]
*[[Videos#Installation Guides|Installation Videos]]
*[http://www.commitcrm.com/videos/commit_crm_getting_started_tutorial_video.htm Getting Started Tutorial Video]
 

==[[Setup|Setup & Installation]]==
'''Client'''
*[[CommitCRM Installation|Installing CommitCRM]]
*[[Videos#Installation Guides|Installation Videos]]
*[[Accounts | Account Setup]]
*[[Employees | Employee Setup]]
*[[Privileges | Privileges Setup]]
*[[Import and Export]]
*[[QuickBooks Link|CommitCRM-QuickBooks Link]]
*[[Commit-Outlook Sync|CommitCRM-Outlook Sync]]
*[[QuoteWerks_Link|CommitCRM-QuoteWerks Link]]

'''Server'''
*[[CommitCRM Installation|Installing CommitCRM]]
*[[Web Interface|CommitCRM Web Interface]] ([http://www.commitcrm.com/videos/web_interface_installation_video.htm Watch Video])
*[[Email Connector|CommitCRM Email Connector Setup]] ([http://www.commitcrm.com/videos/email_connector_setup_video.htm Watch Video]), [[Ticket_Management#Email_Distribution_via_Commit_Email_Connector|Email Threading via CommitCRM Email Connector]]
*[[Alerts Server|CommitCRM Alerts Server]] ([http://www.commitcrm.com/videos/commit_alert_server_setup_video.htm Watch Video])
*[[Report Scheduler|CommitCRM Report Scheduler]]
*[[MSP_Integration_Setup|RMM/MSP Systems Integration]]
*[[GFI_MAX_Link|GFI MAX Link Setup Guide]]
*[[Continuum_Link|Continuum Link Setup Guide]]
*[[Commit SQL Database Installation Guide | CommitCRM SQL Database (CSD) Installation Guide (for registered CSD users)]]
*[[Commit SQL Database for Trial Users|CommitCRM SQL Database for Trial Users]]

'''Upgrades'''
*[http://www.commitcrm.com/videos/commitcrm_upgrades_video.htm Upgrading CommitCRM Video]
 

==[[Videos|Videos]]==
*[http://www.commitcrm.com/videos/commit_crm_getting_started_tutorial_video.htm Getting Started Tutorial]
*[http://www.commitcrm.com/videos/web_interface_installation_video.htm Web Interface Installation]
*[http://www.commitcrm.com/videos/email_connector_setup_video.htm Email Connector Installation]
*[http://www.commitcrm.com/videos/commit_alert_server_setup_video.htm Alerts Server Installation]
*[[Videos#Ticket_Management|Ticket Management Videos]]
*[[Videos# Contracts & Billing|Billing Videos]]
*'''[[Videos|To All Videos!]]'''
 

==[[Work_Flows|Work Flows]]==
*[[Tickets|Ticket Lifecycle]] ([[Videos#Ticket Management|Watch Videos]])
*[[Ticket Management]] ([[Videos#Ticket Management|Watch Videos]])
*[[Billing Lifecycle]] ([[Videos#Contracts & Billing|Watch Videos]])
*[[Project Management]]
*[[Recurring Contracts]] ([http://www.commitcrm.com/videos/commit_contracts_batch_copy_wizard_video.htm Watch Video])
*[[SLA|Service Level Agreements (SLA)]]
*[[Over-used Hours]]
*[[Rolling-over Hours]]
*[[Asset Warranties]]
*[[Preventive Maintenance]]
*[[Return Material Authorization (RMA)]]
*[[Barcodes and Assets]]
*[[Sales|Sales Management]]
*[[Activity Templates]] ([http://www.commitcrm.com/videos/commit_activity_templates_video.htm Watch Video])
*[[Managing Quotes]]
 

==[[User_Manuals|User Manuals]]==
*[[Billing]] ([[Videos#Contracts & Billing|Watch Videos]])
*[[Assets]]
*[[Sales]]
*[[Accounts]]
*[[Ticket Management]] ([[Videos#Ticket Management|Watch Videos]])
*[[Quotes]]
*[[SLA|Service Level Agreements (SLA)]]
*[[Knowledge Base]]
*[[Activity Templates]] ([http://www.commitcrm.com/videos/commit_activity_templates_video.htm Watch Video])
*[[Email Templates]]
*[[Documents]]
*[[Statistics Board]]
*[[Web Interface|CommitCRM Web Interface]] ([http://www.commitcrm.com/videos/employee_web_interface_tutorial_video.htm Overview Video], [http://www.commitcrm.com/videos/web_interface_installation_video.htm Installation Video])
*[[Generating_Reports_User_Guide|Generating Reports]]
*[[Report_Designer_User_Guide|Report Designer]] ([http://www.commitcrm.com/videos/commit_report_designer_tutorial_video.htm Watch Video])
*[[To-do Lists]]

'''Integration'''
*[[QuickBooks Link|CommitCRM-QuickBooks Link]]
*[[Commit-Outlook Sync|CommitCRM-Outlook Sync]]
*[[Email Connector|CommitCRM Email Connector]] ([http://www.commitcrm.com/videos/email_connector_setup_video.htm Installation Video])
*[[Alerts Server|CommitCRM Alerts Server]] ([http://www.commitcrm.com/videos/commit_alert_server_setup_video.htm Installation Video])
*[[Report Scheduler|CommitCRM Report Scheduler]]
*[[QuoteWerks_Link|CommitCRM-QuoteWerks Link]]
*[[MSP_Integration_Setup|MSP Systems Integration]]
*[[Commit API Developers Guide|CommitCRM API Developers Guide]]

*'''[[Videos|All Video Tutorials]]'''
 

==[[Office_Management|Office Management]]==
*[[Accounts]]
*[[Employees]]
*[[Subcontractors]]
*[[Privileges]]
*[[Documents]]
*[[Documents#Using Word Merge Templates|Word Templates]]
*[[Email Templates]]
*[[Documents#Managing Outlook Emails within CommitCRM|Filing Emails]]
*[[History]]
*[[Commit-Outlook Sync|CommitCRM-Outlook Sync]]
*[[Sales|Sales Management]]
*[[Quotes]]
*[[Statistics Board]]
*[[Reports|Reports]]
 

==[[Service_Management|Service Management]]==
*[[Ticket Management]] ([[Videos#Ticket_Management|Watch Videos]])
*[[Tickets|Ticket Lifecycle]] ([[Videos#Ticket_Management|Watch Videos]])
*[[Tickets#Dispatch the Ticket|Dispatcher]] ([http://www.commitcrm.com/videos/commit_crm_getting_started_tutorial_video.htm Watch Video])
*[[Assets]]
*[[Managing Quotes]]
*[[Activity Templates]] ([http://www.commitcrm.com/videos/commit_activity_templates_video.htm Watch Video])
*[[Email Templates]]
*[[Knowledge Base]]
*[[Billing]] ([[Videos#Contracts & Billing|Watch Videos]])
 

==[[Billing_Topics|Billing]]==
*[[Videos#Contracts_&_Billing|Billing Videos]]
*[[Billing|Billing User Guide]]
*[[Items]]
*[[Charges]]
*[[Charges#Using_the_Timer_to_Add_Charges|Timer]]
*[[Contracts]]
*[[Custom Pricing]]
*[[SLA|Service Level Agreements (SLA)]]
*[[Contract-Price Charges|Billing for Your Contracts]]
*[[Recurring Contracts]]
*[[Charges#Charging Using Taxes|Taxes]]
*[[QuickBooks Link|CommitCRM-QuickBooks Link]]
*[[Charges#Using CommitCRM Charge Reports|Reports]]
 

==[[Import_and_Export|Import and Export]]==
*[[Import Accounts]]
*[[Import Assets]]
*[[Import Items]]
*[[Documents#Importing Existing Documents|Import Documents]]
*[[Knowledge Base#Importing Articles|Import Knowledge Base Articles]]
*[[Importing from QuickBooks]]
*[[Syncing Accounts with Outlook|Import from Outlook (CommitCRM-Outlook Sync)]]
*[[Import and Export FAQ]]
*[[Import_and_Export_FAQ#Can_I_export_data_from_CommitCRM.3F|Export Data]]
*[[Community_Sharing_Center|Community Sharing Center]]
 

==[[Customization|Customization]]==
*[[Field Customization]]
*[[Report Customization]] ([http://www.commitcrm.com/videos/commit_report_designer_tutorial_video.htm Watch Video])
*[[Activity Templates]] ([http://www.commitcrm.com/videos/commit_activity_templates_video.htm Watch Video])
*[[Email Templates]]
*[[Commit API Developers Guide|CommitCRM API Developers Guide]]
*[[Customization FAQ]]
 

==[[Privileges|Privileges]]==
*[[Employee Privileges]]
*[[Subcontractors#Subcontractors_Permissions|Subcontractors Privileges]]
*[[Customer Privileges]]
*[[Privileges_FAQ|Privileges FAQ]]
 

==[[Integration|Integration]]==
*[[QuickBooks Link|CommitCRM-QuickBooks Link]]
*[[Commit-Outlook Sync|CommitCRM-Outlook Sync]]
*[[Commit Online Services|CommitCRM Online Services]]
*[[Commit API Developers Guide|CommitCRM API Developers Guide]]
*[[API by Email and MSP Integration|API by Email]]
*[[API by Email and MSP Integration|Automated Emails]]
*[[QuoteWerks_Link|CommitCRM-QuoteWerks Link]]
*[[Continuum_Link|CommitCRM-Continuum Link]]
*[[GFI_MAX_Link|CommitCRM-GFI MAX Link]]
*[[MSP_Integration_Setup|MSP Systems Integration]] ([[MSP_Integration_Setup#Kaseya.E2.84.A2|Kaseya™ ]], [[MSP_Integration_Setup#Level_Platforms.E2.84.A2_Managed_Workspace.E2.84.A2|Level Platforms™ Managed Workspace™]], [[MSP_Integration_Setup#N-able.E2.84.A2_N-central.E2.84.A2|N-able™ N-central™]])
*[[Documents#Importing Existing Documents|Import and Export (Excel, CSV, etc.)]]
*[[Documents#Using Word Merge Templates|Word Templates]]
 

==[[FAQ|FAQ]]==
*[[Tickets FAQ|Tickets]]
*[[Contracts FAQ|Contracts]]
*[[Dispatcher & Calendar FAQ|Dispatcher & Calendar]]
*[[Charges FAQ|Charges]]
*[[Items FAQ|Items]]
*[[Reports FAQ|Reports]]
*[[Import and Export FAQ|Import & Export]]
*[[QuickBooks FAQ|QuickBooks]]
*[[Web Interface FAQ|Web Interface]]
*[[Outlook Integration FAQ|Outlook Integration]]
*[[Alerts Server FAQ|Alerts Server]]
*[[Email Connector FAQ|Email Connector]]
*[[Employees & Users FAQ|Employees & Users]]
*[[Documents FAQ|Documents]]
*[[Accounts FAQ|Accounts]]
*[[Assets FAQ|Assets]]
*[[Knowledge Base FAQ|Knowledge Base]]
*[[Activity Templates FAQ|Activity Templates]]
*[[Online Services FAQ|Online Services]]
*[[Customization FAQ|Customization]]
*[[Backup and Restore FAQ|Backup & Restore]]
*[[Global Settings FAQ|Global Settings]]
*[[Labor Rates FAQ|Labor Rates]]
*[[History FAQ|History]]
*[[Privileges FAQ|Privileges]]
*[[Messages FAQ|Messages]]
*[[Taxes FAQ|Taxes]]
 

__NOTOC__

MediaWiki:Sidebar

2014-08-15T18:41:19Z

CmtWikiAdminSysop:

MediaWiki:Sidebar

2014-08-15T18:38:35Z

CmtWikiAdminSysop:

MediaWiki:Sidebar

2014-08-15T18:37:31Z

CmtWikiAdminSysop:

* Navigation
** mainpage | Wiki Home
**http://www.commitcrm.com/ | CommitCRM.com Home
**http://www.commitcrm.com/tour/ | Product Tour
**http://www.commitcrm.com/free-trial/ | Free Trial
**http://www.commitcrm.com/forum | Forums

*Getting Started
**Introduction | Introduction
**CommitCRM Installation | Installing CommitCRM
**http://www.commitcrm.com/videos/commit_crm_getting_started_tutorial_video.htm | Getting Started Tutorial
**Videos | Videos

*Documentation
**Setup | Setup
**Videos | Videos
**Work Flows | Work Flows
**User Manuals | User Manuals
**Office Management | Office Management
**Service Management | Service Management
**Billing Topics|Billing
**Import and Export | Import and Export
**Customization | Customization
**Integration | Integration
**Category:KB | Commit KB Articles
**FAQ | FAQ
**Troubleshooting | Troubleshooting

*Tools
**https://www.commitcrm.com/wiki/Special:Upload | Upload file
**https://www.commitcrm.com/w/index.php?title={{PAGENAME}}&printable=yes | Printable version

MediaWiki:Sidebar

2014-08-15T18:37:11Z

CmtWikiAdminSysop:

* Navigation
** mainpage | Wiki Home
**http://www.commitcrm.com/ | CommitCRM.com Homepage
**http://www.commitcrm.com/tour/ | Product Tour
**http://www.commitcrm.com/free-trial/ | Free Trial
**http://www.commitcrm.com/forum | Forums

*Getting Started
**Introduction | Introduction
**CommitCRM Installation | Installing CommitCRM
**http://www.commitcrm.com/videos/commit_crm_getting_started_tutorial_video.htm | Getting Started Tutorial
**Videos | Videos

*Documentation
**Setup | Setup
**Videos | Videos
**Work Flows | Work Flows
**User Manuals | User Manuals
**Office Management | Office Management
**Service Management | Service Management
**Billing Topics|Billing
**Import and Export | Import and Export
**Customization | Customization
**Integration | Integration
**Category:KB | Commit KB Articles
**FAQ | FAQ
**Troubleshooting | Troubleshooting

*Tools
**https://www.commitcrm.com/wiki/Special:Upload | Upload file
**https://www.commitcrm.com/w/index.php?title={{PAGENAME}}&printable=yes | Printable version

MediaWiki:Sidebar

2014-08-15T18:35:39Z

CmtWikiAdminSysop:

* Navigation
** mainpage | Wiki Home
**http://www.commitcrm.com/tour/ | Product Tour
**http://www.commitcrm.com/free-trial/ | Free Trial
**http://www.commitcrm.com/forum | Forums

*Getting Started
**Introduction | Introduction
**CommitCRM Installation | Installing CommitCRM
**http://www.commitcrm.com/videos/commit_crm_getting_started_tutorial_video.htm | Getting Started Tutorial
**Videos | Videos

*Documentation
**Setup | Setup
**Videos | Videos
**Work Flows | Work Flows
**User Manuals | User Manuals
**Office Management | Office Management
**Service Management | Service Management
**Billing Topics|Billing
**Import and Export | Import and Export
**Customization | Customization
**Integration | Integration
**Category:KB | Commit KB Articles
**FAQ | FAQ
**Troubleshooting | Troubleshooting

*Tools
**https://www.commitcrm.com/wiki/Special:Upload | Upload file
**https://www.commitcrm.com/w/index.php?title={{PAGENAME}}&printable=yes | Printable version

MediaWiki:Common.css

2014-08-13T09:38:45Z

CmtWikiAdminSysop:

/* CSS placed here will be applied to all skins */
/* wikitable/prettytable class for skinning normal tables */
table.wikitable,
table.prettytable {
margin: 1em 1em 1em 0;
background: #f9f9f9;
border: 1px #aaa solid;
border-collapse: collapse;
}
.wikitable th, .wikitable td,
.prettytable th, .prettytable td {
border: 1px #aaa solid;
padding: 0.2em;
}
.wikitable th,
.prettytable th {
background: #f2f2f2;
text-align: center;
}
.wikitable caption,
.prettytable caption {
font-weight: bold;
}

/* MP: Hiding the discussion, read, view history, view source tabs from the top to annon users */
/* Enabled for logged in users in https://www.commitcrm.com/wiki/MediaWiki:Group-user.css */
#ca-talk { display:none!important; }
#ca-history { display:none!important; }
#ca-view { display:none!important; }
#ca-viewsource { display:none!important; }

MediaWiki:Common.css

2014-08-13T09:38:12Z

CmtWikiAdminSysop:

MediaWiki:Group-user.css

2014-08-13T09:36:40Z

CmtWikiAdminSysop:

/* CSS placed here will affect registered users only */

/* MP: Showing the discussion, read, view history, view source, tabs from the top to logged in users*/
/* Disabled for annon users in https://www.commitcrm.com/wiki/MediaWiki:Common.css */
#ca-talk { display:block!important; }
#ca-history { display:block!important; }
#ca-view { display:block!important; }
#ca-viewsource { display:block!important; }

MediaWiki:Common.css

2014-08-13T09:34:42Z

CmtWikiAdminSysop:

MediaWiki:Group-user.css

2014-08-13T09:31:43Z

CmtWikiAdminSysop:

/* CSS placed here will affect registered users only */

/* MP: Showing the discuss, history, tabs to logged in users*/
/* Disabled for annon users in https://www.commitcrm.com/wiki/MediaWiki:Common.css */
#ca-talk { display:block!important; }
#ca-history { display:block!important; }
#ca-viewsource { display:block!important; }

MediaWiki:Common.css

2014-08-13T09:29:12Z

CmtWikiAdminSysop:

/* CSS placed here will be applied to all skins */
/* wikitable/prettytable class for skinning normal tables */
table.wikitable,
table.prettytable {
margin: 1em 1em 1em 0;
background: #f9f9f9;
border: 1px #aaa solid;
border-collapse: collapse;
}
.wikitable th, .wikitable td,
.prettytable th, .prettytable td {
border: 1px #aaa solid;
padding: 0.2em;
}
.wikitable th,
.prettytable th {
background: #f2f2f2;
text-align: center;
}
.wikitable caption,
.prettytable caption {
font-weight: bold;
}

/* MP: Hiding the discuss, history, view source tabs to annon users */
/* Enabled for logged in users in https://www.commitcrm.com/wiki/MediaWiki:Group-user.css */
#ca-talk { display:none!important; }
#ca-history { display:none!important; }
#ca-viewsource { display:none!important; }

MediaWiki:Group-user.css

2014-08-13T09:26:21Z

CmtWikiAdminSysop: Created page with "/* CSS placed here will affect registered users only */ /* MP: Showing the discuss, history, tabs to logged in users*/ #ca-talk { display:block!important; } #ca-history { dis..."

/* CSS placed here will affect registered users only */

/* MP: Showing the discuss, history, tabs to logged in users*/
#ca-talk { display:block!important; }
#ca-history { display:block!important; }

MediaWiki:Common.css

2014-08-13T09:23:52Z

CmtWikiAdminSysop:

MediaWiki:Common.css

2014-08-13T09:05:53Z

CmtWikiAdminSysop:

MediaWiki:Common.css

2014-08-13T09:04:58Z

CmtWikiAdminSysop:

/* CSS placed here will be applied to all skins */
/* wikitable/prettytable class for skinning normal tables */
table.wikitable,
table.prettytable {
margin: 1em 1em 1em 0;
background: #f9f9f9;
border: 1px #aaa solid;
border-collapse: collapse;
}
.wikitable th, .wikitable td,
.prettytable th, .prettytable td {
border: 1px #aaa solid;
padding: 0.2em;
}
.wikitable th,
.prettytable th {
background: #f2f2f2;
text-align: center;
}
.wikitable caption,
.prettytable caption {
font-weight: bold;
}


<?php global $wgUser; if( $wgUser->isAnon() ) { ?>
<style type="text/css">
#ca-viewsource { display: none !important; }
</style>
<?php } ?>

MediaWiki:Sidebar

2014-02-07T14:07:52Z

CmtWikiAdminSysop:

* Navigation
** mainpage | Wiki Home
**http://www.commitcrm.com/forum | Forums
**http://www.commitcrm.com/tour/ | Product Tour

*SEARCH

*Getting Started
**Introduction | Introduction
**CommitCRM Installation | Installing CommitCRM
**http://www.commitcrm.com/videos/commit_crm_getting_started_tutorial_video.htm | Getting Started Tutorial
**Videos | Videos

*Documentation
**Setup | Setup
**Videos | Videos
**Work Flows | Work Flows
**User Manuals | User Manuals
**Office Management | Office Management
**Service Management | Service Management
**Billing Topics|Billing
**Import and Export | Import and Export
**Customization | Customization
**Integration | Integration
**Category:KB | Commit KB Articles
**FAQ | FAQ
**Troubleshooting | Troubleshooting

*Tools
**https://www.commitcrm.com/wiki/Special:Upload | Upload file
**https://www.commitcrm.com/w/index.php?title={{PAGENAME}}&printable=yes | Printable version

RangerMSP Wiki - PSA software for MSPs and IT services providers:About

2014-01-26T12:07:41Z

CmtWikiAdminSysop: Created page with '=== CommitCRM Wiki About === Copyright ©, Commit Business Solutions Limited - All Rights Reserved. Commit and CommitCRM are trademarks of Commit Business Solutions Limited. * […'

=== CommitCRM Wiki About ===
Copyright ©, Commit Business Solutions Limited - All Rights Reserved.
Commit and CommitCRM are trademarks of Commit Business Solutions Limited.

* [http://www.commitcrm.com/about-us/about-commitcrm/ Click here] to visit the About CommitCRM page.

__NOTOC__

RangerMSP Wiki - PSA software for MSPs and IT services providers:Privacy policy

2014-01-26T12:04:09Z

CmtWikiAdminSysop:

=== Privacy Policy, Legal Terms, Notices and Disclaimer ===
* [http://www.commitcrm.com/legal-terms-and-notices/ Click here] for details.

__NOTOC__

RangerMSP Wiki - PSA software for MSPs and IT services providers:General disclaimer

2014-01-26T12:03:02Z

CmtWikiAdminSysop: Created page with '=== Disclaimer, Privacy Policy, Legal Terms and Notices === * [http://www.commitcrm.com/legal-terms-and-notices/ Click here] for details. __NOTOC__'

=== Disclaimer, Privacy Policy, Legal Terms and Notices ===
* [http://www.commitcrm.com/legal-terms-and-notices/ Click here] for details.

__NOTOC__

RangerMSP Wiki - PSA software for MSPs and IT services providers:Privacy policy

2013-08-28T14:07:43Z

CmtWikiAdminSysop: Replaced content with '=== Privacy Policy, Legal Terms and Notices === * [http://www.commitcrm.com/legalterms.htm Click here] for details. __NOTOC__'

=== Privacy Policy, Legal Terms and Notices ===
* [http://www.commitcrm.com/legalterms.htm Click here] for details.

__NOTOC__

RangerMSP Wiki - PSA software for MSPs and IT services providers:Privacy policy

2013-08-28T13:54:10Z

CmtWikiAdminSysop:

Your privacy, and the privacy of all users of commitcrm.com, is important to us. Accordingly, we have adopted the following privacy policy. Our policy is based on the principles of notice, access and security in the collection and use of all information regarding our users and their activities at our site.

===Notice===

This policy tells you, among other things, what information we gather from you and how we may use or disclose that information and our efforts to protect it. Please read this policy carefully, and feel free to contact us at info@commitcrm.com if you have any questions regarding its contents. We may change this policy at any time to correct technical or typographical errors, to increase your rights and protections or to comply with laws. We keep the right of changing this policy in at any time and without notification.

=== Types of Information Collected ===

In connection with your use of our site, we ask for and may collect a variety of information from and about you in different ways. These will not specifically identify the User. The information will be used internally. If the User provides unique identifying information, such as name, address and other information on forms stored on this Site, such information will be used only by us and will not be published for general access. We, however, assumes no responsibility for the security of this information.

=== Use of Cookies ===

Use of our site may require that you accept the use of cookies, which are small data files that our Web site sends to your browser for storage on your computer’s hard drive. We use cookies to protect confidential data, track activity at our site and better serve your needs and interests.

=== Disclosure of Information ===

We may disclose information to fulfill certain legal and regulatory requirements or if we believe, in good faith, that such disclosure is legally required or necessary to protect other’s rights or to prevent harm.

=== Security ===

Please remember that you play a valuable part in security as well. Your password to access our site, which you select at registration, should never be shared with anyone and should be changed frequently. And, after you have finished using our site, you should log off and exit your browser so no unauthorized persons can use our site with your name and account information. Remember that any information you voluntarily disclose on-line in any news or message postings, discussion groups or chat rooms may be collected and used by others without your permission. Furthermore, if you provide any information to parties who operate Web sites that are linked to or from our site, different rules may apply to their collection, use or disclosure of your personal information. We encourage you to review these site's policies before revealing any sensitive or personal information.

Regardless of the precautions taken by you or by us, "perfect security" does not exist on the Internet. We cannot ensure or warrant the security of any information you transmit to us, and you transmit such information at your own risk.

=== Legal Terms and Notices ===
* [http://www.commitcrm.com/legalterms.htm Click here] for Legal Terms and Notices.

__NOTOC__

Main Page

2013-08-16T11:55:47Z

CmtWikiAdminSysop: /* Popular Forum Threads */

{| id="mp-topbanner" style="width:100%; background:#ffffff; margin-top:1.2em; border:1px solid Silver;"
| style="width:56%; color:#000;" |

{| style="width:280px; border:none; background:#ffffff; margin-left:28%"
| style="width:280px; text-align:center; white-space:nowrap; color:#000;" |
<div style="font-size:180%; border:none; margin:0; padding:.1em; color:#000;">Welcome to the CommitCRM Wiki</div>
<div style="top:+0.2em; font-size:120%;">CommitCRM Support Documentation Center.</div>

|}

| style="width:16%; font-size:95%;" |
* [http://www.commitcrm.com/download.php Download CommitCRM]
* [http://www.commitcrm.com/forum/ Forums]
* [http://www.commitcrm.com/why_commitcrm.htm Why CommitCRM?]
* [http://www.commitcrm.com/aboutus.htm About Commit]
|}

{{Col}}
 
=New to CommitCRM?=

*[[Introduction|Introduction to CommitCRM]]
*[[Getting Started|Getting Started]] ([http://www.commitcrm.com/videos/commit_crm_getting_started_tutorial_video.htm Watch Video])
*[[#Setup & Installation|Setup & Installation]] ([[Videos#Installation Guides|Watch Videos]])
*[[Videos|All Videos]]
*[[FAQ]]

 

=Documentation=
*[[#Getting Started|Getting Started]] ([http://www.commitcrm.com/videos/commit_crm_getting_started_tutorial_video.htm Watch Video])
*[[#Setup & Installation|Setup & Installation]] ([[Videos#Installation Guides|Watch Videos]])
*[[#Videos|All Videos]]
*[[#Work Flows|Work Flows]]
*[[#User Manuals|User Manuals]]
*[[#Office Management|Office Management]]
*[[#Service Management|Service Management]]
*[[#Billing|Billing]] ([[Videos#Contracts & Billing|Watch Videos]])
*[[#Import and Export|Import and Export]]
*[[#Customization|Customization]]
*[[#Privileges|Privileges]]
*[[#Integration|Integration]]
*[[#FAQ|FAQ]]
*[[:Category:KB|CommitCRM KB Articles]]

{{Break}}

=Popular Forum Threads=
*[http://www.commitcrm.com/commit_versions.htm New CommitCRM 6.2 Release!]
*[http://www.commitcrm.com/forum/showthread.php?t=1208 Running an IT Services Business Forum ]
*[http://www.commitcrm.com/forum/showthread.php?t=1037 The IT Toolbox – Community Based Resources for IT Professionals]
 

=Recent KB Articles=
*[[KB:_Keeping_Your_Customers_In_Touch_With_You|Keeping Your Customers In Touch With You]]
*[[KB:_Integrating_CommitCRM_Wiki_Search_Into_Your_Browser|Integrating CommitCRM WIki Search Into Your Browser]]
*[[KB:_Web_Interface_Free_Text_Fields|Web Interface Free Text Fields]]
*[[KB:_How_To_Rename_Fields|How To Rename Fields]]
*[[KB:_Setting_up_CommitCRM_with_Terminal_Services|Setting Up CommitCRM with Terminal Services]]
*[[KB:_How_To_Create_Tickets_On_Behalf_of_Your_Customers_Using_Emails|How To Create Tickets On Behalf of Your Customers Using Emails]]
{{Colend}}


==[[Getting_Started|Getting Started]]==

*[[Introduction|Introduction to CommitCRM]]
*[[CommitCRM Installation|Installing CommitCRM]]
*[[Videos#Installation Guides|Installation Videos]]
*[http://www.commitcrm.com/videos/commit_crm_getting_started_tutorial_video.htm Getting Started Tutorial Video]
 

==[[Setup|Setup & Installation]]==
'''Client'''
*[[CommitCRM Installation|Installing CommitCRM]]
*[[Videos#Installation Guides|Installation Videos]]
*[[Accounts | Account Setup]]
*[[Employees | Employee Setup]]
*[[Privileges | Privileges Setup]]
*[[Import and Export]]
*[[QuickBooks Link|CommitCRM-QuickBooks Link]]
*[[Commit-Outlook Sync|CommitCRM-Outlook Sync]]
*[[QuoteWerks_Link|CommitCRM-QuoteWerks Link]]

'''Server'''
*[[CommitCRM Installation|Installing CommitCRM]]
*[[Web Interface|CommitCRM Web Interface]] ([http://www.commitcrm.com/videos/web_interface_installation_video.htm Watch Video])
*[[Email Connector|CommitCRM Email Connector Setup]] ([http://www.commitcrm.com/videos/email_connector_setup_video.htm Watch Video]), [[Ticket_Management#Email_Distribution_via_Commit_Email_Connector|Email Threading via CommitCRM Email Connector]]
*[[Alerts Server|CommitCRM Alerts Server]] ([http://www.commitcrm.com/videos/commit_alert_server_setup_video.htm Watch Video])
*[[MSP_Integration_Setup|RMM/MSP Systems Integration]]
*[[GFI_MAX_Link|GFI MAX Link Setup Guide]]
*[[Zenith_Link|Zenith Link Setup Guide]]
*[[Commit SQL Database Installation Guide | CommitCRM SQL Database (CSD) Installation Guide (for registered CSD users)]]
*[[Commit SQL Database for Trial Users|CommitCRM SQL Database for Trial Users]]

'''Upgrades'''
*[http://www.commitcrm.com/videos/commitcrm_upgrades_video.htm Upgrading CommitCRM Video]
 

==[[Videos|Videos]]==
*[http://www.commitcrm.com/videos/commit_crm_getting_started_tutorial_video.htm Getting Started Tutorial]
*[http://www.commitcrm.com/videos/web_interface_installation_video.htm Web Interface Installation]
*[http://www.commitcrm.com/videos/email_connector_setup_video.htm Email Connector Installation]
*[http://www.commitcrm.com/videos/commit_alert_server_setup_video.htm Alerts Server Installation]
*[[Videos#Ticket_Management|Ticket Management Videos]]
*[[Videos# Contracts & Billing|Billing Videos]]
*'''[[Videos|To All Videos!]]'''
 

==[[Work_Flows|Work Flows]]==
*[[Tickets|Ticket Lifecycle]] ([[Videos#Ticket Management|Watch Videos]])
*[[Ticket Management]] ([[Videos#Ticket Management|Watch Videos]])
*[[Billing Lifecycle]] ([[Videos#Contracts & Billing|Watch Videos]])
*[[Project Management]]
*[[Recurring Contracts]] ([http://www.commitcrm.com/videos/commit_contracts_batch_copy_wizard_video.htm Watch Video])
*[[SLA|Service Level Agreements (SLA)]]
*[[Over-used Hours]]
*[[Rolling-over Hours]]
*[[Asset Warranties]]
*[[Preventive Maintenance]]
*[[Return Material Authorization (RMA)]]
*[[Barcodes and Assets]]
*[[Sales|Sales Management]]
*[[Activity Templates]] ([http://www.commitcrm.com/videos/commit_activity_templates_video.htm Watch Video])
*[[Managing Quotes]]
 

==[[User_Manuals|User Manuals]]==
*[[Billing]] ([[Videos#Contracts & Billing|Watch Videos]])
*[[Assets]]
*[[Sales]]
*[[Accounts]]
*[[Ticket Management]] ([[Videos#Ticket Management|Watch Videos]])
*[[Quotes]]
*[[SLA|Service Level Agreements (SLA)]]
*[[Knowledge Base]]
*[[Activity Templates]] ([http://www.commitcrm.com/videos/commit_activity_templates_video.htm Watch Video])
*[[Email Templates]]
*[[Documents]]
*[[Statistics Board]]
*[[Web Interface|CommitCRM Web Interface]] ([http://www.commitcrm.com/videos/employee_web_interface_tutorial_video.htm Overview Video], [http://www.commitcrm.com/videos/web_interface_installation_video.htm Installation Video])
*[[Generating_Reports_User_Guide|Generating Reports]]
*[[Report_Designer_User_Guide|Report Designer]] ([http://www.commitcrm.com/videos/commit_report_designer_tutorial_video.htm Watch Video])
'''Integration'''
*[[QuickBooks Link|CommitCRM-QuickBooks Link]]
*[[Commit-Outlook Sync|CommitCRM-Outlook Sync]]
*[[Email Connector|CommitCRM Email Connector]] ([http://www.commitcrm.com/videos/email_connector_setup_video.htm Installation Video])
*[[Alerts Server|CommitCRM Alerts Server]] ([http://www.commitcrm.com/videos/commit_alert_server_setup_video.htm Installation Video])
*[[QuoteWerks_Link|CommitCRM-QuoteWerks Link]]
*[[MSP_Integration_Setup|MSP Systems Integration]]
*[[Commit API Developers Guide|CommitCRM API Developers Guide]]

*'''[[Videos|All Video Tutorials]]'''
 

==[[Office_Management|Office Management]]==
*[[Accounts]]
*[[Employees]]
*[[Subcontractors]]
*[[Privileges]]
*[[Documents]]
*[[Documents#Using Word Merge Templates|Word Templates]]
*[[Email Templates]]
*[[Documents#Managing Outlook Emails within CommitCRM|Filing Emails]]
*[[History]]
*[[Commit-Outlook Sync|CommitCRM-Outlook Sync]]
*[[Sales|Sales Management]]
*[[Quotes]]
*[[Statistics Board]]
*[[Reports|Reports]]
 

==[[Service_Management|Service Management]]==
*[[Ticket Management]] ([[Videos#Ticket_Management|Watch Videos]])
*[[Tickets|Ticket Lifecycle]] ([[Videos#Ticket_Management|Watch Videos]])
*[[Tickets#Dispatch the Ticket|Dispatcher]] ([http://www.commitcrm.com/videos/commit_crm_getting_started_tutorial_video.htm Watch Video])
*[[Assets]]
*[[Managing Quotes]]
*[[Activity Templates]] ([http://www.commitcrm.com/videos/commit_activity_templates_video.htm Watch Video])
*[[Email Templates]]
*[[Knowledge Base]]
*[[Billing]] ([[Videos#Contracts & Billing|Watch Videos]])
 

==[[Billing_Topics|Billing]]==
*[[Videos#Contracts_&_Billing|Billing Videos]]
*[[Billing|Billing User Guide]]
*[[Items]]
*[[Charges]]
*[[Charges#Using_the_Timer_to_Add_Charges|Timer]]
*[[Contracts]]
*[[Custom Pricing]]
*[[SLA|Service Level Agreements (SLA)]]
*[[Contract-Price Charges|Billing for Your Contracts]]
*[[Recurring Contracts]]
*[[Charges#Charging Using Taxes|Taxes]]
*[[QuickBooks Link|CommitCRM-QuickBooks Link]]
*[[Charges#Using CommitCRM Charge Reports|Reports]]
 

==[[Import_and_Export|Import and Export]]==
*[[Import Accounts]]
*[[Import Assets]]
*[[Import Items]]
*[[Documents#Importing Existing Documents|Import Documents]]
*[[Knowledge Base#Importing Articles|Import Knowledge Base Articles]]
*[[Importing from QuickBooks]]
*[[Syncing Accounts with Outlook|Import from Outlook (CommitCRM-Outlook Sync)]]
*[[Import and Export FAQ]]
*[[Import_and_Export_FAQ#Can_I_export_data_from_CommitCRM.3F|Export Data]]
*[[Community_Sharing_Center|Community Sharing Center]]
 

==[[Customization|Customization]]==
*[[Field Customization]]
*[[Report Customization]] ([http://www.commitcrm.com/videos/commit_report_designer_tutorial_video.htm Watch Video])
*[[Activity Templates]] ([http://www.commitcrm.com/videos/commit_activity_templates_video.htm Watch Video])
*[[Email Templates]]
*[[Commit API Developers Guide|CommitCRM API Developers Guide]]
*[[Customization FAQ]]
 

==[[Privileges|Privileges]]==
*[[Employee Privileges]]
*[[Subcontractors#Subcontractors_Permissions|Subcontractors Privileges]]
*[[Customer Privileges]]
*[[Privileges_FAQ|Privileges FAQ]]
 

==[[Integration|Integration]]==
*[[QuickBooks Link|CommitCRM-QuickBooks Link]]
*[[Commit-Outlook Sync|CommitCRM-Outlook Sync]]
*[[Commit Online Services|CommitCRM Online Services]]
*[[Commit API Developers Guide|CommitCRM API Developers Guide]]
*[[API by Email and MSP Integration|API by Email]]
*[[API by Email and MSP Integration|Automated Emails]]
*[[QuoteWerks_Link|CommitCRM-QuoteWerks Link]]
*[[Zenith_Link|CommitCRM-Zenith Link]]
*[[GFI_MAX_Link|CommitCRM-GFI MAX Link]]
*[[MSP_Integration_Setup|MSP Systems Integration]] ([[MSP_Integration_Setup#Kaseya.E2.84.A2|Kaseya™ ]], [[MSP_Integration_Setup#LabTech.E2.84.A2|LabTech™]], [[MSP_Integration_Setup#Level_Platforms.E2.84.A2_Managed_Workspace.E2.84.A2|Level Platforms™ Managed Workspace™]], [[MSP_Integration_Setup#N-able.E2.84.A2_N-central.E2.84.A2|N-able™ N-central™]])
*[[Documents#Importing Existing Documents|Import and Export (Excel, CSV, etc.)]]
*[[Documents#Using Word Merge Templates|Word Templates]]
 

==[[FAQ|FAQ]]==
*[[Tickets FAQ|Tickets]]
*[[Contracts FAQ|Contracts]]
*[[Dispatcher & Calendar FAQ|Dispatcher & Calendar]]
*[[Charges FAQ|Charges]]
*[[Items FAQ|Items]]
*[[Reports FAQ|Reports]]
*[[Import and Export FAQ|Import & Export]]
*[[QuickBooks FAQ|QuickBooks]]
*[[Web Interface FAQ|Web Interface]]
*[[Outlook Integration FAQ|Outlook Integration]]
*[[Alerts Server FAQ|Alerts Server]]
*[[Email Connector FAQ|Email Connector]]
*[[Employees & Users FAQ|Employees & Users]]
*[[Documents FAQ|Documents]]
*[[Accounts FAQ|Accounts]]
*[[Assets FAQ|Assets]]
*[[Knowledge Base FAQ|Knowledge Base]]
*[[Activity Templates FAQ|Activity Templates]]
*[[Online Services FAQ|Online Services]]
*[[Customization FAQ|Customization]]
*[[Backup and Restore FAQ|Backup & Restore]]
*[[Global Settings FAQ|Global Settings]]
*[[Labor Rates FAQ|Labor Rates]]
*[[History FAQ|History]]
*[[Privileges FAQ|Privileges]]
*[[Messages FAQ|Messages]]
*[[Taxes FAQ|Taxes]]
 

__NOTOC__

KB: Database Errors, Indexing Errors

2011-09-02T11:52:56Z

CmtWikiAdminSysop: /* Resolution */

=Description=
Sometimes the database indexes that govern search results from the database can be corrupted for several reasons, causing inconsistent behavior when searching or loading specifically affected parts of the database. This behavior can be corrected by rebuilding your database indexes so that the data can be reassessed and properly tagged by the index files. This process is considered safe to run in order to correct suspected database indexing errors. It may also be a good practise to run it once every several months in order to make sure that the indexes are in order and up to date. In some cases, reindexes your database may also increase the overall system performance.

 

=Resolution=
'''Please run the CommitCRM Backup Utility prior to Rebuilding the Database Indexes'''

To run the rebuild indexes, please follow these instructions: (Make sure you're using CommitCRM 5.0 and above)

# Close CommitCRM client on all PCs
# Stop CommitCRM services if installed and used (CommitWebInterface, CommitServer and CommitRMMServer services).
# Stop any third-party services or programs that access CommitCRM database.
# Leave the Advantage Service running if you are using the CSD.
# Backup the <server>\Commit\Db and <server>\Commit\DbSys folders (use a standard zip/archive utility for this (such as Winzip), and/or, also copy the folder to a backup folder.
# [http://www.commitcrm.com/downloads/commit-rebuild-indexes-v5x.exe Click here] to download a Rebuild Indexes program => '''Save it in folder <server>\Commit\Utils'''
# Run the downloaded program and have it rebuild the indexes

----
Check to see if the problem has been resolved.

If the issue persists, we will need some more information in order for us to investigate:

----
:* Send us the log files via '''Help > Technical Support'''.

We'll analyze the logs, get you the support needed to fix this issue.

[[Category:KB|Database]]

VB.NET API

2011-02-16T15:33:11Z

CmtWikiAdminSysop: /* Getting Started */

= Disclaimer =

This documentation refers to CommitCRM 5.6 or later version and assumes CommitCRM is installed and accessible on the local computer.

= Introduction =

This document will show you how to use the CommitCRM VB.NET API library in order to programmatically connect to your CommitCRM server and query or manipulate the CommitCRM database.

= System Requirements =

* CommitCRM 5.6 or later.
* Visual Basic .NET 2008 or Visual Basic .NET 2010.
* CommitLib.dll (the CommitCRM VB.NET compiled library).

= Getting Started =

After you create your VB.NET project, you'll need to add a reference to the '''CommitLib.dll''' file, in order to have access to the CommitCRM library classes.

Each application using the library will have to initialize on startup the '''CommitCRM.Application''' object and terminate it on exit.
Initialization method requires that you pass an object instance of '''CommitCRM.Config''' class configured with the following settings:

* '''AppName'''
: This is free text, preferably the name of your application.

* '''CommitDllFolder'''
: 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 'C:\Commit\ThirdParty\UserDev'.
: '''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'''
: Path to the CommitCRM database, default is 'C:\Commit\db'.

Assuming these default values, we can configure the '''CommitCRM.Config''' object like this:


Dim config As New CommitCRM.Config
config.AppName = "VB.NET Demo"
config.CommitDllFolder = "C:\Commit\ThirdParty\UserDev"
config.CommitDbFolder = "C:\Commit\db"


You should of course check where these paths are exactly on your disk and modify these values accordingly.

Now we can initialize the '''CommitCRM.Application''' object with these settings:


CommitCRM.Application.Initialize(config)


If anything goes wrong, the above line will throw an exception of the '''CommitCRM.Exception''' class.
To prevent unexpected termination of the program execution, we recommend having any call to the CommitCRM library enclosed in a '''Try/Catch''' block.

Before exit, we terminate the '''CommitCRM.Application''' object:


CommitCRM.Application.Terminate()


The most basic VB.NET application that just connects to CommitCRM and terminates could look something like this:


Try
Dim config As New CommitCRM.Config
config.AppName = "VB.NET Demo"
config.CommitDllFolder = "C:\Commit\ThirdParty\UserDev"
config.CommitDbFolder = "C:\Commit\db"

CommitCRM.Application.Initialize(config)

'At this point we have successfully initialized the CommitCRM.Application
'and can start using the other library classes
Catch ex As Exception
Console.Out.Write(ex.Message)
Finally
CommitCRM.Application.Terminate()
End Try


Now that we have confirmed the connectivity to the CommitCRM server (if the above code successfully runs),
we can continue adding more functionality to the example.

The library exposes as VB.NET classes the same CommitCRM objects (Account, Ticket etc.) available through the native CommitCRM API and you can refer to the
[[API_Reference_Manual|API_Reference_Manual]] for reference.

With any of these objects you can:

* Search/query for objects with '''CommitCRM.ObjectQuery''' that satisfy certain criteria
* Read/display the properties of the retrieved objects
* Update/save the properties of the retrieved objects
* Create/save new objects

Now let's see how we can search for '''CommitCRM.Account''' objects.
We instantiate an object of the '''CommitCRM.ObjectQuery''' class and pass '''CommitCRM.Account''' class as generics parameter.


Dim accountSearch As New CommitCRM.ObjectQuery(Of CommitCRM.Account)


'''CommitCRM.ObjectQuery''' class can accept any of the CommitCRM objects in this parameter, but we want to search for accounts now.

Next, we need to set criteria (or more than one) we want to search for:

accountSearch.AddCriteria("FLDCRDCITY", CommitCRM.OperatorEnum.opEqual, "New York")


The first parameter to the '''AddCriteria''' method is the field name we want to look in. Refer to [[API_Reference_Manual#Account_Fields|Account_Fields]]
for a complete list of the available fields for the '''CommitCRM.Account''' class.

The second parameter is a compare operator. We here use the '''CommitCRM.OperatorEnum.opEqual''' to get only exact matches.
In order to get a broader match in the results you can use '''CommitCRM.OperatorEnum.opLike''' operator.

The third parameter is the value we want to find. Prepending and/or appending % (percent) sign at the beginning and/or at the end while using '''CommitCRM.OperatorEnum.opLike''' operator,
will match the phrase even if in the middle of a sentence.

Now we can execute the search and retrieve the '''CommitCRM.Account''' objects (if any):


Dim accounts As List(Of CommitCRM.Account) = accountSearch.FetchObjects()


The above line will populate the List ('''System.Collections.Generic.List''') with all '''CommitCRM.Account''' objects that were found.
Now we can use '''For Each - Next''' statement to iterate through the accounts:


For Each account In accounts
Console.Out.Write(account.CompanyName + vbCrLf)
Next


Or we can manipulate these accounts:


For Each account In accounts
If account.Zip.Length = 0 Then
account.Zip = "10001"
account.Save()
End If
Next


We invoke the '''CommitCRM.Account's''' Save method on both new or existing accounts. For a new account, invoking the Save method would insert a new account in the CommitCRM database.
For an existing account, invoking the Save method would update the fields we modified in the existing account. This rule applies to all CommitCRM objects.

Or we can add a new ticket for each of the accounts:


For Each account In accounts
Dim ticket As New CommitCRM.Ticket
ticket.AccountREC_ID = account.AccountREC_ID
ticket.Description = "Sample ticket for a NewYork account"
ticket.Save()
Next


Each of the CommitCRM library objects have a set of properties that are exposed as VB.NET properties that you can directly manipulate or read from.
You already saw few examples of these properties in the above examples, as: '''account.Zip''' or '''ticket.Description'''. This is the prefered and more intuitive way of accessing the CommitCRM fields.
However, there is also another way of achieving the same results, by invoking '''GetFieldValue''' and '''SetFieldValue''' and specifying the internal field name.

Here is an equivalent of the above example that uses these two generic methods, instead of the object's properties:


For Each account In accounts
Dim ticket As New CommitCRM.Ticket
ticket.SetFieldValue("FLDTKTCARDID", account.GetFieldValue("FLDCRDRECID"))
ticket.SetFieldValue("FLDTKTPROBLEM", "Sample ticket for a NewYork account")
ticket.Save()
Next


= Exception Handling =

While working with the CommitCRM VB.NET library, some operations can fail. In this case the library will throw an exception of the '''CommitCRM.Exception''' class.
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 inspect the '''CommitCRM.Exception.Status''' property that holds the last CommitCRM '''Status''' value,
or inspect the list of '''CommitCRM.Exception.Codes''' (if any). Please refer to [[API_Reference_Manual#Error_Codes_Description|Error Codes Description]] for the description of these values.

VB.NET API

2011-02-16T15:30:59Z

CmtWikiAdminSysop: /* Getting Started */

= Disclaimer =

This documentation refers to CommitCRM 5.6 or later version and assumes CommitCRM is installed and accessible on the local computer.

= Introduction =

This document will show you how to use the CommitCRM VB.NET API library in order to programmatically connect to your CommitCRM server and query or manipulate the CommitCRM database.

= System Requirements =

* CommitCRM 5.6 or later.
* Visual Basic .NET 2008 or Visual Basic .NET 2010.
* CommitLib.dll (the CommitCRM VB.NET compiled library).

= Getting Started =

After you create your VB.NET project, you'll need to add a reference to the '''CommitLib.dll''' file, in order to have access to the CommitCRM library classes.

Each application using the library will have to initialize on startup the '''CommitCRM.Application''' object and terminate it on exit.
Initialization method requires that you pass an object instance of '''CommitCRM.Config''' class configured with the following settings:

* '''AppName'''
: This is free text, preferably the name of your application.

* '''CommitDllFolder'''
: 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 'C:\Commit\ThirdParty\UserDev'.
: '''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 upgrade these dll files, if needed, so you'll be always using the latest release automatically.

* '''CommitDbFolder'''
: Path to the CommitCRM database, default is 'C:\Commit\db'.

Assuming these default values, we can configure the '''CommitCRM.Config''' object like this:


Dim config As New CommitCRM.Config
config.AppName = "VB.NET Demo"
config.CommitDllFolder = "C:\Commit\ThirdParty\UserDev"
config.CommitDbFolder = "C:\Commit\db"


You should of course check where these paths are exactly on your disk and modify these values accordingly.

Now we can initialize the '''CommitCRM.Application''' object with these settings:


CommitCRM.Application.Initialize(config)


If anything goes wrong, the above line will throw an exception of the '''CommitCRM.Exception''' class.
To prevent unexpected termination of the program execution, we recommend having any call to the CommitCRM library enclosed in a '''Try/Catch''' block.

Before exit, we terminate the '''CommitCRM.Application''' object:


CommitCRM.Application.Terminate()


The most basic VB.NET application that just connects to CommitCRM and terminates could look something like this:


Try
Dim config As New CommitCRM.Config
config.AppName = "VB.NET Demo"
config.CommitDllFolder = "C:\Commit\ThirdParty\UserDev"
config.CommitDbFolder = "C:\Commit\db"

CommitCRM.Application.Initialize(config)

'At this point we have successfully initialized the CommitCRM.Application
'and can start using the other library classes
Catch ex As Exception
Console.Out.Write(ex.Message)
Finally
CommitCRM.Application.Terminate()
End Try


Now that we have confirmed the connectivity to the CommitCRM server (if the above code successfully runs),
we can continue adding more functionality to the example.

The library exposes as VB.NET classes the same CommitCRM objects (Account, Ticket etc.) available through the native CommitCRM API and you can refer to the
[[API_Reference_Manual|API_Reference_Manual]] for reference.

With any of these objects you can:

* Search/query for objects with '''CommitCRM.ObjectQuery''' that satisfy certain criteria
* Read/display the properties of the retrieved objects
* Update/save the properties of the retrieved objects
* Create/save new objects

Now let's see how we can search for '''CommitCRM.Account''' objects.
We instantiate an object of the '''CommitCRM.ObjectQuery''' class and pass '''CommitCRM.Account''' class as generics parameter.


Dim accountSearch As New CommitCRM.ObjectQuery(Of CommitCRM.Account)


'''CommitCRM.ObjectQuery''' class can accept any of the CommitCRM objects in this parameter, but we want to search for accounts now.

Next, we need to set criteria (or more than one) we want to search for:

accountSearch.AddCriteria("FLDCRDCITY", CommitCRM.OperatorEnum.opEqual, "New York")


The first parameter to the '''AddCriteria''' method is the field name we want to look in. Refer to [[API_Reference_Manual#Account_Fields|Account_Fields]]
for a complete list of the available fields for the '''CommitCRM.Account''' class.

The second parameter is a compare operator. We here use the '''CommitCRM.OperatorEnum.opEqual''' to get only exact matches.
In order to get a broader match in the results you can use '''CommitCRM.OperatorEnum.opLike''' operator.

The third parameter is the value we want to find. Prepending and/or appending % (percent) sign at the beginning and/or at the end while using '''CommitCRM.OperatorEnum.opLike''' operator,
will match the phrase even if in the middle of a sentence.

Now we can execute the search and retrieve the '''CommitCRM.Account''' objects (if any):


Dim accounts As List(Of CommitCRM.Account) = accountSearch.FetchObjects()


The above line will populate the List ('''System.Collections.Generic.List''') with all '''CommitCRM.Account''' objects that were found.
Now we can use '''For Each - Next''' statement to iterate through the accounts:


For Each account In accounts
Console.Out.Write(account.CompanyName + vbCrLf)
Next


Or we can manipulate these accounts:


For Each account In accounts
If account.Zip.Length = 0 Then
account.Zip = "10001"
account.Save()
End If
Next


We invoke the '''CommitCRM.Account's''' Save method on both new or existing accounts. For a new account, invoking the Save method would insert a new account in the CommitCRM database.
For an existing account, invoking the Save method would update the fields we modified in the existing account. This rule applies to all CommitCRM objects.

Or we can add a new ticket for each of the accounts:


For Each account In accounts
Dim ticket As New CommitCRM.Ticket
ticket.AccountREC_ID = account.AccountREC_ID
ticket.Description = "Sample ticket for a NewYork account"
ticket.Save()
Next


Each of the CommitCRM library objects have a set of properties that are exposed as VB.NET properties that you can directly manipulate or read from.
You already saw few examples of these properties in the above examples, as: '''account.Zip''' or '''ticket.Description'''. This is the prefered and more intuitive way of accessing the CommitCRM fields.
However, there is also another way of achieving the same results, by invoking '''GetFieldValue''' and '''SetFieldValue''' and specifying the internal field name.

Here is an equivalent of the above example that uses these two generic methods, instead of the object's properties:


For Each account In accounts
Dim ticket As New CommitCRM.Ticket
ticket.SetFieldValue("FLDTKTCARDID", account.GetFieldValue("FLDCRDRECID"))
ticket.SetFieldValue("FLDTKTPROBLEM", "Sample ticket for a NewYork account")
ticket.Save()
Next


= Exception Handling =

While working with the CommitCRM VB.NET library, some operations can fail. In this case the library will throw an exception of the '''CommitCRM.Exception''' class.
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 inspect the '''CommitCRM.Exception.Status''' property that holds the last CommitCRM '''Status''' value,
or inspect the list of '''CommitCRM.Exception.Codes''' (if any). Please refer to [[API_Reference_Manual#Error_Codes_Description|Error Codes Description]] for the description of these values.

VB.NET API

2011-02-16T15:30:12Z

CmtWikiAdminSysop: /* Getting Started */

= Disclaimer =

This documentation refers to CommitCRM 5.6 or later version and assumes CommitCRM is installed and accessible on the local computer.

= Introduction =

This document will show you how to use the CommitCRM VB.NET API library in order to programmatically connect to your CommitCRM server and query or manipulate the CommitCRM database.

= System Requirements =

* CommitCRM 5.6 or later.
* Visual Basic .NET 2008 or Visual Basic .NET 2010.
* CommitLib.dll (the CommitCRM VB.NET compiled library).

= Getting Started =

After you create your VB.NET project, you'll need to add a reference to the '''CommitLib.dll''' file, in order to have access to the CommitCRM library classes.

Each application using the library will have to initialize on startup the '''CommitCRM.Application''' object and terminate it on exit.
Initialization method requires that you pass an object instance of '''CommitCRM.Config''' class configured with the following settings:

* '''AppName'''
: This is free text, preferably the name of your application.

* '''CommitDllFolder'''
: 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 'C:\Commit\ThirdParty\UserDev'.
: 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 upgrade these dll files, if needed, so you'll be always using the latest release automatically.

* '''CommitDbFolder'''
: Path to the CommitCRM database, default is 'C:\Commit\db'.

Assuming these default values, we can configure the '''CommitCRM.Config''' object like this:


Dim config As New CommitCRM.Config
config.AppName = "VB.NET Demo"
config.CommitDllFolder = "C:\Commit\ThirdParty\UserDev"
config.CommitDbFolder = "C:\Commit\db"


You should of course check where these paths are exactly on your disk and modify these values accordingly.

Now we can initialize the '''CommitCRM.Application''' object with these settings:


CommitCRM.Application.Initialize(config)


If anything goes wrong, the above line will throw an exception of the '''CommitCRM.Exception''' class.
To prevent unexpected termination of the program execution, we recommend having any call to the CommitCRM library enclosed in a '''Try/Catch''' block.

Before exit, we terminate the '''CommitCRM.Application''' object:


CommitCRM.Application.Terminate()


The most basic VB.NET application that just connects to CommitCRM and terminates could look something like this:


Try
Dim config As New CommitCRM.Config
config.AppName = "VB.NET Demo"
config.CommitDllFolder = "C:\Commit\ThirdParty\UserDev"
config.CommitDbFolder = "C:\Commit\db"

CommitCRM.Application.Initialize(config)

'At this point we have successfully initialized the CommitCRM.Application
'and can start using the other library classes
Catch ex As Exception
Console.Out.Write(ex.Message)
Finally
CommitCRM.Application.Terminate()
End Try


Now that we have confirmed the connectivity to the CommitCRM server (if the above code successfully runs),
we can continue adding more functionality to the example.

The library exposes as VB.NET classes the same CommitCRM objects (Account, Ticket etc.) available through the native CommitCRM API and you can refer to the
[[API_Reference_Manual|API_Reference_Manual]] for reference.

With any of these objects you can:

* Search/query for objects with '''CommitCRM.ObjectQuery''' that satisfy certain criteria
* Read/display the properties of the retrieved objects
* Update/save the properties of the retrieved objects
* Create/save new objects

Now let's see how we can search for '''CommitCRM.Account''' objects.
We instantiate an object of the '''CommitCRM.ObjectQuery''' class and pass '''CommitCRM.Account''' class as generics parameter.


Dim accountSearch As New CommitCRM.ObjectQuery(Of CommitCRM.Account)


'''CommitCRM.ObjectQuery''' class can accept any of the CommitCRM objects in this parameter, but we want to search for accounts now.

Next, we need to set criteria (or more than one) we want to search for:

accountSearch.AddCriteria("FLDCRDCITY", CommitCRM.OperatorEnum.opEqual, "New York")


The first parameter to the '''AddCriteria''' method is the field name we want to look in. Refer to [[API_Reference_Manual#Account_Fields|Account_Fields]]
for a complete list of the available fields for the '''CommitCRM.Account''' class.

The second parameter is a compare operator. We here use the '''CommitCRM.OperatorEnum.opEqual''' to get only exact matches.
In order to get a broader match in the results you can use '''CommitCRM.OperatorEnum.opLike''' operator.

The third parameter is the value we want to find. Prepending and/or appending % (percent) sign at the beginning and/or at the end while using '''CommitCRM.OperatorEnum.opLike''' operator,
will match the phrase even if in the middle of a sentence.

Now we can execute the search and retrieve the '''CommitCRM.Account''' objects (if any):


Dim accounts As List(Of CommitCRM.Account) = accountSearch.FetchObjects()


The above line will populate the List ('''System.Collections.Generic.List''') with all '''CommitCRM.Account''' objects that were found.
Now we can use '''For Each - Next''' statement to iterate through the accounts:


For Each account In accounts
Console.Out.Write(account.CompanyName + vbCrLf)
Next


Or we can manipulate these accounts:


For Each account In accounts
If account.Zip.Length = 0 Then
account.Zip = "10001"
account.Save()
End If
Next


We invoke the '''CommitCRM.Account's''' Save method on both new or existing accounts. For a new account, invoking the Save method would insert a new account in the CommitCRM database.
For an existing account, invoking the Save method would update the fields we modified in the existing account. This rule applies to all CommitCRM objects.

Or we can add a new ticket for each of the accounts:


For Each account In accounts
Dim ticket As New CommitCRM.Ticket
ticket.AccountREC_ID = account.AccountREC_ID
ticket.Description = "Sample ticket for a NewYork account"
ticket.Save()
Next


Each of the CommitCRM library objects have a set of properties that are exposed as VB.NET properties that you can directly manipulate or read from.
You already saw few examples of these properties in the above examples, as: '''account.Zip''' or '''ticket.Description'''. This is the prefered and more intuitive way of accessing the CommitCRM fields.
However, there is also another way of achieving the same results, by invoking '''GetFieldValue''' and '''SetFieldValue''' and specifying the internal field name.

Here is an equivalent of the above example that uses these two generic methods, instead of the object's properties:


For Each account In accounts
Dim ticket As New CommitCRM.Ticket
ticket.SetFieldValue("FLDTKTCARDID", account.GetFieldValue("FLDCRDRECID"))
ticket.SetFieldValue("FLDTKTPROBLEM", "Sample ticket for a NewYork account")
ticket.Save()
Next


= Exception Handling =

While working with the CommitCRM VB.NET library, some operations can fail. In this case the library will throw an exception of the '''CommitCRM.Exception''' class.
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 inspect the '''CommitCRM.Exception.Status''' property that holds the last CommitCRM '''Status''' value,
or inspect the list of '''CommitCRM.Exception.Codes''' (if any). Please refer to [[API_Reference_Manual#Error_Codes_Description|Error Codes Description]] for the description of these values.

VB.NET API

2011-02-16T15:27:45Z

CmtWikiAdminSysop: /* Getting Started */

= Disclaimer =

This documentation refers to CommitCRM 5.6 or later version and assumes CommitCRM is installed and accessible on the local computer.

= Introduction =

This document will show you how to use the CommitCRM VB.NET API library in order to programmatically connect to your CommitCRM server and query or manipulate the CommitCRM database.

= System Requirements =

* CommitCRM 5.6 or later.
* Visual Basic .NET 2008 or Visual Basic .NET 2010.
* CommitLib.dll (the CommitCRM VB.NET compiled library).

= Getting Started =

After you create your VB.NET project, you'll need to add a reference to the '''CommitLib.dll''' file, in order to have access to the CommitCRM library classes.

Each application using the library will have to initialize on startup the '''CommitCRM.Application''' object and terminate it on exit.
Initialization method requires that you pass an object instance of '''CommitCRM.Config''' class configured with the following settings:

* '''AppName'''
: This is free text, preferably the name of your application.

* '''CommitDllFolder'''
: 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 'C:\Commit\ThirdParty\UserDev'.

* '''CommitDbFolder'''
: Path to the CommitCRM database, default is 'C:\Commit\db'.

Assuming these default values, we can configure the '''CommitCRM.Config''' object like this:


Dim config As New CommitCRM.Config
config.AppName = "VB.NET Demo"
config.CommitDllFolder = "C:\Commit\ThirdParty\UserDev"
config.CommitDbFolder = "C:\Commit\db"


You should of course check where these paths are exactly on your disk and modify these values accordingly.

Now we can initialize the '''CommitCRM.Application''' object with these settings:


CommitCRM.Application.Initialize(config)


If anything goes wrong, the above line will throw an exception of the '''CommitCRM.Exception''' class.
To prevent unexpected termination of the program execution, we recommend having any call to the CommitCRM library enclosed in a '''Try/Catch''' block.

Before exit, we terminate the '''CommitCRM.Application''' object:


CommitCRM.Application.Terminate()


The most basic VB.NET application that just connects to CommitCRM and terminates could look something like this:


Try
Dim config As New CommitCRM.Config
config.AppName = "VB.NET Demo"
config.CommitDllFolder = "C:\Commit\ThirdParty\UserDev"
config.CommitDbFolder = "C:\Commit\db"

CommitCRM.Application.Initialize(config)

'At this point we have successfully initialized the CommitCRM.Application
'and can start using the other library classes
Catch ex As Exception
Console.Out.Write(ex.Message)
Finally
CommitCRM.Application.Terminate()
End Try


Now that we have confirmed the connectivity to the CommitCRM server (if the above code successfully runs),
we can continue adding more functionality to the example.

The library exposes as VB.NET classes the same CommitCRM objects (Account, Ticket etc.) available through the native CommitCRM API and you can refer to the
[[API_Reference_Manual|API_Reference_Manual]] for reference.

With any of these objects you can:

* Search/query for objects with '''CommitCRM.ObjectQuery''' that satisfy certain criteria
* Read/display the properties of the retrieved objects
* Update/save the properties of the retrieved objects
* Create/save new objects

Now let's see how we can search for '''CommitCRM.Account''' objects.
We instantiate an object of the '''CommitCRM.ObjectQuery''' class and pass '''CommitCRM.Account''' class as generics parameter.


Dim accountSearch As New CommitCRM.ObjectQuery(Of CommitCRM.Account)


'''CommitCRM.ObjectQuery''' class can accept any of the CommitCRM objects in this parameter, but we want to search for accounts now.

Next, we need to set criteria (or more than one) we want to search for:

accountSearch.AddCriteria("FLDCRDCITY", CommitCRM.OperatorEnum.opEqual, "New York")


The first parameter to the '''AddCriteria''' method is the field name we want to look in. Refer to [[API_Reference_Manual#Account_Fields|Account_Fields]]
for a complete list of the available fields for the '''CommitCRM.Account''' class.

The second parameter is a compare operator. We here use the '''CommitCRM.OperatorEnum.opEqual''' to get only exact matches.
In order to get a broader match in the results you can use '''CommitCRM.OperatorEnum.opLike''' operator.

The third parameter is the value we want to find. Prepending and/or appending % (percent) sign at the beginning and/or at the end while using '''CommitCRM.OperatorEnum.opLike''' operator,
will match the phrase even if in the middle of a sentence.

Now we can execute the search and retrieve the '''CommitCRM.Account''' objects (if any):


Dim accounts As List(Of CommitCRM.Account) = accountSearch.FetchObjects()


The above line will populate the List ('''System.Collections.Generic.List''') with all '''CommitCRM.Account''' objects that were found.
Now we can use '''For Each - Next''' statement to iterate through the accounts:


For Each account In accounts
Console.Out.Write(account.CompanyName + vbCrLf)
Next


Or we can manipulate these accounts:


For Each account In accounts
If account.Zip.Length = 0 Then
account.Zip = "10001"
account.Save()
End If
Next


We invoke the '''CommitCRM.Account's''' Save method on both new or existing accounts. For a new account, invoking the Save method would insert a new account in the CommitCRM database.
For an existing account, invoking the Save method would update the fields we modified in the existing account. This rule applies to all CommitCRM objects.

Or we can add a new ticket for each of the accounts:


For Each account In accounts
Dim ticket As New CommitCRM.Ticket
ticket.AccountREC_ID = account.AccountREC_ID
ticket.Description = "Sample ticket for a NewYork account"
ticket.Save()
Next


Each of the CommitCRM library objects have a set of properties that are exposed as VB.NET properties that you can directly manipulate or read from.
You already saw few examples of these properties in the above examples, as: '''account.Zip''' or '''ticket.Description'''. This is the prefered and more intuitive way of accessing the CommitCRM fields.
However, there is also another way of achieving the same results, by invoking '''GetFieldValue''' and '''SetFieldValue''' and specifying the internal field name.

Here is an equivalent of the above example that uses these two generic methods, instead of the object's properties:


For Each account In accounts
Dim ticket As New CommitCRM.Ticket
ticket.SetFieldValue("FLDTKTCARDID", account.GetFieldValue("FLDCRDRECID"))
ticket.SetFieldValue("FLDTKTPROBLEM", "Sample ticket for a NewYork account")
ticket.Save()
Next


= Exception Handling =

While working with the CommitCRM VB.NET library, some operations can fail. In this case the library will throw an exception of the '''CommitCRM.Exception''' class.
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 inspect the '''CommitCRM.Exception.Status''' property that holds the last CommitCRM '''Status''' value,
or inspect the list of '''CommitCRM.Exception.Codes''' (if any). Please refer to [[API_Reference_Manual#Error_Codes_Description|Error Codes Description]] for the description of these values.

VB.NET API

2011-02-16T15:26:21Z

CmtWikiAdminSysop: /* System Requirements */

= Disclaimer =

This documentation refers to CommitCRM 5.6 or later version and assumes CommitCRM is installed and accessible on the local computer.

= Introduction =

This document will show you how to use the CommitCRM VB.NET API library in order to programmatically connect to your CommitCRM server and query or manipulate the CommitCRM database.

= System Requirements =

* CommitCRM 5.6 or later.
* Visual Basic .NET 2008 or Visual Basic .NET 2010.
* CommitLib.dll (the CommitCRM VB.NET compiled library).

= Getting Started =

After you create your VB.NET project, you'll need to add a reference to the '''CommitLib.dll''' file, in order to have access to the CommitCRM library classes.

Each application using the library will have to initialize on startup the '''CommitCRM.Application''' object and terminate it on exit.
Initialization method requires that you pass an object instance of '''CommitCRM.Config''' class configured with the following settings:

* '''AppName'''
: This is free text, preferably the name of your application

* '''CommitDllFolder'''
: 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 'C:\Commit\ThirdParty\UserDev'.

* '''CommitDbFolder'''
: Path to the CommitCRM database, default is 'C:\Commit\db'.

Assuming these default values, we can configure the '''CommitCRM.Config''' object like this:


Dim config As New CommitCRM.Config
config.AppName = "VB.NET Demo"
config.CommitDllFolder = "C:\Commit\ThirdParty\UserDev"
config.CommitDbFolder = "C:\Commit\db"


You should of course check where these paths are exactly on your disk and modify these values accordingly.

Now we can initialize the '''CommitCRM.Application''' object with these settings:


CommitCRM.Application.Initialize(config)


If anything goes wrong, the above line will throw an exception of the '''CommitCRM.Exception''' class.
To prevent unexpected termination of the program execution, we recommend having any call to the CommitCRM library enclosed in a '''Try/Catch''' block.

Before exit, we terminate the '''CommitCRM.Application''' object:


CommitCRM.Application.Terminate()


The most basic VB.NET application that just connects to CommitCRM and terminates could look something like this:


Try
Dim config As New CommitCRM.Config
config.AppName = "VB.NET Demo"
config.CommitDllFolder = "C:\Commit\ThirdParty\UserDev"
config.CommitDbFolder = "C:\Commit\db"

CommitCRM.Application.Initialize(config)

'At this point we have successfully initialized the CommitCRM.Application
'and can start using the other library classes
Catch ex As Exception
Console.Out.Write(ex.Message)
Finally
CommitCRM.Application.Terminate()
End Try


Now that we have confirmed the connectivity to the CommitCRM server (if the above code successfully runs),
we can continue adding more functionality to the example.

The library exposes as VB.NET classes the same CommitCRM objects (Account, Ticket etc.) available through the native CommitCRM API and you can refer to the
[[API_Reference_Manual|API_Reference_Manual]] for reference.

With any of these objects you can:

* Search/query for objects with '''CommitCRM.ObjectQuery''' that satisfy certain criteria
* Read/display the properties of the retrieved objects
* Update/save the properties of the retrieved objects
* Create/save new objects

Now let's see how we can search for '''CommitCRM.Account''' objects.
We instantiate an object of the '''CommitCRM.ObjectQuery''' class and pass '''CommitCRM.Account''' class as generics parameter.


Dim accountSearch As New CommitCRM.ObjectQuery(Of CommitCRM.Account)


'''CommitCRM.ObjectQuery''' class can accept any of the CommitCRM objects in this parameter, but we want to search for accounts now.

Next, we need to set criteria (or more than one) we want to search for:

accountSearch.AddCriteria("FLDCRDCITY", CommitCRM.OperatorEnum.opEqual, "New York")


The first parameter to the '''AddCriteria''' method is the field name we want to look in. Refer to [[API_Reference_Manual#Account_Fields|Account_Fields]]
for a complete list of the available fields for the '''CommitCRM.Account''' class.

The second parameter is a compare operator. We here use the '''CommitCRM.OperatorEnum.opEqual''' to get only exact matches.
In order to get a broader match in the results you can use '''CommitCRM.OperatorEnum.opLike''' operator.

The third parameter is the value we want to find. Prepending and/or appending % (percent) sign at the beginning and/or at the end while using '''CommitCRM.OperatorEnum.opLike''' operator,
will match the phrase even if in the middle of a sentence.

Now we can execute the search and retrieve the '''CommitCRM.Account''' objects (if any):


Dim accounts As List(Of CommitCRM.Account) = accountSearch.FetchObjects()


The above line will populate the List ('''System.Collections.Generic.List''') with all '''CommitCRM.Account''' objects that were found.
Now we can use '''For Each - Next''' statement to iterate through the accounts:


For Each account In accounts
Console.Out.Write(account.CompanyName + vbCrLf)
Next


Or we can manipulate these accounts:


For Each account In accounts
If account.Zip.Length = 0 Then
account.Zip = "10001"
account.Save()
End If
Next


We invoke the '''CommitCRM.Account's''' Save method on both new or existing accounts. For a new account, invoking the Save method would insert a new account in the CommitCRM database.
For an existing account, invoking the Save method would update the fields we modified in the existing account. This rule applies to all CommitCRM objects.

Or we can add a new ticket for each of the accounts:


For Each account In accounts
Dim ticket As New CommitCRM.Ticket
ticket.AccountREC_ID = account.AccountREC_ID
ticket.Description = "Sample ticket for a NewYork account"
ticket.Save()
Next


Each of the CommitCRM library objects have a set of properties that are exposed as VB.NET properties that you can directly manipulate or read from.
You already saw few examples of these properties in the above examples, as: '''account.Zip''' or '''ticket.Description'''. This is the prefered and more intuitive way of accessing the CommitCRM fields.
However, there is also another way of achieving the same results, by invoking '''GetFieldValue''' and '''SetFieldValue''' and specifying the internal field name.

Here is an equivalent of the above example that uses these two generic methods, instead of the object's properties:


For Each account In accounts
Dim ticket As New CommitCRM.Ticket
ticket.SetFieldValue("FLDTKTCARDID", account.GetFieldValue("FLDCRDRECID"))
ticket.SetFieldValue("FLDTKTPROBLEM", "Sample ticket for a NewYork account")
ticket.Save()
Next


= Exception Handling =

While working with the CommitCRM VB.NET library, some operations can fail. In this case the library will throw an exception of the '''CommitCRM.Exception''' class.
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 inspect the '''CommitCRM.Exception.Status''' property that holds the last CommitCRM '''Status''' value,
or inspect the list of '''CommitCRM.Exception.Codes''' (if any). Please refer to [[API_Reference_Manual#Error_Codes_Description|Error Codes Description]] for the description of these values.

CSharp API

2011-02-10T11:43:58Z

CmtWikiAdminSysop: Created page with '= This Page is Under Construction= '''This Page is Under Construction''''

= This Page is Under Construction=

'''This Page is Under Construction'''

QuickBooks Link

2010-11-25T11:32:46Z

CmtWikiAdminSysop: /* Supported Editions */

{{usermanualsnav}}

__TOC__
== Overview ==
Using the [[QuickBooks Link|Commit-QuickBooks Link]] you can run your computer services business more efficiently. It was designed to simplify routine business, accounting and financial management tasks. With the Commit-QuickBooks Link, you only need to enter data once and it will appear in both Commit and QuickBooks. This feature not only saves you the time of manually entering data, but it also minimizes the problems of duplicate, redundant and wrong data common to manual data entry. Now you can synchronize your data between Commit and QuickBooks and ensure data accuracy, enhance your flexibility, and increase your control over your bottom line.

This user manual will help you use the features included in the Commit-QuickBooks Link module.

The Commit-QuickBooks Link includes the following features:

'''Customers'''
*Import all your QuickBooks Customers into Commit
*Changes made to QuickBooks Customers can be synchronized with Commit
*Create a new Customer in QuickBooks based on a selected Commit Account
*Create links between existing Commit Accounts and QuickBooks Customers to automate synchronization between them
*Send and receive updates for selected Accounts/Customers

'''Vendors'''
*Import all your QuickBooks Vendors into Commit
*Changes made to QuickBooks Vendors can be synchronized with Commit
*Create a new Account in Commit based on a selected QuickBooks Vendor
*Create a new Vendor in QuickBooks based on a selected Commit Account
*Create links between existing Commit Accounts and QuickBooks Vendors to automate synchronization between them
*Send and receive updates for selected Accounts/Vendors

'''Items'''
*Import any/all of the following QuickBooks Items into Commit:
**Service Items => Labor Items in Commit
**Inventory Parts => Products/Parts in Commit
**Non-Inventory Parts => Products/Parts in Commit
**Inventory Assembly Items => Products/Parts in Commit
**Other Charge Items => Expenses in Commit
*Changes made to QuickBooks Items can be synchronized with Commit
*Create a new Item in Commit based on a selected QuickBooks Item
*Create a new Item in QuickBooks based on a selected Commit Item
*Create links between existing Commit Items and QuickBooks Items to automate synchronization between them
*Send and receive updates for selected Items

'''Invoices'''
*Generate QuickBooks invoices based on charges entered in Commit
*Generate invoices at different levels:
**Account - Invoices generated at the Account level may include any charges linked to this account, its contracts and tickets.
**Contract - Generating an invoice at the Contract level may include only charges which are linked to this specific contract
**Ticket - Generating an invoice at the Ticket level may include only charges which are linked to this specific ticket
*See total unbilled pending charges according to Account, Contract and Ticket
*Select which charges to include in the invoice
*Create a QuickBooks invoice directly from the Account, Contract, or Ticket windows
*View all charges included in a QuickBooks invoice by filtering charges by the invoice reference value

==Getting Started==
To enjoy the benefits of the Commit-QuickBooks Link you first need to set it up. The setup is a user-friendly process that walks you through all the necessary steps to completion.

===Supported Editions===
Please note that currently Commit synchronizes with the following versions and editions of QuickBooks:

The following '''US''' versions of QuickBooks are supported:
*QuickBooks Pro 2011 (requires CommitCRM 5.5 or above)
*QuickBooks Premier 2011 (requires CommitCRM 5.5 or above)
*QuickBooks Enterprise 2011 (requires CommitCRM 5.5 or above)
*QuickBooks Pro 2010
*QuickBooks Premier 2010
*QuickBooks Enterprise 2010
*QuickBooks Pro 2009
*QuickBooks Premier 2009
*QuickBooks Enterprise 2009
*QuickBooks Pro 2008
*QuickBooks Premier 2008
*QuickBooks Enterprise 2008
*QuickBooks Pro 2007
*QuickBooks Premier 2007
*QuickBooks Enterprise 2007
*QuickBooks Pro 2006
*QuickBooks Premier 2006
*QuickBooks Enterprise 2006
*QuickBooks Pro 2005 - QuickBooks Premier 2005
*QuickBooks Enterprise 2005 - QuickBooks Pro 2004
*QuickBooks Premier 2004

Note for QuickBooks 2009, or above, users: CommitCRM 4.5, or above, is required to integrate with QuickBooks 2009. Commit-QuickBooks Link uses a single currency. Multi-currency is not supported.

The following '''Canadian''' versions of QuickBooks are supported:
*QuickBooks Canada Pro 2010
*QuickBooks Canada Premier 2010
*QuickBooks Canada Pro 2009
*QuickBooks Canada Premier 2009
*QuickBooks Canada Pro 2008
*QuickBooks Canada Premier 2008
*QuickBooks Canada Pro 2007
*QuickBooks Canada Premier 2007
*QuickBooks Canada Pro 2006
*QuickBooks Canada Premier 2006
*QuickBooks Canada Pro 2005
*QuickBooks Canada Premier 2005
*QuickBooks Canada Pro 2004
*QuickBooks Canada Premier 2004

The following '''UK''' versions of QuickBooks are supported:
*QuickBooks UK Pro 2010
*QuickBooks UK Premier 2010
*QuickBooks UK Pro 2008
*QuickBooks UK Pro 2006
*QuickBooks UK Pro 2005
*QuickBooks UK Pro 2004

The following '''Australian''' versions of QuickBooks are supported (*):
*QuickBooks Pro 2010/11
*QuickBooks Premier 2010/11
*QuickBooks Pro 2009/10
*QuickBooks Premier 2009/10
*QuickBooks Pro 2008/9
*QuickBooks Premier 2008/9

*The integration with QuickBooks Australia was tested and works in US compatibility mode.

[multi user mode is supported]

===Installation Instructions===
The Commit-QuickBooks Link setup uses a step-by-step wizard. In the installation instructions below, only the main steps of the installation process are covered. You can find complete installation instructions in the [[QuickBooks_Link_Advanced_Topics#Detailed_Installation_Instructions_for_Commit-QuickBooks_Link|Detailed Installation Instructions for Commit QuickBooks Link]] section.

The Commit-QuickBooks Link needs to be set up once, after the initial setup you simply use the various options available to you from the QuickBooks menus.

Depending on your current system installation you may be asked to download an Intuit setup file. If you are asked to download the Intuit file, follow the download instructions that will be displayed.

Before running the setup make sure QuickBooks is installed on your computer, it is working properly and includes the latest patches and updates, and that you are logged in as a Windows Administrator.

 
====Requirements====
*'''Using the Commit QuickBooks Link requires a Quickbooks client to already be installed on the PC that you want to generate invoices and sync data from.'''
This can be set up on a single computer responsible for creating invoices for all the charges in the system. Alternatively, you can have the client installed on any PC that needs to use the link. Once the QuickBooks client is installed and connected to the QuickBooks Company File, you can continue with the Commit QuickBooks Link Installation steps.

 
====Installing the Commit-QuickBooks Link====
From the Main menu, select Tools > Options... and then navigate to the QuickBooks tab. The Options dialog box appears.

[[File:commit_options_quickbooks_tab.gif|center]]

Select the country your edition of QuickBooks belongs to, and click on Run Setup Wizard.

To integrate with QuickBooks, CommitCRM uses the latest direct API technologies offered by Intuit/QuickBooks, known as QBFC. QBFC should be installed on every PC on your network which will be using the Commit-QuickBooks Link.

If QBFC is not installed on your PC, you will be asked to install it.

[[File:Commit install qbfc question.gif|center]]

Click 'Yes'. QBFC must be installed in order to use Commit-QuickBooks Link.

If you do not have the QBFC installation file, you may download it from the CommitCRM web site. Instructions for downloading the file from the CommitCRM site will appear. Follow these instructions, and then continue with the setup process.

The entire synchronization process takes place between CommitCRM and a QuickBooks company file which you select.

Continue with the wizard until you are asked to select the QuickBooks company file you wish to synchronize with CommitCRM.

[[File:commit_quickbooks_wizard_step4.gif|center]]

Click on 'Click to Select' button to select your QuickBooks company file.

After selecting the company file continue with the setup process.

In the following screen, you will be asked to run QuickBooks and open the selected QuickBooks company file as a QuickBooks Administrator user and in Single User mode. Follow these instructions carefully to ensure a smooth installation of the Commit-QuickBooks Link.

[[File:commit_quickbooks_wizard_step5.gif|center]]

Please follow the instructions in the screen shot above. After logging into QuickBooks as an Administrator and in a single user mode, click 'Next'

CommitCRM will now try to access the selected QuickBooks company file. QuickBooks will display a window requesting permission to allow access to the file. Grant CommitCRM all the relevant permissions.

[[File:commit_quickbooks_permissions.gif|center]]

Make sure you select the following settings as illustrated above:
#Always allow access even if QuickBooks is not running
#Login as user with Admin privileges.

Note: The dialog box you see may slightly differ from the one above depending on your version/edition of QuickBooks.

Click Continue. QuickBooks will then ask you to confirm that you grant the permissions to CommitCRM. Click Yes.

When the permissions are granted to CommitCRM the setup is complete.

[[File:commit_options_quickbooks_tab2.gif|center]]

You will be returned to the Options window. Confirm by clicking OK.

Done! The Commit-QuickBooks Link setup is now complete.

To view complete installation instructions including all the steps, go to the [[QuickBooks_Link_Advanced_Topics#Detailed_Installation_Instructions_for_Commit-QuickBooks_Link|Detailed Installation Instructions for Commit QuickBooks Link]] section.

===Importing Customers/Vendors from QuickBooks into CommitCRM for the First Time===
his section will show you how to import your Customers into CommitCRM.

Important note: If all your Customers are already in CommitCRM, do not use this import feature until you have created links between existing records in CommitCRM and their related records in QuickBooks. To learn more about how to create these links, [[QuickBooks Link Account Options|click here.]]

Note that before performing a batch import, it is recommended that you first back up all your CommitCRM data. The CommitCRM data is stored in <server>Commit\DB.

After backing up your data, follow the instructions below to import Customers/Vendors from QuickBooks into CommitCRM:

In the Accounts window, go to the QuickBooks drop down toolbar menu and select Import New Records/Update Linked Records from QuickBooks. 

[[File:commit_importing_accounts_from_qb.gif|center]] 

[[File:commit_backup_warning.gif|center]] 

If you have backed up your CommitCRM Data, click OK to continue with the import process.

The import wizard will ask you to select the QuickBooks records you would like to import into CommitCRM. By default, only active Customers are imported. If you want to import your vendors as well, follow the import wizard again once you have completed importing your Customers, and select Vendors.

[[File:commit_accounts_import_wizard.jpg|center]]

Select the type of QuickBooks records you want to import, and click Next.

[[File:commit_accounts_import_wizard_finish.gif|center]]

Click Finish.

[[File:commit_start_importing_data_question.gif|center]]

Click Yes to begin importing the data. The import process will begin.

[[File:commit_import_accounts_progress.gif|center]]

Wait till the records are imported from QuickBooks to CommitCRM:

[[File:commit_successful_import.gif|center]]

Click OK.

The import has finished. You can now see all the imported records in CommitCRM in the Accounts window:

[[File:commit_imported_accounts_list.gif|center]]

Please note that QuickBooks Jobs are not imported in batch imports from QuickBooks. You can import jobs on one by one basis using the 'New Account in CommitCRM Based on QuickBooks' menu option.

===Importing Items from QuickBooks into CommitCRM===
This section will show you how to import your QuickBooks Items into CommitCRM.

Important Note: If all your Items are already in CommitCRM, do not use this import feature until you have created links between existing records in CommitCRM and their related records in QuickBooks. To learn more about how to create these links, [[QuickBooks Link Items Options|click here]].

Every Labor/Parts/Expense Charge in CommitCRM is based on a selected Item. This is why Items are important to the entire billing process. The Commit-QuickBooks Link enables you to import all your Items from QuickBooks, saving you from retyping Item details in CommitCRM.

Note that before performing a batch import, it is recommended that you first back up all your CommitCRM data. The CommitCRM data is stored in <server>Commit\DB.

After backing up your data follow the instructions below to import Items from QuickBooks into CommitCRM:

In the Items window, go to the QuickBooks drop down toolbar menu and select Import New Records/Update Linked Records from QuickBooks.

[[File:commit_importing_items_from_qb.gif|center]]

[[File:commit_backup_warning.gif|center]]

If you have backed up your CommitCRM Data, click OK to continue with the import process.

The import wizard will ask you to select the QuickBooks records you would like to import into CommitCRM. By default, all active Items are imported.

[[File:commit_items_import_wizard.gif|center]]

Select the types of Items you want to import from QuickBooks and click Next.

[[File:commit_items_import_wizard_finish.gif|center]]

Click '''Finish'''.

[[File:commit_start_importing_data_question.gif|center]]

Click Yes to begin importing the data. The import process will begin.

[[File:commit_import_items_progress.gif|center]]

Wait until the record are imported from QuickBooks to CommitCRM:

[[File:commit_successful_import.gif|center]]

Click '''OK'''.

The import has finished. You can now see all the imported records in CommitCRM, in the Items window.

[[File:commit_imported_items_list.gif|center]]

===Creating a New Invoice in QuickBooks===
CommitCRM lets you create QuickBooks Invoices at the '''Account/Ticket/Contract '''levels.

If you create an invoice at the '''Account level''', all Billable charges related to the Account that haven't been billed yet will be included in the invoice, including charges related to Tickets and Contracts.

If you create an invoice at the '''Contract level''', only Billable charges that haven't been billed yet which are related to the selected Contract will be included in the invoice, including all Ticket-related charges.

If you create an invoice at the '''Ticket level''', only Billable charges that haven't been billed yet which are related to the selected Ticket will be included in the invoice.

In all cases, you can also include not-billable charges in the invoice, which will be displayed in the invoice with a zero billable total amount. This way you can include all the charges without actually billing for not-billable charges.

There are two ways to create an invoice. The first option is creating an invoice for a specific Account, Ticket or Contract, and the second option is creating invoices for open balances in general.

Option 1: Go to the Accounts/Tickets/Contracts window, and select Create Invoice... on the QuickBooks drop down toolbar menu.

[[File:commit_accounts_window_create_invoice_menu.gif|center]]

or

[[File:commit_tickets_window_create_invoice_menu.gif|center]]

or

[[File:commit_contracts_window_create_invoice_menu.gif|center]]

Option 2: Go to the File menu, select New and then QuickBooks Invoice.

[[File:commit_new_quickbooks_invoice_menu.gif|center]]

After selecting this option the Generate QuickBooks Invoice dialog box is displayed:

[[File:commit_general_new_invoice_window.gif|center]]

Select the level at which you want to generate the invoice (either Accounts, Tickets, or Contracts).

View all the open Billable charges for the level you selected:

[[File:commit_all_tickets_to_be_invoiced.gif|center]]

In the example above, the Ticket level was selected. All the Tickets with open Billable charges are displayed. Select the Ticket for which you want to create an invoice and click Select Ticket and Continue.

After selecting the Account/Contract/Ticket record for which you want to create an invoice, the following window is displayed (this window is also displayed when the Create Invoice... option has been selected from the Account/Contact/Ticket window in Option 1 above):

[[File:commit_invoice_wizard_step2.gif|center]]

All Billable charges that haven't been billed yet and are related to the selected Account, Contract or Ticket record (Contract in the example above) are displayed and by default are selected (using the check mark) to be included in the invoice.

In the charge list you can select which charges will be included in the invoice by selecting or unselecting them by clicking on the checkbox to the left of the record.
 
'''Include/Exclude Not-Billable Charges''' 
In addition to the billable charges, you can include Not-billable charges in the invoice. When adding them, Not-Billable charges are displayed in the invoice, however, they do not affect the invoice total.

To include or exclude the not-billable charges click the Include Not-Billable Charge/Exclude Not-Billable toggle Charges button. Note that Administrators can set the system to always include the Not-Billable charges from Tools > Options > QuickBooks.
 
'''To be Printed/To be Emailed Flags''' 
Depending on your QuickBooks edition, Invoices in QuickBooks may include the following options: ‘To be printed’ and ‘To be emailed’.

By default, when creating new invoices from CommitCRM, the values for these options are taken from the default settings in QuickBooks (see the selected 'by QuickBooks' option). When un-checking the 'by QuickBooks' option, you can control the values to be used when generating the QuickBooks Invoice.

See more details in [[QuickBooks_Link#QuickBooks_Link_Settings|QuickBooks Link Settings]].

{| id="mp-tfp" style="margin:7px 0 0 0; width:100%; background:none;"

| class="MainPageBG" style="width:50%; border:1px solid #FFCB99; background:#ffffff; vertical-align:top; color:#000;" |
{| id="mp-left" cellpadding="2" cellspacing="5" style="width:100%; vertical-align:top; background:#ffffff;"
! <h3 id="mp-tfa-h2" style="margin:0; background:#fff3e1; font-size:120%; font-weight:bold; border:1px solid #FFCB99; text-align:left; color:#000; padding:0.2em 0.4em;">Tip
|-
| style="color:#000;" | <div id="mp-tfa">You can use the Quick Select and/or Quick Unselect and/or Advanced Sort buttons to more easily select the Charges to be billed (this is usually required when a lot of charges are displayed). </div>
|}
|}

At this stage you can also set different parameters for the invoice itself. The following options are located at the top of the Generate QuickBooks Invoice window:
#Bill To - This is the invoice billing address. By default it is taken from the Bill To data defined for the customer in QuickBooks. You can enter a different address in this box if necessary. If you have modified this information by mistake and want to use the QuickBooks defaults, right-click above the field and select Set by QuickBooks.
#Ship To - This is the invoice shipping address. By default it is taken from the Ship To data set defined for the customer in QuickBooks. You can enter a different address in this box if necessary. If you have modified this information by mistake and want to use the QuickBooks defaults, right-click above the field and select Set by QuickBooks.
#Date - This is the invoice date. By default, the date used is today's date. You can modify the date if necessary by typing an alternate date in this field.
#Reference - This is the invoice Reference number. This number is set by default by QuickBooks. You can modify this number if necessary by typing an alternate Reference number in the field.
#Due Date - This is the invoice Due Date. By default, the date is one month from today's date. You can modify this date if necessary by entering an alternate due date in the field.
#Memo - This field is for invoice memo/notes. If necessary, enter a memo that will appear as part of the QuickBooks invoice.

After entering the invoice details and selecting the relevant Charges, click Next.

The lines of the invoice are now displayed as they will appear in the QuickBooks invoice.

[[File:commit_invoice_wizard_step3.gif|center]]

In this step you can modify the text which will be displayed on the invoice lines. Note that all modifications made to the invoice lines here are not applied to Charges in CommitCRM, and only apply to the QuickBooks invoice lines.

'''Move Line Up/Down'''
You can use the Move Line Up/Move Line Down buttons or the Advanced Sort button to modify the order of the invoice lines.

'''Insert Line/s'''
You can also use the Add Blank Line button to include blank lines between the invoice lines in order to space the invoice up and make it more readable

'''Incl. in Description'''
You can also use the "Incl. in Description" button to include additional information to all invoice line simultaneously, such as:

[[File:commit_include_in_description_button.gif|center]]

Click on Incl. in Description and select the data you wish to be added to the description for every invoice line. To add this information to all invoices by default go to Tools > Options > QuickBooks and select the information you want to include in invoice lines.

You can double-click on each invoice line to add or edit the text/description of the selected line.

As mentioned above, these changes will take affect only on the invoice lines in QuickBooks. The original charges will not be affected by these changes.

[[File:commit_edit_invoice_line_description.gif|center]]

In the image below, you can see that additional information has appeared in the Description column of the invoice lines.

[[File:commit_invoice_wizard_step3_with_changes .gif|center]]

When the invoice information is complete, click Generate QuickBooks Invoice.

CommitCRM will now verify all the settings with QuickBooks and will add the QuickBooks invoice. Once an invoice has been created, the following unofficial invoice will be displayed. This invoice is just to give you an idea of how the invoice was created in QuickBooks. For complete details, view the invoice details in QuickBooks.

[[File:commit_quickbooks_invoice_in_commit.gif|center]]

If you wish to create another invoice, click on Create New Invoice'. Otherwise, you can close the window.

The invoice we've created looks like the following in QuickBooks:

[[File:commit_quickbooks_invoice_in_quickbooks.gif|center]]

== Using the Commit-QuickBooks Link ==
At this stage, where the Commit-QuickBooks Link installation setup is complete, you can start using it.

A few clicks will allow you to sync information between the two programs. Thus saving a lot of time and increasing productivity.

The first stage after the installation is to import Customers, Vendors and Items from QuickBooks into CommitCRM. Please note that you can easily perform the imports (as explained below).

However, we strongly recommend to backup CommitCRM data prior to the imports.

You should backup <server>\Commit\DB folder including all files while no one is using CommitCRM.

Note: If you are already using CommitCRM for a while and already have all your customers and items record in CommitCRM you should match CommitCRM records with QuickBooks records '''instead''' of importing the records (importing the records in this case will only create duplicates in your database and therefore it should be avoided). To learn more about how to link existing records between the two systems see [[QuickBooks Link Account Options|Link Account to QuickBooks Customer/Job/Vendor Record]] or [[QuickBooks Link Account Options|click here]].

===Accounts===
Your company has ongoing interactions with customers, vendors, business partners, friends, leads, and so on. In CommitCRM, each of these types of contacts is called an Account. You can manage your Account contact data and all other related data in the Accounts window.

In Accounts, related data is any information related to the Account that is presently being managed in CommitCRM, such as scheduled Appointments, open Tasks, Phone Call monitoring, Ticket/incident history, Assets (customer equipment and software licenses), Charges, linked Documents (MS-Word, emails, Excel etc.), Sales Opportunities and so on.

Account information is organized in separate information tabs that display different types of data.

To view all information related to an Account, open the Accounts window, locate the required Account, and browse through its data by clicking on the information tabs.

Accounts can be easily imported from QuickBooks, and changes can be synchronized between both systems.

For more details see [[QuickBooks Link Account Options|Commit-QuickBooks Link Account Options.]]

===Items===
[[Items]] in CommitCRM are a catalog of all the services and products you offer. The Items list in CommitCRM acts as your price list.

Each Item has a unique Code, Name, Description and Pricing Setting.

There are three types of Items in CommitCRM:

'''Parts''' Items are hardware, software, or any other items you ship to your customer. These items have fixed prices.

'''Labor''' Items are services you provide to your customers, such as server installation, network installation, on-site technician visits, etc. Each Labor item can have a fixed price, a fixed hourly rate, or a dynamic hourly rate that varies depending upon the employee who performs the service.

'''Expense''' Items are used to charge expenses, such as travel and special deliveries. Expense Items can have a fixed price per unit or a fixed hourly rate.

For each new Charge record, an Item is selected and the relevant Item data is automatically copied to the new charge. This streamlines your data entry process. Also, the selected Item for a Charge in CommitCRM will be the Item that appears on the QuickBooks invoice line when the Charge is transferred to a QuickBooks invoice.

Items can be Active or Suspended. A suspended Item cannot be selected when adding new charges.

Items can be easily imported from QuickBooks, and changes can be synchronized between QuickBooks and CommitCRM.

For more details see [[QuickBooks Link Items Options]].

===Invoices===
With the '''Commit-QuickBooks Link''' you can create invoices in QuickBooks based on charges entered in CommitCRM.

This feature allows you to manage all the aspects of your service in one program: '''CommitCRM'''. You can manage Tickets, enter Charges, etc. in CommitCRM, while all billing is managed in QuickBooks.

QuickBooks invoices can easily be created from CommitCRM at the customer level, the service contract level and the ticket level.

All invoices created from CommitCRM are based on Charge records added in CommitCRM. Each Charge record is either a labor charge for work performed, a parts charge describing a part that has been used, or an expense charge for expenses spent on behalf of the customer, i.e. for special deliveries.

It is recommended that you familiarize yourself with the following terms in CommitCRM:

'''[[Tickets]]''' – Every incident, problem, or job you handle for a customer is managed in CommitCRM using a Ticket record. Click here to learn more.

'''[[Contracts]]''' – Contract records are used to manage your service contracts and track their status. Click here to learn more.

'''[[Charges]]''' – Charge records are used to track all activities that will be charged to customers, such as labor, parts and expenses. Click here to learn more.

*For more details see [[QuickBooks Link Invoice Creation Options]].

===Charges===
Tracking Charges is a key factor for running your service business well and improving its performance. Most employees, however, consider this to be a nuisance or a burden, which makes it difficult to maximize your full income potential.

Three types of Charges can be tracked in CommitCRM:

<blockquote>Labor Charges for services provided Expense Charges for expenses such as travel and delivery Parts Charges for parts or products used</blockquote>

Each Charge record includes a description and information regarding the Account being charged, the charged Item (see the section on Items above), quantity, price, and total amount. Each Charge record can also be linked to a Ticket (optional).

All Charges are entered under one of the Account’s active Contracts. Charges may automatically change the current state of the contract where relevant, i.e. a Charge will reduce the time remaining in a Block of Time contract, reduce the amount of money in a Block of Money contract, etc.

A Charge can be set as Billable or Not Billable. When a Charge is set as Billable it means that you intend to bill the customer for this charge. The default billing status for Charges is determined by the type of contract under which the Charge is being created. See [[QuickBooks Link Charges Options#Understanding the Billing Status of Charges|Understanding the Billing Status]] of Charges below. Not-billable charges can also be included in invoices, however, these charges will display a zero amount and will not affect the invoice total amount.

Once a charged has been included in an invoice, the Charge record is set as Billed, and you can view the QuickBooks invoice reference number in the charge window. This prevents a customer from being billed again for the same Charge.

Adding a Charge is easy and this can be done in CommitCRM’s Main menu, the Tickets window (recommended), the Charges main window, or the Account window. Charges can also be added from anywhere using a web browser and an Internet connection, for this you need [[Web Interface|Commit Web Interface]].

Use Items to speed up the process of entering new Charges. When an Item is selected for a Charge, its description and price are automatically copied into the relevant fields in the Charge record.

Many types of Charge reports are available. These reports are used to bill customers and analyze business performance.

For more details see [[QuickBooks Link Charges Options]].

==QuickBooks Link Settings==
QuickBooks Link Settings can be defined from Tools > Options > QuickBooks tab.

[[File:Commit_options_quickbooks_tab_clear.gif]]
 
In this window the following settings are available:
* '''Accounting Package to be integrated with Commit'''
** None – means you do not want to integrate with any system
** QuickBooks – choosing this option you should specify the QuickBooks edition you use:
*** Edition: US, UK or Canada. Note that users working with the QuickBooks Australia edition should select US in this field (the Australian edition provides the API to external system compatible with the US edition).
*** QBFC: this is the QuickBooks API package. By default the system uses the latest QBFC edition. For very old QuickBooks editions you may need to change the QBFC edition being used. See more details in [[Commit-QuickBooks_Link_Troubleshooting|QuickBooks Troubleshooting]].
* '''QuickBooks Company File''' Once running the setup wizard (see below) and choosing the company file, the selected file name will appear here. This way you can see at all times which file is being used when syncing with QuickBooks.
* '''Advanced Settings''' The Advanced Settings deal with default items created in QuickBooks for un-synced items. In cases when charged Items in CommitCRM were not synchronized with QuickBooks Item, the invoice cannot be created because can't link to an Item in QuickBooks. To make the invoicing process easier and smoother, Commit-QuickBooks Link automatically creates default Items in QuickBooks for such cases. These items can be managed in this window. See more details in [[QuickBooks_Link_Invoice_Creation_Options#Using_Special_QuickBooks_Items_and_Accounts|Using Special QuickBooks Items and Accounts]].
* '''Invoice Charges''' These settings define which charges will be included in invoices by default. All Billable charges that haven't been billed yet and are related to the selected Account, Contract or Ticket record are included in the invoice by default. It is possible to include Not-billable charges in the invoice as well, if you wish to show the customer work performed which is not being billed (e.g. when it is covered by a service contract). When including not-billable charges in the invoice, they do not affect the invoice total amount. Not-billable charges can be added to the invoice on-the-fly from the Invoice Creation Wizard, or you can set the system to always include the not-billable charges in invoices. Possible options:
**Display and automatically select not-billable charges Selecting this option will always include all not-billable charges in invoices.
**Display not-billable charges; do not automatically select them Selecting this option will always show the not-billable charges in the Invoice Creation Wizard window, however, these charge will remain un-selected, unless you explicitly select to include them in the Invoice.
**Hide not-billable charges Selecting this option will never hide the not-billable charges. You can have them included manually while creating the Invoice in the Invoice Creation Wizard. See more details on setting options when running the Invoice Creation Wizard in [[QuickBooks_Link_Invoice_Creation_Options|Invoice Creation Options]].
* '''Invoice Lines Content''' Here you can select which data you want to include in each invoice line. This will affect all invoices being created via the QuickBooks Invoice Creation Wizard. Data which can be added to Invoices:
** Date
** Employee name
** Ticket Number
** Contract Code
** Insert blank lines between each invoice line
* '''QuickBooks Options: To be Printed & To be Emailed''' Depending on your QuickBooks edition, Invoices in QuickBooks may include the following options: ‘To be printed’ and ‘To be emailed’. By default, when creating new invoices from CommitCRM, the values for these options are taken from the default settings in QuickBooks. Using the flags in this options window, you can define default values to be used when generating QuickBooks Invoices from within CommitCRM. 
** To be Printed –
*** By QuickBooks (default) – choosing this option will take the value for this flag from the settings defined in QuickBooks.
*** Yes – choosing Yes will always set the To be Printed as Yes for new invoices created from CommitCRM.
*** No - choosing No will always set the To be Printed as No for new invoices created from CommitCRM. Note that these values can be modified on-the-fly when creating the invoice using the Invoice Creation Wizard.
** To be Emailed -
*** By QuickBooks (default) – choosing this option will take the value for this flag from the settings defined in QuickBooks.
*** Yes – choosing Yes will always set the To be Printed as Yes for new invoices created from CommitCRM.
*** No - choosing No will always set the To be Printed as No for new invoices created from CommitCRM. Note that these values can be modified on-the-fly when creating the invoice using the Invoice Creation Wizard.

==See Also==
*[[QuickBooks Link Account Options]]
*[[QuickBooks Link Items Options]]
*[[QuickBooks Link Invoice Creation Options]]
*[[QuickBooks Link Charges Options]]
*[[QuickBooks Link Advanced Topics]]
**[[QuickBooks Link Advanced Topics#Changing Path/Company File|Changing Path/Company File]]
**[[QuickBooks Link Advanced Topics#Starting a New Financial Year in QuickBooks|Starting a New Financial Year in QuickBooks]]
**[[QuickBooks Link Advanced Topics#Introduction to CommitCRM Service Tickets|Introduction to CommitCRM Service Tickets]]
**[[QuickBooks Link Advanced Topics#Introduction to Contracts|Introduction to Contracts]]
**[[QuickBooks Link Advanced Topics#Detailed Installation Instructions for Commit-QuickBooks Link|Detailed Installation Instructions for Commit-QuickBooks Link]]
*[[Billing]]
*[[QuickBooks FAQ]]
*[[Commit-QuickBooks_Link_Troubleshooting|Commit QuickBooks Link Troubleshooting]]

[[Category:Setup]]
[[Category:User Manuals]]
[[Category:Billing]]

KB: Changing Documents Folder Path

2010-11-22T11:34:59Z

CmtWikiAdminSysop: /* Step 1 - Update the path for existing docs */

=Introduction=
CommitCRM documents are saved in the database including the full path to the file location. When the path to the Documents folder changes (for example when [[Transferring_Commit_Installation_from_One_Server_to_Another|transferring your CommitCRM Installation from one server to another]]), you may also need to update the CommitCRM Documents Folder as well.

Since the document path is saved in the database, there is a need to actually update the path in the document records.

__TOC__

=How to change the database paths=
Updating the documents path to a new location consist of three steps:
* Updating the paths in your database to the new location
* Updating the Accounts default document folder to the new location
* Updating the Global Default Document Folder settings.
'''IMPORTANT''': Please backup the Commit folder and sub-folders. [[Backup_and_Restore_FAQ|Click here]] for more details on backing up your system.

==Step 1 - Update the path for existing docs==
In order to change the documents path in the database, you should use a utility designed for updating the path in the database according to the old location.

* Make sure you are using CommitCRM '''version 5.0 or higher''' (you can check this from the '''Help > About window'''). If you are using a version prior to 5.0, please contact us again for a different link to the program.

* If you are using '''CommitCRM version 5.3 or higher''' - [http://www.commitcrm.com/downloads/commit-change-all-docs-path-53.exe Click here to download] a utility that will help you modify the path.

* If you are using '''CommitCRM version 5.0, 5.1 or 5.2''' - [http://www.commitcrm.com/downloads/commit-change-all-docs-path-50.exe Click here to download] a utility that will help you modify the path.

* Save it in folder:
'''<server>\Commit\Utils'''

* Run the downloaded program

* Set the original/old path

* Set the new path of the new server

'''NOTE''': The path should point to the root folder where the documents are stored
e.g. '''<server>/x/y/z/docs/'''

* Make SURE you end each path you set with a slash ( '''/''' )

* Click Replace

* Done.

* Run CommitCRM and make sure the path was updated successfully.

 

==Step 2 - Update the Account Default Folders==
'''Note''': The '''default folder location''' for your accounts is '''not''' modified by the document path updater program. You should update the relevant default folders for your Accounts (via the '''Account's Details tab > Docs Dir'''). This is relevant only for accounts who have the default directory defined.
 

==Step 3 – Update the Global Default Documents Folders==
* Set the default folder to be used for new accounts by going to:
'''Tools menu > Options > Documents tab > Default Documents Folder'''

=See Also=
[[Transferring_Commit_Installation_from_One_Server_to_Another|Transferring your CommitCRM Installation from one server to another]]

[[Category:KB|Docs]]

SQL ADS 6420 On Login

2010-09-28T15:12:34Z

CmtWikiAdminSysop: Created page with 'Verify that Commit SQL Database is up and running on your server and try again.'

Verify that Commit SQL Database is up and running on your server and try again.

Subcontractors

2010-06-19T17:36:43Z

CmtWikiAdminSysop: Created page with 'Information on how to use CommitCRM with Subcontractors will be displayed here.'

Information on how to use CommitCRM with Subcontractors will be displayed here.

Alerts to Customers

2010-05-06T08:11:40Z

CmtWikiAdminSysop: Created page with 'Under construction.'

Under construction.

Regular Expressions

2010-04-27T09:09:45Z

CmtWikiAdminSysop: Created page with 'CommitCRM 5.3 Beta This page is currently under construction.'

CommitCRM 5.3 Beta

This page is currently under construction.

QuickBooks Link

2010-04-03T18:02:30Z

CmtWikiAdminSysop: /* Supported Editions */

{{usermanualsnav}}

__TOC__
== Overview ==
Using the [[QuickBooks Link|Commit-QuickBooks Link]] you can run your computer services business more efficiently. It was designed to simplify routine business, accounting and financial management tasks. With the Commit-QuickBooks Link, you only need to enter data once and it will appear in both Commit and QuickBooks. This feature not only saves you the time of manually entering data, but it also minimizes the problems of duplicate, redundant and wrong data common to manual data entry. Now you can synchronize your data between Commit and QuickBooks and ensure data accuracy, enhance your flexibility, and increase your control over your bottom line.

This user manual will help you use the features included in the Commit-QuickBooks Link module.

The Commit-QuickBooks Link includes the following features:

'''Customers'''
*Import all your QuickBooks Customers into Commit
*Changes made to QuickBooks Customers can be synchronized with Commit
*Create a new Customer in QuickBooks based on a selected Commit Account
*Create links between existing Commit Accounts and QuickBooks Customers to automate synchronization between them
*Send and receive updates for selected Accounts/Customers

'''Vendors'''
*Import all your QuickBooks Vendors into Commit
*Changes made to QuickBooks Vendors can be synchronized with Commit
*Create a new Account in Commit based on a selected QuickBooks Vendor
*Create a new Vendor in QuickBooks based on a selected Commit Account
*Create links between existing Commit Accounts and QuickBooks Vendors to automate synchronization between them
*Send and receive updates for selected Accounts/Vendors

'''Items'''
*Import any/all of the following QuickBooks Items into Commit:
**Service Items => Labor Items in Commit
**Inventory Parts => Products/Parts in Commit
**Non-Inventory Parts => Products/Parts in Commit
**Inventory Assembly Items => Products/Parts in Commit
**Other Charge Items => Expenses in Commit
*Changes made to QuickBooks Items can be synchronized with Commit
*Create a new Item in Commit based on a selected QuickBooks Item
*Create a new Item in QuickBooks based on a selected Commit Item
*Create links between existing Commit Items and QuickBooks Items to automate synchronization between them
*Send and receive updates for selected Items

'''Invoices'''
*Generate QuickBooks invoices based on charges entered in Commit
*Generate invoices at different levels:
**Account - Invoices generated at the Account level may include any charges linked to this account, its contracts and tickets.
**Contract - Generating an invoice at the Contract level may include only charges which are linked to this specific contract
**Ticket - Generating an invoice at the Ticket level may include only charges which are linked to this specific ticket
*See total unbilled pending charges according to Account, Contract and Ticket
*Select which charges to include in the invoice
*Create a QuickBooks invoice directly from the Account, Contract, or Ticket windows
*View all charges included in a QuickBooks invoice by filtering charges by the invoice reference value

==Getting Started==
To enjoy the benefits of the Commit-QuickBooks Link you first need to set it up. The setup is a user-friendly process that walks you through all the necessary steps to completion.

===Supported Editions===
Please note that currently Commit synchronizes with the following versions and editions of QuickBooks:

The following '''US''' versions of QuickBooks are supported:
*QuickBooks Pro 2010
*QuickBooks Premier 2010
*QuickBooks Enterprise 2010
*QuickBooks Pro 2009
*QuickBooks Premier 2009
*QuickBooks Enterprise 2009
*QuickBooks Pro 2008
*QuickBooks Premier 2008
*QuickBooks Enterprise 2008
*QuickBooks Pro 2007
*QuickBooks Premier 2007
*QuickBooks Enterprise 2007
*QuickBooks Pro 2006
*QuickBooks Premier 2006
*QuickBooks Enterprise 2006
*QuickBooks Pro 2005 - QuickBooks Premier 2005
*QuickBooks Enterprise 2005 - QuickBooks Pro 2004
*QuickBooks Premier 2004

Note for QuickBooks 2009, or above, users: CommitCRM 4.5, or above, is required to integrate with QuickBooks 2009. Commit-QuickBooks Link uses a single currency. Multi-currency is not supported.

The following '''Canadian''' versions of QuickBooks are supported:
*QuickBooks Canada Pro 2010
*QuickBooks Canada Premier 2010
*QuickBooks Canada Pro 2009
*QuickBooks Canada Premier 2009
*QuickBooks Canada Pro 2008
*QuickBooks Canada Premier 2008
*QuickBooks Canada Pro 2007
*QuickBooks Canada Premier 2007
*QuickBooks Canada Pro 2006
*QuickBooks Canada Premier 2006
*QuickBooks Canada Pro 2005
*QuickBooks Canada Premier 2005
*QuickBooks Canada Pro 2004
*QuickBooks Canada Premier 2004

The following '''UK''' versions of QuickBooks are supported:
*QuickBooks UK Pro 2008
*QuickBooks UK Pro 2006
*QuickBooks UK Pro 2005
*QuickBooks UK Pro 2004

The following '''Australian''' versions of QuickBooks are supported (*):
*QuickBooks Pro 2009/10
*QuickBooks Premier 2009/10
*QuickBooks Pro 2008/9
*QuickBooks Premier 2008/9

*The integration with QuickBooks Australia was tested and works in US compatibility mode.

[multi user mode is supported]

===Installation Instructions===
The Commit-QuickBooks Link setup uses a step-by-step wizard. In the installation instructions below, only the main steps of the installation process are covered. You can find complete installation instructions in the [[QuickBooks_Link_Advanced_Topics#Detailed_Installation_Instructions_for_Commit-QuickBooks_Link|Detailed Installation Instructions for Commit QuickBooks Link]] section.

The Commit-QuickBooks Link needs to be set up once, after the initial setup you simply use the various options available to you from the QuickBooks menus.

Depending on your current system installation you may be asked to download an Intuit setup file. If you are asked to download the Intuit file, follow the download instructions that will be displayed.

Before running the setup make sure QuickBooks is installed on your computer, it is working properly and includes the latest patches and updates, and that you are logged in as a Windows Administrator.

 
====Requirements====
*'''Using the Commit QuickBooks Link requires a Quickbooks client to already be installed on the PC that you want to generate invoices and sync data from.'''
This can be set up on a single computer responsible for creating invoices for all the charges in the system. Alternatively, you can have the client installed on any PC that needs to use the link. Once the QuickBooks client is installed and connected to the QuickBooks Company File, you can continue with the Commit QuickBooks Link Installation steps.

 
====Installing the Commit-QuickBooks Link====
From the Main menu, select Tools > Options... and then navigate to the QuickBooks tab. The Options dialog box appears.

[[File:commit_options_quickbooks_tab.gif|center]]

Select the country your edition of QuickBooks belongs to, and click on Run Setup Wizard.

To integrate with QuickBooks, CommitCRM uses the latest direct API technologies offered by Intuit/QuickBooks, known as QBFC. QBFC should be installed on every PC on your network which will be using the Commit-QuickBooks Link.

If QBFC is not installed on your PC, you will be asked to install it.

[[File:Commit install qbfc question.gif|center]]

Click 'Yes'. QBFC must be installed in order to use Commit-QuickBooks Link.

If you do not have the QBFC installation file, you may download it from the CommitCRM web site. Instructions for downloading the file from the CommitCRM site will appear. Follow these instructions, and then continue with the setup process.

The entire synchronization process takes place between CommitCRM and a QuickBooks company file which you select.

Continue with the wizard until you are asked to select the QuickBooks company file you wish to synchronize with CommitCRM.

[[File:commit_quickbooks_wizard_step4.gif|center]]

Click on 'Click to Select' button to select your QuickBooks company file.

After selecting the company file continue with the setup process.

In the following screen, you will be asked to run QuickBooks and open the selected QuickBooks company file as a QuickBooks Administrator user and in Single User mode. Follow these instructions carefully to ensure a smooth installation of the Commit-QuickBooks Link.

[[File:commit_quickbooks_wizard_step5.gif|center]]

Please follow the instructions in the screen shot above. After logging into QuickBooks as an Administrator and in a single user mode, click 'Next'

CommitCRM will now try to access the selected QuickBooks company file. QuickBooks will display a window requesting permission to allow access to the file. Grant CommitCRM all the relevant permissions.

[[File:commit_quickbooks_permissions.gif|center]]

Make sure you select the following settings as illustrated above:
#Always allow access even if QuickBooks is not running
#Login as user with Admin privileges.

Note: The dialog box you see may slightly differ from the one above depending on your version/edition of QuickBooks.

Click Continue. QuickBooks will then ask you to confirm that you grant the permissions to CommitCRM. Click Yes.

When the permissions are granted to CommitCRM the setup is complete.

[[File:commit_options_quickbooks_tab2.gif|center]]

You will be returned to the Options window. Confirm by clicking OK.

Done! The Commit-QuickBooks Link setup is now complete.

To view complete installation instructions including all the steps, go to the [[QuickBooks_Link_Advanced_Topics#Detailed_Installation_Instructions_for_Commit-QuickBooks_Link|Detailed Installation Instructions for Commit QuickBooks Link]] section.

===Importing Customers/Vendors from QuickBooks into CommitCRM for the First Time===
his section will show you how to import your Customers into CommitCRM.

Important note: If all your Customers are already in CommitCRM, do not use this import feature until you have created links between existing records in CommitCRM and their related records in QuickBooks. To learn more about how to create these links, [[QuickBooks Link Account Options|click here.]]

Note that before performing a batch import, it is recommended that you first back up all your CommitCRM data. The CommitCRM data is stored in <server>Commit\DB.

After backing up your data, follow the instructions below to import Customers/Vendors from QuickBooks into CommitCRM:

In the Accounts window, go to the QuickBooks drop down toolbar menu and select Import New Records/Update Linked Records from QuickBooks. 

[[File:commit_importing_accounts_from_qb.gif|center]] 

[[File:commit_backup_warning.gif|center]] 

If you have backed up your CommitCRM Data, click OK to continue with the import process.

The import wizard will ask you to select the QuickBooks records you would like to import into CommitCRM. By default, only active Customers are imported. If you want to import your vendors as well, follow the import wizard again once you have completed importing your Customers, and select Vendors.

[[File:commit_accounts_import_wizard.jpg|center]]

Select the type of QuickBooks records you want to import, and click Next.

[[File:commit_accounts_import_wizard_finish.gif|center]]

Click Finish.

[[File:commit_start_importing_data_question.gif|center]]

Click Yes to begin importing the data. The import process will begin.

[[File:commit_import_accounts_progress.gif|center]]

Wait till the records are imported from QuickBooks to CommitCRM:

[[File:commit_successful_import.gif|center]]

Click OK.

The import has finished. You can now see all the imported records in CommitCRM in the Accounts window:

[[File:commit_imported_accounts_list.gif|center]]

Please note that QuickBooks Jobs are not imported in batch imports from QuickBooks. You can import jobs on one by one basis using the 'New Account in CommitCRM Based on QuickBooks' menu option.

===Importing Items from QuickBooks into CommitCRM===
This section will show you how to import your QuickBooks Items into CommitCRM.

Important Note: If all your Items are already in CommitCRM, do not use this import feature until you have created links between existing records in CommitCRM and their related records in QuickBooks. To learn more about how to create these links, [[QuickBooks Link Items Options|click here]].

Every Labor/Parts/Expense Charge in CommitCRM is based on a selected Item. This is why Items are important to the entire billing process. The Commit-QuickBooks Link enables you to import all your Items from QuickBooks, saving you from retyping Item details in CommitCRM.

Note that before performing a batch import, it is recommended that you first back up all your CommitCRM data. The CommitCRM data is stored in <server>Commit\DB.

After backing up your data follow the instructions below to import Items from QuickBooks into CommitCRM:

In the Items window, go to the QuickBooks drop down toolbar menu and select Import New Records/Update Linked Records from QuickBooks.

[[File:commit_importing_items_from_qb.gif|center]]

[[File:commit_backup_warning.gif|center]]

If you have backed up your CommitCRM Data, click OK to continue with the import process.

The import wizard will ask you to select the QuickBooks records you would like to import into CommitCRM. By default, all active Items are imported.

[[File:commit_items_import_wizard.gif|center]]

Select the types of Items you want to import from QuickBooks and click Next.

[[File:commit_items_import_wizard_finish.gif|center]]

Click '''Finish'''.

[[File:commit_start_importing_data_question.gif|center]]

Click Yes to begin importing the data. The import process will begin.

[[File:commit_import_items_progress.gif|center]]

Wait until the record are imported from QuickBooks to CommitCRM:

[[File:commit_successful_import.gif|center]]

Click '''OK'''.

The import has finished. You can now see all the imported records in CommitCRM, in the Items window.

[[File:commit_imported_items_list.gif|center]]

===Creating a New Invoice in QuickBooks===
CommitCRM lets you create QuickBooks Invoices at the '''Account/Ticket/Contract '''levels.

If you create an invoice at the '''Account level''', all Billable charges related to the Account that haven't been billed yet will be included in the invoice, including charges related to Tickets and Contracts.

If you create an invoice at the '''Contract level''', only Billable charges that haven't been billed yet which are related to the selected Contract will be included in the invoice, including all Ticket-related charges.

If you create an invoice at the '''Ticket level''', only Billable charges that haven't been billed yet which are related to the selected Ticket will be included in the invoice.

In all cases, you can also include not-billable charges in the invoice, which will be displayed in the invoice with a zero billable total amount. This way you can include all the charges without actually billing for not-billable charges.

There are two ways to create an invoice. The first option is creating an invoice for a specific Account, Ticket or Contract, and the second option is creating invoices for open balances in general.

Option 1: Go to the Accounts/Tickets/Contracts window, and select Create Invoice... on the QuickBooks drop down toolbar menu.

[[File:commit_accounts_window_create_invoice_menu.gif|center]]

or

[[File:commit_tickets_window_create_invoice_menu.gif|center]]

or

[[File:commit_contracts_window_create_invoice_menu.gif|center]]

Option 2: Go to the File menu, select New and then QuickBooks Invoice.

[[File:commit_new_quickbooks_invoice_menu.gif|center]]

After selecting this option the Generate QuickBooks Invoice dialog box is displayed:

[[File:commit_general_new_invoice_window.gif|center]]

Select the level at which you want to generate the invoice (either Accounts, Tickets, or Contracts).

View all the open Billable charges for the level you selected:

[[File:commit_all_tickets_to_be_invoiced.gif|center]]

In the example above, the Ticket level was selected. All the Tickets with open Billable charges are displayed. Select the Ticket for which you want to create an invoice and click Select Ticket and Continue.

After selecting the Account/Contract/Ticket record for which you want to create an invoice, the following window is displayed (this window is also displayed when the Create Invoice... option has been selected from the Account/Contact/Ticket window in Option 1 above):

[[File:commit_invoice_wizard_step2.gif|center]]

All Billable charges that haven't been billed yet and are related to the selected Account, Contract or Ticket record (Ticket in the example above) are displayed and by default are selected (using the check mark) to be included in the invoice. In addition, you can include Not-billable charges in the invoice. Not-Billable charges are displayed in the invoice, however, they do not affect the invoice total.

To include or exclude the not-billable charges click the Include Not-Billable Charge/Exclude Not-Billable Charges button. Note that Administrators can set the system to always include the Not-Billable charges from Tools > Options > QuickBooks.

In the charge list you can select which charges will be included in the invoice by selecting or unselecting them by clicking on the checkbox to the left of the record.

{| id="mp-tfp" style="margin:7px 0 0 0; width:100%; background:none;"

| class="MainPageBG" style="width:50%; border:1px solid #FFCB99; background:#ffffff; vertical-align:top; color:#000;" |
{| id="mp-left" cellpadding="2" cellspacing="5" style="width:100%; vertical-align:top; background:#ffffff;"
! <h3 id="mp-tfa-h2" style="margin:0; background:#fff3e1; font-size:120%; font-weight:bold; border:1px solid #FFCB99; text-align:left; color:#000; padding:0.2em 0.4em;">Tip
|-
| style="color:#000;" | <div id="mp-tfa">You can use the Quick Select and/or Quick Unselect and/or Advanced Sort buttons to more easily select the Charges to be billed (this is usually required when a lot of charges are displayed). </div>
|}
|}

At this stage you can also set different parameters for the invoice itself. The following options are located at the top of the Generate QuickBooks Invoice window:
#Bill To - This is the invoice billing address. By default it is taken from the Bill To data defined for the customer in QuickBooks. You can enter a different address in this box if necessary. If you have modified this information by mistake and want to use the QuickBooks defaults, right-click above the field and select Set by QuickBooks.
#Ship To - This is the invoice shipping address. By default it is taken from the Ship To data set defined for the customer in QuickBooks. You can enter a different address in this box if necessary. If you have modified this information by mistake and want to use the QuickBooks defaults, right-click above the field and select Set by QuickBooks.
#Date - This is the invoice date. By default, the date used is today's date. You can modify the date if necessary by typing an alternate date in this field.
#Reference - This is the invoice Reference number. This number is set by default by QuickBooks. You can modify this number if necessary by typing an alternate Reference number in the field.
#Due Date - This is the invoice Due Date. By default, the date is one month from today's date. You can modify this date if necessary by entering an alternate due date in the field.
#Memo - This field is for invoice memo/notes. If necessary, enter a memo that will appear as part of the QuickBooks invoice.

After entering the invoice details and selecting the relevant Charges, click Next.

The lines of the invoice are now displayed as they will appear in the QuickBooks invoice.

[[File:commit_invoice_wizard_step3.gif|center]]

In this step you can modify the text which will be displayed on the invoice lines. Note that all modifications made to the invoice lines here are not applied to Charges in CommitCRM, and only apply to the QuickBooks invoice lines.

'''Move Line Up/Down'''
You can use the Move Line Up/Move Line Down buttons or the Advanced Sort button to modify the order of the invoice lines.

'''Insert Line/s'''
You can also use the Add Blank Line button to include blank lines between the invoice lines in order to space the invoice up and make it more readable

'''Incl. in Description'''
You can also use the "Incl. in Description" button to include additional information to all invoice line simultaneously, such as:

[[File:commit_include_in_description_button.gif|center]]

Click on Incl. in Description and select the data you wish to be added to the description for every invoice line. To add this information to all invoices by default go to Tools > Options > QuickBooks and select the information you want to include in invoice lines.

You can double-click on each invoice line to add or edit the text/description of the selected line.

As mentioned above, these changes will take affect only on the invoice lines in QuickBooks. The original charges will not be affected by these changes.

[[File:commit_edit_invoice_line_description.gif|center]]

In the image below, you can see that additional information has appeared in the Description column of the invoice lines.

[[File:commit_invoice_wizard_step3_with_changes .gif|center]]

When the invoice information is complete, click Generate QuickBooks Invoice.

CommitCRM will now verify all the settings with QuickBooks and will add the QuickBooks invoice. Once an invoice has been created, the following unofficial invoice will be displayed. This invoice is just to give you an idea of how the invoice was created in QuickBooks. For complete details, view the invoice details in QuickBooks.

[[File:commit_quickbooks_invoice_in_commit.gif|center]]

If you wish to create another invoice, click on Create New Invoice'. Otherwise, you can close the window.

The invoice we've created looks like the following in QuickBooks:

[[File:commit_quickbooks_invoice_in_quickbooks.gif|center]]

== Using the Commit-QuickBooks Link ==
At this stage, where the Commit-QuickBooks Link installation setup is complete, you can start using it.

A few clicks will allow you to sync information between the two programs. Thus saving a lot of time and increasing productivity.

The first stage after the installation is to import Customers, Vendors and Items from QuickBooks into CommitCRM. Please note that you can easily perform the imports (as explained below).

However, we strongly recommend to backup CommitCRM data prior to the imports.

You should backup <server>\Commit\DB folder including all files while no one is using CommitCRM.

Note: If you are already using CommitCRM for a while and already have all your customers and items record in CommitCRM you should match CommitCRM records with QuickBooks records '''instead''' of importing the records (importing the records in this case will only create duplicates in your database and therefore it should be avoided). To learn more about how to link existing records between the two systems see [[QuickBooks Link Account Options|Link Account to QuickBooks Customer/Job/Vendor Record]] or [[QuickBooks Link Account Options|click here]].

===Accounts===
Your company has ongoing interactions with customers, vendors, business partners, friends, leads, and so on. In CommitCRM, each of these types of contacts is called an Account. You can manage your Account contact data and all other related data in the Accounts window.

In Accounts, related data is any information related to the Account that is presently being managed in CommitCRM, such as scheduled Appointments, open Tasks, Phone Call monitoring, Ticket/incident history, Assets (customer equipment and software licenses), Charges, linked Documents (MS-Word, emails, Excel etc.), Sales Opportunities and so on.

Account information is organized in separate information tabs that display different types of data.

To view all information related to an Account, open the Accounts window, locate the required Account, and browse through its data by clicking on the information tabs.

Accounts can be easily imported from QuickBooks, and changes can be synchronized between both systems.

For more details see [[QuickBooks Link Account Options|Commit-QuickBooks Link Account Options.]]

===Items===
[[Items]] in CommitCRM are a catalog of all the services and products you offer. The Items list in CommitCRM acts as your price list.

Each Item has a unique Code, Name, Description and Pricing Setting.

There are three types of Items in CommitCRM:

'''Parts''' Items are hardware, software, or any other items you ship to your customer. These items have fixed prices.

'''Labor''' Items are services you provide to your customers, such as server installation, network installation, on-site technician visits, etc. Each Labor item can have a fixed price, a fixed hourly rate, or a dynamic hourly rate that varies depending upon the employee who performs the service.

'''Expense''' Items are used to charge expenses, such as travel and special deliveries. Expense Items can have a fixed price per unit or a fixed hourly rate.

For each new Charge record, an Item is selected and the relevant Item data is automatically copied to the new charge. This streamlines your data entry process. Also, the selected Item for a Charge in CommitCRM will be the Item that appears on the QuickBooks invoice line when the Charge is transferred to a QuickBooks invoice.

Items can be Active or Suspended. A suspended Item cannot be selected when adding new charges.

Items can be easily imported from QuickBooks, and changes can be synchronized between QuickBooks and CommitCRM.

For more details see [[QuickBooks Link Items Options]].

===Invoices===
With the '''Commit-QuickBooks Link''' you can create invoices in QuickBooks based on charges entered in CommitCRM.

This feature allows you to manage all the aspects of your service in one program: '''CommitCRM'''. You can manage Tickets, enter Charges, etc. in CommitCRM, while all billing is managed in QuickBooks.

QuickBooks invoices can easily be created from CommitCRM at the customer level, the service contract level and the ticket level.

All invoices created from CommitCRM are based on Charge records added in CommitCRM. Each Charge record is either a labor charge for work performed, a parts charge describing a part that has been used, or an expense charge for expenses spent on behalf of the customer, i.e. for special deliveries.

It is recommended that you familiarize yourself with the following terms in CommitCRM:

'''[[Tickets]]''' – Every incident, problem, or job you handle for a customer is managed in CommitCRM using a Ticket record. Click here to learn more.

'''[[Contracts]]''' – Contract records are used to manage your service contracts and track their status. Click here to learn more.

'''[[Charges]]''' – Charge records are used to track all activities that will be charged to customers, such as labor, parts and expenses. Click here to learn more.

*For more details see [[QuickBooks Link Invoice Creation Options]].

===Charges===
Tracking Charges is a key factor for running your service business well and improving its performance. Most employees, however, consider this to be a nuisance or a burden, which makes it difficult to maximize your full income potential.

Three types of Charges can be tracked in CommitCRM:

<blockquote>Labor Charges for services provided Expense Charges for expenses such as travel and delivery Parts Charges for parts or products used</blockquote>

Each Charge record includes a description and information regarding the Account being charged, the charged Item (see the section on Items above), quantity, price, and total amount. Each Charge record can also be linked to a Ticket (optional).

All Charges are entered under one of the Account’s active Contracts. Charges may automatically change the current state of the contract where relevant, i.e. a Charge will reduce the time remaining in a Block of Time contract, reduce the amount of money in a Block of Money contract, etc.

A Charge can be set as Billable or Not Billable. When a Charge is set as Billable it means that you intend to bill the customer for this charge. The default billing status for Charges is determined by the type of contract under which the Charge is being created. See [[QuickBooks Link Charges Options#Understanding the Billing Status of Charges|Understanding the Billing Status]] of Charges below. Not-billable charges can also be included in invoices, however, these charges will display a zero amount and will not affect the invoice total amount.

Once a charged has been included in an invoice, the Charge record is set as Billed, and you can view the QuickBooks invoice reference number in the charge window. This prevents a customer from being billed again for the same Charge.

Adding a Charge is easy and this can be done in CommitCRM’s Main menu, the Tickets window (recommended), the Charges main window, or the Account window. Charges can also be added from anywhere using a web browser and an Internet connection, for this you need [[Web Interface|Commit Web Interface]].

Use Items to speed up the process of entering new Charges. When an Item is selected for a Charge, its description and price are automatically copied into the relevant fields in the Charge record.

Many types of Charge reports are available. These reports are used to bill customers and analyze business performance.

For more details see [[QuickBooks Link Charges Options]].

==See Also==
*[[QuickBooks Link Account Options]]
*[[QuickBooks Link Items Options]]
*[[QuickBooks Link Invoice Creation Options]]
*[[QuickBooks Link Charges Options]]
*[[QuickBooks Link Advanced Topics]]
**[[QuickBooks Link Advanced Topics#Changing Path/Company File|Changing Path/Company File]]
**[[QuickBooks Link Advanced Topics#Starting a New Financial Year in QuickBooks|Starting a New Financial Year in QuickBooks]]
**[[QuickBooks Link Advanced Topics#Introduction to CommitCRM Service Tickets|Introduction to CommitCRM Service Tickets]]
**[[QuickBooks Link Advanced Topics#Introduction to Contracts|Introduction to Contracts]]
**[[QuickBooks Link Advanced Topics#Detailed Installation Instructions for Commit-QuickBooks Link|Detailed Installation Instructions for Commit-QuickBooks Link]]
*[[Billing]]
*[[QuickBooks FAQ]]
*[[Commit-QuickBooks_Link_Troubleshooting|Commit QuickBooks Link Troubleshooting]]

[[Category:Setup]]
[[Category:User Manuals]]
[[Category:Billing]]

MediaWiki:Sidebar

2010-01-18T20:41:55Z

CmtWikiAdminSysop: adding troubleshooting

* Navigation
** mainpage | Wiki Home
**http://www.commitcrm.com/forum | Forums
**http://www.commitcrm.com/tour.htm | Product Tour

*SEARCH

*Getting Started
**Introduction | Introduction
**CommitCRM Installation | Installing CommitCRM
**http://www.commitcrm.com/videos/commit_crm_getting_started_tutorial_video.htm | Getting Started Tutorial
**Videos | Videos

*Documentation
**Setup | Setup
**Videos | Videos
**Work Flows | Work Flows
**User Manuals | User Manuals
**Office Management | Office Management
**Service Management | Service Management
**Billing Topics|Billing
**Import and Export | Import and Export
**Customization | Customization
**Integration | Integration
**Category:KB | Commit KB Articles
**FAQ | FAQ
**Troubleshooting | Troubleshooting

*Tools
**https://www.commitcrm.com/wiki/Special:Upload | Upload file
**https://www.commitcrm.com/w/index.php?title={{PAGENAME}}&printable=yes | Printable version

MediaWiki:Sidebar

2009-10-08T09:17:33Z

CmtWikiAdminSysop:

* Navigation
** mainpage | Wiki Home
**http://www.commitcrm.com/forum | Forums
**http://www.commitcrm.com/tour.htm | Product Tour

*SEARCH

*Getting Started
**Introduction | Introduction
**CommitCRM Installation | Installing CommitCRM
**http://www.commitcrm.com/videos/commit_crm_getting_started_tutorial_video.htm | Getting Started Tutorial
**Videos | Videos

*Documentation
**Setup | Setup
**Videos | Videos
**Work Flows | Work Flows
**User Manuals | User Manuals
**Office Management | Office Management
**Service Management | Service Management
**Billing Topics|Billing
**Import and Export | Import and Export
**Customization | Customization
**Integration | Integration
**Category:KB | Commit KB Articles
**FAQ | FAQ

*Tools
**https://www.commitcrm.com/wiki/Special:Upload | Upload file
**https://www.commitcrm.com/w/index.php?title={{PAGENAME}}&printable=yes | Printable version

MediaWiki:Sidebar

2009-10-08T09:17:11Z

CmtWikiAdminSysop:

* Navigation
** mainpage | Wiki Home
**http://www.commitcrm.com/forum | Forums
**http://www.commitcrm.com/tour.htm | Product Tour

*SEARCH

*Getting Started
**Introduction | Introduction
**CommitCRM Installation | Installing CommitCRM
**http://www.commitcrm.com/videos/commit_crm_getting_started_tutorial_video.htm | Getting Started Tutorial
**Videos | Videos

*Documentation
**Setup | Setup
**Videos | Videos
**Work Flows | Work Flows
**User Manuals | User Manuals
**Office Management | Office Management
**Service Management | Service Management
**Billing Topics|Billing
**Import and Export | Import and Export
**Customization | Customization
**Integration | Integration
**Category:KB | KB Articles
**FAQ | FAQ

*Tools
**https://www.commitcrm.com/wiki/Special:Upload | Upload file
**https://www.commitcrm.com/w/index.php?title={{PAGENAME}}&printable=yes | Printable version