Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | fch/fchdis/fchdis0029rp.p |
Considerações Gerais
Objetivo
Receber os parâmetros que foram salvos no pedido de execução e iniciar o processo de monitoração de contas do CRM.
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 sintaxe para a chamada da API é:
run fch/fchdis/fchdis0029.p (INPUT raw-param, INPUT table tt-raw-digita). |
A sintaxe para executar a API em modo persistente é:
run fch/fchdis/fchdis0029.p persistent set h-handle (INPUT raw-param, INPUT table tt-raw-digita). |
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:
ttParam1 | Entrada/Saída | ||||
Parâmetros RPW. | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
opcao | Int | - | Opção filtro conta. | - | - |
ltabelBasic | Log | - | Tabelas básicas? | - | - |
lInfoPedEnv | log | - | Enviar Info Pedido? | - | - |
lInfoPedReceb | log | - | Receber Info Pedido? | - | - |
lTitCta | Log | - | Enviar Titulos Conta? | - | - |
iPeriodico | int | - | Periódico. | - | - |
disProces | Char | - | Processo. | - | - |
dtExec | Char | - | Data execução. | - | - |
dtLimit | char | - | Data limite. | - | - |
cHoraExec | Char | - | Hora execução. | - | - |
dtAux | Char | - | Data auxiliar. | - | - |
lAgenda | log | - | Possuí agenda de execução? | - | - |
destino | Int | - | Tipo destino. | - | - |
arquivo | Char | - | Arquivo. | - | - |
usuario | Char | - | Usuário. | - | - |
progRp | Char | - | Programa rp. | - | - |
programa | Char | - | Programa. | - | - |
versao | char | - | Versão. | - | - |
ttParam | Entrada/Saída | ||||
Parâmetros RPW. | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
opcao | Int | - | Opção filtro conta. | - | - |
ltabelBasic | Log | - | Tabelas básicas? | - | - |
lInfoPedEnv | log | - | Enviar Info Pedido? | - | - |
lInfoPedReceb | log | - | Receber Info Pedido? | - | - |
lTitCta | Log | - | Enviar Titulos Conta? | - | - |
iPeriodico | int | - | Periódico. | - | - |
disProces | Char | - | Processo. | - | - |
dtExec | Char | - | Data execução. | - | - |
dtLimit | char | - | Data limite. | - | - |
cHoraExec | Char | - | Hora execução. | - | - |
dtAux | Char | - | Data auxiliar. | - | - |
lAgenda | log | - | Possuí agenda de execução? | - | - |
destino | Int | - | Tipo destino. | - | - |
arquivo | Char | - | Arquivo. | - | - |
usuario | Char | - | Usuário. | - | - |
progRp | Char | - | Programa rp. | - | - |
programa | Char | - | Programa. | - | - |
versao | char | - | Versão. | - | - |
rttRepresTarget | Raw | - | Filtro representante. | - | - |
rttEstabTarget | Raw | - | Filtro estabelecimento. | - | - |
rttTabPrecoTarget | Raw | - | Filtro tabela de preço. | - | - |
rttCondPagtoTarget | raw | - | Filtro condição de pagamento. | - | - |
ttRepresSource | Entrada/Saída | ||||
Representantes disponíveis no filtro. | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
codigo | char | - | Código. | Sim | - |
nivAces | char | - | Nivel acesso. | Sim | - |
descr | char | - | Nome. | Sim | - |
ttRepresTarget | Entrada/Saída | ||||
Representantes disponíveis no filtro. | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
codigo | char | - | Código. | Sim | - |
nivAces | char | - | Nivel acesso. | Sim | - |
descr | char | - | Nome. | Sim | - |
ttEstabSource | Entrada/Saída | ||||
Estabelecimentos disponíveis no filtro. | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
codigo | char | - | Código. | Sim | - |
descr | char | - | Nome. | Sim | - |
ttEstabTarget | Entrada/Saída | ||||
Estabelecimentos selecionados no filtro. | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
codigo | char | - | Código. | Sim | - |
descr | char | - | Nome. | Sim | - |
ttTabPrecoSource | Entrada/Saída | ||||
Tabelas de Preço disponíveis no filtro. | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
codigo | char | - | Código. | Sim | - |
descr | char | - | Nome. | Sim | - |
ttTabPrecoTarget | Entrada/Saída | ||||
Tabelas de preços selecionadas no filtro. | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
codigo | char | - | Código. | Sim | - |
descr | char | - | Nome. | Sim | - |
ttCondPagtoSource | Entrada/Saída | ||||
Condições de pagamento disponíveis no filtro. | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
codigo | char | - | Código. | Sim | - |
descr | char | - | Nome. | Sim | - |
tt-cta_usuar | Entrada/Saída | ||||
Contas regra de time. | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cod_pessoa_erp | char | - | Código conta erp. | Sim | - |
num_id_pessoa | int | - | Código conta crm. | Sim | - |
tt-canal_cliente | Entrada/Saída | ||||
Canal cliente. | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cod_canal_cliente | char | - | Canal cliente. | Sim | - |
ttUsuar | Entrada/Saída | ||||
Dados do usuário. | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cod_usuario | char | - | Código usuário. | Sim | - |
idi_niv_acess | int | - | Nível de acesso. | Sim | - |
tt-raw-digita | Entrada/Saída | ||||
Digita. | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
raw-digita | raw | - | Parâmetros digita (não utilizado). | Não | - |
Método Básico
Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
piCallUpsertAdapterPaymentCondition | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Efetuar chamada para o adapter de integração com a Softsite (condição de pagamento). | |
Parâmetros | Descrição | |
Não contém. | - | |
Retorno | - | |
piCallUpsertAdapterItem | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Efetuar chamada para o adapter de integração com a Softsite (Produto). | |
Parâmetros | Descrição | |
Não contém. | - | |
Retorno | - | |
piCallUpsertAdapterCustomerVendor | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Efetuar chamada para o adapter de integração com a Softsite (cliente/vendedor). | |
Parâmetros | Descrição | |
iOpcao | Opção de filtro (regra de time,responsável, canal cliente). | |
Retorno | - | |
piCallUpsertAdapterCommercialFamily | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Efetuar chamada para o adapter de integração com a Softsite (família comercial). | |
Parâmetros | Descrição | |
Não contém. | - | |
Retorno | - | |
piCallUpsertAdapterSeller | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Efetuar chamada para o adapter de integração com a Softsite (vendedor). | |
Parâmetros | Descrição | |
Não contém. | - | |
Retorno | - | |
piCallUpsertAdapterCarrier | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Efetuar chamada para o adapter de integração com a Softsite (portador). | |
Parâmetros | Descrição | |
Não contém. | - | |
Retorno | - | |
piCallUpsertAdapterPriceListHeaderItem | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Efetuar chamada para o adapter de integração com a Softsite (tabela de preço). | |
Parâmetros | Descrição | |
Não contém. | - | |
Retorno | - | |
iCallUpsertAdapterUnitOfMeasure | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Efetuar chamada para o adapter de integração com a Softsite (unidade de medida). | |
Parâmetros | Descrição | |
Não contém. | - | |
Retorno | - | |
piCallUpsertAdapterUnitOfMeasureConversion | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Efetuar chamada para o adapter de integração com a Softsite (tabela de conversão unidade de medida). | |
Parâmetros | Descrição | |
Não contém. | - | |
Retorno | - | |
piCallUpsertAdapterAccountReceivableDocument | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Efetuar chamada para o adapter de integração com a Softsite (títulos do cliente). | |
Parâmetros | Descrição | |
Não contém. | - | |
Retorno | - | |
piCallUpsertAdapterEstablishment | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Efetuar chamada para o adapter de integração com a Softsite (estabelecimento). | |
Parâmetros | Descrição | |
Não contém. | - | |
Retorno | - | |
piCallUpsertAdapterReference | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Efetuar chamada para o adapter de integração com a Softsite (referência). | |
Parâmetros | Descrição | |
ttParamMonitorMovCta | Parametrização para monitoração. | |
RowErrors | Erros. | |
Retorno | RowErrors. | |
piCallUpsertAdapterItemReference | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Efetuar chamada para o adapter de integração com a Softsite (produto x referência). | |
Parâmetros | Descrição | |
Não contém. | - | |
Retorno | - | |
piCallUpsertAdapterCustumerEstablishment | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Efetuar chamada para o adapter de integração com a Softsite (cliente x estabelecimento). | |
Parâmetros | Descrição | |
Não contém. | - | |
Retorno | - | |
piCallUpsertAdapterRoute | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Efetuar chamada para o adapter de integração com a Softsite (rota). | |
Parâmetros | Descrição | |
Não contém. | - | |
Retorno | - | |
piCallUpsertAdapterOrder | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Efetuar chamada para o adapter de integração com a Softsite (enviar pedido de venda). | |
Parâmetros | Descrição | |
Não contém. | - | |
Retorno | - | |
piCallUpsertAdapterOrderReceiver | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Efetuar chamada para o adapter de integração com a Softsite (receber pedido de venda). | |
Parâmetros | Descrição | |
Não contém. | - | |
Retorno | - | |
returnUsers | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Retorna os usuários equivalentes aos representates selecionados no filtro. | |
Parâmetros | Descrição | |
ttRepresTarget | Representantes selecionados no filtro. | |
| ttUsuar | Usuários equivalentes ao representante. |
Retorno | ttUsuar (saida). | |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas