Skip to content

Commit f3cb779

Browse files
Update README.md
1 parent 566c319 commit f3cb779

1 file changed

Lines changed: 67 additions & 2 deletions

File tree

README.md

Lines changed: 67 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,67 @@
1-
# CTX-Jira-Service-Desk
2-
This module allows users to interact with Jira Service Desk by creating, deleting, updating, resolving and getting details of issues.
1+
# CTX-Jira-Service-Desk Cortex Module
2+
<Module Details>
3+
4+
The module allows users to perform the following functionality:
5+
* Encrypt Jira username and password
6+
* Create Jira Issue
7+
* Edit Jira Issue
8+
* Get details of Jira issue
9+
* Resolve Jira issue
10+
* Delete Jira issue
11+
12+
## Table of Contents
13+
1) [Dependencies](#dependencies)
14+
* [Cortex Version](#cortex-version)
15+
* [OCIs](#ocis)
16+
* [Files](#files)
17+
* [Other](#other)
18+
2) [Installation](#installation)
19+
3) [How to use](#how-to-use)
20+
4) [How you can contribute](#how-you-can-contribute)
21+
5) [Versioning](#versioning)
22+
6) [Licensing](#licensing)
23+
24+
25+
## Dependencies
26+
### Cortex Version
27+
This version of the CTX-Jira-Service-Desk module was developed in Cortex version 6.5. Some functionality may not be available on different verions of Cortex.
28+
29+
### Jira Version
30+
This version of the CTX-Jira-Service-Desk module was tested using a server with Jira Service Desk version 8.2.0 installed. Some functionality may not be available on different versions of Jira Service Desk.
31+
32+
### OCIs
33+
The module requires the following Cortex OCIs:
34+
* PowerShell
35+
* HTTP
36+
37+
### Files
38+
The CTX-Jira-Service-Desk module requires the following files:
39+
* [CTX-Jira-Service-Desk.studiopkg](https://github.com/CortexIntelligentAutomation/CTX-Jira-Service-Desk-/releases/download/1.0/CTX-Jira-Service-Desk.studiopkg)
40+
41+
## Installation
42+
Details of the installation can be found in the [CTX-Jira-Service-Desk Deployment Plan](https://github.com/CortexIntelligentAutomation/CTX-Jira-Service-Desk/blob/master/CTX-Jira-Service-Desk%20-%20Deployment%20Plan.pdf).
43+
## How to use
44+
A detailed User Guide has been provided with instructions on how to use the flows/subtasks, available [here](https://github.com/CortexIntelligentAutomation/CTX-Jira-Service-Desk/blob/master/CTX-Jira-Service-Desk-%20-%20User%20Guide.pdf). Configuration of subtask inputs and outputs are detailed in notes on the subtask workspace.
45+
46+
## How you can contribute
47+
Unfortunately, we cannot offer pull requests at this time or accept any improvements.
48+
49+
## Versioning
50+
CTX-Jira-Service-Desk-With-Details has the following versions, starting with the most recent:<Module Version History>
51+
52+
## Licensing
53+
All functionality within this module is licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
54+
55+
Copyright 2019 Cortex Limited
56+
57+
Licensed under the Apache License, Version 2.0 (the "License");
58+
you may not use this file except in compliance with the License.
59+
You may obtain a copy of the License at
60+
61+
http://www.apache.org/licenses/LICENSE-2.0
62+
63+
Unless required by applicable law or agreed to in writing, software
64+
distributed under the License is distributed on an "AS IS" BASIS,
65+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
66+
See the License for the specific language governing permissions and
67+
limitations under the License.

0 commit comments

Comments
 (0)