DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
EXT: Name of your Extension¶
| Author: | Christopher |
|---|---|
| Created: | 2010-12-18T19:57:23 |
| Changed by: | Christian Nölle |
| Changed: | 2012-03-12T14:25:48.490000000 |
| Classification: | extension key |
| Description: | The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) see more: http://wiki.typo3.org/doc_template#tags ---- |
| Keywords: | keywords comma-separated |
| Author: | Christopher |
| Email: | Chrissitopher@gmx.de |
| Language: | en |
EXT: Signaling system for caretaker¶
Extension Key: buw_caretakersignal
Language: en
Version: 0.1.4
Keywords: signal system, monitoring, caretaker
Copyright 2012, Christian Nölle, <noelle@uni-wuppertal.de>
This document is published under the Open Content License
available from http://www.opencontent.org/opl.shtml
The content of this document is related to TYPO3
- a GNU/GPL CMS/Framework available from www.typo3.org
Table of Contents¶
`EXT: Signaling system for caretaker 1 <#1.EXT:%20Signaling%20system%20for%20caretaker%20|outline>`_
`Introduction 3 <#1.1.Introduction|outline>`_
`Users manual 4 <#1.2.Users%20manual|outline>`_
`Administration 5 <#1.3.Administration|outline>`_
`Configuration 6 <#1.4.Configuration|outline>`_
`Known problems 8 <#1.5.Known%20problems|outline>`_
`To-Do list 9 <#1.6.To-Do%20list|outline>`_
Introduction¶
What does it do?¶
Provides a boiled down status of your caretaker monitored servers for your website.
In a normal monitoring setup you will have your caretaker server within a controlled network, which is not accessible from outside. Thus the nice graphs caretaker is painting are only visible to yourself ;). With this extension you can easily add a “status page” to your public website, providing your customers the state of certain machines / tests.
Uses the caretaker eID mechanism to retrieve the data. So make sure that caretaker is configured to provide information via eID and you webserver can access the eID interface of your caretaker server.
Screenshots¶
Users manual
------------
Insert the extension as page content element “Plugin” on a page of your choice.
After that, you will have to fill out the fields “Instance” and “Test” properly, otherwise you will get an error, as the extension is not able to retrieve the results from your caretaker server.
Available fields¶
Name
Name of the content element that will be displayed as header (e.g. server identifier).
Instance
Number of the instance as defined in your caretaker server.
Test
Number of the specific test you would like to show. Must be assigned to the instance!
Text
Some free text field. You can enter any information you like. For example, if you have a scheduled downtime, here is the place to announce this to your users.
Please note, that the fields “Instance” and “Test” are numerical and must be retrieved from the caretaker server. If they are not properly defined or wrong, you will not be able to display proper results.
Administration¶
In case that your editors should be able to work with this extension as well, please make sure, that the exclude fields of the extension in the user groups access list are enabled.
Configuration
-------------
Installation¶
Import and install via the extension manager. Nothing special, no database queries or configuration needed.
Preperation for usage¶
Before you and your editors can use this extension, make sure that the static template record for buw_caretakersignal is added to your TypoScript page template (or extension template).
Please define the URL of the caretaker server afterwards in the setup section of your template.
Reference¶
plugin.tx_buwcaretakersignal_pi1
server¶
Property
server
Data type
string
Description
Address of your caretaker server.
Default
[tsref:plugin.tx_buwcaretakersignal_pi1]
plugin.tx_buwcaretakersignal_pi1.state
due¶
Property
due
Data type
wrap
Description
Wraps the due item.
Default
<span class="due">|</span>
ack¶
Property
ack
Data type
wrap
Description
Wraps the ack item.
Default
<span class="ack">|</span>
undef¶
Property
undef
Data type
wrap
Description
Wraps the undef item.
Default
<span class="undef">|</span>
ok¶
Property
ok
Data type
wrap
Description
Wraps the ok item
Default
<span class="ok">|</span>
warn¶
Property
warn
Data type
wrap
Description
Wraps the warn item
Default
<span class="warn">|</span>
err¶
Property
err
Data type
wrap
Description
Wraps the err item
Default
<span class="err">|</span>
[tsref:plugin.tx_buwcaretakersignal_pi1.state]
plugin.tx_buwcaretakersignal_pi1.timestamp
allWrap¶
Property
allWrap
Data type
wrap
Description
Wraps the timestamp objekt
Default
<span class="timestamp">|</span>
strftime¶
Property
strftime
Data type
wrap
Description
Defines the output format of the timestamp
Default
%d.%m.%Y %T
[tsref:plugin.tx_buwcaretakersignal_pi1.timestamp]
Known problems¶
None so far.
To-Do list¶
Thinking about it. Let me know, what you would like to see...