Add / update an alarm notes via code / API

Hello,

I need to add notes or update an existing one for alarm.

I know I get can notes via API / code but I did not find any way to overwrite the data from code or API.

For example this code will get alarms notes:

alarmId = args['alarmId']
alarmService = server.get('AlarmService');
topSrv = server.get('TopologyService');
annos = alarmService.getAnnotations(alarmId);
alarmNotes = [];
for(anno in annos){
        note = topSrv.createAnonymousDataObject(topSrv.getType('AlarmNote'));
	note.set("id", anno.getID());
	note.set("text", anno.getText());
	note.set("alarmId", alarmId);
	note.set("username", anno.getUsername());
	note.set("createdTime", anno.getCreatedTime());
	alarmNotes.add(note);
}
return alarmNotes;

when I try to set the text of the notes it will not update in Foglight database, there is a way to use code to set the data that will save in the system?

Thanks.

Top Replies

wouter.detroyer over 2 years ago +1 verified
we use this to set a unique note, you'll have to set the args yoursef of course

not sure if it helps:
```
def alarmID = args[1]
def text = args[2]		
def annotations = server["AlarmService"].getAnnotations…
```

+1 wouter.detroyer over 2 years ago

we use this to set a unique note, you'll have to set the args yoursef of course

not sure if it helps:

def alarmID = args[1]
def text = args[2]		
def annotations = server["AlarmService"].getAnnotations(alarmID)
def exists = annotations. find {it.text.equals(text)}
if(!exists){
 	server.AlarmService.createAnnotation ( text as String, alarmID)
}

0 support over 2 years ago in reply to wouter.detroyer

it's working great thank you!

is there any document with list of functions? from where did you knew about 'createAnnotation'?

thanks again.
Cancel
Up 0 Down

Reply

Verify Answer

Cancel
0 wouter.detroyer over 2 years ago in reply to support

the API is under the "launch service layer documentation" button on the Script console

https://support.quest.com/kb/232352/running-a-groovy-script-using-the-script-console

Foglight Reporting using Metric Queries or Groovy

you look for alarmservice in <fms>/console/script-help/index.html?com/quest/nitro/service/sl/interfaces/ServiceLocator.html

As to writing the scripts, there not much documentation on the quest portal as far as i know.

in the Foglight included help there is some info under Customizing Your Foglight Environment with Tooling > Retrieving Data with Scripts and Queries

Most of the things go in server[<a service>] , so you get server["alarmservice"], server["topologyservice"], etc

I mostly did the reverse engineering based upon stuff from PSO (or swooped via support).
Be prepared to face a significant learning curve if you cant go that route.
Cancel
Up 0 Down

Reply

Verify Answer

Cancel