Pandhuan Instalasi API
Pandhuan Referensi
Changepoint 2021

© 2021 Changepoint Canada ULC Kabeh hak dilindhungi undhang-undhang. HAK PEMERINTAH AS-Panggunaan, duplikasi, utawa pambocoran dening Pamrentah AS tundhuk watesan kaya sing kasebut ing perjanjian lisensi Changepoint Canada ULC lan kaya sing diwenehake ing DFARS 227.7202-1(a) lan 227.7202-3(a) (1995), DFARS 252.227-7013 (c) (1) (ii) (OCT 1988), FAR 12.212 (a) (1995), FAR 52.227-19, utawa FAR 52.227-14 (ALT III), minangka ditrapake. Produk iki ngemot informasi rahasia lan rahasia dagang Changepoint Canada ULC. Pambocoran dilarang tanpa ijin tertulis saka Changepoint Canada ULC. Panganggone produk iki tundhuk karo syarat lan kahanan Perjanjian Lisensi pangguna karo Changepoint Canada ULC. Dokumentasi mung bisa diprodhuksi dening Penerima Lisensi kanggo panggunaan internal. Isi dokumen iki ora bisa diowahi, diowahi utawa diganti tanpa idin tinulis saka Changepoint Canada ULC. Changepoint Canada ULC bisa ngganti konten sing ditemtokake ing kene kapan wae, kanthi utawa tanpa kabar.

Nginstal Changepoint API

Babagan nginstal Changepoint API
Changepoint API kasedhiya minangka COM API, layanan Windows Communication Foundation (WCF) lan, kanggo kompatibilitas mundur, minangka Web Layanan Peningkatan Layanan (WSE). Kanggo informasi bab Changepoint API, ndeleng Changepoint API Reference. Kanggo cathetan upgrade, caveat lan masalah sing dikenal, deleng Cathetan Rilis ing folder tim ing Changepoint.
Nganyarke Changepoint API
Yen sampeyan nganyarke saka versi Changepoint sadurunge, gunakake Panel Kontrol Windows kanggo instal versi Changepoint API sadurunge lan komponene sadurunge nginstal versi iki.
Persyaratan API Changepoint
Sampeyan kudu nginstal Changepoint sadurunge nginstal Changepoint API. Kanggo syarat piranti lunak, deleng Changepoint Software Compatibility Matrix, sing kasedhiya ing folder tim Cathetan Rilis lan Patches 2021 ing Changepoint.
File konvènsi path
Saindhenging dokumen iki, konvensi ing ngisor iki digunakake kanggo jalur umum:

• Path ROOT saka instalasi Changepoint.
  Path standar yaiku:
  C: Program Files (x86)ChangepointChangepoint
• Lokasi ROOT kanggo utilitas Changepoint umum, kayata utilitas Setelan Login.
  Path standar yaiku:
  C: Program Files (x86) Umum FilesChangepointChangepoint

Nginstal Changepoint API

1. Saka direktori root media Changepoint API, mbukak setup.exe.
2. Tindakake pituduh nganti layar Pilih Fitur katon.
3. Pilih fitur sing pengin diinstal, banjur klik Sabanjure.
4. Pilih folder tujuan API, standar API, banjur klik Sabanjure.
   Cathetan: Utilitas Setelan Login Changepoint wis diinstal ing LoginSettings, preduli saka folder tujuan sing sampeyan nemtokake.
5. Yen sampeyan milih Web API Layanan: a. Nalika Pilih
   a Web Layar situs katon, pilih a websitus kanggo nambah direktori virtual, banjur klik Sabanjure.
   b. Klik Sabanjure kanggo nerusake. 6. Nalika instalasi API wis rampung, klik Rampung.

Konfigurasi Changepoint API supaya ngerti cache
Kanggo ngatur API Changepoint supaya ngerti cache, ganti nilai kanggo "cache. Sandi" lan "cache. Server" tombol ing CP Web LayananWeb.config file karo nilai sing digunakake ing EnterpriseWeb.config file.
Ngaktifake Web Peningkatan Layanan (WSE)

1. Sunting ing Web.config file kanggo web layanan. Lokasi standar yaiku:
   APICP Web LayananWeb.config
2. Temokake telung conto baris komentar ing ngisor iki:
   < !– Batal komentar ing unsur ing ngisor iki yen sampeyan nggunakake Web Service Enhancements (WSE) API. Ninggalake komentar yen nggunakake layanan WCF lan ora nginstal Web Peningkatan Layanan (WSE) ->
3. Batal komentar unsur sing ngetutake saben conto baris komentar:
   <section name=”microsoft.web.layanan2″ … >webLayanan>web.layanan2>
   Cathetan: IngwebLayanan> unsur kanggo uncommented iku anak sakaweb>.

Konfigurasi logging kanggo Web Layanan API
Sampeyan kudu nyetel log file path lan tingkat log. Tingkat log iku kumulatif. Kanggo example, yen sampeyan nemtokake level 3, banjur level 1, 2, lan 3 dicathet. Tingkat log standar yaiku 8.

1. Sunting ing web layanan Web.config. Lokasi standar yaiku:
   APICP Web LayananWeb.config
2. Setel LogFilePath. Nilai standar yaiku APIAPILlogs. 3. Setel LogLevel. Nilai sing valid yaiku:
   0 = Ora ana logging
   1 = Sumber obyek lan cara
   2 = Pesen kesalahan
   3 = Paramèter input
   4 = Wangsul
   5 = Warning
   8 = Titik mriksa

Konfigurasi otentikasi direktori virtual kanggo Web Layanan API
Sampeyan kudu ngaktifake akses anonim lan mateni otentikasi Windows Terpadu kanggo CPWebLayanan direktori virtual ing Internet Information Services (IIS). Kanggo informasi luwih lengkap, waca dokumentasi Microsoft IIS.
Konfigurasi setelan sambungan database kanggo Web Layanan API
Gunakake utilitas Setelan Login kanggo ndhelik setelan sambungan database ing Web Layanan API Web.config file. Kanggo informasi luwih lengkap, goleki "Konfigurasi Setelan Sambungan Database" ing Pandhuan Instalasi Changepoint.
Konfigurasi otentikasi kanggo Changepoint WCF Web Layanan
Sampeyan bisa ngatur Otentikasi Aplikasi lan mlebu siji (SSO) kanggo Changepoint WCF Web Layanan.
Opsi implementasi ing ngisor iki kasedhiya nggunakake Layanan Token Aman (STS):

• SSO nggunakake ISAPI SSL opsional
• SSO nggunakake WS-Federation (ADFS 2.0) SSL dibutuhake

Yen SSL dibutuhake, skrip konfigurasi mesthekake yen digunakake.
Skrip konfigurasi kanggo ISAPI lan otentikasi aplikasi bisa opsional ngaktifake SSL.
Konfigurasi otentikasi aplikasi kanggo WCF Web Layanan
Jinis otentikasi standar kanggo Changepoint WCF Web Layanan minangka otentikasi aplikasi.
Gunakake tata cara ing bagean iki kanggo:

• ngatur Changepoint WCF Web Layanan kanggo nggunakake otentikasi aplikasi nganggo SSL
• bali Changepoint WCF Web Layanan kanggo otentikasi aplikasi sawise Duwe dipun ginakaken siji saka implementasine SSO

Konfigurasi PowerShell

1. Bukak pituduh Windows PowerShell.
2. Ngowahi kabijakan eksekusi:
   Set-ExecutionPolicy Ora Watesan

Stage 1 Nglumpukake paramèter konfigurasi
Nemtokake nilai kanggo paramèter konfigurasi.

Paramèter	Katrangan
WebService_Path	Lokasi Changepoint WCF Web Layanan web aplikasi files. Default: \API\CP Web Layanan
Sertifikat Layanan_ jeneng	Jeneng sertifikat sing bakal digunakake kanggo otentikasi layanan menyang klien nggunakake mode keamanan Pesen. Default: Jeneng Sertifikat "CN=ChangepointAPICertificate".
mbutuhake HTTPS	Mbutuhake HTTPS (Bener/Salah) Default: Palsu.

Stage 2 Nglakokake skrip konfigurasi
Gunakake nilai kanggo paramèter konfigurasi kanggo ngowahi konfigurasi saka websitus.

1.  Bukak pituduh PowerShell.
   Cathetan: Yen server sampeyan ngaktifake Kontrol Akun pangguna, sampeyan kudu mbukak pituduh PowerShell nggunakake ijin administrator sing luwih dhuwur.
2. Navigasi menyang CP web direktori konfigurasi layanan, standar:
   KonfigurasiCPWebLayanan
3.  Eksekusi ./Configuration_AppAuth.ps1
4. Tindakake pituduh.

Konfigurasi single sign-on (SSO) kanggo WCF Web Layanan
Konfigurasi PowerShell

1. Bukak pituduh Windows PowerShell.
2. Ngowahi kabijakan eksekusi:
   Set-ExecutionPolicy Ora Watesan

Konfigurasi SSO nggunakake ISAPI kanggo WCF Web Layanan
Stage 1 Nglumpukake paramèter konfigurasi
Nemtokake nilai kanggo paramèter konfigurasi ing ngisor iki.

Paramèter	Katrangan
WebService_Path	Lokasi Changepoint WCF Web Layanan web aplikasi files. Default: \API\CP Web Layanan
mbutuhake HTTPS	Mbutuhake HTTPS (Bener/Salah). Default: Palsu.
Changepoint_RSA_ Cookie_Transform	Jeneng sertifikat sing sampeyan gunakake kanggo enkripsi Cookie. Default: Jeneng Sertifikat "CN=ChangepointAPICertificate".
ServiceCertificate_Name	Ketik jeneng sertifikat sing bakal digunakake kanggo otentikasi layanan menyang klien nggunakake mode keamanan Pesen. Default: Jeneng Sertifikat "CN=ChangepointAPICertificate".
SigningCertificate_Name	Ketik jeneng sertifikat teken. Iki jeneng sertifikat sing sampeyan gunakake kanggo mlebu pesen. Default: Jeneng Sertifikat "CN=ChangepointAPICertificate".
ISAPI_Mode	Mode ISAPI. Default: NT
ISAPI_Header	Header sing digunakake nalika ISAPI_Mode yaiku "HEADER", contoneample, kosong.
Tipe Klaim	Ketik Tipe Klaim SSO. Default: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Nglakokake skrip konfigurasi

1. Bukak pituduh PowerShell.
   Cathetan: Yen server sampeyan ngaktifake Kontrol Akun pangguna, sampeyan kudu mbukak pituduh PowerShell nggunakake ijin administrator sing luwih dhuwur.
2. Navigasi menyang CP web direktori konfigurasi layanan, standar:
   KonfigurasiCPWebLayanan
3. Eksekusi: ./Configuration_SSO_ISAPI.ps1
4. Tindakake pituduh.

Konfigurasi SSO nggunakake WS-Federation (ADFS 2.0) kanggo WCF Web Layanan
Stage 1 Nglumpukake paramèter konfigurasi
Nemtokake nilai kanggo paramèter konfigurasi ing tabel, ing ngisor iki. Priksa manawa ADFS_Server_URI ana ing zona Intranet browser pangguna pungkasan.
Cathetan: Kanthi gawan, Changepoint dikonfigurasi kanthi otomatis nganyari kunci umum sing digunakake kanggo mlebu token keamanan kanthi nggunakake dokumen metadata federasi sing diterbitake. Ing ADFS iki:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Ing sawetara kasus, bisa uga ora bisa tekan server ADFS saka Changepoint web server supaya sampeyan kudu nganyari konfigurasi kanthi manual sawise mbukak skrip konfigurasi. Kanggo rincian, deleng "Nganyarake tombol umum kanthi manual" ing kaca 12.

Paramèter	Katrangan
WebService_Path	Lokasi Changepoint WCF Web Layanan web aplikasi files. Default: \API\CP Web Layanan
WebService_URI	Pengenal domain sing sampeyan gunakake kanggo Changepoint WCF Web Layanan. Kanggo example., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Jeneng sertifikat sing sampeyan gunakake kanggo enkripsi Cookie. Default: Jeneng Sertifikat "CN=ChangepointApiCertificate".
ServiceCertificate_Name	Jeneng sertifikat sing bakal digunakake kanggo otentikasi layanan menyang klien nggunakake mode keamanan Pesen. Default: Jeneng Sertifikat "CN=ChangepointApiCertificate".
SigningCertificate_Name	Jeneng sertifikat sing sampeyan gunakake kanggo mlebu pesen. Default: Jeneng Sertifikat "CN=ChangepointApiCertificate" digunakake.
ADFS_ FederationServiceName	Jeneng Layanan Federasi. Kanggo entuk jeneng: Saka server ADFS, Bukak konsol Manajemen ADFS 2.0. • Pilih ADFS 2.0 saka menu kiwa. • Saka panel Tindakan pilih Edit Federation Service Properties. Jeneng Layanan Federasi ana ing tab Umum.
Tipe Klaim	Tipe Klaim SSO. Default yaiku: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Nglakokake skrip konfigurasi
Konfigurasi ing websitus nggunakake nilai kanggo paramèter konfigurasi.

1. Bukak pituduh PowerShell.
   Cathetan: Yen server sampeyan ngaktifake Kontrol Akun pangguna, sampeyan kudu mbukak pituduh PowerShell nggunakake ijin administrator sing luwih dhuwur.
2. Navigasi menyang Changepoint web direktori konfigurasi layanan, standar: KonfigurasiCPWebLayanan
3.  Eksekusi: ./Configuration_SSO_ADFS.ps1
4. Tindakake pituduh.

Stage 3 Nggawe kapercayan partai gumantung
Nggawe Trust Party Relying ing ADFS 2.0 Console.

1. Ing server ADFS sampeyan, bukak konsol ADFS 2.0.
2. Pilih Action > Add Relying Party Trust.
3. Klik Mulai.
4. Pilih Impor data babagan pihak sing dipercaya sing diterbitake online utawa ing jaringan lokal.
5. Ketik alamat metadata Federasi, banjur klik Sabanjure, contoneample:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Ketik jeneng Tampilan, contone Changepoint WCF API, banjur klik Sabanjure, Sabanjure, Sabanjure, banjur Tutup.
7. Tambah Aturan Klaim kanggo Partai Pengandel Changepoint ing ndhuwur. Kanggo Changepoint, jeneng aturan Klaim standar yaiku "UPN".
8. Peta Atribut LDAP "User-Principal-Name" menyang Outgoing Claim Type "* UPN" utawa "UPN".

Nganyari kunci umum kanthi manual
Kanggo entuk AdFS Server Token Signing Thumbprint

1. Saka server ADFS, Bukak ADFS 2.0 Manajemen console.
2. Pilih Layanan > Sertifikat, banjur klik kaping pindho sertifikat penandatanganan Token.
3. Pilih tab Details.
4. Pilih kolom Thumbprint.
5. Kanggo entuk nilai cap jempol, copot kabeh spasi kalebu spasi pisanan.

Kanggo nganyari Web.config file

1. Sunting ADFS web.config. Lokasi standar yaiku:
   EnterpriseRP-STS_ADFS
2. Ing ngisor unsur, golek ida:FederationMetadataLocation kunci lan mbusak nilai:
   
3. Ing , golek unsur lan ngganti karo ing ngisor iki: https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust” />

Nguji sambungan COM API

1. Jalanake Kit Tes API. Lokasi standar yaiku:
   Komponen APIAPIApiTestKit.exe.
2. Klik Connection String > Encrypter.
3. Ing kolom Plain Text Connections String:
   a. Ganti SERVERNAME lan DATABASENAME karo informasi basis data sampeyan.
   b. Ganti USERID lan PASSWORD karo informasi akun pangguna admin database.
   c. Ketik nilai wektu entek yen perlu.
4. Klik Encrypt.
5. Ing kolom Encrypted Connection String, nyalin teks kasebut.
6. Nutup kothak dialog.
7. Ing menu API Test Kit, klik Connection > COM API Connection Tester.
8. Ing tab Versi Saiki, tempel string sambungan sing dienkripsi menyang kolom Sambungan String.
9. Ing kolom LoginId lan Sandi, ketik ID login lan sandhi kanggo akun Changepoint sampeyan.
10. Ing lapangan Loglevel (0-8), nemtokake tingkat informasi kesalahan sing bakal bali ing log API COM file yen asil test nuduhake masalah karo sambungan.
    0 = Ora ana logging
    1 = Sumber obyek lan cara
    2 = Pesen kesalahan
    3 = Paramèter input
    4 = Wangsul
    5 = Warning
    8 = Titik mriksa
    Default 8.
11. Klik Sambungake.
    Yen sambungan kasebut sukses, pesen sukses ditampilake ing kolom Hasil. Yen sambungan gagal, mriksa COM API log file kanggo kasalahan. Lokasi gawan saka log file punika APIAPILlogs.

Priksa versi komponen API sing diinstal
Sampeyan bisa nggunakake sarana mriksa versi kanggo njupuk rincian babagan komponen sing diinstal, kalebu versi release lan path.

1. Jalanake CPVersionChecker.exe. Path standar yaiku: Komponen APIAPI
2. Klik Waca.

Priksa versi saka Web Layanan API

1. Bukak Internet Explorer saka server ngendi Web Layanan API wis diinstal, lan ketik alamat:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  ngendi port nomer port saka websitus ngendi sampeyan nginstal CPWebLayanan direktori virtual.
2. Ing kaca WSLogin, klik link GetVersion.
3. Klik Invoke.

Pengujian ing Web Layanan sambungan API

1. Bukak Internet Explorer saka server ngendi Web Layanan API wis diinstal, lan ketik alamat: http://localhost.port/CPWeb.Service/WSLogin.asmx  ngendi port nomer port saka websitus ngendi sampeyan nginstal CPWebLayanan direktori virtual.
2. Ing kaca WSLogin klik link TestConnection.
3. Klik Invoke. 4. Ing asil tes:

• Yen unsur palsu, sambungan test kasil.
• Yen unsur bener, sambungan test gagal. Kanggo luwih
  informasi ing alasan kanggo Gagal, ndeleng ing lan unsur ing asil test, lan mriksa log API. Path standar kanggo log API yaiku: APIAPILlogs

Nyetel ing Web Layanan API ing server basa

1. Kanggo masang Changepoint Web Layanan API ing server basa, sampeyan kudu nambah utawa nganyari tag ing Web Layanan API web.config. Lokasi gawan saka Web.config file yaiku: APICP Web LayananWeb.config
2. Yen ing tag wis ana, priksa manawa atribut budaya lan uiCulture minangka "en-US."
3. Yen ing tag durung ana, nambah ing ngisor iki , komentar, lan unsur menyangweb> simpul:web>
   Opsi Visual Basic: Setel strict = "bener" kanggo ora ngidini kabeh konversi jinis data sing bisa ilang data. Setel eksplisit = "true" kanggo meksa deklarasi kabeh variabel. –>
4. Wiwiti maneh IIS.

Dokumen / Sumber Daya

Piranti Lunak Changepoint API [pdf] Pandhuan Instalasi API, Software, API Software

Referensi

• Manual pangguna