Tópico anterior: Objeto de parâmetros

Próximo tópico: Objeto de vetor

Objeto de ferramentas

Um objeto global que contém alguns métodos úteis .

AddEventAnnotation(<Info>, <EventId>)

Salva uma anotação do evento para o evento especificado. Essa informação pode ser útil posteriormente ao exibir dados brutos (eventos). A anotação salva pode explicar algumas situações específicas durante a execução da fórmula de lógica de negócios em um determinado momento.

O parâmetro Informações especifica o texto de anotação que deve ser gravado.

Ele também aceita um parâmetro EventId, especificando o evento anotado.

AddRootCauseComment(<Info>, <Timestamp>, <ResourceId>)

Salva um comentário de causa raiz. Essa informação pode ser útil posteriormente na geração de relatórios. O comentário de causa raiz salvo explica uma situação específica durante a execução da fórmula de lógica de negócios em um determinado momento.

O parâmetro Informações especifica o comentário que deve ser gravado.

O método recebe uma data e hora a serem salvas junto com o comentário. Ele também aceita um parâmetro ResourceId, especificando o recurso relacionado ao contexto do método. (Esse parâmetro é opcional e pode ser omitido).

GetCustomAttributeForResource(resourceName, timestamp, customAttributeName)

Retorna o valor do atributo personalizado especificado, do recurso especificado, na hora especificada.

Se o atributo não existir no momento do evento, ocorrerá um erro.

Exemplo:

Dim AttribVal
AttribVal = Tools. GetCustomAttributeForResource. "MyResource", #12/12/06 12:34:56#, "MyAttribute"

GetExternalData (connectionString, query)

Este método retorna um conjunto de registros obtidos a partir do banco de dados especificado pelo texto da conexão, com base na consulta especificada.

Ambas as sequências de caracteres devem terminar com um ponto-e-vírgula (;).

O usuário pode então usar conjunto de registros, como segue:

Exemplo:

Dim rs
Set rs = Tools.GetExternalData(
"dsn=oblicore;uid=oblicore;pwd=oblicore;", "select * from t_rules")
Do Until rs.EOF
  Out.Log "Name=" & rs("RULE_NAME"), "I"
  rs.MoveNext
Loop
rs.Close 

GetLocaleTime(<utcTime>)

O método converte uma hora dada em UTC no fuso horário da métrica atual.

GetUtcTime(<localeTime>)

O método converte uma hora dada no fuso horário da métrica atual em UTC.

HasCustomAttributeForResource(resourceName, timestamp, customAttributeName)

O retorno especifica se o atributo especificado existe ou não no recurso especificado na hora especificada.

Exemplo:

Dim AttribExistsNow
AttribExistsNow = Tools. HasCustomAttributeForResource "MyResource", #12/12/06 12:34:56#, "MyAttribute"

NetTime(<Begin time>, <End time>)

Aceita dois parâmetros que significam um período de tempo.

O método calcula e retorna a quantidade de tempo (em segundos) desde o início do período até o fim, o qual está no período de atividade.

Se a Hora de início for posterior à Hora de término, o resultado será um número negativo.

SaveFields(<tableName>, <Key>, fieldName1, fieldValue1, fieldName2, fieldValue2,…)

Semelhante a SaveRecord, exceto pelo fato de que, em vez de enumerar todos os valores, ele fornece pares de nomes de campo e os valores de campo relacionados. Os números de campo podem ser substituídos por nomes de campo. (O número do primeiro campo de valor é 1).

Observação: esse método é executado somente pelo agente do período de monitoramento.

SaveRecord <tableName>, <key>, <val1>, <val2>,…

Salva um registro em uma tabela de usuário. As tabelas de usuário são usadas para produzir informações durante o cálculo de nível de serviço. Essas informações podem ser usadas posteriormente para gerar relatórios. Pode haver muitas tabelas de usuário.

O parâmetro tableName especifica a tabela na qual as informações devem ser gravadas. Cada registro na tabela de usuário tem uma chave exclusiva, que especifica o registro no qual as informações devem ser gravadas. Cada registro também tem muitos campos de valor de sequência de caracteres. O número exato de campos de valor em cada tabela de usuário e os nomes dos campo são definidos durante a implementação.

O método SaveRecord recebe o nome de uma tabela de usuário e uma chave. Ele também aceita todos os campos de valor na tabela de usuário. (Esses parâmetros de valor são opcionais e podem ser omitidos.) Se um registro com a mesma chave já existir, ela será atualizada. (Somente os campos de valor transferidos como parâmetros são atualizados.) Se um registro com esta chave não existir, ela será criada.

Observação: esse método é executado somente pelo agente do período de monitoramento.

SendEvent(<eventName>, <resourceName>, <Timestamp>, <TimeUnit>, <args>)

Esse método cria um novo evento de métrica. As definições dos parâmetros são como segue:

Exemplo:

Tools.SendEvent "OnEvent", "MyResource", #02/01/06 13:46:00#, "All", 1, 2