...

Location Structure Edition

External API

In this page is the external API to connect to third party software is enabled. Just select the parts of the API that need to be enabled. They will be activated immediately and the options saved. 

Image Added

For more details on the External API go to External API

General Settings

Organization → Settings shows the general settings of the organization.

Image Added

It includes:

• Organization name and short name. They cannot be changed. The Oganization Short Name has to be used on the SiteController for correct configuration.
• Map Widgets: This option lets the Administrator select the type of marker of the dashboard map. There are two types:
  • Map Marker → Image Added
  • BTS Antenna → Image Added
• Logo: A image can be uploaded and will be shown as a logo on the top left corner of the screen.
• Generator Test: Here a json can be pasted to create new items on the Operations menu. See next section on how to configure them.

Creating New Operations Items

To create new items on the operations menu a json with the desired item has to be pasted on the Generator Test section of the Organization Settings. This items allow the user to perform and action on all the sites (or they sites of his choosing) at the same time and from the same screen. This is as example of a json:

[{
	"name": "Switch Sites to Generator",
	"startAction": {
		"actionId": "Switch_Power",
		"commandStart": "GENERATOR",
		"commandCancel": "GRID"
	},
	"resultSensors": [
		"Switch_Power"
	],
	"readyStates": {
		"sensorId": "Switch_Power",
		"states": [
			"SITE ON GENSET - AUTO",
			"SITE ON GRID - AUTO",
			"SITE ON BATTERIES - AUTO"
		]
	}
},
{
	"name": "Switch Sites to Grid",
	"startAction": {
		"actionId": "Switch_Power",
		"commandStart": "GRID",
		"commandCancel": "GENERATOR"
	},
	"resultSensors": [
		"Switch_Power"
	],
	"readyStates": {
		"sensorId": "Switch_Power",
		"states": [
			"SITE ON GENSET - MANUAL"
		]
	}
}]

This json defines two items. Each one has the following fields:

• name: The item name that will be shown on the Operations menu

• startAction: Defines the action that can be triggered in this item:

  • actionId: The name of the action, as defined on the site template.

  • commandStart: The command that will be triggered as a start.

  • commandCancel: The command triggered if the action has to be canceled
• resultSensors: The name of the sensor that will be shown on the result list. Has to be the same name for all the sites. The result list will display sensor for each site that has it configured.
• readyStates: This will indicate which sensor and state to check before triggering the actions. This means that unless this sensor is in the specified state the action cannot be started.
  
  • sensorId: The name of the sensor that will indicate the action can be performed.
  • states: The state the sensor has to be in.