-
Notifications
You must be signed in to change notification settings - Fork 1
Home
Marius Merkevicius edited this page Feb 4, 2020
·
33 revisions
Brief description how to set-up and use the tool.
Main purpose of the tool is to track your work through the day and log it to JIRA with least amount of hassle.
Documentation below will provide an overview how you can use the app, but for the app to connect to JIRA, check Set-up section.
And here are in-depth details how to use some of the features of the app
- Setting up Basic auth / OAuth (iTo) with JIRA
- Creating / Updating logs: Logs
- Searching for Tickets
- Tips on installing on MacOS or Windows
Main screen presents your day / week worklogs in one screen.
- Press on
>
to start the clock - Press on running clock opens screen to save your log
- Press on
x
would stop the running clock -
Pro tip: Short-cut to save log is
Cmd + s
orCtrl + s
- Press on
<
or>
to change to next day / week - Press on date to open day selection
- Every log you save is stored on your computer. Those logs need to be synchronized (Sent to JIRA). This action is done automatically after some time (~2 minutes)
- Logs are not synchronized instantly for a purpose to make you time to update worklogs
-
Pro tip: Short-cut to synchronize is
Cmd + r
orCtrl + r
- Worklogs are displayed in different color. Each color means status of the worklog.
- Green worklogs - synchronized (visible in JIRA)
- Yellow worklogs - needs synchronization (stored on computer only, not in JIRA)
- Sometimes worklog might not be sent to JIRA after sync. That may mean:
- Worklog does not have a ticket number
- Worklog does not have a comment
- Worklog is less than one minute
- JIRA might not be accepting worklog
- All of these statuses can be viewed inside the ticket
- Displays worked hours for active day
- In week view will display total worked hours for the whole week
- Various settings to configure your Account and app preferences
- Account settings - set-up your JIRA account
- App settings - configure app preferences
- Statistics - graph for your current day / week
- Credits - used libraries ant attributions
- Help - this wiki ᕕ( ᐛ )ᕗ
- Change into day's view
- Change into week's view
- Change into day's view as a list
You can use the app without the connection to JIRA, but to take full advangage of the app it's recommended to connect it.
You only need to set up the app only once.
Note: Users from iTo should use OAuth!
There are two types of connections:
- OAuth (iTo) - more secure, but requires an additional set-up (If you're using iTo company build, use this!)
- Basic - most common one, easiest to set-up (This is probably you wanna use)