Saltar para o conteúdo

Referência de comandos

Sintaxe

stcpren [opções] <arquivo>                     # processa um arquivo
stcpren [opções] -scan <diretório>             # varre um diretório
stcpren -ini <regras.ini> -rules <regras.json> # converte regras INI para JSON
stcpren -db -rules <roteamento> -export <destino> # exporta um roteamento do banco

As opções vêm antes do nome do arquivo. É preciso informar um arquivo, a opção -scan, a opção -ini ou a opção -export; caso contrário, o comando exibe a ajuda e termina com o código 2. Com -scan "", o diretório é o informado em ScanDir no roteamento.

Configuração e regras

OpçãoTipoPadrãoDescrição
-configtexto/usr/local/stcpren/configs/config.jsonArquivo de configuração.
-dbbooleanafalseLê o roteamento do banco de configuração.
-rulestexto—Com -db, nome do roteamento. Sem -db, caminho do arquivo JSON do roteamento. Com -ini, arquivo JSON gerado.
-initexto—Arquivo de regras em formato INI a converter para JSON.
-exporttexto—Com -db, grava o roteamento em JSON. Se o destino for um diretório, o arquivo recebe o nome do roteamento com a extensão .json.
-testbooleanafalseMostra a regra que seria aplicada a cada arquivo, sem processá-lo.

Varredura

OpçãoTipoPadrãoDescrição
-scantexto—Diretório da varredura. Substitui ScanDir.
-nosubdirbooleanafalseSomente o diretório informado.
-subdirbooleanafalseSomente os subdiretórios.
-subdir2booleanafalseO diretório e os subdiretórios.
-dirregex, -dirregexnegtexto—Expressões que incluem ou excluem diretórios.
-fileregex, -fileregexnegtexto—Expressões que incluem ou excluem arquivos.
-firstruleinteiro0Número da primeira regra avaliada.
-scansemnametexto—Nome do semáforo da varredura.
-scansemtimeoutinteiro-1Tempo máximo de espera pelo semáforo, em milissegundos.
-scansemoptionsinteiro0Opções do semáforo. 1: termina se o semáforo estiver em uso.

As opções de varredura substituem os valores correspondentes do roteamento. Veja Referência de regras.

Dados do arquivo

OpçãoTipoPadrãoDescrição
-srctexto—Origem do arquivo, comparada com SrcRegEx.
-dsttexto—Destino do arquivo, disponível em $DSTUSER quando nenhuma regra é aplicada.
-filekeytexto—Chave do arquivo, disponível em $FILEKEY.
-copydirtexto—Diretório de cópia. Substitui CopyToDir.
-backupdirtexto—Diretório de backup. Substitui BkpToDir.
-var0 a -var9texto—Valores das variáveis $VAR0 a $VAR9 e dos itens de substituição por valor fixo. Veja Referência de variáveis.

Execução e log

OpçãoTipoPadrãoDescrição
-langtextoptbIdioma das mensagens: ptb (português), enu (inglês) ou esp (espanhol).
-langfiletexto/usr/local/stcpren/configs/messages.jsonArquivo de mensagens.
-pidtexto—Arquivo de PID. Substitui applPidFile.
-errfiletexto—Redireciona a saída de erro (stderr) para um arquivo.
-nologevent, -nologroutebooleanafalseMantidas para compatibilidade. Não têm efeito nesta versão.
-vbooleanafalseExibe a versão e termina.

Códigos de saída

CódigoSignificado
0Execução concluída. Na varredura, os erros de arquivos individuais são registrados no log e não mudam o código.
1Falha no processamento do arquivo, na leitura da configuração ou do roteamento. Também é o código de -v.
2Uso inválido: falta o arquivo ou a opção -scan, -ini ou -export.
4Falha na inicialização, por exemplo na licença, no banco de configuração ou no log.

Exemplos

# Processa um arquivo recebido de PARCEIRO
stcpren -db -rules ENTRADA -src PARCEIRO /caixa/IN/NOTAS.TXT

# Varre o diretório e os subdiretórios, somente arquivos .TXT
stcpren -db -rules ENTRADA -scan /caixa/IN -subdir2 -fileregex '\.TXT$'

# Mostra a regra aplicada a cada arquivo, sem processar
stcpren -db -rules ENTRADA -scan /caixa/IN -test

# Usa um roteamento em arquivo local
stcpren -rules /usr/local/stcpren/configs/entrada.json /caixa/IN/NOTAS.TXT

# Exporta um roteamento do banco
stcpren -db -rules ENTRADA -export /tmp