Handleiding voor de applicatiebeheerder Cane Webservices.nl Integratie

Transcriptie

1 Handleiding voor de applicatiebeheerder Cane Webservices.nl Integratie

2 Versie 1.1 Cane Webservices.nl Integratie Handleiding voor de Applicatiebeheerder 1

3 Inhoud INHOUD INTRODUCTIE... 3 DOELSTELLING DOCUMENT... 3 GERELATEERDE DOCUMENTEN... 3 GEBRUIK VAN HET DOCUMENT... 3 LEZERS DOELGROEP INRICHTING WEBSERVICES.NL KOPPELING... 4 INSTELLINGEN EXACT SYNERGY ENTERPRISE... 4 CONTROLE WERKING WEBSERVICES.NL MODULE BACKGROUNDJOB VOOR BINNENHALEN INDICATIE VAN WIJZIGING... 5 DE URL DE MAATWERKTABELLEN... 6 CSCANEWEBNLCICMPY... 6 CSCANEWEBNLLEGALFORMS... 6 CSCANEWEBNLSBILEVEL CSCANEWEBNLSBILEVEL CSCANEWEBNLSBILEVEL CSCANEWEBNLSBILEVEL CSCANEWEBNLSBISECTIONS... 6 CSCANEWEBNLCOMPANYSIZE BEKENDE (FOUT)MELDINGEN... 8 AUTHENTICATIE PROBLEEM. CONTROLEER DE WEBSERVICES.NL GEBRUIKERSNAAM EN WACHTWOORD... 8 WEBSERVICES.NL IS ONBEREIKBAAR. CONTROLEER DE INTERNETVERBINDING OP DE SERVER... 8 ONVERWACHTE EN ONBEKENDE FOUT OPGETREDEN... 8 GEEN RESULTAAT NA HET INGEVEN VAN EEN ZOEKACTIE... 8 ONVOLDOENDE SALDO OM DEZE ACTIE UIT TE VOEREN... 8 BIJ HET AANMAKEN VAN EEN NIEUWE RELATIE KOM IK NIET EERST IN HET ZOEKSCHERM, MAAR GA IK GELIJK NAAR HET AANMAKEN: RELATIE SCHERM... 8 BIJLAGE A EXTRA INFORMATIE MAATWERKTABELLEN... 9 BIJLAGE A.1 CSCANEWEBNLCICMPY... 9 BIJLAGE A.2 CSCANEWEBNLLEGALFORMS BIJLAGE A.3 CSCANEWEBNLSBILEVEL BIJLAGE A.4 CSCANEWEBNLSBILEVEL BIJLAGE A.5 CSCANEWEBNLSBILEVEL BIJLAGE A.6 CSCANEWEBNLSBILEVEL BIJLAGE A.7 CSCANEWEBNLSBISECTIONS BIJLAGE A.8 CSCANEWEBNLCOMPANYSIZE Versie 1.1 Cane Webservices.nl Integratie Handleiding voor de Applicatiebeheerder 2

4 1. Introductie In dit document komen wat achtergrond zaken aan bod, waarmee de applicatiebeheerder meer informatie krijgt over de werking 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 applicatiebeheerder of een beheerder van de Exact Software de gebruikers van de Webservices.nl module ondersteunen. Daarnaast 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 Gebruikers handleiding Cane Webservices.nl Integratie Installatie handleiding Cane Webservices.nl Integratie Omschrijving Gebruikershandleiding waarin de werking van de Cane Webservices.nl Integratie module worden besproken. Installatie handleiding waarin de installatie van de Cane Webservices.nl Integratie module worden besproken. Gebruik van het document Gebruik dit document als ondersteuning bij het beheren van de Webservices.nl module applicatie. Lezers doelgroep Het document is bestemd voor de volgende doelgroepen: Doelgroep Applicatiebeheerders Systeembeheerders Omschrijving Applicatiebeheerders die vanuit hun opdracht de software voor de Cane Webservices.nl Integratie moeten onderhouden. Persoon verantwoordelijk voor het onderhoud en inrichten van het Exact Synergy Enterprise systeem. Versie 1.1 Cane Webservices.nl Integratie Handleiding voor de Applicatiebeheerder 3

5 2. Inrichting Webservices.nl koppeling Nadat de software geïnstalleerd is, dient 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 1: Bedrijven: Zoeken scherm Zoek een willekeurig bedrijf. Indien de koppeling juist werkt, zal een resultaat teruggegeven worden. Versie 1.1 Cane Webservices.nl Integratie Handleiding voor de Applicatiebeheerder 4

6 3. 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.1 Cane Webservices.nl Integratie Handleiding voor de Applicatiebeheerder 5

7 4. De maatwerktabellen De Webservices.nl module heeft de volgende maatwerktabellen. CSCaneWebNLCicmpy CSCaneWebNLLegalForms CSCaneWebNLSBILevel1 CSCaneWebNLSBILevel2 CSCaneWebNLSBILevel3 CSCaneWebNLSBILevel4 CSCaneWebNLSBISections CSCaneWebNLCompanySize CSCaneWebNLCicmpy In deze tabel wordt de link gelegd met de relatie tabel (cicmpy). Informatie over het dossiernummer en laatst bijgewerkte datum (bij Kvk) worden vastgelegd in deze tabel. Ook de update indicatie staat weg geschreven in deze tabel. Zie bijlage A.1 voor de tabelvelden en extra uitleg. CSCaneWebNLLegalForms In deze tabel worden de beschikbare rechtsvormen vastgelegd. Deze worden met de installatie van de Webservices.nl module meegeleverd. Zie bijlage A.2 voor de tabelvelden en extra uitleg. CSCaneWebNLSBILevel1 In deze tabel worden de beschikbare sectorcodes (2 cijferig) vastgelegd. Deze worden met de installatie van Webserces.nl module meegeleverd. Zie bijlage A.3 voor de tabelvelden en extra uitleg. CSCaneWebNLSBILevel2 In deze tabel worden de beschikbare sectorcodes (3 cijferig) vastgelegd. Deze tabel wordt gevuld met de door Webservices.nl opgehaalde gegevens. Zie bijlage A.4 voor de tabelvelden en extra uitleg. CSCaneWebNLSBILevel3 In deze tabel worden de beschikbare sectorcodes (4 cijferig) vastgelegd. Deze tabel wordt gevuld met de door Webservices.nl opgehaalde gegevens. Zie bijlage A.5 voor de tabelvelden en extra uitleg. CSCaneWebNLSBILevel4 In deze tabel worden de beschikbare sectorcodes (5 cijferig) vastgelegd. Deze tabel wordt gevuld met de door Webservices.nl opgehaalde gegevens. Zie bijlage A.6 voor de tabelvelden en extra uitleg. CSCaneWebNLSBISections In deze tabel worden de beschikbare sectorcodes (letters) vastgelegd. Deze worden met de installatie van de Webservices.nl module meegeleverd. Zie bijlage A.7 voor de tabelvelden en extra uitleg. Versie 1.1 Cane Webservices.nl Integratie Handleiding voor de Applicatiebeheerder 6

8 CSCaneWebNLCompanySize In deze meelooptabel (met standaard tabel CiSize) worden de vanaf aantal medewerkers en t/m aantal medewerkers vastgelegd van bedrijfsgroottes. Zie bijlage A.8 voor de tabelvelden en extra uitleg. (beschikbaar vanaf versie ) Versie 1.1 Cane Webservices.nl Integratie Handleiding voor de Applicatiebeheerder 7

9 5. Bekende (fout)meldingen In dit hoofdstuk worden de bekende (fout)meldingen weergegeven. Authenticatie probleem. Controleer de Webservices.nl gebruikersnaam en wachtwoord Indien de login gegevens incorrect zijn, zal de Webservices.nl module de volgende melding teruggeven: Figuur 2: Authenticatie probleem. Controleer de Webservices.nl gebruikersnaam en wachtwoord. Webservices.nl is onbereikbaar. Controleer de internetverbinding op de server Indien een probleem met de internetverbinding zich voordoet, dan zal de volgende melding getoond worden: Figuur 3: Webservices.nl is onbereikbaar. Controleer de internetverbinding op de server Controleer de internetverbinding van de webserver ( Synergy server). Onverwachte en onbekende fout opgetreden Neem contact op met de systeembeheerder. Er heeft zich een fout voorgedaan op de webserver. Geen resultaat na het ingeven van een zoekactie 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. Onvoldoende saldo om deze actie uit te voeren Neem dan contact op met Webservices.nl, het tegoed bij Webservices.nl is op. Bij het aanmaken van een nieuwe relatie kom ik niet eerst in het zoekscherm, maar ga ik gelijk naar het aanmaken: relatie scherm Indien u een natuurlijk persoon aan het aanmaken ben, dan klopt dit. Hierop kunt u niet in het KvK zoeken. Indien u een relatie wilt aanmaken dan dient u te controleren of u beschikt over een Enable add-on licentie rol in combinatie met OF een professional licentie rol OF een CRM rol. Indien u hierover niet beschikt, dan kunt u inderdaad geen gebruik maken van het aanmaken van relaties via de Webservices.nl Module. Heeft u de benodigde licentie rollen wel, dan dient u de login gegevens van Webservices te (laten) controleren. Deze vindt u terug onder Webservices.nl/ Inrichting/ Algemeen/ Instellingen. Indien deze NIET gevuld staan, dan zal u bij het aanmaken van relaties altijd uitkomen in het aanmaken relatie scherm. Versie 1.1 Cane Webservices.nl Integratie Handleiding voor de Applicatiebeheerder 8

10 Bijlage A maatwerktabellen In deze bijlage vindt u extra uitleg over de maatwerktabellen Bijlage A.1 CSCaneWebNLCicmpy LinkID DossierNumber EstablishmentNumber MainEstablishmentNumber IndicationMainEstablishment TradeNameFull RSINnumber LegalFormCode IndicationOrganisationCode Koppeling naar de cmp_wwn veld in tabel cicmpy KvK nummer en dossiernummer bij Webservices.nl. Op basis van dit gegeven wordt bekeken of een update van gegevens beschikbaar is. Vestigingsnummer. Niet functioneel zichtbaar. Hoofdvestigingsnummer. Niet functioneel zichtbaar. Indicatie hoofdvestiging. Niet functioneel zichtbaar. Volledige handelsnaam. RSIN nummer (Rechtspersonen Samenwerkingsverbanden Informatie Nummer). Rechtsvorm code. Koppeling met het code veld in tabel CSCaneWebNLLegalForms. Soort organisatie. Vast gedefinieerd. Volgende mogelijkheden zijn er: O Onderneming V Vereniging S Stichting K Kerkgenootschap IndicationEconomicallyActive Indicatie Economisch actief. ( 0=geen vinkje, 1=vinkje) IndicationBankruptcy Indicatie Failliet. ( 0=geen vinkje, 1=vinkje) Indien waarde = 1, dan zal op de relatiekaart (bewerken modus) in rode dik gedrukte letters het veld Failliet worden weergegeven. Dit is in de bewerken modus niet zichtbaar. IndicationDIP Indicatie Surseance. ( 0=geen vinkje, 1=vinkje) DateLastUpdate Datum gegevens laatst bijgewerkt in het KvK. NeedsUpdate Update aanwezig. (0= geen update benodigd, 1=update van gegevens beschikbaar). Als dit veld op 1 staat, dan is de button Webservices.nl: Bijwerken beschikbaar op de relatiekaart en komt de relatie naar voren in het menupad Webservices.nl, Overzichten, Bijwerken, Bij te werken Relaties. NeedsUpdateLegalform Update aanwezig voor Rechtsvorm. (0= geen update aanwezig, 1= update aanwezig). Indien dit veld op 1 staat, dan wordt in het overzicht Webservices.nl, Overzichten, Bijwerken, Bij te werken relaties naast de kolom Bijwerken onder de i icoon getoond dat het veld rechtsvorm gewijzigd is. NeedsUpdateName Update aanwezig voor Bedrijfsnaam. (0= geen update aanwezig, 1= update aanwezig). Indien dit veld op 1 staat, dan wordt in het overzicht Webservices.nl, Overzichten, Bijwerken, Bij te werken relaties naast de kolom Bijwerken onder de i icoon getoond dat het veld Bedrijfsnaam gewijzigd is. NeedsUpdateEstablishmentAddress Update aanwezig voor Vestigingsadres. (0= geen update aanwezig, 1= update aanwezig). Indien dit veld op 1 staat, dan wordt in het overzicht Webservices.nl, Overzichten, Bijwerken, Bij te werken relaties naast de kolom Bijwerken onder de i icoon getoond dat het Vestigingsadres gewijzigd is. Versie 1.1 Cane Webservices.nl Integratie Handleiding voor de Applicatiebeheerder 9

11 NeedsUpdateCorrespondenceAddress Update aanwezig voor Correspondentieadres. (0= geen update aanwezig, 1= update aanwezig). Indien dit veld op 1 staat, dan wordt in het overzicht Webservices.nl, Overzichten, Bijwerken, Bij te werken relaties naast de kolom Bijwerken onder de i icoon getoond dat het veld Correspondentie gewijzigd is. NeedsUpdateContact Update aanwezig voor Contactpersoon. (0= geen update aanwezig, 1= update aanwezig). Indien dit veld op 1 staat, dan wordt in het overzicht Webservices.nl, Overzichten, Bijwerken, Bij te werken relaties naast de kolom Bijwerken onder de i icoon getoond dat de contactpersoon gewijzigd is. NeedsUpdateActivity Update aanwezig voor het veld Sector/ SBI sectie. (0= geen update aanwezig, 1= update aanwezig). Indien dit veld op 1 staat, dan wordt in het overzicht Webservices.nl, Overzichten, Bijwerken, Bij te werken relaties naast de kolom Bijwerken onder de i icoon getoond dat het veld Sector/ SBI sectie gewijzigd is. NeedsUpdateFinancialStatus Update aanwezig voor de velden Failliet en/of In surseance. (0= geen update aanwezig, 1= update aanwezig). Indien dit veld op 1 staat, dan wordt in het overzicht Webservices.nl, Overzichten, Bijwerken, Bij te werken relaties naast de kolom Bijwerken onder de i icoon getoond dat de velden Failliet en/of in surseance gewijzigd is. NeedsUpdateStatus Update aanwezig voor het veld Economisch Actief. (0= geen update aanwezig, 1= update aanwezig). Indien dit veld op 1 staat, dan wordt in het overzicht Webservices.nl, Overzichten, Bijwerken, Bij te werken relaties naast de kolom Bijwerken onder de i icoon getoond dat het veld Economisch Actief gewijzigd is. NeedsUpdateEstablishment Update aanwezig voor het database veld Vestigingsnummer. (0= geen update aanwezig, 1= update aanwezig). Dit veld wordt alleen op de achtergrond gebruikt. NeedsUpdateRSIN Update aanwezig voor het veld RSIN nummer. (0= geen update aanwezig, 1= update aanwezig). Indien dit veld op 1 staat, dan wordt in het overzicht Webservices.nl, Overzichten, Bijwerken, Bij te werken relaties naast de kolom Bijwerken onder de i icoon getoond dat het veld RSIN nummer gewijzigd is. SBISector Veld Standaard Bedrijfs Indeling: Sectie. Veld is niet functioneel te wijzigen en alleen in de bekijken modus van een relatiekaart zichtbaar. Koppeling naar het code veld in tabel CSCaneWebNLSBISections. SBILevel1 Veld Standaard Bedrijfs Indeling: Niveau 1. Veld is niet functioneel te wijzigen en alleen in de bekijken modus van een relatiekaart zichtbaar. Koppeling naar het code veld in tabel CSCaneWebNLSBILevel1. SBILevel2 Veld Standaard Bedrijfs Indeling: Niveau 2. Veld is niet functioneel te wijzigen en alleen in de bekijken modus van een relatiekaart zichtbaar. Koppeling naar het code veld in tabel CSCaneWebNLSBILevel2. SBILevel3 Veld Standaard Bedrijfs Indeling: Niveau 3. Veld is niet functioneel te wijzigen en alleen in de bekijken modus van een relatiekaart zichtbaar. Koppeling naar het code veld in tabel CSCaneWebNLSBILevel3. SBILevel4 Veld Standaard Bedrijfs Indeling: Niveau 4. Veld is niet functioneel te wijzigen en alleen in de bekijken modus van een relatiekaart zichtbaar. Koppeling naar het code veld in tabel CSCaneWebNLSBILevel4. Versie 1.1 Cane Webservices.nl Integratie Handleiding voor de Applicatiebeheerder 10

12 Bijlage A.2 CSCaneWebNLLegalForms Code Code. Deze code wordt weggeschreven in het veld LegalFormCode in tabel CSCaneWebNLCicmpy Description Omschrijving van de Rechtsvorm. Dit wordt daadwerkelijk weergegeven op de relatiekaart. Bijlage A.3 CSCaneWebNLSBILevel1 Section Code DescriptionNL DescriptionEN SBI Sectie. Koppeling met het code veld van tabel CSCaneWebNLSBISections Code van de SBI Level 1. Koppeling met veld SBILevel1 in tabel CSCaneWebNLCicmpy en met het veld Level in tabel CSCaneWebNLSBILevel2 Nederlandstalige omschrijving van de sector. Getoond indien voorkeurstaal op NL staat. Engelstalige omschrijving van de sector. Getoond indien voorkeurstaal andere taal dan NL staat. Bijlage A.4 CSCaneWebNLSBILevel2 Level Code DescriptionNL DescriptionEN Code van de bijbehorende SBI Level 1. Koppeling met het veld Code in tabel CSCaneWebNLSBILevel1 Code van de SBI Level 2. Koppeling met veld SBILevel2 in tabel CSCaneWebNLCicmpy en met het veld Level in tabel CSCaneWebNLSBILevel3 Nederlandstalige omschrijving van de sector. Getoond indien voorkeurstaal op NL staat. Engelstalige omschrijving van de sector. Getoond indien voorkeurstaal andere taal dan NL staat. Bijlage A.5 CSCaneWebNLSBILevel3 Level Code DescriptionNL DescriptionEN Code van de bijbehorende SBI Level 2. Koppeling met het veld Code in tabel CSCaneWebNLSBILevel2 Code van de SBI Level 3. Koppeling met veld SBILevel3 in tabel CSCaneWebNLCicmpy en met het veld Level in tabel CSCaneWebNLSBILevel4 Nederlandstalige omschrijving van de sector. Getoond indien voorkeurstaal op NL staat. Engelstalige omschrijving van de sector. Getoond indien voorkeurstaal andere taal dan NL staat. Bijlage A.6 CSCaneWebNLSBILevel4 Level Code DescriptionNL DescriptionEN Code van de bijbehorende SBI Level 3. Koppeling met het veld Code in tabel CSCaneWebNLSBILevel3 Code van de SBI Level 4. Koppeling met veld SBILevel4 in tabel CSCaneWebNLCicmpy Nederlandstalige omschrijving van de sector. Getoond indien voorkeurstaal op NL staat. Engelstalige omschrijving van de sector. Getoond indien voorkeurstaal andere taal dan NL staat. Versie 1.1 Cane Webservices.nl Integratie Handleiding voor de Applicatiebeheerder 11

13 Bijlage A.7 CSCaneWebNLSBISections Code Code van de SBISector. Koppeling met veld SBISector in tabel CSCaneWebNLCicmpy en veld Section in tabel CSCaneWebNLSBILevel1 DescriptionNL Nederlandstalige omschrijving van de sector. Getoond indien voorkeurstaal op NL staat. DescriptionEN Engelstalige omschrijving van de sector. Getoond indien voorkeurstaal andere taal dan NL staat. Bijlage A.8 CSCaneWebNLCompanySize FromEmployees Vanaf aantal medewerkers UntilEmployees T/m aantal medewerkers LinkID Code bedrijfsgrootte. Koppeling met het siz_code veld in tabel cisize. Dit is de standaard tabel voor het vastleggen van groottes codes. Versie 1.1 Cane Webservices.nl Integratie Handleiding voor de Applicatiebeheerder 12