Changepoint API Software Installationsvejledning

API installationsvejledning
Referencevejledning
Changepoint 2021

© 2021 Changepoint Canada ULC. Alle rettigheder forbeholdes. RETTIGHEDER FOR amerikansk regering - Brug, duplikering eller offentliggørelse af den amerikanske regering er underlagt begrænsninger som angivet i Changepoint Canada ULC-licensaftalen og som angivet i DFARS 227.7202-1(a) og 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OKT 1988), FAR 12.212(a) (1995), FAR 52.227-19 eller FAR 52.227-14 (ALT III), alt efter hvad der er relevant. Dette produkt indeholder fortrolige oplysninger og forretningshemmeligheder tilhørende Changepoint Canada ULC. Offentliggørelse er forbudt uden forudgående udtrykkelig skriftlig tilladelse fra Changepoint Canada ULC. Brug af dette produkt er underlagt vilkårene og betingelserne i brugerens licensaftale med Changepoint Canada ULC. Dokumentation må kun gengives af licenstager til intern brug. Indholdet af dette dokument må ikke ændres, modificeres eller ændres uden udtrykkeligt skriftligt samtykke fra Changepoint Canada ULC. Changepoint Canada ULC kan til enhver tid ændre det heri specificerede indhold, med eller uden varsel.

Installation af Changepoint API

Om installation af Changepoint API
Changepoint API er tilgængelig som en COM API, en Windows Communication Foundation (WCF)-tjeneste og, for bagudkompatibilitet, som en Web Services Enhancements (WSE) service. For information om Changepoint API, se Changepoint API Reference. For opgraderingsnoter, advarsler og kendte problemer, se Release Notes i teammapper i Changepoint.
Opgradering af Changepoint API
Hvis du opgraderer fra en tidligere version af Changepoint, skal du bruge Windows Kontrolpanel til at afinstallere den tidligere version af Changepoint API og dets komponenter, før du installerer denne version.
Changepoint API-krav
Du skal installere Changepoint, før du installerer Changepoint API. For softwarekrav, se Changepoint Software Compatibility Matrix, som er tilgængelig i 2021 Release Notes and Patches-teammappen i Changepoint.
File stikonventioner
I hele dette dokument bruges følgende konventioner til almindelige stier:

• Rodstien til Changepoint-installationen.
  Standardstien er:
  C: Program Files (x86)ChangepointChangepoint
• Rodplaceringen for almindelige Changepoint-værktøjer, såsom værktøjet Login Settings.
  Standardstien er:
  C: Program Files (x86) Almindelig FilesChangepointChangepoint

Installation af Changepoint API

1. Kør setup.exe fra Changepoint API-medierodmappen.
2. Følg anvisningerne, indtil skærmbilledet Vælg funktioner vises.
3. Vælg de funktioner, du vil installere, og klik derefter på Næste.
4. Vælg API-destinationsmappen, standard API, og klik på Næste.
   Note: Værktøjet Changepoint Login Settings er installeret i LoginSettings, uanset hvilken destinationsmappe du angiver.
5. Hvis du valgte Web Services API: a. Når Vælg
   a Web Webstedsskærmen vises, vælg en webwebsted for at føje den virtuelle mappe til, og klik derefter på Næste.
   b. Klik på Næste for at fortsætte. 6. Når installationen af ​​API'en er færdig, skal du klikke på Udfør.

Konfiguration af Changepoint API til at være cachebevidst
For at konfigurere Changepoint API til at være cache-bevidst skal du erstatte værdierne for "cache. Adgangskode" og "cache. Servere” nøgler i CP Web TjenesterWeb.config file med de værdier, der bruges i virksomhedenWeb.config file.
Aktiverer Web Services Enhancements (WSE)

1. Rediger Web.config file for web tjenester. Standardplaceringen er:
   APICP Web TjenesterWeb.config
2. Find de tre forekomster af følgende kommentarlinje:
   < !– Fjern kommentarer til følgende element, hvis du bruger Web Service Enhancements (WSE) API. Efterlad kommentarer, hvis du bruger WCF-tjenester og ikke installerer Web Service Enhancements (WSE) –>
3. Fjern kommentaren til det element, der følger efter hver forekomst af kommentarlinjen:
   <section name=”microsoft.web.services2″ … >webTjenester>web.tjenester2>
   Note: DewebTjenester> element, der skal ikke kommenteres er et barn afweb>.

Konfiguration af logning for Web Services API
Du skal indstille loggen file sti- og logniveauer. Logniveauerne er kumulative. F.eksample, hvis du angiver niveau 3, bliver niveau 1, 2 og 3 logget. Standardlogniveauet er 8.

1. Rediger web tjenester Web.config. Standardplaceringen er:
   APICP Web TjenesterWeb.config
2. Indstil loggenFileSti. Standardværdien er APIAPILogs. 3. Indstil LogLevel. De gyldige værdier er:
   0 = Ingen logning
   1 = Kildeobjekt og metode
   2 = Fejlmeddelelse
   3 = Indgangsparametre
   4 = Returnerer
   5 = Advarsel
   8 = Kontrolpunkt

Konfiguration af virtuel mappegodkendelse for Web Services API
Du skal aktivere anonym adgang og deaktivere integreret Windows-godkendelse for CP'enWebTjeneste virtuelt bibliotek i Internet Information Services (IIS). Se Microsoft IIS-dokumentationen for at få flere oplysninger.
Konfiguration af databaseforbindelsesindstillinger for Web Services API
Brug værktøjet Login Settings til at kryptere databaseforbindelsesindstillingerne i Web Services API Web.config file. For mere information, søg efter "Konfiguration af databaseforbindelsesindstillinger" i Changepoint Installation Guide.
Konfiguration af godkendelse for Changepoint WCF Web Tjenester
Du kan konfigurere Application Authentication og Single Sign-on (SSO) for Changepoint WCF Web Tjenester.
Følgende implementeringsmuligheder er tilgængelige ved brug af Secure Token Service (STS):

• SSO ved hjælp af ISAPI SSL valgfri
• SSO ved hjælp af WS-Federation (ADFS 2.0) SSL påkrævet

Hvis SSL er påkrævet, sikrer konfigurationsscriptet, at det bruges.
Konfigurationsscripts for ISAPI og applikationsgodkendelse kan valgfrit aktivere SSL.
Konfiguration af applikationsgodkendelse til WCF Web Tjenester
Standardgodkendelsestypen for Changepoint WCF Web Tjenester er applikationsgodkendelse.
Brug procedurerne i dette afsnit til at:

• konfigurere Changepoint WCF Web Tjenester til at bruge applikationsgodkendelse med SSL
• tilbagefør Changepoint WCF Web Tjenester til applikationsgodkendelse efter at have implementeret en af ​​SSO-implementeringerne

Konfigurer PowerShell

1. Åbn en Windows PowerShell-prompt.
2. Rediger udførelsespolitikken:
   Set-ExecutionPolicy Ubegrænset

Stage 1 Indsaml konfigurationsparametre
Bestem værdierne for konfigurationsparametrene.

Parameter	Beskrivelse
WebService_Path	Placering af Changepoint WCF Web Tjenester web anvendelse files. Standard: \API\CP Web Tjenester
Servicecertifikat_ Navn	Certifikatnavn, der vil blive brugt til at godkende tjenesten til klienter, der bruger meddelelsessikkerhedstilstand. Standard: "CN=ChangepointAPICertificate"-certifikatnavnet.
kræver HTTPS	Kræv HTTPS (sandt/falsk) Standard: Falsk.

Stage 2 Udfør konfigurationsscripts
Brug værdierne for konfigurationsparametrene til at ændre konfigurationen af webwebsteder.

1.  Åbn en PowerShell-prompt.
   Note: Hvis din server har Brugerkontokontrol aktiveret, skal du åbne PowerShell-prompten ved hjælp af forhøjede administratortilladelser.
2. Naviger til CP web servicekonfigurationsmappe, standard:
   KonfigurationCPWebService
3.  Udfør ./Configuration_AppAuth.ps1
4. Følg anvisningerne.

Konfiguration af single sign-on (SSO) for WCF Web Tjenester
Konfigurer PowerShell

1. Åbn en Windows PowerShell-prompt.
2. Rediger udførelsespolitikken:
   Set-ExecutionPolicy Ubegrænset

Konfiguration af SSO ved hjælp af ISAPI til WCF Web Tjenester
Stage 1 Indsaml konfigurationsparametre
Bestem værdierne for følgende konfigurationsparametre.

Parameter	Beskrivelse
WebService_Path	Placeringen af ​​Changepoint WCF Web Tjenester web anvendelse files. Standard: \API\CP Web Tjenester
kræver HTTPS	Kræv HTTPS (True/False). Standard: Falsk.
Changepoint_RSA_ Cookie_Transform	Navnet på det certifikat, du bruger til Cookie-kryptering. Standard: "CN=ChangepointAPICertificate"-certifikatnavnet.
ServiceCertificate_Name	Indtast certifikatnavnet, der skal bruges til at godkende tjenesten over for klienter, der bruger meddelelsessikkerhedstilstand. Standard: "CN=ChangepointAPICertificate"-certifikatnavnet.
SigningCertificate_Name	Indtast navnet på signeringscertifikatet. Dette er navnet på det certifikat, du bruger til at signere beskeder. Standard: "CN=ChangepointAPICertificate"-certifikatnavnet.
ISAPI_Mode	ISAPI-tilstanden. Standard: NT
ISAPI_Header	Headeren, der bruges, når ISAPI_Mode er "HEADER", f.eksample, blank.
ClaimType	Indtast SSO-kravstypen. Misligholdelse: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Udfør konfigurationsscripts

1. Åbn en PowerShell-prompt.
   Note: Hvis din server har Brugerkontokontrol aktiveret, skal du åbne PowerShell-prompten ved hjælp af forhøjede administratortilladelser.
2. Naviger til CP web servicekonfigurationsmappe, standard:
   KonfigurationCPWebService
3. Udfør: ./Configuration_SSO_ISAPI.ps1
4. Følg anvisningerne.

Konfiguration af SSO ved hjælp af WS-Federation (ADFS 2.0) til WCF Web Tjenester
Stage 1 Indsaml konfigurationsparametre
Bestem værdierne for konfigurationsparametrene i tabellen nedenfor. Sørg for, at ADFS_Server_URI er i Intranet-zonen i slutbrugerens browser.
Note: Som standard er Changepoint konfigureret til automatisk at opdatere de offentlige nøgler, der bruges til at signere sikkerhedstokens ved at bruge det offentliggjorte federations-metadatadokument. I ADFS er dette:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
I nogle tilfælde er det muligvis ikke muligt at nå ADFS-serveren fra Changepoint web server, så du bliver nødt til manuelt at opdatere konfigurationen efter at have kørt konfigurationsscriptet. For detaljer, se "Manuel opdatering af offentlige nøgler" på side 12.

Parameter	Beskrivelse
WebService_Path	Placering af Changepoint WCF Web Tjenester web anvendelse files. Standard: \API\CP Web Tjenester
WebService_URI	Domæne-id, som du bruger til Changepoint WCF Web Tjenester. F.eksample., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Navn på det certifikat, du bruger til kryptering af cookies. Standard: "CN=ChangepointApiCertificate"-certifikatnavnet.
ServiceCertificate_Name	Certifikatnavn, der vil blive brugt til at godkende tjenesten til klienter, der bruger meddelelsessikkerhedstilstand. Standard: "CN=ChangepointApiCertificate"-certifikatnavnet.
SigningCertificate_Name	Navn på det certifikat, du bruger til at signere beskeder. Standard: "CN=ChangepointApiCertificate" certifikatnavnet bruges.
ADFS_ FederationServiceName	Føderationstjenestenavn. For at få navnet: Start ADFS 2.0 Management-konsollen fra ADFS-serveren. •Vælg ADFS 2.0 fra menuen til venstre. •Vælg Rediger Federation Service Properties i handlingsruden. Føderationstjenestens navn er på fanen Generelt.
ClaimType	SSO-kravtype. Standard er: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Udfør konfigurationsscripts
Konfigurer webwebsteder, der bruger værdierne for konfigurationsparametrene.

1. Åbn en PowerShell-prompt.
   Note: Hvis din server har Brugerkontokontrol aktiveret, skal du åbne PowerShell-prompten ved hjælp af forhøjede administratortilladelser.
2. Naviger til Changepoint web servicekonfigurationsmappe, standard: KonfigurationCPWebService
3.  Udfør: ./Configuration_SSO_ADFS.ps1
4. Følg anvisningerne.

Stage 3 Skab tillid til den afhængige part
Opret Relying Party Trust i ADFS 2.0 Console.

1. Start ADFS 2.0-konsollen på din ADFS-server.
2. Vælg Action > Add Relying Party Trust.
3. Klik på Start.
4. Vælg Importer data om den afhængige part offentliggjort online eller på et lokalt netværk.
5. Indtast føderationens metadataadresse, og klik derefter på Næste, f.eksampdet:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Indtast et visningsnavn, f.eks. Changepoint WCF API, og klik på Næste, Næste, Næste og derefter Luk.
7. Tilføj en kravregel for ovenstående Changepoint Relying Party. For Changepoint er standardkravsregelnavnet "UPN".
8. Tilknyt LDAP-attributtet "User-Principal-Name" til udgående kravtype "* UPN" eller "UPN".

Manuel opdatering af offentlige nøgler
For at få ADFS Server Token Signing Thumbprint

1. Start ADFS 2.0 Management-konsollen fra ADFS-serveren.
2. Vælg Service > Certifikater, og dobbeltklik på Token-signeringscertifikatet.
3. Vælg fanen Detaljer.
4. Vælg feltet Thumbprint.
5. For at få tommelfingeraftryksværdien skal du fjerne alle mellemrum inklusive det første mellemrum.

For at opdatere Web.config file

1. Rediger ADFS web.config. Standardplaceringen er:
   EnterpriseRP-STS_ADFS
2. Under element, find nøglen ida:FederationMetadataLocation og ryd dens værdi:
   
3. Under , Find element og erstat det med følgende: https://ADFS_Federation.ServiceName/adfs/services/trust">https://ADFS_Federation.ServiceName/adfs/services/trust” />

Test af COM API-forbindelsen

1. Kør API Test Kit. Standardplaceringen er:
   APIAPI ComponentsApiTestKit.exe.
2. Klik på Forbindelsesstreng > Kryptering.
3. I feltet Plain Text Connections String:
   en. Erstat SERVERNAME og DATABASENAME med dine databaseoplysninger.
   b. Erstat USERID og PASSWORD med oplysninger om din databaseadministratorbrugerkonto.
   c. Indtast timeoutværdien efter behov.
4. Klik på Krypter.
5. Kopier teksten i feltet Krypteret forbindelsesstreng.
6. Luk dialogboksen.
7. Klik på Connection > COM API Connection Tester i menuen API Test Kit.
8. På fanen Aktuel version skal du indsætte den krypterede forbindelsesstreng i feltet Forbindelsesstreng.
9. Indtast login-id og adgangskode til din Changepoint-konto i felterne LoginId og Password.
10. I feltet Logniveau (0-8) skal du angive niveauet for fejlinformation, der skal returneres i COM API-loggen file hvis testresultatet viser et problem med forbindelsen.
    0 = Ingen logning
    1 = Kildeobjekt og metode
    2 = Fejlmeddelelse
    3 = Indgangsparametre
    4 = Returnerer
    5 = Advarsel
    8 = Kontrolpunkt
    Standard er 8.
11. Klik på Opret forbindelse.
    Hvis forbindelsen lykkedes, vises en succesmeddelelse i feltet Resultat. Hvis forbindelsen mislykkedes, skal du kontrollere COM API-loggen file for fejl. Standardplaceringen af ​​loggen file er APIAPILogs.

Kontrollerer versionen af ​​installerede API-komponenter
Du kan bruge versionskontrolværktøjet til at få detaljer om de installerede komponenter, inklusive udgivelsesversionen og stien.

1. Kør CPVersionChecker.exe. Standardstien er: APIAPI komponenter
2. Klik på Læs.

Kontrollerer versionen af Web Services API

1. Start Internet Explorer fra den server, hvor Web Services API er installeret, og indtast adressen:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  hvor port er portnummeret på webstedet, hvor du installerede CP'enWebTjeneste virtuelt bibliotek.
2. På WSLogin-siden skal du klikke på linket GetVersion.
3. Klik på Kald.

Test af Web Services API-forbindelse

1. Start Internet Explorer fra den server, hvor Web Services API er installeret, og indtast adressen: http://localhost.port/CPWeb.Service/WSLogin.asmx  hvor port er portnummeret på webstedet, hvor du installerede CP'enWebTjeneste virtuelt bibliotek.
2. Klik på linket TestConnection på WSLogin-siden.
3. Klik på Kald. 4. I testresultaterne:

• Hvis elementet er falsk, er testforbindelsen lykkedes.
• Hvis elementet er sandt, mislykkedes testforbindelsen. For mere
  oplysninger om årsagerne til svigtet, se og elementer i testresultaterne, og kontroller API-logfilerne. Standardstien til API-logfilerne er: APIAPILogs

Opsætning af Web Services API på en sprogserver

1. For at implementere Changepoint Web Services API på en sprogserver, skal du tilføje eller opdatere tag i Web Services API web.config. Standardplaceringen af Web.config file er: APICP Web TjenesterWeb.config
2. Hvis tag allerede eksisterer, skal du sikre dig, at både kultur- og uiCulture-attributter er "en-US."
3. Hvis tag ikke allerede eksisterer, tilføj følgende , kommentar og elementer tilweb> node:web>
   Visual Basic-indstillinger: Indstil strict=” true” for at forbyde alle datatypekonverteringer, hvor datatab kan forekomme. Indstil eksplicit = "sand" for at fremtvinge deklaration af alle variable. –>
4. Genstart IIS.