Ver código fonte para SC 36 Importacao de Anexos

[[Importacoes Dados]]

=1957 — Iniciar Smart Component (SC Importacao de Anexos)=

Recurso utilizado para executar o Smart '''36 - SC Importacao de Anexos''', responsável pela importação em lote de arquivos e pelo vínculo automático desses anexos aos registros de um recurso do sistema.

O Smart permite importar arquivos organizados em subpastas, localizar automaticamente o registro correspondente e criar ou atualizar o arquivamento na Central Documentos - Anexos.

Diferente de uma importação específica de imagens de produtos, este Smart pode ser configurado para trabalhar com diferentes recursos e entidades do sistema.

==Objetivo==
Esta funcionalidade tem como objetivo automatizar a importação e o vínculo de anexos aos registros do ERP.

Através de um arquivo compactado, o sistema analisa as subpastas existentes, identifica o registro correspondente e realiza o arquivamento dos arquivos encontrados.

A utilização do Smart reduz o trabalho manual de anexação de documentos e permite importar grandes volumes de arquivos em uma única execução.

==Pré-requisitos==
- Ter permissão para acessar o recurso 1957 - Iniciar Smart Component.
- Ter o Smart '''36 - SC Importacao de Anexos''' disponível no recurso 1947 - Smart Component.
- Ter os registros que receberão os anexos previamente cadastrados no sistema.
- Enviar um arquivo compactado válido no formato ''.zip''.
- Organizar os arquivos em subpastas.
- O nome de cada subpasta deve corresponder ao valor utilizado para localizar o registro no sistema.
- Configurar corretamente o recurso/nodo que receberá os anexos.
- Informar as extensões de arquivos permitidas para importação.
- Informar um Tipo de Arquivamento válido.

==Fluxo Principal==
Passo a passo para utilizar o Smart:

#Acesse o recurso 1957 - Iniciar Smart Component.
#Selecione o Smart '''36 - SC Importacao de Anexos'''.
#Selecione o perfil de parâmetros desejado.
#Envie o arquivo compactado no formato ''.zip''.
#Configure as extensões de arquivos permitidas.
#Informe o recurso/nodo ao qual os anexos serão vinculados.
#Informe, se necessário, o campo utilizado para localizar o registro.
#Defina o Tipo de Arquivamento.
#Defina a Opção de Arquivamento.
#Informe, opcionalmente, o alias do arquivo principal.
#Clique em '''Importar Dados'''.
#O sistema irá extrair o arquivo compactado.
#As subpastas encontradas serão analisadas individualmente.
#O nome da subpasta será utilizado para localizar o registro correspondente.
#Os arquivos com extensões permitidas serão importados.
#O sistema criará ou atualizará o arquivamento conforme a Opção de Arquivamento selecionada.
#Ao final, será gerada uma planilha contendo o resultado da importação.

===Orientação para preenchimento de campos===
{| class="wikitable"
!Nome do campo!!Objetivo!!Orientação de preenchimento
|-
|Extensões arquivos permitidas a Importar (.png; .jpeg; .jpg etc)||Define quais tipos de arquivos poderão ser importados||Informe as extensões permitidas. Apenas arquivos que correspondam às extensões configuradas serão considerados durante a importação.
|-
|Recurso/Nodo a Vincular||Define o recurso e a entidade cujos registros receberão os anexos||Informe o recurso correspondente ao cadastro que deverá receber os arquivos. O sistema utilizará a entidade vinculada ao recurso para localizar os registros.
|-
|Campo de Pesquisa (Deixe em branco para identificador)||Define o campo utilizado para localizar o registro através do nome da subpasta||Informe o nome do campo da entidade que deverá ser utilizado na pesquisa. Quando deixado em branco, o sistema utilizará automaticamente o campo identificador da entidade.
|-
|Tipo Arquivamento||Define o Tipo de Arquivamento utilizado na Central Documentos - Anexos||Selecione o tipo de arquivamento que será associado ao registro criado ou localizado.
|-
|Opção de Arquivamento||Define como o Smart deverá tratar arquivamentos existentes||Selecione entre criar um novo arquivamento sempre, limpar os anexos existentes antes de importar os novos ou adicionar os novos arquivos ao arquivamento existente.
|-
|Alias Arquivo Principal (Opcional)||Permite identificar um arquivo que deverá ser tratado como arquivo principal||Informe parte do nome do arquivo principal. Quando configurado, o Smart procura um arquivo cujo nome contenha o alias informado. O preenchimento é opcional.
|}

===Opções de Arquivamento===
{| class="wikitable"
!Opção!!Comportamento
|-
|Criar novo arquivamento sempre||Cria um novo arquivamento para o registro em cada execução do Smart.
|-
|Criar caso não exista, limpar anexos se existirem e anexar novos||Localiza o arquivamento existente. Caso exista, remove seus anexos e importa os novos arquivos. Caso não exista, cria um novo arquivamento.
|-
|Criar caso não exista e anexar novos arquivos||Utiliza o arquivamento existente e adiciona os novos arquivos. Caso não exista, cria um novo arquivamento.
|}

==Estrutura do Arquivo Compactado==
Os arquivos devem ser organizados em subpastas.

Cada subpasta representa um registro do recurso configurado.

Exemplo:

 arquivo.zip
 ├── 1598
 │   ├── imagem1.jpg
 │   ├── imagem2.png
 │   └── manual.pdf
 ├── 1599
 │   ├── contrato.pdf
 │   └── foto.jpg
 └── 1600
     └── documento.pdf

Neste exemplo, caso o campo de pesquisa esteja em branco, o sistema utilizará o identificador da entidade.

A pasta '''1598''' será utilizada para localizar o registro de identificador '''1598''', e os arquivos válidos existentes dentro dela serão vinculados ao registro.

Caso um Campo de Pesquisa seja informado, o nome da pasta será comparado com o valor desse campo.

==Funcionalidades==
- Importação de anexos através de arquivo compactado.
- Processamento automático de subpastas.
- Configuração das extensões de arquivos permitidas.
- Vínculo dos anexos a diferentes recursos e entidades do sistema.
- Pesquisa do registro por campo configurável.
- Utilização automática do identificador quando nenhum Campo de Pesquisa for informado.
- Criação automática de arquivamentos.
- Limpeza dos anexos existentes conforme configuração.
- Inclusão de novos arquivos em arquivamentos existentes.
- Criação de um novo arquivamento em cada execução.
- Definição opcional de arquivo principal através de alias.
- Geração de planilha com o resultado da importação.
- Desconsideração de pastas ocultas e diretórios internos do macOS identificados como ''__MACOSX''.

==Planilha de Resultado==
Ao final da execução, o Smart gera uma planilha contendo o resultado do processamento.

{| class="wikitable"
!Campo!!Descrição
|-
|Entidade||Registro ou entidade processada pelo Smart.
|-
|Arquivo||Nome do arquivo processado.
|-
|Status||Resultado do processamento, como Sucesso ou Erro.
|-
|Observação||Mensagem complementar ou descrição do erro ocorrido.
|}

==Problemas e Soluções==
{| class="wikitable"
!Problema!!Solução
|-
|O processo informa que o arquivo não existe||Realize novamente o upload do arquivo compactado e execute o Smart.
|-
|Os arquivos não foram importados||Verifique se a extensão do arquivo está configurada em '''Extensões arquivos permitidas a Importar'''.
|-
|O registro não foi localizado||Verifique se o nome da subpasta corresponde ao valor existente no Campo de Pesquisa configurado.
|-
|O Campo de Pesquisa está vazio||Neste caso, o sistema utiliza automaticamente o campo identificador da entidade.
|-
|Os anexos existentes foram removidos||Verifique se foi utilizada a opção '''Criar caso não exista, limpar anexos se existirem e anexar novos'''.
|-
|Foi criado um novo arquivamento||Verifique se a opção '''Criar novo arquivamento sempre''' está selecionada.
|-
|Os novos arquivos foram adicionados ao arquivamento existente||Este é o comportamento da opção '''Criar caso não exista e anexar novos arquivos'''.
|-
|Uma subpasta não possui arquivos processados||Verifique se existem arquivos com extensões permitidas dentro da pasta.
|-
|O arquivo principal não foi identificado||Verifique se o nome do arquivo contém o texto configurado em '''Alias Arquivo Principal'''.
|-
|Pastas __MACOSX não foram processadas||Essas pastas são ignoradas automaticamente pelo Smart.
|}

==Exemplos de Uso==
- Importar imagens e documentos para produtos.
- Importar contratos vinculados a registros do sistema.
- Importar documentos utilizando o identificador do registro como nome da subpasta.
- Importar arquivos utilizando outro campo da entidade como código, referência ou número de controle.
- Substituir todos os anexos existentes pelos arquivos enviados.
- Adicionar novos anexos mantendo os arquivos já arquivados.
- Criar um novo arquivamento a cada lote importado.

==Observações Gerais==
- O nome das subpastas é utilizado para localizar os registros no sistema.
- Quando o Campo de Pesquisa estiver vazio, será utilizado o identificador da entidade.
- Apenas arquivos com extensões permitidas serão importados.
- Subpastas sem arquivos válidos não serão processadas.
- Pastas ocultas são ignoradas.
- Diretórios ''__MACOSX'' são ignorados automaticamente.
- A Opção de Arquivamento deve ser definida de acordo com o comportamento desejado para os anexos existentes.
- A opção de limpeza remove os itens existentes antes de realizar a nova importação.
- O Alias Arquivo Principal é opcional.
- Recomenda-se consultar a planilha gerada ao final para validar o resultado da execução.
- Após a importação, os arquivos poderão ser consultados através da Central Documentos - Anexos ou pelo recurso vinculado, quando este disponibilizar acesso aos anexos.

==Benefícios do Recurso==
- Reduz o trabalho manual de anexação de arquivos.
- Permite importação em lote.
- Pode ser utilizado com diferentes recursos do sistema.
- Permite configurar o campo utilizado para localizar registros.
- Flexibiliza o tratamento de arquivamentos existentes.
- Facilita a substituição ou inclusão de anexos.
- Gera retorno detalhado da execução.
- Reduz erros operacionais em importações de grande volume.

==Glossário de Termos==
- '''Smart Component''' — Rotina automatizada executada pelo ERP.
- '''SC Importacao de Anexos''' — Smart Component número 36 responsável pela importação e vínculo automático de arquivos.
- '''Recurso/Nodo''' — Recurso do sistema utilizado para determinar a entidade que receberá os anexos.
- '''Campo de Pesquisa''' — Campo da entidade utilizado para localizar o registro através do nome da subpasta.
- '''Tipo de Arquivamento''' — Classificação utilizada para organizar o arquivamento na Central Documentos - Anexos.
- '''Opção de Arquivamento''' — Configuração que determina como arquivamentos existentes serão tratados.
- '''Alias Arquivo Principal''' — Texto utilizado para identificar um arquivo principal entre os arquivos importados.
- '''Central Documentos - Anexos''' — Recurso responsável pelo armazenamento e gerenciamento de documentos e arquivos vinculados aos registros do sistema.

==Links Relacionados==
- 1947 - Smart Component
- 1957 - Iniciar Smart Component
- 2027 - Central Documentos - Anexos