Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicocrmapi\apiDistribuirTarefa.p

 

Objetivo

Distribuir tarefas entre os usuários e validar data e hora das tarefas.

 

Tabelas Temporárias

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

tt-DistTar

 

Atributo

Tipo

Formato

        Descrição

Obr.

idUsuario

Int

 

Usuário

 

nomeUsuario

Char

 

Nome do usuário

 

qtdTar

Int

 

Quantidade de tarefa

 

tt-DadosPuclic

 

Atributo

Tipo

Formato

        Descrição

Obr.

idPublico

Int

 

Publico

 

numIdPessoa

Int

 

Conta

 

numIdContato

Int

 

Conta

 

ttdgUsuariosselec

 

Atributo

Tipo

Formato

        Descrição

Obr.

num_id_respons

Int

 

Usuário responsável

 

nomeUsuario

Char

 

Nome do usuário

 

ttdgUsuarios

 

Atributo

Tipo

Formato

        Descrição

Obr.

num_id_respons

Int

 

Usuário responsável

 

nomeUsuario

Char

 

Nome do usuário

 

ttTodosUsuarios

 

Atributo

Tipo

Formato

        Descrição

Obr.

num_id_respons

Int

 

Usuário responsável

 

nomeUsuario

Char

 

Nome do usuário

 

tipo_registro

Int

 

Tipo de usuário

 

ttTodosUsuariosAcaoCampanha

 

Atributo

Tipo

Formato

        Descrição

Obr.

num_id_respons

Int

 

Usuário

 

ttChaveAcao

 

Atributo

Tipo

Formato

        Descrição

Obr.

numIdAcao

Int

 

ação

 

ttChaveObjetivo

 

Atributo

Tipo

Formato

        Descrição

Obr.

numIdObjetivo

Int

 

objetivo

 

ttCrmPublicDados

 

Atributo

Tipo

Formato

        Descrição

Obr.

num_id

Int

 

Id da conta do publico

 

num_id_contat

Int

 

Contato

 

num_id_pessoa

Int

 

Conta

 

num_id_public

Int

 

id do publico

 

ttDistTar

 

Atributo

Tipo

Formato

        Descrição

Obr.

idUsuario

Int

 

Usuário

 

nomeUsuario

Char

 

Nome do usuário

 

qtdTar

Int

 

Quantidade de tarefa

 

ttParametros

 

Atributo

Tipo

Formato

        Descrição

Obr.

numIdCampanha

Char

 

Campanha

 

numIdAcao

Char

 

Ação

 

numIdPublic

Char

 

Publico

 

numIdObjet

Char

 

Objetivo

 

cDataInicio

Char

 

Data inicial

 

iUsaCalendarioComercial

Int

 

1 = yes , 2 = no

 

iValidarTarefasExistentes

Int

 

1 = yes , 2 = no

 

cTempoLanche

Char

 

Tempo de lache

 

cHoraInicio

Char

 

Hora inicio

 

cHoraReinicio

Char

 

Hora reinicio

 

cTempoTarefa

Char

 

Tempo da tarefa

 

cHoraAlmoco

Char

 

Hora almoço

 

cHoraSaida

Char

 

Hora saída

 

cTempoDescompressao

Char

 

Tempo de descompressão

 

cHoraLancheMatutino

Char

 

Hora lanche matutino

 

cHoraLancheVespertino

Char

 

Hora lanche vespertino

 

cDescricao

Char

 

Descrição

 

iQtTarPorUsuario

int

 

Qtd de tarefas por usuário

 

iRedistribuir

Int

 

Redistribuir 1 yes, 2 no

 

 

tt-crm_tar

Tabela definida conforme tabela CRM_TAR, porém com as diferenças abaixo.

Atributo

Tipo

Formato

        Descrição

Obr.

R-ROWID

ROWID

 

Rowid

 

 

ttCrmTar

Tabela definida conforme tabela CRM_TAR, porém com as diferenças abaixo.

Atributo

Tipo

Formato

        Descrição

Obr.

R-ROWID

ROWID

 

Rowid

 

 

Parâmetros de input e output da api

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

 

 

 

 

 

 

 

 

Métodos 

 

Métodos básicos

 

Método: getUsuarioAcao

Descrição: busca o usuário da ação          

Requisitos: nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

icodAcao

Int

 

X

 

 

Ação

ttdgUsuariosselec

Tt

 

 

X

 

Usuários relacionados a ação

 

Método: getTotalTarefasDistribuidas

Descrição: retorna o total de tarefas pendentes do usuário.          

Requisitos: nenhum 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

iCampanhaSelec

Int

 

X

 

 

Campanha

iAcaoSelec

Int

 

X

 

 

Ação

iPublicoSelec

Int

 

X

 

 

Publico

iObjetSelec

Int

 

X

 

 

Objetivo

i-numTarefasPendentes

Int

 

 

X

 

Tarefas pendentes

 

Método: getTotalContasPublico

Descrição: retorna a quantidade de contas do publico alvo.           

Requisitos: nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

iPublico

Int

 

X

 

 

Publico

iqtdConta

Int

 

 

X

 

Total de contas

 

Método: getAcaoCampanha

Descrição: retorna a ação da campanha.           

Requisitos: nenhum 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

c-campanha

Char

 

X

 

 

Campanha

c-acao

Char

 

X

 

 

Ação

c-campanhaAcao

Char

 

 

X

 

Aça da campanha

 

Método: getUsuarioNome

Descrição: retorna todos os usuários relacionados a ação.           

Requisitos: nenhum 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

c-CampanhaAcao

Char

 

X

 

 

Ação da campanha

ttTodosUsuarios

Tt

 

 

X

 

usuarios

 

Método: getProcessaSelecionados

Descrição: retorna os usuários selecionados que estejam relacionados a ação.          

Requisitos: nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

ttTodosUsuarios

Tt

 

X

 

 

Todos os Usuários

ttdgUsuariosselec

Tt

 

X

 

 

Somente usuários selecionados

ttdgUsuarios

Tt

 

 

X

 

Relação de Usuários filtrados

 

Método: distribuirTarefas

Descrição: distribui tarefas entre os usuários.           

Requisitos: nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

ttParametros

Tt

 

X

 

 

Parâmetros

ttdgUsuariosselec

Tt

 

 

X

 

Somente usuários selecionados

 

Método: getFinalHora

Descrição: retorna a hora final.          

Requisitos: nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

c-Hora

Char

 

X

 

 

Hora

cTempoTarefa

Char

 

X

 

 

Hora tarefa

c-horaFinal

Char

 

 

X

 

Hora final

 

Método: getDataCalendarioValida

Descrição: retorna uma data valida de acordo com o calendário.          

Requisitos: nenhum 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pi-usaCalendarioComercial

Int

 

X

 

 

Usa calendário comercial 1 yes, 2 no

pd-data

Char

 

X

 

 

Data

pd-dataValida

Char

 

 

X

 

Data valida

pi-statusDataValida

Int

 

 

X

 

Status valido 1 yes, 2 no

 

Método: getHoraDataValida

Descrição: Retorna horario valido para inicio da tarefa.           

Requisitos: nenhum 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

cDataInicio

Char

 

X

 

 

Data incial

cTempoLanche

Char

 

x

 

 

Data valida

cHoraInicio

Char

 

X

 

 

Hora inicial

cHoraReinicio

Char

 

X

 

 

Hora reinicio

cTempoTarefa

Char

 

X

 

 

Tempo para tarefa

cHoraAlmoco

Char

 

x

 

 

Hora almoço

cHoraSaida

Char

 

x

 

 

Hora saída

cTempoDescompressao

Char

 

x

 

 

Tempo de descompressão

cHoraLancheMatutino

Char

 

x

 

 

Hora lanche matutino

cHoraLancheVespertino

Char

 

x

 

 

Hora lanche vespertino

i-usaCalendarioComercial

int

 

x

 

 

Usa calendário comercial

c-Hora

Char

 

 

x

 

Hora

c-data

Char

 

 

x

 

Data

numIdCampanha

Char

 

x

 

 

Campanha

numIdAcao

Char

 

x

 

 

Ação

numIdPublic

Char

 

x

 

 

Publico

numIdObjet

Char

 

x

 

 

Objetivo

iUserRespnsavel

Int

 

x

 

 

Usuário responsável

  

Método: horaUltimaTarefaDoDia

Descrição: retorna um horário e da ta valido para tarefa.           

Requisitos: nenhum 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

c-hora

Char

 

X

 

 

Hora

c-data

Char

 

x

 

 

Data

c-HoraSaida

Char

 

x

 

 

Hora saída

i-UsuarioResp

Int

 

x

 

 

Usuário responsável

i-usaCalendarioComercial

Int

 

x

 

 

Usa calendário comercial 1 yes, 2 no

c-HoraValida

Char

 

 

X

 

Hora valida

c-DataValida

Char

 

 

X

 

Data valida

 

Método: getCampanhaAcaoDefault

Descrição: retorna a campanha e o objetivo default.           

Requisitos: nenhum 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

i-id-campanhaDefault

int

 

 

X

 

Campanha default

i-id-objetivoDefault

Int

 

 

X

 

Objetivo default

 

Método: verificaAcaoRelacaoCampanha

Descrição: retorna as ações da campanha selecionada.           

Requisitos: nenhum 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

i-campanha

Int

 

X

 

 

Campanha

ttChaveAcao

Tt

 

 

X

 

ações

  

Método: verificaAcaoRelacaoAcao

Descrição: retorna os objetivos da ação.           

Requisitos: nenhum 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

i-campanha

Int

 

X

 

 

Campanha

i-acao

Int

 

X

 

 

Ação

ttChaveObjetivo

Tt

 

 

X

 

objetivos