Guida all'installazione del software API di Changepoint

Guida all'installazione dell'API
Guida di riferimento
Punto di cambio 2021

© 2021 Changepoint Canada ULC Tutti i diritti riservati. DIRITTI DEL GOVERNO DEGLI STATI UNITI-L'uso, la duplicazione o la divulgazione da parte del governo degli Stati Uniti è soggetto alle restrizioni stabilite nel contratto di licenza ULC di Changepoint Canada e come previsto in DFARS 227.7202-1(a) e 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OTTOBRE 1988), FAR 12.212(a) (1995), FAR 52.227-19 o FAR 52.227-14 (ALT III), a seconda dei casi. Questo prodotto contiene informazioni riservate e segreti commerciali di Changepoint Canada ULC. La divulgazione è vietata senza il previo consenso scritto di Changepoint Canada ULC. L'uso di questo prodotto è soggetto ai termini e alle condizioni del contratto di licenza dell'utente con Changepoint Canada ULC. La documentazione può essere riprodotta dal Licenziatario solo per uso interno. Il contenuto di questo documento non può essere alterato, modificato o cambiato senza l'espresso consenso scritto di Changepoint Canada ULC. Changepoint Canada ULC può modificare il contenuto qui specificato in qualsiasi momento, con o senza preavviso.

Contenuto nascondere

1 Installazione dell'API Changepoint

2 Verifica della connessione dell'API COM

3 Testare il Web Connessione API Servizi

4 Documenti / Risorse

4.1 Riferimenti

5 Post correlati

Installazione dell'API Changepoint

Informazioni sull'installazione dell'API Changepoint
L'API Changepoint è disponibile come API COM, un servizio Windows Communication Foundation (WCF) e, per compatibilità con le versioni precedenti, come Web Servizio di miglioramento dei servizi (WSE). Per informazioni sull'API di Changepoint, vedere il Riferimento API di Changepoint. Per note di aggiornamento, avvertenze e problemi noti, vedere le note di rilascio nelle cartelle del team in Changepoint.
Aggiornamento dell'API di Changepoint
Se si esegue l'aggiornamento da una versione precedente di Changepoint, utilizzare il Pannello di controllo di Windows per disinstallare la versione precedente dell'API di Changepoint e dei suoi componenti prima di installare questa versione.
Requisiti dell'API di Changepoint
È necessario installare Changepoint prima di installare l'API di Changepoint. Per i requisiti software, vedere la matrice di compatibilità del software di Changepoint, disponibile nella cartella del team Note di rilascio e patch 2021 in Changepoint.
File convenzioni di percorso
In questo documento vengono utilizzate le seguenti convenzioni per i percorsi comuni:

Il percorso principale dell'installazione di Changepoint.
Il percorso predefinito è:
C:Program Files (x86) Punto di cambio Punto di cambio

Il percorso principale per le utilità di Changepoint comuni, come l'utilità Impostazioni di accesso.
Il percorso predefinito è:
C:Program Files (x86)Comune FilesPunto di cambiamentoPunto di cambiamento

Installazione dell'API Changepoint

Dalla directory principale del supporto dell'API di Changepoint, eseguire setup.exe.
Segui le istruzioni finché non viene visualizzata la schermata Seleziona funzionalità.

Seleziona le funzionalità che desideri installare, quindi fai clic su Avanti.
Seleziona la cartella di destinazione dell'API, predefinita API e fare clic su Avanti.
Nota: L'utilità Impostazioni di accesso di Changepoint è installata in LoginSettings, indipendentemente dalla cartella di destinazione specificata.

Se hai selezionato il file Web API dei servizi: a. Quando il Seleziona
a Web Viene visualizzata la schermata del sito, selezionare a websito a cui aggiungere la directory virtuale, quindi fare clic su Avanti.
b. Fare clic su Avanti per continuare. 6. Al termine dell'installazione dell'API, fare clic su Fine.

Configurazione dell'API di Changepoint in modo che sia consapevole della cache
Per configurare l'API di Changepoint in modo che sia in grado di riconoscere la cache, sostituire i valori per "cache. Password” e “cache. Server” nel CP Web ServiziWeb.configurazione file con i valori utilizzati nell'EnterpriseWeb.configurazione file.
Abilitazione Web Miglioramenti dei servizi (WSE)

Modifica il Web.configurazione file per web Servizi. La posizione predefinita è:
APICP Web ServiziWeb.configurazione
Trova le tre istanze della seguente riga di commento:
< !– Decommenta il seguente elemento se stai usando Web API dei miglioramenti del servizio (WSE). Lascia commenti se utilizzi i servizi WCF e non stai installando Web Miglioramenti del servizio (WSE) –>

Decommenta l'elemento che segue ogni istanza della riga di commento:
<section name=”microsoft.web.servizi2″ … >webServizi>web.servizi2>
Nota: ILwebServizi> l'elemento da non commentare è figlio diweb>.

Configurazione della registrazione per il Web API dei servizi
Devi impostare il registro file livelli di percorso e log. I livelli di registro sono cumulativi. Per esample, se si specifica il livello 3, vengono registrati i livelli 1, 2 e 3. Il livello di registro predefinito è 8.

Modifica il web servizi Web.config. La posizione predefinita è:
APICP Web ServiziWeb.configurazione
Imposta il registroFileSentiero. Il valore predefinito è Registri APIAPI. 3. Impostare il livello di registro. I valori validi sono:
0 = Nessuna registrazione
1 = Oggetto e metodo di origine
2 = Messaggio di errore
3 = Input parametri
4 = Resi
5 = Attenzione
8 = Punto di controllo

Configurazione dell'autenticazione della directory virtuale per il Web API dei servizi
È necessario abilitare l'accesso anonimo e disattivare l'autenticazione integrata di Windows per il CPWebDirectory virtuale del servizio in Internet Information Services (IIS). Per ulteriori informazioni, vedere la documentazione di Microsoft IIS.
Configurazione delle impostazioni di connessione al database per Web API dei servizi
Utilizzare l'utilità Impostazioni di accesso per crittografare le impostazioni di connessione al database in Web API dei servizi Web.configurazione file. Per ulteriori informazioni, cercare "Configurazione delle impostazioni di connessione al database" nella Guida all'installazione di Changepoint.
Configurazione dell'autenticazione per Changepoint WCF Web Servizi
È possibile configurare l'autenticazione dell'applicazione e il Single Sign-On (SSO) per Changepoint WCF Web Servizi.
Le seguenti opzioni di implementazione sono disponibili utilizzando Secure Token Service (STS):

SSO utilizzando ISAPI SSL facoltativo

SSO che utilizza WS-Federation (ADFS 2.0) SSL richiesto

Se è richiesto SSL, lo script di configurazione garantisce che venga utilizzato.
Gli script di configurazione per ISAPI e l'autenticazione dell'applicazione possono abilitare facoltativamente SSL.
Configurazione dell'autenticazione dell'applicazione per WCF Web Servizi
Il tipo di autenticazione predefinito per Changepoint WCF Web Servizi è l'autenticazione dell'applicazione.
Utilizzare le procedure in questa sezione per:

configurare Changepoint WCF Web Servizi per utilizzare l'autenticazione dell'applicazione con SSL
ripristinare il punto di cambio WCF Web Servizi all'autenticazione dell'applicazione dopo aver implementato una delle implementazioni SSO

Configura PowerShell

Aprire un prompt di Windows PowerShell.

Modifica la politica di esecuzione:
Set-ExecutionPolicy senza restrizioni

Stage 1 Raccogliere i parametri di configurazione
Determinare i valori per i parametri di configurazione.

Parametro	Descrizione
WebServizio_Percorso	Posizione del punto di cambio WCF Web Servizi web applicazione files. Predefinito: \API\CP Web Servizi
Certificato di servizio_ Nome	Nome del certificato che verrà utilizzato per autenticare il servizio per i client utilizzando la modalità di protezione dei messaggi. Predefinito: il nome del certificato “CN=ChangepointAPICertificate”.
richiedono HTTPS	Richiedi HTTPS (vero/falso) Predefinito: falso.

Stage 2 Eseguire gli script di configurazione
Utilizzare i valori per i parametri di configurazione per modificare la configurazione di websiti.

Aprire un prompt di PowerShell.
Nota: Se il tuo server ha abilitato il controllo dell'account utente, devi aprire il prompt di PowerShell usando autorizzazioni di amministratore elevate.

Passare al CP web directory di configurazione del servizio, impostazione predefinita:
ConfigurazioneCPWebServizio
Esegui ./Configuration_AppAuth.ps1
Segui le istruzioni.

Configurazione del Single Sign-On (SSO) per WCF Web Servizi
Configura PowerShell

Aprire un prompt di Windows PowerShell.
Modifica la politica di esecuzione:
Set-ExecutionPolicy senza restrizioni

Configurazione di SSO tramite ISAPI per WCF Web Servizi
Stage 1 Raccogliere i parametri di configurazione
Determinare i valori per i seguenti parametri di configurazione.

Parametro	Descrizione
WebServizio_Percorso	La posizione del Changepoint WCF Web Servizi web applicazione files. Predefinito: \API\CP Web Servizi
richiedono HTTPS	Richiedi HTTPS (vero/falso). Predefinito: falso.
Punto di cambio_RSA_ Cookie_Trasforma	Il nome del certificato che utilizzi per la crittografia dei cookie. Predefinito: il nome del certificato “CN=ChangepointAPICertificate”.
Nome_CertificatoServizio	Immettere il nome del certificato che verrà utilizzato per autenticare il servizio per i client utilizzando la modalità di protezione dei messaggi. Predefinito: il nome del certificato “CN=ChangepointAPICertificate”.
FirmaCertificate_Name	Immettere il nome del certificato di firma. Questo è il nome del certificato utilizzato per la firma dei messaggi. Predefinito: il nome del certificato “CN=ChangepointAPICertificate”.
Modalità_ISAPI	La modalità ISAPI. Predefinito: NT
ISAPI_Intestazione	L'intestazione utilizzata quando ISAPI_Mode è "HEADER", ad esample, vuoto.
Tipo di reclamo	Immettere il tipo di attestazione SSO. Predefinito: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Eseguire gli script di configurazione

Aprire un prompt di PowerShell.
Nota: Se il tuo server ha abilitato il controllo dell'account utente, devi aprire il prompt di PowerShell usando autorizzazioni di amministratore elevate.
Passare al CP web directory di configurazione del servizio, impostazione predefinita:
ConfigurazioneCPWebServizio
Eseguire: ./Configuration_SSO_ISAPI.ps1
Segui le istruzioni.

Configurazione dell'accesso SSO tramite WS-Federation (ADFS 2.0) per WCF Web Servizi
Stage 1 Raccogliere i parametri di configurazione
Determinare i valori per i parametri di configurazione nella tabella seguente. Assicurarsi che ADFS_Server_URI si trovi nell'area Intranet del browser dell'utente finale.
Nota: Per impostazione predefinita, Changepoint è configurato per aggiornare automaticamente le chiavi pubbliche utilizzate per firmare i token di sicurezza utilizzando il documento di metadati della federazione pubblicato. In ADFS questo è:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
In alcuni casi potrebbe non essere possibile raggiungere il server ADFS dal punto di cambio web server, quindi dovrai aggiornare manualmente la configurazione dopo aver eseguito lo script di configurazione. Per i dettagli, vedere “Aggiornamento manuale delle chiavi pubbliche” a pagina 12.

Parametro	Descrizione
WebServizio_Percorso	Posizione del punto di cambio WCF Web Servizi web applicazione fileS. Predefinito: \API\CP Web Servizi
WebServizio_URI	Identificatore di dominio utilizzato per Changepoint WCF Web Servizi. Per esampcioè, https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_Cookie_Transform	Nome del certificato che utilizzi per la crittografia dei cookie. Predefinito: il nome del certificato "CN=ChangepointApiCertificate".
Nome_CertificatoServizio	Nome del certificato che verrà utilizzato per autenticare il servizio per i client utilizzando la modalità di protezione dei messaggi. Predefinito: il nome del certificato "CN=ChangepointApiCertificate".
FirmaCertificate_Name	Nome del certificato utilizzato per la firma dei messaggi. Predefinito: viene utilizzato il nome del certificato "CN=ChangepointApiCertificate".
ADFS_ NomeServizioFederazione	Nome del servizio federativo. Per ottenere il nome: dal server ADFS, avviare la console di gestione di ADFS 2.0. •Selezionare ADFS 2.0 dal menu a sinistra. •Dal riquadro Azioni selezionare Modifica proprietà servizio federativo. Il nome del servizio federativo si trova nella scheda Generale.
Tipo di reclamo	Tipo di attestazione SSO. L'impostazione predefinita è: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Eseguire gli script di configurazione
Configurare il websiti utilizzando i valori per i parametri di configurazione.

Aprire un prompt di PowerShell.
Nota: Se il tuo server ha abilitato il controllo dell'account utente, devi aprire il prompt di PowerShell usando autorizzazioni di amministratore elevate.
Vai al punto di cambio web directory di configurazione del servizio, impostazione predefinita: ConfigurazioneCPWebServizio
Eseguire: ./Configuration_SSO_ADFS.ps1

Segui le istruzioni.

Stage 3 Creare la fiducia del relying party
Creare il Trusting Party nella console ADFS 2.0.

Sul tuo server ADFS, avvia la console ADFS 2.0.

Selezionare Azione > Aggiungi Trusting Party.
Fare clic su Avvia.
Selezionare Importa dati sulla relying party pubblicati online o su una rete locale.

Immettere l'indirizzo dei metadati della federazione, quindi fare clic su Avanti, ad esampon:
https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
Immettere un nome visualizzato, ad es. API Changepoint WCF, e fare clic su Avanti, Avanti, Avanti, quindi Chiudi.
Aggiungere una regola di reclamo per la parte che fa affidamento su Changepoint sopra. Per Changepoint, il nome della regola attestazione predefinito è "UPN".

Mappare l'attributo LDAP "User-Principal-Name" al tipo di attestazione in uscita "* UPN" o "UPN".

Aggiornamento manuale delle chiavi pubbliche
Per ottenere l'identificazione personale per la firma del token del server ADFS

Dal server ADFS, avviare la console di gestione di ADFS 2.0.

Seleziona Servizio > Certificati e fai doppio clic sul certificato di firma del token.
Selezionare la scheda Dettagli.
Seleziona il campo Identificazione personale.

Per ottenere il valore dell'identificazione personale, rimuovere tutti gli spazi incluso il primo spazio.

Per aggiornare il Web.configurazione file

Modifica l'ADFS web.config. La posizione predefinita è:
EnterpriseRP-STS_ADFS

Sotto il elemento, trova la chiave ida:FederationMetadataLocation e cancella il suo valore:
Sotto , trovare la elemento e sostituirlo con il seguente: https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust” />

Verifica della connessione dell'API COM

Esegui il kit di test API. La posizione predefinita è:
Componenti APIAPIApiTestKit.exe.

Fare clic su Stringa di connessione > Crittografia.
Nel campo Stringa di connessioni in testo normale:
un. Sostituisci SERVERNAME e DATABASENAME con le informazioni del tuo database.
b. Sostituisci USERID e PASSWORD con le informazioni sull'account utente dell'amministratore del database.
c. Immettere il valore di timeout secondo necessità.
Fare clic su Crittografa.

Nel campo Stringa di connessione crittografata, copiare il testo.
Chiudere la finestra di dialogo.
Nel menu API Test Kit, fare clic su Connessione > Test di connessione API COM.

Nella scheda Versione corrente, incolla la stringa di connessione crittografata nel campo Stringa di connessione.
Nei campi LoginId e Password, inserisci l'ID di accesso e la password per il tuo account Changepoint.
Nel campo Loglevel (0-8), specificare il livello di informazioni sull'errore da restituire nel registro dell'API COM file se il risultato del test mostra un problema con la connessione.
0 = Nessuna registrazione
1 = Oggetto e metodo di origine
2 = Messaggio di errore
3 = Input parametri
4 = Resi
5 = Attenzione
8 = Punto di controllo
L'impostazione predefinita è 8.

Fare clic su Connetti.
Se la connessione è riuscita, nel campo Risultato viene visualizzato un messaggio di successo. Se la connessione non riesce, controllare il registro dell'API COM file per errori. La posizione predefinita del registro file è Registri APIAPI.

Verifica della versione dei componenti API installati
È possibile utilizzare l'utilità di verifica della versione per ottenere dettagli sui componenti installati, inclusi la versione di rilascio e il percorso.

Esegui CPVersionChecker.exe. Il percorso predefinito è: Componenti APIAPI

Fare clic su Leggi.

Controllo della versione del Web API dei servizi

Avvia Internet Explorer dal server in cui il file Web L'API dei servizi è installata e inserisci l'indirizzo:
http://localhost.port/CPWeb.Service/WSLogin.asmx dove port è il numero di porta del websito in cui hai installato il CPWebDirectory virtuale del servizio.

Nella pagina WSLogin, fare clic sul collegamento GetVersion.
Fare clic su Richiama.

Testare il Web Connessione API Servizi

Avvia Internet Explorer dal server in cui il file Web L'API dei servizi è installata e inserisci l'indirizzo: http://localhost.port/CPWeb.Service/WSLogin.asmx dove port è il numero di porta del websito in cui hai installato il CPWebDirectory virtuale del servizio.

Nella pagina WSLogin fare clic sul collegamento TestConnection.
Fare clic su Richiama. 4. Nei risultati del test:

Se l'elemento è false, la connessione di prova è riuscita.

Se l'elemento è vero, la connessione di prova non è riuscita. Per più
informazioni sui motivi del fallimento, vedere il e elementi nei risultati del test e controllare i log dell'API. Il percorso predefinito per i registri API è: Registri APIAPI

Impostazione del Web API dei servizi su un server di lingua

Per distribuire il punto di cambiamento Web API dei servizi su un server di lingua, è necessario aggiungere o aggiornare il tag nel Web API dei servizi web.config. La posizione predefinita di Web.configurazione file è: APICP Web ServiziWeb.configurazione

Se la tag esiste già, assicurati che gli attributi culture e uiCulture siano "en-US".
Se la tag non esiste già, aggiungere quanto segue , commento e elementi alweb> nodo:web>
Opzioni di Visual Basic: imposta strict=" true" per impedire tutte le conversioni di tipi di dati in cui può verificarsi la perdita di dati. Impostare esplicito="true" per forzare la dichiarazione di tutte le variabili. –>
Riavvia IIS.