ELO Serviço Web para Integração de Informação entre Empresas

(1)

Contactos

Elo, SI Lda.

Centro Empresarial Vilar do Pinheiro Via José Régio, 302 (EN 13)

4485 – 860 Vilar do Pinheiro, VDC, Portugal T + 351 229 279 990 ¶ F + 351 229 279 999

marketing@elo-si.com

Tagus Space

Rua Rui Teles Palhinha, nº 6, piso 3, DC – Leião 2740-278 Porto Salvo

T + 351 21 421 4291

www.elo-si.com

ELO

Serviço Web para

Integração de Informação

entre Empresas

(2)

(3)

DCS_MN_SWIntegraçaoEmpresas_03_Pt.docx Rev. 10 dez-13 Página 3 de 11

Introdução

O presente manual tem o objetivo de apresentar o esquema de funcionamento do Serviço Web para Integração de Informação entre Empresas disponibilizado pela ELO – Sistemas de Informação, Lda.

Em determinados momentos torna-se oportuno para duas ou mais empresas transferir informação entre si. Muitas vezes este facto torna-se sinónimo de um processo longo e complexo que consequentemente atrasa o negócio de todas as partes interessadas. No âmbito de apresentar uma solução para esta problemática apresenta-se este serviço de integração.

As soluções informáticas da ELO, como representantes da gestão de tempo, segurança e tarefas, apresentam uma elevada quantidade de informação de vasta utilidade como por exemplo: funcionários de uma empresa, horários, planos de acesso, entre outros. A existência da possibilidade da receção/envio/troca desta informação entre sistemas representa assim uma mais-valia fundamental na integração de empresas.

O presente documento apresenta assim uma solução viável para troca de informação de forma simples e rápida, através de processos informáticos transparentes e sólidos. Aconselha-se uma leitura atenta deste documento. Em caso de dúvidas ou esclarecimentos os mesmos deverão ser remetidos para esta empresa autora deste projeto.

(4)

Estrutura

É assim disponibilizado um serviço web com uma interface constituída por uma serie de funcionalidades que serão descritas ao longo deste manual.

Todas as funcionalidades irão oferecer uma mensagem de retorno com indicação do resultado do processo. Essa mensagem será sempre retornada no formato de um objeto de informação descendente do objeto “CallResult”. Este ultimo tem a seguinte constituição:

int OperationSuccess Variável indicadora do Sucesso total (1), Sucesso

com Erros/Avisos (0) ou Não sucesso (-1) da operação

String

OperationResultDescription

Descrição do resultado da operação

O serviço web disponibilizado assenta sobre a tecnologia WCF SOAP e tem o seu WSDL exposto publicamente para testes no endereço

http://83.240.174.165/dcsSWEPIIE/EloWebService.svc

Todas as chamadas efetuadas para este endereço irão retornar sucesso mas não terão qualquer efeito sobre qualquer sistema.

(5)

Funcionalidades

1.1 Receção de Funcionários

O presente serviço web disponibiliza uma metodologia simples de inserção de informação de perfis de funcionário no sistema ELO nG.

Cada funcionário possui o seu perfil com informação básica sobre si próprio, um conjunto de identificações no sistema e ainda um plano de acessos associado.

Assim, na prática cada Funcionário no sistema possui um Perfil onde constam as suas informações pessoais. Cada perfil tem a si associada uma Identificação que representa a informação que permite ao sistema identificar o funcionário nos dispositivos de acessos e controlo de tempo. À identificação estão associadas Expressões de

Identificação que representam as diversas formas pelas quais o funcionário poderá ser

identificado, por exemplo: cartão, chip, biometria, matricula, etc.

A funcionalidade tem a seguinte assinatura:

RegistEmployeeResult RegistEmployee(Employee Employee);

O método “RegistEmployee” recebe assim como parâmetro um objeto “Employee” representativo de toda a informação a receber e persistir no sistema. O seu retorno é constituído por um objecto “RegistEmployeeResult”. Este objeto é herdeiro do objeto “CallResult” e acrescenta a si um objeto “Employee” com os campos com erro/campos não aceites preenchidos de forma a indicar possíveis situações inválidas. Todos os campos aceites/válidos serão retornados com um valor vazio ou nulo.

Nota: Se já existir informação sobre o funcionário (identificado pelo Código único de funcionário) no sistema, a nova informação recebida irá atualizar a informação atual. Todos os campos recebidos a nulo não sofrerão atualizações. No caso de serem enviadas novas Expressões de Identificação as mesmas serão adicionadas ao sistema.

(6)

Perfil do Funcionário (“Employee”)

(*) – Campos Obrigatórios

String EmployeeCode (*) Código único do novo funcionário

String CompanyCode (*) Código da Empresa à qual o funcionário está

associado.

String Name Nome completo do funcionário

String AbbreviatedName Nome abreviado (Ex. Primeiro e último nome)

String SpouseName Nome do conjugue, se aplicável

String Address Morada do funcionário

String PostalCode Código postal da morada indicada

String PostalLocality Localidade do funcionário

String Town Freguesia/Vila onde habita o funcionário

String County Concelho onde habita o funcionário

String District Distrito onde habita o funcionário

String CountryCode Código do país onde habita o funcionário. Por

exemplo: Portugal = “PT”

String MobilePhoneNumber Número de telefone móvel

String TelephoneNumber1 Número de telefone fixo 1

String TelephoneNumber2 Número de telefone fixo 2

String Email Endereço de correio eletrónico

String Nationality Nacionalidade do funcionário

String CountryOfBirth País de nascimento do funcionário

String Gender Género Sexual. M = (Male) Masculino | F = (Female)

Feminino

String Observations Observações adicionais sobre o funcionário

String EmployeeTypeCode Código do Tipo de Funcionário. Deve ser indicado

conforme o configurado no software nG. Na ausência de uma configuração prévia o código será aceite mas não terá correspondência válida

String TimeGroupCode Código do Grupo Time. Deve ser indicado conforme

(7)

DCS_MN_SWIntegraçaoEmpresas_03_Pt.docx Rev. 10 dez-13 Página 7 de 11 configuração prévia o código será aceite mas não terá correspondência válida

String ProfessionalGroupCode Código do Grupo Profissional. Deve ser indicado

String

ProfessionalCategoryCode

Código da Categoria Profissional. Deve ser indicado conforme o configurado no software nG. Na ausência de uma configuração prévia o código será aceite mas não terá correspondência válida

String OriginLocationCode Código do Local de Origem do funcionário. Deve ser

indicado conforme o configurado no software nG. Na ausência de uma configuração prévia o código será aceite mas não terá correspondência válida

String WorkLocationCode Código do local de trabalho do funcionário. Deve ser

indicado conforme o configurado no software nG. Na ausência de uma configuração prévia o código será aceite mas não terá correspondência válida

String SectionCode Código da secção do funcionário. Deve ser indicado

String AditionalCode1 Campo para informação adicional número 1

DateTime? StartDate Data de inicio a partir da qual o perfil de funcionário

passará a ser válido. Se nula ou superior à variável “EndDate” será considerada a data mínima (01/01/0001 00:00:00)

DateTime? EndDate Data a partir da qual o perfil do funcionário passará

(8)

DCS_MN_SWIntegraçaoEmpresas_03_Pt.docx Rev. 10 dez-13 Página 8 de 11 variável “StartDate” será considerada a data máxima (31/12/9999 23:59:59)

Boolean? ComputeTime Variável indicadora se o funcionário deverá (true) ou

não (false) ser incluído no Processamento de Tempo. Valor por Defeito: false

String AccessPlanCode Código do Plano de Acessos associado. Deve ser

indicado conforme o configurado no software nG.

Nota: O funcionário apenas será associado a um

plano de acessos se possuir a sua identificação (objecto “Identification”) preenchida

Identification Identification Objeto representativo da identificação do

funcionário perante os dispositivos do sistema

Identificação do Funcionário (“Identification”)

String CompanyCode (*) Código da Empresa à qual a identificação está

associada.

IdentificationGCEI

Fabricante do dispositivo associado à identificação. O valor desta variável deve corresponder a um dos valores do enumerado “IdentificationGCEI”:

 Suprema

 Isgus

DateTime? RegistryDateTime Data e hora do momento em que a identificação foi

criada. Valor por Defeito: data do momento da receção da informação

Boolean? Active Variável indicadora se a identificação se encontra

ativa (true) ou não (false). Valor por Defeito: false

List<IdentificationExpression>

IdentificationExpressions

Conjunto de formas de expressão da identificação do funcionário

(9)

Forma de Expressão da Identificação do Funcionário (“IdentificationExpression”)

IdentificationExpressionType

IdentificationExpressionType (*)

Tipo da forma de expressão de identificação. O valor desta variável deve corresponder a um dos

valores do enumerado

“IdentificationExpressionType”:

 Card (Cartão)

 Fingerprint (Impressão Digital)

 PIN (Código PIN)

 Face (Rosto)

 IRIS (Íris ótica)

 Chip (Chip ou botão)

 LicencePlate (Matricula)

DateTime? EmissionDateTime Data de emissão/criação da expressão de

identificação. Valor por Defeito: data do momento da receção da informação

DateTime? StartDateTime Data a partir do qual a expressão da identificação

passará a ser válida/estar ativa. Se nula ou superior à variável “EndDateTime” será considerada a data mínima (01/01/0001 00:00:00)

DateTime? EndDateTime Data a partir do qual a expressão da identificação

passará a ser inválida. Se nula ou inferior à variável “StartDateTime” será considerada a data máxima (31/12/9999 23:59:59)

String Code Variável com o valor associado à expressão de

identificação. O valor deverá variar consoante o tipo de expressão da seguinte forma:

 Card (Cartão) = Numero do Cartão

 Fingerprint (Impressão Digital) = (Não aplicável)

 PIN (Código PIN) = Código PIN

(10)

DCS_MN_SWIntegraçaoEmpresas_03_Pt.docx Rev. 10 dez-13 Página 10 de 11

 IRIS (Íris ótica) = (Não aplicável)

 Chip (Chip ou botão) = Numero do Chip

 LicencePlate (Matricula) = Matricula

Todos os casos não aplicáveis devem ser

posteriormente configurados utilizando o

sistema nG para preenchimento da restante

informação.

Por

exemplo:

recolha

da

impressão digital

(11)

DCS_MN_SWIntegraçaoEmpresas_03_Pt.docx Rev. 10 dez-13 Página 11 de 11

Conclusão

O presente documento apresenta assim de forma breve as funcionalidades do seu serviço de integração de informação entre empresas.

Quaisquer dúvidas, sugestões ou questões técnicas deverão ser submetidas a esta empresa para análise.