Ställa in agenten för filimport

Agenten för filimport är ett kommandoradsprogram som körs på alla datorer och fungerar som källa för import av innehåll från en övervakad filsystemsplats, exempelvis en mapp eller en nätverksenhet. Den övervakar och fångar det innehåll som finns på platsen och skickar det till importprocessorn för vidare bearbetning och dirigering i enlighet med de regler som definierats i proceduren.

Agenten för filimport behöver endast installeras och köras på din lokala dator om din källa är en övervakad mapp (inte ett övervakat e-postkonto). Kommandoradsverktyget Capture finns tillgängligt för att hjälpa dig registrera servrar, och konfigurera och lista importjobb.

Ladda ned och installera agenten för filimport

Innan du kan importera filer från en övervakad mapp måste du installera Agenten för filimport på din lokala dator.

Systemkrav

Agenten för filimport är en Java-applikation som kräver att Oracle JDK version 8u251, eller den senaste tillgängliga versionen, finns på datorn när du ska installera applikationen. Agenten för filimport är kompatibel med Windows, Linux och Mac (se Oracle JDK 8- och JRE 8-certifierade systemkonfigurationer).

Så här laddar du ned och installerar agenten för filimport
  1. Logga in på webbgränssnittet för Oracle Content Management och klicka på Fånga i den vänstra navigeringspanelen (under Administration). Om du inte ser det här alternativet har du inte den åtkomstbehörighet som krävs.
  2. På sidan Content Capture-procedurer, under Nedladdningar klickar du på Agenten för filimport i Oracle Content Capture för att ladda ned filen capture-agent.zip till din lokala dator.
  3. Extrahera ZIP-filen.
  4. Du måste lägga till <mapp för agent>\bin till PATH. Mapp för agent är den mapp där capture-agent.zip extraherats. Du kan också sätta miljövariabeln CAPTURE_HOME till den extraherade mappen och lägga till $CAPTURE_HOME\bin till PATH.
    För Mac:
    sudo ln -s <agent directory>/bin/capture /usr/local/bin/capture

    För Windows:

    Kör filen SystemPropertiesAdvanced.exe och redigera sedan miljövariabler, och lägg sedan till <mapp för agent>\bin till variabeln PATH.

  5. Sätt variabeln CAPTURE_JAVA_HOME till en giltig JDK-plats, antingen som en miljövariabel eller i filen <mapp för agent>/conf/agent.properties.

Skapa applikationen Oracles molntjänst för identiteter (IDCS) för agenten för filimport

Agenten för filimport interagerar med Oracle Content Management för att hämta konfigurationer för importerade jobb och ladda upp filer. Den gör det genom att anropa RESTful-webbtjänster. API:erna skyddas av OAuth, så agenten för filimport kräver OAuth-token. IDCS-applikationen tillåter agenten för filimport att generera de här token.

Så här skapar du en IDCS-applikationer:
  1. Logga in på infopanelen Mina tjänster.
  2. Klicka på Moln för identiteter.
  3. Kopiera URL:en för tjänsteinstansen. Den här URL:en ger dig åtkomst till din instans av Oracle Content Management. Du använder den alltså för att registrera dig på servern efter att den har installerats.
  4. I konsolen för molntjänst för identiteter expanderar du Navigeringsmenyn och klickar sedan på Applikationer.
  5. Klicka på Lägg till.
  6. På sidan Lägg till applikation klickar du på Konfidentiell applikation.
  7. I rutan Appdetaljer i fönstret Lägg till konfidentiell applikation anger du ett namn på din applikation och klickar på Nästa.
  8. Välj Konfigurera applikationen som en klient nu.
  9. Under Behörighet väljer du Resursägare och JWT-verifiering.
  10. Under Policy för utfärdande av token väljer du Alla för Behöriga resurser och klickar på Nästa.
  11. På fliken Resurs accepterar du standardvärdena och klickar på Nästa.
  12. På fliken Policy för webbskikt accepterar du standardvärdena och klickar på Nästa.
  13. På fliken Behörighet klickar du på standardvärdena och sedan på Nästa.
  14. Klicka på Slutför.
    Kopiera klient-id och klienthemlighet. Du behöver dem när du registrerar din server med Captures kommandoradsverktyg.
  15. På fliken Konfiguration expanderar du Klientkonfiguration.
  16. Rulla ned till sektionen Policy för utfärdande av token och klicka på Lägg till omfattning.
  17. I dialogrutan Välj omfattning söker du efter din instans av Oracle Content Management och klickar på >.
  18. Välj den omfattning som har URL:en med /urn:opc:... och klicka sedan på Lägg till.
  19. Kopiera omfattnings-URL. Du behöver den när du registrerar din server med Captures kommandoradsverktyg.
  20. Klicka på Spara och sedan på Aktivera.

Din IDCS-applikation har skapats. Nu kan du registrerar din server med Captures kommandoradsverktyg.

Registrera Oracle Content Management med agenten för filimport

Instansen av Oracle Content Management måste registreras i kommandoradsverktyget för Capture, så att verktyget vet vilka importjobb som är konfigurerade med instansen av Oracle Content Management, och kan ladda upp filer till den här instansen.

För att registrera Oracle Content Management:
  1. Ladda ned och installera agenten för filimport om den inte redan finns installerad på datorn.
  2. Kör följande kommando i Windows-, Linux- eller Mac-operativsystemet:
    $ 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
    
    • Oracle Content Management-instansens URL: <oracle content management-instansens namn>.oraclecloud.com

    • Användarnamnet och lösenordet för din URL för Oracle Content Management-instansen

      Obs!:

      För att motverka ett potentiellt säkerhetshot kan du överväga att skapa en användare som är specifik för agenten för filimport och som endast tilldelas roller eller behörigheter i Content Capture för de procedurer som krävs.
    • URL för instansen av identitetstjänsten: https://<server name>.identity.oraclecloud.com/oauth2/v1/token (Du kopierade detta värde i samband med processen för att skapa IDCS-applikation.)

    • Klient-id: sampleid (Du kopierade detta värde i samband med processen för att skapa IDCS-applikation.)

    • Klienthemlighet: sample-secret (Du kopierade detta värde i samband med processen för att skapa IDCS-applikation.)

    • Omfattnings-URL: https://<server name>:<port number>/urn:opc:cec:all (Du kopierade detta värde i samband med processen för att skapa IDCS-applikation.)

  3. Testa anslutningen genom att köra kommandot för att lista importjobben:
    $ capture list-import-jobs
    

    Då visas en lista över alla mapp- och fillistimportjobb som konfigurerats i procedurerna för Content Capture på den angivna instansen av Oracle Content Management.

När du har registrerat Oracle Content Management och konfigurerat importjobb går du vidare till att konfigurera filimport från en mapp eller konfigurera listfilimport.

Använda kommandoradsverktyget för Capture

Med kommandoradsverktyget för capture kan du konfigurera agenten för filimport så att agenten kan importera dokument till datalagret i Oracle Content Management. Det tillhandahåller kommandon för att använda och hantera agenten för filimport.

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