Online Services: Difference between revisions

From RangerMSP Wiki - PSA software for MSPs and IT services providers
Jump to navigation Jump to search
Line 212: Line 212:
|}
|}


===Displaying HP Warranties===
===Displaying Online Warranties Checks===
'''Contributed by DavidW'''
'''Contributed by DavidW'''



Revision as of 13:48, 20 August 2009

Integration > Online Services

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.

Parameters Values
Name Google Maps
Base URL http://maps.google.com/maps
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.

Parameters Values
Name MapQuest
Base URL http://www.mapquest.com/maps
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.

Parameters Values
Name Yahoo! Maps
Base URL http://maps.yahoo.com
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.

Parameters Values
Name Google Company
Base URL http://www.google.com/search
URL Parameters ?q=<CMTLBLDATA_FLDCRDCOMPANY>

Google Contact - Opens Google and searches for the Contact Name.

Parameters Values
Name Google Contact
Base URL http://www.google.com/search
URL Parameters ?q=<CMTLBLDATA_FLDCRDCONTACT>

Finding Ticket Description in Google

Google Ticket - Opens Google and searches for the Ticket description.

Parameters Values
Name Google Search for Ticket Description
Base URL http://www.google.com/search
URL Parameters ?q=<CMTLBLDATA_FLDTKTPROBLEM>

Finding Account Address From Ticket (using Lookup Field)

Google Address From Ticket - Opens Google and searches for the Address of the Account which is linked to the Ticket.

Parameters Values
Name Google Search for Ticket's Account Address
Base URL http://maps.google.com/maps
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>).

Parameters Values
Data Source Assets
Name HP Warranty Lookup
Base URL http://h20000.www2.hp.com/bizsupport/TechSupport/WarrantyResults.jsp?
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://).

Parameters Values
Data Source Accounts
Name Domain WHOIS (NetworkSolutions)
Base URL http://www.networksolutions.com/whois-search/
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://).

Parameters Values
Data Source Accounts
Name Domain WHOIS (DomainTools)
Base URL http://whois.domaintools.com/
URL Parameters <CMTLBLDATA_FLDCRDURL1>

Parameters list

Parameters List for Accounts

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

Field Name Parameter Name to Use
Account (Lookup field) <CMTLBLDATA_FLDASTACCRECID>
Asset Code <CMTLBLDATA_FLDASTASSETCODE>
Asset Type <CMTLBLDATA_FLDASTASSETTYPE>
Contact (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

Field Name Parameter Name to Use
Account (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 (Lookup field) <CMTLBLDATA_FLDBCTDEFITMEXPNS>
Default Item Labor (Lookup field) <CMTLBLDATA_FLDBCTDEFITMLABOR>
Default Item Part (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

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

Field Name Parameter Name to Use
Amount <CMTLBLDATA_FLDOPPAMOUNT>
Amount by Probability <CMTLBLDATA_FLDOPPCALCAMOUNT>
Account (Lookup field) <CMTLBLDATA_FLDOPPCARDID>
Closing amnt <CMTLBLDATA_FLDOPPCLOSEAMOUNT>
Close <CMTLBLDATA_FLDOPPCLOSEDATE>
Currency <CMTLBLDATA_FLDOPPCOINID>
Contact (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

Field Name Parameter Name to Use
Asset (Lookup field) <CMTLBLDATA_FLDTKTASSETRECID>
Contract (Lookup field) <CMTLBLDATA_FLDTKTBCRECID>
Account (Lookup field) <CMTLBLDATA_FLDTKTCARDID>
Category <CMTLBLDATA_FLDTKTCATEGORY>
Cause <CMTLBLDATA_FLDTKTCAUSE>
Close Date <CMTLBLDATA_FLDTKTCLOSEDATETIME>
Contact (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

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