How to review/change the Setup Authentication

From the left Menu bar select Setup and then choose Authentication from the options.

A screen will appear which will allow you to update the Setup Authentication (i.e. where the information for your usernames and passwords come from). Users can either be entered manually using the Setup or a directory can be used.

Fill out the required fields and select Save Settings. If you would like to confirm that the details entered are valid, select Test Authentication

Time Zone

In the Setup under Options you can edit the GMT_TIME_OFFSET option and set it to your time zone. The value entered is either 0 for GMT or a + or - number indicating the number of hours ahead or behind GMT. For instance +10 is ten hours ahead of GMT for Australian Eastern time

In addition the TIMEZONE_CITY option may be set. If set daylight savings times will be taken into consideration.

Shared Secret

In order to ensure data injected by agents is genuine a shared secret is passed by the agent. Set this to a combination of letters and numbers but do not use spaces or symbols:

Business Hours

Business hours should be set as follows and stored in JSON format.

Finance

Currency and start of year financial options are configured using the following two options:

The START_OF_FINANCIAL_YEAR option is of the format day-month, i.e. 01-01 is the 1st of January. 01-07 means the start of the financial year is the 1st of July. Do not include the year.

The SALARY_CPI_MULTIPLIER option is used when calculating salaries in future years. Salaries for next year are calculated to this year"s cost multiplied by this value, so 1.04 is a 4% annual increase.

Self-Serve Registration

To enable self-serve registration the option ALLOW_SELF_REGISTER needs to be set to yes.

Portal Appearance

To change the portal colours enter the desired colours in the fields and click save. When the primary colour is changed ServiceView will automaticall calulate lighter and darker colours. These can be overwritten if desired by entering new values.

Setting Arbitrary Text on the Portal Header

If you are running more than one instance of ServiceView you may wish to distinguish between them by adding text on the header of the portal, such as Development ServiceView

To achieve this use an environment variable in the apache virtual hosts file.

SetEnv HEADER_MSG "Development ServiceView"

Email Text

ServiceView uses options to store standard meial text. Set these to the desired values.

DR Plan Email

Set the option 'CRON_DR_PLAN_MESSAGE' to the desired value.

Sample value:

<p style="margin-top:10px;margin-bottom:10px;">Dear Stakeholder,</p>
<p style="margin-bottom:10px;">Please find attached the latest copy of the SV IT service restoration plan. Please review the plan for accuracy and either make the necessary changes directly in ServiceView at <a href="http://serviceview.its.sv.edu.au">serviceview.its.sv.edu.au</a> or send an email to <a href="mailto:serviceview@sv.edu.au">serviceview@sv.edu.au</a> with notification of errors.</p>
<p style="margin-bottom:10px;">In order to be properly prepared in the event of a disaster we suggest you download the attached service restoration plan to your laptop or ipad.</p>
<p style="margin-bottom:10px;">Best regards,</p>
<p>ServiceView team<br>
http://serviceview.its.sv.edu.au<br>
serviceview@sv.edu.au</p>

Service Status Email

The following options are used to compose the service status emails:

Agents

Data is populated into the ServiceView database using agents. An agent is a script, usually running daily on the service infrastructure, collecting the data and then posting it to ServiceView. Agents can be written in any language as long as they are able to perform HTTP GET requests.

Agents an be used to inject metric data,calendar envents and equipement

Collecting Metric Data

The HTTP address used to send metric data for a given service is made up of:

http://<serviceview_url>/record.php?service=&metric=<metricname>&date=<date>&secret=<secret>&value=<value>&accumulate=0

Parameters are as follows:

The HTTP request can either be sent using a HTTP GET or POST request.

The URL to use for each metric can be obtained on the services page under the reports tab. On the right side of each metric three icons, the first is the URL to inject data.

If the metric or service hasn't been added do that first. See sections on adding services and metrics.

Perl Example

#!/usr/bin/perl 

use LWP::Simple;
use CGI;

$url = 'http://serviceview.its.uq.edu.au/record.php
	     ?service=' . CGI::escape($service) . 
                        '&metric=' . CGI::escape($metric) .
                        '&date=' .     CGI::escape($date) .
                        '&secret= .
                        '&value=' . $value;
$result = get($url);
if ($result !~ /SUCCESS/) {
        print "Cannot post to ServiceView: ".$result;
} 

Importing Calendar Events

Calendar events can be injected into the ServiceView database using an HTTP POST comprising:

http://<serviceview_url>/event.php?service=<servicecode>&start=<start>&end=<end>&title=<title>&description=<description>&service_availability =<service_availability>&event_group_name =<event_group_name>&secret=<secret>

Parameters are as follows:

The HTTP request can either be sent using a HTTP GET or POST request. Given the description section may be long, a HTTP POST is recommended

PHP Example

$fields = "secret=<secret>&service=<servicecode>&start=<start>&end=<end>&title=<title>
                &description=<description>&service_availability=3&event_group_name=For+Information";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,"http://<serviceview_url>/event.php");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $fields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec ($ch);
curl_close ($ch);

PHP Example SSL Port 443

$fields = "secret=<secret>&service=<servicecode>&start=<start>&end=<end>&title=<title>
                &description=<description>&service_availability=3&event_group_name=For+Information";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,"https://<serviceview_url>/event.php");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_PORT , 443); 
curl_setopt($ch, CURLOPT_POSTFIELDS, $fields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
$response = curl_exec ($ch);
curl_close ($ch);

Equipment Discovery

Equipment discovery can be achievedby placing agents on the servers or desktops. Agents send HTTP(S) signals to the equipment.php API

http://<serviceview_url>/equipment.php?name=<name>&manufacturer=<manufacturer>&model=<model>&virtual=<virtual>&use=<use>&operating_system=<operating_system>&series_number=<serial_number>&asset_tag=<asset_tag>&service_code=<service_code>&data_center=<data_center>&rack=<rack>&rack_position=<rack_position>&secret=<secret>

Parameters are as follows:

* Optional parameter

The HTTP request can either be sent using a HTTP GET or POST request.

PHP Example

$fields ="name=<name>&manufacturer=<manufacturer>&model=<model>&virtual=<virtual>&use=<use>&operating_system=<operating_system>&series_number=<serial_number>&asset_tag=<asset_tag>&service_code=<service_code>&data_center=<data_center>&rack=<rack>&rack_position=<rack_position>&secret=<secret>";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,"http://<serviceview_url>/equipment.php");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $fields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec ($ch);
curl_close ($ch);

PHP Example SSL Port 443

$ fields ="name=<name>&manufacturer=<manufacturer>&model=<model>&virtual=<virtual>&use=<use>
&operating_system=<operating_system>&series_number=<serial_number>&asset_tag=<asset_tag>&service_code=<service_code>&data_center=<data_center>&rack=<rack>&rack_position=<rack_position>&secret=<secret>";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,"https://<serviceview_url>/equipment.php");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_PORT , 443); 
curl_setopt($ch, CURLOPT_POSTFIELDS, $fields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
$response = curl_exec ($ch);
curl_close ($ch);

Importing & Exporting Services & Equipment

In order to synchronise services and equipment between different systems it may be useful to use this set of APIs.

Servies in ServiceView fall into many categories, some of which would include equipment and some wouldn't.

Get Services

API to retrieve a list of all services or a subset dependent of search criteria passed to it.

http://<serviceview_url>/get_services.php?service_code=<service_code>&property_code =<property_code>&full=1&equipment=1&secret=<secret>

Parameters are as follows:

* Optional parameter

Return Data

A JSON encoded array is returned:

If <full> is not specified the following fields are returned

If <full> is specified the following fields are returned

PHP Example

$fields = "secret=<secret>&service=<servicecode>&start=<start>&end=<end>&title=<title>
                &description=<description>&servicevavailability=3&event_group_name=For+Information";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,"http://<serviceview_url>/event.php");
curl_setopt($ch, CURLOPT_POST, 1);
curlvsetopt($ch, CURLOPT_POSTFIELDS, $fields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec ($ch);
curl_close ($ch);

Service Status Website Integration

Calendar events also known as service status events can be exported from the ServiceView system to use on a service status website.

The following APIs are available:

Get current, future and past event descriptions

The main feed for the service status website, returns upcoming service events as well as current and recent ones.

http://<serviceview_url>/index.php?AP=service_ap&ACT=ajax_get_events

Parameters are as follows:

* Optional Paramter

The HTTP request can either be sent using a HTTP GET or POST request.

Return Data

Data is returned JSON encoded in a format suitable for the Datatabales jQuery plugin but can be used for other purposes:

Get Service Availability Status

API to display the current status of each service for use with service status LEDs

http://<serviceview_url>/index.php?AP=service_ap&ACT= ajax_list_public_service_status

Parameters are as follows:

Return Data

Get Event Details and Updates

http://<serviceview_url>/index.php?AP=service_ap&ACT=ajax_get_event

Parameters are as follows:

The HTTP request can either be sent using HTTP GET or POST request.

Return Data

Subscribe to Service Event

http://<serviceview_url>/index.php?AP=event_ap&ACT= subscribe_to_event

Parameters are as follows:

The HTTP request can either be sent using a HTTP GET or POST request.

Return JSON encode:

Is Subscribed to Service Event

http://<serviceview_url>/index.php?AP=event_ap&ACT=is_subscribe_to_event

Parameters are as follows:

The HTTP request can either be sent using HTTP GET or POST request

Return JSON encode:

http://<serviceview_url>/index.php?AP=service_ap&ACT= ajax_get_service_availability_period

The HTTP request can either be sent using a HTTP GET or POST request

Return Data

Data is returned JSON encoded in the following format:

Active Directory / LDAP Lookup

ServiceView can be configured to look up unknown people in Active Directory or LDAP.

Administrators need to configure the following options:

Spreadsheet Export & Import

Administrators can make the job of populating the ServiceView system much simpler using an Excel export and import process.

Under the Setup menu click on Download Spreadsheet to take a copy of the ServieView setup and download in a multi tabbed spreadsheet.

The spreadsheet contains the following tabs:

Note: Greyed out columns contain internal references and should not be changed.

Services Tab

The service tab contains information about service, service group and service dependencies.

People Tab

The people tab contains informastion about teams and people.

Positions Tab

The position tab contains a list of positions and their annual cost.

Roles Tab

The roles tab contains a list of roles. A role is what work a person performs for a service. For instance database administration.

Metrics Tab

The metrics tab contains a list of metrics for all services.

Reports Tab

The reports tab contains a list of reports for all services.