Impostare l'agente di importazione file

L'agente di importazione file è un'applicazione di riga di comando che viene eseguita su qualsiasi computer e che funge da origine per l'importazione del contenuto da una posizione monitorata del file system, ad esempio una cartella o un'unità di rete. L'agente monitora e acquisisce il contenuto in tale posizione e lo invia al processore di importazione per un'ulteriore elaborazione e instradamento in base alle regole definite nella procedura.

L'installazione e l'esecuzione dell'agente di importazione file nel computer locale sono necessarie solo se l'origine è una cartella monitorata (e non un account di posta elettronica monitorato). La utility della riga di comando Capture è disponibile per facilitare la registrazione dei server, nonché la configurazione e l'elencazione dei job di importazione.

Scaricare e installare l'agente di importazione file

Per poter importare i file da una cartella monitorata, è necessario installare l'agente di importazione file nel computer locale.

Requisiti di sistema

L'agente di importazione file è un'applicazione Java per la quale deve essere disponibile il kit Oracle JDK versione 8u251 (o più recente) al momento dell'installazione. L'agente di importazione file è compatibili con gli ambienti Windows, Linux e Mac (vedere Configurazioni di sistema certificate Oracle JDK 8 e JRE 8).

Per scaricare e installare l'agente di importazione file, effettuare le operazioni riportate di seguito.
  1. Eseguire il login all'interfaccia Web di Oracle Content Management e fare clic su Acquisisci nel pannello di navigazione a sinistra (in Amministrazione). Se questa opzione non è visibile, vuol dire che non si dispone dei privilegi di accesso necessari.
  2. Nella pagina Procedure di Content Capture, in Download, fare clic su Agente di importazione file di Oracle Content Capture per scaricare il file capture-agent.zip nel computer locale.
  3. Estrarre il file ZIP.
  4. È necessario aggiungere <agent directory>\bin a PATH. L'argomento agent directory indica la cartella in cui è stato estratto il file capture-agent.zip scaricato. È inoltre possibile impostare la variabile di ambiente CAPTURE_HOME sulla directory di estrazione e aggiungere $CAPTURE_HOME\bin a PATH.
    In Mac:
    sudo ln -s <agent directory>/bin/capture /usr/local/bin/capture

    In Windows:

    eseguire il file SystemPropertiesAdvanced.exe, quindi modificare Variabili di ambiente e aggiungere il percorso <agent directory>\bin alla variabile PATH.

  5. Impostare la variabile CAPTURE_JAVA_HOME sulla posizione JDK valida come variabile di ambiente o nel file <agent directory>/conf/agent.properties.

Creare l'applicazione IDCS (Identity Cloud Service) Oracle per l'agente di importazione file

L'agente di importazione file interagisce con Oracle Content Management per recuperare le configurazioni dei job di importazione e caricare i file. Per queste operazioni l'agente richiama i Web Service RESTful. Le interfacce API sono protette mediante il protocollo OAuth, pertanto l'agente di importazione file richiede i token OAuth. L'applicazione IDCS consente all'agente di importazione file di generare i token richiesti.

Per creare un'applicazione IDCS, effettuare le operazioni riportate di seguito.
  1. Collegarsi al dashboard My Services.
  2. Fare clic su Identity Cloud.
  3. Copiare l'URL dell'istanza del servizio. Questo URL consentirà di accedere all'istanza di Oracle Content Management in uso. In altre parole, dovrà essere utilizzato per registrare il server dopo averlo installato.
  4. Nella console di Identity Cloud Service espandere il cassetto di navigazione, quindi fare clic su Applicazioni.
  5. Fare clic su Aggiungi.
  6. Nella pagina Aggiungi applicazione fare clic su Applicazione riservata.
  7. Nel riquadro Dettagli applicazione della finestra Aggiungi applicazione riservata immettere il nome dell'applicazione e fare clic su Successivo.
  8. Scegliere Configurare questa applicazione come client ora.
  9. In Autorizzazione selezionare Proprietario risorsa e Asserzione JWT.
  10. In Criterio di emissione token scegliere Tutte per Risorse autorizzate e fare clic su Successivo.
  11. Nella scheda Risorsa accettare i valori predefiniti e fare clic su Successivo.
  12. Nella scheda Criteri livello Web accettare i valori predefiniti e fare clic su Successivo.
  13. Nella scheda Autorizzazione fare clic sui valori predefiniti, quindi fare clic su Successivo.
  14. Fare clic su Fine.
    Copiare i valori ID client e Segreto client. Saranno necessari durante la registrazione del server con la utility della riga di comando Capture.
  15. Nella scheda Configurazione espandere Configurazione client.
  16. Scorrere verso il basso fino alla sezione Criterio di emissione token e fare clic su Aggiungi ambito.
  17. Nella finestra di dialogo Seleziona ambito individuare l'istanza di Oracle Content Management e fare clic su >.
  18. Selezionare l'ambito a cui è associato l'URL con /urn:opc:..., quindi fare clic su Aggiungi.
  19. Copiare l'URL dell'ambito. Sarà necessario durante la registrazione del server con la utility della riga di comando Capture.
  20. Fare clic su Salva, quindi su Attiva.

L'applicazione IDCS è stata creata. Ora è possibile procedere alla registrazione del server con la utility della riga di comando Capture.

Registrare Oracle Content Management con l'agente di importazione file

L'istanza di Oracle Content Management da utilizzare deve essere registrata con la utility della riga di comando Capture in modo che la utility acquisisca le informazioni inerenti ai job di importazione configurati nell'istanza di Oracle Content Management e possa caricare i file.

Per registrare Oracle Content Management, effettuare le operazioni riportate di seguito.
  1. Scaricare e installare l'agente di importazione file se non è già stato installato nel computer in uso.
  2. Eseguire il comando seguente nel sistema Windows, Linux o Mac:
    $ capture register-server <NAME> --endpoint https://<oracle content management instance name>.oraclecloud.com -u username -p 'password' --idcsurl https://<server name>.identity.oraclecloud.com/oauth2/v1/token --clientid sampleid --clientsecret sample-secret --scope https://<server name>:<port number>/urn:opc:cec:all
    
    • URL istanza di Oracle Content Management: <oracle content management instance name>.oraclecloud.com

    • Nome utente e password per l'URL dell'istanza di Oracle Content Management.

      Nota:

      Per limitare i potenziali rischi per la sicurezza, si consiglia di creare un utente specifico per l'agente di importazione file al quale assegnare solo i ruoli o le autorizzazioni di Content Capture per le procedure obbligatorie.
    • URL dell'istanza Identity Service: https://<nome server>.identity.oraclecloud.com/oauth2/v1/token (valore copiato durante la creazione dell'applicazione IDCS).

    • ID client: sampleid (valore copiato durante la creazione dell'applicazione IDCS).

    • Segreto client: sample-secret (valore copiato durante la creazione dell'applicazione IDCS).

    • URL ambito: https://<nome server>:<numero porta>/urn:opc:cec:all (valore copiato durante la creazione dell'applicazione IDCS).

  3. Eseguire il test della connessione eseguendo il comando per elencare i job di importazione:
    $ capture list-import-jobs
    

    Verrà visualizzata la lista di tutti i job di configurazione da cartella e file lista configurati nelle procedure di acquisizione del contenuto nell'istanza di Oracle Content Management specificata.

Dopo aver registrato Oracle Content Management e configurato i job di importazione, configurare l'importazione dei file da una cartella o configurare l'importazione da file lista.

Usare la utility della riga di comando Capture

La utility della riga di comando capture consente di configurare l'agente di importazione file in modo che possa importare i documenti nel repository di Oracle Content Management. Fornisce inoltre i comandi per l'utilizzo e la gestione dell'agente di importazione file.

------------------------
capture
------------------------
usage : capture <command> [options]
Run capture <command> -h' to get the detailed help for the command.
Commands:  
capture create-encryption-key <file>     Create an encryption key to encrypt/decrypt password for servers.                       [alias:   cek]  
capture register-server <name>           Registers a CEC server                                                                  [alias:   rs]  
capture list-servers                     Lists registered servers                                                                [alias:   ls]  
capture list-import-jobs                 Lists all Import Jobs from server                                                       [alias:  lij]  
capture configure-import-job             Configures import job. Set Import Folder path. Enable or disable.                       [alias:  cij] 
capture trigger-import-job               Forces import job processing.                                                           [alias:  tij]
capture refresh-config                   Refresh configuration from server.                                                      [alias:   rc]
capture list-procedures                  Displays capture procedures.                                                            [alias:   lp]  
capture register-database <name>         Registers external database.                                                            [alias:   rd]  
capture deregister-database              Deregister previously registered database.                                              [alias:   dd]  
capture list-databases                   Displays registered databases and tables.                                               [alias:   ld]  
capture register-table                   Registers tables in a database.                                                         [alias:   rt]  
capture deregister-table                 Deregister previously registered table.                                                 [alias:   dt]
capture list-table-sync-jobs             Lists all Asset Sync Jobs from server.                                                  [alias: ltsj]
capture trigger-table-sync               Force table / asset synchronization.                                                    [alias:  tts]
capture start                            Starts import agent                                                                     [alias:    s]  
capture stop                             Stops import agent                                                                      [alias:    x]  
capture status                           Shows import agent status                                                               [alias:   st]  
capture help                             Shows this message                                                                      [alias:    h]

-----------------------------
capture create-encryption-key
-----------------------------
usage: create-encryption-key <file> [-h]
Create an encryption key to encrypt/decrypt password for servers and save to <file>.
Options: 
-h,--help   Show help
Example:  
capture create-encryption-key ~/.ceckey                      Create encryption key and save to file ~/.ceckey
------------------------
capture register-server
------------------------
usage: capture register-server <name> -e <endpoint> -u <user> -p <password> [-k <key>] [-i <idcsurl>] [-c <clientid>] [-s <clientsecret>] [-o <scope>] [-m <timeout>] [-h]
Registers a CEC server. Specify -e <endpoint> for the server URL. Specify -u <user> and -p <password> for connecting to the server. Optionally specify -k <key> to encrypt the password.
Optionally specify <idcsurl>, <clientid>, <clientsecret> and <scope> for integration with IDCS app.
Options: 
-e,--endpoint <endpoint>           Server endpoint 
-u,--user <user>                   User name 
-p,--password <password>           Password 
-k,--key <key>                     The key file used to encrypt the password 
-i,--idcsurl <idcsurl>             Oracle Identity Cloud Service Instance URL 
-c,--clientid <clientid>           Client ID 
-s,--clientsecret <clientsecret>   Client secret 
-o,--scope <scope>                 Scope -m,--timeout <timeout>             Timeout in millisecond when try to login to the server. Defaults to 30000ms 
-h,--help                          Show help
Examples:  
capture register-server server1 -e http://server1.com -u user1 -p password1 -i                         The server is a tenant on Oracle Public cloud  
http://idcs1.com -c clientid -s clientsecret -o https://primary-audience-and-scope  
capture register-server server1 -e http://server1.com -u user1 -p password1                            The server is a tenant on Oracle Public cloud  
capture register-server server1 -e http://server1.com -u user1 -p password1 -m 60000                   The timeout is set to 60 seconds  
capture register-server server1 -e http://server1.com -u user1 -p password1 -k ~/.mykey                The password will be encrypted
------------------------
capture list-servers
------------------------
usage: capture list-servers [-u <user>] [-f <pattern>] [-h]
Lists registered CEC servers. Optionally specify -u <user> and -f <pattern> to filter results based on user or server name.
Options: -u,--user <user>         User name 
-f,--pattern <pattern>   String to search in server name 
-h,--help                Show help
Examples:  
capture list-servers                                         Lists all registered servers  
capture list-servers -u user1                                Lists all registered servers linked to user 'user1'  
capture list-servers -f demo                                 Lists all registered servers whose name contains 'demo'
------------------------
capture list-import-jobs
------------------------
usage: capture list-import-jobs [-f] [-l] [-h]
Lists all Import Jobs from server. Optionally specify -f and -l to show only folder or list file import jobs.
Options: 
-f,--folder     Display only folder import jobs 
-l,--listfile   Display only list file import jobs 
-h,--help       Show help
Examples:  
capture list-import-jobs                                         Lists all import jobs  
capture list-import-jobs -f                                      Lists all folder import jobs  
capture list-import-jobs -l                                      Lists all list file import jobs
-----------------------------
capture configure-import-job
-----------------------------
usage: capture configure-import-job -s <server> [-i <import>] [-p <path>] [-e] [-E] [-d] [-D] [-h]
Configures the import job.  Specify -s <server> -i <importjobid> to select the server and import job. Optionally specify -p <path> to set the import folder path. 
Optionally specify -d to disable import job and -e to enable import job
Options: 
-s,--server <server>   Set server name associated with import job 
-i,--import <import>   Set Import Job Id 
-p,--path <path>       Set Local Import Folder Path 
-e,--enable            Enables specific import job 
-E,--enable-all        Enables all import jobs 
-d,--disable           Disables specific import job 
-D,--disable-all       Disables all import job 
-h,--help              Show help
Examples:  
capture configure-import-job -s prod -i import_id -p /Users/user1/data/      Sets the import directory  
capture configure-import-job -s prod -i import_id -e                         Enables a specific import job  
capture configure-import-job -s prod -D                                      Disables all import jobs  
capture configure-import-job -s prod -i import_id -d                         Disables a specific import job
------------------------
capture trigger-import-job
------------------------
usage: capture trigger-import-job -s <server> -i <import> [-h] 
Forces import job processing.  
Options: 
-s,--server <server>   Set server name associated with import job 
-i,--import <import>   Set Import Job Id 
-h,--help              Show help 
Examples:  capture trigger-import-job --server production --import xx-job-id-xx           Forces processing of specified import job
------------------------
capture refresh-config
------------------------
usage: capture refresh-config [-s <server>] [-h] Refresh configuration from server. 
Optionally specify -s to only refresh config for selected server. 
Options: 
-s,--server <server>   Specify the server 
-h,--help              Show help 
Examples:  
capture refresh-config                       Force refresh configuration for all servers  
capture refresh-config -s production         Force refresh configuration from specified server                        
------------------------
capture list-procedures
------------------------
usage: capture list-procedures -s <server> [-h] 
Lists capture procedures. Must specify -s <server> to select a server. 
Options: 
-s,--server <server>   Specify the server 
-h,--help              Show help 
Examples:  capture list-procedures -s ocetest                           Lists all capture procedures available for current user
------------------------
capture register-database
------------------------
usage: capture register-database <name> -s <server> -w <procedure> -c <connection> -u <user> -p <password> [-a] [-h] 
Registers on-prem database with Capture. Specify -c <connection> for the connection URL, -u <user> and -p <password> for connecting to the server. 
Options: 
-s,--server <server>           Specify the server 
-w,--procedure <procedure>     Set procedure to be associated with database 
-c,--connection <connection>   Database connection url 
-u,--user <user>               Database User name 
-p,--password <password>       Database Password 
-a,--attach                    Attach existing database 
-h,--help                      Show help 
Examples:  
capture register-database ebsdb -s server1 -w 1 -c jdbc:oracle:thin:@//host:port/service -u user1 -p pass         Register ebsdb with server1
------------------------
capture deregister-database
------------------------
usage: capture deregister-database  -s <server> -w <procedure> -d <database> [-e] [-h] 
Deregister previously registered database. Specify -s <server>, -w <procedure> and -d <database> to select the database. 
Options: 
-s,--server <server>         Specify the server 
-w,--procedure <procedure>   Procedure associated with database 
-d,--database <database>     Database to deregister 
-e,--detach                  Only detach 
-h,--help                    Show help 
Examples:  
capture deregister-database -s server1 -w 1 -d ebsdb                   Deregister VENDORS table from ebsdb database  
capture deregister-database -s server1 -w 1 -d ebsdb --detach          Detaches ebsdb database without deregistering it
------------------------
capture list-databases
------------------------
usage: capture list-databases -s <server> [-h] Lists registered databases and tables. Must specify -s <server> to select a server. 
Options: 
-s,--server <server>   Specify the server 
-h,--help              Show help 
Examples:  
capture list-databases -s ocetest     Lists all registered databased linked to server 'ocetest'  
------------------------
capture register-table
------------------------
usage: capture register-table -s <server> -w <procedure> -d <database> -t <table> [-m <schema>] [-h]
Registers table with Capture. Specify -s <server>, -w <procedure> and -d <database> to select the database. 
Options: 
-s,--server <server>         Specify the server 
-w,--procedure <procedure>   Specify the procedure 
-d,--database <database>     Specify the database 
-t,--table <table>           Table to sync 
-m,--schema <schema>         Override schema qualifier 
-h,--help                    Show help 
Examples:  
capture register-table -s server1 -w 1 -d ebsdb -t VENDORS                  Register VENDORS table from ebsdb database  
capture register-table -s server1 -w 1 -d ebsdb -t VENDORS -m SVR           Register VENDORS table from ebsdb database in SVR schema
------------------------
capture deregister-table
------------------------
usage: capture deregister-table -s <server> -w <procedure> -d <database> -t <table> [-m <schema>] [-h] 
Deregister table. Specify table details. 
Options: 
-s,--server <server>         Specify the server 
-w,--procedure <procedure>   Procedure associated with database 
-d,--database <database>     Specify the database 
-t,--table <table>           Table to sync 
-m,--schema <schema>         Override schema qualifier 
-h,--help                    Show help 
Examples:  capture deregister-table -s server1 -w 1 -d ebsdb -t VENDORS                      Deregister VENDORS table from ebsdb database      
------------------------
capture list-table-sync-jobs
------------------------
usage: capture list-table-sync-jobs [-r] [-h] Lists all Asset Sync Jobs from server. 
Options: 
-r,--refresh   Force refresh asset sync jobs from server 
-h,--help      Show help 
Examples:  
capture list-table-sync-jobs                                         Lists all asset sync jobs  
capture list-table-sync-jobs -r                                      Refresh asset sync jobs from server and list them
------------------------
capture trigger-table-sync
------------------------
usage: capture trigger-table-sync -s <server> -a <asset> [-h] 
Force table / asset synchronization.  
Options: 
-s,--server <server>   Set server name associated with table sync job 
-a,--asset <asset>     Set Asset Sync Job Id 
-h,--help              Show help 
Examples:  
capture trigger-table-sync -s production -i xx-123-sync-id-xx      Forces processing of asset synchronization job
------------------------
capture start
------------------------
usage: capture start [-h]
Starts capture agent. 
Options: 
-h,--help   Show help
Examples:  
capture start                                                Starts capture agent if not running
------------------------
capture stop
------------------------
usage: capture stop [-h]
Stops capture agent. 
Options: 
-h,--help   Show help
Examples:  
capture stop                                                 Stops capture agent if currently running
------------------------
capture status
------------------------
usage: capture status [-s <server>] [-i <import>] [-u <user>] [-m <machine>] [-l <limit>] [-d <duration>] [-c | -p]  [-h] 
Display capture agent status and activity.  
Options: 
-s,--server <server>       Set Server name 
-i,--import <import>       Set Import Job name 
-u,--user <user>           Set user name. Defaults to current user 
-m,--machine <machine>     Set host name. Defaults to current hostname 
-l,--limit <limit>         Set number of results to return. Defaults to 200 
-d,--duration <duration>   Set duration period in hours 
-c,--completed             Display only completed uploads 
-p,--pending               Display only pending uploads 
-h,--help                  Show help 
Examples:  
capture status                             Display capture agent status  
capture status -u user@example.com         Show upload activity for user : user@example.com  
capture status -i Invoices                 Show upload activity for Invoices import job  
capture status -m myhost.example.com       Show upload activity for a specific host / machine  
capture status -p                          Show uploads pending completion  
capture status -c                          Show completed uploads
------------------------
capture version
------------------------
usage: capture version [-h] 
Displays capture version details. 
Options: 
-h,--help    Show help 
Example:  
capture  version                  Display Capture Agent version