Escolar Documentos
Profissional Documentos
Cultura Documentos
Guia de Integração
SE Suite 2.0
DC TE .P T00033
Rev 16
O SoftExpert Excellence Suite (SE Suite) é a mais completa solução corporativa para a gestão integrada da
excelência e conformidade empresarial.
Oferecendo um amplo conjunto de módulos multi-idiomas, nativamente integrados e 100% web, a solução
automatiza os principais processos envolvidos nas necessidades de melhoria e otimização das diversas
áreas de negócio das organizações, aprimorando a gestão, reduzindo custos operacionais, e facilitando o
atendimento às principais normas e regulamentações do mercado.
A solução também complementa e otimiza a utilização dos sistemas de gestão empresarial, estando
integrada aos principais ERPs do mercado através de conectores prontos ou desenvolvidos conforme a
necessidade específica de cada empresa.
A informação contida aqui está sujeita a mudanças sem aviso prévio. Se você encontrar qualquer
informação inconsistente, por favor, reporte-a por escrito ao nosso suporte.
O usuário assume inteiro risco quanto ao uso e aos resultados do uso deste documento. Os exemplos de
empresas, organizações, produtos, nomes de domínios, endereços de e-mail, logotipos, pessoas, lugares e
acontecimentos aqui mencionados são fictícios. Nenhuma associação com qualquer empresa, organização,
produto, nome de domínio, endereço de e-mail, logotipo, pessoa, lugar ou acontecimento real é intencional
ou deve ser inferida.
Obedecer às leis de direitos autorais é responsabilidade do usuário. Sem limitar os direitos autorais,
nenhuma parte deste documento pode ser reproduzida, armazenada ou introduzida em um sistema de
recuperação, ou transmitida de qualquer forma por qualquer meio (eletrônico, mecânico, fotocópia,
gravação ou qualquer outro), ou para qualquer propósito, sem a permissão expressa, por escrito, da
SoftExpert.
SoftExpert pode ter patentes ou requisições para obtenção de patente, marcas comerciais, direitos autorais
ou outros direitos de propriedade intelectual que abrangem o conteúdo deste documento. A posse deste
documento não lhe confere nenhum direito sobre as citadas patentes, marcas comerciais, direitos autorais
ou outros direitos de propriedade intelectual.
Este software e documento podem fornecer acesso a informações sobre conteúdo, produtos e serviços de
terceiros. SoftExpert não é responsável por isso, e expressamente nega garantia de qualquer tipo, em
respeito ao conteúdo, produtos e serviços de terceiros. SoftExpert não será responsável por qualquer perda,
custos, ou danos ocorridos devido ao acesso ou uso de conteúdo, produto, ou serviços de terceiros.
Capítulo I
Introdução
Este documento tem por objetivo definir as especificações e critérios técnicos necessários para a
integração de sistemas de informação diversos com o SoftExpert Excellence Suite (SE Suite).
A realização da integração utilizando o modelo disponibilizado no SE Suite deve ser executada por um profissional de TI
com conhecimento em web services ou banco de dados (preferencialmente um integrador ou DBA).
§ Para integração via Web Services será necessário ter conhecimento no protocolo SOAP e em ferramentas
§ Para integração via Banco de Dados será necessário fazer a manipulação de dados de uma tabela específica onde a
Objetivo
A arquitetura de integração foi desenvolvida como parte de um SDK, seguindo uma padronização para a
importação de dados de uma origem qualquer para o SE Suite, e a extração de dados provenientes das
saídas obtidas a partir do processamento dos dados da importação para um destino qualquer.
ATENÇÃO
Apesar da SoftExpert fornecer suporte a versões recentes de pacotes e patches de softwares de terceiros, a
SoftExpert não tem controle sobre a atualização desses softwares, e, portanto, não pode garantir a compatibilidade
com seus produtos. Em todo caso, verifique com o fornecedor as especificações do produto para mais detalhes sobre
a compatibilidade.
Capítulo II
Convenções tipográficas
Este documento utiliza as convenções descritas na tabela a seguir, para distinguir elementos do texto.
Convenção
Elementos que podem ser clicados na interface do usuário (como, por exemplo,
[Exemplo]
botões).
Variáveis fornecidas pelo usuário que substituem o conteúdo entre os caracteres < e
<Exemplo>
>.
# mkdir <nome_da_pasta>
Nesta caixa de texto é apresentado o conteúdo do arquivo que está sendo editado.
Durante a utilização deste manual, serão encontradas diferentes estratégias para chamar a atenção do
usuário para informações importantes. As imagens que indicam estas informações serão apresentadas a
seguir:
Exibe detalhes importantes sobre determinada funcionalidade, que devem ser levados em consideração e/ou que
facilitam a utilização do sistema. Um link será disponibilizado caso a funcionalidade já tenha sido descrita em outra parte
da documentação.
Alerta para indicar funcionalidade ou ação que, quando não executada corretamente, pode prejudicar alguma etapa
da utilização do sistema.
Capítulo III
Possibilidades de integração
1. Integração de portais e/ou sistemas legados dos clientes para inicialização de workflow/processo
dentro do SE Suite.
§ A integração pode ser feita utilizando API de inicialização externa, detalhada tecnicamente no
§ Ou poderá ser utilizado os Web Services da SoftExpert para inicialização. Os Web Services da
Demais ações de workflow também estão liberados a partir da utilização do WEB Service, como execução de
atividades, preenchimento de atributos e campos de formulário, upload de anexos, etc. (Documentação on-line
dos Web Services http://<domínio>/se/ws/wf_ws.php).
§ Para isto o BI do cliente deverá acessar diretamente as tabelas do SE Suite e montar as consultas
§ Para este tipo de demanda temos disponível as tabelas de interface e próprios Web Services,
ambos estão detalhados nos capítulos Integração via banco de dados e Integração via web
services.
5. Ler dados de bancos de dados externos, para serem utilizados dentro do SE Suite.
§ Para isto temos a opção do recurso de atributos externos dentro da aplicação. Os detalhes de
aplicações externas onde pode-se testar uma informação externa, retornar algum tipo de dados,
etc, seja via o conceito de Web Service ou mesmo uma aplicação personalizada (mediante
customização).
O mesmo conceito pode ser utilizado para carregar dados de lista de campos de formulário. Nesse caso não há
opção da conexão direta como o atributo externo, mas pequenas rotinas e conectores poderão ser
desenvolvidos.
§ Para isto é possível utilizar interfaces Web Services (se o sistema externo possuir), exportar para
arquivos de dados (TXT, CSV), para importação pelo sistema externo ou senão realizar as
gravações diretamente no banco de dados do sistema externo.
aplicações externas onde pode-se configurar os clients de Web Service nativamente (salvo
particularidades de autenticação e arquitetura que no caso teria que ser implementado o client
específico).
serem utilizados. Por exemplo, se a conexão for direta entre os bancos de dados, estes devem
possibilitar um DBLINK ou estarem numa mesma rede (VPN Dedicada). Se a necessidade for de
transferência de arquivos, os fileservers devem estar disponíveis na nuvem, e assim por diante.
§ Pode ser efetivada por qualquer ferramental do SAP (ABAP, XI, RFC, etc), sendo estas dependentes
O mesmo entendimento pode ser aplicado a qualquer outro ERP, ou seja, a equipe SoftExpert precisa mapear
qual o método de disponibilização de dados pelo ERP em questão. A partir disso é direcionado ao métodos
supracitados.
Capítulo IV
A seção Modelo de dados da interface apresenta cada campo tanto da tabela ADINTERFACE quanto do
cabeçalho do arquivo para importação .xls;
A seção Carga de dados na interface define como é feita a carga dos dados na tabela ADINTERFACE;
A seção Definição da estrutura do arquivo XLS define como deve ser utilizado o arquivo .xls, e como o
mesmo deve ser preenchido;
A seção Diagnóstico e correção de erros descreve como deve ser feita a correção de registros que não
foram importados com sucesso;
A seção Interfaces publicadas define todas as interfaces publicadas no sistema, e o que deve ser
preenchido em cada uma delas;
Os sistemas de informação de terceiros terão acesso somente a esta interface, buscando com isso a não
interferência deste sistema de informação no resto do ambiente. Não deve ser gerada nenhuma trigger na
interface, evitando a interrupção de qualquer transação da base, dando transparência às
responsabilidades entre o SE Suite e softwares de terceiros.
IMPORTANTE!
Todas as informações sobre a entrada de dados no SE Suite serão feitas através da interface disponibilizada e
apresentada no decorrer deste documento, não sendo permitida a inserção direta de dados em tabelas do SE Suite.
ADINTERFACE
ADINTERFACE
ADINTERFACE
ADINTERFACE
ADINTERFACE
IMPORTANTE!
§ Todo tipo de registro ficará guardado nessa tabela, mesmo após a importação ou mesmo que houver erro na
importação;
§ O que diferencia um registro do outro é o código do sistema (CDISOSYSTEM) e o tipo de importação que se
§ O campo CDINTERFACE, além de ser chave primária e sequencial, é quem define a ordem de importação dos itens
registrados na interface.
Tanto o CDISOSYSTEM quanto o FGOPTION, bem como os demais campos relacionados às importações já
publicadas no SE Suite, serão detalhados nos próximos capítulos. Cada uma destas importações
publicadas possui uma quantidade de dados diferentes, tanto de dados obrigatórios, quanto de dados
complementares.
Os programas responsáveis por carregar os dados devem ler as informações de um repositório de origem
(banco de dados, arquivos XLS, CSV, XML, etc.) e escrever as mesmas na interface ADINTERFACE disponível
no SESUITE. No processo de importação os usuários são responsáveis pela exclusão dos registros
processados e pelo tratamento de exceções e erros ocorridos na importação via sistema. Já no processo
de saída dos dados, os softwares de terceiros é que são responsáveis por excluir os registros consumidos
da interface.
É importante salientar que a arquitetura não guarda informações deletadas, seja ele um registro já
importado ou um registro ainda não importado. Portanto, uma vez que um registro é deletado do sistema,
ou diretamente da interface, não há um lugar na arquitetura de integração para manter o dado deletado.
IMPORTANTE!
Todos os campos devem ser colocados no cabeçalho, mesmo que não utilizados. Os campos devem ser escritos todos
com letras maiúsculas, e devem seguir a ordem abaixo:
CDINTERFACE, DSERROR, FGIMPORT, FGBLOBOPTION, FGOPTION, CDISOSYSTEM, QTHRINIT,
QTHRFINISH, DTEXECUTION, NRSEQUENCE, NMFIELD01, NMFIELD02, ..., NMFIELD101,
DSFIELD01, DSFIELD02, ..., DSFIELD15
O arquivo deve possuir no seu nome a palavra seimport, e deve estar dentro da pasta C:
\Inetpub\SE\web\import. Ao executar um agendamento, esta pasta é verificada, e caso existam um ou
mais arquivos, a arquitetura de integração estará carregando os registros encontrados para a interface.
dados sejam capturados com sucesso, ou vai para o diretório C:\Inetpub\SE\web\import\error caso
ocorra algum problema no processo de importação.
IMPORTANTE!
Exemplos de nomes:
§ 20.05.seimport.xls
§ seimport.20.05.xls
§ _seimport_.xls
Caso esteja sendo utilizado o recurso de multidatabase, deve ser adicionado o domínio e mais um
underline antes da palavra seimport. Exemplos de nomes para o domínio www.softexpert.com:
§ 20.05.www.softexpert.com_seimport.xls
§ www.softexpert.com_seimport.20.05.xls
§ _www.softexpert.com_seimport_.xls
Além do recurso automático de busca do XLS e inserção dos dados na interface através do agendamento,
existe a possibilidade de se carregar os dados via sistema, dentro da tela de Pendências de Importação
(SE Configuração Ferramenta Importação Acompanhamento). Nesta tela é possível trabalhar com três
recursos de integração
Com o primeiro é possível exportar os dados da lista de pendência de importação através do botão
exportar, o qual já monta um arquivo no formato XLS com o cabeçalho já pronto com todos os dados da
interface. Depois de exportados, os dados podem ser alterados, e importados novamente para o sistema
através do segundo botão acima apresentado, o qual faz a importação dos dados. O segundo recurso, não
só importa os dados que já estavam na lista de pendências de importação, como também inclui novos
itens, facilitando uma importação pontual de dados. Este último, exporta uma planilha base que
corresponde ao modelo correto para importação de arquivo.
Caso algum erro desse tipo tenha ocorrido, a verificação do mesmo pode ser realizada através da tela de
Acompanhamento de Importação, localizada no componente Configuração (Configuração Ferramenta
Importação Acompanhamento). Nesta tela é possível consultar os registros que foram executados com
sucesso ou não. Pode-se utilizar o recurso de Filtro por Situação para filtrar os registros e exibir apenas os
registros com erro. O motivo do erro é exibido na coluna “Descrição do erro” tornando possível o
diagnóstico do problema para então corrigi-lo.
Após verificar a descrição do erro, e filtrar os registros desejados, pode-se então utilizar o botão
denominado “Exportar planilha” localizado na barra de ferramentas, para exportar o conjunto de dados
novamente, e corrigi-lo.
Serão exportados todos os registros listados na grid. Para se exportar somente os registros com erro, deve-se filtrar os
dados para que somente apareçam estes registros na grid.
Para realizar a correção, deve-se abrir o XLS gerado, efetuar a correção dos dados de acordo com a
descrição do erro, (ex: se o erro indicava que o registro já existe, altere a coluna que possui o valor
duplicado). Todos os valores da coluna DSERROR serão apagados e da coluna FGIMPORT alterados para
“1”. Mantenha os valores nas colunas CDINTERFACE, FGOPTION e CDISOSYSTEM iguais, pois esses valores
são usados para encontrar qual registro substituir na tabela de interface.
Realizadas as correções no XLS, basta utilizar o botão “Importar planilha” para substituir os dados na
tabela ADINTERFACE. Note que após o arquivo ser enviado para o servidor, os registros que foram
alterados estarão novamente marcados para importação, e serão reimportados de acordo com o
Agendamento de importação realizado no servidor.
§ Ação
§ Administração
§ Almoxarifado
§ Ativo
§ Calibração
§ CEP
§ Competência
§ Controle de atividades
§ Desempenho
§ Documento
§ Inspeção
§ Insumo
§ Manutenção
§ PDM
§ Projeto
§ Questionário
§ Resíduo
§ Risco
§ Teste
§ Treinamento
4.6.1 - Ação
§ Dados de um Item:
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir/editar item
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Mensurável?
1- Sim;
NMFIELD05 NUMÉRIC O 2
2- Não.
Excluir item
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
4.6.2 - Administração
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
18 - Excluir empresa.
Empresa cliente:
2 - Não.
Empresa fornecedora:
2 - Não.
Empresa fabricante:
2 - Não.
Exemplo: 109;107.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
C ontato padrão:
2 - Não.
§ Dados da atividade
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
22 - Excluir atividade.
Exemplo de inserção/exclusão:
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir/excluir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
24 - Excluir atividade.
Exemplo de inserção/exclusão:
Este modelo de importação possibilita adicionar novos atributos para os componentes SE Suite. Siga o
padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Tipo do atributo.
1 - Lista de valores;
NMFIELD04 X TEXTO 255
2 - Indeterminado;
3 - Externo.
Listas de valores:
1 Texto;
2 - Numérico;
3 - Data;
5 - Moeda.
NMFIELD05 X TEXTO 255
Indeterminado:
1 - Texto;
2 - Numérico;
3 - Data;
4 - Memorando;
5 - Moeda.
Externo:
1 - Texto.
Modo de seleção.
1 - Zoom;
2 – C ombo.
1 - Multivalorado
Exemplo: 109;107.
Formato do campo:
2 - Expressão regular.
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
153
Valor do atributo.
· aaaa-mm-dd.
Exemplo de inserção:
Este modelo de importação possibilita inserir valores a atributos já cadastrados no SE Suite. Siga o padrão
abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Bancos suportados:
1 - INTERBASE;
2 - MSSQL;
3 - MSSQL (ODBC );
7 - ORAC LE (ODBC );
8 - DB2 (ODBC );
9 - INFORMIX;
11 - MYSQL;
12 - POSTGRESQL;
Os valores aceitos para a importação de datas devem seguir um dos seguintes padrões:
§ AAAA-MM-DD
§ DD/MM/AAAA
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Os valores aceitos para a importação de datas devem seguir um dos seguintes padrões:
§ AAAA-MM-DD
§ DD/MM/AAAA
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir área
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Excluir área
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
§ Nível de instrução;
§ Data de nascimento;
§ Data de admissão;
§ Data de demissão;
§ Observação;
§ Endereço.
Para a edição de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
1 - C ompleto;
NMFIELD3 TEXTO 255 2 – Incompleto;
Os valores aceitos para a importação de datas devem seguir um dos seguintes padrões:
§ AAAA-MM-DD
§ DD/MM/AAAA
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Exemplo: 109;107.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir função
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Excluir função
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
§ Dados de equipes;
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado:
Inserir/Editar/Excluir Equipes
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
31 – Inserir equipe;
FGOPTION X NUMÉRIC O 2
32 – Editar equipe;
33 – Excluir equipe.
1 – Áreas;
NMFIELD04 X TEXTO 255
2 – Usuários;
3 – Funções.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado:
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
1 – Áreas;
3 – Funções.
§ Dados de um Usuário;
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir/editar usuário
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
1 - Inglês;
2 - Português (Brasil);
NMFIELD04 TEXTO 255
X 3 - Espanhol;
4 - Português (Portugal);
5 - Alemão;
6 - Francês;
7 - Romeno.
'Description of Micael');
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Área padrão:
2 - Não.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Inativar usuário
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
§ Dados de um Usuário;
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir/editar usuário
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
1 - Inglês;
NMFIELD04 TEXTO 255
X 2 - Português (Brasil);
3 - Espanhol;
4 - Português (Portugal);
5 - Alemão;
6 - Francês;
7 - Romeno.
4.6.3 - Almoxarifado
§ Dados de um atributo.
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro;
Tipo do atributo:
1 - Lista de valores;
NMFIELD04 TEXTO 255
X 2 - Indeterminado;
3 - Externo.
Listas de valores:
1 - Texto;
2 - Numérico;
5 - Moeda.
Indeterminado:
1 - Texto;
2 - Numérico;
3 - Data;
4 - Memorando;
5 - Moeda.
Externo:
1 - Texto.
1 - Zoom;
Valores aceitos:
1 - Multivalorado.
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Valor do atributo.
Tipo de BD:
1 – ITERBASE;
2 – MSSQL;
3 – MSSQL (ODBC );
7 – ORAC LE (ODBC );
8 – DB2 (ODBC );
9 – INFORMIX;
11 – MySQL;
12 – POSTGRESQL.
C ampo.
§ aaaa-mm-dd.
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Exclusão
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Exemplo da Exclusão:
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Exclusão
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Exemplo da Exclusão:
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Exclusão
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Exemplo da Exclusão:
§ Um almoxarifado cadastrado.
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Exclusão
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Exemplo da Exclusão:
§ Objetos do almoxarifado.
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Exclusão
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Valor do atributo.
§ aaaa-mm-dd.
Identificador da revisão.
Valor do atributo.
DSFIELD01 TEXTO 4000 Informação obrigatória caso o valor do
atributo seja do tipo MEMO.
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Tipo do emissor:
1 – Área;
3 – Fornecedor;
4 – Atividade do processo.
Identificador da atividade
NMFIELD05 TEXTO 255 Obs.: Obrigatório somente quando o tipo do
emissor for atividade do processo.
Exemplo da Inserção:
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Exemplo da Inserção:
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Tipo do destinatário:
1 – Área;
3 – Fornecedor;
4 – Eliminar.
Eliminar - Disposição/tratamento:
identificador da disposição/tratamento.
Exemplo da Inserção:
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Tipo do local:
2 ou NULL – Não.
Exemplo da Inserção:
§ Dados de um almoxarifado.
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Objeto do almoxarifado:
2 – Resíduo;
NMFIELD04 TEXTO 255
X 3 – PDM;
4 – Insumo.
Identificador da configuração da
NMFIELD07 TEXTO 255
movimentação.
1 – Interno;
NMFIELD08 X TEXTO 255
2 – C liente;
3 – Fornecedor.
Identificador do proprietário do
almoxarifado.
Exemplo da Inserção:
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Valor do atributo.
§ aaaa-mm-dd.
Identificador da revisão.
Valor do atributo.
DSFIELD01 TEXTO 4000 Informação obrigatória caso o valor do
atributo seja do tipo MEMO.
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
2 ou NULL – Não.
2 ou NULL – Não.
2 ou NULL – Não.
2 ou NULL – Não.
2 ou NULL – Não.
2 ou NULL – Não.
4.6.4 - Ativo
§ Dados de um ativo.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir/editar/excluir ativo
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Especificação do ativo:
1 - Instrumento;
2 - Equipamento;
NMFIELD05 X TEXTO 255 4 - Outros;
6 - Ferramental;
7 – Ferramentas;
11 – C omputador.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro;
Valor do atributo.
· aaaa-mm-dd.
§ Localização física.
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
Registro ativo
2 – Não.
Inserir
Requerid
Coluna Tipo Precisão Descrição
o
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Exemplo de Inclusão:
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir/editar
Requerid
Coluna Tipo Precisão Descrição
o
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Tipo do plano:
1 – Verificação;
NMFIELD01 X¹ TEXTO 255
2 – Manutenção preventiva;
3 – C alibração.
C onfiguração do plano:
Ex: IDATIVO01;IDATIVO02;IDATIVO03
2 – Desabilitar.
Tipo da frequência:
1 – Data de execução;
NMFIELD11 X³ TEXTO 255
2 – Primeiro uso;
3 – Tempo de uso.
Unidade de frequência:
1 – Dia(s);
2 – Semana(s);
NMFIELD13 X³ TEXTO 255
3 – Mês(es);
4 – Ano(s);
5 – Dia(s) útil(eis).
Visualização da data:
2 – Mês/Ano.
2 – Desabilitar.
2 – Desabilitar.
2 – A iniciar.
Exemplo de Inclusão:
Exemplo de alteração:
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
1 - Equipe;
2 - Área;
4 - Função;
5 - Usuário;
6 - Todos.
C ontrole de incluir:
2 - Não.
C ontrole de editar:
C ontrole de excluir:
2 - Não.
2 - Não.
C ontrole de listar:
2 - Não.
C ontrole de visualizar:
2 - Não.
Permissão:
2 - Negar.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Tipo de localização:
1 - Localização;
NMFIELD04 TEXTO 255
X 2 - Usuário;
3 - Localização e usuário.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Ativar/desativar ativos
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
1 - Ativar ativo;
NMFIELD02 X TEXTO 255
2 - Desativar ativo.
2 - Não.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
2 - Insumo.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
1 - Sim;
2 - Não.
C ontrolar revisão:
2 - Não.
2 - Texto;
3 - C ustomizado.
1 - Incremental;
2 - C ircular.
2 - Manual.
1 - Revisões;
NMFIELD12 TEXTO 255
2 - Meses;
3 - Anos.
2 - Variável.
1 - E;
2 - OU.
1 - E;
2 - OU.
1 - E;
2 - OU.
1 - E;
2 - OU.
4.6.5 - Calibração
§ Dados da calibração
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
2 – Excluir.
Identificador da classificação de
NMFIELD09 X TEXTO 255
atividade.
2 - Aprovado condicional;
3 - Reprovado.
1 – Aprovado;
2 - Reprovado.
Exemplo da inclusão:
Exemplo da exclusão:
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
2 – Ponto de descida.
2 – C alibração.
Variável complementar.
[Identificador da variável]=VALOR;
Exemplo de alteração:
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
2 – Pré-calibração.
Variável complementar.
[Identificador da variável]=VALOR;
2 = Reprovado.
2 = Reprovado.
Exemplo da inclusão:
4.6.6 - CEP
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
2 - C aracterística.
Formato:
DEFEC T01:3;DEFEC T\;02:4
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
2 – C aracterística.
4.6.7 - Competência
§ CPTREG - Competência
§ Competências
Para a inclusão, edição e exclusão de cada um destes itens é necessário seguir o padrão abaixo
documentado.
Inserir/editar/excluir dados
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro;
2 - Exclusão de competências.
Exemplo de inclusão/edição:
Exemplo de exclusão:
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
2 – Editar;
2 – Projeto;
3 – Atividade isolada;
2 – Receita;
Tipo de importação:
1 – Planejamento;
NMFIELD12 X NUMÉRIC O 2
2 – Replanejamento;
3 – Real;
§ Planejamento:
§ Replanejamento:
§ Realizado:
§ Planejamento:
§ Replanejamento:
§ Realizado:
§ Planejamento:
§ Replanejamento:
§ Realizado:
§ Planejamento:
§ Replanejamento:
§ Realizado:
§ Valores do recurso
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Exemplo da associação do calendário e valor inicial do custo e faturamento para recurso do tipo Trabalho:
Exemplo da associação do calendário e valor inicial do custo e faturamento para recurso do tipo Ativo:
§ Apontamento de horas
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Tipo de hora:
2 – Hora extra;
Tipo de atividade:
1 – Atividade de projeto;
2 – Atividade isolada;
4 – Reunião;
5 – Ação isolada;
4.6.9 - Desempenho
§ Itens para serem utilizados no Scorecard. Os itens devem ter um elemento cadastrado antecipadamente.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Para a inserção de cada um destes indicadores são necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Frequência do indicador:
1 - Anual;
2 - Semestral;
3 - Quadrimestral;
4 - Trimestral;
NMFIELD06 X NUMÉRIC O 2
5 - Bimestral;
6 - Mensal;
7 - Quinzenal;
8 - Semanal;
9 - Diário;
10 - Por evento
1 - Soma;
3 - Nenhum;
4 - Manual.
1 - Anual;
2 - Semestral;
3 - Quadrimestral;
4 - Trimestral;
NMFIELD09 NUMÉRIC O 2
5 - Bimestral;
6 - Mensal;
7 - Quinzenal;
8 - Semanal;
9 - Diário.
2 - Não.
Exemplo da inserção:
§ Itens no Scorecard. Os itens podem ser configurados conforme a necessidade do cliente. Exemplos:
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
0 - Não;
NMFIELD06 NUMÉRIC O 2
1 - Sim (Valor da pontuação) (Padrão);
Exemplo da inserção:
§ Indicadores de Scorecard.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
0 - Não;
NMFIELD06 NUMÉRIC O 2
1 - Sim (Valor da pontuação)(Padrão);
Segurança de visualização:
2 - Restrito.
Peso fixo?
2 - Não (Padrão).
Exemplo da inserção:
§ Sub-indicadores de Scorecard.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
2 - Não.
Exemplo da inserção:
Esta importação possui uma particularidade, os valores da ADINTERFACE são gravados na STINTERFACE
onde é feito uma validação dos valores antes de inserir no sistema. Para verificar se os registros foram
aceitos em todos os processos deve-se acessar a tela de Entrada de Meta ou Entrada de Medição e
selecionar o botão importar.
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado:
Inserir/editar
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
Exemplo da inserção/edição:
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Para a inserção de cada um destes itens na planilha é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
1 – Equipe
2 – Área
4 – Função
5 – Usuário
6 – Todos
Para a inserção de cada um destes itens na planilha é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Tipo de acesso.
1 – Equipe
2 – Área
3 – Área/Função
4 – Função
NMFIELD02 NUMÉRIC O 2
5 – Usuário
6 – Todos
Para a inserção de cada um destes itens na planilha é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
1 – Equipe
2 – Área
4 – Função
5 – Usuário
6 – Todos
Para a inserção de cada um destes itens na planilha é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Tipo de acesso.
1 – Equipe
2 – Área
3 – Área/Função
4 – Função
NMFIELD02 NUMÉRIC O 2
5 – Usuário
6 – Todos
4.6.10 - Documento
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Tipo de acesso:
2 - Área;
4 - Função;
5 - Usuário;
6 - Todos.
Tipo de permissão:
1 - Permitir;
NMFIELD03 TEXTO 255
2 - Negar.
Permissões:
1 - C onhecimento;
2 -Treinamento;
3 - Visualizar;
4 - Alterar;
5 - Excluir;
6 - Imprimir;
7 - Arquivar;
8 - Revisar;
9 - Distribuir cópia;
NMFIELD04 TEXTO 255
10 - Registrar Treinamento;
X
11 - C ancelar;
12 - Salvar Localmente;
13 - Assinar;
14 - Notificação;
15 - Incluir C omentário;
16 - Avaliar Aplicabilidade.
§ Dados de um documento.
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
1 - Herdar;
NMFIELD05 TEXTO 255
2 - Não herdar.
§ Dados de um atributo.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Tipo do atributo:
1 - Lista de valores;
NMFIELD04 X TEXTO 255
2 - Indeterminado;
3 - Externo.
Listas de Valores:
1 - Texto;
2 - Numérico;
3 - Data;
5 - Moeda.
Indeterminado
NMFIELD05 TEXTO 255
1 - Texto;
2 - Numérico;
3 - Data;
4 - Memorando;
5 - Moeda.
Externo
1 - Texto.
Modo de seleção.
1 - Zoom;
NMFIELD06 TEXTO 255
2 - C ombo.
1 - Multivalorado.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
Valor do atributo.
§ aaaa-mm-dd.
Identificador da revisão.
Valor do atributo.
DSFIELD01 X TEXTO 4000 Informação obrigatória caso o valor do
atributo seja do tipo MEMO.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Valor do atributo.
Tipo de BD.
1 - ITERBASE
2 - MSSQL
3 - MSSQL (ODBC )
7 - ORAC LE (ODBC )
8 - DB2 (ODBC )
9 - INFORMIX
11 - MySQL
12 - POSTGRESQL
C ampo.
· aaaa-mm-dd.
§ Documento
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Cancelar
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro;
Exemplo do cancelamento:
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
1 - C ompactação GZ.
2 - C ompactação ZIP.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
§ aaaa-mm-dd.
§ aaaa-mm-dd.
§ aaaa-mm-dd.
§ aaaa-mm-dd.
§ aaaa-mm-dd.
§ aaaa-mm-dd.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
1 - Equipe NMFIELD06
2 - Área NMFIELD07
NMFIELD02 X TEXTO 255
3 - Área/Função NMFIELD07/
NMFIELD08
4 - Função NMFIELD08
5 - Usuário NMFIELD09
Etapa da revisão.
Valores possíveis:
1 - Elaboração;
X TEXTO 255
NMFIELD03 2 - C onsenso;
3 - Aprovação;
4 - Homologação.
1 – Aprovado;
NMFIELD10 TEXTO 255
2 – Reprovado.
Obrigatório preenchimento do
NMFIELD11.
Data da aprovação/reprovação da
NMFIELD11 TEXTO 255 revisão.
4.6.11 - Inspeção
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir/editar
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
14 – Inserir;
FGOPTION X NUMÉRIC O 2
15 – Alterar;
16 – Excluir.
Tipo de frequência:
1 – Não controlada;
2 – Data de execução;
NMFIELD13 X4 TEXTO 255
3 – Inspecionar uma instância a cada... (só está
disponível quando houverem processos
envolvidos).
Unidade de frequência:
1 – Dias;
3 – Meses;
4 – Anos.
Situação da amostra:
1 – Bloqueado;
NMFIELD22 X7 TEXTO 255
2 – Amostra inicial;
3 – Liberado.
1 – Dias;
NMFIELD26 X8 TEXTO 255
2 – Semanas;
3 – Meses;
4 – Inspeções.
Registrar médias/leituras:
2 – Registrar leituras.
Regra:
1 – Plano de amostragem;
3 – Tamanho definido;
4 – Porcentagem.
Plano de amostragem:
1 – Simples;
NMFIELD29 X9 TEXTO 255
2 – Duplo;
3 – Múltipla.
Nível de inspeção:
NMFIELD30 X9 TEXTO 255 As opções disponíveis são os mesmos valores
mostrados na tela de dados da ficha de inspeção.
Regime de trabalho:
1 – Atenuado;
NMFIELD31 X9 TEXTO 255
2 – Normal;
3 – Severo.
NQA:
NMFIELD32 X9 TEXTO 255 As opções disponíveis são os mesmos valores
mostrados na tela de dados da ficha de inspeção.
§ X 4 – Obrigatório durante a inclusão caso o tipo de objeto da ficha permita que a frequência seja controlada
§ X 6 – Obrigatório durante a inclusão caso o tipo de objeto da ficha exija que a frequência de inspeção seja
preenchida
§ X 7 – Obrigatório durante a inclusão caso o tipo de objeto da ficha exija que a frequência de inspeção seja
preenchida e a opção de controlar amostra inicial esteja ativa
§ X 8 – Obrigatório durante a inclusão caso o tipo de objeto da ficha exija que a frequência de inspeção seja
preenchida, a opção de controlar amostra inicial e de controlar a validade estejam ativas.
§ X 9 – Obrigatório caso o tipo de objeto da ficha exija o preenchimento de um plano de amostragem e a opção da
regra de amostragem exija o preenchimento.
Exemplo de Inclusão:
Exemplo de Alteração:
Exemplo de Exclusão:
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir/editar
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
20 – Inserir característica;
FGOPTION X NUMÉRIC O 2
21 – Alterar característica;
22 – Excluir característica.
Requerido:
2 – Não requerido.
Unidade de frequência:
1 – Dias;
3 – Meses;
4 – Inspeções.
Registrar médias/leituras:
2 – Registrar leituras.
Regra:
1 – Plano de amostragem;
3 – Tamanho definido;
4 – Porcentagem.
Plano de amostragem:
1 – Simples;
NMFIELD09 X3 TEXTO 255
2 – Duplo;
3 – Múltipla.
Nível de inspeção:
NMFIELD10 X3 TEXTO 255 As opções disponíveis são os mesmos valores
mostrados na tela de dados da ficha de inspeção.
Regime de trabalho:
1 – Atenuado;
NMFIELD11 X3 TEXTO 255
2 – Normal;
3 – Severo.
NQA:
NMFIELD12 X3 TEXTO 255 As opções disponíveis são os mesmos valores
mostrados na tela de dados da ficha de inspeção.
Exemplo de Associação:
Exemplo de Alteração:
Exemplo de Desassociação:
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Associação
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
26 – Desassociar checklist.
Exemplo de associação:
Exemplo de desassociação:
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
11 – Incluir;
FGOPTION X NUMÉRIC O 2 12 – Alterar;
§ X 1 – Obrigatório para inspeções onde o Objeto, Processo, Atividade do Processo ou Fornecedor fizerem parte da
avaliação, caso contrário são ignorados.
Exemplo de inclusão:
Exemplo de alteração:
Exemplo de exclusão:
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
§ Dados do recebimento
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir/editar/excluir recebimento
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
3 – Incluir;
FGOPTION X NUMÉRIC O 2
4 – Alterar;
5 – Excluir.
§ X 2 – Obrigatório para inspeções de Insumos, Serviços e Produtos acabados externos, ignorado para outros tipos
de objetos.
§ X 3 – Obrigatório, não-obrigatório ou ignorado, dependendo das configurações do tipo da ficha de inspeção definida.
§ X 4 – Obrigatório caso a opção “Permitir alterar o fluxo durante o recebimento” estiver marcada na ficha de
inspeção, ou ignorado caso contrário.
§ X 5 – Obrigatório caso o objeto da inspeção seja uma instância de processo do Workflow, caso contrário é ignorado.
Exemplo de inclusão:
Exemplo de alteração:
Exemplo de exclusão:
4.6.12 - Insumo
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado:
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
§ aaaa-mm-dd.
Exemplo:
§ Definição do Insumo.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
2 – Excluir insumo.
NMFIELD03 X
1 TEXTO 255 Tipo do insumo (identificador).
§ Insumo na estrutura.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
§ Tipo de Insumo.
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
1 – Sim;
2 – Não.
C ontrolar revisão:
2 – Não.
Modelo de Revisão:
1 – Modelo ISO9000;
NMFIELD07 TEXTO 255
2 – Workflow.
Tipo do roteiro:
1 – Fixo;
3 – Fixo único.
Processo (Identificador):
NMFIELD10 TEXTO 255 Requerido caso modelo de revisão seja
WORKFLOW.
Identificador da revisão:
1 – Numérico;
3 – C ustomizado.
C iclo:
1 – Numérico;
NMFIELD12 TEXTO 255
2 – Texto.
2 – Meses;
3 – Anos.
Alteração:
1 – Texto;
NMFIELD15 TEXTO 255
2 – Numérico.
1 – Incremental;
NMFIELD16 TEXTO 255
2 – C ircular.
1 – Automático;
NMFIELD17 TEXTO 255
2 – Manual.
1 – E;
NMFIELD18 TEXTO 255
2 – OU.
1 – E;
NMFIELD19 TEXTO 255
2 – OU.
1 – E;
NMFIELD20 TEXTO 255
2 – OU.
1 – E;
NMFIELD21 TEXTO 255
2 – OU.
2 – Não.
4.6.13 - Manutenção
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir/editar/excluir ativo
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Técnico responsável:
identificador_do_atributo1=valor_do
_atributo1;
identificador_do_atributo1=valor1_d
o_atributo1,valor2_do_atributo1,val
DSFIELD01 X3 TEXTO 4000
or3_do_atributo1.
§ X¹ - Requerido caso o(s) campo(s) "Data de início" e/ou "Hora de início" e/ou "Porcentagem real" estiver(em)
preenchido(s)
Exemplo de inclusão:
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir Leitura
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Valor da leitura.
X¹ - Requerido caso a ação seja Nova leitura de medidor. Não-requerido caso a ação seja Novo reinício de medidor.
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Inserir Leitura
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
4.6.14 - PDM
Este modelo de importação possibilita a importação de atributos ao cadastro de item e determinar o valor
para os mesmos.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado:
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
Valor do atributo.
§ dd/mm/aaaa;
§ aaaa-mm-dd.
Valor do atributo.
DSFIELD01 TEXTO 4000 Informação obrigatória caso o valor
do atributo seja do tipo MEMO
Exemplo:
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
2 - Insumo.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado:
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
15 – Somente insere;
16 – Somente edita;
FGOPTION X NUMÉRIC O 2
17 – Inserir e caso já existir registro com
o mesmo identificador edita o registro
existente.
C aracterística especial:
2 – Não.
Exemplo:
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado:
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado:
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
18 – Somente insere;
19 – Somente edita;
FGOPTION X NUMÉRIC O 2
20 – Inserir e caso já existir registro com
o mesmo identificador edita o registro
existente.
C aracterística especial:
2 – Não.
Limites:
0 – Bilateral;
NMFIELD10 X TEXTO 255
1 – Unilateral para cima;
Exemplo:
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
X 2 - C ampo requerido caso “C ódigo da Empresa” esteja vazio (válido também para a exclusão).
X 3 - C ampo requerido caso “C ódigo da Empresa” esteja vazio (válido também para a exclusão).
X 4 - C ampo requerido caso “Nome Fantasia” e/ou “Razão social” estejam vazios (válido também para a exclusão).
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Exemplo:
§ Dados de um item.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir/editar/excluir item
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
2 - Excluir item.
Estado físico:
1 – Solido;
3 – Gaseoso;
4 – Pastoso.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
7 – Inserir/Alterar associação de
FGOPTION X NUMÉRIC O 2 fabricantes aos itens;
X 2 - C ampo requerido caso “C ódigo da Empresa” esteja vazio. (válido também para a exclusão).
X 3 - C ampo requerido caso “C ódigo da Empresa” esteja vazio. (válido também para a exclusão).
X 4 - C ampo requerido caso “Nome Fantasia” e/ou “Razão social” estejam vazios. (válido também para a exclusão).
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
1 - Equipe;
2 - Área;
4 - Função;
5 - Usuário;
6 - Todos.
C ontrole de incluir:
2 - Não.
C ontrole de editar:
C ontrole de excluir:
2 - Não.
2 - Não.
C ontrole de listar:
2 - Não.
C ontrole de visualizar:
2 - Não.
Permissão:
2 - Negar.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
1 - Dia;
3 - Mês;
4 - Ano.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
1 - Sim;
2 - Não.
C ontrolar revisão:
2 - Não.
2 - Texto;
3 - C ustomizado.
1 - Incremental;
2 - C ircular.
2 - Manual.
2 - Meses;
3 - Anos.
2 - Variável.
1 - E;
2 - OU.
1 - E;
2 - OU.
1 - E;
2 - OU.
1 - E;
2 - OU.
Marca d’água:
2 - Não.
2 - Não.
Tipo de arquivo:
1 - Simples;
NMFIELD20 X TEXTO 255
2 - Múltiplo;
3 - C omplexo.
4.6.15 - Projeto
Inserir
2 - Editar
2 - Projeto;
3 - Atividade isolada;
4 - Programa;
Tipo de importação:
1 - Planejamento;
NMFIELD12 X NUMÉRIC O 2
2 - Replanejamento;
3 - Real.
Os valores aceitos para a importação de datas devem seguir um dos seguintes padrões:
§ AAAA-MM-DD
§ DD/MM/AAAA
Planejamento:
Replanejamento:
Realizado:
Planejamento:
Replanejamento:
Realizado:
Planejamento:
Replanejamento:
Realizado:
Planejamento:
Replanejamento:
Realizado:
§ Valores do recurso;
Para a inserção de cada um destes itens é necessários seguir o padrão abaixo documentado.
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro.
Associação do calendário e valor inicial do custo e faturamento para recurso do tipo Trabalho:
Associação do calendário e valor inicial do custo e faturamento para recurso do tipo Ativo:
§ Apontamento de horas;
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Tipo de hora:
2 - Hora extra.
Tipo de atividade:
1 - Atividade de projeto;
2 - Atividade isolada;
4 - Reunião;
5 - Ação isolada;
4.6.16 - Questionário
Para a inserção de cada um destes respondentes é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
FGIMPORT X NUMÉRIC O 2 2 – Em andamento;
3 – Encerrado;
4 – Erro;
4.6.17 - Resíduo
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Valor do atributo.
§ aaaa-mm-dd.
Identificador da revisão.
§ Dados de um atributo.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Tipo do atributo:
1 - Lista de valores;
NMFIELD04 X TEXTO 255
2 - Indeterminado;
3 - Externo.
Listas de valores:
1 - Texto;
2 - Numérico;
3 - Data;
5 - Moeda.
Indeterminado:
NMFIELD05 TEXTO 255
1 - Texto;
2 - Numérico;
3 - Data;
4 - Memorando;
5 - Moeda.
Externo:
1 - Texto.
Modo de seleção.
1 - Zoom;
NMFIELD06 TEXTO 255
2 - C ombo.
1 - Multivalorado.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Valor do atributo.
· aaaa-mm-dd.
Identificador da revisão.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Valor do atributo.
Tipo de BD.
1 - ITERBASE;
2 - MSSQL;
3 - MSSQL (ODBC );
7 - ORAC LE (ODBC );
8 - DB2 (ODBC );
9 - INFORMIX;
11 - MySQL;
12 - POSTGRESQL.
C ampo.
· aaaa-mm-dd.
4.6.18 - Risco
§ RISCONSEQUENCE – Consequência
§ RISCONTROL – Controle
§ RISITEM – Elemento
§ RISOBJECTIVE – Objetivo
§ RISRISK – Risco
§ RISTREATMENT – Tratamento
§ Valores aos atributos de um controle. Para inserir mais de um valor a um atributo multivalorado, repetir
Para a inserção de cada um destes tens é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Valor do atributo
§ dd/mm/aaaa;
NMFIELD03 TEXTO 255
§ dd-mm-aaaa;
§ hhhh:mm.
X 1 - A coluna NMFIELD03 é obrigatória para todos os atributos, EXC ETO os de tipo Memorando, onde a coluna
DSFIELD01 deve ser preenchida.
§ Valores aos atributos de um risco. Para inserir mais de um valor a um atributo multivalorado, adicionar
outra linha com os mesmos dados e alterar apenas o valor do atributo (NMFIELD03).
Para a inserção de cada um destes tens é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
FGIMPORT X NUMÉRIC O 2 2 – Em andamento;
3 – Encerrado;
4 – Erro;
Valor do atributo
§ dd/mm/aaaa;
NMFIELD03 TEXTO 255
§ dd-mm-aaaa;
§ hhhh:mm.
X 1 - A coluna NMFIELD03 é obrigatória para todos os atributos, EXC ETO os de tipo Memorando, onde a coluna
DSFIELD01 deve ser preenchida.
§ Melhores práticas.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
§ Consequências.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
§ Tipos de consequência.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
§ Controles.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Implementação:
1 – Não implementado;
NMFIELD06 NUMÉRIC O 2
2 – Implementado parcialmente;
3 – Implementado totalmente;
Relevante:
2 – Não;
Tipo da automatização:
1 – Automático;
NMFIELD09 NUMÉRIC O 2
2 – Semiautomático;
3 – Manual;
C aracterística do controle:
2 – Preventivo;
Automatização:
1 – Workflow;
NMFIELD11 NUMÉRIC O 2
2 – Questionário;
3 – Teste;
Identificador do Processo
NMFIELD12 TEXTO 50 (Apenas será considerado se o controle
for automatizado por Workflow)
Identificador do formulário de
Questionário
NMFIELD13 TEXTO 50
(Apenas será considerado se o controle
for automatizado por Questionário)
Identificador do Procedimento
(Documento)
NMFIELD15 TEXTO 50
(Apenas será considerado se o controle
for automatizado)
§ Tipos de controle.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
§ Elementos.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
§ Tipos de elemento.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
§ Objetivos.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
§ Tipos de objetivo.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
§ Riscos.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
C lassificação do risco:
2 – Oportunidade;
§ Tipos de risco.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
§ Fontes de risco.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
§ Tratamentos.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
§ Tipos de tratamento.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 - Novo;
3 - Encerrado;
4 - Erro.
4.6.19 - Teste
§ Respondentes convidados que serão cadastrados no teste. O teste deverá estar cadastrado
antecipadamente.
Para a inserção de cada um destes respondentes é necessários seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Exemplo da Inserção:
4.6.20 - Treinamento
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserira/editar
Status da importação:
1 – Novo;
FGIMPORT X NUMÉRIC O 2 2 – Em andamento;
3 – Encerrado;
4 – Erro;
129
Exemplo:
§ Treinamentos
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Inserir
Status da importação:
1 – Novo;
3 – Encerrado;
4 – Erro;
Exemplo:
Capítulo V
A seção Web services publicados define todos os Web Services publicados no sistema, e o que deve ser
preenchido em cada uma deles. Também contém um exemplo de client utilizando a linguagem Java.
IMPORTANTE!
§ O uso da integração via web services não é recomendado para carga de grande volume de dados.
§ É recomendável a criação de um usuário específico no SE Suite para realizar as integrações via web services. Este
usuário deve possui uma licença "Gestor", não deve ser sincronizado com o AD e não deve ser utilizado para acessar
o sistema no dia-a-dia, pois ele deve ser de uso exclusivo para as integrações. Desta forma, facilita tanto a gestão
das permissões de acesso desse usuário às integrações disponibilizadas, quanto à manutenção do histórico de
integrações realizadas, o qual pode ser extraído observando os registros inseridos por este usuário.
Para dar um auxílio ainda maior na criação de integrações, é disponibilizado, para cada serviço duas
classes JAVA, uma de requisição e outra de retorno do serviço, utilizando a biblioteca Apache Axis 2. O
caminho das classes para consulta está detalhado em cada serviço.
Autenticação e comunicação
Para autenticação de Web Services Java ou PHP, serão utilizados os mesmos recursos disponibilizados pelo
SE Suite para login. Essa autenticação será feita através de uma servlet disponibilizada para este fim, a
qual também será responsável por redirecionar a chamada ao destino final, o web service.
O componente utilizado para fazer a comunicação com os Web services é compatível com o SOAP 1.2.
O domínio padrão do SE Suite é "SE Suite". Porém, se for utilizada autenticação via AD, deve ser utilizado o
identificador do domínio, o mesmo informado na configuração do servidor de autenticação no SE Configuração.
Nota: Para a elaboração do arquivo php de conexão, é necessário inserir por meio da tag location o
endereço do WSDL para a conexão conforme exemplo abaixo:
// URL do WSDL
$wsdl = "http://$server/se/ws/dc_ws.php?wsdl";
$location = "http://$server/softexpert/webserviceproxy/se/ws/conteudo.php";
§ Administração
§ Arquivo físico
§ Ativo
§ Calibração
§ CEP
§ Controle de atividades
§ Desempenho
§ Documento
§ Generic
§ Incidente
§ Inspeção
§ Insumo
§ Manutenção
§ PDM
§ Problema
§ Projeto
§ Solicitação
§ Workflow
5.2.1 - Administração
Web Services
https://<domínio>/softexpert/webserviceproxy/se/ws/adm_ws.ph
URL do Web Service:
p
Nesta seção são apresentadas as interfaces disponíveis para o SE Administração. Para a inserção de cada
um destes itens será necessário seguir o padrão documentado nas próximas seções.
Método Descrição
Método Descrição
5.2.1.1 - addAttribProfileValue
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\admin\AddAttribProfileValueRequestType.java
Retorno web\wwwroot\ws\java\admin\AddAttribProfileValueResponseType.java
Requisição
Valor do atributo.
§ aaaa-mm-dd.
X 1 - Requerido quando o tipo de dados do atributo for MEMORANDO e o tipo de atributo for INDETERMINADO.
Retorno
Identificador Descrição
SUC ESSO: 1.
return
FALHA: Mensagem descrevendo o erro.
5.2.1.2 - AddAttribute
§ Dados de atributos
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado:
Classe Java
Requisição web\wwwroot\ws\java\admin\AddAttributeRequestType.java
Retorno web\wwwroot\ws\java\admin\AddAttributeResponseType.java
Requisição
DSMASK Máscara
Retorno
Identificador Descrição
5.2.1.3 - addAttributeValue
§ Valores em atributos
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado
Classe Java
Requisição web\wwwroot\ws\java\admin\AddAttribValueRequestType.java
Retorno web\wwwroot\ws\java\admin\AddAttribValueResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.1.4 - AddCompany
§ Dados de empresas;
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Este método possibilita associar valores de atributos a empresas. Para a inserção de cada um destes itens
é necessário seguir o padrão abaixo documentado:
Classe Java
Requisição web\wwwroot\ws\java\admin\AddCompanyRequestType.java
Retorno web\wwwroot\ws\java\admin\AddCompanyResponseType.java
Requisição
dsaddress Endereço.
nmcity C idade.
idstate Estado.
nmcountry País.
idzipcode C EP.
idphone Telefone.
idfax FAX.
dscompany Descrição.
Retorno
Identificador Descrição
5.2.1.5 - AddCompContact
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\admin\AddCompContactRequestType.java
Retorno web\wwwroot\ws\java\admin\AddCompContactResponseType.java
Requisição
NMDEPARTMENT Área.
NMPOSITION Função.
IDPHONE Telefone.
IDFAX Fax.
NMEMAIL E-mail.
Retorno
Identificador Descrição
5.2.1.6 - AddMeasUnity
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado:
Classe Java
Requisição web\wwwroot\ws\java\admin\AddMeasUnityRequestType.java
Retorno web\wwwroot\ws\java\admin\AddMeasUnityResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.1.7 - AddUserDepartment
Este método possibilita inserir um relacionamento entre usuário, área e função. Para esta inserção é
necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\admin\AddUserDepartmentRequestType.java
Retorno web\wwwroot\ws\java\admin\AddUserDepartmentResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.1.8 - ChangePositionStatus
Este método possibilita modificar o status de uma função de desabilitado para habilitado e vice-versa. Para
esta operação é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\admin\ChangePositionStatusRequestType.java
Retorno web\wwwroot\ws\java\admin\ChangePositionStatusResponseType.java
Requisição
ID X Identificador da função
Retorno
Identificador Descrição
5.2.1.9 - compAtribAssoc
Este método possibilita associar valores de atributos a empresas. Para a inserção de cada um destes itens
é necessário seguir o padrão abaixo documentado:
Classe Java
Requisição web\wwwroot\ws\java\admin\CompAtribAssocRequestType.java
Retorno web\wwwroot\ws\java\admin\CompAtribAssocResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.1.10 - DeleteCompany
Este método possibilita excluir empresas. Para a exclusão de cada um destes itens é necessário seguir o
padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\admin\DeleteCompanyRequestType.java
Retorno web\wwwroot\ws\java\admin\DeleteCompanyResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.1.11 - DeleteCompContact
Este método possibilita excluir contatos de empresas. Para a exclusão de cada um destes itens é
necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\admin\DeleteCompContactRequestType.java
Retorno web\wwwroot\ws\java\admin\DeleteCompContactResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.1.12 - DeleteDepartment
Este método possibilita excluir uma área. Para a exclusão deste é necessário seguir o padrão abaixo
documentado.
Classe Java
Requisição web\wwwroot\ws\java\admin\DeleteDepartmentRequestType.java
Retorno web\wwwroot\ws\java\admin\DeleteDepartmentResponseType.java
Requisição
ID X Identificador da área
Retorno
Identificador Descrição
5.2.1.13 - DeleteMeasUnity
Este método possibilita excluir unidades de medida. Para a exclusão de cada um destes itens é necessário
seguir o padrão abaixo documentado
Classe Java
Requisição web\wwwroot\ws\java\admin\DeleteMeasUnityRequestType.java
Retorno web\wwwroot\ws\java\admin\DeleteMeasUnityResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.1.14 - DeleteUser
Este método possibilita excluir um usuário. Para a exclusão deste é necessário seguir o padrão abaixo
documentado.
Classe Java
Requisição web\wwwroot\ws\java\admin\DeleteUserRequestType.java
Retorno web\wwwroot\ws\java\admin\DeleteUserResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.1.15 - DeleteUserAcessGroup
Este método possibilita excluir um relacionamento entre usuário e grupo de acesso. Para esta exclusão, é
necessário seguir o padrão abaixo documentado.
Classe Java
web\wwwroot\ws\java\admin\DeleteUserDepartmentAcessGroupRequestType.j
Requisição
ava
Retorno web\wwwroot\ws\java\admin\DeleteUserAcessGroupResponseType.java
Requisição
ID X Identificador do usuário.
Retorno
Identificador Descrição
5.2.1.16 - DeleteUserDepartment
Este método possibilita excluir um relacionamento entre usuário, área e função. Para esta exclusão é
necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\admin\DeleteUserDepartmentRequestType.java
Retorno web\wwwroot\ws\java\admin\DeleteUserDepartmentResponseType.java
Requisição
ID X Identificador do usuário.
Retorno
Identificador Descrição
5.2.1.17 - deleteUserLeader
Este método possibilita remover o líder associado a um usuário. Para sua utilização, é necessário seguir o
padrão abaixo documentado.
Classe Java
Retorno web\wwwroot\ws\java\admin\DeleteUserLeaderResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.1.18 - disableUser
Este método possibilita desabilitar/habilitar um usuário. Para sua utilização, é necessário seguir o padrão
abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\admin\DisableUserRequestType.java
Retorno web\wwwroot\ws\java\admin\DisableUserResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.1.19 - EditDepartment
Este método possibilita editar os dados de uma área. Para alterar estes dados é necessário seguir o
padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\admin\EditDepartmentRequestType.java
Retorno web\wwwroot\ws\java\admin\EditDepartmentResponseType.java
Requisição
ID X Identificador da área
Retorno
Identificador Descrição
5.2.1.20 - EditUser
Este método possibilita editar os dados de um usuário. Para a edição deste é necessário seguir o padrão
abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\admin\EditUserRequestType.java
Retorno web\wwwroot\ws\java\admin\EditUserResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.1.21 - editUserDepartment
Este método possibilita editar o relacionamento entre usuário, área e função associados a um usuário. Se
o usuário já possuir uma área padrão, a mesma será substituída e a nova será considerada como padrão.
Para sua utilização, é necessário seguir o padrão abaixo documentado
Classe Java
Requisição web\wwwroot\ws\java\admin\EditUserDepartmentRequestType.java
Retorno web\wwwroot\ws\java\admin\EditUserDepartmentResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.1.22 - getAttribData
Este método possibilita buscar os dados de um atributo. Para sua utilização, é necessário seguir o padrão
abaixo documentado.
Classe Java
Retorno web\wwwroot\ws\java\admin\GetAttribDataResponseType.java
Requisição
Exemplo: "Atributo1,Atributo2,Atributo3"
Retorno
Identificador Descrição
SUC ESSO: Deverá ser retornado um array com as seguintes informações do atributo:
5.2.1.23 - NewDepartment
Este método possibilita inserir os dados de uma área. Para esta inserção é necessário seguir o padrão
abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\admin\NewDepartmentRequestType.java
Retorno web\wwwroot\ws\java\admin\NewDepartmentResponseType.java
Requisição
ID X Identificador da área
Retorno
Identificador Descrição
5.2.1.24 - NewPosition/EditPosition
Este método possibilita inserir/editar os dados de uma função. Para esta inserção/edição é necessário
seguir o padrão abaixo documentado.
Classe Java
web\wwwroot\ws\java\admin\NewPositionRequestType.java
Requisição
web\wwwroot\ws\java\admin\EditPositionRequestType.java
web\wwwroot\ws\java\admin\NewPositionResponseType.java
Retorno
web\wwwroot\ws\java\admin\EditPositionResponseType.java
Requisição
ID X Identificador da função.
Retorno
Identificador Descrição
5.2.1.25 - NewUser
§ Dados de um usuário;
Se o usuário já existir e estiver sendo informada uma área diferente da qual o usuário já está associado, a
nova área será associada e considerada como a padrão;
Se o usuário já existir e algum campo for alterado com a mesma área e função já cadastrada, o sistema irá
retornar erro informando que o usuário já está sendo utilizado por essa área e função. Para realizar uma
edição, deverá ser informado em branco o identificador de IDAREA e IDFUNC. Caso o objetivo for a
alteração de área e função, pode ser informado essas duas informações que o sistema irá fazer essa
alteração.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\admin\NewUserRequestType.java
Retorno web\wwwroot\ws\java\admin\NewUserResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.1.26 - updateEmployeeProfile
§ Nível de instrução;
§ Data de nascimento;
§ Data de admissão;
§ Data de demissão;
§ Observação;
§ Endereço.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
web/wwwroot/ws/java/administration/UpdateEmployeeProfileRequestType.j
Requisição
ava
web/wwwroot/ws/java/administration/UpdateEmployeeProfileResponseType.
Retorno
java
Requisição
1 - C ompleto;
FGEDULEVELSTATUS
2 - Incompleto;
DSADDRESS Endereço
DSOBS Observação
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Mensagem descrevendo o erro
Os valores aceitos para a importação de datas devem seguir um dos seguintes padrões:
§ AAAA-MM-DD
§ DD/MM/AAAA
Web Services
Nesta seção são apresentadas as interfaces disponíveis para o SE Arquivo físico. Para a inserção de cada
um destes itens será necessário seguir o padrão documentado nas próximas seções.
Método Descrição
5.2.2.1 - newPhysicalFileLoan
Este método possibilita inserir um registro de empréstimo de arquivo físico. Para esta ação é necessário
seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/archival/NewPhysicalFileLoanRequestType.java
Retorno web/wwwroot/ws/java/archival/NewPhysicalFileLoanResponseType.java
Requisição
Retorno
Identificador Descrição
Status FAILURE (em caso de falha) / SUC C ESS (em caso de sucesso)
· 6 - Documento já emprestado;
· 7 - Documento em tramitação;
· 9 - Documento já eliminado;
C ódigo do registro de empréstimo criado (em caso de sucesso) ou vazio (em caso de
RecordID
falha)
5.2.3 - Ativo
Web Services
Nesta seção são apresentadas as interfaces disponíveis para o SE Ativo. Para a inserção de cada um
destes itens será necessário seguir o padrão documentado nas próximas seções.
Método Descrição
5.2.3.1 - del_objectType
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\asset\Del_objectTypeRequestType.java
Retorno web\wwwroot\ws\java\asset\Del_objectTypeResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.3.2 - delete_assetConfSite
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\asset\Delete_assetConfSiteRequestType.java
Retorno web\wwwroot\ws\java\asset\Delete_assetConfSiteResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.3.3 - import_asset
§ Dados de um ativo;
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\asset\Import_assetRequestType.java
Retorno web\wwwroot\ws\java\asset\Import_assetResponseType.java
Requisição
Especificação do ativo:
1 - Instrumento;
2 - Equipamento;
FGAPPLIC ATION X 4 - Outros;
6 - Ferramental;
7 – Ferramentas;
11 – C omputador.
IDMODEL Modelo.
DSOBSERVATION Observações
Retorno
Identificador Descrição
5.2.3.4 - import_asset_oee
Classe Java
Requisição web\wwwroot\ws\java\asset\Import_asset_oeeRequestType.java
Retorno web\wwwroot\ws\java\asset\Import_asset_oeeResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.3.5 - import_asset_site
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\asset\Import_asset_siteRequestType.java
Retorno web\wwwroot\ws\java\asset\Import_asset_siteResponseType.java
Requisição
Tipo de localização:
1 - Localização,
TYPE X
2 - Usuário,
3 - Localização/Usuário
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.3.6 - import_asset_state
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\asset\Import_asset_stateRequestType.java
Retorno web\wwwroot\ws\java\asset\Import_asset_stateResponseType.java
Requisição
DSOBSERVATION Observação
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.3.7 - import_asset_status
§ Situação de um ativo;
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\asset\Import_asset_statusRequestType
Retorno web\wwwroot\ws\java\asset\Import_asset_statusResponseType
Requisição
Situação do ativo:
FGASSTATUS X 1 – Ativar;
2 – Desativar.
RESERVE X 1 – Sim;
2 – Não.
DSJUSTIFY X Justificativa
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.3.8 - import_asset_structure_insert_update
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
web\wwwroot\ws\java\asset\Import_asset_structure_insert_updateRequest
Requisição
Type.java
web\wwwroot\ws\java\asset\Import_asset_structure_insert_updateRespons
Retorno
eType.java
Requisição
VLQUANTITY X Quantidade
2 - Insumo.
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.3.9 - import_assetConfSite
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\asset\Import_assetConfSiteRequestType.java
Retorno web\wwwroot\ws\java\asset\Import_assetConfSiteResponseType.java
Requisição
1 - Ativo
FGENABLED X
2 - Inativo
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.3.10 - import_attrib_assoc
Para a associação dos atributos obter sucesso é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\asset\Import_attrib_assocRequestType.java
Retorno web\wwwroot\ws\java\asset\Import_attrib_assocResponseType.java
Requisição
Valor do atributo.
Padrões para entrada de dados do tipo data:
VALUE X
- dd/mm/aaaa;
- aaaa-mm-dd.
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.3.11 - import_del_asset
§ Dados de um ativo;
Para a exclusão de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\asset\Import_del_assetRequestType.java
Retorno web\wwwroot\ws\java\asset\Import_del_assetResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.3.12 - import_del_asset_site
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\asset\Import_del_asset_siteRequestType.java
Retorno web\wwwroot\ws\java\asset\Import_del_asset_siteResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.3.13 - import_del_asset_state
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\asset\Import_del_asset_stateRequestType.java
Retorno web\wwwroot\ws\java\asset\Import_del_asset_stateResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.3.14 - Import_del_asset_structure
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\asset\Import_asset_del_structureRequestType.java
Retorno web\wwwroot\ws\java\asset\Import_asset_del_structureResponseType.java
Requisição
2 - Insumo.
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.3.15 - import_objectSecurity
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\asset\Import_objectSecurityRequestType.java
Retorno web\wwwroot\ws\java\asset\Import_objectSecurityResponseType.java
Requisição
1 - Grupo de usuários,
2 - Área,
AC C ESSTYPE X 3 - Área/Função,
4 - Função,
5 - Usuário,
6 - Todos
Tipo de permissão:
PERMISSION X 1 - Permitir,
2 - Negar
C ontrole de incluir:
INSERT X1 1 - Sim,
2 - Não
C ontrole de editar:
EDIT X1 1 - Sim,
2 - Não
C ontrole de deletar:
DELETE X1 1 - Sim,
2 - Não
C ontrole de segurança:
2 - Não
C ontrole de listagem:
LIST X1 1 - Sim,
2 - Não
C ontrole de visualização:
VIEW X1 1 - Sim,
2 - Não
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.3.16 - import_objectType
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\asset\Import_objectTypeRequestType.java
Retorno web\wwwroot\ws\java\asset\Import_objectTypeResponseType.java
Requisição
2 - Não
2 - Não
1 - Texto
2 - Numérico
FGEDITID
3 - C ustomizado
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.3.17 - importPlanActivity
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\asset\ImportPlanActivityRequestType.java
Retorno web\wwwroot\ws\java\asset\ImportPlanActivityRequestType.java
Requisição
Opção da ação:
FGOPTION X 21 – Incluir;
22 – Editar.
Tipo do plano:
1 – Verificação;
FGPLANTYPE X¹
2 – Manutenção preventiva;
3 – C alibração.
C onfiguração do plano:
Ex: IDATIVO01;IDATIVO02;IDATIVO03
FGDATEFREQUENC Y 1 – Habilitar;
2 – Desabilitar.
Tipo da frequência:
1 – Data de execução;
FGFREQTYPE X³
2 – Primeiro uso;
3 – Tempo de uso.
QTFREQUENC E X³ Frequência
Unidade de frequência:
1 – Dia(s);
2 – Semana(s);
FGFREQUNIT X³
3 – Mês(es);
4 – Ano(s);
5 – Dia(s) útil(eis).
Visualização da data:
FGDATEVIEW X³ 1 – Dia/Mês/Ano;
2 – Mês/Ano.
FGMETERFREQUENC Y 1 – Habilitar;
2 – Desabilitar.
VLMETERFREQUENC Y X4 Frequência
2 – Desabilitar.
FGAUTOSTATUS X5 1 – Planejamento;
2 – A iniciar.
§ X²: Requerido na inserção se a configuração do plano for de cópia (FGPLANC ONF = 2).
§ X5: Requerido se a opção de criar atividade automaticamente estiver habilitada (FGAUTOC REATE = 1).
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.4 - Calibração
Web Services
Nesta seção são apresentadas as interfaces disponíveis para o SE Calibração. Para a inserção de cada um
destes itens será necessário seguir o padrão documentado nas próximas seções.
Método Descrição
5.2.4.1 - import_calibration
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\calibration\Import_calibrationRequestType.java
Retorno web\wwwroot\ws\java\calibration\Import_calibrationResponseType.java
Requisição
Responsável:
RESP X § C entro de serviço interno: Matrícula
§ C entro de serviço externo: Nome
C ALRESULT 1 - Aprovado;
2 - Aprovado condicional;
3 - Reprovado;
1 - Aprovado;
2 - Reprovado;
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.4.2 - import_del_calibration
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
web\wwwroot\ws\java\calibration\Import_del_calibrationRequestType.jav
Requisição
a
web\wwwroot\ws\java\calibration\Import_del_calibrationResponseType.ja
Retorno
va
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.4.3 - import_point
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\calibration\Import_pointRequestType.java
Retorno web\wwwroot\ws\java\calibration\Import_pointResponseType.java
Requisição
FGUPORDOWN X1 1- Subida
2- Descida
Indica se é:
TYPE_VALUE X1 1- C alibração
2- Pré-calibração
Variável extra.
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.4.4 - import_table
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\calibration\Import_tableRequestType.java
Retorno web\wwwroot\ws\java\calibration\Import_tableResponseType.java
Requisição
Indica se é:
TYPE_VALUE X 1- C alibração
2- Pré-calibração
Variável extra.
RESULT 1 - Aprovado;
2 - Reprovado;
RESULTDI 1 - Aprovado;
2 - Reprovado;
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.5 - CEP
Web Services
Nesta seção são apresentadas as interfaces disponíveis para o SE CEP. Para a inserção de cada um destes
itens será necessário seguir o padrão documentado nas próximas seções.
Método Descrição
5.2.5.1 - ChangeStatusSample
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/spc/ChangeStatusSampleRequestType.java
Retorno web/wwwroot/ws/java/spc/ChangeStatusSampleResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.5.2 - DeleteAttCause
Este método possibilita a exclusão de causas de defeitos de uma amostra (zera as causas).
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/spc/DeleteAttCauseRequestType.java
Retorno web/wwwroot/ws/java/spc/DeleteAttCauseResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.5.3 - DeleteAttDefect
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/spc/DeleteAttDefectRequestType.java
Retorno web/wwwroot/ws/java/spc/DeleteAttDefectResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.5.4 - DeleteSampleAtt
Este método possibilita a exclusão de uma amostra do tipo atributo de uma coleta
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/spc/DeleteSampleAttRequestType.java
Retorno web/wwwroot/ws/java/spc/DeleteSampleAttResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.5.5 - DeleteSampleVar
Este método possibilita a exclusão de uma amostra do tipo variável de uma coleta
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/spc/DeleteSampleVarRequestType.java
Retorno web/wwwroot/ws/java/spc/DeleteSampleVarResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.5.6 - ImportAttCause
Este método possibilita alterar a quantidade de causas de um defeito da amostra do tipo atributo de uma
coleta de dados.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/spc/ImportAttCauseRequestType.java
Retorno web/wwwroot/ws/java/spc/ImportAttCauseResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.5.7 - ImportAttDefect
Este método possibilita alterar a quantidade de defeitos da amostra do tipo atributo de uma coleta de
dados.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/spc/ImportAttDefectRequestType.java
Retorno web/wwwroot/ws/java/spc/ImportAttDefectResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.5.8 - ImportSampleAtt
Este método possibilita a importação de uma amostra do tipo atributo em uma coleta que possua uma
característica do tipo atributo.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/spc/ImportSampleAttRequestType.java
Retorno web/wwwroot/ws/java/spc/ImportSampleAttResponseType.java
Requisição
NMLOT Lote
NMMO OF
Formato:
DEFEC T01:3;DEFEC T\;02:4
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.5.9 - ImportSampleVar
Este método possibilita a importação de uma amostra do tipo variável em uma coleta que possua uma
característica do tipo variável.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/spc/ImportSampleVarRequestType.java
Retorno web/wwwroot/ws/java/spc/ImportSampleVarResponseType.java
Requisição
NMLOT Lote
NMMO OF
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
Web Services
Nesta seção são apresentadas as interfaces disponíveis para o SE Controle de atividades. Para a inserção
de cada um destes itens será necessário seguir o padrão documentado nas próximas seções.
Método Descrição
5.2.6.1 - cancelRat
Este método altera a situação para cancelado o relatório de serviço. Para esta ação é necessário seguir o
padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/workforce/CancelRatRequestType.java
Retorno web/wwwroot/ws/workforce/project/CancelRatResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: 2
5.2.6.2 - editNonProjectTaskCost
Este método possibilita editar custo de uma atividade isolada. Para esta ação é necessário seguir o padrão
abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/workforce/EditNonProjectTaskCostRequestType.java
Retorno web/wwwroot/ws/java/workforce/EditNonProjectTaskCostResponseType.java
Requisição
1- Planejado;
Phase X
2- Reprogramado;
3- Realizado.
Amount X Quantidade
Description Descrição
Retorno
Identificador Descrição
5.2.6.3 - editNonProjectTaskRevenue
Este método possibilita editar receita de uma atividade isolada. Para esta ação é necessário seguir o
padrão abaixo documentado.
Classe Java
web/wwwroot/ws/java/workforce/EditNonProjectTaskRevenueRequestType.ja
Requisição
va
web/wwwroot/ws/java/workforce/EditNonProjectTaskRevenueResponseType.j
Retorno
ava
Requisição
1- Planejado;
Phase X
2- Reprogramado;
3- Realizado.
Amount X Quantidade
Description Descrição
Retorno
Identificador Descrição
5.2.6.4 - executeNonProjectTask
Este método possibilita executar uma atividade isolada. Para esta ação é necessário seguir o padrão
abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/workforce/ExecuteNonProjectTaskRequestType.java
Retorno web/wwwroot/ws/java/workforce/ExecuteNonProjectTaskResponseType.java
Requisição
Opção de preenchimento:
UsePlannedOrRescheduledD
1 - Utilizar datas planejadas,
ates
2 - Utilizar datas reprogramadas
Retorno
Identificador Descrição
5.2.6.5 - newNonProjectTaskCost
Este método possibilita inserir custo em uma atividade isolada. Para esta ação é necessário seguir o
padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/workforce/NewNonProjectTaskCostRequestType.java
Retorno web/wwwroot/ws/java/workforce/NewNonProjectTaskCostResponseType.java
Requisição
1- Planejado;
Phase X
2- Reprogramado;
3- Realizado.
Amount X Quantidade
Description Descrição
Retorno
Identificador Descrição
5.2.6.6 - newNonProjectTaskRevenue
Este método possibilita inserir receita em uma atividade isolada. Para esta ação é necessário seguir o
padrão abaixo documentado.
Classe Java
web/wwwroot/ws/java/workforce/NewNonProjectTaskRevenueRequestType.jav
Requisição
a
web/wwwroot/ws/java/workforce/NewNonProjectTaskRevenueResponseType.ja
Retorno
va
Requisição
1- Planejado;
Phase X
2- Reprogramado;
3- Realizado.
Amount X Quantidade
Description Descrição
Retorno
Identificador Descrição
5.2.6.7 - RatSent
Este método torna o relatório de serviço indisponível para ser retornado pelo outros serviços de
returnRatApproval e returnRatApprovalOne. Para esta ação é necessário seguir o padrão abaixo
documentado.
Classe Java
Requisição web/wwwroot/ws/java/workforce/RatSentRequestType.java
Retorno web/wwwroot/ws/java/workforce/RatSentResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: 2
5.2.6.8 - returnRatApproval
Retorna um XML dos relatórios de serviço em aprovação que ainda não foram enviados. Para a edição
deste é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/workforce/ReturnRatApprovalRequestType.java
Retorno web/wwwroot/ws/java/workforce/ReturnRatApprovalResponseType.java
Retorno
Identificador Descrição
SUC ESSO: Retorna um XML de todos os relatórios de serviço em aprovação que ainda
return não foram enviados.
FALHA: -1
5.2.6.9 - returnRatApprovalOne
Retorna um XML dos relatórios de serviço em aprovação que ainda não foram enviados. Para a edição
deste é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/workforce/ReturnRatApprovalOneRequestType.java
Retorno web/wwwroot/ws/java/workforce/ReturnRatApprovalOneResponseType.java
Retorno
Identificador Descrição
SUC ESSO: Retorna um XML de um relatório de serviço em aprovação que ainda não
return foi enviado.
FALHA: -1
5.2.6.10 - setRatAttributeValue
Este método atribui um valor a um atributo do Relatório de Serviço. Caso o atributo não esteja associado a
um Relatório de Serviço, este será associado. Para esta ação é necessário seguir o padrão abaixo
documentado.
Classe Java
Requisição web/wwwroot/ws/java/workforce/SetRatAttributeValueRequestType.java
Retorno web/wwwroot/ws/java/workforce/SetRatAttributeValueResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Mensagem do erro
5.2.7 - Desempenho
Web Services
Nesta seção são apresentadas as interfaces disponíveis para o SE Desempenho. Para a inserção de cada
um destes itens será necessário seguir o padrão documentado nas próximas seções.
Método Descrição
5.2.7.1 - addMeasuresInAdinterface
Este método possibilita criar valor de meta/medição/meta acumulada/medição acumulada para um período
do indicador. Para a inserir é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/strategy/AddMeasuresInAdinterfaceRequestType.java
web/wwwroot/ws/java/strategy/AddMeasuresInAdinterfaceResponseType.jav
Retorno
a
Requisição
Retorno
Identificador Descrição
5.2.8 - Documento
Web Services
Nesta seção são apresentadas as interfaces disponíveis para o SE Documento. Para a inserção de cada um
destes itens será necessário seguir o padrão documentado nas próximas seções.
Método Descrição
5.2.8.1 - cancelDocument
Este método possibilita cancelar um documento. Para a utilização deste é necessário seguir o padrão
abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/document/CancelDocumentRequestType.java
Retorno web/wwwroot/ws/java/document/CancelDocumentResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.8.2 - checkAccessPermission
Este método possibilita verificar se o usuário possui permissão ao documento. Para a utilização deste é
necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/document/CheckAccessPermissionRequestType.java
Retorno web/wwwroot/ws/java/document/CheckAccessPermissionResponseType.java
Requisição
Tipo de permissão:
1 Alterar;
2 Excluir;
3 Revisar;
4 C onhecimento;
5 Distribuir cópia;
6 Visualizar;
7 C ancelar;
PERMISSIONSTYPE X 8 Arquivar;
9 Imprimir;
10 Treinamento;
11 Registrar treinamento;
12 Salvar localmente;
13 Assinar;
14 Notificação;
15 Incluir comentário;
16 Avaliar aplicabilidade.
Retorno
Identificador Descrição
5.2.8.3 - deleteAccessPermission
Este método possibilita remover permissão de acesso de determinado documento. Para a utilização deste
é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/document/DeleteAccessPermissionRequestType.java
Retorno web/wwwroot/ws/java/document/DeleteAccessPermissionResponseType.java
Requisição
Tipo de usuário:
§ 1 Usuário;
§ 2 Área;
USERTYPE X § 3 Função;
§ 4 Área/Função;
§ 5 Equipe;
§ 6 Todos.
Retorno
Identificador Descrição
5.2.8.4 - deleteDocument
Este método possibilita excluir um documento. Para a utilização deste é necessário seguir o padrão abaixo
documentado.
Classe Java
Requisição web/wwwroot/ws/java/document/DeleteDocumentRequestType.java
Retorno web/wwwroot/ws/java/document/DeleteDocumentResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.8.5 - deleteRevision
Este método possibilita remover determinada revisão do documento. Para a utilização deste é necessário
seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/document/DeleteRevisionRequestType.java
Retorno web/wwwroot/ws/java/document/DeleteRevisionResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.8.6 - downloadEletronicFile
Este método possibilita fazer o download de um arquivo eletrônico. Para a utilização deste é necessário
seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/document/DownloadEletronicFileRequestType.java
Retorno web/wwwroot/ws/java/document/DownloadEletronicFileResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.8.7 - editDocument
Este método possibilita alterar um documento. Para sua utilização é necessário seguir o padrão abaixo
documentado.
Classe Java
Requisição web/wwwroot/ws/java/document/EditDocumentRequestType.java
Retorno web/wwwroot/ws/java/document/EditDocumentResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.8.8 - getKeyWords
Este método possibilita realizar a busca de palavras-chave. Para a utilização deste é necessário seguir o
padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/document/GetKeyWordsRequestType.java
Retorno web/wwwroot/ws/java/document/GetKeyWordsResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.8.9 - getKeyWordsData
Este método possibilita realizar a busca de palavras-chave. Para a utilização deste é necessário seguir o
padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/document/GetKeyWordsDataRequestType.java
Retorno web/wwwroot/ws/java/document/GetKeyWordsDataResponseType.java
Requisição
Retorno
Identificador Descrição
§ IDKEYWORD Palavra-chave;
5.2.8.10 - listAccessPermission
Este método possibilita verificar os tipos de acessos que o usuário possui no documento. Para a utilização
deste é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/document/ListAccessPermissionRequestType.java
Retorno web/wwwroot/ws/java/document/ListAccessPermissionResponseType.java
Requisição
Retorno
Identificador Descrição
§ 1 Alterar;
§ 2 Excluir;
§ 3 Revisar;
§ 4 C onhecimento;
§ 5 Distribuir cópia;
§ 6 Visualizar;
§ 7 C ancelar;
§ 8 Arquivar;
return
§ 9 Imprimir;
§ 10 Treinamento;
§ 11 Registrar treinamento;
§ 12 Salvar localmente;
§ 13 Assinar;
§ 14 Notificação;
§ 15 Incluir comentário;
§ 16 Avaliar aplicabilidade.
5.2.8.11 - listPendencyDocument
Classe Java
Requisição web/wwwroot/ws/java/document/ListPendencyDocumentRequestType.java
Retorno web/wwwroot/ws/java/document/ListPendencyDocumentResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.8.12 - newAccessPermission
Este método possibilita incluir permissão de acesso a determinado documento. Para a utilização deste é
necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/document/NewAccessPermissionRequestType.java
Retorno web/wwwroot/ws/java/document/NewAccessPermissionResponseType.java
Requisição
Tipo de usuário:
§ 1 Usuário;
§ 2 Área;
USERTYPE X § 3 Função;
§ 4 Área/Função;
§ 5 Equipe;
§ 6 Todos.
Tipos de permissão:
§ 1 Alterar;
§ 2 Excluir;
§ 3 Revisar;
§ 4 C onhecimento;
§ 5 Distribuir cópia;
§ 6 Visualizar;
§ 7 C ancelar;
§ 8 Arquivar;
PERMISSION X
§ 9 Imprimir;
§ 10 Treinamento;
§ 11 Registrar treinamento;
§ 12 Salvar localmente;
§ 13 Assinar;
§ 14 Notificação;
§ 15 Incluir comentário;
§ 16 Avaliar aplicabilidade.
Ex.: 1,2,3
Tipo de ação:
PERMISSIONTYPE X § 1 Permitir;
§ 2 Negar.
Retorno
Identificador Descrição
5.2.8.13 - newDocument
Este método possibilita criar um documento. Para sua utilização é necessário seguir o padrão abaixo
documentado.
Classe Java
Requisição web/wwwroot/ws/java/document/NewDocumentRequestType.java
Retorno web/wwwroot/ws/java/document/NewDocumentResponseType.java
Requisição
Atributos do documento.
Exemplo:
identificador_do_atributo1=valor_do_atributo1;
identificador_do_atributo2=valor_do_atributo2;
identificador_do_atributo3=valor_do_atributo3.
ATTRIBUTES
Exemplo com atributo multivalorado:
identificador_do_atributo1=valor1_do_atributo1,valor2_d
o_atributo1,valor3_do_atributo1.
Participantes de revisão:
§ 1 Usuário;
§ 2 Área;
§ 3 Função;
§ 4 Área/Função;
§ 5 Equipe.
§ 1-Elaboração;
§ 2- C onsenso;
§ 3-Aprovação;
§ 4-Homologação.
Retorno
Identificador Descrição
5.2.8.14 - newRevision
Este método possibilita criar uma nova revisão para o documento. Para a utilização deste é necessário
seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/document/NewRevisionRequestType.java
Retorno web/wwwroot/ws/java/document/NewRevisionResponseType.java
Requisição
Participantes de revisão:
§ 1 usuário;
§ 2 Área;
§ 3 função;
§ 4 Área/Função;
§ 5 Equipe;
§ 1-Elaboração;
§ 2- C onsenso;
§ 3-Aprovação;
§ 4-Homologação.
Exemplo:
identificador_do_atributo1=valor_do_atributo1;identificad
or_do_atributo2=valor_do_atributo2;identificador_do_atri
buto3=valor_do_atributo3.
DOC UMENTDATA
Exemplo com atributo multivalorado:
identificador_do_atributo1=valor1_do_atributo1,valor2_d
o_atributo1,valor3_do_atributo1.
Retorno
Identificador Descrição
5.2.8.15 - releasePendencyDocument
Este método possibilita liberar uma pendência de execução de revisão de determinado usuário. Para a
utilização deste é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/document/ReleasePendencyDocumentRequestType.java
Retorno web/wwwroot/ws/java/document/ReleasePendencyDocumentResponseType.java
Requisição
Retorno
Identificador Descrição
§ 1 Usuário;
§ 2 Área;
return
§ 3 Função;
§ 4 Área/Função;
§ 5 Equipe;
§ 6 Todos
5.2.8.16 - searchAccessAudit
Este método possibilita realizar uma consulta na auditoria de acessos do SE Documento. Para a utilização
deste é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/document/SearchAccessAuditRequestType.java
Retorno web/wwwroot/ws/java/document/SearchAccessAuditResponseType.java
Requisição
Retorno
Identificador Descrição
1 - Visualização de documento;
2 - Documento cadastrado;
3 - Documento removido;
4 - Revisão cadastrada;
5 - Revisão removida;
6 - Revisão encerrada;
11 - Documento cancelado;
12 - Documento liberado;
15 - Arquivamento cancelado;
16 - Assinatura digital;
§ IPADDRESS: IP da estação;
5.2.8.17 - searchCategory
Este método possibilita listar todas as categorias cadastradas no sistema que o usuário de autenticação
possuir acesso de visualização.
Classe Java
Requisição web/wwwroot/ws/java/document/SearchCategoryRequestType.java
Retorno web/wwwroot/ws/java/document/SearchCategoryResponseType.java
Requisição
Retorno
Identificador Descrição
FALHA: -1
5.2.8.18 - searchDocument
Este método possibilita realizar a consulta de documentos. Para a utilização deste é necessário seguir o
padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/document/SearchDocumentRequestType.java
Retorno web/wwwroot/ws/java/document/SearchDocumentResponseType.java
Requisição
Array de atributos:
Retorno
Identificador Descrição
5.2.8.19 - setAttributeValue
Este método possibilita atribuir um valor a um atributo de determinado documento. Para a utilização deste
é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/document/SetAttributeValueRequestType.java
Retorno web/wwwroot/ws/java/document/SetAttributeValueResponseType.java
Requisição
Identificador da revisão.
IDREVISION Obs.: C aso não informado, será considerado a revisão
vigente.
Retorno
Identificador Descrição
SUC ESSO: retorna '1' significando que o atributo foi alterado com sucesso.
return
FALHA: retorna uma mensagem com o erro ocorrido.
5.2.8.20 - uploadEletronicFile
Este método possibilita fazer o upload de um arquivo eletrônico. Para a utilização deste é necessário
seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/document/UploadEletronicFileRequestType.java
Retorno web/wwwroot/ws/java/document/UploadEletronicFileResponseType.java
Requisição
Array de arquivos:
Retorno
Identificador Descrição
5.2.8.21 - viewDocumentData
Este método possibilita recuperar os dados de um documento. Para a utilização deste é necessário seguir
o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/document/ViewDocumentDataRequestType.java
Retorno web/wwwroot/ws/java/document/ViewDocumentDataResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.9 - Generic
Web Services
Nesta seção são apresentadas as interfaces genéricas disponíveis para o SE Suite. Para a inserção de
cada um destes itens será necessário seguir o padrão documentado nas próximas seções.
Método Descrição
createTeamByArea C ria uma equipe informando as áreas que estarão contidas nela
createTeamByPosition C ria uma equipe informando as funções que estarão contidas nela
createTeamByUser C ria uma equipe informando os usuários que estarão contidos nela
5.2.9.1 - addAreaToTeam
Para adicionar novas áreas à equipe cada um destes itens é necessário seguir o padrão abaixo
documentado.
Classe Java
Requisição web\wwwroot\ws\java\generic\AddAreaToTeamRequestType.java
Retorno web\wwwroot\ws\java\generic\AddAreaToTeamResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.9.2 - addPositionToTeam
Para adicionar novas funções à uma equipe é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\generic\AddPositionToTeamRequestType.java
Retorno web\wwwroot\ws\java\generic\AddPositionToTeamResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.9.3 - addUserToTeam
Para adicionar novos usuários à uma equipe é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\generic\AddUserToTeamRequestType.java
Retorno web\wwwroot\ws\java\generic\AddUserToTeamResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.9.4 - createTeamByArea
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\generic\CreateTeamByAreaRequestType.java
Retorno web\wwwroot\ws\java\generic\CreateTeamByAreaResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.9.5 - createTeamByPosition
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\generic\CreateTeamByPositionRequestType.java
Retorno web\wwwroot\ws\java\generic\CreateTeamByPositionResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.9.6 - createTeamByUser
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\generic\CreateTeamByUserRequestType.java
Retorno web\wwwroot\ws\java\generic\CreateTeamByUserResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.9.7 - editTeamByArea
Para a edição de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\generic\EditTeamByAreaRequestType.java
Retorno web\wwwroot\ws\java\generic\EditTeamByAreaResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.9.8 - editTeamByPosition
Para a edição de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\generic\EditTeamByPositionRequestType.java
Retorno web\wwwroot\ws\java\generic\EditTeamByPositionResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.9.9 - editTeamByUser
Para a edição de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\generic\EditTeamByUserRequestType.java
Retorno web\wwwroot\ws\java\generic\EditTeamByUserResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.9.10 - removeAreaFromTeam
Para a remoção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\generic\RemoveAreaFromTeamRequestType.java
Retorno web\wwwroot\ws\java\generic\RemoveAreaFromTeamResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.9.11 - removePositionFromTeam
Para a remoção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\generic\RemovePositionFromTeamRequestType.java
Retorno web\wwwroot\ws\java\generic\RemovePositionFromTeamResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.9.12 - removeTeam
Para a exclusão de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\generic\RemoveTeamRequestType.java
Retorno web\wwwroot\ws\java\generic\RemoveTeamResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.9.13 - removeUserFromTeam
Para a remoção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\generic\RemoveUserFromTeamRequestType.java
Retorno web\wwwroot\ws\java\generic\RemoveUserFromTeamResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.10 - Incidente
Web Services
Nesta seção são apresentados os web services disponíveis para o SE Incidente. Para a invocação de cada
um destes métodos é necessário seguir o padrão documentado nas próximas seções.
Método Descrição
5.2.10.1 - cancelIncident
Classe Java
Requisição web\wwwroot\ws\java\incident\CancelIncidentRequestType.java
Retorno web\wwwroot\ws\java\incident\CancelIncidentResponseType.java
Estrutura de requisição
<cancelIncident>
<IncidentID>?</IncidentID>
<Explanation>?</Explanation>
</cancelIncident>
Requisição
Explanation X Justificativa
Retorno
Identificador Descrição
5.2.10.2 - clearChildEntityRecord
Este método exclui todos registros relacionados da entidade de formulário descendente do incidente.
Classe Java
Requisição web\wwwroot\ws\java\incident\ClearChildEntityRecordRequestType.java
Retorno web\wwwroot\ws\java\incident\ClearChildEntityRecordResponseType.java
Estrutura de requisição
<clearChildEntityRecord>
<IncidentID>?</IncidentID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
</clearChildEntityRecord>
Requisição
Retorno
Identificador Descrição
5.2.10.3 - deleteChildEntityRecord
Classe Java
Requisição web\wwwroot\ws\java\incident\DeleteChildEntityRecordRequestType.java
Retorno web\wwwroot\ws\java\incident\DeleteChildEntityRecordResponseType.java
Estrutura de requisição
<deleteChildEntityRecord>
<IncidentID>?</IncidentID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
<ChildRecordOID>?</ChildRecordOID>
</deleteChildEntityRecord>
Requisição
Retorno
Identificador Descrição
5.2.10.4 - editAttributeValue
Classe Java
Requisição web\wwwroot\ws\java\incident\EditAttributeValueRequestType.java
Retorno web\wwwroot\ws\java\incident\EditAttributeValueResponseType.java
Estrutura de requisição
<editAttributeValue>
<IncidentID>?</IncidentID>
<AttributeList>
<!--1 ou mais repetições:-->
<Attribute>
<AttributeID>?</AttributeID>
<!--Zero ou mais repetições:-->
<AttributeValueList>
<AttributeValue>?</AttributeValue>
</AttributeValueList>
</Attribute>
</AttributeList>
</editAttributeValue>
Requisição
Valor do atributo
§ Data: YYYY-MM-DD
§ Hora: HHHH:MM
Retorno
Identificador Descrição
5.2.10.5 - editChildEntityRecord
Classe Java
Requisição web\wwwroot\ws\java\incident\EditChildEntityRecordRequestType.java
Retorno web\wwwroot\ws\java\incident\EditChildEntityRecordResponseType.java
Estrutura de requisição
<editChildEntityRecord>
<IncidentID>?</IncidentID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
<ChildRecordOID>?</ChildRecordOID>
<EntityAttributeList>
<!--Zero ou mais repetições:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero ou mais repetições:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<!--1 ou mais repetições:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?</RelationshipAttributeValue>
</RelationshipAttribute>
</Relationship>
</RelationshipList>
</editChildEntityRecord>
Requisição
§ Data: YYYY-MM-DD
§ Hora: HH:MM
§ Boolean: 0 ou 1
§ Data: YYYY-MM-DD
§ Hora: HH:MM
§ Boolean: 0 ou 1
Retorno
Identificador Descrição
5.2.10.6 - editEntityRecord
Classe Java
Requisição web\wwwroot\ws\java\incident\EditEntityRecordRequestType.java
Retorno web\wwwroot\ws\java\incident\EditEntityRecordResponseType.java
Estrutura de requisição
<editEntityRecord>
<IncidentID>?</IncidentID>
<EntityID>?</EntityID>
<EntityAttributeList>
<!--Zero ou mais repetições:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero ou mais repetições:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<!--1 ou mais repetições:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?</RelationshipAttributeValue>
</RelationshipAttribute>
</Relationship>
</RelationshipList>
</editEntityRecord>
Requisição
§ Data: YYYY-MM-DD
§ Hora: HH:MM
§ Boolean: 0 ou 1
§ Data: YYYY-MM-DD
§ Hora: HH:MM
§ Boolean: 0 ou 1
Retorno
Identificador Descrição
5.2.10.7 - executeActivity
Classe Java
Requisição web\wwwroot\ws\java\incident\ExecuteActivityRequestType.java
Retorno web\wwwroot\ws\java\incident\ExecuteActivityResponseType.java
Estrutura de requisição
<executeActivity>
<IncidentID>?</IncidentID>
<ActivityID>?</ActivityID>
<ActionSequence>?</ActionSequence>
<UserID>?</UserID>
</executeActivity>
Requisição
Retorno
Identificador Descrição
5.2.10.8 - executeSystemActivity
Classe Java
Requisição web\wwwroot\ws\java\incident\ExecuteSystemActivityRequestType.java
Retorno web\wwwroot\ws\java\incident\ExecuteSystemActivityResponseType.java
Estrutura de requisição
<executeSystemActivity>
<IncidentID>?</IncidentID>
<ActivityID>?</ActivityID>
</executeSystemActivity>
Requisição
Retorno
Identificador Descrição
5.2.10.9 - newAssocDocument
Classe Java
Requisição web\wwwroot\ws\java\incident\NewAssocDocumentRequestType.java
Retorno web\wwwroot\ws\java\incident\NewAssocDocumentResponseType.java
Estrutura de requisição
<newAssocDocument>
<IncidentID>?</IncidentID>
<ActivityID>?</ActivityID>
<DocumentID>?</DocumentID>
</newAssocDocument>
Requisição
Retorno
Identificador Descrição
5.2.10.10 - newAttachment
Classe Java
Requisição web\wwwroot\ws\java\incident\NewAttachmentRequestType.java
Retorno web\wwwroot\ws\java\incident\NewAttachmentResponseType.java
Estrutura de requisição
<newAttachment>
<IncidentID>?</IncidentID>
<ActivityID>?</ActivityID>
<FileName>?</FileName>
<FileContent>?</FileContent>
<UserID>?</UserID>
<AttachmentID>?</AttachmentID>
<AttachmentName>?</AttachmentName>
<Summary>?</Summary>
</newAttachment>
Requisição
Summary Resumo
Retorno
Identificador Descrição
5.2.10.11 - newChildEntityRecord
Classe Java
Requisição web\wwwroot\ws\java\incident\NewChildEntityRecordRequestType.java
Retorno web\wwwroot\ws\java\incident\NewChildEntityRecordResponseType.java
Estrutura de requisição
<newChildEntityRecord>
<IncidentID>?</IncidentID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
<EntityAttributeList>
<!--Zero ou mais repetições:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero ou mais repetições:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<!--1 ou mais repetições:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?</RelationshipAttributeValue>
</RelationshipAttribute>
</Relationship>
</RelationshipList>
</newChildEntityRecord>
Requisição
§ Data: YYYY-MM-DD
§ Hora: HH:MM
§ Boolean: 0 ou 1
§ Data: YYYY-MM-DD
§ Hora: HH:MM
§ Boolean: 0 ou 1
Retorno
Identificador Descrição
5.2.10.12 - newIncident
Classe Java
Requisição web\wwwroot\ws\java\incident\NewIncidentRequestType.java
Retorno web\wwwroot\ws\java\incident\NewIncidentResponseType.java
Estrutura de requisição
<newIncident>
<IncidentTypeID>?</IncidentTypeID>
<IncidentTitle>?</IncidentTitle>
<UserID>?</UserID>
</newIncident>
Requisição
Retorno
Identificador Descrição
5.2.11 - Inspeção
Web Services
Nesta seção são apresentadas as interfaces disponíveis para o SE Inspeção. Para a inserção de cada um
destes itens será necessário seguir o padrão documentado nas próximas seções.
Método Descrição
relateCharacteristicToInspConfi
Relacionamento de característica na configuração da inspeção
guration
relateChecklistToInspConfigurat
Relacionamento de checklist na configuração da inspeção
ion
5.2.11.1 - createUpdateConfiguration
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
web\wwwroot\ws\java\inspection\CreateUpdateConfigurationRequestType.j
Requisição
ava
web\wwwroot\ws\java\inspection\CreateUpdateConfigurationResponseType.
Retorno
java
Requisição
14 – Inserir;
FGOPTION X
15 – Alterar;
16 – Inserir/Alterar.
FGALLOWEDITWF 1 – Permitir;
FGBLOC K 1 – Bloquear
Tipo de frequência:
1 – Não C ontrolada;
FGTYPEFREQUENC E X4 2 – Data de execução;
Unidade de frequência:
1 – Dias;
FGFREQUENC E X5 2 – Semanas;
3 – Meses;
4 – Anos
Frequência de inspeção:
1 - Skip-lote
FGINSPFREQ X6
2 - Inspeção total
3 - Sem inspeção
FGINITIALSMP 1 – Sim;
2 – Não(opção padrão)
Situação da amostra:
1 – Bloqueado;
FGSTATUSINITIALSMP X7
2 – Amostra Inicial;
3 – Liberado
DTDUEDATE X7 Prazo
FGVALIDITYRIA 1 – Sim;
2 – Não(opção padrão)
1 – Dias;
FGFREQVALIDITYRIA X8 2 – Semanas;
3 – Meses;
4 – Inspeções
Registrar médias/leituras:
2 – Registrar Leituras
Regra:
1 – Plano de amostragem;
9
FGSAMPLEPLAN X 2 – Tabela de amostragem;
3 – Tamanho definido;
4 – Porcentagem
Plano de amostragem:
1 – Simples;
FGDEFAULSAMPLEPLAN X9
2 – Duplo;
3 – Múltipla
Nível de inspeção:
IDLEVEL X9
[01, 02, 03, S1, S2, S3, S4]
Regime de trabalho:
1 – Atenuado;
FGSWITC HRULE X9
2 – Normal;
3 – Severo
NQA:
FGFIXED X9 1 – Sim;
2 – Não(opção padrão);
§ X 4 – Obrigatório durante a inclusão caso o tipo de objeto da ficha permita que a frequência seja controlada.
§ X 6 – Obrigatório durante a inclusão caso o tipo de objeto da ficha exija que a frequência de inspeção seja
preenchida.
§ X 7 – Obrigatório durante a inclusão caso o tipo de objeto da ficha exija que a frequência de inspeção seja
preenchida e a opção de controlar amostra inicial esteja ativa.
§ X 8 – Obrigatório durante a inclusão caso o tipo de objeto da ficha exija que a frequência de inspeção seja
preenchida, a opção de controlar amostra inicial e de controlar a validade estejam ativas.
§ X 9 – Obrigatório caso o tipo de objeto da ficha exija o preenchimento de um plano de amostragem e a opção da
regra de amostragem exija o preenchimento.
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.11.2 - createUpdateDeleteQualityIndex
§ Avaliação de índice.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
web\wwwroot\ws\java\inspection\CreateUpdateDeleteQualityIndexRequestT
Requisição
ype.java
web\wwwroot\ws\java\inspection\CreateUpdateDeleteQualityIndexResponse
Retorno
Type.java
Requisição
Opção de ação:
11 – Incluir
FGOPTION X 12 – Alterar
DTINDEXEVALVALID X1 Vencimento.
§ X 2 – Obrigatório para inspeções onde o Objeto, Processo, Atividade do Processo ou Fornecedor fizerem parte da
avaliação, caso contrário são ignorados.
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.11.3 - createUpdateDeleteReceiving
§ Dados de um recebimento.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
web\wwwroot\ws\java\inspection\CreateUpdateDeleteReceivingRequestType
Requisição
.java
web\wwwroot\ws\java\inspection\CreateUpdateDeleteReceivingResponseTyp
Retorno
e.java
Requisição
Opção de ação:
3 – Incluir;
FGOPTION X
4 – Alterar;
5 – Excluir.
§ X 2 – Obrigatório para inspeções de Insumos, Serviços e Produtos acabados externos, ignorado para outros tipos
de objetos.
§ X 3 – Obrigatório, não-obrigatório ou ignorado, dependendo das configurações do tipo da ficha de inspeção definida.
§ X 4 – Obrigatório caso a opção “Permitir alterar o fluxo durante o recebimento” estiver marcada na ficha de
inspeção, ou ignorado caso contrário.
§ X 5 – Obrigatório caso o objeto da inspeção seja uma instância de processo do Workflow, caso contrário é ignorado.
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.11.4 - editQualificationIndexValue
Este modelo de importação possibilita editar o índice de qualificação e enviar para a próxima etapa:
§ Dados do recebimento.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
web\wwwroot\ws\java\inspection\EditQualificationIndexValueRequestType
Requisição
.java
web\wwwroot\ws\java\inspection\EditQualificationIndexValueResponseTyp
Retorno
e.java
Requisição
Executar a etapa:
FGEXEC UTE
1 – Enviar para a próxima etapa;
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.11.5 - relateCharacteristicToInspConfiguration
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
web\wwwroot\ws\java\inspection\RelateCharacteristicToInspConfiguratio
Requisição
nRequestType.java
web\wwwroot\ws\java\inspection\RelateCharacteristicToInspConfiguratio
Retorno
nResponseType.java
Requisição
20 – Associar;
FGOPTION X
21 – Alterar;
22 – Desassociar.
Requerido:
2 – Não requerido
NRVALIDITY X1 Validade
Unidade de frequência:
1 – Dias;
FGVALIDITY X1 2 – Semanas;
3 – Meses;
4 – Inspeções
FGENABLEDPRINT 1 – Sim;
Registrar médias/leituras:
2 – Registrar Leituras
Regra:
1 – Plano de amostragem;
3 – Tamanho definido;
4 – Porcentagem
Plano de amostragem:
1 – Simples;
FGSAMPLEPLAN X3
2 – Duplo;
3 – Múltipla
Nível de inspeção:
IDLEVEL X3
[01, 02, 03, S1, S2, S3, S4]
Regime de trabalho:
1 – Atenuado;
FGSWITC HRULE X3
2 – Normal;
3 – Severo
NQA:
FGFIXED X3 1 – Sim;
2 – Não(opção padrão);
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.11.6 - relateChecklistToInspConfiguration
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
web\wwwroot\ws\java\inspection\RelateChecklistToInspConfigurationRequ
Requisição
estType.java
web\wwwroot\ws\java\inspection\RelateChecklistToInspConfigurationResp
Retorno
onseType.java
Requisição
FGOPTION X 25 – Associar;
26 – Desassociar.
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.12 - Insumo
Web Services
Nesta seção são apresentadas as interfaces disponíveis para o SE Insumo. Para a inserção de cada um
destes itens será necessário seguir o padrão documentado nas próximas seções.
Método Descrição
5.2.12.1 - addEditSupplyWarehouse
Este método possibilita associar/editar um almoxarifado com um insumo. Para a inserção de cada um
destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\supply\AddEditSupplyWarehouseRequestType.java
Retorno web\wwwroot\ws\java\supply\AddEditSupplyWarehouseResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.12.2 - addSupplyStructure
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\supply\AddSupplyStructureRequestType.java
Retorno web\wwwroot\ws\java\supply\AddSupplyStructureResponseType.java
Requisição
VLQUANTITY X Quantidade
Retorno
Identificador Descrição
5.2.12.3 - createEditSupply
§ Dados de um insumo.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\supply\CreateEditSupplyRequestType.java
Retorno web\wwwroot\ws\java\supply\CreateEditSupplyResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.12.4 - createSupplyType
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\supply\CreateSupplyTypeRequestType.java
Retorno web\wwwroot\ws\java\supply\CreateSupplyTypeResponseType.java
Requisição
FGUSEREVISIONOBJTYPE X 1 - Possuirá;
2 - Não possuirá;
Identificador da revisão:
1 – Texto;
FGEDITID 2 – Numérico;
3 – C ustomizado;
C iclo da revisão:
2 - Texto
Tipo da aprovação:
FGREVAPPROVALMODEOBJT
1 - Incremental;
YPE
2 - C ircular
Tipo de encerramento:
FGREVRELEASEMODEOBJTY
1 - Automático
PE
2 - Manual
Retorno
Identificador Descrição
5.2.12.5 - deleteSupply
§ Dados de um insumo.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\supply\DeleteSupplyRequestType.java
Retorno web\wwwroot\ws\java\supply\DeleteSupplyResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.12.6 - deleteSupplyStructure
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\supply\DeleteSupplyStructureRequestType.java
Retorno web\wwwroot\ws\java\supply\DeleteSupplyStructureResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.12.7 - deleteSupplyWarehouse
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\supply\DeleteSupplyWarehouseRequestType.java
Retorno web\wwwroot\ws\java\supply\DeleteSupplyWarehouseResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.13 - Manutenção
Web Services
Nesta seção são apresentadas as interfaces disponíveis para o SE Manutenção. Para a inserção de cada
um destes itens será necessário seguir o padrão documentado nas próximas seções.
Método Descrição
5.2.13.1 - insertMeterReading
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição InsertMeterReadingRequestType.java
Retorno InsertMeterReadingResponseType.java
Requisição
Valor da leitura.
X¹ - Requerido caso a ação seja Nova leitura de medidor. Não-requerido caso a ação seja Novo reinício de medidor.
Retorno
Identificador Descrição
SUC ESSO: 1.
return
FALHA: Mensagem descrevendo o erro.
5.2.13.2 - insertVariableReading
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição InsertVariableReadingRequestType.java
Retorno InsertVariableReadingResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1.
return
FALHA: Mensagem descrevendo o erro.
5.2.13.3 - createCorrectiveMaintenance
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
web\wwwroot\ws\java\maintenance\CreateCorrectiveMaintenanceRequestTyp
Requisição
e.java
web\wwwroot\ws\java\maintenance\CreateCorrectiveMaintenanceResponseTy
Retorno
pe.java
Requisição
Técnico responsável:
Atributos do documento.
Exemplo:
§ identificador_do_atributo1=valor_do_atributo1;
§ identificador_do_atributo2=valor_do_atributo2;
§ identificador_do_atributo3=valor_do_atributo3;
ATTRIBUTES X³
Exemplo com atributo multivalorado:
§ identificador_do_atributo1=valor1_do_atributo1,valor2
_do_atributo1,valor3_do_atributo1.
X¹ - Requerido caso o(s) campo(s) "Data de início" e/ou "Hora de início" e/ou "Porcentagem real" estiver(em)
preenchido(s);
Retorno
Identificador Descrição
SUC ESSO: 1.
return
FALHA: Retorna uma mensagem referente ao erro ocorrido.
5.2.14 - PDM
Web Services
Nesta seção são apresentadas as interfaces disponíveis para o SE PDM. Para a inserção de cada um
destes itens será necessário seguir o padrão documentado nas próximas seções.
Método Descrição
5.2.14.1 - addBom
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\item\AddBomRequestType.java
Retorno web\wwwroot\ws\java\item\AddBomResponseType.java
Requisição
VLQUANTITY X Quantidade
2 - Insumo.
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.14.2 - addCharacteristicAttrib
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\item\AddCharacteristicAttribRequestType.java
Retorno web\wwwroot\ws\java\item\AddCharacteristicAttribResponseType.java
Requisição
C aracterística especial:
2 – Não.
DSOBSERVATION Observação.
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.14.3 - addCharacteristicVar
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\item\AddCharacteristicVarRequestType.java
Retorno web\wwwroot\ws\java\item\AddCharacteristicVarResponseType.java
Requisição
C aracterística especial:
2 - Não;
Limites:
0 - Bilateral;
FGLIMIT X
1 - Unilateral para cima;
DSOBSERVATION Observação
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.14.4 - addCustomer
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\item\AddCustomerRequestType.java
Retorno web\wwwroot\ws\java\item\AddCustomerResponseType.java
Requisição
X 2 - Requerido caso os campos “Nome fantasia” e/ou a “Razão social” não estiverem preenchidos.
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.14.5 - addManufacturer
Este método possibilita associar um fabricante com o item. Para a inserção de cada um destes itens é
necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\item\AddManufacturerRequestType.java
Retorno web\wwwroot\ws\java\item\AddManufacturerResponseType.java
Requisição
X 2 - Requerido caso os campos “Nome fantasia” e/ou a “Razão social” não estiverem preenchidos.
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.14.6 - addSupplier
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\item\AddSupplierRequestType.java
Retorno web\wwwroot\ws\java\item\AddSupplierResponseType.java
Requisição
1 - Dia
3 - Mês
4 - Ano
X 2 - Requerido caso os campos “Nome fantasia” e/ou a “Razão social” não estiverem preenchidos.
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.14.7 - deleteBom
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\item\AddBomRequestType.java
Retorno web\wwwroot\ws\java\item\AddBomResponseType.java
Requisição
2 - Insumo.
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.14.8 - deleteCustomer
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\item\DeleteCustomerRequestType.java
Retorno web\wwwroot\ws\java\item\DeleteCustomerResponseType.java
Requisição
X 2 - Requerido caso os campos “Nome fantasia” e/ou a “Razão social” não estiverem preenchidos.
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.14.9 - deleteItem
§ Dados de um item.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\item\DeleteItemRequestType.java
Retorno web\wwwroot\ws\java\item\DeleteItemResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.14.10 - deleteManufacturer
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\item\DeleteManufacturerRequestType.java
Retorno web\wwwroot\ws\java\item\DeleteManufacturerResponseType.java
Requisição
X 2 - Requerido caso os campos “Nome fantasia” e/ou a “Razão social” não estiverem preenchidos.
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.14.11 - deleteSupplier
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\item\DeleteSupplierRequestType.java
Retorno web\wwwroot\ws\java\item\DeleteSupplierResponseType.java
Requisição
X 2 - Requerido caso os campos “Nome fantasia” e/ou a “Razão social” não estiverem preenchidos.
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.14.12 - import_attrib_assoc
Para a associação dos atributos ser realizada com sucesso é necessário seguir o padrão abaixo
documentado.
Classe Java
Requisição web\wwwroot\ws\java\item\Import_attrib_assocRequestType.java
Retorno web\wwwroot\ws\java\item\Import_attrib_assocResponseType.java
Requisição
Valor do atributo.
VALUE X 1 - NMATTRIBUTE
2 - VLATTRIBUTE
3 - DTATTRIBUTE
NMATTRIBUTE Memorando
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.14.13 - newItem
§ Dados de um item.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\item\NewItemRequestType.java
Retorno web\wwwroot\ws\java\item\NewItemResponseType.java
Requisição
Estado físico:
1 Solido;
3 Gasoso;
4 Pastoso
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.14.14 - newItemType
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\item\NewItemTypeRequestType.java
Retorno web\wwwroot\ws\java\item\NewItemTypeResponseType.java
Requisição
FGUSEMASK X 1 - Sim;
2 - Não.
1 - Sim;
2 - Não.
C ontrolar revisão:
FGUSEREVISION X 1 - Sim;
2 - Não.
Identificador da revisão:
1 - Numérico;
FGREVID X1
2 - Texto;
3 - C ustomizado.
Tipo da aprovação:
FGREVAPPROVALMODE X1 1 - Incremental;
2 - C ircular.
Tipo de encerramento:
FGREVRELEASEMODE X1 1 - Automático;
2 - Manual.
Frequência de retenção:
1 - Revisões;
FGREVRETENTIONMODE X1
2 - Meses;
3 - Anos.
Tipo de roteiro:
FGREVROUTETYPE X1 1 - Fixo;
2 - Variável.
FGREVELABC LAUSE X1 1 - E;
2 - OU.
2 - OU.
FGREVAPROVC LAUSE X1 1 - E;
2 - OU.
FGREVHOMOLOGC LAUSE X1 1 - E;
2 - OU.
Marca d’água:
2 - Não.
2 - Não.
Tipo de arquivo:
1 - Simples;
FGFILETYPE X
2 - Múltiplo;
3 - C omplexo.
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.14.15 - relateAssetTypeToCharacteristic
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
web\wwwroot\ws\java\item\RelateAssetTypeToCharacteristicRequestType.j
Requisição
ava
web\wwwroot\ws\java\item\RelateAssetTypeToCharacteristicResponseType.
Retorno
java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Retorna uma mensagem referente ao erro ocorrido
5.2.15 - Problema
Web Services
Nesta seção são apresentados os web services disponíveis para o SE Problema. Para a invocação de cada
um destes métodos é necessário seguir o padrão documentado nas próximas seções.
Método Descrição
5.2.15.1 - cancelProblem
Classe Java
Requisição web\wwwroot\ws\java\problem\CancelProblemRequestType.java
Retorno web\wwwroot\ws\java\problem\CancelProblemResponseType.java
Estrutura de requisição
<cancelProblem>
<ProblemID>?</ProblemID>
<Explanation>?</Explanation>
</cancelProblem>
Requisição
Explanation X Justificativa
Retorno
Identificador Descrição
5.2.15.2 - clearChildEntityRecord
Este método exclui todos registros relacionados da entidade de formulário descendente do problema.
Classe Java
Requisição web\wwwroot\ws\java\problem\ClearChildEntityRecordRequestType.java
Retorno web\wwwroot\ws\java\problem\ClearChildEntityRecordResponseType.java
Estrutura de requisição
<clearChildEntityRecord>
<ProblemID>?</ProblemID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
</clearChildEntityRecord>
Requisição
Retorno
Identificador Descrição
5.2.15.3 - deleteChildEntityRecord
Classe Java
Requisição web\wwwroot\ws\java\problem\DeleteChildEntityRecordRequestType.java
Retorno web\wwwroot\ws\java\problem\DeleteChildEntityRecordResponseType.java
Estrutura de requisição
<deleteChildEntityRecord>
<ProblemID>?</ProblemID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
<ChildRecordOID>?</ChildRecordOID>
</deleteChildEntityRecord>
Requisição
Retorno
Identificador Descrição
5.2.15.4 - editAttributeValue
Classe Java
Requisição web\wwwroot\ws\java\problem\EditAttributeValueRequestType.java
Retorno web\wwwroot\ws\java\problem\EditAttributeValueResponseType.java
Estrutura de requisição
<editAttributeValue>
<ProblemID>?</ProblemID>
<AttributeList>
<!--1 ou mais repetições:-->
<Attribute>
<AttributeID>?</AttributeID>
<!--Zero ou mais repetições:-->
<AttributeValueList>
<AttributeValue>?</AttributeValue>
</AttributeValueList>
</Attribute>
</AttributeList>
</editAttributeValue>
Requisição
Valor do atributo
§ Data: YYYY-MM-DD
§ Hora: HHHH:MM
Retorno
Identificador Descrição
5.2.15.5 - editChildEntityRecord
Classe Java
Requisição web\wwwroot\ws\java\problem\EditChildEntityRecordRequestType.java
Retorno web\wwwroot\ws\java\problem\EditChildEntityRecordResponseType.java
Estrutura de requisição
<editChildEntityRecord>
<ProblemID>?</ProblemID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
<ChildRecordOID>?</ChildRecordOID>
<EntityAttributeList>
<!--Zero ou mais repetições:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero ou mais repetições:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<!--1 ou mais repetições:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?</RelationshipAttributeValue>
</RelationshipAttribute>
</Relationship>
</RelationshipList>
</editChildEntityRecord>
Requisição
§ Data: YYYY-MM-DD
§ Hora: HH:MM
§ Boolean: 0 ou 1
§ Data: YYYY-MM-DD
§ Hora: HH:MM
§ Boolean: 0 ou 1
Retorno
Identificador Descrição
5.2.15.6 - editEntityRecord
Classe Java
Requisição web\wwwroot\ws\java\problem\EditEntityRecordRequestType.java
Retorno web\wwwroot\ws\java\problem\EditEntityRecordResponseType.java
Estrutura de requisição
<editEntityRecord>
<ProblemID>?</ProblemID>
<EntityID>?</EntityID>
<EntityAttributeList>
<!--Zero ou mais repetições:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero ou mais repetições:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<!--1 ou mais repetições:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?</RelationshipAttributeValue>
</RelationshipAttribute>
</Relationship>
</RelationshipList>
</editEntityRecord>
Requisição
§ Data: YYYY-MM-DD
§ Hora: HH:MM
§ Boolean: 0 ou 1
§ Data: YYYY-MM-DD
§ Hora: HH:MM
§ Boolean: 0 ou 1
Retorno
Identificador Descrição
5.2.15.7 - executeActivity
Classe Java
Requisição web\wwwroot\ws\java\problem\ExecuteActivityRequestType.java
Retorno web\wwwroot\ws\java\problem\ExecuteActivityResponseType.java
Estrutura de requisição
<executeActivity>
<ProblemID>?</ProblemID>
<ActivityID>?</ActivityID>
<ActionSequence>?</ActionSequence>
<UserID>?</UserID>
</executeActivity>
Requisição
Retorno
Identificador Descrição
5.2.15.8 - executeSystemActivity
Classe Java
Requisição web\wwwroot\ws\java\problem\ExecuteSystemActivityRequestType.java
Retorno web\wwwroot\ws\java\problem\ExecuteSystemActivityResponseType.java
Estrutura de requisição
<executeSystemActivity>
<ProblemID>?</ProblemID>
<ActivityID>?</ActivityID>
</executeSystemActivity>
Requisição
Retorno
Identificador Descrição
5.2.15.9 - newAssocDocument
Classe Java
Requisição web\wwwroot\ws\java\problem\NewAssocDocumentRequestType.java
Retorno web\wwwroot\ws\java\problem\NewAssocDocumentResponseType.java
Estrutura de requisição
<newAssocDocument>
<ProblemID>?</ProblemID>
<ActivityID>?</ActivityID>
<DocumentID>?</DocumentID>
</newAssocDocument>
Requisição
Retorno
Identificador Descrição
5.2.15.10 - newAttachment
Classe Java
Requisição web\wwwroot\ws\java\problem\NewAttachmentRequestType.java
Retorno web\wwwroot\ws\java\problem\NewAttachmentResponseType.java
Estrutura de requisição
<newAttachment>
<ProblemID>?</ProblemID>
<ActivityID>?</ActivityID>
<FileName>?</FileName>
<FileContent>?</FileContent>
<UserID>?</UserID>
<AttachmentID>?</AttachmentID>
<AttachmentName>?</AttachmentName>
<Summary>?</Summary>
</newAttachment>
Requisição
Summary Resumo
Retorno
Identificador Descrição
5.2.15.11 - newChildEntityRecord
Classe Java
Requisição web\wwwroot\ws\java\problem\NewChildEntityRecordRequestType.java
Retorno web\wwwroot\ws\java\problem\NewChildEntityRecordResponseType.java
Estrutura de requisição
<newChildEntityRecord>
<ProblemID>?</ProblemID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
<EntityAttributeList>
<!--Zero ou mais repetições:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero ou mais repetições:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<!--1 ou mais repetições:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?</RelationshipAttributeValue>
</RelationshipAttribute>
</Relationship>
</RelationshipList>
</newChildEntityRecord>
Requisição
§ Data: YYYY-MM-DD
§ Hora: HH:MM
§ Boolean: 0 ou 1
§ Data: YYYY-MM-DD
§ Hora: HH:MM
§ Boolean: 0 ou 1
Retorno
Identificador Descrição
5.2.15.12 - newProblem
Classe Java
Requisição web\wwwroot\ws\java\problem\NewProblemRequestType.java
Retorno web\wwwroot\ws\java\problem\NewProblemResponseType.java
Estrutura de requisição
<newProblem>
<ProblemTypeID>?</ProblemTypeID>
<ProblemTitle>?</ProblemTitle>
<UserID>?</UserID>
</newProblem>
Requisição
Retorno
Identificador Descrição
5.2.16 - Projeto
Web Services
Nesta seção são apresentadas as interfaces disponíveis para o SE Projeto. Para a inserção de cada um
destes itens será necessário seguir o padrão documentado nas próximas seções.
Método Descrição
5.2.16.1 - cancelRat
Este método altera a situação para cancelado o relatório de serviço. Para esta ação é necessário seguir o
padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/project/CancelRatRequestType.java
Retorno web/wwwroot/ws/java/project/CancelRatResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: 2
5.2.16.2 - editProgramCost
Este método possibilita editar custo de um programa. Para esta ação é necessário seguir o padrão abaixo
documentado.
Classe Java
Requisição web/wwwroot/ws/java/project/NewProgramCostRequestType.java
Retorno web/wwwroot/ws/java/project/NewProgramCostResponseType.java
Requisição
1- Planejado;
Phase X
2- Reprogramado;
3- Realizado.
Amount X Quantidade
Description Descrição
Retorno
Identificador Descrição
5.2.16.3 - editProgramRevenue
Este método possibilita editar receita de um programa. Para esta ação é necessário seguir o padrão abaixo
documentado.
Classe Java
Requisição web/wwwroot/ws/java/project/EditProgramRevenueRequestType.java
Retorno web/wwwroot/ws/java/project/EditProgramRevenueResponseType.java
Requisição
1- Planejado;
Phase X
2- Reprogramado;
3- Realizado.
Amount X Quantidade
Description Descrição
Retorno
Identificador Descrição
5.2.16.4 - editProjectCost
Este método possibilita editar custo de um projeto. Para esta ação é necessário seguir o padrão abaixo
documentado.
Classe Java
Requisição web/wwwroot/ws/java/project/EditProjectCostRequestType.java
Retorno web/wwwroot/ws/java/project/EditProjectCostResponseType.java
Requisição
1- Planejado;
Phase X
2- Reprogramado;
3- Realizado.
Amount X Quantidade
Description Descrição
Retorno
Identificador Descrição
5.2.16.5 - editProjectRevenue
Este método possibilita editar receita de um projeto. Para esta ação é necessário seguir o padrão abaixo
documentado.
Classe Java
Requisição web/wwwroot/ws/java/project/EditProjectRevenueRequestType.java
Retorno web/wwwroot/ws/java/project/EditProjectRevenueResponseType.java
Requisição
1- Planejado;
Phase X
2- Reprogramado;
3- Realizado.
Amount X Quantidade
Description Descrição
Retorno
Identificador Descrição
5.2.16.6 - editProjectTaskRevenue
Este método possibilita editar receita de uma atividade de um projeto. Para esta ação é necessário seguir
o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/project/NewProjectTaskRevenueRequestType.java
Retorno web/wwwroot/ws/java/project/NewProjectTaskRevenueResponseType.java
Requisição
1- Planejado;
Phase X
2- Reprogramado;
3- Realizado.
Amount X Quantidade
Description Descrição
Retorno
Identificador Descrição
5.2.16.7 - executeProjectTask
Este método possibilita executar uma atividade de projeto. Para esta ação é necessário seguir o padrão
abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/project/NewAssocDocProjRequestType.java
Retorno web/wwwroot/ws/java/project/NewAssocDocProjResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.16.8 - newAssocDocProj
Este método possibilita associar um documento ao projeto ou a uma atividade de projeto. Para a edição
deste é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/project/NewAssocDocProjRequestType.java
Retorno web/wwwroot/ws/java/project/NewAssocDocProjResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Mensagem do erro
5.2.16.9 - newProgramCost
Este método possibilita inserir custo em um programa. Para esta ação é necessário seguir o padrão abaixo
documentado.
Classe Java
Requisição web/wwwroot/ws/java/project/EditProjectTaskRevenueRequestType.java
Retorno web/wwwroot/ws/java/project/EditProjectTaskRevenueResponseType.java
Requisição
1- Planejado;
Phase X
2- Reprogramado;
3- Realizado.
Amount X Quantidade
Description Descrição
Retorno
Identificador Descrição
5.2.16.10 - newProgramRevenue
Este método possibilita inserir receita em um programa. Para esta ação é necessário seguir o padrão
abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/project/NewProgramRevenueRequestType.java
Retorno web/wwwroot/ws/java/project/NewProgramRevenueResponseType.java
Requisição
1- Planejado;
Phase X
2- Reprogramado;
3- Realizado.
Amount X Quantidade
Description Descrição
Retorno
Identificador Descrição
5.2.16.11 - newProjectCost
Este método possibilita inserir custo em um projeto. Para esta ação é necessário seguir o padrão abaixo
documentado.
Classe Java
Requisição web/wwwroot/ws/java/project/NewProjectCostRequestType.java
Retorno web/wwwroot/ws/java/project/NewProjectCostResponseType.java
Requisição
1- Planejado;
Phase X
2- Reprogramado;
3- Realizado.
Amount X Quantidade
Description Descrição
Retorno
Identificador Descrição
5.2.16.12 - newProjectRevenue
Classe Java
Requisição web/wwwroot/ws/java/project/NewProjectRevenueRequestType.java
Retorno web/wwwroot/ws/java/project/NewProjectRevenueResponseType.java
Requisição
1- Planejado;
Phase X
2- Reprogramado;
3- Realizado.
Amount X Quantidade
Description Descrição
Retorno
Identificador Descrição
5.2.16.13 - newProjectTaskCost
Este método possibilita inserir custo em uma atividade de um projeto . Para esta ação é necessário seguir
o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/project/NewProjectTaskCostRequestType.java
Retorno web/wwwroot/ws/java/project/NewProjectTaskCostResponseType.java
Requisição
1- Planejado;
Phase X
2- Reprogramado;
3- Realizado.
Amount X Quantidade
Description Descrição
Retorno
Identificador Descrição
5.2.16.14 - RatSent
Este método torna o relatório de serviço indisponível para ser retornado pelo outros serviços de
returnRatApproval e returnRatApprovalOne. Para esta ação é necessário seguir o padrão abaixo
documentado.
Classe Java
Requisição web/wwwroot/ws/java/project/RatSentRequestType.java
Retorno web/wwwroot/ws/java/project/RatSentResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: 2
5.2.16.15 - returnRatApproval
Retorna um XML dos relatórios de serviço em aprovação que ainda não foram enviados. Para a edição
deste é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/project/ReturnRatApprovalRequestType.java
Retorno web/wwwroot/ws/java/project/ReturnRatApprovalResponseType.java
Retorno
Identificador Descrição
SUC ESSO: Retorna um XML de todos os relatórios de serviço em aprovação que ainda
return não foram enviados.
FALHA: -1
5.2.16.16 - returnRatApprovalOne
Retorna um XML dos relatórios de serviço em aprovação que ainda não foram enviados. Para a edição
deste é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web/wwwroot/ws/java/project/ReturnRatApprovalOneRequestType.java
Retorno web/wwwroot/ws/java/project/ReturnRatApprovalOneResponseType.java
Retorno
Identificador Descrição
SUC ESSO: Retorna um XML de um relatório de serviço em aprovação que ainda não
return foi enviado.
FALHA: -1
5.2.16.17 - setRatAttributeValue
Este método atribui um valor a um atributo do Relatório de Serviço. Caso o atributo não esteja associado a
um Relatório de Serviço, este será associado. Para esta ação é necessário seguir o padrão abaixo
documentado.
Classe Java
Requisição web/wwwroot/ws/java/project/SetRatAttributeValueRequestType.java
Retorno web/wwwroot/ws/java/project/SetRatAttributeValueResponseType.java
Requisição
Retorno
Identificador Descrição
SUC ESSO: 1
return
FALHA: Mensagem do erro
5.2.17 - Solicitação
Web Services
Nesta seção são apresentadas as interfaces disponíveis para o SE Solicitação. Para a inserção de cada um
destes itens será necessário seguir o padrão documentado nas próximas seções.
Método Descrição
5.2.17.1 - getKeyWordRequestStatus
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\servicer\GetKeyWordRequestStatusRequestType.java
Retorno web\wwwroot\ws\java\servicer\GetKeyWordRequestStatusResponseType.java
Requisição
Retorno
Identificador Descrição
1 – Emissão
2 – Aprovação
3 – A atender
return 4 – Em atendimento
5 – Encerramento
6 – Encerrada
7 – C ancelada
5.2.17.2 - newKeyWordRequest
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\servicer\NewKeyWordRequestRequestType.java
Retorno web\wwwroot\ws\java\servicer\NewKeyWordRequestResponseType.java
Requisição
Atributos da solicitação.
Exemplo:
IDENTIFIC ADOR_DO_ATRIBUTO1=VALOR_DO_ATRIBUT
O1;IDENTIFIC ADOR_DO_ATRIBUTO2=VALOR_DO_ATRIB
UTO2;IDENTIFIC ADOR_DO_ATRIBUTO3=VALOR_DO_AT
RIBUTO3.
ATTRIBUTES X
Exemplo com atributo multivalorado. Observe que o
separador para os valores dos atributos multivalorados é
uma "," (vírgula):
IDENTIFIC ADOR_DO_ATRIBUTO1=VALOR1_DO_ATRIBUT
O1,VALOR2_DO_ATRIBUTO1,VALOR3_DO_ATRIBUTO1.
Retorno
Identificador Descrição
5.2.17.3 - sendRequestToApprov
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java
Requisição web\wwwroot\ws\java\servicer\SendRequestToApprovRequestType.java
Retorno web\wwwroot\ws\java\servicer\SendRequestToApprovResponseType.java
Requisição
Retorno
Identificador Descrição
5.2.18 - Workflow
Web Services
Nesta seção são apresentados os web services disponíveis para o SE Workflow. Para a invocação de cada
um
Método Descrição
5.2.18.1 - cancelWorkflow
Classe Java
Requisição web\wwwroot\ws\java\workflow\CancelWorkflowRequestType.java
Retorno web\wwwroot\ws\java\workflow\CancelWorkflowResponseType.java
Estrutura de requisição
<cancelWorkflow>
<WorkflowID>?</WorkflowID>
<Explanation>?</Explanation>
</cancelWorkflow>
Requisição
Explanation X Justificativa
Retorno
Identificador Descrição
5.2.18.2 - clearChildEntityRecord
Este método exclui todos registros relacionados da entidade de formulário descendente do workflow.
Classe Java
Requisição web\wwwroot\ws\java\workflow\ClearChildEntityRecordRequestType.java
Retorno web\wwwroot\ws\java\incident\ClearChildEntityRecordResponseType.java
Estrutura de requisição
<clearChildEntityRecord>
<WorkflowID>?</WorkflowID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
</clearChildEntityRecord>
Requisição
Retorno
Identificador Descrição
5.2.18.3 - deleteChildEntityRecord
Classe Java
Requisição web\wwwroot\ws\java\workflow\DeleteChildEntityRecordRequestType.java
Retorno web\wwwroot\ws\java\workflow\DeleteChildEntityRecordResponseType.java
Estrutura de requisição
<deleteChildEntityRecord>
<WorkflowID>?</WorkflowID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
<ChildRecordOID>?</ChildRecordOID>
</deleteChildEntityRecord>
Requisição
Retorno
Identificador Descrição
5.2.18.4 - editAttributeValue
Classe Java
Requisição web\wwwroot\ws\java\workflow\EditAttributeValueRequestType.java
Retorno web\wwwroot\ws\java\workflow\EditAttributeValueResponseType.java
Estrutura de requisição
<editAttributeValue>
<WorkflowID>?</WorkflowID>
<AttributeList>
<!--1 ou mais repetições:-->
<Attribute>
<AttributeID>?</AttributeID>
<!--Zero ou mais repetições:-->
<AttributeValueList>
<AttributeValue>?</AttributeValue>
</AttributeValueList>
</Attribute>
</AttributeList>
</editAttributeValue>
Requisição
Valor do atributo
§ Data: YYYY-MM-DD
§ Hora: HHHH:MM
Retorno
Identificador Descrição
5.2.18.5 - editChildEntityRecord
Classe Java
Requisição web\wwwroot\ws\java\workflow\EditChildEntityRecordRequestType.java
Retorno web\wwwroot\ws\java\workflow\EditChildEntityRecordResponseType.java
Estrutura de requisição
<editChildEntityRecord>
<WorkflowID>?</WorkflowID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
<ChildRecordOID>?</ChildRecordOID>
<EntityAttributeList>
<!--Zero ou mais repetições:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero ou mais repetições:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<!--1 ou mais repetições:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?</RelationshipAttributeValue>
</RelationshipAttribute>
</Relationship>
</RelationshipList>
</editChildEntityRecord>
Requisição
§ Data: YYYY-MM-DD
§ Hora: HH:MM
§ Boolean: 0 ou 1
§ Data: YYYY-MM-DD
§ Hora: HH:MM
§ Boolean: 0 ou 1
Retorno
Identificador Descrição
5.2.18.6 - editEntityRecord
Classe Java
Requisição web\wwwroot\ws\java\workflow\EditEntityRecordRequestType.java
Retorno web\wwwroot\ws\java\workflow\EditEntityRecordResponseType.java
Estrutura de requisição
<editEntityRecord>
<WorkflowID>?</WorkflowID>
<EntityID>?</EntityID>
<EntityAttributeList>
<!--Zero ou mais repetições:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero ou mais repetições:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<!--1 ou mais repetições:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?</RelationshipAttributeValue>
</RelationshipAttribute>
</Relationship>
</RelationshipList>
</editEntityRecord>
Requisição
§ Data: YYYY-MM-DD
§ Hora: HH:MM
§ Boolean: 0 ou 1
§ Data: YYYY-MM-DD
§ Hora: HH:MM
§ Boolean: 0 ou 1
Retorno
Identificador Descrição
5.2.18.7 - executeActivity
Classe Java
Requisição web\wwwroot\ws\java\workflow\ExecuteActivityRequestType.java
Retorno web\wwwroot\ws\java\workflow\ExecuteActivityResponseType.java
Estrutura de requisição
<executeActivity>
<WorkflowID>?</WorkflowID>
<ActivityID>?</ActivityID>
<ActionSequence>?</ActionSequence>
<UserID>?</UserID>
</executeActivity>
Requisição
Retorno
Identificador Descrição
5.2.18.8 - executeSystemActivity
Classe Java
Requisição web\wwwroot\ws\java\workflow\ExecuteSystemActivityRequestType.java
Retorno web\wwwroot\ws\java\workflow\ExecuteSystemActivityResponseType.java
Estrutura de requisição
<executeSystemActivity>
<WorkflowID>?</WorkflowID>
<ActivityID>?</ActivityID>
</executeSystemActivity>
Requisição
Retorno
Identificador Descrição
5.2.18.9 - newAssocDocument
Classe Java
Requisição web\wwwroot\ws\java\workflow\NewAssocDocumentRequestType.java
Retorno web\wwwroot\ws\java\workflow\NewAssocDocumentResponseType.java
Estrutura de requisição
<newAssocDocument>
<WorkflowID>?</WorkflowID>
<ActivityID>?</ActivityID>
<DocumentID>?</DocumentID>
</newAssocDocument>
Requisição
Retorno
Identificador Descrição
5.2.18.10 - newAttachment
Classe Java
Requisição web\wwwroot\ws\java\workflow\NewAttachmentRequestType.java
Retorno web\wwwroot\ws\java\workflow\NewAttachmentResponseType.java
Estrutura de requisição
<newAttachment>
<WorkflowID>?</WorkflowID>
<ActivityID>?</ActivityID>
<FileName>?</FileName>
<FileContent>?</FileContent>
<UserID>?</UserID>
<AttachmentID>?</AttachmentID>
<AttachmentName>?</AttachmentName>
<Summary>?</Summary>
</newAttachment>
Requisição
AttachmentID
Summary Resumo
Retorno
Identificador Descrição
5.2.18.11 - newChildEntityRecord
Classe Java
Requisição web\wwwroot\ws\java\workflow\NewChildEntityRecordRequestType.java
Retorno web\wwwroot\ws\java\workflow\NewChildEntityRecordResponseType.java
Estrutura de requisição
<newChildEntityRecord>
<WorkflowID>?</WorkflowID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
<EntityAttributeList>
<!--Zero ou mais repetições:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero ou mais repetições:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<!--1 ou mais repetições:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?</RelationshipAttributeValue>
</RelationshipAttribute>
</Relationship>
</RelationshipList>
</newChildEntityRecord>
Requisição
§ Data: YYYY-MM-DD
§ Hora: HH:MM
§ Boolean: 0 ou 1
§ Data: YYYY-MM-DD
§ Hora: HH:MM
§ Boolean: 0 ou 1
Retorno
Identificador Descrição
5.2.18.12 - newWorkflow
Classe Java
Requisição web\wwwroot\ws\java\workflow\NewWorkflowRequestType.java
Retorno web\wwwroot\ws\java\workflow\NewWorkflowResponseType.java
Estrutura de requisição
<newWorkflow>
<ProcessID>?</ProcessID>
<WorkflowTitle>?</WorkflowTitle>
<UserID>?</UserID>
</newWorkflow>
Requisição
Retorno
Identificador Descrição
5.2.18.13 - newWorkflowUpdateData
Classe Java
Requisição web\wwwroot\ws\java\workflow\NewWorkflowUpdateDataRequestType.java
Retorno web\wwwroot\ws\java\workflow\NewWorkflowUpdateDataResponseType.java
Estrutura de requisição
<newWorkflowUpdateData>
<ProcessID>?</ProcessID>
<WorkflowTitle>?</WorkflowTitle>
<UserID>?</UserID>
<EntityList>
<Entity>
<EntityID>?</EntityID>
<EntityAttributeList>
<!--Zero ou mais repetições:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero ou mais repetições:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<RelationshipAttributeList>
<!--1 ou mais repetições:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?
</RelationshipAttributeValue>
</RelationshipAttribute>
</RelationshipAttributeList>
</Relationship>
</RelationshipList>
<EntityAttributeFileList>
<!--Zero ou mais repetições:-->
<EntityAttributeFile>
<EntityAttributeID>?</EntityAttributeID>
<FileName>?</FileName>
<FileContent>?</FileContent>
</EntityAttributeFile>
</EntityAttributeFileList>
</Entity>
</EntityList>
<AttributeList>
<!--1 ou mais repetições:-->
<Attribute>
<AttributeID>?</AttributeID>
<!--Zero ou mais repetições:-->
<AttributeValueList>
<AttributeValue>?</AttributeValue>
</AttributeValueList>
</Attribute>
</AttributeList>
</newWorkflowUpdateData>
Requisição
· Data: YYYY-MM-DD
· Hora: HH:MM
· Boolean: 0 ou 1
· Data: YYYY-MM-DD
· Hora: HH:MM
· Boolean: 0 ou 1
· Data: YYYY-MM-DD
· Hora: HHHH:MM
Boolean: 0 ou 1
Retorno
Identificador Descrição
Capítulo VI
Histórico de atualização
A tabela abaixo descreve as principais alterações realizadas neste documento.
16 2.0.10 11/12/2017
ð Atualização das seguintes interfaces:
§ Risco RISC ONTROL – C ontrole
§ Risco RISRISK – Risco
§ Ativo ASTOEE - Inclusão de dados dos parâmetros para cálculo do OEE
§ Ativo ASTSEC U - Importação da segurança dos tipos de ativos
§ PDM ITSEC U - Importação da segurança dos tipos de itens
§ Projeto PROFINANC E - Importação financeira
§ Administração disableUser
§ Administração ADMUSRC OMP - Importação completa dos dados do usuário
ð Inclusão de interface dos seguintes componentes:
§ Administração ADMEMPLOYEEPROF – Edita dados do perfil do colaborador
§ C ontrole de atividades editNonProjectTaskC ost
§ C ontrole de atividades editNonProjectTaskRevenue
§ C ontrole de atividades executeNonProjectTask
§ C ontrole de atividades newNonProjectTaskC ost
§ C ontrole de atividades newNonProjectTaskRevenue
§ Desempenho addMeasuresInAdinterface
§ Projeto editProgramC ost
§ Projeto editProgramRevenue
§ Projeto editProjectC ost
§ Projeto editProjectRevenue
§ Projeto editProjectTaskRevenue
§ Projeto executeProjectTask
§ Projeto newProgramC ost
§ Projeto newProjectRevenue
§ Projeto newProjectTaskC ost
§ Projeto setRatAttributeValue
ð Atualização de webservices dos seguintes componentes:
§ Administração DeleteUserAcessGroup
ð Inclusão de web services dos seguintes componentes:
§ Administração updateEmployeeProfile
§ Arquivo físico newPhysicalFileLoan
ð Alteração no Modelo de dados da interface:
§ Inseridas novas colunas NMFIELDs (Da NMFIELD76 até NMFIELD 101) e DSFIELD
(da DSFIELD06 até a DSFIELD15).
ð Alteração na Definição da estrutura do arquivo XLS
§ Inseridas as novas colunas do Modelo de dados da interface.
15 2.0.9 18/10/2017
ð C orreção das seguintes interfaces:
§ Risco RIC ONTROLATTRIBUTE - Valor do atributo do controle
§ Risco RIRISKATTRIBUTE – Valor do atributo do risco
ð Atualização das seguintes interfaces:
§ Ativo ASTSEC U - Importação da segurança dos tipos de ativos
§ Ativo ASTTYPE - Importação de tipos de ativos
ð Atualização dos webservices dos seguintes componentes:
§ PDM addSupplier
ð Interfaces do SE Generic foram movidas para o SE Administração: ADMTEAM e
ADMTEAMASSOC .
14 2.0.9 19/09/2017
ð Inclusão das seguintes interfaces:
§ Ativo ASTPLANAC T - Importação de plano de atividades
§ C ompetência C PTREG - C ompetência
§ Risco RIC ONTROLATTRIBUTE - Valor do atributo do controle
§ Risco RIRISKATTRIBUTE – Valor do atributo do risco
ð Atualização das seguintes interfaces:
08 2.0.5 24/10/2016
ð Atualização da interface:
§ Projeto PROFINANC E - Importação financeira
ð Inclusão das interfaces:
§ C EP SPC SAMPC HANGESTATUS – Alteração de situação de amostra
ð Inclusão dos webservices:
§ C EP C hangeStatusSample
07 2.0.5 11/10/2016
ð Inclusão das interfaces:
§ Administração ADMATRPROFVL - Valor do atributo do perfil do colaborador
ð Inclusão dos webservices:
§ Administração addAttribProfileValue
06 2.0.4 23/08/2016
ð Inclusão das interfaces:
§ Questionário SRVGUESTUSER - Respondente convidado
§ Teste TSTGUESTUSER - Respondente convidado
ð Atualização da seguinte interface:
§ Inspeção IPQUAL - Importação das qualificações da inspeção
§ Inspeção IPREC - Importação de recebimentos
05 2.0.4 06/07/2016
ð Inclusão das interfaces MNMAINTMETER – Leitura de Medidores e
MNMAINTVARIABLE – Leitura de Variáveis.
ð Inclusão dos web services do componente SE Manutenção.
ð Atualização do web service AddAttribute.
04 2.0.3 17/05/2016
ð Inclusão dos web services do componente SE C ontrole de atividades.
ð Inclusão de nota no tópico Integração via web services.
ð Atualização da interface PRORESOURC E - Importação de valores do recurso.
03 2.0.2 25/02/2016
ð Inclusão de nota na seção Autenticação Basic HTTP.
ð Atualização da seguinte interface:
§ Treinamento TRREG - Registro de treinamento
ð Inclusão da seguinte interface:
§ Manutenção MNMAINTC ORREC T – Importação de manutenção corretiva
ð Inclusão dos web services dos seguintes componentes:
§ Incidente
§ Problema
ð Atualização dos web services dos seguintes componentes:
§ Administração
§ Ativo
§ C alibração
§ Documento
§ Inspeção
§ PDM
§ Workflow
02 2.0.2 03/12/2015
ð Atualização das interfaces do componente:
§ Risco
ð Atualização dos web services dos seguintes componentes:
§ Administração
§ Ativo
§ C alibração
§ C EP
§ Generic
§ Inspeção
§ PDM
§ Solicitação
01 2.0.1 20/11/2015
ð Atualização das seguintes interfaces:
§ Administração ADMATR - Importação de atributos
§ Ativo ASTAST - Importação de ativos e ASTASTATT - Importação de
atributos do ativo
ð Atualização dos web services dos seguintes componentes:
§ Administração
§ Ativo
§ Documento
§ PDM
00 2.0.0 01/09/2015
ð C riação do documento a partir do documento "SE Suite 1.3 - Guia de integração".
Fundada em 1995 e contando atualmente com mais de 2 mil clientes e 300 mil usuários ao redor
do mundo, as soluções da SoftExpert são utilizadas por empresas dos mais variados portes e
ramos de atuação, incluindo manufatura, governo, farmacêutico, hospitais e laboratórios,
serviços financeiros, alta tecnologia e TI, educação, energia e utilidade pública, logística,
varejo, serviços, dentre outros.