Sprievodca inštaláciou softvéru Changepoint API

Sprievodca inštaláciou API
Referenčná príručka
Bod zmeny 2021

© 2021 Changepoint Canada ULC Všetky práva vyhradené. PRÁVA VLÁDY USA – Použitie, duplikácia alebo zverejnenie vládou USA podlieha obmedzeniam, ako je uvedené v licenčnej zmluve Changepoint Canada ULC a ako je uvedené v DFARS 227.7202-1(a) a 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OKT 1988), FAR 12.212(a) (1995), FAR 52.227-19 alebo FAR 52.227-14 (ALT III), podľa potreby. Tento produkt obsahuje dôverné informácie a obchodné tajomstvá spoločnosti Changepoint Canada ULC. Zverejnenie je zakázané bez predchádzajúceho výslovného písomného súhlasu Changepoint Canada ULC. Používanie tohto produktu podlieha ustanoveniam a podmienkam licenčnej zmluvy používateľa so spoločnosťou Changepoint Canada ULC. Dokumentáciu môže držiteľ licencie reprodukovať iba na interné použitie. Obsah tohto dokumentu sa nesmie meniť, upravovať alebo meniť bez výslovného písomného súhlasu spoločnosti Changepoint Canada ULC. Changepoint Canada ULC môže kedykoľvek zmeniť obsah špecifikovaný v tomto dokumente s upozornením alebo bez neho.

Inštalácia rozhrania Changepoint API

O inštalácii rozhrania Changepoint API
Changepoint API je dostupné ako COM API, služba Windows Communication Foundation (WCF) a pre spätnú kompatibilitu ako Web Služba vylepšenia služieb (WSE). Informácie o Changepoint API nájdete v Changepoint API Reference. Poznámky k inovácii, upozornenia a známe problémy nájdete v poznámkach k vydaniu v priečinkoch tímu v Changepoint.
Aktualizácia rozhrania Changepoint API
Ak inovujete z predchádzajúceho vydania Changepoint, použite Ovládací panel Windows na odinštalovanie predchádzajúcej verzie Changepoint API a jeho komponentov pred inštaláciou tejto verzie.
Požiadavky rozhrania Changepoint API
Pred inštaláciou rozhrania Changepoint API musíte nainštalovať Changepoint. Softvérové ​​požiadavky nájdete v matici kompatibility softvéru Changepoint, ktorá je k dispozícii v tímovom priečinku Poznámky k vydaniu a záplaty 2021 v Changepoint.
File cestné konvencie
V tomto dokumente sa pre bežné cesty používajú nasledujúce konvencie:

• Koreňová cesta inštalácie Changepoint.
  Predvolená cesta je:
  C: Program Files (x86)ChangepointChangepoint
• Koreňové umiestnenie bežných pomocných programov Changepoint, ako je pomôcka Nastavenia prihlásenia.
  Predvolená cesta je:
  C: Program Files (x86) Bežné FilesChangepointChangepoint

Inštalácia rozhrania Changepoint API

1. V koreňovom adresári média API Changepoint spustite setup.exe.
2. Postupujte podľa pokynov, kým sa nezobrazí obrazovka Select Features.
3. Vyberte funkcie, ktoré chcete nainštalovať, a potom kliknite na tlačidlo Ďalej.
4. Vyberte cieľový priečinok API, predvolený API a kliknite na tlačidlo Ďalej.
   Poznámka: Nástroj Changepoint Login Settings je nainštalovaný v LoginSettings, bez ohľadu na cieľový priečinok, ktorý určíte.
5. Ak ste vybrali Web Služby API: a. Keď sa zobrazí tlačidlo Vybrať
   a Web Zobrazí sa obrazovka lokality, vyberte a weblokality, do ktorej chcete pridať virtuálny adresár, a potom kliknite na tlačidlo Ďalej.
   b. Pokračujte kliknutím na tlačidlo Ďalej. 6. Po dokončení inštalácie API kliknite na Finish.

Konfigurácia rozhrania Changepoint API, aby bolo vedomé pamäte cache
Ak chcete nakonfigurovať rozhranie Changepoint API tak, aby podporovalo vyrovnávaciu pamäť, nahraďte hodnoty pre „cache. Heslo“ a „vyrovnávacia pamäť. Servery“ v CP Web SlužbyWeb.config file s hodnotami používanými v EnterpriseWeb.config file.
Povolenie Web Vylepšenia služieb (WSE)

1. Upravte Web.config file pre web služby. Predvolené umiestnenie je:
   APICP Web SlužbyWeb.config
2. Nájdite tri výskyty nasledujúceho riadka komentára:
   < !– Odkomentujte nasledujúci prvok, ak ho používate Web Rozhranie API vylepšenia služieb (WSE). Ak používate služby WCF a neinštalujete ich, zanechajte komentáre Web Vylepšenia služieb (WSE) –>
3. Odkomentujte prvok, ktorý nasleduje za každou inštanciou riadka komentára:
   <section name=”microsoft.web.services2″ … >webSlužby>web.služby2>
   Poznámka: ThewebSlužby> prvok, ktorý nemá byť komentovaný, je potomkomweb>.

Konfigurácia protokolovania pre Web Služby API
Musíte nastaviť denník file úrovne cesty a denníka. Úrovne denníka sú kumulatívne. Naprample, ak zadáte úroveň 3, zaprotokolujú sa úrovne 1, 2 a 3. Predvolená úroveň denníka je 8.

1. Upravte web služby Web.config. Predvolené umiestnenie je:
   APICP Web SlužbyWeb.config
2. Nastavte denníkFileCesta. Predvolená hodnota je Protokoly APIAPI. 3. Nastavte LogLevel. Platné hodnoty sú:
   0 = Bez protokolovania
   1 = Zdrojový objekt a metóda
   2 = chybové hlásenie
   3 = Vstupné parametre
   4 = Vrátenie
   5 = Varovanie
   8 = Kontrolný bod

Konfigurácia autentifikácie virtuálneho adresára pre Web Služby API
Musíte povoliť anonymný prístup a zakázať integrované overovanie systému Windows pre CPWebSlužba virtuálneho adresára v Internetovej informačnej službe (IIS). Ďalšie informácie nájdete v dokumentácii služby Microsoft IIS.
Konfigurácia nastavení pripojenia k databáze pre Web Služby API
Použite pomôcku Nastavenia prihlásenia na zašifrovanie nastavení pripojenia k databáze v Web Služby API Web.config file. Ďalšie informácie nájdete v časti „Konfigurácia nastavení pripojenia databázy“ v príručke Changepoint Installation Guide.
Konfigurácia autentifikácie pre Changepoint WCF Web Služby
Pre Changepoint WCF môžete nakonfigurovať overenie aplikácie a jednotné prihlásenie (SSO). Web Služby.
Nasledujúce možnosti implementácie sú dostupné pomocou Secure Token Service (STS):

• SSO pomocou ISAPI SSL voliteľné
• Jednotné prihlásenie pomocou WS-Federation (ADFS 2.0) Vyžaduje sa SSL

Ak sa vyžaduje SSL, konfiguračný skript zabezpečí jeho použitie.
Konfiguračné skripty pre ISAPI a autentifikáciu aplikácií môžu voliteľne povoliť SSL.
Konfigurácia overenia aplikácie pre WCF Web Služby
Predvolený typ autentifikácie pre Changepoint WCF Web Služba je autentifikácia aplikácie.
Pomocou postupov v tejto časti:

• konfigurovať Changepoint WCF Web Služby na používanie autentifikácie aplikácií pomocou SSL
• vrátiť zmenu bodu WCF Web Služby pre autentifikáciu aplikácie po implementácii jednej z implementácií SSO

Nakonfigurujte PowerShell

1. Otvorte výzvu prostredia Windows PowerShell.
2. Upravte politiku vykonávania:
   Set-ExecutionPolicy Unrestricted

Stage 1 Zhromaždite konfiguračné parametre
Určite hodnoty konfiguračných parametrov.

Parameter	Popis
WebService_Path	Umiestnenie Changepoint WCF Web Služby web aplikácie files. Predvolená hodnota: \API\CP Web Služby
ServiceCertificate_ Meno	Názov certifikátu, ktorý sa použije na overenie služby klientom pomocou režimu zabezpečenia správ. Predvolené: názov certifikátu „CN=ChangepointAPICertificate“.
vyžadujú HTTPS	Vyžadovať HTTPS (pravda/nepravda) Predvolená hodnota: False.

Stage 2 Spustite konfiguračné skripty
Použite hodnoty pre konfiguračné parametre na úpravu konfigurácie webstránky.

1.  Otvorte výzvu PowerShell.
   Poznámka: Ak má váš server povolenú kontrolu používateľských kont, musíte otvoriť výzvu prostredia PowerShell pomocou zvýšených povolení správcu.
2. Prejdite na CP web adresár konfigurácie služby, predvolený:
   ConfigurationCPWebservis
3.  Spustite ./Configuration_AppAuth.ps1
4. Postupujte podľa pokynov.

Konfigurácia jednotného prihlásenia (SSO) pre WCF Web Služby
Nakonfigurujte PowerShell

1. Otvorte výzvu prostredia Windows PowerShell.
2. Upravte politiku vykonávania:
   Set-ExecutionPolicy Unrestricted

Konfigurácia SSO pomocou ISAPI pre WCF Web Služby
Stage 1 Zhromaždite konfiguračné parametre
Určite hodnoty pre nasledujúce konfiguračné parametre.

Parameter	Popis
WebService_Path	Umiestnenie Changepoint WCF Web Služby web aplikácie files. Predvolená hodnota: \API\CP Web Služby
vyžadujú HTTPS	Vyžadovať HTTPS (True/False). Predvolená hodnota: False.
Changepoint_RSA_ Cookie_Transform	Názov certifikátu, ktorý používate na šifrovanie súborov cookie. Predvolené: názov certifikátu „CN=ChangepointAPICertificate“.
ServiceCertificate_Name	Zadajte názov certifikátu, ktorý sa použije na overenie služby klientom pomocou režimu zabezpečenia správ. Predvolené: názov certifikátu „CN=ChangepointAPICertificate“.
SigningCertificate_Name	Zadajte názov podpisového certifikátu. Toto je názov certifikátu, ktorý používate na podpisovanie správ. Predvolené: názov certifikátu „CN=ChangepointAPICertificate“.
ISAPI_Mode	Režim ISAPI. Predvolené: NT
ISAPI_Header	Hlavička, ktorá sa používa, keď je ISAPI_Mode „HEADER“, naprample, prázdne.
ClaimType	Zadajte typ nároku SSO. Predvolená hodnota: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Spustite konfiguračné skripty

1. Otvorte výzvu PowerShell.
   Poznámka: Ak má váš server povolenú kontrolu používateľských kont, musíte otvoriť výzvu prostredia PowerShell pomocou zvýšených povolení správcu.
2. Prejdite na CP web adresár konfigurácie služby, predvolený:
   ConfigurationCPWebservis
3. Vykonajte: ./Configuration_SSO_ISAPI.ps1
4. Postupujte podľa pokynov.

Konfigurácia SSO pomocou WS-Federation (ADFS 2.0) pre WCF Web Služby
Stage 1 Zhromaždite konfiguračné parametre
V tabuľke nižšie určite hodnoty pre konfiguračné parametre. Uistite sa, že ADFS_Server_URI je v intranetovej zóne prehliadača koncového používateľa.
Poznámka: V predvolenom nastavení je Changepoint nakonfigurovaný tak, aby automaticky aktualizoval verejné kľúče, ktoré sa používajú na podpisovanie bezpečnostných tokenov, pomocou publikovaného dokumentu s metaúdajmi federácie. V ADFS je to:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
V niektorých prípadoch nemusí byť možné dosiahnuť server ADFS z bodu zmeny web server, takže po spustení konfiguračného skriptu budete musieť konfiguráciu aktualizovať manuálne. Podrobnosti nájdete v časti „Manuálna aktualizácia verejných kľúčov“ na strane 12.

Parameter	Popis
WebService_Path	Umiestnenie Changepoint WCF Web Služby web aplikácie files. Predvolená hodnota: \API\CP Web Služby
WebService_URI	Identifikátor domény, ktorý používate pre Changepoint WCF Web Služby. Napríkladample., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Názov certifikátu, ktorý používate na šifrovanie súborov cookie. Predvolené: názov certifikátu „CN=ChangepointApiCertificate“.
ServiceCertificate_Name	Názov certifikátu, ktorý sa použije na overenie služby klientom pomocou režimu zabezpečenia správ. Predvolené: názov certifikátu „CN=ChangepointApiCertificate“.
SigningCertificate_Name	Názov certifikátu, ktorý používate na podpisovanie správ. Predvolené: používa sa názov certifikátu „CN=ChangepointApiCertificate“.
ADFS_ FederationServiceName	Názov služby federácie. Ak chcete získať názov: Na serveri ADFS spustite konzolu správy ADFS 2.0. •Z ľavého menu vyberte ADFS 2.0. •Na table Akcia vyberte položku Upraviť vlastnosti služby Federation Service. Názov služby Federation Service je na karte Všeobecné.
ClaimType	Typ nároku na jednotné prihlásenie. Predvolená hodnota je: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Spustite konfiguračné skripty
Nakonfigurujte webstránky používajúce hodnoty pre konfiguračné parametre.

1. Otvorte výzvu PowerShell.
   Poznámka: Ak má váš server povolenú kontrolu používateľských kont, musíte otvoriť výzvu prostredia PowerShell pomocou zvýšených povolení správcu.
2. Prejdite na bod zmeny web adresár konfigurácie služby, predvolený: ConfigurationCPWebservis
3.  Vykonajte: ./Configuration_SSO_ADFS.ps1
4. Postupujte podľa pokynov.

Stage 3 Vytvorte dôveru spoliehajúcej sa strany
Vytvorte dôveru spoliehajúcej sa strany v konzole ADFS 2.0.

1. Na svojom serveri ADFS spustite konzolu ADFS 2.0.
2. Vyberte položku Akcia > Pridať dôveru spoliehajúcej sa strany.
3. Kliknite na tlačidlo Štart.
4. Vyberte možnosť Importovať údaje o spoliehajúcej sa strane zverejnené online alebo v lokálnej sieti.
5. Zadajte adresu metadát federácie a potom kliknite na tlačidlo Ďalej, naprample:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Zadajte zobrazovaný názov, napr. Changepoint WCF API, a kliknite na Ďalej, Ďalej, Ďalej, potom Zavrieť.
7. Pridajte pravidlo nároku pre vyššie uvedenú závislú stranu Changepoint. Pre Changepoint je predvolený názov pravidla Reklamácie „UPN“.
8. Namapujte atribút LDAP „User-Principal-Name“ na typ odchádzajúceho nároku „* UPN“ alebo „UPN“.

Manuálna aktualizácia verejných kľúčov
Ak chcete získať odtlačok podpisu tokenu servera ADFS

1. Zo servera ADFS spustite konzolu správy ADFS 2.0.
2. Vyberte položku Služba > Certifikáty a dvakrát kliknite na certifikát na podpisovanie tokenu.
3. Vyberte kartu Podrobnosti.
4. Vyberte pole Thumbprint.
5. Ak chcete získať hodnotu odtlačku, odstráňte všetky medzery vrátane prvej medzery.

Ak chcete aktualizovať Web.config file

1. Upravte ADFS web.config. Predvolené umiestnenie je:
   EnterpriseRP-STS_ADFS
2. Pod prvok, nájdite kľúč ida:FederationMetadataLocation a vymažte jeho hodnotu:
   
3. Pod , nájsť prvok a nahraďte ho nasledujúcim: https://ADFS_Federation.ServiceName/adfs/services/trust">https://ADFS_Federation.ServiceName/adfs/services/trust“/>

Testovanie pripojenia COM API

1. Spustite testovaciu súpravu API. Predvolené umiestnenie je:
   Komponenty APIAPIApiTestKit.exe.
2. Kliknite na položku Reťazec pripojenia > Šifrovač.
3. V poli Reťazec spojení s obyčajným textom:
   a. Nahraďte SERVERNAME a DATABASENAME informáciami o vašej databáze.
   b. Nahraďte USERID a PASSWORD informáciami o používateľskom účte správcu databázy.
   c. Podľa potreby zadajte hodnotu časového limitu.
4. Kliknite na položku Šifrovať.
5. Do poľa Encrypted Connection String skopírujte text.
6. Zatvorte dialógové okno.
7. V ponuke testovacej súpravy API kliknite na položku Pripojenie > Tester pripojenia COM API.
8. Na karte Aktuálna verzia prilepte zašifrovaný reťazec pripojenia do poľa Reťazec pripojenia.
9. Do polí LoginId a Password zadajte prihlasovacie meno a heslo pre váš účet Changepoint.
10. V poli Loglevel (0-8) zadajte úroveň chybových informácií, ktoré sa majú vrátiť do protokolu COM API file ak výsledok testu ukazuje problém s pripojením.
    0 = Bez protokolovania
    1 = Zdrojový objekt a metóda
    2 = chybové hlásenie
    3 = Vstupné parametre
    4 = Vrátenie
    5 = Varovanie
    8 = Kontrolný bod
    Predvolená hodnota je 8.
11. Kliknite na Pripojiť.
    Ak bolo pripojenie úspešné, v poli Výsledok sa zobrazí správa o úspechu. Ak pripojenie zlyhalo, skontrolujte protokol rozhrania COM API file za chyby. Predvolené umiestnenie denníka file je Protokoly APIAPI.

Kontrola verzie nainštalovaných komponentov API
Na získanie podrobností o nainštalovaných komponentoch vrátane verzie vydania a cesty môžete použiť pomocný program na kontrolu verzie.

1. Spustite CPVersionChecker.exe. Predvolená cesta je: Komponenty APIAPI
2. Kliknite na položku Čítať.

Kontrola verzie Web Služby API

1. Spustite Internet Explorer zo servera, na ktorom je Web Services API je nainštalované a zadajte adresu:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  kde port je číslo portu webmiesto, kde ste nainštalovali CPWebSlužba virtuálneho adresára.
2. Na stránke WSLogin kliknite na prepojenie GetVersion.
3. Kliknite na položku Vyvolať.

Testovanie Web Pripojenie služby API

1. Spustite Internet Explorer zo servera, na ktorom je Web Services API je nainštalované a zadajte adresu: http://localhost.port/CPWeb.Service/WSLogin.asmx  kde port je číslo portu webmiesto, kde ste nainštalovali CPWebSlužba virtuálneho adresára.
2. Na stránke WSLogin kliknite na odkaz TestConnection.
3. Kliknite na položku Vyvolať. 4. Vo výsledkoch testu:

• Ak je nepravda, testovacie pripojenie bolo úspešné.
• Ak je pravdivé, testovacie pripojenie zlyhalo. Pre viac
  informácie o príčinách poruchy nájdete v časti a prvky vo výsledkoch testu a skontrolujte protokoly API. Predvolená cesta k protokolom API je: Protokoly APIAPI

Nastavenie Web Services API na jazykovom serveri

1. Na nasadenie Changepointu Web Services API na jazykovom serveri, musíte pridať alebo aktualizovať tag v Web Služby API web.config. Predvolené umiestnenie Web.config file je: APICP Web SlužbyWeb.config
2. Ak tag už existuje, uistite sa, že atribúty kultúry aj uiCulture sú „en-US“.
3. Ak tag ešte neexistuje, pridajte nasledujúce , komentovať a prvky kweb> uzol:web>
   Možnosti jazyka Visual Basic: Ak chcete zakázať všetky konverzie typu údajov, pri ktorých môže dôjsť k strate údajov, nastavte strict=”pravda”. Ak chcete vynútiť deklaráciu všetkých premenných, nastavte explicit=”true”. –>
4. Reštartujte IIS.