Changepoint API Software Ynstallaasje Guide

API ynstallaasje Guide
Referinsjegids
Feroaringspunt 2021

© 2021 Changepoint Kanada ULC Alle rjochten foarbehâlden. RJOCHTEN fan 'e FS - Gebrûk, duplikaasje, of iepenbiering troch de Amerikaanske regearing is ûnderwurpen oan beheiningen lykas fêstlein yn 'e Changepoint Canada ULC-lisinsje-oerienkomst en lykas bepaald yn DFARS 227.7202-1(a) en 227.7202-3(a) (1995), DFARS 252.227-7013 (c) (1) (ii) (OKT 1988), FAR 12.212 (a) (1995), FAR 52.227-19, of FAR 52.227-14 (ALT III), as fan tapassing. Dit produkt befettet fertroulike ynformaasje en hannelsgeheimen fan Changepoint Canada ULC. Disclosure is ferbean sûnder de foarôfgeande útdruklike skriftlike tastimming fan Changepoint Canada ULC. Gebrûk fan dit produkt is ûnderwurpen oan de betingsten en betingsten fan de lisinsje-oerienkomst fan de brûker mei Changepoint Canada ULC. Dokumintaasje kin allinnich wurde reprodusearre troch lisinsjenimmer foar yntern gebrûk. De ynhâld fan dit dokumint kin net feroare, wizige of feroare wurde sûnder de útdruklike skriftlike tastimming fan Changepoint Canada ULC. Changepoint Kanada ULC kin de ynhâld hjiryn opjûn op elk momint feroarje, mei of sûnder notice.

It ynstallearjen fan de Changepoint API

Oer it ynstallearjen fan de Changepoint API
De Changepoint API is beskikber as in COM API, in Windows Communication Foundation (WCF) tsjinst en, foar efterútkompatibiliteit, as in Web Tsjinsten Enhancements (WSE) tsjinst. Foar ynformaasje oer de Changepoint API, sjoch de Changepoint API Reference. Foar upgrade-notysjes, caveats en bekende problemen, sjoch de Release Notes yn teammappen yn Changepoint.
It opwurdearjen fan de Changepoint API
As jo ​​opwurdearje fan in eardere ferzje fan Changepoint, brûk dan it Windows Control Panel om de foarige ferzje fan 'e Changepoint API en syn komponinten te ferwiderjen foardat jo dizze ferzje ynstallearje.
Changepoint API easken
Jo moatte Changepoint ynstallearje foardat jo de Changepoint API ynstallearje. Foar softwareeasken, sjoch de Changepoint Software Compatibility Matrix, dy't beskikber is yn 'e 2021 Release Notes and Patches team map yn Changepoint.
File paad konvinsjes
Yn dit hiele dokumint wurde de folgjende konvinsjes brûkt foar mienskiplike paden:

• It rootpaad fan 'e Changepoint-ynstallaasje.
  It standert paad is:
  C: Programma Files (x86) Feroaringspunt Feroaringspunt
• De root-lokaasje foar mienskiplike Changepoint-helpprogramma's, lykas it hulpprogramma Login Settings.
  It standert paad is:
  C: Programma Files (x86) Mienskiplik FilesChangepointChangepoint

It ynstallearjen fan de Changepoint API

1. Ut de Changepoint API media root map, run setup.exe.
2. Folgje de prompts oant it skerm Selektearje funksjes ferskynt.
3. Selektearje de funksjes dy't jo wolle ynstallearje en klikje dan op Folgjende.
4. Selektearje de API bestimming map, standert API, en klikje Folgjende.
   Noat: It hulpprogramma Changepoint Login Settings is ynstalleare yn LoginSettings, nettsjinsteande de bestimmingsmap dy't jo oantsjutte.
5. As jo ​​selektearre de Web Tsjinsten API: a. Wannear't de Selektearje
   a Web Site skerm ferskynt, selektearje in webside om de firtuele map ta te foegjen, en klik dan op Folgjende.
   b. Klik Folgjende om troch te gean. 6. As de ynstallaasje fan de API foltôge is, klikje op Finish.

De Changepoint API konfigurearje om cache bewust te wêzen
Om de Changepoint API te konfigurearjen om cache-bewust te wêzen, ferfange de wearden foar de "cache. Wachtwurd" en "cache. Servers" toetsen yn 'e CP Web TsjinstenWeb.config file mei de wearden brûkt yn 'e EnterpriseWeb.config file.
Ynskeakelje Web Services Enhancements (WSE)

1. Bewurkje de Web.config file foar web tsjinsten. De standert lokaasje is:
   APICP Web TsjinstenWeb.config
2. Fyn de trije eksimplaren fan 'e folgjende opmerkingsline:
   < !– Untkommentearje it folgjende elemint as jo brûke Web Service Enhancements (WSE) API. Lit opmerkingen litte as jo WCF-tsjinsten brûke en net ynstallearje Web Service Enhancements (WSE) ->
3. Untkommentearje it elemint dat folget op elk eksimplaar fan 'e kommentaarrigel:
   <section name = "microsoft.web.services2″ … >webTsjinsten>web.tsjinsten2>
   Noat: DewebTsjinsten> elemint te wêzen uncommented is in bern fanweb>.

It ynstellen fan logging foar de Web Tsjinsten API
Jo moatte it log ynstelle file paad- en lognivo's. De lognivo's binne kumulatyf. Bygelyksample, as jo it nivo 3 oantsjutte, dan wurde nivo's 1, 2 en 3 oanmeld. It standert lognivo is 8.

1. Bewurkje de web tsjinsten Web.config. De standert lokaasje is:
   APICP Web TsjinstenWeb.config
2. Stel de log ynFilePaad. De standertwearde is APIAPILogs. 3. Stel it LogLevel yn. De jildige wearden binne:
   0 = Gjin logging
   1 = Boarne foarwerp en metoade
   2 = Flaterberjocht
   3 = Ynfier parameters
   4 = werom
   5 = Warskôging
   8 = Kontrolepunt

It konfigurearjen fan firtuele triemtafelferifikaasje foar de Web Tsjinsten API
Jo moatte anonime tagong ynskeakelje en yntegreare Windows-ferifikaasje foar de CP útskeakeljeWebService firtuele triemtafel yn Internet Information Services (IIS). Foar mear ynformaasje, sjoch de Microsoft IIS dokumintaasje.
Konfigurearje databank ferbining ynstellings foar de Web Tsjinsten API
Brûk it hulpprogramma Login Settings om de ynstellings foar databaseferbining te fersiferjen yn 'e Web Tsjinsten API Web.config file. Foar mear ynformaasje, sykje nei "Configuring Database Connection Settings" yn 'e Changepoint Installation Guide.
It ynstellen fan autentikaasje foar Changepoint WCF Web Tsjinsten
Jo kinne tapassing Authentication en single sign-on (SSO) ynstelle foar Changepoint WCF Web Tsjinsten.
De folgjende ymplemintaasjeopsjes binne beskikber mei Secure Token Service (STS):

• SSO mei ISAPI SSL opsjoneel
• SSO mei WS-Federation (ADFS 2.0) SSL fereaske

As SSL fereaske is, soarget it konfiguraasjeskript dat it wurdt brûkt.
De konfiguraasjeskripts foar ISAPI en applikaasje-autentikaasje kinne opsjoneel SSL ynskeakelje.
Applikaasjeferifikaasje konfigurearje foar WCF Web Tsjinsten
It standert autentikaasjetype foar Changepoint WCF Web Tsjinsten is applikaasje autentikaasje.
Brûk de prosedueres yn dizze seksje om:

• konfigurearje Changepoint WCF Web Tsjinsten om applikaasje-autentikaasje te brûken mei SSL
• weromsette Changepoint WCF Web Tsjinsten foar applikaasje-autentikaasje nei't jo ien fan 'e SSO-ymplemintaasjes hawwe ymplementearre

PowerShell ynstelle

1. Iepenje in Windows PowerShell-prompt.
2. Feroarje it útfieringsbelied:
   Set-ExecutionPolicy Unbeheind

Stage 1 Sammelje konfiguraasje parameters
Bepale de wearden foar de konfiguraasje parameters.

Parameter	Beskriuwing
WebService_Path	Lokaasje fan de Changepoint WCF Web Tsjinsten web oanfraach files. Standert: \API\CP Web Tsjinsten
ServiceCertificate_ Namme	Sertifikaatnamme dy't sil wurde brûkt om de tsjinst te autentisearjen foar kliïnten mei help fan Berjochtbefeiligingsmodus. Standert: de "CN=ChangepointAPICertificate" sertifikaatnamme.
fereaskje HTTPS	Fereaskje HTTPS (Wier/False) Standert: falsk.

Stage 2 Utfiere konfiguraasje skripts
Brûk de wearden foar de konfiguraasje parameters te feroarjen de konfiguraasje fan de websites.

1.  Iepenje in PowerShell-prompt.
   Noat: As jo ​​tsjinner brûkersaccountkontrôle ynskeakele hat, moatte jo de PowerShell-prompt iepenje mei ferhege beheardersrjochten.
2. Gean nei de CP web tsjinst konfiguraasjemap, standert:
   KonfiguraasjeCPWebTsjinst
3.  ./Configuration_AppAuth.ps1 útfiere
4. Folgje de prompts.

Single sign-on (SSO) konfigurearje foar WCF Web Tsjinsten
PowerShell ynstelle

1. Iepenje in Windows PowerShell-prompt.
2. Feroarje it útfieringsbelied:
   Set-ExecutionPolicy Unbeheind

SSO konfigurearje mei ISAPI foar WCF Web Tsjinsten
Stage 1 Sammelje konfiguraasje parameters
Bepale de wearden foar de folgjende konfiguraasje parameters.

Parameter	Beskriuwing
WebService_Path	De lokaasje fan de Changepoint WCF Web Tsjinsten web oanfraach files. Standert: \API\CP Web Tsjinsten
fereaskje HTTPS	Fereaskje HTTPS (Wier/False). Standert: falsk.
Changepoint_RSA_ Cookie_Transform	De namme fan it sertifikaat dat jo brûke foar Cookie-kodearring. Standert: de "CN=ChangepointAPICertificate" sertifikaatnamme.
ServiceCertificate_Name	Fier de sertifikaatnamme yn dy't sil wurde brûkt om de tsjinst te ferifiearjen foar kliïnten mei help fan Berjochtbefeiligingsmodus. Standert: de "CN=ChangepointAPICertificate" sertifikaatnamme.
SigningCertificate_Name	Fier de namme fan it ûndertekeningssertifikaat yn. Dit is de namme fan it sertifikaat dat jo brûke foar it ûndertekenjen fan berjochten. Standert: de "CN=ChangepointAPICertificate" sertifikaatnamme.
ISAPI_Modus	De ISAPI-modus. Standert: NT
ISAPI_Header	De koptekst brûkt as ISAPI_Mode "HEADER" is, bygelyksample, leech.
ClaimType	Fier it SSO Claim Type yn. Standert: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Utfiere konfiguraasje skripts

1. Iepenje in PowerShell-prompt.
   Noat: As jo ​​tsjinner brûkersaccountkontrôle ynskeakele hat, moatte jo de PowerShell-prompt iepenje mei ferhege beheardersrjochten.
2. Gean nei de CP web tsjinst konfiguraasjemap, standert:
   KonfiguraasjeCPWebTsjinst
3. Utfiere: ./Configuration_SSO_ISAPI.ps1
4. Folgje de prompts.

SSO konfigurearje mei WS-Federation (ADFS 2.0) foar WCF Web Tsjinsten
Stage 1 Sammelje konfiguraasje parameters
Bepale de wearden foar de konfiguraasjeparameters yn 'e tabel hjirûnder. Soargje derfoar dat de ADFS_Server_URI yn 'e intranetsône fan' e browser fan 'e ein-brûker is.
Noat: Standert is Changepoint konfigurearre om de iepenbiere kaaien automatysk te aktualisearjen dy't brûkt wurde om befeiligingstokens te ûndertekenjen troch it publisearre federaasje-metadatadokumint te brûken. Yn ADFS is dit:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Yn guon gefallen is it miskien net mooglik om de ADFS-tsjinner te berikken fanút it Changepoint web tsjinner sadat jo de konfiguraasje manuell moatte bywurkje nei it útfieren fan it konfiguraasjeskript. Foar details, sjoch "Iepenbiere kaaien mei de hân bywurkje" op side 12.

Parameter	Beskriuwing
WebService_Path	Lokaasje fan de Changepoint WCF Web Tsjinsten web oanfraach files. Standert: \API\CP Web Tsjinsten
WebService_URI	Domeinidentifikaasje dy't jo brûke foar Changepoint WCF Web Tsjinsten. Bygelyksample., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Namme fan it sertifikaat dat jo brûke foar Cookie-kodearring. Standert: de "CN=ChangepointApiCertificate" sertifikaatnamme.
ServiceCertificate_Name	Sertifikaatnamme dy't sil wurde brûkt om de tsjinst te autentisearjen foar kliïnten mei help fan Berjochtbefeiligingsmodus. Standert: de "CN=ChangepointApiCertificate" sertifikaatnamme.
SigningCertificate_Name	Namme fan it sertifikaat dat jo brûke foar it ûndertekenjen fan berjochten. Standert: de sertifikaatnamme "CN=ChangepointApiCertificate" wurdt brûkt.
ADFS_ FederationServiceName	Federaasje Service Namme. Om de namme te krijen: Start ADFS 2.0 Management konsole fan 'e ADFS-tsjinner. •Selektearje ADFS 2.0 út it linkermenu. •Ut it Aksje-paniel selektearje Bewurkje Federaasjetsjinsteigenskippen. De namme fan de Federaasjetsjinst stiet op it ljepblêd Algemien.
ClaimType	SSO Claim Type. De standert is: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Utfiere konfiguraasje skripts
Konfigurearje de websiden mei help fan de wearden foar de konfiguraasje parameters.

1. Iepenje in PowerShell-prompt.
   Noat: As jo ​​tsjinner brûkersaccountkontrôle ynskeakele hat, moatte jo de PowerShell-prompt iepenje mei ferhege beheardersrjochten.
2. Gean nei it Feroaringspunt web tsjinst konfiguraasjemap, standert: KonfiguraasjeCPWebTsjinst
3.  Utfiere: ./Configuration_SSO_ADFS.ps1
4. Folgje de prompts.

Stage 3 Meitsje betrouwende partij fertrouwen
Meitsje de Relying Party Trust yn ADFS 2.0 Console.

1. Start de ADFS 2.0-konsole op jo ADFS-tsjinner.
2. Selektearje Aksje > Add Relying Party Trust.
3. Klik Start.
4. Selektearje Ymportearje gegevens oer de fertroude partij publisearre online of op in lokaal netwurk.
5. Fier it adres fan de Federaasje metadata yn, en klik dan op Folgjende, bygelyksample:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Fier in werjeftenamme yn, bygelyks Changepoint WCF API, en klikje Folgjende, Folgjende, Folgjende, dan slute.
7. Foegje in claimregel ta foar de boppesteande Changepoint Relying Party. Foar Changepoint is de standertnamme fan Claimregel "UPN".
8. Map it LDAP-attribuut "User-Principal-Name" oan útgeande claimtype "* UPN" of "UPN".

Iepenbiere kaaien manuell bywurkje
Om de ADFS Server Token Signing Thumbprint te krijen

1. Fanôf de ADFS-tsjinner, Launch ADFS 2.0 Management console.
2. Selektearje Tsjinst> Sertifikaten, en dûbelklik op it sertifikaat foar tekenûndertekening.
3. Selektearje it ljepblêd Details.
4. Selektearje it Thumbprint fjild.
5. Om de thumbprintwearde te krijen, ferwiderje alle spaasjes ynklusyf de earste spaasje.

Om bywurkje de Web.config file

1. ADFS bewurkje web.config. De standert lokaasje is:
   EnterpriseRP-STS_ADFS
2. Ûnder de elemint, fyn de ida:FederationMetadataLocation-kaai en wiskje de wearde:
   
3. Ûnder , fyn elemint en ferfange it mei it folgjende: https://ADFS_Federation.ServiceName/adfs/services/trust">https://ADFS_Federation.ServiceName/adfs/services/trust” />

De COM API-ferbining testen

1. Run de API Test Kit. De standert lokaasje is:
   APIAPI ComponentsApiTestKit.exe.
2. Klik Connection String > Encrypter.
3. Yn it fjild Plain Text Connections String:
   in. Ferfang SERVERNAME en DATABASENAME mei jo databankynformaasje.
   b. Ferfange USERID en PASSWORD mei jo database admin brûkersaccount ynformaasje.
   c. Fier de timeoutwearde yn as nedich.
4. Klikje op Fersiferje.
5. Kopiearje de tekst yn it fjild Fersifere ferbiningsstring.
6. Slút it dialoochfinster.
7. Klikje op it menu API Test Kit Ferbining > COM API Connection Tester.
8. Plak yn it ljepblêd Aktuele ferzje de fersifere ferbiningstring yn it fjild Ferbiningsstring.
9. Fier yn de fjilden LoginId en Wachtwurd de oanmeld-ID en wachtwurd yn foar jo Changepoint-akkount.
10. Spesifisearje yn it fjild Loglevel (0-8) it nivo fan flaterynformaasje dat weromjûn wurdt yn it COM API-log file as it testresultaat in probleem mei de ferbining toant.
    0 = Gjin logging
    1 = Boarne foarwerp en metoade
    2 = Flaterberjocht
    3 = Ynfier parameters
    4 = werom
    5 = Warskôging
    8 = Kontrolepunt
    De standert is 8.
11. Klik Ferbine.
    As de ferbining suksesfol wie, wurdt in súksesberjocht werjûn yn it Resultaatfjild. As de ferbining mislearre, kontrolearje dan it COM API log file foar flaters. De standert lokaasje fan it log file is APIAPILogs.

Kontrolearje de ferzje fan ynstallearre API-komponinten
Jo kinne it ferzjekontrôleprogramma brûke om details te krijen oer de ynstalleare komponinten, ynklusyf de releaseferzje en it paad.

1. Run CPVersionChecker.exe. It standert paad is: APIAPI Components
2. Klik op Lês.

Kontrolearje de ferzje fan de Web Tsjinsten API

1. Starte Internet Explorer fanôf de tsjinner wêr't de Web Services API is ynstalleare, en fier it adres yn:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  dêr't haven is de haven nûmer fan de webside wêr't jo de CP ynstalleareWebService firtuele triemtafel.
2. Klikje op de WSLogin-side op de GetVersion-keppeling.
3. Klik Oproppe.

It testen fan de Web Tsjinsten API ferbining

1. Starte Internet Explorer fanôf de tsjinner wêr't de Web Services API is ynstalleare, en fier it adres yn: http://localhost.port/CPWeb.Service/WSLogin.asmx  dêr't haven is de haven nûmer fan de webside wêr't jo de CP ynstalleareWebService firtuele triemtafel.
2. Klikje op de WSLogin-side op de TestConnection-keppeling.
3. Klik Oproppe. 4. Yn de testresultaten:

• As elemint is falsk, de testferbining slagge.
• As elemint is wier, de testferbining mislearre. Foar mear
  ynformaasje oer de redenen foar it mislearjen, sjoch de en eleminten yn 'e testresultaten, en kontrolearje de API-logs. It standertpaad nei de API-logs is: APIAPILogs

It opsetten fan de Web Tsjinsten API op in taaltsjinner

1. Om it Changepoint yn te setten Web Tsjinsten API op in taal tsjinner, moatte jo tafoegje of bywurkje de tag yn de Web Tsjinsten API web.config. De standert lokaasje fan de Web.config file is: APICP Web TsjinstenWeb.config
2. As de tag bestiet al, soargje derfoar dat sawol kultuer as uiCulture attributen binne "en-US."
3. As de tag bestiet net al, foegje it folgjende ta , kommentaar, en eleminten oan deweb> knooppunt:web>
   Visual Basic-opsjes: Stel strikt = "wier" yn om alle konverzjes fan gegevenstypes te ferwiderjen wêr't gegevensferlies kin foarkomme. Stel eksplisyt = "wier" om deklaraasje fan alle fariabelen te twingen. –>
4. IIS opnij starte.