MIAPI086 - Consulta Agenda Técnico da Manutenção

Documento de API

Objetivo

Consultar a agenda (tarefas programadas) para determinado técnico.

Na forma padrão, realiza-se a chamada através de um comando RUN.

A sintaxe para a chamada da API/BO é:

run mip/miapi086.p.

Porém esta tem funcionalidade apenas chamando as procedures internas das mesma.

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

run mip/miapi086.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.

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

Tabela Temporária	Descrição	Entrada/Saída
ttTecn	Tabela com as informações dos técnicos da manutenção industrial.	Saída

Tabela Temporária	Descrição	Entrada/Saída
ttEsp	Especialidades do Técnico	Saída

Tabela Temporária	Descrição	Entrada/Saída
ttListaTecnico	Listagem de técnicos	Saída

Tabela Temporária	Descrição	Entrada/Saída
ttSelecaoConsultaAgenda	Filtro das informações (Parametros e faixas)	Entrada/Saída

Tabela Temporária	Descrição	Entrada/Saída
ttAgendaVIEWAgenda	Agenda do técnico	Saída

Tabela Temporária	Descrição	Entrada/Saída
RowErrors	Contém os erros ocorridos na API.	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
ErrorSequence	integer	padrão	Seqüência dos erros	Sim
ErrorNumber	integer	padrão	Número do erro	Sim
ErrorDescription	char	padrão	Descrição do erro	Sim
ErrorParameters	char	padrão	Parâmetros passados para criar mensagem	Não
ErrorType	char	padrão	Tipo do erro: WARNING: Aviso ERROR: Erro	Sim
ErrorHelp	char	padrão	Texto de ajuda do erro	Sim
ErrorSubType	char	padrão	Sub Tipo da mensagem de erro	Não

Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

Método Básico

Requisito	Nenhum
Sintaxe	Run carregaListaTecnico in h-handle (output ttListaTecnico)
Descrição	Carrega os técnicos cadastrados no sistema com situação igual a ativo.
	Parâmetros	Descrição
	ttListaTecnico	Temp-table Técnicos
Retorno	A API/BO irá setar o return-value para retornar os técnicos cadastrados no sistema com situação igual a ativo.

Requisito	Nenhum
Sintaxe	run carregaTecnico in h-handle (input <character>, output table ttTecn, output table ttEsp).
Descrição	Retorna as informação do técnico passado como parâmetro(matrícula) bem como as especialidades do mesmo.
	Parâmetros	Descrição
	Pcod-tecnico	Matrícula do Técnico
	ttTecn	Temp-table Técnico
	ttEsp	Temp-table Especialidades
Retorno	ttTecn contém as informações do técnico conforme definição da temp-table e ttEsp lista as especialidades associadas a técnico.

Requisito	Nenhum
Sintaxe	run carregaAgenda in h-handle (input table ttTecn, input table ttEsp, input table ttSelecaoConsultaAgenda, output table ttAgendaVIEWAgenda).
Descrição	Retorna a agenda do técnico, respeitando a especialidade e o filtro passado.
	Parâmetros	Descrição
	ttTecn	Técnico da manutenção
	ttEsp	Especialidade
	ttSelecaoConsultaAgenda	Seleção
	ttAgendaVIEWAgenda	Agenda
Retorno	As temp-tables de input: ttTecn, ttEsp e ttSelecaoConsultaAgenda devem ter apenas um registro criado. O retorno da ttAgendaVIEWAgenda trará todas as tarefas agendas para o técnico respeitando a especialidade e o filtro passado para a API através de suas temp-tables. Para criação do registro da temp-table ttSelecaoConsultaAgenda recomenda-se o uso da procedure “confFiltro” para criar a busca de faixa aberta, e após isso editar os valores do cliente.

Requisito	Nenhum
Sintaxe	run getDateField in h-handle (input table ttSelecaoConsultaAgenda, output table ttSelecaoConsultaAgenda).
Descrição	Retorna os valores dos campos da tabela que são data.
	Parâmetros	Descrição
	ttSelecaoConsultaAgenda	Filtro para seleção
Retorno	A API retorna com valores padrões para pesquisa a temp-table ttSelecaoConsultaAgenda, respeitando os formatos dos campos no dicionário de dados. Recomenda-se o uso de prrocedure para criar o registro da Temp-table e após isso editar as faixas que o cliente deseja para a pesquisa.