|
1 |
| -# CTX-PRTG |
2 |
| -This module allows users to interact with PRTG by getting historic data, getting current system status, acknowledge alarms and make custom REST API calls. |
| 1 | +<a href="https://www.cortex-ia.co.uk/" target="_blank"><img src="https://github.com/CortexIATest/CTXImages/blob/master/Cortex-350-120.png" alt="Welcome to Cortex!" width="350" height="120" border="0"></a> |
| 2 | + |
| 3 | +# CTX-PRTG |
| 4 | +Cortex Subtasks which interact with PRTG. |
| 5 | + |
| 6 | +The module allows users to perform the following functionality: |
| 7 | +* Get historic data |
| 8 | +* Get current system status |
| 9 | +* Acknowledge alarms |
| 10 | + |
| 11 | +## Table of Contents 1) |
| 12 | +1) [Dependencies](#dependencies) |
| 13 | + * [Cortex Version](#cortex-version) |
| 14 | + * [Files](#files) |
| 15 | +1) [Installation](#installation) |
| 16 | +1) [How to use](#how-to-use) |
| 17 | +1) [How you can contribute](#how-you-can-contribute) |
| 18 | +1) [Versioning](#versioning) |
| 19 | +1) [Licensing](#licensing) |
| 20 | + |
| 21 | +## Dependencies |
| 22 | +### Cortex Version |
| 23 | +This version of the CTX-PRTGmodule was developed in Cortex v6.4.0. Some functionality may not be available in other versions of Cortex. |
| 24 | + |
| 25 | +### Files |
| 26 | +The CTX-PRTG module requires the following files: |
| 27 | +* [CTX-PRTG Studio Package](https://github.com/CortexIATest/CTXExcel/releases/download/untagged-735f460df6f7d65c9d19/Cortex.Studio.Package.-.V2.2.studiopkg) |
| 28 | + |
| 29 | +## Installation |
| 30 | +Details of how the module should be imported into Cortex can be found in the [Deployment Plan](#Installation). |
| 31 | + |
| 32 | +## How to use |
| 33 | +A detailed User Guide has been provided with instructions on how to use the flows/subtasks, available [here](https://github.com/CortexIATest/CTXExcel/blob/master/CTXExcel%20-%20LLD%20-%20v2.2.docx). Configuring of the subtask's inputs and outputs are detailed in notes on the subtask workspace. |
| 34 | + |
| 35 | +## How you can contribute |
| 36 | +Unfortunately, we cannot offer pull requests at this time or accept any improvements. |
| 37 | + |
| 38 | +## Versioning |
| 39 | +The CTX-PRTG module has the following versions, starting with the most recent: |
| 40 | + |
| 41 | +Version | Release | Functionality | Notes |
| 42 | +------------ | ------------- | ----------- | ----------- |
| 43 | +v1.0 | 26/04/2019 | Get Historic Data | Created |
| 44 | +v1.0 | 26/04/2019 | Get System Status | Created |
| 45 | +v1.0 | 26/04/2019 | Acknowledge Alarm | Created |
| 46 | + |
| 47 | +## Licensing |
| 48 | +All functionality within this module is licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0). |
| 49 | + |
| 50 | +Copyright 2019 Cortex Limited |
| 51 | + |
| 52 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 53 | +you may not use this file except in compliance with the License. |
| 54 | +You may obtain a copy of the License at |
| 55 | + |
| 56 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 57 | + |
| 58 | +Unless required by applicable law or agreed to in writing, software |
| 59 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 60 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 61 | +See the License for the specific language governing permissions and |
| 62 | +limitations under the License. |
0 commit comments