Uputstvo za instalaciju softvera Changepoint API

Vodič za instalaciju API-ja
Referentni vodič
Changepoint 2021

© 2021 Changepoint Canada ULC Sva prava zadržana. PRAVA VLADE SAD-Upotreba, umnožavanje ili otkrivanje od strane Vlade SAD podliježe ograničenjima kako je navedeno u Ugovoru o licenci Changepoint Canada ULC i kako je predviđeno u DFARS 227.7202-1(a) i 227.7202-3(a) (1995.), DFARS 252.227-7013(c)(1)(ii) (OKT 1988.), FAR 12.212(a) (1995.), FAR 52.227-19 ili FAR 52.227-14 (ALT III), kako je primjenjivo. Ovaj proizvod sadrži povjerljive informacije i poslovne tajne Changepoint Canada ULC. Otkrivanje je zabranjeno bez prethodne izričite pismene dozvole Changepoint Canada ULC. Korišćenje ovog proizvoda podleže uslovima i odredbama Ugovora o licenciranju korisnika sa Changepoint Canada ULC. Dokumentaciju može reproducirati samo korisnik licence za internu upotrebu. Sadržaj ovog dokumenta ne smije se mijenjati, modificirati ili mijenjati bez izričitog pismenog pristanka Changepoint Canada ULC. Changepoint Canada ULC može promijeniti ovdje naveden sadržaj u bilo koje vrijeme, sa ili bez obavještenja.

Instaliranje Changepoint API-ja

O instalaciji Changepoint API-ja
Changepoint API je dostupan kao COM API, usluga Windows Communication Foundation (WCF) i, za kompatibilnost unatrag, kao Web Usluga poboljšanja usluga (WSE). Za informacije o Changepoint API-ju, pogledajte Changepoint API Reference. Za napomene o nadogradnji, upozorenja i poznate probleme, pogledajte Bilješke o izdanju u timskim mapama u Changepoint.
Nadogradnja Changepoint API-ja
Ako vršite nadogradnju sa prethodnog izdanja Changepoint-a, koristite Windows Control Panel da deinstalirate prethodnu verziju Changepoint API-ja i njegove komponente prije instaliranja ove verzije.
Changepoint API zahtjevi
Morate instalirati Changepoint prije nego instalirate Changepoint API. Za softverske zahtjeve pogledajte matricu kompatibilnosti softvera Changepoint, koja je dostupna u fascikli tima Napomene o izdanju i zakrpe za 2021. u Changepoint.
File konvencije o putevima
U ovom dokumentu se koriste sljedeće konvencije za uobičajene puteve:

• Korenska staza instalacije Changepoint.
  Zadana staza je:
  C: Program Files (x86)ChangepointChangepoint
• Osnovna lokacija za uobičajene uslužne programe Changepoint, kao što je pomoćni program za postavke prijave.
  Zadana staza je:
  C: Program Files (x86) Uobičajeno FilesChangepointChangepoint

Instaliranje Changepoint API-ja

1. Iz korijenskog direktorija API medija Changepoint, pokrenite setup.exe.
2. Slijedite upute dok se ne pojavi ekran Select Features.
3. Odaberite funkcije koje želite instalirati, a zatim kliknite na Next.
4. Odaberite API odredišnu mapu, zadanu API i kliknite na Next.
   Napomena: Uslužni program Changepoint Login Settings je instaliran LoginSettings, bez obzira na odredišni folder koji navedete.
5. Ako ste odabrali Web Services API: a. Kada se pojavi Select
   a Web Pojavi se ekran lokacije, izaberite a webweb-mjestu za dodavanje virtualnog direktorija, a zatim kliknite na Next.
   b. Kliknite na Next za nastavak. 6. Kada je instalacija API-ja završena, kliknite na Završi.

Konfiguriranje Changepoint API-ja da bude svjestan predmemorije
Da biste konfigurirali Changepoint API da bude svjestan predmemorije, zamijenite vrijednosti za „cache. Lozinka” i „cache. Serveri” ključevi u CP Web UslugeWeb.config file sa vrijednostima koje se koriste u PreduzećuWeb.config file.
Omogućavanje Web Poboljšanja usluga (WSE)

1. Uredite Web.config file za web usluge. Zadana lokacija je:
   APICP Web UslugeWeb.config
2. Pronađite tri instance sljedećeg reda komentara:
   < !– Dekomentirajte sljedeći element ako ga koristite Web API poboljšanja usluga (WSE). Ostavite komentare ako koristite WCF usluge i ne instalirate Web Poboljšanja usluge (WSE) –>
3. Dekomentirajte element koji slijedi svaku instancu reda komentara:
   <section name=”microsoft.web.services2″ … >webUsluge>web.services2>
   Napomena: ThewebServices> element koji treba dekomentirati je podređeni elementweb>.

Konfiguriranje evidentiranja za Web Services API
Morate postaviti dnevnik file putanja i nivoi dnevnika. Nivoi dnevnika su kumulativni. Za nprample, ako navedete nivo 3, nivoi 1, 2 i 3 se evidentiraju. Podrazumevani nivo dnevnika je 8.

1. Uredite web usluge Web.config. Zadana lokacija je:
   APICP Web UslugeWeb.config
2. Postavite dnevnikFilePut. Zadana vrijednost je APIAPILogs. 3. Postavite LogLevel. Važeće vrijednosti su:
   0 = Nema evidentiranja
   1 = Izvorni objekat i metod
   2 = Poruka o grešci
   3 = Ulazni parametri
   4 = Povratak
   5 = Upozorenje
   8 = Kontrolna tačka

Konfiguriranje provjere autentičnosti virtualnog direktorija za Web Services API
Morate omogućiti anonimni pristup i onemogućiti integriranu Windows autentifikaciju za CPWebVirtuelni imenik usluge u Internet Information Services (IIS). Za više informacija pogledajte Microsoft IIS dokumentaciju.
Konfiguriranje postavki veze sa bazom podataka za Web Services API
Koristite uslužni program Postavke prijave da šifrirate postavke veze sa bazom podataka u Web Services API Web.config file. Za više informacija potražite “Konfiguriranje postavki veze sa bazom podataka” u Changepoint Vodiču za instalaciju.
Konfiguriranje provjere autentičnosti za Changepoint WCF Web Usluge
Možete konfigurirati provjeru autentičnosti aplikacije i jednostruku prijavu (SSO) za Changepoint WCF Web Usluge.
Sljedeće opcije implementacije dostupne su korištenjem Secure Token Service (STS):

• SSO koristeći ISAPI SSL opciono
• Potreban je SSO koji koristi WS-Federation (ADFS 2.0).

Ako je SSL potreban, konfiguracijska skripta osigurava da se koristi.
Konfiguracijske skripte za ISAPI i provjeru autentičnosti aplikacije mogu opciono omogućiti SSL.
Konfiguriranje provjere autentičnosti aplikacije za WCF Web Usluge
Zadani tip provjere autentičnosti za Changepoint WCF Web Usluga je autentikacija aplikacije.
Koristite procedure u ovom odeljku da:

• konfigurirajte Changepoint WCF Web Usluge za korištenje provjere autentičnosti aplikacije sa SSL-om
• vrati Changepoint WCF Web Usluge provjere autentičnosti aplikacije nakon implementacije jedne od SSO implementacija

Konfigurišite PowerShell

1. Otvorite Windows PowerShell prompt.
2. Izmijenite politiku izvršavanja:
   Set-ExecutionPolicy neograničeno

Stage 1 Prikupite konfiguracijske parametre
Odredite vrijednosti za konfiguracijske parametre.

Parametar	Opis
WebService_Path	Lokacija WCF točke promjene Web Usluge web aplikacija files. Zadano: \API\CP Web Usluge
Sertifikat_ Ime	Naziv certifikata koji će se koristiti za provjeru autentičnosti usluge klijentima pomoću sigurnosnog načina poruke. Zadano: naziv certifikata “CN=ChangepointAPICertificate”.
zahtijevaju HTTPS	Zahtijeva HTTPS (tačno/netačno) Podrazumevano: False.

Stage 2 Izvršite konfiguracijske skripte
Koristite vrijednosti za konfiguracijske parametre za izmjenu konfiguracije webweb stranice.

1.  Otvorite PowerShell prompt.
   Napomena: Ako je na vašem serveru omogućena kontrola korisničkog naloga, morate otvoriti PowerShell prompt koristeći povišene administratorske dozvole.
2. Idite do CP web direktorij konfiguracije usluge, zadano:
   ConfigurationCPWebServis
3.  Izvršite ./Configuration_AppAuth.ps1
4. Slijedite upute.

Konfiguriranje jedinstvene prijave (SSO) za WCF Web Usluge
Konfigurišite PowerShell

1. Otvorite Windows PowerShell prompt.
2. Izmijenite politiku izvršavanja:
   Set-ExecutionPolicy neograničeno

Konfiguriranje SSO koristeći ISAPI za WCF Web Usluge
Stage 1 Prikupite konfiguracijske parametre
Odredite vrijednosti za sljedeće konfiguracijske parametre.

Parametar	Opis
WebService_Path	Lokacija Changepoint WCF Web Usluge web aplikacija files. Zadano: \API\CP Web Usluge
zahtijevaju HTTPS	Zahtijeva HTTPS (tačno/netačno). Podrazumevano: False.
Changepoint_RSA_ Cookie_Transform	Naziv certifikata koji koristite za šifriranje kolačića. Zadano: naziv certifikata “CN=ChangepointAPICertificate”.
ServiceCertificate_Name	Unesite naziv certifikata koji će se koristiti za provjeru autentičnosti usluge klijentima koristeći Sigurnosni način poruke. Zadano: naziv certifikata “CN=ChangepointAPICertificate”.
SigningCertificate_Name	Unesite naziv certifikata za potpisivanje. Ovo je naziv certifikata koji koristite za potpisivanje poruka. Zadano: naziv certifikata “CN=ChangepointAPICertificate”.
ISAPI_Mode	ISAPI način rada. Podrazumevano: NT
ISAPI_Header	Zaglavlje koje se koristi kada je ISAPI_Mode "HEADER", nprample, prazno.
ClaimType	Unesite SSO vrstu zahtjeva. Zadano: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Izvršite konfiguracijske skripte

1. Otvorite PowerShell prompt.
   Napomena: Ako je na vašem serveru omogućena kontrola korisničkog naloga, morate otvoriti PowerShell prompt koristeći povišene administratorske dozvole.
2. Idite do CP web direktorij konfiguracije usluge, zadano:
   ConfigurationCPWebServis
3. Izvršite: ./Configuration_SSO_ISAPI.ps1
4. Slijedite upute.

Konfiguriranje SSO-a pomoću WS-Federacije (ADFS 2.0) za WCF Web Usluge
Stage 1 Prikupite konfiguracijske parametre
Odredite vrijednosti za konfiguracijske parametre u tabeli ispod. Uvjerite se da je ADFS_Server_URI u intranet zoni pretraživača krajnjeg korisnika.
Napomena: Po defaultu, Changepoint je konfiguriran da automatski ažurira javne ključeve koji se koriste za potpisivanje sigurnosnih tokena korištenjem objavljenog dokumenta sa metapodacima federacije. U ADFS-u ovo je:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
U nekim slučajevima možda neće biti moguće doći do ADFS servera iz Changepoint-a web server tako da ćete morati ručno ažurirati konfiguraciju nakon pokretanja skripte za konfiguraciju. Za detalje pogledajte “Ručno ažuriranje javnih ključeva” na stranici 12.

Parametar	Opis
WebService_Path	Lokacija WCF točke promjene Web Usluge web aplikacija files. Zadano: \API\CP Web Usluge
WebService_URI	Identifikator domene koji koristite za Changepoint WCF Web Usluge. Za nprample., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Naziv certifikata koji koristite za šifriranje kolačića. Zadano: naziv certifikata “CN=ChangepointApiCertificate”.
ServiceCertificate_Name	Naziv certifikata koji će se koristiti za provjeru autentičnosti usluge klijentima pomoću sigurnosnog načina poruke. Zadano: naziv certifikata “CN=ChangepointApiCertificate”.
SigningCertificate_Name	Naziv certifikata koji koristite za potpisivanje poruka. Zadano: koristi se naziv certifikata “CN=ChangepointApiCertificate”.
ADFS_ FederationServiceName	Naziv službe Federacije. Da biste dobili ime: Sa ADFS servera, pokrenite ADFS 2.0 konzolu za upravljanje. •Iz levog menija izaberite ADFS 2.0. • Iz okna Akcija izaberite Uredi svojstva usluge Federacije. Naziv usluge Federacije je na kartici Općenito.
ClaimType	SSO vrsta zahtjeva. Zadana postavka je: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Izvršite konfiguracijske skripte
Konfigurišite webweb stranice koje koriste vrijednosti za konfiguracijske parametre.

1. Otvorite PowerShell prompt.
   Napomena: Ako je na vašem serveru omogućena kontrola korisničkog naloga, morate otvoriti PowerShell prompt koristeći povišene administratorske dozvole.
2. Idite do Changepoint web direktorij konfiguracije usluge, zadano: ConfigurationCPWebServis
3.  Izvršite: ./Configuration_SSO_ADFS.ps1
4. Slijedite upute.

Stage 3 Stvorite povjerenje oslonjene strane
Kreirajte povjerenje pouzdane strane u ADFS 2.0 konzoli.

1. Na vašem ADFS serveru pokrenite ADFS 2.0 konzolu.
2. Odaberite Akcija > Dodaj povjerenje pouzdane strane.
3. Kliknite na Start.
4. Odaberite Uvezi podatke o pouzdanoj strani objavljene na mreži ili na lokalnoj mreži.
5. Unesite adresu metapodataka Federacije, a zatim kliknite na Next, nprample:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Unesite naziv za prikaz, npr. Changepoint WCF API, i kliknite na Next, Next, Next, zatim Zatvori.
7. Dodajte pravilo zahtjeva za gornju stranu koja se oslanja na promjenu tačke. Za Changepoint, zadani naziv pravila zahtjeva je “UPN”.
8. Mapirajte LDAP atribut “User-Principal-Name” u tip odlaznog zahtjeva “* UPN” ili “UPN”.

Ručno ažuriranje javnih ključeva
Da biste dobili otisak palca za potpisivanje tokena ADFS servera

1. Sa ADFS servera, pokrenite ADFS 2.0 konzolu za upravljanje.
2. Odaberite Usluga > Certifikati i dvaput kliknite na certifikat za potpisivanje tokena.
3. Odaberite karticu Detalji.
4. Odaberite polje Thumbprint.
5. Da biste dobili vrijednost otiska palca, uklonite sve razmake uključujući prvi razmak.

Za ažuriranje Web.config file

1. Uredite ADFS web.config. Zadana lokacija je:
   EnterpriseRP-STS_ADFS
2. Ispod element, pronađite ključ ida:FederationMetadataLocation i obrišite njegovu vrijednost:
   
3. Ispod , pronađite element i zamijenite ga sljedećim: https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust” />

Testiranje COM API veze

1. Pokrenite komplet za testiranje API-ja. Zadana lokacija je:
   APIAPI ComponentsApiTestKit.exe.
2. Kliknite na Niz veze > Encrypter.
3. U polju Niz veza običnog teksta:
   a. Zamijenite SERVERNAME i DATABASENAME informacijama o vašoj bazi podataka.
   b. Zamijenite USERID i PASSWORD informacijama o korisničkom računu administratora baze podataka.
   c. Unesite vrijednost vremenskog ograničenja po potrebi.
4. Kliknite Šifriraj.
5. U polju Encrypted Connection String kopirajte tekst.
6. Zatvorite dijaloški okvir.
7. U meniju API Test Kit, kliknite na Connection > COM API Connection Tester.
8. Na kartici Trenutna verzija zalijepite šifrirani niz veze u polje Niz veze.
9. U polja LoginId i Password unesite ID za prijavu i lozinku za vaš Changepoint nalog.
10. U polju Loglevel (0-8) navedite nivo informacija o grešci koje će se vratiti u COM API dnevnik file ako rezultat testa pokaže problem sa vezom.
    0 = Nema evidentiranja
    1 = Izvorni objekat i metod
    2 = Poruka o grešci
    3 = Ulazni parametri
    4 = Povratak
    5 = Upozorenje
    8 = Kontrolna tačka
    Podrazumevano je 8.
11. Kliknite na Connect.
    Ako je veza bila uspješna, u polju Rezultat se prikazuje poruka o uspjehu. Ako veza nije uspjela, provjerite COM API dnevnik file za greške. Zadana lokacija dnevnika file je APIAPILogs.

Provjera verzije instaliranih API komponenti
Možete koristiti uslužni program za provjeru verzije da dobijete detalje o instaliranim komponentama, uključujući verziju izdanja i putanju.

1. Pokrenite CPVersionChecker.exe. Zadana staza je: APIAPI komponente
2. Kliknite na Read.

Provjera verzije Web Services API

1. Pokrenite Internet Explorer sa servera na kojem je Web Services API je instaliran i unesite adresu:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  gdje je port broj porta weblokacija na kojoj ste instalirali CPWebVirtualni direktorij servisa.
2. Na stranici WSLogin kliknite na vezu GetVersion.
3. Kliknite Pozovi.

Testiranje Web Services API veza

1. Pokrenite Internet Explorer sa servera na kojem je Web Services API je instaliran i unesite adresu: http://localhost.port/CPWeb.Service/WSLogin.asmx  gdje je port broj porta weblokacija na kojoj ste instalirali CPWebVirtualni direktorij servisa.
2. Na stranici WSLogin kliknite na vezu TestConnection.
3. Kliknite Pozovi. 4. U rezultatima testa:

• Ako element je netačan, probna veza je uspjela.
• Ako element je istinit, probna veza nije uspjela. Za više
  informacije o razlozima kvara, pogledajte i elemente u rezultatima testa i provjerite API logove. Zadana staza do API dnevnika je: APIAPILogs

Postavljanje Web Services API na jezičkom serveru

1. Da biste postavili Changepoint Web Services API na jezičkom serveru, morate dodati ili ažurirati tag u Web Services API web.config. Zadana lokacija za Web.config file je: APICP Web UslugeWeb.config
2. Ako je tag već postoji, osigurajte da su atributi kulture i uiCulture “en-US”.
3. Ako je tag već ne postoji, dodajte sljedeće , komentar i elementi zaweb> čvor:web>
   Visual Basic opcije: Postavite strict=” true” da zabranite sve konverzije tipova podataka u kojima može doći do gubitka podataka. Postavite explicit=”true” da prisilite deklaraciju svih varijabli. –>
4. Ponovo pokrenite IIS.