Header Web
Logo_PHC_Software
Manuais
Comunicação de Documentos com SaphetyDoc via Webservice no PHC CS Desktop

No PHC CS Desktop, passa a ser possível comunicar documentos eletrónicos em xml padrão através da Saphety, via Webservice SaphetyDoc.
Esta nova opção substitui a comunicação via ficheiros com SaphetyBox.

 

Para passar a comunicar documentos de faturação via SaphetyDoc é necessário:
1 – Preencher os parâmetros SaphetyDoc webservice: Username, Password e URL;
2 – Preencher os parâmetros Digital Sign: Utiliza Certificado, ID do Autorizador, Obter Autorização de Comunicação e Secret;
3 – Preencher a plataforma EDI na ficha de cliente com SaphetyDoc;
4 – Na série do documento de faturação:
a) Ativar a opção Inclui Formato XML Padrão PHC;
b) Preencher o valor da versão na opção Versão do Formato XML Padrão PHC;
c) Selecionar Certificado Digital Sign na opção "Tipo de Certificado a assinar digitalmente".

 

Para passar a receber encomendas via SaphetyDoc é necessário:
1 – Preencher os parâmetros SaphetyDoc webservice: Username, Password e URL;
2 – Preencher os parâmetros Digital Sign: Utiliza Certificado, ID do Autorizador, Obter Autorização de Comunicação e Secret;
3 – Ativar o parâmetro Utiliza receção e envio de documentos via XML;
4 – No ecrã de Documentos XML:
a) Configurar um documento do tipo XML Padrão;
b) Ativar o Método de Receção por Webservice;
5 – Na série de dossier interno:
a) Ativar a opção Série para documentos importados;
b) Selecionar o documento xml, que foi configurado no ecrã "Documentos XML", na opção Documento XML;
c) Preencher a opção Descritivo principal do dossier com um texto identificativo (por exemplo: SaphetyDoc).

 

De seguida, vamos explicar detalhadamente como se processa a configuração e comunicação de documentos, conforme preferências de utilização:

 

1. Condições



Apenas é possível efetuar a comunicação se estiverem reunidas as seguintes condições:

  • PHC ON ativo;
  • Módulos PHC CS Gestão, PHC CS Assinaturas Qualificadas, PHC CS Documentos Eletrónicos e PHC CS EDI Broker;
  • Geografia de Portugal;
  • Todas as gamas;
  • Ter saldo de Assinaturas Qualificadas Digital Sign (parceria atual);
  • Parâmetro geral "Utiliza Certificado - Digital Sign" ativo
  • Parâmetros "Digital Sign": ID do Autorizador, Obter Autorização de Comunicação e Secret preenchidos;
  • Parâmetro geral "Utiliza Documento Eletrónico" ativo.
Informação
O Módulo PHC CS EDI Broker está disponível a partir da gama Corporate.
 

 

2. Configurações



2.1 - No ecrã de Parâmetros do Software (menu Sistema > Parâmetros > nó Documento Eletrónico) deve preencher os três parâmetros:

  • SaphetyDoc webservice: Username - fornecido pela Saphety
  • SaphetyDoc webservice: Password - fornecido pela Saphety
  • SaphetyDoc webservice: URL - por defeito o parâmetro URL está preenchido com o URL de produção “https://wsrest.netdocs.com.pt/TradeHttp/MessageServiceRest”
Notas
As credenciais para o webservice da SaphetyDoc são diferentes das credenciais de acesso ao portal da SaphetyDoc (ao contrário do que ocorre com a Saphety SIN).

 

2.2 - No ecrã de Clientes (menu Gestão > Gestão de Clientes > separador Informação) e na ficha do cliente deve preencher:

  • O campo Plataforma EDI com o valor SaphetyDoc.

 

2.3 - No ecrã de Configuração de Documentos de Faturação (menu Tabelas > Gestão > Configurar Documentos de Faturação), a série deve ter as seguintes configurações:

  • Opção "Inclui Formato XML Padrão PHC" ativa;
  • Opção "Versão do Formato XML Padrão PHC" preenchida com o valor da versão;
  • Opção "Tipo de Certificado a assinar digitalmente" preenchida com o valor "Certificado Digital Sign";
  • Se pretender comunicar via Doc. Eletrónico, deve ter a opção "Documento para assinar digitalmente" preenchida com o valor "Documento XML" ou com o valor "Documento PDF" (e neste caso é necessário ativar a opção "Inclui documento PDF");
    • Ao ativar a opção 'Inclui documento PDF', o PDF é enviado embebido no ficheiro XML;
  • Se pretender comunicar automaticamente, via EDI ou via Doc. Eletrónico, ao gravar o documento, deve preencher a opção "Ao gravar comunica o documento eletrónico via webservice" com o valor "Sim" ou "Sim e anexa".
Notas
 
- Por defeito, a opção "Ao gravar comunica o documento eletrónico via webservice" tem o valor "Não" e, neste caso, é necessário o utilizador realizar a comunicação manualmente;
- O valor "Sim e anexa" só está disponível com o módulo PHC CS Documentos e para utilizar é necessário configurar:
a) a série de faturação para ter anexos (menu Tabelas > Documentos > Tabelas com Anexos);
b) a pasta onde o anexo será guardado no PHC (menu Tabelas > Documentos > Pasta de Anexos);
c) na configuração da série deve ser definida a pasta onde o anexo será guardado no PHC.


2.4 - Outras configurações para comunicação:

  • Nos parâmetros do sistema deve estar preenchido o Código EAN da própria empresa; 
  • Na ficha do cliente, devem estar preenchidos os campos: Código EAN, Nº de fornecedor do Cliente e Morada;
  • Na ficha da empresa, devem estar preenchidos os campos: Nome completo, Morada, Código postal, NIF, Registo comercial e Capital social.

 

3. Comunicação de documentos


 

3.1 - Comunicação via Doc. Eletrónico de forma manual, no ecrã de Faturação

- Aceder ao ecrã de Faturação (menu Gestão);
- Escolher a série com a opção "Ao gravar comunica o documento eletrónico via webservice" preenchida com o valor "Não";
- Emitir um novo documento e clicar no botão "Gravar";
- Clicar no botão "Doc. Eletrónico" (se este botão não estiver disponível, pode usar o botão "Enviar EDI" ou consultar a "Informação" no ponto 4 deste documento);
- É apresentado o texto "A comunicar documento à SaphetyDoc..." e a comunicação é efetuada:
a) Se a comunicação foi efetuada com sucesso, então será apresentada a mensagem "Foi produzido e enviado o Documento de Faturação «XPTO, nºN de DD.MM.AAAA». Consulte o resultado da comunicação nas Opções Diversas deste documento."
b) Se a comunicação não foi efetuada com sucesso, então será apresentada a mensagem "Ocorreu um erro ao produzir e enviar o documento de faturação «XPTO, nºN de DD.MM.AAAA». Consulte o resultado da comunicação nas Opções Diversas deste documento."

Após a comunicação de um documento via SaphetyDoc, este passa para o estado "Em processamento" e ficam disponíveis as seguintes opções diversas:


 

- Resultado da comunicação de documentos eletrónicos - permite visualizar o histórico de comunicações/atualizações de estado do documento;

Notas
 
a) Na grelha são apresentados 5 campos: Plataforma; Estado; Descrição; Data e Hora;
b) Só é adicionado um novo registo ao resultado da comunicação, se o estado obtido da Saphety for diferente do estado atual do documento no PHC;
c) Se o estado for igual, apenas atualiza os dados referentes à DATA e HORA do estado atual (o último estado obtido no resultado da comunicação);
d) Quando o estado do documento é "Em processamento", é adicionado o MessageID. Este código pode ser pedido pela Saphety ao cliente para verificar ou esclarecer alguma dúvida;
e) No caso de ocorrer algum erro de comunicação com o servidor da Saphety ou algum erro de configuração, se o documento já tiver um estado associado, então esse estado mantém-se, mas é adicionada uma descrição no resultado da comunicação.

 

- Dar documento eletrónico como finalizado manualmente - significa que este documento é fechado manualmente, sem ter que aguardar atualizações por parte da Saphety (Estado: "Fechado manualmente").

Informação
 
Passamos a ter um ícone que representa a comunicação via SaphetyDoc. Este é composto por cores que correspondem ao estado da comunicação. A descrição destas cores encontra-se no Monitor de Comunicação de Documentos Eletrónicos.

 

3.2 - Comunicação via Doc. Eletrónico de forma manual, no ecrã de Emissão Automática de Documentos Eletrónicos

- Aceder ao ecrã de Faturação (menu Gestão);
- Escolher a série com a opção "Ao gravar comunica o documento eletrónico via webservice" preenchida com o valor "Não";
- Emitir um novo documento e clicar no botão "Gravar";
- Aceder ao ecrã de "Emissão Automática de Documentos Eletrónicos" (menu Gestão > Outras opções de clientes), selecionar a série pretendida, escolher um das opções de "Comunicação com Broker" e clicar em "Preparar" e em "Emitir";
- É apresentado o texto "A produzir os Documentos Eletrónicos…" e de seguida uma lista de documentos comunicados;
- É possível consultar o resultado na opção diversa do ecrã de Faturação.

 

3.3 - Comunicação via Doc. Eletrónico de forma automática, no ecrã de Faturação

- Aceder ao ecrã de Faturação (menu Gestão);
- Escolher a série com a opção "Ao gravar comunica o documento eletrónico via webservice" preenchida com o valor "Sim" ou "Sim e anexa";
- Emitir um novo documento e clicar no botão "Gravar";
- É apresentado o texto "A comunicar documento à SaphetyDoc..." e a comunicação é efetuada.

 

4. Monitor de Comunicação de Documentos Eletrónicos



É no Monitor de Comunicação de Documentos Eletrónicos (menu Supervisor > separador Documentos de Faturação SaphetyDoc ou Menu Gestão > Faturação a Clientes > clique no ícone da SaphetyDoc), que é possível enviar documentos que ainda não tenham sido comunicados, atualizar os estados dos documentos ou finalizá-los manualmente.


Este monitor permite:

  • Efetuar diferentes tipos de filtros aos documentos de faturação apresentados;
  • Visualizar os documentos que não estejam num estado final;
  • Comunicar um ou vários documentos via webservice;
  • Atualizar o estado de todos os documentos;
  • Finalizar/fechar manualmente um ou vários documentos;
  • Visualizar os vários estados possíveis dos documentos, com a descrição das cores;
  • Marcar ou desmarcar todos os documentos;
  • Imprimir ou pré-visualizar uma listagem de documentos de faturação.

 

4.1 - Ao clicar em Finalizar já com documentos selecionados, é apresentada uma barra de carregamento até o processo terminar. No fim do processo, é apresentada uma lista (browlist) com o resultado da atualização dos estados;

4.2 - Ao clicar em Enviar já com documentos selecionados, é apresentada uma barra de carregamento até o processo terminar. No fim do processo, é apresentada uma lista (browlist) com o resultado da comunicação;

4.3 - Ao clicar em Atualizar estados dos documentos, são apresentadas várias mensagens de atualização até o processo terminar;

4.4 - Ao clicar no ícone SaphetyDoc, abre o ecrã de faturação e o resultado da comunicação do respetivo documento;

4.5 - Com duplo-clique nos campos das colunas referentes ao documento de faturação, é aberto o ecrã de faturação com o respetivo documento em modo de consulta;

4.6 - Com duplo-clique nos campos das colunas referentes ao cliente, é aberto o ecrã de clientes com os dados do respetivo cliente em modo de consulta;

4.7 - Ao clicar no botão "i" junto à grelha, é aberto um ecrã com informações sobre o monitor, tal como a informação relativa aos vários estados possíveis na comunicação dos documentos.

 

Informação

Se pretender realizar a comunicação via EDI pode fazer pelos seguintes meios:  
1 – de forma automática ao gravar, no ecrã de faturação, caso a respetiva série tenha a opção "Ao gravar comunica o documento eletrónico via webservice" configurada com o valor "Sim" ou "Sim e anexa"; 
2 - de forma manual através do botão "Enviar EDI", no ecrã de Faturação, caso a respetiva série tenha a opção "Ao gravar comunica o documento eletrónico via webservice" configurada com o valor "Não"; 
3 - de forma manual, no ecrã "Integração com EDI"; 
4 - de forma manual através do módulo Servidor (gama Enterprise), através das configurações definidas no ecrã "Integração com EDI". 

 

5. Receção de Encomendas via SaphetyDoc


Para utilizar o método de receção de documentos por Webservice via SaphetyDoc, é necessário proceder a algumas configurações para importação de encomendas:

5.1 - No ecrã de Parâmetros do Software (Menu Sistema > Parâmetros > nó Documento Eletrónico) deve preencher os três parâmetros:

  • SaphetyDoc webservice: Username - fornecido pela Saphety
  • SaphetyDoc webservice: Password - fornecido pela Saphety
  • SaphetyDoc webservice: URL - por defeito, o parâmetro URL está preenchido com o URL de produção https://wsrest.netdocs.com.pt/TradeHttp/MessageServiceRest

     

5.2 - No ecrã de Parâmetros do Software (menu Sistema > Parâmetros > nó Dossiers Internos) deve ativar o parâmetro Utiliza receção e envio de documentos via XML;

5.3 - No ecrã Documentos XML (menu Tabelas > Supervisor > Configurações Documentos XML) deve configurar um documento xml para receber encomendas XML Padrão com as seguintes definições:

No separador "Dados principais":
- Campo "Tipo de XML" com o valor "XML Padrão";
- Opção "Webservice" ativa no "Método de Receção";
- Campo "Diretoria" com o caminho para a importação do xml.

No separador "XML campos" > "Opções para importação de Dossiers internos":
- Campo "Código do Documento" com o valor "220" (exemplo para o elemento coddoc do documento xml a importar);
- Campo "Nº Interno do Dossier" com o valor referente ao tipo de dossier interno para onde será importado o xml;
- Campo "Código do Documento de Referência" com o valor "5" (exemplo para o elemento refnumdoc que existe no elemento LinhaReferencias, relativo ao tipo de documento que está na origem do dossier a ser importado).

5.4 - No ecrã Configuração de Dossiers Internos (menu Tabelas > Gestão > Configurar Dossiers Internos) a série deve ter as seguintes configurações:
- Opção "Série para documentos importados" ativa;
- Opção "Documento XML" com o valor do documento xml que foi configurado no ecrã "Documentos XML";
- Opção "Descritivo principal do dossier" com um texto identificativo (por exemplo: SaphetyDoc).

 

É possível efetuar a importação de dossiers internos (encomendas) através de:
a) Opção diversa Receber documentos via XML do ecrã "Dossiers internos";
b) Botão Importar do ecrã "Documentos XML" posicionado no documento XML configurado com webservice;
c) Alerta do utilizador configurado com a reação "Receber ficheiros xml" e preenchido com o "Documento de XML" que foi configurado com a opção webservice, para importação no módulo servidor.

 

Ao efetuar a importação de um documento com sucesso, este passa para o estado "Recebido" e fica disponível a opção diversa Resultado da comunicação de documentos eletrónicos no ecrã "Dossiers Internos" que permite visualizar o estado do documento importado.

Notas
O ficheiro importado na diretoria definida no documento XML passa a ter a extensão ".lido" para diferenciar dos ficheiros que ainda não foram lidos.