OK

To obtain approval for Tracker issues, use the OK service. This service enables you to use issue comments to collect opinions of all the involved users as OK or Not OK.

If at least one approver answers Not OK, the approval process is suspended. The author can resume or finish the approval process.

All users who have access to the issue will see the list of approvers and their answers.

Creating approvals

There are two methods of creating an approval: set up a scenario for the queue or add a single approval to the issue.

Setting up an approval scenario

Use scenarios to initiate multiple approvals with typical parameters. You can always edit settings in such scenarios.

1. Create a scenario in the OK service. To learn how to set up a scenario, see the article on Wiki.

2. If you often run approvals with the same parameters, in the scenario settings, enable the option Pre-fill approval and specify additional details for filling out the form.

3. Under issue comments, open a list of macros and select the scenario.

4. Click Create request. An approval form appears in the comment.

5. Fill out the form.

Setting up a single approval

If you need to run a single approval, specify the issue and set up the parameters:

1. In the OK service, in the upper panel, click Approvals, then select New approval.

2. Enter the key of the issue where the approval will be run.

3. If an approval scenario has been set up for the queue that includes the issue, you can select the scenario.

4. Fill out the form.

/iframe/(src="https://ok.yandex-team.ru/tracker?_embedded=1&author=<login>&object_id=<issue_key>&uid=00001" frameborder=0 width=100% height=400px scrolling=no)

Fill out the approval form

1. Specify the approval parameters in the form:

   • Describe what needs to be approved.

   • Specify the approvers. The order matters: approval notifications are sent to each subsequent approver once the previous one has answered. To notify all the approvers at once, select Parallel approval.

     Next to an approver's name, you can see a calendar that shows when they are absent during the week.

     If an approver has no access to the issue, once the approval is created, the approver will be added to the Access field automatically.

   • To set up a group approval step, click Add group and specify the approvers.

     By default, it is enough to get an OK from at least one member of the group for approval. If each group member's approval is required, select Approval from all.

   • In the Approval managers field, specify the groups of users (departments/ABC/Wiki) who will be granted full access to approval settings.

     The members of the added groups do not receive notifications about approvals.

   • To add an option to refuse an approval, select Allow "Not OK".

2. Click Create approval.

Setting up a trigger

If some approvers prefer to respond in issue comments rather than by adding an approval resolution, you can set up a trigger for response parsing. In such a case, the OK or Yes comment by the approver will be counted and shown in the approval progress.

If an approver posts another comment in the issue, the approval author gets an email notification about a question regarding the approval. The Not OK comments will classify as questions on the approval.

To create a trigger:

1. Go to the queue settings, open the Triggers section, and click Create trigger.

2. Enter a name for the trigger.

3. Set the conditions for the trigger to fire whenever an approver posts a comment changing the Approval status field of the issue:

   1. Select Conditions to be met → All.

   2. Add the condition: Event type → Comment created.

   3. Add the condition: Approval → Approval status → Equal to string, and specify the Started value.

4. Set the action for the trigger:

   1. Add the HTTP request action.

   2. In the Method field, choose POST.

   3. In the Address field, enter: https://ok.yandex-team.ru/_api/comments/added/.

   4. In the Authentication method and Content type fields, leave the default values (NoAuth and application/json).

   5. For the request body, use the value: {"issue_key": "{{issue.key}}"}.

5. Save your trigger.

   To test your trigger, create an approval in an issue of the queue where you set up the trigger. Then post a comment containing OK. If all settings are correct, the response will appear in the approval form.

How to approve?

• After an approval is created, each approver receives a message from the robot inviting them to go to the issue and vote.

• All active approvals for each approver are shown on their My approvals tab in the OK service.

  The robot sends a reminder once a day until the approver responds. If no response has been received from the approver within three days, the user who created the approval is notified, too.

• In the issue comments, the approver sees the approval status and can vote with either OK or Not OK.

• If you set up a trigger for response parsing in the queue, the approver can use a comment to approve.

• If at least one of the approvers chooses "Not OK", the robot notifies the user who created the approval.

• The approval author can respond on behalf of any other approver.