Sett opp filimportagenten

Filimportagenten er en kommandolinjeapplikasjon som kjører på en hvilken som helst datamaskin, og som fungerer som kilde for import av innhold fra en overvåket filsystemplassering, for eksempel en mappe eller en nettverksstasjon. Den overvåker og registrerer innholdet på denne plasseringen og sender det til importbehandleren for videre behandling og distribusjon i henhold til reglene som er definert i prosedyren.

Du trenger bare å installere og kjøre filimportagenten på den lokale datamaskinen dersom kilden er en overvåket mappe (ikke en overvåket e-postkonto). Kommandolinjeverktøyet for Capture kan hjelpe deg med å registrere tjenere, konfigurere importjobber og føre dem opp.

Last ned og installer filimportagenten

Før du kan importere filer fra en overvåket mappe, må du installere filimportagenten på den lokale datamaskinen.

Systemkrav

Filimportagenten er en Java-applikasjon som trenger versjon 8u251 av Oracle JDK, eller den nyeste versjonen som er tilgjengelig på det tidspunktet du skal installere denne applikasjonen. Filimportagenten er kompatibel med Windows, Linux og Mac (se Sertifiserte systemkonfigurasjoner for Oracle JDK 8 og JRE 8).

Slik laster du ned og installerer du filimportagenten:
  1. Logg på Web-grensesnittet for Oracle Content Management, og klikk på Registrer i navigeringsruten til venstre (under Administrasjon). Hvis du ikke ser dette valget, har du ikke de nødvendige tilgangsprivilegiene.
  2. Klikk på Filimportagent for Oracle Content Capture under Nedlastinger på siden for Content Capture-prosedyrer når du vil laste ned filen capture-agent.zip til den lokale datamaskinen.
  3. Pakk ut ZIP-filen.
  4. Du må legge til <agentkatalog>\bin til PATH. Agentkatalogen er mappen der capture-agent.zip pakkes ut. Du kan også sette miljøvariabelen CAPTURE_HOME til den utpakkede katalogen og legge til $CAPTURE_HOME\bin i PATH.
    På Mac:
    sudo ln -s <agent directory>/bin/capture /usr/local/bin/capture

    I Windows:

    Kjør filen SystemPropertiesAdvanced.exe, rediger Miljøvariabler, og legg deretter til <agentkatalog>\bin i variabelen PATH.

  5. Sett variabelen CAPTURE_JAVA_HOME til en gyldig JDK-plassering, enten som en miljøvariabel eller i filen <agentkatalog>/conf/agent.properties.

Opprette applikasjonen Oracle Identity Cloud Service (IDCS) for filimportagenten

Filimportagenten samhandler med Oracle Content Management om å hente importjobbkonfigurasjoner og laste opp filer. Den gjør det ved å starte Web-tjenester for RESTful. API-ene er beskyttet av OAuth, så filimportagenten må ha OAuth-symboler. IDCS-applikasjonen tillater at filimportagenten genererer disse symbolene.

Slik oppretter du en IDCS-applikasjon:
  1. Logg på instrumentpanelet for Mine tjenester.
  2. Klikk på Identity Cloud.
  3. Kopier URL-adressen til tjenesteforekomsten. Med denne URL-adressen får du tilgang til Oracle Content Management-forekomsten. Det vil si at du skal bruke den til å registrere tjenesten når den er installert.
  4. I Identity Cloud Service-konsollen utvider du navigasjonsskuffen, og deretter klikker du på Applikasjoner.
  5. Klikk på Legg til.
  6. På siden Legg til applikasjon klikker du på Konfidensiell applikasjon.
  7. I ruten Appdetaljer i vinduet Legg til konfidensiell applikasjon angir du et navn på applikasjonen og klikker på Neste.
  8. Velg Konfigurer denne applikasjonen som en klient nå.
  9. Under Autorisasjoner velger du Ressurseier og JWT-påstand.
  10. Under Retningslinjer for symbolutsendelse velger du Alle for Autoriserte ressurser og klikker på Neste.
  11. I fanen Ressurs godtar du standardverdiene og klikker på Neste.
  12. I fanen Retningslinjer for Web-lag godtar du standardverdiene og klikker på Neste.
  13. I fanen Autorisasjoner klikker du på standardverdiene og så klikker du på Neste.
  14. Klikk på Fullfør.
    Kopier Klient-ID og Klienthemmelighet. Du kommer til å trenge dem når du skal registrere tjeneren med Capture-kommandolinjeverktøyet.
  15. I fanen Konfigurasjon utvider du Klientkonfigurasjon.
  16. Bla ned til delen Retningslinjer for symbolutsendelse og klikk på Legg til omfang.
  17. Finn Oracle Content Management-forekomsten i dialogboksen Velg omfang, og klikk på >.
  18. Velg omfanget som har URL-adressen med /urn:opc:..., og klikk deretter på Legg til.
  19. Kopier omfangs-URL-adressen. Du kommer til å trenge den når du skal registrere tjeneren med Capture-kommandolinjeverktøyet.
  20. Klikk på Lagre og deretter på Aktiver.

IDCS-applikasjonen er opprettet. Du kan nå gå videre og registrere tjeneren med Capture-kommandolinjeverktøyet.

Registrere Oracle Content Management i filimportagenten

Oracle Content Management-forekomsten må være registrert i kommandolinjeverktøyet Capture, slik at verktøyet vet hvilke importjobber som er konfigurert i Oracle Content Management-forekomsten, og kan laste opp filene til denne forekomsten.

Slik registrerer du Oracle Content Management:
  1. Last ned og installer filimportagenten hvis den ikke allerede er installert på datamaskinen.
  2. Kjør følgende kommando i operativsystemet Windows, Linux eller 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-adresse for Oracle Content Management: <navn på Oracle Content Management-forekomst>.oraclecloud.com

    • Brukernavn og passord for URL-adressen for Oracle Content Management-forekomsten.

      Merknad:

      Hvis du vil minske en potensiell sikkerhetsrisiko, bør du vurdere å opprette en bruker som er spesifikk for filimportagenten, som bare er tilordnet til Content Capture-rollene eller -tillatelsene i de nødvendige prosedyrene.
    • URL-adresse for identitetstjenesteforekomsten: https://<tjenernavn>.identity.oraclecloud.com/oauth2/v1/token (Du kopierte verdien samtidig med opprettelsen av IDCS-applikasjonen.)

    • Klient-ID: sampleid (Du kopierte denne verdien samtidig med opprettelsen av IDCS-applikasjonen.)

    • Klienthemmelighet: sample-secret (Du kopierte verdien samtidig med opprettelsen av IDCS-applikasjonen.)

    • Omfangs-URL: https://<tjenernavn>:<portnummer>/urn:opc:cec:all (Du kopierte verdien samtidig med opprettelsen av IDCS-applikasjonen.)

  3. Test tilkoblingen ved å kjøre kommandoen slik at du viser importjobbene:
    $ capture list-import-jobs
    

    Det vises en liste over alle mappe- og fillisteimportjobber som er konfigurert i innholdsregistreringsprosedyrer i den angitte Oracle Content Management-forekomsten.

Når du har registrert Oracle Content Management og konfigurert importjobber, kan du konfigurere filimport fra en mappe eller konfigurere listefilimport.

Bruke Capture-kommandolinjeverktøyet

Med kommandolinjeverktøyet Capture kan du konfigurere filimportagenten slik at agenten kan importere dokumenter til Oracle Content Management-registeret. Det har kommandoer for bruk og administrasjon av filimportagenten.

------------------------
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