Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicocrmrpw\apiChooseProcessRPW.p

 

Objetivo: Agendamento RPW para programas do CRM.


Tabelas Temporárias:

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

Métodos

Métodos básicos

Método: chooseConta

Descrição: método principal para agendamento do programa de carga ERP EMS para o CRM – processo contas.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

iPeriodico

Int

 

x

 

 

Opção período de execução

cDataExec

Char

 

X

 

 

Data execução pedido

cHoraExec

Char

 

X

 

 

Hora execução pedido

cDataLimite

Char

 

X

 

 

Data limite execução pedido

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

RowErrors

Tt

 

 

X

 

Erros relacionado ao processo

 

Método: chooseProduto

Descrição: método principal para agendamento do programa de carga ERP EMS para o CRM – processo produtos.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

iPeriodico

Int

 

x

 

 

Opção período de execução

cDataExec

Char

 

X

 

 

Data execução pedido

cHoraExec

Char

 

X

 

 

Hora execução pedido

cDataLimite

Char

 

X

 

 

Data limite execução pedido

crm-codFimProduto

Char

 

X

 

 

Código do produto

crm-codIniProduto

Char

 

X

 

 

Código do produto

RowErrors

Tt

 

 

X

 

Erros relacionado ao processo

 

Método: chooseTabPreco

Descrição: método principal para agendamento do programa de carga ERP EMS para o CRM – processo tabela de preços.   

 

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

iPeriodico

Int

 

x

 

 

Opção período de execução

cDataExec

Char

 

X

 

 

Data execução pedido

cHoraExec

Char

 

X

 

 

Hora execução pedido

cDataLimite

Char

 

X

 

 

Data limite execução pedido

crm-codFimTabPreco

Char

 

X

 

 

Código tabela de preço

crm-codIniTabPreco

Char

 

X

 

 

Código tabela de preço

RowErrors

Tt

 

 

X

 

Erros relacionado ao processo

 

Método: chooseClienProd

Descrição: método principal para agendamento do programa de carga ERP EMS para o CRM – processo itens do cliente.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

iPeriodico

Int

 

x

 

 

Opção período de execução

cDataExec

Char

 

X

 

 

Data execução pedido

cHoraExec

Char

 

X

 

 

Hora execução pedido

cDataLimite

Char

 

X

 

 

Data limite execução pedido

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

RowErrors

Tt

 

 

X

 

Retorna erros do processo

 

Método: chooseEtiq

Descrição: Método principal para o agendamento de pedido de execução de etiquetas.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

iPeriodico

Int

 

x

 

 

Opção período de execução

cDataExec

Char

 

X

 

 

Data execução pedido

cHoraExec

Char

 

X

 

 

Hora execução pedido

cDataLimite

Char

 

X

 

 

Data limite execução pedido

Layout

Char

 

X

 

 

Código layout

Publico

Char

 

X

 

 

Código publico

RowErrors

Tt

 

 

X

 

Erros relacionado ao processo


Método: chooseTransClas

Descrição: Método para agendamento do processo de transição de classe.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

iPeriodico

Int

 

x

 

 

Opção período de execução

cDataExec

Char

 

X

 

 

Data execução pedido

cHoraExec

Char

 

X

 

 

Hora execução pedido

cDataLimite

Char

 

X

 

 

Data limite execução pedido

cConta

Char

 

X

 

 

Código conta

cPublico

Char

 

X

 

 

Código publico

lTodos

Log

 

X

 

 

Todas as contas do CRM

RowErrors

Tt

 

 

X

 

Retorna os erros do processo

 

Método: chooseSendMail

Descrição: Método para agendamento do envio de email.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

iPeriodico

Int

 

x

 

 

Opção período de execução

dValDataExec

Char

 

X

 

 

Data execução pedido

cValoHoraExec

Char

 

X

 

 

Hora execução pedido

dDataLimite

Char

 

X

 

 

Data limite execução pedido

cValueLayoutEmail

Char

 

X

 

 

Código layout

iValueProcess

Int

 

X

 

 

Código rotina

cAssunto

Char

 

X

 

 

Assunto do email

lAgendaRpw

Log

 

X

 

 

Existe agenda ativa?

RowErrors

Tt

 

 

X

 

Retorna os erros do processo

 

Método: choosePrfv

Descrição: método principal para agendamento do programa que calcula o PRFV dos clientes da base.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

lAgendaRPW

Log

 

x

 

 

Existe agenda ativa?

iPeriodico

Int

 

x

 

 

Opção período de execução

cDataExec

Char

 

X

 

 

Data execução pedido

cHoraExec

Char

 

X

 

 

Hora execução pedido

cDataLimite

Char

 

X

 

 

Data limite execução pedido

cParamPrfv

Char

 

X

 

 

Código do PRFV

RowErrors

Tt

 

 

X

 

Retorna os erros do processo

 

Método: validaData

Descrição: Método para validação de data do agendamento.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

cData

char

 

x

 

 

Data pedido de execução

Msg

Char

 

 

X

 

Mensagem de retorno

Lhoje

Log

 

 

X

 

Data igual a hoje?

 

Método: validaHoraDataAtual

Descrição: Método para validar horário se data igual a hoje.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

cData

char

 

x

 

 

Data pedido de execução

Msg

Char

 

 

X

 

Mensagem de retorno

Lhoje

Log

 

 

X

 

Data igual a hoje?

 

Método: validaDataLimite

Descrição: Método para validar a data limite do pedido de execução.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

cDataI

char

 

x

 

 

Data inicial

cDataL

char

 

X

 

 

Data final

Msg

Char

 

 

X

 

Mensagem de retorno do processo

 

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

 

 

Método: VerificaAgendaAtiva

Descrição: Método para verificar se possui agenda automática ativada.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

v-log-agenda-auto-ok

Log

 

 

 

 

Agenda automática

p_cod_prog_dtsul_w

char

 

X

 

 

Código programa

lAtivo

Log

 

 

X

 

Parâmetro que indica se possui agenda