Changepoint API-programvareinstallasjonsveiledning

API-installasjonsveiledning
Referanseguide
Endringspunkt 2021

© 2021 Changepoint Canada ULC Alle rettigheter forbeholdt. RETTIGHETER FOR amerikansk regjering – Bruk, duplisering eller avsløring av amerikanske myndigheter er underlagt restriksjoner som angitt i Changepoint Canada ULC-lisensavtalen og som gitt 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), som aktuelt. Dette produktet inneholder konfidensiell informasjon og forretningshemmeligheter til Changepoint Canada ULC. Offentliggjøring er forbudt uten forutgående uttrykkelig skriftlig tillatelse fra Changepoint Canada ULC. Bruk av dette produktet er underlagt vilkårene og betingelsene i brukerens lisensavtale med Changepoint Canada ULC. Dokumentasjon kan kun reproduseres av lisenstaker for intern bruk. Innholdet i dette dokumentet kan ikke endres, modifiseres eller endres uten uttrykkelig skriftlig samtykke fra Changepoint Canada ULC. Changepoint Canada ULC kan endre innholdet som er spesifisert her når som helst, med eller uten varsel.

Installere Changepoint API

Om installasjon av Changepoint API
Changepoint API er tilgjengelig som en COM API, en Windows Communication Foundation (WCF)-tjeneste og, for bakoverkompatibilitet, som en Web Tjenester Enhancements (WSE) tjeneste. For informasjon om Changepoint API, se Changepoint API Reference. For oppgraderingsnotater, forbehold og kjente problemer, se versjonsmerknadene i teammapper i Changepoint.
Oppgradering av Changepoint API
Hvis du oppgraderer fra en tidligere versjon av Changepoint, bruk Windows Kontrollpanel til å avinstallere den forrige versjonen av Changepoint API og dens komponenter før du installerer denne versjonen.
Changepoint API-krav
Du må installere Changepoint før du installerer Changepoint API. For programvarekrav, se Changepoint Software Compatibility Matrix, som er tilgjengelig i 2021 Release Notes and Patches-teammappen i Changepoint.
File sti-konvensjoner
Gjennom dette dokumentet brukes følgende konvensjoner for vanlige baner:

• Rotbanen til Changepoint-installasjonen.
  Standard banen er:
  C: Program Files (x86)ChangepointChangepoint
• Rotplasseringen for vanlige Changepoint-verktøy, for eksempel verktøyet påloggingsinnstillinger.
  Standard banen er:
  C: Program Files (x86) Vanlig FilesChangepointChangepoint

Installere Changepoint API

1. Fra Changepoint API-medierotkatalogen, kjør setup.exe.
2. Følg instruksjonene til skjermbildet Velg funksjoner vises.
3. Velg funksjonene du vil installere, og klikk deretter på Neste.
4. Velg API-destinasjonsmappen, standard API, og klikk på Neste.
   Note: Changepoint Login Settings-verktøyet er installert i Påloggingsinnstillinger, uavhengig av målmappen du angir.
5. Hvis du valgte Web Tjenester API: a. Når Velg
   a Web Sideskjermen vises, velg en webnettstedet for å legge til den virtuelle katalogen, og klikk deretter Neste.
   b. Klikk Neste for å fortsette. 6. Når installasjonen av API er fullført, klikker du på Fullfør.

Konfigurere Changepoint API for å være cache-bevisst
For å konfigurere Changepoint API til å være cache-bevisst, bytt ut verdiene for "cache. Passord" og "cache. Servere"-tastene i CP Web TjenesterWeb.config file med verdiene som brukes i EnterpriseWeb.config file.
Aktiverer Web Tjenesteforbedringer (WSE)

1. Rediger Web.config file til web tjenester. Standardplasseringen er:
   APICP Web TjenesterWeb.config
2. Finn de tre forekomstene av følgende kommentarlinje:
   < !– Fjern kommentaren til følgende element hvis du bruker Web Service Enhancements (WSE) API. Legg igjen kommentarer hvis du bruker WCF-tjenester og ikke installerer Web Service Enhancements (WSE) –>
3. Fjern kommentaren til elementet som følger hver forekomst av kommentarlinjen:
   <section name=”microsoft.web.services2″ … >webTjenester>web.tjenester2>
   Note: DewebTjenester>-elementet som skal ikke kommenteres er et barn avweb>.

Konfigurering av logging for Web Tjenester API
Du må angi loggen file bane- og loggnivåer. Loggnivåene er kumulative. For eksample, hvis du spesifiserer nivå 3, logges nivå 1, 2 og 3. Standard loggnivå er 8.

1. Rediger web tjenester Web.config. Standardplasseringen er:
   APICP Web TjenesterWeb.config
2. Sett loggenFileSti. Standardverdien er APIAPILogs. 3. Angi LogLevel. De gyldige verdiene er:
   0 = Ingen logging
   1 = Kildeobjekt og metode
   2 = Feilmelding
   3 = Inndataparametere
   4 = Returnerer
   5 = Advarsel
   8 = Sjekkpunkt

Konfigurering av virtuell katalogautentisering for Web Tjenester API
Du må aktivere anonym tilgang og deaktivere integrert Windows-autentisering for CPWebVirtuell tjenestekatalog i Internet Information Services (IIS). For mer informasjon, se Microsoft IIS-dokumentasjonen.
Konfigurere databasetilkoblingsinnstillinger for Web Tjenester API
Bruk påloggingsinnstillinger-verktøyet til å kryptere databasetilkoblingsinnstillingene i Web Tjenester API Web.config file. For mer informasjon, søk etter "Konfigurere innstillinger for databasetilkobling" i Changepoint Installation Guide.
Konfigurerer autentisering for Changepoint WCF Web Tjenester
Du kan konfigurere applikasjonsautentisering og enkel pålogging (SSO) for Changepoint WCF Web Tjenester.
Følgende implementeringsalternativer er tilgjengelige ved bruk av Secure Token Service (STS):

• SSO med ISAPI SSL valgfritt
• SSO som bruker WS-Federation (ADFS 2.0) SSL kreves

Hvis SSL kreves, sikrer konfigurasjonsskriptet at det brukes.
Konfigurasjonsskriptene for ISAPI og applikasjonsautentisering kan valgfritt aktivere SSL.
Konfigurerer applikasjonsautentisering for WCF Web Tjenester
Standard autentiseringstype for Changepoint WCF Web Tjenester er appautentisering.
Bruk prosedyrene i denne delen for å:

• konfigurere Changepoint WCF Web Tjenester for å bruke applikasjonsautentisering med SSL
• tilbakestille Changepoint WCF Web Tjenester til applikasjonsautentisering etter å ha implementert en av SSO-implementeringene

Konfigurer PowerShell

1. Åpne en Windows PowerShell-ledetekst.
2. Endre utførelsespolicyen:
   Set-ExecutionPolicy Ubegrenset

Stage 1 Samle inn konfigurasjonsparametere
Bestem verdiene for konfigurasjonsparameterne.

Parameter	Beskrivelse
WebService_Path	Plassering av Changepoint WCF Web Tjenester web søknad files. Misligholde: \API\CP Web Tjenester
ServiceCertificate_ Navn	Sertifikatnavn som vil bli brukt til å autentisere tjenesten til klienter som bruker meldingssikkerhetsmodus. Standard: "CN=ChangepointAPICertificate"-sertifikatnavnet.
krever HTTPS	Krev HTTPS (sant/usant) Standard: False.

Stage 2 Utfør konfigurasjonsskript
Bruk verdiene for konfigurasjonsparameterne for å endre konfigurasjonen av webnettsteder.

1.  Åpne en PowerShell-ledetekst.
   Note: Hvis serveren din har brukerkontokontroll aktivert, må du åpne PowerShell-ledeteksten ved å bruke forhøyede administratortillatelser.
2. Naviger til CP web tjenestekonfigurasjonskatalog, standard:
   Konfigurasjon CPWebService
3.  Kjør ./Configuration_AppAuth.ps1
4. Følg instruksjonene.

Konfigurerer enkel pålogging (SSO) for WCF Web Tjenester
Konfigurer PowerShell

1. Åpne en Windows PowerShell-ledetekst.
2. Endre utførelsespolicyen:
   Set-ExecutionPolicy Ubegrenset

Konfigurere SSO ved hjelp av ISAPI for WCF Web Tjenester
Stage 1 Samle inn konfigurasjonsparametere
Bestem verdiene for følgende konfigurasjonsparametere.

Parameter	Beskrivelse
WebService_Path	Plasseringen av Changepoint WCF Web Tjenester web søknad files. Misligholde: \API\CP Web Tjenester
krever HTTPS	Krev HTTPS (True/False). Standard: False.
Changepoint_RSA_ Cookie_Transform	Navnet på sertifikatet du bruker for kryptering av informasjonskapsler. Standard: "CN=ChangepointAPICertificate"-sertifikatnavnet.
ServiceCertificate_Name	Skriv inn sertifikatnavnet som skal brukes til å autentisere tjenesten til klienter som bruker meldingssikkerhetsmodus. Standard: "CN=ChangepointAPICertificate"-sertifikatnavnet.
SigningCertificate_Name	Skriv inn navnet på signeringssertifikatet. Dette er navnet på sertifikatet du bruker til å signere meldinger. Standard: "CN=ChangepointAPICertificate"-sertifikatnavnet.
ISAPI_Mode	ISAPI-modusen. Standard: NT
ISAPI_Header	Overskriften som brukes når ISAPI_Mode er "HEADER", for eksempelample, blank.
ClaimType	Skriv inn SSO-kravtype. Misligholde: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Utfør konfigurasjonsskript

1. Åpne en PowerShell-ledetekst.
   Note: Hvis serveren din har brukerkontokontroll aktivert, må du åpne PowerShell-ledeteksten ved å bruke forhøyede administratortillatelser.
2. Naviger til CP web tjenestekonfigurasjonskatalog, standard:
   Konfigurasjon CPWebService
3. Kjør: ./Configuration_SSO_ISAPI.ps1
4. Følg instruksjonene.

Konfigurere SSO ved hjelp av WS-Federation (ADFS 2.0) for WCF Web Tjenester
Stage 1 Samle inn konfigurasjonsparametere
Bestem verdiene for konfigurasjonsparameterne i tabellen nedenfor. Sørg for at ADFS_Server_URI er i intranettsonen til sluttbrukerens nettleser.
Note: Som standard er Changepoint konfigurert til å automatisk oppdatere de offentlige nøklene som brukes til å signere sikkerhetstokener ved å bruke det publiserte føderasjonsmetadatadokumentet. I ADFS er dette:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
I noen tilfeller er det kanskje ikke mulig å nå ADFS-serveren fra endringspunktet web server slik at du må oppdatere konfigurasjonen manuelt etter å ha kjørt konfigurasjonsskriptet. For detaljer, se "Manuell oppdatering av offentlige nøkler" på side 12.

Parameter	Beskrivelse
WebService_Path	Plassering av Changepoint WCF Web Tjenester web søknad files. Misligholde: \API\CP Web Tjenester
WebService_URI	Domeneidentifikator som du bruker for Changepoint WCF Web Tjenester. For eksample., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Navn på sertifikatet du bruker for kryptering av informasjonskapsler. Standard: "CN=ChangepointApiCertificate"-sertifikatnavnet.
ServiceCertificate_Name	Sertifikatnavn som vil bli brukt til å autentisere tjenesten til klienter som bruker meldingssikkerhetsmodus. Standard: "CN=ChangepointApiCertificate"-sertifikatnavnet.
SigningCertificate_Name	Navn på sertifikatet du bruker til å signere meldinger. Standard: "CN=ChangepointApiCertificate"-sertifikatnavnet brukes.
ADFS_ FederationServiceName	Føderasjonstjenestenavn. For å få navnet: Start ADFS 2.0 Management-konsollen fra ADFS-serveren. •Velg ADFS 2.0 fra venstremenyen. •Velg Rediger Federation Service Properties fra handlingsruten. Federation Service Name er på Generelt-fanen.
ClaimType	SSO-kravtype. Standard er: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Utfør konfigurasjonsskript
Konfigurer webnettsteder som bruker verdiene for konfigurasjonsparameterne.

1. Åpne en PowerShell-ledetekst.
   Note: Hvis serveren din har brukerkontokontroll aktivert, må du åpne PowerShell-ledeteksten ved å bruke forhøyede administratortillatelser.
2. Naviger til endringspunktet web tjenestekonfigurasjonskatalog, standard: Konfigurasjon CPWebService
3.  Kjør: ./Configuration_SSO_ADFS.ps1
4. Følg instruksjonene.

Stage 3 Skap tillit hos avhengige parter
Opprett Relying Party Trust i ADFS 2.0-konsollen.

1. Start ADFS 2.0-konsollen på ADFS-serveren.
2. Velg Handling > Add Relying Party Trust.
3. Klikk Start.
4. Velg Importer data om den pålitelige parten publisert på nettet eller på et lokalt nettverk.
5. Skriv inn føderasjonsmetadataadressen, og klikk deretter Neste, for eksempelampde:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Skriv inn et visningsnavn, f.eks. Changepoint WCF API, og klikk på Neste, Neste, Neste og deretter Lukk.
7. Legg til en kravregel for endringspunktet ovenfor. For Changepoint er standard kravregelnavn "UPN".
8. Tilordne LDAP-attributtet "User-Principal-Name" til utgående kravtype "* UPN" eller "UPN".

Manuell oppdatering av offentlige nøkler
For å få ADFS Server Token Signing Thumbprint

1. Start ADFS 2.0 Management-konsollen fra ADFS-serveren.
2. Velg Tjeneste > Sertifikater, og dobbeltklikk på Token-signeringssertifikatet.
3. Velg fanen Detaljer.
4. Velg Thumbprint-feltet.
5. For å få tommelavtrykksverdien, fjern alle mellomrommene inkludert det første mellomrommet.

For å oppdatere Web.config file

1. Rediger ADFS web.config. Standardplasseringen er:
   EnterpriseRP-STS_ADFS
2. Under element, finn nøkkelen ida:FederationMetadataLocation og fjern verdien:
   
3. Under , Finn element og erstatt det med følgende: https://ADFS_Federation.ServiceName/adfs/services/trust">https://ADFS_Federation.ServiceName/adfs/services/trust” />

Tester COM API-tilkoblingen

1. Kjør API-testsettet. Standardplasseringen er:
   APIAPI ComponentsApiTestKit.exe.
2. Klikk Connection String > Encrypter.
3. I feltet Plain Text Connections String:
   en. Erstatt SERVERNAME og DATABASENAME med databaseinformasjonen din.
   b. Erstatt BRUKERID og PASSORD med informasjon om din databaseadministratorbrukerkonto.
   c. Angi tidsavbruddsverdien etter behov.
4. Klikk på Krypter.
5. I feltet Kryptert tilkoblingsstreng kopierer du teksten.
6. Lukk dialogboksen.
7. På API Test Kit-menyen, klikk Connection > COM API Connection Tester.
8. I fanen Current Version limer du inn den krypterte tilkoblingsstrengen i feltet Connection String.
9. I feltene LoginId og Password skriver du inn påloggings-ID og passord for Changepoint-kontoen din.
10. I feltet Loggnivå (0-8) angir du nivået på feilinformasjonen som skal returneres i COM API-loggen file hvis testresultatet viser et problem med tilkoblingen.
    0 = Ingen logging
    1 = Kildeobjekt og metode
    2 = Feilmelding
    3 = Inndataparametere
    4 = Returnerer
    5 = Advarsel
    8 = Sjekkpunkt
    Standard er 8.
11. Klikk på Koble til.
    Hvis tilkoblingen var vellykket, vises en vellykket melding i resultatfeltet. Hvis tilkoblingen mislyktes, sjekk COM API-loggen file for feil. Standardplasseringen for loggen file er APIAPILogs.

Kontrollerer versjonen av installerte API-komponenter
Du kan bruke versjonskontrollverktøyet for å få detaljer om de installerte komponentene, inkludert utgivelsesversjonen og banen.

1. Kjør CPVersionChecker.exe. Standard banen er: APIAPI-komponenter
2. Klikk Les.

Sjekker versjonen av Web Tjenester API

1. Start Internet Explorer fra serveren der Web Services API er installert, og skriv inn adressen:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  hvor port er portnummeret til webstedet der du installerte CPWebVirtuell tjenestekatalog.
2. På WSLogin-siden klikker du på GetVersion-koblingen.
3. Klikk Påkall.

Tester Web Tjenester API-tilkobling

1. Start Internet Explorer fra serveren der Web Services API er installert, og skriv inn adressen: http://localhost.port/CPWeb.Service/WSLogin.asmx  hvor port er portnummeret til webstedet der du installerte CPWebVirtuell tjenestekatalog.
2. På WSLogin-siden klikker du på TestConnection-koblingen.
3. Klikk Påkall. 4. I testresultatene:

• Hvis elementet er usann, lyktes testtilkoblingen.
• Hvis elementet er sant, testtilkoblingen mislyktes. For mer
  informasjon om årsakene til feilen, se og elementer i testresultatene, og sjekk API-loggene. Standardbanen til API-loggene er: APIAPILogs

Sette opp Web Services API på en språkserver

1. For å distribuere Changepoint Web Services API på en språkserver, må du legge til eller oppdatere tag i Web Tjenester API web.config. Standardplasseringen til Web.config file er: APICP Web TjenesterWeb.config
2. Hvis tag allerede eksisterer, sørg for at både kultur- og uiCulture-attributter er «en-US».
3. Hvis tag ikke allerede eksisterer, legg til følgende , kommentar og elementer tilweb> node:web>
   Visual Basic-alternativer: Angi strict=”true” for å ikke tillate alle datatypekonverteringer der datatap kan forekomme. Sett eksplisitt=”true” for å fremtvinge deklarasjon av alle variabler. –>
4. Start IIS på nytt.