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

Main Page

2009-08-25T14:49:16Z

Yarden:

{| 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:162%; border:none; margin:0; padding:.1em; color:#000;">Welcome to the Commit Wiki</div>
<div style="top:+0.2em; font-size:95%;">Commit 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 Commit?]
* [http://www.commitcrm.com/aboutus.htm About Commit]
|}


{{Col}}
=Documentation=
*[[#Getting Started|Getting Started]]
*[[#Setup|Setup]]
*[[#Videos|Videos]]
*[[#Work Flows|Work Flows]]
*[[#User Manuals|User Manuals]]
*[[#Office Management|Office Management]]
*[[#Service Management|Service Management]]
*[[#Billing|Billing]]
*[[#Import and Export|Import and Export]]
*[[#Customization|Customization]]
*[[#Privileges|Privileges]]
*[[#Integration|Integration]]
*[[#FAQ|FAQ]]

{{Break}}
=Forum Threads=
*[http://www.commitcrm.com/forum/showthread.php?t=1153 New! Installation Video Tutorials]
*[http://www.commitcrm.com/forum/showthread.php?t=1137 New! CommitCRM 5.1 is Now Available ]
*[http://www.commitcrm.com/forum/showthread.php?t=1025 New! Follow us on Twitter – twitter.com/CommitCRM]
*[http://www.commitcrm.com/forum/showthread.php?t=1037 The IT Toolbox – Community Based Resources for IT Professionals]

=Headline=

{{Colend}}


== [[Getting Started]] ==

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

==Setup==
*[[Import and Export]]
*[[Web Interface|Commit Web Interface Installation]]
*[[Email Connector|Commit Email Connector Installation]]
*[[Alerts Server|Commit Alerts Server Installation]]
*[[QuickBooks Link|Commit-QuickBooks Link]]
*[[Commit-Outlook Sync]]
*[[Videos#Installation Guides|Installation 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/web_interface_installation_video.htm Email Connector Installation]
*[http://www.commitcrm.com/videos/web_interface_installation_video.htm Alerts Server Installation]
*[[Videos|Watch more videos!]]

==Work Flows==
*[[Tickets|Ticket Lifecycle]]
*[[Billing Lifecycle]]
*[[Project Management]]
*[[Recurring Contracts]]
*[[Over-used Hours]]
*[[Asset Warranties]]
*[[Preventive Maintenance]]
*[[Return Material Authorization (RMA)]]
*[[Barcodes and Assets]]
*[[Sales|Sales Management]]
*[[Managing Quotes]]

==User Manuals==
*[[Billing]]
*[[Assets]]
*[[Sales]]
*[[Knowledge Base]]
*[[Activity Templates]]
*[[Email Templates]]
*[[Documents]]
*[[QuickBooks Link|Commit-QuickBooks Link]]
*[[Commit-Outlook Sync]]
*[[Web Interface|Commit Web Interface]]
*[[Email Connector|Commit Email Connector]]
*[[Alerts Server|Commit Alerts Server]]

==Office Management==
*[[Accounts]]
*[[Documents]]
*[[Documents#Using Word Merge Templates|Word Templates]]
*[[Email Templates]]
*[[Documents#Managing Outlook Emails within CommitCRM|Filing Emails]]
*[[History]]
*[[Commit-Outlook Sync]]

==Service Management==
*[[Tickets]]
*[[Tickets#Dispatch the Ticket|Dispatcher]]
*[[Assets]]
*[[Activity Templates]]
*[[Email Templates]]
*[[Knowledge Base]]
*[[Billing]]

==Billing==
*[[Billing]]
*[[Items]]
*[[Charges]]
*[[Contracts]]
*[[Custom Pricing]]
*[[Contract-Price Charges]]
*[[Recurring Contracts]]
*[[Charges#Charging Using Taxes|Taxes]]
*[[QuickBooks Link|Commit-QuickBooks Link]]
*[[Charges#Using CommitCRM Charge Reports|Charge Reports]]

==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|Sync with Outlook]]

==Customization==
*[[Field Customization]]
*[[Report Customization]]

==Privileges==
*[[Employees#Employee Privileges Group|Employee Privileges]]
*[[Customer Privileges]]

==Integration==
*[[QuickBooks Link|Commit-QuickBooks Link]]
*[[Commit-Outlook Sync]]
*[[Commit Online Services]]
*[[Commit API Developers Guide]]
*[[Documents#Importing Existing Documents|Import and Export (Excel, CSV, etc.)]]
*[[Documents#Using Word Merge Templates|Word Templates]]

==FAQ==
*[[Tickets FAQ|Tickets]]
*[[Contracts FAQ|Contracts]]
*[[Dispatcher & Calendar FAQ|Dispatcher & Calendar]]
*[[Charges FAQ|Charges]]
*[[Items FAQ|Items]]
*[[Reports FAQ|Reports]]
*[[Import & 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 & 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__
__NOEDITSECTION__

Help:Editing

2009-08-25T12:31:42Z

Yarden:

for navigation help, see [[Template:Navbar]]

== Color Writing==
<nowiki>TEXT</nowiki>

==Tip Box==
{| 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;"
! <h2 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</h2>
|-
| style="color:#000;" | <div id="mp-tfa">TEXT TEXT TEXT TEXT TEXT TEXT TEXT TEXT TEXT TEXT </div>
|}
|}

<pre>
{| 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;"
! <h2 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</h2>
|-
| style="color:#000;" | <div id="mp-tfa">TEXT TEXT TEXT TEXT TEXT TEXT TEXT TEXT TEXT TEXT </div>
|}
|}</pre>

== Text formatting markup ==
{| class="wikitable"
! style="width:15%" |Description
! style="width:45%" |You type
! style="width:40%" |You get
|-
! colspan="3" align="center" style="background:#A7C1F2" | character formatting - ''applies anywhere''
|-
|Italic text
|<pre>''italic''</pre>
|''italic''
|-
| Bold text
|<pre>'''bold'''</pre>
|'''bold'''
|-
| Bold and italic
|<pre>'''''bold & italic'''''</pre>
|'''''bold & italic'''''
|-
|Escape wiki markup
|
<pre><nowiki>no ''markup''</nowiki></pre>
|<nowiki>no ''markup''</nowiki>
|-
! colspan="3" align="center" style="background:#A7C1F2"| section formatting - ''only at the beginning of the line''
|-
|Headings of different levels
|
<pre>=level 1=
==level 2==
===level 3===
====level 4====
=====level 5=====
======level 6======</pre>
An article with four or more headings will automatically create a [http://en.wikipedia.org/wiki/Wikipedia:Section#Table_of_contents_.28TOC.29 table of contents].

|

<div style="font-size: 188%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa;">Level 1</div>
<div style="font-size: 150%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa;">Level 2</div>
<div style="font-size: 132%; border-bottom: none; font-weight: bold;">Level 3</div>
<div style="font-size: 100%; border-bottom: none; font-weight: bold;">Level 4</div>
<div style="font-size: 86%; border-bottom: none; font-weight: bold;">Level 5</div>
<div style="font-size: 80%; border-bottom: none; font-weight: bold;">Level 6</div>
|-
|Horizontal rule
|
<pre>----</pre>
|
----
|-
|Bullet list
|
<pre>
* one
* two
* three
** three point one
** three point two
</pre>
Inserting a blank line will end the first list and start another.
|
* one
* two
* three
** three point one
** three point two
|-
|Numbered list
|
<pre>
# one
# two several lines without breaking numbering
# three
## three point one
## three point two
</pre>
|
# one
# two spanning several lines without breaking the numbering
# three
## three point one
## three point two
|-
|Definition list
|
<pre>
;item 1
:definition 1
;item 2
:definition 2-1
:definition 2-2
</pre>
|
;item 1
:definition 1
;item 2
:definition 2-1
:definition 2-2
|-
| Adopting definition list to indent text
|
<pre>:Single indent
::Double indent
:::::Multiple indent</pre>
This adoption may be controversial from the viewpoint of accessibility.
|
:Single indent
::Double indent
:::::Multiple indent
|-
| Mixture of different types of list
|
<pre>
# one
# two
#* two point one
#* two point two
# three
#; three item one
#: three def one
# four
#: four def one
#: this rather looks like the continuation of # four
#: and thus often used instead of 
# five
## five sub 1
### five sub 1 sub 1
## five sub 2
;item 1
:* definition 1-1
:* definition 1-2
:
;item 2
:# definition 2-1
:# definition 2-2
</pre>
The usage of <code>#:</code> and <code>*:</code> for breaking a line within an item may also be controversial.
|
# one
# two
#* two point one
#* two point two
# three
#; three item one
#: three def one
# four
#: four def one
#: this rather looks like the continuation of <code># four</code>
#: and thus often used instead of <code><nowiki> </nowiki></code>
# five
## five sub 1
### five sub 1 sub 1
## five sub 2
;item 1
:* definition 1-1
:* definition 1-2
:
;item 2
:# definition 2-1
:# definition 2-2
|-
|-
|Preformatted text
|
<pre>
preformatted text is done with
a '''space''' at the
''beginning'' of the line
</pre>
This way of preformatting only applies to section formatting, and character formatting markups are still effective.
|
preformatted text is done with
a '''space''' at the
''beginning'' of the line
|}

== HTML ==
Some [[wikipedia:HTML|HTML]] tags are allowed in MediaWiki, for example <code><nowiki><code></nowiki></code>, <code><nowiki><div></nowiki></code>, <code><nowiki></nowiki></code> and <code><nowiki></nowiki></code>. These apply anywhere you insert them.

{| class="wikitable"
!Description
!You type
!You get
|-
| Strikethrough
|<pre><del>Strikethrough</del></pre>
|<del>Strikethrough</del>
|-
|Fixed width text
|
<pre><tt>Fixed width text</tt></pre>
|
<tt>Fixed width text</tt>
|-
|Blockquotes
|
<pre>
text text text text text
text text text text text
<blockquote> quote quote quote </blockquote>
text text text text text
</pre>
|
text text text text text text text text text text text text
text text text text text text text text text text text text
<blockquote> quote quote quote quote quote quote </blockquote>
text text text text text text text text text text text text
|-
|Comment
|
<pre></pre>

Text can only be viewed in the edit window.
|

|-
|Completely preformatted text
|
<pre><pre>all markups are '''ignored'''</pre></pre>
|
<pre>
this way, all markups are '''ignored'''</pre>
|}

== Internal links ==
To add an internal link, enclose the name of the page you want to link to in double square brackets. When you save the page, you'll see the new link pointing to your page. If the page exists already it is displayed in blue, if it does not, in red.
Selflinks to the current page are not transformed in URLs but displayed in bold.
(If you really want to link to the current page, use an anchor (see below), or <nowiki>[[#top|current page]]</nowiki> which always links to the top.)

The first letter of the target page is automatically capitalized, unless otherwise set by the admins, and spaces are represented as underscores (typing an underscore in the link will have a similar effect as typing a space, but is not recommended, since the underscore will also be shown in the text).

{| border="1" class="wikitable"
!Description
!You type
!You get
|-
|Internal link
|<pre>[[Main Page]]</pre>
|[[Main Page]]
|-
|Piped link
|<pre>[[Main Page|different text]]</pre>
|[[Main Page|different text]]
|-
|Redirect
|<pre>#REDIRECT [[Main Page]]</pre>
See also [[Help:Redirects]]
| → [[Main Page]]
|-
|Internal link to an anchor
|<pre>[[#See also]]</pre>
[[Help:Formatting|Section headings]] and the [[#top|top]] of the page are automatically anchored.
|[[#See also]]
|-
|Internal link to an anchor at another page
|<pre>[[Help:Images#See also]]</pre>
|[[Help:Images#See also]]
|-
|Internal link to the current page's talk page
|<pre>[[{{TALKPAGENAME}}|Discussion]]</pre>
See also [[Help:Magic_words#Page_names]]
|[[{{TALKPAGENAME}}|Discussion]]
|-
|Internal link to a subpage
|<pre>[[/example]]</pre>
Shortcut for <nowiki>[[Help:Links/example]]</nowiki>.
|[[/example]]
|-
|Internal link to a category page
|<pre>[[:Category:Help]]</pre>
See also [[Help:Categories]]
|[[:Category:Help]]
|-
|Internal link to an image or a file of other types
|<pre>[[media:example.jpg]]

[[media:example.pdf]]</pre>
See also [[Help:Images]]
|[[media:example.jpg]]

[[media:example.pdf]]
|}
== External links ==
{| border="1" class="wikitable"
!style="width:15%"|Description
!style="width:45%"|You type
!style="width:40%"|You get
|-
|External link
|<pre>http://mediawiki.org</pre>
|http://mediawiki.org
|-
|External link with different label
|<pre>[http://mediawiki.org MediaWiki]</pre>
|[http://mediawiki.org MediaWiki]
|-
|External link numbered
|<pre>[http://mediawiki.org]</pre>
|[http://mediawiki.org]
|-
|External link icons
|<pre>
[http://en.wikipedia.org/wiki/.avi video]
[http://en.wikipedia.org/wiki/.wav sound]
[http://en.wikipedia.org/wiki/.pdf document]
</pre>
External link icons may differ depending on the file type of the target.
|
[http://en.wikipedia.org/wiki/.avi video]
[http://en.wikipedia.org/wiki/.wav sound]
[http://en.wikipedia.org/wiki/.pdf document]
|-
|External link to the same host
|<pre>[http://{{SERVERNAME}}/pagename]</pre>
|[http://{{SERVERNAME}}/pagename]
|-
|External link to other host passing the pagename
|<pre>[http://google.com/search?q={{PAGENAMEE}}]</pre>
|[http://google.com/search?q={{PAGENAMEE}}]
|-
|Mailto link
|<pre>[mailto:info@example.org email me]</pre>
|[mailto:info@example.org email me]

|}

<source lang="css">
#bodyContent a.external,
#bodyContent a[href ^="gopher://"] {
background: none;
padding-right: 0;
}
</source>
}}

=== How to avoid auto-links ===
By default, when you write a URL as is, it will be transformed to an external link.

To avoid that effect, put the URL between <code><nowiki></code> tags as in:
<nowiki><nowiki>http://mediawiki.org</nowiki></nowiki>

Help:Editing

2009-08-25T12:31:29Z

Yarden:

for navigation help, see [[Templates:Navbar]]

== Color Writing==
<nowiki>TEXT</nowiki>

==Tip Box==
{| 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;"
! <h2 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</h2>
|-
| style="color:#000;" | <div id="mp-tfa">TEXT TEXT TEXT TEXT TEXT TEXT TEXT TEXT TEXT TEXT </div>
|}
|}

<pre>
{| 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;"
! <h2 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</h2>
|-
| style="color:#000;" | <div id="mp-tfa">TEXT TEXT TEXT TEXT TEXT TEXT TEXT TEXT TEXT TEXT </div>
|}
|}</pre>

== Text formatting markup ==
{| class="wikitable"
! style="width:15%" |Description
! style="width:45%" |You type
! style="width:40%" |You get
|-
! colspan="3" align="center" style="background:#A7C1F2" | character formatting - ''applies anywhere''
|-
|Italic text
|<pre>''italic''</pre>
|''italic''
|-
| Bold text
|<pre>'''bold'''</pre>
|'''bold'''
|-
| Bold and italic
|<pre>'''''bold & italic'''''</pre>
|'''''bold & italic'''''
|-
|Escape wiki markup
|
<pre><nowiki>no ''markup''</nowiki></pre>
|<nowiki>no ''markup''</nowiki>
|-
! colspan="3" align="center" style="background:#A7C1F2"| section formatting - ''only at the beginning of the line''
|-
|Headings of different levels
|
<pre>=level 1=
==level 2==
===level 3===
====level 4====
=====level 5=====
======level 6======</pre>
An article with four or more headings will automatically create a [http://en.wikipedia.org/wiki/Wikipedia:Section#Table_of_contents_.28TOC.29 table of contents].

|

<div style="font-size: 188%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa;">Level 1</div>
<div style="font-size: 150%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa;">Level 2</div>
<div style="font-size: 132%; border-bottom: none; font-weight: bold;">Level 3</div>
<div style="font-size: 100%; border-bottom: none; font-weight: bold;">Level 4</div>
<div style="font-size: 86%; border-bottom: none; font-weight: bold;">Level 5</div>
<div style="font-size: 80%; border-bottom: none; font-weight: bold;">Level 6</div>
|-
|Horizontal rule
|
<pre>----</pre>
|
----
|-
|Bullet list
|
<pre>
* one
* two
* three
** three point one
** three point two
</pre>
Inserting a blank line will end the first list and start another.
|
* one
* two
* three
** three point one
** three point two
|-
|Numbered list
|
<pre>
# one
# two several lines without breaking numbering
# three
## three point one
## three point two
</pre>
|
# one
# two spanning several lines without breaking the numbering
# three
## three point one
## three point two
|-
|Definition list
|
<pre>
;item 1
:definition 1
;item 2
:definition 2-1
:definition 2-2
</pre>
|
;item 1
:definition 1
;item 2
:definition 2-1
:definition 2-2
|-
| Adopting definition list to indent text
|
<pre>:Single indent
::Double indent
:::::Multiple indent</pre>
This adoption may be controversial from the viewpoint of accessibility.
|
:Single indent
::Double indent
:::::Multiple indent
|-
| Mixture of different types of list
|
<pre>
# one
# two
#* two point one
#* two point two
# three
#; three item one
#: three def one
# four
#: four def one
#: this rather looks like the continuation of # four
#: and thus often used instead of 
# five
## five sub 1
### five sub 1 sub 1
## five sub 2
;item 1
:* definition 1-1
:* definition 1-2
:
;item 2
:# definition 2-1
:# definition 2-2
</pre>
The usage of <code>#:</code> and <code>*:</code> for breaking a line within an item may also be controversial.
|
# one
# two
#* two point one
#* two point two
# three
#; three item one
#: three def one
# four
#: four def one
#: this rather looks like the continuation of <code># four</code>
#: and thus often used instead of <code><nowiki> </nowiki></code>
# five
## five sub 1
### five sub 1 sub 1
## five sub 2
;item 1
:* definition 1-1
:* definition 1-2
:
;item 2
:# definition 2-1
:# definition 2-2
|-
|-
|Preformatted text
|
<pre>
preformatted text is done with
a '''space''' at the
''beginning'' of the line
</pre>
This way of preformatting only applies to section formatting, and character formatting markups are still effective.
|
preformatted text is done with
a '''space''' at the
''beginning'' of the line
|}

== HTML ==
Some [[wikipedia:HTML|HTML]] tags are allowed in MediaWiki, for example <code><nowiki><code></nowiki></code>, <code><nowiki><div></nowiki></code>, <code><nowiki></nowiki></code> and <code><nowiki></nowiki></code>. These apply anywhere you insert them.

{| class="wikitable"
!Description
!You type
!You get
|-
| Strikethrough
|<pre><del>Strikethrough</del></pre>
|<del>Strikethrough</del>
|-
|Fixed width text
|
<pre><tt>Fixed width text</tt></pre>
|
<tt>Fixed width text</tt>
|-
|Blockquotes
|
<pre>
text text text text text
text text text text text
<blockquote> quote quote quote </blockquote>
text text text text text
</pre>
|
text text text text text text text text text text text text
text text text text text text text text text text text text
<blockquote> quote quote quote quote quote quote </blockquote>
text text text text text text text text text text text text
|-
|Comment
|
<pre></pre>

Text can only be viewed in the edit window.
|

|-
|Completely preformatted text
|
<pre><pre>all markups are '''ignored'''</pre></pre>
|
<pre>
this way, all markups are '''ignored'''</pre>
|}

== Internal links ==
To add an internal link, enclose the name of the page you want to link to in double square brackets. When you save the page, you'll see the new link pointing to your page. If the page exists already it is displayed in blue, if it does not, in red.
Selflinks to the current page are not transformed in URLs but displayed in bold.
(If you really want to link to the current page, use an anchor (see below), or <nowiki>[[#top|current page]]</nowiki> which always links to the top.)

The first letter of the target page is automatically capitalized, unless otherwise set by the admins, and spaces are represented as underscores (typing an underscore in the link will have a similar effect as typing a space, but is not recommended, since the underscore will also be shown in the text).

{| border="1" class="wikitable"
!Description
!You type
!You get
|-
|Internal link
|<pre>[[Main Page]]</pre>
|[[Main Page]]
|-
|Piped link
|<pre>[[Main Page|different text]]</pre>
|[[Main Page|different text]]
|-
|Redirect
|<pre>#REDIRECT [[Main Page]]</pre>
See also [[Help:Redirects]]
| → [[Main Page]]
|-
|Internal link to an anchor
|<pre>[[#See also]]</pre>
[[Help:Formatting|Section headings]] and the [[#top|top]] of the page are automatically anchored.
|[[#See also]]
|-
|Internal link to an anchor at another page
|<pre>[[Help:Images#See also]]</pre>
|[[Help:Images#See also]]
|-
|Internal link to the current page's talk page
|<pre>[[{{TALKPAGENAME}}|Discussion]]</pre>
See also [[Help:Magic_words#Page_names]]
|[[{{TALKPAGENAME}}|Discussion]]
|-
|Internal link to a subpage
|<pre>[[/example]]</pre>
Shortcut for <nowiki>[[Help:Links/example]]</nowiki>.
|[[/example]]
|-
|Internal link to a category page
|<pre>[[:Category:Help]]</pre>
See also [[Help:Categories]]
|[[:Category:Help]]
|-
|Internal link to an image or a file of other types
|<pre>[[media:example.jpg]]

[[media:example.pdf]]</pre>
See also [[Help:Images]]
|[[media:example.jpg]]

[[media:example.pdf]]
|}
== External links ==
{| border="1" class="wikitable"
!style="width:15%"|Description
!style="width:45%"|You type
!style="width:40%"|You get
|-
|External link
|<pre>http://mediawiki.org</pre>
|http://mediawiki.org
|-
|External link with different label
|<pre>[http://mediawiki.org MediaWiki]</pre>
|[http://mediawiki.org MediaWiki]
|-
|External link numbered
|<pre>[http://mediawiki.org]</pre>
|[http://mediawiki.org]
|-
|External link icons
|<pre>
[http://en.wikipedia.org/wiki/.avi video]
[http://en.wikipedia.org/wiki/.wav sound]
[http://en.wikipedia.org/wiki/.pdf document]
</pre>
External link icons may differ depending on the file type of the target.
|
[http://en.wikipedia.org/wiki/.avi video]
[http://en.wikipedia.org/wiki/.wav sound]
[http://en.wikipedia.org/wiki/.pdf document]
|-
|External link to the same host
|<pre>[http://{{SERVERNAME}}/pagename]</pre>
|[http://{{SERVERNAME}}/pagename]
|-
|External link to other host passing the pagename
|<pre>[http://google.com/search?q={{PAGENAMEE}}]</pre>
|[http://google.com/search?q={{PAGENAMEE}}]
|-
|Mailto link
|<pre>[mailto:info@example.org email me]</pre>
|[mailto:info@example.org email me]

|}

<source lang="css">
#bodyContent a.external,
#bodyContent a[href ^="gopher://"] {
background: none;
padding-right: 0;
}
</source>
}}

=== How to avoid auto-links ===
By default, when you write a URL as is, it will be transformed to an external link.

To avoid that effect, put the URL between <code><nowiki></code> tags as in:
<nowiki><nowiki>http://mediawiki.org</nowiki></nowiki>

Tickets

2009-08-24T15:05:05Z

Yarden: /* Service Management Flow */

{{servicemanagement}}

Manage your business using '''Tickets''' feature in CommitCRM.

__TOC__

== Service Management Flow ==
The basic flow includes the following steps (click each step to learn more about it):

<div class="center">'''[[Tickets#Open the Account Window|Open the Account Window]]''' Find an existing Account or create a new one

V

'''[[Tickets#Create a New Ticket|New ticket]]''' A Customer creates a Ticket via the [[Web Interface]] or A Technician creates a Ticket via the Application or the [[Web Interface]]

V

'''[[Tickets#Dispatch the Ticket|Dispatch]]''' (optional): If the Ticket requires an Appointment (i.e. an on-site visit), Dispatch the Ticket to the correct technician

V

'''[[Tickets#Resolve the Ticket|Resolve]]''' Add '''Charges''' describing the work done and '''Resolve''' the Ticket

V

'''[[Tickets#Bill the Customer|Bill the customer]]''' If the Charge is Billable – create [[Charges#Using CommitCRM Charge Reports|Charges reports]] or [[Invoices]]
</div>

==New Ticket Flow==
This section will demonstrate how to create a new Ticket for an [[Accounts|Account]], and how to easily dispatch it to the relevant technician.

=== Before you start ===
This guide assumes you already have some Accounts in the system. You can create Accounts by importing Accounts from Outlook, QuickBooks or any other data source. You can read more about how to import Accounts into CommitCRM in the [[New Users|CommitCRM Setup Guide]].

You can also create an Account manually from within CommitCRM:

#From the Accounts Window, click the '''New''' icon .
# Fill in the Account details.
#Click '''OK''' to save.

===Open the Account Window===
At the top of the Account window, there is a Search pane. Using the '''Find''' field, you can search for an Account by any keyword, or you can '''search''' according to specific fields, such as phone numbers, company name, etc.

Once the search word has been typed, hit the Enter key or click Refresh.
You will now see a filtered list of Accounts which includes only those who match the search criteria.

[[File:tutorial_accounts_window.gif|center]]

Note that you can also do a quick search by type, by selecting the '''[all types]''' drop down list and selecting the relevant type.

Once the desired Account appears in the search results list, double-click it to see its complete details.

Note that the Accounts list has several possible '''Views''': Complete Details, List and Details, List, Business Cards, List and Complete Details. You can select the display using the View menu on the top right-corner of the window

[[File:tutorial_accounts_view_menu.gif|center]]

Also note that the blue '''Accounts''' on this tool bar is a menu which contains options which are relevant for Accounts only, this menu is also available in the '''Main menu > Accounts'''.

===Create a New Ticket===
From the Account window, you can create a new Ticket in the following ways:

#From the Tickets, tab, click the New icon on the bottom of the tab.
#Click the More Actions button on the tool bar and select '''New ticket for Account'''.
#From the Main menu, select '''File > New > Ticket...''' Note that this option will not automatically use the selected Account - you need to use one of the Account options (the first two) for this.

Repeat the first step (click the new icon from the Tickets tab).

The''' New Ticket''' window opens:

[[File:tutorial_ticket_new_window.gif|center]]

'''New Ticket window'''

*'''Account''' - The Account is already selected since the Ticket was opened from within a specific Account. Note: If you wish to open a Ticket for a new Account, you can click the '+' in the Account field to add a new Account. 
**The Account's Description In the box beneath the Account name, you will see a summary of the Account's '''Description''' and the '''Service Internal Description'''. You can use the Account's Internal Description in order to keep special comments regarding the service level for this customer, which should be displayed to the user whenever opening a Ticket.
**Other Open Tickets for the Account In the box beneath the description, you can see a list of other Tickets which already exist for this Account. By reviewing this list before creating new Tickets, you can make sure that duplicate tickets are not created for reported issues. If you do find a matching Ticket during the process of creating a new one, you can simply double-click the existing ticket, and the new Ticket creation will be aborted and the existing Ticket's details will be displayed. 
*'''Contract''' - If no other contract was defined for the Account, the '''Global System Contract''' will be used as the default contract. At this stage, we will use the default contract to demonstrate a simple scenario. 
*'''Show ticket in Dispatcher''' - When this flag is set, the Ticket will be available for dispatching in the Dispatcher window tickets list. Note that Tickets that should not be dispatched for appointments should be set with an un-checked flag. 
*'''Manager''' - The manager is the person who is in charge of the Ticket. This is not necessarily the same person who will actually perform the work for the Ticket. Each Ticket can later be dispatched to several technicians to perform the actual work in several appointments/tasks. 
*'''Ticket Description''' - The Ticket Description should be entered in this field.
*Click '''OK''' to Save

The New Ticket is now displayed with all the other Ticket details. You can now fill in the rest of the Ticket information as follows:

[[File:tutorial_ticket_details_window.gif|center]]

*You can set a different '''Ticket Priority''' (the default is Normal)
*You can set the Due Date for the Ticket. When the Due Date is reached, it will appear in Red.
*In the Details Tab you can update details about the cause, source and category for this Ticket.
*The '''Estimated Work Duration''' is there to help when dispatching. For example, when you set it to 120 minutes, and drag/drop the Ticket from the Tickets list on to the Dispatcher window, the duration of the scheduled on-site visit is automatically set for 120 minutes, rather than the default of 30 minutes.
*You can also add additional '''Notes''' in the Notes field.
*'''Save''' your changes once done.

===Dispatch the Ticket===
The CommitCRM Dispatcher allows you to easily view tickets pending and the technicians calendars in order to dispatch tickets for on-site visits. Once the Ticket is entered into CommitCRM, it appears in the Dispatcher window as "Waiting for Dispatching". Note that you can set the Ticket to not appear in the Dispatcher, for example when there is no need to set any appointments for this Ticket.

The Dispatcher lets you appoint the relevant technicians to the Appointments set for this Ticket.

[[File:tutorial_dispatcher_window.gif|center]]

Dispatch the Ticket
#Open the Dispatcher Window, and on the bottom you will see the '''Tickets Marked for Dispatching '''tab.
#Above this list you can see the '''Dispatcher''' window which consists of a daily view of Appointments per technician. You can view technicians' calendars using the magnifying glass tutorial_magnifying_glass
#Select the Ticket in the list using the mouse and '''drag''' it to the Dispatcher view above, '''dropping''' it on the relevant technician calendar in the desired time for the Appointment.
#A new '''Appointment window''' opens. [[File:tutorial_dispatcher_appointment.gif|center]] 
#Most of the relevant information is already there since it is taken from the Ticket – the Ticket Description, the Account, the Ticket, the owner (who is the employee which you dropped the ticket onto in the Dispatcher window), the date and the duration (taken from the Ticket).
#Add details to the description if needed, such as describe what is the purpose of the appointment for the technician.
#You can optionally set different background colors to represent different technicians' appointments, priority levels, etc.
#'''Click OK''' to save the Appointment.

{| 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;"
! <h2 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 easily add Account details, such as Name, Phone Number, etc, to Appointments set in the Dispatcher window by clicking the yellow arrow next to the Account name in the Appointment window.

You can also set Appointments to automatically contain the Account details in the Appointment description. To do this, go to '''Tools > Options > Calendar > Miscellaneous''' and check the '''Attach Account Details to Description''' box.</div>
|}
|}

At this point, technicians can view their new Appointments in their Calendars using the Application or the Web Interface - See the [[Tickets#On-Site Visits|On-Site Visits]] section.

You can also view the Ticket scheduled appointments in the Ticket's '''Pending''' tab (see [[History#Viewing Ticket History|Viewing Ticket History]]).

===Add Tasks for Tickets===
Other than Dispatching a Ticket and setting Appointments to the technicians, you can also manage Tasks for the Ticket.

You can set reminders to Tasks so this may help you set reminders to perform certain actions before going on site (e.g. remember to take an additional cartridge for the Printer).

You can also use the Tasks in order to track complex Tickets which require several on-site visits and should be coordinated and actively tracked. For example, a technician may need to install a new network at a customer site, which involves buying parts and then installing them over a series of on-site visits. You may set a daily reminder to follow up on the project's status by adding a recurring task over the duration of the project.

Another helpful option is adding tasks and appointments from activity templates. This allows you to add a predefined group of common tasks and appointments to the ticket at once. You can read more about activity templates in the Activity Templates user guide here.

Once you create a Task that is linked to a certain Ticket, you can view all the tasks for a Ticket in the Ticket's '''Pending''' tab.

[[File:tutorial_ticket_pending_tab.gif|center]]

==Create a New Ticket from the Web Interface==
The Web Interface allows employees and customers to open new Tickets which will be added to the database.

It is recommended to read the [[Web Interface|Web Interface Manual]].

The following steps assume the Web Interface is installed and that Web users were defined for the relevant employee (Learn more about the [[Web Interface|Commit Web Interface]]).

#To open a new Ticket, login to the Web Interface
#Go to the '''Accounts''' tab and click '''View''' for a certain Account.
#From the Account window, click '''Create for Account''', and select '''Ticket'''. [[File:tutorial_web_ticket_new_menu.gif|center]] 
#In the New Ticket window, the Account is already selected , as we created the Ticket from within the Account (you can click +/- to expand the Account details). The System Global Contract will already be selected. All you need to do is enter the '''Description''' and you are done. You can set also other values such as the Ticket Type, Cause, Due date, etc. Note that the Web Interface New Ticket window contains more information than the Client Application. Not all the information is mandatory, and you may fill it in now or at a later stage.
#Click '''Save''' to add the Ticket. [[File:tutorial_web_new_ticket_window.gif|center]]

===Create New Tickets from the Web Interface as a Customer===
Your customers may use the Web Interface for Customers module which allows them to view, edit and create data in CommitCRM.

Customers can create new Tickets from the Tickets window.

#In the Tickets tab, click the '''New Ticket''' link or click '''Create New''' and select Ticket.
#The new Ticket window will open. [[File:tutorial_web_ticket_new_window_customer.gif|Center]] 
#Fill in the '''Description'''. You may also enter the Cause and Type. 
# Click '''Save'''

{| 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 set a default '''Type''' to be used when creating new Tickets. To do this, use the Client Application, double-click on the "Type:" field label, and the field setting window will open. Go to the '''Field Behavior''' tab and set the '''Default Value'''. </div>
|}
|}

The new Ticket is immediately updated in the CommitCRM database, and can be viewed from any CommitCRM Client Application.

You can also automatically send [[Alerts Server|email alerts]] to predefined lists of email addresses.

Learn more about setting up automatic emails in our [[FAQ]] section.

==On-Site Visits==
When you have an on-site appointment, it is helpful to be able to view the Ticket details before and during the visit, or while on the road:

===Before You Leave the Office===
Before you leave the office to go on-site, you may wish to:
#Print out the Ticket details.
#View the Account address on a map.

Print Technician Service Forms

Before leaving on an on-site appointment, you can print a hard-copy of the Ticket details, including the Account details (address, phone number, etc.) and the Ticket description and history. You may use one of the pre-defined Technician Service Forms or customize your own form.

You can create a Service Form for each Ticket from the Ticket window, using the '''Print''' icon. You can view the form before printing a hard-copy by clicking the '''Print Preview''' icon. You can also print it directly to a PDF file (English fonts only) by clicking the '''Print to PDF''' icon.

#Click the arrow near the icon to open the available Service Forms list.
#Click the Icon itself to print out the default report. You can view which is the default report by opening the list with the arrow - the first report in the list, which appears in bold is the default for printing (you can set a different default for Tickets in '''Tools > Options > Tickets > Default Detailed Report''').

[[File:tutorial_ticket_print_icon_details.gif|center]]

View the Account address using the [[Commit Online Services|Online Services]]
You may wish to find the address of the Account you will be visiting before you set out. You can define your own Online Service which will open map sites (e.g. Google Maps, Yahoo! Maps etc.), and the map will automatically open to address of the Account or Contact stored in CommitCRM.

To activate the Online Service from within the Ticket, you can right click on the Account Name field to open a pop up menu, and select the Online Services menu option.

[[File:tutorial_ticket_right_click_account.gif|center]]

You can learn more about how to activate the CommitCRM [[Commit Online Services|Online Service]] on our [[FAQ]].

===On the road - Using [[Web Interface|Commit Web Interface]]===

While on the road, or when you are already at the customer's site, you may wish to Access CommitCRM's data in order to view the Ticket details, Account and Contract terms or print a service form to give to the customer.

Commit Web Interface

If you have Internet access, you can use the Commit Web Interface in order to view the Ticket details, History Notes, Contract information, Account address, phone numbers and more.

To install and use the Web Interface, read our simple Web Interface installation instructions on our Web site, under Support > Documents.

[[File:tutorial_web_accounts_list.gif|center]]

'''Account list on the Web'''

Service Forms

You can also print a Service Form via the Web interface:
#Click a Ticket to view its details.
#On the top-right corner, select the Service Form and click Print Preview... menu or click the Print Preview icon to print the default form
#The Print Preview window opens.
#Click the Print link.
#Optionally, you can also print the report to a PDF file. This option lets you print any ticket form report, including customized reports. To print to PDF files, click the Print report to PDF file menu and select the report you wish to print.

[[File:tutorial_web_service_form_menu.gif|center]]

==Resolve the Ticket==
Resolving a Ticket includes two main steps:
#[[Tickets#Add Charges|Add Charges]] for the Ticket
#[[Tickets#Set Ticket Status to Completed|Closing the Ticket]] (setting its status as Completed)

===Add Charges===
Charges are the way to log the work performed for the Ticket. Charges can be billable or not-billable (read more about Charges in the Introduction to Charges and Billing in CommitCRM), depending on the service agreement that was agreed upon with the customer.

In this demonstration, we will add a simple Labor Charge using the System Global Contract, and will set the Rate during the process:
#Open the '''Ticket''' window.
#Go to the '''Charges''' tab.
#Click the '''New''' icon at the bottom on the screen.
#Select '''Labor Charge'''.
#The new charge window will open. Note that the Account, Ticket and Contract are already selected according to the Ticket information. [[File:tutorial_charge_new_window.gif|center]] 
#Select the default''' Labor Item'''.
#Fill in the To-From time and click the total time button to copy it to the '''Hours '''field (you can manually enter the hours if you prefer).#Add a description of the work performed to keep a log of the activity.
#'''Save & Close.'''

Note:The Billable flag will be set by default. This is the default behavior for Global Contracts.

{| 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;"
! <h1 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">Adding the Charge appears as an event in the activity History of the Ticket Resolution/History tab, and in the Account History tab (check the '''Detail''' check box on the bottom-right corner of the History tab in order to view internal history events).

Note that you can go directly to the Account window from the Ticket by right-clicking the '''Account''' field in the ticket General tab and selecting '''Show Account'''</div>
|}
|}

====Using the Timer to Add Charges====
You can use the CommitCRM Timer in order to record activity for a certain Ticket and then convert it into a Charge. This is usually useful for activities like phone support.

You can activate the Timer from various places. First display the Ticket details and then:
*Click the '''Timer Icon'''.
*Or go to the '''Ticket Menu > Tools > New Timer''' option
*Or use the '''Ctrl+T''' keyboard shortcut, but make sure to have the correct Ticket/Account selected when performing this action.

[[File:tutorial_ticket_timer_icon.gif|center]]

'''How to activate the Timer'''

You can start and stop the Timer as many times as you need, and all time spent will be added to the total time (clicking on the magnifying glass will display all the time logged and you can right-click each line and delete it if needed).

[[File:tutorial_timer_window.gif|center]]

'''Timer window'''

Once you are finished timing and have completed the service, click the '''Add Charge''' button, and a new Charge window will open with the relevant Ticket and Account already selected. The total time from the Timer will be copied to the Charge '''Hours''' field.

====Using the Web Interface to Add Charges====
To add new Charges from the Web Interface:
#Go to the Ticket Details Window (click '''View''' for a specific Ticket)
#Click the''' Create for Ticket''' menu, and select the new Charge (Labor, Expense or Product/Part). You can also scroll down to the Charges tab and click the '''New Charge''' at the top of the Charges list.

[[File:tutorial_web_charge_new_link.gif|center]]

The New Charge window will open.

#Select the default '''Labor Item''', and fill in the '''Units''' and the '''Rate'''.
#Click '''Save'''.
#Note that the Billable flag will be set by default – this is the default behavior for Global Contracts.

[[File:tutorial_web_charge_new_window.gif|center]]

===Set Ticket Status to Completed===
After performing the work for the Ticket and adding Charges, the Ticket can be resolved:
#Open the Ticket window.
#Go to the Resolution tab and fill in the resolution description. This should be a short summary of the work performed in order to resolve the ticket.
#Click the Completed button on the toolbar.

[[File:tutorial_ticket_completed_icon.gif|center]]

At this point, the Ticket's status becomes Completed.

You can view the Completed Ticket list in the Tickets window by selecting [closed] on the status filter. This will display all Tickets that have a status which is considered "'''closed'''".

===Ticket Resolution vs. Charges===
The Ticket Resolution/History tab contains:
#Charges list - the Charges are the way to log the work performed for a Ticket.
#Resolution - once the Ticket is resolved, you can add a short summary which is the Ticket Resolution. You can edit the Resolution in the top edit area in the Resolution/History tab.

[[File:tutorial_ticket_resolution_tab.gif|center]]

Benefits of using Charges to log the work Using Charges to log work performed for a Ticket provides a much more detailed history log of the Ticket activity, and it allows you to better analyze the work at a later date. You will be able to analyze which Items you use most, how much time you spend on each customer or on each type of Ticket, view charges by Employees, etc. The more information you keep in your system, the better analyses can be performed on it later.

Charges are also the way you can bill your customer - each Charge can be sent to the customer using CommitCRM Reports or can be the base for a new QuickBooks Invoice (see [[Billing]]).

Using Resolution rather than Charges
In some cases you may not wish to log the work performed for the Ticket using a Charge (i.e. you do not plan to bill the customer for this work). In this case the Ticket resolution can be used to log the work, rather than the Charges.

==See Also==
*[[Web Interface]]
*[[Billing]]
*[[Charges]]
*[[History]]
*[[Tickets FAQ]]
*[[Dispatcher & Calendar FAQ|Dispatcher FAQ]]
[[Category:Service Management]]
[[Category:Work Flows]]

Online Services

2009-08-23T09:07:17Z

Yarden: /* Displaying Domain WHOIS */

{{integration}}

Commit's '''Online Services''' is a powerful feature which allows you to link to web sites (URL) and activate the web application using parameters taken from CommitCRM.

You can define as many online Services as you wish. This feature is available for the following entities: Accounts, Tickets, Assets, Items, Contracts, Knowledge Base Articles and Oppotrunities.
*Accounts window
*Tickets window
*Dispatcher window
*Asset window
*Items window
*Contracts window
*Opportunities window

==What can I use Online Services for?==
Wouldn't you like your technicians to be able to find an address for a scheduled visit with just a single click? You can do this by defining an Online Service which will open maps site (e.g. Google Maps, Yahoo! Maps etc.) and the map will open automatically on the address of the Account or Contact stored in CommitCRM.

This powerful tool allows you to define any URL and open it with parameters. You can basically do with it whatever you want.

==Adding new Online Services==
To define a new Online Service, Open the Online Services Management window from Settings > Online Services. or click the Online Services icon from the Accounts window toolbar. Click the New button to add a new Online Service and enter the following parameters:

*'''Name''' - The name of the service which will be displayed in the Online Services list and menus throughout the system, for example, "Google Maps".
*'''Base URL''' - The URL you wish to open in order to use the Service. This is the address of the main service (before passing any parameters to it), for example http://maps.google.com/maps.
*'''URL Parameters''' - Parameters which will be appended to the URL in order to create specific queries when opening the URL. These parameters can be CommitCRM Account database fields which will be taken and filled from CommitCRM when clicking the Online Service.

See the Tips and Tricks for examples of useful Online Services

==Activating Online Services==
Online Services can be activated from various places in CommitCRM including:
*The '''Account, Ticket, Asset, Item, Opportunity, Contract, Knowledge Base Article windows''' - click the Online Services icon to activate the service for the selected account
*The '''Dispatcher Windows''' - right-click on a selected Ticket to run any Online Service for the Ticket's Account or Contact (such as displaying a map).
*The '''Calendar / Scheduled Appointments''' views - right-click above an Appointment and select Online Services.
*The '''secondary Contacts tab''' - select a Contact, right-click and select Online Services
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.
*'''Secondary Contact selection''' field - right-click and select Online Services.
*The '''Relations tab under Account''' - right-click and select Online Services.

==Possible Usage==
*'''Online Services and Assets''' – Access your MSP product online and pass the Asset ID to display its details from your external system
*'''Online Services and Items''' – Search for better prices for items by passing specific item information directly from within CommitCRM.
*'''Online Services for Assets''' – Search for a specific product review by its hardware serial number.
*'''Online Services for Tickets''' – Search in online knowledge bases for solutions based on the ticket description
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.

==Using Lookup Fields==
Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket.

This way you can define an Online Service for the Ticket, which will be activated from the Ticket window and will be using Account information.

Lookup Field syntax:

<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>

Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account
FLDCRDADDRESS1 is the account's Address field

==Tips & Tricks==
Following are examples of possible Online Services configurations.
These examples are intended to explain the use of Online Services only.

Disclaimer - Before defining your Online Services you should read the terms of use for each web site you want to access. The examples below are displayed to explain how to use online services and how to pass parameters.

===Displaying Online Maps===
'''Google Maps''' - Opens Google Maps and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Maps
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDCRDADDRESS1>+<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDSTATE>+<CMTLBLDATA_FLDCRDZIP>
|}

'''MapQuest''' - Opens MapQuest Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| MapQuest
|-
| Base URL
| <nowiki>http://www.mapquest.com/maps</nowiki>
|-
| URL Parameters
| /map.adp?searchtype=address&country=<CMTLBLDATA_FLDCRDCOUNTRY>&addtohistory=&searchtab=home&formtype=address&popflag=0&latitude=&longitude=&name=&phone=&level=&cat=&address=&city=<CMTLBLDATA_FLDCRDCITY>&state=<CMTLBLDATA_FLDCRDSTATE>&zipcode=<CMTLBLDATA_FLDCRDZIP>
|}

'''Yahoo! Maps''' - Opens Yahoo! Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Yahoo! Maps
|-
| Base URL
| <nowiki>http://maps.yahoo.com</nowiki>
|-
| URL Parameters
| /maps_result?addr=<CMTLBLDATA_FLDCRDADDRESS1>&csz=<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDCOUNTRY>&country=<CMTLBLDATA_FLDCRDSTATE>
|}

===Finding Account Information===
'''Google Company''' - Opens Google and searches for the Account Company Name.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Company
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCOMPANY>
|}

'''Google Contact''' - Opens Google and searches for the Contact Name.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Contact
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCONTACT>
|}

===Finding Ticket Description in Google===
'''Google Ticket''' - Opens Google and searches for the Ticket description.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket Description
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDTKTPROBLEM>
|}

===Finding Account Address From Ticket (using [[Commit Online Services#Using Lookup Fields|Lookup Field]]) ===
'''Google Address From Ticket''' - Opens Google and searches for the Address of the Account which is linked to the Ticket.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDCITY>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDSTATE>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDZIP>
|}

===Displaying Products Warranties Online===
'''HP Warranty Lookup''' - Displays HP products warranty expiration dates, using the products number and the products serial number.

Note: Product Number goes into Plate# field (<CMTLBLDATA_FLDASTUSER1>).

'''Contributed by Easy I.T'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| HP Warranty Lookup
|-
| Base URL
| <nowiki>http://h20000.www2.hp.com/bizsupport/TechSupport/WarrantyResults.jsp?</nowiki>
|-
| URL Parameters
| lang=en&cc=us&prodSeriesId=454811&prodTypeId=12454&sn=<CMTLBLDATA_FLDASTSERIALNO>&pn=<CMTLBLDATA_FLDASTUSER1>&country=US&nickname=&find=Display+Warranty+Information+%C2%BB
|}

'''DELL Service Contracts and Warranties''' - Displays Dell products warranty expiration dates, using the service tag number.

Note: Customize a Field for Service Tag or use existing field. In this sample we will use Field3 as custumized Service Tag Field

'''Contributed by JoshuaB'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| Dell Warranty Check
|-
| Base URL
| <nowiki>http://support.dell.com/support/topics/global.aspx/support/my_systems_info/details</nowiki>
|-
| URL Parameters
| ?c=us&l=en&s=gen&servicetag=<CMTLBLDATA_FLDASTUSER3>
|}

===Displaying Domain WHOIS===

'''Network Solutions Domain WHOIS''' - WHOIS domain registration information by Network Solutions.

Note: Domain must be stripped from URL (without <nowiki>http://</nowiki>).

'''Contributed by DavidW'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (NetworkSolutions)
|-
| Base URL
| <nowiki>http://www.networksolutions.com/whois-search/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''Domain Tools Domain WHOIS''' - WHOIS domain registration information by Domain Tools.

Note: Domain must be stripped from URL (without <nowiki>http://</nowiki>).

'''Contributed by ajgyomber'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DomainTools)
|-
| Base URL
| <nowiki>http://whois.domaintools.com/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''DNSstuff Domain WHOIS''' - WHOIS domain registration information by DNSstuff.

Note: Domain must be stripped from URL (without <nowiki>http://</nowiki>).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DNSstuff)
|-
| Base URL
| <nowiki>http://www.dnsstuff.com/dnslite/?r=u2r&domain=</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

===Displaying Online Work Orders Status===
'''Work Orders Status Check''' - Track your orders statuses in <nowiki>onforce.com</nowiki>

Note: Set Field1 to order number or change the parameter (<CMTLBLDATA_FLDTKTUSER1>) to a different field.

'''Contributed by secion8'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Tickets
|-
| Name
| Work Orders Status (onforce.com)
|-
| Base URL
| <nowiki>http://www.onforce.com/?action=pcc_work_order_view&id=</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDTKTUSER1>
|}

===N-central===

'''Show Account and Asset information directly in N-central.'''

'''Contributed by ajgyomber'''

Note: You'll need to replace "server.n-able.com", "email@domain.com" and "your_actual_password" with your actual information.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| N-central Dashboard
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=defaultDashboard&username=email@domain.com&password=your_actual_password
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Device Details
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceDetails&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Device Services
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceService&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Launch Remote Control
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceRC&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| N-central NOC View
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=nocView&username=email@domain.com&password =your_actual_password
|}

==Parameters list==

===Parameters List for Accounts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account Number
| <CMTLBLDATA_FLDCRDCARDID2>
|-
| Address: City
| <CMTLBLDATA_FLDCRDCITY>
|-
| Address: Country
| <CMTLBLDATA_FLDCRDCOUNTRY>
|-
| Address: Line1
| <CMTLBLDATA_FLDCRDADDRESS1>
|-
| Address: Line2
| <CMTLBLDATA_FLDCRDADDRESS2>
|-
| Address: Line3
| <CMTLBLDATA_FLDCRDADDRESS3>
|-
| Address: State
| <CMTLBLDATA_FLDCRDSTATE>
|-
| Address: ZIP Code
| <CMTLBLDATA_FLDCRDZIP>
|-
| Assistant
| <CMTLBLDATA_FLDCRDASSISTANT>
|-
| Birthday
| <CMTLBLDATA_FLDCRDBIRTHDAY>
|-
| Company name
| <CMTLBLDATA_FLDCRDCOMPANY>
|-
| Contact: First & Last Name
| <CMTLBLDATA_FLDCRDCONTACT>
|-
| Dear
| <CMTLBLDATA_FLDCRDDEAR>
|-
| Department
| <CMTLBLDATA_FLDCRDDEPARTMENT>
|-
| E-Mail Address 1
| <CMTLBLDATA_FLDCRDEMAIL1>
|-
| E-Mail Address 2
| <CMTLBLDATA_FLDCRDEMAIL2>
|-
| Fax Number
| <CMTLBLDATA_FLDCRDFAX1>
|-
| Fax Number Extention
| <CMTLBLDATA_FLDCRDFAXDESC1>
|-
| Field
| <CMTLBLDATA_FLDCRDPERSONID>
|-
| Field1
| <CMTLBLDATA_FLDCRDUSER2>
|-
| Field2
| <CMTLBLDATA_FLDCRDUSER3>
|-
| Field3
| <CMTLBLDATA_FLDCRDUSER4>
|-
| Field4
| <CMTLBLDATA_FLDCRDUSER5>
|-
| Field5
| <CMTLBLDATA_FLDCRDCOMPANYNO>
|-
| File as
| <CMTLBLDATA_FLDCRDFULLNAME>
|-
| ID
| <CMTLBLDATA_FLDCRDCARDID3>
|-
| Last Name
| <CMTLBLDATA_FLDCRDLASTNAME>
|-
| Phone 1
| <CMTLBLDATA_FLDCRDPHONE1>
|-
| Phone 1 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC1>
|-
| Phone 2
| <CMTLBLDATA_FLDCRDPHONE2>
|-
| Phone 2 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC2>
|-
| Phone 3
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Phone 3 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC3>
|-
| Phone 4
| <CMTLBLDATA_FLDCRDPHONE4>
|-
| Phone 4 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC4>
|-
| Popup Message
| <CMTLBLDATA_FLDCRDCARDMESSAGE>
|-
| Region
| <CMTLBLDATA_FLDCRDREGIONCODE>
|-
| Salutation
| <CMTLBLDATA_FLDCRDSUFFIX>
|-
| Status
| <CMTLBLDATA_FLDCRDUSER1>
|-
| Sub-Contact Code
| <CMTLBLDATA_FLDCRDSUBCODE>
|-
| Title
| <CMTLBLDATA_FLDCRDTITLE>
|-
| Type
| <CMTLBLDATA_FLDCRDKIND>
|-
| Web Address 1
| <CMTLBLDATA_FLDCRDURL1>
|-
| Web Address 2
| <CMTLBLDATA_FLDCRDURL2>
|}

===Parameters list for Assets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTACCRECID>
|-
| Asset Code
| <CMTLBLDATA_FLDASTASSETCODE>
|-
| Asset Type
| <CMTLBLDATA_FLDASTASSETTYPE>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTCONTACTRECID>
|-
| Create Date
| <CMTLBLDATA_FLDASTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDASTCREATEUSER_FLDWRKNICKNAME>
|-
| Purchase Date
| <CMTLBLDATA_FLDASTCUSTPURDATE>
|-
| Purchased From Us
| <CMTLBLDATA_FLDASTCUSTPURFROMUS>
|-
| Purchase Our Invoice #
| <CMTLBLDATA_FLDASTCUSTPUROURINV>
|-
| Customer PO
| <CMTLBLDATA_FLDASTCUSTPURPO>
|-
| Purchase Price
| <CMTLBLDATA_FLDASTCUSTPURPRICE>
|-
| Delivered Date
| <CMTLBLDATA_FLDASTDELIVEDATE>
|-
| Description
| <CMTLBLDATA_FLDASTDESC>
|-
| Installed By
| <CMTLBLDATA_FLDASTINSTALBY_FLDWRKNICKNAME>
|-
| Installed Date
| <CMTLBLDATA_FLDASTINSTALDATE>
|-
| License Codes
| <CMTLBLDATA_FLDASTLICENSECODE>
|-
| License Keys
| <CMTLBLDATA_FLDASTLICENSEKEYS>
|-
| License Notes
| <CMTLBLDATA_FLDASTLICENSENOTES>
|-
| Location
| <CMTLBLDATA_FLDASTLOCATION>
|-
| Manufacturer
| <CMTLBLDATA_FLDASTMANUFACTURER>
|-
| Manufacturer Serial No.
| <CMTLBLDATA_FLDASTMNFSERIALNO>
|-
| Model
| <CMTLBLDATA_FLDASTMODEL>
|-
| Asset Name
| <CMTLBLDATA_FLDASTNAME>
|-
| Notes
| <CMTLBLDATA_FLDASTNOTES>
|-
| PARENTASSETRECID
| <CMTLBLDATA_FLDASTPARENTRECID>
|-
| Quantity
| <CMTLBLDATA_FLDASTQUANTITY>
|-
| Record ID
| <CMTLBLDATA_FLDASTRECID>
|-
| Serial No.
| <CMTLBLDATA_FLDASTSERIALNO>
|-
| Status
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Last Update date
| <CMTLBLDATA_FLDASTUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDASTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDASTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDASTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDASTUSER3>
|-
| Field4
| <CMTLBLDATA_FLDASTUSER4>
|-
| Field5
| <CMTLBLDATA_FLDASTUSER5>
|-
| Date1
| <CMTLBLDATA_FLDASTUSERDATE1>
|-
| Number1
| <CMTLBLDATA_FLDASTUSERNUMBER1>
|-
| Vendor Purchased Date
| <CMTLBLDATA_FLDASTVENDORDATEPURC>
|-
| Vendor Invoice #
| <CMTLBLDATA_FLDASTVENDORINVNO>
|-
| Vendor Name
| <CMTLBLDATA_FLDASTVENDORNAME>
|-
| Vendor PO
| <CMTLBLDATA_FLDASTVENDOROURPO>
|-
| Vendor Price
| <CMTLBLDATA_FLDASTVENDORPRICE>
|-
| Vendor
| <CMTLBLDATA_FLDASTVENDORRECID>
|-
| Vendor Serial No.
| <CMTLBLDATA_FLDASTVENDORSERNO>
|-
| Vendor Warranty Exp. Date
| <CMTLBLDATA_FLDASTVENDORWARREXP>
|-
| Version
| <CMTLBLDATA_FLDASTVERSION>
|-
| Warranty/License Exp. Date
| <CMTLBLDATA_FLDASTWARREXPDATE>FLDASTWARREXPDATE
|}

===Parameters list for Contracts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTACCRECID>
|-
| Block - Used
| <CMTLBLDATA_FLDBCTAMOUNTUSED>
|-
| Code
| <CMTLBLDATA_FLDBCTCODE>
|-
| Contract Type Type
| <CMTLBLDATA_FLDBCTCONTRACTTYPE>
|-
| Create Date
| <CMTLBLDATA_FLDBCTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDBCTCREATEUSER_FLDWRKNICKNAME>
|-
| Default Item Expense ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMEXPNS>
|-
| Default Item Labor ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMLABOR>
|-
| Default Item Part ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMPART>
|-
| Description
| <CMTLBLDATA_FLDBCTDESCEXTERNAL>
|-
| Internal Description
| <CMTLBLDATA_FLDBCTDESCINTERNAL>
|-
| End Date
| <CMTLBLDATA_FLDBCTENDDATE>
|-
| Name
| <CMTLBLDATA_FLDBCTNAME>
|-
| Note
| <CMTLBLDATA_FLDBCTNOTE>
|-
| Record ID
| <CMTLBLDATA_FLDBCTRECID>
|-
| Start Date
| <CMTLBLDATA_FLDBCTSTARTDATE>
|-
| Status
| <CMTLBLDATA_FLDBCTSTATUS>
|-
| Last Update date
| <CMTLBLDATA_FLDBCTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDBCTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field 1
| <CMTLBLDATA_FLDBCTUSER1>
|-
| Field 2
| <CMTLBLDATA_FLDBCTUSER2>
|-
| Field 3
| <CMTLBLDATA_FLDBCTUSER3>
|}

===Parameters list for Items===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Currency
| <CMTLBLDATA_FLDITMCOINID>
|-
| Created by User
| <CMTLBLDATA_FLDITMCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDITMDESC>
|-
| Expense Type
| <CMTLBLDATA_FLDITMEXPITEMTYPE>
|-
| Labor Type
| <CMTLBLDATA_FLDITMFEEITEMTYPE>
|-
| Item Code
| <CMTLBLDATA_FLDITMITEMNO>
|-
| Group
| <CMTLBLDATA_FLDITMITEMTYPEGROUP>
|-
| Name
| <CMTLBLDATA_FLDITMNAME>
|-
| Notes
| <CMTLBLDATA_FLDITMNOTES>
|-
| Price Source
| <CMTLBLDATA_FLDITMPRICESOURCE>
|-
| Product/Part Type
| <CMTLBLDATA_FLDITMPRODITEMTYPE>
|-
| Record Id
| <CMTLBLDATA_FLDITMRECID>
|-
| Cost
| <CMTLBLDATA_FLDITMSTANDARDCOST>
|-
| Suspend
| <CMTLBLDATA_FLDITMSUSPENDED>
|-
| Price
| <CMTLBLDATA_FLDITMUNITPRICE>
|-
| Update Date
| <CMTLBLDATA_FLDITMUPDATEDATE>
|-
| Update User
| <CMTLBLDATA_FLDITMUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDITMUSER1>
|}

===Parameters list for Opportunities===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Amount
| <CMTLBLDATA_FLDOPPAMOUNT>
|-
| Amount by Probability
| <CMTLBLDATA_FLDOPPCALCAMOUNT>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCARDID>
|-
| Closing amnt
| <CMTLBLDATA_FLDOPPCLOSEAMOUNT>
|-
| Close
| <CMTLBLDATA_FLDOPPCLOSEDATE>
|-
| Currency
| <CMTLBLDATA_FLDOPPCOINID>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCONTACTID>
|-
| Creation Date
| <CMTLBLDATA_FLDOPPCREATEDATE>
|-
| Created by User
| <CMTLBLDATA_FLDOPPCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDOPPDESCRIPTION>
|-
| Close By
| <CMTLBLDATA_FLDOPPESTDATE>
|-
| Oppty Type
| <CMTLBLDATA_FLDOPPKIND>
|-
| Opportunity
| <CMTLBLDATA_FLDOPPNAME>
|-
| Note
| <CMTLBLDATA_FLDOPPNOTES>
|-
| Open
| <CMTLBLDATA_FLDOPPOPENDATE>
|-
| Probability %
| <CMTLBLDATA_FLDOPPPROBABILITY>
|-
| Reason
| <CMTLBLDATA_FLDOPPREASON>
|-
| Record ID
| <CMTLBLDATA_FLDOPPRECID>
|-
| Record type
| <CMTLBLDATA_FLDOPPRECKIND>
|-
| Territory
| <CMTLBLDATA_FLDOPPREGION>
|-
| Source
| <CMTLBLDATA_FLDOPPSOURCE>
|-
| Stage
| <CMTLBLDATA_FLDOPPSTAGE>
|-
| Status
| <CMTLBLDATA_FLDOPPSTATUS>
|-
| Last Update Date
| <CMTLBLDATA_FLDOPPUPDATEDATE>
|-
| Last Update: By User
| <CMTLBLDATA_FLDOPPUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDOPPUSER1>
|-
| Field2
| <CMTLBLDATA_FLDOPPUSER2>
|-
| Field3
| <CMTLBLDATA_FLDOPPUSER3>
|-
| Opportunity ID
| <CMTLBLDATA_FLDOPPUSERID>
|-
| Manager
| <CMTLBLDATA_FLDOPPWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Asset ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTASSETRECID>
|-
| Contract ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTBCRECID>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCARDID>
|-
| Category
| <CMTLBLDATA_FLDTKTCATEGORY>
|-
| Cause
| <CMTLBLDATA_FLDTKTCAUSE>
|-
| Close Date
| <CMTLBLDATA_FLDTKTCLOSEDATETIME>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCONTACTID>
|-
| Creation: Date
| <CMTLBLDATA_FLDTKTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDTKTCREATEUSER_FLDWRKNICKNAME>
|-
| Due Date
| <CMTLBLDATA_FLDTKTDUEDATETIME>
|-
| Ticket Type
| <CMTLBLDATA_FLDTKTKIND>
|-
| Notes
| <CMTLBLDATA_FLDTKTNOTES>CMTLBLDATA
|-
| Open Date
| <CMTLBLDATA_FLDTKTOPENDATETIME>
|-
| Priority
| <CMTLBLDATA_FLDTKTPRIORITY>
|-
| Description
| <CMTLBLDATA_FLDTKTPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDTKTRECID>
|-
| Account's Region Code
| <CMTLBLDATA_FLDTKTREGIONCODE>
|-
| Estimated Duration Needed
| <CMTLBLDATA_FLDTKTSCHEDLENESTIM>
|-
| Resolution Description
| <CMTLBLDATA_FLDTKTSOLUTION>
|-
| Source
| <CMTLBLDATA_FLDTKTSOURCE>
|-
| Status
| <CMTLBLDATA_FLDTKTSTATUS>
|-
| Status: Ext.
| <CMTLBLDATA_FLDTKTSTATUSNOTE>
|-
| Ticket Number
| <CMTLBLDATA_FLDTKTTICKETNO>
|-
| Last Update Date
| <CMTLBLDATA_FLDTKTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDTKTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDTKTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDTKTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDTKTUSER3>
|-
| Manager
| <CMTLBLDATA_FLDTKTWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Category
| <CMTLBLDATA_FLDKBACATEGORY>
|-
| Create Date
| <CMTLBLDATA_FLDKBACREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDKBACREATEUSER_FLDWRKNICKNAME>
|-
| Public
| <CMTLBLDATA_FLDKBAISPUBLIC>
|-
| Problem
| <CMTLBLDATA_FLDKBAPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDKBARECID>
|-
| Solution
| <CMTLBLDATA_FLDKBASOLUTION>
|-
| Status
| <CMTLBLDATA_FLDKBASTATUS>
|-
| Title
| <CMTLBLDATA_FLDKBATITLE>
|-
| Last Update date
| <CMTLBLDATA_FLDKBAUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDKBAUPDATEUSER_FLDWRKNICKNAME>
|}

===Lookup Fields===
*Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket. This way you can define an Online Service for the Account, which will be activated from the Ticket window. Lookup Field syntax: <CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1> Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account FLDCRDADDRESS1 is the account's Address field

==See Also==
*[[Online Services FAQ]]

[[Category:Integration]]

Online Services

2009-08-23T09:06:38Z

Yarden: /* Displaying Domain WHOIS */

{{integration}}

Commit's '''Online Services''' is a powerful feature which allows you to link to web sites (URL) and activate the web application using parameters taken from CommitCRM.

You can define as many online Services as you wish. This feature is available for the following entities: Accounts, Tickets, Assets, Items, Contracts, Knowledge Base Articles and Oppotrunities.
*Accounts window
*Tickets window
*Dispatcher window
*Asset window
*Items window
*Contracts window
*Opportunities window

==What can I use Online Services for?==
Wouldn't you like your technicians to be able to find an address for a scheduled visit with just a single click? You can do this by defining an Online Service which will open maps site (e.g. Google Maps, Yahoo! Maps etc.) and the map will open automatically on the address of the Account or Contact stored in CommitCRM.

This powerful tool allows you to define any URL and open it with parameters. You can basically do with it whatever you want.

==Adding new Online Services==
To define a new Online Service, Open the Online Services Management window from Settings > Online Services. or click the Online Services icon from the Accounts window toolbar. Click the New button to add a new Online Service and enter the following parameters:

*'''Name''' - The name of the service which will be displayed in the Online Services list and menus throughout the system, for example, "Google Maps".
*'''Base URL''' - The URL you wish to open in order to use the Service. This is the address of the main service (before passing any parameters to it), for example http://maps.google.com/maps.
*'''URL Parameters''' - Parameters which will be appended to the URL in order to create specific queries when opening the URL. These parameters can be CommitCRM Account database fields which will be taken and filled from CommitCRM when clicking the Online Service.

See the Tips and Tricks for examples of useful Online Services

==Activating Online Services==
Online Services can be activated from various places in CommitCRM including:
*The '''Account, Ticket, Asset, Item, Opportunity, Contract, Knowledge Base Article windows''' - click the Online Services icon to activate the service for the selected account
*The '''Dispatcher Windows''' - right-click on a selected Ticket to run any Online Service for the Ticket's Account or Contact (such as displaying a map).
*The '''Calendar / Scheduled Appointments''' views - right-click above an Appointment and select Online Services.
*The '''secondary Contacts tab''' - select a Contact, right-click and select Online Services
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.
*'''Secondary Contact selection''' field - right-click and select Online Services.
*The '''Relations tab under Account''' - right-click and select Online Services.

==Possible Usage==
*'''Online Services and Assets''' – Access your MSP product online and pass the Asset ID to display its details from your external system
*'''Online Services and Items''' – Search for better prices for items by passing specific item information directly from within CommitCRM.
*'''Online Services for Assets''' – Search for a specific product review by its hardware serial number.
*'''Online Services for Tickets''' – Search in online knowledge bases for solutions based on the ticket description
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.

==Using Lookup Fields==
Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket.

This way you can define an Online Service for the Ticket, which will be activated from the Ticket window and will be using Account information.

Lookup Field syntax:

<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>

Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account
FLDCRDADDRESS1 is the account's Address field

==Tips & Tricks==
Following are examples of possible Online Services configurations.
These examples are intended to explain the use of Online Services only.

Disclaimer - Before defining your Online Services you should read the terms of use for each web site you want to access. The examples below are displayed to explain how to use online services and how to pass parameters.

===Displaying Online Maps===
'''Google Maps''' - Opens Google Maps and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Maps
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDCRDADDRESS1>+<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDSTATE>+<CMTLBLDATA_FLDCRDZIP>
|}

'''MapQuest''' - Opens MapQuest Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| MapQuest
|-
| Base URL
| <nowiki>http://www.mapquest.com/maps</nowiki>
|-
| URL Parameters
| /map.adp?searchtype=address&country=<CMTLBLDATA_FLDCRDCOUNTRY>&addtohistory=&searchtab=home&formtype=address&popflag=0&latitude=&longitude=&name=&phone=&level=&cat=&address=&city=<CMTLBLDATA_FLDCRDCITY>&state=<CMTLBLDATA_FLDCRDSTATE>&zipcode=<CMTLBLDATA_FLDCRDZIP>
|}

'''Yahoo! Maps''' - Opens Yahoo! Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Yahoo! Maps
|-
| Base URL
| <nowiki>http://maps.yahoo.com</nowiki>
|-
| URL Parameters
| /maps_result?addr=<CMTLBLDATA_FLDCRDADDRESS1>&csz=<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDCOUNTRY>&country=<CMTLBLDATA_FLDCRDSTATE>
|}

===Finding Account Information===
'''Google Company''' - Opens Google and searches for the Account Company Name.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Company
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCOMPANY>
|}

'''Google Contact''' - Opens Google and searches for the Contact Name.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Contact
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCONTACT>
|}

===Finding Ticket Description in Google===
'''Google Ticket''' - Opens Google and searches for the Ticket description.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket Description
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDTKTPROBLEM>
|}

===Finding Account Address From Ticket (using [[Commit Online Services#Using Lookup Fields|Lookup Field]]) ===
'''Google Address From Ticket''' - Opens Google and searches for the Address of the Account which is linked to the Ticket.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDCITY>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDSTATE>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDZIP>
|}

===Displaying Products Warranties Online===
'''HP Warranty Lookup''' - Displays HP products warranty expiration dates, using the products number and the products serial number.

Note: Product Number goes into Plate# field (<CMTLBLDATA_FLDASTUSER1>).

'''Contributed by Easy I.T'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| HP Warranty Lookup
|-
| Base URL
| <nowiki>http://h20000.www2.hp.com/bizsupport/TechSupport/WarrantyResults.jsp?</nowiki>
|-
| URL Parameters
| lang=en&cc=us&prodSeriesId=454811&prodTypeId=12454&sn=<CMTLBLDATA_FLDASTSERIALNO>&pn=<CMTLBLDATA_FLDASTUSER1>&country=US&nickname=&find=Display+Warranty+Information+%C2%BB
|}

'''DELL Service Contracts and Warranties''' - Displays Dell products warranty expiration dates, using the service tag number.

Note: Customize a Field for Service Tag or use existing field. In this sample we will use Field3 as custumized Service Tag Field

'''Contributed by JoshuaB'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| Dell Warranty Check
|-
| Base URL
| <nowiki>http://support.dell.com/support/topics/global.aspx/support/my_systems_info/details</nowiki>
|-
| URL Parameters
| ?c=us&l=en&s=gen&servicetag=<CMTLBLDATA_FLDASTUSER3>
|}

===Displaying Domain WHOIS===

'''Network Solutions Domain WHOIS''' - WHOIS domain registration information by Network Solutions.

Note: Domain must be stripped from URL (without http://).

'''Contributed by DavidW'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (NetworkSolutions)
|-
| Base URL
| <nowiki>http://www.networksolutions.com/whois-search/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''Domain Tools Domain WHOIS''' - WHOIS domain registration information by Domain Tools.

Note: Domain must be stripped from URL (without http://).

'''Contributed by ajgyomber'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DomainTools)
|-
| Base URL
| <nowiki>http://whois.domaintools.com/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''DNSstuff Domain WHOIS''' - WHOIS domain registration information by DNSstuff.

Note: Domain must be stripped from URL (without http://).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DNSstuff)
|-
| Base URL
| <nowiki>http://www.dnsstuff.com/dnslite/?r=u2r&domain=</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

===Displaying Online Work Orders Status===
'''Work Orders Status Check''' - Track your orders statuses in <nowiki>onforce.com</nowiki>

Note: Set Field1 to order number or change the parameter (<CMTLBLDATA_FLDTKTUSER1>) to a different field.

'''Contributed by secion8'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Tickets
|-
| Name
| Work Orders Status (onforce.com)
|-
| Base URL
| <nowiki>http://www.onforce.com/?action=pcc_work_order_view&id=</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDTKTUSER1>
|}

===N-central===

'''Show Account and Asset information directly in N-central.'''

'''Contributed by ajgyomber'''

Note: You'll need to replace "server.n-able.com", "email@domain.com" and "your_actual_password" with your actual information.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| N-central Dashboard
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=defaultDashboard&username=email@domain.com&password=your_actual_password
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Device Details
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceDetails&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Device Services
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceService&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Launch Remote Control
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceRC&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| N-central NOC View
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=nocView&username=email@domain.com&password =your_actual_password
|}

==Parameters list==

===Parameters List for Accounts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account Number
| <CMTLBLDATA_FLDCRDCARDID2>
|-
| Address: City
| <CMTLBLDATA_FLDCRDCITY>
|-
| Address: Country
| <CMTLBLDATA_FLDCRDCOUNTRY>
|-
| Address: Line1
| <CMTLBLDATA_FLDCRDADDRESS1>
|-
| Address: Line2
| <CMTLBLDATA_FLDCRDADDRESS2>
|-
| Address: Line3
| <CMTLBLDATA_FLDCRDADDRESS3>
|-
| Address: State
| <CMTLBLDATA_FLDCRDSTATE>
|-
| Address: ZIP Code
| <CMTLBLDATA_FLDCRDZIP>
|-
| Assistant
| <CMTLBLDATA_FLDCRDASSISTANT>
|-
| Birthday
| <CMTLBLDATA_FLDCRDBIRTHDAY>
|-
| Company name
| <CMTLBLDATA_FLDCRDCOMPANY>
|-
| Contact: First & Last Name
| <CMTLBLDATA_FLDCRDCONTACT>
|-
| Dear
| <CMTLBLDATA_FLDCRDDEAR>
|-
| Department
| <CMTLBLDATA_FLDCRDDEPARTMENT>
|-
| E-Mail Address 1
| <CMTLBLDATA_FLDCRDEMAIL1>
|-
| E-Mail Address 2
| <CMTLBLDATA_FLDCRDEMAIL2>
|-
| Fax Number
| <CMTLBLDATA_FLDCRDFAX1>
|-
| Fax Number Extention
| <CMTLBLDATA_FLDCRDFAXDESC1>
|-
| Field
| <CMTLBLDATA_FLDCRDPERSONID>
|-
| Field1
| <CMTLBLDATA_FLDCRDUSER2>
|-
| Field2
| <CMTLBLDATA_FLDCRDUSER3>
|-
| Field3
| <CMTLBLDATA_FLDCRDUSER4>
|-
| Field4
| <CMTLBLDATA_FLDCRDUSER5>
|-
| Field5
| <CMTLBLDATA_FLDCRDCOMPANYNO>
|-
| File as
| <CMTLBLDATA_FLDCRDFULLNAME>
|-
| ID
| <CMTLBLDATA_FLDCRDCARDID3>
|-
| Last Name
| <CMTLBLDATA_FLDCRDLASTNAME>
|-
| Phone 1
| <CMTLBLDATA_FLDCRDPHONE1>
|-
| Phone 1 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC1>
|-
| Phone 2
| <CMTLBLDATA_FLDCRDPHONE2>
|-
| Phone 2 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC2>
|-
| Phone 3
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Phone 3 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC3>
|-
| Phone 4
| <CMTLBLDATA_FLDCRDPHONE4>
|-
| Phone 4 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC4>
|-
| Popup Message
| <CMTLBLDATA_FLDCRDCARDMESSAGE>
|-
| Region
| <CMTLBLDATA_FLDCRDREGIONCODE>
|-
| Salutation
| <CMTLBLDATA_FLDCRDSUFFIX>
|-
| Status
| <CMTLBLDATA_FLDCRDUSER1>
|-
| Sub-Contact Code
| <CMTLBLDATA_FLDCRDSUBCODE>
|-
| Title
| <CMTLBLDATA_FLDCRDTITLE>
|-
| Type
| <CMTLBLDATA_FLDCRDKIND>
|-
| Web Address 1
| <CMTLBLDATA_FLDCRDURL1>
|-
| Web Address 2
| <CMTLBLDATA_FLDCRDURL2>
|}

===Parameters list for Assets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTACCRECID>
|-
| Asset Code
| <CMTLBLDATA_FLDASTASSETCODE>
|-
| Asset Type
| <CMTLBLDATA_FLDASTASSETTYPE>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTCONTACTRECID>
|-
| Create Date
| <CMTLBLDATA_FLDASTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDASTCREATEUSER_FLDWRKNICKNAME>
|-
| Purchase Date
| <CMTLBLDATA_FLDASTCUSTPURDATE>
|-
| Purchased From Us
| <CMTLBLDATA_FLDASTCUSTPURFROMUS>
|-
| Purchase Our Invoice #
| <CMTLBLDATA_FLDASTCUSTPUROURINV>
|-
| Customer PO
| <CMTLBLDATA_FLDASTCUSTPURPO>
|-
| Purchase Price
| <CMTLBLDATA_FLDASTCUSTPURPRICE>
|-
| Delivered Date
| <CMTLBLDATA_FLDASTDELIVEDATE>
|-
| Description
| <CMTLBLDATA_FLDASTDESC>
|-
| Installed By
| <CMTLBLDATA_FLDASTINSTALBY_FLDWRKNICKNAME>
|-
| Installed Date
| <CMTLBLDATA_FLDASTINSTALDATE>
|-
| License Codes
| <CMTLBLDATA_FLDASTLICENSECODE>
|-
| License Keys
| <CMTLBLDATA_FLDASTLICENSEKEYS>
|-
| License Notes
| <CMTLBLDATA_FLDASTLICENSENOTES>
|-
| Location
| <CMTLBLDATA_FLDASTLOCATION>
|-
| Manufacturer
| <CMTLBLDATA_FLDASTMANUFACTURER>
|-
| Manufacturer Serial No.
| <CMTLBLDATA_FLDASTMNFSERIALNO>
|-
| Model
| <CMTLBLDATA_FLDASTMODEL>
|-
| Asset Name
| <CMTLBLDATA_FLDASTNAME>
|-
| Notes
| <CMTLBLDATA_FLDASTNOTES>
|-
| PARENTASSETRECID
| <CMTLBLDATA_FLDASTPARENTRECID>
|-
| Quantity
| <CMTLBLDATA_FLDASTQUANTITY>
|-
| Record ID
| <CMTLBLDATA_FLDASTRECID>
|-
| Serial No.
| <CMTLBLDATA_FLDASTSERIALNO>
|-
| Status
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Last Update date
| <CMTLBLDATA_FLDASTUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDASTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDASTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDASTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDASTUSER3>
|-
| Field4
| <CMTLBLDATA_FLDASTUSER4>
|-
| Field5
| <CMTLBLDATA_FLDASTUSER5>
|-
| Date1
| <CMTLBLDATA_FLDASTUSERDATE1>
|-
| Number1
| <CMTLBLDATA_FLDASTUSERNUMBER1>
|-
| Vendor Purchased Date
| <CMTLBLDATA_FLDASTVENDORDATEPURC>
|-
| Vendor Invoice #
| <CMTLBLDATA_FLDASTVENDORINVNO>
|-
| Vendor Name
| <CMTLBLDATA_FLDASTVENDORNAME>
|-
| Vendor PO
| <CMTLBLDATA_FLDASTVENDOROURPO>
|-
| Vendor Price
| <CMTLBLDATA_FLDASTVENDORPRICE>
|-
| Vendor
| <CMTLBLDATA_FLDASTVENDORRECID>
|-
| Vendor Serial No.
| <CMTLBLDATA_FLDASTVENDORSERNO>
|-
| Vendor Warranty Exp. Date
| <CMTLBLDATA_FLDASTVENDORWARREXP>
|-
| Version
| <CMTLBLDATA_FLDASTVERSION>
|-
| Warranty/License Exp. Date
| <CMTLBLDATA_FLDASTWARREXPDATE>FLDASTWARREXPDATE
|}

===Parameters list for Contracts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTACCRECID>
|-
| Block - Used
| <CMTLBLDATA_FLDBCTAMOUNTUSED>
|-
| Code
| <CMTLBLDATA_FLDBCTCODE>
|-
| Contract Type Type
| <CMTLBLDATA_FLDBCTCONTRACTTYPE>
|-
| Create Date
| <CMTLBLDATA_FLDBCTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDBCTCREATEUSER_FLDWRKNICKNAME>
|-
| Default Item Expense ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMEXPNS>
|-
| Default Item Labor ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMLABOR>
|-
| Default Item Part ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMPART>
|-
| Description
| <CMTLBLDATA_FLDBCTDESCEXTERNAL>
|-
| Internal Description
| <CMTLBLDATA_FLDBCTDESCINTERNAL>
|-
| End Date
| <CMTLBLDATA_FLDBCTENDDATE>
|-
| Name
| <CMTLBLDATA_FLDBCTNAME>
|-
| Note
| <CMTLBLDATA_FLDBCTNOTE>
|-
| Record ID
| <CMTLBLDATA_FLDBCTRECID>
|-
| Start Date
| <CMTLBLDATA_FLDBCTSTARTDATE>
|-
| Status
| <CMTLBLDATA_FLDBCTSTATUS>
|-
| Last Update date
| <CMTLBLDATA_FLDBCTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDBCTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field 1
| <CMTLBLDATA_FLDBCTUSER1>
|-
| Field 2
| <CMTLBLDATA_FLDBCTUSER2>
|-
| Field 3
| <CMTLBLDATA_FLDBCTUSER3>
|}

===Parameters list for Items===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Currency
| <CMTLBLDATA_FLDITMCOINID>
|-
| Created by User
| <CMTLBLDATA_FLDITMCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDITMDESC>
|-
| Expense Type
| <CMTLBLDATA_FLDITMEXPITEMTYPE>
|-
| Labor Type
| <CMTLBLDATA_FLDITMFEEITEMTYPE>
|-
| Item Code
| <CMTLBLDATA_FLDITMITEMNO>
|-
| Group
| <CMTLBLDATA_FLDITMITEMTYPEGROUP>
|-
| Name
| <CMTLBLDATA_FLDITMNAME>
|-
| Notes
| <CMTLBLDATA_FLDITMNOTES>
|-
| Price Source
| <CMTLBLDATA_FLDITMPRICESOURCE>
|-
| Product/Part Type
| <CMTLBLDATA_FLDITMPRODITEMTYPE>
|-
| Record Id
| <CMTLBLDATA_FLDITMRECID>
|-
| Cost
| <CMTLBLDATA_FLDITMSTANDARDCOST>
|-
| Suspend
| <CMTLBLDATA_FLDITMSUSPENDED>
|-
| Price
| <CMTLBLDATA_FLDITMUNITPRICE>
|-
| Update Date
| <CMTLBLDATA_FLDITMUPDATEDATE>
|-
| Update User
| <CMTLBLDATA_FLDITMUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDITMUSER1>
|}

===Parameters list for Opportunities===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Amount
| <CMTLBLDATA_FLDOPPAMOUNT>
|-
| Amount by Probability
| <CMTLBLDATA_FLDOPPCALCAMOUNT>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCARDID>
|-
| Closing amnt
| <CMTLBLDATA_FLDOPPCLOSEAMOUNT>
|-
| Close
| <CMTLBLDATA_FLDOPPCLOSEDATE>
|-
| Currency
| <CMTLBLDATA_FLDOPPCOINID>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCONTACTID>
|-
| Creation Date
| <CMTLBLDATA_FLDOPPCREATEDATE>
|-
| Created by User
| <CMTLBLDATA_FLDOPPCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDOPPDESCRIPTION>
|-
| Close By
| <CMTLBLDATA_FLDOPPESTDATE>
|-
| Oppty Type
| <CMTLBLDATA_FLDOPPKIND>
|-
| Opportunity
| <CMTLBLDATA_FLDOPPNAME>
|-
| Note
| <CMTLBLDATA_FLDOPPNOTES>
|-
| Open
| <CMTLBLDATA_FLDOPPOPENDATE>
|-
| Probability %
| <CMTLBLDATA_FLDOPPPROBABILITY>
|-
| Reason
| <CMTLBLDATA_FLDOPPREASON>
|-
| Record ID
| <CMTLBLDATA_FLDOPPRECID>
|-
| Record type
| <CMTLBLDATA_FLDOPPRECKIND>
|-
| Territory
| <CMTLBLDATA_FLDOPPREGION>
|-
| Source
| <CMTLBLDATA_FLDOPPSOURCE>
|-
| Stage
| <CMTLBLDATA_FLDOPPSTAGE>
|-
| Status
| <CMTLBLDATA_FLDOPPSTATUS>
|-
| Last Update Date
| <CMTLBLDATA_FLDOPPUPDATEDATE>
|-
| Last Update: By User
| <CMTLBLDATA_FLDOPPUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDOPPUSER1>
|-
| Field2
| <CMTLBLDATA_FLDOPPUSER2>
|-
| Field3
| <CMTLBLDATA_FLDOPPUSER3>
|-
| Opportunity ID
| <CMTLBLDATA_FLDOPPUSERID>
|-
| Manager
| <CMTLBLDATA_FLDOPPWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Asset ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTASSETRECID>
|-
| Contract ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTBCRECID>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCARDID>
|-
| Category
| <CMTLBLDATA_FLDTKTCATEGORY>
|-
| Cause
| <CMTLBLDATA_FLDTKTCAUSE>
|-
| Close Date
| <CMTLBLDATA_FLDTKTCLOSEDATETIME>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCONTACTID>
|-
| Creation: Date
| <CMTLBLDATA_FLDTKTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDTKTCREATEUSER_FLDWRKNICKNAME>
|-
| Due Date
| <CMTLBLDATA_FLDTKTDUEDATETIME>
|-
| Ticket Type
| <CMTLBLDATA_FLDTKTKIND>
|-
| Notes
| <CMTLBLDATA_FLDTKTNOTES>CMTLBLDATA
|-
| Open Date
| <CMTLBLDATA_FLDTKTOPENDATETIME>
|-
| Priority
| <CMTLBLDATA_FLDTKTPRIORITY>
|-
| Description
| <CMTLBLDATA_FLDTKTPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDTKTRECID>
|-
| Account's Region Code
| <CMTLBLDATA_FLDTKTREGIONCODE>
|-
| Estimated Duration Needed
| <CMTLBLDATA_FLDTKTSCHEDLENESTIM>
|-
| Resolution Description
| <CMTLBLDATA_FLDTKTSOLUTION>
|-
| Source
| <CMTLBLDATA_FLDTKTSOURCE>
|-
| Status
| <CMTLBLDATA_FLDTKTSTATUS>
|-
| Status: Ext.
| <CMTLBLDATA_FLDTKTSTATUSNOTE>
|-
| Ticket Number
| <CMTLBLDATA_FLDTKTTICKETNO>
|-
| Last Update Date
| <CMTLBLDATA_FLDTKTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDTKTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDTKTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDTKTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDTKTUSER3>
|-
| Manager
| <CMTLBLDATA_FLDTKTWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Category
| <CMTLBLDATA_FLDKBACATEGORY>
|-
| Create Date
| <CMTLBLDATA_FLDKBACREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDKBACREATEUSER_FLDWRKNICKNAME>
|-
| Public
| <CMTLBLDATA_FLDKBAISPUBLIC>
|-
| Problem
| <CMTLBLDATA_FLDKBAPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDKBARECID>
|-
| Solution
| <CMTLBLDATA_FLDKBASOLUTION>
|-
| Status
| <CMTLBLDATA_FLDKBASTATUS>
|-
| Title
| <CMTLBLDATA_FLDKBATITLE>
|-
| Last Update date
| <CMTLBLDATA_FLDKBAUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDKBAUPDATEUSER_FLDWRKNICKNAME>
|}

===Lookup Fields===
*Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket. This way you can define an Online Service for the Account, which will be activated from the Ticket window. Lookup Field syntax: <CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1> Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account FLDCRDADDRESS1 is the account's Address field

==See Also==
*[[Online Services FAQ]]

[[Category:Integration]]

Online Services

2009-08-23T09:05:02Z

Yarden: /* Finding Ticket Description in Google */

{{integration}}

Commit's '''Online Services''' is a powerful feature which allows you to link to web sites (URL) and activate the web application using parameters taken from CommitCRM.

You can define as many online Services as you wish. This feature is available for the following entities: Accounts, Tickets, Assets, Items, Contracts, Knowledge Base Articles and Oppotrunities.
*Accounts window
*Tickets window
*Dispatcher window
*Asset window
*Items window
*Contracts window
*Opportunities window

==What can I use Online Services for?==
Wouldn't you like your technicians to be able to find an address for a scheduled visit with just a single click? You can do this by defining an Online Service which will open maps site (e.g. Google Maps, Yahoo! Maps etc.) and the map will open automatically on the address of the Account or Contact stored in CommitCRM.

This powerful tool allows you to define any URL and open it with parameters. You can basically do with it whatever you want.

==Adding new Online Services==
To define a new Online Service, Open the Online Services Management window from Settings > Online Services. or click the Online Services icon from the Accounts window toolbar. Click the New button to add a new Online Service and enter the following parameters:

*'''Name''' - The name of the service which will be displayed in the Online Services list and menus throughout the system, for example, "Google Maps".
*'''Base URL''' - The URL you wish to open in order to use the Service. This is the address of the main service (before passing any parameters to it), for example http://maps.google.com/maps.
*'''URL Parameters''' - Parameters which will be appended to the URL in order to create specific queries when opening the URL. These parameters can be CommitCRM Account database fields which will be taken and filled from CommitCRM when clicking the Online Service.

See the Tips and Tricks for examples of useful Online Services

==Activating Online Services==
Online Services can be activated from various places in CommitCRM including:
*The '''Account, Ticket, Asset, Item, Opportunity, Contract, Knowledge Base Article windows''' - click the Online Services icon to activate the service for the selected account
*The '''Dispatcher Windows''' - right-click on a selected Ticket to run any Online Service for the Ticket's Account or Contact (such as displaying a map).
*The '''Calendar / Scheduled Appointments''' views - right-click above an Appointment and select Online Services.
*The '''secondary Contacts tab''' - select a Contact, right-click and select Online Services
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.
*'''Secondary Contact selection''' field - right-click and select Online Services.
*The '''Relations tab under Account''' - right-click and select Online Services.

==Possible Usage==
*'''Online Services and Assets''' – Access your MSP product online and pass the Asset ID to display its details from your external system
*'''Online Services and Items''' – Search for better prices for items by passing specific item information directly from within CommitCRM.
*'''Online Services for Assets''' – Search for a specific product review by its hardware serial number.
*'''Online Services for Tickets''' – Search in online knowledge bases for solutions based on the ticket description
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.

==Using Lookup Fields==
Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket.

This way you can define an Online Service for the Ticket, which will be activated from the Ticket window and will be using Account information.

Lookup Field syntax:

<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>

Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account
FLDCRDADDRESS1 is the account's Address field

==Tips & Tricks==
Following are examples of possible Online Services configurations.
These examples are intended to explain the use of Online Services only.

Disclaimer - Before defining your Online Services you should read the terms of use for each web site you want to access. The examples below are displayed to explain how to use online services and how to pass parameters.

===Displaying Online Maps===
'''Google Maps''' - Opens Google Maps and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Maps
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDCRDADDRESS1>+<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDSTATE>+<CMTLBLDATA_FLDCRDZIP>
|}

'''MapQuest''' - Opens MapQuest Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| MapQuest
|-
| Base URL
| <nowiki>http://www.mapquest.com/maps</nowiki>
|-
| URL Parameters
| /map.adp?searchtype=address&country=<CMTLBLDATA_FLDCRDCOUNTRY>&addtohistory=&searchtab=home&formtype=address&popflag=0&latitude=&longitude=&name=&phone=&level=&cat=&address=&city=<CMTLBLDATA_FLDCRDCITY>&state=<CMTLBLDATA_FLDCRDSTATE>&zipcode=<CMTLBLDATA_FLDCRDZIP>
|}

'''Yahoo! Maps''' - Opens Yahoo! Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Yahoo! Maps
|-
| Base URL
| <nowiki>http://maps.yahoo.com</nowiki>
|-
| URL Parameters
| /maps_result?addr=<CMTLBLDATA_FLDCRDADDRESS1>&csz=<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDCOUNTRY>&country=<CMTLBLDATA_FLDCRDSTATE>
|}

===Finding Account Information===
'''Google Company''' - Opens Google and searches for the Account Company Name.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Company
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCOMPANY>
|}

'''Google Contact''' - Opens Google and searches for the Contact Name.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Contact
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCONTACT>
|}

===Finding Ticket Description in Google===
'''Google Ticket''' - Opens Google and searches for the Ticket description.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket Description
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDTKTPROBLEM>
|}

===Finding Account Address From Ticket (using [[Commit Online Services#Using Lookup Fields|Lookup Field]]) ===
'''Google Address From Ticket''' - Opens Google and searches for the Address of the Account which is linked to the Ticket.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDCITY>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDSTATE>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDZIP>
|}

===Displaying Products Warranties Online===
'''HP Warranty Lookup''' - Displays HP products warranty expiration dates, using the products number and the products serial number.

Note: Product Number goes into Plate# field (<CMTLBLDATA_FLDASTUSER1>).

'''Contributed by Easy I.T'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| HP Warranty Lookup
|-
| Base URL
| <nowiki>http://h20000.www2.hp.com/bizsupport/TechSupport/WarrantyResults.jsp?</nowiki>
|-
| URL Parameters
| lang=en&cc=us&prodSeriesId=454811&prodTypeId=12454&sn=<CMTLBLDATA_FLDASTSERIALNO>&pn=<CMTLBLDATA_FLDASTUSER1>&country=US&nickname=&find=Display+Warranty+Information+%C2%BB
|}

'''DELL Service Contracts and Warranties''' - Displays Dell products warranty expiration dates, using the service tag number.

Note: Customize a Field for Service Tag or use existing field. In this sample we will use Field3 as custumized Service Tag Field

'''Contributed by JoshuaB'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| Dell Warranty Check
|-
| Base URL
| <nowiki>http://support.dell.com/support/topics/global.aspx/support/my_systems_info/details</nowiki>
|-
| URL Parameters
| ?c=us&l=en&s=gen&servicetag=<CMTLBLDATA_FLDASTUSER3>
|}

===Displaying Domain WHOIS===

'''Network Solutions Domain WHOIS''' - WHOIS domain registration information by Network Solutions.

Note: Domain must be stripped from URL (without http://).

'''Contributed by DavidW'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (NetworkSolutions)
|-
| Base URL
| <nowiki>http://www.networksolutions.com/whois-search/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''Domain Tools Domain WHOIS''' - WHOIS domain registration information by .

Note: Domain must be stripped from URL (without http://).

'''Contributed by ajgyomber'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DomainTools)
|-
| Base URL
| <nowiki>http://whois.domaintools.com/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''DNSstuff Domain WHOIS''' - WHOIS domain registration information by DNSstuff.

Note: Domain must be stripped from URL (without http://).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DNSstuff)
|-
| Base URL
| <nowiki>http://www.dnsstuff.com/dnslite/?r=u2r&domain=</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

===Displaying Online Work Orders Status===
'''Work Orders Status Check''' - Track your orders statuses in <nowiki>onforce.com</nowiki>

Note: Set Field1 to order number or change the parameter (<CMTLBLDATA_FLDTKTUSER1>) to a different field.

'''Contributed by secion8'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Tickets
|-
| Name
| Work Orders Status (onforce.com)
|-
| Base URL
| <nowiki>http://www.onforce.com/?action=pcc_work_order_view&id=</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDTKTUSER1>
|}

===N-central===

'''Show Account and Asset information directly in N-central.'''

'''Contributed by ajgyomber'''

Note: You'll need to replace "server.n-able.com", "email@domain.com" and "your_actual_password" with your actual information.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| N-central Dashboard
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=defaultDashboard&username=email@domain.com&password=your_actual_password
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Device Details
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceDetails&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Device Services
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceService&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Launch Remote Control
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceRC&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| N-central NOC View
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=nocView&username=email@domain.com&password =your_actual_password
|}

==Parameters list==

===Parameters List for Accounts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account Number
| <CMTLBLDATA_FLDCRDCARDID2>
|-
| Address: City
| <CMTLBLDATA_FLDCRDCITY>
|-
| Address: Country
| <CMTLBLDATA_FLDCRDCOUNTRY>
|-
| Address: Line1
| <CMTLBLDATA_FLDCRDADDRESS1>
|-
| Address: Line2
| <CMTLBLDATA_FLDCRDADDRESS2>
|-
| Address: Line3
| <CMTLBLDATA_FLDCRDADDRESS3>
|-
| Address: State
| <CMTLBLDATA_FLDCRDSTATE>
|-
| Address: ZIP Code
| <CMTLBLDATA_FLDCRDZIP>
|-
| Assistant
| <CMTLBLDATA_FLDCRDASSISTANT>
|-
| Birthday
| <CMTLBLDATA_FLDCRDBIRTHDAY>
|-
| Company name
| <CMTLBLDATA_FLDCRDCOMPANY>
|-
| Contact: First & Last Name
| <CMTLBLDATA_FLDCRDCONTACT>
|-
| Dear
| <CMTLBLDATA_FLDCRDDEAR>
|-
| Department
| <CMTLBLDATA_FLDCRDDEPARTMENT>
|-
| E-Mail Address 1
| <CMTLBLDATA_FLDCRDEMAIL1>
|-
| E-Mail Address 2
| <CMTLBLDATA_FLDCRDEMAIL2>
|-
| Fax Number
| <CMTLBLDATA_FLDCRDFAX1>
|-
| Fax Number Extention
| <CMTLBLDATA_FLDCRDFAXDESC1>
|-
| Field
| <CMTLBLDATA_FLDCRDPERSONID>
|-
| Field1
| <CMTLBLDATA_FLDCRDUSER2>
|-
| Field2
| <CMTLBLDATA_FLDCRDUSER3>
|-
| Field3
| <CMTLBLDATA_FLDCRDUSER4>
|-
| Field4
| <CMTLBLDATA_FLDCRDUSER5>
|-
| Field5
| <CMTLBLDATA_FLDCRDCOMPANYNO>
|-
| File as
| <CMTLBLDATA_FLDCRDFULLNAME>
|-
| ID
| <CMTLBLDATA_FLDCRDCARDID3>
|-
| Last Name
| <CMTLBLDATA_FLDCRDLASTNAME>
|-
| Phone 1
| <CMTLBLDATA_FLDCRDPHONE1>
|-
| Phone 1 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC1>
|-
| Phone 2
| <CMTLBLDATA_FLDCRDPHONE2>
|-
| Phone 2 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC2>
|-
| Phone 3
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Phone 3 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC3>
|-
| Phone 4
| <CMTLBLDATA_FLDCRDPHONE4>
|-
| Phone 4 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC4>
|-
| Popup Message
| <CMTLBLDATA_FLDCRDCARDMESSAGE>
|-
| Region
| <CMTLBLDATA_FLDCRDREGIONCODE>
|-
| Salutation
| <CMTLBLDATA_FLDCRDSUFFIX>
|-
| Status
| <CMTLBLDATA_FLDCRDUSER1>
|-
| Sub-Contact Code
| <CMTLBLDATA_FLDCRDSUBCODE>
|-
| Title
| <CMTLBLDATA_FLDCRDTITLE>
|-
| Type
| <CMTLBLDATA_FLDCRDKIND>
|-
| Web Address 1
| <CMTLBLDATA_FLDCRDURL1>
|-
| Web Address 2
| <CMTLBLDATA_FLDCRDURL2>
|}

===Parameters list for Assets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTACCRECID>
|-
| Asset Code
| <CMTLBLDATA_FLDASTASSETCODE>
|-
| Asset Type
| <CMTLBLDATA_FLDASTASSETTYPE>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTCONTACTRECID>
|-
| Create Date
| <CMTLBLDATA_FLDASTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDASTCREATEUSER_FLDWRKNICKNAME>
|-
| Purchase Date
| <CMTLBLDATA_FLDASTCUSTPURDATE>
|-
| Purchased From Us
| <CMTLBLDATA_FLDASTCUSTPURFROMUS>
|-
| Purchase Our Invoice #
| <CMTLBLDATA_FLDASTCUSTPUROURINV>
|-
| Customer PO
| <CMTLBLDATA_FLDASTCUSTPURPO>
|-
| Purchase Price
| <CMTLBLDATA_FLDASTCUSTPURPRICE>
|-
| Delivered Date
| <CMTLBLDATA_FLDASTDELIVEDATE>
|-
| Description
| <CMTLBLDATA_FLDASTDESC>
|-
| Installed By
| <CMTLBLDATA_FLDASTINSTALBY_FLDWRKNICKNAME>
|-
| Installed Date
| <CMTLBLDATA_FLDASTINSTALDATE>
|-
| License Codes
| <CMTLBLDATA_FLDASTLICENSECODE>
|-
| License Keys
| <CMTLBLDATA_FLDASTLICENSEKEYS>
|-
| License Notes
| <CMTLBLDATA_FLDASTLICENSENOTES>
|-
| Location
| <CMTLBLDATA_FLDASTLOCATION>
|-
| Manufacturer
| <CMTLBLDATA_FLDASTMANUFACTURER>
|-
| Manufacturer Serial No.
| <CMTLBLDATA_FLDASTMNFSERIALNO>
|-
| Model
| <CMTLBLDATA_FLDASTMODEL>
|-
| Asset Name
| <CMTLBLDATA_FLDASTNAME>
|-
| Notes
| <CMTLBLDATA_FLDASTNOTES>
|-
| PARENTASSETRECID
| <CMTLBLDATA_FLDASTPARENTRECID>
|-
| Quantity
| <CMTLBLDATA_FLDASTQUANTITY>
|-
| Record ID
| <CMTLBLDATA_FLDASTRECID>
|-
| Serial No.
| <CMTLBLDATA_FLDASTSERIALNO>
|-
| Status
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Last Update date
| <CMTLBLDATA_FLDASTUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDASTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDASTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDASTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDASTUSER3>
|-
| Field4
| <CMTLBLDATA_FLDASTUSER4>
|-
| Field5
| <CMTLBLDATA_FLDASTUSER5>
|-
| Date1
| <CMTLBLDATA_FLDASTUSERDATE1>
|-
| Number1
| <CMTLBLDATA_FLDASTUSERNUMBER1>
|-
| Vendor Purchased Date
| <CMTLBLDATA_FLDASTVENDORDATEPURC>
|-
| Vendor Invoice #
| <CMTLBLDATA_FLDASTVENDORINVNO>
|-
| Vendor Name
| <CMTLBLDATA_FLDASTVENDORNAME>
|-
| Vendor PO
| <CMTLBLDATA_FLDASTVENDOROURPO>
|-
| Vendor Price
| <CMTLBLDATA_FLDASTVENDORPRICE>
|-
| Vendor
| <CMTLBLDATA_FLDASTVENDORRECID>
|-
| Vendor Serial No.
| <CMTLBLDATA_FLDASTVENDORSERNO>
|-
| Vendor Warranty Exp. Date
| <CMTLBLDATA_FLDASTVENDORWARREXP>
|-
| Version
| <CMTLBLDATA_FLDASTVERSION>
|-
| Warranty/License Exp. Date
| <CMTLBLDATA_FLDASTWARREXPDATE>FLDASTWARREXPDATE
|}

===Parameters list for Contracts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTACCRECID>
|-
| Block - Used
| <CMTLBLDATA_FLDBCTAMOUNTUSED>
|-
| Code
| <CMTLBLDATA_FLDBCTCODE>
|-
| Contract Type Type
| <CMTLBLDATA_FLDBCTCONTRACTTYPE>
|-
| Create Date
| <CMTLBLDATA_FLDBCTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDBCTCREATEUSER_FLDWRKNICKNAME>
|-
| Default Item Expense ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMEXPNS>
|-
| Default Item Labor ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMLABOR>
|-
| Default Item Part ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMPART>
|-
| Description
| <CMTLBLDATA_FLDBCTDESCEXTERNAL>
|-
| Internal Description
| <CMTLBLDATA_FLDBCTDESCINTERNAL>
|-
| End Date
| <CMTLBLDATA_FLDBCTENDDATE>
|-
| Name
| <CMTLBLDATA_FLDBCTNAME>
|-
| Note
| <CMTLBLDATA_FLDBCTNOTE>
|-
| Record ID
| <CMTLBLDATA_FLDBCTRECID>
|-
| Start Date
| <CMTLBLDATA_FLDBCTSTARTDATE>
|-
| Status
| <CMTLBLDATA_FLDBCTSTATUS>
|-
| Last Update date
| <CMTLBLDATA_FLDBCTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDBCTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field 1
| <CMTLBLDATA_FLDBCTUSER1>
|-
| Field 2
| <CMTLBLDATA_FLDBCTUSER2>
|-
| Field 3
| <CMTLBLDATA_FLDBCTUSER3>
|}

===Parameters list for Items===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Currency
| <CMTLBLDATA_FLDITMCOINID>
|-
| Created by User
| <CMTLBLDATA_FLDITMCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDITMDESC>
|-
| Expense Type
| <CMTLBLDATA_FLDITMEXPITEMTYPE>
|-
| Labor Type
| <CMTLBLDATA_FLDITMFEEITEMTYPE>
|-
| Item Code
| <CMTLBLDATA_FLDITMITEMNO>
|-
| Group
| <CMTLBLDATA_FLDITMITEMTYPEGROUP>
|-
| Name
| <CMTLBLDATA_FLDITMNAME>
|-
| Notes
| <CMTLBLDATA_FLDITMNOTES>
|-
| Price Source
| <CMTLBLDATA_FLDITMPRICESOURCE>
|-
| Product/Part Type
| <CMTLBLDATA_FLDITMPRODITEMTYPE>
|-
| Record Id
| <CMTLBLDATA_FLDITMRECID>
|-
| Cost
| <CMTLBLDATA_FLDITMSTANDARDCOST>
|-
| Suspend
| <CMTLBLDATA_FLDITMSUSPENDED>
|-
| Price
| <CMTLBLDATA_FLDITMUNITPRICE>
|-
| Update Date
| <CMTLBLDATA_FLDITMUPDATEDATE>
|-
| Update User
| <CMTLBLDATA_FLDITMUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDITMUSER1>
|}

===Parameters list for Opportunities===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Amount
| <CMTLBLDATA_FLDOPPAMOUNT>
|-
| Amount by Probability
| <CMTLBLDATA_FLDOPPCALCAMOUNT>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCARDID>
|-
| Closing amnt
| <CMTLBLDATA_FLDOPPCLOSEAMOUNT>
|-
| Close
| <CMTLBLDATA_FLDOPPCLOSEDATE>
|-
| Currency
| <CMTLBLDATA_FLDOPPCOINID>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCONTACTID>
|-
| Creation Date
| <CMTLBLDATA_FLDOPPCREATEDATE>
|-
| Created by User
| <CMTLBLDATA_FLDOPPCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDOPPDESCRIPTION>
|-
| Close By
| <CMTLBLDATA_FLDOPPESTDATE>
|-
| Oppty Type
| <CMTLBLDATA_FLDOPPKIND>
|-
| Opportunity
| <CMTLBLDATA_FLDOPPNAME>
|-
| Note
| <CMTLBLDATA_FLDOPPNOTES>
|-
| Open
| <CMTLBLDATA_FLDOPPOPENDATE>
|-
| Probability %
| <CMTLBLDATA_FLDOPPPROBABILITY>
|-
| Reason
| <CMTLBLDATA_FLDOPPREASON>
|-
| Record ID
| <CMTLBLDATA_FLDOPPRECID>
|-
| Record type
| <CMTLBLDATA_FLDOPPRECKIND>
|-
| Territory
| <CMTLBLDATA_FLDOPPREGION>
|-
| Source
| <CMTLBLDATA_FLDOPPSOURCE>
|-
| Stage
| <CMTLBLDATA_FLDOPPSTAGE>
|-
| Status
| <CMTLBLDATA_FLDOPPSTATUS>
|-
| Last Update Date
| <CMTLBLDATA_FLDOPPUPDATEDATE>
|-
| Last Update: By User
| <CMTLBLDATA_FLDOPPUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDOPPUSER1>
|-
| Field2
| <CMTLBLDATA_FLDOPPUSER2>
|-
| Field3
| <CMTLBLDATA_FLDOPPUSER3>
|-
| Opportunity ID
| <CMTLBLDATA_FLDOPPUSERID>
|-
| Manager
| <CMTLBLDATA_FLDOPPWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Asset ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTASSETRECID>
|-
| Contract ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTBCRECID>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCARDID>
|-
| Category
| <CMTLBLDATA_FLDTKTCATEGORY>
|-
| Cause
| <CMTLBLDATA_FLDTKTCAUSE>
|-
| Close Date
| <CMTLBLDATA_FLDTKTCLOSEDATETIME>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCONTACTID>
|-
| Creation: Date
| <CMTLBLDATA_FLDTKTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDTKTCREATEUSER_FLDWRKNICKNAME>
|-
| Due Date
| <CMTLBLDATA_FLDTKTDUEDATETIME>
|-
| Ticket Type
| <CMTLBLDATA_FLDTKTKIND>
|-
| Notes
| <CMTLBLDATA_FLDTKTNOTES>CMTLBLDATA
|-
| Open Date
| <CMTLBLDATA_FLDTKTOPENDATETIME>
|-
| Priority
| <CMTLBLDATA_FLDTKTPRIORITY>
|-
| Description
| <CMTLBLDATA_FLDTKTPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDTKTRECID>
|-
| Account's Region Code
| <CMTLBLDATA_FLDTKTREGIONCODE>
|-
| Estimated Duration Needed
| <CMTLBLDATA_FLDTKTSCHEDLENESTIM>
|-
| Resolution Description
| <CMTLBLDATA_FLDTKTSOLUTION>
|-
| Source
| <CMTLBLDATA_FLDTKTSOURCE>
|-
| Status
| <CMTLBLDATA_FLDTKTSTATUS>
|-
| Status: Ext.
| <CMTLBLDATA_FLDTKTSTATUSNOTE>
|-
| Ticket Number
| <CMTLBLDATA_FLDTKTTICKETNO>
|-
| Last Update Date
| <CMTLBLDATA_FLDTKTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDTKTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDTKTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDTKTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDTKTUSER3>
|-
| Manager
| <CMTLBLDATA_FLDTKTWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Category
| <CMTLBLDATA_FLDKBACATEGORY>
|-
| Create Date
| <CMTLBLDATA_FLDKBACREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDKBACREATEUSER_FLDWRKNICKNAME>
|-
| Public
| <CMTLBLDATA_FLDKBAISPUBLIC>
|-
| Problem
| <CMTLBLDATA_FLDKBAPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDKBARECID>
|-
| Solution
| <CMTLBLDATA_FLDKBASOLUTION>
|-
| Status
| <CMTLBLDATA_FLDKBASTATUS>
|-
| Title
| <CMTLBLDATA_FLDKBATITLE>
|-
| Last Update date
| <CMTLBLDATA_FLDKBAUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDKBAUPDATEUSER_FLDWRKNICKNAME>
|}

===Lookup Fields===
*Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket. This way you can define an Online Service for the Account, which will be activated from the Ticket window. Lookup Field syntax: <CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1> Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account FLDCRDADDRESS1 is the account's Address field

==See Also==
*[[Online Services FAQ]]

[[Category:Integration]]

Online Services

2009-08-23T09:02:51Z

Yarden: /* N-central */

{{integration}}

Commit's '''Online Services''' is a powerful feature which allows you to link to web sites (URL) and activate the web application using parameters taken from CommitCRM.

You can define as many online Services as you wish. This feature is available for the following entities: Accounts, Tickets, Assets, Items, Contracts, Knowledge Base Articles and Oppotrunities.
*Accounts window
*Tickets window
*Dispatcher window
*Asset window
*Items window
*Contracts window
*Opportunities window

==What can I use Online Services for?==
Wouldn't you like your technicians to be able to find an address for a scheduled visit with just a single click? You can do this by defining an Online Service which will open maps site (e.g. Google Maps, Yahoo! Maps etc.) and the map will open automatically on the address of the Account or Contact stored in CommitCRM.

This powerful tool allows you to define any URL and open it with parameters. You can basically do with it whatever you want.

==Adding new Online Services==
To define a new Online Service, Open the Online Services Management window from Settings > Online Services. or click the Online Services icon from the Accounts window toolbar. Click the New button to add a new Online Service and enter the following parameters:

*'''Name''' - The name of the service which will be displayed in the Online Services list and menus throughout the system, for example, "Google Maps".
*'''Base URL''' - The URL you wish to open in order to use the Service. This is the address of the main service (before passing any parameters to it), for example http://maps.google.com/maps.
*'''URL Parameters''' - Parameters which will be appended to the URL in order to create specific queries when opening the URL. These parameters can be CommitCRM Account database fields which will be taken and filled from CommitCRM when clicking the Online Service.

See the Tips and Tricks for examples of useful Online Services

==Activating Online Services==
Online Services can be activated from various places in CommitCRM including:
*The '''Account, Ticket, Asset, Item, Opportunity, Contract, Knowledge Base Article windows''' - click the Online Services icon to activate the service for the selected account
*The '''Dispatcher Windows''' - right-click on a selected Ticket to run any Online Service for the Ticket's Account or Contact (such as displaying a map).
*The '''Calendar / Scheduled Appointments''' views - right-click above an Appointment and select Online Services.
*The '''secondary Contacts tab''' - select a Contact, right-click and select Online Services
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.
*'''Secondary Contact selection''' field - right-click and select Online Services.
*The '''Relations tab under Account''' - right-click and select Online Services.

==Possible Usage==
*'''Online Services and Assets''' – Access your MSP product online and pass the Asset ID to display its details from your external system
*'''Online Services and Items''' – Search for better prices for items by passing specific item information directly from within CommitCRM.
*'''Online Services for Assets''' – Search for a specific product review by its hardware serial number.
*'''Online Services for Tickets''' – Search in online knowledge bases for solutions based on the ticket description
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.

==Using Lookup Fields==
Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket.

This way you can define an Online Service for the Ticket, which will be activated from the Ticket window and will be using Account information.

Lookup Field syntax:

<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>

Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account
FLDCRDADDRESS1 is the account's Address field

==Tips & Tricks==
Following are examples of possible Online Services configurations.
These examples are intended to explain the use of Online Services only.

Disclaimer - Before defining your Online Services you should read the terms of use for each web site you want to access. The examples below are displayed to explain how to use online services and how to pass parameters.

===Displaying Online Maps===
'''Google Maps''' - Opens Google Maps and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Maps
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDCRDADDRESS1>+<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDSTATE>+<CMTLBLDATA_FLDCRDZIP>
|}

'''MapQuest''' - Opens MapQuest Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| MapQuest
|-
| Base URL
| <nowiki>http://www.mapquest.com/maps</nowiki>
|-
| URL Parameters
| /map.adp?searchtype=address&country=<CMTLBLDATA_FLDCRDCOUNTRY>&addtohistory=&searchtab=home&formtype=address&popflag=0&latitude=&longitude=&name=&phone=&level=&cat=&address=&city=<CMTLBLDATA_FLDCRDCITY>&state=<CMTLBLDATA_FLDCRDSTATE>&zipcode=<CMTLBLDATA_FLDCRDZIP>
|}

'''Yahoo! Maps''' - Opens Yahoo! Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Yahoo! Maps
|-
| Base URL
| <nowiki>http://maps.yahoo.com</nowiki>
|-
| URL Parameters
| /maps_result?addr=<CMTLBLDATA_FLDCRDADDRESS1>&csz=<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDCOUNTRY>&country=<CMTLBLDATA_FLDCRDSTATE>
|}

===Finding Account Information===
'''Google Company''' - Opens Google and searches for the Account Company Name.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Company
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCOMPANY>
|}

'''Google Contact''' - Opens Google and searches for the Contact Name.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Contact
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCONTACT>
|}

===Finding Ticket Description in Google===
'''Google Ticket''' - Opens Google and searches for the Ticket description.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket Description
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDTKTPROBLEM>
|}

===Finding Account Address From Ticket (using [[Commit Online Services#Using Lookup Fields|Lookup Field]]) ===
'''Google Address From Ticket''' - Opens Google and searches for the Address of the Account which is linked to the Ticket.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDCITY>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDSTATE>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDZIP>
|}

===Displaying Products Warranties Online===
'''HP Warranty Lookup''' - Displays HP products warranty expiration dates, using the products number and the products serial number.

Note: Product Number goes into Plate# field (<CMTLBLDATA_FLDASTUSER1>).

'''Contributed by Easy I.T'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| HP Warranty Lookup
|-
| Base URL
| <nowiki>http://h20000.www2.hp.com/bizsupport/TechSupport/WarrantyResults.jsp?</nowiki>
|-
| URL Parameters
| lang=en&cc=us&prodSeriesId=454811&prodTypeId=12454&sn=<CMTLBLDATA_FLDASTSERIALNO>&pn=<CMTLBLDATA_FLDASTUSER1>&country=US&nickname=&find=Display+Warranty+Information+%C2%BB
|}

'''DELL Service Contracts and Warranties''' - Displays Dell products warranty expiration dates, using the service tag number.

Note: Customize a Field for Service Tag or use existing field. In this sample we will use Field3 as custumized Service Tag Field

'''Contributed by JoshuaB'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| Dell Warranty Check
|-
| Base URL
| <nowiki>http://support.dell.com/support/topics/global.aspx/support/my_systems_info/details</nowiki>
|-
| URL Parameters
| ?c=us&l=en&s=gen&servicetag=<CMTLBLDATA_FLDASTUSER3>
|}

===Displaying Domain WHOIS===

'''Network Solutions Domain WHOIS''' - WHOIS domain registration information by Network Solutions.

Note: Domain must be stripped from URL (without http://).

'''Contributed by DavidW'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (NetworkSolutions)
|-
| Base URL
| <nowiki>http://www.networksolutions.com/whois-search/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''Domain Tools Domain WHOIS''' - WHOIS domain registration information by .

Note: Domain must be stripped from URL (without http://).

'''Contributed by ajgyomber'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DomainTools)
|-
| Base URL
| <nowiki>http://whois.domaintools.com/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''DNSstuff Domain WHOIS''' - WHOIS domain registration information by DNSstuff.

Note: Domain must be stripped from URL (without http://).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DNSstuff)
|-
| Base URL
| <nowiki>http://www.dnsstuff.com/dnslite/?r=u2r&domain=</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

===Displaying Online Work Orders Status===
'''Work Orders Status Check''' - Track your orders statuses in <nowiki>onforce.com</nowiki>

Note: Set Field1 to order number or change the parameter (<CMTLBLDATA_FLDTKTUSER1>) to a different field.

'''Contributed by secion8'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Tickets
|-
| Name
| Work Orders Status (onforce.com)
|-
| Base URL
| <nowiki>http://www.onforce.com/?action=pcc_work_order_view&id=</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDTKTUSER1>
|}

===N-central===

'''Show Account and Asset information directly in N-central.'''

'''Contributed by ajgyomber'''

Note: You'll need to replace "server.n-able.com", "email@domain.com" and "your_actual_password" with your actual information.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| N-central Dashboard
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=defaultDashboard&username=email@domain.com&password=your_actual_password
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Device Details
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceDetails&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Device Services
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceService&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Launch Remote Control
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceRC&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| N-central NOC View
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=nocView&username=email@domain.com&password =your_actual_password
|}

==Parameters list==

===Parameters List for Accounts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account Number
| <CMTLBLDATA_FLDCRDCARDID2>
|-
| Address: City
| <CMTLBLDATA_FLDCRDCITY>
|-
| Address: Country
| <CMTLBLDATA_FLDCRDCOUNTRY>
|-
| Address: Line1
| <CMTLBLDATA_FLDCRDADDRESS1>
|-
| Address: Line2
| <CMTLBLDATA_FLDCRDADDRESS2>
|-
| Address: Line3
| <CMTLBLDATA_FLDCRDADDRESS3>
|-
| Address: State
| <CMTLBLDATA_FLDCRDSTATE>
|-
| Address: ZIP Code
| <CMTLBLDATA_FLDCRDZIP>
|-
| Assistant
| <CMTLBLDATA_FLDCRDASSISTANT>
|-
| Birthday
| <CMTLBLDATA_FLDCRDBIRTHDAY>
|-
| Company name
| <CMTLBLDATA_FLDCRDCOMPANY>
|-
| Contact: First & Last Name
| <CMTLBLDATA_FLDCRDCONTACT>
|-
| Dear
| <CMTLBLDATA_FLDCRDDEAR>
|-
| Department
| <CMTLBLDATA_FLDCRDDEPARTMENT>
|-
| E-Mail Address 1
| <CMTLBLDATA_FLDCRDEMAIL1>
|-
| E-Mail Address 2
| <CMTLBLDATA_FLDCRDEMAIL2>
|-
| Fax Number
| <CMTLBLDATA_FLDCRDFAX1>
|-
| Fax Number Extention
| <CMTLBLDATA_FLDCRDFAXDESC1>
|-
| Field
| <CMTLBLDATA_FLDCRDPERSONID>
|-
| Field1
| <CMTLBLDATA_FLDCRDUSER2>
|-
| Field2
| <CMTLBLDATA_FLDCRDUSER3>
|-
| Field3
| <CMTLBLDATA_FLDCRDUSER4>
|-
| Field4
| <CMTLBLDATA_FLDCRDUSER5>
|-
| Field5
| <CMTLBLDATA_FLDCRDCOMPANYNO>
|-
| File as
| <CMTLBLDATA_FLDCRDFULLNAME>
|-
| ID
| <CMTLBLDATA_FLDCRDCARDID3>
|-
| Last Name
| <CMTLBLDATA_FLDCRDLASTNAME>
|-
| Phone 1
| <CMTLBLDATA_FLDCRDPHONE1>
|-
| Phone 1 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC1>
|-
| Phone 2
| <CMTLBLDATA_FLDCRDPHONE2>
|-
| Phone 2 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC2>
|-
| Phone 3
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Phone 3 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC3>
|-
| Phone 4
| <CMTLBLDATA_FLDCRDPHONE4>
|-
| Phone 4 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC4>
|-
| Popup Message
| <CMTLBLDATA_FLDCRDCARDMESSAGE>
|-
| Region
| <CMTLBLDATA_FLDCRDREGIONCODE>
|-
| Salutation
| <CMTLBLDATA_FLDCRDSUFFIX>
|-
| Status
| <CMTLBLDATA_FLDCRDUSER1>
|-
| Sub-Contact Code
| <CMTLBLDATA_FLDCRDSUBCODE>
|-
| Title
| <CMTLBLDATA_FLDCRDTITLE>
|-
| Type
| <CMTLBLDATA_FLDCRDKIND>
|-
| Web Address 1
| <CMTLBLDATA_FLDCRDURL1>
|-
| Web Address 2
| <CMTLBLDATA_FLDCRDURL2>
|}

===Parameters list for Assets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTACCRECID>
|-
| Asset Code
| <CMTLBLDATA_FLDASTASSETCODE>
|-
| Asset Type
| <CMTLBLDATA_FLDASTASSETTYPE>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTCONTACTRECID>
|-
| Create Date
| <CMTLBLDATA_FLDASTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDASTCREATEUSER_FLDWRKNICKNAME>
|-
| Purchase Date
| <CMTLBLDATA_FLDASTCUSTPURDATE>
|-
| Purchased From Us
| <CMTLBLDATA_FLDASTCUSTPURFROMUS>
|-
| Purchase Our Invoice #
| <CMTLBLDATA_FLDASTCUSTPUROURINV>
|-
| Customer PO
| <CMTLBLDATA_FLDASTCUSTPURPO>
|-
| Purchase Price
| <CMTLBLDATA_FLDASTCUSTPURPRICE>
|-
| Delivered Date
| <CMTLBLDATA_FLDASTDELIVEDATE>
|-
| Description
| <CMTLBLDATA_FLDASTDESC>
|-
| Installed By
| <CMTLBLDATA_FLDASTINSTALBY_FLDWRKNICKNAME>
|-
| Installed Date
| <CMTLBLDATA_FLDASTINSTALDATE>
|-
| License Codes
| <CMTLBLDATA_FLDASTLICENSECODE>
|-
| License Keys
| <CMTLBLDATA_FLDASTLICENSEKEYS>
|-
| License Notes
| <CMTLBLDATA_FLDASTLICENSENOTES>
|-
| Location
| <CMTLBLDATA_FLDASTLOCATION>
|-
| Manufacturer
| <CMTLBLDATA_FLDASTMANUFACTURER>
|-
| Manufacturer Serial No.
| <CMTLBLDATA_FLDASTMNFSERIALNO>
|-
| Model
| <CMTLBLDATA_FLDASTMODEL>
|-
| Asset Name
| <CMTLBLDATA_FLDASTNAME>
|-
| Notes
| <CMTLBLDATA_FLDASTNOTES>
|-
| PARENTASSETRECID
| <CMTLBLDATA_FLDASTPARENTRECID>
|-
| Quantity
| <CMTLBLDATA_FLDASTQUANTITY>
|-
| Record ID
| <CMTLBLDATA_FLDASTRECID>
|-
| Serial No.
| <CMTLBLDATA_FLDASTSERIALNO>
|-
| Status
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Last Update date
| <CMTLBLDATA_FLDASTUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDASTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDASTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDASTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDASTUSER3>
|-
| Field4
| <CMTLBLDATA_FLDASTUSER4>
|-
| Field5
| <CMTLBLDATA_FLDASTUSER5>
|-
| Date1
| <CMTLBLDATA_FLDASTUSERDATE1>
|-
| Number1
| <CMTLBLDATA_FLDASTUSERNUMBER1>
|-
| Vendor Purchased Date
| <CMTLBLDATA_FLDASTVENDORDATEPURC>
|-
| Vendor Invoice #
| <CMTLBLDATA_FLDASTVENDORINVNO>
|-
| Vendor Name
| <CMTLBLDATA_FLDASTVENDORNAME>
|-
| Vendor PO
| <CMTLBLDATA_FLDASTVENDOROURPO>
|-
| Vendor Price
| <CMTLBLDATA_FLDASTVENDORPRICE>
|-
| Vendor
| <CMTLBLDATA_FLDASTVENDORRECID>
|-
| Vendor Serial No.
| <CMTLBLDATA_FLDASTVENDORSERNO>
|-
| Vendor Warranty Exp. Date
| <CMTLBLDATA_FLDASTVENDORWARREXP>
|-
| Version
| <CMTLBLDATA_FLDASTVERSION>
|-
| Warranty/License Exp. Date
| <CMTLBLDATA_FLDASTWARREXPDATE>FLDASTWARREXPDATE
|}

===Parameters list for Contracts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTACCRECID>
|-
| Block - Used
| <CMTLBLDATA_FLDBCTAMOUNTUSED>
|-
| Code
| <CMTLBLDATA_FLDBCTCODE>
|-
| Contract Type Type
| <CMTLBLDATA_FLDBCTCONTRACTTYPE>
|-
| Create Date
| <CMTLBLDATA_FLDBCTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDBCTCREATEUSER_FLDWRKNICKNAME>
|-
| Default Item Expense ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMEXPNS>
|-
| Default Item Labor ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMLABOR>
|-
| Default Item Part ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMPART>
|-
| Description
| <CMTLBLDATA_FLDBCTDESCEXTERNAL>
|-
| Internal Description
| <CMTLBLDATA_FLDBCTDESCINTERNAL>
|-
| End Date
| <CMTLBLDATA_FLDBCTENDDATE>
|-
| Name
| <CMTLBLDATA_FLDBCTNAME>
|-
| Note
| <CMTLBLDATA_FLDBCTNOTE>
|-
| Record ID
| <CMTLBLDATA_FLDBCTRECID>
|-
| Start Date
| <CMTLBLDATA_FLDBCTSTARTDATE>
|-
| Status
| <CMTLBLDATA_FLDBCTSTATUS>
|-
| Last Update date
| <CMTLBLDATA_FLDBCTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDBCTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field 1
| <CMTLBLDATA_FLDBCTUSER1>
|-
| Field 2
| <CMTLBLDATA_FLDBCTUSER2>
|-
| Field 3
| <CMTLBLDATA_FLDBCTUSER3>
|}

===Parameters list for Items===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Currency
| <CMTLBLDATA_FLDITMCOINID>
|-
| Created by User
| <CMTLBLDATA_FLDITMCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDITMDESC>
|-
| Expense Type
| <CMTLBLDATA_FLDITMEXPITEMTYPE>
|-
| Labor Type
| <CMTLBLDATA_FLDITMFEEITEMTYPE>
|-
| Item Code
| <CMTLBLDATA_FLDITMITEMNO>
|-
| Group
| <CMTLBLDATA_FLDITMITEMTYPEGROUP>
|-
| Name
| <CMTLBLDATA_FLDITMNAME>
|-
| Notes
| <CMTLBLDATA_FLDITMNOTES>
|-
| Price Source
| <CMTLBLDATA_FLDITMPRICESOURCE>
|-
| Product/Part Type
| <CMTLBLDATA_FLDITMPRODITEMTYPE>
|-
| Record Id
| <CMTLBLDATA_FLDITMRECID>
|-
| Cost
| <CMTLBLDATA_FLDITMSTANDARDCOST>
|-
| Suspend
| <CMTLBLDATA_FLDITMSUSPENDED>
|-
| Price
| <CMTLBLDATA_FLDITMUNITPRICE>
|-
| Update Date
| <CMTLBLDATA_FLDITMUPDATEDATE>
|-
| Update User
| <CMTLBLDATA_FLDITMUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDITMUSER1>
|}

===Parameters list for Opportunities===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Amount
| <CMTLBLDATA_FLDOPPAMOUNT>
|-
| Amount by Probability
| <CMTLBLDATA_FLDOPPCALCAMOUNT>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCARDID>
|-
| Closing amnt
| <CMTLBLDATA_FLDOPPCLOSEAMOUNT>
|-
| Close
| <CMTLBLDATA_FLDOPPCLOSEDATE>
|-
| Currency
| <CMTLBLDATA_FLDOPPCOINID>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCONTACTID>
|-
| Creation Date
| <CMTLBLDATA_FLDOPPCREATEDATE>
|-
| Created by User
| <CMTLBLDATA_FLDOPPCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDOPPDESCRIPTION>
|-
| Close By
| <CMTLBLDATA_FLDOPPESTDATE>
|-
| Oppty Type
| <CMTLBLDATA_FLDOPPKIND>
|-
| Opportunity
| <CMTLBLDATA_FLDOPPNAME>
|-
| Note
| <CMTLBLDATA_FLDOPPNOTES>
|-
| Open
| <CMTLBLDATA_FLDOPPOPENDATE>
|-
| Probability %
| <CMTLBLDATA_FLDOPPPROBABILITY>
|-
| Reason
| <CMTLBLDATA_FLDOPPREASON>
|-
| Record ID
| <CMTLBLDATA_FLDOPPRECID>
|-
| Record type
| <CMTLBLDATA_FLDOPPRECKIND>
|-
| Territory
| <CMTLBLDATA_FLDOPPREGION>
|-
| Source
| <CMTLBLDATA_FLDOPPSOURCE>
|-
| Stage
| <CMTLBLDATA_FLDOPPSTAGE>
|-
| Status
| <CMTLBLDATA_FLDOPPSTATUS>
|-
| Last Update Date
| <CMTLBLDATA_FLDOPPUPDATEDATE>
|-
| Last Update: By User
| <CMTLBLDATA_FLDOPPUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDOPPUSER1>
|-
| Field2
| <CMTLBLDATA_FLDOPPUSER2>
|-
| Field3
| <CMTLBLDATA_FLDOPPUSER3>
|-
| Opportunity ID
| <CMTLBLDATA_FLDOPPUSERID>
|-
| Manager
| <CMTLBLDATA_FLDOPPWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Asset ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTASSETRECID>
|-
| Contract ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTBCRECID>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCARDID>
|-
| Category
| <CMTLBLDATA_FLDTKTCATEGORY>
|-
| Cause
| <CMTLBLDATA_FLDTKTCAUSE>
|-
| Close Date
| <CMTLBLDATA_FLDTKTCLOSEDATETIME>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCONTACTID>
|-
| Creation: Date
| <CMTLBLDATA_FLDTKTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDTKTCREATEUSER_FLDWRKNICKNAME>
|-
| Due Date
| <CMTLBLDATA_FLDTKTDUEDATETIME>
|-
| Ticket Type
| <CMTLBLDATA_FLDTKTKIND>
|-
| Notes
| <CMTLBLDATA_FLDTKTNOTES>CMTLBLDATA
|-
| Open Date
| <CMTLBLDATA_FLDTKTOPENDATETIME>
|-
| Priority
| <CMTLBLDATA_FLDTKTPRIORITY>
|-
| Description
| <CMTLBLDATA_FLDTKTPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDTKTRECID>
|-
| Account's Region Code
| <CMTLBLDATA_FLDTKTREGIONCODE>
|-
| Estimated Duration Needed
| <CMTLBLDATA_FLDTKTSCHEDLENESTIM>
|-
| Resolution Description
| <CMTLBLDATA_FLDTKTSOLUTION>
|-
| Source
| <CMTLBLDATA_FLDTKTSOURCE>
|-
| Status
| <CMTLBLDATA_FLDTKTSTATUS>
|-
| Status: Ext.
| <CMTLBLDATA_FLDTKTSTATUSNOTE>
|-
| Ticket Number
| <CMTLBLDATA_FLDTKTTICKETNO>
|-
| Last Update Date
| <CMTLBLDATA_FLDTKTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDTKTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDTKTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDTKTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDTKTUSER3>
|-
| Manager
| <CMTLBLDATA_FLDTKTWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Category
| <CMTLBLDATA_FLDKBACATEGORY>
|-
| Create Date
| <CMTLBLDATA_FLDKBACREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDKBACREATEUSER_FLDWRKNICKNAME>
|-
| Public
| <CMTLBLDATA_FLDKBAISPUBLIC>
|-
| Problem
| <CMTLBLDATA_FLDKBAPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDKBARECID>
|-
| Solution
| <CMTLBLDATA_FLDKBASOLUTION>
|-
| Status
| <CMTLBLDATA_FLDKBASTATUS>
|-
| Title
| <CMTLBLDATA_FLDKBATITLE>
|-
| Last Update date
| <CMTLBLDATA_FLDKBAUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDKBAUPDATEUSER_FLDWRKNICKNAME>
|}

===Lookup Fields===
*Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket. This way you can define an Online Service for the Account, which will be activated from the Ticket window. Lookup Field syntax: <CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1> Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account FLDCRDADDRESS1 is the account's Address field

==See Also==
*[[Online Services FAQ]]

[[Category:Integration]]

Online Services

2009-08-23T09:00:55Z

Yarden: /* Displaying Domain WHOIS */

{{integration}}

Commit's '''Online Services''' is a powerful feature which allows you to link to web sites (URL) and activate the web application using parameters taken from CommitCRM.

You can define as many online Services as you wish. This feature is available for the following entities: Accounts, Tickets, Assets, Items, Contracts, Knowledge Base Articles and Oppotrunities.
*Accounts window
*Tickets window
*Dispatcher window
*Asset window
*Items window
*Contracts window
*Opportunities window

==What can I use Online Services for?==
Wouldn't you like your technicians to be able to find an address for a scheduled visit with just a single click? You can do this by defining an Online Service which will open maps site (e.g. Google Maps, Yahoo! Maps etc.) and the map will open automatically on the address of the Account or Contact stored in CommitCRM.

This powerful tool allows you to define any URL and open it with parameters. You can basically do with it whatever you want.

==Adding new Online Services==
To define a new Online Service, Open the Online Services Management window from Settings > Online Services. or click the Online Services icon from the Accounts window toolbar. Click the New button to add a new Online Service and enter the following parameters:

*'''Name''' - The name of the service which will be displayed in the Online Services list and menus throughout the system, for example, "Google Maps".
*'''Base URL''' - The URL you wish to open in order to use the Service. This is the address of the main service (before passing any parameters to it), for example http://maps.google.com/maps.
*'''URL Parameters''' - Parameters which will be appended to the URL in order to create specific queries when opening the URL. These parameters can be CommitCRM Account database fields which will be taken and filled from CommitCRM when clicking the Online Service.

See the Tips and Tricks for examples of useful Online Services

==Activating Online Services==
Online Services can be activated from various places in CommitCRM including:
*The '''Account, Ticket, Asset, Item, Opportunity, Contract, Knowledge Base Article windows''' - click the Online Services icon to activate the service for the selected account
*The '''Dispatcher Windows''' - right-click on a selected Ticket to run any Online Service for the Ticket's Account or Contact (such as displaying a map).
*The '''Calendar / Scheduled Appointments''' views - right-click above an Appointment and select Online Services.
*The '''secondary Contacts tab''' - select a Contact, right-click and select Online Services
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.
*'''Secondary Contact selection''' field - right-click and select Online Services.
*The '''Relations tab under Account''' - right-click and select Online Services.

==Possible Usage==
*'''Online Services and Assets''' – Access your MSP product online and pass the Asset ID to display its details from your external system
*'''Online Services and Items''' – Search for better prices for items by passing specific item information directly from within CommitCRM.
*'''Online Services for Assets''' – Search for a specific product review by its hardware serial number.
*'''Online Services for Tickets''' – Search in online knowledge bases for solutions based on the ticket description
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.

==Using Lookup Fields==
Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket.

This way you can define an Online Service for the Ticket, which will be activated from the Ticket window and will be using Account information.

Lookup Field syntax:

<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>

Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account
FLDCRDADDRESS1 is the account's Address field

==Tips & Tricks==
Following are examples of possible Online Services configurations.
These examples are intended to explain the use of Online Services only.

Disclaimer - Before defining your Online Services you should read the terms of use for each web site you want to access. The examples below are displayed to explain how to use online services and how to pass parameters.

===Displaying Online Maps===
'''Google Maps''' - Opens Google Maps and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Maps
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDCRDADDRESS1>+<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDSTATE>+<CMTLBLDATA_FLDCRDZIP>
|}

'''MapQuest''' - Opens MapQuest Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| MapQuest
|-
| Base URL
| <nowiki>http://www.mapquest.com/maps</nowiki>
|-
| URL Parameters
| /map.adp?searchtype=address&country=<CMTLBLDATA_FLDCRDCOUNTRY>&addtohistory=&searchtab=home&formtype=address&popflag=0&latitude=&longitude=&name=&phone=&level=&cat=&address=&city=<CMTLBLDATA_FLDCRDCITY>&state=<CMTLBLDATA_FLDCRDSTATE>&zipcode=<CMTLBLDATA_FLDCRDZIP>
|}

'''Yahoo! Maps''' - Opens Yahoo! Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Yahoo! Maps
|-
| Base URL
| <nowiki>http://maps.yahoo.com</nowiki>
|-
| URL Parameters
| /maps_result?addr=<CMTLBLDATA_FLDCRDADDRESS1>&csz=<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDCOUNTRY>&country=<CMTLBLDATA_FLDCRDSTATE>
|}

===Finding Account Information===
'''Google Company''' - Opens Google and searches for the Account Company Name.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Company
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCOMPANY>
|}

'''Google Contact''' - Opens Google and searches for the Contact Name.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Contact
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCONTACT>
|}

===Finding Ticket Description in Google===
'''Google Ticket''' - Opens Google and searches for the Ticket description.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket Description
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDTKTPROBLEM>
|}

===Finding Account Address From Ticket (using [[Commit Online Services#Using Lookup Fields|Lookup Field]]) ===
'''Google Address From Ticket''' - Opens Google and searches for the Address of the Account which is linked to the Ticket.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDCITY>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDSTATE>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDZIP>
|}

===Displaying Products Warranties Online===
'''HP Warranty Lookup''' - Displays HP products warranty expiration dates, using the products number and the products serial number.

Note: Product Number goes into Plate# field (<CMTLBLDATA_FLDASTUSER1>).

'''Contributed by Easy I.T'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| HP Warranty Lookup
|-
| Base URL
| <nowiki>http://h20000.www2.hp.com/bizsupport/TechSupport/WarrantyResults.jsp?</nowiki>
|-
| URL Parameters
| lang=en&cc=us&prodSeriesId=454811&prodTypeId=12454&sn=<CMTLBLDATA_FLDASTSERIALNO>&pn=<CMTLBLDATA_FLDASTUSER1>&country=US&nickname=&find=Display+Warranty+Information+%C2%BB
|}

'''DELL Service Contracts and Warranties''' - Displays Dell products warranty expiration dates, using the service tag number.

Note: Customize a Field for Service Tag or use existing field. In this sample we will use Field3 as custumized Service Tag Field

'''Contributed by JoshuaB'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| Dell Warranty Check
|-
| Base URL
| <nowiki>http://support.dell.com/support/topics/global.aspx/support/my_systems_info/details</nowiki>
|-
| URL Parameters
| ?c=us&l=en&s=gen&servicetag=<CMTLBLDATA_FLDASTUSER3>
|}

===Displaying Domain WHOIS===

'''Network Solutions Domain WHOIS''' - WHOIS domain registration information by Network Solutions.

Note: Domain must be stripped from URL (without http://).

'''Contributed by DavidW'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (NetworkSolutions)
|-
| Base URL
| <nowiki>http://www.networksolutions.com/whois-search/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''Domain Tools Domain WHOIS''' - WHOIS domain registration information by .

Note: Domain must be stripped from URL (without http://).

'''Contributed by ajgyomber'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DomainTools)
|-
| Base URL
| <nowiki>http://whois.domaintools.com/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''DNSstuff Domain WHOIS''' - WHOIS domain registration information by DNSstuff.

Note: Domain must be stripped from URL (without http://).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DNSstuff)
|-
| Base URL
| <nowiki>http://www.dnsstuff.com/dnslite/?r=u2r&domain=</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

===Displaying Online Work Orders Status===
'''Work Orders Status Check''' - Track your orders statuses in <nowiki>onforce.com</nowiki>

Note: Set Field1 to order number or change the parameter (<CMTLBLDATA_FLDTKTUSER1>) to a different field.

'''Contributed by secion8'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Tickets
|-
| Name
| Work Orders Status (onforce.com)
|-
| Base URL
| <nowiki>http://www.onforce.com/?action=pcc_work_order_view&id=</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDTKTUSER1>
|}

===N-central===

'''Contributed by ajgyomber'''

Note: You'll need to replace "server.n-able.com", "email@domain.com" and "your_actual_password" with your actual information.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| N-central Dashboard
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=defaultDashboard&username=email@domain.com&password=your_actual_password
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Device Details
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceDetails&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Device Services
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceService&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Launch Remote Control
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceRC&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| N-central NOC View
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=nocView&username=email@domain.com&password =your_actual_password
|}

==Parameters list==

===Parameters List for Accounts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account Number
| <CMTLBLDATA_FLDCRDCARDID2>
|-
| Address: City
| <CMTLBLDATA_FLDCRDCITY>
|-
| Address: Country
| <CMTLBLDATA_FLDCRDCOUNTRY>
|-
| Address: Line1
| <CMTLBLDATA_FLDCRDADDRESS1>
|-
| Address: Line2
| <CMTLBLDATA_FLDCRDADDRESS2>
|-
| Address: Line3
| <CMTLBLDATA_FLDCRDADDRESS3>
|-
| Address: State
| <CMTLBLDATA_FLDCRDSTATE>
|-
| Address: ZIP Code
| <CMTLBLDATA_FLDCRDZIP>
|-
| Assistant
| <CMTLBLDATA_FLDCRDASSISTANT>
|-
| Birthday
| <CMTLBLDATA_FLDCRDBIRTHDAY>
|-
| Company name
| <CMTLBLDATA_FLDCRDCOMPANY>
|-
| Contact: First & Last Name
| <CMTLBLDATA_FLDCRDCONTACT>
|-
| Dear
| <CMTLBLDATA_FLDCRDDEAR>
|-
| Department
| <CMTLBLDATA_FLDCRDDEPARTMENT>
|-
| E-Mail Address 1
| <CMTLBLDATA_FLDCRDEMAIL1>
|-
| E-Mail Address 2
| <CMTLBLDATA_FLDCRDEMAIL2>
|-
| Fax Number
| <CMTLBLDATA_FLDCRDFAX1>
|-
| Fax Number Extention
| <CMTLBLDATA_FLDCRDFAXDESC1>
|-
| Field
| <CMTLBLDATA_FLDCRDPERSONID>
|-
| Field1
| <CMTLBLDATA_FLDCRDUSER2>
|-
| Field2
| <CMTLBLDATA_FLDCRDUSER3>
|-
| Field3
| <CMTLBLDATA_FLDCRDUSER4>
|-
| Field4
| <CMTLBLDATA_FLDCRDUSER5>
|-
| Field5
| <CMTLBLDATA_FLDCRDCOMPANYNO>
|-
| File as
| <CMTLBLDATA_FLDCRDFULLNAME>
|-
| ID
| <CMTLBLDATA_FLDCRDCARDID3>
|-
| Last Name
| <CMTLBLDATA_FLDCRDLASTNAME>
|-
| Phone 1
| <CMTLBLDATA_FLDCRDPHONE1>
|-
| Phone 1 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC1>
|-
| Phone 2
| <CMTLBLDATA_FLDCRDPHONE2>
|-
| Phone 2 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC2>
|-
| Phone 3
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Phone 3 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC3>
|-
| Phone 4
| <CMTLBLDATA_FLDCRDPHONE4>
|-
| Phone 4 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC4>
|-
| Popup Message
| <CMTLBLDATA_FLDCRDCARDMESSAGE>
|-
| Region
| <CMTLBLDATA_FLDCRDREGIONCODE>
|-
| Salutation
| <CMTLBLDATA_FLDCRDSUFFIX>
|-
| Status
| <CMTLBLDATA_FLDCRDUSER1>
|-
| Sub-Contact Code
| <CMTLBLDATA_FLDCRDSUBCODE>
|-
| Title
| <CMTLBLDATA_FLDCRDTITLE>
|-
| Type
| <CMTLBLDATA_FLDCRDKIND>
|-
| Web Address 1
| <CMTLBLDATA_FLDCRDURL1>
|-
| Web Address 2
| <CMTLBLDATA_FLDCRDURL2>
|}

===Parameters list for Assets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTACCRECID>
|-
| Asset Code
| <CMTLBLDATA_FLDASTASSETCODE>
|-
| Asset Type
| <CMTLBLDATA_FLDASTASSETTYPE>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTCONTACTRECID>
|-
| Create Date
| <CMTLBLDATA_FLDASTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDASTCREATEUSER_FLDWRKNICKNAME>
|-
| Purchase Date
| <CMTLBLDATA_FLDASTCUSTPURDATE>
|-
| Purchased From Us
| <CMTLBLDATA_FLDASTCUSTPURFROMUS>
|-
| Purchase Our Invoice #
| <CMTLBLDATA_FLDASTCUSTPUROURINV>
|-
| Customer PO
| <CMTLBLDATA_FLDASTCUSTPURPO>
|-
| Purchase Price
| <CMTLBLDATA_FLDASTCUSTPURPRICE>
|-
| Delivered Date
| <CMTLBLDATA_FLDASTDELIVEDATE>
|-
| Description
| <CMTLBLDATA_FLDASTDESC>
|-
| Installed By
| <CMTLBLDATA_FLDASTINSTALBY_FLDWRKNICKNAME>
|-
| Installed Date
| <CMTLBLDATA_FLDASTINSTALDATE>
|-
| License Codes
| <CMTLBLDATA_FLDASTLICENSECODE>
|-
| License Keys
| <CMTLBLDATA_FLDASTLICENSEKEYS>
|-
| License Notes
| <CMTLBLDATA_FLDASTLICENSENOTES>
|-
| Location
| <CMTLBLDATA_FLDASTLOCATION>
|-
| Manufacturer
| <CMTLBLDATA_FLDASTMANUFACTURER>
|-
| Manufacturer Serial No.
| <CMTLBLDATA_FLDASTMNFSERIALNO>
|-
| Model
| <CMTLBLDATA_FLDASTMODEL>
|-
| Asset Name
| <CMTLBLDATA_FLDASTNAME>
|-
| Notes
| <CMTLBLDATA_FLDASTNOTES>
|-
| PARENTASSETRECID
| <CMTLBLDATA_FLDASTPARENTRECID>
|-
| Quantity
| <CMTLBLDATA_FLDASTQUANTITY>
|-
| Record ID
| <CMTLBLDATA_FLDASTRECID>
|-
| Serial No.
| <CMTLBLDATA_FLDASTSERIALNO>
|-
| Status
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Last Update date
| <CMTLBLDATA_FLDASTUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDASTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDASTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDASTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDASTUSER3>
|-
| Field4
| <CMTLBLDATA_FLDASTUSER4>
|-
| Field5
| <CMTLBLDATA_FLDASTUSER5>
|-
| Date1
| <CMTLBLDATA_FLDASTUSERDATE1>
|-
| Number1
| <CMTLBLDATA_FLDASTUSERNUMBER1>
|-
| Vendor Purchased Date
| <CMTLBLDATA_FLDASTVENDORDATEPURC>
|-
| Vendor Invoice #
| <CMTLBLDATA_FLDASTVENDORINVNO>
|-
| Vendor Name
| <CMTLBLDATA_FLDASTVENDORNAME>
|-
| Vendor PO
| <CMTLBLDATA_FLDASTVENDOROURPO>
|-
| Vendor Price
| <CMTLBLDATA_FLDASTVENDORPRICE>
|-
| Vendor
| <CMTLBLDATA_FLDASTVENDORRECID>
|-
| Vendor Serial No.
| <CMTLBLDATA_FLDASTVENDORSERNO>
|-
| Vendor Warranty Exp. Date
| <CMTLBLDATA_FLDASTVENDORWARREXP>
|-
| Version
| <CMTLBLDATA_FLDASTVERSION>
|-
| Warranty/License Exp. Date
| <CMTLBLDATA_FLDASTWARREXPDATE>FLDASTWARREXPDATE
|}

===Parameters list for Contracts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTACCRECID>
|-
| Block - Used
| <CMTLBLDATA_FLDBCTAMOUNTUSED>
|-
| Code
| <CMTLBLDATA_FLDBCTCODE>
|-
| Contract Type Type
| <CMTLBLDATA_FLDBCTCONTRACTTYPE>
|-
| Create Date
| <CMTLBLDATA_FLDBCTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDBCTCREATEUSER_FLDWRKNICKNAME>
|-
| Default Item Expense ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMEXPNS>
|-
| Default Item Labor ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMLABOR>
|-
| Default Item Part ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMPART>
|-
| Description
| <CMTLBLDATA_FLDBCTDESCEXTERNAL>
|-
| Internal Description
| <CMTLBLDATA_FLDBCTDESCINTERNAL>
|-
| End Date
| <CMTLBLDATA_FLDBCTENDDATE>
|-
| Name
| <CMTLBLDATA_FLDBCTNAME>
|-
| Note
| <CMTLBLDATA_FLDBCTNOTE>
|-
| Record ID
| <CMTLBLDATA_FLDBCTRECID>
|-
| Start Date
| <CMTLBLDATA_FLDBCTSTARTDATE>
|-
| Status
| <CMTLBLDATA_FLDBCTSTATUS>
|-
| Last Update date
| <CMTLBLDATA_FLDBCTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDBCTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field 1
| <CMTLBLDATA_FLDBCTUSER1>
|-
| Field 2
| <CMTLBLDATA_FLDBCTUSER2>
|-
| Field 3
| <CMTLBLDATA_FLDBCTUSER3>
|}

===Parameters list for Items===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Currency
| <CMTLBLDATA_FLDITMCOINID>
|-
| Created by User
| <CMTLBLDATA_FLDITMCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDITMDESC>
|-
| Expense Type
| <CMTLBLDATA_FLDITMEXPITEMTYPE>
|-
| Labor Type
| <CMTLBLDATA_FLDITMFEEITEMTYPE>
|-
| Item Code
| <CMTLBLDATA_FLDITMITEMNO>
|-
| Group
| <CMTLBLDATA_FLDITMITEMTYPEGROUP>
|-
| Name
| <CMTLBLDATA_FLDITMNAME>
|-
| Notes
| <CMTLBLDATA_FLDITMNOTES>
|-
| Price Source
| <CMTLBLDATA_FLDITMPRICESOURCE>
|-
| Product/Part Type
| <CMTLBLDATA_FLDITMPRODITEMTYPE>
|-
| Record Id
| <CMTLBLDATA_FLDITMRECID>
|-
| Cost
| <CMTLBLDATA_FLDITMSTANDARDCOST>
|-
| Suspend
| <CMTLBLDATA_FLDITMSUSPENDED>
|-
| Price
| <CMTLBLDATA_FLDITMUNITPRICE>
|-
| Update Date
| <CMTLBLDATA_FLDITMUPDATEDATE>
|-
| Update User
| <CMTLBLDATA_FLDITMUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDITMUSER1>
|}

===Parameters list for Opportunities===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Amount
| <CMTLBLDATA_FLDOPPAMOUNT>
|-
| Amount by Probability
| <CMTLBLDATA_FLDOPPCALCAMOUNT>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCARDID>
|-
| Closing amnt
| <CMTLBLDATA_FLDOPPCLOSEAMOUNT>
|-
| Close
| <CMTLBLDATA_FLDOPPCLOSEDATE>
|-
| Currency
| <CMTLBLDATA_FLDOPPCOINID>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCONTACTID>
|-
| Creation Date
| <CMTLBLDATA_FLDOPPCREATEDATE>
|-
| Created by User
| <CMTLBLDATA_FLDOPPCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDOPPDESCRIPTION>
|-
| Close By
| <CMTLBLDATA_FLDOPPESTDATE>
|-
| Oppty Type
| <CMTLBLDATA_FLDOPPKIND>
|-
| Opportunity
| <CMTLBLDATA_FLDOPPNAME>
|-
| Note
| <CMTLBLDATA_FLDOPPNOTES>
|-
| Open
| <CMTLBLDATA_FLDOPPOPENDATE>
|-
| Probability %
| <CMTLBLDATA_FLDOPPPROBABILITY>
|-
| Reason
| <CMTLBLDATA_FLDOPPREASON>
|-
| Record ID
| <CMTLBLDATA_FLDOPPRECID>
|-
| Record type
| <CMTLBLDATA_FLDOPPRECKIND>
|-
| Territory
| <CMTLBLDATA_FLDOPPREGION>
|-
| Source
| <CMTLBLDATA_FLDOPPSOURCE>
|-
| Stage
| <CMTLBLDATA_FLDOPPSTAGE>
|-
| Status
| <CMTLBLDATA_FLDOPPSTATUS>
|-
| Last Update Date
| <CMTLBLDATA_FLDOPPUPDATEDATE>
|-
| Last Update: By User
| <CMTLBLDATA_FLDOPPUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDOPPUSER1>
|-
| Field2
| <CMTLBLDATA_FLDOPPUSER2>
|-
| Field3
| <CMTLBLDATA_FLDOPPUSER3>
|-
| Opportunity ID
| <CMTLBLDATA_FLDOPPUSERID>
|-
| Manager
| <CMTLBLDATA_FLDOPPWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Asset ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTASSETRECID>
|-
| Contract ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTBCRECID>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCARDID>
|-
| Category
| <CMTLBLDATA_FLDTKTCATEGORY>
|-
| Cause
| <CMTLBLDATA_FLDTKTCAUSE>
|-
| Close Date
| <CMTLBLDATA_FLDTKTCLOSEDATETIME>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCONTACTID>
|-
| Creation: Date
| <CMTLBLDATA_FLDTKTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDTKTCREATEUSER_FLDWRKNICKNAME>
|-
| Due Date
| <CMTLBLDATA_FLDTKTDUEDATETIME>
|-
| Ticket Type
| <CMTLBLDATA_FLDTKTKIND>
|-
| Notes
| <CMTLBLDATA_FLDTKTNOTES>CMTLBLDATA
|-
| Open Date
| <CMTLBLDATA_FLDTKTOPENDATETIME>
|-
| Priority
| <CMTLBLDATA_FLDTKTPRIORITY>
|-
| Description
| <CMTLBLDATA_FLDTKTPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDTKTRECID>
|-
| Account's Region Code
| <CMTLBLDATA_FLDTKTREGIONCODE>
|-
| Estimated Duration Needed
| <CMTLBLDATA_FLDTKTSCHEDLENESTIM>
|-
| Resolution Description
| <CMTLBLDATA_FLDTKTSOLUTION>
|-
| Source
| <CMTLBLDATA_FLDTKTSOURCE>
|-
| Status
| <CMTLBLDATA_FLDTKTSTATUS>
|-
| Status: Ext.
| <CMTLBLDATA_FLDTKTSTATUSNOTE>
|-
| Ticket Number
| <CMTLBLDATA_FLDTKTTICKETNO>
|-
| Last Update Date
| <CMTLBLDATA_FLDTKTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDTKTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDTKTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDTKTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDTKTUSER3>
|-
| Manager
| <CMTLBLDATA_FLDTKTWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Category
| <CMTLBLDATA_FLDKBACATEGORY>
|-
| Create Date
| <CMTLBLDATA_FLDKBACREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDKBACREATEUSER_FLDWRKNICKNAME>
|-
| Public
| <CMTLBLDATA_FLDKBAISPUBLIC>
|-
| Problem
| <CMTLBLDATA_FLDKBAPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDKBARECID>
|-
| Solution
| <CMTLBLDATA_FLDKBASOLUTION>
|-
| Status
| <CMTLBLDATA_FLDKBASTATUS>
|-
| Title
| <CMTLBLDATA_FLDKBATITLE>
|-
| Last Update date
| <CMTLBLDATA_FLDKBAUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDKBAUPDATEUSER_FLDWRKNICKNAME>
|}

===Lookup Fields===
*Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket. This way you can define an Online Service for the Account, which will be activated from the Ticket window. Lookup Field syntax: <CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1> Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account FLDCRDADDRESS1 is the account's Address field

==See Also==
*[[Online Services FAQ]]

[[Category:Integration]]

Online Services

2009-08-23T08:58:03Z

Yarden: /* Finding Account Information */

{{integration}}

Commit's '''Online Services''' is a powerful feature which allows you to link to web sites (URL) and activate the web application using parameters taken from CommitCRM.

You can define as many online Services as you wish. This feature is available for the following entities: Accounts, Tickets, Assets, Items, Contracts, Knowledge Base Articles and Oppotrunities.
*Accounts window
*Tickets window
*Dispatcher window
*Asset window
*Items window
*Contracts window
*Opportunities window

==What can I use Online Services for?==
Wouldn't you like your technicians to be able to find an address for a scheduled visit with just a single click? You can do this by defining an Online Service which will open maps site (e.g. Google Maps, Yahoo! Maps etc.) and the map will open automatically on the address of the Account or Contact stored in CommitCRM.

This powerful tool allows you to define any URL and open it with parameters. You can basically do with it whatever you want.

==Adding new Online Services==
To define a new Online Service, Open the Online Services Management window from Settings > Online Services. or click the Online Services icon from the Accounts window toolbar. Click the New button to add a new Online Service and enter the following parameters:

*'''Name''' - The name of the service which will be displayed in the Online Services list and menus throughout the system, for example, "Google Maps".
*'''Base URL''' - The URL you wish to open in order to use the Service. This is the address of the main service (before passing any parameters to it), for example http://maps.google.com/maps.
*'''URL Parameters''' - Parameters which will be appended to the URL in order to create specific queries when opening the URL. These parameters can be CommitCRM Account database fields which will be taken and filled from CommitCRM when clicking the Online Service.

See the Tips and Tricks for examples of useful Online Services

==Activating Online Services==
Online Services can be activated from various places in CommitCRM including:
*The '''Account, Ticket, Asset, Item, Opportunity, Contract, Knowledge Base Article windows''' - click the Online Services icon to activate the service for the selected account
*The '''Dispatcher Windows''' - right-click on a selected Ticket to run any Online Service for the Ticket's Account or Contact (such as displaying a map).
*The '''Calendar / Scheduled Appointments''' views - right-click above an Appointment and select Online Services.
*The '''secondary Contacts tab''' - select a Contact, right-click and select Online Services
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.
*'''Secondary Contact selection''' field - right-click and select Online Services.
*The '''Relations tab under Account''' - right-click and select Online Services.

==Possible Usage==
*'''Online Services and Assets''' – Access your MSP product online and pass the Asset ID to display its details from your external system
*'''Online Services and Items''' – Search for better prices for items by passing specific item information directly from within CommitCRM.
*'''Online Services for Assets''' – Search for a specific product review by its hardware serial number.
*'''Online Services for Tickets''' – Search in online knowledge bases for solutions based on the ticket description
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.

==Using Lookup Fields==
Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket.

This way you can define an Online Service for the Ticket, which will be activated from the Ticket window and will be using Account information.

Lookup Field syntax:

<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>

Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account
FLDCRDADDRESS1 is the account's Address field

==Tips & Tricks==
Following are examples of possible Online Services configurations.
These examples are intended to explain the use of Online Services only.

Disclaimer - Before defining your Online Services you should read the terms of use for each web site you want to access. The examples below are displayed to explain how to use online services and how to pass parameters.

===Displaying Online Maps===
'''Google Maps''' - Opens Google Maps and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Maps
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDCRDADDRESS1>+<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDSTATE>+<CMTLBLDATA_FLDCRDZIP>
|}

'''MapQuest''' - Opens MapQuest Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| MapQuest
|-
| Base URL
| <nowiki>http://www.mapquest.com/maps</nowiki>
|-
| URL Parameters
| /map.adp?searchtype=address&country=<CMTLBLDATA_FLDCRDCOUNTRY>&addtohistory=&searchtab=home&formtype=address&popflag=0&latitude=&longitude=&name=&phone=&level=&cat=&address=&city=<CMTLBLDATA_FLDCRDCITY>&state=<CMTLBLDATA_FLDCRDSTATE>&zipcode=<CMTLBLDATA_FLDCRDZIP>
|}

'''Yahoo! Maps''' - Opens Yahoo! Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Yahoo! Maps
|-
| Base URL
| <nowiki>http://maps.yahoo.com</nowiki>
|-
| URL Parameters
| /maps_result?addr=<CMTLBLDATA_FLDCRDADDRESS1>&csz=<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDCOUNTRY>&country=<CMTLBLDATA_FLDCRDSTATE>
|}

===Finding Account Information===
'''Google Company''' - Opens Google and searches for the Account Company Name.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Company
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCOMPANY>
|}

'''Google Contact''' - Opens Google and searches for the Contact Name.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Contact
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCONTACT>
|}

===Finding Ticket Description in Google===
'''Google Ticket''' - Opens Google and searches for the Ticket description.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket Description
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDTKTPROBLEM>
|}

===Finding Account Address From Ticket (using [[Commit Online Services#Using Lookup Fields|Lookup Field]]) ===
'''Google Address From Ticket''' - Opens Google and searches for the Address of the Account which is linked to the Ticket.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDCITY>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDSTATE>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDZIP>
|}

===Displaying Products Warranties Online===
'''HP Warranty Lookup''' - Displays HP products warranty expiration dates, using the products number and the products serial number.

Note: Product Number goes into Plate# field (<CMTLBLDATA_FLDASTUSER1>).

'''Contributed by Easy I.T'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| HP Warranty Lookup
|-
| Base URL
| <nowiki>http://h20000.www2.hp.com/bizsupport/TechSupport/WarrantyResults.jsp?</nowiki>
|-
| URL Parameters
| lang=en&cc=us&prodSeriesId=454811&prodTypeId=12454&sn=<CMTLBLDATA_FLDASTSERIALNO>&pn=<CMTLBLDATA_FLDASTUSER1>&country=US&nickname=&find=Display+Warranty+Information+%C2%BB
|}

'''DELL Service Contracts and Warranties''' - Displays Dell products warranty expiration dates, using the service tag number.

Note: Customize a Field for Service Tag or use existing field. In this sample we will use Field3 as custumized Service Tag Field

'''Contributed by JoshuaB'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| Dell Warranty Check
|-
| Base URL
| <nowiki>http://support.dell.com/support/topics/global.aspx/support/my_systems_info/details</nowiki>
|-
| URL Parameters
| ?c=us&l=en&s=gen&servicetag=<CMTLBLDATA_FLDASTUSER3>
|}

===Displaying Domain WHOIS===

'''Domain Tools Domain WHOIS''' - WHOIS domain registration information by .

Note: Domain must be stripped from URL (without http://).

'''Contributed by DavidW'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (NetworkSolutions)
|-
| Base URL
| <nowiki>http://www.networksolutions.com/whois-search/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''Network Solutions Domain WHOIS''' - WHOIS domain registration information by Network Solutions.

Note: Domain must be stripped from URL (without http://).

'''Contributed by ajgyomber'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DomainTools)
|-
| Base URL
| <nowiki>http://whois.domaintools.com/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''DNSstuff Domain WHOIS''' - WHOIS domain registration information by DNSstuff.

Note: Domain must be stripped from URL (without http://).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DNSstuff)
|-
| Base URL
| <nowiki>http://www.dnsstuff.com/dnslite/?r=u2r&domain=</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

===Displaying Online Work Orders Status===
'''Work Orders Status Check''' - Track your orders statuses in <nowiki>onforce.com</nowiki>

Note: Set Field1 to order number or change the parameter (<CMTLBLDATA_FLDTKTUSER1>) to a different field.

'''Contributed by secion8'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Tickets
|-
| Name
| Work Orders Status (onforce.com)
|-
| Base URL
| <nowiki>http://www.onforce.com/?action=pcc_work_order_view&id=</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDTKTUSER1>
|}

===N-central===

'''Contributed by ajgyomber'''

Note: You'll need to replace "server.n-able.com", "email@domain.com" and "your_actual_password" with your actual information.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| N-central Dashboard
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=defaultDashboard&username=email@domain.com&password=your_actual_password
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Device Details
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceDetails&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Device Services
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceService&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Launch Remote Control
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceRC&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| N-central NOC View
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=nocView&username=email@domain.com&password =your_actual_password
|}

==Parameters list==

===Parameters List for Accounts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account Number
| <CMTLBLDATA_FLDCRDCARDID2>
|-
| Address: City
| <CMTLBLDATA_FLDCRDCITY>
|-
| Address: Country
| <CMTLBLDATA_FLDCRDCOUNTRY>
|-
| Address: Line1
| <CMTLBLDATA_FLDCRDADDRESS1>
|-
| Address: Line2
| <CMTLBLDATA_FLDCRDADDRESS2>
|-
| Address: Line3
| <CMTLBLDATA_FLDCRDADDRESS3>
|-
| Address: State
| <CMTLBLDATA_FLDCRDSTATE>
|-
| Address: ZIP Code
| <CMTLBLDATA_FLDCRDZIP>
|-
| Assistant
| <CMTLBLDATA_FLDCRDASSISTANT>
|-
| Birthday
| <CMTLBLDATA_FLDCRDBIRTHDAY>
|-
| Company name
| <CMTLBLDATA_FLDCRDCOMPANY>
|-
| Contact: First & Last Name
| <CMTLBLDATA_FLDCRDCONTACT>
|-
| Dear
| <CMTLBLDATA_FLDCRDDEAR>
|-
| Department
| <CMTLBLDATA_FLDCRDDEPARTMENT>
|-
| E-Mail Address 1
| <CMTLBLDATA_FLDCRDEMAIL1>
|-
| E-Mail Address 2
| <CMTLBLDATA_FLDCRDEMAIL2>
|-
| Fax Number
| <CMTLBLDATA_FLDCRDFAX1>
|-
| Fax Number Extention
| <CMTLBLDATA_FLDCRDFAXDESC1>
|-
| Field
| <CMTLBLDATA_FLDCRDPERSONID>
|-
| Field1
| <CMTLBLDATA_FLDCRDUSER2>
|-
| Field2
| <CMTLBLDATA_FLDCRDUSER3>
|-
| Field3
| <CMTLBLDATA_FLDCRDUSER4>
|-
| Field4
| <CMTLBLDATA_FLDCRDUSER5>
|-
| Field5
| <CMTLBLDATA_FLDCRDCOMPANYNO>
|-
| File as
| <CMTLBLDATA_FLDCRDFULLNAME>
|-
| ID
| <CMTLBLDATA_FLDCRDCARDID3>
|-
| Last Name
| <CMTLBLDATA_FLDCRDLASTNAME>
|-
| Phone 1
| <CMTLBLDATA_FLDCRDPHONE1>
|-
| Phone 1 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC1>
|-
| Phone 2
| <CMTLBLDATA_FLDCRDPHONE2>
|-
| Phone 2 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC2>
|-
| Phone 3
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Phone 3 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC3>
|-
| Phone 4
| <CMTLBLDATA_FLDCRDPHONE4>
|-
| Phone 4 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC4>
|-
| Popup Message
| <CMTLBLDATA_FLDCRDCARDMESSAGE>
|-
| Region
| <CMTLBLDATA_FLDCRDREGIONCODE>
|-
| Salutation
| <CMTLBLDATA_FLDCRDSUFFIX>
|-
| Status
| <CMTLBLDATA_FLDCRDUSER1>
|-
| Sub-Contact Code
| <CMTLBLDATA_FLDCRDSUBCODE>
|-
| Title
| <CMTLBLDATA_FLDCRDTITLE>
|-
| Type
| <CMTLBLDATA_FLDCRDKIND>
|-
| Web Address 1
| <CMTLBLDATA_FLDCRDURL1>
|-
| Web Address 2
| <CMTLBLDATA_FLDCRDURL2>
|}

===Parameters list for Assets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTACCRECID>
|-
| Asset Code
| <CMTLBLDATA_FLDASTASSETCODE>
|-
| Asset Type
| <CMTLBLDATA_FLDASTASSETTYPE>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTCONTACTRECID>
|-
| Create Date
| <CMTLBLDATA_FLDASTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDASTCREATEUSER_FLDWRKNICKNAME>
|-
| Purchase Date
| <CMTLBLDATA_FLDASTCUSTPURDATE>
|-
| Purchased From Us
| <CMTLBLDATA_FLDASTCUSTPURFROMUS>
|-
| Purchase Our Invoice #
| <CMTLBLDATA_FLDASTCUSTPUROURINV>
|-
| Customer PO
| <CMTLBLDATA_FLDASTCUSTPURPO>
|-
| Purchase Price
| <CMTLBLDATA_FLDASTCUSTPURPRICE>
|-
| Delivered Date
| <CMTLBLDATA_FLDASTDELIVEDATE>
|-
| Description
| <CMTLBLDATA_FLDASTDESC>
|-
| Installed By
| <CMTLBLDATA_FLDASTINSTALBY_FLDWRKNICKNAME>
|-
| Installed Date
| <CMTLBLDATA_FLDASTINSTALDATE>
|-
| License Codes
| <CMTLBLDATA_FLDASTLICENSECODE>
|-
| License Keys
| <CMTLBLDATA_FLDASTLICENSEKEYS>
|-
| License Notes
| <CMTLBLDATA_FLDASTLICENSENOTES>
|-
| Location
| <CMTLBLDATA_FLDASTLOCATION>
|-
| Manufacturer
| <CMTLBLDATA_FLDASTMANUFACTURER>
|-
| Manufacturer Serial No.
| <CMTLBLDATA_FLDASTMNFSERIALNO>
|-
| Model
| <CMTLBLDATA_FLDASTMODEL>
|-
| Asset Name
| <CMTLBLDATA_FLDASTNAME>
|-
| Notes
| <CMTLBLDATA_FLDASTNOTES>
|-
| PARENTASSETRECID
| <CMTLBLDATA_FLDASTPARENTRECID>
|-
| Quantity
| <CMTLBLDATA_FLDASTQUANTITY>
|-
| Record ID
| <CMTLBLDATA_FLDASTRECID>
|-
| Serial No.
| <CMTLBLDATA_FLDASTSERIALNO>
|-
| Status
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Last Update date
| <CMTLBLDATA_FLDASTUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDASTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDASTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDASTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDASTUSER3>
|-
| Field4
| <CMTLBLDATA_FLDASTUSER4>
|-
| Field5
| <CMTLBLDATA_FLDASTUSER5>
|-
| Date1
| <CMTLBLDATA_FLDASTUSERDATE1>
|-
| Number1
| <CMTLBLDATA_FLDASTUSERNUMBER1>
|-
| Vendor Purchased Date
| <CMTLBLDATA_FLDASTVENDORDATEPURC>
|-
| Vendor Invoice #
| <CMTLBLDATA_FLDASTVENDORINVNO>
|-
| Vendor Name
| <CMTLBLDATA_FLDASTVENDORNAME>
|-
| Vendor PO
| <CMTLBLDATA_FLDASTVENDOROURPO>
|-
| Vendor Price
| <CMTLBLDATA_FLDASTVENDORPRICE>
|-
| Vendor
| <CMTLBLDATA_FLDASTVENDORRECID>
|-
| Vendor Serial No.
| <CMTLBLDATA_FLDASTVENDORSERNO>
|-
| Vendor Warranty Exp. Date
| <CMTLBLDATA_FLDASTVENDORWARREXP>
|-
| Version
| <CMTLBLDATA_FLDASTVERSION>
|-
| Warranty/License Exp. Date
| <CMTLBLDATA_FLDASTWARREXPDATE>FLDASTWARREXPDATE
|}

===Parameters list for Contracts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTACCRECID>
|-
| Block - Used
| <CMTLBLDATA_FLDBCTAMOUNTUSED>
|-
| Code
| <CMTLBLDATA_FLDBCTCODE>
|-
| Contract Type Type
| <CMTLBLDATA_FLDBCTCONTRACTTYPE>
|-
| Create Date
| <CMTLBLDATA_FLDBCTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDBCTCREATEUSER_FLDWRKNICKNAME>
|-
| Default Item Expense ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMEXPNS>
|-
| Default Item Labor ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMLABOR>
|-
| Default Item Part ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMPART>
|-
| Description
| <CMTLBLDATA_FLDBCTDESCEXTERNAL>
|-
| Internal Description
| <CMTLBLDATA_FLDBCTDESCINTERNAL>
|-
| End Date
| <CMTLBLDATA_FLDBCTENDDATE>
|-
| Name
| <CMTLBLDATA_FLDBCTNAME>
|-
| Note
| <CMTLBLDATA_FLDBCTNOTE>
|-
| Record ID
| <CMTLBLDATA_FLDBCTRECID>
|-
| Start Date
| <CMTLBLDATA_FLDBCTSTARTDATE>
|-
| Status
| <CMTLBLDATA_FLDBCTSTATUS>
|-
| Last Update date
| <CMTLBLDATA_FLDBCTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDBCTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field 1
| <CMTLBLDATA_FLDBCTUSER1>
|-
| Field 2
| <CMTLBLDATA_FLDBCTUSER2>
|-
| Field 3
| <CMTLBLDATA_FLDBCTUSER3>
|}

===Parameters list for Items===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Currency
| <CMTLBLDATA_FLDITMCOINID>
|-
| Created by User
| <CMTLBLDATA_FLDITMCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDITMDESC>
|-
| Expense Type
| <CMTLBLDATA_FLDITMEXPITEMTYPE>
|-
| Labor Type
| <CMTLBLDATA_FLDITMFEEITEMTYPE>
|-
| Item Code
| <CMTLBLDATA_FLDITMITEMNO>
|-
| Group
| <CMTLBLDATA_FLDITMITEMTYPEGROUP>
|-
| Name
| <CMTLBLDATA_FLDITMNAME>
|-
| Notes
| <CMTLBLDATA_FLDITMNOTES>
|-
| Price Source
| <CMTLBLDATA_FLDITMPRICESOURCE>
|-
| Product/Part Type
| <CMTLBLDATA_FLDITMPRODITEMTYPE>
|-
| Record Id
| <CMTLBLDATA_FLDITMRECID>
|-
| Cost
| <CMTLBLDATA_FLDITMSTANDARDCOST>
|-
| Suspend
| <CMTLBLDATA_FLDITMSUSPENDED>
|-
| Price
| <CMTLBLDATA_FLDITMUNITPRICE>
|-
| Update Date
| <CMTLBLDATA_FLDITMUPDATEDATE>
|-
| Update User
| <CMTLBLDATA_FLDITMUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDITMUSER1>
|}

===Parameters list for Opportunities===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Amount
| <CMTLBLDATA_FLDOPPAMOUNT>
|-
| Amount by Probability
| <CMTLBLDATA_FLDOPPCALCAMOUNT>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCARDID>
|-
| Closing amnt
| <CMTLBLDATA_FLDOPPCLOSEAMOUNT>
|-
| Close
| <CMTLBLDATA_FLDOPPCLOSEDATE>
|-
| Currency
| <CMTLBLDATA_FLDOPPCOINID>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCONTACTID>
|-
| Creation Date
| <CMTLBLDATA_FLDOPPCREATEDATE>
|-
| Created by User
| <CMTLBLDATA_FLDOPPCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDOPPDESCRIPTION>
|-
| Close By
| <CMTLBLDATA_FLDOPPESTDATE>
|-
| Oppty Type
| <CMTLBLDATA_FLDOPPKIND>
|-
| Opportunity
| <CMTLBLDATA_FLDOPPNAME>
|-
| Note
| <CMTLBLDATA_FLDOPPNOTES>
|-
| Open
| <CMTLBLDATA_FLDOPPOPENDATE>
|-
| Probability %
| <CMTLBLDATA_FLDOPPPROBABILITY>
|-
| Reason
| <CMTLBLDATA_FLDOPPREASON>
|-
| Record ID
| <CMTLBLDATA_FLDOPPRECID>
|-
| Record type
| <CMTLBLDATA_FLDOPPRECKIND>
|-
| Territory
| <CMTLBLDATA_FLDOPPREGION>
|-
| Source
| <CMTLBLDATA_FLDOPPSOURCE>
|-
| Stage
| <CMTLBLDATA_FLDOPPSTAGE>
|-
| Status
| <CMTLBLDATA_FLDOPPSTATUS>
|-
| Last Update Date
| <CMTLBLDATA_FLDOPPUPDATEDATE>
|-
| Last Update: By User
| <CMTLBLDATA_FLDOPPUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDOPPUSER1>
|-
| Field2
| <CMTLBLDATA_FLDOPPUSER2>
|-
| Field3
| <CMTLBLDATA_FLDOPPUSER3>
|-
| Opportunity ID
| <CMTLBLDATA_FLDOPPUSERID>
|-
| Manager
| <CMTLBLDATA_FLDOPPWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Asset ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTASSETRECID>
|-
| Contract ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTBCRECID>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCARDID>
|-
| Category
| <CMTLBLDATA_FLDTKTCATEGORY>
|-
| Cause
| <CMTLBLDATA_FLDTKTCAUSE>
|-
| Close Date
| <CMTLBLDATA_FLDTKTCLOSEDATETIME>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCONTACTID>
|-
| Creation: Date
| <CMTLBLDATA_FLDTKTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDTKTCREATEUSER_FLDWRKNICKNAME>
|-
| Due Date
| <CMTLBLDATA_FLDTKTDUEDATETIME>
|-
| Ticket Type
| <CMTLBLDATA_FLDTKTKIND>
|-
| Notes
| <CMTLBLDATA_FLDTKTNOTES>CMTLBLDATA
|-
| Open Date
| <CMTLBLDATA_FLDTKTOPENDATETIME>
|-
| Priority
| <CMTLBLDATA_FLDTKTPRIORITY>
|-
| Description
| <CMTLBLDATA_FLDTKTPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDTKTRECID>
|-
| Account's Region Code
| <CMTLBLDATA_FLDTKTREGIONCODE>
|-
| Estimated Duration Needed
| <CMTLBLDATA_FLDTKTSCHEDLENESTIM>
|-
| Resolution Description
| <CMTLBLDATA_FLDTKTSOLUTION>
|-
| Source
| <CMTLBLDATA_FLDTKTSOURCE>
|-
| Status
| <CMTLBLDATA_FLDTKTSTATUS>
|-
| Status: Ext.
| <CMTLBLDATA_FLDTKTSTATUSNOTE>
|-
| Ticket Number
| <CMTLBLDATA_FLDTKTTICKETNO>
|-
| Last Update Date
| <CMTLBLDATA_FLDTKTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDTKTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDTKTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDTKTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDTKTUSER3>
|-
| Manager
| <CMTLBLDATA_FLDTKTWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Category
| <CMTLBLDATA_FLDKBACATEGORY>
|-
| Create Date
| <CMTLBLDATA_FLDKBACREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDKBACREATEUSER_FLDWRKNICKNAME>
|-
| Public
| <CMTLBLDATA_FLDKBAISPUBLIC>
|-
| Problem
| <CMTLBLDATA_FLDKBAPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDKBARECID>
|-
| Solution
| <CMTLBLDATA_FLDKBASOLUTION>
|-
| Status
| <CMTLBLDATA_FLDKBASTATUS>
|-
| Title
| <CMTLBLDATA_FLDKBATITLE>
|-
| Last Update date
| <CMTLBLDATA_FLDKBAUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDKBAUPDATEUSER_FLDWRKNICKNAME>
|}

===Lookup Fields===
*Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket. This way you can define an Online Service for the Account, which will be activated from the Ticket window. Lookup Field syntax: <CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1> Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account FLDCRDADDRESS1 is the account's Address field

==See Also==
*[[Online Services FAQ]]

[[Category:Integration]]

Online Services

2009-08-20T14:49:09Z

Yarden: /* Displaying Online Work Orders Status */

{{integration}}

Commit's '''Online Services''' is a powerful feature which allows you to link to web sites (URL) and activate the web application using parameters taken from CommitCRM.

You can define as many online Services as you wish. This feature is available for the following entities: Accounts, Tickets, Assets, Items, Contracts, Knowledge Base Articles and Oppotrunities.
*Accounts window
*Tickets window
*Dispatcher window
*Asset window
*Items window
*Contracts window
*Opportunities window

==What can I use Online Services for?==
Wouldn't you like your technicians to be able to find an address for a scheduled visit with just a single click? You can do this by defining an Online Service which will open maps site (e.g. Google Maps, Yahoo! Maps etc.) and the map will open automatically on the address of the Account or Contact stored in CommitCRM.

This powerful tool allows you to define any URL and open it with parameters. You can basically do with it whatever you want.

==Adding new Online Services==
To define a new Online Service, Open the Online Services Management window from Settings > Online Services. or click the Online Services icon from the Accounts window toolbar. Click the New button to add a new Online Service and enter the following parameters:

*'''Name''' - The name of the service which will be displayed in the Online Services list and menus throughout the system, for example, "Google Maps".
*'''Base URL''' - The URL you wish to open in order to use the Service. This is the address of the main service (before passing any parameters to it), for example http://maps.google.com/maps.
*'''URL Parameters''' - Parameters which will be appended to the URL in order to create specific queries when opening the URL. These parameters can be CommitCRM Account database fields which will be taken and filled from CommitCRM when clicking the Online Service.

See the Tips and Tricks for examples of useful Online Services

==Activating Online Services==
Online Services can be activated from various places in CommitCRM including:
*The '''Account, Ticket, Asset, Item, Opportunity, Contract, Knowledge Base Article windows''' - click the Online Services icon to activate the service for the selected account
*The '''Dispatcher Windows''' - right-click on a selected Ticket to run any Online Service for the Ticket's Account or Contact (such as displaying a map).
*The '''Calendar / Scheduled Appointments''' views - right-click above an Appointment and select Online Services.
*The '''secondary Contacts tab''' - select a Contact, right-click and select Online Services
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.
*'''Secondary Contact selection''' field - right-click and select Online Services.
*The '''Relations tab under Account''' - right-click and select Online Services.

==Possible Usage==
*'''Online Services and Assets''' – Access your MSP product online and pass the Asset ID to display its details from your external system
*'''Online Services and Items''' – Search for better prices for items by passing specific item information directly from within CommitCRM.
*'''Online Services for Assets''' – Search for a specific product review by its hardware serial number.
*'''Online Services for Tickets''' – Search in online knowledge bases for solutions based on the ticket description
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.

==Using Lookup Fields==
Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket.

This way you can define an Online Service for the Ticket, which will be activated from the Ticket window and will be using Account information.

Lookup Field syntax:

<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>

Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account
FLDCRDADDRESS1 is the account's Address field

==Tips & Tricks==
Following are examples of possible Online Services configurations.
These examples are intended to explain the use of Online Services only.

Disclaimer - Before defining your Online Services you should read the terms of use for each web site you want to access. The examples below are displayed to explain how to use online services and how to pass parameters.

===Displaying Online Maps===
'''Google Maps''' - Opens Google Maps and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Maps
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDCRDADDRESS1>+<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDSTATE>+<CMTLBLDATA_FLDCRDZIP>
|}

'''MapQuest''' - Opens MapQuest Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| MapQuest
|-
| Base URL
| <nowiki>http://www.mapquest.com/maps</nowiki>
|-
| URL Parameters
| /map.adp?searchtype=address&country=<CMTLBLDATA_FLDCRDCOUNTRY>&addtohistory=&searchtab=home&formtype=address&popflag=0&latitude=&longitude=&name=&phone=&level=&cat=&address=&city=<CMTLBLDATA_FLDCRDCITY>&state=<CMTLBLDATA_FLDCRDSTATE>&zipcode=<CMTLBLDATA_FLDCRDZIP>
|}

'''Yahoo! Maps''' - Opens Yahoo! Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Yahoo! Maps
|-
| Base URL
| <nowiki>http://maps.yahoo.com</nowiki>
|-
| URL Parameters
| /maps_result?addr=<CMTLBLDATA_FLDCRDADDRESS1>&csz=<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDCOUNTRY>&country=<CMTLBLDATA_FLDCRDSTATE>
|}

===Finding Account Information===
'''Google Company''' - Opens Google and searches for the Account Company Name.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Company
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCOMPANY>
|}

'''Google Contact''' - Opens Google and searches for the Contact Name.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Contact
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCONTACT>
|}

===Finding Ticket Description in Google===
'''Google Ticket''' - Opens Google and searches for the Ticket description.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket Description
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDTKTPROBLEM>
|}

===Finding Account Address From Ticket (using [[Commit Online Services#Using Lookup Fields|Lookup Field]]) ===
'''Google Address From Ticket''' - Opens Google and searches for the Address of the Account which is linked to the Ticket.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDCITY>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDSTATE>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDZIP>
|}

===Displaying Products Warranties Online===
'''HP Warranty Lookup''' - Displays HP products warranty expiration dates, using the products number and the products serial number.

Note: Product Number goes into Plate# field (<CMTLBLDATA_FLDASTUSER1>).

'''Contributed by Easy I.T'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| HP Warranty Lookup
|-
| Base URL
| <nowiki>http://h20000.www2.hp.com/bizsupport/TechSupport/WarrantyResults.jsp?</nowiki>
|-
| URL Parameters
| lang=en&cc=us&prodSeriesId=454811&prodTypeId=12454&sn=<CMTLBLDATA_FLDASTSERIALNO>&pn=<CMTLBLDATA_FLDASTUSER1>&country=US&nickname=&find=Display+Warranty+Information+%C2%BB
|}

'''DELL Service Contracts and Warranties''' - Displays Dell products warranty expiration dates, using the service tag number.

Note: Customize a Field for Service Tag or use existing field. In this sample we will use Field3 as custumized Service Tag Field

'''Contributed by JoshuaB'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| Dell Warranty Check
|-
| Base URL
| <nowiki>http://support.dell.com/support/topics/global.aspx/support/my_systems_info/details</nowiki>
|-
| URL Parameters
| ?c=us&l=en&s=gen&servicetag=<CMTLBLDATA_FLDASTUSER3>
|}

===Displaying Domain WHOIS===

'''Domain Tools Domain WHOIS''' - WHOIS domain registration information by .

Note: Domain must be stripped from URL (without http://).

'''Contributed by DavidW'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (NetworkSolutions)
|-
| Base URL
| <nowiki>http://www.networksolutions.com/whois-search/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''Network Solutions Domain WHOIS''' - WHOIS domain registration information by Network Solutions.

Note: Domain must be stripped from URL (without http://).

'''Contributed by ajgyomber'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DomainTools)
|-
| Base URL
| <nowiki>http://whois.domaintools.com/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''DNSstuff Domain WHOIS''' - WHOIS domain registration information by DNSstuff.

Note: Domain must be stripped from URL (without http://).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DNSstuff)
|-
| Base URL
| <nowiki>http://www.dnsstuff.com/dnslite/?r=u2r&domain=</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

===Displaying Online Work Orders Status===
'''Work Orders Status Check''' - Track your orders statuses in <nowiki>onforce.com</nowiki>

Note: Set Field1 to order number or change the parameter (<CMTLBLDATA_FLDTKTUSER1>) to a different field.

'''Contributed by secion8'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Tickets
|-
| Name
| Work Orders Status (onforce.com)
|-
| Base URL
| <nowiki>http://www.onforce.com/?action=pcc_work_order_view&id=</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDTKTUSER1>
|}

===N-central===

'''Contributed by ajgyomber'''

Note: You'll need to replace "server.n-able.com", "email@domain.com" and "your_actual_password" with your actual information.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| N-central Dashboard
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=defaultDashboard&username=email@domain.com&password=your_actual_password
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Device Details
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceDetails&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Device Services
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceService&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| N-central Launch Remote Control
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=deviceRC&username=email@domain.com&password=your_actual_password&customerID=<CMTLBLDATA_FLDASTACCRECID_FLDCRDCARDID3>&deviceID=<CMTLBLDATA_FLDASTUSER1>
|}

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| N-central NOC View
|-
| Base URL
| <nowiki>https://server.n-able.com/deepLinkAction.do</nowiki>
|-
| URL Parameters
| ?method=nocView&username=email@domain.com&password =your_actual_password
|}

==Parameters list==

===Parameters List for Accounts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account Number
| <CMTLBLDATA_FLDCRDCARDID2>
|-
| Address: City
| <CMTLBLDATA_FLDCRDCITY>
|-
| Address: Country
| <CMTLBLDATA_FLDCRDCOUNTRY>
|-
| Address: Line1
| <CMTLBLDATA_FLDCRDADDRESS1>
|-
| Address: Line2
| <CMTLBLDATA_FLDCRDADDRESS2>
|-
| Address: Line3
| <CMTLBLDATA_FLDCRDADDRESS3>
|-
| Address: State
| <CMTLBLDATA_FLDCRDSTATE>
|-
| Address: ZIP Code
| <CMTLBLDATA_FLDCRDZIP>
|-
| Assistant
| <CMTLBLDATA_FLDCRDASSISTANT>
|-
| Birthday
| <CMTLBLDATA_FLDCRDBIRTHDAY>
|-
| Company name
| <CMTLBLDATA_FLDCRDCOMPANY>
|-
| Contact: First & Last Name
| <CMTLBLDATA_FLDCRDCONTACT>
|-
| Dear
| <CMTLBLDATA_FLDCRDDEAR>
|-
| Department
| <CMTLBLDATA_FLDCRDDEPARTMENT>
|-
| E-Mail Address 1
| <CMTLBLDATA_FLDCRDEMAIL1>
|-
| E-Mail Address 2
| <CMTLBLDATA_FLDCRDEMAIL2>
|-
| Fax Number
| <CMTLBLDATA_FLDCRDFAX1>
|-
| Fax Number Extention
| <CMTLBLDATA_FLDCRDFAXDESC1>
|-
| Field
| <CMTLBLDATA_FLDCRDPERSONID>
|-
| Field1
| <CMTLBLDATA_FLDCRDUSER2>
|-
| Field2
| <CMTLBLDATA_FLDCRDUSER3>
|-
| Field3
| <CMTLBLDATA_FLDCRDUSER4>
|-
| Field4
| <CMTLBLDATA_FLDCRDUSER5>
|-
| Field5
| <CMTLBLDATA_FLDCRDCOMPANYNO>
|-
| File as
| <CMTLBLDATA_FLDCRDFULLNAME>
|-
| ID
| <CMTLBLDATA_FLDCRDCARDID3>
|-
| Last Name
| <CMTLBLDATA_FLDCRDLASTNAME>
|-
| Phone 1
| <CMTLBLDATA_FLDCRDPHONE1>
|-
| Phone 1 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC1>
|-
| Phone 2
| <CMTLBLDATA_FLDCRDPHONE2>
|-
| Phone 2 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC2>
|-
| Phone 3
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Phone 3 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC3>
|-
| Phone 4
| <CMTLBLDATA_FLDCRDPHONE4>
|-
| Phone 4 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC4>
|-
| Popup Message
| <CMTLBLDATA_FLDCRDCARDMESSAGE>
|-
| Region
| <CMTLBLDATA_FLDCRDREGIONCODE>
|-
| Salutation
| <CMTLBLDATA_FLDCRDSUFFIX>
|-
| Status
| <CMTLBLDATA_FLDCRDUSER1>
|-
| Sub-Contact Code
| <CMTLBLDATA_FLDCRDSUBCODE>
|-
| Title
| <CMTLBLDATA_FLDCRDTITLE>
|-
| Type
| <CMTLBLDATA_FLDCRDKIND>
|-
| Web Address 1
| <CMTLBLDATA_FLDCRDURL1>
|-
| Web Address 2
| <CMTLBLDATA_FLDCRDURL2>
|}

===Parameters list for Assets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTACCRECID>
|-
| Asset Code
| <CMTLBLDATA_FLDASTASSETCODE>
|-
| Asset Type
| <CMTLBLDATA_FLDASTASSETTYPE>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTCONTACTRECID>
|-
| Create Date
| <CMTLBLDATA_FLDASTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDASTCREATEUSER_FLDWRKNICKNAME>
|-
| Purchase Date
| <CMTLBLDATA_FLDASTCUSTPURDATE>
|-
| Purchased From Us
| <CMTLBLDATA_FLDASTCUSTPURFROMUS>
|-
| Purchase Our Invoice #
| <CMTLBLDATA_FLDASTCUSTPUROURINV>
|-
| Customer PO
| <CMTLBLDATA_FLDASTCUSTPURPO>
|-
| Purchase Price
| <CMTLBLDATA_FLDASTCUSTPURPRICE>
|-
| Delivered Date
| <CMTLBLDATA_FLDASTDELIVEDATE>
|-
| Description
| <CMTLBLDATA_FLDASTDESC>
|-
| Installed By
| <CMTLBLDATA_FLDASTINSTALBY_FLDWRKNICKNAME>
|-
| Installed Date
| <CMTLBLDATA_FLDASTINSTALDATE>
|-
| License Codes
| <CMTLBLDATA_FLDASTLICENSECODE>
|-
| License Keys
| <CMTLBLDATA_FLDASTLICENSEKEYS>
|-
| License Notes
| <CMTLBLDATA_FLDASTLICENSENOTES>
|-
| Location
| <CMTLBLDATA_FLDASTLOCATION>
|-
| Manufacturer
| <CMTLBLDATA_FLDASTMANUFACTURER>
|-
| Manufacturer Serial No.
| <CMTLBLDATA_FLDASTMNFSERIALNO>
|-
| Model
| <CMTLBLDATA_FLDASTMODEL>
|-
| Asset Name
| <CMTLBLDATA_FLDASTNAME>
|-
| Notes
| <CMTLBLDATA_FLDASTNOTES>
|-
| PARENTASSETRECID
| <CMTLBLDATA_FLDASTPARENTRECID>
|-
| Quantity
| <CMTLBLDATA_FLDASTQUANTITY>
|-
| Record ID
| <CMTLBLDATA_FLDASTRECID>
|-
| Serial No.
| <CMTLBLDATA_FLDASTSERIALNO>
|-
| Status
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Last Update date
| <CMTLBLDATA_FLDASTUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDASTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDASTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDASTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDASTUSER3>
|-
| Field4
| <CMTLBLDATA_FLDASTUSER4>
|-
| Field5
| <CMTLBLDATA_FLDASTUSER5>
|-
| Date1
| <CMTLBLDATA_FLDASTUSERDATE1>
|-
| Number1
| <CMTLBLDATA_FLDASTUSERNUMBER1>
|-
| Vendor Purchased Date
| <CMTLBLDATA_FLDASTVENDORDATEPURC>
|-
| Vendor Invoice #
| <CMTLBLDATA_FLDASTVENDORINVNO>
|-
| Vendor Name
| <CMTLBLDATA_FLDASTVENDORNAME>
|-
| Vendor PO
| <CMTLBLDATA_FLDASTVENDOROURPO>
|-
| Vendor Price
| <CMTLBLDATA_FLDASTVENDORPRICE>
|-
| Vendor
| <CMTLBLDATA_FLDASTVENDORRECID>
|-
| Vendor Serial No.
| <CMTLBLDATA_FLDASTVENDORSERNO>
|-
| Vendor Warranty Exp. Date
| <CMTLBLDATA_FLDASTVENDORWARREXP>
|-
| Version
| <CMTLBLDATA_FLDASTVERSION>
|-
| Warranty/License Exp. Date
| <CMTLBLDATA_FLDASTWARREXPDATE>FLDASTWARREXPDATE
|}

===Parameters list for Contracts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTACCRECID>
|-
| Block - Used
| <CMTLBLDATA_FLDBCTAMOUNTUSED>
|-
| Code
| <CMTLBLDATA_FLDBCTCODE>
|-
| Contract Type Type
| <CMTLBLDATA_FLDBCTCONTRACTTYPE>
|-
| Create Date
| <CMTLBLDATA_FLDBCTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDBCTCREATEUSER_FLDWRKNICKNAME>
|-
| Default Item Expense ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMEXPNS>
|-
| Default Item Labor ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMLABOR>
|-
| Default Item Part ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMPART>
|-
| Description
| <CMTLBLDATA_FLDBCTDESCEXTERNAL>
|-
| Internal Description
| <CMTLBLDATA_FLDBCTDESCINTERNAL>
|-
| End Date
| <CMTLBLDATA_FLDBCTENDDATE>
|-
| Name
| <CMTLBLDATA_FLDBCTNAME>
|-
| Note
| <CMTLBLDATA_FLDBCTNOTE>
|-
| Record ID
| <CMTLBLDATA_FLDBCTRECID>
|-
| Start Date
| <CMTLBLDATA_FLDBCTSTARTDATE>
|-
| Status
| <CMTLBLDATA_FLDBCTSTATUS>
|-
| Last Update date
| <CMTLBLDATA_FLDBCTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDBCTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field 1
| <CMTLBLDATA_FLDBCTUSER1>
|-
| Field 2
| <CMTLBLDATA_FLDBCTUSER2>
|-
| Field 3
| <CMTLBLDATA_FLDBCTUSER3>
|}

===Parameters list for Items===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Currency
| <CMTLBLDATA_FLDITMCOINID>
|-
| Created by User
| <CMTLBLDATA_FLDITMCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDITMDESC>
|-
| Expense Type
| <CMTLBLDATA_FLDITMEXPITEMTYPE>
|-
| Labor Type
| <CMTLBLDATA_FLDITMFEEITEMTYPE>
|-
| Item Code
| <CMTLBLDATA_FLDITMITEMNO>
|-
| Group
| <CMTLBLDATA_FLDITMITEMTYPEGROUP>
|-
| Name
| <CMTLBLDATA_FLDITMNAME>
|-
| Notes
| <CMTLBLDATA_FLDITMNOTES>
|-
| Price Source
| <CMTLBLDATA_FLDITMPRICESOURCE>
|-
| Product/Part Type
| <CMTLBLDATA_FLDITMPRODITEMTYPE>
|-
| Record Id
| <CMTLBLDATA_FLDITMRECID>
|-
| Cost
| <CMTLBLDATA_FLDITMSTANDARDCOST>
|-
| Suspend
| <CMTLBLDATA_FLDITMSUSPENDED>
|-
| Price
| <CMTLBLDATA_FLDITMUNITPRICE>
|-
| Update Date
| <CMTLBLDATA_FLDITMUPDATEDATE>
|-
| Update User
| <CMTLBLDATA_FLDITMUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDITMUSER1>
|}

===Parameters list for Opportunities===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Amount
| <CMTLBLDATA_FLDOPPAMOUNT>
|-
| Amount by Probability
| <CMTLBLDATA_FLDOPPCALCAMOUNT>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCARDID>
|-
| Closing amnt
| <CMTLBLDATA_FLDOPPCLOSEAMOUNT>
|-
| Close
| <CMTLBLDATA_FLDOPPCLOSEDATE>
|-
| Currency
| <CMTLBLDATA_FLDOPPCOINID>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCONTACTID>
|-
| Creation Date
| <CMTLBLDATA_FLDOPPCREATEDATE>
|-
| Created by User
| <CMTLBLDATA_FLDOPPCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDOPPDESCRIPTION>
|-
| Close By
| <CMTLBLDATA_FLDOPPESTDATE>
|-
| Oppty Type
| <CMTLBLDATA_FLDOPPKIND>
|-
| Opportunity
| <CMTLBLDATA_FLDOPPNAME>
|-
| Note
| <CMTLBLDATA_FLDOPPNOTES>
|-
| Open
| <CMTLBLDATA_FLDOPPOPENDATE>
|-
| Probability %
| <CMTLBLDATA_FLDOPPPROBABILITY>
|-
| Reason
| <CMTLBLDATA_FLDOPPREASON>
|-
| Record ID
| <CMTLBLDATA_FLDOPPRECID>
|-
| Record type
| <CMTLBLDATA_FLDOPPRECKIND>
|-
| Territory
| <CMTLBLDATA_FLDOPPREGION>
|-
| Source
| <CMTLBLDATA_FLDOPPSOURCE>
|-
| Stage
| <CMTLBLDATA_FLDOPPSTAGE>
|-
| Status
| <CMTLBLDATA_FLDOPPSTATUS>
|-
| Last Update Date
| <CMTLBLDATA_FLDOPPUPDATEDATE>
|-
| Last Update: By User
| <CMTLBLDATA_FLDOPPUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDOPPUSER1>
|-
| Field2
| <CMTLBLDATA_FLDOPPUSER2>
|-
| Field3
| <CMTLBLDATA_FLDOPPUSER3>
|-
| Opportunity ID
| <CMTLBLDATA_FLDOPPUSERID>
|-
| Manager
| <CMTLBLDATA_FLDOPPWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Asset ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTASSETRECID>
|-
| Contract ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTBCRECID>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCARDID>
|-
| Category
| <CMTLBLDATA_FLDTKTCATEGORY>
|-
| Cause
| <CMTLBLDATA_FLDTKTCAUSE>
|-
| Close Date
| <CMTLBLDATA_FLDTKTCLOSEDATETIME>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCONTACTID>
|-
| Creation: Date
| <CMTLBLDATA_FLDTKTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDTKTCREATEUSER_FLDWRKNICKNAME>
|-
| Due Date
| <CMTLBLDATA_FLDTKTDUEDATETIME>
|-
| Ticket Type
| <CMTLBLDATA_FLDTKTKIND>
|-
| Notes
| <CMTLBLDATA_FLDTKTNOTES>CMTLBLDATA
|-
| Open Date
| <CMTLBLDATA_FLDTKTOPENDATETIME>
|-
| Priority
| <CMTLBLDATA_FLDTKTPRIORITY>
|-
| Description
| <CMTLBLDATA_FLDTKTPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDTKTRECID>
|-
| Account's Region Code
| <CMTLBLDATA_FLDTKTREGIONCODE>
|-
| Estimated Duration Needed
| <CMTLBLDATA_FLDTKTSCHEDLENESTIM>
|-
| Resolution Description
| <CMTLBLDATA_FLDTKTSOLUTION>
|-
| Source
| <CMTLBLDATA_FLDTKTSOURCE>
|-
| Status
| <CMTLBLDATA_FLDTKTSTATUS>
|-
| Status: Ext.
| <CMTLBLDATA_FLDTKTSTATUSNOTE>
|-
| Ticket Number
| <CMTLBLDATA_FLDTKTTICKETNO>
|-
| Last Update Date
| <CMTLBLDATA_FLDTKTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDTKTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDTKTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDTKTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDTKTUSER3>
|-
| Manager
| <CMTLBLDATA_FLDTKTWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Category
| <CMTLBLDATA_FLDKBACATEGORY>
|-
| Create Date
| <CMTLBLDATA_FLDKBACREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDKBACREATEUSER_FLDWRKNICKNAME>
|-
| Public
| <CMTLBLDATA_FLDKBAISPUBLIC>
|-
| Problem
| <CMTLBLDATA_FLDKBAPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDKBARECID>
|-
| Solution
| <CMTLBLDATA_FLDKBASOLUTION>
|-
| Status
| <CMTLBLDATA_FLDKBASTATUS>
|-
| Title
| <CMTLBLDATA_FLDKBATITLE>
|-
| Last Update date
| <CMTLBLDATA_FLDKBAUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDKBAUPDATEUSER_FLDWRKNICKNAME>
|}

===Lookup Fields===
*Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket. This way you can define an Online Service for the Account, which will be activated from the Ticket window. Lookup Field syntax: <CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1> Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account FLDCRDADDRESS1 is the account's Address field

==See Also==
*[[Online Services FAQ]]

[[Category:Integration]]

Main Page

2009-08-20T14:30:33Z

Yarden:

{| 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:162%; border:none; margin:0; padding:.1em; color:#000;">Welcome to the Commit Wiki</div>
<div style="top:+0.2em; font-size:95%;">Commit 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 Commit?]
* [http://www.commitcrm.com/aboutus.htm About Commit]
|}


{{Col}}
=Documentation=
*[[#Getting Started|Getting Started]]
*[[#Setup|Setup]]
*[[#Videos|Videos]]
*[[#Work Flows|Work Flows]]
*[[#User Manuals|User Manuals]]
*[[#Office Management|Office Management]]
*[[#Service Management|Service Management]]
*[[#Billing|Billing]]
*[[#Import and Export|Import and Export]]
*[[#Customization|Customization]]
*[[#Privileges|Privileges]]
*[[#Integration|Integration]]
*[[#FAQ|FAQ]]

{{Break}}
=Forum Threads=
*[http://www.commitcrm.com/forum/showthread.php?t=1153 New! Installation Video Tutorials]
*[http://www.commitcrm.com/forum/showthread.php?t=1137 New! CommitCRM 5.1 is Now Available ]
*[http://www.commitcrm.com/forum/showthread.php?t=1025 New! Follow us on Twitter – twitter.com/CommitCRM]
*[http://www.commitcrm.com/forum/showthread.php?t=1037 The IT Toolbox – Community Based Resources for IT Professionals]

=Headline=

{{Colend}}


== [[Getting Started]] ==

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

==[[Setup]]==
*[[Import and Export]]
*[[Web Interface|Commit Web Interface Installation]]
*[[Email Connector|Commit Email Connector Installation]]
*[[Alerts Server|Commit Alerts Server Installation]]
*[[QuickBooks Link|Commit-QuickBooks Link]]
*[[Commit-Outlook Sync]]
*[[Videos#Installation Guides|Installation 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/web_interface_installation_video.htm Email Connector Installation]
*[http://www.commitcrm.com/videos/web_interface_installation_video.htm Alerts Server Installation]
*[[Videos|Watch more videos!]]

==[[Work Flows]]==
*[[Tickets|Ticket Lifecycle]]
*[[Billing Lifecycle]]
*[[Project Management]]
*[[Recurring Contracts]]
*[[Over-used Hours]]
*[[Asset Warranties]]
*[[Preventive Maintenance]]
*[[Return Material Authorization (RMA)]]
*[[Barcodes and Assets]]
*[[Sales|Sales Management]]
*[[Managing Quotes]]

== [[User Manuals]] ==
*[[Billing]]
*[[Assets]]
*[[Sales]]
*[[Knowledge Base]]
*[[Activity Templates]]
*[[Email Templates]]
*[[Documents]]
*[[QuickBooks Link|Commit-QuickBooks Link]]
*[[Commit-Outlook Sync]]
*[[Web Interface|Commit Web Interface]]
*[[Email Connector|Commit Email Connector]]
*[[Alerts Server|Commit Alerts Server]]

==[[Office Management]]==
*[[Accounts]]
*[[Documents]]
*[[Documents#Using Word Merge Templates|Word Templates]]
*[[Email Templates]]
*[[Documents#Managing Outlook Emails within CommitCRM|Filing Emails]]
*[[History]]
*[[Commit-Outlook Sync]]

==[[Service Management]]==
*[[Tickets]]
*[[Tickets#Dispatch the Ticket|Dispatcher]]
*[[Assets]]
*[[Activity Templates]]
*[[Email Templates]]
*[[Knowledge Base]]
*[[Billing]]

==[[Billing]]==
*[[Billing]]
*[[Items]]
*[[Charges]]
*[[Contracts]]
*[[Custom Pricing]]
*[[Contract-Price Charges]]
*[[Recurring Contracts]]
*[[Charges#Charging Using Taxes|Taxes]]
*[[QuickBooks Link|Commit-QuickBooks Link]]
*[[Charges#Using CommitCRM Charge Reports|Charge Reports]]

==[[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|Sync with Outlook]]

==[[Customization]]==
*[[Field Customization]]
*[[Report Customization]]

==[[Privileges]]==
*[[Employees#Employee Privileges Group|Employee Privileges]]
*[[Customer Privileges]]

==[[Integration]]==
*[[QuickBooks Link|Commit-QuickBooks Link]]
*[[Commit-Outlook Sync]]
*[[Commit Online Services]]
*[[Commit API Developers Guide]]
*[[Documents#Importing Existing Documents|Import and Export (Excel, CSV, etc.)]]
*[[Documents#Using Word Merge Templates|Word Templates]]

== [[FAQ]] ==
*[[Tickets FAQ|Tickets]]
*[[Contracts FAQ|Contracts]]
*[[Dispatcher & Calendar FAQ|Dispatcher & Calendar]]
*[[Charges FAQ|Charges]]
*[[Items FAQ|Items]]
*[[Reports FAQ|Reports]]
*[[Import & 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 & 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__
__NOEDITSECTION__

Online Services

2009-08-20T14:19:35Z

Yarden: /* Displaying Domain WHOIS */

{{integration}}

Commit's '''Online Services''' is a powerful feature which allows you to link to web sites (URL) and activate the web application using parameters taken from CommitCRM.

You can define as many online Services as you wish. This feature is available for the following entities: Accounts, Tickets, Assets, Items, Contracts, Knowledge Base Articles and Oppotrunities.
*Accounts window
*Tickets window
*Dispatcher window
*Asset window
*Items window
*Contracts window
*Opportunities window

==What can I use Online Services for?==
Wouldn't you like your technicians to be able to find an address for a scheduled visit with just a single click? You can do this by defining an Online Service which will open maps site (e.g. Google Maps, Yahoo! Maps etc.) and the map will open automatically on the address of the Account or Contact stored in CommitCRM.

This powerful tool allows you to define any URL and open it with parameters. You can basically do with it whatever you want.

==Adding new Online Services==
To define a new Online Service, Open the Online Services Management window from Settings > Online Services. or click the Online Services icon from the Accounts window toolbar. Click the New button to add a new Online Service and enter the following parameters:

*'''Name''' - The name of the service which will be displayed in the Online Services list and menus throughout the system, for example, "Google Maps".
*'''Base URL''' - The URL you wish to open in order to use the Service. This is the address of the main service (before passing any parameters to it), for example http://maps.google.com/maps.
*'''URL Parameters''' - Parameters which will be appended to the URL in order to create specific queries when opening the URL. These parameters can be CommitCRM Account database fields which will be taken and filled from CommitCRM when clicking the Online Service.

See the Tips and Tricks for examples of useful Online Services

==Activating Online Services==
Online Services can be activated from various places in CommitCRM including:
*The '''Account, Ticket, Asset, Item, Opportunity, Contract, Knowledge Base Article windows''' - click the Online Services icon to activate the service for the selected account
*The '''Dispatcher Windows''' - right-click on a selected Ticket to run any Online Service for the Ticket's Account or Contact (such as displaying a map).
*The '''Calendar / Scheduled Appointments''' views - right-click above an Appointment and select Online Services.
*The '''secondary Contacts tab''' - select a Contact, right-click and select Online Services
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.
*'''Secondary Contact selection''' field - right-click and select Online Services.
*The '''Relations tab under Account''' - right-click and select Online Services.

==Possible Usage==
*'''Online Services and Assets''' – Access your MSP product online and pass the Asset ID to display its details from your external system
*'''Online Services and Items''' – Search for better prices for items by passing specific item information directly from within CommitCRM.
*'''Online Services for Assets''' – Search for a specific product review by its hardware serial number.
*'''Online Services for Tickets''' – Search in online knowledge bases for solutions based on the ticket description
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.

==Using Lookup Fields==
Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket.

This way you can define an Online Service for the Ticket, which will be activated from the Ticket window and will be using Account information.

Lookup Field syntax:

<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>

Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account
FLDCRDADDRESS1 is the account's Address field

==Tips & Tricks==
Following are examples of possible Online Services configurations.
These examples are intended to explain the use of Online Services only.

Disclaimer - Before defining your Online Services you should read the terms of use for each web site you want to access. The examples below are displayed to explain how to use online services and how to pass parameters.

===Displaying Online Maps===
'''Google Maps''' - Opens Google Maps and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Maps
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDCRDADDRESS1>+<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDSTATE>+<CMTLBLDATA_FLDCRDZIP>
|}

'''MapQuest''' - Opens MapQuest Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| MapQuest
|-
| Base URL
| <nowiki>http://www.mapquest.com/maps</nowiki>
|-
| URL Parameters
| /map.adp?searchtype=address&country=<CMTLBLDATA_FLDCRDCOUNTRY>&addtohistory=&searchtab=home&formtype=address&popflag=0&latitude=&longitude=&name=&phone=&level=&cat=&address=&city=<CMTLBLDATA_FLDCRDCITY>&state=<CMTLBLDATA_FLDCRDSTATE>&zipcode=<CMTLBLDATA_FLDCRDZIP>
|}

'''Yahoo! Maps''' - Opens Yahoo! Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Yahoo! Maps
|-
| Base URL
| <nowiki>http://maps.yahoo.com</nowiki>
|-
| URL Parameters
| /maps_result?addr=<CMTLBLDATA_FLDCRDADDRESS1>&csz=<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDCOUNTRY>&country=<CMTLBLDATA_FLDCRDSTATE>
|}

===Finding Account Information===
'''Google Company''' - Opens Google and searches for the Account Company Name.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Company
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCOMPANY>
|}

'''Google Contact''' - Opens Google and searches for the Contact Name.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Contact
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCONTACT>
|}

===Finding Ticket Description in Google===
'''Google Ticket''' - Opens Google and searches for the Ticket description.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket Description
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDTKTPROBLEM>
|}

===Finding Account Address From Ticket (using [[Commit Online Services#Using Lookup Fields|Lookup Field]]) ===
'''Google Address From Ticket''' - Opens Google and searches for the Address of the Account which is linked to the Ticket.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDCITY>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDSTATE>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDZIP>
|}

===Displaying Products Warranties Online===
'''HP Warranty Lookup''' - Displays HP products warranty expiration dates, using the products number and the products serial number.

Note: Product Number goes into Plate# field (<CMTLBLDATA_FLDASTUSER1>).

'''Contributed by Easy I.T'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| HP Warranty Lookup
|-
| Base URL
| <nowiki>http://h20000.www2.hp.com/bizsupport/TechSupport/WarrantyResults.jsp?</nowiki>
|-
| URL Parameters
| lang=en&cc=us&prodSeriesId=454811&prodTypeId=12454&sn=<CMTLBLDATA_FLDASTSERIALNO>&pn=<CMTLBLDATA_FLDASTUSER1>&country=US&nickname=&find=Display+Warranty+Information+%C2%BB
|}

'''DELL Service Contracts and Warranties''' - Displays Dell products warranty expiration dates, using the service tag number.

Note: Customize a Field for Service Tag or use existing field. In this sample we will use Field3 as custumized Service Tag Field

'''Contributed by JoshuaB'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| Dell Warranty Check
|-
| Base URL
| <nowiki>http://support.dell.com/support/topics/global.aspx/support/my_systems_info/details</nowiki>
|-
| URL Parameters
| ?c=us&l=en&s=gen&servicetag=<CMTLBLDATA_FLDASTUSER3>
|}

===Displaying Domain WHOIS===

'''Domain Tools Domain WHOIS''' - WHOIS domain registration information by .

Note: Domain must be stripped from URL (without http://).

'''Contributed by DavidW'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (NetworkSolutions)
|-
| Base URL
| <nowiki>http://www.networksolutions.com/whois-search/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''Network Solutions Domain WHOIS''' - WHOIS domain registration information by Network Solutions.

Note: Domain must be stripped from URL (without http://).

'''Contributed by ajgyomber'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DomainTools)
|-
| Base URL
| <nowiki>http://whois.domaintools.com/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''DNSstuff Domain WHOIS''' - WHOIS domain registration information by DNSstuff.

Note: Domain must be stripped from URL (without http://).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DNSstuff)
|-
| Base URL
| <nowiki>http://www.dnsstuff.com/dnslite/?r=u2r&domain=</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

===Displaying Online Work Orders Status===
'''Work Orders Status Check''' - Track your orders statuses in <nowiki>onforce.com</nowiki>

Note: Set Field1 to order number or change the parameter (<CMTLBLDATA_FLDTKTUSER1>) to a different field.

'''Contributed by secion8'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Tickets
|-
| Name
| Work Orders Status (onforce.com
|-
| Base URL
| <nowiki>http://www.onforce.com/?action=pcc_work_order_view&id=</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDTKTUSER1>
|}

==Parameters list==

===Parameters List for Accounts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account Number
| <CMTLBLDATA_FLDCRDCARDID2>
|-
| Address: City
| <CMTLBLDATA_FLDCRDCITY>
|-
| Address: Country
| <CMTLBLDATA_FLDCRDCOUNTRY>
|-
| Address: Line1
| <CMTLBLDATA_FLDCRDADDRESS1>
|-
| Address: Line2
| <CMTLBLDATA_FLDCRDADDRESS2>
|-
| Address: Line3
| <CMTLBLDATA_FLDCRDADDRESS3>
|-
| Address: State
| <CMTLBLDATA_FLDCRDSTATE>
|-
| Address: ZIP Code
| <CMTLBLDATA_FLDCRDZIP>
|-
| Assistant
| <CMTLBLDATA_FLDCRDASSISTANT>
|-
| Birthday
| <CMTLBLDATA_FLDCRDBIRTHDAY>
|-
| Company name
| <CMTLBLDATA_FLDCRDCOMPANY>
|-
| Contact: First & Last Name
| <CMTLBLDATA_FLDCRDCONTACT>
|-
| Dear
| <CMTLBLDATA_FLDCRDDEAR>
|-
| Department
| <CMTLBLDATA_FLDCRDDEPARTMENT>
|-
| E-Mail Address 1
| <CMTLBLDATA_FLDCRDEMAIL1>
|-
| E-Mail Address 2
| <CMTLBLDATA_FLDCRDEMAIL2>
|-
| Fax Number
| <CMTLBLDATA_FLDCRDFAX1>
|-
| Fax Number Extention
| <CMTLBLDATA_FLDCRDFAXDESC1>
|-
| Field
| <CMTLBLDATA_FLDCRDPERSONID>
|-
| Field1
| <CMTLBLDATA_FLDCRDUSER2>
|-
| Field2
| <CMTLBLDATA_FLDCRDUSER3>
|-
| Field3
| <CMTLBLDATA_FLDCRDUSER4>
|-
| Field4
| <CMTLBLDATA_FLDCRDUSER5>
|-
| Field5
| <CMTLBLDATA_FLDCRDCOMPANYNO>
|-
| File as
| <CMTLBLDATA_FLDCRDFULLNAME>
|-
| ID
| <CMTLBLDATA_FLDCRDCARDID3>
|-
| Last Name
| <CMTLBLDATA_FLDCRDLASTNAME>
|-
| Phone 1
| <CMTLBLDATA_FLDCRDPHONE1>
|-
| Phone 1 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC1>
|-
| Phone 2
| <CMTLBLDATA_FLDCRDPHONE2>
|-
| Phone 2 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC2>
|-
| Phone 3
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Phone 3 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC3>
|-
| Phone 4
| <CMTLBLDATA_FLDCRDPHONE4>
|-
| Phone 4 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC4>
|-
| Popup Message
| <CMTLBLDATA_FLDCRDCARDMESSAGE>
|-
| Region
| <CMTLBLDATA_FLDCRDREGIONCODE>
|-
| Salutation
| <CMTLBLDATA_FLDCRDSUFFIX>
|-
| Status
| <CMTLBLDATA_FLDCRDUSER1>
|-
| Sub-Contact Code
| <CMTLBLDATA_FLDCRDSUBCODE>
|-
| Title
| <CMTLBLDATA_FLDCRDTITLE>
|-
| Type
| <CMTLBLDATA_FLDCRDKIND>
|-
| Web Address 1
| <CMTLBLDATA_FLDCRDURL1>
|-
| Web Address 2
| <CMTLBLDATA_FLDCRDURL2>
|}

===Parameters list for Assets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTACCRECID>
|-
| Asset Code
| <CMTLBLDATA_FLDASTASSETCODE>
|-
| Asset Type
| <CMTLBLDATA_FLDASTASSETTYPE>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTCONTACTRECID>
|-
| Create Date
| <CMTLBLDATA_FLDASTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDASTCREATEUSER_FLDWRKNICKNAME>
|-
| Purchase Date
| <CMTLBLDATA_FLDASTCUSTPURDATE>
|-
| Purchased From Us
| <CMTLBLDATA_FLDASTCUSTPURFROMUS>
|-
| Purchase Our Invoice #
| <CMTLBLDATA_FLDASTCUSTPUROURINV>
|-
| Customer PO
| <CMTLBLDATA_FLDASTCUSTPURPO>
|-
| Purchase Price
| <CMTLBLDATA_FLDASTCUSTPURPRICE>
|-
| Delivered Date
| <CMTLBLDATA_FLDASTDELIVEDATE>
|-
| Description
| <CMTLBLDATA_FLDASTDESC>
|-
| Installed By
| <CMTLBLDATA_FLDASTINSTALBY_FLDWRKNICKNAME>
|-
| Installed Date
| <CMTLBLDATA_FLDASTINSTALDATE>
|-
| License Codes
| <CMTLBLDATA_FLDASTLICENSECODE>
|-
| License Keys
| <CMTLBLDATA_FLDASTLICENSEKEYS>
|-
| License Notes
| <CMTLBLDATA_FLDASTLICENSENOTES>
|-
| Location
| <CMTLBLDATA_FLDASTLOCATION>
|-
| Manufacturer
| <CMTLBLDATA_FLDASTMANUFACTURER>
|-
| Manufacturer Serial No.
| <CMTLBLDATA_FLDASTMNFSERIALNO>
|-
| Model
| <CMTLBLDATA_FLDASTMODEL>
|-
| Asset Name
| <CMTLBLDATA_FLDASTNAME>
|-
| Notes
| <CMTLBLDATA_FLDASTNOTES>
|-
| PARENTASSETRECID
| <CMTLBLDATA_FLDASTPARENTRECID>
|-
| Quantity
| <CMTLBLDATA_FLDASTQUANTITY>
|-
| Record ID
| <CMTLBLDATA_FLDASTRECID>
|-
| Serial No.
| <CMTLBLDATA_FLDASTSERIALNO>
|-
| Status
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Last Update date
| <CMTLBLDATA_FLDASTUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDASTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDASTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDASTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDASTUSER3>
|-
| Field4
| <CMTLBLDATA_FLDASTUSER4>
|-
| Field5
| <CMTLBLDATA_FLDASTUSER5>
|-
| Date1
| <CMTLBLDATA_FLDASTUSERDATE1>
|-
| Number1
| <CMTLBLDATA_FLDASTUSERNUMBER1>
|-
| Vendor Purchased Date
| <CMTLBLDATA_FLDASTVENDORDATEPURC>
|-
| Vendor Invoice #
| <CMTLBLDATA_FLDASTVENDORINVNO>
|-
| Vendor Name
| <CMTLBLDATA_FLDASTVENDORNAME>
|-
| Vendor PO
| <CMTLBLDATA_FLDASTVENDOROURPO>
|-
| Vendor Price
| <CMTLBLDATA_FLDASTVENDORPRICE>
|-
| Vendor
| <CMTLBLDATA_FLDASTVENDORRECID>
|-
| Vendor Serial No.
| <CMTLBLDATA_FLDASTVENDORSERNO>
|-
| Vendor Warranty Exp. Date
| <CMTLBLDATA_FLDASTVENDORWARREXP>
|-
| Version
| <CMTLBLDATA_FLDASTVERSION>
|-
| Warranty/License Exp. Date
| <CMTLBLDATA_FLDASTWARREXPDATE>FLDASTWARREXPDATE
|}

===Parameters list for Contracts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTACCRECID>
|-
| Block - Used
| <CMTLBLDATA_FLDBCTAMOUNTUSED>
|-
| Code
| <CMTLBLDATA_FLDBCTCODE>
|-
| Contract Type Type
| <CMTLBLDATA_FLDBCTCONTRACTTYPE>
|-
| Create Date
| <CMTLBLDATA_FLDBCTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDBCTCREATEUSER_FLDWRKNICKNAME>
|-
| Default Item Expense ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMEXPNS>
|-
| Default Item Labor ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMLABOR>
|-
| Default Item Part ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMPART>
|-
| Description
| <CMTLBLDATA_FLDBCTDESCEXTERNAL>
|-
| Internal Description
| <CMTLBLDATA_FLDBCTDESCINTERNAL>
|-
| End Date
| <CMTLBLDATA_FLDBCTENDDATE>
|-
| Name
| <CMTLBLDATA_FLDBCTNAME>
|-
| Note
| <CMTLBLDATA_FLDBCTNOTE>
|-
| Record ID
| <CMTLBLDATA_FLDBCTRECID>
|-
| Start Date
| <CMTLBLDATA_FLDBCTSTARTDATE>
|-
| Status
| <CMTLBLDATA_FLDBCTSTATUS>
|-
| Last Update date
| <CMTLBLDATA_FLDBCTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDBCTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field 1
| <CMTLBLDATA_FLDBCTUSER1>
|-
| Field 2
| <CMTLBLDATA_FLDBCTUSER2>
|-
| Field 3
| <CMTLBLDATA_FLDBCTUSER3>
|}

===Parameters list for Items===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Currency
| <CMTLBLDATA_FLDITMCOINID>
|-
| Created by User
| <CMTLBLDATA_FLDITMCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDITMDESC>
|-
| Expense Type
| <CMTLBLDATA_FLDITMEXPITEMTYPE>
|-
| Labor Type
| <CMTLBLDATA_FLDITMFEEITEMTYPE>
|-
| Item Code
| <CMTLBLDATA_FLDITMITEMNO>
|-
| Group
| <CMTLBLDATA_FLDITMITEMTYPEGROUP>
|-
| Name
| <CMTLBLDATA_FLDITMNAME>
|-
| Notes
| <CMTLBLDATA_FLDITMNOTES>
|-
| Price Source
| <CMTLBLDATA_FLDITMPRICESOURCE>
|-
| Product/Part Type
| <CMTLBLDATA_FLDITMPRODITEMTYPE>
|-
| Record Id
| <CMTLBLDATA_FLDITMRECID>
|-
| Cost
| <CMTLBLDATA_FLDITMSTANDARDCOST>
|-
| Suspend
| <CMTLBLDATA_FLDITMSUSPENDED>
|-
| Price
| <CMTLBLDATA_FLDITMUNITPRICE>
|-
| Update Date
| <CMTLBLDATA_FLDITMUPDATEDATE>
|-
| Update User
| <CMTLBLDATA_FLDITMUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDITMUSER1>
|}

===Parameters list for Opportunities===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Amount
| <CMTLBLDATA_FLDOPPAMOUNT>
|-
| Amount by Probability
| <CMTLBLDATA_FLDOPPCALCAMOUNT>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCARDID>
|-
| Closing amnt
| <CMTLBLDATA_FLDOPPCLOSEAMOUNT>
|-
| Close
| <CMTLBLDATA_FLDOPPCLOSEDATE>
|-
| Currency
| <CMTLBLDATA_FLDOPPCOINID>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCONTACTID>
|-
| Creation Date
| <CMTLBLDATA_FLDOPPCREATEDATE>
|-
| Created by User
| <CMTLBLDATA_FLDOPPCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDOPPDESCRIPTION>
|-
| Close By
| <CMTLBLDATA_FLDOPPESTDATE>
|-
| Oppty Type
| <CMTLBLDATA_FLDOPPKIND>
|-
| Opportunity
| <CMTLBLDATA_FLDOPPNAME>
|-
| Note
| <CMTLBLDATA_FLDOPPNOTES>
|-
| Open
| <CMTLBLDATA_FLDOPPOPENDATE>
|-
| Probability %
| <CMTLBLDATA_FLDOPPPROBABILITY>
|-
| Reason
| <CMTLBLDATA_FLDOPPREASON>
|-
| Record ID
| <CMTLBLDATA_FLDOPPRECID>
|-
| Record type
| <CMTLBLDATA_FLDOPPRECKIND>
|-
| Territory
| <CMTLBLDATA_FLDOPPREGION>
|-
| Source
| <CMTLBLDATA_FLDOPPSOURCE>
|-
| Stage
| <CMTLBLDATA_FLDOPPSTAGE>
|-
| Status
| <CMTLBLDATA_FLDOPPSTATUS>
|-
| Last Update Date
| <CMTLBLDATA_FLDOPPUPDATEDATE>
|-
| Last Update: By User
| <CMTLBLDATA_FLDOPPUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDOPPUSER1>
|-
| Field2
| <CMTLBLDATA_FLDOPPUSER2>
|-
| Field3
| <CMTLBLDATA_FLDOPPUSER3>
|-
| Opportunity ID
| <CMTLBLDATA_FLDOPPUSERID>
|-
| Manager
| <CMTLBLDATA_FLDOPPWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Asset ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTASSETRECID>
|-
| Contract ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTBCRECID>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCARDID>
|-
| Category
| <CMTLBLDATA_FLDTKTCATEGORY>
|-
| Cause
| <CMTLBLDATA_FLDTKTCAUSE>
|-
| Close Date
| <CMTLBLDATA_FLDTKTCLOSEDATETIME>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCONTACTID>
|-
| Creation: Date
| <CMTLBLDATA_FLDTKTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDTKTCREATEUSER_FLDWRKNICKNAME>
|-
| Due Date
| <CMTLBLDATA_FLDTKTDUEDATETIME>
|-
| Ticket Type
| <CMTLBLDATA_FLDTKTKIND>
|-
| Notes
| <CMTLBLDATA_FLDTKTNOTES>CMTLBLDATA
|-
| Open Date
| <CMTLBLDATA_FLDTKTOPENDATETIME>
|-
| Priority
| <CMTLBLDATA_FLDTKTPRIORITY>
|-
| Description
| <CMTLBLDATA_FLDTKTPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDTKTRECID>
|-
| Account's Region Code
| <CMTLBLDATA_FLDTKTREGIONCODE>
|-
| Estimated Duration Needed
| <CMTLBLDATA_FLDTKTSCHEDLENESTIM>
|-
| Resolution Description
| <CMTLBLDATA_FLDTKTSOLUTION>
|-
| Source
| <CMTLBLDATA_FLDTKTSOURCE>
|-
| Status
| <CMTLBLDATA_FLDTKTSTATUS>
|-
| Status: Ext.
| <CMTLBLDATA_FLDTKTSTATUSNOTE>
|-
| Ticket Number
| <CMTLBLDATA_FLDTKTTICKETNO>
|-
| Last Update Date
| <CMTLBLDATA_FLDTKTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDTKTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDTKTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDTKTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDTKTUSER3>
|-
| Manager
| <CMTLBLDATA_FLDTKTWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Category
| <CMTLBLDATA_FLDKBACATEGORY>
|-
| Create Date
| <CMTLBLDATA_FLDKBACREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDKBACREATEUSER_FLDWRKNICKNAME>
|-
| Public
| <CMTLBLDATA_FLDKBAISPUBLIC>
|-
| Problem
| <CMTLBLDATA_FLDKBAPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDKBARECID>
|-
| Solution
| <CMTLBLDATA_FLDKBASOLUTION>
|-
| Status
| <CMTLBLDATA_FLDKBASTATUS>
|-
| Title
| <CMTLBLDATA_FLDKBATITLE>
|-
| Last Update date
| <CMTLBLDATA_FLDKBAUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDKBAUPDATEUSER_FLDWRKNICKNAME>
|}

===Lookup Fields===
*Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket. This way you can define an Online Service for the Account, which will be activated from the Ticket window. Lookup Field syntax: <CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1> Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account FLDCRDADDRESS1 is the account's Address field

==See Also==
*[[Online Services FAQ]]

[[Category:Integration]]

Online Services

2009-08-20T14:14:17Z

Yarden: /* Displaying Products Warranties Online */

{{integration}}

Commit's '''Online Services''' is a powerful feature which allows you to link to web sites (URL) and activate the web application using parameters taken from CommitCRM.

You can define as many online Services as you wish. This feature is available for the following entities: Accounts, Tickets, Assets, Items, Contracts, Knowledge Base Articles and Oppotrunities.
*Accounts window
*Tickets window
*Dispatcher window
*Asset window
*Items window
*Contracts window
*Opportunities window

==What can I use Online Services for?==
Wouldn't you like your technicians to be able to find an address for a scheduled visit with just a single click? You can do this by defining an Online Service which will open maps site (e.g. Google Maps, Yahoo! Maps etc.) and the map will open automatically on the address of the Account or Contact stored in CommitCRM.

This powerful tool allows you to define any URL and open it with parameters. You can basically do with it whatever you want.

==Adding new Online Services==
To define a new Online Service, Open the Online Services Management window from Settings > Online Services. or click the Online Services icon from the Accounts window toolbar. Click the New button to add a new Online Service and enter the following parameters:

*'''Name''' - The name of the service which will be displayed in the Online Services list and menus throughout the system, for example, "Google Maps".
*'''Base URL''' - The URL you wish to open in order to use the Service. This is the address of the main service (before passing any parameters to it), for example http://maps.google.com/maps.
*'''URL Parameters''' - Parameters which will be appended to the URL in order to create specific queries when opening the URL. These parameters can be CommitCRM Account database fields which will be taken and filled from CommitCRM when clicking the Online Service.

See the Tips and Tricks for examples of useful Online Services

==Activating Online Services==
Online Services can be activated from various places in CommitCRM including:
*The '''Account, Ticket, Asset, Item, Opportunity, Contract, Knowledge Base Article windows''' - click the Online Services icon to activate the service for the selected account
*The '''Dispatcher Windows''' - right-click on a selected Ticket to run any Online Service for the Ticket's Account or Contact (such as displaying a map).
*The '''Calendar / Scheduled Appointments''' views - right-click above an Appointment and select Online Services.
*The '''secondary Contacts tab''' - select a Contact, right-click and select Online Services
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.
*'''Secondary Contact selection''' field - right-click and select Online Services.
*The '''Relations tab under Account''' - right-click and select Online Services.

==Possible Usage==
*'''Online Services and Assets''' – Access your MSP product online and pass the Asset ID to display its details from your external system
*'''Online Services and Items''' – Search for better prices for items by passing specific item information directly from within CommitCRM.
*'''Online Services for Assets''' – Search for a specific product review by its hardware serial number.
*'''Online Services for Tickets''' – Search in online knowledge bases for solutions based on the ticket description
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.

==Using Lookup Fields==
Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket.

This way you can define an Online Service for the Ticket, which will be activated from the Ticket window and will be using Account information.

Lookup Field syntax:

<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>

Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account
FLDCRDADDRESS1 is the account's Address field

==Tips & Tricks==
Following are examples of possible Online Services configurations.
These examples are intended to explain the use of Online Services only.

Disclaimer - Before defining your Online Services you should read the terms of use for each web site you want to access. The examples below are displayed to explain how to use online services and how to pass parameters.

===Displaying Online Maps===
'''Google Maps''' - Opens Google Maps and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Maps
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDCRDADDRESS1>+<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDSTATE>+<CMTLBLDATA_FLDCRDZIP>
|}

'''MapQuest''' - Opens MapQuest Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| MapQuest
|-
| Base URL
| <nowiki>http://www.mapquest.com/maps</nowiki>
|-
| URL Parameters
| /map.adp?searchtype=address&country=<CMTLBLDATA_FLDCRDCOUNTRY>&addtohistory=&searchtab=home&formtype=address&popflag=0&latitude=&longitude=&name=&phone=&level=&cat=&address=&city=<CMTLBLDATA_FLDCRDCITY>&state=<CMTLBLDATA_FLDCRDSTATE>&zipcode=<CMTLBLDATA_FLDCRDZIP>
|}

'''Yahoo! Maps''' - Opens Yahoo! Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Yahoo! Maps
|-
| Base URL
| <nowiki>http://maps.yahoo.com</nowiki>
|-
| URL Parameters
| /maps_result?addr=<CMTLBLDATA_FLDCRDADDRESS1>&csz=<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDCOUNTRY>&country=<CMTLBLDATA_FLDCRDSTATE>
|}

===Finding Account Information===
'''Google Company''' - Opens Google and searches for the Account Company Name.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Company
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCOMPANY>
|}

'''Google Contact''' - Opens Google and searches for the Contact Name.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Contact
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCONTACT>
|}

===Finding Ticket Description in Google===
'''Google Ticket''' - Opens Google and searches for the Ticket description.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket Description
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDTKTPROBLEM>
|}

===Finding Account Address From Ticket (using [[Commit Online Services#Using Lookup Fields|Lookup Field]]) ===
'''Google Address From Ticket''' - Opens Google and searches for the Address of the Account which is linked to the Ticket.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDCITY>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDSTATE>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDZIP>
|}

===Displaying Products Warranties Online===
'''HP Warranty Lookup''' - Displays HP products warranty expiration dates, using the products number and the products serial number.

Note: Product Number goes into Plate# field (<CMTLBLDATA_FLDASTUSER1>).

'''Contributed by Easy I.T'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| HP Warranty Lookup
|-
| Base URL
| <nowiki>http://h20000.www2.hp.com/bizsupport/TechSupport/WarrantyResults.jsp?</nowiki>
|-
| URL Parameters
| lang=en&cc=us&prodSeriesId=454811&prodTypeId=12454&sn=<CMTLBLDATA_FLDASTSERIALNO>&pn=<CMTLBLDATA_FLDASTUSER1>&country=US&nickname=&find=Display+Warranty+Information+%C2%BB
|}

'''DELL Service Contracts and Warranties''' - Displays Dell products warranty expiration dates, using the service tag number.

Note: Customize a Field for Service Tag or use existing field. In this sample we will use Field3 as custumized Service Tag Field

'''Contributed by JoshuaB'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| Dell Warranty Check
|-
| Base URL
| <nowiki>http://support.dell.com/support/topics/global.aspx/support/my_systems_info/details</nowiki>
|-
| URL Parameters
| ?c=us&l=en&s=gen&servicetag=<CMTLBLDATA_FLDASTUSER3>
|}

===Displaying Domain WHOIS===

'''Domain WHOIS''' - WHOIS domain registration information by Domain Tools.

Note: Domain must be stripped from URL (without http://).

'''Contributed by DavidW'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (NetworkSolutions)
|-
| Base URL
| <nowiki>http://www.networksolutions.com/whois-search/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''Domain WHOIS''' - WHOIS domain registration information by Network Solutions.

Note: Domain must be stripped from URL (without http://).

'''Contributed by ajgyomber'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DomainTools)
|-
| Base URL
| <nowiki>http://whois.domaintools.com/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

===Displaying Online Work Orders Status===
'''Work Orders Status Check''' - Track your orders statuses in <nowiki>onforce.com</nowiki>

Note: Set Field1 to order number or change the parameter (<CMTLBLDATA_FLDTKTUSER1>) to a different field.

'''Contributed by secion8'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Tickets
|-
| Name
| Work Orders Status (onforce.com
|-
| Base URL
| <nowiki>http://www.onforce.com/?action=pcc_work_order_view&id=</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDTKTUSER1>
|}

==Parameters list==

===Parameters List for Accounts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account Number
| <CMTLBLDATA_FLDCRDCARDID2>
|-
| Address: City
| <CMTLBLDATA_FLDCRDCITY>
|-
| Address: Country
| <CMTLBLDATA_FLDCRDCOUNTRY>
|-
| Address: Line1
| <CMTLBLDATA_FLDCRDADDRESS1>
|-
| Address: Line2
| <CMTLBLDATA_FLDCRDADDRESS2>
|-
| Address: Line3
| <CMTLBLDATA_FLDCRDADDRESS3>
|-
| Address: State
| <CMTLBLDATA_FLDCRDSTATE>
|-
| Address: ZIP Code
| <CMTLBLDATA_FLDCRDZIP>
|-
| Assistant
| <CMTLBLDATA_FLDCRDASSISTANT>
|-
| Birthday
| <CMTLBLDATA_FLDCRDBIRTHDAY>
|-
| Company name
| <CMTLBLDATA_FLDCRDCOMPANY>
|-
| Contact: First & Last Name
| <CMTLBLDATA_FLDCRDCONTACT>
|-
| Dear
| <CMTLBLDATA_FLDCRDDEAR>
|-
| Department
| <CMTLBLDATA_FLDCRDDEPARTMENT>
|-
| E-Mail Address 1
| <CMTLBLDATA_FLDCRDEMAIL1>
|-
| E-Mail Address 2
| <CMTLBLDATA_FLDCRDEMAIL2>
|-
| Fax Number
| <CMTLBLDATA_FLDCRDFAX1>
|-
| Fax Number Extention
| <CMTLBLDATA_FLDCRDFAXDESC1>
|-
| Field
| <CMTLBLDATA_FLDCRDPERSONID>
|-
| Field1
| <CMTLBLDATA_FLDCRDUSER2>
|-
| Field2
| <CMTLBLDATA_FLDCRDUSER3>
|-
| Field3
| <CMTLBLDATA_FLDCRDUSER4>
|-
| Field4
| <CMTLBLDATA_FLDCRDUSER5>
|-
| Field5
| <CMTLBLDATA_FLDCRDCOMPANYNO>
|-
| File as
| <CMTLBLDATA_FLDCRDFULLNAME>
|-
| ID
| <CMTLBLDATA_FLDCRDCARDID3>
|-
| Last Name
| <CMTLBLDATA_FLDCRDLASTNAME>
|-
| Phone 1
| <CMTLBLDATA_FLDCRDPHONE1>
|-
| Phone 1 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC1>
|-
| Phone 2
| <CMTLBLDATA_FLDCRDPHONE2>
|-
| Phone 2 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC2>
|-
| Phone 3
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Phone 3 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC3>
|-
| Phone 4
| <CMTLBLDATA_FLDCRDPHONE4>
|-
| Phone 4 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC4>
|-
| Popup Message
| <CMTLBLDATA_FLDCRDCARDMESSAGE>
|-
| Region
| <CMTLBLDATA_FLDCRDREGIONCODE>
|-
| Salutation
| <CMTLBLDATA_FLDCRDSUFFIX>
|-
| Status
| <CMTLBLDATA_FLDCRDUSER1>
|-
| Sub-Contact Code
| <CMTLBLDATA_FLDCRDSUBCODE>
|-
| Title
| <CMTLBLDATA_FLDCRDTITLE>
|-
| Type
| <CMTLBLDATA_FLDCRDKIND>
|-
| Web Address 1
| <CMTLBLDATA_FLDCRDURL1>
|-
| Web Address 2
| <CMTLBLDATA_FLDCRDURL2>
|}

===Parameters list for Assets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTACCRECID>
|-
| Asset Code
| <CMTLBLDATA_FLDASTASSETCODE>
|-
| Asset Type
| <CMTLBLDATA_FLDASTASSETTYPE>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTCONTACTRECID>
|-
| Create Date
| <CMTLBLDATA_FLDASTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDASTCREATEUSER_FLDWRKNICKNAME>
|-
| Purchase Date
| <CMTLBLDATA_FLDASTCUSTPURDATE>
|-
| Purchased From Us
| <CMTLBLDATA_FLDASTCUSTPURFROMUS>
|-
| Purchase Our Invoice #
| <CMTLBLDATA_FLDASTCUSTPUROURINV>
|-
| Customer PO
| <CMTLBLDATA_FLDASTCUSTPURPO>
|-
| Purchase Price
| <CMTLBLDATA_FLDASTCUSTPURPRICE>
|-
| Delivered Date
| <CMTLBLDATA_FLDASTDELIVEDATE>
|-
| Description
| <CMTLBLDATA_FLDASTDESC>
|-
| Installed By
| <CMTLBLDATA_FLDASTINSTALBY_FLDWRKNICKNAME>
|-
| Installed Date
| <CMTLBLDATA_FLDASTINSTALDATE>
|-
| License Codes
| <CMTLBLDATA_FLDASTLICENSECODE>
|-
| License Keys
| <CMTLBLDATA_FLDASTLICENSEKEYS>
|-
| License Notes
| <CMTLBLDATA_FLDASTLICENSENOTES>
|-
| Location
| <CMTLBLDATA_FLDASTLOCATION>
|-
| Manufacturer
| <CMTLBLDATA_FLDASTMANUFACTURER>
|-
| Manufacturer Serial No.
| <CMTLBLDATA_FLDASTMNFSERIALNO>
|-
| Model
| <CMTLBLDATA_FLDASTMODEL>
|-
| Asset Name
| <CMTLBLDATA_FLDASTNAME>
|-
| Notes
| <CMTLBLDATA_FLDASTNOTES>
|-
| PARENTASSETRECID
| <CMTLBLDATA_FLDASTPARENTRECID>
|-
| Quantity
| <CMTLBLDATA_FLDASTQUANTITY>
|-
| Record ID
| <CMTLBLDATA_FLDASTRECID>
|-
| Serial No.
| <CMTLBLDATA_FLDASTSERIALNO>
|-
| Status
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Last Update date
| <CMTLBLDATA_FLDASTUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDASTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDASTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDASTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDASTUSER3>
|-
| Field4
| <CMTLBLDATA_FLDASTUSER4>
|-
| Field5
| <CMTLBLDATA_FLDASTUSER5>
|-
| Date1
| <CMTLBLDATA_FLDASTUSERDATE1>
|-
| Number1
| <CMTLBLDATA_FLDASTUSERNUMBER1>
|-
| Vendor Purchased Date
| <CMTLBLDATA_FLDASTVENDORDATEPURC>
|-
| Vendor Invoice #
| <CMTLBLDATA_FLDASTVENDORINVNO>
|-
| Vendor Name
| <CMTLBLDATA_FLDASTVENDORNAME>
|-
| Vendor PO
| <CMTLBLDATA_FLDASTVENDOROURPO>
|-
| Vendor Price
| <CMTLBLDATA_FLDASTVENDORPRICE>
|-
| Vendor
| <CMTLBLDATA_FLDASTVENDORRECID>
|-
| Vendor Serial No.
| <CMTLBLDATA_FLDASTVENDORSERNO>
|-
| Vendor Warranty Exp. Date
| <CMTLBLDATA_FLDASTVENDORWARREXP>
|-
| Version
| <CMTLBLDATA_FLDASTVERSION>
|-
| Warranty/License Exp. Date
| <CMTLBLDATA_FLDASTWARREXPDATE>FLDASTWARREXPDATE
|}

===Parameters list for Contracts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTACCRECID>
|-
| Block - Used
| <CMTLBLDATA_FLDBCTAMOUNTUSED>
|-
| Code
| <CMTLBLDATA_FLDBCTCODE>
|-
| Contract Type Type
| <CMTLBLDATA_FLDBCTCONTRACTTYPE>
|-
| Create Date
| <CMTLBLDATA_FLDBCTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDBCTCREATEUSER_FLDWRKNICKNAME>
|-
| Default Item Expense ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMEXPNS>
|-
| Default Item Labor ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMLABOR>
|-
| Default Item Part ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMPART>
|-
| Description
| <CMTLBLDATA_FLDBCTDESCEXTERNAL>
|-
| Internal Description
| <CMTLBLDATA_FLDBCTDESCINTERNAL>
|-
| End Date
| <CMTLBLDATA_FLDBCTENDDATE>
|-
| Name
| <CMTLBLDATA_FLDBCTNAME>
|-
| Note
| <CMTLBLDATA_FLDBCTNOTE>
|-
| Record ID
| <CMTLBLDATA_FLDBCTRECID>
|-
| Start Date
| <CMTLBLDATA_FLDBCTSTARTDATE>
|-
| Status
| <CMTLBLDATA_FLDBCTSTATUS>
|-
| Last Update date
| <CMTLBLDATA_FLDBCTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDBCTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field 1
| <CMTLBLDATA_FLDBCTUSER1>
|-
| Field 2
| <CMTLBLDATA_FLDBCTUSER2>
|-
| Field 3
| <CMTLBLDATA_FLDBCTUSER3>
|}

===Parameters list for Items===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Currency
| <CMTLBLDATA_FLDITMCOINID>
|-
| Created by User
| <CMTLBLDATA_FLDITMCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDITMDESC>
|-
| Expense Type
| <CMTLBLDATA_FLDITMEXPITEMTYPE>
|-
| Labor Type
| <CMTLBLDATA_FLDITMFEEITEMTYPE>
|-
| Item Code
| <CMTLBLDATA_FLDITMITEMNO>
|-
| Group
| <CMTLBLDATA_FLDITMITEMTYPEGROUP>
|-
| Name
| <CMTLBLDATA_FLDITMNAME>
|-
| Notes
| <CMTLBLDATA_FLDITMNOTES>
|-
| Price Source
| <CMTLBLDATA_FLDITMPRICESOURCE>
|-
| Product/Part Type
| <CMTLBLDATA_FLDITMPRODITEMTYPE>
|-
| Record Id
| <CMTLBLDATA_FLDITMRECID>
|-
| Cost
| <CMTLBLDATA_FLDITMSTANDARDCOST>
|-
| Suspend
| <CMTLBLDATA_FLDITMSUSPENDED>
|-
| Price
| <CMTLBLDATA_FLDITMUNITPRICE>
|-
| Update Date
| <CMTLBLDATA_FLDITMUPDATEDATE>
|-
| Update User
| <CMTLBLDATA_FLDITMUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDITMUSER1>
|}

===Parameters list for Opportunities===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Amount
| <CMTLBLDATA_FLDOPPAMOUNT>
|-
| Amount by Probability
| <CMTLBLDATA_FLDOPPCALCAMOUNT>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCARDID>
|-
| Closing amnt
| <CMTLBLDATA_FLDOPPCLOSEAMOUNT>
|-
| Close
| <CMTLBLDATA_FLDOPPCLOSEDATE>
|-
| Currency
| <CMTLBLDATA_FLDOPPCOINID>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCONTACTID>
|-
| Creation Date
| <CMTLBLDATA_FLDOPPCREATEDATE>
|-
| Created by User
| <CMTLBLDATA_FLDOPPCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDOPPDESCRIPTION>
|-
| Close By
| <CMTLBLDATA_FLDOPPESTDATE>
|-
| Oppty Type
| <CMTLBLDATA_FLDOPPKIND>
|-
| Opportunity
| <CMTLBLDATA_FLDOPPNAME>
|-
| Note
| <CMTLBLDATA_FLDOPPNOTES>
|-
| Open
| <CMTLBLDATA_FLDOPPOPENDATE>
|-
| Probability %
| <CMTLBLDATA_FLDOPPPROBABILITY>
|-
| Reason
| <CMTLBLDATA_FLDOPPREASON>
|-
| Record ID
| <CMTLBLDATA_FLDOPPRECID>
|-
| Record type
| <CMTLBLDATA_FLDOPPRECKIND>
|-
| Territory
| <CMTLBLDATA_FLDOPPREGION>
|-
| Source
| <CMTLBLDATA_FLDOPPSOURCE>
|-
| Stage
| <CMTLBLDATA_FLDOPPSTAGE>
|-
| Status
| <CMTLBLDATA_FLDOPPSTATUS>
|-
| Last Update Date
| <CMTLBLDATA_FLDOPPUPDATEDATE>
|-
| Last Update: By User
| <CMTLBLDATA_FLDOPPUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDOPPUSER1>
|-
| Field2
| <CMTLBLDATA_FLDOPPUSER2>
|-
| Field3
| <CMTLBLDATA_FLDOPPUSER3>
|-
| Opportunity ID
| <CMTLBLDATA_FLDOPPUSERID>
|-
| Manager
| <CMTLBLDATA_FLDOPPWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Asset ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTASSETRECID>
|-
| Contract ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTBCRECID>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCARDID>
|-
| Category
| <CMTLBLDATA_FLDTKTCATEGORY>
|-
| Cause
| <CMTLBLDATA_FLDTKTCAUSE>
|-
| Close Date
| <CMTLBLDATA_FLDTKTCLOSEDATETIME>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCONTACTID>
|-
| Creation: Date
| <CMTLBLDATA_FLDTKTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDTKTCREATEUSER_FLDWRKNICKNAME>
|-
| Due Date
| <CMTLBLDATA_FLDTKTDUEDATETIME>
|-
| Ticket Type
| <CMTLBLDATA_FLDTKTKIND>
|-
| Notes
| <CMTLBLDATA_FLDTKTNOTES>CMTLBLDATA
|-
| Open Date
| <CMTLBLDATA_FLDTKTOPENDATETIME>
|-
| Priority
| <CMTLBLDATA_FLDTKTPRIORITY>
|-
| Description
| <CMTLBLDATA_FLDTKTPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDTKTRECID>
|-
| Account's Region Code
| <CMTLBLDATA_FLDTKTREGIONCODE>
|-
| Estimated Duration Needed
| <CMTLBLDATA_FLDTKTSCHEDLENESTIM>
|-
| Resolution Description
| <CMTLBLDATA_FLDTKTSOLUTION>
|-
| Source
| <CMTLBLDATA_FLDTKTSOURCE>
|-
| Status
| <CMTLBLDATA_FLDTKTSTATUS>
|-
| Status: Ext.
| <CMTLBLDATA_FLDTKTSTATUSNOTE>
|-
| Ticket Number
| <CMTLBLDATA_FLDTKTTICKETNO>
|-
| Last Update Date
| <CMTLBLDATA_FLDTKTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDTKTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDTKTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDTKTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDTKTUSER3>
|-
| Manager
| <CMTLBLDATA_FLDTKTWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Category
| <CMTLBLDATA_FLDKBACATEGORY>
|-
| Create Date
| <CMTLBLDATA_FLDKBACREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDKBACREATEUSER_FLDWRKNICKNAME>
|-
| Public
| <CMTLBLDATA_FLDKBAISPUBLIC>
|-
| Problem
| <CMTLBLDATA_FLDKBAPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDKBARECID>
|-
| Solution
| <CMTLBLDATA_FLDKBASOLUTION>
|-
| Status
| <CMTLBLDATA_FLDKBASTATUS>
|-
| Title
| <CMTLBLDATA_FLDKBATITLE>
|-
| Last Update date
| <CMTLBLDATA_FLDKBAUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDKBAUPDATEUSER_FLDWRKNICKNAME>
|}

===Lookup Fields===
*Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket. This way you can define an Online Service for the Account, which will be activated from the Ticket window. Lookup Field syntax: <CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1> Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account FLDCRDADDRESS1 is the account's Address field

==See Also==
*[[Online Services FAQ]]

[[Category:Integration]]

Online Services

2009-08-20T14:02:12Z

Yarden: /* Displaying Domain WHOIS */

{{integration}}

Commit's '''Online Services''' is a powerful feature which allows you to link to web sites (URL) and activate the web application using parameters taken from CommitCRM.

You can define as many online Services as you wish. This feature is available for the following entities: Accounts, Tickets, Assets, Items, Contracts, Knowledge Base Articles and Oppotrunities.
*Accounts window
*Tickets window
*Dispatcher window
*Asset window
*Items window
*Contracts window
*Opportunities window

==What can I use Online Services for?==
Wouldn't you like your technicians to be able to find an address for a scheduled visit with just a single click? You can do this by defining an Online Service which will open maps site (e.g. Google Maps, Yahoo! Maps etc.) and the map will open automatically on the address of the Account or Contact stored in CommitCRM.

This powerful tool allows you to define any URL and open it with parameters. You can basically do with it whatever you want.

==Adding new Online Services==
To define a new Online Service, Open the Online Services Management window from Settings > Online Services. or click the Online Services icon from the Accounts window toolbar. Click the New button to add a new Online Service and enter the following parameters:

*'''Name''' - The name of the service which will be displayed in the Online Services list and menus throughout the system, for example, "Google Maps".
*'''Base URL''' - The URL you wish to open in order to use the Service. This is the address of the main service (before passing any parameters to it), for example http://maps.google.com/maps.
*'''URL Parameters''' - Parameters which will be appended to the URL in order to create specific queries when opening the URL. These parameters can be CommitCRM Account database fields which will be taken and filled from CommitCRM when clicking the Online Service.

See the Tips and Tricks for examples of useful Online Services

==Activating Online Services==
Online Services can be activated from various places in CommitCRM including:
*The '''Account, Ticket, Asset, Item, Opportunity, Contract, Knowledge Base Article windows''' - click the Online Services icon to activate the service for the selected account
*The '''Dispatcher Windows''' - right-click on a selected Ticket to run any Online Service for the Ticket's Account or Contact (such as displaying a map).
*The '''Calendar / Scheduled Appointments''' views - right-click above an Appointment and select Online Services.
*The '''secondary Contacts tab''' - select a Contact, right-click and select Online Services
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.
*'''Secondary Contact selection''' field - right-click and select Online Services.
*The '''Relations tab under Account''' - right-click and select Online Services.

==Possible Usage==
*'''Online Services and Assets''' – Access your MSP product online and pass the Asset ID to display its details from your external system
*'''Online Services and Items''' – Search for better prices for items by passing specific item information directly from within CommitCRM.
*'''Online Services for Assets''' – Search for a specific product review by its hardware serial number.
*'''Online Services for Tickets''' – Search in online knowledge bases for solutions based on the ticket description
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.

==Using Lookup Fields==
Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket.

This way you can define an Online Service for the Ticket, which will be activated from the Ticket window and will be using Account information.

Lookup Field syntax:

<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>

Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account
FLDCRDADDRESS1 is the account's Address field

==Tips & Tricks==
Following are examples of possible Online Services configurations.
These examples are intended to explain the use of Online Services only.

Disclaimer - Before defining your Online Services you should read the terms of use for each web site you want to access. The examples below are displayed to explain how to use online services and how to pass parameters.

===Displaying Online Maps===
'''Google Maps''' - Opens Google Maps and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Maps
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDCRDADDRESS1>+<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDSTATE>+<CMTLBLDATA_FLDCRDZIP>
|}

'''MapQuest''' - Opens MapQuest Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| MapQuest
|-
| Base URL
| <nowiki>http://www.mapquest.com/maps</nowiki>
|-
| URL Parameters
| /map.adp?searchtype=address&country=<CMTLBLDATA_FLDCRDCOUNTRY>&addtohistory=&searchtab=home&formtype=address&popflag=0&latitude=&longitude=&name=&phone=&level=&cat=&address=&city=<CMTLBLDATA_FLDCRDCITY>&state=<CMTLBLDATA_FLDCRDSTATE>&zipcode=<CMTLBLDATA_FLDCRDZIP>
|}

'''Yahoo! Maps''' - Opens Yahoo! Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Yahoo! Maps
|-
| Base URL
| <nowiki>http://maps.yahoo.com</nowiki>
|-
| URL Parameters
| /maps_result?addr=<CMTLBLDATA_FLDCRDADDRESS1>&csz=<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDCOUNTRY>&country=<CMTLBLDATA_FLDCRDSTATE>
|}

===Finding Account Information===
'''Google Company''' - Opens Google and searches for the Account Company Name.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Company
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCOMPANY>
|}

'''Google Contact''' - Opens Google and searches for the Contact Name.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Contact
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCONTACT>
|}

===Finding Ticket Description in Google===
'''Google Ticket''' - Opens Google and searches for the Ticket description.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket Description
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDTKTPROBLEM>
|}

===Finding Account Address From Ticket (using [[Commit Online Services#Using Lookup Fields|Lookup Field]]) ===
'''Google Address From Ticket''' - Opens Google and searches for the Address of the Account which is linked to the Ticket.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDCITY>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDSTATE>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDZIP>
|}

===Displaying Products Warranties Online===
'''Contributed by Easy I.T'''

'''HP Warranty Lookup''' - Displays HP products warranty expiration dates, using the products number and the products serial number.

Note: Product Number goes into Plate# field (<CMTLBLDATA_FLDASTUSER1>).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| HP Warranty Lookup
|-
| Base URL
| <nowiki>http://h20000.www2.hp.com/bizsupport/TechSupport/WarrantyResults.jsp?</nowiki>
|-
| URL Parameters
| lang=en&cc=us&prodSeriesId=454811&prodTypeId=12454&sn=<CMTLBLDATA_FLDASTSERIALNO>&pn=<CMTLBLDATA_FLDASTUSER1>&country=US&nickname=&find=Display+Warranty+Information+%C2%BB
|}

===Displaying Domain WHOIS===

'''Domain WHOIS''' - WHOIS domain registration information by Domain Tools.

Note: Domain must be stripped from URL (without http://).

'''Contributed by DavidW'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (NetworkSolutions)
|-
| Base URL
| <nowiki>http://www.networksolutions.com/whois-search/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''Domain WHOIS''' - WHOIS domain registration information by Network Solutions.

Note: Domain must be stripped from URL (without http://).

'''Contributed by ajgyomber'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DomainTools)
|-
| Base URL
| <nowiki>http://whois.domaintools.com/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

===Displaying Online Work Orders Status===
'''Work Orders Status Check''' - Track your orders statuses in <nowiki>onforce.com</nowiki>

Note: Set Field1 to order number or change the parameter (<CMTLBLDATA_FLDTKTUSER1>) to a different field.

'''Contributed by secion8'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Tickets
|-
| Name
| Work Orders Status (onforce.com
|-
| Base URL
| <nowiki>http://www.onforce.com/?action=pcc_work_order_view&id=</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDTKTUSER1>
|}

==Parameters list==

===Parameters List for Accounts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account Number
| <CMTLBLDATA_FLDCRDCARDID2>
|-
| Address: City
| <CMTLBLDATA_FLDCRDCITY>
|-
| Address: Country
| <CMTLBLDATA_FLDCRDCOUNTRY>
|-
| Address: Line1
| <CMTLBLDATA_FLDCRDADDRESS1>
|-
| Address: Line2
| <CMTLBLDATA_FLDCRDADDRESS2>
|-
| Address: Line3
| <CMTLBLDATA_FLDCRDADDRESS3>
|-
| Address: State
| <CMTLBLDATA_FLDCRDSTATE>
|-
| Address: ZIP Code
| <CMTLBLDATA_FLDCRDZIP>
|-
| Assistant
| <CMTLBLDATA_FLDCRDASSISTANT>
|-
| Birthday
| <CMTLBLDATA_FLDCRDBIRTHDAY>
|-
| Company name
| <CMTLBLDATA_FLDCRDCOMPANY>
|-
| Contact: First & Last Name
| <CMTLBLDATA_FLDCRDCONTACT>
|-
| Dear
| <CMTLBLDATA_FLDCRDDEAR>
|-
| Department
| <CMTLBLDATA_FLDCRDDEPARTMENT>
|-
| E-Mail Address 1
| <CMTLBLDATA_FLDCRDEMAIL1>
|-
| E-Mail Address 2
| <CMTLBLDATA_FLDCRDEMAIL2>
|-
| Fax Number
| <CMTLBLDATA_FLDCRDFAX1>
|-
| Fax Number Extention
| <CMTLBLDATA_FLDCRDFAXDESC1>
|-
| Field
| <CMTLBLDATA_FLDCRDPERSONID>
|-
| Field1
| <CMTLBLDATA_FLDCRDUSER2>
|-
| Field2
| <CMTLBLDATA_FLDCRDUSER3>
|-
| Field3
| <CMTLBLDATA_FLDCRDUSER4>
|-
| Field4
| <CMTLBLDATA_FLDCRDUSER5>
|-
| Field5
| <CMTLBLDATA_FLDCRDCOMPANYNO>
|-
| File as
| <CMTLBLDATA_FLDCRDFULLNAME>
|-
| ID
| <CMTLBLDATA_FLDCRDCARDID3>
|-
| Last Name
| <CMTLBLDATA_FLDCRDLASTNAME>
|-
| Phone 1
| <CMTLBLDATA_FLDCRDPHONE1>
|-
| Phone 1 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC1>
|-
| Phone 2
| <CMTLBLDATA_FLDCRDPHONE2>
|-
| Phone 2 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC2>
|-
| Phone 3
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Phone 3 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC3>
|-
| Phone 4
| <CMTLBLDATA_FLDCRDPHONE4>
|-
| Phone 4 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC4>
|-
| Popup Message
| <CMTLBLDATA_FLDCRDCARDMESSAGE>
|-
| Region
| <CMTLBLDATA_FLDCRDREGIONCODE>
|-
| Salutation
| <CMTLBLDATA_FLDCRDSUFFIX>
|-
| Status
| <CMTLBLDATA_FLDCRDUSER1>
|-
| Sub-Contact Code
| <CMTLBLDATA_FLDCRDSUBCODE>
|-
| Title
| <CMTLBLDATA_FLDCRDTITLE>
|-
| Type
| <CMTLBLDATA_FLDCRDKIND>
|-
| Web Address 1
| <CMTLBLDATA_FLDCRDURL1>
|-
| Web Address 2
| <CMTLBLDATA_FLDCRDURL2>
|}

===Parameters list for Assets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTACCRECID>
|-
| Asset Code
| <CMTLBLDATA_FLDASTASSETCODE>
|-
| Asset Type
| <CMTLBLDATA_FLDASTASSETTYPE>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTCONTACTRECID>
|-
| Create Date
| <CMTLBLDATA_FLDASTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDASTCREATEUSER_FLDWRKNICKNAME>
|-
| Purchase Date
| <CMTLBLDATA_FLDASTCUSTPURDATE>
|-
| Purchased From Us
| <CMTLBLDATA_FLDASTCUSTPURFROMUS>
|-
| Purchase Our Invoice #
| <CMTLBLDATA_FLDASTCUSTPUROURINV>
|-
| Customer PO
| <CMTLBLDATA_FLDASTCUSTPURPO>
|-
| Purchase Price
| <CMTLBLDATA_FLDASTCUSTPURPRICE>
|-
| Delivered Date
| <CMTLBLDATA_FLDASTDELIVEDATE>
|-
| Description
| <CMTLBLDATA_FLDASTDESC>
|-
| Installed By
| <CMTLBLDATA_FLDASTINSTALBY_FLDWRKNICKNAME>
|-
| Installed Date
| <CMTLBLDATA_FLDASTINSTALDATE>
|-
| License Codes
| <CMTLBLDATA_FLDASTLICENSECODE>
|-
| License Keys
| <CMTLBLDATA_FLDASTLICENSEKEYS>
|-
| License Notes
| <CMTLBLDATA_FLDASTLICENSENOTES>
|-
| Location
| <CMTLBLDATA_FLDASTLOCATION>
|-
| Manufacturer
| <CMTLBLDATA_FLDASTMANUFACTURER>
|-
| Manufacturer Serial No.
| <CMTLBLDATA_FLDASTMNFSERIALNO>
|-
| Model
| <CMTLBLDATA_FLDASTMODEL>
|-
| Asset Name
| <CMTLBLDATA_FLDASTNAME>
|-
| Notes
| <CMTLBLDATA_FLDASTNOTES>
|-
| PARENTASSETRECID
| <CMTLBLDATA_FLDASTPARENTRECID>
|-
| Quantity
| <CMTLBLDATA_FLDASTQUANTITY>
|-
| Record ID
| <CMTLBLDATA_FLDASTRECID>
|-
| Serial No.
| <CMTLBLDATA_FLDASTSERIALNO>
|-
| Status
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Last Update date
| <CMTLBLDATA_FLDASTUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDASTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDASTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDASTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDASTUSER3>
|-
| Field4
| <CMTLBLDATA_FLDASTUSER4>
|-
| Field5
| <CMTLBLDATA_FLDASTUSER5>
|-
| Date1
| <CMTLBLDATA_FLDASTUSERDATE1>
|-
| Number1
| <CMTLBLDATA_FLDASTUSERNUMBER1>
|-
| Vendor Purchased Date
| <CMTLBLDATA_FLDASTVENDORDATEPURC>
|-
| Vendor Invoice #
| <CMTLBLDATA_FLDASTVENDORINVNO>
|-
| Vendor Name
| <CMTLBLDATA_FLDASTVENDORNAME>
|-
| Vendor PO
| <CMTLBLDATA_FLDASTVENDOROURPO>
|-
| Vendor Price
| <CMTLBLDATA_FLDASTVENDORPRICE>
|-
| Vendor
| <CMTLBLDATA_FLDASTVENDORRECID>
|-
| Vendor Serial No.
| <CMTLBLDATA_FLDASTVENDORSERNO>
|-
| Vendor Warranty Exp. Date
| <CMTLBLDATA_FLDASTVENDORWARREXP>
|-
| Version
| <CMTLBLDATA_FLDASTVERSION>
|-
| Warranty/License Exp. Date
| <CMTLBLDATA_FLDASTWARREXPDATE>FLDASTWARREXPDATE
|}

===Parameters list for Contracts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTACCRECID>
|-
| Block - Used
| <CMTLBLDATA_FLDBCTAMOUNTUSED>
|-
| Code
| <CMTLBLDATA_FLDBCTCODE>
|-
| Contract Type Type
| <CMTLBLDATA_FLDBCTCONTRACTTYPE>
|-
| Create Date
| <CMTLBLDATA_FLDBCTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDBCTCREATEUSER_FLDWRKNICKNAME>
|-
| Default Item Expense ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMEXPNS>
|-
| Default Item Labor ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMLABOR>
|-
| Default Item Part ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMPART>
|-
| Description
| <CMTLBLDATA_FLDBCTDESCEXTERNAL>
|-
| Internal Description
| <CMTLBLDATA_FLDBCTDESCINTERNAL>
|-
| End Date
| <CMTLBLDATA_FLDBCTENDDATE>
|-
| Name
| <CMTLBLDATA_FLDBCTNAME>
|-
| Note
| <CMTLBLDATA_FLDBCTNOTE>
|-
| Record ID
| <CMTLBLDATA_FLDBCTRECID>
|-
| Start Date
| <CMTLBLDATA_FLDBCTSTARTDATE>
|-
| Status
| <CMTLBLDATA_FLDBCTSTATUS>
|-
| Last Update date
| <CMTLBLDATA_FLDBCTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDBCTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field 1
| <CMTLBLDATA_FLDBCTUSER1>
|-
| Field 2
| <CMTLBLDATA_FLDBCTUSER2>
|-
| Field 3
| <CMTLBLDATA_FLDBCTUSER3>
|}

===Parameters list for Items===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Currency
| <CMTLBLDATA_FLDITMCOINID>
|-
| Created by User
| <CMTLBLDATA_FLDITMCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDITMDESC>
|-
| Expense Type
| <CMTLBLDATA_FLDITMEXPITEMTYPE>
|-
| Labor Type
| <CMTLBLDATA_FLDITMFEEITEMTYPE>
|-
| Item Code
| <CMTLBLDATA_FLDITMITEMNO>
|-
| Group
| <CMTLBLDATA_FLDITMITEMTYPEGROUP>
|-
| Name
| <CMTLBLDATA_FLDITMNAME>
|-
| Notes
| <CMTLBLDATA_FLDITMNOTES>
|-
| Price Source
| <CMTLBLDATA_FLDITMPRICESOURCE>
|-
| Product/Part Type
| <CMTLBLDATA_FLDITMPRODITEMTYPE>
|-
| Record Id
| <CMTLBLDATA_FLDITMRECID>
|-
| Cost
| <CMTLBLDATA_FLDITMSTANDARDCOST>
|-
| Suspend
| <CMTLBLDATA_FLDITMSUSPENDED>
|-
| Price
| <CMTLBLDATA_FLDITMUNITPRICE>
|-
| Update Date
| <CMTLBLDATA_FLDITMUPDATEDATE>
|-
| Update User
| <CMTLBLDATA_FLDITMUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDITMUSER1>
|}

===Parameters list for Opportunities===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Amount
| <CMTLBLDATA_FLDOPPAMOUNT>
|-
| Amount by Probability
| <CMTLBLDATA_FLDOPPCALCAMOUNT>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCARDID>
|-
| Closing amnt
| <CMTLBLDATA_FLDOPPCLOSEAMOUNT>
|-
| Close
| <CMTLBLDATA_FLDOPPCLOSEDATE>
|-
| Currency
| <CMTLBLDATA_FLDOPPCOINID>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCONTACTID>
|-
| Creation Date
| <CMTLBLDATA_FLDOPPCREATEDATE>
|-
| Created by User
| <CMTLBLDATA_FLDOPPCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDOPPDESCRIPTION>
|-
| Close By
| <CMTLBLDATA_FLDOPPESTDATE>
|-
| Oppty Type
| <CMTLBLDATA_FLDOPPKIND>
|-
| Opportunity
| <CMTLBLDATA_FLDOPPNAME>
|-
| Note
| <CMTLBLDATA_FLDOPPNOTES>
|-
| Open
| <CMTLBLDATA_FLDOPPOPENDATE>
|-
| Probability %
| <CMTLBLDATA_FLDOPPPROBABILITY>
|-
| Reason
| <CMTLBLDATA_FLDOPPREASON>
|-
| Record ID
| <CMTLBLDATA_FLDOPPRECID>
|-
| Record type
| <CMTLBLDATA_FLDOPPRECKIND>
|-
| Territory
| <CMTLBLDATA_FLDOPPREGION>
|-
| Source
| <CMTLBLDATA_FLDOPPSOURCE>
|-
| Stage
| <CMTLBLDATA_FLDOPPSTAGE>
|-
| Status
| <CMTLBLDATA_FLDOPPSTATUS>
|-
| Last Update Date
| <CMTLBLDATA_FLDOPPUPDATEDATE>
|-
| Last Update: By User
| <CMTLBLDATA_FLDOPPUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDOPPUSER1>
|-
| Field2
| <CMTLBLDATA_FLDOPPUSER2>
|-
| Field3
| <CMTLBLDATA_FLDOPPUSER3>
|-
| Opportunity ID
| <CMTLBLDATA_FLDOPPUSERID>
|-
| Manager
| <CMTLBLDATA_FLDOPPWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Asset ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTASSETRECID>
|-
| Contract ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTBCRECID>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCARDID>
|-
| Category
| <CMTLBLDATA_FLDTKTCATEGORY>
|-
| Cause
| <CMTLBLDATA_FLDTKTCAUSE>
|-
| Close Date
| <CMTLBLDATA_FLDTKTCLOSEDATETIME>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCONTACTID>
|-
| Creation: Date
| <CMTLBLDATA_FLDTKTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDTKTCREATEUSER_FLDWRKNICKNAME>
|-
| Due Date
| <CMTLBLDATA_FLDTKTDUEDATETIME>
|-
| Ticket Type
| <CMTLBLDATA_FLDTKTKIND>
|-
| Notes
| <CMTLBLDATA_FLDTKTNOTES>CMTLBLDATA
|-
| Open Date
| <CMTLBLDATA_FLDTKTOPENDATETIME>
|-
| Priority
| <CMTLBLDATA_FLDTKTPRIORITY>
|-
| Description
| <CMTLBLDATA_FLDTKTPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDTKTRECID>
|-
| Account's Region Code
| <CMTLBLDATA_FLDTKTREGIONCODE>
|-
| Estimated Duration Needed
| <CMTLBLDATA_FLDTKTSCHEDLENESTIM>
|-
| Resolution Description
| <CMTLBLDATA_FLDTKTSOLUTION>
|-
| Source
| <CMTLBLDATA_FLDTKTSOURCE>
|-
| Status
| <CMTLBLDATA_FLDTKTSTATUS>
|-
| Status: Ext.
| <CMTLBLDATA_FLDTKTSTATUSNOTE>
|-
| Ticket Number
| <CMTLBLDATA_FLDTKTTICKETNO>
|-
| Last Update Date
| <CMTLBLDATA_FLDTKTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDTKTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDTKTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDTKTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDTKTUSER3>
|-
| Manager
| <CMTLBLDATA_FLDTKTWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Category
| <CMTLBLDATA_FLDKBACATEGORY>
|-
| Create Date
| <CMTLBLDATA_FLDKBACREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDKBACREATEUSER_FLDWRKNICKNAME>
|-
| Public
| <CMTLBLDATA_FLDKBAISPUBLIC>
|-
| Problem
| <CMTLBLDATA_FLDKBAPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDKBARECID>
|-
| Solution
| <CMTLBLDATA_FLDKBASOLUTION>
|-
| Status
| <CMTLBLDATA_FLDKBASTATUS>
|-
| Title
| <CMTLBLDATA_FLDKBATITLE>
|-
| Last Update date
| <CMTLBLDATA_FLDKBAUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDKBAUPDATEUSER_FLDWRKNICKNAME>
|}

===Lookup Fields===
*Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket. This way you can define an Online Service for the Account, which will be activated from the Ticket window. Lookup Field syntax: <CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1> Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account FLDCRDADDRESS1 is the account's Address field

==See Also==
*[[Online Services FAQ]]

[[Category:Integration]]

Online Services

2009-08-20T13:52:03Z

Yarden: /* Displaying HP Warranties */

{{integration}}

Commit's '''Online Services''' is a powerful feature which allows you to link to web sites (URL) and activate the web application using parameters taken from CommitCRM.

You can define as many online Services as you wish. This feature is available for the following entities: Accounts, Tickets, Assets, Items, Contracts, Knowledge Base Articles and Oppotrunities.
*Accounts window
*Tickets window
*Dispatcher window
*Asset window
*Items window
*Contracts window
*Opportunities window

==What can I use Online Services for?==
Wouldn't you like your technicians to be able to find an address for a scheduled visit with just a single click? You can do this by defining an Online Service which will open maps site (e.g. Google Maps, Yahoo! Maps etc.) and the map will open automatically on the address of the Account or Contact stored in CommitCRM.

This powerful tool allows you to define any URL and open it with parameters. You can basically do with it whatever you want.

==Adding new Online Services==
To define a new Online Service, Open the Online Services Management window from Settings > Online Services. or click the Online Services icon from the Accounts window toolbar. Click the New button to add a new Online Service and enter the following parameters:

*'''Name''' - The name of the service which will be displayed in the Online Services list and menus throughout the system, for example, "Google Maps".
*'''Base URL''' - The URL you wish to open in order to use the Service. This is the address of the main service (before passing any parameters to it), for example http://maps.google.com/maps.
*'''URL Parameters''' - Parameters which will be appended to the URL in order to create specific queries when opening the URL. These parameters can be CommitCRM Account database fields which will be taken and filled from CommitCRM when clicking the Online Service.

See the Tips and Tricks for examples of useful Online Services

==Activating Online Services==
Online Services can be activated from various places in CommitCRM including:
*The '''Account, Ticket, Asset, Item, Opportunity, Contract, Knowledge Base Article windows''' - click the Online Services icon to activate the service for the selected account
*The '''Dispatcher Windows''' - right-click on a selected Ticket to run any Online Service for the Ticket's Account or Contact (such as displaying a map).
*The '''Calendar / Scheduled Appointments''' views - right-click above an Appointment and select Online Services.
*The '''secondary Contacts tab''' - select a Contact, right-click and select Online Services
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.
*'''Secondary Contact selection''' field - right-click and select Online Services.
*The '''Relations tab under Account''' - right-click and select Online Services.

==Possible Usage==
*'''Online Services and Assets''' – Access your MSP product online and pass the Asset ID to display its details from your external system
*'''Online Services and Items''' – Search for better prices for items by passing specific item information directly from within CommitCRM.
*'''Online Services for Assets''' – Search for a specific product review by its hardware serial number.
*'''Online Services for Tickets''' – Search in online knowledge bases for solutions based on the ticket description
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.

==Using Lookup Fields==
Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket.

This way you can define an Online Service for the Ticket, which will be activated from the Ticket window and will be using Account information.

Lookup Field syntax:

<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>

Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account
FLDCRDADDRESS1 is the account's Address field

==Tips & Tricks==
Following are examples of possible Online Services configurations.
These examples are intended to explain the use of Online Services only.

Disclaimer - Before defining your Online Services you should read the terms of use for each web site you want to access. The examples below are displayed to explain how to use online services and how to pass parameters.

===Displaying Online Maps===
'''Google Maps''' - Opens Google Maps and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Maps
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDCRDADDRESS1>+<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDSTATE>+<CMTLBLDATA_FLDCRDZIP>
|}

'''MapQuest''' - Opens MapQuest Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| MapQuest
|-
| Base URL
| <nowiki>http://www.mapquest.com/maps</nowiki>
|-
| URL Parameters
| /map.adp?searchtype=address&country=<CMTLBLDATA_FLDCRDCOUNTRY>&addtohistory=&searchtab=home&formtype=address&popflag=0&latitude=&longitude=&name=&phone=&level=&cat=&address=&city=<CMTLBLDATA_FLDCRDCITY>&state=<CMTLBLDATA_FLDCRDSTATE>&zipcode=<CMTLBLDATA_FLDCRDZIP>
|}

'''Yahoo! Maps''' - Opens Yahoo! Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Yahoo! Maps
|-
| Base URL
| <nowiki>http://maps.yahoo.com</nowiki>
|-
| URL Parameters
| /maps_result?addr=<CMTLBLDATA_FLDCRDADDRESS1>&csz=<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDCOUNTRY>&country=<CMTLBLDATA_FLDCRDSTATE>
|}

===Finding Account Information===
'''Google Company''' - Opens Google and searches for the Account Company Name.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Company
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCOMPANY>
|}

'''Google Contact''' - Opens Google and searches for the Contact Name.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Contact
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCONTACT>
|}

===Finding Ticket Description in Google===
'''Google Ticket''' - Opens Google and searches for the Ticket description.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket Description
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDTKTPROBLEM>
|}

===Finding Account Address From Ticket (using [[Commit Online Services#Using Lookup Fields|Lookup Field]]) ===
'''Google Address From Ticket''' - Opens Google and searches for the Address of the Account which is linked to the Ticket.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDCITY>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDSTATE>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDZIP>
|}

===Displaying Products Warranties Online===
'''Contributed by Easy I.T'''

'''HP Warranty Lookup''' - Displays HP products warranty expiration dates, using the products number and the products serial number.

Note: Product Number goes into Plate# field (<CMTLBLDATA_FLDASTUSER1>).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| HP Warranty Lookup
|-
| Base URL
| <nowiki>http://h20000.www2.hp.com/bizsupport/TechSupport/WarrantyResults.jsp?</nowiki>
|-
| URL Parameters
| lang=en&cc=us&prodSeriesId=454811&prodTypeId=12454&sn=<CMTLBLDATA_FLDASTSERIALNO>&pn=<CMTLBLDATA_FLDASTUSER1>&country=US&nickname=&find=Display+Warranty+Information+%C2%BB
|}

===Displaying Domain WHOIS===

'''Domain WHOIS''' - WHOIS domain registration information by Domain Tools.

Note: Domain must be stripped from URL (without http://).

'''Contributed by DavidW'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (NetworkSolutions)
|-
| Base URL
| <nowiki>http://www.networksolutions.com/whois-search/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''Domain WHOIS''' - WHOIS domain registration information by Network Solutions.

Note: Domain must be stripped from URL (without http://).

'''Contributed by ajgyomber'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DomainTools)
|-
| Base URL
| <nowiki>http://whois.domaintools.com/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

==Parameters list==

===Parameters List for Accounts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account Number
| <CMTLBLDATA_FLDCRDCARDID2>
|-
| Address: City
| <CMTLBLDATA_FLDCRDCITY>
|-
| Address: Country
| <CMTLBLDATA_FLDCRDCOUNTRY>
|-
| Address: Line1
| <CMTLBLDATA_FLDCRDADDRESS1>
|-
| Address: Line2
| <CMTLBLDATA_FLDCRDADDRESS2>
|-
| Address: Line3
| <CMTLBLDATA_FLDCRDADDRESS3>
|-
| Address: State
| <CMTLBLDATA_FLDCRDSTATE>
|-
| Address: ZIP Code
| <CMTLBLDATA_FLDCRDZIP>
|-
| Assistant
| <CMTLBLDATA_FLDCRDASSISTANT>
|-
| Birthday
| <CMTLBLDATA_FLDCRDBIRTHDAY>
|-
| Company name
| <CMTLBLDATA_FLDCRDCOMPANY>
|-
| Contact: First & Last Name
| <CMTLBLDATA_FLDCRDCONTACT>
|-
| Dear
| <CMTLBLDATA_FLDCRDDEAR>
|-
| Department
| <CMTLBLDATA_FLDCRDDEPARTMENT>
|-
| E-Mail Address 1
| <CMTLBLDATA_FLDCRDEMAIL1>
|-
| E-Mail Address 2
| <CMTLBLDATA_FLDCRDEMAIL2>
|-
| Fax Number
| <CMTLBLDATA_FLDCRDFAX1>
|-
| Fax Number Extention
| <CMTLBLDATA_FLDCRDFAXDESC1>
|-
| Field
| <CMTLBLDATA_FLDCRDPERSONID>
|-
| Field1
| <CMTLBLDATA_FLDCRDUSER2>
|-
| Field2
| <CMTLBLDATA_FLDCRDUSER3>
|-
| Field3
| <CMTLBLDATA_FLDCRDUSER4>
|-
| Field4
| <CMTLBLDATA_FLDCRDUSER5>
|-
| Field5
| <CMTLBLDATA_FLDCRDCOMPANYNO>
|-
| File as
| <CMTLBLDATA_FLDCRDFULLNAME>
|-
| ID
| <CMTLBLDATA_FLDCRDCARDID3>
|-
| Last Name
| <CMTLBLDATA_FLDCRDLASTNAME>
|-
| Phone 1
| <CMTLBLDATA_FLDCRDPHONE1>
|-
| Phone 1 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC1>
|-
| Phone 2
| <CMTLBLDATA_FLDCRDPHONE2>
|-
| Phone 2 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC2>
|-
| Phone 3
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Phone 3 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC3>
|-
| Phone 4
| <CMTLBLDATA_FLDCRDPHONE4>
|-
| Phone 4 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC4>
|-
| Popup Message
| <CMTLBLDATA_FLDCRDCARDMESSAGE>
|-
| Region
| <CMTLBLDATA_FLDCRDREGIONCODE>
|-
| Salutation
| <CMTLBLDATA_FLDCRDSUFFIX>
|-
| Status
| <CMTLBLDATA_FLDCRDUSER1>
|-
| Sub-Contact Code
| <CMTLBLDATA_FLDCRDSUBCODE>
|-
| Title
| <CMTLBLDATA_FLDCRDTITLE>
|-
| Type
| <CMTLBLDATA_FLDCRDKIND>
|-
| Web Address 1
| <CMTLBLDATA_FLDCRDURL1>
|-
| Web Address 2
| <CMTLBLDATA_FLDCRDURL2>
|}

===Parameters list for Assets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTACCRECID>
|-
| Asset Code
| <CMTLBLDATA_FLDASTASSETCODE>
|-
| Asset Type
| <CMTLBLDATA_FLDASTASSETTYPE>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTCONTACTRECID>
|-
| Create Date
| <CMTLBLDATA_FLDASTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDASTCREATEUSER_FLDWRKNICKNAME>
|-
| Purchase Date
| <CMTLBLDATA_FLDASTCUSTPURDATE>
|-
| Purchased From Us
| <CMTLBLDATA_FLDASTCUSTPURFROMUS>
|-
| Purchase Our Invoice #
| <CMTLBLDATA_FLDASTCUSTPUROURINV>
|-
| Customer PO
| <CMTLBLDATA_FLDASTCUSTPURPO>
|-
| Purchase Price
| <CMTLBLDATA_FLDASTCUSTPURPRICE>
|-
| Delivered Date
| <CMTLBLDATA_FLDASTDELIVEDATE>
|-
| Description
| <CMTLBLDATA_FLDASTDESC>
|-
| Installed By
| <CMTLBLDATA_FLDASTINSTALBY_FLDWRKNICKNAME>
|-
| Installed Date
| <CMTLBLDATA_FLDASTINSTALDATE>
|-
| License Codes
| <CMTLBLDATA_FLDASTLICENSECODE>
|-
| License Keys
| <CMTLBLDATA_FLDASTLICENSEKEYS>
|-
| License Notes
| <CMTLBLDATA_FLDASTLICENSENOTES>
|-
| Location
| <CMTLBLDATA_FLDASTLOCATION>
|-
| Manufacturer
| <CMTLBLDATA_FLDASTMANUFACTURER>
|-
| Manufacturer Serial No.
| <CMTLBLDATA_FLDASTMNFSERIALNO>
|-
| Model
| <CMTLBLDATA_FLDASTMODEL>
|-
| Asset Name
| <CMTLBLDATA_FLDASTNAME>
|-
| Notes
| <CMTLBLDATA_FLDASTNOTES>
|-
| PARENTASSETRECID
| <CMTLBLDATA_FLDASTPARENTRECID>
|-
| Quantity
| <CMTLBLDATA_FLDASTQUANTITY>
|-
| Record ID
| <CMTLBLDATA_FLDASTRECID>
|-
| Serial No.
| <CMTLBLDATA_FLDASTSERIALNO>
|-
| Status
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Last Update date
| <CMTLBLDATA_FLDASTUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDASTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDASTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDASTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDASTUSER3>
|-
| Field4
| <CMTLBLDATA_FLDASTUSER4>
|-
| Field5
| <CMTLBLDATA_FLDASTUSER5>
|-
| Date1
| <CMTLBLDATA_FLDASTUSERDATE1>
|-
| Number1
| <CMTLBLDATA_FLDASTUSERNUMBER1>
|-
| Vendor Purchased Date
| <CMTLBLDATA_FLDASTVENDORDATEPURC>
|-
| Vendor Invoice #
| <CMTLBLDATA_FLDASTVENDORINVNO>
|-
| Vendor Name
| <CMTLBLDATA_FLDASTVENDORNAME>
|-
| Vendor PO
| <CMTLBLDATA_FLDASTVENDOROURPO>
|-
| Vendor Price
| <CMTLBLDATA_FLDASTVENDORPRICE>
|-
| Vendor
| <CMTLBLDATA_FLDASTVENDORRECID>
|-
| Vendor Serial No.
| <CMTLBLDATA_FLDASTVENDORSERNO>
|-
| Vendor Warranty Exp. Date
| <CMTLBLDATA_FLDASTVENDORWARREXP>
|-
| Version
| <CMTLBLDATA_FLDASTVERSION>
|-
| Warranty/License Exp. Date
| <CMTLBLDATA_FLDASTWARREXPDATE>FLDASTWARREXPDATE
|}

===Parameters list for Contracts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTACCRECID>
|-
| Block - Used
| <CMTLBLDATA_FLDBCTAMOUNTUSED>
|-
| Code
| <CMTLBLDATA_FLDBCTCODE>
|-
| Contract Type Type
| <CMTLBLDATA_FLDBCTCONTRACTTYPE>
|-
| Create Date
| <CMTLBLDATA_FLDBCTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDBCTCREATEUSER_FLDWRKNICKNAME>
|-
| Default Item Expense ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMEXPNS>
|-
| Default Item Labor ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMLABOR>
|-
| Default Item Part ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMPART>
|-
| Description
| <CMTLBLDATA_FLDBCTDESCEXTERNAL>
|-
| Internal Description
| <CMTLBLDATA_FLDBCTDESCINTERNAL>
|-
| End Date
| <CMTLBLDATA_FLDBCTENDDATE>
|-
| Name
| <CMTLBLDATA_FLDBCTNAME>
|-
| Note
| <CMTLBLDATA_FLDBCTNOTE>
|-
| Record ID
| <CMTLBLDATA_FLDBCTRECID>
|-
| Start Date
| <CMTLBLDATA_FLDBCTSTARTDATE>
|-
| Status
| <CMTLBLDATA_FLDBCTSTATUS>
|-
| Last Update date
| <CMTLBLDATA_FLDBCTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDBCTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field 1
| <CMTLBLDATA_FLDBCTUSER1>
|-
| Field 2
| <CMTLBLDATA_FLDBCTUSER2>
|-
| Field 3
| <CMTLBLDATA_FLDBCTUSER3>
|}

===Parameters list for Items===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Currency
| <CMTLBLDATA_FLDITMCOINID>
|-
| Created by User
| <CMTLBLDATA_FLDITMCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDITMDESC>
|-
| Expense Type
| <CMTLBLDATA_FLDITMEXPITEMTYPE>
|-
| Labor Type
| <CMTLBLDATA_FLDITMFEEITEMTYPE>
|-
| Item Code
| <CMTLBLDATA_FLDITMITEMNO>
|-
| Group
| <CMTLBLDATA_FLDITMITEMTYPEGROUP>
|-
| Name
| <CMTLBLDATA_FLDITMNAME>
|-
| Notes
| <CMTLBLDATA_FLDITMNOTES>
|-
| Price Source
| <CMTLBLDATA_FLDITMPRICESOURCE>
|-
| Product/Part Type
| <CMTLBLDATA_FLDITMPRODITEMTYPE>
|-
| Record Id
| <CMTLBLDATA_FLDITMRECID>
|-
| Cost
| <CMTLBLDATA_FLDITMSTANDARDCOST>
|-
| Suspend
| <CMTLBLDATA_FLDITMSUSPENDED>
|-
| Price
| <CMTLBLDATA_FLDITMUNITPRICE>
|-
| Update Date
| <CMTLBLDATA_FLDITMUPDATEDATE>
|-
| Update User
| <CMTLBLDATA_FLDITMUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDITMUSER1>
|}

===Parameters list for Opportunities===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Amount
| <CMTLBLDATA_FLDOPPAMOUNT>
|-
| Amount by Probability
| <CMTLBLDATA_FLDOPPCALCAMOUNT>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCARDID>
|-
| Closing amnt
| <CMTLBLDATA_FLDOPPCLOSEAMOUNT>
|-
| Close
| <CMTLBLDATA_FLDOPPCLOSEDATE>
|-
| Currency
| <CMTLBLDATA_FLDOPPCOINID>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCONTACTID>
|-
| Creation Date
| <CMTLBLDATA_FLDOPPCREATEDATE>
|-
| Created by User
| <CMTLBLDATA_FLDOPPCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDOPPDESCRIPTION>
|-
| Close By
| <CMTLBLDATA_FLDOPPESTDATE>
|-
| Oppty Type
| <CMTLBLDATA_FLDOPPKIND>
|-
| Opportunity
| <CMTLBLDATA_FLDOPPNAME>
|-
| Note
| <CMTLBLDATA_FLDOPPNOTES>
|-
| Open
| <CMTLBLDATA_FLDOPPOPENDATE>
|-
| Probability %
| <CMTLBLDATA_FLDOPPPROBABILITY>
|-
| Reason
| <CMTLBLDATA_FLDOPPREASON>
|-
| Record ID
| <CMTLBLDATA_FLDOPPRECID>
|-
| Record type
| <CMTLBLDATA_FLDOPPRECKIND>
|-
| Territory
| <CMTLBLDATA_FLDOPPREGION>
|-
| Source
| <CMTLBLDATA_FLDOPPSOURCE>
|-
| Stage
| <CMTLBLDATA_FLDOPPSTAGE>
|-
| Status
| <CMTLBLDATA_FLDOPPSTATUS>
|-
| Last Update Date
| <CMTLBLDATA_FLDOPPUPDATEDATE>
|-
| Last Update: By User
| <CMTLBLDATA_FLDOPPUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDOPPUSER1>
|-
| Field2
| <CMTLBLDATA_FLDOPPUSER2>
|-
| Field3
| <CMTLBLDATA_FLDOPPUSER3>
|-
| Opportunity ID
| <CMTLBLDATA_FLDOPPUSERID>
|-
| Manager
| <CMTLBLDATA_FLDOPPWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Asset ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTASSETRECID>
|-
| Contract ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTBCRECID>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCARDID>
|-
| Category
| <CMTLBLDATA_FLDTKTCATEGORY>
|-
| Cause
| <CMTLBLDATA_FLDTKTCAUSE>
|-
| Close Date
| <CMTLBLDATA_FLDTKTCLOSEDATETIME>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCONTACTID>
|-
| Creation: Date
| <CMTLBLDATA_FLDTKTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDTKTCREATEUSER_FLDWRKNICKNAME>
|-
| Due Date
| <CMTLBLDATA_FLDTKTDUEDATETIME>
|-
| Ticket Type
| <CMTLBLDATA_FLDTKTKIND>
|-
| Notes
| <CMTLBLDATA_FLDTKTNOTES>CMTLBLDATA
|-
| Open Date
| <CMTLBLDATA_FLDTKTOPENDATETIME>
|-
| Priority
| <CMTLBLDATA_FLDTKTPRIORITY>
|-
| Description
| <CMTLBLDATA_FLDTKTPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDTKTRECID>
|-
| Account's Region Code
| <CMTLBLDATA_FLDTKTREGIONCODE>
|-
| Estimated Duration Needed
| <CMTLBLDATA_FLDTKTSCHEDLENESTIM>
|-
| Resolution Description
| <CMTLBLDATA_FLDTKTSOLUTION>
|-
| Source
| <CMTLBLDATA_FLDTKTSOURCE>
|-
| Status
| <CMTLBLDATA_FLDTKTSTATUS>
|-
| Status: Ext.
| <CMTLBLDATA_FLDTKTSTATUSNOTE>
|-
| Ticket Number
| <CMTLBLDATA_FLDTKTTICKETNO>
|-
| Last Update Date
| <CMTLBLDATA_FLDTKTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDTKTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDTKTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDTKTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDTKTUSER3>
|-
| Manager
| <CMTLBLDATA_FLDTKTWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Category
| <CMTLBLDATA_FLDKBACATEGORY>
|-
| Create Date
| <CMTLBLDATA_FLDKBACREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDKBACREATEUSER_FLDWRKNICKNAME>
|-
| Public
| <CMTLBLDATA_FLDKBAISPUBLIC>
|-
| Problem
| <CMTLBLDATA_FLDKBAPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDKBARECID>
|-
| Solution
| <CMTLBLDATA_FLDKBASOLUTION>
|-
| Status
| <CMTLBLDATA_FLDKBASTATUS>
|-
| Title
| <CMTLBLDATA_FLDKBATITLE>
|-
| Last Update date
| <CMTLBLDATA_FLDKBAUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDKBAUPDATEUSER_FLDWRKNICKNAME>
|}

===Lookup Fields===
*Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket. This way you can define an Online Service for the Account, which will be activated from the Ticket window. Lookup Field syntax: <CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1> Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account FLDCRDADDRESS1 is the account's Address field

==See Also==
*[[Online Services FAQ]]

[[Category:Integration]]

Online Services

2009-08-20T13:51:01Z

Yarden: /* Displaying Domain WHOIS */

{{integration}}

Commit's '''Online Services''' is a powerful feature which allows you to link to web sites (URL) and activate the web application using parameters taken from CommitCRM.

You can define as many online Services as you wish. This feature is available for the following entities: Accounts, Tickets, Assets, Items, Contracts, Knowledge Base Articles and Oppotrunities.
*Accounts window
*Tickets window
*Dispatcher window
*Asset window
*Items window
*Contracts window
*Opportunities window

==What can I use Online Services for?==
Wouldn't you like your technicians to be able to find an address for a scheduled visit with just a single click? You can do this by defining an Online Service which will open maps site (e.g. Google Maps, Yahoo! Maps etc.) and the map will open automatically on the address of the Account or Contact stored in CommitCRM.

This powerful tool allows you to define any URL and open it with parameters. You can basically do with it whatever you want.

==Adding new Online Services==
To define a new Online Service, Open the Online Services Management window from Settings > Online Services. or click the Online Services icon from the Accounts window toolbar. Click the New button to add a new Online Service and enter the following parameters:

*'''Name''' - The name of the service which will be displayed in the Online Services list and menus throughout the system, for example, "Google Maps".
*'''Base URL''' - The URL you wish to open in order to use the Service. This is the address of the main service (before passing any parameters to it), for example http://maps.google.com/maps.
*'''URL Parameters''' - Parameters which will be appended to the URL in order to create specific queries when opening the URL. These parameters can be CommitCRM Account database fields which will be taken and filled from CommitCRM when clicking the Online Service.

See the Tips and Tricks for examples of useful Online Services

==Activating Online Services==
Online Services can be activated from various places in CommitCRM including:
*The '''Account, Ticket, Asset, Item, Opportunity, Contract, Knowledge Base Article windows''' - click the Online Services icon to activate the service for the selected account
*The '''Dispatcher Windows''' - right-click on a selected Ticket to run any Online Service for the Ticket's Account or Contact (such as displaying a map).
*The '''Calendar / Scheduled Appointments''' views - right-click above an Appointment and select Online Services.
*The '''secondary Contacts tab''' - select a Contact, right-click and select Online Services
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.
*'''Secondary Contact selection''' field - right-click and select Online Services.
*The '''Relations tab under Account''' - right-click and select Online Services.

==Possible Usage==
*'''Online Services and Assets''' – Access your MSP product online and pass the Asset ID to display its details from your external system
*'''Online Services and Items''' – Search for better prices for items by passing specific item information directly from within CommitCRM.
*'''Online Services for Assets''' – Search for a specific product review by its hardware serial number.
*'''Online Services for Tickets''' – Search in online knowledge bases for solutions based on the ticket description
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.

==Using Lookup Fields==
Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket.

This way you can define an Online Service for the Ticket, which will be activated from the Ticket window and will be using Account information.

Lookup Field syntax:

<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>

Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account
FLDCRDADDRESS1 is the account's Address field

==Tips & Tricks==
Following are examples of possible Online Services configurations.
These examples are intended to explain the use of Online Services only.

Disclaimer - Before defining your Online Services you should read the terms of use for each web site you want to access. The examples below are displayed to explain how to use online services and how to pass parameters.

===Displaying Online Maps===
'''Google Maps''' - Opens Google Maps and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Maps
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDCRDADDRESS1>+<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDSTATE>+<CMTLBLDATA_FLDCRDZIP>
|}

'''MapQuest''' - Opens MapQuest Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| MapQuest
|-
| Base URL
| <nowiki>http://www.mapquest.com/maps</nowiki>
|-
| URL Parameters
| /map.adp?searchtype=address&country=<CMTLBLDATA_FLDCRDCOUNTRY>&addtohistory=&searchtab=home&formtype=address&popflag=0&latitude=&longitude=&name=&phone=&level=&cat=&address=&city=<CMTLBLDATA_FLDCRDCITY>&state=<CMTLBLDATA_FLDCRDSTATE>&zipcode=<CMTLBLDATA_FLDCRDZIP>
|}

'''Yahoo! Maps''' - Opens Yahoo! Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Yahoo! Maps
|-
| Base URL
| <nowiki>http://maps.yahoo.com</nowiki>
|-
| URL Parameters
| /maps_result?addr=<CMTLBLDATA_FLDCRDADDRESS1>&csz=<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDCOUNTRY>&country=<CMTLBLDATA_FLDCRDSTATE>
|}

===Finding Account Information===
'''Google Company''' - Opens Google and searches for the Account Company Name.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Company
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCOMPANY>
|}

'''Google Contact''' - Opens Google and searches for the Contact Name.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Contact
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCONTACT>
|}

===Finding Ticket Description in Google===
'''Google Ticket''' - Opens Google and searches for the Ticket description.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket Description
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDTKTPROBLEM>
|}

===Finding Account Address From Ticket (using [[Commit Online Services#Using Lookup Fields|Lookup Field]]) ===
'''Google Address From Ticket''' - Opens Google and searches for the Address of the Account which is linked to the Ticket.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDCITY>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDSTATE>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDZIP>
|}

===Displaying HP Warranties===
'''Contributed by Easy I.T'''

'''HP Warranty Lookup''' - Displays HP products warranty expiration dates, using the products number and the products serial number.

Note: Product Number goes into Plate# field (<CMTLBLDATA_FLDASTUSER1>).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| HP Warranty Lookup
|-
| Base URL
| <nowiki>http://h20000.www2.hp.com/bizsupport/TechSupport/WarrantyResults.jsp?</nowiki>
|-
| URL Parameters
| lang=en&cc=us&prodSeriesId=454811&prodTypeId=12454&sn=<CMTLBLDATA_FLDASTSERIALNO>&pn=<CMTLBLDATA_FLDASTUSER1>&country=US&nickname=&find=Display+Warranty+Information+%C2%BB
|}

===Displaying Domain WHOIS===

'''Domain WHOIS''' - WHOIS domain registration information by Domain Tools.

Note: Domain must be stripped from URL (without http://).

'''Contributed by DavidW'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (NetworkSolutions)
|-
| Base URL
| <nowiki>http://www.networksolutions.com/whois-search/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''Domain WHOIS''' - WHOIS domain registration information by Network Solutions.

Note: Domain must be stripped from URL (without http://).

'''Contributed by ajgyomber'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DomainTools)
|-
| Base URL
| <nowiki>http://whois.domaintools.com/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

==Parameters list==

===Parameters List for Accounts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account Number
| <CMTLBLDATA_FLDCRDCARDID2>
|-
| Address: City
| <CMTLBLDATA_FLDCRDCITY>
|-
| Address: Country
| <CMTLBLDATA_FLDCRDCOUNTRY>
|-
| Address: Line1
| <CMTLBLDATA_FLDCRDADDRESS1>
|-
| Address: Line2
| <CMTLBLDATA_FLDCRDADDRESS2>
|-
| Address: Line3
| <CMTLBLDATA_FLDCRDADDRESS3>
|-
| Address: State
| <CMTLBLDATA_FLDCRDSTATE>
|-
| Address: ZIP Code
| <CMTLBLDATA_FLDCRDZIP>
|-
| Assistant
| <CMTLBLDATA_FLDCRDASSISTANT>
|-
| Birthday
| <CMTLBLDATA_FLDCRDBIRTHDAY>
|-
| Company name
| <CMTLBLDATA_FLDCRDCOMPANY>
|-
| Contact: First & Last Name
| <CMTLBLDATA_FLDCRDCONTACT>
|-
| Dear
| <CMTLBLDATA_FLDCRDDEAR>
|-
| Department
| <CMTLBLDATA_FLDCRDDEPARTMENT>
|-
| E-Mail Address 1
| <CMTLBLDATA_FLDCRDEMAIL1>
|-
| E-Mail Address 2
| <CMTLBLDATA_FLDCRDEMAIL2>
|-
| Fax Number
| <CMTLBLDATA_FLDCRDFAX1>
|-
| Fax Number Extention
| <CMTLBLDATA_FLDCRDFAXDESC1>
|-
| Field
| <CMTLBLDATA_FLDCRDPERSONID>
|-
| Field1
| <CMTLBLDATA_FLDCRDUSER2>
|-
| Field2
| <CMTLBLDATA_FLDCRDUSER3>
|-
| Field3
| <CMTLBLDATA_FLDCRDUSER4>
|-
| Field4
| <CMTLBLDATA_FLDCRDUSER5>
|-
| Field5
| <CMTLBLDATA_FLDCRDCOMPANYNO>
|-
| File as
| <CMTLBLDATA_FLDCRDFULLNAME>
|-
| ID
| <CMTLBLDATA_FLDCRDCARDID3>
|-
| Last Name
| <CMTLBLDATA_FLDCRDLASTNAME>
|-
| Phone 1
| <CMTLBLDATA_FLDCRDPHONE1>
|-
| Phone 1 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC1>
|-
| Phone 2
| <CMTLBLDATA_FLDCRDPHONE2>
|-
| Phone 2 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC2>
|-
| Phone 3
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Phone 3 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC3>
|-
| Phone 4
| <CMTLBLDATA_FLDCRDPHONE4>
|-
| Phone 4 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC4>
|-
| Popup Message
| <CMTLBLDATA_FLDCRDCARDMESSAGE>
|-
| Region
| <CMTLBLDATA_FLDCRDREGIONCODE>
|-
| Salutation
| <CMTLBLDATA_FLDCRDSUFFIX>
|-
| Status
| <CMTLBLDATA_FLDCRDUSER1>
|-
| Sub-Contact Code
| <CMTLBLDATA_FLDCRDSUBCODE>
|-
| Title
| <CMTLBLDATA_FLDCRDTITLE>
|-
| Type
| <CMTLBLDATA_FLDCRDKIND>
|-
| Web Address 1
| <CMTLBLDATA_FLDCRDURL1>
|-
| Web Address 2
| <CMTLBLDATA_FLDCRDURL2>
|}

===Parameters list for Assets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTACCRECID>
|-
| Asset Code
| <CMTLBLDATA_FLDASTASSETCODE>
|-
| Asset Type
| <CMTLBLDATA_FLDASTASSETTYPE>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTCONTACTRECID>
|-
| Create Date
| <CMTLBLDATA_FLDASTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDASTCREATEUSER_FLDWRKNICKNAME>
|-
| Purchase Date
| <CMTLBLDATA_FLDASTCUSTPURDATE>
|-
| Purchased From Us
| <CMTLBLDATA_FLDASTCUSTPURFROMUS>
|-
| Purchase Our Invoice #
| <CMTLBLDATA_FLDASTCUSTPUROURINV>
|-
| Customer PO
| <CMTLBLDATA_FLDASTCUSTPURPO>
|-
| Purchase Price
| <CMTLBLDATA_FLDASTCUSTPURPRICE>
|-
| Delivered Date
| <CMTLBLDATA_FLDASTDELIVEDATE>
|-
| Description
| <CMTLBLDATA_FLDASTDESC>
|-
| Installed By
| <CMTLBLDATA_FLDASTINSTALBY_FLDWRKNICKNAME>
|-
| Installed Date
| <CMTLBLDATA_FLDASTINSTALDATE>
|-
| License Codes
| <CMTLBLDATA_FLDASTLICENSECODE>
|-
| License Keys
| <CMTLBLDATA_FLDASTLICENSEKEYS>
|-
| License Notes
| <CMTLBLDATA_FLDASTLICENSENOTES>
|-
| Location
| <CMTLBLDATA_FLDASTLOCATION>
|-
| Manufacturer
| <CMTLBLDATA_FLDASTMANUFACTURER>
|-
| Manufacturer Serial No.
| <CMTLBLDATA_FLDASTMNFSERIALNO>
|-
| Model
| <CMTLBLDATA_FLDASTMODEL>
|-
| Asset Name
| <CMTLBLDATA_FLDASTNAME>
|-
| Notes
| <CMTLBLDATA_FLDASTNOTES>
|-
| PARENTASSETRECID
| <CMTLBLDATA_FLDASTPARENTRECID>
|-
| Quantity
| <CMTLBLDATA_FLDASTQUANTITY>
|-
| Record ID
| <CMTLBLDATA_FLDASTRECID>
|-
| Serial No.
| <CMTLBLDATA_FLDASTSERIALNO>
|-
| Status
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Last Update date
| <CMTLBLDATA_FLDASTUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDASTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDASTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDASTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDASTUSER3>
|-
| Field4
| <CMTLBLDATA_FLDASTUSER4>
|-
| Field5
| <CMTLBLDATA_FLDASTUSER5>
|-
| Date1
| <CMTLBLDATA_FLDASTUSERDATE1>
|-
| Number1
| <CMTLBLDATA_FLDASTUSERNUMBER1>
|-
| Vendor Purchased Date
| <CMTLBLDATA_FLDASTVENDORDATEPURC>
|-
| Vendor Invoice #
| <CMTLBLDATA_FLDASTVENDORINVNO>
|-
| Vendor Name
| <CMTLBLDATA_FLDASTVENDORNAME>
|-
| Vendor PO
| <CMTLBLDATA_FLDASTVENDOROURPO>
|-
| Vendor Price
| <CMTLBLDATA_FLDASTVENDORPRICE>
|-
| Vendor
| <CMTLBLDATA_FLDASTVENDORRECID>
|-
| Vendor Serial No.
| <CMTLBLDATA_FLDASTVENDORSERNO>
|-
| Vendor Warranty Exp. Date
| <CMTLBLDATA_FLDASTVENDORWARREXP>
|-
| Version
| <CMTLBLDATA_FLDASTVERSION>
|-
| Warranty/License Exp. Date
| <CMTLBLDATA_FLDASTWARREXPDATE>FLDASTWARREXPDATE
|}

===Parameters list for Contracts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTACCRECID>
|-
| Block - Used
| <CMTLBLDATA_FLDBCTAMOUNTUSED>
|-
| Code
| <CMTLBLDATA_FLDBCTCODE>
|-
| Contract Type Type
| <CMTLBLDATA_FLDBCTCONTRACTTYPE>
|-
| Create Date
| <CMTLBLDATA_FLDBCTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDBCTCREATEUSER_FLDWRKNICKNAME>
|-
| Default Item Expense ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMEXPNS>
|-
| Default Item Labor ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMLABOR>
|-
| Default Item Part ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMPART>
|-
| Description
| <CMTLBLDATA_FLDBCTDESCEXTERNAL>
|-
| Internal Description
| <CMTLBLDATA_FLDBCTDESCINTERNAL>
|-
| End Date
| <CMTLBLDATA_FLDBCTENDDATE>
|-
| Name
| <CMTLBLDATA_FLDBCTNAME>
|-
| Note
| <CMTLBLDATA_FLDBCTNOTE>
|-
| Record ID
| <CMTLBLDATA_FLDBCTRECID>
|-
| Start Date
| <CMTLBLDATA_FLDBCTSTARTDATE>
|-
| Status
| <CMTLBLDATA_FLDBCTSTATUS>
|-
| Last Update date
| <CMTLBLDATA_FLDBCTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDBCTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field 1
| <CMTLBLDATA_FLDBCTUSER1>
|-
| Field 2
| <CMTLBLDATA_FLDBCTUSER2>
|-
| Field 3
| <CMTLBLDATA_FLDBCTUSER3>
|}

===Parameters list for Items===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Currency
| <CMTLBLDATA_FLDITMCOINID>
|-
| Created by User
| <CMTLBLDATA_FLDITMCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDITMDESC>
|-
| Expense Type
| <CMTLBLDATA_FLDITMEXPITEMTYPE>
|-
| Labor Type
| <CMTLBLDATA_FLDITMFEEITEMTYPE>
|-
| Item Code
| <CMTLBLDATA_FLDITMITEMNO>
|-
| Group
| <CMTLBLDATA_FLDITMITEMTYPEGROUP>
|-
| Name
| <CMTLBLDATA_FLDITMNAME>
|-
| Notes
| <CMTLBLDATA_FLDITMNOTES>
|-
| Price Source
| <CMTLBLDATA_FLDITMPRICESOURCE>
|-
| Product/Part Type
| <CMTLBLDATA_FLDITMPRODITEMTYPE>
|-
| Record Id
| <CMTLBLDATA_FLDITMRECID>
|-
| Cost
| <CMTLBLDATA_FLDITMSTANDARDCOST>
|-
| Suspend
| <CMTLBLDATA_FLDITMSUSPENDED>
|-
| Price
| <CMTLBLDATA_FLDITMUNITPRICE>
|-
| Update Date
| <CMTLBLDATA_FLDITMUPDATEDATE>
|-
| Update User
| <CMTLBLDATA_FLDITMUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDITMUSER1>
|}

===Parameters list for Opportunities===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Amount
| <CMTLBLDATA_FLDOPPAMOUNT>
|-
| Amount by Probability
| <CMTLBLDATA_FLDOPPCALCAMOUNT>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCARDID>
|-
| Closing amnt
| <CMTLBLDATA_FLDOPPCLOSEAMOUNT>
|-
| Close
| <CMTLBLDATA_FLDOPPCLOSEDATE>
|-
| Currency
| <CMTLBLDATA_FLDOPPCOINID>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCONTACTID>
|-
| Creation Date
| <CMTLBLDATA_FLDOPPCREATEDATE>
|-
| Created by User
| <CMTLBLDATA_FLDOPPCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDOPPDESCRIPTION>
|-
| Close By
| <CMTLBLDATA_FLDOPPESTDATE>
|-
| Oppty Type
| <CMTLBLDATA_FLDOPPKIND>
|-
| Opportunity
| <CMTLBLDATA_FLDOPPNAME>
|-
| Note
| <CMTLBLDATA_FLDOPPNOTES>
|-
| Open
| <CMTLBLDATA_FLDOPPOPENDATE>
|-
| Probability %
| <CMTLBLDATA_FLDOPPPROBABILITY>
|-
| Reason
| <CMTLBLDATA_FLDOPPREASON>
|-
| Record ID
| <CMTLBLDATA_FLDOPPRECID>
|-
| Record type
| <CMTLBLDATA_FLDOPPRECKIND>
|-
| Territory
| <CMTLBLDATA_FLDOPPREGION>
|-
| Source
| <CMTLBLDATA_FLDOPPSOURCE>
|-
| Stage
| <CMTLBLDATA_FLDOPPSTAGE>
|-
| Status
| <CMTLBLDATA_FLDOPPSTATUS>
|-
| Last Update Date
| <CMTLBLDATA_FLDOPPUPDATEDATE>
|-
| Last Update: By User
| <CMTLBLDATA_FLDOPPUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDOPPUSER1>
|-
| Field2
| <CMTLBLDATA_FLDOPPUSER2>
|-
| Field3
| <CMTLBLDATA_FLDOPPUSER3>
|-
| Opportunity ID
| <CMTLBLDATA_FLDOPPUSERID>
|-
| Manager
| <CMTLBLDATA_FLDOPPWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Asset ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTASSETRECID>
|-
| Contract ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTBCRECID>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCARDID>
|-
| Category
| <CMTLBLDATA_FLDTKTCATEGORY>
|-
| Cause
| <CMTLBLDATA_FLDTKTCAUSE>
|-
| Close Date
| <CMTLBLDATA_FLDTKTCLOSEDATETIME>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCONTACTID>
|-
| Creation: Date
| <CMTLBLDATA_FLDTKTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDTKTCREATEUSER_FLDWRKNICKNAME>
|-
| Due Date
| <CMTLBLDATA_FLDTKTDUEDATETIME>
|-
| Ticket Type
| <CMTLBLDATA_FLDTKTKIND>
|-
| Notes
| <CMTLBLDATA_FLDTKTNOTES>CMTLBLDATA
|-
| Open Date
| <CMTLBLDATA_FLDTKTOPENDATETIME>
|-
| Priority
| <CMTLBLDATA_FLDTKTPRIORITY>
|-
| Description
| <CMTLBLDATA_FLDTKTPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDTKTRECID>
|-
| Account's Region Code
| <CMTLBLDATA_FLDTKTREGIONCODE>
|-
| Estimated Duration Needed
| <CMTLBLDATA_FLDTKTSCHEDLENESTIM>
|-
| Resolution Description
| <CMTLBLDATA_FLDTKTSOLUTION>
|-
| Source
| <CMTLBLDATA_FLDTKTSOURCE>
|-
| Status
| <CMTLBLDATA_FLDTKTSTATUS>
|-
| Status: Ext.
| <CMTLBLDATA_FLDTKTSTATUSNOTE>
|-
| Ticket Number
| <CMTLBLDATA_FLDTKTTICKETNO>
|-
| Last Update Date
| <CMTLBLDATA_FLDTKTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDTKTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDTKTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDTKTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDTKTUSER3>
|-
| Manager
| <CMTLBLDATA_FLDTKTWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Category
| <CMTLBLDATA_FLDKBACATEGORY>
|-
| Create Date
| <CMTLBLDATA_FLDKBACREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDKBACREATEUSER_FLDWRKNICKNAME>
|-
| Public
| <CMTLBLDATA_FLDKBAISPUBLIC>
|-
| Problem
| <CMTLBLDATA_FLDKBAPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDKBARECID>
|-
| Solution
| <CMTLBLDATA_FLDKBASOLUTION>
|-
| Status
| <CMTLBLDATA_FLDKBASTATUS>
|-
| Title
| <CMTLBLDATA_FLDKBATITLE>
|-
| Last Update date
| <CMTLBLDATA_FLDKBAUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDKBAUPDATEUSER_FLDWRKNICKNAME>
|}

===Lookup Fields===
*Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket. This way you can define an Online Service for the Account, which will be activated from the Ticket window. Lookup Field syntax: <CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1> Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account FLDCRDADDRESS1 is the account's Address field

==See Also==
*[[Online Services FAQ]]

[[Category:Integration]]

Online Services

2009-08-20T13:50:23Z

Yarden: /* Displaying Domain WHOIS */

{{integration}}

Commit's '''Online Services''' is a powerful feature which allows you to link to web sites (URL) and activate the web application using parameters taken from CommitCRM.

You can define as many online Services as you wish. This feature is available for the following entities: Accounts, Tickets, Assets, Items, Contracts, Knowledge Base Articles and Oppotrunities.
*Accounts window
*Tickets window
*Dispatcher window
*Asset window
*Items window
*Contracts window
*Opportunities window

==What can I use Online Services for?==
Wouldn't you like your technicians to be able to find an address for a scheduled visit with just a single click? You can do this by defining an Online Service which will open maps site (e.g. Google Maps, Yahoo! Maps etc.) and the map will open automatically on the address of the Account or Contact stored in CommitCRM.

This powerful tool allows you to define any URL and open it with parameters. You can basically do with it whatever you want.

==Adding new Online Services==
To define a new Online Service, Open the Online Services Management window from Settings > Online Services. or click the Online Services icon from the Accounts window toolbar. Click the New button to add a new Online Service and enter the following parameters:

*'''Name''' - The name of the service which will be displayed in the Online Services list and menus throughout the system, for example, "Google Maps".
*'''Base URL''' - The URL you wish to open in order to use the Service. This is the address of the main service (before passing any parameters to it), for example http://maps.google.com/maps.
*'''URL Parameters''' - Parameters which will be appended to the URL in order to create specific queries when opening the URL. These parameters can be CommitCRM Account database fields which will be taken and filled from CommitCRM when clicking the Online Service.

See the Tips and Tricks for examples of useful Online Services

==Activating Online Services==
Online Services can be activated from various places in CommitCRM including:
*The '''Account, Ticket, Asset, Item, Opportunity, Contract, Knowledge Base Article windows''' - click the Online Services icon to activate the service for the selected account
*The '''Dispatcher Windows''' - right-click on a selected Ticket to run any Online Service for the Ticket's Account or Contact (such as displaying a map).
*The '''Calendar / Scheduled Appointments''' views - right-click above an Appointment and select Online Services.
*The '''secondary Contacts tab''' - select a Contact, right-click and select Online Services
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.
*'''Secondary Contact selection''' field - right-click and select Online Services.
*The '''Relations tab under Account''' - right-click and select Online Services.

==Possible Usage==
*'''Online Services and Assets''' – Access your MSP product online and pass the Asset ID to display its details from your external system
*'''Online Services and Items''' – Search for better prices for items by passing specific item information directly from within CommitCRM.
*'''Online Services for Assets''' – Search for a specific product review by its hardware serial number.
*'''Online Services for Tickets''' – Search in online knowledge bases for solutions based on the ticket description
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.

==Using Lookup Fields==
Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket.

This way you can define an Online Service for the Ticket, which will be activated from the Ticket window and will be using Account information.

Lookup Field syntax:

<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>

Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account
FLDCRDADDRESS1 is the account's Address field

==Tips & Tricks==
Following are examples of possible Online Services configurations.
These examples are intended to explain the use of Online Services only.

Disclaimer - Before defining your Online Services you should read the terms of use for each web site you want to access. The examples below are displayed to explain how to use online services and how to pass parameters.

===Displaying Online Maps===
'''Google Maps''' - Opens Google Maps and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Maps
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDCRDADDRESS1>+<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDSTATE>+<CMTLBLDATA_FLDCRDZIP>
|}

'''MapQuest''' - Opens MapQuest Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| MapQuest
|-
| Base URL
| <nowiki>http://www.mapquest.com/maps</nowiki>
|-
| URL Parameters
| /map.adp?searchtype=address&country=<CMTLBLDATA_FLDCRDCOUNTRY>&addtohistory=&searchtab=home&formtype=address&popflag=0&latitude=&longitude=&name=&phone=&level=&cat=&address=&city=<CMTLBLDATA_FLDCRDCITY>&state=<CMTLBLDATA_FLDCRDSTATE>&zipcode=<CMTLBLDATA_FLDCRDZIP>
|}

'''Yahoo! Maps''' - Opens Yahoo! Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Yahoo! Maps
|-
| Base URL
| <nowiki>http://maps.yahoo.com</nowiki>
|-
| URL Parameters
| /maps_result?addr=<CMTLBLDATA_FLDCRDADDRESS1>&csz=<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDCOUNTRY>&country=<CMTLBLDATA_FLDCRDSTATE>
|}

===Finding Account Information===
'''Google Company''' - Opens Google and searches for the Account Company Name.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Company
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCOMPANY>
|}

'''Google Contact''' - Opens Google and searches for the Contact Name.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Contact
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCONTACT>
|}

===Finding Ticket Description in Google===
'''Google Ticket''' - Opens Google and searches for the Ticket description.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket Description
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDTKTPROBLEM>
|}

===Finding Account Address From Ticket (using [[Commit Online Services#Using Lookup Fields|Lookup Field]]) ===
'''Google Address From Ticket''' - Opens Google and searches for the Address of the Account which is linked to the Ticket.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDCITY>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDSTATE>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDZIP>
|}

===Displaying HP Warranties===
'''Contributed by Easy I.T'''

'''HP Warranty Lookup''' - Displays HP products warranty expiration dates, using the products number and the products serial number.

Note: Product Number goes into Plate# field (<CMTLBLDATA_FLDASTUSER1>).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| HP Warranty Lookup
|-
| Base URL
| <nowiki>http://h20000.www2.hp.com/bizsupport/TechSupport/WarrantyResults.jsp?</nowiki>
|-
| URL Parameters
| lang=en&cc=us&prodSeriesId=454811&prodTypeId=12454&sn=<CMTLBLDATA_FLDASTSERIALNO>&pn=<CMTLBLDATA_FLDASTUSER1>&country=US&nickname=&find=Display+Warranty+Information+%C2%BB
|}

===Displaying Domain WHOIS===

'''Domain WHOIS''' - WHOIS domain registration information by Domain Tools.

Note: Domain must be stripped from URL (without http://).

'''Contributed by DavidW'''
{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (NetworkSolutions)
|-
| Base URL
| <nowiki>http://www.networksolutions.com/whois-search/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''Contributed by ajgyomber'''

'''Domain WHOIS''' - WHOIS domain registration information by Network Solutions.

Note: Domain must be stripped from URL (without http://).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DomainTools)
|-
| Base URL
| <nowiki>http://whois.domaintools.com/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

==Parameters list==

===Parameters List for Accounts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account Number
| <CMTLBLDATA_FLDCRDCARDID2>
|-
| Address: City
| <CMTLBLDATA_FLDCRDCITY>
|-
| Address: Country
| <CMTLBLDATA_FLDCRDCOUNTRY>
|-
| Address: Line1
| <CMTLBLDATA_FLDCRDADDRESS1>
|-
| Address: Line2
| <CMTLBLDATA_FLDCRDADDRESS2>
|-
| Address: Line3
| <CMTLBLDATA_FLDCRDADDRESS3>
|-
| Address: State
| <CMTLBLDATA_FLDCRDSTATE>
|-
| Address: ZIP Code
| <CMTLBLDATA_FLDCRDZIP>
|-
| Assistant
| <CMTLBLDATA_FLDCRDASSISTANT>
|-
| Birthday
| <CMTLBLDATA_FLDCRDBIRTHDAY>
|-
| Company name
| <CMTLBLDATA_FLDCRDCOMPANY>
|-
| Contact: First & Last Name
| <CMTLBLDATA_FLDCRDCONTACT>
|-
| Dear
| <CMTLBLDATA_FLDCRDDEAR>
|-
| Department
| <CMTLBLDATA_FLDCRDDEPARTMENT>
|-
| E-Mail Address 1
| <CMTLBLDATA_FLDCRDEMAIL1>
|-
| E-Mail Address 2
| <CMTLBLDATA_FLDCRDEMAIL2>
|-
| Fax Number
| <CMTLBLDATA_FLDCRDFAX1>
|-
| Fax Number Extention
| <CMTLBLDATA_FLDCRDFAXDESC1>
|-
| Field
| <CMTLBLDATA_FLDCRDPERSONID>
|-
| Field1
| <CMTLBLDATA_FLDCRDUSER2>
|-
| Field2
| <CMTLBLDATA_FLDCRDUSER3>
|-
| Field3
| <CMTLBLDATA_FLDCRDUSER4>
|-
| Field4
| <CMTLBLDATA_FLDCRDUSER5>
|-
| Field5
| <CMTLBLDATA_FLDCRDCOMPANYNO>
|-
| File as
| <CMTLBLDATA_FLDCRDFULLNAME>
|-
| ID
| <CMTLBLDATA_FLDCRDCARDID3>
|-
| Last Name
| <CMTLBLDATA_FLDCRDLASTNAME>
|-
| Phone 1
| <CMTLBLDATA_FLDCRDPHONE1>
|-
| Phone 1 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC1>
|-
| Phone 2
| <CMTLBLDATA_FLDCRDPHONE2>
|-
| Phone 2 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC2>
|-
| Phone 3
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Phone 3 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC3>
|-
| Phone 4
| <CMTLBLDATA_FLDCRDPHONE4>
|-
| Phone 4 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC4>
|-
| Popup Message
| <CMTLBLDATA_FLDCRDCARDMESSAGE>
|-
| Region
| <CMTLBLDATA_FLDCRDREGIONCODE>
|-
| Salutation
| <CMTLBLDATA_FLDCRDSUFFIX>
|-
| Status
| <CMTLBLDATA_FLDCRDUSER1>
|-
| Sub-Contact Code
| <CMTLBLDATA_FLDCRDSUBCODE>
|-
| Title
| <CMTLBLDATA_FLDCRDTITLE>
|-
| Type
| <CMTLBLDATA_FLDCRDKIND>
|-
| Web Address 1
| <CMTLBLDATA_FLDCRDURL1>
|-
| Web Address 2
| <CMTLBLDATA_FLDCRDURL2>
|}

===Parameters list for Assets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTACCRECID>
|-
| Asset Code
| <CMTLBLDATA_FLDASTASSETCODE>
|-
| Asset Type
| <CMTLBLDATA_FLDASTASSETTYPE>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTCONTACTRECID>
|-
| Create Date
| <CMTLBLDATA_FLDASTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDASTCREATEUSER_FLDWRKNICKNAME>
|-
| Purchase Date
| <CMTLBLDATA_FLDASTCUSTPURDATE>
|-
| Purchased From Us
| <CMTLBLDATA_FLDASTCUSTPURFROMUS>
|-
| Purchase Our Invoice #
| <CMTLBLDATA_FLDASTCUSTPUROURINV>
|-
| Customer PO
| <CMTLBLDATA_FLDASTCUSTPURPO>
|-
| Purchase Price
| <CMTLBLDATA_FLDASTCUSTPURPRICE>
|-
| Delivered Date
| <CMTLBLDATA_FLDASTDELIVEDATE>
|-
| Description
| <CMTLBLDATA_FLDASTDESC>
|-
| Installed By
| <CMTLBLDATA_FLDASTINSTALBY_FLDWRKNICKNAME>
|-
| Installed Date
| <CMTLBLDATA_FLDASTINSTALDATE>
|-
| License Codes
| <CMTLBLDATA_FLDASTLICENSECODE>
|-
| License Keys
| <CMTLBLDATA_FLDASTLICENSEKEYS>
|-
| License Notes
| <CMTLBLDATA_FLDASTLICENSENOTES>
|-
| Location
| <CMTLBLDATA_FLDASTLOCATION>
|-
| Manufacturer
| <CMTLBLDATA_FLDASTMANUFACTURER>
|-
| Manufacturer Serial No.
| <CMTLBLDATA_FLDASTMNFSERIALNO>
|-
| Model
| <CMTLBLDATA_FLDASTMODEL>
|-
| Asset Name
| <CMTLBLDATA_FLDASTNAME>
|-
| Notes
| <CMTLBLDATA_FLDASTNOTES>
|-
| PARENTASSETRECID
| <CMTLBLDATA_FLDASTPARENTRECID>
|-
| Quantity
| <CMTLBLDATA_FLDASTQUANTITY>
|-
| Record ID
| <CMTLBLDATA_FLDASTRECID>
|-
| Serial No.
| <CMTLBLDATA_FLDASTSERIALNO>
|-
| Status
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Last Update date
| <CMTLBLDATA_FLDASTUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDASTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDASTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDASTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDASTUSER3>
|-
| Field4
| <CMTLBLDATA_FLDASTUSER4>
|-
| Field5
| <CMTLBLDATA_FLDASTUSER5>
|-
| Date1
| <CMTLBLDATA_FLDASTUSERDATE1>
|-
| Number1
| <CMTLBLDATA_FLDASTUSERNUMBER1>
|-
| Vendor Purchased Date
| <CMTLBLDATA_FLDASTVENDORDATEPURC>
|-
| Vendor Invoice #
| <CMTLBLDATA_FLDASTVENDORINVNO>
|-
| Vendor Name
| <CMTLBLDATA_FLDASTVENDORNAME>
|-
| Vendor PO
| <CMTLBLDATA_FLDASTVENDOROURPO>
|-
| Vendor Price
| <CMTLBLDATA_FLDASTVENDORPRICE>
|-
| Vendor
| <CMTLBLDATA_FLDASTVENDORRECID>
|-
| Vendor Serial No.
| <CMTLBLDATA_FLDASTVENDORSERNO>
|-
| Vendor Warranty Exp. Date
| <CMTLBLDATA_FLDASTVENDORWARREXP>
|-
| Version
| <CMTLBLDATA_FLDASTVERSION>
|-
| Warranty/License Exp. Date
| <CMTLBLDATA_FLDASTWARREXPDATE>FLDASTWARREXPDATE
|}

===Parameters list for Contracts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTACCRECID>
|-
| Block - Used
| <CMTLBLDATA_FLDBCTAMOUNTUSED>
|-
| Code
| <CMTLBLDATA_FLDBCTCODE>
|-
| Contract Type Type
| <CMTLBLDATA_FLDBCTCONTRACTTYPE>
|-
| Create Date
| <CMTLBLDATA_FLDBCTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDBCTCREATEUSER_FLDWRKNICKNAME>
|-
| Default Item Expense ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMEXPNS>
|-
| Default Item Labor ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMLABOR>
|-
| Default Item Part ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMPART>
|-
| Description
| <CMTLBLDATA_FLDBCTDESCEXTERNAL>
|-
| Internal Description
| <CMTLBLDATA_FLDBCTDESCINTERNAL>
|-
| End Date
| <CMTLBLDATA_FLDBCTENDDATE>
|-
| Name
| <CMTLBLDATA_FLDBCTNAME>
|-
| Note
| <CMTLBLDATA_FLDBCTNOTE>
|-
| Record ID
| <CMTLBLDATA_FLDBCTRECID>
|-
| Start Date
| <CMTLBLDATA_FLDBCTSTARTDATE>
|-
| Status
| <CMTLBLDATA_FLDBCTSTATUS>
|-
| Last Update date
| <CMTLBLDATA_FLDBCTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDBCTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field 1
| <CMTLBLDATA_FLDBCTUSER1>
|-
| Field 2
| <CMTLBLDATA_FLDBCTUSER2>
|-
| Field 3
| <CMTLBLDATA_FLDBCTUSER3>
|}

===Parameters list for Items===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Currency
| <CMTLBLDATA_FLDITMCOINID>
|-
| Created by User
| <CMTLBLDATA_FLDITMCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDITMDESC>
|-
| Expense Type
| <CMTLBLDATA_FLDITMEXPITEMTYPE>
|-
| Labor Type
| <CMTLBLDATA_FLDITMFEEITEMTYPE>
|-
| Item Code
| <CMTLBLDATA_FLDITMITEMNO>
|-
| Group
| <CMTLBLDATA_FLDITMITEMTYPEGROUP>
|-
| Name
| <CMTLBLDATA_FLDITMNAME>
|-
| Notes
| <CMTLBLDATA_FLDITMNOTES>
|-
| Price Source
| <CMTLBLDATA_FLDITMPRICESOURCE>
|-
| Product/Part Type
| <CMTLBLDATA_FLDITMPRODITEMTYPE>
|-
| Record Id
| <CMTLBLDATA_FLDITMRECID>
|-
| Cost
| <CMTLBLDATA_FLDITMSTANDARDCOST>
|-
| Suspend
| <CMTLBLDATA_FLDITMSUSPENDED>
|-
| Price
| <CMTLBLDATA_FLDITMUNITPRICE>
|-
| Update Date
| <CMTLBLDATA_FLDITMUPDATEDATE>
|-
| Update User
| <CMTLBLDATA_FLDITMUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDITMUSER1>
|}

===Parameters list for Opportunities===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Amount
| <CMTLBLDATA_FLDOPPAMOUNT>
|-
| Amount by Probability
| <CMTLBLDATA_FLDOPPCALCAMOUNT>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCARDID>
|-
| Closing amnt
| <CMTLBLDATA_FLDOPPCLOSEAMOUNT>
|-
| Close
| <CMTLBLDATA_FLDOPPCLOSEDATE>
|-
| Currency
| <CMTLBLDATA_FLDOPPCOINID>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCONTACTID>
|-
| Creation Date
| <CMTLBLDATA_FLDOPPCREATEDATE>
|-
| Created by User
| <CMTLBLDATA_FLDOPPCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDOPPDESCRIPTION>
|-
| Close By
| <CMTLBLDATA_FLDOPPESTDATE>
|-
| Oppty Type
| <CMTLBLDATA_FLDOPPKIND>
|-
| Opportunity
| <CMTLBLDATA_FLDOPPNAME>
|-
| Note
| <CMTLBLDATA_FLDOPPNOTES>
|-
| Open
| <CMTLBLDATA_FLDOPPOPENDATE>
|-
| Probability %
| <CMTLBLDATA_FLDOPPPROBABILITY>
|-
| Reason
| <CMTLBLDATA_FLDOPPREASON>
|-
| Record ID
| <CMTLBLDATA_FLDOPPRECID>
|-
| Record type
| <CMTLBLDATA_FLDOPPRECKIND>
|-
| Territory
| <CMTLBLDATA_FLDOPPREGION>
|-
| Source
| <CMTLBLDATA_FLDOPPSOURCE>
|-
| Stage
| <CMTLBLDATA_FLDOPPSTAGE>
|-
| Status
| <CMTLBLDATA_FLDOPPSTATUS>
|-
| Last Update Date
| <CMTLBLDATA_FLDOPPUPDATEDATE>
|-
| Last Update: By User
| <CMTLBLDATA_FLDOPPUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDOPPUSER1>
|-
| Field2
| <CMTLBLDATA_FLDOPPUSER2>
|-
| Field3
| <CMTLBLDATA_FLDOPPUSER3>
|-
| Opportunity ID
| <CMTLBLDATA_FLDOPPUSERID>
|-
| Manager
| <CMTLBLDATA_FLDOPPWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Asset ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTASSETRECID>
|-
| Contract ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTBCRECID>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCARDID>
|-
| Category
| <CMTLBLDATA_FLDTKTCATEGORY>
|-
| Cause
| <CMTLBLDATA_FLDTKTCAUSE>
|-
| Close Date
| <CMTLBLDATA_FLDTKTCLOSEDATETIME>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCONTACTID>
|-
| Creation: Date
| <CMTLBLDATA_FLDTKTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDTKTCREATEUSER_FLDWRKNICKNAME>
|-
| Due Date
| <CMTLBLDATA_FLDTKTDUEDATETIME>
|-
| Ticket Type
| <CMTLBLDATA_FLDTKTKIND>
|-
| Notes
| <CMTLBLDATA_FLDTKTNOTES>CMTLBLDATA
|-
| Open Date
| <CMTLBLDATA_FLDTKTOPENDATETIME>
|-
| Priority
| <CMTLBLDATA_FLDTKTPRIORITY>
|-
| Description
| <CMTLBLDATA_FLDTKTPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDTKTRECID>
|-
| Account's Region Code
| <CMTLBLDATA_FLDTKTREGIONCODE>
|-
| Estimated Duration Needed
| <CMTLBLDATA_FLDTKTSCHEDLENESTIM>
|-
| Resolution Description
| <CMTLBLDATA_FLDTKTSOLUTION>
|-
| Source
| <CMTLBLDATA_FLDTKTSOURCE>
|-
| Status
| <CMTLBLDATA_FLDTKTSTATUS>
|-
| Status: Ext.
| <CMTLBLDATA_FLDTKTSTATUSNOTE>
|-
| Ticket Number
| <CMTLBLDATA_FLDTKTTICKETNO>
|-
| Last Update Date
| <CMTLBLDATA_FLDTKTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDTKTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDTKTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDTKTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDTKTUSER3>
|-
| Manager
| <CMTLBLDATA_FLDTKTWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Category
| <CMTLBLDATA_FLDKBACATEGORY>
|-
| Create Date
| <CMTLBLDATA_FLDKBACREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDKBACREATEUSER_FLDWRKNICKNAME>
|-
| Public
| <CMTLBLDATA_FLDKBAISPUBLIC>
|-
| Problem
| <CMTLBLDATA_FLDKBAPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDKBARECID>
|-
| Solution
| <CMTLBLDATA_FLDKBASOLUTION>
|-
| Status
| <CMTLBLDATA_FLDKBASTATUS>
|-
| Title
| <CMTLBLDATA_FLDKBATITLE>
|-
| Last Update date
| <CMTLBLDATA_FLDKBAUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDKBAUPDATEUSER_FLDWRKNICKNAME>
|}

===Lookup Fields===
*Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket. This way you can define an Online Service for the Account, which will be activated from the Ticket window. Lookup Field syntax: <CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1> Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account FLDCRDADDRESS1 is the account's Address field

==See Also==
*[[Online Services FAQ]]

[[Category:Integration]]

Online Services

2009-08-20T13:49:28Z

Yarden: /* Displaying Online Warranties Checks */

{{integration}}

Commit's '''Online Services''' is a powerful feature which allows you to link to web sites (URL) and activate the web application using parameters taken from CommitCRM.

You can define as many online Services as you wish. This feature is available for the following entities: Accounts, Tickets, Assets, Items, Contracts, Knowledge Base Articles and Oppotrunities.
*Accounts window
*Tickets window
*Dispatcher window
*Asset window
*Items window
*Contracts window
*Opportunities window

==What can I use Online Services for?==
Wouldn't you like your technicians to be able to find an address for a scheduled visit with just a single click? You can do this by defining an Online Service which will open maps site (e.g. Google Maps, Yahoo! Maps etc.) and the map will open automatically on the address of the Account or Contact stored in CommitCRM.

This powerful tool allows you to define any URL and open it with parameters. You can basically do with it whatever you want.

==Adding new Online Services==
To define a new Online Service, Open the Online Services Management window from Settings > Online Services. or click the Online Services icon from the Accounts window toolbar. Click the New button to add a new Online Service and enter the following parameters:

*'''Name''' - The name of the service which will be displayed in the Online Services list and menus throughout the system, for example, "Google Maps".
*'''Base URL''' - The URL you wish to open in order to use the Service. This is the address of the main service (before passing any parameters to it), for example http://maps.google.com/maps.
*'''URL Parameters''' - Parameters which will be appended to the URL in order to create specific queries when opening the URL. These parameters can be CommitCRM Account database fields which will be taken and filled from CommitCRM when clicking the Online Service.

See the Tips and Tricks for examples of useful Online Services

==Activating Online Services==
Online Services can be activated from various places in CommitCRM including:
*The '''Account, Ticket, Asset, Item, Opportunity, Contract, Knowledge Base Article windows''' - click the Online Services icon to activate the service for the selected account
*The '''Dispatcher Windows''' - right-click on a selected Ticket to run any Online Service for the Ticket's Account or Contact (such as displaying a map).
*The '''Calendar / Scheduled Appointments''' views - right-click above an Appointment and select Online Services.
*The '''secondary Contacts tab''' - select a Contact, right-click and select Online Services
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.
*'''Secondary Contact selection''' field - right-click and select Online Services.
*The '''Relations tab under Account''' - right-click and select Online Services.

==Possible Usage==
*'''Online Services and Assets''' – Access your MSP product online and pass the Asset ID to display its details from your external system
*'''Online Services and Items''' – Search for better prices for items by passing specific item information directly from within CommitCRM.
*'''Online Services for Assets''' – Search for a specific product review by its hardware serial number.
*'''Online Services for Tickets''' – Search in online knowledge bases for solutions based on the ticket description
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.

==Using Lookup Fields==
Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket.

This way you can define an Online Service for the Ticket, which will be activated from the Ticket window and will be using Account information.

Lookup Field syntax:

<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>

Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account
FLDCRDADDRESS1 is the account's Address field

==Tips & Tricks==
Following are examples of possible Online Services configurations.
These examples are intended to explain the use of Online Services only.

Disclaimer - Before defining your Online Services you should read the terms of use for each web site you want to access. The examples below are displayed to explain how to use online services and how to pass parameters.

===Displaying Online Maps===
'''Google Maps''' - Opens Google Maps and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Maps
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDCRDADDRESS1>+<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDSTATE>+<CMTLBLDATA_FLDCRDZIP>
|}

'''MapQuest''' - Opens MapQuest Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| MapQuest
|-
| Base URL
| <nowiki>http://www.mapquest.com/maps</nowiki>
|-
| URL Parameters
| /map.adp?searchtype=address&country=<CMTLBLDATA_FLDCRDCOUNTRY>&addtohistory=&searchtab=home&formtype=address&popflag=0&latitude=&longitude=&name=&phone=&level=&cat=&address=&city=<CMTLBLDATA_FLDCRDCITY>&state=<CMTLBLDATA_FLDCRDSTATE>&zipcode=<CMTLBLDATA_FLDCRDZIP>
|}

'''Yahoo! Maps''' - Opens Yahoo! Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Yahoo! Maps
|-
| Base URL
| <nowiki>http://maps.yahoo.com</nowiki>
|-
| URL Parameters
| /maps_result?addr=<CMTLBLDATA_FLDCRDADDRESS1>&csz=<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDCOUNTRY>&country=<CMTLBLDATA_FLDCRDSTATE>
|}

===Finding Account Information===
'''Google Company''' - Opens Google and searches for the Account Company Name.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Company
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCOMPANY>
|}

'''Google Contact''' - Opens Google and searches for the Contact Name.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Contact
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCONTACT>
|}

===Finding Ticket Description in Google===
'''Google Ticket''' - Opens Google and searches for the Ticket description.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket Description
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDTKTPROBLEM>
|}

===Finding Account Address From Ticket (using [[Commit Online Services#Using Lookup Fields|Lookup Field]]) ===
'''Google Address From Ticket''' - Opens Google and searches for the Address of the Account which is linked to the Ticket.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDCITY>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDSTATE>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDZIP>
|}

===Displaying HP Warranties===
'''Contributed by Easy I.T'''

'''HP Warranty Lookup''' - Displays HP products warranty expiration dates, using the products number and the products serial number.

Note: Product Number goes into Plate# field (<CMTLBLDATA_FLDASTUSER1>).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| HP Warranty Lookup
|-
| Base URL
| <nowiki>http://h20000.www2.hp.com/bizsupport/TechSupport/WarrantyResults.jsp?</nowiki>
|-
| URL Parameters
| lang=en&cc=us&prodSeriesId=454811&prodTypeId=12454&sn=<CMTLBLDATA_FLDASTSERIALNO>&pn=<CMTLBLDATA_FLDASTUSER1>&country=US&nickname=&find=Display+Warranty+Information+%C2%BB
|}

===Displaying Domain WHOIS===
'''Contributed by DavidW'''

'''Domain WHOIS''' - WHOIS domain registration information by Network Solutions.

Note: Domain must be stripped from URL (without http://).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (NetworkSolutions)
|-
| Base URL
| <nowiki>http://www.networksolutions.com/whois-search/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''Contributed by ajgyomber'''

'''Domain WHOIS''' - WHOIS domain registration information by Network Solutions.

Note: Domain must be stripped from URL (without http://).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DomainTools)
|-
| Base URL
| <nowiki>http://whois.domaintools.com/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

==Parameters list==

===Parameters List for Accounts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account Number
| <CMTLBLDATA_FLDCRDCARDID2>
|-
| Address: City
| <CMTLBLDATA_FLDCRDCITY>
|-
| Address: Country
| <CMTLBLDATA_FLDCRDCOUNTRY>
|-
| Address: Line1
| <CMTLBLDATA_FLDCRDADDRESS1>
|-
| Address: Line2
| <CMTLBLDATA_FLDCRDADDRESS2>
|-
| Address: Line3
| <CMTLBLDATA_FLDCRDADDRESS3>
|-
| Address: State
| <CMTLBLDATA_FLDCRDSTATE>
|-
| Address: ZIP Code
| <CMTLBLDATA_FLDCRDZIP>
|-
| Assistant
| <CMTLBLDATA_FLDCRDASSISTANT>
|-
| Birthday
| <CMTLBLDATA_FLDCRDBIRTHDAY>
|-
| Company name
| <CMTLBLDATA_FLDCRDCOMPANY>
|-
| Contact: First & Last Name
| <CMTLBLDATA_FLDCRDCONTACT>
|-
| Dear
| <CMTLBLDATA_FLDCRDDEAR>
|-
| Department
| <CMTLBLDATA_FLDCRDDEPARTMENT>
|-
| E-Mail Address 1
| <CMTLBLDATA_FLDCRDEMAIL1>
|-
| E-Mail Address 2
| <CMTLBLDATA_FLDCRDEMAIL2>
|-
| Fax Number
| <CMTLBLDATA_FLDCRDFAX1>
|-
| Fax Number Extention
| <CMTLBLDATA_FLDCRDFAXDESC1>
|-
| Field
| <CMTLBLDATA_FLDCRDPERSONID>
|-
| Field1
| <CMTLBLDATA_FLDCRDUSER2>
|-
| Field2
| <CMTLBLDATA_FLDCRDUSER3>
|-
| Field3
| <CMTLBLDATA_FLDCRDUSER4>
|-
| Field4
| <CMTLBLDATA_FLDCRDUSER5>
|-
| Field5
| <CMTLBLDATA_FLDCRDCOMPANYNO>
|-
| File as
| <CMTLBLDATA_FLDCRDFULLNAME>
|-
| ID
| <CMTLBLDATA_FLDCRDCARDID3>
|-
| Last Name
| <CMTLBLDATA_FLDCRDLASTNAME>
|-
| Phone 1
| <CMTLBLDATA_FLDCRDPHONE1>
|-
| Phone 1 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC1>
|-
| Phone 2
| <CMTLBLDATA_FLDCRDPHONE2>
|-
| Phone 2 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC2>
|-
| Phone 3
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Phone 3 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC3>
|-
| Phone 4
| <CMTLBLDATA_FLDCRDPHONE4>
|-
| Phone 4 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC4>
|-
| Popup Message
| <CMTLBLDATA_FLDCRDCARDMESSAGE>
|-
| Region
| <CMTLBLDATA_FLDCRDREGIONCODE>
|-
| Salutation
| <CMTLBLDATA_FLDCRDSUFFIX>
|-
| Status
| <CMTLBLDATA_FLDCRDUSER1>
|-
| Sub-Contact Code
| <CMTLBLDATA_FLDCRDSUBCODE>
|-
| Title
| <CMTLBLDATA_FLDCRDTITLE>
|-
| Type
| <CMTLBLDATA_FLDCRDKIND>
|-
| Web Address 1
| <CMTLBLDATA_FLDCRDURL1>
|-
| Web Address 2
| <CMTLBLDATA_FLDCRDURL2>
|}

===Parameters list for Assets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTACCRECID>
|-
| Asset Code
| <CMTLBLDATA_FLDASTASSETCODE>
|-
| Asset Type
| <CMTLBLDATA_FLDASTASSETTYPE>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTCONTACTRECID>
|-
| Create Date
| <CMTLBLDATA_FLDASTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDASTCREATEUSER_FLDWRKNICKNAME>
|-
| Purchase Date
| <CMTLBLDATA_FLDASTCUSTPURDATE>
|-
| Purchased From Us
| <CMTLBLDATA_FLDASTCUSTPURFROMUS>
|-
| Purchase Our Invoice #
| <CMTLBLDATA_FLDASTCUSTPUROURINV>
|-
| Customer PO
| <CMTLBLDATA_FLDASTCUSTPURPO>
|-
| Purchase Price
| <CMTLBLDATA_FLDASTCUSTPURPRICE>
|-
| Delivered Date
| <CMTLBLDATA_FLDASTDELIVEDATE>
|-
| Description
| <CMTLBLDATA_FLDASTDESC>
|-
| Installed By
| <CMTLBLDATA_FLDASTINSTALBY_FLDWRKNICKNAME>
|-
| Installed Date
| <CMTLBLDATA_FLDASTINSTALDATE>
|-
| License Codes
| <CMTLBLDATA_FLDASTLICENSECODE>
|-
| License Keys
| <CMTLBLDATA_FLDASTLICENSEKEYS>
|-
| License Notes
| <CMTLBLDATA_FLDASTLICENSENOTES>
|-
| Location
| <CMTLBLDATA_FLDASTLOCATION>
|-
| Manufacturer
| <CMTLBLDATA_FLDASTMANUFACTURER>
|-
| Manufacturer Serial No.
| <CMTLBLDATA_FLDASTMNFSERIALNO>
|-
| Model
| <CMTLBLDATA_FLDASTMODEL>
|-
| Asset Name
| <CMTLBLDATA_FLDASTNAME>
|-
| Notes
| <CMTLBLDATA_FLDASTNOTES>
|-
| PARENTASSETRECID
| <CMTLBLDATA_FLDASTPARENTRECID>
|-
| Quantity
| <CMTLBLDATA_FLDASTQUANTITY>
|-
| Record ID
| <CMTLBLDATA_FLDASTRECID>
|-
| Serial No.
| <CMTLBLDATA_FLDASTSERIALNO>
|-
| Status
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Last Update date
| <CMTLBLDATA_FLDASTUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDASTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDASTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDASTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDASTUSER3>
|-
| Field4
| <CMTLBLDATA_FLDASTUSER4>
|-
| Field5
| <CMTLBLDATA_FLDASTUSER5>
|-
| Date1
| <CMTLBLDATA_FLDASTUSERDATE1>
|-
| Number1
| <CMTLBLDATA_FLDASTUSERNUMBER1>
|-
| Vendor Purchased Date
| <CMTLBLDATA_FLDASTVENDORDATEPURC>
|-
| Vendor Invoice #
| <CMTLBLDATA_FLDASTVENDORINVNO>
|-
| Vendor Name
| <CMTLBLDATA_FLDASTVENDORNAME>
|-
| Vendor PO
| <CMTLBLDATA_FLDASTVENDOROURPO>
|-
| Vendor Price
| <CMTLBLDATA_FLDASTVENDORPRICE>
|-
| Vendor
| <CMTLBLDATA_FLDASTVENDORRECID>
|-
| Vendor Serial No.
| <CMTLBLDATA_FLDASTVENDORSERNO>
|-
| Vendor Warranty Exp. Date
| <CMTLBLDATA_FLDASTVENDORWARREXP>
|-
| Version
| <CMTLBLDATA_FLDASTVERSION>
|-
| Warranty/License Exp. Date
| <CMTLBLDATA_FLDASTWARREXPDATE>FLDASTWARREXPDATE
|}

===Parameters list for Contracts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTACCRECID>
|-
| Block - Used
| <CMTLBLDATA_FLDBCTAMOUNTUSED>
|-
| Code
| <CMTLBLDATA_FLDBCTCODE>
|-
| Contract Type Type
| <CMTLBLDATA_FLDBCTCONTRACTTYPE>
|-
| Create Date
| <CMTLBLDATA_FLDBCTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDBCTCREATEUSER_FLDWRKNICKNAME>
|-
| Default Item Expense ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMEXPNS>
|-
| Default Item Labor ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMLABOR>
|-
| Default Item Part ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMPART>
|-
| Description
| <CMTLBLDATA_FLDBCTDESCEXTERNAL>
|-
| Internal Description
| <CMTLBLDATA_FLDBCTDESCINTERNAL>
|-
| End Date
| <CMTLBLDATA_FLDBCTENDDATE>
|-
| Name
| <CMTLBLDATA_FLDBCTNAME>
|-
| Note
| <CMTLBLDATA_FLDBCTNOTE>
|-
| Record ID
| <CMTLBLDATA_FLDBCTRECID>
|-
| Start Date
| <CMTLBLDATA_FLDBCTSTARTDATE>
|-
| Status
| <CMTLBLDATA_FLDBCTSTATUS>
|-
| Last Update date
| <CMTLBLDATA_FLDBCTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDBCTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field 1
| <CMTLBLDATA_FLDBCTUSER1>
|-
| Field 2
| <CMTLBLDATA_FLDBCTUSER2>
|-
| Field 3
| <CMTLBLDATA_FLDBCTUSER3>
|}

===Parameters list for Items===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Currency
| <CMTLBLDATA_FLDITMCOINID>
|-
| Created by User
| <CMTLBLDATA_FLDITMCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDITMDESC>
|-
| Expense Type
| <CMTLBLDATA_FLDITMEXPITEMTYPE>
|-
| Labor Type
| <CMTLBLDATA_FLDITMFEEITEMTYPE>
|-
| Item Code
| <CMTLBLDATA_FLDITMITEMNO>
|-
| Group
| <CMTLBLDATA_FLDITMITEMTYPEGROUP>
|-
| Name
| <CMTLBLDATA_FLDITMNAME>
|-
| Notes
| <CMTLBLDATA_FLDITMNOTES>
|-
| Price Source
| <CMTLBLDATA_FLDITMPRICESOURCE>
|-
| Product/Part Type
| <CMTLBLDATA_FLDITMPRODITEMTYPE>
|-
| Record Id
| <CMTLBLDATA_FLDITMRECID>
|-
| Cost
| <CMTLBLDATA_FLDITMSTANDARDCOST>
|-
| Suspend
| <CMTLBLDATA_FLDITMSUSPENDED>
|-
| Price
| <CMTLBLDATA_FLDITMUNITPRICE>
|-
| Update Date
| <CMTLBLDATA_FLDITMUPDATEDATE>
|-
| Update User
| <CMTLBLDATA_FLDITMUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDITMUSER1>
|}

===Parameters list for Opportunities===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Amount
| <CMTLBLDATA_FLDOPPAMOUNT>
|-
| Amount by Probability
| <CMTLBLDATA_FLDOPPCALCAMOUNT>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCARDID>
|-
| Closing amnt
| <CMTLBLDATA_FLDOPPCLOSEAMOUNT>
|-
| Close
| <CMTLBLDATA_FLDOPPCLOSEDATE>
|-
| Currency
| <CMTLBLDATA_FLDOPPCOINID>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCONTACTID>
|-
| Creation Date
| <CMTLBLDATA_FLDOPPCREATEDATE>
|-
| Created by User
| <CMTLBLDATA_FLDOPPCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDOPPDESCRIPTION>
|-
| Close By
| <CMTLBLDATA_FLDOPPESTDATE>
|-
| Oppty Type
| <CMTLBLDATA_FLDOPPKIND>
|-
| Opportunity
| <CMTLBLDATA_FLDOPPNAME>
|-
| Note
| <CMTLBLDATA_FLDOPPNOTES>
|-
| Open
| <CMTLBLDATA_FLDOPPOPENDATE>
|-
| Probability %
| <CMTLBLDATA_FLDOPPPROBABILITY>
|-
| Reason
| <CMTLBLDATA_FLDOPPREASON>
|-
| Record ID
| <CMTLBLDATA_FLDOPPRECID>
|-
| Record type
| <CMTLBLDATA_FLDOPPRECKIND>
|-
| Territory
| <CMTLBLDATA_FLDOPPREGION>
|-
| Source
| <CMTLBLDATA_FLDOPPSOURCE>
|-
| Stage
| <CMTLBLDATA_FLDOPPSTAGE>
|-
| Status
| <CMTLBLDATA_FLDOPPSTATUS>
|-
| Last Update Date
| <CMTLBLDATA_FLDOPPUPDATEDATE>
|-
| Last Update: By User
| <CMTLBLDATA_FLDOPPUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDOPPUSER1>
|-
| Field2
| <CMTLBLDATA_FLDOPPUSER2>
|-
| Field3
| <CMTLBLDATA_FLDOPPUSER3>
|-
| Opportunity ID
| <CMTLBLDATA_FLDOPPUSERID>
|-
| Manager
| <CMTLBLDATA_FLDOPPWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Asset ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTASSETRECID>
|-
| Contract ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTBCRECID>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCARDID>
|-
| Category
| <CMTLBLDATA_FLDTKTCATEGORY>
|-
| Cause
| <CMTLBLDATA_FLDTKTCAUSE>
|-
| Close Date
| <CMTLBLDATA_FLDTKTCLOSEDATETIME>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCONTACTID>
|-
| Creation: Date
| <CMTLBLDATA_FLDTKTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDTKTCREATEUSER_FLDWRKNICKNAME>
|-
| Due Date
| <CMTLBLDATA_FLDTKTDUEDATETIME>
|-
| Ticket Type
| <CMTLBLDATA_FLDTKTKIND>
|-
| Notes
| <CMTLBLDATA_FLDTKTNOTES>CMTLBLDATA
|-
| Open Date
| <CMTLBLDATA_FLDTKTOPENDATETIME>
|-
| Priority
| <CMTLBLDATA_FLDTKTPRIORITY>
|-
| Description
| <CMTLBLDATA_FLDTKTPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDTKTRECID>
|-
| Account's Region Code
| <CMTLBLDATA_FLDTKTREGIONCODE>
|-
| Estimated Duration Needed
| <CMTLBLDATA_FLDTKTSCHEDLENESTIM>
|-
| Resolution Description
| <CMTLBLDATA_FLDTKTSOLUTION>
|-
| Source
| <CMTLBLDATA_FLDTKTSOURCE>
|-
| Status
| <CMTLBLDATA_FLDTKTSTATUS>
|-
| Status: Ext.
| <CMTLBLDATA_FLDTKTSTATUSNOTE>
|-
| Ticket Number
| <CMTLBLDATA_FLDTKTTICKETNO>
|-
| Last Update Date
| <CMTLBLDATA_FLDTKTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDTKTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDTKTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDTKTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDTKTUSER3>
|-
| Manager
| <CMTLBLDATA_FLDTKTWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Category
| <CMTLBLDATA_FLDKBACATEGORY>
|-
| Create Date
| <CMTLBLDATA_FLDKBACREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDKBACREATEUSER_FLDWRKNICKNAME>
|-
| Public
| <CMTLBLDATA_FLDKBAISPUBLIC>
|-
| Problem
| <CMTLBLDATA_FLDKBAPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDKBARECID>
|-
| Solution
| <CMTLBLDATA_FLDKBASOLUTION>
|-
| Status
| <CMTLBLDATA_FLDKBASTATUS>
|-
| Title
| <CMTLBLDATA_FLDKBATITLE>
|-
| Last Update date
| <CMTLBLDATA_FLDKBAUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDKBAUPDATEUSER_FLDWRKNICKNAME>
|}

===Lookup Fields===
*Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket. This way you can define an Online Service for the Account, which will be activated from the Ticket window. Lookup Field syntax: <CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1> Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account FLDCRDADDRESS1 is the account's Address field

==See Also==
*[[Online Services FAQ]]

[[Category:Integration]]

Online Services

2009-08-20T13:48:32Z

Yarden: /* Displaying HP Warranties */

{{integration}}

Commit's '''Online Services''' is a powerful feature which allows you to link to web sites (URL) and activate the web application using parameters taken from CommitCRM.

You can define as many online Services as you wish. This feature is available for the following entities: Accounts, Tickets, Assets, Items, Contracts, Knowledge Base Articles and Oppotrunities.
*Accounts window
*Tickets window
*Dispatcher window
*Asset window
*Items window
*Contracts window
*Opportunities window

==What can I use Online Services for?==
Wouldn't you like your technicians to be able to find an address for a scheduled visit with just a single click? You can do this by defining an Online Service which will open maps site (e.g. Google Maps, Yahoo! Maps etc.) and the map will open automatically on the address of the Account or Contact stored in CommitCRM.

This powerful tool allows you to define any URL and open it with parameters. You can basically do with it whatever you want.

==Adding new Online Services==
To define a new Online Service, Open the Online Services Management window from Settings > Online Services. or click the Online Services icon from the Accounts window toolbar. Click the New button to add a new Online Service and enter the following parameters:

*'''Name''' - The name of the service which will be displayed in the Online Services list and menus throughout the system, for example, "Google Maps".
*'''Base URL''' - The URL you wish to open in order to use the Service. This is the address of the main service (before passing any parameters to it), for example http://maps.google.com/maps.
*'''URL Parameters''' - Parameters which will be appended to the URL in order to create specific queries when opening the URL. These parameters can be CommitCRM Account database fields which will be taken and filled from CommitCRM when clicking the Online Service.

See the Tips and Tricks for examples of useful Online Services

==Activating Online Services==
Online Services can be activated from various places in CommitCRM including:
*The '''Account, Ticket, Asset, Item, Opportunity, Contract, Knowledge Base Article windows''' - click the Online Services icon to activate the service for the selected account
*The '''Dispatcher Windows''' - right-click on a selected Ticket to run any Online Service for the Ticket's Account or Contact (such as displaying a map).
*The '''Calendar / Scheduled Appointments''' views - right-click above an Appointment and select Online Services.
*The '''secondary Contacts tab''' - select a Contact, right-click and select Online Services
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.
*'''Secondary Contact selection''' field - right-click and select Online Services.
*The '''Relations tab under Account''' - right-click and select Online Services.

==Possible Usage==
*'''Online Services and Assets''' – Access your MSP product online and pass the Asset ID to display its details from your external system
*'''Online Services and Items''' – Search for better prices for items by passing specific item information directly from within CommitCRM.
*'''Online Services for Assets''' – Search for a specific product review by its hardware serial number.
*'''Online Services for Tickets''' – Search in online knowledge bases for solutions based on the ticket description
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.

==Using Lookup Fields==
Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket.

This way you can define an Online Service for the Ticket, which will be activated from the Ticket window and will be using Account information.

Lookup Field syntax:

<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>

Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account
FLDCRDADDRESS1 is the account's Address field

==Tips & Tricks==
Following are examples of possible Online Services configurations.
These examples are intended to explain the use of Online Services only.

Disclaimer - Before defining your Online Services you should read the terms of use for each web site you want to access. The examples below are displayed to explain how to use online services and how to pass parameters.

===Displaying Online Maps===
'''Google Maps''' - Opens Google Maps and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Maps
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDCRDADDRESS1>+<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDSTATE>+<CMTLBLDATA_FLDCRDZIP>
|}

'''MapQuest''' - Opens MapQuest Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| MapQuest
|-
| Base URL
| <nowiki>http://www.mapquest.com/maps</nowiki>
|-
| URL Parameters
| /map.adp?searchtype=address&country=<CMTLBLDATA_FLDCRDCOUNTRY>&addtohistory=&searchtab=home&formtype=address&popflag=0&latitude=&longitude=&name=&phone=&level=&cat=&address=&city=<CMTLBLDATA_FLDCRDCITY>&state=<CMTLBLDATA_FLDCRDSTATE>&zipcode=<CMTLBLDATA_FLDCRDZIP>
|}

'''Yahoo! Maps''' - Opens Yahoo! Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Yahoo! Maps
|-
| Base URL
| <nowiki>http://maps.yahoo.com</nowiki>
|-
| URL Parameters
| /maps_result?addr=<CMTLBLDATA_FLDCRDADDRESS1>&csz=<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDCOUNTRY>&country=<CMTLBLDATA_FLDCRDSTATE>
|}

===Finding Account Information===
'''Google Company''' - Opens Google and searches for the Account Company Name.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Company
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCOMPANY>
|}

'''Google Contact''' - Opens Google and searches for the Contact Name.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Contact
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCONTACT>
|}

===Finding Ticket Description in Google===
'''Google Ticket''' - Opens Google and searches for the Ticket description.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket Description
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDTKTPROBLEM>
|}

===Finding Account Address From Ticket (using [[Commit Online Services#Using Lookup Fields|Lookup Field]]) ===
'''Google Address From Ticket''' - Opens Google and searches for the Address of the Account which is linked to the Ticket.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDCITY>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDSTATE>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDZIP>
|}

===Displaying HP Warranties===
'''Contributed by Easy I.T'''

'''HP Warranty Lookup''' - Displays HP products warranty expiration dates, using the products number and the products serial number.

Note: Product Number goes into Plate# field (<CMTLBLDATA_FLDASTUSER1>).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| HP Warranty Lookup
|-
| Base URL
| <nowiki>http://h20000.www2.hp.com/bizsupport/TechSupport/WarrantyResults.jsp?</nowiki>
|-
| URL Parameters
| lang=en&cc=us&prodSeriesId=454811&prodTypeId=12454&sn=<CMTLBLDATA_FLDASTSERIALNO>&pn=<CMTLBLDATA_FLDASTUSER1>&country=US&nickname=&find=Display+Warranty+Information+%C2%BB
|}

===Displaying Online Warranties Checks===
'''Contributed by DavidW'''

'''Domain WHOIS''' - WHOIS domain registration information by Network Solutions.

Note: Domain must be stripped from URL (without http://).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (NetworkSolutions)
|-
| Base URL
| <nowiki>http://www.networksolutions.com/whois-search/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''Contributed by ajgyomber'''

'''Domain WHOIS''' - WHOIS domain registration information by Network Solutions.

Note: Domain must be stripped from URL (without http://).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DomainTools)
|-
| Base URL
| <nowiki>http://whois.domaintools.com/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

==Parameters list==

===Parameters List for Accounts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account Number
| <CMTLBLDATA_FLDCRDCARDID2>
|-
| Address: City
| <CMTLBLDATA_FLDCRDCITY>
|-
| Address: Country
| <CMTLBLDATA_FLDCRDCOUNTRY>
|-
| Address: Line1
| <CMTLBLDATA_FLDCRDADDRESS1>
|-
| Address: Line2
| <CMTLBLDATA_FLDCRDADDRESS2>
|-
| Address: Line3
| <CMTLBLDATA_FLDCRDADDRESS3>
|-
| Address: State
| <CMTLBLDATA_FLDCRDSTATE>
|-
| Address: ZIP Code
| <CMTLBLDATA_FLDCRDZIP>
|-
| Assistant
| <CMTLBLDATA_FLDCRDASSISTANT>
|-
| Birthday
| <CMTLBLDATA_FLDCRDBIRTHDAY>
|-
| Company name
| <CMTLBLDATA_FLDCRDCOMPANY>
|-
| Contact: First & Last Name
| <CMTLBLDATA_FLDCRDCONTACT>
|-
| Dear
| <CMTLBLDATA_FLDCRDDEAR>
|-
| Department
| <CMTLBLDATA_FLDCRDDEPARTMENT>
|-
| E-Mail Address 1
| <CMTLBLDATA_FLDCRDEMAIL1>
|-
| E-Mail Address 2
| <CMTLBLDATA_FLDCRDEMAIL2>
|-
| Fax Number
| <CMTLBLDATA_FLDCRDFAX1>
|-
| Fax Number Extention
| <CMTLBLDATA_FLDCRDFAXDESC1>
|-
| Field
| <CMTLBLDATA_FLDCRDPERSONID>
|-
| Field1
| <CMTLBLDATA_FLDCRDUSER2>
|-
| Field2
| <CMTLBLDATA_FLDCRDUSER3>
|-
| Field3
| <CMTLBLDATA_FLDCRDUSER4>
|-
| Field4
| <CMTLBLDATA_FLDCRDUSER5>
|-
| Field5
| <CMTLBLDATA_FLDCRDCOMPANYNO>
|-
| File as
| <CMTLBLDATA_FLDCRDFULLNAME>
|-
| ID
| <CMTLBLDATA_FLDCRDCARDID3>
|-
| Last Name
| <CMTLBLDATA_FLDCRDLASTNAME>
|-
| Phone 1
| <CMTLBLDATA_FLDCRDPHONE1>
|-
| Phone 1 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC1>
|-
| Phone 2
| <CMTLBLDATA_FLDCRDPHONE2>
|-
| Phone 2 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC2>
|-
| Phone 3
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Phone 3 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC3>
|-
| Phone 4
| <CMTLBLDATA_FLDCRDPHONE4>
|-
| Phone 4 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC4>
|-
| Popup Message
| <CMTLBLDATA_FLDCRDCARDMESSAGE>
|-
| Region
| <CMTLBLDATA_FLDCRDREGIONCODE>
|-
| Salutation
| <CMTLBLDATA_FLDCRDSUFFIX>
|-
| Status
| <CMTLBLDATA_FLDCRDUSER1>
|-
| Sub-Contact Code
| <CMTLBLDATA_FLDCRDSUBCODE>
|-
| Title
| <CMTLBLDATA_FLDCRDTITLE>
|-
| Type
| <CMTLBLDATA_FLDCRDKIND>
|-
| Web Address 1
| <CMTLBLDATA_FLDCRDURL1>
|-
| Web Address 2
| <CMTLBLDATA_FLDCRDURL2>
|}

===Parameters list for Assets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTACCRECID>
|-
| Asset Code
| <CMTLBLDATA_FLDASTASSETCODE>
|-
| Asset Type
| <CMTLBLDATA_FLDASTASSETTYPE>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTCONTACTRECID>
|-
| Create Date
| <CMTLBLDATA_FLDASTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDASTCREATEUSER_FLDWRKNICKNAME>
|-
| Purchase Date
| <CMTLBLDATA_FLDASTCUSTPURDATE>
|-
| Purchased From Us
| <CMTLBLDATA_FLDASTCUSTPURFROMUS>
|-
| Purchase Our Invoice #
| <CMTLBLDATA_FLDASTCUSTPUROURINV>
|-
| Customer PO
| <CMTLBLDATA_FLDASTCUSTPURPO>
|-
| Purchase Price
| <CMTLBLDATA_FLDASTCUSTPURPRICE>
|-
| Delivered Date
| <CMTLBLDATA_FLDASTDELIVEDATE>
|-
| Description
| <CMTLBLDATA_FLDASTDESC>
|-
| Installed By
| <CMTLBLDATA_FLDASTINSTALBY_FLDWRKNICKNAME>
|-
| Installed Date
| <CMTLBLDATA_FLDASTINSTALDATE>
|-
| License Codes
| <CMTLBLDATA_FLDASTLICENSECODE>
|-
| License Keys
| <CMTLBLDATA_FLDASTLICENSEKEYS>
|-
| License Notes
| <CMTLBLDATA_FLDASTLICENSENOTES>
|-
| Location
| <CMTLBLDATA_FLDASTLOCATION>
|-
| Manufacturer
| <CMTLBLDATA_FLDASTMANUFACTURER>
|-
| Manufacturer Serial No.
| <CMTLBLDATA_FLDASTMNFSERIALNO>
|-
| Model
| <CMTLBLDATA_FLDASTMODEL>
|-
| Asset Name
| <CMTLBLDATA_FLDASTNAME>
|-
| Notes
| <CMTLBLDATA_FLDASTNOTES>
|-
| PARENTASSETRECID
| <CMTLBLDATA_FLDASTPARENTRECID>
|-
| Quantity
| <CMTLBLDATA_FLDASTQUANTITY>
|-
| Record ID
| <CMTLBLDATA_FLDASTRECID>
|-
| Serial No.
| <CMTLBLDATA_FLDASTSERIALNO>
|-
| Status
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Last Update date
| <CMTLBLDATA_FLDASTUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDASTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDASTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDASTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDASTUSER3>
|-
| Field4
| <CMTLBLDATA_FLDASTUSER4>
|-
| Field5
| <CMTLBLDATA_FLDASTUSER5>
|-
| Date1
| <CMTLBLDATA_FLDASTUSERDATE1>
|-
| Number1
| <CMTLBLDATA_FLDASTUSERNUMBER1>
|-
| Vendor Purchased Date
| <CMTLBLDATA_FLDASTVENDORDATEPURC>
|-
| Vendor Invoice #
| <CMTLBLDATA_FLDASTVENDORINVNO>
|-
| Vendor Name
| <CMTLBLDATA_FLDASTVENDORNAME>
|-
| Vendor PO
| <CMTLBLDATA_FLDASTVENDOROURPO>
|-
| Vendor Price
| <CMTLBLDATA_FLDASTVENDORPRICE>
|-
| Vendor
| <CMTLBLDATA_FLDASTVENDORRECID>
|-
| Vendor Serial No.
| <CMTLBLDATA_FLDASTVENDORSERNO>
|-
| Vendor Warranty Exp. Date
| <CMTLBLDATA_FLDASTVENDORWARREXP>
|-
| Version
| <CMTLBLDATA_FLDASTVERSION>
|-
| Warranty/License Exp. Date
| <CMTLBLDATA_FLDASTWARREXPDATE>FLDASTWARREXPDATE
|}

===Parameters list for Contracts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTACCRECID>
|-
| Block - Used
| <CMTLBLDATA_FLDBCTAMOUNTUSED>
|-
| Code
| <CMTLBLDATA_FLDBCTCODE>
|-
| Contract Type Type
| <CMTLBLDATA_FLDBCTCONTRACTTYPE>
|-
| Create Date
| <CMTLBLDATA_FLDBCTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDBCTCREATEUSER_FLDWRKNICKNAME>
|-
| Default Item Expense ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMEXPNS>
|-
| Default Item Labor ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMLABOR>
|-
| Default Item Part ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMPART>
|-
| Description
| <CMTLBLDATA_FLDBCTDESCEXTERNAL>
|-
| Internal Description
| <CMTLBLDATA_FLDBCTDESCINTERNAL>
|-
| End Date
| <CMTLBLDATA_FLDBCTENDDATE>
|-
| Name
| <CMTLBLDATA_FLDBCTNAME>
|-
| Note
| <CMTLBLDATA_FLDBCTNOTE>
|-
| Record ID
| <CMTLBLDATA_FLDBCTRECID>
|-
| Start Date
| <CMTLBLDATA_FLDBCTSTARTDATE>
|-
| Status
| <CMTLBLDATA_FLDBCTSTATUS>
|-
| Last Update date
| <CMTLBLDATA_FLDBCTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDBCTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field 1
| <CMTLBLDATA_FLDBCTUSER1>
|-
| Field 2
| <CMTLBLDATA_FLDBCTUSER2>
|-
| Field 3
| <CMTLBLDATA_FLDBCTUSER3>
|}

===Parameters list for Items===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Currency
| <CMTLBLDATA_FLDITMCOINID>
|-
| Created by User
| <CMTLBLDATA_FLDITMCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDITMDESC>
|-
| Expense Type
| <CMTLBLDATA_FLDITMEXPITEMTYPE>
|-
| Labor Type
| <CMTLBLDATA_FLDITMFEEITEMTYPE>
|-
| Item Code
| <CMTLBLDATA_FLDITMITEMNO>
|-
| Group
| <CMTLBLDATA_FLDITMITEMTYPEGROUP>
|-
| Name
| <CMTLBLDATA_FLDITMNAME>
|-
| Notes
| <CMTLBLDATA_FLDITMNOTES>
|-
| Price Source
| <CMTLBLDATA_FLDITMPRICESOURCE>
|-
| Product/Part Type
| <CMTLBLDATA_FLDITMPRODITEMTYPE>
|-
| Record Id
| <CMTLBLDATA_FLDITMRECID>
|-
| Cost
| <CMTLBLDATA_FLDITMSTANDARDCOST>
|-
| Suspend
| <CMTLBLDATA_FLDITMSUSPENDED>
|-
| Price
| <CMTLBLDATA_FLDITMUNITPRICE>
|-
| Update Date
| <CMTLBLDATA_FLDITMUPDATEDATE>
|-
| Update User
| <CMTLBLDATA_FLDITMUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDITMUSER1>
|}

===Parameters list for Opportunities===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Amount
| <CMTLBLDATA_FLDOPPAMOUNT>
|-
| Amount by Probability
| <CMTLBLDATA_FLDOPPCALCAMOUNT>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCARDID>
|-
| Closing amnt
| <CMTLBLDATA_FLDOPPCLOSEAMOUNT>
|-
| Close
| <CMTLBLDATA_FLDOPPCLOSEDATE>
|-
| Currency
| <CMTLBLDATA_FLDOPPCOINID>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCONTACTID>
|-
| Creation Date
| <CMTLBLDATA_FLDOPPCREATEDATE>
|-
| Created by User
| <CMTLBLDATA_FLDOPPCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDOPPDESCRIPTION>
|-
| Close By
| <CMTLBLDATA_FLDOPPESTDATE>
|-
| Oppty Type
| <CMTLBLDATA_FLDOPPKIND>
|-
| Opportunity
| <CMTLBLDATA_FLDOPPNAME>
|-
| Note
| <CMTLBLDATA_FLDOPPNOTES>
|-
| Open
| <CMTLBLDATA_FLDOPPOPENDATE>
|-
| Probability %
| <CMTLBLDATA_FLDOPPPROBABILITY>
|-
| Reason
| <CMTLBLDATA_FLDOPPREASON>
|-
| Record ID
| <CMTLBLDATA_FLDOPPRECID>
|-
| Record type
| <CMTLBLDATA_FLDOPPRECKIND>
|-
| Territory
| <CMTLBLDATA_FLDOPPREGION>
|-
| Source
| <CMTLBLDATA_FLDOPPSOURCE>
|-
| Stage
| <CMTLBLDATA_FLDOPPSTAGE>
|-
| Status
| <CMTLBLDATA_FLDOPPSTATUS>
|-
| Last Update Date
| <CMTLBLDATA_FLDOPPUPDATEDATE>
|-
| Last Update: By User
| <CMTLBLDATA_FLDOPPUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDOPPUSER1>
|-
| Field2
| <CMTLBLDATA_FLDOPPUSER2>
|-
| Field3
| <CMTLBLDATA_FLDOPPUSER3>
|-
| Opportunity ID
| <CMTLBLDATA_FLDOPPUSERID>
|-
| Manager
| <CMTLBLDATA_FLDOPPWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Asset ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTASSETRECID>
|-
| Contract ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTBCRECID>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCARDID>
|-
| Category
| <CMTLBLDATA_FLDTKTCATEGORY>
|-
| Cause
| <CMTLBLDATA_FLDTKTCAUSE>
|-
| Close Date
| <CMTLBLDATA_FLDTKTCLOSEDATETIME>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCONTACTID>
|-
| Creation: Date
| <CMTLBLDATA_FLDTKTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDTKTCREATEUSER_FLDWRKNICKNAME>
|-
| Due Date
| <CMTLBLDATA_FLDTKTDUEDATETIME>
|-
| Ticket Type
| <CMTLBLDATA_FLDTKTKIND>
|-
| Notes
| <CMTLBLDATA_FLDTKTNOTES>CMTLBLDATA
|-
| Open Date
| <CMTLBLDATA_FLDTKTOPENDATETIME>
|-
| Priority
| <CMTLBLDATA_FLDTKTPRIORITY>
|-
| Description
| <CMTLBLDATA_FLDTKTPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDTKTRECID>
|-
| Account's Region Code
| <CMTLBLDATA_FLDTKTREGIONCODE>
|-
| Estimated Duration Needed
| <CMTLBLDATA_FLDTKTSCHEDLENESTIM>
|-
| Resolution Description
| <CMTLBLDATA_FLDTKTSOLUTION>
|-
| Source
| <CMTLBLDATA_FLDTKTSOURCE>
|-
| Status
| <CMTLBLDATA_FLDTKTSTATUS>
|-
| Status: Ext.
| <CMTLBLDATA_FLDTKTSTATUSNOTE>
|-
| Ticket Number
| <CMTLBLDATA_FLDTKTTICKETNO>
|-
| Last Update Date
| <CMTLBLDATA_FLDTKTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDTKTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDTKTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDTKTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDTKTUSER3>
|-
| Manager
| <CMTLBLDATA_FLDTKTWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Category
| <CMTLBLDATA_FLDKBACATEGORY>
|-
| Create Date
| <CMTLBLDATA_FLDKBACREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDKBACREATEUSER_FLDWRKNICKNAME>
|-
| Public
| <CMTLBLDATA_FLDKBAISPUBLIC>
|-
| Problem
| <CMTLBLDATA_FLDKBAPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDKBARECID>
|-
| Solution
| <CMTLBLDATA_FLDKBASOLUTION>
|-
| Status
| <CMTLBLDATA_FLDKBASTATUS>
|-
| Title
| <CMTLBLDATA_FLDKBATITLE>
|-
| Last Update date
| <CMTLBLDATA_FLDKBAUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDKBAUPDATEUSER_FLDWRKNICKNAME>
|}

===Lookup Fields===
*Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket. This way you can define an Online Service for the Account, which will be activated from the Ticket window. Lookup Field syntax: <CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1> Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account FLDCRDADDRESS1 is the account's Address field

==See Also==
*[[Online Services FAQ]]

[[Category:Integration]]

Online Services

2009-08-20T13:47:58Z

Yarden: /* Displaying HP Warranties */

{{integration}}

Commit's '''Online Services''' is a powerful feature which allows you to link to web sites (URL) and activate the web application using parameters taken from CommitCRM.

You can define as many online Services as you wish. This feature is available for the following entities: Accounts, Tickets, Assets, Items, Contracts, Knowledge Base Articles and Oppotrunities.
*Accounts window
*Tickets window
*Dispatcher window
*Asset window
*Items window
*Contracts window
*Opportunities window

==What can I use Online Services for?==
Wouldn't you like your technicians to be able to find an address for a scheduled visit with just a single click? You can do this by defining an Online Service which will open maps site (e.g. Google Maps, Yahoo! Maps etc.) and the map will open automatically on the address of the Account or Contact stored in CommitCRM.

This powerful tool allows you to define any URL and open it with parameters. You can basically do with it whatever you want.

==Adding new Online Services==
To define a new Online Service, Open the Online Services Management window from Settings > Online Services. or click the Online Services icon from the Accounts window toolbar. Click the New button to add a new Online Service and enter the following parameters:

*'''Name''' - The name of the service which will be displayed in the Online Services list and menus throughout the system, for example, "Google Maps".
*'''Base URL''' - The URL you wish to open in order to use the Service. This is the address of the main service (before passing any parameters to it), for example http://maps.google.com/maps.
*'''URL Parameters''' - Parameters which will be appended to the URL in order to create specific queries when opening the URL. These parameters can be CommitCRM Account database fields which will be taken and filled from CommitCRM when clicking the Online Service.

See the Tips and Tricks for examples of useful Online Services

==Activating Online Services==
Online Services can be activated from various places in CommitCRM including:
*The '''Account, Ticket, Asset, Item, Opportunity, Contract, Knowledge Base Article windows''' - click the Online Services icon to activate the service for the selected account
*The '''Dispatcher Windows''' - right-click on a selected Ticket to run any Online Service for the Ticket's Account or Contact (such as displaying a map).
*The '''Calendar / Scheduled Appointments''' views - right-click above an Appointment and select Online Services.
*The '''secondary Contacts tab''' - select a Contact, right-click and select Online Services
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.
*'''Secondary Contact selection''' field - right-click and select Online Services.
*The '''Relations tab under Account''' - right-click and select Online Services.

==Possible Usage==
*'''Online Services and Assets''' – Access your MSP product online and pass the Asset ID to display its details from your external system
*'''Online Services and Items''' – Search for better prices for items by passing specific item information directly from within CommitCRM.
*'''Online Services for Assets''' – Search for a specific product review by its hardware serial number.
*'''Online Services for Tickets''' – Search in online knowledge bases for solutions based on the ticket description
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.

==Using Lookup Fields==
Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket.

This way you can define an Online Service for the Ticket, which will be activated from the Ticket window and will be using Account information.

Lookup Field syntax:

<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>

Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account
FLDCRDADDRESS1 is the account's Address field

==Tips & Tricks==
Following are examples of possible Online Services configurations.
These examples are intended to explain the use of Online Services only.

Disclaimer - Before defining your Online Services you should read the terms of use for each web site you want to access. The examples below are displayed to explain how to use online services and how to pass parameters.

===Displaying Online Maps===
'''Google Maps''' - Opens Google Maps and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Maps
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDCRDADDRESS1>+<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDSTATE>+<CMTLBLDATA_FLDCRDZIP>
|}

'''MapQuest''' - Opens MapQuest Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| MapQuest
|-
| Base URL
| <nowiki>http://www.mapquest.com/maps</nowiki>
|-
| URL Parameters
| /map.adp?searchtype=address&country=<CMTLBLDATA_FLDCRDCOUNTRY>&addtohistory=&searchtab=home&formtype=address&popflag=0&latitude=&longitude=&name=&phone=&level=&cat=&address=&city=<CMTLBLDATA_FLDCRDCITY>&state=<CMTLBLDATA_FLDCRDSTATE>&zipcode=<CMTLBLDATA_FLDCRDZIP>
|}

'''Yahoo! Maps''' - Opens Yahoo! Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Yahoo! Maps
|-
| Base URL
| <nowiki>http://maps.yahoo.com</nowiki>
|-
| URL Parameters
| /maps_result?addr=<CMTLBLDATA_FLDCRDADDRESS1>&csz=<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDCOUNTRY>&country=<CMTLBLDATA_FLDCRDSTATE>
|}

===Finding Account Information===
'''Google Company''' - Opens Google and searches for the Account Company Name.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Company
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCOMPANY>
|}

'''Google Contact''' - Opens Google and searches for the Contact Name.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Contact
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCONTACT>
|}

===Finding Ticket Description in Google===
'''Google Ticket''' - Opens Google and searches for the Ticket description.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket Description
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDTKTPROBLEM>
|}

===Finding Account Address From Ticket (using [[Commit Online Services#Using Lookup Fields|Lookup Field]]) ===
'''Google Address From Ticket''' - Opens Google and searches for the Address of the Account which is linked to the Ticket.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDCITY>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDSTATE>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDZIP>
|}

===Displaying HP Warranties===
'''Contributed by Easy I.T'''

'''HP Warranty Lookup''' - Displays HP products warranty expiration dates, using the products number and the products serial number.

Note: Product Number goes into Plate# field (<CMTLBLDATA_FLDASTUSER1>).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| HP Warranty Lookup
|-
| Base URL
| <nowiki>http://h20000.www2.hp.com/bizsupport/TechSupport/WarrantyResults.jsp?</nowiki>
|-
| URL Parameters
| lang=en&cc=us&prodSeriesId=454811&prodTypeId=12454&sn=<CMTLBLDATA_FLDASTSERIALNO>&pn=<CMTLBLDATA_FLDASTUSER1>&country=US&nickname=&find=Display+Warranty+Information+%C2%BB
|}

===Displaying HP Warranties===
'''Contributed by DavidW'''

'''Domain WHOIS''' - WHOIS domain registration information by Network Solutions.

Note: Domain must be stripped from URL (without http://).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (NetworkSolutions)
|-
| Base URL
| <nowiki>http://www.networksolutions.com/whois-search/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

'''Contributed by ajgyomber'''

'''Domain WHOIS''' - WHOIS domain registration information by Network Solutions.

Note: Domain must be stripped from URL (without http://).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Accounts
|-
| Name
| Domain WHOIS (DomainTools)
|-
| Base URL
| <nowiki>http://whois.domaintools.com/</nowiki>
|-
| URL Parameters
| <CMTLBLDATA_FLDCRDURL1>
|}

==Parameters list==

===Parameters List for Accounts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account Number
| <CMTLBLDATA_FLDCRDCARDID2>
|-
| Address: City
| <CMTLBLDATA_FLDCRDCITY>
|-
| Address: Country
| <CMTLBLDATA_FLDCRDCOUNTRY>
|-
| Address: Line1
| <CMTLBLDATA_FLDCRDADDRESS1>
|-
| Address: Line2
| <CMTLBLDATA_FLDCRDADDRESS2>
|-
| Address: Line3
| <CMTLBLDATA_FLDCRDADDRESS3>
|-
| Address: State
| <CMTLBLDATA_FLDCRDSTATE>
|-
| Address: ZIP Code
| <CMTLBLDATA_FLDCRDZIP>
|-
| Assistant
| <CMTLBLDATA_FLDCRDASSISTANT>
|-
| Birthday
| <CMTLBLDATA_FLDCRDBIRTHDAY>
|-
| Company name
| <CMTLBLDATA_FLDCRDCOMPANY>
|-
| Contact: First & Last Name
| <CMTLBLDATA_FLDCRDCONTACT>
|-
| Dear
| <CMTLBLDATA_FLDCRDDEAR>
|-
| Department
| <CMTLBLDATA_FLDCRDDEPARTMENT>
|-
| E-Mail Address 1
| <CMTLBLDATA_FLDCRDEMAIL1>
|-
| E-Mail Address 2
| <CMTLBLDATA_FLDCRDEMAIL2>
|-
| Fax Number
| <CMTLBLDATA_FLDCRDFAX1>
|-
| Fax Number Extention
| <CMTLBLDATA_FLDCRDFAXDESC1>
|-
| Field
| <CMTLBLDATA_FLDCRDPERSONID>
|-
| Field1
| <CMTLBLDATA_FLDCRDUSER2>
|-
| Field2
| <CMTLBLDATA_FLDCRDUSER3>
|-
| Field3
| <CMTLBLDATA_FLDCRDUSER4>
|-
| Field4
| <CMTLBLDATA_FLDCRDUSER5>
|-
| Field5
| <CMTLBLDATA_FLDCRDCOMPANYNO>
|-
| File as
| <CMTLBLDATA_FLDCRDFULLNAME>
|-
| ID
| <CMTLBLDATA_FLDCRDCARDID3>
|-
| Last Name
| <CMTLBLDATA_FLDCRDLASTNAME>
|-
| Phone 1
| <CMTLBLDATA_FLDCRDPHONE1>
|-
| Phone 1 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC1>
|-
| Phone 2
| <CMTLBLDATA_FLDCRDPHONE2>
|-
| Phone 2 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC2>
|-
| Phone 3
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Phone 3 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC3>
|-
| Phone 4
| <CMTLBLDATA_FLDCRDPHONE4>
|-
| Phone 4 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC4>
|-
| Popup Message
| <CMTLBLDATA_FLDCRDCARDMESSAGE>
|-
| Region
| <CMTLBLDATA_FLDCRDREGIONCODE>
|-
| Salutation
| <CMTLBLDATA_FLDCRDSUFFIX>
|-
| Status
| <CMTLBLDATA_FLDCRDUSER1>
|-
| Sub-Contact Code
| <CMTLBLDATA_FLDCRDSUBCODE>
|-
| Title
| <CMTLBLDATA_FLDCRDTITLE>
|-
| Type
| <CMTLBLDATA_FLDCRDKIND>
|-
| Web Address 1
| <CMTLBLDATA_FLDCRDURL1>
|-
| Web Address 2
| <CMTLBLDATA_FLDCRDURL2>
|}

===Parameters list for Assets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTACCRECID>
|-
| Asset Code
| <CMTLBLDATA_FLDASTASSETCODE>
|-
| Asset Type
| <CMTLBLDATA_FLDASTASSETTYPE>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTCONTACTRECID>
|-
| Create Date
| <CMTLBLDATA_FLDASTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDASTCREATEUSER_FLDWRKNICKNAME>
|-
| Purchase Date
| <CMTLBLDATA_FLDASTCUSTPURDATE>
|-
| Purchased From Us
| <CMTLBLDATA_FLDASTCUSTPURFROMUS>
|-
| Purchase Our Invoice #
| <CMTLBLDATA_FLDASTCUSTPUROURINV>
|-
| Customer PO
| <CMTLBLDATA_FLDASTCUSTPURPO>
|-
| Purchase Price
| <CMTLBLDATA_FLDASTCUSTPURPRICE>
|-
| Delivered Date
| <CMTLBLDATA_FLDASTDELIVEDATE>
|-
| Description
| <CMTLBLDATA_FLDASTDESC>
|-
| Installed By
| <CMTLBLDATA_FLDASTINSTALBY_FLDWRKNICKNAME>
|-
| Installed Date
| <CMTLBLDATA_FLDASTINSTALDATE>
|-
| License Codes
| <CMTLBLDATA_FLDASTLICENSECODE>
|-
| License Keys
| <CMTLBLDATA_FLDASTLICENSEKEYS>
|-
| License Notes
| <CMTLBLDATA_FLDASTLICENSENOTES>
|-
| Location
| <CMTLBLDATA_FLDASTLOCATION>
|-
| Manufacturer
| <CMTLBLDATA_FLDASTMANUFACTURER>
|-
| Manufacturer Serial No.
| <CMTLBLDATA_FLDASTMNFSERIALNO>
|-
| Model
| <CMTLBLDATA_FLDASTMODEL>
|-
| Asset Name
| <CMTLBLDATA_FLDASTNAME>
|-
| Notes
| <CMTLBLDATA_FLDASTNOTES>
|-
| PARENTASSETRECID
| <CMTLBLDATA_FLDASTPARENTRECID>
|-
| Quantity
| <CMTLBLDATA_FLDASTQUANTITY>
|-
| Record ID
| <CMTLBLDATA_FLDASTRECID>
|-
| Serial No.
| <CMTLBLDATA_FLDASTSERIALNO>
|-
| Status
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Last Update date
| <CMTLBLDATA_FLDASTUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDASTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDASTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDASTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDASTUSER3>
|-
| Field4
| <CMTLBLDATA_FLDASTUSER4>
|-
| Field5
| <CMTLBLDATA_FLDASTUSER5>
|-
| Date1
| <CMTLBLDATA_FLDASTUSERDATE1>
|-
| Number1
| <CMTLBLDATA_FLDASTUSERNUMBER1>
|-
| Vendor Purchased Date
| <CMTLBLDATA_FLDASTVENDORDATEPURC>
|-
| Vendor Invoice #
| <CMTLBLDATA_FLDASTVENDORINVNO>
|-
| Vendor Name
| <CMTLBLDATA_FLDASTVENDORNAME>
|-
| Vendor PO
| <CMTLBLDATA_FLDASTVENDOROURPO>
|-
| Vendor Price
| <CMTLBLDATA_FLDASTVENDORPRICE>
|-
| Vendor
| <CMTLBLDATA_FLDASTVENDORRECID>
|-
| Vendor Serial No.
| <CMTLBLDATA_FLDASTVENDORSERNO>
|-
| Vendor Warranty Exp. Date
| <CMTLBLDATA_FLDASTVENDORWARREXP>
|-
| Version
| <CMTLBLDATA_FLDASTVERSION>
|-
| Warranty/License Exp. Date
| <CMTLBLDATA_FLDASTWARREXPDATE>FLDASTWARREXPDATE
|}

===Parameters list for Contracts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTACCRECID>
|-
| Block - Used
| <CMTLBLDATA_FLDBCTAMOUNTUSED>
|-
| Code
| <CMTLBLDATA_FLDBCTCODE>
|-
| Contract Type Type
| <CMTLBLDATA_FLDBCTCONTRACTTYPE>
|-
| Create Date
| <CMTLBLDATA_FLDBCTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDBCTCREATEUSER_FLDWRKNICKNAME>
|-
| Default Item Expense ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMEXPNS>
|-
| Default Item Labor ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMLABOR>
|-
| Default Item Part ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMPART>
|-
| Description
| <CMTLBLDATA_FLDBCTDESCEXTERNAL>
|-
| Internal Description
| <CMTLBLDATA_FLDBCTDESCINTERNAL>
|-
| End Date
| <CMTLBLDATA_FLDBCTENDDATE>
|-
| Name
| <CMTLBLDATA_FLDBCTNAME>
|-
| Note
| <CMTLBLDATA_FLDBCTNOTE>
|-
| Record ID
| <CMTLBLDATA_FLDBCTRECID>
|-
| Start Date
| <CMTLBLDATA_FLDBCTSTARTDATE>
|-
| Status
| <CMTLBLDATA_FLDBCTSTATUS>
|-
| Last Update date
| <CMTLBLDATA_FLDBCTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDBCTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field 1
| <CMTLBLDATA_FLDBCTUSER1>
|-
| Field 2
| <CMTLBLDATA_FLDBCTUSER2>
|-
| Field 3
| <CMTLBLDATA_FLDBCTUSER3>
|}

===Parameters list for Items===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Currency
| <CMTLBLDATA_FLDITMCOINID>
|-
| Created by User
| <CMTLBLDATA_FLDITMCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDITMDESC>
|-
| Expense Type
| <CMTLBLDATA_FLDITMEXPITEMTYPE>
|-
| Labor Type
| <CMTLBLDATA_FLDITMFEEITEMTYPE>
|-
| Item Code
| <CMTLBLDATA_FLDITMITEMNO>
|-
| Group
| <CMTLBLDATA_FLDITMITEMTYPEGROUP>
|-
| Name
| <CMTLBLDATA_FLDITMNAME>
|-
| Notes
| <CMTLBLDATA_FLDITMNOTES>
|-
| Price Source
| <CMTLBLDATA_FLDITMPRICESOURCE>
|-
| Product/Part Type
| <CMTLBLDATA_FLDITMPRODITEMTYPE>
|-
| Record Id
| <CMTLBLDATA_FLDITMRECID>
|-
| Cost
| <CMTLBLDATA_FLDITMSTANDARDCOST>
|-
| Suspend
| <CMTLBLDATA_FLDITMSUSPENDED>
|-
| Price
| <CMTLBLDATA_FLDITMUNITPRICE>
|-
| Update Date
| <CMTLBLDATA_FLDITMUPDATEDATE>
|-
| Update User
| <CMTLBLDATA_FLDITMUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDITMUSER1>
|}

===Parameters list for Opportunities===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Amount
| <CMTLBLDATA_FLDOPPAMOUNT>
|-
| Amount by Probability
| <CMTLBLDATA_FLDOPPCALCAMOUNT>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCARDID>
|-
| Closing amnt
| <CMTLBLDATA_FLDOPPCLOSEAMOUNT>
|-
| Close
| <CMTLBLDATA_FLDOPPCLOSEDATE>
|-
| Currency
| <CMTLBLDATA_FLDOPPCOINID>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCONTACTID>
|-
| Creation Date
| <CMTLBLDATA_FLDOPPCREATEDATE>
|-
| Created by User
| <CMTLBLDATA_FLDOPPCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDOPPDESCRIPTION>
|-
| Close By
| <CMTLBLDATA_FLDOPPESTDATE>
|-
| Oppty Type
| <CMTLBLDATA_FLDOPPKIND>
|-
| Opportunity
| <CMTLBLDATA_FLDOPPNAME>
|-
| Note
| <CMTLBLDATA_FLDOPPNOTES>
|-
| Open
| <CMTLBLDATA_FLDOPPOPENDATE>
|-
| Probability %
| <CMTLBLDATA_FLDOPPPROBABILITY>
|-
| Reason
| <CMTLBLDATA_FLDOPPREASON>
|-
| Record ID
| <CMTLBLDATA_FLDOPPRECID>
|-
| Record type
| <CMTLBLDATA_FLDOPPRECKIND>
|-
| Territory
| <CMTLBLDATA_FLDOPPREGION>
|-
| Source
| <CMTLBLDATA_FLDOPPSOURCE>
|-
| Stage
| <CMTLBLDATA_FLDOPPSTAGE>
|-
| Status
| <CMTLBLDATA_FLDOPPSTATUS>
|-
| Last Update Date
| <CMTLBLDATA_FLDOPPUPDATEDATE>
|-
| Last Update: By User
| <CMTLBLDATA_FLDOPPUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDOPPUSER1>
|-
| Field2
| <CMTLBLDATA_FLDOPPUSER2>
|-
| Field3
| <CMTLBLDATA_FLDOPPUSER3>
|-
| Opportunity ID
| <CMTLBLDATA_FLDOPPUSERID>
|-
| Manager
| <CMTLBLDATA_FLDOPPWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Asset ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTASSETRECID>
|-
| Contract ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTBCRECID>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCARDID>
|-
| Category
| <CMTLBLDATA_FLDTKTCATEGORY>
|-
| Cause
| <CMTLBLDATA_FLDTKTCAUSE>
|-
| Close Date
| <CMTLBLDATA_FLDTKTCLOSEDATETIME>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCONTACTID>
|-
| Creation: Date
| <CMTLBLDATA_FLDTKTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDTKTCREATEUSER_FLDWRKNICKNAME>
|-
| Due Date
| <CMTLBLDATA_FLDTKTDUEDATETIME>
|-
| Ticket Type
| <CMTLBLDATA_FLDTKTKIND>
|-
| Notes
| <CMTLBLDATA_FLDTKTNOTES>CMTLBLDATA
|-
| Open Date
| <CMTLBLDATA_FLDTKTOPENDATETIME>
|-
| Priority
| <CMTLBLDATA_FLDTKTPRIORITY>
|-
| Description
| <CMTLBLDATA_FLDTKTPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDTKTRECID>
|-
| Account's Region Code
| <CMTLBLDATA_FLDTKTREGIONCODE>
|-
| Estimated Duration Needed
| <CMTLBLDATA_FLDTKTSCHEDLENESTIM>
|-
| Resolution Description
| <CMTLBLDATA_FLDTKTSOLUTION>
|-
| Source
| <CMTLBLDATA_FLDTKTSOURCE>
|-
| Status
| <CMTLBLDATA_FLDTKTSTATUS>
|-
| Status: Ext.
| <CMTLBLDATA_FLDTKTSTATUSNOTE>
|-
| Ticket Number
| <CMTLBLDATA_FLDTKTTICKETNO>
|-
| Last Update Date
| <CMTLBLDATA_FLDTKTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDTKTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDTKTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDTKTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDTKTUSER3>
|-
| Manager
| <CMTLBLDATA_FLDTKTWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Category
| <CMTLBLDATA_FLDKBACATEGORY>
|-
| Create Date
| <CMTLBLDATA_FLDKBACREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDKBACREATEUSER_FLDWRKNICKNAME>
|-
| Public
| <CMTLBLDATA_FLDKBAISPUBLIC>
|-
| Problem
| <CMTLBLDATA_FLDKBAPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDKBARECID>
|-
| Solution
| <CMTLBLDATA_FLDKBASOLUTION>
|-
| Status
| <CMTLBLDATA_FLDKBASTATUS>
|-
| Title
| <CMTLBLDATA_FLDKBATITLE>
|-
| Last Update date
| <CMTLBLDATA_FLDKBAUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDKBAUPDATEUSER_FLDWRKNICKNAME>
|}

===Lookup Fields===
*Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket. This way you can define an Online Service for the Account, which will be activated from the Ticket window. Lookup Field syntax: <CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1> Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account FLDCRDADDRESS1 is the account's Address field

==See Also==
*[[Online Services FAQ]]

[[Category:Integration]]

Online Services

2009-08-20T13:05:17Z

Yarden: /* Displaying HP Warranties */

{{integration}}

Commit's '''Online Services''' is a powerful feature which allows you to link to web sites (URL) and activate the web application using parameters taken from CommitCRM.

You can define as many online Services as you wish. This feature is available for the following entities: Accounts, Tickets, Assets, Items, Contracts, Knowledge Base Articles and Oppotrunities.
*Accounts window
*Tickets window
*Dispatcher window
*Asset window
*Items window
*Contracts window
*Opportunities window

==What can I use Online Services for?==
Wouldn't you like your technicians to be able to find an address for a scheduled visit with just a single click? You can do this by defining an Online Service which will open maps site (e.g. Google Maps, Yahoo! Maps etc.) and the map will open automatically on the address of the Account or Contact stored in CommitCRM.

This powerful tool allows you to define any URL and open it with parameters. You can basically do with it whatever you want.

==Adding new Online Services==
To define a new Online Service, Open the Online Services Management window from Settings > Online Services. or click the Online Services icon from the Accounts window toolbar. Click the New button to add a new Online Service and enter the following parameters:

*'''Name''' - The name of the service which will be displayed in the Online Services list and menus throughout the system, for example, "Google Maps".
*'''Base URL''' - The URL you wish to open in order to use the Service. This is the address of the main service (before passing any parameters to it), for example http://maps.google.com/maps.
*'''URL Parameters''' - Parameters which will be appended to the URL in order to create specific queries when opening the URL. These parameters can be CommitCRM Account database fields which will be taken and filled from CommitCRM when clicking the Online Service.

See the Tips and Tricks for examples of useful Online Services

==Activating Online Services==
Online Services can be activated from various places in CommitCRM including:
*The '''Account, Ticket, Asset, Item, Opportunity, Contract, Knowledge Base Article windows''' - click the Online Services icon to activate the service for the selected account
*The '''Dispatcher Windows''' - right-click on a selected Ticket to run any Online Service for the Ticket's Account or Contact (such as displaying a map).
*The '''Calendar / Scheduled Appointments''' views - right-click above an Appointment and select Online Services.
*The '''secondary Contacts tab''' - select a Contact, right-click and select Online Services
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.
*'''Secondary Contact selection''' field - right-click and select Online Services.
*The '''Relations tab under Account''' - right-click and select Online Services.

==Possible Usage==
*'''Online Services and Assets''' – Access your MSP product online and pass the Asset ID to display its details from your external system
*'''Online Services and Items''' – Search for better prices for items by passing specific item information directly from within CommitCRM.
*'''Online Services for Assets''' – Search for a specific product review by its hardware serial number.
*'''Online Services for Tickets''' – Search in online knowledge bases for solutions based on the ticket description
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.

==Using Lookup Fields==
Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket.

This way you can define an Online Service for the Ticket, which will be activated from the Ticket window and will be using Account information.

Lookup Field syntax:

<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>

Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account
FLDCRDADDRESS1 is the account's Address field

==Tips & Tricks==
Following are examples of possible Online Services configurations.
These examples are intended to explain the use of Online Services only.

Disclaimer - Before defining your Online Services you should read the terms of use for each web site you want to access. The examples below are displayed to explain how to use online services and how to pass parameters.

===Displaying Online Maps===
'''Google Maps''' - Opens Google Maps and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Maps
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDCRDADDRESS1>+<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDSTATE>+<CMTLBLDATA_FLDCRDZIP>
|}

'''MapQuest''' - Opens MapQuest Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| MapQuest
|-
| Base URL
| <nowiki>http://www.mapquest.com/maps</nowiki>
|-
| URL Parameters
| /map.adp?searchtype=address&country=<CMTLBLDATA_FLDCRDCOUNTRY>&addtohistory=&searchtab=home&formtype=address&popflag=0&latitude=&longitude=&name=&phone=&level=&cat=&address=&city=<CMTLBLDATA_FLDCRDCITY>&state=<CMTLBLDATA_FLDCRDSTATE>&zipcode=<CMTLBLDATA_FLDCRDZIP>
|}

'''Yahoo! Maps''' - Opens Yahoo! Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Yahoo! Maps
|-
| Base URL
| <nowiki>http://maps.yahoo.com</nowiki>
|-
| URL Parameters
| /maps_result?addr=<CMTLBLDATA_FLDCRDADDRESS1>&csz=<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDCOUNTRY>&country=<CMTLBLDATA_FLDCRDSTATE>
|}

===Finding Account Information===
'''Google Company''' - Opens Google and searches for the Account Company Name.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Company
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCOMPANY>
|}

'''Google Contact''' - Opens Google and searches for the Contact Name.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Contact
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCONTACT>
|}

===Finding Ticket Description in Google===
'''Google Ticket''' - Opens Google and searches for the Ticket description.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket Description
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDTKTPROBLEM>
|}

===Finding Account Address From Ticket (using [[Commit Online Services#Using Lookup Fields|Lookup Field]]) ===
'''Google Address From Ticket''' - Opens Google and searches for the Address of the Account which is linked to the Ticket.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDCITY>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDSTATE>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDZIP>
|}

===Displaying HP Warranties===
'''Contributed by Easy I.T'''

'''HP Warranty Lookup''' - Displays HP products warranty expiration dates, using the products number and the products serial number.

Note: Product Number goes into Plate# field (<CMTLBLDATA_FLDASTUSER1>).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Data Source
| Assets
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://h20000.www2.hp.com/bizsupport/TechSupport/WarrantyResults.jsp?</nowiki>
|-
| URL Parameters
| lang=en&cc=us&prodSeriesId=454811&prodTypeId=12454&sn=<CMTLBLDATA_FLDASTSERIALNO>&pn=<CMTLBLDATA_FLDASTUSER1>&country=US&nickname=&find=Display+Warranty+Information+%C2%BB
|}

==Parameters list==

===Parameters List for Accounts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account Number
| <CMTLBLDATA_FLDCRDCARDID2>
|-
| Address: City
| <CMTLBLDATA_FLDCRDCITY>
|-
| Address: Country
| <CMTLBLDATA_FLDCRDCOUNTRY>
|-
| Address: Line1
| <CMTLBLDATA_FLDCRDADDRESS1>
|-
| Address: Line2
| <CMTLBLDATA_FLDCRDADDRESS2>
|-
| Address: Line3
| <CMTLBLDATA_FLDCRDADDRESS3>
|-
| Address: State
| <CMTLBLDATA_FLDCRDSTATE>
|-
| Address: ZIP Code
| <CMTLBLDATA_FLDCRDZIP>
|-
| Assistant
| <CMTLBLDATA_FLDCRDASSISTANT>
|-
| Birthday
| <CMTLBLDATA_FLDCRDBIRTHDAY>
|-
| Company name
| <CMTLBLDATA_FLDCRDCOMPANY>
|-
| Contact: First & Last Name
| <CMTLBLDATA_FLDCRDCONTACT>
|-
| Dear
| <CMTLBLDATA_FLDCRDDEAR>
|-
| Department
| <CMTLBLDATA_FLDCRDDEPARTMENT>
|-
| E-Mail Address 1
| <CMTLBLDATA_FLDCRDEMAIL1>
|-
| E-Mail Address 2
| <CMTLBLDATA_FLDCRDEMAIL2>
|-
| Fax Number
| <CMTLBLDATA_FLDCRDFAX1>
|-
| Fax Number Extention
| <CMTLBLDATA_FLDCRDFAXDESC1>
|-
| Field
| <CMTLBLDATA_FLDCRDPERSONID>
|-
| Field1
| <CMTLBLDATA_FLDCRDUSER2>
|-
| Field2
| <CMTLBLDATA_FLDCRDUSER3>
|-
| Field3
| <CMTLBLDATA_FLDCRDUSER4>
|-
| Field4
| <CMTLBLDATA_FLDCRDUSER5>
|-
| Field5
| <CMTLBLDATA_FLDCRDCOMPANYNO>
|-
| File as
| <CMTLBLDATA_FLDCRDFULLNAME>
|-
| ID
| <CMTLBLDATA_FLDCRDCARDID3>
|-
| Last Name
| <CMTLBLDATA_FLDCRDLASTNAME>
|-
| Phone 1
| <CMTLBLDATA_FLDCRDPHONE1>
|-
| Phone 1 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC1>
|-
| Phone 2
| <CMTLBLDATA_FLDCRDPHONE2>
|-
| Phone 2 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC2>
|-
| Phone 3
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Phone 3 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC3>
|-
| Phone 4
| <CMTLBLDATA_FLDCRDPHONE4>
|-
| Phone 4 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC4>
|-
| Popup Message
| <CMTLBLDATA_FLDCRDCARDMESSAGE>
|-
| Region
| <CMTLBLDATA_FLDCRDREGIONCODE>
|-
| Salutation
| <CMTLBLDATA_FLDCRDSUFFIX>
|-
| Status
| <CMTLBLDATA_FLDCRDUSER1>
|-
| Sub-Contact Code
| <CMTLBLDATA_FLDCRDSUBCODE>
|-
| Title
| <CMTLBLDATA_FLDCRDTITLE>
|-
| Type
| <CMTLBLDATA_FLDCRDKIND>
|-
| Web Address 1
| <CMTLBLDATA_FLDCRDURL1>
|-
| Web Address 2
| <CMTLBLDATA_FLDCRDURL2>
|}

===Parameters list for Assets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTACCRECID>
|-
| Asset Code
| <CMTLBLDATA_FLDASTASSETCODE>
|-
| Asset Type
| <CMTLBLDATA_FLDASTASSETTYPE>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTCONTACTRECID>
|-
| Create Date
| <CMTLBLDATA_FLDASTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDASTCREATEUSER_FLDWRKNICKNAME>
|-
| Purchase Date
| <CMTLBLDATA_FLDASTCUSTPURDATE>
|-
| Purchased From Us
| <CMTLBLDATA_FLDASTCUSTPURFROMUS>
|-
| Purchase Our Invoice #
| <CMTLBLDATA_FLDASTCUSTPUROURINV>
|-
| Customer PO
| <CMTLBLDATA_FLDASTCUSTPURPO>
|-
| Purchase Price
| <CMTLBLDATA_FLDASTCUSTPURPRICE>
|-
| Delivered Date
| <CMTLBLDATA_FLDASTDELIVEDATE>
|-
| Description
| <CMTLBLDATA_FLDASTDESC>
|-
| Installed By
| <CMTLBLDATA_FLDASTINSTALBY_FLDWRKNICKNAME>
|-
| Installed Date
| <CMTLBLDATA_FLDASTINSTALDATE>
|-
| License Codes
| <CMTLBLDATA_FLDASTLICENSECODE>
|-
| License Keys
| <CMTLBLDATA_FLDASTLICENSEKEYS>
|-
| License Notes
| <CMTLBLDATA_FLDASTLICENSENOTES>
|-
| Location
| <CMTLBLDATA_FLDASTLOCATION>
|-
| Manufacturer
| <CMTLBLDATA_FLDASTMANUFACTURER>
|-
| Manufacturer Serial No.
| <CMTLBLDATA_FLDASTMNFSERIALNO>
|-
| Model
| <CMTLBLDATA_FLDASTMODEL>
|-
| Asset Name
| <CMTLBLDATA_FLDASTNAME>
|-
| Notes
| <CMTLBLDATA_FLDASTNOTES>
|-
| PARENTASSETRECID
| <CMTLBLDATA_FLDASTPARENTRECID>
|-
| Quantity
| <CMTLBLDATA_FLDASTQUANTITY>
|-
| Record ID
| <CMTLBLDATA_FLDASTRECID>
|-
| Serial No.
| <CMTLBLDATA_FLDASTSERIALNO>
|-
| Status
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Last Update date
| <CMTLBLDATA_FLDASTUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDASTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDASTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDASTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDASTUSER3>
|-
| Field4
| <CMTLBLDATA_FLDASTUSER4>
|-
| Field5
| <CMTLBLDATA_FLDASTUSER5>
|-
| Date1
| <CMTLBLDATA_FLDASTUSERDATE1>
|-
| Number1
| <CMTLBLDATA_FLDASTUSERNUMBER1>
|-
| Vendor Purchased Date
| <CMTLBLDATA_FLDASTVENDORDATEPURC>
|-
| Vendor Invoice #
| <CMTLBLDATA_FLDASTVENDORINVNO>
|-
| Vendor Name
| <CMTLBLDATA_FLDASTVENDORNAME>
|-
| Vendor PO
| <CMTLBLDATA_FLDASTVENDOROURPO>
|-
| Vendor Price
| <CMTLBLDATA_FLDASTVENDORPRICE>
|-
| Vendor
| <CMTLBLDATA_FLDASTVENDORRECID>
|-
| Vendor Serial No.
| <CMTLBLDATA_FLDASTVENDORSERNO>
|-
| Vendor Warranty Exp. Date
| <CMTLBLDATA_FLDASTVENDORWARREXP>
|-
| Version
| <CMTLBLDATA_FLDASTVERSION>
|-
| Warranty/License Exp. Date
| <CMTLBLDATA_FLDASTWARREXPDATE>FLDASTWARREXPDATE
|}

===Parameters list for Contracts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTACCRECID>
|-
| Block - Used
| <CMTLBLDATA_FLDBCTAMOUNTUSED>
|-
| Code
| <CMTLBLDATA_FLDBCTCODE>
|-
| Contract Type Type
| <CMTLBLDATA_FLDBCTCONTRACTTYPE>
|-
| Create Date
| <CMTLBLDATA_FLDBCTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDBCTCREATEUSER_FLDWRKNICKNAME>
|-
| Default Item Expense ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMEXPNS>
|-
| Default Item Labor ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMLABOR>
|-
| Default Item Part ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMPART>
|-
| Description
| <CMTLBLDATA_FLDBCTDESCEXTERNAL>
|-
| Internal Description
| <CMTLBLDATA_FLDBCTDESCINTERNAL>
|-
| End Date
| <CMTLBLDATA_FLDBCTENDDATE>
|-
| Name
| <CMTLBLDATA_FLDBCTNAME>
|-
| Note
| <CMTLBLDATA_FLDBCTNOTE>
|-
| Record ID
| <CMTLBLDATA_FLDBCTRECID>
|-
| Start Date
| <CMTLBLDATA_FLDBCTSTARTDATE>
|-
| Status
| <CMTLBLDATA_FLDBCTSTATUS>
|-
| Last Update date
| <CMTLBLDATA_FLDBCTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDBCTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field 1
| <CMTLBLDATA_FLDBCTUSER1>
|-
| Field 2
| <CMTLBLDATA_FLDBCTUSER2>
|-
| Field 3
| <CMTLBLDATA_FLDBCTUSER3>
|}

===Parameters list for Items===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Currency
| <CMTLBLDATA_FLDITMCOINID>
|-
| Created by User
| <CMTLBLDATA_FLDITMCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDITMDESC>
|-
| Expense Type
| <CMTLBLDATA_FLDITMEXPITEMTYPE>
|-
| Labor Type
| <CMTLBLDATA_FLDITMFEEITEMTYPE>
|-
| Item Code
| <CMTLBLDATA_FLDITMITEMNO>
|-
| Group
| <CMTLBLDATA_FLDITMITEMTYPEGROUP>
|-
| Name
| <CMTLBLDATA_FLDITMNAME>
|-
| Notes
| <CMTLBLDATA_FLDITMNOTES>
|-
| Price Source
| <CMTLBLDATA_FLDITMPRICESOURCE>
|-
| Product/Part Type
| <CMTLBLDATA_FLDITMPRODITEMTYPE>
|-
| Record Id
| <CMTLBLDATA_FLDITMRECID>
|-
| Cost
| <CMTLBLDATA_FLDITMSTANDARDCOST>
|-
| Suspend
| <CMTLBLDATA_FLDITMSUSPENDED>
|-
| Price
| <CMTLBLDATA_FLDITMUNITPRICE>
|-
| Update Date
| <CMTLBLDATA_FLDITMUPDATEDATE>
|-
| Update User
| <CMTLBLDATA_FLDITMUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDITMUSER1>
|}

===Parameters list for Opportunities===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Amount
| <CMTLBLDATA_FLDOPPAMOUNT>
|-
| Amount by Probability
| <CMTLBLDATA_FLDOPPCALCAMOUNT>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCARDID>
|-
| Closing amnt
| <CMTLBLDATA_FLDOPPCLOSEAMOUNT>
|-
| Close
| <CMTLBLDATA_FLDOPPCLOSEDATE>
|-
| Currency
| <CMTLBLDATA_FLDOPPCOINID>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCONTACTID>
|-
| Creation Date
| <CMTLBLDATA_FLDOPPCREATEDATE>
|-
| Created by User
| <CMTLBLDATA_FLDOPPCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDOPPDESCRIPTION>
|-
| Close By
| <CMTLBLDATA_FLDOPPESTDATE>
|-
| Oppty Type
| <CMTLBLDATA_FLDOPPKIND>
|-
| Opportunity
| <CMTLBLDATA_FLDOPPNAME>
|-
| Note
| <CMTLBLDATA_FLDOPPNOTES>
|-
| Open
| <CMTLBLDATA_FLDOPPOPENDATE>
|-
| Probability %
| <CMTLBLDATA_FLDOPPPROBABILITY>
|-
| Reason
| <CMTLBLDATA_FLDOPPREASON>
|-
| Record ID
| <CMTLBLDATA_FLDOPPRECID>
|-
| Record type
| <CMTLBLDATA_FLDOPPRECKIND>
|-
| Territory
| <CMTLBLDATA_FLDOPPREGION>
|-
| Source
| <CMTLBLDATA_FLDOPPSOURCE>
|-
| Stage
| <CMTLBLDATA_FLDOPPSTAGE>
|-
| Status
| <CMTLBLDATA_FLDOPPSTATUS>
|-
| Last Update Date
| <CMTLBLDATA_FLDOPPUPDATEDATE>
|-
| Last Update: By User
| <CMTLBLDATA_FLDOPPUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDOPPUSER1>
|-
| Field2
| <CMTLBLDATA_FLDOPPUSER2>
|-
| Field3
| <CMTLBLDATA_FLDOPPUSER3>
|-
| Opportunity ID
| <CMTLBLDATA_FLDOPPUSERID>
|-
| Manager
| <CMTLBLDATA_FLDOPPWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Asset ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTASSETRECID>
|-
| Contract ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTBCRECID>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCARDID>
|-
| Category
| <CMTLBLDATA_FLDTKTCATEGORY>
|-
| Cause
| <CMTLBLDATA_FLDTKTCAUSE>
|-
| Close Date
| <CMTLBLDATA_FLDTKTCLOSEDATETIME>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCONTACTID>
|-
| Creation: Date
| <CMTLBLDATA_FLDTKTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDTKTCREATEUSER_FLDWRKNICKNAME>
|-
| Due Date
| <CMTLBLDATA_FLDTKTDUEDATETIME>
|-
| Ticket Type
| <CMTLBLDATA_FLDTKTKIND>
|-
| Notes
| <CMTLBLDATA_FLDTKTNOTES>CMTLBLDATA
|-
| Open Date
| <CMTLBLDATA_FLDTKTOPENDATETIME>
|-
| Priority
| <CMTLBLDATA_FLDTKTPRIORITY>
|-
| Description
| <CMTLBLDATA_FLDTKTPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDTKTRECID>
|-
| Account's Region Code
| <CMTLBLDATA_FLDTKTREGIONCODE>
|-
| Estimated Duration Needed
| <CMTLBLDATA_FLDTKTSCHEDLENESTIM>
|-
| Resolution Description
| <CMTLBLDATA_FLDTKTSOLUTION>
|-
| Source
| <CMTLBLDATA_FLDTKTSOURCE>
|-
| Status
| <CMTLBLDATA_FLDTKTSTATUS>
|-
| Status: Ext.
| <CMTLBLDATA_FLDTKTSTATUSNOTE>
|-
| Ticket Number
| <CMTLBLDATA_FLDTKTTICKETNO>
|-
| Last Update Date
| <CMTLBLDATA_FLDTKTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDTKTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDTKTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDTKTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDTKTUSER3>
|-
| Manager
| <CMTLBLDATA_FLDTKTWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Category
| <CMTLBLDATA_FLDKBACATEGORY>
|-
| Create Date
| <CMTLBLDATA_FLDKBACREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDKBACREATEUSER_FLDWRKNICKNAME>
|-
| Public
| <CMTLBLDATA_FLDKBAISPUBLIC>
|-
| Problem
| <CMTLBLDATA_FLDKBAPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDKBARECID>
|-
| Solution
| <CMTLBLDATA_FLDKBASOLUTION>
|-
| Status
| <CMTLBLDATA_FLDKBASTATUS>
|-
| Title
| <CMTLBLDATA_FLDKBATITLE>
|-
| Last Update date
| <CMTLBLDATA_FLDKBAUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDKBAUPDATEUSER_FLDWRKNICKNAME>
|}

===Lookup Fields===
*Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket. This way you can define an Online Service for the Account, which will be activated from the Ticket window. Lookup Field syntax: <CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1> Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account FLDCRDADDRESS1 is the account's Address field

==See Also==
*[[Online Services FAQ]]

[[Category:Integration]]

Online Services

2009-08-20T13:03:57Z

Yarden: /* Finding Account Address From Ticket (using Lookup Field) */

{{integration}}

Commit's '''Online Services''' is a powerful feature which allows you to link to web sites (URL) and activate the web application using parameters taken from CommitCRM.

You can define as many online Services as you wish. This feature is available for the following entities: Accounts, Tickets, Assets, Items, Contracts, Knowledge Base Articles and Oppotrunities.
*Accounts window
*Tickets window
*Dispatcher window
*Asset window
*Items window
*Contracts window
*Opportunities window

==What can I use Online Services for?==
Wouldn't you like your technicians to be able to find an address for a scheduled visit with just a single click? You can do this by defining an Online Service which will open maps site (e.g. Google Maps, Yahoo! Maps etc.) and the map will open automatically on the address of the Account or Contact stored in CommitCRM.

This powerful tool allows you to define any URL and open it with parameters. You can basically do with it whatever you want.

==Adding new Online Services==
To define a new Online Service, Open the Online Services Management window from Settings > Online Services. or click the Online Services icon from the Accounts window toolbar. Click the New button to add a new Online Service and enter the following parameters:

*'''Name''' - The name of the service which will be displayed in the Online Services list and menus throughout the system, for example, "Google Maps".
*'''Base URL''' - The URL you wish to open in order to use the Service. This is the address of the main service (before passing any parameters to it), for example http://maps.google.com/maps.
*'''URL Parameters''' - Parameters which will be appended to the URL in order to create specific queries when opening the URL. These parameters can be CommitCRM Account database fields which will be taken and filled from CommitCRM when clicking the Online Service.

See the Tips and Tricks for examples of useful Online Services

==Activating Online Services==
Online Services can be activated from various places in CommitCRM including:
*The '''Account, Ticket, Asset, Item, Opportunity, Contract, Knowledge Base Article windows''' - click the Online Services icon to activate the service for the selected account
*The '''Dispatcher Windows''' - right-click on a selected Ticket to run any Online Service for the Ticket's Account or Contact (such as displaying a map).
*The '''Calendar / Scheduled Appointments''' views - right-click above an Appointment and select Online Services.
*The '''secondary Contacts tab''' - select a Contact, right-click and select Online Services
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.
*'''Secondary Contact selection''' field - right-click and select Online Services.
*The '''Relations tab under Account''' - right-click and select Online Services.

==Possible Usage==
*'''Online Services and Assets''' – Access your MSP product online and pass the Asset ID to display its details from your external system
*'''Online Services and Items''' – Search for better prices for items by passing specific item information directly from within CommitCRM.
*'''Online Services for Assets''' – Search for a specific product review by its hardware serial number.
*'''Online Services for Tickets''' – Search in online knowledge bases for solutions based on the ticket description
*'''Selection field''' - anywhere where the entity selection field is displayed - right-click and select Online Services, activate Online Services.

==Using Lookup Fields==
Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket.

This way you can define an Online Service for the Ticket, which will be activated from the Ticket window and will be using Account information.

Lookup Field syntax:

<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>

Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account
FLDCRDADDRESS1 is the account's Address field

==Tips & Tricks==
Following are examples of possible Online Services configurations.
These examples are intended to explain the use of Online Services only.

Disclaimer - Before defining your Online Services you should read the terms of use for each web site you want to access. The examples below are displayed to explain how to use online services and how to pass parameters.

===Displaying Online Maps===
'''Google Maps''' - Opens Google Maps and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Maps
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDCRDADDRESS1>+<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDSTATE>+<CMTLBLDATA_FLDCRDZIP>
|}

'''MapQuest''' - Opens MapQuest Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| MapQuest
|-
| Base URL
| <nowiki>http://www.mapquest.com/maps</nowiki>
|-
| URL Parameters
| /map.adp?searchtype=address&country=<CMTLBLDATA_FLDCRDCOUNTRY>&addtohistory=&searchtab=home&formtype=address&popflag=0&latitude=&longitude=&name=&phone=&level=&cat=&address=&city=<CMTLBLDATA_FLDCRDCITY>&state=<CMTLBLDATA_FLDCRDSTATE>&zipcode=<CMTLBLDATA_FLDCRDZIP>
|}

'''Yahoo! Maps''' - Opens Yahoo! Map and displays the Account/Contact address.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Yahoo! Maps
|-
| Base URL
| <nowiki>http://maps.yahoo.com</nowiki>
|-
| URL Parameters
| /maps_result?addr=<CMTLBLDATA_FLDCRDADDRESS1>&csz=<CMTLBLDATA_FLDCRDCITY>+<CMTLBLDATA_FLDCRDCOUNTRY>&country=<CMTLBLDATA_FLDCRDSTATE>
|}

===Finding Account Information===
'''Google Company''' - Opens Google and searches for the Account Company Name.

{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Company
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCOMPANY>
|}

'''Google Contact''' - Opens Google and searches for the Contact Name.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Contact
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDCRDCONTACT>
|}

===Finding Ticket Description in Google===
'''Google Ticket''' - Opens Google and searches for the Ticket description.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket Description
|-
| Base URL
| <nowiki>http://www.google.com/search</nowiki>
|-
| URL Parameters
| ?q=<CMTLBLDATA_FLDTKTPROBLEM>
|}

===Finding Account Address From Ticket (using [[Commit Online Services#Using Lookup Fields|Lookup Field]]) ===
'''Google Address From Ticket''' - Opens Google and searches for the Address of the Account which is linked to the Ticket.
{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://maps.google.com/maps</nowiki>
|-
| URL Parameters
| ?f=q&hl=en&q=<CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDCITY>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDSTATE>+<CMTLBLDATA_FLDTKTCARDID_FLDCRDZIP>
|}

===Displaying HP Warranties===
'''Contributed by Easy I.T'''

'''HP Warranty Lookup''' - Displays HP products warranty expiration dates, using the products number and the products serial number.

Note: Product Number goes into Plate# field (<CMTLBLDATA_FLDASTUSER1>).

{| class="wikitable"
|-
! Parameters
! Values
|-
| Name
| Google Search for Ticket's Account Address
|-
| Base URL
| <nowiki>http://h20000.www2.hp.com/bizsupport/TechSupport/WarrantyResults.jsp?</nowiki>
|-
| URL Parameters
| lang=en&cc=us&prodSeriesId=454811&prodTypeId=12454&sn=<CMTLBLDATA_FLDASTSERIALNO>&pn=<CMTLBLDATA_FLDASTUSER1>&country=US&nickname=&find=Display+Warranty+Information+%C2%BB
|}

==Parameters list==

===Parameters List for Accounts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account Number
| <CMTLBLDATA_FLDCRDCARDID2>
|-
| Address: City
| <CMTLBLDATA_FLDCRDCITY>
|-
| Address: Country
| <CMTLBLDATA_FLDCRDCOUNTRY>
|-
| Address: Line1
| <CMTLBLDATA_FLDCRDADDRESS1>
|-
| Address: Line2
| <CMTLBLDATA_FLDCRDADDRESS2>
|-
| Address: Line3
| <CMTLBLDATA_FLDCRDADDRESS3>
|-
| Address: State
| <CMTLBLDATA_FLDCRDSTATE>
|-
| Address: ZIP Code
| <CMTLBLDATA_FLDCRDZIP>
|-
| Assistant
| <CMTLBLDATA_FLDCRDASSISTANT>
|-
| Birthday
| <CMTLBLDATA_FLDCRDBIRTHDAY>
|-
| Company name
| <CMTLBLDATA_FLDCRDCOMPANY>
|-
| Contact: First & Last Name
| <CMTLBLDATA_FLDCRDCONTACT>
|-
| Dear
| <CMTLBLDATA_FLDCRDDEAR>
|-
| Department
| <CMTLBLDATA_FLDCRDDEPARTMENT>
|-
| E-Mail Address 1
| <CMTLBLDATA_FLDCRDEMAIL1>
|-
| E-Mail Address 2
| <CMTLBLDATA_FLDCRDEMAIL2>
|-
| Fax Number
| <CMTLBLDATA_FLDCRDFAX1>
|-
| Fax Number Extention
| <CMTLBLDATA_FLDCRDFAXDESC1>
|-
| Field
| <CMTLBLDATA_FLDCRDPERSONID>
|-
| Field1
| <CMTLBLDATA_FLDCRDUSER2>
|-
| Field2
| <CMTLBLDATA_FLDCRDUSER3>
|-
| Field3
| <CMTLBLDATA_FLDCRDUSER4>
|-
| Field4
| <CMTLBLDATA_FLDCRDUSER5>
|-
| Field5
| <CMTLBLDATA_FLDCRDCOMPANYNO>
|-
| File as
| <CMTLBLDATA_FLDCRDFULLNAME>
|-
| ID
| <CMTLBLDATA_FLDCRDCARDID3>
|-
| Last Name
| <CMTLBLDATA_FLDCRDLASTNAME>
|-
| Phone 1
| <CMTLBLDATA_FLDCRDPHONE1>
|-
| Phone 1 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC1>
|-
| Phone 2
| <CMTLBLDATA_FLDCRDPHONE2>
|-
| Phone 2 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC2>
|-
| Phone 3
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Phone 3 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC3>
|-
| Phone 4
| <CMTLBLDATA_FLDCRDPHONE4>
|-
| Phone 4 Ext.
| <CMTLBLDATA_FLDCRDPHNDESC4>
|-
| Popup Message
| <CMTLBLDATA_FLDCRDCARDMESSAGE>
|-
| Region
| <CMTLBLDATA_FLDCRDREGIONCODE>
|-
| Salutation
| <CMTLBLDATA_FLDCRDSUFFIX>
|-
| Status
| <CMTLBLDATA_FLDCRDUSER1>
|-
| Sub-Contact Code
| <CMTLBLDATA_FLDCRDSUBCODE>
|-
| Title
| <CMTLBLDATA_FLDCRDTITLE>
|-
| Type
| <CMTLBLDATA_FLDCRDKIND>
|-
| Web Address 1
| <CMTLBLDATA_FLDCRDURL1>
|-
| Web Address 2
| <CMTLBLDATA_FLDCRDURL2>
|}

===Parameters list for Assets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTACCRECID>
|-
| Asset Code
| <CMTLBLDATA_FLDASTASSETCODE>
|-
| Asset Type
| <CMTLBLDATA_FLDASTASSETTYPE>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDASTCONTACTRECID>
|-
| Create Date
| <CMTLBLDATA_FLDASTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDASTCREATEUSER_FLDWRKNICKNAME>
|-
| Purchase Date
| <CMTLBLDATA_FLDASTCUSTPURDATE>
|-
| Purchased From Us
| <CMTLBLDATA_FLDASTCUSTPURFROMUS>
|-
| Purchase Our Invoice #
| <CMTLBLDATA_FLDASTCUSTPUROURINV>
|-
| Customer PO
| <CMTLBLDATA_FLDASTCUSTPURPO>
|-
| Purchase Price
| <CMTLBLDATA_FLDASTCUSTPURPRICE>
|-
| Delivered Date
| <CMTLBLDATA_FLDASTDELIVEDATE>
|-
| Description
| <CMTLBLDATA_FLDASTDESC>
|-
| Installed By
| <CMTLBLDATA_FLDASTINSTALBY_FLDWRKNICKNAME>
|-
| Installed Date
| <CMTLBLDATA_FLDASTINSTALDATE>
|-
| License Codes
| <CMTLBLDATA_FLDASTLICENSECODE>
|-
| License Keys
| <CMTLBLDATA_FLDASTLICENSEKEYS>
|-
| License Notes
| <CMTLBLDATA_FLDASTLICENSENOTES>
|-
| Location
| <CMTLBLDATA_FLDASTLOCATION>
|-
| Manufacturer
| <CMTLBLDATA_FLDASTMANUFACTURER>
|-
| Manufacturer Serial No.
| <CMTLBLDATA_FLDASTMNFSERIALNO>
|-
| Model
| <CMTLBLDATA_FLDASTMODEL>
|-
| Asset Name
| <CMTLBLDATA_FLDASTNAME>
|-
| Notes
| <CMTLBLDATA_FLDASTNOTES>
|-
| PARENTASSETRECID
| <CMTLBLDATA_FLDASTPARENTRECID>
|-
| Quantity
| <CMTLBLDATA_FLDASTQUANTITY>
|-
| Record ID
| <CMTLBLDATA_FLDASTRECID>
|-
| Serial No.
| <CMTLBLDATA_FLDASTSERIALNO>
|-
| Status
| <CMTLBLDATA_FLDCRDPHONE3>
|-
| Last Update date
| <CMTLBLDATA_FLDASTUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDASTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDASTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDASTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDASTUSER3>
|-
| Field4
| <CMTLBLDATA_FLDASTUSER4>
|-
| Field5
| <CMTLBLDATA_FLDASTUSER5>
|-
| Date1
| <CMTLBLDATA_FLDASTUSERDATE1>
|-
| Number1
| <CMTLBLDATA_FLDASTUSERNUMBER1>
|-
| Vendor Purchased Date
| <CMTLBLDATA_FLDASTVENDORDATEPURC>
|-
| Vendor Invoice #
| <CMTLBLDATA_FLDASTVENDORINVNO>
|-
| Vendor Name
| <CMTLBLDATA_FLDASTVENDORNAME>
|-
| Vendor PO
| <CMTLBLDATA_FLDASTVENDOROURPO>
|-
| Vendor Price
| <CMTLBLDATA_FLDASTVENDORPRICE>
|-
| Vendor
| <CMTLBLDATA_FLDASTVENDORRECID>
|-
| Vendor Serial No.
| <CMTLBLDATA_FLDASTVENDORSERNO>
|-
| Vendor Warranty Exp. Date
| <CMTLBLDATA_FLDASTVENDORWARREXP>
|-
| Version
| <CMTLBLDATA_FLDASTVERSION>
|-
| Warranty/License Exp. Date
| <CMTLBLDATA_FLDASTWARREXPDATE>FLDASTWARREXPDATE
|}

===Parameters list for Contracts===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTACCRECID>
|-
| Block - Used
| <CMTLBLDATA_FLDBCTAMOUNTUSED>
|-
| Code
| <CMTLBLDATA_FLDBCTCODE>
|-
| Contract Type Type
| <CMTLBLDATA_FLDBCTCONTRACTTYPE>
|-
| Create Date
| <CMTLBLDATA_FLDBCTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDBCTCREATEUSER_FLDWRKNICKNAME>
|-
| Default Item Expense ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMEXPNS>
|-
| Default Item Labor ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMLABOR>
|-
| Default Item Part ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDBCTDEFITMPART>
|-
| Description
| <CMTLBLDATA_FLDBCTDESCEXTERNAL>
|-
| Internal Description
| <CMTLBLDATA_FLDBCTDESCINTERNAL>
|-
| End Date
| <CMTLBLDATA_FLDBCTENDDATE>
|-
| Name
| <CMTLBLDATA_FLDBCTNAME>
|-
| Note
| <CMTLBLDATA_FLDBCTNOTE>
|-
| Record ID
| <CMTLBLDATA_FLDBCTRECID>
|-
| Start Date
| <CMTLBLDATA_FLDBCTSTARTDATE>
|-
| Status
| <CMTLBLDATA_FLDBCTSTATUS>
|-
| Last Update date
| <CMTLBLDATA_FLDBCTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDBCTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field 1
| <CMTLBLDATA_FLDBCTUSER1>
|-
| Field 2
| <CMTLBLDATA_FLDBCTUSER2>
|-
| Field 3
| <CMTLBLDATA_FLDBCTUSER3>
|}

===Parameters list for Items===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Currency
| <CMTLBLDATA_FLDITMCOINID>
|-
| Created by User
| <CMTLBLDATA_FLDITMCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDITMDESC>
|-
| Expense Type
| <CMTLBLDATA_FLDITMEXPITEMTYPE>
|-
| Labor Type
| <CMTLBLDATA_FLDITMFEEITEMTYPE>
|-
| Item Code
| <CMTLBLDATA_FLDITMITEMNO>
|-
| Group
| <CMTLBLDATA_FLDITMITEMTYPEGROUP>
|-
| Name
| <CMTLBLDATA_FLDITMNAME>
|-
| Notes
| <CMTLBLDATA_FLDITMNOTES>
|-
| Price Source
| <CMTLBLDATA_FLDITMPRICESOURCE>
|-
| Product/Part Type
| <CMTLBLDATA_FLDITMPRODITEMTYPE>
|-
| Record Id
| <CMTLBLDATA_FLDITMRECID>
|-
| Cost
| <CMTLBLDATA_FLDITMSTANDARDCOST>
|-
| Suspend
| <CMTLBLDATA_FLDITMSUSPENDED>
|-
| Price
| <CMTLBLDATA_FLDITMUNITPRICE>
|-
| Update Date
| <CMTLBLDATA_FLDITMUPDATEDATE>
|-
| Update User
| <CMTLBLDATA_FLDITMUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDITMUSER1>
|}

===Parameters list for Opportunities===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Amount
| <CMTLBLDATA_FLDOPPAMOUNT>
|-
| Amount by Probability
| <CMTLBLDATA_FLDOPPCALCAMOUNT>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCARDID>
|-
| Closing amnt
| <CMTLBLDATA_FLDOPPCLOSEAMOUNT>
|-
| Close
| <CMTLBLDATA_FLDOPPCLOSEDATE>
|-
| Currency
| <CMTLBLDATA_FLDOPPCOINID>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDOPPCONTACTID>
|-
| Creation Date
| <CMTLBLDATA_FLDOPPCREATEDATE>
|-
| Created by User
| <CMTLBLDATA_FLDOPPCREATEUSER_FLDWRKNICKNAME>
|-
| Description
| <CMTLBLDATA_FLDOPPDESCRIPTION>
|-
| Close By
| <CMTLBLDATA_FLDOPPESTDATE>
|-
| Oppty Type
| <CMTLBLDATA_FLDOPPKIND>
|-
| Opportunity
| <CMTLBLDATA_FLDOPPNAME>
|-
| Note
| <CMTLBLDATA_FLDOPPNOTES>
|-
| Open
| <CMTLBLDATA_FLDOPPOPENDATE>
|-
| Probability %
| <CMTLBLDATA_FLDOPPPROBABILITY>
|-
| Reason
| <CMTLBLDATA_FLDOPPREASON>
|-
| Record ID
| <CMTLBLDATA_FLDOPPRECID>
|-
| Record type
| <CMTLBLDATA_FLDOPPRECKIND>
|-
| Territory
| <CMTLBLDATA_FLDOPPREGION>
|-
| Source
| <CMTLBLDATA_FLDOPPSOURCE>
|-
| Stage
| <CMTLBLDATA_FLDOPPSTAGE>
|-
| Status
| <CMTLBLDATA_FLDOPPSTATUS>
|-
| Last Update Date
| <CMTLBLDATA_FLDOPPUPDATEDATE>
|-
| Last Update: By User
| <CMTLBLDATA_FLDOPPUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDOPPUSER1>
|-
| Field2
| <CMTLBLDATA_FLDOPPUSER2>
|-
| Field3
| <CMTLBLDATA_FLDOPPUSER3>
|-
| Opportunity ID
| <CMTLBLDATA_FLDOPPUSERID>
|-
| Manager
| <CMTLBLDATA_FLDOPPWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Asset ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTASSETRECID>
|-
| Contract ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTBCRECID>
|-
| Account ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCARDID>
|-
| Category
| <CMTLBLDATA_FLDTKTCATEGORY>
|-
| Cause
| <CMTLBLDATA_FLDTKTCAUSE>
|-
| Close Date
| <CMTLBLDATA_FLDTKTCLOSEDATETIME>
|-
| Contact ([[Commit Online Services#Lookup Fields|Lookup field]])
| <CMTLBLDATA_FLDTKTCONTACTID>
|-
| Creation: Date
| <CMTLBLDATA_FLDTKTCREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDTKTCREATEUSER_FLDWRKNICKNAME>
|-
| Due Date
| <CMTLBLDATA_FLDTKTDUEDATETIME>
|-
| Ticket Type
| <CMTLBLDATA_FLDTKTKIND>
|-
| Notes
| <CMTLBLDATA_FLDTKTNOTES>CMTLBLDATA
|-
| Open Date
| <CMTLBLDATA_FLDTKTOPENDATETIME>
|-
| Priority
| <CMTLBLDATA_FLDTKTPRIORITY>
|-
| Description
| <CMTLBLDATA_FLDTKTPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDTKTRECID>
|-
| Account's Region Code
| <CMTLBLDATA_FLDTKTREGIONCODE>
|-
| Estimated Duration Needed
| <CMTLBLDATA_FLDTKTSCHEDLENESTIM>
|-
| Resolution Description
| <CMTLBLDATA_FLDTKTSOLUTION>
|-
| Source
| <CMTLBLDATA_FLDTKTSOURCE>
|-
| Status
| <CMTLBLDATA_FLDTKTSTATUS>
|-
| Status: Ext.
| <CMTLBLDATA_FLDTKTSTATUSNOTE>
|-
| Ticket Number
| <CMTLBLDATA_FLDTKTTICKETNO>
|-
| Last Update Date
| <CMTLBLDATA_FLDTKTUPDATEDATE>
|-
| Last Updated by User
| <CMTLBLDATA_FLDTKTUPDATEUSER_FLDWRKNICKNAME>
|-
| Field1
| <CMTLBLDATA_FLDTKTUSER1>
|-
| Field2
| <CMTLBLDATA_FLDTKTUSER2>
|-
| Field3
| <CMTLBLDATA_FLDTKTUSER3>
|-
| Manager
| <CMTLBLDATA_FLDTKTWORKERID_FLDWRKNICKNAME>
|}

===Parameters list for Tickets===
{| class="wikitable"
|-
! Field Name
! Parameter Name to Use
|-
| Category
| <CMTLBLDATA_FLDKBACATEGORY>
|-
| Create Date
| <CMTLBLDATA_FLDKBACREATEDATE>
|-
| Created by user
| <CMTLBLDATA_FLDKBACREATEUSER_FLDWRKNICKNAME>
|-
| Public
| <CMTLBLDATA_FLDKBAISPUBLIC>
|-
| Problem
| <CMTLBLDATA_FLDKBAPROBLEM>
|-
| Record ID
| <CMTLBLDATA_FLDKBARECID>
|-
| Solution
| <CMTLBLDATA_FLDKBASOLUTION>
|-
| Status
| <CMTLBLDATA_FLDKBASTATUS>
|-
| Title
| <CMTLBLDATA_FLDKBATITLE>
|-
| Last Update date
| <CMTLBLDATA_FLDKBAUPDATEDATE>
|-
| Last Update By
| <CMTLBLDATA_FLDKBAUPDATEUSER_FLDWRKNICKNAME>
|}

===Lookup Fields===
*Lookup Fields can be used in order to pass parameters from an entity which is linked to the entity you are currently using. For example, you can create an Online Service for a Ticket, and pass the address of the account which is linked to the ticket. This way you can define an Online Service for the Account, which will be activated from the Ticket window. Lookup Field syntax: <CMTLBLDATA_FLDTKTCARDID_FLDCRDADDRESS1> Where:
CMTLBLDATA_FLDTKTCARDID is the pointer to the linked account FLDCRDADDRESS1 is the account's Address field

==See Also==
*[[Online Services FAQ]]

[[Category:Integration]]

Main Page

2009-08-20T10:54:34Z

Yarden:

{| 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:162%; border:none; margin:0; padding:.1em; color:#000;">Welcome to the Commit Wiki</div>
<div style="top:+0.2em; font-size:95%;">Commit 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 Commit?]
* [http://www.commitcrm.com/aboutus.htm About Commit]
|}


{{Col}}
=Documentation=
*[[#Getting Started|Getting Started]]
*[[#Setup|Setup]]
*[[#Videos|Videos]]
*[[#Work Flows|Work Flows]]
*[[#User Manuals|User Manuals]]
*[[#Office Management|Office Management]]
*[[#Service Management|Service Management]]
*[[#Billing|Billing]]
*[[#Import and Export|Import and Export]]
*[[#Customization|Customization]]
*[[#Privileges|Privileges]]
*[[#Integration|Integration]]
*[[#FAQ|FAQ]]

{{Break}}
=Forum Threads=
*[http://www.commitcrm.com/forum/showthread.php?t=1153 New! Installation Video Tutorials]
*[http://www.commitcrm.com/forum/showthread.php?t=1137 New! CommitCRM 5.1 is Now Available ]
*[http://www.commitcrm.com/forum/showthread.php?t=1025 New! Follow us on Twitter – twitter.com/CommitCRM]
*[http://www.commitcrm.com/forum/showthread.php?t=1037 The IT Toolbox – Community Based Resources for IT Professionals]

=Headline=

{{Colend}}


== [[Getting Started]] ==

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

==[[Setup]]==
*[[Import and Export]]
*[[Web Interface|Commit Web Interface Installation]]
*[[Email Connector|Commit Email Connector Installation]]
*[[Alerts Server|Commit Alerts Server Installation]]
*[[QuickBooks Link|Commit-QuickBooks Link]]
*[[Commit-Outlook Sync]]
*[[Videos#Installation Guides|Installation 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/web_interface_installation_video.htm Email Connector Installation]
*[http://www.commitcrm.com/videos/web_interface_installation_video.htm Alerts Server Installation]
*[[Videos|Watch more videos!]]

==Work Flows==
*[[Tickets|Ticket Lifecycle]]
*[[Billing Lifecycle]]
*[[Project Management]]
*[[Recurring Contracts]]
*[[Over-used Hours]]
*[[Asset Warranties]]
*[[Preventive Maintenance]]
*[[Return Material Authorization (RMA)]]
*[[Barcodes and Assets]]
*[[Sales|Sales Management]]
*[[Managing Quotes]]

== User Manuals ==
*[[Billing]]
*[[Assets]]
*[[Sales]]
*[[Knowledge Base]]
*[[Activity Templates]]
*[[Email Templates]]
*[[Documents]]
*[[QuickBooks Link|Commit-QuickBooks Link]]
*[[Commit-Outlook Sync]]
*[[Web Interface|Commit Web Interface]]
*[[Email Connector|Commit Email Connector]]
*[[Alerts Server|Commit Alerts Server]]

==Office Management==
*[[Accounts]]
*[[Documents]]
*[[Documents#Using Word Merge Templates|Word Templates]]
*[[Email Templates]]
*[[Documents#Managing Outlook Emails within CommitCRM|Filing Emails]]
*[[History]]
*[[Commit-Outlook Sync]]

==Service Management==
*[[Tickets]]
*[[Tickets#Dispatch the Ticket|Dispatcher]]
*[[Assets]]
*[[Activity Templates]]
*[[Email Templates]]
*[[Knowledge Base]]
*[[Billing]]

==Billing==
*[[Billing]]
*[[Items]]
*[[Charges]]
*[[Contracts]]
*[[Custom Pricing]]
*[[Contract-Price Charges]]
*[[Recurring Contracts]]
*[[Charges#Charging Using Taxes|Taxes]]
*[[QuickBooks Link|Commit-QuickBooks Link]]
*[[Charges#Using CommitCRM Charge Reports|Charge Reports]]

==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|Sync with Outlook]]

==Customization==
*[[Field Customization]]
*[[Report Customization]]

==Privileges==
*[[Employees#Employee Privileges Group|Employee Privileges]]
*[[Customer Privileges]]

==[[Integration]]==
*[[QuickBooks Link|Commit-QuickBooks Link]]
*[[Commit-Outlook Sync]]
*[[Commit Online Services]]
*[[Commit API Developers Guide]]
*[[Documents#Importing Existing Documents|Import and Export (Excel, CSV, etc.)]]
*[[Documents#Using Word Merge Templates|Word Templates]]

== FAQ ==
*[[Tickets FAQ|Tickets]]
*[[Contracts FAQ|Contracts]]
*[[Dispatcher & Calendar FAQ|Dispatcher & Calendar]]
*[[Charges FAQ|Charges]]
*[[Items FAQ|Items]]
*[[Reports FAQ|Reports]]
*[[Import & 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 & 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__
__NOEDITSECTION__

API Developers Guide

2009-08-20T10:53:49Z

Yarden: /* See Also */

{{usermanuals}}
CommitCRM provides various tools in order to read/add/update information in the CommitCRM
database. These tools include: Programming API and API by Email for updating the
database, and an ODBC Link for pulling information from the database.
The Commit API provides developers with a set of APIs which allow them to perform
database transactions in order to add and update records in the CommitCRM database. The
API can be used as a Programming API by embedding code which uses the API functions,
or as an API by Email which allows you to send XML formatted emails which will be
processed and executed.

*'''Programming API''' The Commit API provides developers with a set of API functions which can be used in VB, C++, Delphi and any other programming language that lets you use a standard Windows dll file. It provides the ability to create a connection to CommitCRM's database, add new records to the database and update them.

*'''API by Email''' The API by Email allows you to send XML formatted emails which contain database transactions. Commit Email Connector then pulls the incoming XML emails from your POP3 mail server, processes the email and performs the transactions in the XML transaction. XML formatted email gives you an API for the CommitCRM database, which allows you to perform many actions such as linking to external systems, receiving forms submitted from your web site, and more.

*'''ODBC Link''' While the API provides the means for adding and updating information in the database, you should use ODBC Link in order to read information from the database. CommitCRM uses an open database structure and allows other applications to access the database using ODBC (Open Data Base Connectivity) for '''read-only''' purposes. You can use ODBC Link in order to read data from the database and integrate it with an external system (i.e. Crystal reports, or any other application). You may also use the ODBC Link to read Database Record IDs and update existing records. This will be discussed later in this document.

__TOC__
==Glossary==
*'''Commit API (Application Programming Interface)''' - CommitCRM provides an API which allows you to add and update records in the CommitCRM database. The API includes a list of possible actions and parameters.

*'''ODBC Link (Open Data Base Connectivity)''' - ODBC is a function library which provides a common API for ODBC compliant databases. CommitCRM provides an open database and allows other applications to access the database using ODBC for '''read-only''' purposes.

*'''Record''' - Each entity in the CommitCRM database (such as Ticket, Account, Asset, Item, Appointment, Task, etc.) is considered a "record".

*'''Database fields''' - Each record contains a list of fields, each of which holds the record's data.

*'''Transaction''' – All additions or updates to record in the database are done by using a transaction. Each transaction includes the operation you wish to perform, the data type you wish to add/update and the additional parameters (database fields and their values).

*'''Transaction Parameters''' - Each transaction contains the parameters for performing the transaction: record type, list of database fields and a list of the values to be updated in these fields.

*'''External Application''' - This refers to the external program which integrates with CommitCRM in order to update the database. This name should be passed when performing updates to the database, and it will be saved in the CommitCRM record to indicate who performed the changes.

*'''Record ID (REC ID)''' - Each record in CommitCRM has a '''unique Record ID''' which is created when adding the record to the database. Every ID is 20 characters and should be transferred with the API transaction when you need to update an existing record.

==Using Commit API==
Commit API allows you to add and update records in the CommitCRM database, such as
Accounts, Tickets, Assets, Items, Appointments, Tasks and more.

The updates are performed using transactions, where each transaction includes the
operation you wish to perform, the data type you wish to add/update, and any additional
parameters (i.e. record type, database fields and their values).

Every record added to the system is assigned a unique Record ID (REC ID) which is the
database identifier for this record.

The Commit API allows you to perform the following operations.

*'''Add new records''' - if no Record ID is passed in the transaction, the API assumes that this is a new record, adds it to the system and creates a new Record ID for it.

*'''Update existing records''' - if the record ID is passed in the transaction, and the record exists, the system will update the record with the information in the transaction.

In both cases, the system will try to set default values for fields which do not exist in the
incoming transaction. If it fails, the action will fail with an error.

Note that in order to '''read data''' from the CommitCRM database, you should use the ODBC
Link, which provides a read-only link for the CommitCRM database. See more details in
[[#Retrieving data using ODBC|Retrieving data using ODBC]].

===Workflow===
Following is a sample work-flow, which demonstrates the process of adding a new Account, and then adding a new Ticket to this Account, using the Commit API.

Note that the API can return two parameters to the External Application:
#The Commit REC ID - when adding new records to the database, this will contains the new record ID.
#The ExternalTransactionID (relevant for XML transaction only) - In case the external application passes a parameter to be returned with the response, the ExternalTransactionID will be returned as-is to in the response.

The External Application should keep the REC ID which is returned from the API response. This allows you to later update the existing records with new data or add records related to it (such as opening a Ticket under the Account).

[[File:flow.gif|center]]

===Updating existing records===
In order to update an already existing record in the database (e.g. add a Ticket to an
Account, update an Account's phone number, add a new Charge to an existing Ticket,
etc.), you should pass the record's unique identifier to the API so it will update the
existing record rather than create a new Account. The record's unique identifier is
referred to as the Record ID (REC ID).

The Record ID can be obtained in the following ways:
#'''API Response''' (as in the flow above) - You can extract the newly created Record ID from the Email Response when adding new records with the API. This requires the developer to process the API responses, and extract the returning REC ID for each newly added record.
#'''ODBC Link''' - Use the ODBC Link to find relevant records (Accounts, Tickets, etc.), and read all information from the database, including the unique Record ID.
#'''Manually''' - from the Account's Notes tab, at the bottom, right-click the REC ID field and copy it.

Once you have obtained the Record ID you can pass the Record ID as a parameter for the
API and update this record.

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

The programming API executes database transactions. Each transaction uses API methods
provides by the API dll file which is located in the CommitCRM installation. Both the
Programming API and the API by Email use the same dll for performing the transactions.

Note that the API provides the tools needed for adding/updating information in the
database. In order to retrieve data, you should use the ODBC link which allows you to
connect to the database and retrieve data directly from the tables. You can read more
about it in the [[Commit API Reference Manual#Retrieving data using ODBC|Retrieving data using ODBC]] section.

You can find more information and samples in the [[API Code Samples]] section.

===API by Email (XML transaction)===
The API by Email operates under the Commit Email Connector module, which
automatically processes incoming emails arriving at a defined public email address. The
Email may contain XML formatted messages which contain API transactions, and provides
a full API to CommitCRM.

The Email Connector pulls incoming emails from your POP3 mail server, and processes the
email. When an email containing XML formatted message is detected, the system analyzes
the XML content of the email and performs the transactions written in the XML. You may
set the Email Connector to send automatic replies in response to XML formatted email.

The API by Email executes database transactions. Each transaction uses API methods
provided by the API dll file which is located in the CommitCRM installation. Both the
Programming API and the API by Email use the same dll for performing the transactions.

Note that the API provides the tools for adding/updating information in the database. In
order to retrieve data, you should use the ODBC link which allows you to connect to the
database and retrieve data directly from the tables. You can read more about it in the
[[Commit API Reference Manual#Retrieving data using ODBC|Retrieving data using ODBC]] section.

You can find more information and samples in [[API Code Samples#XML samples|XML samples]].

==Retrieving data using ODBC==
CommitCRM uses an open database and allows other applications to access it using ODBC
(Open Data Base Connectivity) for '''read-only''' purposes. While the API provides the means
for adding and updating information in the database, it is preferred to use ODBC to read
information from the database.

You can use ODBC Link to read data from the database and integrate it with an external
system (i.e. Crystal reports, or any other application). You may also use the ODBC Link in
order to read the Database Record ID and update existing records (see [[Commit API Reference Manual#Updating existing records|Updating existing records]]).

'''Activation Notes:'''

*ODBC connection is not officially supported yet, and although ODBC itself is well tested, we do not provide "pure ODBC" support.

*NEVER use ODBC to modify or delete data; use it for READ purposes only. Modifying data should be done using the Commit API.

*The ODBC Link can be used with your installed version of CommitCRM, and only requires installing an external driver. Before working with the API we recommend that you '''backup the database'''.

*We also suggest that the CommitCRM application not be in use while data is being accessed with ODBC (this includes the CommitWebInterface and CommitServer services if they are in use). This may prevent data sharing issues.

Below are the database table names and their meaning:
{| class="wikitable"
|-
! '''CommitCRM Record'''
! '''Database Table Name'''
|-
| Accounts
| Cards
|-
| Tickets
| Tickets
|-
| Charges
| Slips
|-
| Assets
| Assets
|-
| Appointments
| Events
|-
| Tasks
| Events
|-
| History Notes
| NoteBook
|-
| Opportunities
| Opps
|-
| Documents
| Docs
|-
| Knowledge Base
| KBArticles
|}

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

===Installing ODBC Driver===
'''Product Overview''' 
The Advantage ODBC Driver is an ODBC version 3 driver based on the Advantage Client Engine that provides SQL access to the Advantage Database Server. The driver provides
full support for the "Minimum" ODBC SQL grammar specification, as well as many functions
included in the "Core" and "Extended" grammar specifications. When used with the
Advantage Database Server, ODBC users can have the
application stability, performance and reduced network traffic benefits of client/server
architecture.

'''Installation on Windows''' 
Like other ODBC drivers, the Advantage ODBC Driver is installed and managed using the
ODBC Administrator Utility. This utility works with the ODBC Driver Manager to configure
ODBC data sources. At runtime, the ODBC Driver Manager works with available drivers and
their configured data sources. If you have previously installed ODBC drivers, the ODBC Administrator may already be installed on your workstation. The icon for the Administrator is usually found in the Control Panel.

To install the Advantage ODBC Driver:
#[http://www.commitcrm.com/downloads/commit-odbc-8-1-0-26.exe Click here] to download the Advantage ODBC setup program.
#Run the Setup program.
#Proceed through the setup windows to complete installation.

'''Data Source Setup for Windows''' 
Once the Advantage ODBC Driver is installed, a data source needs to be configured to use
the Advantage ODBC Driver. The data source is an entry in the Windows Registry. When a
data source is defined for the Advantage Driver, all information specific to the Advantage
Driver and database files is stored under the Data Source entry in the Windows 95/98/ME/
NT/2000/2003/XP Registry. 
The database files and indexes must be stored on your file server, and the Advantage
Database Server must be loaded in order to access the files.

The Data Source settings may be modified at any time. Using the ODBC Administrator, you
may modify the Data Source and Option settings.
For specific information about the screen fields see the Data Source Setup Screen.

'''To Setup the Data Source:'''
#From the ODBC Administrator, click Add.
#Highlight the Advantage SQL ODBC line, and click OK.
#Type a unique data source name. For example, type AdvData. This name is used by applications to reference the data source.
#Specify the database or data dictionary path. Type a valid path name to a mapped drive on the server where the Advantage Database Server is installed or the path and file name of your Advantage Data Dictionary. Click Browse to select a database path or check the Data Dictionary check box and then browse to select a data dictionary file. Note Multiple Advantage data sources may need to be defined for your environment. If different settings are needed for ODBC connections in one application, separate data sources may be required.
#Review the options and change them to your desired setup.
#Once the Options are reviewed and/or altered, click OK to exit and save the settings. The new data source is displayed.
#Click Close to exit the ODBC Administrator.

'''ODBC Data Source Entries for Windows''' 
In Microsoft Windows, the entries are registry settings found on HKEY_CURRENT_USER\Software\ODBC\ODBC.INI\ (your unique data source name) or HKEY_LOCAL_MACHINE\Software\ODBC\ODBC.INI (your unique data source name). Unless specified otherwise, all registry entries can be setup by the Advantage ODBC Driver setup utility. See Data Source Setup for Windows and Data Source Setup Screen for more information. ODBC Data Source Keys.

'''ODBC Data Source Keys''' 
The following ODBC registry is '''required''' for the driver to load:
{| class="wikitable"
|-
! '''Registry Entry'''
! '''Comments'''
|-
| DataDirectory=data path
| 'data path' should be a valid path name for files locations (e.g., x:\data). This path is used to automatically select all tables in the specified directory.
|-
| DefaultType=Advantage
| Sets a certain type of database files to use Advantageproprietary ADT/ADI/ADM files.
|-
| ServerTypes=3
| Allows the Driver to use the remote or local server
|}

The following ODBC registry keys are '''optional''':

{| class="wikitable"
|-
! '''Registry Entry'''
! '''Comments'''
|-
| AdvantageLocking=ON \ OFF
| The default is ON to use the Advantage proprietary locking.
|-
| CharSet=OEM \ ANSI
| The default character collation setting is ANSI. If OEM is specified, Language must be indicated as well.
|-
| Language=USA
| Used if CharSet=OEM.
|-
| Description=String
| This is provided for easier administration.
|-
| Locking=RECORD \ FILE
| Indicates whether updates lock the entire file or the individual records that are updated. The default is RECORD.
|-
| MaxTableCloseCache=n
| N is the number of tables to hold in cache when cursors are opened and closed. The default is 25.
|-
| MemoBlockSize=n
| N is the size of the Advantage memo blocks in tables that are created by the ODBC driver. The default value is 8 for Advantage proprietary table (ADT/ADM).
|-
| Rows=TRUE \ FALSE
| Select whether deleted rows are displayed. If True, deleted rows are displayed. The default is False.
|-
| TrimTrailingSpaces=TRUE \ FALSE
| The default is False. If True is specified, trailing spaces in character fields will be removed prior to returning the values to the application.
|}

==Samples==
The Commit API allows you to add/update the following entities:
*Accounts
*Assets
*Tickets
*Charges
*Appointments
*Tasks
*History Notes
*Opportunities
*Documents
*Knowledge Base Articles

Each API method requires a list of parameters which contain the field names and their values. The field names are the Database field names. You can see each field's name within the application (so you can verify which field you are about to update), by right-clicking the field and selecting Field Settings > Advanced Tab > view the Tech. Rec ID field.

You can view the complete list of database fields in the [[Commit API Reference Manual#API Reference Manual|API Reference Manual]] above.

Following are samples for using the API by Email and the Programming API. The samples are basic and provide an easy starting point.

See [[API Code Samples]].

==API Reference Manual==

The API allows you to add/update the following entities:
*Accounts
*Assets
*Tickets
*Charges (and Contract-price Charges)
*Appointments
*Tasks
*History Notes
*Opportunities
*Documents
*Knowledge Base Articles

You can find a detailed listing of the database fields in the [[API Reference Manual]].

==See Also==
*[[API Code Samples]]
*[[API Reference Manual]]
*[[Email Connector|Commit Email Connector]]
*[[API by Email and MSP Integration]]
*[[MSP Integration Setup]]
*[[Commit SQL Database]]

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

Integration

2009-08-20T10:53:33Z

Yarden:

{| 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;"
! <h2 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;">Integration</h2>
|-
| style="color:#000;" | <div id="mp-tfa">
*[[QuickBooks Link|Commit-QuickBooks Link]]
*[[Commit-Outlook Sync]]
*[[Commit Online Services]]
*[[Commit API Developers Guide]]
*[[Documents#Importing Existing Documents|Import and Export (Excel, CSV, etc.)]]
*[[Documents#Using Word Merge Templates|Word Templates]]
</div>
|}
|}

API Reference Manual

2009-08-20T10:46:10Z

Yarden: /* Account Fields */

{{usermanualsapidevelopersguide}}
==Intorduction==

Following is a detailed listing of fields per entity which can be added/updated using the API. The API parameters are the same when using the Programming API or the XML API.

The API allows you to add/update the following entities:
*[[#Account Fields|Accounts]]
*[[#Ticket Fields|Tickets]]
*[[#Charge Fields|Charges (and Contract-price Charges)]]
*[[#Item Fields|Items]]
*[[#History Note Fields|History Notes]]
*[[#Asset Fields|Assets]]
*[[#Calendar Fields|Calender]]
*[[#Opportunity Fields|Opportunities]]
*[[#Document Fields|Documents]]
*[[#Knowledge Base Article Fields|Knowledge Base Articles]]

All API functions may return error codes. You can find the possible error codes in:
*[[#Error Codes Description|Error Codes]]

In the following section you will find a detailed listing of the database fields. Each table includes the fields '''Display name''' (as shows in the application), the '''Database Field Name''' (internal database field identifier) and comments.

Note that when using XML formatted messages, the database field name refers to the name to be provided within the XML token. For example, when the field name is FLDSLPQUANTITY, the XML token should look like this:
<FLDSLPQUANTITY>10</FLDSLPQUANTITY>

The following table shows the data kind code when using XML or when using the API functions:

{| class="wikitable"
|-
! '''Application entity'''
! '''Table name'''
! '''Programming Code'''
! '''XML Data Kind Name'''
|-
| Accounts
| Cards
| 10
| ACCOUNT
|-
| Opportunities
| Opps
| 20
| OPPORTUNITY
|-
| Documents
| Docs
| 30
| DOCUMENT
|-
| Charges
| Slips
| 40
| CHARGE
|-
| Appointments/Tasks
| Events
| 50
| APPOINTMENT-OR-TASK
|-
| History Notes
| Notebook
| 60
| HISTORY-NOTE
|-
| Tickets
| Tickets
| 70
| TICKET
|-
| Items
| Items
| 80
| ITEM
|-
| Assets
| Assets
| 90
| ASSET
|-
| Knowledge Base
| KBArticles
| 100
| KBARTICLE
|}
You can find examples of adding and updating records in the database by using the database field in the [[API Code Samples]] section.

===Account Fields===
The following table lists the most important parameters for adding/updating Account
records.
Note slight differences when adding a main account vs. adding a secondary contact.

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Account REC ID
| FLDTKTCARDID
|The Account record ID (20 chars). The Account Rec ID can be taken from:
#Account Notes tab, at the bottom, rightclick the RecID field and use Copy. e.g. CRDVQYSOD1B4U4HZIQJJ
#Using ODBC to pull information from the database.
#From the Email Response when adding new Account with the API.
|-
| Account Manager
| FLDCRDASSIGNCARDID
| This field has two roles:
#When adding a main Account: The account manager should contain the ID of the Employee who is the account manager.
#When adding a secondary contact: 
This field should contain the ID of the main Account to which the secondary contacted is
added.
|-
|Company name
|FLDCRDCOMPANY
|
|-
|Contact: First & Last Name
|FLDCRDCONTACT
|
|-
| Assistant
| FLDCRDASSISTANT
|
|-
|Contract
|FLDCRDBCRECID
|The default Contract for this Account (not required)
|-
|Account Number
|FLDCRDCARDID2
|
|-
|ID
|FLDCRDCARDID3
|
|-
|Popup Message
|FLDCRDCARDMESSAGE
|
|-
| Address: Line1
| FLDCRDADDRESS1
|
|-
| Address: Line2
| FLDCRDADDRESS2
|
|-
| Address: Line3
| FLDCRDADDRESS3
|
|-
|Address: City
|FLDCRDCITY
|
|-
|Address: State
|FLDCRDCOUNTRY
|
|-
|Address: Country
|FLDCRDSTATE
|
|-
|Address: Zip
|FLDCRDZIP
|
|-
|Creation Date
|FLDCRDCREATEDATE
|Any date format, such as DD/MM/YYYY
|-
|Created by User
|FLDCRDCREATEUSERID
|Foreign Software Name which created the account
|-
|Dear
|FLDCRDDEAR
|
|-
|Department
|FLDCRDDEPARTMENT
|
|-
|Documents Store Directory
|FLDCRDDOCSFOLDER
|
|-
|E-Mail Address 1
|FLDCRDEMAIL1
|
|-
|E-Mail Address 2
|FLDCRDEMAIL2
|
|-
|Account Type
|FLDCRDENTITYKIND
|When adding a Main Account = 1 When adding a secondary contact = 5
|-
|Fax Number
|FLDCRDFAX1
|
|-
|Fax Number Extension
|FLDCRDFAXDESC1
|
|-
|File as
|FLDCRDFULLNAME
|
|-
|Type
|FLDCRDKIND
|
|-
|Last Name
|FLDCRDLASTNAME
|
|-
|Notes
|FLDCRDNOTES
|
|-
|Field
|FLDCRDPERSONID
|
|-
|Phone 1 Ext.
|FLDCRDPHNDESC1
|
|-
|Phone 2 Ext.
|FLDCRDPHNDESC2
|
|-
|Phone 3 Ext.
|FLDCRDPHNDESC3
|
|-
|Phone 4 Ext.
|FLDCRDPHNDESC4
|
|-
|Phone 1
|FLDCRDPHONE1
|
|-
|Phone 2
|FLDCRDPHONE2
|
|-
|Phone 3
|FLDCRDPHONE3
|
|-
|Phone 4
|FLDCRDPHONE4
|
|-
|Region
|Region FLDCRDREGIONCODE
|
|-
|Popup Message: Display Indication
|FLDCRDSHOWMESSAGE
|
|-
|Sub-Contact Code
|FLDCRDSUBCODE
|
|-
|Salutation
|FLDCRDSUFFIX
|
|-
|Tax1
|FLDCRDTAXCODE1
|
|-
|Tax2
|FLDCRDTAXCODE2
|
|-
|Notes
|FLDCRDNOTES
|
|-
|Title
|FLDCRDTITLE
|
|-
|Last Updated by
|FLDCRDUPDATEUSERID
|When performing updates on existing Account - pass the Foreign Software Name which performs the update.
|-
|Web Address 1
|FLDCRDURL1
|
|-
|Web Address 2
|FLDCRDURL2
|
|-
|Status
|FLDCRDUSER1
|
|-
|Field1
|FLDCRDUSER2
|
|-
|Field2
|FLDCRDUSER3
|
|-
|Field3
|FLDCRDUSER4
|
|-
|Field4
|FLDCRDUSER5
|
|}

===Ticket Fields===

The table below lists the most important Ticket parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Account REC ID
| FLDTKTCARDID
|The Account record ID (20 chars). The Account Rec ID can be taken from:
#Account Notes tab, at the bottom by rightclicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a cnew Account with the API
|-
| Contact REC ID
| FLDTKTCONTACTID
|The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
| Contract REC ID
| FLDTKTBCRECID
|The Contract ID. If not supplied, will be taken from the Account's default contract.
|-
| Emp. REC ID
| FLDTKTWORKERID
|The worker ID to be linked to the Ticket. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
| Priority
| FLDTKTPRIORITY
| The ticket priority. If not passed in the transaction, the default value for new Tickets will be used.
Immediate = 10 High = 20 Normal = 30 Low = 40 Not Applicable= 50
|-
| Ticket Number
| FLDTKTTICKETNO
| The Ticket number. If passed, must be an existing Ticket, and this will update the Ticket with the details in the transaction.
|-
|Description
|FLDTKTPROBLEM
|This is the Ticket Description. This is a mandatory field, which must contain text.
|-
|Ticket Type
|FLDTKTKIND
|Ticket Type (optional). The Ticket Type string should be passed. If not provided, default is used.
|-
|Source
|FLDTKTSOURCE
|
|-
|Estimated Duration Time
|FLDTKTSCHEDLENESTIM
|Estimated duration time for the Ticket in minutes.
|-
|Show Ticket in Dispatcher
|FLDTKTFORDISPATCH
|Possible values: Yes/No
|-
|Status
|FLDTKTSTATUS
|The Ticket Status (optional). 
Possible values: 
New = 100 
Pending = 200 
Scheduled = 300 
In-House Service = 400 
On-Site Service = 500 
Laboratory Service = 600 
Hold = 700 
Other = 800 
Canceled = 900 
Completed = 1000
|-
|Created by User
|FLDTKTCREATEUSER
|Should contain the external software name which created the Ticket
|-
|Due Date
|FLDTKTDUEDATETIME
|Due date for the Ticket. Should be passed in date format. e.g. MM/DD/YYYY
|-
|Resolution
|FLDTKTSOLUTION
|Ticket resolution text
|}

===Charge Fields===
The table below lists the most important Charge parameters and behavior.

Contract-price Charges have some special characteristics (see comments marked by * in
the table below):

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDSLPRECID
|The Charge record ID. If provided, the existing Charge will be updated. Otherwise, this will be
added as a new Charge.
|-
| Charge Source
| FLDSLPSOURCERECID
|The Charge source is the entity for which the charge is created. 
Possible values:
*Linked Contract RecID (for Contract-price Charges). Cannot be the "System Global Contract".
**Passing the Contract RecID indicates that this is a Contract-price charge.
*Entity RecID from which the charge is created (for example when creating a charge from an Appointment or Task).
|-
| Account REC ID
| FLDSLPCARDID
|The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by rightclicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new Account with the API
|-
| Employee REC ID
| FLDSLPWORKERID
| The worker record ID to be linked to the Charge. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
| Charged Item
| FLDSLPITEMID
| The Item Record ID to be linked to the Charge. This is a mandatory field.
*For Contract-price Charge can be only Fixed-Price, Unit-based Item.
|-
| Contract REC ID
| FLDSLPBCRECID
| The contract record ID (must be a Contract of the Account)
|-
|Ticket REC ID
|FLDSLPTICKETID
|The Ticket ID to be linked to the Charge.
*Not relevant for Contract-price Charge
|-
|Date
|FLDSLPSLIPDATE
|The date for the Charge. This is an optional parameter. If not provided, the current date will
be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
|Description
|FLDSLPDESC
|The Charge Description. If not provided, will be taken from the Item's description.
|-
|Units/Hours
|FLDSLPQUANTITY
|This is the quantity of hours/units
|-
|Adjust Amount
|FLDSLPADJUSTAMOUNT
|Discount/Markup amount. Positive number means Markup, negative number means Discount.
|-
|Adjust Percent
|FLDSLPADJUSTPERCENT
|Discount/Markup in percentage, must be between (-100) - 100. Positive number means Markup, negative number means Discount.
|-
|From Time
|FLDSLPSTARTTIME
|From time for labor Charges e.g. 12:06
*Not relevant for Contract-price Charge
|-
|To Time
|FLDSLPENDTIME
|From time for labor Charges e.g. 14:50
* Not relevant for Contract-price Charge
|-
|Price/Rate
|FLDSLPPRICE
|If not provided, the price is taken from the Item.
|-
| Billable
| FLDSLPBILLKIND
| B - Billable 
N - Not Billable 
If not provided, will be set according to the Contract type.
|-
| Billed
| FLDSLPSTAGE
| D - Draft
B - Billed
|-
| Field1
| FLDSLPUSER1
| User defined field
|-
| Create User
| FLDSLPCREATEUSER
| External software name which created the Charge
|}

===Item Fields===

The table below lists the most important Item parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDSLPRECID
|The Item record ID. If provided, the existing item will be updated. Otherwise, this will be added as a new item.
|-
| Item Group
| FLDITMITEMTYPEGROUP
|The Item Group to be linked to the Charge. This is a mandatory field: 
F - Labor (Fee) 
X - Expense 
P - Part
|-
| Item Code
| FLDITMITEMNO
|The item code is a mandatory field
|-
| Item Name
| FLDITMNAME
| The item name is a mandatory field
|-
| Price Source
| FLDITMPRICESOURCE
| F - Fixed Price 
W - by Employee Rate
|-
| Price per Hour/Unit
| FLDITMUNITISHOUR
| This field indicated whether the price is unitbased or hours-based. 
Y - by Hours 
N - by Units 
This is an optional field, depending on the Item Group. For example, if the item group is Labor, and Price Source is By Employee, the value will always be by hours
|-
|Price
|FLDITMUNITPRICE
|Must be a valid numeric value
|-
|Cost
|FLDITMSTANDARDCOST
|The date for the Charge. This is an optional parameter. If not provided, the current date will
be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
|Taxes
|FLDITMTAXCODE1 
FLDITMTAXCODE2 
FLDITMTAXCODE3
|You can pass up to 3 different tax codes.
|-
|Description by Name
|FLDITMDESCBYNAME
|Y - take the description from the name field 
N - take the description from the Description field
|-
|Description
|FLDITMDESC
|If not provided, the description is taken from the name.
|-
|Suspend
|FLDITMSUSPENDED
|Indicated whether this item is currently suspended: 
Y - yes 
N - no
|-
|Notes
|FLDITMNOTES
|
|-
|Field1
|FLDSLPUSER1
|User defined field
|-
|Create User
|FLDSLPCREATEUSER
|External software name which created the Charge
|-
| Created by User
| FLDTKTCREATEUSER
| Should contain the external software name which created the Ticket
|}

===History Note Fields===
The table below lists the most important History Note parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDHISRECID
|The History Note record ID. If provided, the existing History Note will be updated. otherwise, this will be added as a new History Note.
|-
| Date
| FLDHISNOTEDATETIME
|Any date format, such as DD/MM/YYYY
|-
| Description
| FLDHISDESCRIPTION
| The Description text
|-
| Opportunity/Ticket/Contract
| FLDHISLINKRECID
| Link to Opportunity or Ticket or Contract
|-
| Field
| FLDHISUSER1
| User defined field
|-
| About
| FLDHISKIND
| Optional field
|-
|Employee
|FLDHISWORKERID
|The worker ID to be linked to the Ticket. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
|Account
|FLDHISCARDID
|The Account record ID (20 chars). The Account Rec ID can be taken from:
#Account Notes tab, at the bottom, right-click the REC ID field and use Copy. e.g. CRDVQYSOD1B4U4HZIQJJ
#Using ODBC to pull information from the database
#From the Email Response when adding new Account with the API
|-
|Contact
|FLDHISCONTACTID
|The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Document
|FLDHISDOCID
|Linked Document ID, can be taken from the Document Properties window (right-click RecID and use Copy), or using the ODBC to pull information from the database.
|-
|Created by User
|FLDHISCREATEUSER
|Name of the external software which created this History Note
|}

===Asset Fields===
The table below lists the most important Asset parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Asset Code
| FLDASTASSETCODE
|If an existing Asset Code is provided, then existing Asset is updated. Otherwise a new Asset is added.
|-
| Asset Type
| FLDASTASSETTYPE
|The Type field is mandatory: 
Hardware = H 
Software = S 
Other = T
|-
| Asset Name
| FLDASTNAME
|
|-
| Status
| FLDASTSTATUS
| Mandatory field. 
Active = A 
Not Active = N 
If not provided, default Active is used.
|-
| Record ID
| FLDASTRECID
| If provided, must exist in the database. Ignored if empty
|-
| Serial No.
| FLDASTSERIALNO
|
|-
|Account
|FLDASTACCRECID
|The Account which is linked to the Asset
|-
|Contact
|FLDASTCONTACTRECID
|The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Created by user
|FLDASTCREATEUSER
|Name of external software which created this Asset
|-
|Purchase Date
|FLDASTCUSTPURDATE
|Any date format, such as DD/MM/YYYY
|-
|Purchased From Us
|FLDASTCUSTPURFROMUS
|Possible values: Y/N. 
If not provided, default value Y is used.
|-
| Purchase Invoice #
| FLDASTCUSTPUROURINV
|
|-
| Customer PO
| FLDASTCUSTPURPO
|
|-
| Purchase Price
| FLDASTCUSTPURPRICE
|
|-
| Delivered Date
| FLDASTDELIVEDATE
|
|-
| Description
| FLDASTDESC
|
|-
| Installed By
| FLDASTINSTALBY
|
|-
| Installed Date
| FLDASTINSTALDATE
|
|-
| License Codes
| FLDASTLICENSECODE
|
|-
| License Keys
| FLDASTLICENSEKEY
|
|-
| License Notes
| FLDASTLICENSENOTES
|
|-
| Location
| FLDASTLOCATION
|
|-
| Manufacturer
| FLDASTMANUFACTURER
|
|-
| Mnf Serial No.
| FLDASTMNFSERIALNO
|
|-
| Model
| FLDASTMODEL
|
|-
| Notes
| FLDASTNOTES
|
|-
| Quantity
| FLDASTQUANTITY
| If not provided, default value of 1 is used.
|-
| Last Update By
| FLDASTUPDATEUSER
| Name of externals software which performed the update
|-
| Field1
| FLDASTUSER1
| User defined field
|-
| Field2
| FLDASTUSER2
| User defined field
|-
| Field3
| FLDASTUSER3
| User defined field
|-
| Field4
| FLDASTUSER4
| User defined field
|-
| Field5
| FLDASTUSER5
| User defined field
|-
| Date1
| FLDASTUSERDATE1
| User defined field
|-
| Number1
| FLDASTUSERNUMBER1
| User defined field
|-
| Vendor Purchased Date
| FLDASTVENDORDATEPURC
|
|-
| Vendor Invoice #
| FLDASTVENDORINVNO
|
|-
| Vendor PO
| FLDASTVENDOROURPO
|
|-
| Vendor Price
| FLDASTVENDORPRICE
|
|-
| Vendor
| FLDASTVENDORRECID
|
|-
| Vendor Serial No.
| FLDASTVENDORSERNO
|
|-
| Vendor Warranty Exp. Date
| FLDASTVENDORWARREXP
| Any date format, such as DD/MM/YYYY
|-
| Version
| FLDASTVERSION
|
|-
| Warranty/License Exp.
| FLDASTWARREXPDATE
| Any date format, such as DD/MM/YYYY
|-
| Date
|
|
|}

===Calendar Fields===
The table below lists the most important Calendar parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDEVTRECID
|The Appointment/Task record ID. If provided, the existing entity will be updated. Otherwise, this
will be added as a new Appointment/Task.
|-
| Event Type
| FLDEVTWRITETOID
|The Event type is a mandatory field. 
Appointment = 1 
Task = 2
|-
| Employee
| FLDEVTWORKERID
| The Task/Appointment owner (for private events)
|-
| Private: User
| FLDEVTPRIVATEID
| Possible values: Y/N 
If an Employee was set, this field must be Y
|-
| Account
| FLDEVTCARDID
| The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by rightclicking
the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a
new Account with the API
|-
| Contact
| FLDEVTCONTACTID
| The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Document
|FLDEVTDOCID
|Linked Document ID, can be taken from the Document Properties window (right-click RecID and use Copy), or using the ODBC to pull information from the database.
|-
|Done Indication
|FLDEVTDONE
|Possible values: Y/N
|-
|Date
|FLDEVTEVENTDATE
|The Appointment/Task date is a mandatory field of Any date format, such as DD/MM/YYYY. If not
provided, the current date will be used.
|-
|Description
|FLDEVTFREETEXT
|
|-
|Time: Start
|FLDEVTFROMTIME
|Mandatory field
|-
| Time: End
| FLDEVTTOTIME
| Relevant only for Appointments. If this parameter is not provided, 30 min. interval from Start Time is used.
|-
| Opportunity/Ticket
| FLDEVTLINKRECID
| Linked Ticket/Opportunity/Contract/Asset
|-
| Field1
| FLDEVTFAMILY
| User Defined field
|-
| Field2
| FLDEVTACTION
| User Defined field
|-
| Field3
| FLDEVTPLACE
| User Defined field
|-
| Field4
| FLDEVTPLACE1
| User Defined field
|-
| Field5
| FLDEVTPLACE2
| User Defined field
|-
| Created by User
| FLDEVTCREATEUSERID
| Name of external software which created the event
|-
| Last Update: By User
| FLDEVTUPDATEUSER
| Name of external software which updated the
event
|}

===Opportunity Fields===
The table below lists the most important Opportunity parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDOPPRECID
| The Opportunity record ID. If provided, the existing Opportunity will be updated. Otherwise, this will be added as a new Opportunity.
|-
| Opportunity Name
| FLDOPPNAME
| Mandatory field.
|-
| Opportunity ID
| FLDOPPUSERID
| Optional (Oppty ID)
|-
| Account
| FLDOPPCARDID
| The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by right-clicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new Account with the API
|-
| Contact
| FLDEVTCONTACTID
| The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
| Source
| FLDOPPSOURCE
|
|-
|Document
|FLDEVTDOCID
|Linked Document ID, can be taken from the Document Properties window (right-click RecID and use Copy), or using the ODBC to pull information from the database.
|-
|Done Indication
|FLDEVTDONE
|Possible values: Y/N
|-
|Close Date
|FLDOPPCLOSEDATE
|
|-
|Manager
|FLDOPPWORKERID
|The Manager's REC ID
|-
|Open Date
|FLDOPPOPENDATE
|
|-
| Close By Date
| FLDOPPESTDATE
| Opportunity must be closed by this date
|-
| Amount
| FLDOPPAMOUNT
|
|-
| Probability %
| FLDOPPPROBABILITY
|
|-
| Stage
| FLDOPPSTAGE
|
|-
| Status
| FLDOPPSTATUS
|
|-
| Closing Amount
| FLDOPPCLOSEAMOUNT
|
|-
| Description
| FLDOPPDESCRIPTION
|
|-
| Opportunity Type
| FLDOPPKIND
|
|-
| Opportunity Reason
| FLDOPPREASON
|
|-
| Note
| FLDOPPNOTES
|
|-
| Territory
| FLDOPPREGION
|
|-
| Field1
| FLDEVTFAMILY
| User Defined field
|-
| Field2
| FLDEVTACTION
| User Defined field
|-
| Field3
| FLDEVTPLACE
| User Defined field
|-
| Created by User
| FLDEVTCREATEUSERID
| Name of external software which created the event
|-
| Last Update: By User
| FLDEVTUPDATEUSER
| Name of external software which updated the event
|}

===Document Fields===
The table below lists the Document parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDDOCRECID
| The Document record ID. If provided, the existing Document will be updated. Otherwise, this will be added as a new Document.
|-
| Document Date
| FLDDOCDOCDATE
| The date for the Document. This is an optional parameter. If not provided, or if the value is illegal, the current date will be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
| Subject
| FLDOPPUSERID
|
|-
| Linked Record
| FLDDOCLINKRECID
| The RECID of a linked object. Each Document can be linked to one of the following objects:
*Ticket
*Contract
*Opportunity
*Knowledge Base Article
*Asset
The Record ID (20 chars) can be taken from:
#Object's Notes tab, at the bottom by right-clicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new object with the API.
|-
| Account Rec ID
| CARDID
| The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by right-clicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new Account with the API
|-
| Contact REC ID
| FLDDOCCONTACTID
| The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Field1
|FLDDOCTRANSPORT
|User Defined field
|-
|Field2
|FLDDOCFOLDER
|User Defined field
|-
|Field3
|FLDDOCUMENTPLACE
|User Defined field
|-
|File Path + File name
|FLDDOCDOCUMENTNAME
|The Document path
|-
|Category
|FLDDOCTREEID
|The category record ID should be taken from the database table called TreeTbl which contains the Category tree
|-
| Employee REC ID
| FLDDOCWORKERID
| The worker record ID to be linked to the Document. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
| Created by User
| FLDDOCCREATEUSER
| Name of external software which created the document
|-
| Last Update: By User
| FLDDOCUPDATEUSER
| Name of external software which updated the document
|}

===Knowledge Base Article Fields===
The table below lists the Knowledge Base Article parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDKBARECID
| The Article record ID. If provided, the existing Article will be updated. Otherwise, this will be added as a new Article.
|-
| Document Date
| FLDKBACREATEDATE
| The date for the Document. This is an optional parameter. If not provided, or if the value is illegal, the current date will be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
| Title
| FLDKBATITLE
|
|-
| Problem
| FLDKBAPROBLEM
|
|-
| Solution
| FLDKBASOLUTION
|
|-
| Status
| FLDKBASTATUS
| Possible values:
*DRAFT = 'D'
*PUBLISHED = 'P'
*OBSOLETE = 'O'
|-
|Category
|FLDKBACATEGORY
|
|-
|Public
|FLDKBAISPUBLIC
|Is the Document public. 
Possible values: 
*'Y' = Yes
*'N' = No
|-
|Created by User
|FLDDOCCREATEUSER
|Name of external software which created the document
|-
|Last Update: By User
|FLDDOCUPDATEUSER
|Name of external software which updated the document
|}

===Error Codes Description===
These error codes are returned when calling the CmtGetDescriptionByStatus function: 
'''1000''' CmtDbEng.dll not found. 
'''1001''' Invalid value for the Data Kind value. 
'''1002''' Invalid DATA buffer received. Make sure you have allocated the buffer correctly and
that you have passed the correct buffer length. 
'''1003''' Invalid MAP buffer received. Make sure you have allocated the buffer correctly and
that you have passed the correct buffer length. 
'''1004''' Invalid REC ID buffer received. Make sure you have allocated the buffer correctly
and that you have passed the correct buffer length. 
'''1005''' Invalid LOG buffer received. Make sure you've allocated the buffer correctly and
that you've passed the correct buffer length. 
'''1006''' Invalid REC ID buffer received. It should be at least 20 characters. 
'''1007''' Invalid external software name received. Specify a unique name that identifies your
software. 
'''1008''' Cannot process the transaction. Make sure to call the INIT procedure at least once
prior to sending transactions for processing. 
'''1009''' Path specified for Commit DB folder not found. 
'''1010''' Path specified for Commit DB folder found, but its contents do not reflect a valid DB
folder. 
'''1011''' The RED ID received for the employee/user was not found in Commit, is invalid or is
related to an inactive employee record. 
'''1012''' Error registering software. 
'''1013''' Software name is missing. Make sure you specify a name that identifies your
software. 
'''1014''' Software name is less than 3 characters long. Make sure you enter a software name
that has 3 to 15 characters. 
'''1015''' Software name is too long. Make sure your software name has 3 to 15 characters. 
'''1100''' Database access error. 

General error codes, returned when calling the functions CmtGetDescriptionByCode: 
'''50000''' The data is not correct for its type. 
'''50001''' The field value has been truncated due to the field length in the database. 
'''50002''' The insert operation Failed because the REC ID already existed in the database. 
'''50003''' Failed to update Record since it is being updated by another user. 
'''50103''' Illegal REC ID. 
'''50104''' REC ID Creation failed. 
'''50105''' Illegal Sub-Contact REC ID. 
'''50106''' Illegal Contract REC ID. 
'''50107''' Illegal Employee REC ID. 
'''50108''' Illegal Ticket REC ID. 
'''50109''' Illegal Account REC ID. 
'''50110''' Illegal data for that Contract. 
'''50111''' This Employee is not active. 
'''50112''' Illegal Document REC ID. 
'''50113''' Illegal linked object REC ID. 
'''50114''' Employee not found. 
'''50115''' Some mandatory fields have no values. 
'''51000''' Illegal kind of Account entity. 
'''51001''' Account Manager not found. 
'''51002''' The REC ID of the Account Manager is illegal. 
'''51003''' Illegal tax code. 
'''51004''' This code does not exist in Commit. 
'''52000''' Illegal kind of event. 
'''52001''' Illegal start time. 
'''52002''' Illegal end time. 
'''52003''' Illegal event date. 
'''52004''' The field Reminder1 has Illegal Value. 
'''52005''' The amount in the field has an illegal value. 
'''52006''' The Field Remider1:Units has Illegal Value. 
'''52007''' The Field Remider2:Active has Illegal Value. 
'''52008''' The Field Remider2:Amount has Illegal Value. 
'''52009''' The Field Remider2:Units has Illegal Value. 
'''52010''' Illegal employee REC ID. 
'''52011''' Error occurred while updating the Task/Appointment employee field. 
'''54000''' Illegal Ticket open date. 
'''54001''' Illegal Ticket close date. 
'''54002''' Illegal Ticket code area. 
'''54004''' Illegal Ticket priority. 
'''54005''' Illegal Ticket status. 
'''54006''' The Ticket Account was not found in the database. 
'''54007''' The Ticket Account Manager was not ound in the database. 
'''54008''' This code does not exist in Commit. 
'''54009''' This code does not exist in Commit. 
'''54010''' This code does not exist in Commit. 
'''54011''' This code does not exist in Commit. 
'''54012''' This code does not exist in Commit. 
'''55000''' Illegal charge date. 
'''55001''' Illegal charge REC ID. 
'''55002''' Illegal start date. 
'''55003''' Illegal start time. 
'''55004''' Illegal amount entered for hours. 
'''55005''' Illegal quantity. 
'''55006''' Illegal price. 
'''55007''' Illegal total. 
'''55008''' Illegal value in the Adjust Amount field. 
'''55009''' Illegal value in the Adjust Percent. 
'''55010''' The Discount/Markup field has an illegal value. 
'''55011''' Illegal value in the Adjust Kind field. 
'''55012''' Illegal bill total. 
'''55013''' You can not create a charge for a suspended item. 
'''55014''' Item was not found in Commit. 
'''55015''' This code does not exist in Commit. 
'''55016''' This code does not exists in Commit. 
'''55017''' This Code does not exist in Commit. 
'''55018''' This Code does not exist in Commit. 
'''55019''' This Code does not exist in Commit. 
'''55020''' This Code does not exist in Commit. 
'''55021''' This Code does not exist in Commit. 
'''56000''' Illegal item code. 
'''56001''' The field that indicates the item group type has an illegal value. 
'''56002''' The field that indicates if the Item is suspended has an illegal value. 
'''56003''' Illegal value of The field that indicate if the item is suspended. 
'''56004''' Mismatch found between the fields price and price source. 
'''56005''' Illegal cost. 
'''56006''' Mismatch found between the fields cost and item group type. 
'''56007''' The field that indicates if the charge is by unit or by hours has an illegal value. 
'''56008''' Illegal value in the Description. 
'''56009''' The field that indicates the item type has an illegal value. 
'''57000''' This Code does not exist in Commit. 
'''58000''' Illegal date time. 
'''58001''' The Description field was not found. 
'''58002''' The field kind was not found. 
'''58003''' The Account member was not found. 
'''59000''' This code does not exists in Commit. 
'''59001''' This Code does not exist in Commit. 
'''59002''' This Code does not exist in Commit. 
'''59003''' This Code does not exist in Commit. 
'''59004''' This Code does not exist in Commit. 
'''59005''' This Code does not exist in Commit. 
'''60000''' Invalid web user record ID number. 
'''60001''' This customer web user is not active. 
'''60002''' This user is not a customer. 

==See Also==
*[[Commit API Developers Guide]]
*[[API Code Samples]]
[[Category:User Manuals]]
[[Category:Integration]]

__NOTOC__

API Reference Manual

2009-08-20T10:45:14Z

Yarden: /* Account Fields */

{{usermanualsapidevelopersguide}}
==Intorduction==

Following is a detailed listing of fields per entity which can be added/updated using the API. The API parameters are the same when using the Programming API or the XML API.

The API allows you to add/update the following entities:
*[[#Account Fields|Accounts]]
*[[#Ticket Fields|Tickets]]
*[[#Charge Fields|Charges (and Contract-price Charges)]]
*[[#Item Fields|Items]]
*[[#History Note Fields|History Notes]]
*[[#Asset Fields|Assets]]
*[[#Calendar Fields|Calender]]
*[[#Opportunity Fields|Opportunities]]
*[[#Document Fields|Documents]]
*[[#Knowledge Base Article Fields|Knowledge Base Articles]]

All API functions may return error codes. You can find the possible error codes in:
*[[#Error Codes Description|Error Codes]]

In the following section you will find a detailed listing of the database fields. Each table includes the fields '''Display name''' (as shows in the application), the '''Database Field Name''' (internal database field identifier) and comments.

Note that when using XML formatted messages, the database field name refers to the name to be provided within the XML token. For example, when the field name is FLDSLPQUANTITY, the XML token should look like this:
<FLDSLPQUANTITY>10</FLDSLPQUANTITY>

The following table shows the data kind code when using XML or when using the API functions:

{| class="wikitable"
|-
! '''Application entity'''
! '''Table name'''
! '''Programming Code'''
! '''XML Data Kind Name'''
|-
| Accounts
| Cards
| 10
| ACCOUNT
|-
| Opportunities
| Opps
| 20
| OPPORTUNITY
|-
| Documents
| Docs
| 30
| DOCUMENT
|-
| Charges
| Slips
| 40
| CHARGE
|-
| Appointments/Tasks
| Events
| 50
| APPOINTMENT-OR-TASK
|-
| History Notes
| Notebook
| 60
| HISTORY-NOTE
|-
| Tickets
| Tickets
| 70
| TICKET
|-
| Items
| Items
| 80
| ITEM
|-
| Assets
| Assets
| 90
| ASSET
|-
| Knowledge Base
| KBArticles
| 100
| KBARTICLE
|}
You can find examples of adding and updating records in the database by using the database field in the [[API Code Samples]] section.

===Account Fields===
The following table lists the most important parameters for adding/updating Account
records.
Note slight differences when adding a main account vs. adding a secondary contact.

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Account REC ID
| FLDTKTCARDID
|The Account record ID (20 chars). The Account Rec ID can be taken from:
#Account Notes tab, at the bottom, rightclick the RecID field and use Copy. e.g. CRDVQYSOD1B4U4HZIQJJ
#Using ODBC to pull information from the database.
#From the Email Response when adding new Account with the API.
|-
| Account Manager
| FLDCRDASSIGNCARDID
| This field has two roles:
#When adding a main Account: The account manager should contain the ID of the Employee who is the account manager.
#When adding a secondary contact: 
This field should contain the ID of the main Account to which the secondary contacted is
added.
|-
| Assistant
| FLDCRDASSISTANT
|
|-
|Contract
|FLDCRDBCRECID
|The default Contract for this Account (not required)
|-
|Account Number
|FLDCRDCARDID2
|
|-
|ID
|FLDCRDCARDID3
|
|-
|Popup Message
|FLDCRDCARDMESSAGE
|
|-
| Address: Line1
| FLDCRDADDRESS1
|
|-
| Address: Line2
| FLDCRDADDRESS2
|
|-
| Address: Line3
| FLDCRDADDRESS3
|
|-
|Address: City
|FLDCRDCITY
|
|-
|Address: State
|FLDCRDCOUNTRY
|
|-
|Address: Country
|FLDCRDSTATE
|
|-
|Address: Zip
|FLDCRDZIP
|
|-
|Company name
|FLDCRDCOMPANY
|
|-
|Contact: First & Last Name
|FLDCRDCONTACT
|
|-
|Creation Date
|FLDCRDCREATEDATE
|Any date format, such as DD/MM/YYYY
|-
|Created by User
|FLDCRDCREATEUSERID
|Foreign Software Name which created the account
|-
|Dear
|FLDCRDDEAR
|
|-
|Department
|FLDCRDDEPARTMENT
|
|-
|Documents Store Directory
|FLDCRDDOCSFOLDER
|
|-
|E-Mail Address 1
|FLDCRDEMAIL1
|
|-
|E-Mail Address 2
|FLDCRDEMAIL2
|
|-
|Account Type
|FLDCRDENTITYKIND
|When adding a Main Account = 1 When adding a secondary contact = 5
|-
|Fax Number
|FLDCRDFAX1
|
|-
|Fax Number Extension
|FLDCRDFAXDESC1
|
|-
|File as
|FLDCRDFULLNAME
|
|-
|Type
|FLDCRDKIND
|
|-
|Last Name
|FLDCRDLASTNAME
|
|-
|Notes
|FLDCRDNOTES
|
|-
|Field
|FLDCRDPERSONID
|
|-
|Phone 1 Ext.
|FLDCRDPHNDESC1
|
|-
|Phone 2 Ext.
|FLDCRDPHNDESC2
|
|-
|Phone 3 Ext.
|FLDCRDPHNDESC3
|
|-
|Phone 4 Ext.
|FLDCRDPHNDESC4
|
|-
|Phone 1
|FLDCRDPHONE1
|
|-
|Phone 2
|FLDCRDPHONE2
|
|-
|Phone 3
|FLDCRDPHONE3
|
|-
|Phone 4
|FLDCRDPHONE4
|
|-
|Region
|Region FLDCRDREGIONCODE
|
|-
|Popup Message: Display Indication
|FLDCRDSHOWMESSAGE
|
|-
|Sub-Contact Code
|FLDCRDSUBCODE
|
|-
|Salutation
|FLDCRDSUFFIX
|
|-
|Tax1
|FLDCRDTAXCODE1
|
|-
|Tax2
|FLDCRDTAXCODE2
|
|-
|Notes
|FLDCRDNOTES
|
|-
|Title
|FLDCRDTITLE
|
|-
|Last Updated by
|FLDCRDUPDATEUSERID
|When performing updates on existing Account - pass the Foreign Software Name which performs the update.
|-
|Web Address 1
|FLDCRDURL1
|
|-
|Web Address 2
|FLDCRDURL2
|
|-
|Status
|FLDCRDUSER1
|
|-
|Field1
|FLDCRDUSER2
|
|-
|Field2
|FLDCRDUSER3
|
|-
|Field3
|FLDCRDUSER4
|
|-
|Field4
|FLDCRDUSER5
|
|}

===Ticket Fields===

The table below lists the most important Ticket parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Account REC ID
| FLDTKTCARDID
|The Account record ID (20 chars). The Account Rec ID can be taken from:
#Account Notes tab, at the bottom by rightclicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a cnew Account with the API
|-
| Contact REC ID
| FLDTKTCONTACTID
|The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
| Contract REC ID
| FLDTKTBCRECID
|The Contract ID. If not supplied, will be taken from the Account's default contract.
|-
| Emp. REC ID
| FLDTKTWORKERID
|The worker ID to be linked to the Ticket. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
| Priority
| FLDTKTPRIORITY
| The ticket priority. If not passed in the transaction, the default value for new Tickets will be used.
Immediate = 10 High = 20 Normal = 30 Low = 40 Not Applicable= 50
|-
| Ticket Number
| FLDTKTTICKETNO
| The Ticket number. If passed, must be an existing Ticket, and this will update the Ticket with the details in the transaction.
|-
|Description
|FLDTKTPROBLEM
|This is the Ticket Description. This is a mandatory field, which must contain text.
|-
|Ticket Type
|FLDTKTKIND
|Ticket Type (optional). The Ticket Type string should be passed. If not provided, default is used.
|-
|Source
|FLDTKTSOURCE
|
|-
|Estimated Duration Time
|FLDTKTSCHEDLENESTIM
|Estimated duration time for the Ticket in minutes.
|-
|Show Ticket in Dispatcher
|FLDTKTFORDISPATCH
|Possible values: Yes/No
|-
|Status
|FLDTKTSTATUS
|The Ticket Status (optional). 
Possible values: 
New = 100 
Pending = 200 
Scheduled = 300 
In-House Service = 400 
On-Site Service = 500 
Laboratory Service = 600 
Hold = 700 
Other = 800 
Canceled = 900 
Completed = 1000
|-
|Created by User
|FLDTKTCREATEUSER
|Should contain the external software name which created the Ticket
|-
|Due Date
|FLDTKTDUEDATETIME
|Due date for the Ticket. Should be passed in date format. e.g. MM/DD/YYYY
|-
|Resolution
|FLDTKTSOLUTION
|Ticket resolution text
|}

===Charge Fields===
The table below lists the most important Charge parameters and behavior.

Contract-price Charges have some special characteristics (see comments marked by * in
the table below):

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDSLPRECID
|The Charge record ID. If provided, the existing Charge will be updated. Otherwise, this will be
added as a new Charge.
|-
| Charge Source
| FLDSLPSOURCERECID
|The Charge source is the entity for which the charge is created. 
Possible values:
*Linked Contract RecID (for Contract-price Charges). Cannot be the "System Global Contract".
**Passing the Contract RecID indicates that this is a Contract-price charge.
*Entity RecID from which the charge is created (for example when creating a charge from an Appointment or Task).
|-
| Account REC ID
| FLDSLPCARDID
|The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by rightclicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new Account with the API
|-
| Employee REC ID
| FLDSLPWORKERID
| The worker record ID to be linked to the Charge. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
| Charged Item
| FLDSLPITEMID
| The Item Record ID to be linked to the Charge. This is a mandatory field.
*For Contract-price Charge can be only Fixed-Price, Unit-based Item.
|-
| Contract REC ID
| FLDSLPBCRECID
| The contract record ID (must be a Contract of the Account)
|-
|Ticket REC ID
|FLDSLPTICKETID
|The Ticket ID to be linked to the Charge.
*Not relevant for Contract-price Charge
|-
|Date
|FLDSLPSLIPDATE
|The date for the Charge. This is an optional parameter. If not provided, the current date will
be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
|Description
|FLDSLPDESC
|The Charge Description. If not provided, will be taken from the Item's description.
|-
|Units/Hours
|FLDSLPQUANTITY
|This is the quantity of hours/units
|-
|Adjust Amount
|FLDSLPADJUSTAMOUNT
|Discount/Markup amount. Positive number means Markup, negative number means Discount.
|-
|Adjust Percent
|FLDSLPADJUSTPERCENT
|Discount/Markup in percentage, must be between (-100) - 100. Positive number means Markup, negative number means Discount.
|-
|From Time
|FLDSLPSTARTTIME
|From time for labor Charges e.g. 12:06
*Not relevant for Contract-price Charge
|-
|To Time
|FLDSLPENDTIME
|From time for labor Charges e.g. 14:50
* Not relevant for Contract-price Charge
|-
|Price/Rate
|FLDSLPPRICE
|If not provided, the price is taken from the Item.
|-
| Billable
| FLDSLPBILLKIND
| B - Billable 
N - Not Billable 
If not provided, will be set according to the Contract type.
|-
| Billed
| FLDSLPSTAGE
| D - Draft
B - Billed
|-
| Field1
| FLDSLPUSER1
| User defined field
|-
| Create User
| FLDSLPCREATEUSER
| External software name which created the Charge
|}

===Item Fields===

The table below lists the most important Item parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDSLPRECID
|The Item record ID. If provided, the existing item will be updated. Otherwise, this will be added as a new item.
|-
| Item Group
| FLDITMITEMTYPEGROUP
|The Item Group to be linked to the Charge. This is a mandatory field: 
F - Labor (Fee) 
X - Expense 
P - Part
|-
| Item Code
| FLDITMITEMNO
|The item code is a mandatory field
|-
| Item Name
| FLDITMNAME
| The item name is a mandatory field
|-
| Price Source
| FLDITMPRICESOURCE
| F - Fixed Price 
W - by Employee Rate
|-
| Price per Hour/Unit
| FLDITMUNITISHOUR
| This field indicated whether the price is unitbased or hours-based. 
Y - by Hours 
N - by Units 
This is an optional field, depending on the Item Group. For example, if the item group is Labor, and Price Source is By Employee, the value will always be by hours
|-
|Price
|FLDITMUNITPRICE
|Must be a valid numeric value
|-
|Cost
|FLDITMSTANDARDCOST
|The date for the Charge. This is an optional parameter. If not provided, the current date will
be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
|Taxes
|FLDITMTAXCODE1 
FLDITMTAXCODE2 
FLDITMTAXCODE3
|You can pass up to 3 different tax codes.
|-
|Description by Name
|FLDITMDESCBYNAME
|Y - take the description from the name field 
N - take the description from the Description field
|-
|Description
|FLDITMDESC
|If not provided, the description is taken from the name.
|-
|Suspend
|FLDITMSUSPENDED
|Indicated whether this item is currently suspended: 
Y - yes 
N - no
|-
|Notes
|FLDITMNOTES
|
|-
|Field1
|FLDSLPUSER1
|User defined field
|-
|Create User
|FLDSLPCREATEUSER
|External software name which created the Charge
|-
| Created by User
| FLDTKTCREATEUSER
| Should contain the external software name which created the Ticket
|}

===History Note Fields===
The table below lists the most important History Note parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDHISRECID
|The History Note record ID. If provided, the existing History Note will be updated. otherwise, this will be added as a new History Note.
|-
| Date
| FLDHISNOTEDATETIME
|Any date format, such as DD/MM/YYYY
|-
| Description
| FLDHISDESCRIPTION
| The Description text
|-
| Opportunity/Ticket/Contract
| FLDHISLINKRECID
| Link to Opportunity or Ticket or Contract
|-
| Field
| FLDHISUSER1
| User defined field
|-
| About
| FLDHISKIND
| Optional field
|-
|Employee
|FLDHISWORKERID
|The worker ID to be linked to the Ticket. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
|Account
|FLDHISCARDID
|The Account record ID (20 chars). The Account Rec ID can be taken from:
#Account Notes tab, at the bottom, right-click the REC ID field and use Copy. e.g. CRDVQYSOD1B4U4HZIQJJ
#Using ODBC to pull information from the database
#From the Email Response when adding new Account with the API
|-
|Contact
|FLDHISCONTACTID
|The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Document
|FLDHISDOCID
|Linked Document ID, can be taken from the Document Properties window (right-click RecID and use Copy), or using the ODBC to pull information from the database.
|-
|Created by User
|FLDHISCREATEUSER
|Name of the external software which created this History Note
|}

===Asset Fields===
The table below lists the most important Asset parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Asset Code
| FLDASTASSETCODE
|If an existing Asset Code is provided, then existing Asset is updated. Otherwise a new Asset is added.
|-
| Asset Type
| FLDASTASSETTYPE
|The Type field is mandatory: 
Hardware = H 
Software = S 
Other = T
|-
| Asset Name
| FLDASTNAME
|
|-
| Status
| FLDASTSTATUS
| Mandatory field. 
Active = A 
Not Active = N 
If not provided, default Active is used.
|-
| Record ID
| FLDASTRECID
| If provided, must exist in the database. Ignored if empty
|-
| Serial No.
| FLDASTSERIALNO
|
|-
|Account
|FLDASTACCRECID
|The Account which is linked to the Asset
|-
|Contact
|FLDASTCONTACTRECID
|The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Created by user
|FLDASTCREATEUSER
|Name of external software which created this Asset
|-
|Purchase Date
|FLDASTCUSTPURDATE
|Any date format, such as DD/MM/YYYY
|-
|Purchased From Us
|FLDASTCUSTPURFROMUS
|Possible values: Y/N. 
If not provided, default value Y is used.
|-
| Purchase Invoice #
| FLDASTCUSTPUROURINV
|
|-
| Customer PO
| FLDASTCUSTPURPO
|
|-
| Purchase Price
| FLDASTCUSTPURPRICE
|
|-
| Delivered Date
| FLDASTDELIVEDATE
|
|-
| Description
| FLDASTDESC
|
|-
| Installed By
| FLDASTINSTALBY
|
|-
| Installed Date
| FLDASTINSTALDATE
|
|-
| License Codes
| FLDASTLICENSECODE
|
|-
| License Keys
| FLDASTLICENSEKEY
|
|-
| License Notes
| FLDASTLICENSENOTES
|
|-
| Location
| FLDASTLOCATION
|
|-
| Manufacturer
| FLDASTMANUFACTURER
|
|-
| Mnf Serial No.
| FLDASTMNFSERIALNO
|
|-
| Model
| FLDASTMODEL
|
|-
| Notes
| FLDASTNOTES
|
|-
| Quantity
| FLDASTQUANTITY
| If not provided, default value of 1 is used.
|-
| Last Update By
| FLDASTUPDATEUSER
| Name of externals software which performed the update
|-
| Field1
| FLDASTUSER1
| User defined field
|-
| Field2
| FLDASTUSER2
| User defined field
|-
| Field3
| FLDASTUSER3
| User defined field
|-
| Field4
| FLDASTUSER4
| User defined field
|-
| Field5
| FLDASTUSER5
| User defined field
|-
| Date1
| FLDASTUSERDATE1
| User defined field
|-
| Number1
| FLDASTUSERNUMBER1
| User defined field
|-
| Vendor Purchased Date
| FLDASTVENDORDATEPURC
|
|-
| Vendor Invoice #
| FLDASTVENDORINVNO
|
|-
| Vendor PO
| FLDASTVENDOROURPO
|
|-
| Vendor Price
| FLDASTVENDORPRICE
|
|-
| Vendor
| FLDASTVENDORRECID
|
|-
| Vendor Serial No.
| FLDASTVENDORSERNO
|
|-
| Vendor Warranty Exp. Date
| FLDASTVENDORWARREXP
| Any date format, such as DD/MM/YYYY
|-
| Version
| FLDASTVERSION
|
|-
| Warranty/License Exp.
| FLDASTWARREXPDATE
| Any date format, such as DD/MM/YYYY
|-
| Date
|
|
|}

===Calendar Fields===
The table below lists the most important Calendar parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDEVTRECID
|The Appointment/Task record ID. If provided, the existing entity will be updated. Otherwise, this
will be added as a new Appointment/Task.
|-
| Event Type
| FLDEVTWRITETOID
|The Event type is a mandatory field. 
Appointment = 1 
Task = 2
|-
| Employee
| FLDEVTWORKERID
| The Task/Appointment owner (for private events)
|-
| Private: User
| FLDEVTPRIVATEID
| Possible values: Y/N 
If an Employee was set, this field must be Y
|-
| Account
| FLDEVTCARDID
| The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by rightclicking
the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a
new Account with the API
|-
| Contact
| FLDEVTCONTACTID
| The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Document
|FLDEVTDOCID
|Linked Document ID, can be taken from the Document Properties window (right-click RecID and use Copy), or using the ODBC to pull information from the database.
|-
|Done Indication
|FLDEVTDONE
|Possible values: Y/N
|-
|Date
|FLDEVTEVENTDATE
|The Appointment/Task date is a mandatory field of Any date format, such as DD/MM/YYYY. If not
provided, the current date will be used.
|-
|Description
|FLDEVTFREETEXT
|
|-
|Time: Start
|FLDEVTFROMTIME
|Mandatory field
|-
| Time: End
| FLDEVTTOTIME
| Relevant only for Appointments. If this parameter is not provided, 30 min. interval from Start Time is used.
|-
| Opportunity/Ticket
| FLDEVTLINKRECID
| Linked Ticket/Opportunity/Contract/Asset
|-
| Field1
| FLDEVTFAMILY
| User Defined field
|-
| Field2
| FLDEVTACTION
| User Defined field
|-
| Field3
| FLDEVTPLACE
| User Defined field
|-
| Field4
| FLDEVTPLACE1
| User Defined field
|-
| Field5
| FLDEVTPLACE2
| User Defined field
|-
| Created by User
| FLDEVTCREATEUSERID
| Name of external software which created the event
|-
| Last Update: By User
| FLDEVTUPDATEUSER
| Name of external software which updated the
event
|}

===Opportunity Fields===
The table below lists the most important Opportunity parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDOPPRECID
| The Opportunity record ID. If provided, the existing Opportunity will be updated. Otherwise, this will be added as a new Opportunity.
|-
| Opportunity Name
| FLDOPPNAME
| Mandatory field.
|-
| Opportunity ID
| FLDOPPUSERID
| Optional (Oppty ID)
|-
| Account
| FLDOPPCARDID
| The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by right-clicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new Account with the API
|-
| Contact
| FLDEVTCONTACTID
| The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
| Source
| FLDOPPSOURCE
|
|-
|Document
|FLDEVTDOCID
|Linked Document ID, can be taken from the Document Properties window (right-click RecID and use Copy), or using the ODBC to pull information from the database.
|-
|Done Indication
|FLDEVTDONE
|Possible values: Y/N
|-
|Close Date
|FLDOPPCLOSEDATE
|
|-
|Manager
|FLDOPPWORKERID
|The Manager's REC ID
|-
|Open Date
|FLDOPPOPENDATE
|
|-
| Close By Date
| FLDOPPESTDATE
| Opportunity must be closed by this date
|-
| Amount
| FLDOPPAMOUNT
|
|-
| Probability %
| FLDOPPPROBABILITY
|
|-
| Stage
| FLDOPPSTAGE
|
|-
| Status
| FLDOPPSTATUS
|
|-
| Closing Amount
| FLDOPPCLOSEAMOUNT
|
|-
| Description
| FLDOPPDESCRIPTION
|
|-
| Opportunity Type
| FLDOPPKIND
|
|-
| Opportunity Reason
| FLDOPPREASON
|
|-
| Note
| FLDOPPNOTES
|
|-
| Territory
| FLDOPPREGION
|
|-
| Field1
| FLDEVTFAMILY
| User Defined field
|-
| Field2
| FLDEVTACTION
| User Defined field
|-
| Field3
| FLDEVTPLACE
| User Defined field
|-
| Created by User
| FLDEVTCREATEUSERID
| Name of external software which created the event
|-
| Last Update: By User
| FLDEVTUPDATEUSER
| Name of external software which updated the event
|}

===Document Fields===
The table below lists the Document parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDDOCRECID
| The Document record ID. If provided, the existing Document will be updated. Otherwise, this will be added as a new Document.
|-
| Document Date
| FLDDOCDOCDATE
| The date for the Document. This is an optional parameter. If not provided, or if the value is illegal, the current date will be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
| Subject
| FLDOPPUSERID
|
|-
| Linked Record
| FLDDOCLINKRECID
| The RECID of a linked object. Each Document can be linked to one of the following objects:
*Ticket
*Contract
*Opportunity
*Knowledge Base Article
*Asset
The Record ID (20 chars) can be taken from:
#Object's Notes tab, at the bottom by right-clicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new object with the API.
|-
| Account Rec ID
| CARDID
| The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by right-clicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new Account with the API
|-
| Contact REC ID
| FLDDOCCONTACTID
| The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Field1
|FLDDOCTRANSPORT
|User Defined field
|-
|Field2
|FLDDOCFOLDER
|User Defined field
|-
|Field3
|FLDDOCUMENTPLACE
|User Defined field
|-
|File Path + File name
|FLDDOCDOCUMENTNAME
|The Document path
|-
|Category
|FLDDOCTREEID
|The category record ID should be taken from the database table called TreeTbl which contains the Category tree
|-
| Employee REC ID
| FLDDOCWORKERID
| The worker record ID to be linked to the Document. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
| Created by User
| FLDDOCCREATEUSER
| Name of external software which created the document
|-
| Last Update: By User
| FLDDOCUPDATEUSER
| Name of external software which updated the document
|}

===Knowledge Base Article Fields===
The table below lists the Knowledge Base Article parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDKBARECID
| The Article record ID. If provided, the existing Article will be updated. Otherwise, this will be added as a new Article.
|-
| Document Date
| FLDKBACREATEDATE
| The date for the Document. This is an optional parameter. If not provided, or if the value is illegal, the current date will be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
| Title
| FLDKBATITLE
|
|-
| Problem
| FLDKBAPROBLEM
|
|-
| Solution
| FLDKBASOLUTION
|
|-
| Status
| FLDKBASTATUS
| Possible values:
*DRAFT = 'D'
*PUBLISHED = 'P'
*OBSOLETE = 'O'
|-
|Category
|FLDKBACATEGORY
|
|-
|Public
|FLDKBAISPUBLIC
|Is the Document public. 
Possible values: 
*'Y' = Yes
*'N' = No
|-
|Created by User
|FLDDOCCREATEUSER
|Name of external software which created the document
|-
|Last Update: By User
|FLDDOCUPDATEUSER
|Name of external software which updated the document
|}

===Error Codes Description===
These error codes are returned when calling the CmtGetDescriptionByStatus function: 
'''1000''' CmtDbEng.dll not found. 
'''1001''' Invalid value for the Data Kind value. 
'''1002''' Invalid DATA buffer received. Make sure you have allocated the buffer correctly and
that you have passed the correct buffer length. 
'''1003''' Invalid MAP buffer received. Make sure you have allocated the buffer correctly and
that you have passed the correct buffer length. 
'''1004''' Invalid REC ID buffer received. Make sure you have allocated the buffer correctly
and that you have passed the correct buffer length. 
'''1005''' Invalid LOG buffer received. Make sure you've allocated the buffer correctly and
that you've passed the correct buffer length. 
'''1006''' Invalid REC ID buffer received. It should be at least 20 characters. 
'''1007''' Invalid external software name received. Specify a unique name that identifies your
software. 
'''1008''' Cannot process the transaction. Make sure to call the INIT procedure at least once
prior to sending transactions for processing. 
'''1009''' Path specified for Commit DB folder not found. 
'''1010''' Path specified for Commit DB folder found, but its contents do not reflect a valid DB
folder. 
'''1011''' The RED ID received for the employee/user was not found in Commit, is invalid or is
related to an inactive employee record. 
'''1012''' Error registering software. 
'''1013''' Software name is missing. Make sure you specify a name that identifies your
software. 
'''1014''' Software name is less than 3 characters long. Make sure you enter a software name
that has 3 to 15 characters. 
'''1015''' Software name is too long. Make sure your software name has 3 to 15 characters. 
'''1100''' Database access error. 

General error codes, returned when calling the functions CmtGetDescriptionByCode: 
'''50000''' The data is not correct for its type. 
'''50001''' The field value has been truncated due to the field length in the database. 
'''50002''' The insert operation Failed because the REC ID already existed in the database. 
'''50003''' Failed to update Record since it is being updated by another user. 
'''50103''' Illegal REC ID. 
'''50104''' REC ID Creation failed. 
'''50105''' Illegal Sub-Contact REC ID. 
'''50106''' Illegal Contract REC ID. 
'''50107''' Illegal Employee REC ID. 
'''50108''' Illegal Ticket REC ID. 
'''50109''' Illegal Account REC ID. 
'''50110''' Illegal data for that Contract. 
'''50111''' This Employee is not active. 
'''50112''' Illegal Document REC ID. 
'''50113''' Illegal linked object REC ID. 
'''50114''' Employee not found. 
'''50115''' Some mandatory fields have no values. 
'''51000''' Illegal kind of Account entity. 
'''51001''' Account Manager not found. 
'''51002''' The REC ID of the Account Manager is illegal. 
'''51003''' Illegal tax code. 
'''51004''' This code does not exist in Commit. 
'''52000''' Illegal kind of event. 
'''52001''' Illegal start time. 
'''52002''' Illegal end time. 
'''52003''' Illegal event date. 
'''52004''' The field Reminder1 has Illegal Value. 
'''52005''' The amount in the field has an illegal value. 
'''52006''' The Field Remider1:Units has Illegal Value. 
'''52007''' The Field Remider2:Active has Illegal Value. 
'''52008''' The Field Remider2:Amount has Illegal Value. 
'''52009''' The Field Remider2:Units has Illegal Value. 
'''52010''' Illegal employee REC ID. 
'''52011''' Error occurred while updating the Task/Appointment employee field. 
'''54000''' Illegal Ticket open date. 
'''54001''' Illegal Ticket close date. 
'''54002''' Illegal Ticket code area. 
'''54004''' Illegal Ticket priority. 
'''54005''' Illegal Ticket status. 
'''54006''' The Ticket Account was not found in the database. 
'''54007''' The Ticket Account Manager was not ound in the database. 
'''54008''' This code does not exist in Commit. 
'''54009''' This code does not exist in Commit. 
'''54010''' This code does not exist in Commit. 
'''54011''' This code does not exist in Commit. 
'''54012''' This code does not exist in Commit. 
'''55000''' Illegal charge date. 
'''55001''' Illegal charge REC ID. 
'''55002''' Illegal start date. 
'''55003''' Illegal start time. 
'''55004''' Illegal amount entered for hours. 
'''55005''' Illegal quantity. 
'''55006''' Illegal price. 
'''55007''' Illegal total. 
'''55008''' Illegal value in the Adjust Amount field. 
'''55009''' Illegal value in the Adjust Percent. 
'''55010''' The Discount/Markup field has an illegal value. 
'''55011''' Illegal value in the Adjust Kind field. 
'''55012''' Illegal bill total. 
'''55013''' You can not create a charge for a suspended item. 
'''55014''' Item was not found in Commit. 
'''55015''' This code does not exist in Commit. 
'''55016''' This code does not exists in Commit. 
'''55017''' This Code does not exist in Commit. 
'''55018''' This Code does not exist in Commit. 
'''55019''' This Code does not exist in Commit. 
'''55020''' This Code does not exist in Commit. 
'''55021''' This Code does not exist in Commit. 
'''56000''' Illegal item code. 
'''56001''' The field that indicates the item group type has an illegal value. 
'''56002''' The field that indicates if the Item is suspended has an illegal value. 
'''56003''' Illegal value of The field that indicate if the item is suspended. 
'''56004''' Mismatch found between the fields price and price source. 
'''56005''' Illegal cost. 
'''56006''' Mismatch found between the fields cost and item group type. 
'''56007''' The field that indicates if the charge is by unit or by hours has an illegal value. 
'''56008''' Illegal value in the Description. 
'''56009''' The field that indicates the item type has an illegal value. 
'''57000''' This Code does not exist in Commit. 
'''58000''' Illegal date time. 
'''58001''' The Description field was not found. 
'''58002''' The field kind was not found. 
'''58003''' The Account member was not found. 
'''59000''' This code does not exists in Commit. 
'''59001''' This Code does not exist in Commit. 
'''59002''' This Code does not exist in Commit. 
'''59003''' This Code does not exist in Commit. 
'''59004''' This Code does not exist in Commit. 
'''59005''' This Code does not exist in Commit. 
'''60000''' Invalid web user record ID number. 
'''60001''' This customer web user is not active. 
'''60002''' This user is not a customer. 

==See Also==
*[[Commit API Developers Guide]]
*[[API Code Samples]]
[[Category:User Manuals]]
[[Category:Integration]]

__NOTOC__

API Reference Manual

2009-08-20T10:39:16Z

Yarden: /* Intorduction */

{{usermanualsapidevelopersguide}}
==Intorduction==

Following is a detailed listing of fields per entity which can be added/updated using the API. The API parameters are the same when using the Programming API or the XML API.

The API allows you to add/update the following entities:
*[[#Account Fields|Accounts]]
*[[#Ticket Fields|Tickets]]
*[[#Charge Fields|Charges (and Contract-price Charges)]]
*[[#Item Fields|Items]]
*[[#History Note Fields|History Notes]]
*[[#Asset Fields|Assets]]
*[[#Calendar Fields|Calender]]
*[[#Opportunity Fields|Opportunities]]
*[[#Document Fields|Documents]]
*[[#Knowledge Base Article Fields|Knowledge Base Articles]]

All API functions may return error codes. You can find the possible error codes in:
*[[#Error Codes Description|Error Codes]]

In the following section you will find a detailed listing of the database fields. Each table includes the fields '''Display name''' (as shows in the application), the '''Database Field Name''' (internal database field identifier) and comments.

Note that when using XML formatted messages, the database field name refers to the name to be provided within the XML token. For example, when the field name is FLDSLPQUANTITY, the XML token should look like this:
<FLDSLPQUANTITY>10</FLDSLPQUANTITY>

The following table shows the data kind code when using XML or when using the API functions:

{| class="wikitable"
|-
! '''Application entity'''
! '''Table name'''
! '''Programming Code'''
! '''XML Data Kind Name'''
|-
| Accounts
| Cards
| 10
| ACCOUNT
|-
| Opportunities
| Opps
| 20
| OPPORTUNITY
|-
| Documents
| Docs
| 30
| DOCUMENT
|-
| Charges
| Slips
| 40
| CHARGE
|-
| Appointments/Tasks
| Events
| 50
| APPOINTMENT-OR-TASK
|-
| History Notes
| Notebook
| 60
| HISTORY-NOTE
|-
| Tickets
| Tickets
| 70
| TICKET
|-
| Items
| Items
| 80
| ITEM
|-
| Assets
| Assets
| 90
| ASSET
|-
| Knowledge Base
| KBArticles
| 100
| KBARTICLE
|}
You can find examples of adding and updating records in the database by using the database field in the [[API Code Samples]] section.

===Account Fields===
The following table lists the most important parameters for adding/updating Account
records.
Note slight differences when adding a main account vs. adding a secondary contact.

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Account REC ID
| FLDTKTCARDID
|The Account record ID (20 chars). The Account Rec ID can be taken from:
#Account Notes tab, at the bottom, rightclick the RecID field and use Copy. e.g. CRDVQYSOD1B4U4HZIQJJ
#Using ODBC to pull information from the database.
#From the Email Response when adding new Account with the API.
|-
| Address: Line1
| FLDCRDADDRESS1
|
|-
| Address: Line2
| FLDCRDADDRESS2
|
|-
| Address: Line3
| FLDCRDADDRESS3
|
|-
| Account Manager
| FLDCRDASSIGNCARDID
| This field has two roles:
#When adding a main Account: The account manager should contain the ID of the Employee who is the account manager.
#When adding a secondary contact: 
This field should contain the ID of the main Account to which the secondary contacted is
added.
|-
| Assistant
| FLDCRDASSISTANT
|
|-
|Contract
|FLDCRDBCRECID
|The default Contract for this Account (not required)
|-
|Account Number
|FLDCRDCARDID2
|
|-
|ID
|FLDCRDCARDID3
|
|-
|Popup Message
|FLDCRDCARDMESSAGE
|
|-
|Address: City
|FLDCRDCITY
|
|-
|Address: Zip
|FLDCRDZIP
|
|-
|Company name
|FLDCRDCOMPANY
|
|-
|Contact: First & Last Name
|FLDCRDCONTACT
|
|-
|Address: State
|FLDCRDCOUNTRY
|
|-
|Creation Date
|FLDCRDCREATEDATE
|Any date format, such as DD/MM/YYYY
|-
|Created by User
|FLDCRDCREATEUSERID
|Foreign Software Name which created the account
|-
|Dear
|FLDCRDDEAR
|
|-
|Department
|FLDCRDDEPARTMENT
|
|-
|Documents Store Directory
|FLDCRDDOCSFOLDER
|
|-
|E-Mail Address 1
|FLDCRDEMAIL1
|
|-
|E-Mail Address 2
|FLDCRDEMAIL2
|
|-
|Account Type
|FLDCRDENTITYKIND
|When adding a Main Account = 1 When adding a secondary contact = 5
|-
|Fax Number
|FLDCRDFAX1
|
|-
|Fax Number Extension
|FLDCRDFAXDESC1
|
|-
|File as
|FLDCRDFULLNAME
|
|-
|Type
|FLDCRDKIND
|
|-
|Last Name
|FLDCRDLASTNAME
|
|-
|Notes
|FLDCRDNOTES
|
|-
|Field
|FLDCRDPERSONID
|
|-
|Phone 1 Ext.
|FLDCRDPHNDESC1
|
|-
|Phone 2 Ext.
|FLDCRDPHNDESC2
|
|-
|Phone 3 Ext.
|FLDCRDPHNDESC3
|
|-
|Phone 4 Ext.
|FLDCRDPHNDESC4
|
|-
|Phone 1
|FLDCRDPHONE1
|
|-
|Phone 2
|FLDCRDPHONE2
|
|-
|Phone 3
|FLDCRDPHONE3
|
|-
|Phone 4
|FLDCRDPHONE4
|
|-
|Region
|Region FLDCRDREGIONCODE
|
|-
|Popup Message: Display Indication
|FLDCRDSHOWMESSAGE
|
|-
|Address: Country
|FLDCRDSTATE
|
|-
|Sub-Contact Code
|FLDCRDSUBCODE
|
|-
|Salutation
|FLDCRDSUFFIX
|
|-
|Tax1
|FLDCRDTAXCODE1
|
|-
|Tax2
|FLDCRDTAXCODE2
|
|-
|Notes
|FLDCRDNOTES
|
|-
|Title
|FLDCRDTITLE
|
|-
|Last Updated by
|FLDCRDUPDATEUSERID
|When performing updates on existing Account - pass the Foreign Software Name which performs the update.
|-
|Web Address 1
|FLDCRDURL1
|
|-
|Web Address 2
|FLDCRDURL2
|
|-
|Status
|FLDCRDUSER1
|
|-
|Field1
|FLDCRDUSER2
|
|-
|Field2
|FLDCRDUSER3
|
|-
|Field3
|FLDCRDUSER4
|
|-
|Field4
|FLDCRDUSER5
|
|}

===Ticket Fields===

The table below lists the most important Ticket parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Account REC ID
| FLDTKTCARDID
|The Account record ID (20 chars). The Account Rec ID can be taken from:
#Account Notes tab, at the bottom by rightclicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a cnew Account with the API
|-
| Contact REC ID
| FLDTKTCONTACTID
|The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
| Contract REC ID
| FLDTKTBCRECID
|The Contract ID. If not supplied, will be taken from the Account's default contract.
|-
| Emp. REC ID
| FLDTKTWORKERID
|The worker ID to be linked to the Ticket. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
| Priority
| FLDTKTPRIORITY
| The ticket priority. If not passed in the transaction, the default value for new Tickets will be used.
Immediate = 10 High = 20 Normal = 30 Low = 40 Not Applicable= 50
|-
| Ticket Number
| FLDTKTTICKETNO
| The Ticket number. If passed, must be an existing Ticket, and this will update the Ticket with the details in the transaction.
|-
|Description
|FLDTKTPROBLEM
|This is the Ticket Description. This is a mandatory field, which must contain text.
|-
|Ticket Type
|FLDTKTKIND
|Ticket Type (optional). The Ticket Type string should be passed. If not provided, default is used.
|-
|Source
|FLDTKTSOURCE
|
|-
|Estimated Duration Time
|FLDTKTSCHEDLENESTIM
|Estimated duration time for the Ticket in minutes.
|-
|Show Ticket in Dispatcher
|FLDTKTFORDISPATCH
|Possible values: Yes/No
|-
|Status
|FLDTKTSTATUS
|The Ticket Status (optional). 
Possible values: 
New = 100 
Pending = 200 
Scheduled = 300 
In-House Service = 400 
On-Site Service = 500 
Laboratory Service = 600 
Hold = 700 
Other = 800 
Canceled = 900 
Completed = 1000
|-
|Created by User
|FLDTKTCREATEUSER
|Should contain the external software name which created the Ticket
|-
|Due Date
|FLDTKTDUEDATETIME
|Due date for the Ticket. Should be passed in date format. e.g. MM/DD/YYYY
|-
|Resolution
|FLDTKTSOLUTION
|Ticket resolution text
|}

===Charge Fields===
The table below lists the most important Charge parameters and behavior.

Contract-price Charges have some special characteristics (see comments marked by * in
the table below):

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDSLPRECID
|The Charge record ID. If provided, the existing Charge will be updated. Otherwise, this will be
added as a new Charge.
|-
| Charge Source
| FLDSLPSOURCERECID
|The Charge source is the entity for which the charge is created. 
Possible values:
*Linked Contract RecID (for Contract-price Charges). Cannot be the "System Global Contract".
**Passing the Contract RecID indicates that this is a Contract-price charge.
*Entity RecID from which the charge is created (for example when creating a charge from an Appointment or Task).
|-
| Account REC ID
| FLDSLPCARDID
|The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by rightclicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new Account with the API
|-
| Employee REC ID
| FLDSLPWORKERID
| The worker record ID to be linked to the Charge. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
| Charged Item
| FLDSLPITEMID
| The Item Record ID to be linked to the Charge. This is a mandatory field.
*For Contract-price Charge can be only Fixed-Price, Unit-based Item.
|-
| Contract REC ID
| FLDSLPBCRECID
| The contract record ID (must be a Contract of the Account)
|-
|Ticket REC ID
|FLDSLPTICKETID
|The Ticket ID to be linked to the Charge.
*Not relevant for Contract-price Charge
|-
|Date
|FLDSLPSLIPDATE
|The date for the Charge. This is an optional parameter. If not provided, the current date will
be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
|Description
|FLDSLPDESC
|The Charge Description. If not provided, will be taken from the Item's description.
|-
|Units/Hours
|FLDSLPQUANTITY
|This is the quantity of hours/units
|-
|Adjust Amount
|FLDSLPADJUSTAMOUNT
|Discount/Markup amount. Positive number means Markup, negative number means Discount.
|-
|Adjust Percent
|FLDSLPADJUSTPERCENT
|Discount/Markup in percentage, must be between (-100) - 100. Positive number means Markup, negative number means Discount.
|-
|From Time
|FLDSLPSTARTTIME
|From time for labor Charges e.g. 12:06
*Not relevant for Contract-price Charge
|-
|To Time
|FLDSLPENDTIME
|From time for labor Charges e.g. 14:50
* Not relevant for Contract-price Charge
|-
|Price/Rate
|FLDSLPPRICE
|If not provided, the price is taken from the Item.
|-
| Billable
| FLDSLPBILLKIND
| B - Billable 
N - Not Billable 
If not provided, will be set according to the Contract type.
|-
| Billed
| FLDSLPSTAGE
| D - Draft
B - Billed
|-
| Field1
| FLDSLPUSER1
| User defined field
|-
| Create User
| FLDSLPCREATEUSER
| External software name which created the Charge
|}

===Item Fields===

The table below lists the most important Item parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDSLPRECID
|The Item record ID. If provided, the existing item will be updated. Otherwise, this will be added as a new item.
|-
| Item Group
| FLDITMITEMTYPEGROUP
|The Item Group to be linked to the Charge. This is a mandatory field: 
F - Labor (Fee) 
X - Expense 
P - Part
|-
| Item Code
| FLDITMITEMNO
|The item code is a mandatory field
|-
| Item Name
| FLDITMNAME
| The item name is a mandatory field
|-
| Price Source
| FLDITMPRICESOURCE
| F - Fixed Price 
W - by Employee Rate
|-
| Price per Hour/Unit
| FLDITMUNITISHOUR
| This field indicated whether the price is unitbased or hours-based. 
Y - by Hours 
N - by Units 
This is an optional field, depending on the Item Group. For example, if the item group is Labor, and Price Source is By Employee, the value will always be by hours
|-
|Price
|FLDITMUNITPRICE
|Must be a valid numeric value
|-
|Cost
|FLDITMSTANDARDCOST
|The date for the Charge. This is an optional parameter. If not provided, the current date will
be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
|Taxes
|FLDITMTAXCODE1 
FLDITMTAXCODE2 
FLDITMTAXCODE3
|You can pass up to 3 different tax codes.
|-
|Description by Name
|FLDITMDESCBYNAME
|Y - take the description from the name field 
N - take the description from the Description field
|-
|Description
|FLDITMDESC
|If not provided, the description is taken from the name.
|-
|Suspend
|FLDITMSUSPENDED
|Indicated whether this item is currently suspended: 
Y - yes 
N - no
|-
|Notes
|FLDITMNOTES
|
|-
|Field1
|FLDSLPUSER1
|User defined field
|-
|Create User
|FLDSLPCREATEUSER
|External software name which created the Charge
|-
| Created by User
| FLDTKTCREATEUSER
| Should contain the external software name which created the Ticket
|}

===History Note Fields===
The table below lists the most important History Note parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDHISRECID
|The History Note record ID. If provided, the existing History Note will be updated. otherwise, this will be added as a new History Note.
|-
| Date
| FLDHISNOTEDATETIME
|Any date format, such as DD/MM/YYYY
|-
| Description
| FLDHISDESCRIPTION
| The Description text
|-
| Opportunity/Ticket/Contract
| FLDHISLINKRECID
| Link to Opportunity or Ticket or Contract
|-
| Field
| FLDHISUSER1
| User defined field
|-
| About
| FLDHISKIND
| Optional field
|-
|Employee
|FLDHISWORKERID
|The worker ID to be linked to the Ticket. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
|Account
|FLDHISCARDID
|The Account record ID (20 chars). The Account Rec ID can be taken from:
#Account Notes tab, at the bottom, right-click the REC ID field and use Copy. e.g. CRDVQYSOD1B4U4HZIQJJ
#Using ODBC to pull information from the database
#From the Email Response when adding new Account with the API
|-
|Contact
|FLDHISCONTACTID
|The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Document
|FLDHISDOCID
|Linked Document ID, can be taken from the Document Properties window (right-click RecID and use Copy), or using the ODBC to pull information from the database.
|-
|Created by User
|FLDHISCREATEUSER
|Name of the external software which created this History Note
|}

===Asset Fields===
The table below lists the most important Asset parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Asset Code
| FLDASTASSETCODE
|If an existing Asset Code is provided, then existing Asset is updated. Otherwise a new Asset is added.
|-
| Asset Type
| FLDASTASSETTYPE
|The Type field is mandatory: 
Hardware = H 
Software = S 
Other = T
|-
| Asset Name
| FLDASTNAME
|
|-
| Status
| FLDASTSTATUS
| Mandatory field. 
Active = A 
Not Active = N 
If not provided, default Active is used.
|-
| Record ID
| FLDASTRECID
| If provided, must exist in the database. Ignored if empty
|-
| Serial No.
| FLDASTSERIALNO
|
|-
|Account
|FLDASTACCRECID
|The Account which is linked to the Asset
|-
|Contact
|FLDASTCONTACTRECID
|The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Created by user
|FLDASTCREATEUSER
|Name of external software which created this Asset
|-
|Purchase Date
|FLDASTCUSTPURDATE
|Any date format, such as DD/MM/YYYY
|-
|Purchased From Us
|FLDASTCUSTPURFROMUS
|Possible values: Y/N. 
If not provided, default value Y is used.
|-
| Purchase Invoice #
| FLDASTCUSTPUROURINV
|
|-
| Customer PO
| FLDASTCUSTPURPO
|
|-
| Purchase Price
| FLDASTCUSTPURPRICE
|
|-
| Delivered Date
| FLDASTDELIVEDATE
|
|-
| Description
| FLDASTDESC
|
|-
| Installed By
| FLDASTINSTALBY
|
|-
| Installed Date
| FLDASTINSTALDATE
|
|-
| License Codes
| FLDASTLICENSECODE
|
|-
| License Keys
| FLDASTLICENSEKEY
|
|-
| License Notes
| FLDASTLICENSENOTES
|
|-
| Location
| FLDASTLOCATION
|
|-
| Manufacturer
| FLDASTMANUFACTURER
|
|-
| Mnf Serial No.
| FLDASTMNFSERIALNO
|
|-
| Model
| FLDASTMODEL
|
|-
| Notes
| FLDASTNOTES
|
|-
| Quantity
| FLDASTQUANTITY
| If not provided, default value of 1 is used.
|-
| Last Update By
| FLDASTUPDATEUSER
| Name of externals software which performed the update
|-
| Field1
| FLDASTUSER1
| User defined field
|-
| Field2
| FLDASTUSER2
| User defined field
|-
| Field3
| FLDASTUSER3
| User defined field
|-
| Field4
| FLDASTUSER4
| User defined field
|-
| Field5
| FLDASTUSER5
| User defined field
|-
| Date1
| FLDASTUSERDATE1
| User defined field
|-
| Number1
| FLDASTUSERNUMBER1
| User defined field
|-
| Vendor Purchased Date
| FLDASTVENDORDATEPURC
|
|-
| Vendor Invoice #
| FLDASTVENDORINVNO
|
|-
| Vendor PO
| FLDASTVENDOROURPO
|
|-
| Vendor Price
| FLDASTVENDORPRICE
|
|-
| Vendor
| FLDASTVENDORRECID
|
|-
| Vendor Serial No.
| FLDASTVENDORSERNO
|
|-
| Vendor Warranty Exp. Date
| FLDASTVENDORWARREXP
| Any date format, such as DD/MM/YYYY
|-
| Version
| FLDASTVERSION
|
|-
| Warranty/License Exp.
| FLDASTWARREXPDATE
| Any date format, such as DD/MM/YYYY
|-
| Date
|
|
|}

===Calendar Fields===
The table below lists the most important Calendar parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDEVTRECID
|The Appointment/Task record ID. If provided, the existing entity will be updated. Otherwise, this
will be added as a new Appointment/Task.
|-
| Event Type
| FLDEVTWRITETOID
|The Event type is a mandatory field. 
Appointment = 1 
Task = 2
|-
| Employee
| FLDEVTWORKERID
| The Task/Appointment owner (for private events)
|-
| Private: User
| FLDEVTPRIVATEID
| Possible values: Y/N 
If an Employee was set, this field must be Y
|-
| Account
| FLDEVTCARDID
| The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by rightclicking
the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a
new Account with the API
|-
| Contact
| FLDEVTCONTACTID
| The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Document
|FLDEVTDOCID
|Linked Document ID, can be taken from the Document Properties window (right-click RecID and use Copy), or using the ODBC to pull information from the database.
|-
|Done Indication
|FLDEVTDONE
|Possible values: Y/N
|-
|Date
|FLDEVTEVENTDATE
|The Appointment/Task date is a mandatory field of Any date format, such as DD/MM/YYYY. If not
provided, the current date will be used.
|-
|Description
|FLDEVTFREETEXT
|
|-
|Time: Start
|FLDEVTFROMTIME
|Mandatory field
|-
| Time: End
| FLDEVTTOTIME
| Relevant only for Appointments. If this parameter is not provided, 30 min. interval from Start Time is used.
|-
| Opportunity/Ticket
| FLDEVTLINKRECID
| Linked Ticket/Opportunity/Contract/Asset
|-
| Field1
| FLDEVTFAMILY
| User Defined field
|-
| Field2
| FLDEVTACTION
| User Defined field
|-
| Field3
| FLDEVTPLACE
| User Defined field
|-
| Field4
| FLDEVTPLACE1
| User Defined field
|-
| Field5
| FLDEVTPLACE2
| User Defined field
|-
| Created by User
| FLDEVTCREATEUSERID
| Name of external software which created the event
|-
| Last Update: By User
| FLDEVTUPDATEUSER
| Name of external software which updated the
event
|}

===Opportunity Fields===
The table below lists the most important Opportunity parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDOPPRECID
| The Opportunity record ID. If provided, the existing Opportunity will be updated. Otherwise, this will be added as a new Opportunity.
|-
| Opportunity Name
| FLDOPPNAME
| Mandatory field.
|-
| Opportunity ID
| FLDOPPUSERID
| Optional (Oppty ID)
|-
| Account
| FLDOPPCARDID
| The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by right-clicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new Account with the API
|-
| Contact
| FLDEVTCONTACTID
| The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
| Source
| FLDOPPSOURCE
|
|-
|Document
|FLDEVTDOCID
|Linked Document ID, can be taken from the Document Properties window (right-click RecID and use Copy), or using the ODBC to pull information from the database.
|-
|Done Indication
|FLDEVTDONE
|Possible values: Y/N
|-
|Close Date
|FLDOPPCLOSEDATE
|
|-
|Manager
|FLDOPPWORKERID
|The Manager's REC ID
|-
|Open Date
|FLDOPPOPENDATE
|
|-
| Close By Date
| FLDOPPESTDATE
| Opportunity must be closed by this date
|-
| Amount
| FLDOPPAMOUNT
|
|-
| Probability %
| FLDOPPPROBABILITY
|
|-
| Stage
| FLDOPPSTAGE
|
|-
| Status
| FLDOPPSTATUS
|
|-
| Closing Amount
| FLDOPPCLOSEAMOUNT
|
|-
| Description
| FLDOPPDESCRIPTION
|
|-
| Opportunity Type
| FLDOPPKIND
|
|-
| Opportunity Reason
| FLDOPPREASON
|
|-
| Note
| FLDOPPNOTES
|
|-
| Territory
| FLDOPPREGION
|
|-
| Field1
| FLDEVTFAMILY
| User Defined field
|-
| Field2
| FLDEVTACTION
| User Defined field
|-
| Field3
| FLDEVTPLACE
| User Defined field
|-
| Created by User
| FLDEVTCREATEUSERID
| Name of external software which created the event
|-
| Last Update: By User
| FLDEVTUPDATEUSER
| Name of external software which updated the event
|}

===Document Fields===
The table below lists the Document parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDDOCRECID
| The Document record ID. If provided, the existing Document will be updated. Otherwise, this will be added as a new Document.
|-
| Document Date
| FLDDOCDOCDATE
| The date for the Document. This is an optional parameter. If not provided, or if the value is illegal, the current date will be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
| Subject
| FLDOPPUSERID
|
|-
| Linked Record
| FLDDOCLINKRECID
| The RECID of a linked object. Each Document can be linked to one of the following objects:
*Ticket
*Contract
*Opportunity
*Knowledge Base Article
*Asset
The Record ID (20 chars) can be taken from:
#Object's Notes tab, at the bottom by right-clicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new object with the API.
|-
| Account Rec ID
| CARDID
| The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by right-clicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new Account with the API
|-
| Contact REC ID
| FLDDOCCONTACTID
| The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Field1
|FLDDOCTRANSPORT
|User Defined field
|-
|Field2
|FLDDOCFOLDER
|User Defined field
|-
|Field3
|FLDDOCUMENTPLACE
|User Defined field
|-
|File Path + File name
|FLDDOCDOCUMENTNAME
|The Document path
|-
|Category
|FLDDOCTREEID
|The category record ID should be taken from the database table called TreeTbl which contains the Category tree
|-
| Employee REC ID
| FLDDOCWORKERID
| The worker record ID to be linked to the Document. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
| Created by User
| FLDDOCCREATEUSER
| Name of external software which created the document
|-
| Last Update: By User
| FLDDOCUPDATEUSER
| Name of external software which updated the document
|}

===Knowledge Base Article Fields===
The table below lists the Knowledge Base Article parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDKBARECID
| The Article record ID. If provided, the existing Article will be updated. Otherwise, this will be added as a new Article.
|-
| Document Date
| FLDKBACREATEDATE
| The date for the Document. This is an optional parameter. If not provided, or if the value is illegal, the current date will be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
| Title
| FLDKBATITLE
|
|-
| Problem
| FLDKBAPROBLEM
|
|-
| Solution
| FLDKBASOLUTION
|
|-
| Status
| FLDKBASTATUS
| Possible values:
*DRAFT = 'D'
*PUBLISHED = 'P'
*OBSOLETE = 'O'
|-
|Category
|FLDKBACATEGORY
|
|-
|Public
|FLDKBAISPUBLIC
|Is the Document public. 
Possible values: 
*'Y' = Yes
*'N' = No
|-
|Created by User
|FLDDOCCREATEUSER
|Name of external software which created the document
|-
|Last Update: By User
|FLDDOCUPDATEUSER
|Name of external software which updated the document
|}

===Error Codes Description===
These error codes are returned when calling the CmtGetDescriptionByStatus function: 
'''1000''' CmtDbEng.dll not found. 
'''1001''' Invalid value for the Data Kind value. 
'''1002''' Invalid DATA buffer received. Make sure you have allocated the buffer correctly and
that you have passed the correct buffer length. 
'''1003''' Invalid MAP buffer received. Make sure you have allocated the buffer correctly and
that you have passed the correct buffer length. 
'''1004''' Invalid REC ID buffer received. Make sure you have allocated the buffer correctly
and that you have passed the correct buffer length. 
'''1005''' Invalid LOG buffer received. Make sure you've allocated the buffer correctly and
that you've passed the correct buffer length. 
'''1006''' Invalid REC ID buffer received. It should be at least 20 characters. 
'''1007''' Invalid external software name received. Specify a unique name that identifies your
software. 
'''1008''' Cannot process the transaction. Make sure to call the INIT procedure at least once
prior to sending transactions for processing. 
'''1009''' Path specified for Commit DB folder not found. 
'''1010''' Path specified for Commit DB folder found, but its contents do not reflect a valid DB
folder. 
'''1011''' The RED ID received for the employee/user was not found in Commit, is invalid or is
related to an inactive employee record. 
'''1012''' Error registering software. 
'''1013''' Software name is missing. Make sure you specify a name that identifies your
software. 
'''1014''' Software name is less than 3 characters long. Make sure you enter a software name
that has 3 to 15 characters. 
'''1015''' Software name is too long. Make sure your software name has 3 to 15 characters. 
'''1100''' Database access error. 

General error codes, returned when calling the functions CmtGetDescriptionByCode: 
'''50000''' The data is not correct for its type. 
'''50001''' The field value has been truncated due to the field length in the database. 
'''50002''' The insert operation Failed because the REC ID already existed in the database. 
'''50003''' Failed to update Record since it is being updated by another user. 
'''50103''' Illegal REC ID. 
'''50104''' REC ID Creation failed. 
'''50105''' Illegal Sub-Contact REC ID. 
'''50106''' Illegal Contract REC ID. 
'''50107''' Illegal Employee REC ID. 
'''50108''' Illegal Ticket REC ID. 
'''50109''' Illegal Account REC ID. 
'''50110''' Illegal data for that Contract. 
'''50111''' This Employee is not active. 
'''50112''' Illegal Document REC ID. 
'''50113''' Illegal linked object REC ID. 
'''50114''' Employee not found. 
'''50115''' Some mandatory fields have no values. 
'''51000''' Illegal kind of Account entity. 
'''51001''' Account Manager not found. 
'''51002''' The REC ID of the Account Manager is illegal. 
'''51003''' Illegal tax code. 
'''51004''' This code does not exist in Commit. 
'''52000''' Illegal kind of event. 
'''52001''' Illegal start time. 
'''52002''' Illegal end time. 
'''52003''' Illegal event date. 
'''52004''' The field Reminder1 has Illegal Value. 
'''52005''' The amount in the field has an illegal value. 
'''52006''' The Field Remider1:Units has Illegal Value. 
'''52007''' The Field Remider2:Active has Illegal Value. 
'''52008''' The Field Remider2:Amount has Illegal Value. 
'''52009''' The Field Remider2:Units has Illegal Value. 
'''52010''' Illegal employee REC ID. 
'''52011''' Error occurred while updating the Task/Appointment employee field. 
'''54000''' Illegal Ticket open date. 
'''54001''' Illegal Ticket close date. 
'''54002''' Illegal Ticket code area. 
'''54004''' Illegal Ticket priority. 
'''54005''' Illegal Ticket status. 
'''54006''' The Ticket Account was not found in the database. 
'''54007''' The Ticket Account Manager was not ound in the database. 
'''54008''' This code does not exist in Commit. 
'''54009''' This code does not exist in Commit. 
'''54010''' This code does not exist in Commit. 
'''54011''' This code does not exist in Commit. 
'''54012''' This code does not exist in Commit. 
'''55000''' Illegal charge date. 
'''55001''' Illegal charge REC ID. 
'''55002''' Illegal start date. 
'''55003''' Illegal start time. 
'''55004''' Illegal amount entered for hours. 
'''55005''' Illegal quantity. 
'''55006''' Illegal price. 
'''55007''' Illegal total. 
'''55008''' Illegal value in the Adjust Amount field. 
'''55009''' Illegal value in the Adjust Percent. 
'''55010''' The Discount/Markup field has an illegal value. 
'''55011''' Illegal value in the Adjust Kind field. 
'''55012''' Illegal bill total. 
'''55013''' You can not create a charge for a suspended item. 
'''55014''' Item was not found in Commit. 
'''55015''' This code does not exist in Commit. 
'''55016''' This code does not exists in Commit. 
'''55017''' This Code does not exist in Commit. 
'''55018''' This Code does not exist in Commit. 
'''55019''' This Code does not exist in Commit. 
'''55020''' This Code does not exist in Commit. 
'''55021''' This Code does not exist in Commit. 
'''56000''' Illegal item code. 
'''56001''' The field that indicates the item group type has an illegal value. 
'''56002''' The field that indicates if the Item is suspended has an illegal value. 
'''56003''' Illegal value of The field that indicate if the item is suspended. 
'''56004''' Mismatch found between the fields price and price source. 
'''56005''' Illegal cost. 
'''56006''' Mismatch found between the fields cost and item group type. 
'''56007''' The field that indicates if the charge is by unit or by hours has an illegal value. 
'''56008''' Illegal value in the Description. 
'''56009''' The field that indicates the item type has an illegal value. 
'''57000''' This Code does not exist in Commit. 
'''58000''' Illegal date time. 
'''58001''' The Description field was not found. 
'''58002''' The field kind was not found. 
'''58003''' The Account member was not found. 
'''59000''' This code does not exists in Commit. 
'''59001''' This Code does not exist in Commit. 
'''59002''' This Code does not exist in Commit. 
'''59003''' This Code does not exist in Commit. 
'''59004''' This Code does not exist in Commit. 
'''59005''' This Code does not exist in Commit. 
'''60000''' Invalid web user record ID number. 
'''60001''' This customer web user is not active. 
'''60002''' This user is not a customer. 

==See Also==
*[[Commit API Developers Guide]]
*[[API Code Samples]]
[[Category:User Manuals]]
[[Category:Integration]]

__NOTOC__

API Reference Manual

2009-08-20T10:34:41Z

Yarden: /* Intorduction */

{{usermanualsapidevelopersguide}}
==Intorduction==

Following is a detailed listing of fields per entity which can be added/updated using the API. The API parameters are the same when using the Programming API or the XML API.

The API allows you to add/update the following entities:
*[[#Account Fields|Accounts]]
*[[#Ticket Fields|Tickets]]
*[[#Charge Fields|Charges (and Contract-price Charges)]]
*[[#Item Fields|Items]]
*[[#History Note Fields|History Notes]]
*[[#Asset Fields|Assets]]
*[[#Calendar Fields|Calender]]
*[[#Opportunity Fields|Opportunities]]
*[[#Document Fields|Documents]]
*[[#Knowledge Base Article Fields|Knowledge Base Articles]]

All API functions may return error codes. You can find the possible error codes in:
*[[#Error Codes Description|Error Codes]]

In the following section you will find a detailed listing of the database fields. Each table includes the fields '''Display name''' (as shows in the application), the '''Database Field Name''' (internal database field identifier) and comments.

Note that when using XML formatted messages, the database field name refers to the name to be provided within the XML token. For example, when the field name is FLDSLPQUANTITY, the XML token should look like this:
<FLDSLPQUANTITY>10</FLDSLPQUANTITY>

The following table shows the data kind code when using XML or when using the API functions:

{| class="wikitable"
|-
! '''Application entity'''
! '''Table name'''
! '''Code'''
|-
| Accounts
| Cards
| 10
|-
| Opportunities
| Opps
| 20
|-
| Documents
| Docs
| 30
|-
| Charges
| Docs
| 30
|-
| Charges
| Slips
| 40
|-
| Appointments/Tasks
| Events
| 50
|-
| History Notes
| Notebook
| 60
|-
| Tickets
| Tickets
| 70
|-
| Items
| Items
| 80
|-
| Assets
| Assets
| 90
|-
| Knowledge Base
| KBArticles
| 100
|}
You can find examples of adding and updating records in the database by using the database field in the [[API Code Samples]] section.

===Account Fields===
The following table lists the most important parameters for adding/updating Account
records.
Note slight differences when adding a main account vs. adding a secondary contact.

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Account REC ID
| FLDTKTCARDID
|The Account record ID (20 chars). The Account Rec ID can be taken from:
#Account Notes tab, at the bottom, rightclick the RecID field and use Copy. e.g. CRDVQYSOD1B4U4HZIQJJ
#Using ODBC to pull information from the database.
#From the Email Response when adding new Account with the API.
|-
| Address: Line1
| FLDCRDADDRESS1
|
|-
| Address: Line2
| FLDCRDADDRESS2
|
|-
| Address: Line3
| FLDCRDADDRESS3
|
|-
| Account Manager
| FLDCRDASSIGNCARDID
| This field has two roles:
#When adding a main Account: The account manager should contain the ID of the Employee who is the account manager.
#When adding a secondary contact: 
This field should contain the ID of the main Account to which the secondary contacted is
added.
|-
| Assistant
| FLDCRDASSISTANT
|
|-
|Contract
|FLDCRDBCRECID
|The default Contract for this Account (not required)
|-
|Account Number
|FLDCRDCARDID2
|
|-
|ID
|FLDCRDCARDID3
|
|-
|Popup Message
|FLDCRDCARDMESSAGE
|
|-
|Address: City
|FLDCRDCITY
|
|-
|Address: Zip
|FLDCRDZIP
|
|-
|Company name
|FLDCRDCOMPANY
|
|-
|Contact: First & Last Name
|FLDCRDCONTACT
|
|-
|Address: State
|FLDCRDCOUNTRY
|
|-
|Creation Date
|FLDCRDCREATEDATE
|Any date format, such as DD/MM/YYYY
|-
|Created by User
|FLDCRDCREATEUSERID
|Foreign Software Name which created the account
|-
|Dear
|FLDCRDDEAR
|
|-
|Department
|FLDCRDDEPARTMENT
|
|-
|Documents Store Directory
|FLDCRDDOCSFOLDER
|
|-
|E-Mail Address 1
|FLDCRDEMAIL1
|
|-
|E-Mail Address 2
|FLDCRDEMAIL2
|
|-
|Account Type
|FLDCRDENTITYKIND
|When adding a Main Account = 1 When adding a secondary contact = 5
|-
|Fax Number
|FLDCRDFAX1
|
|-
|Fax Number Extension
|FLDCRDFAXDESC1
|
|-
|File as
|FLDCRDFULLNAME
|
|-
|Type
|FLDCRDKIND
|
|-
|Last Name
|FLDCRDLASTNAME
|
|-
|Notes
|FLDCRDNOTES
|
|-
|Field
|FLDCRDPERSONID
|
|-
|Phone 1 Ext.
|FLDCRDPHNDESC1
|
|-
|Phone 2 Ext.
|FLDCRDPHNDESC2
|
|-
|Phone 3 Ext.
|FLDCRDPHNDESC3
|
|-
|Phone 4 Ext.
|FLDCRDPHNDESC4
|
|-
|Phone 1
|FLDCRDPHONE1
|
|-
|Phone 2
|FLDCRDPHONE2
|
|-
|Phone 3
|FLDCRDPHONE3
|
|-
|Phone 4
|FLDCRDPHONE4
|
|-
|Region
|Region FLDCRDREGIONCODE
|
|-
|Popup Message: Display Indication
|FLDCRDSHOWMESSAGE
|
|-
|Address: Country
|FLDCRDSTATE
|
|-
|Sub-Contact Code
|FLDCRDSUBCODE
|
|-
|Salutation
|FLDCRDSUFFIX
|
|-
|Tax1
|FLDCRDTAXCODE1
|
|-
|Tax2
|FLDCRDTAXCODE2
|
|-
|Notes
|FLDCRDNOTES
|
|-
|Title
|FLDCRDTITLE
|
|-
|Last Updated by
|FLDCRDUPDATEUSERID
|When performing updates on existing Account - pass the Foreign Software Name which performs the update.
|-
|Web Address 1
|FLDCRDURL1
|
|-
|Web Address 2
|FLDCRDURL2
|
|-
|Status
|FLDCRDUSER1
|
|-
|Field1
|FLDCRDUSER2
|
|-
|Field2
|FLDCRDUSER3
|
|-
|Field3
|FLDCRDUSER4
|
|-
|Field4
|FLDCRDUSER5
|
|}

===Ticket Fields===

The table below lists the most important Ticket parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Account REC ID
| FLDTKTCARDID
|The Account record ID (20 chars). The Account Rec ID can be taken from:
#Account Notes tab, at the bottom by rightclicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a cnew Account with the API
|-
| Contact REC ID
| FLDTKTCONTACTID
|The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
| Contract REC ID
| FLDTKTBCRECID
|The Contract ID. If not supplied, will be taken from the Account's default contract.
|-
| Emp. REC ID
| FLDTKTWORKERID
|The worker ID to be linked to the Ticket. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
| Priority
| FLDTKTPRIORITY
| The ticket priority. If not passed in the transaction, the default value for new Tickets will be used.
Immediate = 10 High = 20 Normal = 30 Low = 40 Not Applicable= 50
|-
| Ticket Number
| FLDTKTTICKETNO
| The Ticket number. If passed, must be an existing Ticket, and this will update the Ticket with the details in the transaction.
|-
|Description
|FLDTKTPROBLEM
|This is the Ticket Description. This is a mandatory field, which must contain text.
|-
|Ticket Type
|FLDTKTKIND
|Ticket Type (optional). The Ticket Type string should be passed. If not provided, default is used.
|-
|Source
|FLDTKTSOURCE
|
|-
|Estimated Duration Time
|FLDTKTSCHEDLENESTIM
|Estimated duration time for the Ticket in minutes.
|-
|Show Ticket in Dispatcher
|FLDTKTFORDISPATCH
|Possible values: Yes/No
|-
|Status
|FLDTKTSTATUS
|The Ticket Status (optional). 
Possible values: 
New = 100 
Pending = 200 
Scheduled = 300 
In-House Service = 400 
On-Site Service = 500 
Laboratory Service = 600 
Hold = 700 
Other = 800 
Canceled = 900 
Completed = 1000
|-
|Created by User
|FLDTKTCREATEUSER
|Should contain the external software name which created the Ticket
|-
|Due Date
|FLDTKTDUEDATETIME
|Due date for the Ticket. Should be passed in date format. e.g. MM/DD/YYYY
|-
|Resolution
|FLDTKTSOLUTION
|Ticket resolution text
|}

===Charge Fields===
The table below lists the most important Charge parameters and behavior.

Contract-price Charges have some special characteristics (see comments marked by * in
the table below):

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDSLPRECID
|The Charge record ID. If provided, the existing Charge will be updated. Otherwise, this will be
added as a new Charge.
|-
| Charge Source
| FLDSLPSOURCERECID
|The Charge source is the entity for which the charge is created. 
Possible values:
*Linked Contract RecID (for Contract-price Charges). Cannot be the "System Global Contract".
**Passing the Contract RecID indicates that this is a Contract-price charge.
*Entity RecID from which the charge is created (for example when creating a charge from an Appointment or Task).
|-
| Account REC ID
| FLDSLPCARDID
|The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by rightclicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new Account with the API
|-
| Employee REC ID
| FLDSLPWORKERID
| The worker record ID to be linked to the Charge. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
| Charged Item
| FLDSLPITEMID
| The Item Record ID to be linked to the Charge. This is a mandatory field.
*For Contract-price Charge can be only Fixed-Price, Unit-based Item.
|-
| Contract REC ID
| FLDSLPBCRECID
| The contract record ID (must be a Contract of the Account)
|-
|Ticket REC ID
|FLDSLPTICKETID
|The Ticket ID to be linked to the Charge.
*Not relevant for Contract-price Charge
|-
|Date
|FLDSLPSLIPDATE
|The date for the Charge. This is an optional parameter. If not provided, the current date will
be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
|Description
|FLDSLPDESC
|The Charge Description. If not provided, will be taken from the Item's description.
|-
|Units/Hours
|FLDSLPQUANTITY
|This is the quantity of hours/units
|-
|Adjust Amount
|FLDSLPADJUSTAMOUNT
|Discount/Markup amount. Positive number means Markup, negative number means Discount.
|-
|Adjust Percent
|FLDSLPADJUSTPERCENT
|Discount/Markup in percentage, must be between (-100) - 100. Positive number means Markup, negative number means Discount.
|-
|From Time
|FLDSLPSTARTTIME
|From time for labor Charges e.g. 12:06
*Not relevant for Contract-price Charge
|-
|To Time
|FLDSLPENDTIME
|From time for labor Charges e.g. 14:50
* Not relevant for Contract-price Charge
|-
|Price/Rate
|FLDSLPPRICE
|If not provided, the price is taken from the Item.
|-
| Billable
| FLDSLPBILLKIND
| B - Billable 
N - Not Billable 
If not provided, will be set according to the Contract type.
|-
| Billed
| FLDSLPSTAGE
| D - Draft
B - Billed
|-
| Field1
| FLDSLPUSER1
| User defined field
|-
| Create User
| FLDSLPCREATEUSER
| External software name which created the Charge
|}

===Item Fields===

The table below lists the most important Item parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDSLPRECID
|The Item record ID. If provided, the existing item will be updated. Otherwise, this will be added as a new item.
|-
| Item Group
| FLDITMITEMTYPEGROUP
|The Item Group to be linked to the Charge. This is a mandatory field: 
F - Labor (Fee) 
X - Expense 
P - Part
|-
| Item Code
| FLDITMITEMNO
|The item code is a mandatory field
|-
| Item Name
| FLDITMNAME
| The item name is a mandatory field
|-
| Price Source
| FLDITMPRICESOURCE
| F - Fixed Price 
W - by Employee Rate
|-
| Price per Hour/Unit
| FLDITMUNITISHOUR
| This field indicated whether the price is unitbased or hours-based. 
Y - by Hours 
N - by Units 
This is an optional field, depending on the Item Group. For example, if the item group is Labor, and Price Source is By Employee, the value will always be by hours
|-
|Price
|FLDITMUNITPRICE
|Must be a valid numeric value
|-
|Cost
|FLDITMSTANDARDCOST
|The date for the Charge. This is an optional parameter. If not provided, the current date will
be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
|Taxes
|FLDITMTAXCODE1 
FLDITMTAXCODE2 
FLDITMTAXCODE3
|You can pass up to 3 different tax codes.
|-
|Description by Name
|FLDITMDESCBYNAME
|Y - take the description from the name field 
N - take the description from the Description field
|-
|Description
|FLDITMDESC
|If not provided, the description is taken from the name.
|-
|Suspend
|FLDITMSUSPENDED
|Indicated whether this item is currently suspended: 
Y - yes 
N - no
|-
|Notes
|FLDITMNOTES
|
|-
|Field1
|FLDSLPUSER1
|User defined field
|-
|Create User
|FLDSLPCREATEUSER
|External software name which created the Charge
|-
| Created by User
| FLDTKTCREATEUSER
| Should contain the external software name which created the Ticket
|}

===History Note Fields===
The table below lists the most important History Note parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDHISRECID
|The History Note record ID. If provided, the existing History Note will be updated. otherwise, this will be added as a new History Note.
|-
| Date
| FLDHISNOTEDATETIME
|Any date format, such as DD/MM/YYYY
|-
| Description
| FLDHISDESCRIPTION
| The Description text
|-
| Opportunity/Ticket/Contract
| FLDHISLINKRECID
| Link to Opportunity or Ticket or Contract
|-
| Field
| FLDHISUSER1
| User defined field
|-
| About
| FLDHISKIND
| Optional field
|-
|Employee
|FLDHISWORKERID
|The worker ID to be linked to the Ticket. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
|Account
|FLDHISCARDID
|The Account record ID (20 chars). The Account Rec ID can be taken from:
#Account Notes tab, at the bottom, right-click the REC ID field and use Copy. e.g. CRDVQYSOD1B4U4HZIQJJ
#Using ODBC to pull information from the database
#From the Email Response when adding new Account with the API
|-
|Contact
|FLDHISCONTACTID
|The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Document
|FLDHISDOCID
|Linked Document ID, can be taken from the Document Properties window (right-click RecID and use Copy), or using the ODBC to pull information from the database.
|-
|Created by User
|FLDHISCREATEUSER
|Name of the external software which created this History Note
|}

===Asset Fields===
The table below lists the most important Asset parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Asset Code
| FLDASTASSETCODE
|If an existing Asset Code is provided, then existing Asset is updated. Otherwise a new Asset is added.
|-
| Asset Type
| FLDASTASSETTYPE
|The Type field is mandatory: 
Hardware = H 
Software = S 
Other = T
|-
| Asset Name
| FLDASTNAME
|
|-
| Status
| FLDASTSTATUS
| Mandatory field. 
Active = A 
Not Active = N 
If not provided, default Active is used.
|-
| Record ID
| FLDASTRECID
| If provided, must exist in the database. Ignored if empty
|-
| Serial No.
| FLDASTSERIALNO
|
|-
|Account
|FLDASTACCRECID
|The Account which is linked to the Asset
|-
|Contact
|FLDASTCONTACTRECID
|The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Created by user
|FLDASTCREATEUSER
|Name of external software which created this Asset
|-
|Purchase Date
|FLDASTCUSTPURDATE
|Any date format, such as DD/MM/YYYY
|-
|Purchased From Us
|FLDASTCUSTPURFROMUS
|Possible values: Y/N. 
If not provided, default value Y is used.
|-
| Purchase Invoice #
| FLDASTCUSTPUROURINV
|
|-
| Customer PO
| FLDASTCUSTPURPO
|
|-
| Purchase Price
| FLDASTCUSTPURPRICE
|
|-
| Delivered Date
| FLDASTDELIVEDATE
|
|-
| Description
| FLDASTDESC
|
|-
| Installed By
| FLDASTINSTALBY
|
|-
| Installed Date
| FLDASTINSTALDATE
|
|-
| License Codes
| FLDASTLICENSECODE
|
|-
| License Keys
| FLDASTLICENSEKEY
|
|-
| License Notes
| FLDASTLICENSENOTES
|
|-
| Location
| FLDASTLOCATION
|
|-
| Manufacturer
| FLDASTMANUFACTURER
|
|-
| Mnf Serial No.
| FLDASTMNFSERIALNO
|
|-
| Model
| FLDASTMODEL
|
|-
| Notes
| FLDASTNOTES
|
|-
| Quantity
| FLDASTQUANTITY
| If not provided, default value of 1 is used.
|-
| Last Update By
| FLDASTUPDATEUSER
| Name of externals software which performed the update
|-
| Field1
| FLDASTUSER1
| User defined field
|-
| Field2
| FLDASTUSER2
| User defined field
|-
| Field3
| FLDASTUSER3
| User defined field
|-
| Field4
| FLDASTUSER4
| User defined field
|-
| Field5
| FLDASTUSER5
| User defined field
|-
| Date1
| FLDASTUSERDATE1
| User defined field
|-
| Number1
| FLDASTUSERNUMBER1
| User defined field
|-
| Vendor Purchased Date
| FLDASTVENDORDATEPURC
|
|-
| Vendor Invoice #
| FLDASTVENDORINVNO
|
|-
| Vendor PO
| FLDASTVENDOROURPO
|
|-
| Vendor Price
| FLDASTVENDORPRICE
|
|-
| Vendor
| FLDASTVENDORRECID
|
|-
| Vendor Serial No.
| FLDASTVENDORSERNO
|
|-
| Vendor Warranty Exp. Date
| FLDASTVENDORWARREXP
| Any date format, such as DD/MM/YYYY
|-
| Version
| FLDASTVERSION
|
|-
| Warranty/License Exp.
| FLDASTWARREXPDATE
| Any date format, such as DD/MM/YYYY
|-
| Date
|
|
|}

===Calendar Fields===
The table below lists the most important Calendar parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDEVTRECID
|The Appointment/Task record ID. If provided, the existing entity will be updated. Otherwise, this
will be added as a new Appointment/Task.
|-
| Event Type
| FLDEVTWRITETOID
|The Event type is a mandatory field. 
Appointment = 1 
Task = 2
|-
| Employee
| FLDEVTWORKERID
| The Task/Appointment owner (for private events)
|-
| Private: User
| FLDEVTPRIVATEID
| Possible values: Y/N 
If an Employee was set, this field must be Y
|-
| Account
| FLDEVTCARDID
| The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by rightclicking
the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a
new Account with the API
|-
| Contact
| FLDEVTCONTACTID
| The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Document
|FLDEVTDOCID
|Linked Document ID, can be taken from the Document Properties window (right-click RecID and use Copy), or using the ODBC to pull information from the database.
|-
|Done Indication
|FLDEVTDONE
|Possible values: Y/N
|-
|Date
|FLDEVTEVENTDATE
|The Appointment/Task date is a mandatory field of Any date format, such as DD/MM/YYYY. If not
provided, the current date will be used.
|-
|Description
|FLDEVTFREETEXT
|
|-
|Time: Start
|FLDEVTFROMTIME
|Mandatory field
|-
| Time: End
| FLDEVTTOTIME
| Relevant only for Appointments. If this parameter is not provided, 30 min. interval from Start Time is used.
|-
| Opportunity/Ticket
| FLDEVTLINKRECID
| Linked Ticket/Opportunity/Contract/Asset
|-
| Field1
| FLDEVTFAMILY
| User Defined field
|-
| Field2
| FLDEVTACTION
| User Defined field
|-
| Field3
| FLDEVTPLACE
| User Defined field
|-
| Field4
| FLDEVTPLACE1
| User Defined field
|-
| Field5
| FLDEVTPLACE2
| User Defined field
|-
| Created by User
| FLDEVTCREATEUSERID
| Name of external software which created the event
|-
| Last Update: By User
| FLDEVTUPDATEUSER
| Name of external software which updated the
event
|}

===Opportunity Fields===
The table below lists the most important Opportunity parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDOPPRECID
| The Opportunity record ID. If provided, the existing Opportunity will be updated. Otherwise, this will be added as a new Opportunity.
|-
| Opportunity Name
| FLDOPPNAME
| Mandatory field.
|-
| Opportunity ID
| FLDOPPUSERID
| Optional (Oppty ID)
|-
| Account
| FLDOPPCARDID
| The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by right-clicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new Account with the API
|-
| Contact
| FLDEVTCONTACTID
| The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
| Source
| FLDOPPSOURCE
|
|-
|Document
|FLDEVTDOCID
|Linked Document ID, can be taken from the Document Properties window (right-click RecID and use Copy), or using the ODBC to pull information from the database.
|-
|Done Indication
|FLDEVTDONE
|Possible values: Y/N
|-
|Close Date
|FLDOPPCLOSEDATE
|
|-
|Manager
|FLDOPPWORKERID
|The Manager's REC ID
|-
|Open Date
|FLDOPPOPENDATE
|
|-
| Close By Date
| FLDOPPESTDATE
| Opportunity must be closed by this date
|-
| Amount
| FLDOPPAMOUNT
|
|-
| Probability %
| FLDOPPPROBABILITY
|
|-
| Stage
| FLDOPPSTAGE
|
|-
| Status
| FLDOPPSTATUS
|
|-
| Closing Amount
| FLDOPPCLOSEAMOUNT
|
|-
| Description
| FLDOPPDESCRIPTION
|
|-
| Opportunity Type
| FLDOPPKIND
|
|-
| Opportunity Reason
| FLDOPPREASON
|
|-
| Note
| FLDOPPNOTES
|
|-
| Territory
| FLDOPPREGION
|
|-
| Field1
| FLDEVTFAMILY
| User Defined field
|-
| Field2
| FLDEVTACTION
| User Defined field
|-
| Field3
| FLDEVTPLACE
| User Defined field
|-
| Created by User
| FLDEVTCREATEUSERID
| Name of external software which created the event
|-
| Last Update: By User
| FLDEVTUPDATEUSER
| Name of external software which updated the event
|}

===Document Fields===
The table below lists the Document parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDDOCRECID
| The Document record ID. If provided, the existing Document will be updated. Otherwise, this will be added as a new Document.
|-
| Document Date
| FLDDOCDOCDATE
| The date for the Document. This is an optional parameter. If not provided, or if the value is illegal, the current date will be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
| Subject
| FLDOPPUSERID
|
|-
| Linked Record
| FLDDOCLINKRECID
| The RECID of a linked object. Each Document can be linked to one of the following objects:
*Ticket
*Contract
*Opportunity
*Knowledge Base Article
*Asset
The Record ID (20 chars) can be taken from:
#Object's Notes tab, at the bottom by right-clicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new object with the API.
|-
| Account Rec ID
| CARDID
| The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by right-clicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new Account with the API
|-
| Contact REC ID
| FLDDOCCONTACTID
| The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Field1
|FLDDOCTRANSPORT
|User Defined field
|-
|Field2
|FLDDOCFOLDER
|User Defined field
|-
|Field3
|FLDDOCUMENTPLACE
|User Defined field
|-
|File Path + File name
|FLDDOCDOCUMENTNAME
|The Document path
|-
|Category
|FLDDOCTREEID
|The category record ID should be taken from the database table called TreeTbl which contains the Category tree
|-
| Employee REC ID
| FLDDOCWORKERID
| The worker record ID to be linked to the Document. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
| Created by User
| FLDDOCCREATEUSER
| Name of external software which created the document
|-
| Last Update: By User
| FLDDOCUPDATEUSER
| Name of external software which updated the document
|}

===Knowledge Base Article Fields===
The table below lists the Knowledge Base Article parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDKBARECID
| The Article record ID. If provided, the existing Article will be updated. Otherwise, this will be added as a new Article.
|-
| Document Date
| FLDKBACREATEDATE
| The date for the Document. This is an optional parameter. If not provided, or if the value is illegal, the current date will be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
| Title
| FLDKBATITLE
|
|-
| Problem
| FLDKBAPROBLEM
|
|-
| Solution
| FLDKBASOLUTION
|
|-
| Status
| FLDKBASTATUS
| Possible values:
*DRAFT = 'D'
*PUBLISHED = 'P'
*OBSOLETE = 'O'
|-
|Category
|FLDKBACATEGORY
|
|-
|Public
|FLDKBAISPUBLIC
|Is the Document public. 
Possible values: 
*'Y' = Yes
*'N' = No
|-
|Created by User
|FLDDOCCREATEUSER
|Name of external software which created the document
|-
|Last Update: By User
|FLDDOCUPDATEUSER
|Name of external software which updated the document
|}

===Error Codes Description===
These error codes are returned when calling the CmtGetDescriptionByStatus function: 
'''1000''' CmtDbEng.dll not found. 
'''1001''' Invalid value for the Data Kind value. 
'''1002''' Invalid DATA buffer received. Make sure you have allocated the buffer correctly and
that you have passed the correct buffer length. 
'''1003''' Invalid MAP buffer received. Make sure you have allocated the buffer correctly and
that you have passed the correct buffer length. 
'''1004''' Invalid REC ID buffer received. Make sure you have allocated the buffer correctly
and that you have passed the correct buffer length. 
'''1005''' Invalid LOG buffer received. Make sure you've allocated the buffer correctly and
that you've passed the correct buffer length. 
'''1006''' Invalid REC ID buffer received. It should be at least 20 characters. 
'''1007''' Invalid external software name received. Specify a unique name that identifies your
software. 
'''1008''' Cannot process the transaction. Make sure to call the INIT procedure at least once
prior to sending transactions for processing. 
'''1009''' Path specified for Commit DB folder not found. 
'''1010''' Path specified for Commit DB folder found, but its contents do not reflect a valid DB
folder. 
'''1011''' The RED ID received for the employee/user was not found in Commit, is invalid or is
related to an inactive employee record. 
'''1012''' Error registering software. 
'''1013''' Software name is missing. Make sure you specify a name that identifies your
software. 
'''1014''' Software name is less than 3 characters long. Make sure you enter a software name
that has 3 to 15 characters. 
'''1015''' Software name is too long. Make sure your software name has 3 to 15 characters. 
'''1100''' Database access error. 

General error codes, returned when calling the functions CmtGetDescriptionByCode: 
'''50000''' The data is not correct for its type. 
'''50001''' The field value has been truncated due to the field length in the database. 
'''50002''' The insert operation Failed because the REC ID already existed in the database. 
'''50003''' Failed to update Record since it is being updated by another user. 
'''50103''' Illegal REC ID. 
'''50104''' REC ID Creation failed. 
'''50105''' Illegal Sub-Contact REC ID. 
'''50106''' Illegal Contract REC ID. 
'''50107''' Illegal Employee REC ID. 
'''50108''' Illegal Ticket REC ID. 
'''50109''' Illegal Account REC ID. 
'''50110''' Illegal data for that Contract. 
'''50111''' This Employee is not active. 
'''50112''' Illegal Document REC ID. 
'''50113''' Illegal linked object REC ID. 
'''50114''' Employee not found. 
'''50115''' Some mandatory fields have no values. 
'''51000''' Illegal kind of Account entity. 
'''51001''' Account Manager not found. 
'''51002''' The REC ID of the Account Manager is illegal. 
'''51003''' Illegal tax code. 
'''51004''' This code does not exist in Commit. 
'''52000''' Illegal kind of event. 
'''52001''' Illegal start time. 
'''52002''' Illegal end time. 
'''52003''' Illegal event date. 
'''52004''' The field Reminder1 has Illegal Value. 
'''52005''' The amount in the field has an illegal value. 
'''52006''' The Field Remider1:Units has Illegal Value. 
'''52007''' The Field Remider2:Active has Illegal Value. 
'''52008''' The Field Remider2:Amount has Illegal Value. 
'''52009''' The Field Remider2:Units has Illegal Value. 
'''52010''' Illegal employee REC ID. 
'''52011''' Error occurred while updating the Task/Appointment employee field. 
'''54000''' Illegal Ticket open date. 
'''54001''' Illegal Ticket close date. 
'''54002''' Illegal Ticket code area. 
'''54004''' Illegal Ticket priority. 
'''54005''' Illegal Ticket status. 
'''54006''' The Ticket Account was not found in the database. 
'''54007''' The Ticket Account Manager was not ound in the database. 
'''54008''' This code does not exist in Commit. 
'''54009''' This code does not exist in Commit. 
'''54010''' This code does not exist in Commit. 
'''54011''' This code does not exist in Commit. 
'''54012''' This code does not exist in Commit. 
'''55000''' Illegal charge date. 
'''55001''' Illegal charge REC ID. 
'''55002''' Illegal start date. 
'''55003''' Illegal start time. 
'''55004''' Illegal amount entered for hours. 
'''55005''' Illegal quantity. 
'''55006''' Illegal price. 
'''55007''' Illegal total. 
'''55008''' Illegal value in the Adjust Amount field. 
'''55009''' Illegal value in the Adjust Percent. 
'''55010''' The Discount/Markup field has an illegal value. 
'''55011''' Illegal value in the Adjust Kind field. 
'''55012''' Illegal bill total. 
'''55013''' You can not create a charge for a suspended item. 
'''55014''' Item was not found in Commit. 
'''55015''' This code does not exist in Commit. 
'''55016''' This code does not exists in Commit. 
'''55017''' This Code does not exist in Commit. 
'''55018''' This Code does not exist in Commit. 
'''55019''' This Code does not exist in Commit. 
'''55020''' This Code does not exist in Commit. 
'''55021''' This Code does not exist in Commit. 
'''56000''' Illegal item code. 
'''56001''' The field that indicates the item group type has an illegal value. 
'''56002''' The field that indicates if the Item is suspended has an illegal value. 
'''56003''' Illegal value of The field that indicate if the item is suspended. 
'''56004''' Mismatch found between the fields price and price source. 
'''56005''' Illegal cost. 
'''56006''' Mismatch found between the fields cost and item group type. 
'''56007''' The field that indicates if the charge is by unit or by hours has an illegal value. 
'''56008''' Illegal value in the Description. 
'''56009''' The field that indicates the item type has an illegal value. 
'''57000''' This Code does not exist in Commit. 
'''58000''' Illegal date time. 
'''58001''' The Description field was not found. 
'''58002''' The field kind was not found. 
'''58003''' The Account member was not found. 
'''59000''' This code does not exists in Commit. 
'''59001''' This Code does not exist in Commit. 
'''59002''' This Code does not exist in Commit. 
'''59003''' This Code does not exist in Commit. 
'''59004''' This Code does not exist in Commit. 
'''59005''' This Code does not exist in Commit. 
'''60000''' Invalid web user record ID number. 
'''60001''' This customer web user is not active. 
'''60002''' This user is not a customer. 

==See Also==
*[[Commit API Developers Guide]]
*[[API Code Samples]]
[[Category:User Manuals]]
[[Category:Integration]]

__NOTOC__

API Reference Manual

2009-08-20T10:32:33Z

Yarden:

{{usermanualsapidevelopersguide}}
==Intorduction==

Following is a detailed listing of fields per entity which can be added/updated using the API. The API parameters are the same when using the Programming API or the XML API.

The API allows you to add/update the following entities:
*[[#Account Fields|Accounts]]
*[[#Ticket Fields|Tickets]]
*[[#Charge Fields|Charges (and Contract-price Charges)]]
*[[#Item Fields|Items]]
*[[#History Note Fields|History Notes]]
*[[#Asset Fields|Assets]]
*[[#Calendar Fields|Calender]]
*[[#Opportunity Fields|Opportunities]]
*[[#Document Fields|Documents]]
*[[#Knowledge Base Article Fields|Knowledge Base Articles]]

All API functions may return error codes. You can find the possible error codes in:
*[[#Error Codes Description|Error Codes]]

In the following section you will find a detailed listing of the database fields. Each table includes the fields '''Display name''' (as shows in the application), the '''Database Field Name''' (internal database field identifier) and comments.

Note that when using XML formatted messages, the database field name refers to the name to be provided within the XML token. For example, when the field name is FLDSLPQUANTITY, the XML token should look like this:
<FLDSLPQUANTITY>10</FLDSLPQUANTITY>

You can find examples of adding and updating records in the database by using the database field in the [[API Code Samples]] section.

===Account Fields===
The following table lists the most important parameters for adding/updating Account
records.
Note slight differences when adding a main account vs. adding a secondary contact.

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Account REC ID
| FLDTKTCARDID
|The Account record ID (20 chars). The Account Rec ID can be taken from:
#Account Notes tab, at the bottom, rightclick the RecID field and use Copy. e.g. CRDVQYSOD1B4U4HZIQJJ
#Using ODBC to pull information from the database.
#From the Email Response when adding new Account with the API.
|-
| Address: Line1
| FLDCRDADDRESS1
|
|-
| Address: Line2
| FLDCRDADDRESS2
|
|-
| Address: Line3
| FLDCRDADDRESS3
|
|-
| Account Manager
| FLDCRDASSIGNCARDID
| This field has two roles:
#When adding a main Account: The account manager should contain the ID of the Employee who is the account manager.
#When adding a secondary contact: 
This field should contain the ID of the main Account to which the secondary contacted is
added.
|-
| Assistant
| FLDCRDASSISTANT
|
|-
|Contract
|FLDCRDBCRECID
|The default Contract for this Account (not required)
|-
|Account Number
|FLDCRDCARDID2
|
|-
|ID
|FLDCRDCARDID3
|
|-
|Popup Message
|FLDCRDCARDMESSAGE
|
|-
|Address: City
|FLDCRDCITY
|
|-
|Address: Zip
|FLDCRDZIP
|
|-
|Company name
|FLDCRDCOMPANY
|
|-
|Contact: First & Last Name
|FLDCRDCONTACT
|
|-
|Address: State
|FLDCRDCOUNTRY
|
|-
|Creation Date
|FLDCRDCREATEDATE
|Any date format, such as DD/MM/YYYY
|-
|Created by User
|FLDCRDCREATEUSERID
|Foreign Software Name which created the account
|-
|Dear
|FLDCRDDEAR
|
|-
|Department
|FLDCRDDEPARTMENT
|
|-
|Documents Store Directory
|FLDCRDDOCSFOLDER
|
|-
|E-Mail Address 1
|FLDCRDEMAIL1
|
|-
|E-Mail Address 2
|FLDCRDEMAIL2
|
|-
|Account Type
|FLDCRDENTITYKIND
|When adding a Main Account = 1 When adding a secondary contact = 5
|-
|Fax Number
|FLDCRDFAX1
|
|-
|Fax Number Extension
|FLDCRDFAXDESC1
|
|-
|File as
|FLDCRDFULLNAME
|
|-
|Type
|FLDCRDKIND
|
|-
|Last Name
|FLDCRDLASTNAME
|
|-
|Notes
|FLDCRDNOTES
|
|-
|Field
|FLDCRDPERSONID
|
|-
|Phone 1 Ext.
|FLDCRDPHNDESC1
|
|-
|Phone 2 Ext.
|FLDCRDPHNDESC2
|
|-
|Phone 3 Ext.
|FLDCRDPHNDESC3
|
|-
|Phone 4 Ext.
|FLDCRDPHNDESC4
|
|-
|Phone 1
|FLDCRDPHONE1
|
|-
|Phone 2
|FLDCRDPHONE2
|
|-
|Phone 3
|FLDCRDPHONE3
|
|-
|Phone 4
|FLDCRDPHONE4
|
|-
|Region
|Region FLDCRDREGIONCODE
|
|-
|Popup Message: Display Indication
|FLDCRDSHOWMESSAGE
|
|-
|Address: Country
|FLDCRDSTATE
|
|-
|Sub-Contact Code
|FLDCRDSUBCODE
|
|-
|Salutation
|FLDCRDSUFFIX
|
|-
|Tax1
|FLDCRDTAXCODE1
|
|-
|Tax2
|FLDCRDTAXCODE2
|
|-
|Notes
|FLDCRDNOTES
|
|-
|Title
|FLDCRDTITLE
|
|-
|Last Updated by
|FLDCRDUPDATEUSERID
|When performing updates on existing Account - pass the Foreign Software Name which performs the update.
|-
|Web Address 1
|FLDCRDURL1
|
|-
|Web Address 2
|FLDCRDURL2
|
|-
|Status
|FLDCRDUSER1
|
|-
|Field1
|FLDCRDUSER2
|
|-
|Field2
|FLDCRDUSER3
|
|-
|Field3
|FLDCRDUSER4
|
|-
|Field4
|FLDCRDUSER5
|
|}

===Ticket Fields===

The table below lists the most important Ticket parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Account REC ID
| FLDTKTCARDID
|The Account record ID (20 chars). The Account Rec ID can be taken from:
#Account Notes tab, at the bottom by rightclicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a cnew Account with the API
|-
| Contact REC ID
| FLDTKTCONTACTID
|The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
| Contract REC ID
| FLDTKTBCRECID
|The Contract ID. If not supplied, will be taken from the Account's default contract.
|-
| Emp. REC ID
| FLDTKTWORKERID
|The worker ID to be linked to the Ticket. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
| Priority
| FLDTKTPRIORITY
| The ticket priority. If not passed in the transaction, the default value for new Tickets will be used.
Immediate = 10 High = 20 Normal = 30 Low = 40 Not Applicable= 50
|-
| Ticket Number
| FLDTKTTICKETNO
| The Ticket number. If passed, must be an existing Ticket, and this will update the Ticket with the details in the transaction.
|-
|Description
|FLDTKTPROBLEM
|This is the Ticket Description. This is a mandatory field, which must contain text.
|-
|Ticket Type
|FLDTKTKIND
|Ticket Type (optional). The Ticket Type string should be passed. If not provided, default is used.
|-
|Source
|FLDTKTSOURCE
|
|-
|Estimated Duration Time
|FLDTKTSCHEDLENESTIM
|Estimated duration time for the Ticket in minutes.
|-
|Show Ticket in Dispatcher
|FLDTKTFORDISPATCH
|Possible values: Yes/No
|-
|Status
|FLDTKTSTATUS
|The Ticket Status (optional). 
Possible values: 
New = 100 
Pending = 200 
Scheduled = 300 
In-House Service = 400 
On-Site Service = 500 
Laboratory Service = 600 
Hold = 700 
Other = 800 
Canceled = 900 
Completed = 1000
|-
|Created by User
|FLDTKTCREATEUSER
|Should contain the external software name which created the Ticket
|-
|Due Date
|FLDTKTDUEDATETIME
|Due date for the Ticket. Should be passed in date format. e.g. MM/DD/YYYY
|-
|Resolution
|FLDTKTSOLUTION
|Ticket resolution text
|}

===Charge Fields===
The table below lists the most important Charge parameters and behavior.

Contract-price Charges have some special characteristics (see comments marked by * in
the table below):

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDSLPRECID
|The Charge record ID. If provided, the existing Charge will be updated. Otherwise, this will be
added as a new Charge.
|-
| Charge Source
| FLDSLPSOURCERECID
|The Charge source is the entity for which the charge is created. 
Possible values:
*Linked Contract RecID (for Contract-price Charges). Cannot be the "System Global Contract".
**Passing the Contract RecID indicates that this is a Contract-price charge.
*Entity RecID from which the charge is created (for example when creating a charge from an Appointment or Task).
|-
| Account REC ID
| FLDSLPCARDID
|The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by rightclicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new Account with the API
|-
| Employee REC ID
| FLDSLPWORKERID
| The worker record ID to be linked to the Charge. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
| Charged Item
| FLDSLPITEMID
| The Item Record ID to be linked to the Charge. This is a mandatory field.
*For Contract-price Charge can be only Fixed-Price, Unit-based Item.
|-
| Contract REC ID
| FLDSLPBCRECID
| The contract record ID (must be a Contract of the Account)
|-
|Ticket REC ID
|FLDSLPTICKETID
|The Ticket ID to be linked to the Charge.
*Not relevant for Contract-price Charge
|-
|Date
|FLDSLPSLIPDATE
|The date for the Charge. This is an optional parameter. If not provided, the current date will
be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
|Description
|FLDSLPDESC
|The Charge Description. If not provided, will be taken from the Item's description.
|-
|Units/Hours
|FLDSLPQUANTITY
|This is the quantity of hours/units
|-
|Adjust Amount
|FLDSLPADJUSTAMOUNT
|Discount/Markup amount. Positive number means Markup, negative number means Discount.
|-
|Adjust Percent
|FLDSLPADJUSTPERCENT
|Discount/Markup in percentage, must be between (-100) - 100. Positive number means Markup, negative number means Discount.
|-
|From Time
|FLDSLPSTARTTIME
|From time for labor Charges e.g. 12:06
*Not relevant for Contract-price Charge
|-
|To Time
|FLDSLPENDTIME
|From time for labor Charges e.g. 14:50
* Not relevant for Contract-price Charge
|-
|Price/Rate
|FLDSLPPRICE
|If not provided, the price is taken from the Item.
|-
| Billable
| FLDSLPBILLKIND
| B - Billable 
N - Not Billable 
If not provided, will be set according to the Contract type.
|-
| Billed
| FLDSLPSTAGE
| D - Draft
B - Billed
|-
| Field1
| FLDSLPUSER1
| User defined field
|-
| Create User
| FLDSLPCREATEUSER
| External software name which created the Charge
|}

===Item Fields===

The table below lists the most important Item parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDSLPRECID
|The Item record ID. If provided, the existing item will be updated. Otherwise, this will be added as a new item.
|-
| Item Group
| FLDITMITEMTYPEGROUP
|The Item Group to be linked to the Charge. This is a mandatory field: 
F - Labor (Fee) 
X - Expense 
P - Part
|-
| Item Code
| FLDITMITEMNO
|The item code is a mandatory field
|-
| Item Name
| FLDITMNAME
| The item name is a mandatory field
|-
| Price Source
| FLDITMPRICESOURCE
| F - Fixed Price 
W - by Employee Rate
|-
| Price per Hour/Unit
| FLDITMUNITISHOUR
| This field indicated whether the price is unitbased or hours-based. 
Y - by Hours 
N - by Units 
This is an optional field, depending on the Item Group. For example, if the item group is Labor, and Price Source is By Employee, the value will always be by hours
|-
|Price
|FLDITMUNITPRICE
|Must be a valid numeric value
|-
|Cost
|FLDITMSTANDARDCOST
|The date for the Charge. This is an optional parameter. If not provided, the current date will
be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
|Taxes
|FLDITMTAXCODE1 
FLDITMTAXCODE2 
FLDITMTAXCODE3
|You can pass up to 3 different tax codes.
|-
|Description by Name
|FLDITMDESCBYNAME
|Y - take the description from the name field 
N - take the description from the Description field
|-
|Description
|FLDITMDESC
|If not provided, the description is taken from the name.
|-
|Suspend
|FLDITMSUSPENDED
|Indicated whether this item is currently suspended: 
Y - yes 
N - no
|-
|Notes
|FLDITMNOTES
|
|-
|Field1
|FLDSLPUSER1
|User defined field
|-
|Create User
|FLDSLPCREATEUSER
|External software name which created the Charge
|-
| Created by User
| FLDTKTCREATEUSER
| Should contain the external software name which created the Ticket
|}

===History Note Fields===
The table below lists the most important History Note parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDHISRECID
|The History Note record ID. If provided, the existing History Note will be updated. otherwise, this will be added as a new History Note.
|-
| Date
| FLDHISNOTEDATETIME
|Any date format, such as DD/MM/YYYY
|-
| Description
| FLDHISDESCRIPTION
| The Description text
|-
| Opportunity/Ticket/Contract
| FLDHISLINKRECID
| Link to Opportunity or Ticket or Contract
|-
| Field
| FLDHISUSER1
| User defined field
|-
| About
| FLDHISKIND
| Optional field
|-
|Employee
|FLDHISWORKERID
|The worker ID to be linked to the Ticket. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
|Account
|FLDHISCARDID
|The Account record ID (20 chars). The Account Rec ID can be taken from:
#Account Notes tab, at the bottom, right-click the REC ID field and use Copy. e.g. CRDVQYSOD1B4U4HZIQJJ
#Using ODBC to pull information from the database
#From the Email Response when adding new Account with the API
|-
|Contact
|FLDHISCONTACTID
|The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Document
|FLDHISDOCID
|Linked Document ID, can be taken from the Document Properties window (right-click RecID and use Copy), or using the ODBC to pull information from the database.
|-
|Created by User
|FLDHISCREATEUSER
|Name of the external software which created this History Note
|}

===Asset Fields===
The table below lists the most important Asset parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Asset Code
| FLDASTASSETCODE
|If an existing Asset Code is provided, then existing Asset is updated. Otherwise a new Asset is added.
|-
| Asset Type
| FLDASTASSETTYPE
|The Type field is mandatory: 
Hardware = H 
Software = S 
Other = T
|-
| Asset Name
| FLDASTNAME
|
|-
| Status
| FLDASTSTATUS
| Mandatory field. 
Active = A 
Not Active = N 
If not provided, default Active is used.
|-
| Record ID
| FLDASTRECID
| If provided, must exist in the database. Ignored if empty
|-
| Serial No.
| FLDASTSERIALNO
|
|-
|Account
|FLDASTACCRECID
|The Account which is linked to the Asset
|-
|Contact
|FLDASTCONTACTRECID
|The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Created by user
|FLDASTCREATEUSER
|Name of external software which created this Asset
|-
|Purchase Date
|FLDASTCUSTPURDATE
|Any date format, such as DD/MM/YYYY
|-
|Purchased From Us
|FLDASTCUSTPURFROMUS
|Possible values: Y/N. 
If not provided, default value Y is used.
|-
| Purchase Invoice #
| FLDASTCUSTPUROURINV
|
|-
| Customer PO
| FLDASTCUSTPURPO
|
|-
| Purchase Price
| FLDASTCUSTPURPRICE
|
|-
| Delivered Date
| FLDASTDELIVEDATE
|
|-
| Description
| FLDASTDESC
|
|-
| Installed By
| FLDASTINSTALBY
|
|-
| Installed Date
| FLDASTINSTALDATE
|
|-
| License Codes
| FLDASTLICENSECODE
|
|-
| License Keys
| FLDASTLICENSEKEY
|
|-
| License Notes
| FLDASTLICENSENOTES
|
|-
| Location
| FLDASTLOCATION
|
|-
| Manufacturer
| FLDASTMANUFACTURER
|
|-
| Mnf Serial No.
| FLDASTMNFSERIALNO
|
|-
| Model
| FLDASTMODEL
|
|-
| Notes
| FLDASTNOTES
|
|-
| Quantity
| FLDASTQUANTITY
| If not provided, default value of 1 is used.
|-
| Last Update By
| FLDASTUPDATEUSER
| Name of externals software which performed the update
|-
| Field1
| FLDASTUSER1
| User defined field
|-
| Field2
| FLDASTUSER2
| User defined field
|-
| Field3
| FLDASTUSER3
| User defined field
|-
| Field4
| FLDASTUSER4
| User defined field
|-
| Field5
| FLDASTUSER5
| User defined field
|-
| Date1
| FLDASTUSERDATE1
| User defined field
|-
| Number1
| FLDASTUSERNUMBER1
| User defined field
|-
| Vendor Purchased Date
| FLDASTVENDORDATEPURC
|
|-
| Vendor Invoice #
| FLDASTVENDORINVNO
|
|-
| Vendor PO
| FLDASTVENDOROURPO
|
|-
| Vendor Price
| FLDASTVENDORPRICE
|
|-
| Vendor
| FLDASTVENDORRECID
|
|-
| Vendor Serial No.
| FLDASTVENDORSERNO
|
|-
| Vendor Warranty Exp. Date
| FLDASTVENDORWARREXP
| Any date format, such as DD/MM/YYYY
|-
| Version
| FLDASTVERSION
|
|-
| Warranty/License Exp.
| FLDASTWARREXPDATE
| Any date format, such as DD/MM/YYYY
|-
| Date
|
|
|}

===Calendar Fields===
The table below lists the most important Calendar parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDEVTRECID
|The Appointment/Task record ID. If provided, the existing entity will be updated. Otherwise, this
will be added as a new Appointment/Task.
|-
| Event Type
| FLDEVTWRITETOID
|The Event type is a mandatory field. 
Appointment = 1 
Task = 2
|-
| Employee
| FLDEVTWORKERID
| The Task/Appointment owner (for private events)
|-
| Private: User
| FLDEVTPRIVATEID
| Possible values: Y/N 
If an Employee was set, this field must be Y
|-
| Account
| FLDEVTCARDID
| The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by rightclicking
the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a
new Account with the API
|-
| Contact
| FLDEVTCONTACTID
| The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Document
|FLDEVTDOCID
|Linked Document ID, can be taken from the Document Properties window (right-click RecID and use Copy), or using the ODBC to pull information from the database.
|-
|Done Indication
|FLDEVTDONE
|Possible values: Y/N
|-
|Date
|FLDEVTEVENTDATE
|The Appointment/Task date is a mandatory field of Any date format, such as DD/MM/YYYY. If not
provided, the current date will be used.
|-
|Description
|FLDEVTFREETEXT
|
|-
|Time: Start
|FLDEVTFROMTIME
|Mandatory field
|-
| Time: End
| FLDEVTTOTIME
| Relevant only for Appointments. If this parameter is not provided, 30 min. interval from Start Time is used.
|-
| Opportunity/Ticket
| FLDEVTLINKRECID
| Linked Ticket/Opportunity/Contract/Asset
|-
| Field1
| FLDEVTFAMILY
| User Defined field
|-
| Field2
| FLDEVTACTION
| User Defined field
|-
| Field3
| FLDEVTPLACE
| User Defined field
|-
| Field4
| FLDEVTPLACE1
| User Defined field
|-
| Field5
| FLDEVTPLACE2
| User Defined field
|-
| Created by User
| FLDEVTCREATEUSERID
| Name of external software which created the event
|-
| Last Update: By User
| FLDEVTUPDATEUSER
| Name of external software which updated the
event
|}

===Opportunity Fields===
The table below lists the most important Opportunity parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDOPPRECID
| The Opportunity record ID. If provided, the existing Opportunity will be updated. Otherwise, this will be added as a new Opportunity.
|-
| Opportunity Name
| FLDOPPNAME
| Mandatory field.
|-
| Opportunity ID
| FLDOPPUSERID
| Optional (Oppty ID)
|-
| Account
| FLDOPPCARDID
| The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by right-clicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new Account with the API
|-
| Contact
| FLDEVTCONTACTID
| The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
| Source
| FLDOPPSOURCE
|
|-
|Document
|FLDEVTDOCID
|Linked Document ID, can be taken from the Document Properties window (right-click RecID and use Copy), or using the ODBC to pull information from the database.
|-
|Done Indication
|FLDEVTDONE
|Possible values: Y/N
|-
|Close Date
|FLDOPPCLOSEDATE
|
|-
|Manager
|FLDOPPWORKERID
|The Manager's REC ID
|-
|Open Date
|FLDOPPOPENDATE
|
|-
| Close By Date
| FLDOPPESTDATE
| Opportunity must be closed by this date
|-
| Amount
| FLDOPPAMOUNT
|
|-
| Probability %
| FLDOPPPROBABILITY
|
|-
| Stage
| FLDOPPSTAGE
|
|-
| Status
| FLDOPPSTATUS
|
|-
| Closing Amount
| FLDOPPCLOSEAMOUNT
|
|-
| Description
| FLDOPPDESCRIPTION
|
|-
| Opportunity Type
| FLDOPPKIND
|
|-
| Opportunity Reason
| FLDOPPREASON
|
|-
| Note
| FLDOPPNOTES
|
|-
| Territory
| FLDOPPREGION
|
|-
| Field1
| FLDEVTFAMILY
| User Defined field
|-
| Field2
| FLDEVTACTION
| User Defined field
|-
| Field3
| FLDEVTPLACE
| User Defined field
|-
| Created by User
| FLDEVTCREATEUSERID
| Name of external software which created the event
|-
| Last Update: By User
| FLDEVTUPDATEUSER
| Name of external software which updated the event
|}

===Document Fields===
The table below lists the Document parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDDOCRECID
| The Document record ID. If provided, the existing Document will be updated. Otherwise, this will be added as a new Document.
|-
| Document Date
| FLDDOCDOCDATE
| The date for the Document. This is an optional parameter. If not provided, or if the value is illegal, the current date will be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
| Subject
| FLDOPPUSERID
|
|-
| Linked Record
| FLDDOCLINKRECID
| The RECID of a linked object. Each Document can be linked to one of the following objects:
*Ticket
*Contract
*Opportunity
*Knowledge Base Article
*Asset
The Record ID (20 chars) can be taken from:
#Object's Notes tab, at the bottom by right-clicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new object with the API.
|-
| Account Rec ID
| CARDID
| The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by right-clicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new Account with the API
|-
| Contact REC ID
| FLDDOCCONTACTID
| The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Field1
|FLDDOCTRANSPORT
|User Defined field
|-
|Field2
|FLDDOCFOLDER
|User Defined field
|-
|Field3
|FLDDOCUMENTPLACE
|User Defined field
|-
|File Path + File name
|FLDDOCDOCUMENTNAME
|The Document path
|-
|Category
|FLDDOCTREEID
|The category record ID should be taken from the database table called TreeTbl which contains the Category tree
|-
| Employee REC ID
| FLDDOCWORKERID
| The worker record ID to be linked to the Document. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
| Created by User
| FLDDOCCREATEUSER
| Name of external software which created the document
|-
| Last Update: By User
| FLDDOCUPDATEUSER
| Name of external software which updated the document
|}

===Knowledge Base Article Fields===
The table below lists the Knowledge Base Article parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDKBARECID
| The Article record ID. If provided, the existing Article will be updated. Otherwise, this will be added as a new Article.
|-
| Document Date
| FLDKBACREATEDATE
| The date for the Document. This is an optional parameter. If not provided, or if the value is illegal, the current date will be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
| Title
| FLDKBATITLE
|
|-
| Problem
| FLDKBAPROBLEM
|
|-
| Solution
| FLDKBASOLUTION
|
|-
| Status
| FLDKBASTATUS
| Possible values:
*DRAFT = 'D'
*PUBLISHED = 'P'
*OBSOLETE = 'O'
|-
|Category
|FLDKBACATEGORY
|
|-
|Public
|FLDKBAISPUBLIC
|Is the Document public. 
Possible values: 
*'Y' = Yes
*'N' = No
|-
|Created by User
|FLDDOCCREATEUSER
|Name of external software which created the document
|-
|Last Update: By User
|FLDDOCUPDATEUSER
|Name of external software which updated the document
|}

===Error Codes Description===
These error codes are returned when calling the CmtGetDescriptionByStatus function: 
'''1000''' CmtDbEng.dll not found. 
'''1001''' Invalid value for the Data Kind value. 
'''1002''' Invalid DATA buffer received. Make sure you have allocated the buffer correctly and
that you have passed the correct buffer length. 
'''1003''' Invalid MAP buffer received. Make sure you have allocated the buffer correctly and
that you have passed the correct buffer length. 
'''1004''' Invalid REC ID buffer received. Make sure you have allocated the buffer correctly
and that you have passed the correct buffer length. 
'''1005''' Invalid LOG buffer received. Make sure you've allocated the buffer correctly and
that you've passed the correct buffer length. 
'''1006''' Invalid REC ID buffer received. It should be at least 20 characters. 
'''1007''' Invalid external software name received. Specify a unique name that identifies your
software. 
'''1008''' Cannot process the transaction. Make sure to call the INIT procedure at least once
prior to sending transactions for processing. 
'''1009''' Path specified for Commit DB folder not found. 
'''1010''' Path specified for Commit DB folder found, but its contents do not reflect a valid DB
folder. 
'''1011''' The RED ID received for the employee/user was not found in Commit, is invalid or is
related to an inactive employee record. 
'''1012''' Error registering software. 
'''1013''' Software name is missing. Make sure you specify a name that identifies your
software. 
'''1014''' Software name is less than 3 characters long. Make sure you enter a software name
that has 3 to 15 characters. 
'''1015''' Software name is too long. Make sure your software name has 3 to 15 characters. 
'''1100''' Database access error. 

General error codes, returned when calling the functions CmtGetDescriptionByCode: 
'''50000''' The data is not correct for its type. 
'''50001''' The field value has been truncated due to the field length in the database. 
'''50002''' The insert operation Failed because the REC ID already existed in the database. 
'''50003''' Failed to update Record since it is being updated by another user. 
'''50103''' Illegal REC ID. 
'''50104''' REC ID Creation failed. 
'''50105''' Illegal Sub-Contact REC ID. 
'''50106''' Illegal Contract REC ID. 
'''50107''' Illegal Employee REC ID. 
'''50108''' Illegal Ticket REC ID. 
'''50109''' Illegal Account REC ID. 
'''50110''' Illegal data for that Contract. 
'''50111''' This Employee is not active. 
'''50112''' Illegal Document REC ID. 
'''50113''' Illegal linked object REC ID. 
'''50114''' Employee not found. 
'''50115''' Some mandatory fields have no values. 
'''51000''' Illegal kind of Account entity. 
'''51001''' Account Manager not found. 
'''51002''' The REC ID of the Account Manager is illegal. 
'''51003''' Illegal tax code. 
'''51004''' This code does not exist in Commit. 
'''52000''' Illegal kind of event. 
'''52001''' Illegal start time. 
'''52002''' Illegal end time. 
'''52003''' Illegal event date. 
'''52004''' The field Reminder1 has Illegal Value. 
'''52005''' The amount in the field has an illegal value. 
'''52006''' The Field Remider1:Units has Illegal Value. 
'''52007''' The Field Remider2:Active has Illegal Value. 
'''52008''' The Field Remider2:Amount has Illegal Value. 
'''52009''' The Field Remider2:Units has Illegal Value. 
'''52010''' Illegal employee REC ID. 
'''52011''' Error occurred while updating the Task/Appointment employee field. 
'''54000''' Illegal Ticket open date. 
'''54001''' Illegal Ticket close date. 
'''54002''' Illegal Ticket code area. 
'''54004''' Illegal Ticket priority. 
'''54005''' Illegal Ticket status. 
'''54006''' The Ticket Account was not found in the database. 
'''54007''' The Ticket Account Manager was not ound in the database. 
'''54008''' This code does not exist in Commit. 
'''54009''' This code does not exist in Commit. 
'''54010''' This code does not exist in Commit. 
'''54011''' This code does not exist in Commit. 
'''54012''' This code does not exist in Commit. 
'''55000''' Illegal charge date. 
'''55001''' Illegal charge REC ID. 
'''55002''' Illegal start date. 
'''55003''' Illegal start time. 
'''55004''' Illegal amount entered for hours. 
'''55005''' Illegal quantity. 
'''55006''' Illegal price. 
'''55007''' Illegal total. 
'''55008''' Illegal value in the Adjust Amount field. 
'''55009''' Illegal value in the Adjust Percent. 
'''55010''' The Discount/Markup field has an illegal value. 
'''55011''' Illegal value in the Adjust Kind field. 
'''55012''' Illegal bill total. 
'''55013''' You can not create a charge for a suspended item. 
'''55014''' Item was not found in Commit. 
'''55015''' This code does not exist in Commit. 
'''55016''' This code does not exists in Commit. 
'''55017''' This Code does not exist in Commit. 
'''55018''' This Code does not exist in Commit. 
'''55019''' This Code does not exist in Commit. 
'''55020''' This Code does not exist in Commit. 
'''55021''' This Code does not exist in Commit. 
'''56000''' Illegal item code. 
'''56001''' The field that indicates the item group type has an illegal value. 
'''56002''' The field that indicates if the Item is suspended has an illegal value. 
'''56003''' Illegal value of The field that indicate if the item is suspended. 
'''56004''' Mismatch found between the fields price and price source. 
'''56005''' Illegal cost. 
'''56006''' Mismatch found between the fields cost and item group type. 
'''56007''' The field that indicates if the charge is by unit or by hours has an illegal value. 
'''56008''' Illegal value in the Description. 
'''56009''' The field that indicates the item type has an illegal value. 
'''57000''' This Code does not exist in Commit. 
'''58000''' Illegal date time. 
'''58001''' The Description field was not found. 
'''58002''' The field kind was not found. 
'''58003''' The Account member was not found. 
'''59000''' This code does not exists in Commit. 
'''59001''' This Code does not exist in Commit. 
'''59002''' This Code does not exist in Commit. 
'''59003''' This Code does not exist in Commit. 
'''59004''' This Code does not exist in Commit. 
'''59005''' This Code does not exist in Commit. 
'''60000''' Invalid web user record ID number. 
'''60001''' This customer web user is not active. 
'''60002''' This user is not a customer. 

==See Also==
*[[Commit API Developers Guide]]
*[[API Code Samples]]
[[Category:User Manuals]]
[[Category:Integration]]

__NOTOC__

API Code Samples

2009-08-20T10:31:51Z

Yarden: /* Introduction */

{{usermanualsapidevelopersguide}}
==Introduction==
The Commit API allows you to add/update the following entities:
*Accounts
*Assets
*Tickets
*Charges
*Appointments
*Tasks
*History Notes
*Opportunities
*Documents
*Knowledge Base Articles

Each API method requires a list of parameters which contain the field names and their values. The field names are the Database field names. You can see each field's name within the application (so you can verify which field you are about to update), by right-clicking the field and selecting Field Settings > Advanced Tab > view the Tech. Rec ID field.

You can view the complete list of database fields in the [[Commit API Reference Manual#API Reference Manual|API Reference Manual]] above.

Following are samples for using the API by Email and the Programming API. The samples are basic and provide an easy starting point.

__TOC__

===Code samples===
The following code samples demonstrate how to add and update a record in CommitCRM from VBA, C++ or Delphi programs.

Make sure to read [[Commit API Reference Manual#Using Commit API|Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

To test samples, it is recommended that you download a trial version of CommitCRM from our web site and install it on a new computer that is not running CommitCRM. Then, modify the paths in the source code to point to folder <testcomputer>\Commit\LastVer (and to the same files it already points to).

When developing your programs please make sure you work under the <testcomputer>\Commit\ThirdParty\UserDev folder (or at least call the dlls in this location). Do not copy the dll’s to any other location.

These samples create a connection to CommitCRM's database, add a new Account record into
the database, and update it. Each transaction should specify the database table to be updated by the transaction:
{| class="wikitable"
|-
! '''Application entity'''
! '''Table name'''
! '''Code'''
|-
| Accounts
| Cards
| 10
|-
| Opportunities
| Opps
| 20
|-
| Documents
| Docs
| 30
|-
| Charges
| Docs
| 30
|-
| Charges
| Slips
| 40
|-
| Appointments/Tasks
| Events
| 50
|-
| History Notes
| Notebook
| 60
|-
| Tickets
| Tickets
| 70
|-
| Items
| Items
| 80
|-
| Assets
| Assets
| 90
|-
| Knowledge Base
| KBArticles
| 100
|}

====API functions====
The Programming API provides the following API functions:
{| class="wikitable"
|-
! '''Method'''
! '''Return Value'''
! '''Description'''
|-
| '''CmtInitDbEngDll (app_name, path, status)'''
| status (int)
| Establishes a connection to the database. app_name - This string will be used for all functions of the package, and will appear in the application as the user who performs the changes in the records you update. You should specify a meaningful value. path - The path to the DB folder where the Commit server is installed: <server>\Commit\Db status - 1 for success. See Error Codes Description for other values.
|-
| '''CmtInsUpdRec(data_buff, map_buff, flag, tbd, 
rec_id_buff_size, error_codes_buff_size, 
err_msg_buff_size,rec_id_buff, 
err_codes_buff, err_msg_buff, status)'''
| status (int), rec_id (char)
| Adds/Updates records. 
data_buff - string containing the values to insert into the Database 
map_buff - mapping of the database fields corresponding with the data buff 
flag - stop(0)/continue(1) the input process is an invalid data value(s) 
tbd - Not used 
rec_id_buff_size - length of REC ID Buffer 
err_code_buff_size - length of Error Code Buffer 
err_msg_buff_size - length of Error Message Buffer 
rec_id_buff - buffer for returned REC ID 
err_codes_buff - buffer for returned Error Codes 
err_msg_buff - buffer for returned Error Messages 
status - returned status, 1 for success. 
See [[Commit API Reference Manual#Error Codes Description|Error Codes Description]] for other values.
|-
| '''CmtTerminateDbEngDll'''
|
| Close the connection to the database
|-
| '''CmtGetDescriptionByCode''' (code, desc_size, desc)
| message (char)
| Call this function in case of error in 
'''CmtInsUpdRec'''. 
In case of error (return code other than 1), 
you can use this to get error string.
|-
| '''CmtGetDescriptionByStatus'''
|
| Call this function in case of error in 
'''CmtInitDbEngDll'''
|}

'''Field buffers'''
The record to be added/updated in the database is passed to the Commit API in two buffers:
{| class="wikitable"
|-
! '''Parameter'''
! '''Description'''
! '''Example'''
|-
| data_buff
| String containing the values to insert into the Database. Separators between the fields are defined in the map_buff
| "17/04/2008 14:44", "CRD7C9KZPS9JN3LEZVD9", "Charge", "CRDGO0SVQ6074CMAN7DW","Closed","test note in DB Engine", "NTBL6PDPKUU6NXLRHLHP","CRDBSMJ3P72EHMU0HB LX","TKT4S81466E05IM8P23X"
|-
| map_buff
| Mapping of the data_buff: separators, field names.

Field names must be in the same order as the data_buff values.

The field names should be separated with a different separator than the values (e.g. "new line").
| " , FLDHISNOTEDATETIME 
FLDHISWORKERID 
FLDHISKIND 
FLDHISCONTACTID 
FLDHISUSER1 
FLDHISDESCRIPTION 
FLDHISRECID 
FLDHISCARDID 
FLDHISLINKRECID 
|}

====VB Sample====
To test the following VB code, create a VB program that includes this code and executes
it, or open the Visual Basic editor included with MS-Word, paste the code into it and run it.

In order for the VB sample to compile properly, please follow these steps:
#Go to My Computer > Right Click – Properties > Advanced Tab > Environment Variable
#At the bottom of the list, search for the Path variable (not PathText)
#Double click the Path variable > go to the end of the value/line
#Add ;
#Add the path to the folder: <server>\Commit\ThirdParty\UserDev\ and confirm.

For all field description see the [[API Reference Manual]].

Private Declare Sub CmtInitDbEngDll Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDbPath As String, ByRef xvStatus As Integer)

Private Declare Sub InitCommonControls Lib "comctl32.dll" ()

Private Declare Sub CmtInsUpdRec Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDataKind As Integer, _
ByVal xDataBuff As String, _
ByVal xMapBuff As String, _
ByVal xContWhenInvalidData As Integer, _
ByVal xFlags As Integer, _
ByVal xRecIDBuffLen As Integer, _
ByVal xLogErrCodesBuffLen As Integer, _
ByVal xLogErrMsgBuffLen As Integer, _
ByVal xvRecIDBuff As String, _
ByVal xvErrCodesLogBuff As String, _
ByVal xvErrMsgLogBuff As String, _
ByRef xvStatus As Integer)

Private Const C_DataBuffSize As Integer = 1024
Private Const C_MapBufSize As Integer = 1024
Private Const C_ErrMsgBuffSize As Integer = 1024
Private Const C_ErrCodeBuffSize As Integer = 64
Private Const C_RecIDBuffSize As Integer = 20
Private Const C_Flag As Integer = 1
Private Const C_Ok As Integer = 1
Private Const C_AccountsTable As Integer = 10

Private Const C_AppName As String = "Demo"

Public Sub DBEng()

Dim nStatus As Integer
Dim l As Long
Dim S As String
Dim pStr As Long
Dim MapBuff As String
Dim DataBuff As String
Dim RecIdBuff As String * C_RecIDBuffSize
Dim ErrCodesLogBuff As String * C_ErrCodeBuffSize
Dim ErrMsgLogBuff As String * C_ErrMsgBuffSize

Call CmtInitDbEngDll(C_AppName, "C:\DemoVBA\DB\", nStatus)

If nStatus = C_Ok Then

Rem ******************** Establishing connection with Commit, Should be
called only once for the entire session ******
MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDFULLNAME" + Chr(13) + "FLDCRDDEAR" +
Chr(13) + "FLDCRDCONTACT"
DataBuff = "'Bart De Hantsetters','De Hantsetters','Hantsetters'"

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)

If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

If nStatus = C_Ok Then
Rem ******************** Updating the Account record we've just created *******************

MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDDEAR" + Chr(13) + "FLDCRDRECID"
DataBuff = "'Doctor','" + RecIdBuff + "'"
ErrCodesBuff = ""
ErrMsgBuff = ""

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)
If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

Else
MsgBox ("Insert new Account. Error code: " + ErrCodesLogBuff)

End If
Else
MsgBox ("Commit Init failed. Error code: " + ErrCodesLogBuff)
End If

End Sub

====C++ Sample====
For all field description see the [[API Reference Manual]].

// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
const int C_DescSize = 1024;
char desc[C_DescSize];
char Delimiter[] = "\n";
int Code;
char* pch;
pch = strtok (ErrCodeBuff,Delimiter);
while (pch != NULL)
{
Code = atoi(pch);
CmtGetDescriptionByCode(Code, C_DescSize, desc);
printf ("%s\n",desc);
pch = strtok (NULL, Delimiter);
}
return 0;
}
int main(int argc, char* argv[])
{
const int C_DataBuffSize = 1024;
const int C_MapBufSize = 1024;
const int C_ErrMsgBuffSize = 1024;
const int C_ErrCodeBuffSize = 64;
const int C_RecIDBuffSize = 64;
const int C_Flag = 1;
const int C_Ok = 1;
const int C_AccountsTable = 10;
const int C_ExampleCode = 54000;
int Status;
char DataBuff[C_DataBuffSize] = "";
char MapBuff[C_MapBufSize] = "";
char RecIdBuff[C_RecIDBuffSize];
char ErrCodesBuff[C_ErrCodeBuffSize];
char ErrMsgBuff[C_ErrMsgBuffSize];
char* C_AppName = "Demo";

//* Establishing connection with CommitCRM, Should be called only once for the entire session **

CmtInitDbEngDll(C_AppName, // Your application name. This will be used for all functions of the
// package.
// Specify a meaningful value.
"C:\\Demo\\DB\\", //Path to the database folder where CommitCRM the server is
// installed <server>\Commit\Db
&Status); //Returned connection status

if (Status == C_Ok) {

//***Insert New Account into that Accounts table *******************
strcpy (DataBuff,"'Bart De Hantsetters','De Hantsetters','Hantsetters'");
strcat (MapBuff, "'\n,\nFLDCRDFULLNAME\nFLDCRDDEAR\nFLDCRDCONTACT");
strcat (RecIdBuff, "");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, //String for your selection.
C_AccountsTable, //Desired Table Code
DataBuff, //This string contains the values which we want to add to the database
MapBuff, //List of database fields where we want to add data
C_Flag,//Flag - stop(0) continue(1) the input process is data
//value(s) is invalid
0, //Not used
C_RecIDBuffSize, //Length of REC ID Buffer
C_ErrCodeBuffSize, //Length of Error Code Buffer
C_ErrMsgBuffSize, //Length of Error Message Buffer
RecIdBuff, //Buffer for returned REC ID
ErrCodesBuff, //Buffer for returned Error Codes
ErrMsgBuff, //Bufer for returned Error Messages
&Status //Returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if (Status == C_Ok) {

//***** Updating the Account record we've just created *************
strcpy (MapBuff, "'\n,\nFLDCRDDEAR\nFLDCRDRECID"); // Map file for the update
// transaction - the Dear field and the record id
strcpy (DataBuff,"'Doctor','");
strcat (DataBuff, RecIdBuff);
strcat (DataBuff, "'");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, // string for your selection.
C_AccountsTable, // Desired Table Code
DataBuff, // string contains the values, which we want to add into the Database
MapBuff, // list of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // length of RecID Buffer
C_ErrCodeBuffSize, // length of Error Code Buffer
C_ErrMsgBuffSize, // length of Error Message Buffer
RecIdBuff, // buffer for returned RecID
ErrCodesBuff, // buffer for returned Error Codes
ErrMsgBuff, // bufer for returned Error Messages
&Status // returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);
}
else
{
printf("Insert new Account. Error code: %d\n", Status);
};

//****Terminate connection with CommitCRM*******************
CmtTerminateDbEngDll();
}
else
{
printf("Commit Init failed. Error code: %d\n", Status);
};

return 0;
}

====Delphi Sample====
For all field description see the [[API Reference Manual]].

program Demo;

{$APPTYPE CONSOLE}

uses
SysUtils, Classes;
const
C_DataBuffSize = 1024;
C_MapBufSize = 1024;
C_ErrMsgBuffSize = 1024;
C_DescSize = 1024;
C_ErrCodeBuffSize = 64;
C_RecIDBuffSize = 64;

C_Flag = 1;
C_Ok = 1;
C_AccountsTable = 10;
C_AppName = 'Demo';

CmtDbEngDll = 'CmtDbEng.DLL';

var
Status: integer;
DataBuff: array [0..C_DataBuffSize] of Char;
MapBuff: array [0..C_MapBufSize] of Char;
RecIdBuff: array [0..C_RecIDBuffSize] of Char;
ErrCodesBuff: array [0..C_ErrCodeBuffSize] of Char;
ErrMsgBuff: array [0..C_ErrMsgBuffSize] of Char;
s: string;

//** Establishing connection with CommitCRM, Should be called only once for the entire session *
Procedure CmtInitDbEngDll (
xSoftWareName : PChar; // Your application name. Once selected this string
// will be used for all
// functions of the package. Specify a meaningful value.
xDbPath : PChar; // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db

var xvStatus : integer // Returned connection status
); stdcall; external CmtDbEngDll;

//**** Insert/Update record
Procedure CmtInsUpdRec(
xSoftWareName : pChar; // See above
xDataKind : integer; // Desired Table Code
xDataBuff : pChar; // String containing the values, which we want
// to add into the Database
xMapBuff : pChar; // List of the database fields into
//which we want to add data
xContWhenInvalidData : Integer; //Flag - stop(0)/continue(1) the input process
// is some data value(s) is invalid
xFlags : Integer; // Not used
xRecIDBuffLen : Integer; // Length of REC ID Buffer
xLogErrCodesBuffLen : Integer; // Length of Error Code Buffer
xLogErrMsgBuffLen : Integer; // Length of Error Message Buffer
xvRecIDBuff : pChar; // Buffer for returned REC ID
xvErrCodesLogBuff : pChar; // Buffer for returned Error Codes
xvErrMsgLogBuff : pChar; // Buffer for returned Error Messages
var xvStatus : Integer // Returned status
); stdcall; external CmtDbEngDll;

//**** Terminate connection with CommitCRM ****
procedure CmtTerminateDbEngDll; stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByCode(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByStatus(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure ErrCodesParsing (ErrCodeBuff: string);
var
lList: TStringList;
i: integer;
aDescErrCode : Pchar;
begin
try
lList := TStringList.Create;
lList.Text := ErrCodeBuff;
GetMem(aDescErrCode,C_DescSize);
for i := 0 to lList.Count - 1 do
begin
CmtGetDescriptionByCode(StrToInt(lList[i]), C_DescSize, aDescErrCode);
writeln('Error Code: '+lList[i]+' Desc: '+string(aDescErrCode));
end;
finally
FreeMem(aDescErrCode);
lList.Destroy;
end;
end;

procedure DisplayErrStatusCode(xCode : Integer);
var
aStatusErrCode : Pchar;
begin
try
GetMem(aStatusErrCode,C_DescSize);
CmtGetDescriptionByStatus(xCode,C_DescSize, aStatusErrCode);
writeln('Commit Init failed. Error code: '+Inttostr(xCode)+' Desc: '+string(aStatusErrCode));
finally
FreeMem(aStatusErrCode);
end;
end;

begin

//**** Establishing connection with CommitCRM, Should be called only once for the entire session
CmtInitDbEngDll(C_AppName, // Your application name. Once selected this string will be used
// for all functions of the package. Specify a meaningful value.
'C:\DemoDelphi\db\', // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db
Status // Returned connection status
);

if Status = C_Ok then
begin

//**** Insert a new Account into the Accounts table ****

s := '"Bart De Hantsetters","De Hantsetters","Hantsetters"';
StrPCopy(DataBuff, s);
s := '"'+#13','+#13+'FLDCRDFULLNAME'+#13+'FLDCRDDEAR'+#13+'FLDCRDCONTACT'+#0;
StrPCopy(MapBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want to add into
// the Database
MapBuff, // List of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Llength of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned REC ID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if (ErrMsgBuff[0] <> #0) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
begin
//**** Updating the Account record we've just created *****

// Map file for the update transaction - the Dear field and the record id
s := '"'+#13+','+#13+'FLDCRDDEAR'+#13'FLDCRDRECID';
StrPCopy(MapBuff, s);

s := '"Doctor","'+RecIdBuff+'"';
StrPCopy(DataBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want
// to add into the Database
MapBuff, // List of the database fields into which we want to add
//data
C_Flag, // Flag - stop(0)/continue(1) the input process is some
// data value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Length of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned RECID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if ((ErrMsgBuff[0] <> #0)) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
Writeln('Completed Successfully');
end
else
begin
try
s := IntToStr(Status);
except
s := 'ill-defined';
end;
writeln('Insert new Account. Error code: '+ s);
end;

//**** Terminate connection with CommitCRM****

CmtTerminateDbEngDll();
end
else
begin
DisplayErrStatusCode(Status);
end;

writeln(#13#10+'press Enter to quit');
readln;
end.

===XML samples===

Following are samples for adding a new Ticket and a new Charge to the Commit database using XML formatted messages.

Make sure to go over the [[Email Connector]] setup guide, and perform the XML API setup steps prior to testing the XML API.

Also please read [[Commit API Reference Manual|Using Commit API#Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

Notes on API by Email Activation:

*Error Handling - Should the system fail to perform the XML transaction, an error message will be sent to the email address specified in the XML.

*Using a Password - If you wish to use a verification password for the XML transactions, define the password using the ServerConfig.exe utility. To do so, go to the XML tab, enable the API by Email option and set a password (as specified in the XML - see [[Commit API Reference Manual#General XML Tokens|General XML Tokens]]). Make sure to set the same Password in ServerConfig and in the XML email itself.

You can read more about the ServerConfig and how to setup the API by Email configuration in the [[Email Connector|Commit Email Connector]] Setup guide.

====General XML Tokens====
The sample and table demonstrates general parameters which should be used for any XML transaction.

For all field description see the [[API Reference Manual]].

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
... the transaction goes here ...
</RecordData>
</CommitCRMTransaction>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMTransaction>
| Start and end transactions with this token (may have more than one in a single email)
|-
| <ExternalApplicationName>
| The sender application name, can contain any text
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <Password>
| Optional Password - Only emails with a password that matches the password set in the Email Connector Settings will be processed (to prevent SPAM email from being processed and added to your CommitCRM database).
|-
| <DataKind>
| What is the Entity you wish to create/update. 
Possible values: 
ACCOUNT - for Accounts 
TICKET - for Tickets 
CHARGE - for Charges 
ITEM - for Items 
APPOINTMENT-OR-TASK - for Appointments/Task 
HISTORY-NOTE - For History notes 
ASSET - for Assets 
OPPORTUNITY - for Sales Opportunities 
DOCUMENT - for Documents 
KBARTICLE - for Knowledge Base articles 
|}

====Adding new Ticket====

In this sample, we add a new Ticket, and set some additional fields to it, such as Notes, Source, Due Date and Dispatcher flag.

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
<FLDTKTCARDID> CUSTOMER-RECORD-ID-GOES-HERE-20-CHARS </FLDTKTCARDID>
<FLDTKTPROBLEM>ticket description...</FLDTKTPROBLEM>
<FLDTKTSTATUS>100</FLDTKTSTATUS>
<FLDTKTKIND>General</FLDTKTKIND>
<FLDTKTNOTES>Notes</FLDTKTNOTES>
<FLDTKTSOURCE>Source</FLDTKTSOURCE>
<FLDTKTSCHEDLENESTIM>60</FLDTKTSCHEDLENESTIM>
<FLDTKTDUEDATETIME>02/04/08</FLDTKTDUEDATETIME>
<FLDTKTFORDISPATCH>Y</FLDTKTFORDISPATCH>
</RecordData>
</CommitCRMTransaction>

====Adding new Charges====

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>Alert</ExternalApplicationName>
<SendResponseToEmail>your email address for responses</SendResponseToEmail>
<Password>12345</Password> >> Should be the same in the ServerConfig!
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>CHARGE</DataKind>
<RecordData>
<FLDSLPWORKERID> CRDLS71RGU747TLHTFOR </FLDSLPWORKERID>
<FLDSLPCARDID> CRDLQXDL43BP5YCMSGM3</FLDSLPCARDID>
<FLDSLPITEMID> ITM1Q3GUI05ANBQGVY8D </FLDSLPITEMID>
<FLDSLPDESC> Charge Description... </FLDSLPDESC>
<FLDSLPQUANTITY> 10 </FLDSLPQUANTITY>
<FLDSLPSLIPDATE> 31/01/2008 </FLDSLPSLIPDATE>
<FLDSLPSTARTTIME> 12:06 </FLDSLPSTARTTIME>
<FLDSLPENDTIME> 14:50 </FLDSLPENDTIME>
<FLDSLPBCRECID> BCTMA51KBA925J7G0V67 </FLDSLPBCRECID>
<FLDSLPPRICE> 125.3 </FLDSLPPRICE>
<FLDSLPADJUSTAMOUNT> 10 </FLDSLPADJUSTAMOUNT>
<FLDSLPUSER1> Field 1... </FLDSLPUSER1>
</RecordData>
</CommitCRMTransaction>

====Receiving Response====
When adding or updating data via the XML API, the system can send a response (if the
XML transaction specifies this in the SendResponseToEmail token). The format of the XML
response is as follow:

Response in case of success:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>SUCCESS</Status>
<AffectedRecId>TKTN1NIQEYYQ8PBJMDAX</AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
</CommitCRMResponse>

Response in case of error:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>FAILURE</Status>
<AffectedRecId></AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
<ResultCodes>50109</ResultCodes>
<ResultMessage>
Fields with illegal values: Operation canceled. Field: Account has invalid data -
TKTN1NIQEYYQ8PBJMDAX
</ResultMessage>
</CommitCRMResponse>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMResponse>
| The response starts and ends with this token
|-
| <Status>
| The transaction status. Possible values: FAILURE, SUCCESS
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <AffectedRecId>
| The REC ID of the entity which was added or updated when processing the transaction.
|-
|<ResultCodes> <ResultMessage>
|In case of a failure, this will contain the error code and description. You can find more information about error codes [[Commit API Reference Manual#Error Codes Description|here]].
|}

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

API Code Samples

2009-08-20T10:31:14Z

Yarden:

{{usermanualsapidevelopersguide}}
==Introduction==
The Commit API allows you to add/update the following entities:
*Accounts
*Assets
*Tickets
*Charges
*Appointments
*Tasks
*History Notes
*Opportunities
*Documents
*Knowledge Base Articles

Each API method requires a list of parameters which contain the field names and their values. The field names are the Database field names. You can see each field's name within the application (so you can verify which field you are about to update), by right-clicking the field and selecting Field Settings > Advanced Tab > view the Tech. Rec ID field.

You can view the complete list of database fields in the [[Commit API Reference Manual#API Reference Manual|API Reference Manual]] above.

Following are samples for using the API by Email and the Programming API. The samples are basic and provide an easy starting point.

===Code samples===
The following code samples demonstrate how to add and update a record in CommitCRM from VBA, C++ or Delphi programs.

Make sure to read [[Commit API Reference Manual#Using Commit API|Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

To test samples, it is recommended that you download a trial version of CommitCRM from our web site and install it on a new computer that is not running CommitCRM. Then, modify the paths in the source code to point to folder <testcomputer>\Commit\LastVer (and to the same files it already points to).

When developing your programs please make sure you work under the <testcomputer>\Commit\ThirdParty\UserDev folder (or at least call the dlls in this location). Do not copy the dll’s to any other location.

These samples create a connection to CommitCRM's database, add a new Account record into
the database, and update it. Each transaction should specify the database table to be updated by the transaction:
{| class="wikitable"
|-
! '''Application entity'''
! '''Table name'''
! '''Code'''
|-
| Accounts
| Cards
| 10
|-
| Opportunities
| Opps
| 20
|-
| Documents
| Docs
| 30
|-
| Charges
| Docs
| 30
|-
| Charges
| Slips
| 40
|-
| Appointments/Tasks
| Events
| 50
|-
| History Notes
| Notebook
| 60
|-
| Tickets
| Tickets
| 70
|-
| Items
| Items
| 80
|-
| Assets
| Assets
| 90
|-
| Knowledge Base
| KBArticles
| 100
|}

__TOC__

====API functions====
The Programming API provides the following API functions:
{| class="wikitable"
|-
! '''Method'''
! '''Return Value'''
! '''Description'''
|-
| '''CmtInitDbEngDll (app_name, path, status)'''
| status (int)
| Establishes a connection to the database. app_name - This string will be used for all functions of the package, and will appear in the application as the user who performs the changes in the records you update. You should specify a meaningful value. path - The path to the DB folder where the Commit server is installed: <server>\Commit\Db status - 1 for success. See Error Codes Description for other values.
|-
| '''CmtInsUpdRec(data_buff, map_buff, flag, tbd, 
rec_id_buff_size, error_codes_buff_size, 
err_msg_buff_size,rec_id_buff, 
err_codes_buff, err_msg_buff, status)'''
| status (int), rec_id (char)
| Adds/Updates records. 
data_buff - string containing the values to insert into the Database 
map_buff - mapping of the database fields corresponding with the data buff 
flag - stop(0)/continue(1) the input process is an invalid data value(s) 
tbd - Not used 
rec_id_buff_size - length of REC ID Buffer 
err_code_buff_size - length of Error Code Buffer 
err_msg_buff_size - length of Error Message Buffer 
rec_id_buff - buffer for returned REC ID 
err_codes_buff - buffer for returned Error Codes 
err_msg_buff - buffer for returned Error Messages 
status - returned status, 1 for success. 
See [[Commit API Reference Manual#Error Codes Description|Error Codes Description]] for other values.
|-
| '''CmtTerminateDbEngDll'''
|
| Close the connection to the database
|-
| '''CmtGetDescriptionByCode''' (code, desc_size, desc)
| message (char)
| Call this function in case of error in 
'''CmtInsUpdRec'''. 
In case of error (return code other than 1), 
you can use this to get error string.
|-
| '''CmtGetDescriptionByStatus'''
|
| Call this function in case of error in 
'''CmtInitDbEngDll'''
|}

'''Field buffers'''
The record to be added/updated in the database is passed to the Commit API in two buffers:
{| class="wikitable"
|-
! '''Parameter'''
! '''Description'''
! '''Example'''
|-
| data_buff
| String containing the values to insert into the Database. Separators between the fields are defined in the map_buff
| "17/04/2008 14:44", "CRD7C9KZPS9JN3LEZVD9", "Charge", "CRDGO0SVQ6074CMAN7DW","Closed","test note in DB Engine", "NTBL6PDPKUU6NXLRHLHP","CRDBSMJ3P72EHMU0HB LX","TKT4S81466E05IM8P23X"
|-
| map_buff
| Mapping of the data_buff: separators, field names.

Field names must be in the same order as the data_buff values.

The field names should be separated with a different separator than the values (e.g. "new line").
| " , FLDHISNOTEDATETIME 
FLDHISWORKERID 
FLDHISKIND 
FLDHISCONTACTID 
FLDHISUSER1 
FLDHISDESCRIPTION 
FLDHISRECID 
FLDHISCARDID 
FLDHISLINKRECID 
|}

====VB Sample====
To test the following VB code, create a VB program that includes this code and executes
it, or open the Visual Basic editor included with MS-Word, paste the code into it and run it.

In order for the VB sample to compile properly, please follow these steps:
#Go to My Computer > Right Click – Properties > Advanced Tab > Environment Variable
#At the bottom of the list, search for the Path variable (not PathText)
#Double click the Path variable > go to the end of the value/line
#Add ;
#Add the path to the folder: <server>\Commit\ThirdParty\UserDev\ and confirm.

For all field description see the [[API Reference Manual]].

Private Declare Sub CmtInitDbEngDll Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDbPath As String, ByRef xvStatus As Integer)

Private Declare Sub InitCommonControls Lib "comctl32.dll" ()

Private Declare Sub CmtInsUpdRec Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDataKind As Integer, _
ByVal xDataBuff As String, _
ByVal xMapBuff As String, _
ByVal xContWhenInvalidData As Integer, _
ByVal xFlags As Integer, _
ByVal xRecIDBuffLen As Integer, _
ByVal xLogErrCodesBuffLen As Integer, _
ByVal xLogErrMsgBuffLen As Integer, _
ByVal xvRecIDBuff As String, _
ByVal xvErrCodesLogBuff As String, _
ByVal xvErrMsgLogBuff As String, _
ByRef xvStatus As Integer)

Private Const C_DataBuffSize As Integer = 1024
Private Const C_MapBufSize As Integer = 1024
Private Const C_ErrMsgBuffSize As Integer = 1024
Private Const C_ErrCodeBuffSize As Integer = 64
Private Const C_RecIDBuffSize As Integer = 20
Private Const C_Flag As Integer = 1
Private Const C_Ok As Integer = 1
Private Const C_AccountsTable As Integer = 10

Private Const C_AppName As String = "Demo"

Public Sub DBEng()

Dim nStatus As Integer
Dim l As Long
Dim S As String
Dim pStr As Long
Dim MapBuff As String
Dim DataBuff As String
Dim RecIdBuff As String * C_RecIDBuffSize
Dim ErrCodesLogBuff As String * C_ErrCodeBuffSize
Dim ErrMsgLogBuff As String * C_ErrMsgBuffSize

Call CmtInitDbEngDll(C_AppName, "C:\DemoVBA\DB\", nStatus)

If nStatus = C_Ok Then

Rem ******************** Establishing connection with Commit, Should be
called only once for the entire session ******
MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDFULLNAME" + Chr(13) + "FLDCRDDEAR" +
Chr(13) + "FLDCRDCONTACT"
DataBuff = "'Bart De Hantsetters','De Hantsetters','Hantsetters'"

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)

If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

If nStatus = C_Ok Then
Rem ******************** Updating the Account record we've just created *******************

MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDDEAR" + Chr(13) + "FLDCRDRECID"
DataBuff = "'Doctor','" + RecIdBuff + "'"
ErrCodesBuff = ""
ErrMsgBuff = ""

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)
If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

Else
MsgBox ("Insert new Account. Error code: " + ErrCodesLogBuff)

End If
Else
MsgBox ("Commit Init failed. Error code: " + ErrCodesLogBuff)
End If

End Sub

====C++ Sample====
For all field description see the [[API Reference Manual]].

// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
const int C_DescSize = 1024;
char desc[C_DescSize];
char Delimiter[] = "\n";
int Code;
char* pch;
pch = strtok (ErrCodeBuff,Delimiter);
while (pch != NULL)
{
Code = atoi(pch);
CmtGetDescriptionByCode(Code, C_DescSize, desc);
printf ("%s\n",desc);
pch = strtok (NULL, Delimiter);
}
return 0;
}
int main(int argc, char* argv[])
{
const int C_DataBuffSize = 1024;
const int C_MapBufSize = 1024;
const int C_ErrMsgBuffSize = 1024;
const int C_ErrCodeBuffSize = 64;
const int C_RecIDBuffSize = 64;
const int C_Flag = 1;
const int C_Ok = 1;
const int C_AccountsTable = 10;
const int C_ExampleCode = 54000;
int Status;
char DataBuff[C_DataBuffSize] = "";
char MapBuff[C_MapBufSize] = "";
char RecIdBuff[C_RecIDBuffSize];
char ErrCodesBuff[C_ErrCodeBuffSize];
char ErrMsgBuff[C_ErrMsgBuffSize];
char* C_AppName = "Demo";

//* Establishing connection with CommitCRM, Should be called only once for the entire session **

CmtInitDbEngDll(C_AppName, // Your application name. This will be used for all functions of the
// package.
// Specify a meaningful value.
"C:\\Demo\\DB\\", //Path to the database folder where CommitCRM the server is
// installed <server>\Commit\Db
&Status); //Returned connection status

if (Status == C_Ok) {

//***Insert New Account into that Accounts table *******************
strcpy (DataBuff,"'Bart De Hantsetters','De Hantsetters','Hantsetters'");
strcat (MapBuff, "'\n,\nFLDCRDFULLNAME\nFLDCRDDEAR\nFLDCRDCONTACT");
strcat (RecIdBuff, "");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, //String for your selection.
C_AccountsTable, //Desired Table Code
DataBuff, //This string contains the values which we want to add to the database
MapBuff, //List of database fields where we want to add data
C_Flag,//Flag - stop(0) continue(1) the input process is data
//value(s) is invalid
0, //Not used
C_RecIDBuffSize, //Length of REC ID Buffer
C_ErrCodeBuffSize, //Length of Error Code Buffer
C_ErrMsgBuffSize, //Length of Error Message Buffer
RecIdBuff, //Buffer for returned REC ID
ErrCodesBuff, //Buffer for returned Error Codes
ErrMsgBuff, //Bufer for returned Error Messages
&Status //Returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if (Status == C_Ok) {

//***** Updating the Account record we've just created *************
strcpy (MapBuff, "'\n,\nFLDCRDDEAR\nFLDCRDRECID"); // Map file for the update
// transaction - the Dear field and the record id
strcpy (DataBuff,"'Doctor','");
strcat (DataBuff, RecIdBuff);
strcat (DataBuff, "'");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, // string for your selection.
C_AccountsTable, // Desired Table Code
DataBuff, // string contains the values, which we want to add into the Database
MapBuff, // list of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // length of RecID Buffer
C_ErrCodeBuffSize, // length of Error Code Buffer
C_ErrMsgBuffSize, // length of Error Message Buffer
RecIdBuff, // buffer for returned RecID
ErrCodesBuff, // buffer for returned Error Codes
ErrMsgBuff, // bufer for returned Error Messages
&Status // returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);
}
else
{
printf("Insert new Account. Error code: %d\n", Status);
};

//****Terminate connection with CommitCRM*******************
CmtTerminateDbEngDll();
}
else
{
printf("Commit Init failed. Error code: %d\n", Status);
};

return 0;
}

====Delphi Sample====
For all field description see the [[API Reference Manual]].

program Demo;

{$APPTYPE CONSOLE}

uses
SysUtils, Classes;
const
C_DataBuffSize = 1024;
C_MapBufSize = 1024;
C_ErrMsgBuffSize = 1024;
C_DescSize = 1024;
C_ErrCodeBuffSize = 64;
C_RecIDBuffSize = 64;

C_Flag = 1;
C_Ok = 1;
C_AccountsTable = 10;
C_AppName = 'Demo';

CmtDbEngDll = 'CmtDbEng.DLL';

var
Status: integer;
DataBuff: array [0..C_DataBuffSize] of Char;
MapBuff: array [0..C_MapBufSize] of Char;
RecIdBuff: array [0..C_RecIDBuffSize] of Char;
ErrCodesBuff: array [0..C_ErrCodeBuffSize] of Char;
ErrMsgBuff: array [0..C_ErrMsgBuffSize] of Char;
s: string;

//** Establishing connection with CommitCRM, Should be called only once for the entire session *
Procedure CmtInitDbEngDll (
xSoftWareName : PChar; // Your application name. Once selected this string
// will be used for all
// functions of the package. Specify a meaningful value.
xDbPath : PChar; // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db

var xvStatus : integer // Returned connection status
); stdcall; external CmtDbEngDll;

//**** Insert/Update record
Procedure CmtInsUpdRec(
xSoftWareName : pChar; // See above
xDataKind : integer; // Desired Table Code
xDataBuff : pChar; // String containing the values, which we want
// to add into the Database
xMapBuff : pChar; // List of the database fields into
//which we want to add data
xContWhenInvalidData : Integer; //Flag - stop(0)/continue(1) the input process
// is some data value(s) is invalid
xFlags : Integer; // Not used
xRecIDBuffLen : Integer; // Length of REC ID Buffer
xLogErrCodesBuffLen : Integer; // Length of Error Code Buffer
xLogErrMsgBuffLen : Integer; // Length of Error Message Buffer
xvRecIDBuff : pChar; // Buffer for returned REC ID
xvErrCodesLogBuff : pChar; // Buffer for returned Error Codes
xvErrMsgLogBuff : pChar; // Buffer for returned Error Messages
var xvStatus : Integer // Returned status
); stdcall; external CmtDbEngDll;

//**** Terminate connection with CommitCRM ****
procedure CmtTerminateDbEngDll; stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByCode(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByStatus(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure ErrCodesParsing (ErrCodeBuff: string);
var
lList: TStringList;
i: integer;
aDescErrCode : Pchar;
begin
try
lList := TStringList.Create;
lList.Text := ErrCodeBuff;
GetMem(aDescErrCode,C_DescSize);
for i := 0 to lList.Count - 1 do
begin
CmtGetDescriptionByCode(StrToInt(lList[i]), C_DescSize, aDescErrCode);
writeln('Error Code: '+lList[i]+' Desc: '+string(aDescErrCode));
end;
finally
FreeMem(aDescErrCode);
lList.Destroy;
end;
end;

procedure DisplayErrStatusCode(xCode : Integer);
var
aStatusErrCode : Pchar;
begin
try
GetMem(aStatusErrCode,C_DescSize);
CmtGetDescriptionByStatus(xCode,C_DescSize, aStatusErrCode);
writeln('Commit Init failed. Error code: '+Inttostr(xCode)+' Desc: '+string(aStatusErrCode));
finally
FreeMem(aStatusErrCode);
end;
end;

begin

//**** Establishing connection with CommitCRM, Should be called only once for the entire session
CmtInitDbEngDll(C_AppName, // Your application name. Once selected this string will be used
// for all functions of the package. Specify a meaningful value.
'C:\DemoDelphi\db\', // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db
Status // Returned connection status
);

if Status = C_Ok then
begin

//**** Insert a new Account into the Accounts table ****

s := '"Bart De Hantsetters","De Hantsetters","Hantsetters"';
StrPCopy(DataBuff, s);
s := '"'+#13','+#13+'FLDCRDFULLNAME'+#13+'FLDCRDDEAR'+#13+'FLDCRDCONTACT'+#0;
StrPCopy(MapBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want to add into
// the Database
MapBuff, // List of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Llength of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned REC ID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if (ErrMsgBuff[0] <> #0) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
begin
//**** Updating the Account record we've just created *****

// Map file for the update transaction - the Dear field and the record id
s := '"'+#13+','+#13+'FLDCRDDEAR'+#13'FLDCRDRECID';
StrPCopy(MapBuff, s);

s := '"Doctor","'+RecIdBuff+'"';
StrPCopy(DataBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want
// to add into the Database
MapBuff, // List of the database fields into which we want to add
//data
C_Flag, // Flag - stop(0)/continue(1) the input process is some
// data value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Length of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned RECID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if ((ErrMsgBuff[0] <> #0)) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
Writeln('Completed Successfully');
end
else
begin
try
s := IntToStr(Status);
except
s := 'ill-defined';
end;
writeln('Insert new Account. Error code: '+ s);
end;

//**** Terminate connection with CommitCRM****

CmtTerminateDbEngDll();
end
else
begin
DisplayErrStatusCode(Status);
end;

writeln(#13#10+'press Enter to quit');
readln;
end.

===XML samples===

Following are samples for adding a new Ticket and a new Charge to the Commit database using XML formatted messages.

Make sure to go over the [[Email Connector]] setup guide, and perform the XML API setup steps prior to testing the XML API.

Also please read [[Commit API Reference Manual|Using Commit API#Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

Notes on API by Email Activation:

*Error Handling - Should the system fail to perform the XML transaction, an error message will be sent to the email address specified in the XML.

*Using a Password - If you wish to use a verification password for the XML transactions, define the password using the ServerConfig.exe utility. To do so, go to the XML tab, enable the API by Email option and set a password (as specified in the XML - see [[Commit API Reference Manual#General XML Tokens|General XML Tokens]]). Make sure to set the same Password in ServerConfig and in the XML email itself.

You can read more about the ServerConfig and how to setup the API by Email configuration in the [[Email Connector|Commit Email Connector]] Setup guide.

====General XML Tokens====
The sample and table demonstrates general parameters which should be used for any XML transaction.

For all field description see the [[API Reference Manual]].

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
... the transaction goes here ...
</RecordData>
</CommitCRMTransaction>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMTransaction>
| Start and end transactions with this token (may have more than one in a single email)
|-
| <ExternalApplicationName>
| The sender application name, can contain any text
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <Password>
| Optional Password - Only emails with a password that matches the password set in the Email Connector Settings will be processed (to prevent SPAM email from being processed and added to your CommitCRM database).
|-
| <DataKind>
| What is the Entity you wish to create/update. 
Possible values: 
ACCOUNT - for Accounts 
TICKET - for Tickets 
CHARGE - for Charges 
ITEM - for Items 
APPOINTMENT-OR-TASK - for Appointments/Task 
HISTORY-NOTE - For History notes 
ASSET - for Assets 
OPPORTUNITY - for Sales Opportunities 
DOCUMENT - for Documents 
KBARTICLE - for Knowledge Base articles 
|}

====Adding new Ticket====

In this sample, we add a new Ticket, and set some additional fields to it, such as Notes, Source, Due Date and Dispatcher flag.

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
<FLDTKTCARDID> CUSTOMER-RECORD-ID-GOES-HERE-20-CHARS </FLDTKTCARDID>
<FLDTKTPROBLEM>ticket description...</FLDTKTPROBLEM>
<FLDTKTSTATUS>100</FLDTKTSTATUS>
<FLDTKTKIND>General</FLDTKTKIND>
<FLDTKTNOTES>Notes</FLDTKTNOTES>
<FLDTKTSOURCE>Source</FLDTKTSOURCE>
<FLDTKTSCHEDLENESTIM>60</FLDTKTSCHEDLENESTIM>
<FLDTKTDUEDATETIME>02/04/08</FLDTKTDUEDATETIME>
<FLDTKTFORDISPATCH>Y</FLDTKTFORDISPATCH>
</RecordData>
</CommitCRMTransaction>

====Adding new Charges====

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>Alert</ExternalApplicationName>
<SendResponseToEmail>your email address for responses</SendResponseToEmail>
<Password>12345</Password> >> Should be the same in the ServerConfig!
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>CHARGE</DataKind>
<RecordData>
<FLDSLPWORKERID> CRDLS71RGU747TLHTFOR </FLDSLPWORKERID>
<FLDSLPCARDID> CRDLQXDL43BP5YCMSGM3</FLDSLPCARDID>
<FLDSLPITEMID> ITM1Q3GUI05ANBQGVY8D </FLDSLPITEMID>
<FLDSLPDESC> Charge Description... </FLDSLPDESC>
<FLDSLPQUANTITY> 10 </FLDSLPQUANTITY>
<FLDSLPSLIPDATE> 31/01/2008 </FLDSLPSLIPDATE>
<FLDSLPSTARTTIME> 12:06 </FLDSLPSTARTTIME>
<FLDSLPENDTIME> 14:50 </FLDSLPENDTIME>
<FLDSLPBCRECID> BCTMA51KBA925J7G0V67 </FLDSLPBCRECID>
<FLDSLPPRICE> 125.3 </FLDSLPPRICE>
<FLDSLPADJUSTAMOUNT> 10 </FLDSLPADJUSTAMOUNT>
<FLDSLPUSER1> Field 1... </FLDSLPUSER1>
</RecordData>
</CommitCRMTransaction>

====Receiving Response====
When adding or updating data via the XML API, the system can send a response (if the
XML transaction specifies this in the SendResponseToEmail token). The format of the XML
response is as follow:

Response in case of success:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>SUCCESS</Status>
<AffectedRecId>TKTN1NIQEYYQ8PBJMDAX</AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
</CommitCRMResponse>

Response in case of error:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>FAILURE</Status>
<AffectedRecId></AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
<ResultCodes>50109</ResultCodes>
<ResultMessage>
Fields with illegal values: Operation canceled. Field: Account has invalid data -
TKTN1NIQEYYQ8PBJMDAX
</ResultMessage>
</CommitCRMResponse>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMResponse>
| The response starts and ends with this token
|-
| <Status>
| The transaction status. Possible values: FAILURE, SUCCESS
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <AffectedRecId>
| The REC ID of the entity which was added or updated when processing the transaction.
|-
|<ResultCodes> <ResultMessage>
|In case of a failure, this will contain the error code and description. You can find more information about error codes [[Commit API Reference Manual#Error Codes Description|here]].
|}

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

API Code Samples

2009-08-20T10:30:36Z

Yarden:

{{usermanualsapidevelopersguide}}
==Introduction==
The Commit API allows you to add/update the following entities:
*Accounts
*Assets
*Tickets
*Charges
*Appointments
*Tasks
*History Notes
*Opportunities
*Documents
*Knowledge Base Articles

Each API method requires a list of parameters which contain the field names and their values. The field names are the Database field names. You can see each field's name within the application (so you can verify which field you are about to update), by right-clicking the field and selecting Field Settings > Advanced Tab > view the Tech. Rec ID field.

You can view the complete list of database fields in the [[Commit API Reference Manual#API Reference Manual|API Reference Manual]] above.

Following are samples for using the API by Email and the Programming API. The samples are basic and provide an easy starting point.

===Code samples===
The following code samples demonstrate how to add and update a record in CommitCRM from VBA, C++ or Delphi programs.

Make sure to read [[Commit API Reference Manual#Using Commit API|Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

To test samples, it is recommended that you download a trial version of CommitCRM from our web site and install it on a new computer that is not running CommitCRM. Then, modify the paths in the source code to point to folder <testcomputer>\Commit\LastVer (and to the same files it already points to).

When developing your programs please make sure you work under the <testcomputer>\Commit\ThirdParty\UserDev folder (or at least call the dlls in this location). Do not copy the dll’s to any other location.

These samples create a connection to CommitCRM's database, add a new Account record into
the database, and update it. Each transaction should specify the database table to be updated by the transaction:
{| class="wikitable"
|-
! '''Application entity'''
! '''Table name'''
! '''Code'''
|-
| Accounts
| Cards
| 10
|-
| Opportunities
| Opps
| 20
|-
| Documents
| Docs
| 30
|-
| Charges
| Docs
| 30
|-
| Charges
| Slips
| 40
|-
| Appointments/Tasks
| Events
| 50
|-
| History Notes
| Notebook
| 60
|-
| Tickets
| Tickets
| 70
|-
| Items
| Items
| 80
|-
| Assets
| Assets
| 90
|-
| Knowledge Base
| KBArticles
| 100
|}

====API functions====
The Programming API provides the following API functions:
{| class="wikitable"
|-
! '''Method'''
! '''Return Value'''
! '''Description'''
|-
| '''CmtInitDbEngDll (app_name, path, status)'''
| status (int)
| Establishes a connection to the database. app_name - This string will be used for all functions of the package, and will appear in the application as the user who performs the changes in the records you update. You should specify a meaningful value. path - The path to the DB folder where the Commit server is installed: <server>\Commit\Db status - 1 for success. See Error Codes Description for other values.
|-
| '''CmtInsUpdRec(data_buff, map_buff, flag, tbd, 
rec_id_buff_size, error_codes_buff_size, 
err_msg_buff_size,rec_id_buff, 
err_codes_buff, err_msg_buff, status)'''
| status (int), rec_id (char)
| Adds/Updates records. 
data_buff - string containing the values to insert into the Database 
map_buff - mapping of the database fields corresponding with the data buff 
flag - stop(0)/continue(1) the input process is an invalid data value(s) 
tbd - Not used 
rec_id_buff_size - length of REC ID Buffer 
err_code_buff_size - length of Error Code Buffer 
err_msg_buff_size - length of Error Message Buffer 
rec_id_buff - buffer for returned REC ID 
err_codes_buff - buffer for returned Error Codes 
err_msg_buff - buffer for returned Error Messages 
status - returned status, 1 for success. 
See [[Commit API Reference Manual#Error Codes Description|Error Codes Description]] for other values.
|-
| '''CmtTerminateDbEngDll'''
|
| Close the connection to the database
|-
| '''CmtGetDescriptionByCode''' (code, desc_size, desc)
| message (char)
| Call this function in case of error in 
'''CmtInsUpdRec'''. 
In case of error (return code other than 1), 
you can use this to get error string.
|-
| '''CmtGetDescriptionByStatus'''
|
| Call this function in case of error in 
'''CmtInitDbEngDll'''
|}

'''Field buffers'''
The record to be added/updated in the database is passed to the Commit API in two buffers:
{| class="wikitable"
|-
! '''Parameter'''
! '''Description'''
! '''Example'''
|-
| data_buff
| String containing the values to insert into the Database. Separators between the fields are defined in the map_buff
| "17/04/2008 14:44", "CRD7C9KZPS9JN3LEZVD9", "Charge", "CRDGO0SVQ6074CMAN7DW","Closed","test note in DB Engine", "NTBL6PDPKUU6NXLRHLHP","CRDBSMJ3P72EHMU0HB LX","TKT4S81466E05IM8P23X"
|-
| map_buff
| Mapping of the data_buff: separators, field names.

Field names must be in the same order as the data_buff values.

The field names should be separated with a different separator than the values (e.g. "new line").
| " , FLDHISNOTEDATETIME 
FLDHISWORKERID 
FLDHISKIND 
FLDHISCONTACTID 
FLDHISUSER1 
FLDHISDESCRIPTION 
FLDHISRECID 
FLDHISCARDID 
FLDHISLINKRECID 
|}

====VB Sample====
To test the following VB code, create a VB program that includes this code and executes
it, or open the Visual Basic editor included with MS-Word, paste the code into it and run it.

In order for the VB sample to compile properly, please follow these steps:
#Go to My Computer > Right Click – Properties > Advanced Tab > Environment Variable
#At the bottom of the list, search for the Path variable (not PathText)
#Double click the Path variable > go to the end of the value/line
#Add ;
#Add the path to the folder: <server>\Commit\ThirdParty\UserDev\ and confirm.

For all field description see the [[API Reference Manual]].

Private Declare Sub CmtInitDbEngDll Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDbPath As String, ByRef xvStatus As Integer)

Private Declare Sub InitCommonControls Lib "comctl32.dll" ()

Private Declare Sub CmtInsUpdRec Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDataKind As Integer, _
ByVal xDataBuff As String, _
ByVal xMapBuff As String, _
ByVal xContWhenInvalidData As Integer, _
ByVal xFlags As Integer, _
ByVal xRecIDBuffLen As Integer, _
ByVal xLogErrCodesBuffLen As Integer, _
ByVal xLogErrMsgBuffLen As Integer, _
ByVal xvRecIDBuff As String, _
ByVal xvErrCodesLogBuff As String, _
ByVal xvErrMsgLogBuff As String, _
ByRef xvStatus As Integer)

Private Const C_DataBuffSize As Integer = 1024
Private Const C_MapBufSize As Integer = 1024
Private Const C_ErrMsgBuffSize As Integer = 1024
Private Const C_ErrCodeBuffSize As Integer = 64
Private Const C_RecIDBuffSize As Integer = 20
Private Const C_Flag As Integer = 1
Private Const C_Ok As Integer = 1
Private Const C_AccountsTable As Integer = 10

Private Const C_AppName As String = "Demo"

Public Sub DBEng()

Dim nStatus As Integer
Dim l As Long
Dim S As String
Dim pStr As Long
Dim MapBuff As String
Dim DataBuff As String
Dim RecIdBuff As String * C_RecIDBuffSize
Dim ErrCodesLogBuff As String * C_ErrCodeBuffSize
Dim ErrMsgLogBuff As String * C_ErrMsgBuffSize

Call CmtInitDbEngDll(C_AppName, "C:\DemoVBA\DB\", nStatus)

If nStatus = C_Ok Then

Rem ******************** Establishing connection with Commit, Should be
called only once for the entire session ******
MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDFULLNAME" + Chr(13) + "FLDCRDDEAR" +
Chr(13) + "FLDCRDCONTACT"
DataBuff = "'Bart De Hantsetters','De Hantsetters','Hantsetters'"

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)

If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

If nStatus = C_Ok Then
Rem ******************** Updating the Account record we've just created *******************

MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDDEAR" + Chr(13) + "FLDCRDRECID"
DataBuff = "'Doctor','" + RecIdBuff + "'"
ErrCodesBuff = ""
ErrMsgBuff = ""

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)
If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

Else
MsgBox ("Insert new Account. Error code: " + ErrCodesLogBuff)

End If
Else
MsgBox ("Commit Init failed. Error code: " + ErrCodesLogBuff)
End If

End Sub

====C++ Sample====
For all field description see the [[API Reference Manual]].

// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
const int C_DescSize = 1024;
char desc[C_DescSize];
char Delimiter[] = "\n";
int Code;
char* pch;
pch = strtok (ErrCodeBuff,Delimiter);
while (pch != NULL)
{
Code = atoi(pch);
CmtGetDescriptionByCode(Code, C_DescSize, desc);
printf ("%s\n",desc);
pch = strtok (NULL, Delimiter);
}
return 0;
}
int main(int argc, char* argv[])
{
const int C_DataBuffSize = 1024;
const int C_MapBufSize = 1024;
const int C_ErrMsgBuffSize = 1024;
const int C_ErrCodeBuffSize = 64;
const int C_RecIDBuffSize = 64;
const int C_Flag = 1;
const int C_Ok = 1;
const int C_AccountsTable = 10;
const int C_ExampleCode = 54000;
int Status;
char DataBuff[C_DataBuffSize] = "";
char MapBuff[C_MapBufSize] = "";
char RecIdBuff[C_RecIDBuffSize];
char ErrCodesBuff[C_ErrCodeBuffSize];
char ErrMsgBuff[C_ErrMsgBuffSize];
char* C_AppName = "Demo";

//* Establishing connection with CommitCRM, Should be called only once for the entire session **

CmtInitDbEngDll(C_AppName, // Your application name. This will be used for all functions of the
// package.
// Specify a meaningful value.
"C:\\Demo\\DB\\", //Path to the database folder where CommitCRM the server is
// installed <server>\Commit\Db
&Status); //Returned connection status

if (Status == C_Ok) {

//***Insert New Account into that Accounts table *******************
strcpy (DataBuff,"'Bart De Hantsetters','De Hantsetters','Hantsetters'");
strcat (MapBuff, "'\n,\nFLDCRDFULLNAME\nFLDCRDDEAR\nFLDCRDCONTACT");
strcat (RecIdBuff, "");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, //String for your selection.
C_AccountsTable, //Desired Table Code
DataBuff, //This string contains the values which we want to add to the database
MapBuff, //List of database fields where we want to add data
C_Flag,//Flag - stop(0) continue(1) the input process is data
//value(s) is invalid
0, //Not used
C_RecIDBuffSize, //Length of REC ID Buffer
C_ErrCodeBuffSize, //Length of Error Code Buffer
C_ErrMsgBuffSize, //Length of Error Message Buffer
RecIdBuff, //Buffer for returned REC ID
ErrCodesBuff, //Buffer for returned Error Codes
ErrMsgBuff, //Bufer for returned Error Messages
&Status //Returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if (Status == C_Ok) {

//***** Updating the Account record we've just created *************
strcpy (MapBuff, "'\n,\nFLDCRDDEAR\nFLDCRDRECID"); // Map file for the update
// transaction - the Dear field and the record id
strcpy (DataBuff,"'Doctor','");
strcat (DataBuff, RecIdBuff);
strcat (DataBuff, "'");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, // string for your selection.
C_AccountsTable, // Desired Table Code
DataBuff, // string contains the values, which we want to add into the Database
MapBuff, // list of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // length of RecID Buffer
C_ErrCodeBuffSize, // length of Error Code Buffer
C_ErrMsgBuffSize, // length of Error Message Buffer
RecIdBuff, // buffer for returned RecID
ErrCodesBuff, // buffer for returned Error Codes
ErrMsgBuff, // bufer for returned Error Messages
&Status // returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);
}
else
{
printf("Insert new Account. Error code: %d\n", Status);
};

//****Terminate connection with CommitCRM*******************
CmtTerminateDbEngDll();
}
else
{
printf("Commit Init failed. Error code: %d\n", Status);
};

return 0;
}

====Delphi Sample====
For all field description see the [[API Reference Manual]].

program Demo;

{$APPTYPE CONSOLE}

uses
SysUtils, Classes;
const
C_DataBuffSize = 1024;
C_MapBufSize = 1024;
C_ErrMsgBuffSize = 1024;
C_DescSize = 1024;
C_ErrCodeBuffSize = 64;
C_RecIDBuffSize = 64;

C_Flag = 1;
C_Ok = 1;
C_AccountsTable = 10;
C_AppName = 'Demo';

CmtDbEngDll = 'CmtDbEng.DLL';

var
Status: integer;
DataBuff: array [0..C_DataBuffSize] of Char;
MapBuff: array [0..C_MapBufSize] of Char;
RecIdBuff: array [0..C_RecIDBuffSize] of Char;
ErrCodesBuff: array [0..C_ErrCodeBuffSize] of Char;
ErrMsgBuff: array [0..C_ErrMsgBuffSize] of Char;
s: string;

//** Establishing connection with CommitCRM, Should be called only once for the entire session *
Procedure CmtInitDbEngDll (
xSoftWareName : PChar; // Your application name. Once selected this string
// will be used for all
// functions of the package. Specify a meaningful value.
xDbPath : PChar; // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db

var xvStatus : integer // Returned connection status
); stdcall; external CmtDbEngDll;

//**** Insert/Update record
Procedure CmtInsUpdRec(
xSoftWareName : pChar; // See above
xDataKind : integer; // Desired Table Code
xDataBuff : pChar; // String containing the values, which we want
// to add into the Database
xMapBuff : pChar; // List of the database fields into
//which we want to add data
xContWhenInvalidData : Integer; //Flag - stop(0)/continue(1) the input process
// is some data value(s) is invalid
xFlags : Integer; // Not used
xRecIDBuffLen : Integer; // Length of REC ID Buffer
xLogErrCodesBuffLen : Integer; // Length of Error Code Buffer
xLogErrMsgBuffLen : Integer; // Length of Error Message Buffer
xvRecIDBuff : pChar; // Buffer for returned REC ID
xvErrCodesLogBuff : pChar; // Buffer for returned Error Codes
xvErrMsgLogBuff : pChar; // Buffer for returned Error Messages
var xvStatus : Integer // Returned status
); stdcall; external CmtDbEngDll;

//**** Terminate connection with CommitCRM ****
procedure CmtTerminateDbEngDll; stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByCode(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByStatus(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure ErrCodesParsing (ErrCodeBuff: string);
var
lList: TStringList;
i: integer;
aDescErrCode : Pchar;
begin
try
lList := TStringList.Create;
lList.Text := ErrCodeBuff;
GetMem(aDescErrCode,C_DescSize);
for i := 0 to lList.Count - 1 do
begin
CmtGetDescriptionByCode(StrToInt(lList[i]), C_DescSize, aDescErrCode);
writeln('Error Code: '+lList[i]+' Desc: '+string(aDescErrCode));
end;
finally
FreeMem(aDescErrCode);
lList.Destroy;
end;
end;

procedure DisplayErrStatusCode(xCode : Integer);
var
aStatusErrCode : Pchar;
begin
try
GetMem(aStatusErrCode,C_DescSize);
CmtGetDescriptionByStatus(xCode,C_DescSize, aStatusErrCode);
writeln('Commit Init failed. Error code: '+Inttostr(xCode)+' Desc: '+string(aStatusErrCode));
finally
FreeMem(aStatusErrCode);
end;
end;

begin

//**** Establishing connection with CommitCRM, Should be called only once for the entire session
CmtInitDbEngDll(C_AppName, // Your application name. Once selected this string will be used
// for all functions of the package. Specify a meaningful value.
'C:\DemoDelphi\db\', // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db
Status // Returned connection status
);

if Status = C_Ok then
begin

//**** Insert a new Account into the Accounts table ****

s := '"Bart De Hantsetters","De Hantsetters","Hantsetters"';
StrPCopy(DataBuff, s);
s := '"'+#13','+#13+'FLDCRDFULLNAME'+#13+'FLDCRDDEAR'+#13+'FLDCRDCONTACT'+#0;
StrPCopy(MapBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want to add into
// the Database
MapBuff, // List of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Llength of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned REC ID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if (ErrMsgBuff[0] <> #0) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
begin
//**** Updating the Account record we've just created *****

// Map file for the update transaction - the Dear field and the record id
s := '"'+#13+','+#13+'FLDCRDDEAR'+#13'FLDCRDRECID';
StrPCopy(MapBuff, s);

s := '"Doctor","'+RecIdBuff+'"';
StrPCopy(DataBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want
// to add into the Database
MapBuff, // List of the database fields into which we want to add
//data
C_Flag, // Flag - stop(0)/continue(1) the input process is some
// data value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Length of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned RECID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if ((ErrMsgBuff[0] <> #0)) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
Writeln('Completed Successfully');
end
else
begin
try
s := IntToStr(Status);
except
s := 'ill-defined';
end;
writeln('Insert new Account. Error code: '+ s);
end;

//**** Terminate connection with CommitCRM****

CmtTerminateDbEngDll();
end
else
begin
DisplayErrStatusCode(Status);
end;

writeln(#13#10+'press Enter to quit');
readln;
end.

===XML samples===

Following are samples for adding a new Ticket and a new Charge to the Commit database using XML formatted messages.

Make sure to go over the [[Email Connector]] setup guide, and perform the XML API setup steps prior to testing the XML API.

Also please read [[Commit API Reference Manual|Using Commit API#Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

Notes on API by Email Activation:

*Error Handling - Should the system fail to perform the XML transaction, an error message will be sent to the email address specified in the XML.

*Using a Password - If you wish to use a verification password for the XML transactions, define the password using the ServerConfig.exe utility. To do so, go to the XML tab, enable the API by Email option and set a password (as specified in the XML - see [[Commit API Reference Manual#General XML Tokens|General XML Tokens]]). Make sure to set the same Password in ServerConfig and in the XML email itself.

You can read more about the ServerConfig and how to setup the API by Email configuration in the [[Email Connector|Commit Email Connector]] Setup guide.

====General XML Tokens====
The sample and table demonstrates general parameters which should be used for any XML transaction.

For all field description see the [[API Reference Manual]].

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
... the transaction goes here ...
</RecordData>
</CommitCRMTransaction>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMTransaction>
| Start and end transactions with this token (may have more than one in a single email)
|-
| <ExternalApplicationName>
| The sender application name, can contain any text
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <Password>
| Optional Password - Only emails with a password that matches the password set in the Email Connector Settings will be processed (to prevent SPAM email from being processed and added to your CommitCRM database).
|-
| <DataKind>
| What is the Entity you wish to create/update. 
Possible values: 
ACCOUNT - for Accounts 
TICKET - for Tickets 
CHARGE - for Charges 
ITEM - for Items 
APPOINTMENT-OR-TASK - for Appointments/Task 
HISTORY-NOTE - For History notes 
ASSET - for Assets 
OPPORTUNITY - for Sales Opportunities 
DOCUMENT - for Documents 
KBARTICLE - for Knowledge Base articles 
|}

====Adding new Ticket====

In this sample, we add a new Ticket, and set some additional fields to it, such as Notes, Source, Due Date and Dispatcher flag.

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
<FLDTKTCARDID> CUSTOMER-RECORD-ID-GOES-HERE-20-CHARS </FLDTKTCARDID>
<FLDTKTPROBLEM>ticket description...</FLDTKTPROBLEM>
<FLDTKTSTATUS>100</FLDTKTSTATUS>
<FLDTKTKIND>General</FLDTKTKIND>
<FLDTKTNOTES>Notes</FLDTKTNOTES>
<FLDTKTSOURCE>Source</FLDTKTSOURCE>
<FLDTKTSCHEDLENESTIM>60</FLDTKTSCHEDLENESTIM>
<FLDTKTDUEDATETIME>02/04/08</FLDTKTDUEDATETIME>
<FLDTKTFORDISPATCH>Y</FLDTKTFORDISPATCH>
</RecordData>
</CommitCRMTransaction>

====Adding new Charges====

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>Alert</ExternalApplicationName>
<SendResponseToEmail>your email address for responses</SendResponseToEmail>
<Password>12345</Password> >> Should be the same in the ServerConfig!
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>CHARGE</DataKind>
<RecordData>
<FLDSLPWORKERID> CRDLS71RGU747TLHTFOR </FLDSLPWORKERID>
<FLDSLPCARDID> CRDLQXDL43BP5YCMSGM3</FLDSLPCARDID>
<FLDSLPITEMID> ITM1Q3GUI05ANBQGVY8D </FLDSLPITEMID>
<FLDSLPDESC> Charge Description... </FLDSLPDESC>
<FLDSLPQUANTITY> 10 </FLDSLPQUANTITY>
<FLDSLPSLIPDATE> 31/01/2008 </FLDSLPSLIPDATE>
<FLDSLPSTARTTIME> 12:06 </FLDSLPSTARTTIME>
<FLDSLPENDTIME> 14:50 </FLDSLPENDTIME>
<FLDSLPBCRECID> BCTMA51KBA925J7G0V67 </FLDSLPBCRECID>
<FLDSLPPRICE> 125.3 </FLDSLPPRICE>
<FLDSLPADJUSTAMOUNT> 10 </FLDSLPADJUSTAMOUNT>
<FLDSLPUSER1> Field 1... </FLDSLPUSER1>
</RecordData>
</CommitCRMTransaction>

====Receiving Response====
When adding or updating data via the XML API, the system can send a response (if the
XML transaction specifies this in the SendResponseToEmail token). The format of the XML
response is as follow:

Response in case of success:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>SUCCESS</Status>
<AffectedRecId>TKTN1NIQEYYQ8PBJMDAX</AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
</CommitCRMResponse>

Response in case of error:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>FAILURE</Status>
<AffectedRecId></AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
<ResultCodes>50109</ResultCodes>
<ResultMessage>
Fields with illegal values: Operation canceled. Field: Account has invalid data -
TKTN1NIQEYYQ8PBJMDAX
</ResultMessage>
</CommitCRMResponse>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMResponse>
| The response starts and ends with this token
|-
| <Status>
| The transaction status. Possible values: FAILURE, SUCCESS
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <AffectedRecId>
| The REC ID of the entity which was added or updated when processing the transaction.
|-
|<ResultCodes> <ResultMessage>
|In case of a failure, this will contain the error code and description. You can find more information about error codes [[Commit API Reference Manual#Error Codes Description|here]].
|}

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

API Developers Guide

2009-08-20T10:08:17Z

Yarden: /* See Also */

{{usermanuals}}
CommitCRM provides various tools in order to read/add/update information in the CommitCRM
database. These tools include: Programming API and API by Email for updating the
database, and an ODBC Link for pulling information from the database.
The Commit API provides developers with a set of APIs which allow them to perform
database transactions in order to add and update records in the CommitCRM database. The
API can be used as a Programming API by embedding code which uses the API functions,
or as an API by Email which allows you to send XML formatted emails which will be
processed and executed.

*'''Programming API''' The Commit API provides developers with a set of API functions which can be used in VB, C++, Delphi and any other programming language that lets you use a standard Windows dll file. It provides the ability to create a connection to CommitCRM's database, add new records to the database and update them.

*'''API by Email''' The API by Email allows you to send XML formatted emails which contain database transactions. Commit Email Connector then pulls the incoming XML emails from your POP3 mail server, processes the email and performs the transactions in the XML transaction. XML formatted email gives you an API for the CommitCRM database, which allows you to perform many actions such as linking to external systems, receiving forms submitted from your web site, and more.

*'''ODBC Link''' While the API provides the means for adding and updating information in the database, you should use ODBC Link in order to read information from the database. CommitCRM uses an open database structure and allows other applications to access the database using ODBC (Open Data Base Connectivity) for '''read-only''' purposes. You can use ODBC Link in order to read data from the database and integrate it with an external system (i.e. Crystal reports, or any other application). You may also use the ODBC Link to read Database Record IDs and update existing records. This will be discussed later in this document.

__TOC__
==Glossary==
*'''Commit API (Application Programming Interface)''' - CommitCRM provides an API which allows you to add and update records in the CommitCRM database. The API includes a list of possible actions and parameters.

*'''ODBC Link (Open Data Base Connectivity)''' - ODBC is a function library which provides a common API for ODBC compliant databases. CommitCRM provides an open database and allows other applications to access the database using ODBC for '''read-only''' purposes.

*'''Record''' - Each entity in the CommitCRM database (such as Ticket, Account, Asset, Item, Appointment, Task, etc.) is considered a "record".

*'''Database fields''' - Each record contains a list of fields, each of which holds the record's data.

*'''Transaction''' – All additions or updates to record in the database are done by using a transaction. Each transaction includes the operation you wish to perform, the data type you wish to add/update and the additional parameters (database fields and their values).

*'''Transaction Parameters''' - Each transaction contains the parameters for performing the transaction: record type, list of database fields and a list of the values to be updated in these fields.

*'''External Application''' - This refers to the external program which integrates with CommitCRM in order to update the database. This name should be passed when performing updates to the database, and it will be saved in the CommitCRM record to indicate who performed the changes.

*'''Record ID (REC ID)''' - Each record in CommitCRM has a '''unique Record ID''' which is created when adding the record to the database. Every ID is 20 characters and should be transferred with the API transaction when you need to update an existing record.

==Using Commit API==
Commit API allows you to add and update records in the CommitCRM database, such as
Accounts, Tickets, Assets, Items, Appointments, Tasks and more.

The updates are performed using transactions, where each transaction includes the
operation you wish to perform, the data type you wish to add/update, and any additional
parameters (i.e. record type, database fields and their values).

Every record added to the system is assigned a unique Record ID (REC ID) which is the
database identifier for this record.

The Commit API allows you to perform the following operations.

*'''Add new records''' - if no Record ID is passed in the transaction, the API assumes that this is a new record, adds it to the system and creates a new Record ID for it.

*'''Update existing records''' - if the record ID is passed in the transaction, and the record exists, the system will update the record with the information in the transaction.

In both cases, the system will try to set default values for fields which do not exist in the
incoming transaction. If it fails, the action will fail with an error.

Note that in order to '''read data''' from the CommitCRM database, you should use the ODBC
Link, which provides a read-only link for the CommitCRM database. See more details in
[[#Retrieving data using ODBC|Retrieving data using ODBC]].

===Workflow===
Following is a sample work-flow, which demonstrates the process of adding a new Account, and then adding a new Ticket to this Account, using the Commit API.

Note that the API can return two parameters to the External Application:
#The Commit REC ID - when adding new records to the database, this will contains the new record ID.
#The ExternalTransactionID (relevant for XML transaction only) - In case the external application passes a parameter to be returned with the response, the ExternalTransactionID will be returned as-is to in the response.

The External Application should keep the REC ID which is returned from the API response. This allows you to later update the existing records with new data or add records related to it (such as opening a Ticket under the Account).

[[File:flow.gif|center]]

===Updating existing records===
In order to update an already existing record in the database (e.g. add a Ticket to an
Account, update an Account's phone number, add a new Charge to an existing Ticket,
etc.), you should pass the record's unique identifier to the API so it will update the
existing record rather than create a new Account. The record's unique identifier is
referred to as the Record ID (REC ID).

The Record ID can be obtained in the following ways:
#'''API Response''' (as in the flow above) - You can extract the newly created Record ID from the Email Response when adding new records with the API. This requires the developer to process the API responses, and extract the returning REC ID for each newly added record.
#'''ODBC Link''' - Use the ODBC Link to find relevant records (Accounts, Tickets, etc.), and read all information from the database, including the unique Record ID.
#'''Manually''' - from the Account's Notes tab, at the bottom, right-click the REC ID field and copy it.

Once you have obtained the Record ID you can pass the Record ID as a parameter for the
API and update this record.

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

The programming API executes database transactions. Each transaction uses API methods
provides by the API dll file which is located in the CommitCRM installation. Both the
Programming API and the API by Email use the same dll for performing the transactions.

Note that the API provides the tools needed for adding/updating information in the
database. In order to retrieve data, you should use the ODBC link which allows you to
connect to the database and retrieve data directly from the tables. You can read more
about it in the [[Commit API Reference Manual#Retrieving data using ODBC|Retrieving data using ODBC]] section.

You can find more information and samples in the [[API Code Samples]] section.

===API by Email (XML transaction)===
The API by Email operates under the Commit Email Connector module, which
automatically processes incoming emails arriving at a defined public email address. The
Email may contain XML formatted messages which contain API transactions, and provides
a full API to CommitCRM.

The Email Connector pulls incoming emails from your POP3 mail server, and processes the
email. When an email containing XML formatted message is detected, the system analyzes
the XML content of the email and performs the transactions written in the XML. You may
set the Email Connector to send automatic replies in response to XML formatted email.

The API by Email executes database transactions. Each transaction uses API methods
provided by the API dll file which is located in the CommitCRM installation. Both the
Programming API and the API by Email use the same dll for performing the transactions.

Note that the API provides the tools for adding/updating information in the database. In
order to retrieve data, you should use the ODBC link which allows you to connect to the
database and retrieve data directly from the tables. You can read more about it in the
[[Commit API Reference Manual#Retrieving data using ODBC|Retrieving data using ODBC]] section.

You can find more information and samples in [[API Code Samples#XML samples|XML samples]].

==Retrieving data using ODBC==
CommitCRM uses an open database and allows other applications to access it using ODBC
(Open Data Base Connectivity) for '''read-only''' purposes. While the API provides the means
for adding and updating information in the database, it is preferred to use ODBC to read
information from the database.

You can use ODBC Link to read data from the database and integrate it with an external
system (i.e. Crystal reports, or any other application). You may also use the ODBC Link in
order to read the Database Record ID and update existing records (see [[Commit API Reference Manual#Updating existing records|Updating existing records]]).

'''Activation Notes:'''

*ODBC connection is not officially supported yet, and although ODBC itself is well tested, we do not provide "pure ODBC" support.

*NEVER use ODBC to modify or delete data; use it for READ purposes only. Modifying data should be done using the Commit API.

*The ODBC Link can be used with your installed version of CommitCRM, and only requires installing an external driver. Before working with the API we recommend that you '''backup the database'''.

*We also suggest that the CommitCRM application not be in use while data is being accessed with ODBC (this includes the CommitWebInterface and CommitServer services if they are in use). This may prevent data sharing issues.

Below are the database table names and their meaning:
{| class="wikitable"
|-
! '''CommitCRM Record'''
! '''Database Table Name'''
|-
| Accounts
| Cards
|-
| Tickets
| Tickets
|-
| Charges
| Slips
|-
| Assets
| Assets
|-
| Appointments
| Events
|-
| Tasks
| Events
|-
| History Notes
| NoteBook
|-
| Opportunities
| Opps
|-
| Documents
| Docs
|-
| Knowledge Base
| KBArticles
|}

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

===Installing ODBC Driver===
'''Product Overview''' 
The Advantage ODBC Driver is an ODBC version 3 driver based on the Advantage Client Engine that provides SQL access to the Advantage Database Server. The driver provides
full support for the "Minimum" ODBC SQL grammar specification, as well as many functions
included in the "Core" and "Extended" grammar specifications. When used with the
Advantage Database Server, ODBC users can have the
application stability, performance and reduced network traffic benefits of client/server
architecture.

'''Installation on Windows''' 
Like other ODBC drivers, the Advantage ODBC Driver is installed and managed using the
ODBC Administrator Utility. This utility works with the ODBC Driver Manager to configure
ODBC data sources. At runtime, the ODBC Driver Manager works with available drivers and
their configured data sources. If you have previously installed ODBC drivers, the ODBC Administrator may already be installed on your workstation. The icon for the Administrator is usually found in the Control Panel.

To install the Advantage ODBC Driver:
#[http://www.commitcrm.com/downloads/commit-odbc-8-1-0-26.exe Click here] to download the Advantage ODBC setup program.
#Run the Setup program.
#Proceed through the setup windows to complete installation.

'''Data Source Setup for Windows''' 
Once the Advantage ODBC Driver is installed, a data source needs to be configured to use
the Advantage ODBC Driver. The data source is an entry in the Windows Registry. When a
data source is defined for the Advantage Driver, all information specific to the Advantage
Driver and database files is stored under the Data Source entry in the Windows 95/98/ME/
NT/2000/2003/XP Registry. 
The database files and indexes must be stored on your file server, and the Advantage
Database Server must be loaded in order to access the files.

The Data Source settings may be modified at any time. Using the ODBC Administrator, you
may modify the Data Source and Option settings.
For specific information about the screen fields see the Data Source Setup Screen.

'''To Setup the Data Source:'''
#From the ODBC Administrator, click Add.
#Highlight the Advantage SQL ODBC line, and click OK.
#Type a unique data source name. For example, type AdvData. This name is used by applications to reference the data source.
#Specify the database or data dictionary path. Type a valid path name to a mapped drive on the server where the Advantage Database Server is installed or the path and file name of your Advantage Data Dictionary. Click Browse to select a database path or check the Data Dictionary check box and then browse to select a data dictionary file. Note Multiple Advantage data sources may need to be defined for your environment. If different settings are needed for ODBC connections in one application, separate data sources may be required.
#Review the options and change them to your desired setup.
#Once the Options are reviewed and/or altered, click OK to exit and save the settings. The new data source is displayed.
#Click Close to exit the ODBC Administrator.

'''ODBC Data Source Entries for Windows''' 
In Microsoft Windows, the entries are registry settings found on HKEY_CURRENT_USER\Software\ODBC\ODBC.INI\ (your unique data source name) or HKEY_LOCAL_MACHINE\Software\ODBC\ODBC.INI (your unique data source name). Unless specified otherwise, all registry entries can be setup by the Advantage ODBC Driver setup utility. See Data Source Setup for Windows and Data Source Setup Screen for more information. ODBC Data Source Keys.

'''ODBC Data Source Keys''' 
The following ODBC registry is '''required''' for the driver to load:
{| class="wikitable"
|-
! '''Registry Entry'''
! '''Comments'''
|-
| DataDirectory=data path
| 'data path' should be a valid path name for files locations (e.g., x:\data). This path is used to automatically select all tables in the specified directory.
|-
| DefaultType=Advantage
| Sets a certain type of database files to use Advantageproprietary ADT/ADI/ADM files.
|-
| ServerTypes=3
| Allows the Driver to use the remote or local server
|}

The following ODBC registry keys are '''optional''':

{| class="wikitable"
|-
! '''Registry Entry'''
! '''Comments'''
|-
| AdvantageLocking=ON \ OFF
| The default is ON to use the Advantage proprietary locking.
|-
| CharSet=OEM \ ANSI
| The default character collation setting is ANSI. If OEM is specified, Language must be indicated as well.
|-
| Language=USA
| Used if CharSet=OEM.
|-
| Description=String
| This is provided for easier administration.
|-
| Locking=RECORD \ FILE
| Indicates whether updates lock the entire file or the individual records that are updated. The default is RECORD.
|-
| MaxTableCloseCache=n
| N is the number of tables to hold in cache when cursors are opened and closed. The default is 25.
|-
| MemoBlockSize=n
| N is the size of the Advantage memo blocks in tables that are created by the ODBC driver. The default value is 8 for Advantage proprietary table (ADT/ADM).
|-
| Rows=TRUE \ FALSE
| Select whether deleted rows are displayed. If True, deleted rows are displayed. The default is False.
|-
| TrimTrailingSpaces=TRUE \ FALSE
| The default is False. If True is specified, trailing spaces in character fields will be removed prior to returning the values to the application.
|}

==Samples==
The Commit API allows you to add/update the following entities:
*Accounts
*Assets
*Tickets
*Charges
*Appointments
*Tasks
*History Notes
*Opportunities
*Documents
*Knowledge Base Articles

Each API method requires a list of parameters which contain the field names and their values. The field names are the Database field names. You can see each field's name within the application (so you can verify which field you are about to update), by right-clicking the field and selecting Field Settings > Advanced Tab > view the Tech. Rec ID field.

You can view the complete list of database fields in the [[Commit API Reference Manual#API Reference Manual|API Reference Manual]] above.

Following are samples for using the API by Email and the Programming API. The samples are basic and provide an easy starting point.

See [[API Code Samples]].

==API Reference Manual==

The API allows you to add/update the following entities:
*Accounts
*Assets
*Tickets
*Charges (and Contract-price Charges)
*Appointments
*Tasks
*History Notes
*Opportunities
*Documents
*Knowledge Base Articles

You can find a detailed listing of the database fields in the [[API Reference Manual]].

==See Also==
*[[API Code Samples]]
*[[API Reference Manual]]
*[[Email Connector|Commit Email Connector]]
*[[API by Email and MSP Integration]]
*[[MSP Integration Setup]]
*[[Commit SQL Database]]
*[[Programming API and ODBC Link]]
[[Category:User Manuals]]
[[Category:Integration]]

API Developers Guide

2009-08-20T09:44:58Z

Yarden: /* Using Commit API */

API Developers Guide

2009-08-20T09:43:32Z

Yarden: /* Using Commit API */

{{usermanuals}}
CommitCRM provides various tools in order to read/add/update information in the CommitCRM
database. These tools include: Programming API and API by Email for updating the
database, and an ODBC Link for pulling information from the database.
The Commit API provides developers with a set of APIs which allow them to perform
database transactions in order to add and update records in the CommitCRM database. The
API can be used as a Programming API by embedding code which uses the API functions,
or as an API by Email which allows you to send XML formatted emails which will be
processed and executed.

*'''Programming API''' The Commit API provides developers with a set of API functions which can be used in VB, C++, Delphi and any other programming language that lets you use a standard Windows dll file. It provides the ability to create a connection to CommitCRM's database, add new records to the database and update them.

*'''API by Email''' The API by Email allows you to send XML formatted emails which contain database transactions. Commit Email Connector then pulls the incoming XML emails from your POP3 mail server, processes the email and performs the transactions in the XML transaction. XML formatted email gives you an API for the CommitCRM database, which allows you to perform many actions such as linking to external systems, receiving forms submitted from your web site, and more.

*'''ODBC Link''' While the API provides the means for adding and updating information in the database, you should use ODBC Link in order to read information from the database. CommitCRM uses an open database structure and allows other applications to access the database using ODBC (Open Data Base Connectivity) for '''read-only''' purposes. You can use ODBC Link in order to read data from the database and integrate it with an external system (i.e. Crystal reports, or any other application). You may also use the ODBC Link to read Database Record IDs and update existing records. This will be discussed later in this document.

__TOC__
==Glossary==
*'''Commit API (Application Programming Interface)''' - CommitCRM provides an API which allows you to add and update records in the CommitCRM database. The API includes a list of possible actions and parameters.

*'''ODBC Link (Open Data Base Connectivity)''' - ODBC is a function library which provides a common API for ODBC compliant databases. CommitCRM provides an open database and allows other applications to access the database using ODBC for '''read-only''' purposes.

*'''Record''' - Each entity in the CommitCRM database (such as Ticket, Account, Asset, Item, Appointment, Task, etc.) is considered a "record".

*'''Database fields''' - Each record contains a list of fields, each of which holds the record's data.

*'''Transaction''' – All additions or updates to record in the database are done by using a transaction. Each transaction includes the operation you wish to perform, the data type you wish to add/update and the additional parameters (database fields and their values).

*'''Transaction Parameters''' - Each transaction contains the parameters for performing the transaction: record type, list of database fields and a list of the values to be updated in these fields.

*'''External Application''' - This refers to the external program which integrates with CommitCRM in order to update the database. This name should be passed when performing updates to the database, and it will be saved in the CommitCRM record to indicate who performed the changes.

*'''Record ID (REC ID)''' - Each record in CommitCRM has a '''unique Record ID''' which is created when adding the record to the database. Every ID is 20 characters and should be transferred with the API transaction when you need to update an existing record.

==Using Commit API==
Commit API allows you to add and update records in the CommitCRM database, such as
Accounts, Tickets, Assets, Items, Appointments, Tasks and more.

The updates are performed using transactions, where each transaction includes the
operation you wish to perform, the data type you wish to add/update, and any additional
parameters (i.e. record type, database fields and their values).

Every record added to the system is assigned a unique Record ID (REC ID) which is the
database identifier for this record.

The Commit API allows you to perform the following operations.

*'''Add new records''' - if no Record ID is passed in the transaction, the API assumes that this is a new record, adds it to the system and creates a new Record ID for it.

*'''Update existing records''' - if the record ID is passed in the transaction, and the record exists, the system will update the record with the information in the transaction.

In both cases, the system will try to set default values for fields which do not exist in the
incoming transaction. If it fails, the action will fail with an error.

Note that in order to '''read data''' from the CommitCRM database, you should use the ODBC
Link, which provides a read-only link for the CommitCRM database. See more details in
[[API Reference Manual#Retrieving data using ODBC|Retrieving data using ODBC]].

===Workflow===
Following is a sample work-flow, which demonstrates the process of adding a new Account, and then adding a new Ticket to this Account, using the Commit API.

Note that the API can return two parameters to the External Application:
#The Commit REC ID - when adding new records to the database, this will contains the new record ID.
#The ExternalTransactionID (relevant for XML transaction only) - In case the external application passes a parameter to be returned with the response, the ExternalTransactionID will be returned as-is to in the response.

The External Application should keep the REC ID which is returned from the API response. This allows you to later update the existing records with new data or add records related to it (such as opening a Ticket under the Account).

[[File:flow.gif|center]]

===Updating existing records===
In order to update an already existing record in the database (e.g. add a Ticket to an
Account, update an Account's phone number, add a new Charge to an existing Ticket,
etc.), you should pass the record's unique identifier to the API so it will update the
existing record rather than create a new Account. The record's unique identifier is
referred to as the Record ID (REC ID).

The Record ID can be obtained in the following ways:
#'''API Response''' (as in the flow above) - You can extract the newly created Record ID from the Email Response when adding new records with the API. This requires the developer to process the API responses, and extract the returning REC ID for each newly added record.
#'''ODBC Link''' - Use the ODBC Link to find relevant records (Accounts, Tickets, etc.), and read all information from the database, including the unique Record ID.
#'''Manually''' - from the Account's Notes tab, at the bottom, right-click the REC ID field and copy it.

Once you have obtained the Record ID you can pass the Record ID as a parameter for the
API and update this record.

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

The programming API executes database transactions. Each transaction uses API methods
provides by the API dll file which is located in the CommitCRM installation. Both the
Programming API and the API by Email use the same dll for performing the transactions.

Note that the API provides the tools needed for adding/updating information in the
database. In order to retrieve data, you should use the ODBC link which allows you to
connect to the database and retrieve data directly from the tables. You can read more
about it in the [[Commit API Reference Manual#Retrieving data using ODBC|Retrieving data using ODBC]] section.

You can find more information and samples in the [[API Code Samples]] section.

===API by Email (XML transaction)===
The API by Email operates under the Commit Email Connector module, which
automatically processes incoming emails arriving at a defined public email address. The
Email may contain XML formatted messages which contain API transactions, and provides
a full API to CommitCRM.

The Email Connector pulls incoming emails from your POP3 mail server, and processes the
email. When an email containing XML formatted message is detected, the system analyzes
the XML content of the email and performs the transactions written in the XML. You may
set the Email Connector to send automatic replies in response to XML formatted email.

The API by Email executes database transactions. Each transaction uses API methods
provided by the API dll file which is located in the CommitCRM installation. Both the
Programming API and the API by Email use the same dll for performing the transactions.

Note that the API provides the tools for adding/updating information in the database. In
order to retrieve data, you should use the ODBC link which allows you to connect to the
database and retrieve data directly from the tables. You can read more about it in the
[[Commit API Reference Manual#Retrieving data using ODBC|Retrieving data using ODBC]] section.

You can find more information and samples in [[API Code Samples#XML samples|XML samples]].

==Retrieving data using ODBC==
CommitCRM uses an open database and allows other applications to access it using ODBC
(Open Data Base Connectivity) for '''read-only''' purposes. While the API provides the means
for adding and updating information in the database, it is preferred to use ODBC to read
information from the database.

You can use ODBC Link to read data from the database and integrate it with an external
system (i.e. Crystal reports, or any other application). You may also use the ODBC Link in
order to read the Database Record ID and update existing records (see [[Commit API Reference Manual#Updating existing records|Updating existing records]]).

'''Activation Notes:'''

*ODBC connection is not officially supported yet, and although ODBC itself is well tested, we do not provide "pure ODBC" support.

*NEVER use ODBC to modify or delete data; use it for READ purposes only. Modifying data should be done using the Commit API.

*The ODBC Link can be used with your installed version of CommitCRM, and only requires installing an external driver. Before working with the API we recommend that you '''backup the database'''.

*We also suggest that the CommitCRM application not be in use while data is being accessed with ODBC (this includes the CommitWebInterface and CommitServer services if they are in use). This may prevent data sharing issues.

Below are the database table names and their meaning:
{| class="wikitable"
|-
! '''CommitCRM Record'''
! '''Database Table Name'''
|-
| Accounts
| Cards
|-
| Tickets
| Tickets
|-
| Charges
| Slips
|-
| Assets
| Assets
|-
| Appointments
| Events
|-
| Tasks
| Events
|-
| History Notes
| NoteBook
|-
| Opportunities
| Opps
|-
| Documents
| Docs
|-
| Knowledge Base
| KBArticles
|}

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

===Installing ODBC Driver===
'''Product Overview''' 
The Advantage ODBC Driver is an ODBC version 3 driver based on the Advantage Client Engine that provides SQL access to the Advantage Database Server. The driver provides
full support for the "Minimum" ODBC SQL grammar specification, as well as many functions
included in the "Core" and "Extended" grammar specifications. When used with the
Advantage Database Server, ODBC users can have the
application stability, performance and reduced network traffic benefits of client/server
architecture.

'''Installation on Windows''' 
Like other ODBC drivers, the Advantage ODBC Driver is installed and managed using the
ODBC Administrator Utility. This utility works with the ODBC Driver Manager to configure
ODBC data sources. At runtime, the ODBC Driver Manager works with available drivers and
their configured data sources. If you have previously installed ODBC drivers, the ODBC Administrator may already be installed on your workstation. The icon for the Administrator is usually found in the Control Panel.

To install the Advantage ODBC Driver:
#[http://www.commitcrm.com/downloads/commit-odbc-8-1-0-26.exe Click here] to download the Advantage ODBC setup program.
#Run the Setup program.
#Proceed through the setup windows to complete installation.

'''Data Source Setup for Windows''' 
Once the Advantage ODBC Driver is installed, a data source needs to be configured to use
the Advantage ODBC Driver. The data source is an entry in the Windows Registry. When a
data source is defined for the Advantage Driver, all information specific to the Advantage
Driver and database files is stored under the Data Source entry in the Windows 95/98/ME/
NT/2000/2003/XP Registry. 
The database files and indexes must be stored on your file server, and the Advantage
Database Server must be loaded in order to access the files.

The Data Source settings may be modified at any time. Using the ODBC Administrator, you
may modify the Data Source and Option settings.
For specific information about the screen fields see the Data Source Setup Screen.

'''To Setup the Data Source:'''
#From the ODBC Administrator, click Add.
#Highlight the Advantage SQL ODBC line, and click OK.
#Type a unique data source name. For example, type AdvData. This name is used by applications to reference the data source.
#Specify the database or data dictionary path. Type a valid path name to a mapped drive on the server where the Advantage Database Server is installed or the path and file name of your Advantage Data Dictionary. Click Browse to select a database path or check the Data Dictionary check box and then browse to select a data dictionary file. Note Multiple Advantage data sources may need to be defined for your environment. If different settings are needed for ODBC connections in one application, separate data sources may be required.
#Review the options and change them to your desired setup.
#Once the Options are reviewed and/or altered, click OK to exit and save the settings. The new data source is displayed.
#Click Close to exit the ODBC Administrator.

'''ODBC Data Source Entries for Windows''' 
In Microsoft Windows, the entries are registry settings found on HKEY_CURRENT_USER\Software\ODBC\ODBC.INI\ (your unique data source name) or HKEY_LOCAL_MACHINE\Software\ODBC\ODBC.INI (your unique data source name). Unless specified otherwise, all registry entries can be setup by the Advantage ODBC Driver setup utility. See Data Source Setup for Windows and Data Source Setup Screen for more information. ODBC Data Source Keys.

'''ODBC Data Source Keys''' 
The following ODBC registry is '''required''' for the driver to load:
{| class="wikitable"
|-
! '''Registry Entry'''
! '''Comments'''
|-
| DataDirectory=data path
| 'data path' should be a valid path name for files locations (e.g., x:\data). This path is used to automatically select all tables in the specified directory.
|-
| DefaultType=Advantage
| Sets a certain type of database files to use Advantageproprietary ADT/ADI/ADM files.
|-
| ServerTypes=3
| Allows the Driver to use the remote or local server
|}

The following ODBC registry keys are '''optional''':

{| class="wikitable"
|-
! '''Registry Entry'''
! '''Comments'''
|-
| AdvantageLocking=ON \ OFF
| The default is ON to use the Advantage proprietary locking.
|-
| CharSet=OEM \ ANSI
| The default character collation setting is ANSI. If OEM is specified, Language must be indicated as well.
|-
| Language=USA
| Used if CharSet=OEM.
|-
| Description=String
| This is provided for easier administration.
|-
| Locking=RECORD \ FILE
| Indicates whether updates lock the entire file or the individual records that are updated. The default is RECORD.
|-
| MaxTableCloseCache=n
| N is the number of tables to hold in cache when cursors are opened and closed. The default is 25.
|-
| MemoBlockSize=n
| N is the size of the Advantage memo blocks in tables that are created by the ODBC driver. The default value is 8 for Advantage proprietary table (ADT/ADM).
|-
| Rows=TRUE \ FALSE
| Select whether deleted rows are displayed. If True, deleted rows are displayed. The default is False.
|-
| TrimTrailingSpaces=TRUE \ FALSE
| The default is False. If True is specified, trailing spaces in character fields will be removed prior to returning the values to the application.
|}

==Samples==
The Commit API allows you to add/update the following entities:
*Accounts
*Assets
*Tickets
*Charges
*Appointments
*Tasks
*History Notes
*Opportunities
*Documents
*Knowledge Base Articles

Each API method requires a list of parameters which contain the field names and their values. The field names are the Database field names. You can see each field's name within the application (so you can verify which field you are about to update), by right-clicking the field and selecting Field Settings > Advanced Tab > view the Tech. Rec ID field.

You can view the complete list of database fields in the [[Commit API Reference Manual#API Reference Manual|API Reference Manual]] above.

Following are samples for using the API by Email and the Programming API. The samples are basic and provide an easy starting point.

See [[API Code Samples]].

==API Reference Manual==

The API allows you to add/update the following entities:
*Accounts
*Assets
*Tickets
*Charges (and Contract-price Charges)
*Appointments
*Tasks
*History Notes
*Opportunities
*Documents
*Knowledge Base Articles

You can find a detailed listing of the database fields in the [[API Reference Manual]].

==See Also==
*[[API Code Samples]]
*[[API Reference Manual]]
*[[Email Connector|Commit Email Connector]]
*[[API by Email and MSP Integration]]
*[[MSP Integration Setup]]
*[[Commit SQL Database]]

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

API Code Samples

2009-08-20T09:35:21Z

Yarden: /* General XML Tokens */

{{usermanualsapidevelopersguide}}
The Commit API allows you to add/update the following entities:
*Accounts
*Assets
*Tickets
*Charges
*Appointments
*Tasks
*History Notes
*Opportunities
*Documents
*Knowledge Base Articles

Each API method requires a list of parameters which contain the field names and their values. The field names are the Database field names. You can see each field's name within the application (so you can verify which field you are about to update), by right-clicking the field and selecting Field Settings > Advanced Tab > view the Tech. Rec ID field.

You can view the complete list of database fields in the [[Commit API Reference Manual#API Reference Manual|API Reference Manual]] above.

Following are samples for using the API by Email and the Programming API. The samples are basic and provide an easy starting point.

===Code samples===
The following code samples demonstrate how to add and update a record in CommitCRM from VBA, C++ or Delphi programs.

Make sure to read [[Commit API Reference Manual#Using Commit API|Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

To test samples, it is recommended that you download a trial version of CommitCRM from our web site and install it on a new computer that is not running CommitCRM. Then, modify the paths in the source code to point to folder <testcomputer>\Commit\LastVer (and to the same files it already points to).

When developing your programs please make sure you work under the <testcomputer>\Commit\ThirdParty\UserDev folder (or at least call the dlls in this location). Do not copy the dll’s to any other location.

These samples create a connection to CommitCRM's database, add a new Account record into
the database, and update it. Each transaction should specify the database table to be updated by the transaction:
{| class="wikitable"
|-
! '''Application entity'''
! '''Table name'''
! '''Code'''
|-
| Accounts
| Cards
| 10
|-
| Opportunities
| Opps
| 20
|-
| Documents
| Docs
| 30
|-
| Charges
| Docs
| 30
|-
| Charges
| Slips
| 40
|-
| Appointments/Tasks
| Events
| 50
|-
| History Notes
| Notebook
| 60
|-
| Tickets
| Tickets
| 70
|-
| Items
| Items
| 80
|-
| Assets
| Assets
| 90
|-
| Knowledge Base
| KBArticles
| 100
|}

====API functions====
The Programming API provides the following API functions:
{| class="wikitable"
|-
! '''Method'''
! '''Return Value'''
! '''Description'''
|-
| '''CmtInitDbEngDll (app_name, path, status)'''
| status (int)
| Establishes a connection to the database. app_name - This string will be used for all functions of the package, and will appear in the application as the user who performs the changes in the records you update. You should specify a meaningful value. path - The path to the DB folder where the Commit server is installed: <server>\Commit\Db status - 1 for success. See Error Codes Description for other values.
|-
| '''CmtInsUpdRec(data_buff, map_buff, flag, tbd, 
rec_id_buff_size, error_codes_buff_size, 
err_msg_buff_size,rec_id_buff, 
err_codes_buff, err_msg_buff, status)'''
| status (int), rec_id (char)
| Adds/Updates records. 
data_buff - string containing the values to insert into the Database 
map_buff - mapping of the database fields corresponding with the data buff 
flag - stop(0)/continue(1) the input process is an invalid data value(s) 
tbd - Not used 
rec_id_buff_size - length of REC ID Buffer 
err_code_buff_size - length of Error Code Buffer 
err_msg_buff_size - length of Error Message Buffer 
rec_id_buff - buffer for returned REC ID 
err_codes_buff - buffer for returned Error Codes 
err_msg_buff - buffer for returned Error Messages 
status - returned status, 1 for success. 
See [[Commit API Reference Manual#Error Codes Description|Error Codes Description]] for other values.
|-
| '''CmtTerminateDbEngDll'''
|
| Close the connection to the database
|-
| '''CmtGetDescriptionByCode''' (code, desc_size, desc)
| message (char)
| Call this function in case of error in 
'''CmtInsUpdRec'''. 
In case of error (return code other than 1), 
you can use this to get error string.
|-
| '''CmtGetDescriptionByStatus'''
|
| Call this function in case of error in 
'''CmtInitDbEngDll'''
|}

'''Field buffers'''
The record to be added/updated in the database is passed to the Commit API in two buffers:
{| class="wikitable"
|-
! '''Parameter'''
! '''Description'''
! '''Example'''
|-
| data_buff
| String containing the values to insert into the Database. Separators between the fields are defined in the map_buff
| "17/04/2008 14:44", "CRD7C9KZPS9JN3LEZVD9", "Charge", "CRDGO0SVQ6074CMAN7DW","Closed","test note in DB Engine", "NTBL6PDPKUU6NXLRHLHP","CRDBSMJ3P72EHMU0HB LX","TKT4S81466E05IM8P23X"
|-
| map_buff
| Mapping of the data_buff: separators, field names.

Field names must be in the same order as the data_buff values.

The field names should be separated with a different separator than the values (e.g. "new line").
| " , FLDHISNOTEDATETIME 
FLDHISWORKERID 
FLDHISKIND 
FLDHISCONTACTID 
FLDHISUSER1 
FLDHISDESCRIPTION 
FLDHISRECID 
FLDHISCARDID 
FLDHISLINKRECID 
|}

====VB Sample====
To test the following VB code, create a VB program that includes this code and executes
it, or open the Visual Basic editor included with MS-Word, paste the code into it and run it.

In order for the VB sample to compile properly, please follow these steps:
#Go to My Computer > Right Click – Properties > Advanced Tab > Environment Variable
#At the bottom of the list, search for the Path variable (not PathText)
#Double click the Path variable > go to the end of the value/line
#Add ;
#Add the path to the folder: <server>\Commit\ThirdParty\UserDev\ and confirm.

For all field description see the [[API Reference Manual]].

Private Declare Sub CmtInitDbEngDll Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDbPath As String, ByRef xvStatus As Integer)

Private Declare Sub InitCommonControls Lib "comctl32.dll" ()

Private Declare Sub CmtInsUpdRec Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDataKind As Integer, _
ByVal xDataBuff As String, _
ByVal xMapBuff As String, _
ByVal xContWhenInvalidData As Integer, _
ByVal xFlags As Integer, _
ByVal xRecIDBuffLen As Integer, _
ByVal xLogErrCodesBuffLen As Integer, _
ByVal xLogErrMsgBuffLen As Integer, _
ByVal xvRecIDBuff As String, _
ByVal xvErrCodesLogBuff As String, _
ByVal xvErrMsgLogBuff As String, _
ByRef xvStatus As Integer)

Private Const C_DataBuffSize As Integer = 1024
Private Const C_MapBufSize As Integer = 1024
Private Const C_ErrMsgBuffSize As Integer = 1024
Private Const C_ErrCodeBuffSize As Integer = 64
Private Const C_RecIDBuffSize As Integer = 20
Private Const C_Flag As Integer = 1
Private Const C_Ok As Integer = 1
Private Const C_AccountsTable As Integer = 10

Private Const C_AppName As String = "Demo"

Public Sub DBEng()

Dim nStatus As Integer
Dim l As Long
Dim S As String
Dim pStr As Long
Dim MapBuff As String
Dim DataBuff As String
Dim RecIdBuff As String * C_RecIDBuffSize
Dim ErrCodesLogBuff As String * C_ErrCodeBuffSize
Dim ErrMsgLogBuff As String * C_ErrMsgBuffSize

Call CmtInitDbEngDll(C_AppName, "C:\DemoVBA\DB\", nStatus)

If nStatus = C_Ok Then

Rem ******************** Establishing connection with Commit, Should be
called only once for the entire session ******
MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDFULLNAME" + Chr(13) + "FLDCRDDEAR" +
Chr(13) + "FLDCRDCONTACT"
DataBuff = "'Bart De Hantsetters','De Hantsetters','Hantsetters'"

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)

If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

If nStatus = C_Ok Then
Rem ******************** Updating the Account record we've just created *******************

MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDDEAR" + Chr(13) + "FLDCRDRECID"
DataBuff = "'Doctor','" + RecIdBuff + "'"
ErrCodesBuff = ""
ErrMsgBuff = ""

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)
If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

Else
MsgBox ("Insert new Account. Error code: " + ErrCodesLogBuff)

End If
Else
MsgBox ("Commit Init failed. Error code: " + ErrCodesLogBuff)
End If

End Sub

====C++ Sample====
For all field description see the [[API Reference Manual]].

// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
const int C_DescSize = 1024;
char desc[C_DescSize];
char Delimiter[] = "\n";
int Code;
char* pch;
pch = strtok (ErrCodeBuff,Delimiter);
while (pch != NULL)
{
Code = atoi(pch);
CmtGetDescriptionByCode(Code, C_DescSize, desc);
printf ("%s\n",desc);
pch = strtok (NULL, Delimiter);
}
return 0;
}
int main(int argc, char* argv[])
{
const int C_DataBuffSize = 1024;
const int C_MapBufSize = 1024;
const int C_ErrMsgBuffSize = 1024;
const int C_ErrCodeBuffSize = 64;
const int C_RecIDBuffSize = 64;
const int C_Flag = 1;
const int C_Ok = 1;
const int C_AccountsTable = 10;
const int C_ExampleCode = 54000;
int Status;
char DataBuff[C_DataBuffSize] = "";
char MapBuff[C_MapBufSize] = "";
char RecIdBuff[C_RecIDBuffSize];
char ErrCodesBuff[C_ErrCodeBuffSize];
char ErrMsgBuff[C_ErrMsgBuffSize];
char* C_AppName = "Demo";

//* Establishing connection with CommitCRM, Should be called only once for the entire session **

CmtInitDbEngDll(C_AppName, // Your application name. This will be used for all functions of the
// package.
// Specify a meaningful value.
"C:\\Demo\\DB\\", //Path to the database folder where CommitCRM the server is
// installed <server>\Commit\Db
&Status); //Returned connection status

if (Status == C_Ok) {

//***Insert New Account into that Accounts table *******************
strcpy (DataBuff,"'Bart De Hantsetters','De Hantsetters','Hantsetters'");
strcat (MapBuff, "'\n,\nFLDCRDFULLNAME\nFLDCRDDEAR\nFLDCRDCONTACT");
strcat (RecIdBuff, "");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, //String for your selection.
C_AccountsTable, //Desired Table Code
DataBuff, //This string contains the values which we want to add to the database
MapBuff, //List of database fields where we want to add data
C_Flag,//Flag - stop(0) continue(1) the input process is data
//value(s) is invalid
0, //Not used
C_RecIDBuffSize, //Length of REC ID Buffer
C_ErrCodeBuffSize, //Length of Error Code Buffer
C_ErrMsgBuffSize, //Length of Error Message Buffer
RecIdBuff, //Buffer for returned REC ID
ErrCodesBuff, //Buffer for returned Error Codes
ErrMsgBuff, //Bufer for returned Error Messages
&Status //Returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if (Status == C_Ok) {

//***** Updating the Account record we've just created *************
strcpy (MapBuff, "'\n,\nFLDCRDDEAR\nFLDCRDRECID"); // Map file for the update
// transaction - the Dear field and the record id
strcpy (DataBuff,"'Doctor','");
strcat (DataBuff, RecIdBuff);
strcat (DataBuff, "'");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, // string for your selection.
C_AccountsTable, // Desired Table Code
DataBuff, // string contains the values, which we want to add into the Database
MapBuff, // list of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // length of RecID Buffer
C_ErrCodeBuffSize, // length of Error Code Buffer
C_ErrMsgBuffSize, // length of Error Message Buffer
RecIdBuff, // buffer for returned RecID
ErrCodesBuff, // buffer for returned Error Codes
ErrMsgBuff, // bufer for returned Error Messages
&Status // returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);
}
else
{
printf("Insert new Account. Error code: %d\n", Status);
};

//****Terminate connection with CommitCRM*******************
CmtTerminateDbEngDll();
}
else
{
printf("Commit Init failed. Error code: %d\n", Status);
};

return 0;
}

====Delphi Sample====
For all field description see the [[API Reference Manual]].

program Demo;

{$APPTYPE CONSOLE}

uses
SysUtils, Classes;
const
C_DataBuffSize = 1024;
C_MapBufSize = 1024;
C_ErrMsgBuffSize = 1024;
C_DescSize = 1024;
C_ErrCodeBuffSize = 64;
C_RecIDBuffSize = 64;

C_Flag = 1;
C_Ok = 1;
C_AccountsTable = 10;
C_AppName = 'Demo';

CmtDbEngDll = 'CmtDbEng.DLL';

var
Status: integer;
DataBuff: array [0..C_DataBuffSize] of Char;
MapBuff: array [0..C_MapBufSize] of Char;
RecIdBuff: array [0..C_RecIDBuffSize] of Char;
ErrCodesBuff: array [0..C_ErrCodeBuffSize] of Char;
ErrMsgBuff: array [0..C_ErrMsgBuffSize] of Char;
s: string;

//** Establishing connection with CommitCRM, Should be called only once for the entire session *
Procedure CmtInitDbEngDll (
xSoftWareName : PChar; // Your application name. Once selected this string
// will be used for all
// functions of the package. Specify a meaningful value.
xDbPath : PChar; // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db

var xvStatus : integer // Returned connection status
); stdcall; external CmtDbEngDll;

//**** Insert/Update record
Procedure CmtInsUpdRec(
xSoftWareName : pChar; // See above
xDataKind : integer; // Desired Table Code
xDataBuff : pChar; // String containing the values, which we want
// to add into the Database
xMapBuff : pChar; // List of the database fields into
//which we want to add data
xContWhenInvalidData : Integer; //Flag - stop(0)/continue(1) the input process
// is some data value(s) is invalid
xFlags : Integer; // Not used
xRecIDBuffLen : Integer; // Length of REC ID Buffer
xLogErrCodesBuffLen : Integer; // Length of Error Code Buffer
xLogErrMsgBuffLen : Integer; // Length of Error Message Buffer
xvRecIDBuff : pChar; // Buffer for returned REC ID
xvErrCodesLogBuff : pChar; // Buffer for returned Error Codes
xvErrMsgLogBuff : pChar; // Buffer for returned Error Messages
var xvStatus : Integer // Returned status
); stdcall; external CmtDbEngDll;

//**** Terminate connection with CommitCRM ****
procedure CmtTerminateDbEngDll; stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByCode(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByStatus(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure ErrCodesParsing (ErrCodeBuff: string);
var
lList: TStringList;
i: integer;
aDescErrCode : Pchar;
begin
try
lList := TStringList.Create;
lList.Text := ErrCodeBuff;
GetMem(aDescErrCode,C_DescSize);
for i := 0 to lList.Count - 1 do
begin
CmtGetDescriptionByCode(StrToInt(lList[i]), C_DescSize, aDescErrCode);
writeln('Error Code: '+lList[i]+' Desc: '+string(aDescErrCode));
end;
finally
FreeMem(aDescErrCode);
lList.Destroy;
end;
end;

procedure DisplayErrStatusCode(xCode : Integer);
var
aStatusErrCode : Pchar;
begin
try
GetMem(aStatusErrCode,C_DescSize);
CmtGetDescriptionByStatus(xCode,C_DescSize, aStatusErrCode);
writeln('Commit Init failed. Error code: '+Inttostr(xCode)+' Desc: '+string(aStatusErrCode));
finally
FreeMem(aStatusErrCode);
end;
end;

begin

//**** Establishing connection with CommitCRM, Should be called only once for the entire session
CmtInitDbEngDll(C_AppName, // Your application name. Once selected this string will be used
// for all functions of the package. Specify a meaningful value.
'C:\DemoDelphi\db\', // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db
Status // Returned connection status
);

if Status = C_Ok then
begin

//**** Insert a new Account into the Accounts table ****

s := '"Bart De Hantsetters","De Hantsetters","Hantsetters"';
StrPCopy(DataBuff, s);
s := '"'+#13','+#13+'FLDCRDFULLNAME'+#13+'FLDCRDDEAR'+#13+'FLDCRDCONTACT'+#0;
StrPCopy(MapBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want to add into
// the Database
MapBuff, // List of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Llength of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned REC ID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if (ErrMsgBuff[0] <> #0) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
begin
//**** Updating the Account record we've just created *****

// Map file for the update transaction - the Dear field and the record id
s := '"'+#13+','+#13+'FLDCRDDEAR'+#13'FLDCRDRECID';
StrPCopy(MapBuff, s);

s := '"Doctor","'+RecIdBuff+'"';
StrPCopy(DataBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want
// to add into the Database
MapBuff, // List of the database fields into which we want to add
//data
C_Flag, // Flag - stop(0)/continue(1) the input process is some
// data value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Length of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned RECID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if ((ErrMsgBuff[0] <> #0)) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
Writeln('Completed Successfully');
end
else
begin
try
s := IntToStr(Status);
except
s := 'ill-defined';
end;
writeln('Insert new Account. Error code: '+ s);
end;

//**** Terminate connection with CommitCRM****

CmtTerminateDbEngDll();
end
else
begin
DisplayErrStatusCode(Status);
end;

writeln(#13#10+'press Enter to quit');
readln;
end.

===XML samples===

Following are samples for adding a new Ticket and a new Charge to the Commit database using XML formatted messages.

Make sure to go over the [[Email Connector]] setup guide, and perform the XML API setup steps prior to testing the XML API.

Also please read [[Commit API Reference Manual|Using Commit API#Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

Notes on API by Email Activation:

*Error Handling - Should the system fail to perform the XML transaction, an error message will be sent to the email address specified in the XML.

*Using a Password - If you wish to use a verification password for the XML transactions, define the password using the ServerConfig.exe utility. To do so, go to the XML tab, enable the API by Email option and set a password (as specified in the XML - see [[Commit API Reference Manual#General XML Tokens|General XML Tokens]]). Make sure to set the same Password in ServerConfig and in the XML email itself.

You can read more about the ServerConfig and how to setup the API by Email configuration in the [[Email Connector|Commit Email Connector]] Setup guide.

====General XML Tokens====
The sample and table demonstrates general parameters which should be used for any XML transaction.

For all field description see the [[API Reference Manual]].

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
... the transaction goes here ...
</RecordData>
</CommitCRMTransaction>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMTransaction>
| Start and end transactions with this token (may have more than one in a single email)
|-
| <ExternalApplicationName>
| The sender application name, can contain any text
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <Password>
| Optional Password - Only emails with a password that matches the password set in the Email Connector Settings will be processed (to prevent SPAM email from being processed and added to your CommitCRM database).
|-
| <DataKind>
| What is the Entity you wish to create/update. 
Possible values: 
ACCOUNT - for Accounts 
TICKET - for Tickets 
CHARGE - for Charges 
ITEM - for Items 
APPOINTMENT-OR-TASK - for Appointments/Task 
HISTORY-NOTE - For History notes 
ASSET - for Assets 
OPPORTUNITY - for Sales Opportunities 
DOCUMENT - for Documents 
KBARTICLE - for Knowledge Base articles 
|}

====Adding new Ticket====

In this sample, we add a new Ticket, and set some additional fields to it, such as Notes, Source, Due Date and Dispatcher flag.

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
<FLDTKTCARDID> CUSTOMER-RECORD-ID-GOES-HERE-20-CHARS </FLDTKTCARDID>
<FLDTKTPROBLEM>ticket description...</FLDTKTPROBLEM>
<FLDTKTSTATUS>100</FLDTKTSTATUS>
<FLDTKTKIND>General</FLDTKTKIND>
<FLDTKTNOTES>Notes</FLDTKTNOTES>
<FLDTKTSOURCE>Source</FLDTKTSOURCE>
<FLDTKTSCHEDLENESTIM>60</FLDTKTSCHEDLENESTIM>
<FLDTKTDUEDATETIME>02/04/08</FLDTKTDUEDATETIME>
<FLDTKTFORDISPATCH>Y</FLDTKTFORDISPATCH>
</RecordData>
</CommitCRMTransaction>

====Adding new Charges====

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>Alert</ExternalApplicationName>
<SendResponseToEmail>your email address for responses</SendResponseToEmail>
<Password>12345</Password> >> Should be the same in the ServerConfig!
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>CHARGE</DataKind>
<RecordData>
<FLDSLPWORKERID> CRDLS71RGU747TLHTFOR </FLDSLPWORKERID>
<FLDSLPCARDID> CRDLQXDL43BP5YCMSGM3</FLDSLPCARDID>
<FLDSLPITEMID> ITM1Q3GUI05ANBQGVY8D </FLDSLPITEMID>
<FLDSLPDESC> Charge Description... </FLDSLPDESC>
<FLDSLPQUANTITY> 10 </FLDSLPQUANTITY>
<FLDSLPSLIPDATE> 31/01/2008 </FLDSLPSLIPDATE>
<FLDSLPSTARTTIME> 12:06 </FLDSLPSTARTTIME>
<FLDSLPENDTIME> 14:50 </FLDSLPENDTIME>
<FLDSLPBCRECID> BCTMA51KBA925J7G0V67 </FLDSLPBCRECID>
<FLDSLPPRICE> 125.3 </FLDSLPPRICE>
<FLDSLPADJUSTAMOUNT> 10 </FLDSLPADJUSTAMOUNT>
<FLDSLPUSER1> Field 1... </FLDSLPUSER1>
</RecordData>
</CommitCRMTransaction>

====Receiving Response====
When adding or updating data via the XML API, the system can send a response (if the
XML transaction specifies this in the SendResponseToEmail token). The format of the XML
response is as follow:

Response in case of success:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>SUCCESS</Status>
<AffectedRecId>TKTN1NIQEYYQ8PBJMDAX</AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
</CommitCRMResponse>

Response in case of error:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>FAILURE</Status>
<AffectedRecId></AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
<ResultCodes>50109</ResultCodes>
<ResultMessage>
Fields with illegal values: Operation canceled. Field: Account has invalid data -
TKTN1NIQEYYQ8PBJMDAX
</ResultMessage>
</CommitCRMResponse>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMResponse>
| The response starts and ends with this token
|-
| <Status>
| The transaction status. Possible values: FAILURE, SUCCESS
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <AffectedRecId>
| The REC ID of the entity which was added or updated when processing the transaction.
|-
|<ResultCodes> <ResultMessage>
|In case of a failure, this will contain the error code and description. You can find more information about error codes [[Commit API Reference Manual#Error Codes Description|here]].
|}

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

API Code Samples

2009-08-20T09:34:44Z

Yarden: /* XML samples */

{{usermanualsapidevelopersguide}}
The Commit API allows you to add/update the following entities:
*Accounts
*Assets
*Tickets
*Charges
*Appointments
*Tasks
*History Notes
*Opportunities
*Documents
*Knowledge Base Articles

Each API method requires a list of parameters which contain the field names and their values. The field names are the Database field names. You can see each field's name within the application (so you can verify which field you are about to update), by right-clicking the field and selecting Field Settings > Advanced Tab > view the Tech. Rec ID field.

You can view the complete list of database fields in the [[Commit API Reference Manual#API Reference Manual|API Reference Manual]] above.

Following are samples for using the API by Email and the Programming API. The samples are basic and provide an easy starting point.

===Code samples===
The following code samples demonstrate how to add and update a record in CommitCRM from VBA, C++ or Delphi programs.

Make sure to read [[Commit API Reference Manual#Using Commit API|Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

To test samples, it is recommended that you download a trial version of CommitCRM from our web site and install it on a new computer that is not running CommitCRM. Then, modify the paths in the source code to point to folder <testcomputer>\Commit\LastVer (and to the same files it already points to).

When developing your programs please make sure you work under the <testcomputer>\Commit\ThirdParty\UserDev folder (or at least call the dlls in this location). Do not copy the dll’s to any other location.

These samples create a connection to CommitCRM's database, add a new Account record into
the database, and update it. Each transaction should specify the database table to be updated by the transaction:
{| class="wikitable"
|-
! '''Application entity'''
! '''Table name'''
! '''Code'''
|-
| Accounts
| Cards
| 10
|-
| Opportunities
| Opps
| 20
|-
| Documents
| Docs
| 30
|-
| Charges
| Docs
| 30
|-
| Charges
| Slips
| 40
|-
| Appointments/Tasks
| Events
| 50
|-
| History Notes
| Notebook
| 60
|-
| Tickets
| Tickets
| 70
|-
| Items
| Items
| 80
|-
| Assets
| Assets
| 90
|-
| Knowledge Base
| KBArticles
| 100
|}

====API functions====
The Programming API provides the following API functions:
{| class="wikitable"
|-
! '''Method'''
! '''Return Value'''
! '''Description'''
|-
| '''CmtInitDbEngDll (app_name, path, status)'''
| status (int)
| Establishes a connection to the database. app_name - This string will be used for all functions of the package, and will appear in the application as the user who performs the changes in the records you update. You should specify a meaningful value. path - The path to the DB folder where the Commit server is installed: <server>\Commit\Db status - 1 for success. See Error Codes Description for other values.
|-
| '''CmtInsUpdRec(data_buff, map_buff, flag, tbd, 
rec_id_buff_size, error_codes_buff_size, 
err_msg_buff_size,rec_id_buff, 
err_codes_buff, err_msg_buff, status)'''
| status (int), rec_id (char)
| Adds/Updates records. 
data_buff - string containing the values to insert into the Database 
map_buff - mapping of the database fields corresponding with the data buff 
flag - stop(0)/continue(1) the input process is an invalid data value(s) 
tbd - Not used 
rec_id_buff_size - length of REC ID Buffer 
err_code_buff_size - length of Error Code Buffer 
err_msg_buff_size - length of Error Message Buffer 
rec_id_buff - buffer for returned REC ID 
err_codes_buff - buffer for returned Error Codes 
err_msg_buff - buffer for returned Error Messages 
status - returned status, 1 for success. 
See [[Commit API Reference Manual#Error Codes Description|Error Codes Description]] for other values.
|-
| '''CmtTerminateDbEngDll'''
|
| Close the connection to the database
|-
| '''CmtGetDescriptionByCode''' (code, desc_size, desc)
| message (char)
| Call this function in case of error in 
'''CmtInsUpdRec'''. 
In case of error (return code other than 1), 
you can use this to get error string.
|-
| '''CmtGetDescriptionByStatus'''
|
| Call this function in case of error in 
'''CmtInitDbEngDll'''
|}

'''Field buffers'''
The record to be added/updated in the database is passed to the Commit API in two buffers:
{| class="wikitable"
|-
! '''Parameter'''
! '''Description'''
! '''Example'''
|-
| data_buff
| String containing the values to insert into the Database. Separators between the fields are defined in the map_buff
| "17/04/2008 14:44", "CRD7C9KZPS9JN3LEZVD9", "Charge", "CRDGO0SVQ6074CMAN7DW","Closed","test note in DB Engine", "NTBL6PDPKUU6NXLRHLHP","CRDBSMJ3P72EHMU0HB LX","TKT4S81466E05IM8P23X"
|-
| map_buff
| Mapping of the data_buff: separators, field names.

Field names must be in the same order as the data_buff values.

The field names should be separated with a different separator than the values (e.g. "new line").
| " , FLDHISNOTEDATETIME 
FLDHISWORKERID 
FLDHISKIND 
FLDHISCONTACTID 
FLDHISUSER1 
FLDHISDESCRIPTION 
FLDHISRECID 
FLDHISCARDID 
FLDHISLINKRECID 
|}

====VB Sample====
To test the following VB code, create a VB program that includes this code and executes
it, or open the Visual Basic editor included with MS-Word, paste the code into it and run it.

In order for the VB sample to compile properly, please follow these steps:
#Go to My Computer > Right Click – Properties > Advanced Tab > Environment Variable
#At the bottom of the list, search for the Path variable (not PathText)
#Double click the Path variable > go to the end of the value/line
#Add ;
#Add the path to the folder: <server>\Commit\ThirdParty\UserDev\ and confirm.

For all field description see the [[API Reference Manual]].

Private Declare Sub CmtInitDbEngDll Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDbPath As String, ByRef xvStatus As Integer)

Private Declare Sub InitCommonControls Lib "comctl32.dll" ()

Private Declare Sub CmtInsUpdRec Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDataKind As Integer, _
ByVal xDataBuff As String, _
ByVal xMapBuff As String, _
ByVal xContWhenInvalidData As Integer, _
ByVal xFlags As Integer, _
ByVal xRecIDBuffLen As Integer, _
ByVal xLogErrCodesBuffLen As Integer, _
ByVal xLogErrMsgBuffLen As Integer, _
ByVal xvRecIDBuff As String, _
ByVal xvErrCodesLogBuff As String, _
ByVal xvErrMsgLogBuff As String, _
ByRef xvStatus As Integer)

Private Const C_DataBuffSize As Integer = 1024
Private Const C_MapBufSize As Integer = 1024
Private Const C_ErrMsgBuffSize As Integer = 1024
Private Const C_ErrCodeBuffSize As Integer = 64
Private Const C_RecIDBuffSize As Integer = 20
Private Const C_Flag As Integer = 1
Private Const C_Ok As Integer = 1
Private Const C_AccountsTable As Integer = 10

Private Const C_AppName As String = "Demo"

Public Sub DBEng()

Dim nStatus As Integer
Dim l As Long
Dim S As String
Dim pStr As Long
Dim MapBuff As String
Dim DataBuff As String
Dim RecIdBuff As String * C_RecIDBuffSize
Dim ErrCodesLogBuff As String * C_ErrCodeBuffSize
Dim ErrMsgLogBuff As String * C_ErrMsgBuffSize

Call CmtInitDbEngDll(C_AppName, "C:\DemoVBA\DB\", nStatus)

If nStatus = C_Ok Then

Rem ******************** Establishing connection with Commit, Should be
called only once for the entire session ******
MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDFULLNAME" + Chr(13) + "FLDCRDDEAR" +
Chr(13) + "FLDCRDCONTACT"
DataBuff = "'Bart De Hantsetters','De Hantsetters','Hantsetters'"

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)

If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

If nStatus = C_Ok Then
Rem ******************** Updating the Account record we've just created *******************

MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDDEAR" + Chr(13) + "FLDCRDRECID"
DataBuff = "'Doctor','" + RecIdBuff + "'"
ErrCodesBuff = ""
ErrMsgBuff = ""

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)
If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

Else
MsgBox ("Insert new Account. Error code: " + ErrCodesLogBuff)

End If
Else
MsgBox ("Commit Init failed. Error code: " + ErrCodesLogBuff)
End If

End Sub

====C++ Sample====
For all field description see the [[API Reference Manual]].

// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
const int C_DescSize = 1024;
char desc[C_DescSize];
char Delimiter[] = "\n";
int Code;
char* pch;
pch = strtok (ErrCodeBuff,Delimiter);
while (pch != NULL)
{
Code = atoi(pch);
CmtGetDescriptionByCode(Code, C_DescSize, desc);
printf ("%s\n",desc);
pch = strtok (NULL, Delimiter);
}
return 0;
}
int main(int argc, char* argv[])
{
const int C_DataBuffSize = 1024;
const int C_MapBufSize = 1024;
const int C_ErrMsgBuffSize = 1024;
const int C_ErrCodeBuffSize = 64;
const int C_RecIDBuffSize = 64;
const int C_Flag = 1;
const int C_Ok = 1;
const int C_AccountsTable = 10;
const int C_ExampleCode = 54000;
int Status;
char DataBuff[C_DataBuffSize] = "";
char MapBuff[C_MapBufSize] = "";
char RecIdBuff[C_RecIDBuffSize];
char ErrCodesBuff[C_ErrCodeBuffSize];
char ErrMsgBuff[C_ErrMsgBuffSize];
char* C_AppName = "Demo";

//* Establishing connection with CommitCRM, Should be called only once for the entire session **

CmtInitDbEngDll(C_AppName, // Your application name. This will be used for all functions of the
// package.
// Specify a meaningful value.
"C:\\Demo\\DB\\", //Path to the database folder where CommitCRM the server is
// installed <server>\Commit\Db
&Status); //Returned connection status

if (Status == C_Ok) {

//***Insert New Account into that Accounts table *******************
strcpy (DataBuff,"'Bart De Hantsetters','De Hantsetters','Hantsetters'");
strcat (MapBuff, "'\n,\nFLDCRDFULLNAME\nFLDCRDDEAR\nFLDCRDCONTACT");
strcat (RecIdBuff, "");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, //String for your selection.
C_AccountsTable, //Desired Table Code
DataBuff, //This string contains the values which we want to add to the database
MapBuff, //List of database fields where we want to add data
C_Flag,//Flag - stop(0) continue(1) the input process is data
//value(s) is invalid
0, //Not used
C_RecIDBuffSize, //Length of REC ID Buffer
C_ErrCodeBuffSize, //Length of Error Code Buffer
C_ErrMsgBuffSize, //Length of Error Message Buffer
RecIdBuff, //Buffer for returned REC ID
ErrCodesBuff, //Buffer for returned Error Codes
ErrMsgBuff, //Bufer for returned Error Messages
&Status //Returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if (Status == C_Ok) {

//***** Updating the Account record we've just created *************
strcpy (MapBuff, "'\n,\nFLDCRDDEAR\nFLDCRDRECID"); // Map file for the update
// transaction - the Dear field and the record id
strcpy (DataBuff,"'Doctor','");
strcat (DataBuff, RecIdBuff);
strcat (DataBuff, "'");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, // string for your selection.
C_AccountsTable, // Desired Table Code
DataBuff, // string contains the values, which we want to add into the Database
MapBuff, // list of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // length of RecID Buffer
C_ErrCodeBuffSize, // length of Error Code Buffer
C_ErrMsgBuffSize, // length of Error Message Buffer
RecIdBuff, // buffer for returned RecID
ErrCodesBuff, // buffer for returned Error Codes
ErrMsgBuff, // bufer for returned Error Messages
&Status // returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);
}
else
{
printf("Insert new Account. Error code: %d\n", Status);
};

//****Terminate connection with CommitCRM*******************
CmtTerminateDbEngDll();
}
else
{
printf("Commit Init failed. Error code: %d\n", Status);
};

return 0;
}

====Delphi Sample====
For all field description see the [[API Reference Manual]].

program Demo;

{$APPTYPE CONSOLE}

uses
SysUtils, Classes;
const
C_DataBuffSize = 1024;
C_MapBufSize = 1024;
C_ErrMsgBuffSize = 1024;
C_DescSize = 1024;
C_ErrCodeBuffSize = 64;
C_RecIDBuffSize = 64;

C_Flag = 1;
C_Ok = 1;
C_AccountsTable = 10;
C_AppName = 'Demo';

CmtDbEngDll = 'CmtDbEng.DLL';

var
Status: integer;
DataBuff: array [0..C_DataBuffSize] of Char;
MapBuff: array [0..C_MapBufSize] of Char;
RecIdBuff: array [0..C_RecIDBuffSize] of Char;
ErrCodesBuff: array [0..C_ErrCodeBuffSize] of Char;
ErrMsgBuff: array [0..C_ErrMsgBuffSize] of Char;
s: string;

//** Establishing connection with CommitCRM, Should be called only once for the entire session *
Procedure CmtInitDbEngDll (
xSoftWareName : PChar; // Your application name. Once selected this string
// will be used for all
// functions of the package. Specify a meaningful value.
xDbPath : PChar; // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db

var xvStatus : integer // Returned connection status
); stdcall; external CmtDbEngDll;

//**** Insert/Update record
Procedure CmtInsUpdRec(
xSoftWareName : pChar; // See above
xDataKind : integer; // Desired Table Code
xDataBuff : pChar; // String containing the values, which we want
// to add into the Database
xMapBuff : pChar; // List of the database fields into
//which we want to add data
xContWhenInvalidData : Integer; //Flag - stop(0)/continue(1) the input process
// is some data value(s) is invalid
xFlags : Integer; // Not used
xRecIDBuffLen : Integer; // Length of REC ID Buffer
xLogErrCodesBuffLen : Integer; // Length of Error Code Buffer
xLogErrMsgBuffLen : Integer; // Length of Error Message Buffer
xvRecIDBuff : pChar; // Buffer for returned REC ID
xvErrCodesLogBuff : pChar; // Buffer for returned Error Codes
xvErrMsgLogBuff : pChar; // Buffer for returned Error Messages
var xvStatus : Integer // Returned status
); stdcall; external CmtDbEngDll;

//**** Terminate connection with CommitCRM ****
procedure CmtTerminateDbEngDll; stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByCode(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByStatus(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure ErrCodesParsing (ErrCodeBuff: string);
var
lList: TStringList;
i: integer;
aDescErrCode : Pchar;
begin
try
lList := TStringList.Create;
lList.Text := ErrCodeBuff;
GetMem(aDescErrCode,C_DescSize);
for i := 0 to lList.Count - 1 do
begin
CmtGetDescriptionByCode(StrToInt(lList[i]), C_DescSize, aDescErrCode);
writeln('Error Code: '+lList[i]+' Desc: '+string(aDescErrCode));
end;
finally
FreeMem(aDescErrCode);
lList.Destroy;
end;
end;

procedure DisplayErrStatusCode(xCode : Integer);
var
aStatusErrCode : Pchar;
begin
try
GetMem(aStatusErrCode,C_DescSize);
CmtGetDescriptionByStatus(xCode,C_DescSize, aStatusErrCode);
writeln('Commit Init failed. Error code: '+Inttostr(xCode)+' Desc: '+string(aStatusErrCode));
finally
FreeMem(aStatusErrCode);
end;
end;

begin

//**** Establishing connection with CommitCRM, Should be called only once for the entire session
CmtInitDbEngDll(C_AppName, // Your application name. Once selected this string will be used
// for all functions of the package. Specify a meaningful value.
'C:\DemoDelphi\db\', // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db
Status // Returned connection status
);

if Status = C_Ok then
begin

//**** Insert a new Account into the Accounts table ****

s := '"Bart De Hantsetters","De Hantsetters","Hantsetters"';
StrPCopy(DataBuff, s);
s := '"'+#13','+#13+'FLDCRDFULLNAME'+#13+'FLDCRDDEAR'+#13+'FLDCRDCONTACT'+#0;
StrPCopy(MapBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want to add into
// the Database
MapBuff, // List of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Llength of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned REC ID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if (ErrMsgBuff[0] <> #0) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
begin
//**** Updating the Account record we've just created *****

// Map file for the update transaction - the Dear field and the record id
s := '"'+#13+','+#13+'FLDCRDDEAR'+#13'FLDCRDRECID';
StrPCopy(MapBuff, s);

s := '"Doctor","'+RecIdBuff+'"';
StrPCopy(DataBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want
// to add into the Database
MapBuff, // List of the database fields into which we want to add
//data
C_Flag, // Flag - stop(0)/continue(1) the input process is some
// data value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Length of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned RECID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if ((ErrMsgBuff[0] <> #0)) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
Writeln('Completed Successfully');
end
else
begin
try
s := IntToStr(Status);
except
s := 'ill-defined';
end;
writeln('Insert new Account. Error code: '+ s);
end;

//**** Terminate connection with CommitCRM****

CmtTerminateDbEngDll();
end
else
begin
DisplayErrStatusCode(Status);
end;

writeln(#13#10+'press Enter to quit');
readln;
end.

===XML samples===

Following are samples for adding a new Ticket and a new Charge to the Commit database using XML formatted messages.

Make sure to go over the [[Email Connector]] setup guide, and perform the XML API setup steps prior to testing the XML API.

Also please read [[Commit API Reference Manual|Using Commit API#Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

Notes on API by Email Activation:

*Error Handling - Should the system fail to perform the XML transaction, an error message will be sent to the email address specified in the XML.

*Using a Password - If you wish to use a verification password for the XML transactions, define the password using the ServerConfig.exe utility. To do so, go to the XML tab, enable the API by Email option and set a password (as specified in the XML - see [[Commit API Reference Manual#General XML Tokens|General XML Tokens]]). Make sure to set the same Password in ServerConfig and in the XML email itself.

You can read more about the ServerConfig and how to setup the API by Email configuration in the [[Email Connector|Commit Email Connector]] Setup guide.

====General XML Tokens====
The sample and table demonstrates general parameters which should be used for any XML transaction:

For all field description see the [[API Reference Manual]].

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
... the transaction goes here ...
</RecordData>
</CommitCRMTransaction>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMTransaction>
| Start and end transactions with this token (may have more than one in a single email)
|-
| <ExternalApplicationName>
| The sender application name, can contain any text
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <Password>
| Optional Password - Only emails with a password that matches the password set in the Email Connector Settings will be processed (to prevent SPAM email from being processed and added to your CommitCRM database).
|-
| <DataKind>
| What is the Entity you wish to create/update. 
Possible values: 
ACCOUNT - for Accounts 
TICKET - for Tickets 
CHARGE - for Charges 
ITEM - for Items 
APPOINTMENT-OR-TASK - for Appointments/Task 
HISTORY-NOTE - For History notes 
ASSET - for Assets 
OPPORTUNITY - for Sales Opportunities 
DOCUMENT - for Documents 
KBARTICLE - for Knowledge Base articles 
|}

====Adding new Ticket====

In this sample, we add a new Ticket, and set some additional fields to it, such as Notes, Source, Due Date and Dispatcher flag.

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
<FLDTKTCARDID> CUSTOMER-RECORD-ID-GOES-HERE-20-CHARS </FLDTKTCARDID>
<FLDTKTPROBLEM>ticket description...</FLDTKTPROBLEM>
<FLDTKTSTATUS>100</FLDTKTSTATUS>
<FLDTKTKIND>General</FLDTKTKIND>
<FLDTKTNOTES>Notes</FLDTKTNOTES>
<FLDTKTSOURCE>Source</FLDTKTSOURCE>
<FLDTKTSCHEDLENESTIM>60</FLDTKTSCHEDLENESTIM>
<FLDTKTDUEDATETIME>02/04/08</FLDTKTDUEDATETIME>
<FLDTKTFORDISPATCH>Y</FLDTKTFORDISPATCH>
</RecordData>
</CommitCRMTransaction>

====Adding new Charges====

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>Alert</ExternalApplicationName>
<SendResponseToEmail>your email address for responses</SendResponseToEmail>
<Password>12345</Password> >> Should be the same in the ServerConfig!
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>CHARGE</DataKind>
<RecordData>
<FLDSLPWORKERID> CRDLS71RGU747TLHTFOR </FLDSLPWORKERID>
<FLDSLPCARDID> CRDLQXDL43BP5YCMSGM3</FLDSLPCARDID>
<FLDSLPITEMID> ITM1Q3GUI05ANBQGVY8D </FLDSLPITEMID>
<FLDSLPDESC> Charge Description... </FLDSLPDESC>
<FLDSLPQUANTITY> 10 </FLDSLPQUANTITY>
<FLDSLPSLIPDATE> 31/01/2008 </FLDSLPSLIPDATE>
<FLDSLPSTARTTIME> 12:06 </FLDSLPSTARTTIME>
<FLDSLPENDTIME> 14:50 </FLDSLPENDTIME>
<FLDSLPBCRECID> BCTMA51KBA925J7G0V67 </FLDSLPBCRECID>
<FLDSLPPRICE> 125.3 </FLDSLPPRICE>
<FLDSLPADJUSTAMOUNT> 10 </FLDSLPADJUSTAMOUNT>
<FLDSLPUSER1> Field 1... </FLDSLPUSER1>
</RecordData>
</CommitCRMTransaction>

====Receiving Response====
When adding or updating data via the XML API, the system can send a response (if the
XML transaction specifies this in the SendResponseToEmail token). The format of the XML
response is as follow:

Response in case of success:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>SUCCESS</Status>
<AffectedRecId>TKTN1NIQEYYQ8PBJMDAX</AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
</CommitCRMResponse>

Response in case of error:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>FAILURE</Status>
<AffectedRecId></AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
<ResultCodes>50109</ResultCodes>
<ResultMessage>
Fields with illegal values: Operation canceled. Field: Account has invalid data -
TKTN1NIQEYYQ8PBJMDAX
</ResultMessage>
</CommitCRMResponse>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMResponse>
| The response starts and ends with this token
|-
| <Status>
| The transaction status. Possible values: FAILURE, SUCCESS
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <AffectedRecId>
| The REC ID of the entity which was added or updated when processing the transaction.
|-
|<ResultCodes> <ResultMessage>
|In case of a failure, this will contain the error code and description. You can find more information about error codes [[Commit API Reference Manual#Error Codes Description|here]].
|}

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

API Code Samples

2009-08-20T09:32:42Z

Yarden: /* Delphi Sample */

{{usermanualsapidevelopersguide}}
The Commit API allows you to add/update the following entities:
*Accounts
*Assets
*Tickets
*Charges
*Appointments
*Tasks
*History Notes
*Opportunities
*Documents
*Knowledge Base Articles

Each API method requires a list of parameters which contain the field names and their values. The field names are the Database field names. You can see each field's name within the application (so you can verify which field you are about to update), by right-clicking the field and selecting Field Settings > Advanced Tab > view the Tech. Rec ID field.

You can view the complete list of database fields in the [[Commit API Reference Manual#API Reference Manual|API Reference Manual]] above.

Following are samples for using the API by Email and the Programming API. The samples are basic and provide an easy starting point.

===Code samples===
The following code samples demonstrate how to add and update a record in CommitCRM from VBA, C++ or Delphi programs.

Make sure to read [[Commit API Reference Manual#Using Commit API|Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

To test samples, it is recommended that you download a trial version of CommitCRM from our web site and install it on a new computer that is not running CommitCRM. Then, modify the paths in the source code to point to folder <testcomputer>\Commit\LastVer (and to the same files it already points to).

When developing your programs please make sure you work under the <testcomputer>\Commit\ThirdParty\UserDev folder (or at least call the dlls in this location). Do not copy the dll’s to any other location.

These samples create a connection to CommitCRM's database, add a new Account record into
the database, and update it. Each transaction should specify the database table to be updated by the transaction:
{| class="wikitable"
|-
! '''Application entity'''
! '''Table name'''
! '''Code'''
|-
| Accounts
| Cards
| 10
|-
| Opportunities
| Opps
| 20
|-
| Documents
| Docs
| 30
|-
| Charges
| Docs
| 30
|-
| Charges
| Slips
| 40
|-
| Appointments/Tasks
| Events
| 50
|-
| History Notes
| Notebook
| 60
|-
| Tickets
| Tickets
| 70
|-
| Items
| Items
| 80
|-
| Assets
| Assets
| 90
|-
| Knowledge Base
| KBArticles
| 100
|}

====API functions====
The Programming API provides the following API functions:
{| class="wikitable"
|-
! '''Method'''
! '''Return Value'''
! '''Description'''
|-
| '''CmtInitDbEngDll (app_name, path, status)'''
| status (int)
| Establishes a connection to the database. app_name - This string will be used for all functions of the package, and will appear in the application as the user who performs the changes in the records you update. You should specify a meaningful value. path - The path to the DB folder where the Commit server is installed: <server>\Commit\Db status - 1 for success. See Error Codes Description for other values.
|-
| '''CmtInsUpdRec(data_buff, map_buff, flag, tbd, 
rec_id_buff_size, error_codes_buff_size, 
err_msg_buff_size,rec_id_buff, 
err_codes_buff, err_msg_buff, status)'''
| status (int), rec_id (char)
| Adds/Updates records. 
data_buff - string containing the values to insert into the Database 
map_buff - mapping of the database fields corresponding with the data buff 
flag - stop(0)/continue(1) the input process is an invalid data value(s) 
tbd - Not used 
rec_id_buff_size - length of REC ID Buffer 
err_code_buff_size - length of Error Code Buffer 
err_msg_buff_size - length of Error Message Buffer 
rec_id_buff - buffer for returned REC ID 
err_codes_buff - buffer for returned Error Codes 
err_msg_buff - buffer for returned Error Messages 
status - returned status, 1 for success. 
See [[Commit API Reference Manual#Error Codes Description|Error Codes Description]] for other values.
|-
| '''CmtTerminateDbEngDll'''
|
| Close the connection to the database
|-
| '''CmtGetDescriptionByCode''' (code, desc_size, desc)
| message (char)
| Call this function in case of error in 
'''CmtInsUpdRec'''. 
In case of error (return code other than 1), 
you can use this to get error string.
|-
| '''CmtGetDescriptionByStatus'''
|
| Call this function in case of error in 
'''CmtInitDbEngDll'''
|}

'''Field buffers'''
The record to be added/updated in the database is passed to the Commit API in two buffers:
{| class="wikitable"
|-
! '''Parameter'''
! '''Description'''
! '''Example'''
|-
| data_buff
| String containing the values to insert into the Database. Separators between the fields are defined in the map_buff
| "17/04/2008 14:44", "CRD7C9KZPS9JN3LEZVD9", "Charge", "CRDGO0SVQ6074CMAN7DW","Closed","test note in DB Engine", "NTBL6PDPKUU6NXLRHLHP","CRDBSMJ3P72EHMU0HB LX","TKT4S81466E05IM8P23X"
|-
| map_buff
| Mapping of the data_buff: separators, field names.

Field names must be in the same order as the data_buff values.

The field names should be separated with a different separator than the values (e.g. "new line").
| " , FLDHISNOTEDATETIME 
FLDHISWORKERID 
FLDHISKIND 
FLDHISCONTACTID 
FLDHISUSER1 
FLDHISDESCRIPTION 
FLDHISRECID 
FLDHISCARDID 
FLDHISLINKRECID 
|}

====VB Sample====
To test the following VB code, create a VB program that includes this code and executes
it, or open the Visual Basic editor included with MS-Word, paste the code into it and run it.

In order for the VB sample to compile properly, please follow these steps:
#Go to My Computer > Right Click – Properties > Advanced Tab > Environment Variable
#At the bottom of the list, search for the Path variable (not PathText)
#Double click the Path variable > go to the end of the value/line
#Add ;
#Add the path to the folder: <server>\Commit\ThirdParty\UserDev\ and confirm.

For all field description see the [[API Reference Manual]].

Private Declare Sub CmtInitDbEngDll Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDbPath As String, ByRef xvStatus As Integer)

Private Declare Sub InitCommonControls Lib "comctl32.dll" ()

Private Declare Sub CmtInsUpdRec Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDataKind As Integer, _
ByVal xDataBuff As String, _
ByVal xMapBuff As String, _
ByVal xContWhenInvalidData As Integer, _
ByVal xFlags As Integer, _
ByVal xRecIDBuffLen As Integer, _
ByVal xLogErrCodesBuffLen As Integer, _
ByVal xLogErrMsgBuffLen As Integer, _
ByVal xvRecIDBuff As String, _
ByVal xvErrCodesLogBuff As String, _
ByVal xvErrMsgLogBuff As String, _
ByRef xvStatus As Integer)

Private Const C_DataBuffSize As Integer = 1024
Private Const C_MapBufSize As Integer = 1024
Private Const C_ErrMsgBuffSize As Integer = 1024
Private Const C_ErrCodeBuffSize As Integer = 64
Private Const C_RecIDBuffSize As Integer = 20
Private Const C_Flag As Integer = 1
Private Const C_Ok As Integer = 1
Private Const C_AccountsTable As Integer = 10

Private Const C_AppName As String = "Demo"

Public Sub DBEng()

Dim nStatus As Integer
Dim l As Long
Dim S As String
Dim pStr As Long
Dim MapBuff As String
Dim DataBuff As String
Dim RecIdBuff As String * C_RecIDBuffSize
Dim ErrCodesLogBuff As String * C_ErrCodeBuffSize
Dim ErrMsgLogBuff As String * C_ErrMsgBuffSize

Call CmtInitDbEngDll(C_AppName, "C:\DemoVBA\DB\", nStatus)

If nStatus = C_Ok Then

Rem ******************** Establishing connection with Commit, Should be
called only once for the entire session ******
MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDFULLNAME" + Chr(13) + "FLDCRDDEAR" +
Chr(13) + "FLDCRDCONTACT"
DataBuff = "'Bart De Hantsetters','De Hantsetters','Hantsetters'"

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)

If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

If nStatus = C_Ok Then
Rem ******************** Updating the Account record we've just created *******************

MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDDEAR" + Chr(13) + "FLDCRDRECID"
DataBuff = "'Doctor','" + RecIdBuff + "'"
ErrCodesBuff = ""
ErrMsgBuff = ""

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)
If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

Else
MsgBox ("Insert new Account. Error code: " + ErrCodesLogBuff)

End If
Else
MsgBox ("Commit Init failed. Error code: " + ErrCodesLogBuff)
End If

End Sub

====C++ Sample====
For all field description see the [[API Reference Manual]].

// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
const int C_DescSize = 1024;
char desc[C_DescSize];
char Delimiter[] = "\n";
int Code;
char* pch;
pch = strtok (ErrCodeBuff,Delimiter);
while (pch != NULL)
{
Code = atoi(pch);
CmtGetDescriptionByCode(Code, C_DescSize, desc);
printf ("%s\n",desc);
pch = strtok (NULL, Delimiter);
}
return 0;
}
int main(int argc, char* argv[])
{
const int C_DataBuffSize = 1024;
const int C_MapBufSize = 1024;
const int C_ErrMsgBuffSize = 1024;
const int C_ErrCodeBuffSize = 64;
const int C_RecIDBuffSize = 64;
const int C_Flag = 1;
const int C_Ok = 1;
const int C_AccountsTable = 10;
const int C_ExampleCode = 54000;
int Status;
char DataBuff[C_DataBuffSize] = "";
char MapBuff[C_MapBufSize] = "";
char RecIdBuff[C_RecIDBuffSize];
char ErrCodesBuff[C_ErrCodeBuffSize];
char ErrMsgBuff[C_ErrMsgBuffSize];
char* C_AppName = "Demo";

//* Establishing connection with CommitCRM, Should be called only once for the entire session **

CmtInitDbEngDll(C_AppName, // Your application name. This will be used for all functions of the
// package.
// Specify a meaningful value.
"C:\\Demo\\DB\\", //Path to the database folder where CommitCRM the server is
// installed <server>\Commit\Db
&Status); //Returned connection status

if (Status == C_Ok) {

//***Insert New Account into that Accounts table *******************
strcpy (DataBuff,"'Bart De Hantsetters','De Hantsetters','Hantsetters'");
strcat (MapBuff, "'\n,\nFLDCRDFULLNAME\nFLDCRDDEAR\nFLDCRDCONTACT");
strcat (RecIdBuff, "");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, //String for your selection.
C_AccountsTable, //Desired Table Code
DataBuff, //This string contains the values which we want to add to the database
MapBuff, //List of database fields where we want to add data
C_Flag,//Flag - stop(0) continue(1) the input process is data
//value(s) is invalid
0, //Not used
C_RecIDBuffSize, //Length of REC ID Buffer
C_ErrCodeBuffSize, //Length of Error Code Buffer
C_ErrMsgBuffSize, //Length of Error Message Buffer
RecIdBuff, //Buffer for returned REC ID
ErrCodesBuff, //Buffer for returned Error Codes
ErrMsgBuff, //Bufer for returned Error Messages
&Status //Returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if (Status == C_Ok) {

//***** Updating the Account record we've just created *************
strcpy (MapBuff, "'\n,\nFLDCRDDEAR\nFLDCRDRECID"); // Map file for the update
// transaction - the Dear field and the record id
strcpy (DataBuff,"'Doctor','");
strcat (DataBuff, RecIdBuff);
strcat (DataBuff, "'");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, // string for your selection.
C_AccountsTable, // Desired Table Code
DataBuff, // string contains the values, which we want to add into the Database
MapBuff, // list of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // length of RecID Buffer
C_ErrCodeBuffSize, // length of Error Code Buffer
C_ErrMsgBuffSize, // length of Error Message Buffer
RecIdBuff, // buffer for returned RecID
ErrCodesBuff, // buffer for returned Error Codes
ErrMsgBuff, // bufer for returned Error Messages
&Status // returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);
}
else
{
printf("Insert new Account. Error code: %d\n", Status);
};

//****Terminate connection with CommitCRM*******************
CmtTerminateDbEngDll();
}
else
{
printf("Commit Init failed. Error code: %d\n", Status);
};

return 0;
}

====Delphi Sample====
For all field description see the [[API Reference Manual]].

program Demo;

{$APPTYPE CONSOLE}

uses
SysUtils, Classes;
const
C_DataBuffSize = 1024;
C_MapBufSize = 1024;
C_ErrMsgBuffSize = 1024;
C_DescSize = 1024;
C_ErrCodeBuffSize = 64;
C_RecIDBuffSize = 64;

C_Flag = 1;
C_Ok = 1;
C_AccountsTable = 10;
C_AppName = 'Demo';

CmtDbEngDll = 'CmtDbEng.DLL';

var
Status: integer;
DataBuff: array [0..C_DataBuffSize] of Char;
MapBuff: array [0..C_MapBufSize] of Char;
RecIdBuff: array [0..C_RecIDBuffSize] of Char;
ErrCodesBuff: array [0..C_ErrCodeBuffSize] of Char;
ErrMsgBuff: array [0..C_ErrMsgBuffSize] of Char;
s: string;

//** Establishing connection with CommitCRM, Should be called only once for the entire session *
Procedure CmtInitDbEngDll (
xSoftWareName : PChar; // Your application name. Once selected this string
// will be used for all
// functions of the package. Specify a meaningful value.
xDbPath : PChar; // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db

var xvStatus : integer // Returned connection status
); stdcall; external CmtDbEngDll;

//**** Insert/Update record
Procedure CmtInsUpdRec(
xSoftWareName : pChar; // See above
xDataKind : integer; // Desired Table Code
xDataBuff : pChar; // String containing the values, which we want
// to add into the Database
xMapBuff : pChar; // List of the database fields into
//which we want to add data
xContWhenInvalidData : Integer; //Flag - stop(0)/continue(1) the input process
// is some data value(s) is invalid
xFlags : Integer; // Not used
xRecIDBuffLen : Integer; // Length of REC ID Buffer
xLogErrCodesBuffLen : Integer; // Length of Error Code Buffer
xLogErrMsgBuffLen : Integer; // Length of Error Message Buffer
xvRecIDBuff : pChar; // Buffer for returned REC ID
xvErrCodesLogBuff : pChar; // Buffer for returned Error Codes
xvErrMsgLogBuff : pChar; // Buffer for returned Error Messages
var xvStatus : Integer // Returned status
); stdcall; external CmtDbEngDll;

//**** Terminate connection with CommitCRM ****
procedure CmtTerminateDbEngDll; stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByCode(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByStatus(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure ErrCodesParsing (ErrCodeBuff: string);
var
lList: TStringList;
i: integer;
aDescErrCode : Pchar;
begin
try
lList := TStringList.Create;
lList.Text := ErrCodeBuff;
GetMem(aDescErrCode,C_DescSize);
for i := 0 to lList.Count - 1 do
begin
CmtGetDescriptionByCode(StrToInt(lList[i]), C_DescSize, aDescErrCode);
writeln('Error Code: '+lList[i]+' Desc: '+string(aDescErrCode));
end;
finally
FreeMem(aDescErrCode);
lList.Destroy;
end;
end;

procedure DisplayErrStatusCode(xCode : Integer);
var
aStatusErrCode : Pchar;
begin
try
GetMem(aStatusErrCode,C_DescSize);
CmtGetDescriptionByStatus(xCode,C_DescSize, aStatusErrCode);
writeln('Commit Init failed. Error code: '+Inttostr(xCode)+' Desc: '+string(aStatusErrCode));
finally
FreeMem(aStatusErrCode);
end;
end;

begin

//**** Establishing connection with CommitCRM, Should be called only once for the entire session
CmtInitDbEngDll(C_AppName, // Your application name. Once selected this string will be used
// for all functions of the package. Specify a meaningful value.
'C:\DemoDelphi\db\', // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db
Status // Returned connection status
);

if Status = C_Ok then
begin

//**** Insert a new Account into the Accounts table ****

s := '"Bart De Hantsetters","De Hantsetters","Hantsetters"';
StrPCopy(DataBuff, s);
s := '"'+#13','+#13+'FLDCRDFULLNAME'+#13+'FLDCRDDEAR'+#13+'FLDCRDCONTACT'+#0;
StrPCopy(MapBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want to add into
// the Database
MapBuff, // List of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Llength of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned REC ID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if (ErrMsgBuff[0] <> #0) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
begin
//**** Updating the Account record we've just created *****

// Map file for the update transaction - the Dear field and the record id
s := '"'+#13+','+#13+'FLDCRDDEAR'+#13'FLDCRDRECID';
StrPCopy(MapBuff, s);

s := '"Doctor","'+RecIdBuff+'"';
StrPCopy(DataBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want
// to add into the Database
MapBuff, // List of the database fields into which we want to add
//data
C_Flag, // Flag - stop(0)/continue(1) the input process is some
// data value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Length of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned RECID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if ((ErrMsgBuff[0] <> #0)) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
Writeln('Completed Successfully');
end
else
begin
try
s := IntToStr(Status);
except
s := 'ill-defined';
end;
writeln('Insert new Account. Error code: '+ s);
end;

//**** Terminate connection with CommitCRM****

CmtTerminateDbEngDll();
end
else
begin
DisplayErrStatusCode(Status);
end;

writeln(#13#10+'press Enter to quit');
readln;
end.

===XML samples===

Following are samples for adding a new Ticket and a new Charge to the Commit database using XML formatted messages.

Make sure to go over the [[Email Connector]] setup guide, and perform the XML API setup steps prior to testing the XML API.

Also please read [[Commit API Reference Manual|Using Commit API#Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

Notes on API by Email Activation:

*Error Handling - Should the system fail to perform the XML transaction, an error message will be sent to the email address specified in the XML.

*Using a Password - If you wish to use a verification password for the XML transactions, define the password using the ServerConfig.exe utility. To do so, go to the XML tab, enable the API by Email option and set a password (as specified in the XML - see [[Commit API Reference Manual#General XML Tokens|General XML Tokens]]). Make sure to set the same Password in ServerConfig and in the XML email itself.

You can read more about the ServerConfig and how to setup the API by Email configuration in the [[Email Connector|Commit Email Connector]] Setup guide.

====General XML Tokens====
The sample and table demonstrates general parameters which should be used for any XML transaction:

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
... the transaction goes here ...
</RecordData>
</CommitCRMTransaction>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMTransaction>
| Start and end transactions with this token (may have more than one in a single email)
|-
| <ExternalApplicationName>
| The sender application name, can contain any text
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <Password>
| Optional Password - Only emails with a password that matches the password set in the Email Connector Settings will be processed (to prevent SPAM email from being processed and added to your CommitCRM database).
|-
| <DataKind>
| What is the Entity you wish to create/update. 
Possible values: 
ACCOUNT - for Accounts 
TICKET - for Tickets 
CHARGE - for Charges 
ITEM - for Items 
APPOINTMENT-OR-TASK - for Appointments/Task 
HISTORY-NOTE - For History notes 
ASSET - for Assets 
OPPORTUNITY - for Sales Opportunities 
DOCUMENT - for Documents 
KBARTICLE - for Knowledge Base articles 
|}

====Adding new Ticket====

In this sample, we add a new Ticket, and set some additional fields to it, such as Notes, Source, Due Date and Dispatcher flag.

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
<FLDTKTCARDID> CUSTOMER-RECORD-ID-GOES-HERE-20-CHARS </FLDTKTCARDID>
<FLDTKTPROBLEM>ticket description...</FLDTKTPROBLEM>
<FLDTKTSTATUS>100</FLDTKTSTATUS>
<FLDTKTKIND>General</FLDTKTKIND>
<FLDTKTNOTES>Notes</FLDTKTNOTES>
<FLDTKTSOURCE>Source</FLDTKTSOURCE>
<FLDTKTSCHEDLENESTIM>60</FLDTKTSCHEDLENESTIM>
<FLDTKTDUEDATETIME>02/04/08</FLDTKTDUEDATETIME>
<FLDTKTFORDISPATCH>Y</FLDTKTFORDISPATCH>
</RecordData>
</CommitCRMTransaction>

====Adding new Charges====

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>Alert</ExternalApplicationName>
<SendResponseToEmail>your email address for responses</SendResponseToEmail>
<Password>12345</Password> >> Should be the same in the ServerConfig!
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>CHARGE</DataKind>
<RecordData>
<FLDSLPWORKERID> CRDLS71RGU747TLHTFOR </FLDSLPWORKERID>
<FLDSLPCARDID> CRDLQXDL43BP5YCMSGM3</FLDSLPCARDID>
<FLDSLPITEMID> ITM1Q3GUI05ANBQGVY8D </FLDSLPITEMID>
<FLDSLPDESC> Charge Description... </FLDSLPDESC>
<FLDSLPQUANTITY> 10 </FLDSLPQUANTITY>
<FLDSLPSLIPDATE> 31/01/2008 </FLDSLPSLIPDATE>
<FLDSLPSTARTTIME> 12:06 </FLDSLPSTARTTIME>
<FLDSLPENDTIME> 14:50 </FLDSLPENDTIME>
<FLDSLPBCRECID> BCTMA51KBA925J7G0V67 </FLDSLPBCRECID>
<FLDSLPPRICE> 125.3 </FLDSLPPRICE>
<FLDSLPADJUSTAMOUNT> 10 </FLDSLPADJUSTAMOUNT>
<FLDSLPUSER1> Field 1... </FLDSLPUSER1>
</RecordData>
</CommitCRMTransaction>

====Receiving Response====
When adding or updating data via the XML API, the system can send a response (if the
XML transaction specifies this in the SendResponseToEmail token). The format of the XML
response is as follow:

Response in case of success:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>SUCCESS</Status>
<AffectedRecId>TKTN1NIQEYYQ8PBJMDAX</AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
</CommitCRMResponse>

Response in case of error:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>FAILURE</Status>
<AffectedRecId></AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
<ResultCodes>50109</ResultCodes>
<ResultMessage>
Fields with illegal values: Operation canceled. Field: Account has invalid data -
TKTN1NIQEYYQ8PBJMDAX
</ResultMessage>
</CommitCRMResponse>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMResponse>
| The response starts and ends with this token
|-
| <Status>
| The transaction status. Possible values: FAILURE, SUCCESS
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <AffectedRecId>
| The REC ID of the entity which was added or updated when processing the transaction.
|-
|<ResultCodes> <ResultMessage>
|In case of a failure, this will contain the error code and description. You can find more information about error codes [[Commit API Reference Manual#Error Codes Description|here]].
|}

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

API Code Samples

2009-08-20T09:31:52Z

Yarden: /* C++ Sample */

{{usermanualsapidevelopersguide}}
The Commit API allows you to add/update the following entities:
*Accounts
*Assets
*Tickets
*Charges
*Appointments
*Tasks
*History Notes
*Opportunities
*Documents
*Knowledge Base Articles

Each API method requires a list of parameters which contain the field names and their values. The field names are the Database field names. You can see each field's name within the application (so you can verify which field you are about to update), by right-clicking the field and selecting Field Settings > Advanced Tab > view the Tech. Rec ID field.

You can view the complete list of database fields in the [[Commit API Reference Manual#API Reference Manual|API Reference Manual]] above.

Following are samples for using the API by Email and the Programming API. The samples are basic and provide an easy starting point.

===Code samples===
The following code samples demonstrate how to add and update a record in CommitCRM from VBA, C++ or Delphi programs.

Make sure to read [[Commit API Reference Manual#Using Commit API|Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

To test samples, it is recommended that you download a trial version of CommitCRM from our web site and install it on a new computer that is not running CommitCRM. Then, modify the paths in the source code to point to folder <testcomputer>\Commit\LastVer (and to the same files it already points to).

When developing your programs please make sure you work under the <testcomputer>\Commit\ThirdParty\UserDev folder (or at least call the dlls in this location). Do not copy the dll’s to any other location.

These samples create a connection to CommitCRM's database, add a new Account record into
the database, and update it. Each transaction should specify the database table to be updated by the transaction:
{| class="wikitable"
|-
! '''Application entity'''
! '''Table name'''
! '''Code'''
|-
| Accounts
| Cards
| 10
|-
| Opportunities
| Opps
| 20
|-
| Documents
| Docs
| 30
|-
| Charges
| Docs
| 30
|-
| Charges
| Slips
| 40
|-
| Appointments/Tasks
| Events
| 50
|-
| History Notes
| Notebook
| 60
|-
| Tickets
| Tickets
| 70
|-
| Items
| Items
| 80
|-
| Assets
| Assets
| 90
|-
| Knowledge Base
| KBArticles
| 100
|}

====API functions====
The Programming API provides the following API functions:
{| class="wikitable"
|-
! '''Method'''
! '''Return Value'''
! '''Description'''
|-
| '''CmtInitDbEngDll (app_name, path, status)'''
| status (int)
| Establishes a connection to the database. app_name - This string will be used for all functions of the package, and will appear in the application as the user who performs the changes in the records you update. You should specify a meaningful value. path - The path to the DB folder where the Commit server is installed: <server>\Commit\Db status - 1 for success. See Error Codes Description for other values.
|-
| '''CmtInsUpdRec(data_buff, map_buff, flag, tbd, 
rec_id_buff_size, error_codes_buff_size, 
err_msg_buff_size,rec_id_buff, 
err_codes_buff, err_msg_buff, status)'''
| status (int), rec_id (char)
| Adds/Updates records. 
data_buff - string containing the values to insert into the Database 
map_buff - mapping of the database fields corresponding with the data buff 
flag - stop(0)/continue(1) the input process is an invalid data value(s) 
tbd - Not used 
rec_id_buff_size - length of REC ID Buffer 
err_code_buff_size - length of Error Code Buffer 
err_msg_buff_size - length of Error Message Buffer 
rec_id_buff - buffer for returned REC ID 
err_codes_buff - buffer for returned Error Codes 
err_msg_buff - buffer for returned Error Messages 
status - returned status, 1 for success. 
See [[Commit API Reference Manual#Error Codes Description|Error Codes Description]] for other values.
|-
| '''CmtTerminateDbEngDll'''
|
| Close the connection to the database
|-
| '''CmtGetDescriptionByCode''' (code, desc_size, desc)
| message (char)
| Call this function in case of error in 
'''CmtInsUpdRec'''. 
In case of error (return code other than 1), 
you can use this to get error string.
|-
| '''CmtGetDescriptionByStatus'''
|
| Call this function in case of error in 
'''CmtInitDbEngDll'''
|}

'''Field buffers'''
The record to be added/updated in the database is passed to the Commit API in two buffers:
{| class="wikitable"
|-
! '''Parameter'''
! '''Description'''
! '''Example'''
|-
| data_buff
| String containing the values to insert into the Database. Separators between the fields are defined in the map_buff
| "17/04/2008 14:44", "CRD7C9KZPS9JN3LEZVD9", "Charge", "CRDGO0SVQ6074CMAN7DW","Closed","test note in DB Engine", "NTBL6PDPKUU6NXLRHLHP","CRDBSMJ3P72EHMU0HB LX","TKT4S81466E05IM8P23X"
|-
| map_buff
| Mapping of the data_buff: separators, field names.

Field names must be in the same order as the data_buff values.

The field names should be separated with a different separator than the values (e.g. "new line").
| " , FLDHISNOTEDATETIME 
FLDHISWORKERID 
FLDHISKIND 
FLDHISCONTACTID 
FLDHISUSER1 
FLDHISDESCRIPTION 
FLDHISRECID 
FLDHISCARDID 
FLDHISLINKRECID 
|}

====VB Sample====
To test the following VB code, create a VB program that includes this code and executes
it, or open the Visual Basic editor included with MS-Word, paste the code into it and run it.

In order for the VB sample to compile properly, please follow these steps:
#Go to My Computer > Right Click – Properties > Advanced Tab > Environment Variable
#At the bottom of the list, search for the Path variable (not PathText)
#Double click the Path variable > go to the end of the value/line
#Add ;
#Add the path to the folder: <server>\Commit\ThirdParty\UserDev\ and confirm.

For all field description see the [[API Reference Manual]].

Private Declare Sub CmtInitDbEngDll Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDbPath As String, ByRef xvStatus As Integer)

Private Declare Sub InitCommonControls Lib "comctl32.dll" ()

Private Declare Sub CmtInsUpdRec Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDataKind As Integer, _
ByVal xDataBuff As String, _
ByVal xMapBuff As String, _
ByVal xContWhenInvalidData As Integer, _
ByVal xFlags As Integer, _
ByVal xRecIDBuffLen As Integer, _
ByVal xLogErrCodesBuffLen As Integer, _
ByVal xLogErrMsgBuffLen As Integer, _
ByVal xvRecIDBuff As String, _
ByVal xvErrCodesLogBuff As String, _
ByVal xvErrMsgLogBuff As String, _
ByRef xvStatus As Integer)

Private Const C_DataBuffSize As Integer = 1024
Private Const C_MapBufSize As Integer = 1024
Private Const C_ErrMsgBuffSize As Integer = 1024
Private Const C_ErrCodeBuffSize As Integer = 64
Private Const C_RecIDBuffSize As Integer = 20
Private Const C_Flag As Integer = 1
Private Const C_Ok As Integer = 1
Private Const C_AccountsTable As Integer = 10

Private Const C_AppName As String = "Demo"

Public Sub DBEng()

Dim nStatus As Integer
Dim l As Long
Dim S As String
Dim pStr As Long
Dim MapBuff As String
Dim DataBuff As String
Dim RecIdBuff As String * C_RecIDBuffSize
Dim ErrCodesLogBuff As String * C_ErrCodeBuffSize
Dim ErrMsgLogBuff As String * C_ErrMsgBuffSize

Call CmtInitDbEngDll(C_AppName, "C:\DemoVBA\DB\", nStatus)

If nStatus = C_Ok Then

Rem ******************** Establishing connection with Commit, Should be
called only once for the entire session ******
MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDFULLNAME" + Chr(13) + "FLDCRDDEAR" +
Chr(13) + "FLDCRDCONTACT"
DataBuff = "'Bart De Hantsetters','De Hantsetters','Hantsetters'"

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)

If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

If nStatus = C_Ok Then
Rem ******************** Updating the Account record we've just created *******************

MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDDEAR" + Chr(13) + "FLDCRDRECID"
DataBuff = "'Doctor','" + RecIdBuff + "'"
ErrCodesBuff = ""
ErrMsgBuff = ""

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)
If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

Else
MsgBox ("Insert new Account. Error code: " + ErrCodesLogBuff)

End If
Else
MsgBox ("Commit Init failed. Error code: " + ErrCodesLogBuff)
End If

End Sub

====C++ Sample====
For all field description see the [[API Reference Manual]].

// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
const int C_DescSize = 1024;
char desc[C_DescSize];
char Delimiter[] = "\n";
int Code;
char* pch;
pch = strtok (ErrCodeBuff,Delimiter);
while (pch != NULL)
{
Code = atoi(pch);
CmtGetDescriptionByCode(Code, C_DescSize, desc);
printf ("%s\n",desc);
pch = strtok (NULL, Delimiter);
}
return 0;
}
int main(int argc, char* argv[])
{
const int C_DataBuffSize = 1024;
const int C_MapBufSize = 1024;
const int C_ErrMsgBuffSize = 1024;
const int C_ErrCodeBuffSize = 64;
const int C_RecIDBuffSize = 64;
const int C_Flag = 1;
const int C_Ok = 1;
const int C_AccountsTable = 10;
const int C_ExampleCode = 54000;
int Status;
char DataBuff[C_DataBuffSize] = "";
char MapBuff[C_MapBufSize] = "";
char RecIdBuff[C_RecIDBuffSize];
char ErrCodesBuff[C_ErrCodeBuffSize];
char ErrMsgBuff[C_ErrMsgBuffSize];
char* C_AppName = "Demo";

//* Establishing connection with CommitCRM, Should be called only once for the entire session **

CmtInitDbEngDll(C_AppName, // Your application name. This will be used for all functions of the
// package.
// Specify a meaningful value.
"C:\\Demo\\DB\\", //Path to the database folder where CommitCRM the server is
// installed <server>\Commit\Db
&Status); //Returned connection status

if (Status == C_Ok) {

//***Insert New Account into that Accounts table *******************
strcpy (DataBuff,"'Bart De Hantsetters','De Hantsetters','Hantsetters'");
strcat (MapBuff, "'\n,\nFLDCRDFULLNAME\nFLDCRDDEAR\nFLDCRDCONTACT");
strcat (RecIdBuff, "");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, //String for your selection.
C_AccountsTable, //Desired Table Code
DataBuff, //This string contains the values which we want to add to the database
MapBuff, //List of database fields where we want to add data
C_Flag,//Flag - stop(0) continue(1) the input process is data
//value(s) is invalid
0, //Not used
C_RecIDBuffSize, //Length of REC ID Buffer
C_ErrCodeBuffSize, //Length of Error Code Buffer
C_ErrMsgBuffSize, //Length of Error Message Buffer
RecIdBuff, //Buffer for returned REC ID
ErrCodesBuff, //Buffer for returned Error Codes
ErrMsgBuff, //Bufer for returned Error Messages
&Status //Returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if (Status == C_Ok) {

//***** Updating the Account record we've just created *************
strcpy (MapBuff, "'\n,\nFLDCRDDEAR\nFLDCRDRECID"); // Map file for the update
// transaction - the Dear field and the record id
strcpy (DataBuff,"'Doctor','");
strcat (DataBuff, RecIdBuff);
strcat (DataBuff, "'");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, // string for your selection.
C_AccountsTable, // Desired Table Code
DataBuff, // string contains the values, which we want to add into the Database
MapBuff, // list of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // length of RecID Buffer
C_ErrCodeBuffSize, // length of Error Code Buffer
C_ErrMsgBuffSize, // length of Error Message Buffer
RecIdBuff, // buffer for returned RecID
ErrCodesBuff, // buffer for returned Error Codes
ErrMsgBuff, // bufer for returned Error Messages
&Status // returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);
}
else
{
printf("Insert new Account. Error code: %d\n", Status);
};

//****Terminate connection with CommitCRM*******************
CmtTerminateDbEngDll();
}
else
{
printf("Commit Init failed. Error code: %d\n", Status);
};

return 0;
}

====Delphi Sample====
program Demo;

{$APPTYPE CONSOLE}

uses
SysUtils, Classes;
const
C_DataBuffSize = 1024;
C_MapBufSize = 1024;
C_ErrMsgBuffSize = 1024;
C_DescSize = 1024;
C_ErrCodeBuffSize = 64;
C_RecIDBuffSize = 64;

C_Flag = 1;
C_Ok = 1;
C_AccountsTable = 10;
C_AppName = 'Demo';

CmtDbEngDll = 'CmtDbEng.DLL';

var
Status: integer;
DataBuff: array [0..C_DataBuffSize] of Char;
MapBuff: array [0..C_MapBufSize] of Char;
RecIdBuff: array [0..C_RecIDBuffSize] of Char;
ErrCodesBuff: array [0..C_ErrCodeBuffSize] of Char;
ErrMsgBuff: array [0..C_ErrMsgBuffSize] of Char;
s: string;

//** Establishing connection with CommitCRM, Should be called only once for the entire session *
Procedure CmtInitDbEngDll (
xSoftWareName : PChar; // Your application name. Once selected this string
// will be used for all
// functions of the package. Specify a meaningful value.
xDbPath : PChar; // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db

var xvStatus : integer // Returned connection status
); stdcall; external CmtDbEngDll;

//**** Insert/Update record
Procedure CmtInsUpdRec(
xSoftWareName : pChar; // See above
xDataKind : integer; // Desired Table Code
xDataBuff : pChar; // String containing the values, which we want
// to add into the Database
xMapBuff : pChar; // List of the database fields into
//which we want to add data
xContWhenInvalidData : Integer; //Flag - stop(0)/continue(1) the input process
// is some data value(s) is invalid
xFlags : Integer; // Not used
xRecIDBuffLen : Integer; // Length of REC ID Buffer
xLogErrCodesBuffLen : Integer; // Length of Error Code Buffer
xLogErrMsgBuffLen : Integer; // Length of Error Message Buffer
xvRecIDBuff : pChar; // Buffer for returned REC ID
xvErrCodesLogBuff : pChar; // Buffer for returned Error Codes
xvErrMsgLogBuff : pChar; // Buffer for returned Error Messages
var xvStatus : Integer // Returned status
); stdcall; external CmtDbEngDll;

//**** Terminate connection with CommitCRM ****
procedure CmtTerminateDbEngDll; stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByCode(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByStatus(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure ErrCodesParsing (ErrCodeBuff: string);
var
lList: TStringList;
i: integer;
aDescErrCode : Pchar;
begin
try
lList := TStringList.Create;
lList.Text := ErrCodeBuff;
GetMem(aDescErrCode,C_DescSize);
for i := 0 to lList.Count - 1 do
begin
CmtGetDescriptionByCode(StrToInt(lList[i]), C_DescSize, aDescErrCode);
writeln('Error Code: '+lList[i]+' Desc: '+string(aDescErrCode));
end;
finally
FreeMem(aDescErrCode);
lList.Destroy;
end;
end;

procedure DisplayErrStatusCode(xCode : Integer);
var
aStatusErrCode : Pchar;
begin
try
GetMem(aStatusErrCode,C_DescSize);
CmtGetDescriptionByStatus(xCode,C_DescSize, aStatusErrCode);
writeln('Commit Init failed. Error code: '+Inttostr(xCode)+' Desc: '+string(aStatusErrCode));
finally
FreeMem(aStatusErrCode);
end;
end;

begin

//**** Establishing connection with CommitCRM, Should be called only once for the entire session
CmtInitDbEngDll(C_AppName, // Your application name. Once selected this string will be used
// for all functions of the package. Specify a meaningful value.
'C:\DemoDelphi\db\', // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db
Status // Returned connection status
);

if Status = C_Ok then
begin

//**** Insert a new Account into the Accounts table ****

s := '"Bart De Hantsetters","De Hantsetters","Hantsetters"';
StrPCopy(DataBuff, s);
s := '"'+#13','+#13+'FLDCRDFULLNAME'+#13+'FLDCRDDEAR'+#13+'FLDCRDCONTACT'+#0;
StrPCopy(MapBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want to add into
// the Database
MapBuff, // List of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Llength of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned REC ID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if (ErrMsgBuff[0] <> #0) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
begin
//**** Updating the Account record we've just created *****

// Map file for the update transaction - the Dear field and the record id
s := '"'+#13+','+#13+'FLDCRDDEAR'+#13'FLDCRDRECID';
StrPCopy(MapBuff, s);

s := '"Doctor","'+RecIdBuff+'"';
StrPCopy(DataBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want
// to add into the Database
MapBuff, // List of the database fields into which we want to add
//data
C_Flag, // Flag - stop(0)/continue(1) the input process is some
// data value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Length of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned RECID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if ((ErrMsgBuff[0] <> #0)) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
Writeln('Completed Successfully');
end
else
begin
try
s := IntToStr(Status);
except
s := 'ill-defined';
end;
writeln('Insert new Account. Error code: '+ s);
end;

//**** Terminate connection with CommitCRM****

CmtTerminateDbEngDll();
end
else
begin
DisplayErrStatusCode(Status);
end;

writeln(#13#10+'press Enter to quit');
readln;
end.

===XML samples===

Following are samples for adding a new Ticket and a new Charge to the Commit database using XML formatted messages.

Make sure to go over the [[Email Connector]] setup guide, and perform the XML API setup steps prior to testing the XML API.

Also please read [[Commit API Reference Manual|Using Commit API#Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

Notes on API by Email Activation:

*Error Handling - Should the system fail to perform the XML transaction, an error message will be sent to the email address specified in the XML.

*Using a Password - If you wish to use a verification password for the XML transactions, define the password using the ServerConfig.exe utility. To do so, go to the XML tab, enable the API by Email option and set a password (as specified in the XML - see [[Commit API Reference Manual#General XML Tokens|General XML Tokens]]). Make sure to set the same Password in ServerConfig and in the XML email itself.

You can read more about the ServerConfig and how to setup the API by Email configuration in the [[Email Connector|Commit Email Connector]] Setup guide.

====General XML Tokens====
The sample and table demonstrates general parameters which should be used for any XML transaction:

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
... the transaction goes here ...
</RecordData>
</CommitCRMTransaction>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMTransaction>
| Start and end transactions with this token (may have more than one in a single email)
|-
| <ExternalApplicationName>
| The sender application name, can contain any text
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <Password>
| Optional Password - Only emails with a password that matches the password set in the Email Connector Settings will be processed (to prevent SPAM email from being processed and added to your CommitCRM database).
|-
| <DataKind>
| What is the Entity you wish to create/update. 
Possible values: 
ACCOUNT - for Accounts 
TICKET - for Tickets 
CHARGE - for Charges 
ITEM - for Items 
APPOINTMENT-OR-TASK - for Appointments/Task 
HISTORY-NOTE - For History notes 
ASSET - for Assets 
OPPORTUNITY - for Sales Opportunities 
DOCUMENT - for Documents 
KBARTICLE - for Knowledge Base articles 
|}

====Adding new Ticket====

In this sample, we add a new Ticket, and set some additional fields to it, such as Notes, Source, Due Date and Dispatcher flag.

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
<FLDTKTCARDID> CUSTOMER-RECORD-ID-GOES-HERE-20-CHARS </FLDTKTCARDID>
<FLDTKTPROBLEM>ticket description...</FLDTKTPROBLEM>
<FLDTKTSTATUS>100</FLDTKTSTATUS>
<FLDTKTKIND>General</FLDTKTKIND>
<FLDTKTNOTES>Notes</FLDTKTNOTES>
<FLDTKTSOURCE>Source</FLDTKTSOURCE>
<FLDTKTSCHEDLENESTIM>60</FLDTKTSCHEDLENESTIM>
<FLDTKTDUEDATETIME>02/04/08</FLDTKTDUEDATETIME>
<FLDTKTFORDISPATCH>Y</FLDTKTFORDISPATCH>
</RecordData>
</CommitCRMTransaction>

====Adding new Charges====

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>Alert</ExternalApplicationName>
<SendResponseToEmail>your email address for responses</SendResponseToEmail>
<Password>12345</Password> >> Should be the same in the ServerConfig!
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>CHARGE</DataKind>
<RecordData>
<FLDSLPWORKERID> CRDLS71RGU747TLHTFOR </FLDSLPWORKERID>
<FLDSLPCARDID> CRDLQXDL43BP5YCMSGM3</FLDSLPCARDID>
<FLDSLPITEMID> ITM1Q3GUI05ANBQGVY8D </FLDSLPITEMID>
<FLDSLPDESC> Charge Description... </FLDSLPDESC>
<FLDSLPQUANTITY> 10 </FLDSLPQUANTITY>
<FLDSLPSLIPDATE> 31/01/2008 </FLDSLPSLIPDATE>
<FLDSLPSTARTTIME> 12:06 </FLDSLPSTARTTIME>
<FLDSLPENDTIME> 14:50 </FLDSLPENDTIME>
<FLDSLPBCRECID> BCTMA51KBA925J7G0V67 </FLDSLPBCRECID>
<FLDSLPPRICE> 125.3 </FLDSLPPRICE>
<FLDSLPADJUSTAMOUNT> 10 </FLDSLPADJUSTAMOUNT>
<FLDSLPUSER1> Field 1... </FLDSLPUSER1>
</RecordData>
</CommitCRMTransaction>

====Receiving Response====
When adding or updating data via the XML API, the system can send a response (if the
XML transaction specifies this in the SendResponseToEmail token). The format of the XML
response is as follow:

Response in case of success:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>SUCCESS</Status>
<AffectedRecId>TKTN1NIQEYYQ8PBJMDAX</AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
</CommitCRMResponse>

Response in case of error:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>FAILURE</Status>
<AffectedRecId></AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
<ResultCodes>50109</ResultCodes>
<ResultMessage>
Fields with illegal values: Operation canceled. Field: Account has invalid data -
TKTN1NIQEYYQ8PBJMDAX
</ResultMessage>
</CommitCRMResponse>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMResponse>
| The response starts and ends with this token
|-
| <Status>
| The transaction status. Possible values: FAILURE, SUCCESS
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <AffectedRecId>
| The REC ID of the entity which was added or updated when processing the transaction.
|-
|<ResultCodes> <ResultMessage>
|In case of a failure, this will contain the error code and description. You can find more information about error codes [[Commit API Reference Manual#Error Codes Description|here]].
|}

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

API Code Samples

2009-08-20T09:31:13Z

Yarden: /* VB Sample */

{{usermanualsapidevelopersguide}}
The Commit API allows you to add/update the following entities:
*Accounts
*Assets
*Tickets
*Charges
*Appointments
*Tasks
*History Notes
*Opportunities
*Documents
*Knowledge Base Articles

Each API method requires a list of parameters which contain the field names and their values. The field names are the Database field names. You can see each field's name within the application (so you can verify which field you are about to update), by right-clicking the field and selecting Field Settings > Advanced Tab > view the Tech. Rec ID field.

You can view the complete list of database fields in the [[Commit API Reference Manual#API Reference Manual|API Reference Manual]] above.

Following are samples for using the API by Email and the Programming API. The samples are basic and provide an easy starting point.

===Code samples===
The following code samples demonstrate how to add and update a record in CommitCRM from VBA, C++ or Delphi programs.

Make sure to read [[Commit API Reference Manual#Using Commit API|Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

To test samples, it is recommended that you download a trial version of CommitCRM from our web site and install it on a new computer that is not running CommitCRM. Then, modify the paths in the source code to point to folder <testcomputer>\Commit\LastVer (and to the same files it already points to).

When developing your programs please make sure you work under the <testcomputer>\Commit\ThirdParty\UserDev folder (or at least call the dlls in this location). Do not copy the dll’s to any other location.

These samples create a connection to CommitCRM's database, add a new Account record into
the database, and update it. Each transaction should specify the database table to be updated by the transaction:
{| class="wikitable"
|-
! '''Application entity'''
! '''Table name'''
! '''Code'''
|-
| Accounts
| Cards
| 10
|-
| Opportunities
| Opps
| 20
|-
| Documents
| Docs
| 30
|-
| Charges
| Docs
| 30
|-
| Charges
| Slips
| 40
|-
| Appointments/Tasks
| Events
| 50
|-
| History Notes
| Notebook
| 60
|-
| Tickets
| Tickets
| 70
|-
| Items
| Items
| 80
|-
| Assets
| Assets
| 90
|-
| Knowledge Base
| KBArticles
| 100
|}

====API functions====
The Programming API provides the following API functions:
{| class="wikitable"
|-
! '''Method'''
! '''Return Value'''
! '''Description'''
|-
| '''CmtInitDbEngDll (app_name, path, status)'''
| status (int)
| Establishes a connection to the database. app_name - This string will be used for all functions of the package, and will appear in the application as the user who performs the changes in the records you update. You should specify a meaningful value. path - The path to the DB folder where the Commit server is installed: <server>\Commit\Db status - 1 for success. See Error Codes Description for other values.
|-
| '''CmtInsUpdRec(data_buff, map_buff, flag, tbd, 
rec_id_buff_size, error_codes_buff_size, 
err_msg_buff_size,rec_id_buff, 
err_codes_buff, err_msg_buff, status)'''
| status (int), rec_id (char)
| Adds/Updates records. 
data_buff - string containing the values to insert into the Database 
map_buff - mapping of the database fields corresponding with the data buff 
flag - stop(0)/continue(1) the input process is an invalid data value(s) 
tbd - Not used 
rec_id_buff_size - length of REC ID Buffer 
err_code_buff_size - length of Error Code Buffer 
err_msg_buff_size - length of Error Message Buffer 
rec_id_buff - buffer for returned REC ID 
err_codes_buff - buffer for returned Error Codes 
err_msg_buff - buffer for returned Error Messages 
status - returned status, 1 for success. 
See [[Commit API Reference Manual#Error Codes Description|Error Codes Description]] for other values.
|-
| '''CmtTerminateDbEngDll'''
|
| Close the connection to the database
|-
| '''CmtGetDescriptionByCode''' (code, desc_size, desc)
| message (char)
| Call this function in case of error in 
'''CmtInsUpdRec'''. 
In case of error (return code other than 1), 
you can use this to get error string.
|-
| '''CmtGetDescriptionByStatus'''
|
| Call this function in case of error in 
'''CmtInitDbEngDll'''
|}

'''Field buffers'''
The record to be added/updated in the database is passed to the Commit API in two buffers:
{| class="wikitable"
|-
! '''Parameter'''
! '''Description'''
! '''Example'''
|-
| data_buff
| String containing the values to insert into the Database. Separators between the fields are defined in the map_buff
| "17/04/2008 14:44", "CRD7C9KZPS9JN3LEZVD9", "Charge", "CRDGO0SVQ6074CMAN7DW","Closed","test note in DB Engine", "NTBL6PDPKUU6NXLRHLHP","CRDBSMJ3P72EHMU0HB LX","TKT4S81466E05IM8P23X"
|-
| map_buff
| Mapping of the data_buff: separators, field names.

Field names must be in the same order as the data_buff values.

The field names should be separated with a different separator than the values (e.g. "new line").
| " , FLDHISNOTEDATETIME 
FLDHISWORKERID 
FLDHISKIND 
FLDHISCONTACTID 
FLDHISUSER1 
FLDHISDESCRIPTION 
FLDHISRECID 
FLDHISCARDID 
FLDHISLINKRECID 
|}

====VB Sample====
To test the following VB code, create a VB program that includes this code and executes
it, or open the Visual Basic editor included with MS-Word, paste the code into it and run it.

In order for the VB sample to compile properly, please follow these steps:
#Go to My Computer > Right Click – Properties > Advanced Tab > Environment Variable
#At the bottom of the list, search for the Path variable (not PathText)
#Double click the Path variable > go to the end of the value/line
#Add ;
#Add the path to the folder: <server>\Commit\ThirdParty\UserDev\ and confirm.

For all field description see the [[API Reference Manual]].

Private Declare Sub CmtInitDbEngDll Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDbPath As String, ByRef xvStatus As Integer)

Private Declare Sub InitCommonControls Lib "comctl32.dll" ()

Private Declare Sub CmtInsUpdRec Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDataKind As Integer, _
ByVal xDataBuff As String, _
ByVal xMapBuff As String, _
ByVal xContWhenInvalidData As Integer, _
ByVal xFlags As Integer, _
ByVal xRecIDBuffLen As Integer, _
ByVal xLogErrCodesBuffLen As Integer, _
ByVal xLogErrMsgBuffLen As Integer, _
ByVal xvRecIDBuff As String, _
ByVal xvErrCodesLogBuff As String, _
ByVal xvErrMsgLogBuff As String, _
ByRef xvStatus As Integer)

Private Const C_DataBuffSize As Integer = 1024
Private Const C_MapBufSize As Integer = 1024
Private Const C_ErrMsgBuffSize As Integer = 1024
Private Const C_ErrCodeBuffSize As Integer = 64
Private Const C_RecIDBuffSize As Integer = 20
Private Const C_Flag As Integer = 1
Private Const C_Ok As Integer = 1
Private Const C_AccountsTable As Integer = 10

Private Const C_AppName As String = "Demo"

Public Sub DBEng()

Dim nStatus As Integer
Dim l As Long
Dim S As String
Dim pStr As Long
Dim MapBuff As String
Dim DataBuff As String
Dim RecIdBuff As String * C_RecIDBuffSize
Dim ErrCodesLogBuff As String * C_ErrCodeBuffSize
Dim ErrMsgLogBuff As String * C_ErrMsgBuffSize

Call CmtInitDbEngDll(C_AppName, "C:\DemoVBA\DB\", nStatus)

If nStatus = C_Ok Then

Rem ******************** Establishing connection with Commit, Should be
called only once for the entire session ******
MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDFULLNAME" + Chr(13) + "FLDCRDDEAR" +
Chr(13) + "FLDCRDCONTACT"
DataBuff = "'Bart De Hantsetters','De Hantsetters','Hantsetters'"

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)

If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

If nStatus = C_Ok Then
Rem ******************** Updating the Account record we've just created *******************

MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDDEAR" + Chr(13) + "FLDCRDRECID"
DataBuff = "'Doctor','" + RecIdBuff + "'"
ErrCodesBuff = ""
ErrMsgBuff = ""

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)
If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

Else
MsgBox ("Insert new Account. Error code: " + ErrCodesLogBuff)

End If
Else
MsgBox ("Commit Init failed. Error code: " + ErrCodesLogBuff)
End If

End Sub

====C++ Sample====

// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
const int C_DescSize = 1024;
char desc[C_DescSize];
char Delimiter[] = "\n";
int Code;
char* pch;
pch = strtok (ErrCodeBuff,Delimiter);
while (pch != NULL)
{
Code = atoi(pch);
CmtGetDescriptionByCode(Code, C_DescSize, desc);
printf ("%s\n",desc);
pch = strtok (NULL, Delimiter);
}
return 0;
}
int main(int argc, char* argv[])
{
const int C_DataBuffSize = 1024;
const int C_MapBufSize = 1024;
const int C_ErrMsgBuffSize = 1024;
const int C_ErrCodeBuffSize = 64;
const int C_RecIDBuffSize = 64;
const int C_Flag = 1;
const int C_Ok = 1;
const int C_AccountsTable = 10;
const int C_ExampleCode = 54000;
int Status;
char DataBuff[C_DataBuffSize] = "";
char MapBuff[C_MapBufSize] = "";
char RecIdBuff[C_RecIDBuffSize];
char ErrCodesBuff[C_ErrCodeBuffSize];
char ErrMsgBuff[C_ErrMsgBuffSize];
char* C_AppName = "Demo";

//* Establishing connection with CommitCRM, Should be called only once for the entire session **

CmtInitDbEngDll(C_AppName, // Your application name. This will be used for all functions of the
// package.
// Specify a meaningful value.
"C:\\Demo\\DB\\", //Path to the database folder where CommitCRM the server is
// installed <server>\Commit\Db
&Status); //Returned connection status

if (Status == C_Ok) {

//***Insert New Account into that Accounts table *******************
strcpy (DataBuff,"'Bart De Hantsetters','De Hantsetters','Hantsetters'");
strcat (MapBuff, "'\n,\nFLDCRDFULLNAME\nFLDCRDDEAR\nFLDCRDCONTACT");
strcat (RecIdBuff, "");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, //String for your selection.
C_AccountsTable, //Desired Table Code
DataBuff, //This string contains the values which we want to add to the database
MapBuff, //List of database fields where we want to add data
C_Flag,//Flag - stop(0) continue(1) the input process is data
//value(s) is invalid
0, //Not used
C_RecIDBuffSize, //Length of REC ID Buffer
C_ErrCodeBuffSize, //Length of Error Code Buffer
C_ErrMsgBuffSize, //Length of Error Message Buffer
RecIdBuff, //Buffer for returned REC ID
ErrCodesBuff, //Buffer for returned Error Codes
ErrMsgBuff, //Bufer for returned Error Messages
&Status //Returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if (Status == C_Ok) {

//***** Updating the Account record we've just created *************
strcpy (MapBuff, "'\n,\nFLDCRDDEAR\nFLDCRDRECID"); // Map file for the update
// transaction - the Dear field and the record id
strcpy (DataBuff,"'Doctor','");
strcat (DataBuff, RecIdBuff);
strcat (DataBuff, "'");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, // string for your selection.
C_AccountsTable, // Desired Table Code
DataBuff, // string contains the values, which we want to add into the Database
MapBuff, // list of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // length of RecID Buffer
C_ErrCodeBuffSize, // length of Error Code Buffer
C_ErrMsgBuffSize, // length of Error Message Buffer
RecIdBuff, // buffer for returned RecID
ErrCodesBuff, // buffer for returned Error Codes
ErrMsgBuff, // bufer for returned Error Messages
&Status // returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);
}
else
{
printf("Insert new Account. Error code: %d\n", Status);
};

//****Terminate connection with CommitCRM*******************
CmtTerminateDbEngDll();
}
else
{
printf("Commit Init failed. Error code: %d\n", Status);
};

return 0;
}

====Delphi Sample====
program Demo;

{$APPTYPE CONSOLE}

uses
SysUtils, Classes;
const
C_DataBuffSize = 1024;
C_MapBufSize = 1024;
C_ErrMsgBuffSize = 1024;
C_DescSize = 1024;
C_ErrCodeBuffSize = 64;
C_RecIDBuffSize = 64;

C_Flag = 1;
C_Ok = 1;
C_AccountsTable = 10;
C_AppName = 'Demo';

CmtDbEngDll = 'CmtDbEng.DLL';

var
Status: integer;
DataBuff: array [0..C_DataBuffSize] of Char;
MapBuff: array [0..C_MapBufSize] of Char;
RecIdBuff: array [0..C_RecIDBuffSize] of Char;
ErrCodesBuff: array [0..C_ErrCodeBuffSize] of Char;
ErrMsgBuff: array [0..C_ErrMsgBuffSize] of Char;
s: string;

//** Establishing connection with CommitCRM, Should be called only once for the entire session *
Procedure CmtInitDbEngDll (
xSoftWareName : PChar; // Your application name. Once selected this string
// will be used for all
// functions of the package. Specify a meaningful value.
xDbPath : PChar; // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db

var xvStatus : integer // Returned connection status
); stdcall; external CmtDbEngDll;

//**** Insert/Update record
Procedure CmtInsUpdRec(
xSoftWareName : pChar; // See above
xDataKind : integer; // Desired Table Code
xDataBuff : pChar; // String containing the values, which we want
// to add into the Database
xMapBuff : pChar; // List of the database fields into
//which we want to add data
xContWhenInvalidData : Integer; //Flag - stop(0)/continue(1) the input process
// is some data value(s) is invalid
xFlags : Integer; // Not used
xRecIDBuffLen : Integer; // Length of REC ID Buffer
xLogErrCodesBuffLen : Integer; // Length of Error Code Buffer
xLogErrMsgBuffLen : Integer; // Length of Error Message Buffer
xvRecIDBuff : pChar; // Buffer for returned REC ID
xvErrCodesLogBuff : pChar; // Buffer for returned Error Codes
xvErrMsgLogBuff : pChar; // Buffer for returned Error Messages
var xvStatus : Integer // Returned status
); stdcall; external CmtDbEngDll;

//**** Terminate connection with CommitCRM ****
procedure CmtTerminateDbEngDll; stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByCode(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByStatus(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure ErrCodesParsing (ErrCodeBuff: string);
var
lList: TStringList;
i: integer;
aDescErrCode : Pchar;
begin
try
lList := TStringList.Create;
lList.Text := ErrCodeBuff;
GetMem(aDescErrCode,C_DescSize);
for i := 0 to lList.Count - 1 do
begin
CmtGetDescriptionByCode(StrToInt(lList[i]), C_DescSize, aDescErrCode);
writeln('Error Code: '+lList[i]+' Desc: '+string(aDescErrCode));
end;
finally
FreeMem(aDescErrCode);
lList.Destroy;
end;
end;

procedure DisplayErrStatusCode(xCode : Integer);
var
aStatusErrCode : Pchar;
begin
try
GetMem(aStatusErrCode,C_DescSize);
CmtGetDescriptionByStatus(xCode,C_DescSize, aStatusErrCode);
writeln('Commit Init failed. Error code: '+Inttostr(xCode)+' Desc: '+string(aStatusErrCode));
finally
FreeMem(aStatusErrCode);
end;
end;

begin

//**** Establishing connection with CommitCRM, Should be called only once for the entire session
CmtInitDbEngDll(C_AppName, // Your application name. Once selected this string will be used
// for all functions of the package. Specify a meaningful value.
'C:\DemoDelphi\db\', // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db
Status // Returned connection status
);

if Status = C_Ok then
begin

//**** Insert a new Account into the Accounts table ****

s := '"Bart De Hantsetters","De Hantsetters","Hantsetters"';
StrPCopy(DataBuff, s);
s := '"'+#13','+#13+'FLDCRDFULLNAME'+#13+'FLDCRDDEAR'+#13+'FLDCRDCONTACT'+#0;
StrPCopy(MapBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want to add into
// the Database
MapBuff, // List of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Llength of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned REC ID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if (ErrMsgBuff[0] <> #0) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
begin
//**** Updating the Account record we've just created *****

// Map file for the update transaction - the Dear field and the record id
s := '"'+#13+','+#13+'FLDCRDDEAR'+#13'FLDCRDRECID';
StrPCopy(MapBuff, s);

s := '"Doctor","'+RecIdBuff+'"';
StrPCopy(DataBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want
// to add into the Database
MapBuff, // List of the database fields into which we want to add
//data
C_Flag, // Flag - stop(0)/continue(1) the input process is some
// data value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Length of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned RECID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if ((ErrMsgBuff[0] <> #0)) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
Writeln('Completed Successfully');
end
else
begin
try
s := IntToStr(Status);
except
s := 'ill-defined';
end;
writeln('Insert new Account. Error code: '+ s);
end;

//**** Terminate connection with CommitCRM****

CmtTerminateDbEngDll();
end
else
begin
DisplayErrStatusCode(Status);
end;

writeln(#13#10+'press Enter to quit');
readln;
end.

===XML samples===

Following are samples for adding a new Ticket and a new Charge to the Commit database using XML formatted messages.

Make sure to go over the [[Email Connector]] setup guide, and perform the XML API setup steps prior to testing the XML API.

Also please read [[Commit API Reference Manual|Using Commit API#Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

Notes on API by Email Activation:

*Error Handling - Should the system fail to perform the XML transaction, an error message will be sent to the email address specified in the XML.

*Using a Password - If you wish to use a verification password for the XML transactions, define the password using the ServerConfig.exe utility. To do so, go to the XML tab, enable the API by Email option and set a password (as specified in the XML - see [[Commit API Reference Manual#General XML Tokens|General XML Tokens]]). Make sure to set the same Password in ServerConfig and in the XML email itself.

You can read more about the ServerConfig and how to setup the API by Email configuration in the [[Email Connector|Commit Email Connector]] Setup guide.

====General XML Tokens====
The sample and table demonstrates general parameters which should be used for any XML transaction:

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
... the transaction goes here ...
</RecordData>
</CommitCRMTransaction>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMTransaction>
| Start and end transactions with this token (may have more than one in a single email)
|-
| <ExternalApplicationName>
| The sender application name, can contain any text
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <Password>
| Optional Password - Only emails with a password that matches the password set in the Email Connector Settings will be processed (to prevent SPAM email from being processed and added to your CommitCRM database).
|-
| <DataKind>
| What is the Entity you wish to create/update. 
Possible values: 
ACCOUNT - for Accounts 
TICKET - for Tickets 
CHARGE - for Charges 
ITEM - for Items 
APPOINTMENT-OR-TASK - for Appointments/Task 
HISTORY-NOTE - For History notes 
ASSET - for Assets 
OPPORTUNITY - for Sales Opportunities 
DOCUMENT - for Documents 
KBARTICLE - for Knowledge Base articles 
|}

====Adding new Ticket====

In this sample, we add a new Ticket, and set some additional fields to it, such as Notes, Source, Due Date and Dispatcher flag.

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
<FLDTKTCARDID> CUSTOMER-RECORD-ID-GOES-HERE-20-CHARS </FLDTKTCARDID>
<FLDTKTPROBLEM>ticket description...</FLDTKTPROBLEM>
<FLDTKTSTATUS>100</FLDTKTSTATUS>
<FLDTKTKIND>General</FLDTKTKIND>
<FLDTKTNOTES>Notes</FLDTKTNOTES>
<FLDTKTSOURCE>Source</FLDTKTSOURCE>
<FLDTKTSCHEDLENESTIM>60</FLDTKTSCHEDLENESTIM>
<FLDTKTDUEDATETIME>02/04/08</FLDTKTDUEDATETIME>
<FLDTKTFORDISPATCH>Y</FLDTKTFORDISPATCH>
</RecordData>
</CommitCRMTransaction>

====Adding new Charges====

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>Alert</ExternalApplicationName>
<SendResponseToEmail>your email address for responses</SendResponseToEmail>
<Password>12345</Password> >> Should be the same in the ServerConfig!
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>CHARGE</DataKind>
<RecordData>
<FLDSLPWORKERID> CRDLS71RGU747TLHTFOR </FLDSLPWORKERID>
<FLDSLPCARDID> CRDLQXDL43BP5YCMSGM3</FLDSLPCARDID>
<FLDSLPITEMID> ITM1Q3GUI05ANBQGVY8D </FLDSLPITEMID>
<FLDSLPDESC> Charge Description... </FLDSLPDESC>
<FLDSLPQUANTITY> 10 </FLDSLPQUANTITY>
<FLDSLPSLIPDATE> 31/01/2008 </FLDSLPSLIPDATE>
<FLDSLPSTARTTIME> 12:06 </FLDSLPSTARTTIME>
<FLDSLPENDTIME> 14:50 </FLDSLPENDTIME>
<FLDSLPBCRECID> BCTMA51KBA925J7G0V67 </FLDSLPBCRECID>
<FLDSLPPRICE> 125.3 </FLDSLPPRICE>
<FLDSLPADJUSTAMOUNT> 10 </FLDSLPADJUSTAMOUNT>
<FLDSLPUSER1> Field 1... </FLDSLPUSER1>
</RecordData>
</CommitCRMTransaction>

====Receiving Response====
When adding or updating data via the XML API, the system can send a response (if the
XML transaction specifies this in the SendResponseToEmail token). The format of the XML
response is as follow:

Response in case of success:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>SUCCESS</Status>
<AffectedRecId>TKTN1NIQEYYQ8PBJMDAX</AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
</CommitCRMResponse>

Response in case of error:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>FAILURE</Status>
<AffectedRecId></AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
<ResultCodes>50109</ResultCodes>
<ResultMessage>
Fields with illegal values: Operation canceled. Field: Account has invalid data -
TKTN1NIQEYYQ8PBJMDAX
</ResultMessage>
</CommitCRMResponse>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMResponse>
| The response starts and ends with this token
|-
| <Status>
| The transaction status. Possible values: FAILURE, SUCCESS
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <AffectedRecId>
| The REC ID of the entity which was added or updated when processing the transaction.
|-
|<ResultCodes> <ResultMessage>
|In case of a failure, this will contain the error code and description. You can find more information about error codes [[Commit API Reference Manual#Error Codes Description|here]].
|}

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

API Code Samples

2009-08-20T09:30:42Z

Yarden: /* VB Sample */

{{usermanualsapidevelopersguide}}
The Commit API allows you to add/update the following entities:
*Accounts
*Assets
*Tickets
*Charges
*Appointments
*Tasks
*History Notes
*Opportunities
*Documents
*Knowledge Base Articles

Each API method requires a list of parameters which contain the field names and their values. The field names are the Database field names. You can see each field's name within the application (so you can verify which field you are about to update), by right-clicking the field and selecting Field Settings > Advanced Tab > view the Tech. Rec ID field.

You can view the complete list of database fields in the [[Commit API Reference Manual#API Reference Manual|API Reference Manual]] above.

Following are samples for using the API by Email and the Programming API. The samples are basic and provide an easy starting point.

===Code samples===
The following code samples demonstrate how to add and update a record in CommitCRM from VBA, C++ or Delphi programs.

Make sure to read [[Commit API Reference Manual#Using Commit API|Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

To test samples, it is recommended that you download a trial version of CommitCRM from our web site and install it on a new computer that is not running CommitCRM. Then, modify the paths in the source code to point to folder <testcomputer>\Commit\LastVer (and to the same files it already points to).

When developing your programs please make sure you work under the <testcomputer>\Commit\ThirdParty\UserDev folder (or at least call the dlls in this location). Do not copy the dll’s to any other location.

These samples create a connection to CommitCRM's database, add a new Account record into
the database, and update it. Each transaction should specify the database table to be updated by the transaction:
{| class="wikitable"
|-
! '''Application entity'''
! '''Table name'''
! '''Code'''
|-
| Accounts
| Cards
| 10
|-
| Opportunities
| Opps
| 20
|-
| Documents
| Docs
| 30
|-
| Charges
| Docs
| 30
|-
| Charges
| Slips
| 40
|-
| Appointments/Tasks
| Events
| 50
|-
| History Notes
| Notebook
| 60
|-
| Tickets
| Tickets
| 70
|-
| Items
| Items
| 80
|-
| Assets
| Assets
| 90
|-
| Knowledge Base
| KBArticles
| 100
|}

====API functions====
The Programming API provides the following API functions:
{| class="wikitable"
|-
! '''Method'''
! '''Return Value'''
! '''Description'''
|-
| '''CmtInitDbEngDll (app_name, path, status)'''
| status (int)
| Establishes a connection to the database. app_name - This string will be used for all functions of the package, and will appear in the application as the user who performs the changes in the records you update. You should specify a meaningful value. path - The path to the DB folder where the Commit server is installed: <server>\Commit\Db status - 1 for success. See Error Codes Description for other values.
|-
| '''CmtInsUpdRec(data_buff, map_buff, flag, tbd, 
rec_id_buff_size, error_codes_buff_size, 
err_msg_buff_size,rec_id_buff, 
err_codes_buff, err_msg_buff, status)'''
| status (int), rec_id (char)
| Adds/Updates records. 
data_buff - string containing the values to insert into the Database 
map_buff - mapping of the database fields corresponding with the data buff 
flag - stop(0)/continue(1) the input process is an invalid data value(s) 
tbd - Not used 
rec_id_buff_size - length of REC ID Buffer 
err_code_buff_size - length of Error Code Buffer 
err_msg_buff_size - length of Error Message Buffer 
rec_id_buff - buffer for returned REC ID 
err_codes_buff - buffer for returned Error Codes 
err_msg_buff - buffer for returned Error Messages 
status - returned status, 1 for success. 
See [[Commit API Reference Manual#Error Codes Description|Error Codes Description]] for other values.
|-
| '''CmtTerminateDbEngDll'''
|
| Close the connection to the database
|-
| '''CmtGetDescriptionByCode''' (code, desc_size, desc)
| message (char)
| Call this function in case of error in 
'''CmtInsUpdRec'''. 
In case of error (return code other than 1), 
you can use this to get error string.
|-
| '''CmtGetDescriptionByStatus'''
|
| Call this function in case of error in 
'''CmtInitDbEngDll'''
|}

'''Field buffers'''
The record to be added/updated in the database is passed to the Commit API in two buffers:
{| class="wikitable"
|-
! '''Parameter'''
! '''Description'''
! '''Example'''
|-
| data_buff
| String containing the values to insert into the Database. Separators between the fields are defined in the map_buff
| "17/04/2008 14:44", "CRD7C9KZPS9JN3LEZVD9", "Charge", "CRDGO0SVQ6074CMAN7DW","Closed","test note in DB Engine", "NTBL6PDPKUU6NXLRHLHP","CRDBSMJ3P72EHMU0HB LX","TKT4S81466E05IM8P23X"
|-
| map_buff
| Mapping of the data_buff: separators, field names.

Field names must be in the same order as the data_buff values.

The field names should be separated with a different separator than the values (e.g. "new line").
| " , FLDHISNOTEDATETIME 
FLDHISWORKERID 
FLDHISKIND 
FLDHISCONTACTID 
FLDHISUSER1 
FLDHISDESCRIPTION 
FLDHISRECID 
FLDHISCARDID 
FLDHISLINKRECID 
|}

====VB Sample====
To test the following VB code, create a VB program that includes this code and executes
it, or open the Visual Basic editor included with MS-Word, paste the code into it and run it.

In order for the VB sample to compile properly, please follow these steps:
#Go to My Computer > Right Click – Properties > Advanced Tab > Environment Variable
#At the bottom of the list, search for the Path variable (not PathText)
#Double click the Path variable > go to the end of the value/line
#Add ;
#Add the path to the folder: <server>\Commit\ThirdParty\UserDev\ and confirm.

For all field description see the [[API Reference Manual]].

Private Declare Sub CmtInitDbEngDll Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDbPath As String, ByRef xvStatus As Integer)

Private Declare Sub InitCommonControls Lib "comctl32.dll" ()

Private Declare Sub CmtInsUpdRec Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDataKind As Integer, _
ByVal xDataBuff As String, _
ByVal xMapBuff As String, _
ByVal xContWhenInvalidData As Integer, _
ByVal xFlags As Integer, _
ByVal xRecIDBuffLen As Integer, _
ByVal xLogErrCodesBuffLen As Integer, _
ByVal xLogErrMsgBuffLen As Integer, _
ByVal xvRecIDBuff As String, _
ByVal xvErrCodesLogBuff As String, _
ByVal xvErrMsgLogBuff As String, _
ByRef xvStatus As Integer)

Private Const C_DataBuffSize As Integer = 1024
Private Const C_MapBufSize As Integer = 1024
Private Const C_ErrMsgBuffSize As Integer = 1024
Private Const C_ErrCodeBuffSize As Integer = 64
Private Const C_RecIDBuffSize As Integer = 20
Private Const C_Flag As Integer = 1
Private Const C_Ok As Integer = 1
Private Const C_AccountsTable As Integer = 10

Private Const C_AppName As String = "Demo"

Public Sub DBEng()

Dim nStatus As Integer
Dim l As Long
Dim S As String
Dim pStr As Long
Dim MapBuff As String
Dim DataBuff As String
Dim RecIdBuff As String * C_RecIDBuffSize
Dim ErrCodesLogBuff As String * C_ErrCodeBuffSize
Dim ErrMsgLogBuff As String * C_ErrMsgBuffSize

Call CmtInitDbEngDll(C_AppName, "C:\DemoVBA\DB\", nStatus)

If nStatus = C_Ok Then

Rem ******************** Establishing connection with Commit, Should be
called only once for the entire session ******
MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDFULLNAME" + Chr(13) + "FLDCRDDEAR" +
Chr(13) + "FLDCRDCONTACT"
DataBuff = "'Bart De Hantsetters','De Hantsetters','Hantsetters'"

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)

If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

If nStatus = C_Ok Then
Rem ******************** Updating the Account record we've just created *******************

MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDDEAR" + Chr(13) + "FLDCRDRECID"
DataBuff = "'Doctor','" + RecIdBuff + "'"
ErrCodesBuff = ""
ErrMsgBuff = ""

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)
If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

Else
MsgBox ("Insert new Account. Error code: " + ErrCodesLogBuff)

End If
Else
MsgBox ("Commit Init failed. Error code: " + ErrCodesLogBuff)
End If

End Sub

====C++ Sample====

// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
const int C_DescSize = 1024;
char desc[C_DescSize];
char Delimiter[] = "\n";
int Code;
char* pch;
pch = strtok (ErrCodeBuff,Delimiter);
while (pch != NULL)
{
Code = atoi(pch);
CmtGetDescriptionByCode(Code, C_DescSize, desc);
printf ("%s\n",desc);
pch = strtok (NULL, Delimiter);
}
return 0;
}
int main(int argc, char* argv[])
{
const int C_DataBuffSize = 1024;
const int C_MapBufSize = 1024;
const int C_ErrMsgBuffSize = 1024;
const int C_ErrCodeBuffSize = 64;
const int C_RecIDBuffSize = 64;
const int C_Flag = 1;
const int C_Ok = 1;
const int C_AccountsTable = 10;
const int C_ExampleCode = 54000;
int Status;
char DataBuff[C_DataBuffSize] = "";
char MapBuff[C_MapBufSize] = "";
char RecIdBuff[C_RecIDBuffSize];
char ErrCodesBuff[C_ErrCodeBuffSize];
char ErrMsgBuff[C_ErrMsgBuffSize];
char* C_AppName = "Demo";

//* Establishing connection with CommitCRM, Should be called only once for the entire session **

CmtInitDbEngDll(C_AppName, // Your application name. This will be used for all functions of the
// package.
// Specify a meaningful value.
"C:\\Demo\\DB\\", //Path to the database folder where CommitCRM the server is
// installed <server>\Commit\Db
&Status); //Returned connection status

if (Status == C_Ok) {

//***Insert New Account into that Accounts table *******************
strcpy (DataBuff,"'Bart De Hantsetters','De Hantsetters','Hantsetters'");
strcat (MapBuff, "'\n,\nFLDCRDFULLNAME\nFLDCRDDEAR\nFLDCRDCONTACT");
strcat (RecIdBuff, "");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, //String for your selection.
C_AccountsTable, //Desired Table Code
DataBuff, //This string contains the values which we want to add to the database
MapBuff, //List of database fields where we want to add data
C_Flag,//Flag - stop(0) continue(1) the input process is data
//value(s) is invalid
0, //Not used
C_RecIDBuffSize, //Length of REC ID Buffer
C_ErrCodeBuffSize, //Length of Error Code Buffer
C_ErrMsgBuffSize, //Length of Error Message Buffer
RecIdBuff, //Buffer for returned REC ID
ErrCodesBuff, //Buffer for returned Error Codes
ErrMsgBuff, //Bufer for returned Error Messages
&Status //Returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if (Status == C_Ok) {

//***** Updating the Account record we've just created *************
strcpy (MapBuff, "'\n,\nFLDCRDDEAR\nFLDCRDRECID"); // Map file for the update
// transaction - the Dear field and the record id
strcpy (DataBuff,"'Doctor','");
strcat (DataBuff, RecIdBuff);
strcat (DataBuff, "'");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, // string for your selection.
C_AccountsTable, // Desired Table Code
DataBuff, // string contains the values, which we want to add into the Database
MapBuff, // list of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // length of RecID Buffer
C_ErrCodeBuffSize, // length of Error Code Buffer
C_ErrMsgBuffSize, // length of Error Message Buffer
RecIdBuff, // buffer for returned RecID
ErrCodesBuff, // buffer for returned Error Codes
ErrMsgBuff, // bufer for returned Error Messages
&Status // returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);
}
else
{
printf("Insert new Account. Error code: %d\n", Status);
};

//****Terminate connection with CommitCRM*******************
CmtTerminateDbEngDll();
}
else
{
printf("Commit Init failed. Error code: %d\n", Status);
};

return 0;
}

====Delphi Sample====
program Demo;

{$APPTYPE CONSOLE}

uses
SysUtils, Classes;
const
C_DataBuffSize = 1024;
C_MapBufSize = 1024;
C_ErrMsgBuffSize = 1024;
C_DescSize = 1024;
C_ErrCodeBuffSize = 64;
C_RecIDBuffSize = 64;

C_Flag = 1;
C_Ok = 1;
C_AccountsTable = 10;
C_AppName = 'Demo';

CmtDbEngDll = 'CmtDbEng.DLL';

var
Status: integer;
DataBuff: array [0..C_DataBuffSize] of Char;
MapBuff: array [0..C_MapBufSize] of Char;
RecIdBuff: array [0..C_RecIDBuffSize] of Char;
ErrCodesBuff: array [0..C_ErrCodeBuffSize] of Char;
ErrMsgBuff: array [0..C_ErrMsgBuffSize] of Char;
s: string;

//** Establishing connection with CommitCRM, Should be called only once for the entire session *
Procedure CmtInitDbEngDll (
xSoftWareName : PChar; // Your application name. Once selected this string
// will be used for all
// functions of the package. Specify a meaningful value.
xDbPath : PChar; // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db

var xvStatus : integer // Returned connection status
); stdcall; external CmtDbEngDll;

//**** Insert/Update record
Procedure CmtInsUpdRec(
xSoftWareName : pChar; // See above
xDataKind : integer; // Desired Table Code
xDataBuff : pChar; // String containing the values, which we want
// to add into the Database
xMapBuff : pChar; // List of the database fields into
//which we want to add data
xContWhenInvalidData : Integer; //Flag - stop(0)/continue(1) the input process
// is some data value(s) is invalid
xFlags : Integer; // Not used
xRecIDBuffLen : Integer; // Length of REC ID Buffer
xLogErrCodesBuffLen : Integer; // Length of Error Code Buffer
xLogErrMsgBuffLen : Integer; // Length of Error Message Buffer
xvRecIDBuff : pChar; // Buffer for returned REC ID
xvErrCodesLogBuff : pChar; // Buffer for returned Error Codes
xvErrMsgLogBuff : pChar; // Buffer for returned Error Messages
var xvStatus : Integer // Returned status
); stdcall; external CmtDbEngDll;

//**** Terminate connection with CommitCRM ****
procedure CmtTerminateDbEngDll; stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByCode(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByStatus(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure ErrCodesParsing (ErrCodeBuff: string);
var
lList: TStringList;
i: integer;
aDescErrCode : Pchar;
begin
try
lList := TStringList.Create;
lList.Text := ErrCodeBuff;
GetMem(aDescErrCode,C_DescSize);
for i := 0 to lList.Count - 1 do
begin
CmtGetDescriptionByCode(StrToInt(lList[i]), C_DescSize, aDescErrCode);
writeln('Error Code: '+lList[i]+' Desc: '+string(aDescErrCode));
end;
finally
FreeMem(aDescErrCode);
lList.Destroy;
end;
end;

procedure DisplayErrStatusCode(xCode : Integer);
var
aStatusErrCode : Pchar;
begin
try
GetMem(aStatusErrCode,C_DescSize);
CmtGetDescriptionByStatus(xCode,C_DescSize, aStatusErrCode);
writeln('Commit Init failed. Error code: '+Inttostr(xCode)+' Desc: '+string(aStatusErrCode));
finally
FreeMem(aStatusErrCode);
end;
end;

begin

//**** Establishing connection with CommitCRM, Should be called only once for the entire session
CmtInitDbEngDll(C_AppName, // Your application name. Once selected this string will be used
// for all functions of the package. Specify a meaningful value.
'C:\DemoDelphi\db\', // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db
Status // Returned connection status
);

if Status = C_Ok then
begin

//**** Insert a new Account into the Accounts table ****

s := '"Bart De Hantsetters","De Hantsetters","Hantsetters"';
StrPCopy(DataBuff, s);
s := '"'+#13','+#13+'FLDCRDFULLNAME'+#13+'FLDCRDDEAR'+#13+'FLDCRDCONTACT'+#0;
StrPCopy(MapBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want to add into
// the Database
MapBuff, // List of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Llength of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned REC ID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if (ErrMsgBuff[0] <> #0) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
begin
//**** Updating the Account record we've just created *****

// Map file for the update transaction - the Dear field and the record id
s := '"'+#13+','+#13+'FLDCRDDEAR'+#13'FLDCRDRECID';
StrPCopy(MapBuff, s);

s := '"Doctor","'+RecIdBuff+'"';
StrPCopy(DataBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want
// to add into the Database
MapBuff, // List of the database fields into which we want to add
//data
C_Flag, // Flag - stop(0)/continue(1) the input process is some
// data value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Length of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned RECID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if ((ErrMsgBuff[0] <> #0)) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
Writeln('Completed Successfully');
end
else
begin
try
s := IntToStr(Status);
except
s := 'ill-defined';
end;
writeln('Insert new Account. Error code: '+ s);
end;

//**** Terminate connection with CommitCRM****

CmtTerminateDbEngDll();
end
else
begin
DisplayErrStatusCode(Status);
end;

writeln(#13#10+'press Enter to quit');
readln;
end.

===XML samples===

Following are samples for adding a new Ticket and a new Charge to the Commit database using XML formatted messages.

Make sure to go over the [[Email Connector]] setup guide, and perform the XML API setup steps prior to testing the XML API.

Also please read [[Commit API Reference Manual|Using Commit API#Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

Notes on API by Email Activation:

*Error Handling - Should the system fail to perform the XML transaction, an error message will be sent to the email address specified in the XML.

*Using a Password - If you wish to use a verification password for the XML transactions, define the password using the ServerConfig.exe utility. To do so, go to the XML tab, enable the API by Email option and set a password (as specified in the XML - see [[Commit API Reference Manual#General XML Tokens|General XML Tokens]]). Make sure to set the same Password in ServerConfig and in the XML email itself.

You can read more about the ServerConfig and how to setup the API by Email configuration in the [[Email Connector|Commit Email Connector]] Setup guide.

====General XML Tokens====
The sample and table demonstrates general parameters which should be used for any XML transaction:

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
... the transaction goes here ...
</RecordData>
</CommitCRMTransaction>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMTransaction>
| Start and end transactions with this token (may have more than one in a single email)
|-
| <ExternalApplicationName>
| The sender application name, can contain any text
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <Password>
| Optional Password - Only emails with a password that matches the password set in the Email Connector Settings will be processed (to prevent SPAM email from being processed and added to your CommitCRM database).
|-
| <DataKind>
| What is the Entity you wish to create/update. 
Possible values: 
ACCOUNT - for Accounts 
TICKET - for Tickets 
CHARGE - for Charges 
ITEM - for Items 
APPOINTMENT-OR-TASK - for Appointments/Task 
HISTORY-NOTE - For History notes 
ASSET - for Assets 
OPPORTUNITY - for Sales Opportunities 
DOCUMENT - for Documents 
KBARTICLE - for Knowledge Base articles 
|}

====Adding new Ticket====

In this sample, we add a new Ticket, and set some additional fields to it, such as Notes, Source, Due Date and Dispatcher flag.

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
<FLDTKTCARDID> CUSTOMER-RECORD-ID-GOES-HERE-20-CHARS </FLDTKTCARDID>
<FLDTKTPROBLEM>ticket description...</FLDTKTPROBLEM>
<FLDTKTSTATUS>100</FLDTKTSTATUS>
<FLDTKTKIND>General</FLDTKTKIND>
<FLDTKTNOTES>Notes</FLDTKTNOTES>
<FLDTKTSOURCE>Source</FLDTKTSOURCE>
<FLDTKTSCHEDLENESTIM>60</FLDTKTSCHEDLENESTIM>
<FLDTKTDUEDATETIME>02/04/08</FLDTKTDUEDATETIME>
<FLDTKTFORDISPATCH>Y</FLDTKTFORDISPATCH>
</RecordData>
</CommitCRMTransaction>

====Adding new Charges====

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>Alert</ExternalApplicationName>
<SendResponseToEmail>your email address for responses</SendResponseToEmail>
<Password>12345</Password> >> Should be the same in the ServerConfig!
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>CHARGE</DataKind>
<RecordData>
<FLDSLPWORKERID> CRDLS71RGU747TLHTFOR </FLDSLPWORKERID>
<FLDSLPCARDID> CRDLQXDL43BP5YCMSGM3</FLDSLPCARDID>
<FLDSLPITEMID> ITM1Q3GUI05ANBQGVY8D </FLDSLPITEMID>
<FLDSLPDESC> Charge Description... </FLDSLPDESC>
<FLDSLPQUANTITY> 10 </FLDSLPQUANTITY>
<FLDSLPSLIPDATE> 31/01/2008 </FLDSLPSLIPDATE>
<FLDSLPSTARTTIME> 12:06 </FLDSLPSTARTTIME>
<FLDSLPENDTIME> 14:50 </FLDSLPENDTIME>
<FLDSLPBCRECID> BCTMA51KBA925J7G0V67 </FLDSLPBCRECID>
<FLDSLPPRICE> 125.3 </FLDSLPPRICE>
<FLDSLPADJUSTAMOUNT> 10 </FLDSLPADJUSTAMOUNT>
<FLDSLPUSER1> Field 1... </FLDSLPUSER1>
</RecordData>
</CommitCRMTransaction>

====Receiving Response====
When adding or updating data via the XML API, the system can send a response (if the
XML transaction specifies this in the SendResponseToEmail token). The format of the XML
response is as follow:

Response in case of success:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>SUCCESS</Status>
<AffectedRecId>TKTN1NIQEYYQ8PBJMDAX</AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
</CommitCRMResponse>

Response in case of error:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>FAILURE</Status>
<AffectedRecId></AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
<ResultCodes>50109</ResultCodes>
<ResultMessage>
Fields with illegal values: Operation canceled. Field: Account has invalid data -
TKTN1NIQEYYQ8PBJMDAX
</ResultMessage>
</CommitCRMResponse>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMResponse>
| The response starts and ends with this token
|-
| <Status>
| The transaction status. Possible values: FAILURE, SUCCESS
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <AffectedRecId>
| The REC ID of the entity which was added or updated when processing the transaction.
|-
|<ResultCodes> <ResultMessage>
|In case of a failure, this will contain the error code and description. You can find more information about error codes [[Commit API Reference Manual#Error Codes Description|here]].
|}

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

API Code Samples

2009-08-20T09:29:48Z

Yarden: /* See Also */

{{usermanualsapidevelopersguide}}
The Commit API allows you to add/update the following entities:
*Accounts
*Assets
*Tickets
*Charges
*Appointments
*Tasks
*History Notes
*Opportunities
*Documents
*Knowledge Base Articles

Each API method requires a list of parameters which contain the field names and their values. The field names are the Database field names. You can see each field's name within the application (so you can verify which field you are about to update), by right-clicking the field and selecting Field Settings > Advanced Tab > view the Tech. Rec ID field.

You can view the complete list of database fields in the [[Commit API Reference Manual#API Reference Manual|API Reference Manual]] above.

Following are samples for using the API by Email and the Programming API. The samples are basic and provide an easy starting point.

===Code samples===
The following code samples demonstrate how to add and update a record in CommitCRM from VBA, C++ or Delphi programs.

Make sure to read [[Commit API Reference Manual#Using Commit API|Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

To test samples, it is recommended that you download a trial version of CommitCRM from our web site and install it on a new computer that is not running CommitCRM. Then, modify the paths in the source code to point to folder <testcomputer>\Commit\LastVer (and to the same files it already points to).

When developing your programs please make sure you work under the <testcomputer>\Commit\ThirdParty\UserDev folder (or at least call the dlls in this location). Do not copy the dll’s to any other location.

These samples create a connection to CommitCRM's database, add a new Account record into
the database, and update it. Each transaction should specify the database table to be updated by the transaction:
{| class="wikitable"
|-
! '''Application entity'''
! '''Table name'''
! '''Code'''
|-
| Accounts
| Cards
| 10
|-
| Opportunities
| Opps
| 20
|-
| Documents
| Docs
| 30
|-
| Charges
| Docs
| 30
|-
| Charges
| Slips
| 40
|-
| Appointments/Tasks
| Events
| 50
|-
| History Notes
| Notebook
| 60
|-
| Tickets
| Tickets
| 70
|-
| Items
| Items
| 80
|-
| Assets
| Assets
| 90
|-
| Knowledge Base
| KBArticles
| 100
|}

====API functions====
The Programming API provides the following API functions:
{| class="wikitable"
|-
! '''Method'''
! '''Return Value'''
! '''Description'''
|-
| '''CmtInitDbEngDll (app_name, path, status)'''
| status (int)
| Establishes a connection to the database. app_name - This string will be used for all functions of the package, and will appear in the application as the user who performs the changes in the records you update. You should specify a meaningful value. path - The path to the DB folder where the Commit server is installed: <server>\Commit\Db status - 1 for success. See Error Codes Description for other values.
|-
| '''CmtInsUpdRec(data_buff, map_buff, flag, tbd, 
rec_id_buff_size, error_codes_buff_size, 
err_msg_buff_size,rec_id_buff, 
err_codes_buff, err_msg_buff, status)'''
| status (int), rec_id (char)
| Adds/Updates records. 
data_buff - string containing the values to insert into the Database 
map_buff - mapping of the database fields corresponding with the data buff 
flag - stop(0)/continue(1) the input process is an invalid data value(s) 
tbd - Not used 
rec_id_buff_size - length of REC ID Buffer 
err_code_buff_size - length of Error Code Buffer 
err_msg_buff_size - length of Error Message Buffer 
rec_id_buff - buffer for returned REC ID 
err_codes_buff - buffer for returned Error Codes 
err_msg_buff - buffer for returned Error Messages 
status - returned status, 1 for success. 
See [[Commit API Reference Manual#Error Codes Description|Error Codes Description]] for other values.
|-
| '''CmtTerminateDbEngDll'''
|
| Close the connection to the database
|-
| '''CmtGetDescriptionByCode''' (code, desc_size, desc)
| message (char)
| Call this function in case of error in 
'''CmtInsUpdRec'''. 
In case of error (return code other than 1), 
you can use this to get error string.
|-
| '''CmtGetDescriptionByStatus'''
|
| Call this function in case of error in 
'''CmtInitDbEngDll'''
|}

'''Field buffers'''
The record to be added/updated in the database is passed to the Commit API in two buffers:
{| class="wikitable"
|-
! '''Parameter'''
! '''Description'''
! '''Example'''
|-
| data_buff
| String containing the values to insert into the Database. Separators between the fields are defined in the map_buff
| "17/04/2008 14:44", "CRD7C9KZPS9JN3LEZVD9", "Charge", "CRDGO0SVQ6074CMAN7DW","Closed","test note in DB Engine", "NTBL6PDPKUU6NXLRHLHP","CRDBSMJ3P72EHMU0HB LX","TKT4S81466E05IM8P23X"
|-
| map_buff
| Mapping of the data_buff: separators, field names.

Field names must be in the same order as the data_buff values.

The field names should be separated with a different separator than the values (e.g. "new line").
| " , FLDHISNOTEDATETIME 
FLDHISWORKERID 
FLDHISKIND 
FLDHISCONTACTID 
FLDHISUSER1 
FLDHISDESCRIPTION 
FLDHISRECID 
FLDHISCARDID 
FLDHISLINKRECID 
|}

====VB Sample====
To test the following VB code, create a VB program that includes this code and executes
it, or open the Visual Basic editor included with MS-Word, paste the code into it and run it.

In order for the VB sample to compile properly, please follow these steps:
#Go to My Computer > Right Click – Properties > Advanced Tab > Environment Variable
#At the bottom of the list, search for the Path variable (not PathText)
#Double click the Path variable > go to the end of the value/line
#Add ;
#Add the path to the folder: <server>\Commit\ThirdParty\UserDev\ and confirm.

Private Declare Sub CmtInitDbEngDll Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDbPath As String, ByRef xvStatus As Integer)

Private Declare Sub InitCommonControls Lib "comctl32.dll" ()

Private Declare Sub CmtInsUpdRec Lib "C:\DemoVBA\CmtDbEng.dll" (ByVal xSoftWareName As String, _
ByVal xDataKind As Integer, _
ByVal xDataBuff As String, _
ByVal xMapBuff As String, _
ByVal xContWhenInvalidData As Integer, _
ByVal xFlags As Integer, _
ByVal xRecIDBuffLen As Integer, _
ByVal xLogErrCodesBuffLen As Integer, _
ByVal xLogErrMsgBuffLen As Integer, _
ByVal xvRecIDBuff As String, _
ByVal xvErrCodesLogBuff As String, _
ByVal xvErrMsgLogBuff As String, _
ByRef xvStatus As Integer)

Private Const C_DataBuffSize As Integer = 1024
Private Const C_MapBufSize As Integer = 1024
Private Const C_ErrMsgBuffSize As Integer = 1024
Private Const C_ErrCodeBuffSize As Integer = 64
Private Const C_RecIDBuffSize As Integer = 20
Private Const C_Flag As Integer = 1
Private Const C_Ok As Integer = 1
Private Const C_AccountsTable As Integer = 10

Private Const C_AppName As String = "Demo"

Public Sub DBEng()

Dim nStatus As Integer
Dim l As Long
Dim S As String
Dim pStr As Long
Dim MapBuff As String
Dim DataBuff As String
Dim RecIdBuff As String * C_RecIDBuffSize
Dim ErrCodesLogBuff As String * C_ErrCodeBuffSize
Dim ErrMsgLogBuff As String * C_ErrMsgBuffSize

Call CmtInitDbEngDll(C_AppName, "C:\DemoVBA\DB\", nStatus)

If nStatus = C_Ok Then

Rem ******************** Establishing connection with Commit, Should be
called only once for the entire session ******
MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDFULLNAME" + Chr(13) + "FLDCRDDEAR" +
Chr(13) + "FLDCRDCONTACT"
DataBuff = "'Bart De Hantsetters','De Hantsetters','Hantsetters'"

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)

If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

If nStatus = C_Ok Then
Rem ******************** Updating the Account record we've just created *******************

MapBuff = "'" + Chr(13) + "," + Chr(13) + "FLDCRDDEAR" + Chr(13) + "FLDCRDRECID"
DataBuff = "'Doctor','" + RecIdBuff + "'"
ErrCodesBuff = ""
ErrMsgBuff = ""

Call CmtInsUpdRec(C_AccountsTable, _
C_AccountsTable, _
DataBuff, _
MapBuff, _
C_Flag, _
0, _
C_RecIDBuffSize, _
C_ErrCodeBuffSize, _
C_ErrMsgBuffSize, _
RecIdBuff, _
ErrCodesLogBuff, _
ErrMsgLogBuff, _
nStatus)
If (ErrMsgBuff <> "") Then MsgBox ("Error Message: " + ErrMsgBuff)

Else
MsgBox ("Insert new Account. Error code: " + ErrCodesLogBuff)

End If
Else
MsgBox ("Commit Init failed. Error code: " + ErrCodesLogBuff)
End If

End Sub

====C++ Sample====

// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
// Demo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "CmtDBEng.h"
#include <string.h>
#include <stdlib.h>
int ErrCodesParsing (char* ErrCodeBuff)
{
const int C_DescSize = 1024;
char desc[C_DescSize];
char Delimiter[] = "\n";
int Code;
char* pch;
pch = strtok (ErrCodeBuff,Delimiter);
while (pch != NULL)
{
Code = atoi(pch);
CmtGetDescriptionByCode(Code, C_DescSize, desc);
printf ("%s\n",desc);
pch = strtok (NULL, Delimiter);
}
return 0;
}
int main(int argc, char* argv[])
{
const int C_DataBuffSize = 1024;
const int C_MapBufSize = 1024;
const int C_ErrMsgBuffSize = 1024;
const int C_ErrCodeBuffSize = 64;
const int C_RecIDBuffSize = 64;
const int C_Flag = 1;
const int C_Ok = 1;
const int C_AccountsTable = 10;
const int C_ExampleCode = 54000;
int Status;
char DataBuff[C_DataBuffSize] = "";
char MapBuff[C_MapBufSize] = "";
char RecIdBuff[C_RecIDBuffSize];
char ErrCodesBuff[C_ErrCodeBuffSize];
char ErrMsgBuff[C_ErrMsgBuffSize];
char* C_AppName = "Demo";

//* Establishing connection with CommitCRM, Should be called only once for the entire session **

CmtInitDbEngDll(C_AppName, // Your application name. This will be used for all functions of the
// package.
// Specify a meaningful value.
"C:\\Demo\\DB\\", //Path to the database folder where CommitCRM the server is
// installed <server>\Commit\Db
&Status); //Returned connection status

if (Status == C_Ok) {

//***Insert New Account into that Accounts table *******************
strcpy (DataBuff,"'Bart De Hantsetters','De Hantsetters','Hantsetters'");
strcat (MapBuff, "'\n,\nFLDCRDFULLNAME\nFLDCRDDEAR\nFLDCRDCONTACT");
strcat (RecIdBuff, "");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, //String for your selection.
C_AccountsTable, //Desired Table Code
DataBuff, //This string contains the values which we want to add to the database
MapBuff, //List of database fields where we want to add data
C_Flag,//Flag - stop(0) continue(1) the input process is data
//value(s) is invalid
0, //Not used
C_RecIDBuffSize, //Length of REC ID Buffer
C_ErrCodeBuffSize, //Length of Error Code Buffer
C_ErrMsgBuffSize, //Length of Error Message Buffer
RecIdBuff, //Buffer for returned REC ID
ErrCodesBuff, //Buffer for returned Error Codes
ErrMsgBuff, //Bufer for returned Error Messages
&Status //Returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if (Status == C_Ok) {

//***** Updating the Account record we've just created *************
strcpy (MapBuff, "'\n,\nFLDCRDDEAR\nFLDCRDRECID"); // Map file for the update
// transaction - the Dear field and the record id
strcpy (DataBuff,"'Doctor','");
strcat (DataBuff, RecIdBuff);
strcat (DataBuff, "'");
strcat (ErrCodesBuff, "");
strcat (ErrMsgBuff, "");

CmtInsUpdRec(C_AppName, // string for your selection.
C_AccountsTable, // Desired Table Code
DataBuff, // string contains the values, which we want to add into the Database
MapBuff, // list of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // length of RecID Buffer
C_ErrCodeBuffSize, // length of Error Code Buffer
C_ErrMsgBuffSize, // length of Error Message Buffer
RecIdBuff, // buffer for returned RecID
ErrCodesBuff, // buffer for returned Error Codes
ErrMsgBuff, // bufer for returned Error Messages
&Status // returned status
);

if (ErrMsgBuff == "")
printf("Error Message: %s", ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);
}
else
{
printf("Insert new Account. Error code: %d\n", Status);
};

//****Terminate connection with CommitCRM*******************
CmtTerminateDbEngDll();
}
else
{
printf("Commit Init failed. Error code: %d\n", Status);
};

return 0;
}

====Delphi Sample====
program Demo;

{$APPTYPE CONSOLE}

uses
SysUtils, Classes;
const
C_DataBuffSize = 1024;
C_MapBufSize = 1024;
C_ErrMsgBuffSize = 1024;
C_DescSize = 1024;
C_ErrCodeBuffSize = 64;
C_RecIDBuffSize = 64;

C_Flag = 1;
C_Ok = 1;
C_AccountsTable = 10;
C_AppName = 'Demo';

CmtDbEngDll = 'CmtDbEng.DLL';

var
Status: integer;
DataBuff: array [0..C_DataBuffSize] of Char;
MapBuff: array [0..C_MapBufSize] of Char;
RecIdBuff: array [0..C_RecIDBuffSize] of Char;
ErrCodesBuff: array [0..C_ErrCodeBuffSize] of Char;
ErrMsgBuff: array [0..C_ErrMsgBuffSize] of Char;
s: string;

//** Establishing connection with CommitCRM, Should be called only once for the entire session *
Procedure CmtInitDbEngDll (
xSoftWareName : PChar; // Your application name. Once selected this string
// will be used for all
// functions of the package. Specify a meaningful value.
xDbPath : PChar; // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db

var xvStatus : integer // Returned connection status
); stdcall; external CmtDbEngDll;

//**** Insert/Update record
Procedure CmtInsUpdRec(
xSoftWareName : pChar; // See above
xDataKind : integer; // Desired Table Code
xDataBuff : pChar; // String containing the values, which we want
// to add into the Database
xMapBuff : pChar; // List of the database fields into
//which we want to add data
xContWhenInvalidData : Integer; //Flag - stop(0)/continue(1) the input process
// is some data value(s) is invalid
xFlags : Integer; // Not used
xRecIDBuffLen : Integer; // Length of REC ID Buffer
xLogErrCodesBuffLen : Integer; // Length of Error Code Buffer
xLogErrMsgBuffLen : Integer; // Length of Error Message Buffer
xvRecIDBuff : pChar; // Buffer for returned REC ID
xvErrCodesLogBuff : pChar; // Buffer for returned Error Codes
xvErrMsgLogBuff : pChar; // Buffer for returned Error Messages
var xvStatus : Integer // Returned status
); stdcall; external CmtDbEngDll;

//**** Terminate connection with CommitCRM ****
procedure CmtTerminateDbEngDll; stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByCode(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure CmtGetDescriptionByStatus(
xCode : Integer;
xDescLen : Integer;
xvDesc : pChar); stdcall; external CmtDbEngDll;

procedure ErrCodesParsing (ErrCodeBuff: string);
var
lList: TStringList;
i: integer;
aDescErrCode : Pchar;
begin
try
lList := TStringList.Create;
lList.Text := ErrCodeBuff;
GetMem(aDescErrCode,C_DescSize);
for i := 0 to lList.Count - 1 do
begin
CmtGetDescriptionByCode(StrToInt(lList[i]), C_DescSize, aDescErrCode);
writeln('Error Code: '+lList[i]+' Desc: '+string(aDescErrCode));
end;
finally
FreeMem(aDescErrCode);
lList.Destroy;
end;
end;

procedure DisplayErrStatusCode(xCode : Integer);
var
aStatusErrCode : Pchar;
begin
try
GetMem(aStatusErrCode,C_DescSize);
CmtGetDescriptionByStatus(xCode,C_DescSize, aStatusErrCode);
writeln('Commit Init failed. Error code: '+Inttostr(xCode)+' Desc: '+string(aStatusErrCode));
finally
FreeMem(aStatusErrCode);
end;
end;

begin

//**** Establishing connection with CommitCRM, Should be called only once for the entire session
CmtInitDbEngDll(C_AppName, // Your application name. Once selected this string will be used
// for all functions of the package. Specify a meaningful value.
'C:\DemoDelphi\db\', // Path to the DB folder under where Commit server is
// installed <server>\Commit\Db
Status // Returned connection status
);

if Status = C_Ok then
begin

//**** Insert a new Account into the Accounts table ****

s := '"Bart De Hantsetters","De Hantsetters","Hantsetters"';
StrPCopy(DataBuff, s);
s := '"'+#13','+#13+'FLDCRDFULLNAME'+#13+'FLDCRDDEAR'+#13+'FLDCRDCONTACT'+#0;
StrPCopy(MapBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want to add into
// the Database
MapBuff, // List of the Database Fields in which we want to add data
C_Flag, // Flag - stop(0)/continue(1) the input process is some data
// value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Llength of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned REC ID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if (ErrMsgBuff[0] <> #0) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
begin
//**** Updating the Account record we've just created *****

// Map file for the update transaction - the Dear field and the record id
s := '"'+#13+','+#13+'FLDCRDDEAR'+#13'FLDCRDRECID';
StrPCopy(MapBuff, s);

s := '"Doctor","'+RecIdBuff+'"';
StrPCopy(DataBuff, s);

CmtInsUpdRec(C_AppName, // Your application name
C_AccountsTable, // Desired Table Code
DataBuff, // String containing the values, which we want
// to add into the Database
MapBuff, // List of the database fields into which we want to add
//data
C_Flag, // Flag - stop(0)/continue(1) the input process is some
// data value(s) is invalid
0, // Not used
C_RecIDBuffSize, // Length of REC ID Buffer
C_ErrCodeBuffSize, // Length of Error Code Buffer
C_ErrMsgBuffSize, // Length of Error Message Buffer
RecIdBuff, // Buffer for returned RECID
ErrCodesBuff, // Buffer for returned Error Codes
ErrMsgBuff, // Buffer for returned Error Messages
Status // Returned status
);

if ((ErrMsgBuff[0] <> #0)) then
writeln('Error Message: '+ ErrMsgBuff);

ErrCodesParsing(ErrCodesBuff);

if Status = C_Ok then
Writeln('Completed Successfully');
end
else
begin
try
s := IntToStr(Status);
except
s := 'ill-defined';
end;
writeln('Insert new Account. Error code: '+ s);
end;

//**** Terminate connection with CommitCRM****

CmtTerminateDbEngDll();
end
else
begin
DisplayErrStatusCode(Status);
end;

writeln(#13#10+'press Enter to quit');
readln;
end.

===XML samples===

Following are samples for adding a new Ticket and a new Charge to the Commit database using XML formatted messages.

Make sure to go over the [[Email Connector]] setup guide, and perform the XML API setup steps prior to testing the XML API.

Also please read [[Commit API Reference Manual|Using Commit API#Using Commit API]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

Notes on API by Email Activation:

*Error Handling - Should the system fail to perform the XML transaction, an error message will be sent to the email address specified in the XML.

*Using a Password - If you wish to use a verification password for the XML transactions, define the password using the ServerConfig.exe utility. To do so, go to the XML tab, enable the API by Email option and set a password (as specified in the XML - see [[Commit API Reference Manual#General XML Tokens|General XML Tokens]]). Make sure to set the same Password in ServerConfig and in the XML email itself.

You can read more about the ServerConfig and how to setup the API by Email configuration in the [[Email Connector|Commit Email Connector]] Setup guide.

====General XML Tokens====
The sample and table demonstrates general parameters which should be used for any XML transaction:

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
... the transaction goes here ...
</RecordData>
</CommitCRMTransaction>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMTransaction>
| Start and end transactions with this token (may have more than one in a single email)
|-
| <ExternalApplicationName>
| The sender application name, can contain any text
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <Password>
| Optional Password - Only emails with a password that matches the password set in the Email Connector Settings will be processed (to prevent SPAM email from being processed and added to your CommitCRM database).
|-
| <DataKind>
| What is the Entity you wish to create/update. 
Possible values: 
ACCOUNT - for Accounts 
TICKET - for Tickets 
CHARGE - for Charges 
ITEM - for Items 
APPOINTMENT-OR-TASK - for Appointments/Task 
HISTORY-NOTE - For History notes 
ASSET - for Assets 
OPPORTUNITY - for Sales Opportunities 
DOCUMENT - for Documents 
KBARTICLE - for Knowledge Base articles 
|}

====Adding new Ticket====

In this sample, we add a new Ticket, and set some additional fields to it, such as Notes, Source, Due Date and Dispatcher flag.

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>N-Able</ExternalApplicationName>
<SendResponseToEmail>youremail@yourdomain.com</SendResponseToEmail>
<Password>the-predefined-api-password</Password>
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>TICKET</DataKind>
<RecordData>
<FLDTKTCARDID> CUSTOMER-RECORD-ID-GOES-HERE-20-CHARS </FLDTKTCARDID>
<FLDTKTPROBLEM>ticket description...</FLDTKTPROBLEM>
<FLDTKTSTATUS>100</FLDTKTSTATUS>
<FLDTKTKIND>General</FLDTKTKIND>
<FLDTKTNOTES>Notes</FLDTKTNOTES>
<FLDTKTSOURCE>Source</FLDTKTSOURCE>
<FLDTKTSCHEDLENESTIM>60</FLDTKTSCHEDLENESTIM>
<FLDTKTDUEDATETIME>02/04/08</FLDTKTDUEDATETIME>
<FLDTKTFORDISPATCH>Y</FLDTKTFORDISPATCH>
</RecordData>
</CommitCRMTransaction>

====Adding new Charges====

<?xml version="1.0" ?>
<?commitcrmxml version = "1.0" ?>
<CommitCRMTransaction>
<ExternalApplicationName>Alert</ExternalApplicationName>
<SendResponseToEmail>your email address for responses</SendResponseToEmail>
<Password>12345</Password> >> Should be the same in the ServerConfig!
<ReturnTransactionID>data from external application (will be returned as-is in the response)
</ReturnTransactionID>
<DataKind>CHARGE</DataKind>
<RecordData>
<FLDSLPWORKERID> CRDLS71RGU747TLHTFOR </FLDSLPWORKERID>
<FLDSLPCARDID> CRDLQXDL43BP5YCMSGM3</FLDSLPCARDID>
<FLDSLPITEMID> ITM1Q3GUI05ANBQGVY8D </FLDSLPITEMID>
<FLDSLPDESC> Charge Description... </FLDSLPDESC>
<FLDSLPQUANTITY> 10 </FLDSLPQUANTITY>
<FLDSLPSLIPDATE> 31/01/2008 </FLDSLPSLIPDATE>
<FLDSLPSTARTTIME> 12:06 </FLDSLPSTARTTIME>
<FLDSLPENDTIME> 14:50 </FLDSLPENDTIME>
<FLDSLPBCRECID> BCTMA51KBA925J7G0V67 </FLDSLPBCRECID>
<FLDSLPPRICE> 125.3 </FLDSLPPRICE>
<FLDSLPADJUSTAMOUNT> 10 </FLDSLPADJUSTAMOUNT>
<FLDSLPUSER1> Field 1... </FLDSLPUSER1>
</RecordData>
</CommitCRMTransaction>

====Receiving Response====
When adding or updating data via the XML API, the system can send a response (if the
XML transaction specifies this in the SendResponseToEmail token). The format of the XML
response is as follow:

Response in case of success:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>SUCCESS</Status>
<AffectedRecId>TKTN1NIQEYYQ8PBJMDAX</AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
</CommitCRMResponse>

Response in case of error:

<?xml version="1.0" ?>
<?commitcrmxml version="1.0" ?>
<CommitCRMResponse>
<Status>FAILURE</Status>
<AffectedRecId></AffectedRecId>
<ReturnTransactionID>data from external application (as-is)</ReturnTransactionID>
<ResultCodes>50109</ResultCodes>
<ResultMessage>
Fields with illegal values: Operation canceled. Field: Account has invalid data -
TKTN1NIQEYYQ8PBJMDAX
</ResultMessage>
</CommitCRMResponse>

{| class="wikitable"
|-
! '''Token'''
! '''Comment'''
|-
| <?xml version="1.0" ?>
| The XML version - Always 1.0
|-
| <?commitcrmxml version ="1.0" ?>
| The Commit API XML version - Always 1.0
|-
| <CommitCRMResponse>
| The response starts and ends with this token
|-
| <Status>
| The transaction status. Possible values: FAILURE, SUCCESS
|-
| <SendResponseToEmail>
| When set with an email address, then a response email will be sent after processing this transaction by the Email Connector
|-
| <AffectedRecId>
| The REC ID of the entity which was added or updated when processing the transaction.
|-
|<ResultCodes> <ResultMessage>
|In case of a failure, this will contain the error code and description. You can find more information about error codes [[Commit API Reference Manual#Error Codes Description|here]].
|}

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

API Reference Manual

2009-08-20T09:29:30Z

Yarden: /* See Also */

{{usermanualsapidevelopersguide}}
Following is a detailed listing of fields per entity which can be added/updated using the API. The API parameters are the same when using the Programming API or the XML API.

The API allows you to add/update the following entities:
*[[#Account Fields|Accounts]]
*[[#Ticket Fields|Tickets]]
*[[#Charge Fields|Charges (and Contract-price Charges)]]
*[[#Item Fields|Items]]
*[[#History Note Fields|History Notes]]
*[[#Asset Fields|Assets]]
*[[#Calendar Fields|Calender]]
*[[#Opportunity Fields|Opportunities]]
*[[#Document Fields|Documents]]
*[[#Knowledge Base Article Fields|Knowledge Base Articles]]

All API functions may return error codes. You can find the possible error codes in:
*[[#Error Codes Description|Error Codes]]

In the following section you will find a detailed listing of the database fields. Each table includes the fields '''Display name''' (as shows in the application), the '''Database Field Name''' (internal database field identifier) and comments.

Note that when using XML formatted messages, the database field name refers to the name to be provided within the XML token. For example, when the field name is FLDSLPQUANTITY, the XML token should look like this:
<FLDSLPQUANTITY>10</FLDSLPQUANTITY>

You can find examples of adding and updating records in the database by using the database field in the [[API Code Samples]] section.

===Account Fields===
The following table lists the most important parameters for adding/updating Account
records.
Note slight differences when adding a main account vs. adding a secondary contact.

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Account REC ID
| FLDTKTCARDID
|The Account record ID (20 chars). The Account Rec ID can be taken from:
#Account Notes tab, at the bottom, rightclick the RecID field and use Copy. e.g. CRDVQYSOD1B4U4HZIQJJ
#Using ODBC to pull information from the database.
#From the Email Response when adding new Account with the API.
|-
| Address: Line1
| FLDCRDADDRESS1
|
|-
| Address: Line2
| FLDCRDADDRESS2
|
|-
| Address: Line3
| FLDCRDADDRESS3
|
|-
| Account Manager
| FLDCRDASSIGNCARDID
| This field has two roles:
#When adding a main Account: The account manager should contain the ID of the Employee who is the account manager.
#When adding a secondary contact: 
This field should contain the ID of the main Account to which the secondary contacted is
added.
|-
| Assistant
| FLDCRDASSISTANT
|
|-
|Contract
|FLDCRDBCRECID
|The default Contract for this Account (not required)
|-
|Account Number
|FLDCRDCARDID2
|
|-
|ID
|FLDCRDCARDID3
|
|-
|Popup Message
|FLDCRDCARDMESSAGE
|
|-
|Address: City
|FLDCRDCITY
|
|-
|Address: Zip
|FLDCRDZIP
|
|-
|Company name
|FLDCRDCOMPANY
|
|-
|Contact: First & Last Name
|FLDCRDCONTACT
|
|-
|Address: State
|FLDCRDCOUNTRY
|
|-
|Creation Date
|FLDCRDCREATEDATE
|Any date format, such as DD/MM/YYYY
|-
|Created by User
|FLDCRDCREATEUSERID
|Foreign Software Name which created the account
|-
|Dear
|FLDCRDDEAR
|
|-
|Department
|FLDCRDDEPARTMENT
|
|-
|Documents Store Directory
|FLDCRDDOCSFOLDER
|
|-
|E-Mail Address 1
|FLDCRDEMAIL1
|
|-
|E-Mail Address 2
|FLDCRDEMAIL2
|
|-
|Account Type
|FLDCRDENTITYKIND
|When adding a Main Account = 1 When adding a secondary contact = 5
|-
|Fax Number
|FLDCRDFAX1
|
|-
|Fax Number Extension
|FLDCRDFAXDESC1
|
|-
|File as
|FLDCRDFULLNAME
|
|-
|Type
|FLDCRDKIND
|
|-
|Last Name
|FLDCRDLASTNAME
|
|-
|Notes
|FLDCRDNOTES
|
|-
|Field
|FLDCRDPERSONID
|
|-
|Phone 1 Ext.
|FLDCRDPHNDESC1
|
|-
|Phone 2 Ext.
|FLDCRDPHNDESC2
|
|-
|Phone 3 Ext.
|FLDCRDPHNDESC3
|
|-
|Phone 4 Ext.
|FLDCRDPHNDESC4
|
|-
|Phone 1
|FLDCRDPHONE1
|
|-
|Phone 2
|FLDCRDPHONE2
|
|-
|Phone 3
|FLDCRDPHONE3
|
|-
|Phone 4
|FLDCRDPHONE4
|
|-
|Region
|Region FLDCRDREGIONCODE
|
|-
|Popup Message: Display Indication
|FLDCRDSHOWMESSAGE
|
|-
|Address: Country
|FLDCRDSTATE
|
|-
|Sub-Contact Code
|FLDCRDSUBCODE
|
|-
|Salutation
|FLDCRDSUFFIX
|
|-
|Tax1
|FLDCRDTAXCODE1
|
|-
|Tax2
|FLDCRDTAXCODE2
|
|-
|Notes
|FLDCRDNOTES
|
|-
|Title
|FLDCRDTITLE
|
|-
|Last Updated by
|FLDCRDUPDATEUSERID
|When performing updates on existing Account - pass the Foreign Software Name which performs the update.
|-
|Web Address 1
|FLDCRDURL1
|
|-
|Web Address 2
|FLDCRDURL2
|
|-
|Status
|FLDCRDUSER1
|
|-
|Field1
|FLDCRDUSER2
|
|-
|Field2
|FLDCRDUSER3
|
|-
|Field3
|FLDCRDUSER4
|
|-
|Field4
|FLDCRDUSER5
|
|}

===Ticket Fields===

The table below lists the most important Ticket parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Account REC ID
| FLDTKTCARDID
|The Account record ID (20 chars). The Account Rec ID can be taken from:
#Account Notes tab, at the bottom by rightclicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a cnew Account with the API
|-
| Contact REC ID
| FLDTKTCONTACTID
|The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
| Contract REC ID
| FLDTKTBCRECID
|The Contract ID. If not supplied, will be taken from the Account's default contract.
|-
| Emp. REC ID
| FLDTKTWORKERID
|The worker ID to be linked to the Ticket. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
| Priority
| FLDTKTPRIORITY
| The ticket priority. If not passed in the transaction, the default value for new Tickets will be used.
Immediate = 10 High = 20 Normal = 30 Low = 40 Not Applicable= 50
|-
| Ticket Number
| FLDTKTTICKETNO
| The Ticket number. If passed, must be an existing Ticket, and this will update the Ticket with the details in the transaction.
|-
|Description
|FLDTKTPROBLEM
|This is the Ticket Description. This is a mandatory field, which must contain text.
|-
|Ticket Type
|FLDTKTKIND
|Ticket Type (optional). The Ticket Type string should be passed. If not provided, default is used.
|-
|Source
|FLDTKTSOURCE
|
|-
|Estimated Duration Time
|FLDTKTSCHEDLENESTIM
|Estimated duration time for the Ticket in minutes.
|-
|Show Ticket in Dispatcher
|FLDTKTFORDISPATCH
|Possible values: Yes/No
|-
|Status
|FLDTKTSTATUS
|The Ticket Status (optional). 
Possible values: 
New = 100 
Pending = 200 
Scheduled = 300 
In-House Service = 400 
On-Site Service = 500 
Laboratory Service = 600 
Hold = 700 
Other = 800 
Canceled = 900 
Completed = 1000
|-
|Created by User
|FLDTKTCREATEUSER
|Should contain the external software name which created the Ticket
|-
|Due Date
|FLDTKTDUEDATETIME
|Due date for the Ticket. Should be passed in date format. e.g. MM/DD/YYYY
|-
|Resolution
|FLDTKTSOLUTION
|Ticket resolution text
|}

===Charge Fields===
The table below lists the most important Charge parameters and behavior.

Contract-price Charges have some special characteristics (see comments marked by * in
the table below):

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDSLPRECID
|The Charge record ID. If provided, the existing Charge will be updated. Otherwise, this will be
added as a new Charge.
|-
| Charge Source
| FLDSLPSOURCERECID
|The Charge source is the entity for which the charge is created. 
Possible values:
*Linked Contract RecID (for Contract-price Charges). Cannot be the "System Global Contract".
**Passing the Contract RecID indicates that this is a Contract-price charge.
*Entity RecID from which the charge is created (for example when creating a charge from an Appointment or Task).
|-
| Account REC ID
| FLDSLPCARDID
|The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by rightclicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new Account with the API
|-
| Employee REC ID
| FLDSLPWORKERID
| The worker record ID to be linked to the Charge. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
| Charged Item
| FLDSLPITEMID
| The Item Record ID to be linked to the Charge. This is a mandatory field.
*For Contract-price Charge can be only Fixed-Price, Unit-based Item.
|-
| Contract REC ID
| FLDSLPBCRECID
| The contract record ID (must be a Contract of the Account)
|-
|Ticket REC ID
|FLDSLPTICKETID
|The Ticket ID to be linked to the Charge.
*Not relevant for Contract-price Charge
|-
|Date
|FLDSLPSLIPDATE
|The date for the Charge. This is an optional parameter. If not provided, the current date will
be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
|Description
|FLDSLPDESC
|The Charge Description. If not provided, will be taken from the Item's description.
|-
|Units/Hours
|FLDSLPQUANTITY
|This is the quantity of hours/units
|-
|Adjust Amount
|FLDSLPADJUSTAMOUNT
|Discount/Markup amount. Positive number means Markup, negative number means Discount.
|-
|Adjust Percent
|FLDSLPADJUSTPERCENT
|Discount/Markup in percentage, must be between (-100) - 100. Positive number means Markup, negative number means Discount.
|-
|From Time
|FLDSLPSTARTTIME
|From time for labor Charges e.g. 12:06
*Not relevant for Contract-price Charge
|-
|To Time
|FLDSLPENDTIME
|From time for labor Charges e.g. 14:50
* Not relevant for Contract-price Charge
|-
|Price/Rate
|FLDSLPPRICE
|If not provided, the price is taken from the Item.
|-
| Billable
| FLDSLPBILLKIND
| B - Billable 
N - Not Billable 
If not provided, will be set according to the Contract type.
|-
| Billed
| FLDSLPSTAGE
| D - Draft
B - Billed
|-
| Field1
| FLDSLPUSER1
| User defined field
|-
| Create User
| FLDSLPCREATEUSER
| External software name which created the Charge
|}

===Item Fields===

The table below lists the most important Item parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDSLPRECID
|The Item record ID. If provided, the existing item will be updated. Otherwise, this will be added as a new item.
|-
| Item Group
| FLDITMITEMTYPEGROUP
|The Item Group to be linked to the Charge. This is a mandatory field: 
F - Labor (Fee) 
X - Expense 
P - Part
|-
| Item Code
| FLDITMITEMNO
|The item code is a mandatory field
|-
| Item Name
| FLDITMNAME
| The item name is a mandatory field
|-
| Price Source
| FLDITMPRICESOURCE
| F - Fixed Price 
W - by Employee Rate
|-
| Price per Hour/Unit
| FLDITMUNITISHOUR
| This field indicated whether the price is unitbased or hours-based. 
Y - by Hours 
N - by Units 
This is an optional field, depending on the Item Group. For example, if the item group is Labor, and Price Source is By Employee, the value will always be by hours
|-
|Price
|FLDITMUNITPRICE
|Must be a valid numeric value
|-
|Cost
|FLDITMSTANDARDCOST
|The date for the Charge. This is an optional parameter. If not provided, the current date will
be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
|Taxes
|FLDITMTAXCODE1 
FLDITMTAXCODE2 
FLDITMTAXCODE3
|You can pass up to 3 different tax codes.
|-
|Description by Name
|FLDITMDESCBYNAME
|Y - take the description from the name field 
N - take the description from the Description field
|-
|Description
|FLDITMDESC
|If not provided, the description is taken from the name.
|-
|Suspend
|FLDITMSUSPENDED
|Indicated whether this item is currently suspended: 
Y - yes 
N - no
|-
|Notes
|FLDITMNOTES
|
|-
|Field1
|FLDSLPUSER1
|User defined field
|-
|Create User
|FLDSLPCREATEUSER
|External software name which created the Charge
|-
| Created by User
| FLDTKTCREATEUSER
| Should contain the external software name which created the Ticket
|}

===History Note Fields===
The table below lists the most important History Note parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDHISRECID
|The History Note record ID. If provided, the existing History Note will be updated. otherwise, this will be added as a new History Note.
|-
| Date
| FLDHISNOTEDATETIME
|Any date format, such as DD/MM/YYYY
|-
| Description
| FLDHISDESCRIPTION
| The Description text
|-
| Opportunity/Ticket/Contract
| FLDHISLINKRECID
| Link to Opportunity or Ticket or Contract
|-
| Field
| FLDHISUSER1
| User defined field
|-
| About
| FLDHISKIND
| Optional field
|-
|Employee
|FLDHISWORKERID
|The worker ID to be linked to the Ticket. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
|Account
|FLDHISCARDID
|The Account record ID (20 chars). The Account Rec ID can be taken from:
#Account Notes tab, at the bottom, right-click the REC ID field and use Copy. e.g. CRDVQYSOD1B4U4HZIQJJ
#Using ODBC to pull information from the database
#From the Email Response when adding new Account with the API
|-
|Contact
|FLDHISCONTACTID
|The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Document
|FLDHISDOCID
|Linked Document ID, can be taken from the Document Properties window (right-click RecID and use Copy), or using the ODBC to pull information from the database.
|-
|Created by User
|FLDHISCREATEUSER
|Name of the external software which created this History Note
|}

===Asset Fields===
The table below lists the most important Asset parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Asset Code
| FLDASTASSETCODE
|If an existing Asset Code is provided, then existing Asset is updated. Otherwise a new Asset is added.
|-
| Asset Type
| FLDASTASSETTYPE
|The Type field is mandatory: 
Hardware = H 
Software = S 
Other = T
|-
| Asset Name
| FLDASTNAME
|
|-
| Status
| FLDASTSTATUS
| Mandatory field. 
Active = A 
Not Active = N 
If not provided, default Active is used.
|-
| Record ID
| FLDASTRECID
| If provided, must exist in the database. Ignored if empty
|-
| Serial No.
| FLDASTSERIALNO
|
|-
|Account
|FLDASTACCRECID
|The Account which is linked to the Asset
|-
|Contact
|FLDASTCONTACTRECID
|The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Created by user
|FLDASTCREATEUSER
|Name of external software which created this Asset
|-
|Purchase Date
|FLDASTCUSTPURDATE
|Any date format, such as DD/MM/YYYY
|-
|Purchased From Us
|FLDASTCUSTPURFROMUS
|Possible values: Y/N. 
If not provided, default value Y is used.
|-
| Purchase Invoice #
| FLDASTCUSTPUROURINV
|
|-
| Customer PO
| FLDASTCUSTPURPO
|
|-
| Purchase Price
| FLDASTCUSTPURPRICE
|
|-
| Delivered Date
| FLDASTDELIVEDATE
|
|-
| Description
| FLDASTDESC
|
|-
| Installed By
| FLDASTINSTALBY
|
|-
| Installed Date
| FLDASTINSTALDATE
|
|-
| License Codes
| FLDASTLICENSECODE
|
|-
| License Keys
| FLDASTLICENSEKEY
|
|-
| License Notes
| FLDASTLICENSENOTES
|
|-
| Location
| FLDASTLOCATION
|
|-
| Manufacturer
| FLDASTMANUFACTURER
|
|-
| Mnf Serial No.
| FLDASTMNFSERIALNO
|
|-
| Model
| FLDASTMODEL
|
|-
| Notes
| FLDASTNOTES
|
|-
| Quantity
| FLDASTQUANTITY
| If not provided, default value of 1 is used.
|-
| Last Update By
| FLDASTUPDATEUSER
| Name of externals software which performed the update
|-
| Field1
| FLDASTUSER1
| User defined field
|-
| Field2
| FLDASTUSER2
| User defined field
|-
| Field3
| FLDASTUSER3
| User defined field
|-
| Field4
| FLDASTUSER4
| User defined field
|-
| Field5
| FLDASTUSER5
| User defined field
|-
| Date1
| FLDASTUSERDATE1
| User defined field
|-
| Number1
| FLDASTUSERNUMBER1
| User defined field
|-
| Vendor Purchased Date
| FLDASTVENDORDATEPURC
|
|-
| Vendor Invoice #
| FLDASTVENDORINVNO
|
|-
| Vendor PO
| FLDASTVENDOROURPO
|
|-
| Vendor Price
| FLDASTVENDORPRICE
|
|-
| Vendor
| FLDASTVENDORRECID
|
|-
| Vendor Serial No.
| FLDASTVENDORSERNO
|
|-
| Vendor Warranty Exp. Date
| FLDASTVENDORWARREXP
| Any date format, such as DD/MM/YYYY
|-
| Version
| FLDASTVERSION
|
|-
| Warranty/License Exp.
| FLDASTWARREXPDATE
| Any date format, such as DD/MM/YYYY
|-
| Date
|
|
|}

===Calendar Fields===
The table below lists the most important Calendar parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDEVTRECID
|The Appointment/Task record ID. If provided, the existing entity will be updated. Otherwise, this
will be added as a new Appointment/Task.
|-
| Event Type
| FLDEVTWRITETOID
|The Event type is a mandatory field. 
Appointment = 1 
Task = 2
|-
| Employee
| FLDEVTWORKERID
| The Task/Appointment owner (for private events)
|-
| Private: User
| FLDEVTPRIVATEID
| Possible values: Y/N 
If an Employee was set, this field must be Y
|-
| Account
| FLDEVTCARDID
| The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by rightclicking
the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a
new Account with the API
|-
| Contact
| FLDEVTCONTACTID
| The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Document
|FLDEVTDOCID
|Linked Document ID, can be taken from the Document Properties window (right-click RecID and use Copy), or using the ODBC to pull information from the database.
|-
|Done Indication
|FLDEVTDONE
|Possible values: Y/N
|-
|Date
|FLDEVTEVENTDATE
|The Appointment/Task date is a mandatory field of Any date format, such as DD/MM/YYYY. If not
provided, the current date will be used.
|-
|Description
|FLDEVTFREETEXT
|
|-
|Time: Start
|FLDEVTFROMTIME
|Mandatory field
|-
| Time: End
| FLDEVTTOTIME
| Relevant only for Appointments. If this parameter is not provided, 30 min. interval from Start Time is used.
|-
| Opportunity/Ticket
| FLDEVTLINKRECID
| Linked Ticket/Opportunity/Contract/Asset
|-
| Field1
| FLDEVTFAMILY
| User Defined field
|-
| Field2
| FLDEVTACTION
| User Defined field
|-
| Field3
| FLDEVTPLACE
| User Defined field
|-
| Field4
| FLDEVTPLACE1
| User Defined field
|-
| Field5
| FLDEVTPLACE2
| User Defined field
|-
| Created by User
| FLDEVTCREATEUSERID
| Name of external software which created the event
|-
| Last Update: By User
| FLDEVTUPDATEUSER
| Name of external software which updated the
event
|}

===Opportunity Fields===
The table below lists the most important Opportunity parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDOPPRECID
| The Opportunity record ID. If provided, the existing Opportunity will be updated. Otherwise, this will be added as a new Opportunity.
|-
| Opportunity Name
| FLDOPPNAME
| Mandatory field.
|-
| Opportunity ID
| FLDOPPUSERID
| Optional (Oppty ID)
|-
| Account
| FLDOPPCARDID
| The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by right-clicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new Account with the API
|-
| Contact
| FLDEVTCONTACTID
| The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
| Source
| FLDOPPSOURCE
|
|-
|Document
|FLDEVTDOCID
|Linked Document ID, can be taken from the Document Properties window (right-click RecID and use Copy), or using the ODBC to pull information from the database.
|-
|Done Indication
|FLDEVTDONE
|Possible values: Y/N
|-
|Close Date
|FLDOPPCLOSEDATE
|
|-
|Manager
|FLDOPPWORKERID
|The Manager's REC ID
|-
|Open Date
|FLDOPPOPENDATE
|
|-
| Close By Date
| FLDOPPESTDATE
| Opportunity must be closed by this date
|-
| Amount
| FLDOPPAMOUNT
|
|-
| Probability %
| FLDOPPPROBABILITY
|
|-
| Stage
| FLDOPPSTAGE
|
|-
| Status
| FLDOPPSTATUS
|
|-
| Closing Amount
| FLDOPPCLOSEAMOUNT
|
|-
| Description
| FLDOPPDESCRIPTION
|
|-
| Opportunity Type
| FLDOPPKIND
|
|-
| Opportunity Reason
| FLDOPPREASON
|
|-
| Note
| FLDOPPNOTES
|
|-
| Territory
| FLDOPPREGION
|
|-
| Field1
| FLDEVTFAMILY
| User Defined field
|-
| Field2
| FLDEVTACTION
| User Defined field
|-
| Field3
| FLDEVTPLACE
| User Defined field
|-
| Created by User
| FLDEVTCREATEUSERID
| Name of external software which created the event
|-
| Last Update: By User
| FLDEVTUPDATEUSER
| Name of external software which updated the event
|}

===Document Fields===
The table below lists the Document parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDDOCRECID
| The Document record ID. If provided, the existing Document will be updated. Otherwise, this will be added as a new Document.
|-
| Document Date
| FLDDOCDOCDATE
| The date for the Document. This is an optional parameter. If not provided, or if the value is illegal, the current date will be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
| Subject
| FLDOPPUSERID
|
|-
| Linked Record
| FLDDOCLINKRECID
| The RECID of a linked object. Each Document can be linked to one of the following objects:
*Ticket
*Contract
*Opportunity
*Knowledge Base Article
*Asset
The Record ID (20 chars) can be taken from:
#Object's Notes tab, at the bottom by right-clicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new object with the API.
|-
| Account Rec ID
| CARDID
| The Account record ID (20 chars). The Account REC ID can be taken from:
#Account Notes tab, at the bottom by right-clicking the REC ID field and selecting Copy
#ODBC to pull information from the database
#The automated email response when adding a new Account with the API
|-
| Contact REC ID
| FLDDOCCONTACTID
| The Contact for this Account. If not provided, the main Contact for the Account is taken.
|-
|Field1
|FLDDOCTRANSPORT
|User Defined field
|-
|Field2
|FLDDOCFOLDER
|User Defined field
|-
|Field3
|FLDDOCUMENTPLACE
|User Defined field
|-
|File Path + File name
|FLDDOCDOCUMENTNAME
|The Document path
|-
|Category
|FLDDOCTREEID
|The category record ID should be taken from the database table called TreeTbl which contains the Category tree
|-
| Employee REC ID
| FLDDOCWORKERID
| The worker record ID to be linked to the Document. Must be an active employee. This is an optional parameter. If not passed, the system default will be used.
|-
| Created by User
| FLDDOCCREATEUSER
| Name of external software which created the document
|-
| Last Update: By User
| FLDDOCUPDATEUSER
| Name of external software which updated the document
|}

===Knowledge Base Article Fields===
The table below lists the Knowledge Base Article parameters and behavior:

{| class="wikitable"
|-
! '''Field Name'''
! '''Database Field Name'''
! '''Comment'''
|-
| Record ID
| FLDKBARECID
| The Article record ID. If provided, the existing Article will be updated. Otherwise, this will be added as a new Article.
|-
| Document Date
| FLDKBACREATEDATE
| The date for the Document. This is an optional parameter. If not provided, or if the value is illegal, the current date will be used. Should be passed in date format. e.g. MM/DD/YYYY
|-
| Title
| FLDKBATITLE
|
|-
| Problem
| FLDKBAPROBLEM
|
|-
| Solution
| FLDKBASOLUTION
|
|-
| Status
| FLDKBASTATUS
| Possible values:
*DRAFT = 'D'
*PUBLISHED = 'P'
*OBSOLETE = 'O'
|-
|Category
|FLDKBACATEGORY
|
|-
|Public
|FLDKBAISPUBLIC
|Is the Document public. 
Possible values: 
*'Y' = Yes
*'N' = No
|-
|Created by User
|FLDDOCCREATEUSER
|Name of external software which created the document
|-
|Last Update: By User
|FLDDOCUPDATEUSER
|Name of external software which updated the document
|}

===Error Codes Description===
These error codes are returned when calling the CmtGetDescriptionByStatus function: 
'''1000''' CmtDbEng.dll not found. 
'''1001''' Invalid value for the Data Kind value. 
'''1002''' Invalid DATA buffer received. Make sure you have allocated the buffer correctly and
that you have passed the correct buffer length. 
'''1003''' Invalid MAP buffer received. Make sure you have allocated the buffer correctly and
that you have passed the correct buffer length. 
'''1004''' Invalid REC ID buffer received. Make sure you have allocated the buffer correctly
and that you have passed the correct buffer length. 
'''1005''' Invalid LOG buffer received. Make sure you've allocated the buffer correctly and
that you've passed the correct buffer length. 
'''1006''' Invalid REC ID buffer received. It should be at least 20 characters. 
'''1007''' Invalid external software name received. Specify a unique name that identifies your
software. 
'''1008''' Cannot process the transaction. Make sure to call the INIT procedure at least once
prior to sending transactions for processing. 
'''1009''' Path specified for Commit DB folder not found. 
'''1010''' Path specified for Commit DB folder found, but its contents do not reflect a valid DB
folder. 
'''1011''' The RED ID received for the employee/user was not found in Commit, is invalid or is
related to an inactive employee record. 
'''1012''' Error registering software. 
'''1013''' Software name is missing. Make sure you specify a name that identifies your
software. 
'''1014''' Software name is less than 3 characters long. Make sure you enter a software name
that has 3 to 15 characters. 
'''1015''' Software name is too long. Make sure your software name has 3 to 15 characters. 
'''1100''' Database access error. 

General error codes, returned when calling the functions CmtGetDescriptionByCode: 
'''50000''' The data is not correct for its type. 
'''50001''' The field value has been truncated due to the field length in the database. 
'''50002''' The insert operation Failed because the REC ID already existed in the database. 
'''50003''' Failed to update Record since it is being updated by another user. 
'''50103''' Illegal REC ID. 
'''50104''' REC ID Creation failed. 
'''50105''' Illegal Sub-Contact REC ID. 
'''50106''' Illegal Contract REC ID. 
'''50107''' Illegal Employee REC ID. 
'''50108''' Illegal Ticket REC ID. 
'''50109''' Illegal Account REC ID. 
'''50110''' Illegal data for that Contract. 
'''50111''' This Employee is not active. 
'''50112''' Illegal Document REC ID. 
'''50113''' Illegal linked object REC ID. 
'''50114''' Employee not found. 
'''50115''' Some mandatory fields have no values. 
'''51000''' Illegal kind of Account entity. 
'''51001''' Account Manager not found. 
'''51002''' The REC ID of the Account Manager is illegal. 
'''51003''' Illegal tax code. 
'''51004''' This code does not exist in Commit. 
'''52000''' Illegal kind of event. 
'''52001''' Illegal start time. 
'''52002''' Illegal end time. 
'''52003''' Illegal event date. 
'''52004''' The field Reminder1 has Illegal Value. 
'''52005''' The amount in the field has an illegal value. 
'''52006''' The Field Remider1:Units has Illegal Value. 
'''52007''' The Field Remider2:Active has Illegal Value. 
'''52008''' The Field Remider2:Amount has Illegal Value. 
'''52009''' The Field Remider2:Units has Illegal Value. 
'''52010''' Illegal employee REC ID. 
'''52011''' Error occurred while updating the Task/Appointment employee field. 
'''54000''' Illegal Ticket open date. 
'''54001''' Illegal Ticket close date. 
'''54002''' Illegal Ticket code area. 
'''54004''' Illegal Ticket priority. 
'''54005''' Illegal Ticket status. 
'''54006''' The Ticket Account was not found in the database. 
'''54007''' The Ticket Account Manager was not ound in the database. 
'''54008''' This code does not exist in Commit. 
'''54009''' This code does not exist in Commit. 
'''54010''' This code does not exist in Commit. 
'''54011''' This code does not exist in Commit. 
'''54012''' This code does not exist in Commit. 
'''55000''' Illegal charge date. 
'''55001''' Illegal charge REC ID. 
'''55002''' Illegal start date. 
'''55003''' Illegal start time. 
'''55004''' Illegal amount entered for hours. 
'''55005''' Illegal quantity. 
'''55006''' Illegal price. 
'''55007''' Illegal total. 
'''55008''' Illegal value in the Adjust Amount field. 
'''55009''' Illegal value in the Adjust Percent. 
'''55010''' The Discount/Markup field has an illegal value. 
'''55011''' Illegal value in the Adjust Kind field. 
'''55012''' Illegal bill total. 
'''55013''' You can not create a charge for a suspended item. 
'''55014''' Item was not found in Commit. 
'''55015''' This code does not exist in Commit. 
'''55016''' This code does not exists in Commit. 
'''55017''' This Code does not exist in Commit. 
'''55018''' This Code does not exist in Commit. 
'''55019''' This Code does not exist in Commit. 
'''55020''' This Code does not exist in Commit. 
'''55021''' This Code does not exist in Commit. 
'''56000''' Illegal item code. 
'''56001''' The field that indicates the item group type has an illegal value. 
'''56002''' The field that indicates if the Item is suspended has an illegal value. 
'''56003''' Illegal value of The field that indicate if the item is suspended. 
'''56004''' Mismatch found between the fields price and price source. 
'''56005''' Illegal cost. 
'''56006''' Mismatch found between the fields cost and item group type. 
'''56007''' The field that indicates if the charge is by unit or by hours has an illegal value. 
'''56008''' Illegal value in the Description. 
'''56009''' The field that indicates the item type has an illegal value. 
'''57000''' This Code does not exist in Commit. 
'''58000''' Illegal date time. 
'''58001''' The Description field was not found. 
'''58002''' The field kind was not found. 
'''58003''' The Account member was not found. 
'''59000''' This code does not exists in Commit. 
'''59001''' This Code does not exist in Commit. 
'''59002''' This Code does not exist in Commit. 
'''59003''' This Code does not exist in Commit. 
'''59004''' This Code does not exist in Commit. 
'''59005''' This Code does not exist in Commit. 
'''60000''' Invalid web user record ID number. 
'''60001''' This customer web user is not active. 
'''60002''' This user is not a customer. 

==See Also==
*[[Commit API Developers Guide]]
*[[API Code Samples]]
[[Category:User Manuals]]
[[Category:Integration]]

__NOTOC__

Main Page

2009-08-20T09:28:59Z

Yarden:

{| 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:162%; border:none; margin:0; padding:.1em; color:#000;">Welcome to the Commit Wiki</div>
<div style="top:+0.2em; font-size:95%;">Commit 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 Commit?]
* [http://www.commitcrm.com/aboutus.htm About Commit]
|}


{{Col}}
=Documentation=
*[[#Getting Started|Getting Started]]
*[[#Setup|Setup]]
*[[#Videos|Videos]]
*[[#Work Flows|Work Flows]]
*[[#User Manuals|User Manuals]]
*[[#Office Management|Office Management]]
*[[#Service Management|Service Management]]
*[[#Billing|Billing]]
*[[#Import and Export|Import and Export]]
*[[#Customization|Customization]]
*[[#Privileges|Privileges]]
*[[#Integration|Integration]]
*[[#FAQ|FAQ]]

{{Break}}
=Forum Threads=
*[http://www.commitcrm.com/forum/showthread.php?t=1153 New! Installation Video Tutorials]
*[http://www.commitcrm.com/forum/showthread.php?t=1137 New! CommitCRM 5.1 is Now Available ]
*[http://www.commitcrm.com/forum/showthread.php?t=1025 New! Follow us on Twitter – twitter.com/CommitCRM]
*[http://www.commitcrm.com/forum/showthread.php?t=1037 The IT Toolbox – Community Based Resources for IT Professionals]

=Headline=

{{Colend}}


== [[Getting Started]] ==

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

==[[Setup]]==
*[[Import and Export]]
*[[Web Interface|Commit Web Interface Installation]]
*[[Email Connector|Commit Email Connector Installation]]
*[[Alerts Server|Commit Alerts Server Installation]]
*[[QuickBooks Link|Commit-QuickBooks Link]]
*[[Commit-Outlook Sync]]
*[[Videos#Installation Guides|Installation 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/web_interface_installation_video.htm Email Connector Installation]
*[http://www.commitcrm.com/videos/web_interface_installation_video.htm Alerts Server Installation]
*[[Videos|Watch more videos!]]

==Work Flows==
*[[Tickets|Ticket Lifecycle]]
*[[Billing Lifecycle]]
*[[Project Management]]
*[[Recurring Contracts]]
*[[Over-used Hours]]
*[[Asset Warranties]]
*[[Preventive Maintenance]]
*[[Return Material Authorization (RMA)]]
*[[Barcodes and Assets]]
*[[Sales|Sales Management]]
*[[Managing Quotes]]

== User Manuals ==
*[[Billing]]
*[[Assets]]
*[[Sales]]
*[[Knowledge Base]]
*[[Activity Templates]]
*[[Email Templates]]
*[[Documents]]
*[[QuickBooks Link|Commit-QuickBooks Link]]
*[[Commit-Outlook Sync]]
*[[Web Interface|Commit Web Interface]]
*[[Email Connector|Commit Email Connector]]
*[[Alerts Server|Commit Alerts Server]]

==Office Management==
*[[Accounts]]
*[[Documents]]
*[[Documents#Using Word Merge Templates|Word Templates]]
*[[Email Templates]]
*[[Documents#Managing Outlook Emails within CommitCRM|Filing Emails]]
*[[History]]
*[[Commit-Outlook Sync]]

==Service Management==
*[[Tickets]]
*[[Tickets#Dispatch the Ticket|Dispatcher]]
*[[Assets]]
*[[Activity Templates]]
*[[Email Templates]]
*[[Knowledge Base]]
*[[Billing]]

==Billing==
*[[Billing]]
*[[Items]]
*[[Charges]]
*[[Contracts]]
*[[Custom Pricing]]
*[[Contract-Price Charges]]
*[[Recurring Contracts]]
*[[Charges#Charging Using Taxes|Taxes]]
*[[QuickBooks Link|Commit-QuickBooks Link]]
*[[Charges#Using CommitCRM Charge Reports|Charge Reports]]

==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|Sync with Outlook]]

==Customization==
*[[Field Customization]]
*[[Report Customization]]

==Privileges==
*[[Employees#Employee Privileges Group|Employee Privileges]]
*[[Customer Privileges]]

==[[Integration]]==
*[[QuickBooks Link|Commit-QuickBooks Link]]
*[[Commit-Outlook Sync]]
*[[Commit Online Services]]
*[[Commit API Developers Guide]]
*[[Programming API and ODBC Link]]
*[[Documents#Importing Existing Documents|Import and Export (Excel, CSV, etc.)]]
*[[Documents#Using Word Merge Templates|Word Templates]]

== FAQ ==
*[[Tickets FAQ|Tickets]]
*[[Contracts FAQ|Contracts]]
*[[Dispatcher & Calendar FAQ|Dispatcher & Calendar]]
*[[Charges FAQ|Charges]]
*[[Items FAQ|Items]]
*[[Reports FAQ|Reports]]
*[[Import & 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 & 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__
__NOEDITSECTION__

Template:Usermanualsbilling

2009-08-20T07:30:51Z

Yarden:

<div align="right">[[User Manuals]] | [[Billing]] | [[{{PAGENAME}}]] 
</div>

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

2009-08-20T07:15:37Z

Yarden:

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.

__NOTOC__

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

2009-08-20T07:14:40Z

Yarden: moved CommitCRM-Wiki:Privacy policy to Page2

#REDIRECT [[Page2]]

Assets

2009-08-18T14:36:07Z

Yarden:

{{usermanualsnav}}
==Intorduction==
CommitCRM's '''Asset Management''' feature lets you easily track and manage customer equipment, PC inventory and software licenses/subscriptions.

Asset management in CommitCRM is designed to help IT managers and service providers to quickly and efficiently get to the root of problems with the help of the Asset service [[history]] feature, and the Asset management overview of customer hardware and software inventory.

Each Asset can be linked to a specific customer, and it represents their equipment (hardware) or software. Once an Asset is linked to an [[Accounts|Account]], and service [[Tickets]] are opened for it, this link to the Account becomes permanent (i.e. you cannot link it to any other Account).

Each Asset can be one of the following types: Hardware, Software or Other. For each of the types, you can manage slightly different information which is relevant to the Asset type, and track the relevant activity.

__TOC__

==Asset Fields==
Hardware Assets can be used to track Servers, Desktops, Laptops, Printers, Routers, Etc.
For every Hardware Asset item you can manage details which are specific to that Asset, such as Code and Serial Numbers, Warranty expiration date, Vendor and Manufacturer information, license keys and codes, and more.

Software Assets can be used to track Customer Software Assets such as: Windows® Server and Desktop Licenses, Anti-Virus software licenses and subscription information, Microsoft® Office® licenses, Accounting package licenses (i.e. QuickBooks), etc.

See the Asset details window below:

[[File:Commit_assets_details_window.gif|center]]

'''Asset Details Window'''

The following are the fields that are available for every Asset :

===Field List===

{| class="wikitable"
|-
! Field
! Description
|-
| Asset Name
(mandatory)
| Every Asset is given its own name so you will be able to easily identify it when viewing the Assets list. For example, when you wish to link an Asset to a new Ticket, you can click the Asset selection list, and only Assets which are relevant to that customer will be displayed. Using the Asset Name you can easily find the Asset in the list. Note that you can have multiple Assets with the same name.
|-
| Asset Code
| The Asset code field is optional. If you choose to use it, it must have a unique identifier that is not used for any other Asset. For example, you may have several Assets with the same name (e.g. "HP Workstation Z50"), but each Asset should have its own unique identifier (e.g. "HP-Z50-001", "HP-Z50-002", etc.). Note that you can also use the Asset code for scanning-in barcodes (see [[Barcodes and Assets]]).
|-
| Serial No.
| This field is located in the Asset's Details tab. Use this field to store serial numbers. You can also use the barcode scanner to scan a barcode number into the Serial Number fields (see [[Barcodes and Assets]]).
|-
| Warranty / License expiration dates
| You can set the expiration dates for Warranties (for Hardware) or Licenses (for Software) in the "Wrnty./Lic. Exp." field and use it to track expiration dates. When the due date is reached, this date turns red to indicate that this Asset's warranty or license is overdue. You can also filter results by expiration date to see which Assets are about to expire so that you can notify users of warranties or licenses which should be renewed. You can read more about this in the [[Warranty/License Expiration on Assets|Manage Warranty/License Expiration section]].
|-
| Purchase information
| For each Asset you can store purchase information, such as purchase date, delivery date, price, PO, and Invoice #.
|-
| Purchased From Us
| You can also store whether the Asset was purchased from you using the Purchased From Us flag in the Details tab. Note that when converting a won Sales Opportunity into an Asset, this flag will be automatically be set to true.
|-
| Vendor and Manufacturer information (tab)
| Use this section to store Vendor and Manufacturer information and terms, such as the vendor serial number, manufacturer serial number, vendor PO and Invoice #, vendor warranty expiration and more.
|-
| License Keys and Codes (tab)
| Store licenses and keys in this section to easily access equipment. You can also store special notes and instructions, such as "Need to login as admin in order to modify..."
|}

== Adding New Assets ==
New Assets can be added from the Account window, Ticket window, or Asset window. You can also import Assets from Excel® files, CSV files, or other tabular formats into CommitCRM. You can read more about importing Assets in [[Assets#Importing Assets|Importing Assets]]. When you click the New button, the New Asset window opens:

[[File:commit_assets_new.gif|center]]

In this window, you can set the Asset Name (mandatory), Asset Code, Quantity, Location and Description. You can also link the Asset to the Account who is the customer that owns the Asset.

For quick creation of Assets for specific Accounts, you can also add the Asset directly from the Account window:

[[File:commit_assets_new_from_account.gif|center]]

==Linking Assets to Tickets==
Each Asset can be linked to an Account as well as to a specific Ticket. Linking an Asset to a Ticket helps you track the Asset's service history (see [[Assets#Tracking_an_Asset.27s_Service_History|Tracking an Asset's]]).

When creating a new Ticket, you can select the relevant Asset which should be linked to this Ticket by clicking the drop-down menu and selecting the relevant Asset. If you want to add a new Asset to the Ticket, you can do so from within the New Ticket window by clicking the "+" button and adding the new Asset on-the-fly. This new Asset will be automatically linked to the Ticket and to the Account.

[[File:commit_assets_new_from_ticket.gif|center]]

== Searching for Assets ==
You can search for Assets by information stored in the various fields of the Asset.

[[File:commit_assets_search_toolbar.gif|center]]

The most common searches for Assets are based on Asset Name, Asset Code, Asset Description or the Asset's Serial Numbers. To find an Asset based on information stored in one of these fields, click on the drop-down menu next to Find to select the field where the requested information is stored:

[[File:commit_assets_search_menu.gif|center]]

== Tracking an Asset's Service History ==
When an Asset is reported to have a problem, you can open a Ticket and Link it to the Asset so you will have a history record of all service Tickets opened for this Asset. This helps you track recurring problems for the Asset, etc. Before fixing an Asset, you can easily view the Asset's service history to help you decide how to handle the problem.

You can view an Asset's entire Service History in the Asset window under the Tickets tab

[[File:commit_assets_service_tickets.gif|center]]

== Importing Assets ==
You can import Assets from Excel® files, CSV files, or other table formats into CommitCRM. When importing an Assets file, you should select the Asset type (Hardware, Software or Other), and optionally link all the imported Assets to a specific Account. If no Account is selected, the newly created Assets will not be linked to any Account, and you will be able to link them at a later stage.

To import Assets, on the Main menu select '''Tools > Import and Export > Import Assets:'''
#Select the file format.
#Select the type of Assets you want to import:''' Hardware, Software, or Other.'''
#Select whether to link all imported Assets to a selected Account or import them without assigning an Account to the newly created Assets.
#Map the imported data with the equivalent CommitCRM fields.
#Make sure you have all the mandatory fields in your input file. Specifically, make sure to map the Asset name as this is a mandatory field (see [[Assets#Field List|Field List]]).

You can also import Assets from the Assets tab in the Accounts window by right-clicking and selecting '''Import Assets...''' In this case all the imported Assets will be linked to the current Account).

== Transferring Assets between customers ==
Note that once an Asset is linked to an Account, and service Tickets are opened for it, this link to the Account becomes permanent (i.e. you cannot link it to any other Account). If you wish to transfer the Asset (the equipment or software license) to a different customer/Account, you should copy the Asset (right-click the Asset and select Copy...), and select the new customer for the Asset.

You can keep a link to the old Asset in the newly created Asset so you will be able to track its history later on. This can be done by adding a note which indicates that this is a new Asset, and that lists the old Asset's name/code.

== Customizing Assets ==
Each Asset includes many fields which help you store information for tracking the current status of equipment, as well as an Asset's service history so you can have a complete overview of an Asset's history next time you need to handle it.

In addition, you can also customize the Asset or Ticket to contain any additional information using user-defined fields (see Field1, Field2, etc. in the Details tab). Each customized field can be renamed (right-click the field name and select Field Settings), and you can set a list of values that will be available for this field in the drop-down menu (select the Edit List option). You can read more about customizing CommitCRM in the Setup Guide, under the [[Customization]] section.

== Web Access ==
In addition to managing Assets using the CommitCRM client software, the Commit Web Interface allows technicians to access all Asset details from anywhere using a web browser. Technicians at customer sites can easily view Asset details together with all the previous activity and service Tickets related to a selected Asset. They can also add new Assets, update Asset details or add new Tickets for existing Assets.

In addition, customers with web access can optionally have access to their Assets online. (Note that you can select not to show Assets to customers.)

[[File:commit_assets_web_list.gif|center]]

For each Asset, you can view the full Asset details, and edit it to modify Asset details.

[[File:commit_assets_web_details.gif|center]]

You can also open new Tickets for an Asset while on-site, directly from the Asset details window:

[[File:commit_assets_web_details_new_ticket.gif|center]]

==See Also==
*[[Preventive Maintenance]]
*[[Asset Warranties]]
*[[Return Material Authorization (RMA)]]
*[[Barcodes and Assets]]
*[[Assets FAQ]]
[[Category:User Manuals]]
[[Category:Service Management]]