Mioplanet Documentation Center
Resources and Help
HomeProductsMioScriptJavaScriptTechNotesPHP
   Home | Admin Panel Configuration File: Alerts SEARCH    

AdminPanel

  TechNotes
Admin Panel Configuration File: Account
Admin Panel Configuration File: Alerts
Admin Panel Configuration File: Channels
Admin Panel Configuration File: Servers
Admin Panel Configuration File: Software
Admin Panel Configuration File: Tasks
Admin Panel Installation Troubleshooting
Installing Admin Panel on a server
Where to host Mioplanet Admin Panel

  Help
01. Introduction
02. The tab Products
03. The tab Alerts
04. The tab Channels

  Products
All Products
MioDB
MioFactory
Mioplanet Admin Panel

TechNote
Admin Panel Configuration File: Alerts

Product: Admin Panel


An alert channel is a set of files to send alerts to a desktop software or an AJAX like application.

Settings are set in a .mem files stored on the server in panel/config/alerts.

Possibles keys:
 
name
Name of the alert channel.

id
ID of the alert.

history
History is enabled (true) or disabled (false).

server
Valid server ID where the alerts are stored.

location
Path to the folder where the XML files are stored, relative to the path set in the server configuration file.

schedule
Syntax: schedule=scheduleEnabled, startDateEnabled, endDateEnabled, repeatEnabled
Set scheduleEnabled to true for scheduling support, falseSet startDateEnabled to true so a start date can be set to delay an alert.
Set endDateEnabled to true so an end date can be set to disable the alert.
Set repeatEnabled to true so the alerts can be repeated.

defaultTimeZone
Default timezone to be used for scheduling.
Can be local or GMT.
Default value is GMT.

defaultExpirationHours
Number of hours an alert remains active when schedule is enabled.
This default value can be changed for each alert.
24 = 1 day
168 = 1 week
NEXT_YEAR = 1 year

backColor
Set to true for alert background color support.

backColor2
Set to true for second alert background color support.
When two colors are specified, the background flash from one color to the other one.
 





Sample Code

name=My Alerts
id=MyALERT
history=no
server=MySERVER
location=http://www.mioplanet.com/myProduct/myAlert/