Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | pdp/pdapi513.p |
Objetivo
Esta API tem como objetivo Integração dos processos do portal de vendas para cliente com o workflow WF.APP no ECM.
Funcionamento
Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.
A execução na forma persistente é realizada através da chamada de um comando RUN conforme exemplo a seguir.
A sintaxe para executar a API em modo persistente é:
RUN pdp/pdapi513.p PERSISTENT SET h-handle. |
A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.
Nos atributos das tabelas temporárias de entrada e saída:
RowErrors | Entrada/Saída | ||||
Temp-Table de erros | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ErrorSequence | integer | Sequencia do Erro | |||
ErrorNumber | integer | Número do Erro | |||
ErrorDescription | character | Descrição do Erro | |||
ErrorParameters | character | Parâmetros do Erro | |||
ErrorType | character | Tipo do Erro | |||
ErrorHelp | character | Descrição da Ajuda do Erro | |||
ErrorSubType | character | Subtipo do Erro | |||
connectWebservice | ||
Requisito | Nenhum | |
Sintaxe | RUN connectWebservice IN handle (OUTPUT TABLE RowErrors). | |
Descrição | Conecta o WebService do ECM, deve ser chamado antes dos outros métodos desta API | |
Parâmetros | Descrição | |
RowErrors | Temp-table que reporta os problemas ocorridos no processo | |
Retorno | A API irá retornar a temp-table de erro | |
getOrderCardData | ||
Requisito | Nenhum | |
Sintaxe | RUN getOrderCardData IN handle (INPUT <character>, INPUT <character>, OUTPUT <longchar>). | |
Descrição | Retorna dados do pedido de venda informado | |
Parâmetros | Descrição | |
p-nr-pedcli | Indica o número do pedido do cliente do pedido de venda. | |
| p-nome-abrev | Indica o nome abreviado do pedido de venda |
| cardData | Retorna os dados do pedido de venda informado |
Retorno | A API irá retornar dados referente ao pedido informado | |
getOrderMotivoCardData | ||
Requisito | Nenhum | |
Sintaxe | RUN getOrderMotivoCardData IN handle (INPUT <character>, INPUT <character>, INPUT <character>, OUTPUT <longchar>). | |
Descrição | Retorna dados do pedido de venda informado | |
Parâmetros | Descrição | |
p-nr-pedcli | Indica o número do pedido do cliente | |
| p-nome-abrev | Indica o nome abreviado do cliente |
| p-motivo | Motivo do cancelamento |
| cardData | Retorna os dados do pedido de venda informado |
Retorno | A API irá retornar dados referente ao pedido informado | |
simpleStartProcess | ||
Requisito | Nenhum | |
Sintaxe | RUN simpleStartProcess IN handle (INPUT <character>, INPUT <character>, OUTPUT <character>, OUTPUT <logical> OUTPUT <logical>). | |
Descrição | Inicia uma nova instancia do workflow WF.APP no ECM | |
Parâmetros | Descrição | |
p-nr-pedcli | Indica o número do pedido do cliente | |
| p-nome-abrev | Indica o nome abreviado do cliente |
| p-nr-processo | Identifica o número do processo gerado no ECM |
| p-l-terminou | Indica que o processo terminou e não ficou pendente no ECM |
| p-l-aprovado | Indica que o processo terminou, sendo assim o mesmo fica como aprovado |
Retorno | Retorna o número do processo gerado no ECM e seu estado | |
setResponsibleUser | ||
Requisito | Nenhum | |
Sintaxe | RUN setResponsibleUser IN handle (INPUT <character>, INPUT <character>, OUTPUT <character>). | |
Descrição | Busca no ECM qual o usuário responsável pela aprovação do pedido de venda | |
Parâmetros | Descrição | |
p-nr-pedcli | Indica o número do pedido do cliente do pedido de venda. | |
| p-nome-abrev | Indica o nome abreviado do pedido de venda |
| pcUsuarioResponsavel | Retorna o usuário responsável pela aprovação |
Retorno | A API irá retornar o usuário responsável pela aprovação | |
saveAndSendTask | ||
Requisito | Nenhum | |
Sintaxe | RUN saveAndSendTask IN handle (INPUT <character>, INPUT <integer>, INPUT <character extent>, INPUT <character>, INPUT <character>, INPUT <character>, OUTPUT TABLE RowErrors). | |
Descrição | Movimenta o processo de aprovação no ECM | |
Parâmetros | Descrição | |
p-processo | Indica o tipo do processo: reprovação, aprovação, assumir ou transferir | |
| p-choosedState | Indica o código do estado destino do processo do workflow. |
| p-colleagueIds | Indica os usuários responsáveis pela próxima tarefa. |
| p-comments | Comentário relativo ao processo |
| p-nr-pedcli | Indica o número do pedido do cliente |
| p-nome-abrev | Indica o nome abreviado do cliente |
| RowErrors | Temp-table com os problemas ocorridos no processo |
Retorno | A API irá retornar caso existam, os erros ocorridos durante o processo | |
cancelInstance | ||
Requisito | Nenhum | |
Sintaxe | RUN cancelInstance IN handle (INPUT <character>, INPUT <character>). | |
Descrição | Cancela o processo de aprovação no ECM | |
Parâmetros | Descrição | |
p-nr-pedcli | Indica o número do pedido do cliente | |
| p-nome-abrev | Indica o nome abreviado do cliente |
Retorno | Nenhum | |
startCancelationProcess | ||
Requisito | Nenhum | |
Sintaxe | RUN startCancelationProcess IN handle (INPUT <character>, INPUT <character>, INPUT <character>). | |
Descrição | Inicia a solicitação de cancelamento do pedido de venda | |
Parâmetros | Descrição | |
p-nr-pedcli | Indica o número do pedido do cliente | |
| p-nome-abrev | Indica o nome abreviado do cliente |
| p-motivo | Indica o motivo de cancelamento do pedido de venda |
Retorno | Nenhum | |