Mudanças entre as edições de "Protocolo Integrado (Relatórios)"
(→Regras) |
|||
(7 edições intermediárias de um usuário não apresentadas) | |||
Linha 3: | Linha 3: | ||
=Escopo= | =Escopo= | ||
1. Ser um serviço no SAPIENS; | 1. Ser um serviço no SAPIENS; | ||
− | 2. Permita ser executado por linha de comando, dessa forma poderá ser agendado em um servidor, rodando de forma assíncrona (segundo plano), não concorrendo com o processa-mento SAPIENS e não prejudicando a experiência do usuário; | + | |
+ | 2. Permita ser executado por linha de comando, dessa forma poderá ser agendado em um servidor, rodando de forma assíncrona (segundo plano), não concorrendo com o processa-mento SAPIENS e não | ||
+ | prejudicando a experiência do usuário; | ||
+ | |||
3. Faça o envio de pastas de documentos SAPIENS de forma individual ou em lote através do Web Service Protocolo Integrado do Ministério do Planejamento (mais em: | 3. Faça o envio de pastas de documentos SAPIENS de forma individual ou em lote através do Web Service Protocolo Integrado do Ministério do Planejamento (mais em: | ||
http://www.planejamento.gov.br/servicos/servicos-do-mp/protocolo-integrado); | http://www.planejamento.gov.br/servicos/servicos-do-mp/protocolo-integrado); | ||
+ | |||
4. Gere um Log de ações com mensagens de erro e sucesso. | 4. Gere um Log de ações com mensagens de erro e sucesso. | ||
=Regras= | =Regras= | ||
Para enviar uma pasta ao Protocolo Integrado observar: | Para enviar uma pasta ao Protocolo Integrado observar: | ||
+ | |||
1. Somente pastas que não possuam ticket de protocolo serão enviadas (pendentes de envio); | 1. Somente pastas que não possuam ticket de protocolo serão enviadas (pendentes de envio); | ||
+ | |||
2. A pasta não pode conter processo judicial; | 2. A pasta não pode conter processo judicial; | ||
+ | |||
3. A pasta não pode ter visibilidade restrita; | 3. A pasta não pode ter visibilidade restrita; | ||
− | 4. A pasta | + | |
+ | 4. A pasta não pode ser sigilosa; | ||
+ | |||
5. Se a pasta conter procedência, usar data/hora da produção para envio, caso contrário será usada a data de criação da pasta; | 5. Se a pasta conter procedência, usar data/hora da produção para envio, caso contrário será usada a data de criação da pasta; | ||
+ | |||
6. Se a pasta conter documento avulso, a espécie da pasta será Documento Avulso, caso contrário será Processo; | 6. Se a pasta conter documento avulso, a espécie da pasta será Documento Avulso, caso contrário será Processo; | ||
+ | |||
7. O assunto do documento será sempre o título da pasta; | 7. O assunto do documento será sempre o título da pasta; | ||
+ | |||
8. Pegar o nome do interessado do documento e o número do identificador do interessado. Todo documento tem que ter um interessado, se não tiver emite mensagem de erro “Nenhum interessado encontrado” e não envia o documento; | 8. Pegar o nome do interessado do documento e o número do identificador do interessado. Todo documento tem que ter um interessado, se não tiver emite mensagem de erro “Nenhum interessado encontrado” e não envia o documento; | ||
+ | |||
9. O documento dentro de uma pasta tem que ter um volume, que é recuperado do histórico de juntada; | 9. O documento dentro de uma pasta tem que ter um volume, que é recuperado do histórico de juntada; | ||
+ | |||
10. O parâmetro Protocolo é o NUP da pasta; | 10. O parâmetro Protocolo é o NUP da pasta; | ||
=Integração= | =Integração= | ||
− | O serviço é integrado ao "Protocolo integrado" do Ministério do Planejamento. | + | O serviço é integrado ao "Protocolo integrado" do Ministério do Planejamento. Dados dos documentos que são enviados nas pastas: |
− | Dados dos documentos que são enviados nas pastas: | + | |
1. Protocolo | 1. Protocolo | ||
+ | |||
2. Data/hora de produção | 2. Data/hora de produção | ||
+ | |||
3. Assunto | 3. Assunto | ||
+ | |||
4. Lista de interessados | 4. Lista de interessados | ||
+ | |||
5. Espécie | 5. Espécie | ||
+ | |||
6. Histórico | 6. Histórico | ||
+ | |||
Parâmetros de entrada: | Parâmetros de entrada: | ||
+ | |||
1. ID da pasta | 1. ID da pasta | ||
Parâmetros de saída: | Parâmetros de saída: | ||
+ | |||
1. Ações registradas em log do item 2.1 deste documento. | 1. Ações registradas em log do item 2.1 deste documento. | ||
+ | |||
+ | |||
Tabelas SAPIENS gravadas: PASTA | Tabelas SAPIENS gravadas: PASTA | ||
+ | |||
Tabelas SAPIENS lidas: PASTA, INTERESSADOS, JUNTADAS, VOLUMES | Tabelas SAPIENS lidas: PASTA, INTERESSADOS, JUNTADAS, VOLUMES | ||
− | = | + | =Log= |
Ações registradas em Log: | Ações registradas em Log: | ||
+ | |||
1. Falha na execução do comando. Erro: {erro} | 1. Falha na execução do comando. Erro: {erro} | ||
+ | |||
2. Comando executado com sucesso. | 2. Comando executado com sucesso. | ||
+ | |||
3. Erro ao enviar documento avulso: {log} | 3. Erro ao enviar documento avulso: {log} | ||
+ | |||
4. Processo de envio de documento avulso finalizado com sucesso | 4. Processo de envio de documento avulso finalizado com sucesso | ||
+ | |||
5. Não há pastas/documentos avulsos pendentes de envio ao Protocolo Integrado. | 5. Não há pastas/documentos avulsos pendentes de envio ao Protocolo Integrado. | ||
+ | |||
6. Iniciando processamento de envio ao Protocolo Integrado. | 6. Iniciando processamento de envio ao Protocolo Integrado. | ||
+ | |||
7. Erro ao enviar lista de documentos: | 7. Erro ao enviar lista de documentos: | ||
+ | |||
8. Processo de envio de lista de documentos finalizado com sucesso. | 8. Processo de envio de lista de documentos finalizado com sucesso. | ||
+ | |||
9. Não foi possível atualizar a data do último envio das Pastas enviadas. | 9. Não foi possível atualizar a data do último envio das Pastas enviadas. | ||
+ | |||
10. O response retornado pelo webservice possui um formato não esperado. | 10. O response retornado pelo webservice possui um formato não esperado. | ||
+ | |||
11. Erro ao solicitar a quantidade máxima de documentos por requisição: | 11. Erro ao solicitar a quantidade máxima de documentos por requisição: | ||
+ | |||
12. Lote {indiceJob} de {totalJobs} praparado com {linhasAfetadas} pastas marcadas com o ticket: {ticket}. | 12. Lote {indiceJob} de {totalJobs} praparado com {linhasAfetadas} pastas marcadas com o ticket: {ticket}. | ||
+ | |||
13. Não foi possível atualizar o ticket do Job {indiceJob} de {totalJobs}. Erro: | 13. Não foi possível atualizar o ticket do Job {indiceJob} de {totalJobs}. Erro: | ||
+ | |||
14. Ao enviar um documento com sucesso registrar data e hora do envio. | 14. Ao enviar um documento com sucesso registrar data e hora do envio. | ||
Linha 59: | Linha 98: | ||
'''php bin/console sapiens:protocolo:envia-documento --id {id}''' | '''php bin/console sapiens:protocolo:envia-documento --id {id}''' | ||
+ | |||
o ID é parâmetro obrigatório | o ID é parâmetro obrigatório | ||
+ | |||
o ID refere-se a uma única pasta. Uma pasta pode conter um ou mais documentos. | o ID refere-se a uma única pasta. Uma pasta pode conter um ou mais documentos. | ||
Linha 73: | Linha 114: | ||
'''php bin/console sapiens:protocolo:envia-lista --percentual (0 - 100) --batch (numero)''' | '''php bin/console sapiens:protocolo:envia-lista --percentual (0 - 100) --batch (numero)''' | ||
− | o --percentual (0 - 100) | + | |
− | + | o --percentual (0 - 100) | |
− | + | ||
+ | o Percentual é parâmetro obrigatório. | ||
+ | |||
+ | o Refere-se ao % de documentos que serão enviados. O Padrão é 100%. | ||
Chamada com sucesso: | Chamada com sucesso: |
Edição atual tal como às 16h48min de 30 de julho de 2019
Essa funcionalidade permite enviar de forma automática as pastas dos documentos pendentes de envio através de comandos. A identificação dos documentos pendentes de envio se dá por um parâmetro do documento.
Índice |
Escopo
1. Ser um serviço no SAPIENS;
2. Permita ser executado por linha de comando, dessa forma poderá ser agendado em um servidor, rodando de forma assíncrona (segundo plano), não concorrendo com o processa-mento SAPIENS e não prejudicando a experiência do usuário;
3. Faça o envio de pastas de documentos SAPIENS de forma individual ou em lote através do Web Service Protocolo Integrado do Ministério do Planejamento (mais em: http://www.planejamento.gov.br/servicos/servicos-do-mp/protocolo-integrado);
4. Gere um Log de ações com mensagens de erro e sucesso.
Regras
Para enviar uma pasta ao Protocolo Integrado observar:
1. Somente pastas que não possuam ticket de protocolo serão enviadas (pendentes de envio);
2. A pasta não pode conter processo judicial;
3. A pasta não pode ter visibilidade restrita;
4. A pasta não pode ser sigilosa;
5. Se a pasta conter procedência, usar data/hora da produção para envio, caso contrário será usada a data de criação da pasta;
6. Se a pasta conter documento avulso, a espécie da pasta será Documento Avulso, caso contrário será Processo;
7. O assunto do documento será sempre o título da pasta;
8. Pegar o nome do interessado do documento e o número do identificador do interessado. Todo documento tem que ter um interessado, se não tiver emite mensagem de erro “Nenhum interessado encontrado” e não envia o documento;
9. O documento dentro de uma pasta tem que ter um volume, que é recuperado do histórico de juntada;
10. O parâmetro Protocolo é o NUP da pasta;
Integração
O serviço é integrado ao "Protocolo integrado" do Ministério do Planejamento. Dados dos documentos que são enviados nas pastas:
1. Protocolo
2. Data/hora de produção
3. Assunto
4. Lista de interessados
5. Espécie
6. Histórico
Parâmetros de entrada:
1. ID da pasta
Parâmetros de saída:
1. Ações registradas em log do item 2.1 deste documento.
Tabelas SAPIENS gravadas: PASTA
Tabelas SAPIENS lidas: PASTA, INTERESSADOS, JUNTADAS, VOLUMES
Log
Ações registradas em Log:
1. Falha na execução do comando. Erro: {erro}
2. Comando executado com sucesso.
3. Erro ao enviar documento avulso: {log}
4. Processo de envio de documento avulso finalizado com sucesso
5. Não há pastas/documentos avulsos pendentes de envio ao Protocolo Integrado.
6. Iniciando processamento de envio ao Protocolo Integrado.
7. Erro ao enviar lista de documentos:
8. Processo de envio de lista de documentos finalizado com sucesso.
9. Não foi possível atualizar a data do último envio das Pastas enviadas.
10. O response retornado pelo webservice possui um formato não esperado.
11. Erro ao solicitar a quantidade máxima de documentos por requisição:
12. Lote {indiceJob} de {totalJobs} praparado com {linhasAfetadas} pastas marcadas com o ticket: {ticket}.
13. Não foi possível atualizar o ticket do Job {indiceJob} de {totalJobs}. Erro:
14. Ao enviar um documento com sucesso registrar data e hora do envio.
Linha de comando
php bin/console sapiens:protocolo:envia-documento --id {id}
o ID é parâmetro obrigatório
o ID refere-se a uma única pasta. Uma pasta pode conter um ou mais documentos.
Chamada com sucesso:
Chamada com erro:
php bin/console sapiens:protocolo:envia-lista --percentual (0 - 100) --batch (numero)
o --percentual (0 - 100) o Percentual é parâmetro obrigatório.
o Refere-se ao % de documentos que serão enviados. O Padrão é 100%.
Chamada com sucesso:
Chamada com erro: