Set channel dashboard status
Verified
Added by iNTERFACEWARE
Use iguana.setChannelStatus{} to set the channel dashboard channel status "light" and message
Source Code
-- set the status "light" colour and messsage text iguana.setChannelStatus{ color='yellow', text='Connection lost: retrying...' }
Description
Use iguana.setChannelStatus{} to set the channel dashboard channel status "light" and message
Usage Details
Use iguana.setChannelStatus{}
to set the dashboard status “light” and the status message that is shown when you hover mouse over the light. Typical use is to set the “light” colour to yellow to indicate that the channel is waiting and then back to green when the task has completed. For example, retrying a lost connection, waiting for a scheduled task to run, processing some large task etc.
Note: The channel must be running for this code to work, it has no effect in the editor (test mode).
How to use the snippet:
- Paste the code into your script
More Information
Added by iNTERFACEWARE
Use conn:merge{} to merge data into a database
Added by iNTERFACEWARE
Use iguana.isTest() to prevent code from running in the editor
Added by iNTERFACEWARE
Use iguana.isTest() to allow code to run in the editor but not in the live channel
Added by iNTERFACEWARE
Get the name or guid for the current channel by using iguana.channelName() or iguana.channelGuid()
Added by iNTERFACEWARE
Use iguana.channelConfig{} to get configuration information for a channel, you can use either guid or channel name to specify the channel
Added by iNTERFACEWARE
Get the Iguana log (unique) message ID for the message currently being processed
Added by iNTERFACEWARE
Set the timeout for the current script, must be set inside a function, usually main().
Added by iNTERFACEWARE
Use iguana.status() to return an XML summary of the local Iguana's runtime state
Added by iNTERFACEWARE
Use iguana.stopOnError(false) to prevent a channel from stopping when an error occurs
Added by iNTERFACEWARE
Use iguana.version() to get the Iguana version number, can be useful for testing for a required/supported version
Added by iNTERFACEWARE
Use iguana.webInfo() to get web server and HTTP channel server configuration
Added by iNTERFACEWARE
Use iguana.workingDir() to get the current Iguana working directory, where config files etc. are stored
Added by iNTERFACEWARE
How to open a file and write (replace file content), or append data (keep file content)
Added by iNTERFACEWARE
Use os.fs.access() to check if a file exists, and to verify the permissions
Added by iNTERFACEWARE
Use os.fs.chmod() to set file permissions, using octal mode (symbolic mode does not work)
Added by iNTERFACEWARE
Use os.remove() to delete a file or directory, only an empty directory can be deleted
Added by iNTERFACEWARE
Use os.fs.rmdir() to delete an empty directory, if the directory is not empty an error is returned
Added by iNTERFACEWARE
Use os.fs.rename() to rename a file or directory, if the file or directory does not exist an error is returned
Added by iNTERFACEWARE
Use os.fs.stat() to get statistics for a file or directory