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 bancoAs 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ção | Tipo | Padrão | Descrição |
|---|---|---|---|
-config | texto | /usr/local/stcpren/configs/config.json | Arquivo de configuração. |
-db | booleana | false | Lê o roteamento do banco de configuração. |
-rules | texto | — | Com -db, nome do roteamento. Sem -db, caminho do arquivo JSON do roteamento. Com -ini, arquivo JSON gerado. |
-ini | texto | — | Arquivo de regras em formato INI a converter para JSON. |
-export | texto | — | 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. |
-test | booleana | false | Mostra a regra que seria aplicada a cada arquivo, sem processá-lo. |
Varredura
| Opção | Tipo | Padrão | Descrição |
|---|---|---|---|
-scan | texto | — | Diretório da varredura. Substitui ScanDir. |
-nosubdir | booleana | false | Somente o diretório informado. |
-subdir | booleana | false | Somente os subdiretórios. |
-subdir2 | booleana | false | O diretório e os subdiretórios. |
-dirregex, -dirregexneg | texto | — | Expressões que incluem ou excluem diretórios. |
-fileregex, -fileregexneg | texto | — | Expressões que incluem ou excluem arquivos. |
-firstrule | inteiro | 0 | Número da primeira regra avaliada. |
-scansemname | texto | — | Nome do semáforo da varredura. |
-scansemtimeout | inteiro | -1 | Tempo máximo de espera pelo semáforo, em milissegundos. |
-scansemoptions | inteiro | 0 | Opçõ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ção | Tipo | Padrão | Descrição |
|---|---|---|---|
-src | texto | — | Origem do arquivo, comparada com SrcRegEx. |
-dst | texto | — | Destino do arquivo, disponível em $DSTUSER quando nenhuma regra é aplicada. |
-filekey | texto | — | Chave do arquivo, disponível em $FILEKEY. |
-copydir | texto | — | Diretório de cópia. Substitui CopyToDir. |
-backupdir | texto | — | Diretório de backup. Substitui BkpToDir. |
-var0 a -var9 | texto | — | 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ção | Tipo | Padrão | Descrição |
|---|---|---|---|
-lang | texto | ptb | Idioma das mensagens: ptb (português), enu (inglês) ou esp (espanhol). |
-langfile | texto | /usr/local/stcpren/configs/messages.json | Arquivo de mensagens. |
-pid | texto | — | Arquivo de PID. Substitui applPidFile. |
-errfile | texto | — | Redireciona a saída de erro (stderr) para um arquivo. |
-nologevent, -nologroute | booleana | false | Mantidas para compatibilidade. Não têm efeito nesta versão. |
-v | booleana | false | Exibe a versão e termina. |
Códigos de saída
| Código | Significado |
|---|---|
0 | Execução concluída. Na varredura, os erros de arquivos individuais são registrados no log e não mudam o código. |
1 | Falha no processamento do arquivo, na leitura da configuração ou do roteamento. Também é o código de -v. |
2 | Uso inválido: falta o arquivo ou a opção -scan, -ini ou -export. |
4 | Falha 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