Skip to content

Commit

Permalink
Added missing readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
Shellyber committed Jul 18, 2023
1 parent 0e4c560 commit 722a6c6
Show file tree
Hide file tree
Showing 7 changed files with 234 additions and 6 deletions.
12 changes: 6 additions & 6 deletions Packs/Cherwell/.pack-ignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ ignore=IN126
ignore=RM106

[file:CherwellGetIncident.yml]
ignore=BA124,CJ105,RM109
ignore=BA124,CJ105

[file:CherwellIncidentUnlinkTask.yml]
ignore=BA124,CJ105,RM109
ignore=BA124,CJ105

[file:CherwellCreateIncident.yml]
ignore=BA124,CJ105,RM109
ignore=BA124,CJ105

[file:CherwellQueryIncidents.yml]
ignore=BA124,CJ105,RM109
ignore=BA124,CJ105

[file:CherwellUpdateIncident.yml]
ignore=BA124,CJ105,RM109
ignore=BA124,CJ105

[file:CherwellIncidentOwnTask.yml]
ignore=BA124,CJ105,RM109
ignore=BA124,CJ105

39 changes: 39 additions & 0 deletions Packs/Cherwell/Scripts/CherwellCreateIncident/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
This script is an example script of how to create an incident in Cherwell. The script wraps the create business object command in the cherwell integration. When writing your own script to create a business object, follow the instructions in the configuration part, but do not change the execution section.

## Script Data

---

| **Name** | **Description** |
| --- | --- |
| Script Type | python3 |
| Tags | Cherwell |
| Cortex XSOAR Version | 5.0.0 |

## Dependencies

---
This script uses the following commands and scripts.

* cherwell-create-business-object

## Inputs

---

| **Argument Name** | **Description** |
| --- | --- |
| description | Incident description. |
| priority | Incident priority. |
| owned_by | Incident owner. |
| service | Service needed. |
| customer_display_name | Requesting customer name. |

## Outputs

---

| **Path** | **Description** | **Type** |
| --- | --- | --- |
| Cherwell.BusinessObjects.PublicId | Incident public ID | String |
| Cherwell.BusinessObjects.RecordId | Incident record ID | String |
43 changes: 43 additions & 0 deletions Packs/Cherwell/Scripts/CherwellGetIncident/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
This script is an example script of how to retrieve an incident from Cherwell. The script wraps the cherwell-get-business-object command of the cherwell integration. When writing your own script to get a business object, follow the instructions found in the configuration section of the script, but do not change the execution section.

## Script Data

---

| **Name** | **Description** |
| --- | --- |
| Script Type | python3 |
| Tags | Cherwell |
| Cortex XSOAR Version | 5.0.0 |

## Dependencies

---
This script uses the following commands and scripts.

* cherwell-get-business-object

## Inputs

---

| **Argument Name** | **Description** |
| --- | --- |
| id_type | Type of ID. |
| id_value | Public ID or record ID. |

## Outputs

---

| **Path** | **Description** | **Type** |
| --- | --- | --- |
| Cherwell.BusinessObjects.RecordId | Recoed ID | String |
| Cherwell.BusinessObjects.PublicId | Public ID | String |
| Cherwell.BusinessObjects.Description | Incident description | String |
| Cherwell.BusinessObjects.Priority | Incident ptiority | Number |
| Cherwell.BusinessObjects.OwnedBy | Incident owned by field | String |
| Cherwell.BusinessObjects.Service | Service needed for the incident | String |
| Cherwell.BusinessObjects.CustomerDisplayName | Incident reporting customer | String |
| Cherwell.BusinessObjects.CreatedDateTime | Created date time | Date |
| Cherwell.BusinessObjects.TotalTasks | Total tasks for this incident | Number |
32 changes: 32 additions & 0 deletions Packs/Cherwell/Scripts/CherwellIncidentOwnTask/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
This script is an example script of how to link an incident to a task in Cherwell. The script wraps the cherwell-link-business-object command of the cherwell integration. When writing your own script to link business objects, follow the instructions found in the configuration section of the script, but do not change the execution section.

## Script Data

---

| **Name** | **Description** |
| --- | --- |
| Script Type | python3 |
| Tags | Cherwell |
| Cortex XSOAR Version | 5.0.0 |

## Dependencies

---
This script uses the following commands and scripts.

* cherwell-link-business-objects

## Inputs

---

| **Argument Name** | **Description** |
| --- | --- |
| incident_record_id | Incident record ID. |
| task_record_id | Task record ID. |

## Outputs

---
There are no outputs for this script.
32 changes: 32 additions & 0 deletions Packs/Cherwell/Scripts/CherwellIncidentUnlinkTask/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
This script is an example script of how to unlink a task from an incident in Cherwell. The script wraps the cherwell-unlink-business-object command of the cherwell integration. When writing your own script to unlink business objects, follow the instructions found in the configuration section of the script, but do not change the execution section.

## Script Data

---

| **Name** | **Description** |
| --- | --- |
| Script Type | python3 |
| Tags | Cherwell |
| Cortex XSOAR Version | 5.0.0 |

## Dependencies

---
This script uses the following commands and scripts.

* cherwell-unlink-business-objects

## Inputs

---

| **Argument Name** | **Description** |
| --- | --- |
| incident_record_id | Incident record ID. |
| task_record_id | Task record ID. |

## Outputs

---
There are no outputs for this script.
42 changes: 42 additions & 0 deletions Packs/Cherwell/Scripts/CherwellQueryIncidents/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
This script is an example script of how to query incidents from Cherwell. The script wraps the cherwell-query-business-object command of the cherwell integration. When writing your own script to query business objects, follow the instructions found in the configuration section of the script, but do not change the execution section.

## Script Data

---

| **Name** | **Description** |
| --- | --- |
| Script Type | python3 |
| Tags | Cherwell |
| Cortex XSOAR Version | 5.0.0 |

## Dependencies

---
This script uses the following commands and scripts.

* cherwell-query-business-object

## Inputs

---

| **Argument Name** | **Description** |
| --- | --- |
| query | The query to run. The query is a list of comma-seperated filters such that each filter should be of the form: \["field_name","operator","value"\] and operator is one of: 'eq'=equal, 'gt'=greater-than, 'lt'=less-than, 'contains', 'startwith'. Special characters shoud be escaped.<br/>Example: \`\[\["CreatedDateTime":"gt":"4/10/2019 3:10:12 PM"\]\["Priority","eq","1"\]\]\`. <br/>NOTICE: If multiple filters are received for the same field name, an 'OR' operation between the filters is performed. If the field names are different, an 'AND' operation is performed. |

## Outputs

---

| **Path** | **Description** | **Type** |
| --- | --- | --- |
| Cherwell.QueryResults.RecordId | Recoed ID | String |
| Cherwell.QueryResults.PublicId | Public ID | String |
| Cherwell.QueryResults.Description | Incident description | String |
| Cherwell.QueryResults.Priority | Incident ptiority | Number |
| Cherwell.QueryResults.OwnedBy | Incident owned by field | String |
| Cherwell.QueryResults.Service | Service needed for the incident | String |
| Cherwell.QueryResults.CustomerDisplayName | Incident reporting customer | String |
| Cherwell.BusinessObject.CreatedDateTime | Created date time | String |
| Cherwell.BusinessObject.TotalTasks | Total tasks for this incident | Number |
40 changes: 40 additions & 0 deletions Packs/Cherwell/Scripts/CherwellUpdateIncident/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
This script is an example script of how to update an incident in Cherwell. The script wraps the update-business-object command of the cherwell integration. When writing your own script to update a business object, follow the instructions found in the configuration section of the script, but do not change the execution section.

## Script Data

---

| **Name** | **Description** |
| --- | --- |
| Script Type | python3 |
| Tags | Cherwell |
| Cortex XSOAR Version | 5.0.0 |

## Dependencies

---
This script uses the following commands and scripts.

* cherwell-update-business-object

## Inputs

---

| **Argument Name** | **Description** |
| --- | --- |
| description | Incident description. |
| priority | Incident priority. |
| owned_by | Incident owner. |
| service | Service needed. |
| id_value | Public ID or record ID. |
| id_type | Type of ID. |

## Outputs

---

| **Path** | **Description** | **Type** |
| --- | --- | --- |
| Cherwell.BusinessObjects.PublicId | Incident public ID | String |
| Cherwell.BusinessObjects.RecordId | Incident record ID | String |

0 comments on commit 722a6c6

Please sign in to comment.