Initial Bonusly Package Content #7198

trorabaugh · 2020-05-25T08:36:43Z

Status

[] In Progress
Ready
In Hold - (Reason for hold)

Related Issues

fixes: link to the issue

Description

This is an initial bonusly package content.

Bonus.ly is an employee recognition platform which enterprises use to for employee recognition. We're building tools to help people feel a sense of purpose and progress at work. The platform which also has an API enables employees to recognize each other by providing a point based bonus system. Bonus.ly helps your employees feel connected, engaged, and aligned is mission critical right now. Bonusly makes employee recognition easy and fun, fostering community and creating company-wide alignment. It also provides employees with positive feedback in the work that they are doing.

Screenshots

Minimum version of Demisto

4.5.0
5.0.0
5.5.0
...

Does it break backward compatibility?

Yes
- Further details:
No

Must have

[x ] Tests
Documentation

Demisto Partner?

The title must be in the following format: [YOUR_PARTNER_ID] short description

CLAassistant · 2020-05-25T08:36:48Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
5 out of 6 committers have signed the CLA.

✅ trorabaugh
✅ idovandijk
✅ anara123
✅ roysagi
✅ kirbles19
❌ Tyler Rorabaugh

Tyler Rorabaugh seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

ronykoz · 2020-05-25T11:44:36Z

@roysagi let's change the base too

…m for all of the nice work on the updated dev docs. I also wish I could provide AutoGratitude but I dont have admin level points

trorabaugh · 2020-05-26T17:11:00Z

Hi Everyone, I fixed the commit by amending my email. I don't quite follow the CircleCI failures.

Packs/Bonusly/Integrations/Bonusly/CHANGELOG.md

Packs/Bonusly/Integrations/Bonusly/README.md

Packs/Bonusly/pack_metadata.json

roysagi · 2020-05-31T15:09:14Z

Packs/Bonusly/Scripts/IncOwnerToBonuslyUser.yml

@@ -0,0 +1,52 @@
+commonfields:


please split this file to python and yml files. You can use demisto-sdk split-yml -i Packs/Bonusly/Scripts/IncOwnerToBonuslyUser.yml -o Packs/Bonusly/Scripts/IncOwnerToBonuslyUser

is the output command missing a file extension? I don't see what file extension it should be.

i assume this will create a directory with the split files?

That command produced a python 3.7 error...but Im running 3.8...

Detected python version: [3.8] for docker image: demisto/python3:3.8.2.8159 Copying pipenv files from: /Users/******/IdeaProjects/demisto_content/venv/lib/python3.8/site-packages/demisto_sdk/commands/lint/resources/pipfile_python3 Warning: the environment variable LANG is not set! We recommend setting this in ~/.profile (or equivalent) for proper expected behavior. Warning: Python 3.7 was not found on your system… Would you like us to install CPython 3.7.7 with pyenv? [Y/n]:

this seems to be pipenv related - I'll send over a possible solution by slack.

should be fixed

Packs/Bonusly/Scripts/GetOwnerEmail.yml

Packs/Bonusly/Integrations/Bonusly/Bonusly.yml

Packs/Bonusly/Scripts/GetOwnerEmail.yml

roysagi · 2020-05-31T17:17:34Z

Packs/Bonusly/Scripts/IncOwnerToBonuslyUser.yml

+
+
+  def inc_owner_bonusly_user():
+      owner_username = demisto.incidents()[0].get("owner")


same issue as above - I am not sure this is what you wanted to achieve - please explain.

Both of these are used to get the owner of the incident's email address and utilized in the playbook as the owner in the product is only the username and not their email. For their playbook to work, you need the incident owners email.

same as above - please create an argument for owner_username and remove this line. Use the incident context to fill this argument in the playbook.

Packs/Bonusly/Scripts/GetOwnerEmail.yml

roysagi · 2020-06-07T06:40:12Z

Packs/Bonusly/Scripts/IncOwnerToBonuslyUser.yml

+
+
+  def inc_owner_bonusly_user():
+      owner_username = demisto.incidents()[0].get("owner")


same as above - please create an argument for owner_username and remove this line. Use the incident context to fill this argument in the playbook.

roysagi · 2020-06-07T06:50:58Z

Packs/Bonusly/Scripts/IncOwnerToBonuslyUser.yml

@@ -0,0 +1,52 @@
+commonfields:


this seems to be pipenv related - I'll send over a possible solution by slack.

idovandijk · 2020-06-30T09:03:50Z

@roysagi can I begin playbook review here (is the code finalized)?

roysagi · 2020-06-30T15:18:42Z

@idovandijk - I talked to @trorabaugh today, he needs to make some changes in his scripts that will affect the playbooks. I think it is best if I ping you once I see the changes have been made.

idovandijk

I like the idea, the playbooks look good. I have a few comments for changes though.
I know you are working on a change for the script so the way the playbook looks may change a bit.
Please reach out if you have any questions or need assistance with making the changes.
Once the changes are done we can probably close this out with a short meeting to see an incident running smoothly.

Bonusly - AutoGratitude

I like the use of Lists. In the playbook input BonuslyLookupList I suggest starting the description with a short explanation of what this input is. Then proceed with the explanation you already added which explains how to do it.
Task Added scripts (with scripts.json), playbooks and reports. #6 starts a timer but it is never stopped. I think timers are automatically when incidents close, but since this playbook doesn't contain a task that closes the investigation, I recommend using the Done task to stop the time to assignment
Why do we want an input checking whether SLA should be checked? The description of the playbook implies that that is the purpose of it, so it would make sense to remove that input and always check SLA, or to change it to "true" by default.
But removing the SLA part would leave us with a 2-task playbook, one is the script and the other is the create bonus command, so I recommend keeping that - it's a good use case.
To make the playbook even more customizable and generic, you could specify the SLAs as playbook inputs, and then look at those inputs. This would make it very easy for other users to simply use this playbook in their incidents and specify in the inputs which SLAs matter for them
Please add descriptions to all tasks

Bonusly - Create Bonus

Let's remove this playbook and use the task directly in the other one. If the task can be used just like that then we should avoid complicating with extra playbooks.

trorabaugh · 2020-07-06T17:45:14Z

I like the idea, the playbooks look good. I have a few comments for changes though.
I know you are working on a change for the script so the way the playbook looks may change a bit.
Please reach out if you have any questions or need assistance with making the changes.

Yeah I will have to get to this hopefully either later this week or on the weekend as its a challenge to do during the work week.

Once the changes are done we can probably close this out with a short meeting to see an incident running smoothly.

ok

Bonusly - AutoGratitude

I like the use of Lists. In the playbook input BonuslyLookupList I suggest starting the description with a short explanation of what this input is. Then proceed with the explanation you already added which explains how to do it.
Yeah any suggestions on this or better way would be great.

Task Added scripts (with scripts.json), playbooks and reports. #6 starts a timer but it is never stopped. I think timers are automatically when incidents close, but since this playbook doesn't contain a task that closes the investigation, I recommend using the Done task to stop the time to assignment

Ok great ill update that

Why do we want an input checking whether SLA should be checked? The description of the playbook implies that that is the purpose of it, so it would make sense to remove that input and always check SLA, or to change it to "true" by default.
But removing the SLA part would leave us with a 2-task playbook, one is the script and the other is the create bonus command, so I recommend keeping that - it's a good use case.

Not sure I quite follow

To make the playbook even more customizable and generic, you could specify the SLAs as playbook inputs, and then look at those inputs. This would make it very easy for other users to simply use this playbook in their incidents and specify in the inputs which SLAs matter for them

Yeah the thing I was trying to figure out is how you can use SLA's as inputs as they are generally set by the incident I think. Any thoughts on how to make this customization?

Please add descriptions to all tasks

Thx for pointing this out ill check them all again

Bonusly - Create Bonus

Let's remove this playbook and use the task directly in the other one. If the task can be used just like that then we should avoid complicating with extra playbooks.

This part I might disagree on. The challenge I've seen with customers is that sometimes they just want to be able to drop a create task in without having to think about how the command works or learn the command. That was why I created a separate playbook so that it could just be included without needing to know how it works. I can remove it though if people don't think its useful. For me I like when I have example CRUD playbooks as it allows me to just drop them into larger playbooks.

idovandijk · 2020-07-07T13:48:32Z

Not sure I quite follow

I was wondering about this task which determines whether to check the SLA before granting the Bonusly. My thought was that this playbook is there to only provide bonusly of SLA was met, so I can't see the reason in making this check

I thought that if we are not checking the SLA then the playbook kinda loses its purpose.
however, on second thought I see that even if not using this playbook only in conjunction with SLAs, it does convert the email to bonusly user, so actually this is up to you whether to leave this as is, or decide that SLA will always be checked :)

Yeah the thing I was trying to figure out is how you can use SLA's as inputs as they are generally set by the incident I think. Any thoughts on how to make this customization?

SLAs can be changed throughout the incident, yes. I believe you can still pass their values as inputs to the playbook. So if incident.detectionsla.breachedTriggered is false, you can pass that "false" value into your playbook as I showed in the screenshot. Then you would check that value under say inputs.DetectionSLABreached... but honestly, this would require customization of task #5 according to their inputs anyway, so if you want you may also leave it like that :)

This part I might disagree on. The challenge I've seen with customers is that sometimes they just want to be able to drop a create task in without having to think about how the command works or learn the command. That was why I created a separate playbook so that it could just be included without needing to know how it works. I can remove it though if people don't think its useful. For me I like when I have example CRUD playbooks as it allows me to just drop them into larger playbooks.

Can you please elaborate? I understand your position but since this playbook only contains 1 task:

I can't see the reason for a customer to prefer to edit the playbook inputs instead of task inputs.

Thanks again, please tell me if there are any problems or if something is still unclear.

…te bonus playbook

adding line at the end of py file

roysagi · 2020-08-04T12:19:51Z

Packs/Bonusly/Integrations/Bonusly/Bonusly.py

+
+    def bonusly_test(self):
+        suffix = 'bonuses'
+        self._http_request('GET', suffix)


Suggested change

self._http_request('GET', suffix)

return self._http_request('GET', suffix)

I see your test_module is failing, I believe this is the reason

fixing test_module

roysagi · 2020-08-12T16:30:09Z

Me and @trorabaugh are waiting on a bonusly dummy user for testing - then we proceed with this PR

trorabaugh · 2020-08-12T19:32:34Z

@roysagi - intro was sent if you need anything else just ping them

trorabaugh · 2020-08-13T11:40:36Z

Do I need to do anything for the conflicting files?

trorabaugh · 2020-08-24T20:20:21Z

Anything else I need to do here?

idovandijk · 2020-08-25T10:22:44Z

Anything else I need to do here?

Looks like just fixing conflicts.. @roysagi and I both approved

Packs/Bonusly/pack_metadata.json

anara123 · 2020-08-25T20:46:55Z

@roysagi please the validation and lets merge this

anara123 · 2020-08-31T21:51:03Z

@roysagi please fix the validation error and make sure this PR is merged

* Initial Bonusly Package Content (#7198) * Initial Add * Initial Add of Bonusly. I want to thank francesco and the content team for all of the nice work on the updated dev docs. I also wish I could provide AutoGratitude but I dont have admin level points * Added additional readme content based on generate docs request * Updated Ignore * fixed validation outputs * fixed validation outputs * updating validation checks * initial commit * added again and also added new comments and fixed incorrect logic * Fixed commit issues, removed duplicate files, removed individual create bonus playbook * Added new adjustments based on feedback thanks a bunch Roy * Added new adjustments based on feedback thanks a bunch Roy * Update IncOwnerToBonuslyUser.py adding line at the end of py file * added pb readme, img * updated img link in pb readme * Updated secrets ignore file to ignore the email addresses * Updated descriptions * Updated * Updated descriptions * Update Bonusly.py fixing test_module * Update IncOwnerToBonuslyUser.py * Update IncOwnerToBonuslyUser.yml * Update IncOwnerToBonuslyUser.yml * Update IncOwnerToBonuslyUser.py * Update IncOwnerToBonuslyUser.py * Update Bonusly_-_AutoGratitude.yml * Update Bonusly_-_AutoGratitude.yml * Update Bonusly_-_AutoGratitude.yml * Update Bonusly_-_AutoGratitude.yml * Update IncOwnerToBonuslyUser.yml * Update IncOwnerToBonuslyUser.yml * Update Packs/Bonusly/pack_metadata.json * Update Bonusly.yml * Update IncOwnerToBonuslyUser.yml Co-authored-by: Tyler Rorabaugh <[email protected]> Co-authored-by: roysagi <[email protected]> Co-authored-by: idovandijk <[email protected]> Co-authored-by: Alex Fiedler <[email protected]> Co-authored-by: Anar Azadaliyev <[email protected]> * remove TPB * Update Bonusly.yml (#9002) Co-authored-by: Tyler Rorabaugh <[email protected]> Co-authored-by: Tyler Rorabaugh <[email protected]> Co-authored-by: idovandijk <[email protected]> Co-authored-by: Alex Fiedler <[email protected]> Co-authored-by: Anar Azadaliyev <[email protected]> Co-authored-by: ronykoz <[email protected]> Co-authored-by: syaakovi <[email protected]>

Initial Add

227c6c4

trorabaugh requested a review from ronykoz May 25, 2020 08:36

ronykoz requested review from roysagi and removed request for ronykoz May 25, 2020 11:44

ronykoz assigned roysagi May 25, 2020

Initial Add of Bonusly. I want to thank francesco and the content tea…

763edc3

…m for all of the nice work on the updated dev docs. I also wish I could provide AutoGratitude but I dont have admin level points

trorabaugh added 3 commits May 26, 2020 13:27

Added additional readme content based on generate docs request

592881e

Updated Ignore

0bedee3

Updated merge conflict

7bb3eb0

roysagi suggested changes May 31, 2020

View reviewed changes

roysagi suggested changes Jun 7, 2020

View reviewed changes

trorabaugh added 3 commits June 22, 2020 14:43

fixed validation outputs

fcec566

fixed validation outputs

619077d

updating validation checks

1883e5c

michalgold requested a review from idovandijk June 29, 2020 14:14

idovandijk requested changes Jun 30, 2020

View reviewed changes

initial commit

d6b7d34

trorabaugh added 4 commits July 15, 2020 00:29

added again and also added new comments and fixed incorrect logic

a8c68ff

Fixed commit issues, removed duplicate files, removed individual crea…

c30bcfb

…te bonus playbook

Added new adjustments based on feedback thanks a bunch Roy

65b9997

Added new adjustments based on feedback thanks a bunch Roy

8481ab3

roysagi approved these changes Jul 15, 2020

View reviewed changes

Update IncOwnerToBonuslyUser.py

a04c9cf

adding line at the end of py file

roysagi reviewed Aug 4, 2020

View reviewed changes

Itay4 mentioned this pull request Aug 4, 2020

Bonusly #8359

Closed

8 tasks

roysagi added 12 commits August 4, 2020 19:00

Update Bonusly.py

74741a6

fixing test_module

Update IncOwnerToBonuslyUser.py

f06dfb8

Update IncOwnerToBonuslyUser.yml

a77d8e7

Update IncOwnerToBonuslyUser.yml

0ea789e

Update IncOwnerToBonuslyUser.py

92366dd

Update IncOwnerToBonuslyUser.py

e3777a0

Update Bonusly_-_AutoGratitude.yml

cd98539

Update Bonusly_-_AutoGratitude.yml

878a14a

Update Bonusly_-_AutoGratitude.yml

be3d53f

Update Bonusly_-_AutoGratitude.yml

e734a4e

Update IncOwnerToBonuslyUser.yml

a4a86d5

Update IncOwnerToBonuslyUser.yml

9d0ac69

Itay4 closed this Aug 12, 2020

Itay4 reopened this Aug 12, 2020

Merge branch 'contrib/trorabaugh_bonusly' into bonusly

a25e505

anara123 reviewed Aug 25, 2020

View reviewed changes

Packs/Bonusly/pack_metadata.json Outdated Show resolved Hide resolved

Update Packs/Bonusly/pack_metadata.json

4c3e212

roysagi added 2 commits September 1, 2020 11:15

Update Bonusly.yml

accde67

Update IncOwnerToBonuslyUser.yml

7eb66e5

anara123 merged commit 10557be into demisto:contrib/trorabaugh_bonusly Sep 1, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial Bonusly Package Content #7198

Initial Bonusly Package Content #7198

trorabaugh commented May 25, 2020

CLAassistant commented May 25, 2020 •

edited

Loading

ronykoz commented May 25, 2020

trorabaugh commented May 26, 2020

roysagi May 31, 2020

trorabaugh Jun 5, 2020

trorabaugh Jun 5, 2020

trorabaugh Jun 5, 2020 •

edited

Loading

roysagi Jun 7, 2020

trorabaugh Jun 23, 2020

roysagi May 31, 2020

trorabaugh Jun 5, 2020

roysagi Jun 7, 2020

roysagi Jun 7, 2020

roysagi Jun 7, 2020

idovandijk commented Jun 30, 2020

roysagi commented Jun 30, 2020

idovandijk left a comment

trorabaugh commented Jul 6, 2020

Bonusly - AutoGratitude

Bonusly - Create Bonus

idovandijk commented Jul 7, 2020

roysagi Aug 4, 2020

roysagi commented Aug 12, 2020

trorabaugh commented Aug 12, 2020

trorabaugh commented Aug 13, 2020

trorabaugh commented Aug 24, 2020

idovandijk commented Aug 25, 2020

anara123 commented Aug 25, 2020

anara123 commented Aug 31, 2020



		def inc_owner_bonusly_user():
		owner_username = demisto.incidents()[0].get("owner")

	self._http_request('GET', suffix)
	return self._http_request('GET', suffix)

Initial Bonusly Package Content #7198

Initial Bonusly Package Content #7198

Conversation

trorabaugh commented May 25, 2020

Status

Related Issues

Description

Screenshots

Minimum version of Demisto

Does it break backward compatibility?

Must have

Demisto Partner?

CLAassistant commented May 25, 2020 • edited Loading

ronykoz commented May 25, 2020

trorabaugh commented May 26, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trorabaugh Jun 5, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

idovandijk commented Jun 30, 2020

roysagi commented Jun 30, 2020

idovandijk left a comment

Choose a reason for hiding this comment

Bonusly - AutoGratitude

Bonusly - Create Bonus

trorabaugh commented Jul 6, 2020

Bonusly - AutoGratitude

Bonusly - Create Bonus

idovandijk commented Jul 7, 2020

Choose a reason for hiding this comment

roysagi commented Aug 12, 2020

trorabaugh commented Aug 12, 2020

trorabaugh commented Aug 13, 2020

trorabaugh commented Aug 24, 2020

idovandijk commented Aug 25, 2020

anara123 commented Aug 25, 2020

anara123 commented Aug 31, 2020

CLAassistant commented May 25, 2020 •

edited

Loading

trorabaugh Jun 5, 2020 •

edited

Loading