Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | crmapi/apiCrmIntegrTarEcm03.p |
Considerações Gerais
Objetivo
Enviar para o ECM e anexar no workflow o anexo da tarefa.
Funcionamento
A API/BO...
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 sintaxe para a chamada da API é:
run crmapi/apiCrmIntegrTarEcm03.p. |
A sintaxe para executar a API em modo persistente é:
run crmapi/apiCrmIntegrTarEcm03.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.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
RowErrors | Entrada/Saída | ||||
Tabela de Erros | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ErrorSequence | Int |
| Sequência |
|
|
ErrorNumber | Int |
| Número |
|
|
ErrorDescription | Char |
| Descrição |
|
|
ErrorParameters | Char |
| Parâmetros |
|
|
ErrorType | Char |
| Tipo |
|
|
ErrorHelp | Char |
| Ajuda |
|
|
ErrorSubType | Char |
| Sub Tipo |
|
|
Método Básico
Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
sendAttach | ||
Requisito |
| |
Sintaxe |
| |
Descrição | Método principal usado para conectar o servidor ECM e enviar o anexo. | |
Parâmetros | Descrição | |
pNumIdTar | Id tarefa | |
| pNumIdAnexo | Id anexo |
| RowErrors | Erros |
Retorno | Out/RowErrors |
setAttach | ||
Requisito |
| |
Sintaxe |
| |
Descrição | Seta os dados necessários que serão passados como parâmetro para anexar o arquivo no workflow. | |
Parâmetros | Descrição | |
pAttach | Anexo e demais parametros | |
Retorno | Out/pAttach – char contendos os dados necessários para a adicionar o anexo no ECM, separado em tags. |
returnParamStartProcess | ||
Requisito |
| |
Sintaxe |
| |
Descrição | Seta os parâmetros necessários para acesso e conexão com o ECM. | |
Parâmetros | Descrição | |
|
| |
Retorno |
|