Linha Datasul

Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicocrmrpw\apiCrmAgndntoPedExec.p

 

Objetivo

Agendamento RPW para programas do CRM.

 

Tabelas Temporárias

Atributos das tabelas temporárias de entrada e saída:

tt-paramCarga

 

Atributo

Tipo

Formato

        Descrição

Obr.

destino

Char

 

Destino

Sim

Arquivo

Char

 

Arquivo

Sim

Usuario

char

 

Usuário

Sim

data-exec

Date

 

Data execução

Sim

hora-exec

Char

 

Hora execução

Sim

progRp

Char

 

Programa rp

Sim

Programa

Char

 

Programa cadastrado no menu

Sim

Versao

char

 

Versão

 

l-estabel

Log

 

Executar carga estabelecimento

 

l-calend

Log

 

Executar carga calendário

 

l-moeda

Log

 

Executar carga moeda

 

l-natur

Log

 

Executar carga natureza

 

l-regiao

Log

 

Executar carga região

 

l-portador

Log

 

Executar carga portador

 

l-condpagto

Log

 

Executar carga condição pagamento

 

l-repres

Log

 

Executar carga representante

 

l-unidmedid

Log

 

Executar carga unidade medida

 

l-grpclien

Log

 

Executar carga grupo cliente

 

l-clienteprod

Log

 

Executar carga itens do cliente

 

l-produto

Log

 

Executar carga produto

 

l-tabpreco

Log

 

Executar carga tabela de preço

 

l-transp

Log

 

Executar carga transportadora

 

l-conta

log

 

Executar carga cliente

 

crm-codFimProduto

char

 

Código produto

 

crm-codIniProduto

Char

 

Código produto

 

crm-codFimTabPreco

Char

 

Código tabela de preço

 

crm-codIniTabPreco

Char

 

Código tabela de preço

 

crm-codFimClienteProd

Char

 

Itens do cliente

 

crm-codIniClienteProd

Char

 

Itens do cliente

 

crm-nomeAbrevFimClienteProd

Char

 

Nome abreviado

 

crm-nomeAbrevIniClienteProd

Char

 

Nome abreviado

 

crm-naturezaClienteProd

Char

 

Natureza cliente

 

crm-codFimConta

Char

 

Código conta

 

crm-codIniConta

Char

 

Código conta

 

crm-nomeAbrevFimConta

Char

 

Nome abreviado

 

crm-nomeAbrevIniConta

Char

 

Nome abreviado

 

crm-naturezaConta

Char

 

Natureza

 

crm-anoMoeda

Char

 

Ano moeda

 

crm-mesMoeda

Char

 

Mês Moeda

 

crm-codIniMoeda

Char

 

Código moeda

 

crm-codFimMoeda

Char

 

Código moeda

 

crm-ltodos

Char

 

Todos os processos?

 

crm-codEstab

Char

 

Código estabelecimento

 

crm-ano

char

 

ano

 

tt-param

 

Atributo

Tipo

Formato

        Descrição

Obr.

destino

Char

 

Destino

Sim

Arquivo

Char

 

Arquivo

Sim

Usuario

char

 

Usuário

Sim

data-exec

Date

 

Data execução

Sim

hora-exec

Char

 

Hora execução

Sim

progRp

Char

 

Programa rp

Sim

Programa

Char

 

Programa cadastrado no menu

Sim

Versao

char

 

Versão

 

Publico

Int

 

Id do publico

 

Contas

Int

 

Id da conta

 

Todos

Log

 

Todas as contas?

 

tt-paramEtiq

 

Atributo

Tipo

Formato

        Descrição

Obr.

destino

Char

 

Destino

Sim

Arquivo

Char

 

Arquivo

Sim

Usuario

char

 

Usuário

Sim

data-exec

Date

 

Data execução

Sim

hora-exec

Char

 

Hora execução

Sim

progRp

Char

 

Programa rp

Sim

Programa

Char

 

Programa cadastrado no menu

Sim

Versao

char

 

Versão

 

Publico

Int

 

Id do publico

 

Layout

Int

 

Id da layout

 

 

A api faz uso da include padrão {method/dbofun.i}

 

Métodos

 

Métodos básicos

 

Método: setContas

Descrição: método utilizado para atualizar os parâmetros referentes as contas.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

crm-codFimConta

Char

 

X

 

 

Código conta

crm-codIniConta

Char

 

X

 

 

Código conta

crm-nomeAbrevFimConta

Char

 

X

 

 

Nome abreviado

crm-nomeAbrevIniConta

Char

 

X

 

 

Nome abreviado

crm-naturezaConta

Char

 

X

 

 

Natureza conta

 

Método: setProduto 

Descrição: método utilizado para atualizar os parâmetros referentes aos produtos.

Requisitos: Nenhum

Parâme Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

crm-codFimProduto

Char

 

X

 

 

Código do produto

crm-codIniProduto

Char

 

X

 

 

Código do produto

 

Método: setTabPreco 

Descrição: método utilizado para atualizar os parâmetros referentes a tabela de preço.

Requisitos: Nenhum

Parâme Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

crm-codFimTabPreco

Char

 

X

 

 

Código tabela de preço

crm-codIniTabPreco

Char

 

X

 

 

Código tabela de preço

 

Método: setProdClien

Descrição: método utilizado para atualizar os parâmetros referentes a itens do cliente.

Requisitos: Nenhum

Parâme Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

crm-codFimClienteProd

Char

 

X

 

 

Código itens do cliente

crm-codIniClienteProd

Char

 

X

 

 

Código itens do cliente

crm-nomeAbrevFimClienteProd

Char

 

X

 

 

Nome abreviado

crm-nomeAbrevIniClienteProd

Char

 

X

 

 

Nome abreviado

crm-naturezaClienteProd

Char

 

X

 

 

Natureza conta

 

Método: setTransClass

Descrição: método utilizado para atualizar os parâmetros referentes ao processo de transição de classe.

Requisitos: Nenhum

Parâme Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pConta

Char

 

X

 

 

Código conta

pPublico

Char

 

X

 

 

Código publico

pTodos

Log

 

X

 

 

Todas as contas?

 

Método: setSendMail

Descrição: método utilizado para atualizar os parâmetros referentes ao processo de envio de email.

Requisitos: Nenhum 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pLayout

Char

 

X

 

 

Código Layout

pValueProcess

Int

 

X

 

 

Código Rotina

pAssunto

Char

 

X

 

 

Assunto do email

 

Método: setEtiqueta

Descrição: método utilizado para atualizar os parâmetros referentes ao processo de geração de etiquetas.

Requisitos: Nenhum 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pLayout

Char

 

X

 

 

Código layout

pPublico

Char

 

X

 

 

Código publico

 

Método: EnviarParam

Descrição: Método que faz a chamada e encaminha os parâmetros de RPW. 

Requisitos: Nenhum

 Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

cArquivo

char

 

x

 

 

arquivo

cProgram

Char

 

X

 

 

programa

iCodeTable

Log

 

x

 

 

Código tabela

cArquivoRP

Char

 

X

 

 

Arquivo rp

cDataExec

Char

 

X

 

 

Data execução

cHoraExec

Char

 

X

 

 

Hora execução

raw-param

Raw

 

X

 

 

Raw da ttparam

RowErrors

Tt

 

 

X

 

Retorna os erros do processo

 

Método: agendarPedExec

Descrição: Método criação da ttparam e agendamento do pedido.        

Requisitos: Nenhum 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

iPeriodico

char

 

x

 

 

arquivo

cDataExec

Char

 

X

 

 

Data execução

cHoraExec

Char

 

X

 

 

Hora execução

cDataLimite

Char

 

X

 

 

Data limite execução

cProgram

Char

 

X

 

 

Programa

cProgRP

Char

 

X

 

 

Programa rp

cArquivo

Char

 

X

 

 

Arquivo

RowErrors

Tt

 

 

X

 

Retorna os erros do processo

 

Método: CalculeDateExecute

Descrição: Método utilizado para calcular as datas em que deverão ser agendados os pedidos de execução.       

 

Requisitos: Nenhum 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

iPeriodico

Int

 

x

 

 

Opção periódico

dtExec

Date

 

X

 

 

Data execução

dtControle

Date

 

X

 

 

Data controle

 

Método: returnDatHorIncial

Descrição: Método para buscar a data e hora atual.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

cData

char

 

 

x

 

Data atual

cHora

char

 

 

x

 

Hora atual