Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

crmapi/apiCrmRegistroAcaoAuto.p

 

Considerações Gerais

 

Objetivo

Filtrar os resultados e mídias com base na ação da campanha.

 

Funcionamento

A API possibilita tratamento e validação da regra de negócio. 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/BO é:

run crmapi/apiCrmRegistroAcaoAuto.p

 

A execução na forma persistente ...

A sintaxe para executar a API/BO em modo persistente é:

run crmapi/apiCrmRegistroAcaoAuto.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: 

ttrestdo

Entrada/Saída

Tabela temporária usada para armazenar os resultados encontrados para ação da campanha.

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

num_id_campanha_acao

Int

99999999

Identificador da campanha

Sim

-

num_id_restdo

Int

99999999

Identificador do resultado

Sim

-

ttmidia

Entrada/Saída

Tabela temporária usada para armazenar os resultados encontrados para ação da campanha.

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

num_id_campanha_acao

Int

99999999

Identificador da campanha

Sim

-

num_id_midia

Int

99999999

Identificador da mídia

Sim

-

 

Método Negócio

 

filterCampAcao

Requisito

-

Sintaxe

Run filterCampAcao in h-handle(input numIdCampanhaAcao,

                               output table ttmidia,

                               output table ttrestdo).

Descrição

Adiciona no log de conversão o registro que foi removido, de acordo com o processo.

Parâmetros

Descrição

numIdCampanhaAcao

Código da ação da campanha

Ttmidia

Mídias

Ttrestdo

Resultados

Retorno

Retorna os resultados e as mídias pertencentes a ação da campanha. Os  Erros serão tratados na  temp-table RowErrors.