<< Click to Display Table of Contents >> Navigation:  Integratie > Applicatie integratie

 

Het is vanaf Logicworks CRM 7.1 mogelijk om vanuit een andere applicatie te communiceren met Logicworks CRM. Om dit mogelijk te maken is wordt door Logicworks CRM gebruik gemaakt van poort 49491.

 

 

Voorbereiden Logicworks CRM

Om externe applicaties toegang te geven tot Logicworks CRM is het noodzakelijk dat op het werkstation het component xceedwsl.dll is geinstalleerd. U kunt de setup voor dit component downloaden van de Logicworks Klantportal. Kies hier de download Logicworks CRM Winsock 1.2 (dll) om de setup te downloaden en installeer het component op alle werkstations.  

 

Nadat het component xceedwsl.dll is geinstalleerd kunt u Logicworks CRM opnieuw starten. Het is hierbij noodzakelijk om als opstartparameter /allowapi mee te geven om externe toegang mogelijk te maken. De  Windows Firewall zal de eerste keer dat Logicworks CRM wordt gestart een beveiligingsmelding tonen. U dient in dit geval [Toegang toestaan] te selecteren, zodat ook de Firewall communicatie met Logicworks CRM toestaat.

 

 

onStart script

Het is mogelijk de externe applicatietoegang te activeren via het onStart script (Setup), dat direct na het inloggen wordt uitgevoerd. Het toestaan van de externe applicatietoegang wordt ingesteld middels de algemene logische systeemeigenschap LWCRM.AllowApiAccess.  Bijvoorbeeld:

 

LWCRM.AllowApiAccess = True

 

 

API

Zoals reeds werd vermeld, dient de communicatie met Logicworks CRM via poort 49491 te verlopen. Op dit ogenblik is het met de API alleen mogelijk aan Logicworks CRM opdracht te geven een detailvenster van bijvoorbeeld een Contactpersoon, Incident, etc. te openen.  De opdracht hiervoor wordt gegeven heeft de volgende indeling: show:{naam entiteit},{id}. Hierbij moeten de met accolades omgeven variabelen worden vervangen door de juiste waarden.

 

{naam entiteit}

Dit betreft de interne benaming van de entiteit, bijvoorbeeld 'contact', 'incident', etc. Deze kan worden bepaald via de kolom 'CRM Entiteit' (crmobjecttypes.entity) in de menuoptie Designers > Object Designer.

 

{id}

Hier dient de interne ID van het record ingevuld te worden. De kolom waarin de interne ID van het record van een entiteit wordt vastgelegd kan worden bepaald via de kolom 'Sleutelveld' (crmobjecttypes.primarykey) in de menuoptie Designers > Object Designer.

 

Aangezien de interne record ID meestal niet wordt weergegeven en voor gebruikers lastig is om te onthouden, kan als {id} ook gebruik gemaakt worden van een alternatief sleutelveld. Dit moet echter wel een veld van het type 'key' zijn. Bij incidenten is dat bijvoorbeeld het Incidentnummer (incidents.incidentnumber). Welke velden in aanmerking komen als {id} kunt u bepalen via het tabblad 'Velden' in de Object Designer. Bij deze velden wordt als type veld 'key' aangegeven.

 

Voorbeeld

Een voorbeeld van een API-instructie kan zijn: show:incident,11-0383. Logicworks CRM zal nu een proberen de doorgegeven id '11-0383' te vinden in de kolom incidents.incidentid of incidents.incidentnumber. Wordt deze inderdaad gevonden, dan zal het Incident-venster worden geopend en de gegevens van het doorgegeven incident zullen worden ingelezen.

 

 

Opstartparameter

Een andere, wellicht eenvoudiger te implementeren, integratieoptie is gebruik te maken van de opstartparameter show. Tijdens het starten van Logicworks CRM wordt gecontroleerd of de opstartparameter '/show' wordt gebruikt. Is dat het geval dan wordt de desbetreffende kaart direct na het starten getoond. Als Logicworks CRM bij het opstarten echter constateert, dat de applicatie al is gestart, dan wordt deze opstartparameter doorgegeven aan de lopende applicatie. Het opstarten van de tweede Logicworks CRM instantie wordt vervolgens (zonder de gebruikelijke waarschuwingsmelding) weer afgebroken. Aangezien gebruikers niet zien dat de tweede instantie wordt gestart, lijkt het alsof de parameter direct is doorgegeven aan de lopende Logicworks CRM applicatie.

 

 

URL Protocol

Het is mogelijk een in de Windows Registry een URL protocol te definieren voor Logicworks CRM. Hierdoor wordt het mogelijk Logicworks CRM te starten middels een URL gevolgd door de gewenste parameters.  Een toelichting op het gebruik en definitie van een dergelijk protocol wordt beschreven op de volgende webpagina: http://msdn.microsoft.com/en-us/library/aa767914(v=vs.85).aspx.

 

Hieronder wordt een voorbeeld van mogelijke Logicworks CRM URL Protocol definitie getoond. In dit voorbeeld wordt de Logicworks CRM applicatie gestart vanuit het pad '\\lwcrmserver02\projects\Logicworks CRM'. U dient dat uiteraard te vervangen met uw eigen netwerkmap waarin Logicworks CRM is geinstalleerd.

 

HKEY_CLASSES_ROOT

lwcrm

   (Default)    = URL:lwcrm-protocol

   URL Protocol =

  DefaultIcon

     (Default) = lwcrm.exe,1

  shell

    open

      command

         (Default) = "\\lwserver02\projects\Logicworks CRM\lwcrm.exe" /show:%1

 

 

Het testen of de URL Protocol correct functioneert, kunt u eenvoudig testen met behulp van een browser, zoals Internet Explorer, Firefox of Chrome. Type in de adresbalk de volgende instructie lwcrm:{naam entiteit},{id} in, en vervang daarbij de variabelen door bestaande waarden. Logicworks CRM moet nu opstarten en na het inloggen het opgegeven detailvenster openen. Als Logicworks CRM al is gestart, dan moet direct het detailvenster worden geopend in de lopende Logicworks CRM instantie.