Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xmatters/xm-labs-sitescope


https://github.com/xmatters/xm-labs-sitescope

sitescope xmatters

Last synced: 10 days ago
JSON representation

Awesome Lists containing this project

README 

        
# HP SiteScope (One-way) Integration

The information provided details the instructions to configure a one-way integration to trigger a web service call to xMatters.



# Pre-Requisites

* HP SiteScope 11.32.301



# Files

* [SiteScope.zip](SiteScope.zip) - The xMatters Workflow

* [xMatters](xMatters) - The JSON mapping file for SiteScope



# How it works

SiteScope uses Action Alerts that are capable of performing HTTP Rest Web Service calls to xMatters to generate an xMatters alert. The Action Alerts are configured to run based on trigger conditions in SiteScope.



# Installation



## xMatters



### Import the Workflow

* Import the SiteScope Workflow [SiteScope.zip](SiteScope.zip)

* Instructions to import a Workflow can be found here: [Import a Workflow](http://help.xmatters.com/OnDemand/xmodwelcome/communicationplanbuilder/exportcommplan.htm)



### Create a REST user account

* **First Name:** SiteScope

* **Last Name:** Rest Web Service

* **User ID:** sitescope

* **Roles:** REST Web Service User



### Assign permissions to the Workflow, Form, and Endpoint  

1. **Workflow**

    * From within the workflow page, select the Edit drop-down menu for the SiteScope Workflow

    * From the Edit drop-down menu, select Access Permissions

    * From within Access Permissions, add the xMatters REST User created



2. **Form**

    * From within the W tab, select the Edit drop-down menu for the SiteScope Workflow

    * From the Edit drop-down menu, select Forms

    * From within Forms, select the Web Service drop-down menu for the SiteScope form

    * From within Web Service drop-down menu, select Sender Permissions

    * From within Sender Permissions, add the xMatters REST User created



3. **Endpoint**

    * From within the workflow page, select the Edit drop-down menu for the SiteScope Workflow

    * From the Edit drop-down menu, select Integration Builder

    * From within the Integration Builder tab, select Edit Endpoints

    * From within Edit Endpoints, add the xMatters REST User created



## HP SiteScope



### Deploy the xMatters REST Mapping File



1. Navigate to the server that contains the SiteScope root directory

2. Navigate to the following directory: `\templates.rest`

3. From within the `\templates.rest` directory, add the [xMatters](xMatters) file.



### Configure a SiteScope Alert



This task describes the steps involved in configuring an alert definition.



#### Prerequisites



Only a SiteScope administrator user, or a user granted the appropriate alerts permissions can view, create, or edit alerts. For details on user permissions, see Permissions.



#### Create an alert



You can create a new alert or copy an existing alert into any group or monitor container in the SiteScope tree.



To create a new alert:

1. Right-click the container to which you want to associate the alert, and select New > Alert.

2. Enter a name for the alert.

3. Configure an alert action (in the Alert Actions panel, click New Alert Action to start the Alert Action wizard).

4. For Action Type select Rest.





  




5. Once Rest is selected, on the next window ensure that xMatters is selected for template.





  




#### User interface elements are described below:



**Action name:** xMatters Alert



**Rest to URL form:** To populate this field, follow the next steps:

1. Navigate to xMatters

2. Navigate to the workflow page

3. From within the workflow page, select the Edit drop-down menu for the SiteScope Workflow

4. From the Edit drop-down menu, select Integration Builder

5. From within the Integration Builder tab, find the Inbound Integrations and select the **Inbound - SiteScope**

6. From within the Inbound Integrations page, ensure that Base Authentication is selected.

7. Lastly copy the URL at the bottom of the page and paste it into the REST to URL form field.



**Template:** xMatters



Note: You can view the contents of the existing templates or add additional templates in the `\templates.rest` directory. For more details on alert templates, see [Customize Alert Templates](http://sitescope-help.saas.hpe.com/en/11.40/Online/Content/Use/cust_alert_templates.htm).



**HTTP Method:** POST



**Format Type:**  JSON



**Additional Parameters:**  Not needed for the xMatters integration. However, below is an explanation of this field.



Enter any parameter that REST API supports. You must enter all the additional parameters used in the template. The format for providing the parameters is  =  with multiple parameters separated by commas. The  specified here must match the parameter name specified in the template.



Note: If there are additional parameters specified in the template and if you do NOT specify in this field, then it results in an error. You can see the error messages in the alert.log file in the SiteScope Logs directory located at /Sitescope/logs .



#### Relevant tasks

[Configure SiteScope Alerts](http://sitescope-help.saas.hpe.com/en/11.40/Online/Content/Use/alert_workflow.htm)



#### See also

[Alert Action Dialog Box](http://sitescope-help.saas.hpe.com/en/11.40/Online/Content/Use/Action_Type_Settings_Panel.htm)



### Editing the Filter

This task describes how to customize SiteScope alert templates to alter the content and format of alert messages.

1. Open a text editor that has access to the alert template directories on the SiteScope machine.



For a list of the directory names containing SiteScope alert templates, see [Alert Template Directories](http://sitescope-help.saas.hpe.com/en/11.40/Online/Content/Use/cust_alert_templates.htm#Alert_Template_Directories).



2. Open an existing template file of the alert type you want to customize within a text editor.



3. Make changes to the template. Depending on the alert type, you can add or remove text, change the order of text or property variables, or add other property variables. To add specific properties, add the applicable property variable name between < > bracket pairs to the template.



For a list of specific property variables, see [Properties Available in Alerts, Templates, and Events](http://sitescope-help.saas.hpe.com/en/11.40/Online/Content/Use/alert_properties_directory.htm).



4. Save the changes to a unique filename within the directory for the applicable alert type. The new template is added to the Action Type Settings Template drop-down list.



# Testing

For testing execute the action to occur and navigate to xMatters OnDemand and view the Integration Builder activity stream.



# Troubleshooting

For any troubleshooting regarding submissions to xMatters it will be best to view the activity stream