Configuration de l'agent d'import de fichier

L'agent d'import de fichier est une application de ligne de commande exécutable sur n'importe quel ordinateur. Il fait office de source pour l'import de contenu à partir d'un emplacement de système de fichiers surveillé comme un dossier ou un lecteur réseau. Il surveille et capture le contenu de cet emplacement, puis l'envoie dans le processeur d'import à des fins de traitement et d'acheminement telles que définies dans les règles de la procédure.

Vous ne devez installer et exécuter l'agent d'import de fichier sur votre ordinateur local que si vous utilisez un dossier surveillé comme source (et non un compte de messagerie électronique surveillé). L'utilitaire de ligne de commande Capture est disponible pour vous aider à inscrire des serveurs, ainsi qu'à configurer et à répertorier des travaux d'import.

Téléchargement et installation de l'agent d'import de fichier

Pour pouvoir importer des fichiers à partir d'un dossier surveillé, vous devez installer l'agent d'import de fichier sur votre ordinateur local.

Exigences système

L'agent d'import de fichier est une application Java qui requiert la version 8u251 d'Oracle JDK ou la dernière version disponible au moment où vous installez l'application. L'agent d'import de fichier est compatible avec Windows, Linux et Mac (reportez-vous à Configurations système certifiées Oracle JDK 8 et JRE 8).

Pour télécharger et installer l'agent d'import de fichier, procédez comme suit :
  1. Connectez-vous à l'interface Web d'Oracle Content Management et cliquez sur Capture dans le panneau de navigation de gauche (sous Administration). Si vous ne voyez pas cette option, vous ne disposez pas des privilèges d'accès requis.
  2. Sur la page des procédures Content Capture, sous Téléchargements, cliquez sur Agent d'import de fichier Oracle Content Capture pour télécharger le fichier capture-agent.zip sur votre ordinateur local.
  3. Extrayez le fichier ZIP.
  4. Vous devez ajouter <agent directory>\bin à PATH. Le répertoire de l'agent correspond au dossier dans lequel capture-agent.zip est extrait. Vous pouvez également définir la variable d'environnement CAPTURE_HOME sur le répertoire extrait et ajouter $CAPTURE_HOME\bin à PATH.
    Sur Mac, utilisez la commande suivante :
    sudo ln -s <agent directory>/bin/capture /usr/local/bin/capture

    Sur Windows, procédez comme suit :

    Exécutez le fichier SystemPropertiesAdvanced.exe, puis modifiez les variables d'environnement et ajoutez <agent directory>\bin à la variable PATH.

  5. Définissez la variable CAPTURE_JAVA_HOME sur un emplacement JDK valide en tant que variable d'environnement ou dans le fichier <agent directory>/conf/agent.properties.

Création de l'application Oracle Identity Cloud Service (IDCS) pour l'agent d'import de fichier

L'agent d'import de fichier interagit avec Oracle Content Management pour extraire les configurations de travail d'import et télécharger des fichiers. Pour ce faire, il passe par l'appel de services Web RESTful. Les API étant protégées par OAuth, l'agent d'import de fichier requiert des jetons OAuth. L'application IDCS permet à l'agent d'import de fichier de générer ces jetons.

Pour créer une application IDCS, procédez comme suit :
  1. Connectez-vous au tableau de bord Mes services.
  2. Cliquez sur Identity Cloud.
  3. Copiez l'URL d'instance de service. Cette URL vous permet d'accéder à votre instance Oracle Content Management. En d'autres termes, vous l'utiliserez pour inscrire le serveur après son installation.
  4. Dans la console Identity Cloud Service, développez le volet de navigation, puis cliquez sur Applications.
  5. Cliquez sur Ajouter.
  6. Sur la page Ajouter une application, cliquez sur Application confidentielle.
  7. Dans le panneau Détails de l'application de la fenêtre Ajouter une application confidentielle, entrez le nom de l'application et cliquez sur Suivant.
  8. Sélectionnez Configurer cette application en tant que client maintenant.
  9. Sous Autorisation, sélectionnez Propriétaire de ressource et Assertion JWT.
  10. Sous Stratégie d'émission de jeton, sélectionnez Tout pour Ressources autorisées, puis cliquez sur Suivant.
  11. Dans l'onglet Ressource, acceptez les valeurs par défaut et cliquez sur Suivant.
  12. Dans l'onglet Stratégie de niveau Web, acceptez les valeurs par défaut et cliquez sur Suivant.
  13. Dans l'onglet Autorisation, acceptez les valeurs par défaut et cliquez sur Suivant.
  14. Cliquez sur Terminer.
    Copiez l'ID client et la clé secrète client. Vous en avez besoin lorsque vous inscrivez votre serveur avec l'utilitaire de ligne de commande Capture.
  15. Dans l'onglet Configuration, développez Configuration du client.
  16. Faites défiler vers le bas la section Stratégie d'émission de jeton et cliquez sur Ajouter une portée.
  17. Dans la boîte de dialogue Sélectionner une portée, recherchez votre instance Oracle Content Management et cliquez sur >.
  18. Sélectionnez la portée dont l'URL contient /urn:opc:..., puis cliquez sur Ajouter.
  19. Copiez l'URL de la portée. Vous en avez besoin lorsque vous inscrivez votre serveur avec l'utilitaire de ligne de commande Capture.
  20. Cliquez sur Enregistrer, puis sur Activer.

L'application IDCS a été créée. Vous pouvez maintenant continuer : inscrivez votre serveur avec l'utilitaire de ligne de commande Capture.

Inscription d'Oracle Content Management auprès de l'agent d'import de fichier

Votre instance Oracle Content Management doit être inscrite auprès de l'utilitaire de ligne de commande Capture afin que ce dernier connaisse les travaux d'import configurés avec l'instance Oracle Content Management, et que des fichiers puissent être téléchargés vers cette instance.

Pour inscrire Oracle Content Management, procédez comme suit :
  1. Téléchargez et installez l'agent d'import de fichier si vous ne l'avez pas encore installé sur votre ordinateur.
  2. Exécutez la commande suivante sur votre système d'exploitation Windows, Linux ou 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 de l'instance Oracle Content Management : <oracle content management instance name>.oraclecloud.com

    • Nom utilisateur et mot de passe correspondant à l'URL de votre instance Oracle Content Management.

      Remarque :

      Pour éviter un problème de sécurité potentiel, envisagez de créer un utilisateur propre à l'agent d'import de fichier qui dispose uniquement des rôles ou des droits d'accès Content Capture sur les procédures requises.
    • URL d'instance de service d'identité : https://<nom du serveur>.identity.oraclecloud.com/oauth2/v1/token (vous avez copié sa valeur au moment de la création de l'application IDCS)

    • ID client : sampleid (vous avez copié sa valeur au moment de la création de l'application IDCS)

    • Clé secrète client : sample-secret (vous avez copié sa valeur au moment de la création de l'application IDCS)

    • URL de portée : https://<nom du serveur>:<numéro de port>/urn:opc:cec:all (vous avez copié sa valeur au moment de la création de l'application IDCS)

  3. Testez la connexion en exécutant la commande permettant d'obtenir la liste des travaux d'import :
    $ capture list-import-jobs
    

    La liste de tous les travaux d'import de dossier et de fichier de liste configurés dans les procédures de capture de contenu sur l'instance Oracle Content Management spécifiée est affichée.

Une fois que vous avez inscrit Oracle Content Management et configuré les travaux d'import, configurez l'import de fichier à partir d'un dossier ou configurez l'import de fichier de liste.

Emploi de l'utilitaire de ligne de commande Capture

L'utilitaire de ligne de commande capture permet de configurer l'agent d'import de fichier afin que celui-ci puisse importer des documents dans le référentiel Oracle Content Management. Il fournit des commandes permettant d'utiliser et de gérer l'agent d'import de fichier

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