Ocorrência:

Documentação de API

<versao-integracao>

Para os clientes que possuem o EMS 2.04, deve ser informado o valor 204. Para os clientes com EMS 2.05 ou superior, deve ser informado o valor 205.

tt-import-rep-parada

Temp-table com os dados a reportar. Pode ser passada para a API contendo um ou mais registros, sendo que cada registro representa uma Parada a reportar. Mais detalhes sobre a definição da temp-table, obrigatoriedade de campos, etc., estão descritos adiante.

tt-erro

Temp-table de retorno de erros gerados na execução.

tt-import-rep-parada

Deverá ser passada como parâmetro vazia na inicialização.

tt-erro

Temp-table de retorno de erros gerados na execução.

tt-import-rep-parada

Utilizada para a entrada dos dados a reportar. Cada registro passado por esta temp-table corresponde a uma transação que será efetuada, sendo que podem ser passados um ou mais registros. Sua definição está na include sfc/sfapi010.i

Entrada

tt-erro

Utilizada como saída padrão dos erros gerados na execução da API. Sua definição está na include cdp/cd0666.i

Saída

rowErrors

Utilizada como saída alternativa dos erros gerados na execução da API. Sua definição encontra-se na include method/dbotterr.i. Obs.: Somente pode ser utilizada a rowErrors para saída dos erros da API quando fazendo a execução no modo persistente, e mediante o ajuste de um parâmetro específico. Mais detalhes estão descritos no detalhamento do método setaGeraRowErrors.

Saída

ErrorSequence

integer

Seqüência do erro

ErrorNumber

integer

Número do erro

ErrorDescription

char

Descrição do erro

ErrorParameters

char

Parâmetros passados para criar mensagem

ErrorType

char

Tipo do erro. WARNING: Aviso; ERROR: Erro

ErrorHelp

char

Texto de ajuda do erro

ErrorSubType

char

Sub Tipo da mensagem de erro

Sintaxe

run pi-inicializa in h-handle (input  <logical-on-line>,

                               input  <logical-usa-param>,

                               input  <logical-emite-ss>,

                               input  <logical-envia-email>,

                               input  <logical-cria-pend>,

                               input  <integer-nr-ord-produ>,

                               input  table tt-import-rep-parada,

                               output table tt-erro).

Descrição

Efetua a transação (inclusão, exclusão, início ou término) de um ou mais reportes de parada. Obs.: Os cinco primeiros parâmetros da API somente têm efeito caso o cliente possua o módulo de Manutenção Industrial implantado.

<logical-on-line>

Quando marcado como Yes, este parâmetro indica que a API poderá chamar, conforme outros parâmetros explicados a seguir, telas para a geração de Solicitação de Serviço ou envio de E-mail para o planejador.

<logical-usa-param>

Indica, quando marcado igual Yes, que irá utilizar os parâmetros <logical-envia-email> e <logical-emite-ss> para definir se irá ou não enviar e-mail para o planejador e emitir SS na Inclusão de um Reporte de Parada. Caso o parâmetro seja igual No, então serão consideradas os parâmetros de envio de e-mail e emissão de SS presentes no motivo de Parada informado.

<logical-emite-ss>

Indica que, na inclusão ou início de um Reporte de Parada, a API irá emitir uma Solicitação de Serviço no módulo de Manutenção Industrial. Este parâmetro somente terá efeito caso o parâmetro <logical-usa-param> esteja marcado igual à Yes. Caso contrário, será utilizado o parâmetro de emissão de SS presente no motivo de Parada.

<logical-envia-email>

Indica que, na inclusão ou início de um Reporte de Parada, a API irá enviar um e-mail para o planejador do Equipamento, cadastrado na Manutenção Industrial. Este parâmetro somente terá efeito caso o parâmetro <logical-usa-param> esteja marcado igual à Yes. Caso contrário, será utilizado o parâmetro de emissão de e-mail presente no motivo de Parada.

<logical-cria-pend>

Indica que, na ocorrência de erros na execução da API, será também gerada pendência de Importação. Observação: este parâmetro somente é utilizado para clientes que possuem o EMS na versão 2.05 ou superior.

<integer-nr-ord-produ>

Recebe o número da Ordem de Manutenção que deu origem à Parada que está sendo Incluída, Iniciada ou Finalizada. Caso não haja ordem de manutenção, deve ser passado o valor 0 (zero) neste parâmetro.

tt-import-rep-parada

Recebe a temp-table populada com os registros relativos aos reportes de parada que serão efetivados. Quando executando persistente e on-line, é indicado enviar apenas um registro por vez, já que poderão ser apresentadas ao usuário telas para manipular as SSs e e-mails enviados em função da parada. É importante observar também que, caso seja informada uma ordem de manutenção no parâmetro <integer-nr-ord-produ>, a mesma será atribuída a todos os registros de Parada, caso haja mais de um na temp-table.

tt-erro

Temp-table que retorna eventuais erros ocorridos na gravação das informações.

Retorno

Não há.

Sintaxe

run setaGeraRowErrors in h-handle.

Descrição

Quando executada antes da chamada de qualquer outro método, indica que a API deverá gerar os erros na temp-table rowErrors, em paralelo à temp-table de erros padrão (tt-erro).

Esta opção é útil quando se está chamando a API a partir de uma interface escrita com thinTemplates, a qual tem como temp-table padrão de erros a rowErrors.

Retorno

Não há.

Sintaxe

run retornaRowErrors in h-handle (output table rowErrors).

Descrição

Retorna a temp-table rowErrors populada com os erros gerados na execução.

rowErrors

Retorna esta temp-table populada com os erros.

Retorno

Não há.

Sintaxe

run pi-re-analise-parada in h-handle(input <rowid-rep-parada-ctrab>,

                                     input <character-cod-parada>,

                                     input <date-data-fim-prevista>,

                                     input <integer-hra-fim-prevista>,

                                     input <integer-nr-ord-produ>).

Descrição

A função Re-análise de Parada tem como objetivo permitir que uma parada tenha seu motivo e ordem de manutenção modificados após sua Inclusão ou Início. No caso de paradas Iniciadas, também é possível, através desta função, a alteração da data/hora prevista de término. Essa reclassificação da parada impacta nas estatísticas de parada e no processo de alocação de atividades do módulo Chão de Fábrica.

<rowid-rep-parada-ctrab>

Rowid do registro da tabela rep-parada-ctrab cuja parada se deseja Reanalisar.

<character-cod-parada>

Código do novo motivo de parada que se deseja informar.

<date-data-fim-prevista>

Indica a nova data de fim prevista para a parada. Somente será considerado este parâmetro quando se tratar de Parada Iniciada (não finalizada).

<integer-hra-fim-prevista>

Indica a nova hora de fim prevista para a parada, devendo ser informadoem segundos. Somenteserá considerado este parâmetro quando se tratar de Parada Iniciada (não finalizada).

<integer-nr-ord-produ>

Permite informar a Ordem de Manutenção que deu origem a Parada, ou modificar uma ordem informada anteriormente. Caso não haja ordem de manutenção, deve ser passado o valor 0 (zero) neste parâmetro.

Retorno

Quando ocorrem erros durante as validações das informações, a API retorna o valor NOK. Por este motivo, o programa chamador deverá ter tratamento para, após a execução deste método, retornar os erros caso haja return-value = “NOK” através do método retornaRowErrors. 

Sintaxe

run finalizaAPI in h-handle.

Descrição

Método que efetua a finalização da API, eliminando da memória todos os componentes por ela utilizada. Sua execução é obrigatória, devendo, ser executado após a utilização da API.

Retorno

Não há.