Configurar o File Import Agent

O File Import Agent é um aplicativo de linha de comando executado em qualquer computador e serve de origem para importar conteúdo de um local no sistema de arquivos monitorado, por exemplo, uma pasta ou unidade de rede. Ele monitora e captura o conteúdo nesse local e o alimenta para o processador de importação para posterior processamento e roteamento de acordo com as regras definidas no procedimento.

Só instale e execute o File Import Agent em seu computador local se a origem for uma pasta monitorada (não uma conta de e-mail monitorada). O utilitário de linha de comando do Capture está disponível para ajudar você a registrar servidores, configurar jobs de importação e listá-los.

Fazer Download e Instalar o File Import Agent

Para poder importar arquivos de uma pasta monitorada, instale o File Import Agent em seu computador local.

Requisitos do Sistema

O File Import Agent é um aplicativo Java que precisa do Oracle JDK versão 8u251 ou a versão mais recente disponível no momento da instalação desse aplicativo. O File Import Agent é compatível com Windows, Linux e Mac (consulte Configurações do Sistema Certificadas para Oracle JDK 8 e JRE 8).

Para fazer download e instalar o File Import Agent:
  1. Faça log-in na interface web do Oracle Content Management e clique em Capturar no painel de navegação à esquerda (em Administração). Caso não veja essa opção, significará que você não tem os privilégios de acesso necessários.
  2. Na página Procedimentos do Content Capture, em Downloads, clique em Oracle Content Capture File Import Agent para fazer download do arquivo capture-agent.zip para seu computador local.
  3. Extraia o arquivo ZIP.
  4. Adicione <agent directory>\bin a PATH. O diretório do agente é a pasta na qual capture-agent.zip é extraído. Você também pode definir a variável de ambiente CAPTURE_HOME para o diretório extraído e adicionar $CAPTURE_HOME\bin a PATH.
    No Mac:
    sudo ln -s <agent directory>/bin/capture /usr/local/bin/capture

    No Windows:

    Execute o arquivo SystemPropertiesAdvanced.exe; em seguida, edite Variáveis de Ambiente e depois adicione <agent directory>\bin à variável PATH.

  5. Defina a variável CAPTURE_JAVA_HOME para local do JDK válido como variável de ambiente ou no arquivo <agent directory>/conf/agent.properties.

Criar o Aplicativo Oracle Identity Cloud Service (IDCS) para o File Import Agent

O File Import Agent interage com o Oracle Content Management para recuperar as configurações e os arquivos de upload do job de importação. Ele faz isso chamando web services RESTful. As APIs são protegidas por OAuth; assim, o File Import Agent exige tokens OAuth. O aplicativo IDCS permite que o File Import Agent gere esses tokens.

Para criar um aplicativo IDCS:
  1. Faça log-in no painel de controle Meus Serviços.
  2. Clique em Identity Cloud.
  3. Copie o URL da Instância de Serviço. Esse URL permitirá que você acesse a instância do Oracle Content Management. Ou seja, você vai usá-lo para registrar o servidor depois de instalado.
  4. Na console do Identity Cloud Service, expanda a Gaveta de Navegação e depois clique em Aplicativos.
  5. Clique em Adicionar.
  6. Na página Adicionar Aplicativo, clique em Aplicativo Confidencial.
  7. No painel Detalhes do Aplicativo da janela Adicionar Aplicativo Confidencial, digite um nome para seu aplicativo e clique em Próximo.
  8. Escolha Configurar este aplicativo como cliente agora.
  9. Em Autorização, selecione Proprietário do Recurso e Asserção JWT.
  10. Em Política de Emissão de Token, escolha Todos para Recursos Autorizados e clique em Próximo.
  11. Na guia Recursos, aceite os valores padrão e clique em Próximo.
  12. Na guia Política de Camada Web, aceite os valores padrão e clique em Próximo.
  13. Na guia Autorização, clique nos valores padrão e clique em Próximo.
  14. Clique em Finalizar.
    Copie o ID do Cliente e o Segredo do Cliente. Você precisará deles quando registar o servidor no utilitário de linha de comando do Capture.
  15. Na guia Configuração, expanda Configuração do Cliente.
  16. Role para baixo até a seção Política de Emissão de Token e clique em Adicionar Escopo.
  17. Na caixa de diálogo Selecionar Escopo, localize a instância do Oracle Content Management e clique em >.
  18. Selecione o escopo que tenha o URL com /urn:opc:... e clique em Adicionar.
  19. Copie o URL de Escopo. Você precisará dele quando registar o servidor no utilitário de linha de comando do Capture.
  20. Clique em Salvar e depois em Ativar.

Seu aplicativo IDCS foi criado. Agora você pode continuar e registar o servidor no utilitário de linha de comando do Capture.

Registrar o Oracle Content Management no File Import Agent

A instância do Oracle Content Management deve ser registrada no utilitário de linha de comando do Capture para que o utilitário saiba quais jobs de importação estão configurados com a instância do Oracle Content Management e possa fazer upload dos arquivos para essa instância.

Para registrar o Oracle Content Management:
  1. Faça download e instale o File Import Agent caso não o tenha instalado ainda em seu computador.
  2. Execute o seguinte comando no seu sistema operacional 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 da instância do Oracle Content Management: <oracle content management instance name>.oraclecloud.com

    • Nome de usuário e Senha para o URL da instância do Oracle Content Management.

      Nota:

      Para diminuir uma possível ameaça à segurança, tente criar um usuário específico do File Import Agent que tenha recebido apenas as atribuições ou permissões do Content Capture nos procedimentos obrigatórios.
    • URL da Instância do Identity Service: https://<server name>.identity.oraclecloud.com/oauth2/v1/token (Você copiou o valor enquanto estava criando o aplicativo IDCS.)

    • ID do Cliente: sampleid (Você copiou o valor enquanto estava criando o aplicativo IDCS.)

    • Segredo do Cliente: sample-secret (Você copiou o valor enquanto estava criando o aplicativo IDCS.)

    • URL de Escopo: https://<server name>:<port number>/urn:opc:cec:all (Você copiou o valor enquanto estava criando o aplicativo IDCS.)

  3. Teste sua conexão executando o comando para listar os jobs de importação:
    $ capture list-import-jobs
    

    Será exibida uma lista de todos os jobs de importação da lista de pastas e arquivos configurados nos procedimentos de captura de conteúdo, na instância especificada do OOracle Content Management.

Depois de ter registrado o Oracle Content Management e configurado os jobs de importação, configure a importação de arquivo de uma pasta ou configure a importação de arquivo de lista.

Usar o Utilitário de Linha de Comando do Capture

O utilitário de linha de comando capture permite configurar o File Import Agent para que o agente possa importar documentos para o repositório do Oracle Content Management. Ele fornece os comandos para usar e gerenciar o File Import Agent.

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