Na versão 5.5 do Elipse E3, foi criado no E3 Server um objeto do tipo ServerNode chamado Informações do Servidor (“[?Server]”). Este objeto, como diz o nome, retorna as informações sobre o servidor e seus objetos filhos; ele não possui eventos nem métodos associados.
Não apenas este objeto como também todos os seus objetos filhos possuem as propriedades gerais Count, Name e Parent, além do método geral Item. Também é possível utilizar a declaração For Each em scripts a fim de enumerar os objetos filhos.
A utilização de colchetes na referência a este objeto em scripts, como por exemplo “[?Server]”, é obrigatória. Para maiores informações, consulte a documentação atualizada.
Propriedade disponível neste objeto:
- ProductString: Retorna o nome do produto e a versão do servidor, como por exemplo “E3 5.5.192”. Esta propriedade é somente de leitura.
Em seguida, veremos os filhos do objeto Informações do Servidor (“[?Server]”).
1. Informações da Sessão
Esta seção contém informações sobre propriedades do objeto Informações da Sessão (SessionNodeBase). Este objeto não possui nenhum evento ou método associados.
A utilização de colchetes na referência a este objeto em scripts, como por exemplo “[?Server].Clients.RemoteDomains”, é obrigatória.
Os objetos Informações da Sessão atualmente disponíveis são os seguintes, a saber:
· RemoteDomains: Conexões de Domínios remotos
· Studios: Conexões de E3 Studios
· Viewers: Conexões de E3 Viewers
Propriedades disponíveis neste objeto:
- Address: Retorna o endereço IPv4 da máquina cliente no formato XXX.XXX.XXX.XXX, onde XXX é um valor entre 0 (zero) e 255. Esta propriedade é somente de leitura.
- Machine: Retorna o nome da máquina cliente. Esta propriedade é somente de leitura.
- ReadOnly: Indica se a sessão do cliente está no modo somente leitura. Esta propriedade é somente de leitura. Nota: Esta propriedade não está disponível para os objetos de sessões Studios, em “[?Server].Clients.Studios”.
- StartTime: Indica a data e hora do estabelecimento da conexão com o cliente. Esta propriedade é somente de leitura.
- User: Retorna o nome de login do usuário da sessão, ou então uma String vazia no caso de um usuário anônimo. Esta propriedade é somente de leitura.
- Version: Retorna a versão do cliente, como por exemplo “5.5.192”. Esta propriedade é somente de leitura.
2. Informações das Licenças
Esta seção contém informações sobre propriedades do objeto Informações das Licenças (LicenseNode). Este objeto não possui nenhum evento ou método associados.
Este objeto, bem como todos os seus objetos filhos, possui as propriedades gerais Count, Name e Parent, além do método geral Item. Também é possível utilizar a declaração For Each em scripts a fim de enumerar seus objetos filhos.
A utilização de colchetes na referência a este objeto em scripts, como por exemplo “[?Server].License”, é obrigatória.
Propriedades disponíveis neste objeto:
- DbAvailable: Indica se a licença atual permite o recurso de bancos de dados. Esta propriedade é somente de leitura.
- DeviceType: Indica o tipo de dispositivo da licença atual. Os valores possíveis para esta propriedade são 0: Não encontrado, 1: HASP, 2: TimeHasp ou 3: Softkey. Esta propriedade é somente de leitura.
- ExpireDate: Indica a data de expiração da licença atual, ou então 0 (zero) se a licença atual não tem data de expiração. Esta propriedade é somente de leitura.
- ID: Retorna o identificador único do dispositivo de proteção da licença atual, ou então uma String vazia caso o E3 esteja em modo de demonstração. Esta propriedade é somente de leitura.
- IsDemo: Indica se a licença atual está em modo de demonstração, ou seja, se não foi encontrada nenhuma licença válida. Esta propriedade é somente de leitura.
- MaxRuntime: Indica o tempo máximo permitido de execução do Domínio, em minutos. Esta propriedade é somente de leitura.
- OpcClientAvailable: Indica se a licença atual permite a utilização de um cliente OPC DA. Esta propriedade é somente de leitura.
- ReportsAvailable: Indica se a licença atual permite a utilização do recurso de Relatórios. Esta propriedade é somente de leitura.
- UaClientAvailable: Indica se a licença atual permite a utilização de um cliente OPC UA. Esta propriedade é somente de leitura.
- VersionRange: Indica o intervalo de versões permitido pela licença atual, como por exemplo “4.7-5.0”; ou seja, a licença atual pode ser utilizada entre as versões 4.7 e 5.0. Esta propriedade é somente de leitura.
2.1 Informações dos Tipos de Licenças
Esta seção contém informações sobre propriedades do objeto Informações dos Tipos de Licenças (LicenseCounterNode). Este objeto não possui nenhum evento ou método associados.
A utilização de colchetes na referência a este objeto em scripts, como por exemplo “[?Server].License.IoDrivers”, é obrigatória.
Os objetos Informações dos Tipos de Licenças atualmente disponíveis são os seguintes, a saber:
· ViewersControl: Licenças de E3 Viewer
· ViewersOnly: Licenças de E3 Viewer Only
· Studios: Licenças de E3 Studio
· IoPoints: Licenças de pontos de entrada e saída
· StorageTags: Licenças de Tags de Storage
· RemoteServers: Licenças de Domínios remotos servidores
· RemoteClients: Licenças de Domínios remotos clientes
· OpcServer: Licenças de servidor OPC
· IoDrivers: Licenças de Drivers para qualquer Driver, ou seja, licenças ilimitadas de Drivers
· IoDriversId: Licenças de Drivers, em que nnn é um valor numérico entre 1 (um) e 65535, quando há licenças para um ID específico de Driver de entrada e saída
Propriedades disponíveis neste objeto:
- IsUnlimited: Indica se o Tipo de Licença atual é ilimitado, ou seja, se o valor da propriedade Limit não é usado. Esta propriedade é somente de leitura.
- Limit: Indica o limite de licenças para este Tipo de Licença, ou então -1 (menos um) se este Tipo de Licença for ilimitado. Esta propriedade é somente de leitura.
- Used: Indica o número total de licenças já consumidas por este Tipo de Licença. Esta propriedade é somente de leitura.
3. Informações de Segurança
A partir da versão 6.5 do Elipse E3, foi adicionado o nó Security no objeto ?Server. O objeto Informações de Segurança (SecurityNode) não tem eventos, métodos ou propriedades específicos associados, somente as propriedades gerais Count, Name e Parent, além do método geral Item. Também é possível utilizar a declaração For Each em scripts para enumerar os objetos filhos desta coleção.
3.1 Informações de Grupos
Esta seção contém informações sobre métodos do objeto Informações de Grupos (GroupsNode). Este objeto não possui eventos nem propriedades associados.
Este objeto e todos os objetos filhos possuem as propriedades gerais Count, Name e Parent, além do método geral Item. Também é possível utilizar a declaração For Each em scripts para enumerar os objetos filhos desta coleção.
A utilização de colchetes na referência a este objeto em scripts, como por exemplo “[?Server].Security.Groups”, é obrigatória.
Métodos disponíveis neste objeto:
- CreateGroup(Name, Type): Cria um grupo com o nome indicado no parâmetro Name e o tipo indicado no parâmetro Type. Os valores possíveis para o parâmetro Type são 0: Grupo do E3 ou 1: Grupo do Windows. Este método falha caso o grupo indicado no parâmetro Name já exista ou se este parâmetro é uma String vazia.
- GroupExists(Name): Retorna Verdadeiro se o grupo indicado pelo parâmetro Name existe ou Falso se este grupo não existe.
- RemoveGroup(Name): Remove o grupo indicado pelo parâmetro Name. Este método falha caso o parâmetro Name indique um grupo inexistente.
3.1.1 Informações de um Grupo
Esta seção contém informações sobre métodos e propriedades do objeto Informações de um Grupo (GroupNode). Este objeto não possui eventos associados.
Métodos
- AddToGroup(GroupName): Adiciona este grupo ao grupo indicado no parâmetro GroupName. Este método falha se o grupo indicado no parâmetro GroupName não existe ou é uma referência inválida, ou seja, é um grupo do Windows ou um grupo que já pertence a este grupo direta ou indiretamente.
- RemoveFromGroup(GroupName): Remove o grupo indicado pelo parâmetro GroupName deste grupo. Este método falha caso o parâmetro GroupName indique um grupo inexistente.
Propriedades
- Type: Indica o tipo deste grupo. Os valores possíveis para esta propriedade são 0: Grupo do E3 ou 1: Grupo do Windows. Esta propriedade é somente de leitura.
3.2 Informações de Usuários
Esta seção contém informações sobre métodos do objeto Informações de Usuários (UsersNode). Este objeto não possui eventos nem propriedades associados.
Métodos
- CreateUser(Name, Type, IsAdmin, [FullName], [Password]): Cria um novo usuário. Os parâmetros deste método são os seguintes:
Name: Nome do usuário a ser criado
Type: Tipo do usuário a ser criado. Os valores possíveis para este parâmetro são 0: Usuário do E3 ou 1: Usuário do Windows
IsAdmin: Indica se este usuário é um administrador ou não
FullName: Nome completo deste usuário.
Password: Senha deste usuário.
Exemplo de utilização do método CreateUser:
Set Users = Application.GetObject("[?Server].Security.Users")
Users.CreateUser "User01", 0, false, "Teste001", "User01"
msgbox "FullName: " & Application.GetObject("[?Server].Security.Users.[User01]").FullName
- RemoveUser(Name): Remove o usuário indicado no parâmetro Name. Este método falha caso o parâmetro Name indique um usuário inexistente.
- UserExists(Name): Retorna Verdadeiro se o usuário indicado pelo parâmetro Name existe ou Falso se este usuário não existe.
3.2.1 Informações de um Usuário
Esta seção contém informações sobre métodos e propriedades do objeto Informações de um Usuário (UserNode). Este objeto não possui eventos associados.
Métodos
- AddToGroup(GroupName): Adiciona este usuário ao grupo indicado pelo parâmetro GroupName. Este método falha se o grupo indicado no parâmetro GroupName não existe.
- RemoveFromGroup(GroupName): Remove este usuário do grupo indicado pelo parâmetro GroupName. Este método falha caso o parâmetro GroupName indique um grupo inexistente.
Propriedades
- FullName: Texto Retorna ou configura o nome completo deste usuário.
- IsAdministrator: Retorna ou configura se este usuário é um administrador.
- Password: Configura a senha deste usuário. Esta propriedade é somente de escrita.
- Type: Retorna ou configura o tipo deste usuário. Os valores possíveis para esta propriedade são 0: Usuário do E3 ou 1: Usuário do Windows.
4. Informações do Domínio
Esta seção contém informações sobre propriedades do objeto Informações do Domínio (DomainNode). Este objeto não possui nenhum eventos associados.
Este objeto, bem como todos os seus objetos filhos, possui as propriedades gerais Count, Name e Parent, além do método geral Item. Também é possível utilizar a declaração For Each em scripts a fim de enumerar seus objetos filhos.
A utilização de colchetes na referência a este objeto em scripts, como por exemplo “[?Server].Domain”, é obrigatória.
Métodos disponíveis neste objeto:
- Refresh(): Força a atualização do Domínio atual.
- Stop(): Para o Domínio em execução.
Propriedades disponíveis neste objeto:
- Domain: Nome amigável do Domínio, configurado no item Nome do Domínio do grupo Geral na aba Propriedades da janela de configurações do Domínio. Esta propriedade é somente de leitura.
- FullPath: Caminho completo do arquivo de Domínio. Esta propriedade é somente de leitura.
- HotStandby: Retorna Verdadeiro se o modo Hot-Standby está habilitado no Domínio. Esta propriedade é somente de leitura.
- State: Indica o estado do Domínio. Os valores possíveis para esta propriedade são -1: Fechado ou sem Domínio, 0: Parado mas carregado, 1: Em modo Hot-Standby ou 2: Executando. Esta propriedade é somente de leitura.
4.1 Informações dos Servidores do Domínio
Esta seção contém informações sobre propriedades do objeto Informações dos Servidores do Domínio (DomainServerNode). Este objeto não possui nenhum evento ou método associados.
A utilização de colchetes na referência a este objeto em scripts, como por exemplo “[?Server].Domain.Servers.LocalServer”, é obrigatória.
Os objetos Informações dos Servidores do Domínio atualmente disponíveis são LocalServer (Servidor do Domínio local) e RemoteServer (Servidor do Domínio remoto).
Propriedades disponíveis neste objeto:
- Connection: Indica uma mensagem de diagnóstico sobre o estado atual da conexão do servidor local com o servidor remoto. Corresponde ao texto da coluna Conexão da lista Servidores conectados da janela Monitor do E3 Admin. Esta propriedade é somente de leitura e só está disponível para o objeto RemoteServer.
- Disabled: Retorna Verdadeiro se o servidor foi configurado como desabilitado ou em manutenção. Esta propriedade é somente de leitura.
- DomainState: Indica o estado do Domínio no servidor remoto. Os valores possíveis para esta propriedade são -1: Fechado ou sem Domínio, 0: Parado mas carregado, 1: Em modo Hot-Standby ou 2: Executando. Normalmente, o valor desta propriedade é o mesmo valor da propriedade State do objeto Informações do Domínio caso o outro servidor esteja com o mesmo Domínio carregado. Esta propriedade é somente de leitura, e só está disponível para o objeto RemoteServer.
- FailuresWeight: Indica o peso total de falhas ativas no servidor, ou então 0 (zero) para indicar que o servidor está em modo Hot e apresenta falhas. Esta propriedade é somente de leitura.
- IsCandidate: Indica se este servidor está pronto ou não para assumir a execução do Domínio. Esta propriedade é somente de leitura.
- IsIoActive: Indica se há servidores de I/O executando neste servidor. Esta propriedade é somente de leitura.
- IsPrioritySet: Indica se este servidor requisitou ou não prioridade de execução, ou seja, se este servidor requisitou ou não prioridade para ser o servidor ativo. Esta propriedade é somente de leitura.
- NetworkAddress: Indica o nome do servidor na rede. Este nome corresponde ao nome de host, não ao endereço IPv4. Esta propriedade é somente de leitura.
- Online: Retorna Verdadeiro se a conexão com o servidor remoto estiver funcionando. Esta propriedade é somente de leitura, e só está disponível para o objeto RemoteServer.
- Ping: Indica se o comando ping realizado do servidor local para o servidor remoto está funcionando ou não, ou seja, se há resposta. Esta propriedade é somente de leitura e só está disponível para o objeto RemoteServer.
- ServerName: Indica o nome ou alias do servidor, conforme a configuração do Domínio. Esta propriedade é somente de leitura.
- State: Retorna o estado de execução do Domínio no servidor. Os valores possíveis para esta propriedade são -1: Fechado ou sem Domínio, 0: Parado mas carregado, 1: Em modo Hot-Standby ou 2: Executando. Esta propriedade é somente de leitura.
4.2 Informações de Servidores Remotos
Esta seção contém informações sobre propriedades do objeto Informações de um Servidor Remoto (RemoteDomainNode). Este objeto não possui nenhum evento ou método associados.
A utilização de colchetes na referência a este objeto em scripts, como por exemplo “[?Server].Domain.RemoteDomains.Nome_Dominio”, é obrigatória.
Propriedades disponíveis neste objeto:
- ActiveServer: Indica o nome do servidor remoto com a conexão ativa, caso a conexão esteja estabelecida, ou então uma String vazia se o servidor remoto não estiver conectado.
- BackupAddress: Indica o endereço do servidor remoto secundário para este Domínio remoto, ou então uma String vazia se o servidor secundário estiver desabilitado.
- Connected: Indica se no momento há uma conexão estabelecida com algum servidor remoto, seja ele principal ou secundário.
- DomainFile: Indica o nome do arquivo de Domínio configurado para este Domínio remoto.
- LastError: Retorna uma mensagem de diagnóstico sobre o motivo da falha de conexão com o servidor principal, ou então uma String vazia caso haja uma conexão ativa.
- LastErrorBackup: Retorna uma mensagem de diagnóstico sobre o motivo da falha de conexão com o servidor secundário, ou então uma String vazia caso haja uma conexão ativa.
- ServerAddress: Indica o endereço do servidor remoto principal para este Domínio remoto, ou então uma String vazia se o servidor principal estiver desabilitado.
4.3 Informações dos Arquivos do Domínio
O objeto Informações dos Arquivos do Domínio (AppFilesNode) não tem eventos, métodos ou propriedades específicos associados, somente as propriedades gerais Count, Name e Parent, além do método geral Item. Também é possível utilizar a declaração For Each em scripts para enumerar os objetos filhos desta coleção.
4.3.1 Informações dos Arquivos de Pacotes/Biblioteca do Domínio
Propriedades
- FileVersionMaj: Contém o número principal da versão de um arquivo de pacote/biblioteca. Corresponde ao número principal da coluna Versão na janela Relatório de Versões do E3 Studio. Esta propriedade é somente de leitura.
- FileVersionMin: Contém o número secundário da versão de um arquivo de pacote/biblioteca. Corresponde ao número secundário da coluna Versão na janela Relatório de Versões do E3 Studio. Esta propriedade é somente de leitura.
- PathVolume: Caminho completo de um arquivo de pacote/biblioteca. Esta propriedade é somente de leitura.
4.3.2 Informações dos Arquivos de Projeto do Domínio
Propriedades
- DocString: Retorna a propriedade DocString de um arquivo de projeto. Esta propriedade é somente de leitura.
- Enabled: Permite habilitar ou desabilitar um arquivo de projeto.
- FileVersionMaj: Contém o número principal da versão de um arquivo de projeto. Corresponde ao número principal da coluna Versão na janela Relatório de Versões do E3 Studio. Esta propriedade retorna -1 (menos um) se o arquivo de projeto está desabilitado ou 0 (zero) caso haja algum erro de carregamento do arquivo de projeto. Esta propriedade é somente de leitura.
- FileVersionMin: Contém o número secundário da versão de um arquivo de projeto. Corresponde ao número secundário da coluna Versão na janela Relatório de Versões do E3 Studio. Esta propriedade é somente de leitura.
- PathVolume: Caminho completo de um arquivo de projeto. Esta propriedade é somente de leitura.
Em anexo, há uma aplicação exemplo desenvolvida no Elipse E3 v5.5.192, com maiores detalhes sobre a utilização de alguns objetos descritos neste artigo.
Anexos:
