Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Freshwork freshservice integration #25907

Merged

Conversation

content-bot
Copy link
Collaborator

Original External PR

external pull request

Contributor

@TalGumi

Contributing to Cortex XSOAR Content

Make sure to register your contribution by filling the contribution registration form

The Pull Request will be reviewed only after the contribution registration form is filled.

Status

  • In Progress
  • Ready
  • In Hold - (Reason for hold)

Related Issues

fixes: link to the issue

Description

A few sentences describing the overall goals of the pull request's commits.

Screenshots

Paste here any images that will help the reviewer

Minimum version of Cortex XSOAR

  • 6.0.0
  • 6.1.0
  • 6.2.0
  • 6.5.0

Does it break backward compatibility?

  • Yes
    • Further details:
  • No

Must have

  • Tests
  • Documentation

* Update Docker Image To demisto/py3-tools  (#25523)

* Updated Metadata Of Pack FeedAWS

* Added release notes to pack FeedAWS

* Packs/FeedAWS/Integrations/FeedAWS/FeedAWS.yml Docker image update

* Update Freshservice integration

* Update Freshservice integration

* update integration files

* updates

* updates

* Fixing mirroring

* update integration files

* update files acording to validate command

* Update prefix for incident fields

* Update common types

* update last run implemantaion

* update mapper & classifier names

* Update pack metadat name

* Update classifier & mapper & fields prefix name

* updated CommonType release notes

* Update docket image & release notes

* Add to pack_ignore, for some incident fields, error code to ignore.

* add integration README

* put the checkboxes(type 8) at the bottom

* Update Packs/FreshworksFreshservice/Integrations/FreshworksFreshservice/FreshworksFreshservice.yml

Co-authored-by: ShirleyDenkberg <62508050+ShirleyDenkberg@users.noreply.github.com>

* Update Packs/FreshworksFreshservice/Integrations/FreshworksFreshservice/FreshworksFreshservice.yml

Co-authored-by: ShirleyDenkberg <62508050+ShirleyDenkberg@users.noreply.github.com>

* Update Packs/FreshworksFreshservice/Integrations/FreshworksFreshservice/FreshworksFreshservice.yml

Co-authored-by: ShirleyDenkberg <62508050+ShirleyDenkberg@users.noreply.github.com>

* Change description

* Change yml & md

---------

Co-authored-by: Benimanela <benim@qmasters.co>
Co-authored-by: ShirleyDenkberg <62508050+ShirleyDenkberg@users.noreply.github.com>
@content-bot content-bot added Contribution Thank you! Contributions are always welcome! Contribution Form Filled Whether contribution form filled or not. Community labels Apr 17, 2023
@content-bot
Copy link
Collaborator Author

This PR was automatically updated by a GitHub Action

  • CommonTypes pack version was bumped to 3.3.64.

To stop automatic version bumps, add the ignore-auto-bump-version label to the github PR.

…reshservice-integration' into contrib/qmasters-ltd_freshwork-freshservice-integration
description: Release work end date.
type: Date
- contextPath: Freshservice.Release.created_at
description: release creation time.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: release creation time.
description: Datetime the release was created.

description: release creation time.
type: Date
- contextPath: Freshservice.Release.updated_at
description: Release updated at.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Release updated at.
description: Datetime the release was updated.

description: Task description.
type: String
- contextPath: Freshservice.Release.Task.created_at
description: Task creation time.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Task creation time.
description: Datetime the task was created.

description: Task creation time.
type: Date
- contextPath: Freshservice.Release.Task.updated_at
description: Task updated at.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Task updated at.
description: Datetime the task was updated.

description: Task updated at.
type: Date
- contextPath: Freshservice.Release.Task.closed_at
description: Task closed at.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Task closed at.
description: Datetime the task was closed.

description: Task description.
type: String
- contextPath: Freshservice.Release.Task.created_at
description: Task creation time.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Task creation time.
description: Datetime the task was created.

description: Task creation time.
type: Date
- contextPath: Freshservice.Release.Task.updated_at
description: Task updated at.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Task updated at.
description: Datetime the task was updated.

description: Task updated at.
type: Date
- contextPath: Freshservice.Release.Task.closed_at
description: Task closed at.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Task closed at.
description: Datetime the task was closed.

description: Task description.
type: String
- contextPath: Freshservice.Release.Task.created_at
description: Task creation time.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Task creation time.
description: Datetime the task was created.

description: Task creation time.
type: Date
- contextPath: Freshservice.Release.Task.updated_at
description: Task updated at.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Task updated at.
description: Datetime the task was updated.

description: Requester fields creation time.
type: Date
- contextPath: Freshservice.RequesterField.updated_at
description: Requester fields updated at.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Requester fields updated at.
description: Datetime the requester fields were updated.

isArray: false
name: change_initiating_ticket
required: false
- description: Change needed for the Ticket to be fixed that needs to be associated with the Ticket (use freshservice-change-list to get the change ID).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- description: Change needed for the Ticket to be fixed that needs to be associated with the Ticket (use freshservice-change-list to get the change ID).
- description: The change ID that is needed for the ticket to be fixed. (So the change ID needs to be associated with the ticket). (Use freshservice-change-list to get the change ID).

isArray: false
name: problem
required: false
- description: Change causing the Ticket that needs to be associated with the Ticket (use freshservice-change-list to get the change ID).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- description: Change causing the Ticket that needs to be associated with the Ticket (use freshservice-change-list to get the change ID).
- description: The change ID that is needed for the ticket to be initialized. (So the change ID needs to be associated with the ticket). (Use freshservice-change-list to get the change ID).

name: freshservice-ticket-update
outputs:
- contextPath: Freshservice.Ticket.spam
description: Ticket spam.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Ticket spam.
description: Whether the ticket is spam.

isArray: false
name: ticket_id
required: true
- description: The Ticket task ID.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- description: The Ticket task ID.
- description: The ticket task ID.

name: task_id
required: false
deprecated: false
description: Retrieve tasks list (or a specific task) on a Ticket with the given ID from Freshservice.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Retrieve tasks list (or a specific task) on a Ticket with the given ID from Freshservice.
description: Retrieve tasks list (or a specific task) on a ticket with the given ID from Freshservice.

description: Task updated at.
type: Date
- contextPath: Freshservice.Ticket.Task.closed_at
description: Task closed at.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Task closed at.
description: Datetime the task was closed.

isArray: false
name: due_date
required: true
- description: Time in seconds before which notification is sent prior to due date (For example 30 minutes, 7 hours and etc).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- description: Time in seconds before which notification is sent prior to due date (For example 30 minutes, 7 hours and etc).
- description: Time in seconds before which notification is sent prior to due date (for example 30 minutes, 7 hours and etc).

- In Progress
- Completed
required: false
- description: The Ticket ID to add a task for (use freshservice-ticket-list to get ticket ID).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- description: The Ticket ID to add a task for (use freshservice-ticket-list to get ticket ID).
- description: The ticket ID to add a task for (use freshservice-ticket-list to get ticket ID).

gal-forer and others added 3 commits April 17, 2023 14:32
Co-authored-by: ShirleyDenkberg <62508050+ShirleyDenkberg@users.noreply.github.com>
Co-authored-by: ShirleyDenkberg <62508050+ShirleyDenkberg@users.noreply.github.com>
…ce/FreshworksFreshservice.yml

Co-authored-by: ShirleyDenkberg <62508050+ShirleyDenkberg@users.noreply.github.com>
name: ticket_id
required: true
deprecated: false
description: Create a new task on a Ticket request in Freshservice.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Create a new task on a Ticket request in Freshservice.
description: Create a new task on a ticket request in Freshservice.

description: Task due date.
type: Date
- contextPath: Freshservice.Ticket.Task.notify_before
description: Task notify before.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Task notify before.
description: Time in seconds before which notification is sent prior to due date (for example 30 minutes, 7 hours and etc.).

description: Task due date.
type: Date
- contextPath: Freshservice.Ticket.Task.notify_before
description: Task notify before.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Task notify before.
description: Time in seconds before which notification is sent prior to due date.

isArray: false
name: due_date
required: false
- description: Time in seconds before which notification is sent prior to due date (For example 30 minutes, 7 hours and etc).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- description: Time in seconds before which notification is sent prior to due date (For example 30 minutes, 7 hours and etc).
- description: Time in seconds before which notification is sent prior to due date (for example 30 minutes, 7 hours and etc.).

description: Task due date.
type: Date
- contextPath: Freshservice.Ticket.Task.notify_before
description: Task notify before.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Task notify before.
description: Time in seconds before which notification is sent prior to due date.

- Legal Review - Customer Documents
- Other
required: false
- description: The sub-category of the Problem.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- description: The sub-category of the Problem.
- description: The sub-category of the problem.

name: sub_category
required: false
- description: Key value pairs containing the names and values of custom fields.
isArray: false
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be true (isArray: true)

If it is, then the description should be: A comma-separated list of .....

name: custom_fields
required: false
- description: Key value pairs containing the names and values of the Problem Cause, Problem Symptom, and Problem Impact.
isArray: false
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be true (isArray: true)

If it is, then the description should be: A comma-separated list of key value pairs containing the names and values of the problem cause, problem symptom, and problem impact.

isArray: false
name: agent_id
required: false
- description: Unique identifier of the agent group to which the Problem is assigned. Use freshservice-agent-group-list to get the agent group ID.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- description: Unique identifier of the agent group to which the Problem is assigned. Use freshservice-agent-group-list to get the agent group ID.
- description: Unique identifier of the agent group to which the problem is assigned. Use freshservice-agent-group-list to get the agent group ID.

name: group_id
required: false
deprecated: false
description: Create a new problem request in Freshservice. Creating a problem required one of the following- requester_id or email.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Create a new problem request in Freshservice. Creating a problem required one of the following- requester_id or email.
description: Create a new problem request in Freshservice. Creating a problem requires one of the following- requester_id or email.

type: String
- contextPath: Freshservice.Problem.requester_id
description: Problem requester ID.
type: Date
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the ID really a date?

type: String
- contextPath: Freshservice.Problem.group_id
description: Problem group ID.
type: Date
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the ID really a date?

description: The timestamp that denotes when the problem is due to be resolved.
type: Date
- contextPath: Freshservice.Problem.known_error
description: Problem known error.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Problem known error.
description: Whether the problem is a known error.

type: Boolean
- contextPath: Freshservice.Problem.department_id
description: Problem department ID.
type: Date
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the ID really a date?

isArray: false
name: planned_start_date
required: false
- description: Timestamp at which change is ending (for example YYYY-MM-DDThh:mm).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- description: Timestamp at which change is ending (for example YYYY-MM-DDThh:mm).
- description: Timestamp at which the change is ending (for example YYYY-MM-DDThh:mm).

isArray: false
name: subject
required: false
- description: requester email.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- description: requester email.
- description: The requester email.

name: department_id
required: false
- auto: PREDEFINED
description: Category of the Problem.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Category of the Problem.
description: Category of the problem.

- Legal Review - Customer Documents
- Other
required: false
- description: The sub-category of the Problem.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- description: The sub-category of the Problem.
- description: The sub-category of the problem.

name: sub_category
required: false
deprecated: false
description: Update an existing Change request in Freshservice.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Update an existing Change request in Freshservice.
description: Update an existing change request in Freshservice.

@idovandijk idovandijk removed their request for review April 17, 2023 14:32
description: Change risk.
type: Number
- contextPath: Freshservice.Change.change_type
description: Change change_type.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Change change_type.
description: Change type.

type: Number
- contextPath: Freshservice.Change.requester_id
description: Change requester ID.
type: Date
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this really a date?

name: change_id
required: true
deprecated: false
description: Delete the Change request with the given ID from Freshservice.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Delete the Change request with the given ID from Freshservice.
description: Delete the change request with the given ID from Freshservice.

name: task_id
required: false
deprecated: false
description: Retrieve the tasks on a Change request with the given ID from Freshservice.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Retrieve the tasks on a Change request with the given ID from Freshservice.
description: Retrieve the tasks on a change request with the given ID from Freshservice.

description: Task due date.
type: Date
- contextPath: Freshservice.Change.Task.notify_before
description: Task notify before.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Task notify before.
description: Time in seconds before which notification is sent prior to due date.

description: release status.
type: Number
- contextPath: Freshservice.Release.priority
description: release priority.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: release priority.
description: Release priority.

description: release priority.
type: Number
- contextPath: Freshservice.Release.release_type
description: release release_type.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: release release_type.
description: Release type.

description: release release_type.
type: Number
- contextPath: Freshservice.Release.work_start_date
description: release work start date.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: release work start date.
description: Release work start date.

description: release work start date.
type: Date
- contextPath: Freshservice.Release.work_end_date
description: release work end date.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: release work end date.
description: Release work end date.

description: Datetime the release was updated.
type: Date
- contextPath: Freshservice.Release.associated_change_ids
description: release associated change IDs.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: release associated change IDs.
description: Release associated change IDs.

gal-forer and others added 4 commits April 18, 2023 11:16
Co-authored-by: ShirleyDenkberg <62508050+ShirleyDenkberg@users.noreply.github.com>
Co-authored-by: ShirleyDenkberg <62508050+ShirleyDenkberg@users.noreply.github.com>
…ce/FreshworksFreshservice.yml

Co-authored-by: ShirleyDenkberg <62508050+ShirleyDenkberg@users.noreply.github.com>
@ShirleyDenkberg
Copy link
Contributor

I edited the yml file offline since I was having trouble accessing it. I sent the edited file to @gal-forer to upload.
I have some comments:

  • There are several places, where it is an ID, and the type is Date. Is that correct? (for example line 1585).
  • There are several places where isArray: true. Shouldn't the description in these places be: A comma-separated list of.....
  • On line 1688, isArray: false. But in other places I saw that when the description is Key value pairs..., isArray was true.

After the yml file has been uploaded, the readme will need to be regenerated.

@content-bot
Copy link
Collaborator Author

This PR was automatically updated by a GitHub Action

  • CommonTypes pack version was bumped to 3.3.65.

To stop automatic version bumps, add the ignore-auto-bump-version label to the github PR.

…reshservice-integration' into contrib/qmasters-ltd_freshwork-freshservice-integration
@ShirleyDenkberg
Copy link
Contributor

@michalgold @gal-forer Doc review completed. Please regenerate the Readme file.

@gal-forer gal-forer merged commit 768103a into master Apr 19, 2023
12 of 13 checks passed
@gal-forer gal-forer deleted the contrib/qmasters-ltd_freshwork-freshservice-integration branch April 19, 2023 22:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Community Contribution Form Filled Whether contribution form filled or not. Contribution Thank you! Contributions are always welcome! docs-approved
Projects
None yet
5 participants