Installatiehandleiding ‘Cane Webservices.nl Integratie’
Inhoud INHOUD ........................................................................................................................................................... 1 1.
INTRODUCTIE ........................................................................................................................................... 2 DOELSTELLING DOCUMENT......................................................................................................................................... 2 GERELATEERDE DOCUMENTEN .................................................................................................................................... 2 GEBRUIK VAN HET DOCUMENT .................................................................................................................................... 2 LEZERS DOELGROEP .................................................................................................................................................. 2
2.
DE SOFTWARE .......................................................................................................................................... 3 INHOUD VAN DE INSTALLATIESET. ................................................................................................................................ 3 (INSTALLATIE) EISEN ................................................................................................................................................. 3
3.
INSTALLATIE WEBSERVICES.NL ................................................................................................................. 4 INSTALLATIE STAPPEN OP EXACT SYNERGY ENTERPRISE .................................................................................................... 4
4.
STAPPEN NA DE INSTALLATIE ................................................................................................................... 5 INSTELLINGEN EXACT SYNERGY ENTERPRISE ................................................................................................................... 5 CONTROLE WERKING WEBSERVICES.NL MODULE ............................................................................................................ 5 BEKENDE (FOUT)MELDINGEN ...................................................................................................................................... 5
5.
BACKGROUNDJOB VOOR BINNENHALEN INDICATIE VAN WIJZIGING........................................................ 6 DE URL ................................................................................................................................................................. 6
APPENDIX A – DETAIL INHOUD VAN DE INSTALLATIE MAP............................................................................... 7
Versie 1.0 Cane Webservices.nl Integratie
|1
1. Introductie In dit document wordt de installatie en configuratie van de Cane Webservices.nl Integratie module besproken. In dit document wordt de nadruk gelegd op de volgende onderwerpen: 1. Installatie van de Exact Synergy Enterprise software. 2. Inrichting van de Cane Webservices.nl integratie module Vanaf nu wordt de module Cane Webservices.nl Integratie module ‘Webservices.nl’ module genoemd. Doelstelling document Na het lezen van dit document kan een consultant of een beheerder van de Exact Software de installatie van Webservices.nl module op de juiste manier uitvoeren. Daarnaast is de lezer in staat om de installatie te testen en goed te keuren. Indien er problemen ontstaan, kan de lezer eventueel oplossingen definiëren of de juiste gegevens aan de helpdesk van Cane doorsturen. Gerelateerde documenten De volgende documenten zijn een aanvulling op de informatie rondom de Webservices.nl module: Documentnaam Handleiding voor Applicatiebeheerders Cane Webservices.nl Integratie Gebruikers handleiding Cane Webservices.nl Integratie
Omschrijving Handleiding met extra informatie voor applicatiebeheerders van de Cane Webservices Integratie module. Gebruikershandleiding waarin de werking van de Cane Webservices.nl Integratie module worden besproken.
Gebruik van het document Gebruik dit document als ondersteuning bij het installeren van de Webservices.nl module. Door het document goed door te lezen kunt u deze installatie eenvoudig zelf uitvoeren. Lezers doelgroep Het document is bestemd voor de volgende doelgroepen:
Doelgroep Consultants Systeembeheerders
Omschrijving Consultants die vanuit hun opdracht de software voor de Cane Webservices.nl Integratie moeten installeren. Persoon verantwoordelijke voor het onderhoud en inrichten van het Exact Synergy Enterprise systeem.
Versie 1.0 Cane Webservices.nl Integratie
|2
2. De software De Webservices.nl oplossing bestaat uit een aantal verschillende componenten. In de volgende hoofdstukken worden deze componenten kort besproken. Inhoud van de installatieset. De installatie set bestaat uit een aantal verschillende software componenten. Onderstaande tabel laat zien welke componenten dat zijn. Voor een volledige inhoud van de mappen kunt u bijlage A raadplegen. Map BIN Docs SQL
XML
Omschrijving Bevat alle DLL’s voor de Webservices.nl module. Bevat alle ASPX en Images van de Webservices.nl module. Bevat de SQL scripts voor de Webservices.nl module en is onder andere verantwoordelijk voor het aanmaken van tabellen en functies. Bevat alle XML files voor de Webservices.nl module.
Figuur 1: Installatieset van de Webservices.nl module
(Installatie) Eisen U dient minimaal te voldoen aan de volgende (installatie) eisen, voordat u de Webservices.nl module installeert en in gebruik kan nemen: • • • •
De installatie dient minimaal op batch versie 252 van Exact Synergy Enterprise of hoger te worden uitgevoerd. U dient rekening te houden met de systeemeisen van de Exact Synergy Enterprise voor de batch waarmee gewerkt wordt. Installeren van het maatwerk dient uitgevoerd te worden door iemand met de Administrator rol in Exact Synergy Enterprise én Administrator rechten binnen het netwerk. Om als gebruiker gebruik te kunnen maken van de module dient men de licentierol: YA53011 Enabling add-on solutions role te gebruiken in combinatie met de licentierol YA0020 Professional Role of de licentierol YA0023 CRM role.
Versie 1.0 Cane Webservices.nl Integratie
|3
3. Installatie Webservices.nl Voor een volledige werkende omgeving zijn een aantal verschillende installatie stappen nodig. In dit hoofdstuk worden deze per onderdeel besproken. Let op dat al deze zaken worden uitgevoerd! Indien er stappen worden vergeten dan loopt u het risico dat de installatie niet compleet is en bepaalde functies niet werken. Installatie stappen op Exact Synergy Enterprise Voer de volgende stappen uit om de Webservices.nl module softwarematig te installeren voor Exact Synergy Enterprise: • • • •
•
•
Zorg voor een back-up van de Exact Synergy Database; Lokaliseer de installatie map van Exact Synergy Enterprise en stel deze veilig; Kopieer de Webservices.nl installatie bestanden naar de server; Kopieer de inhoud van de installatie map naar de gelijknamige mappen in Synergy. Dus de bin naar de bin, de XML naar de XML, de docs naar de docs, de images naar de docs/images map en de SQL naar de SQL map; Open Exact Synergy Enterprise. Wanneer u de Webservices.nl module voor de eerste keer installeert zal Exact Synergy Enterprise opnieuw gaan opbouwen. Dit betekent dat er een SQL script wordt uitgevoerd en nieuwe tabellen worden aangemaakt. Ook zal de repository van Exact worden aangepast. Het bijwerken van de database dient uitgevoerd te worden door iemand met de Administrator rol binnen Exact Synergy Enterprise en met Administrator rechten binnen het netwerk. Na het bijwerken zal Exact Synergy Enterprise worden geopend en kan de Webservices.nl module zichtbaar gemaakt worden via de voorkeur instellingen pagina. Indien u een upgrade doet, worden SQL wijzigingen door middel van batch to batch scripts uitgevoerd. Dit wordt automatisch gedaan bij het openen van Exact Synergy Enterprise.
Versie 1.0 Cane Webservices.nl Integratie
|4
4. Stappen na de installatie Nadat u de software heeft geïnstalleerd dient u de koppeling naar Webservices.nl te leggen. Instellingen Exact Synergy Enterprise Voor een correcte werking van het Webservices.nl module dient u de volgende instelling in te vullen 1. Webservices.nl>Inrichting>Algemeen>Instellingen. 2. Vul de volgende gegevens bij de sectie ‘Inloggegevens’; Gebruikersnaam bij Webservices.nl Wachtwoord van Webservices.nl 3. In de sectie ‘Standaardwaarde’ is het mogelijk een standaard ‘bron’ op te geven voor relaties aangemaakt via de Webservices.nl module. Dit is niet een verplicht veld. Controle werking Webservices.nl module Bij het aanmaken van een nieuwe relatie zal het ‘Bedrijven: Zoeken’ geopend worden.
Figuur 2: Bedrijven: Zoeken scherm
Zoek een willekeurig bedrijf. Indien de koppeling juist werkt, zal een resultaat teruggegeven worden.
Bekende (fout)meldingen •
Indien de login gegevens incorrect zijn, zal de Webservices.nl module de volgende melding teruggeven:
Figuur 3: Authenticatie probleem. Controleer de Webservices.nl gebruikersnaam en wachtwoord.
Controleert u login gegevens nog een keer. Zijn deze correct? Neem dan contact op met Webservices.nl. •
Indien een probleem met de internetverbinding zich voordoet, dan zal de volgende melding getoond worden:
Figuur 4: Webservices.nl is onbereikbaar. Controleer de internetverbinding op de server
Controleer de internetverbinding van de webserver (‘Synergy’ server). •
Krijgt u bij het zoeken geen foutmelding, maar ook geen resultaat terug? Neem dan contact op met Webservices.nl, het kan zijn dat het ‘tegoed’ bij Webservices.nl op is.
Versie 1.0 Cane Webservices.nl Integratie
|5
5. Backgroundjob voor binnenhalen indicatie van wijziging Het binnenhalen van indicaties van wijzigingen kan functioneel via Webservices.nl, Overzichten, Bijwerken, Haal gewijzigde relaties op. Echter kan dit ook via een ‘backgroundjob’ opgehaald worden. De URL De te gebruiken jobnaam is: CSCaneWebNL.Jobs De te gebruiken class is: GetUpdatedDossiers De url ziet er als volgt uit: “*BestandenPadSynergy*\bin\Exact.Process.exe" /DBCONFIG:*VIRTUALDirectory van Synergy* /ASSEMBLY:CSCaneWebNL.Jobs /CLASS:GetUpdatedDossiers Voorbeeld: "C:\Exact\Synergy Enterprise\bin\Exact.Process.exe" /DBCONFIG:Synergy /ASSEMBLY:CSCaneWebNL.Jobs /CLASS:GetUpdatedDossiers Deze url is te gebruiken in een Windows Taak of via de SQL Server Agent. Let op: bij het inrichten van de background job via SQL Server Agent is het van belang dat het account waaronder de SQL Server Agent draait toegang heeft (Professional Licentierol + Administrator rol) tot Synergy.
Versie 1.0 Cane Webservices.nl Integratie
|6
Appendix A – Detail inhoud van de installatie map MAP
Inhoud
Bin
CSCaneWebNL.Data.dll CSCaneWebNL.dll CSCaneWebNL.Extension.dll CSCaneWebNL.General.dll CSCaneWebNL.Jobs.dll
Docs/Images
CSCaneWebNL.png CSCaneWebNL-equal.png CSCaneWebNL-s.ico CSCaneWebNL-s.png CSCaneWebNL-transparent.png
DOCS
CSCaneWebNLAccountSearch.aspx CSCaneWebNLAccountsToBeUpdated.aspx CSCaneWebNLAccountsUpdate.aspx CSCaneWebNLAddressSearch.aspx CSCaneWebNLSettings.aspx CSCaneWebNLUpdateAccount.aspx
SQL
CSCaneWebNL.sql
XML
Applications.CSCaneWebNL.xml Custom.CSCaneWebNL.xml Menu.CSCaneWebNL.xml Repository.CSCaneWebNL.xml Terms.CSCaneWebNL.xml
Versie 1.0 Cane Webservices.nl Integratie
|7