How to use Cyclam

An app for shift workers that brings together your shift calendar, wake-up alarms, and paid leave and overtime records.

Calendar

One week of the app's calendar. The date cells show Night, Post, Off, Day and PL, each in its own color

Alarms (PRO)

The app's Alarms screen. The next alarm is a wake-up alarm tomorrow at 14:30, for a Night shift

Enter your shifts, and alarms are set automatically to match them

  1. 1Create shift types
  2. 2Enter your shifts
  3. 3Alarms ring

This is a translation of the Japanese original. If there is any difference, the Japanese version prevails.

1. Getting started

What it does

The calendar screen. At the top, your next shift. In the middle, a month of shifts. Below, the monthly summary and paid leave balance. At the very bottom, four tabs: Calendar, Shifts, Alarms and Settings
The calendar screen. From the top: the next shift bar, the month (the small button on the left is the roster photo), a month of shifts, the monthly summary, and your leave balance.

Switch screens with the tabs at the bottom.

CalendarSee your shifts. Tap a date to change that day's shift, leave or hours.
ShiftsCreate shift types. Stations and breaks. Enter shifts in bulk. Connect to your phone's calendar. Send to others.
Alarms App onlyCheck the alarms that are set. Any missing permissions show up here.
SettingsFrom the top: Display, Leave, Shown below the calendar, and Other (backup and more).

Tap i on a screen to open a short explanation right there (tap again to close it). You'll find it next to Cutoff day, Hourly leave, Grant date, Stations and breaks, Build rotation, Alarm sound, Nap slots and Day off (scheduled).

What appears in the calendar cells

You can change how these look in Settings > “Display” > “Advanced display settings”, under “How shifts and days off look” and “Cell marks and colors” (see How shifts and days off look, cell marks and colors).

What's free and what's PRO

The app is free to install. PRO features include “auto alarms”, so you don't have to set your alarms again every night.

FeatureFreePRO
AlarmsAdd by hand
(1 week)
Set automatically
Alarm soundStandardCustom
Paid leave leftTotalBreakdown too
Add leave types—✓
Widgets—✓
Roster photo—✓
Shifts, monthly summary, overtime, hourly leave, important days, stations, calendar connection, sending, backup✓✓

The App only mark means the feature works only in the iPhone and Android apps. It doesn't work in the web version you open in a browser. The PRO mark means the feature works with PRO (or during the trial).

Back to contents

2. Create your shift types

First, add the shifts you use at work. Choose a common shift template to create them all at once.

The Choose a shift template screen, with a 2-shift template highlighted
1Pick the closest
The screen for checking names and times, with the first shift's name and times highlighted
2Edit names, times
The screen for checking names and times, with the Create with these button highlighted
3Tap “Create”

Add or change shifts later

The Shifts tab, with the Add shift row highlighted
1Tap “Add shift”
The Add shift screen, with the name, times and color highlighted
2Name, times, color
The bottom of the shift screen, with the Save and close button highlighted
3“Save and close”

Good to know

Half day off (e.g., working Saturday mornings)

For people who work only half the day on some days, like Saturday mornings. The monthly summary counts the other half as 0.5 day off.

The Shifts tab, with the Day off (scheduled) row highlighted
1Tap “Day off”
The Day off (scheduled) window, with the Half day off button highlighted
2Tap “Half day off”
The Add half-day shift screen, with the name and times highlighted
3Set name, times

Stations and breaks

This is for workplaces where your station (the area or order you're assigned) rotates each day, and for people who want alarms for naps or lunch breaks.

The Shifts tab, with the Stations and breaks row highlighted
1Stations, breaks
The Stations and breaks screen, with the Use button highlighted
2Set to “Use”
The Stations and breaks screen, with the Station names row highlighted
3Set stations
The Stations and breaks screen, with the Add break button highlighted
4Add a break
More (rotation, break alarms)

Set night-shift nap times by day PRO

This is for people whose nap time changes from night to night, like “a night when only early nappers are on”, “4 nights in a row as early, early, late, late”, or “next block of nights is late, late, early, early”. Choose By day under “Time” on the break screen. Tap i next to “Nap slots” to open color-coded steps.

Step by step
  1. Create nap slots: At first there are 2: “Early nap” and “Late nap”. You can change their names and times, and add up to 4 with + Add slot (at least 1 is needed).
  2. Set your usual pattern: Starting from the first night of a run of night shifts, line up which slot you nap in. Tap a square to switch E → L → None, and use − + to change the number of days (1 to 8). If your night shifts run longer than the pattern, the pattern repeats. Nights set to “None” don't ring.
  3. Save the pattern: Tap + Save this sequence to add it to “Saved sequences” (up to 6). With 1, that pattern is used every time. With 2 or more, they're used from the top, one per run of night shifts, and it goes back to Run 1 after the last one. It keeps repeating far ahead, without you entering it again. Tap a saved sequence to bring it up top and rebuild it.
  4. Change for that day only: In “Upcoming night shifts”, tap the square under a date to change that night only (that run shows “This run only”, and Back to usual pattern puts it back). You can also change it in “Station & nap” on the date screen. If you've saved 2 or more, use Make this Run 1 to choose which run to count from.

The first letter of that night's slot (E, L, etc.) appears at the bottom left of the calendar cell (when stations are shown on the calendar).

Back to contents

3. Enter your shifts

“Bulk entry” on the Shifts tab lists the ways to enter shifts. If your workplace runs on a fixed rotation, “Enter by rotation” is the fastest.

Enter by rotation

The Shifts tab, with the Enter by rotation row highlighted
1“By rotation”
The Build rotation screen, with the Tap to add shifts and the Next button highlighted
2Tap shifts in order
The calendar for choosing a start date, with the start date highlighted. The shifts to be entered show with dotted lines
3Tap the start date
Below the calendar, the length and the fill button highlighted
4Pick length, fill
Change a tile in the middle, or start in a later month

Tap that tile in the sequence at the top, and ← Earlier ✕ Remove Later → appear below. When you're done, tap Deselect (back to adding) (tapping the same tile again also takes you back). To start in a later month, tap › at the top to move ahead, then tap the day.

Enter day by day

For workplaces without a fixed rotation, or when you only want to change a few days.

The Shifts tab, with the Enter day by day row highlighted
1“Day by day”
The bar at the bottom, with the Night button highlighted
2Choose a shift
The calendar, with the tapped days highlighted. The tapped days become Night
3Tap the dates
The bar at the bottom, with the Done button highlighted
4Tap “Done”

The bar at the bottom also has Day off, ✕ Clear, and leave such as Paid leave.

Roster photo PRO

Keep photos of the paper roster and annual holiday calendar you get at work. In months that have a photo, the button to the left of the month shows that photo.

The calendar, with the small button to the left of the month highlighted
1Tap left of month
The roster photo screen, with the Take photo and Choose from photos buttons highlighted
2Take or choose
More (view, retake, send)

Photos are kept only on this phone. They're not included in the backup file. When you switch phones, open each photo on your old phone and tap Save to Photos, then add them again on your new phone with Choose from photos.

Copy previous month

The Shifts tab, with the Copy previous month row highlighted
1“Copy”
The Copy previous month screen, with the month to copy to and the Copy by date button highlighted
2Pick month, copy

Copies the shifts from the previous month. Choose whether to copy to the same dates or the same days of the week.

Clear from a date onward

Use this when your schedule changes or you entered something wrong.

The Shifts tab, with the Clear from a date onward row highlighted
1“Clear onward”
The calendar, with the first day to clear and the Delete button highlighted. The days to be cleared are faded
2Tap a day, delete

Days to be cleared are faded and outlined with a red dotted line. Tap Delete, and Delete again to confirm. From that day on, shifts, days off, leave (including hourly leave) and hours changed for single days are cleared. Earlier days, your shift types and your notes are not deleted.

If you make a mistake

When you change something, a bar appears at the top of the screen saying what changed. Tap Undo to go back to how it was.

Find days off

Tap the year and month above the calendar, then tap Find days off. Your days off for the next 3 months are listed.

Back to contents

4. Change one day (early start, overtime, notes)

Tap a date on the calendar to open that day's screen. Changes are saved as soon as you tap.

The calendar, with a date highlighted
1Tap a date
The date screen, with the shift buttons and leave buttons highlighted
2Shift or leave
The date screen, with the Note row highlighted. Rows for Early start / overtime and Alarm are listed too
3Tap a row to open

Note, Early start / overtime, Alarm and the other items are each folded into one row, with the current settings on the right (rows for features you don't use are not shown). Use ‹ Previous day Next day › at the very bottom to move to the day before or after.

Row by row (note, important day, early start, alarm, sound)

How shifts and days off look, cell marks and colors

In Settings > “Display” > “Advanced display settings”, two rows let you choose how cells look. When you tap an option, the one-week preview below (calendar and widget) changes right away.

The Cell marks and colors row in Settings, opened. Four style buttons, the colors for days with overtime or changed hours (2 rows, 12 colors), and below them a one-week preview of cells
“Cell marks and colors” in Settings.
Back to contents

5. Leave and paid leave balance

First, enter the days you were granted

Enter the days you were granted in “Leave (this period)” on the Settings tab.

The Leave section in Settings, with the Paid leave row highlighted
1Tap “Paid leave”
The Paid leave row opened, with − + for Days granted this period and Add 0.5 day highlighted
2Enter your days

Use + and − to enter “Days granted this period” and “Carried over from last period”. If you have half a day left over, check Add 0.5 day (8 days becomes 8.5 days).

Add leave to the calendar

The calendar, with a date highlighted
1Tap a date
The date screen, with the Paid leave button under Leave highlighted
2Tap “Paid leave”

Half day AM, Half day PM and leave types you added are in the same place. To remove it, tap None. You can't add leave to days you don't work, like days off, post-night or off-duty days (you can add it to days with no shift entered yet).

Checking your balance

Your balance is shown in the bar below the calendar and in “Leave (this period)” in Settings. Tap the bar below the calendar to open “Leave history” (a list of days used, and the balance). Change the order of the list with Oldest first Newest first at the top (your choice is remembered).

Hourly paid leave (hourly leave)

You can also count paid leave taken by the hour. It's only for people who use it, so it's hidden at first.

The Use hourly paid leave row in Settings, with the Use button highlighted
1Set to “Use”
The date screen, with the Hourly leave row highlighted. Open it and enter the hours with − +
2Enter the hours

Once it's set to “Use”, set “Scheduled hours per day” just below to your company's working hours per day (not counting breaks). If this is wrong, your balance will be off.

The cell shows “HL 2h”. You can enter up to one day's hours per day, or up to half a day on a half-day leave day.

More (how it's counted, 5-day limit, format)

The days shown are estimates based on what you entered. Check the official numbers with your workplace records.

Back to contents

6. Overtime and monthly summary

The app adds the time extended in “Early start / overtime” on the date screen to each shift's “Overtime” to estimate how much longer than usual you worked. It may be counted differently from your company.

The Shown below the calendar section in Settings, with the All button for Monthly summary highlighted
Set “Monthly summary” in Settings to All to also see days worked, days off and more.
Back to contents

7. Alarms App only

Set alarms automatically PRO

Set “how many minutes before start to wake up” for each shift type, and alarms are set automatically on days with that shift. They're set up to the last day of the shifts you entered (up to 1 year ahead).

The Shifts tab, with the Day row highlighted
1Tap a shift
The shift screen, with the Alarm row highlighted
2Open “Alarm”
The Alarm row opened, with − + for Wake-up 1 minutes before start highlighted. It shows that it rings at 7:00
3Set minutes before
More (weekends, nights, silent mode, sound)

Change one day, or add alarms yourself

Check which alarms are set

The large card at the top of the Alarms tab is the next alarm to ring. Below it, upcoming alarms are listed by day. Check here before you go to sleep.

The Alarms tab. The large card at the top shows the next alarm time and how many hours until it rings. Below it, upcoming alarms are listed by day
The Alarms tab.

Alarms at any time (trash day, etc.)

Set alarms for things unrelated to work, such as trash day or medicine. You can add up to 5. They're free to use.

  1. Open Alarms at any time at the bottom of the Alarms tab.
  2. Tap + Add alarm and choose a time.
  3. Tap Name, repeat & sound to set the details.

Repeating alarms are set up to 8 weeks ahead. Open the app to add later ones. In the list on the Alarms tab, tapping ✕ removes just that one time of a repeating alarm.

When your shifts are about to run out PRO

Alarms don't ring on days with no shift. As the last day of the shifts you entered gets closer, a notice bar appears above the calendar (from 14 days before; from 6 days before, the bar is red). If you allow notifications, you're also told by notification. Enter your shifts further ahead. If you won't use the app for a while, tap Hide (not using it for a while) on the bar that appears after your shifts run out.

Alarms are not guaranteed to ring. Depending on your phone's settings and battery state, they may not ring. Until you're used to the app, use it together with your usual alarm.

Everything to check is in Settings > “Other” > If alarms don't ring. Tap Ring in 1 min to test there and it rings once, 1 minute later. Turn off the screen, wait, and check that it rings and that you can stop it.

Back to contents

8. Phone calendar and widgets App only

“Calendar app” on the Shifts tab has two switches. Both ask for access to your calendar the first time, so please allow it.

Add to phone calendar automatically

Creates a separate calendar named “Cyclam” in your phone's calendar and puts your shifts in it. When you change your shifts, the calendar changes too. Your other calendars are not touched.

Show phone events in Cyclam

Shows events from your phone's calendar (including Google and iCloud events) on top of Cyclam's cells. It only reads them and never changes them.

Home screen widgets PRO

CalendarLarge. This month's shifts and notes. Today's date turns blue and its cell is outlined in blue. Important days get the same colored ring as in the app. On Android, if you make it short, it shows this week and next week.
Today & next shiftMedium: today's shift and events, plus the next few days. Small: today's date and your next shift. On Android, there's also a wide one with today and tomorrow side by side.
Lock screeniPhone only. Your next shift and your wake-up and departure times. In the list it's called “Cyclam Next shift”.
The Calendar widget. This month's grid shows dates, shift names and notes as text
Calendar (large). Orange text is a note you wrote.
The Today & next shift widget (medium). Today's shift on the left, upcoming shifts on the right
Today & next shift (medium)
The Today & next shift widget (small). Today's date and your next shift
Today & next shift (small)
Back to contents

9. Share and back up

Send your shifts

With Send / copy shifts on the Shifts tab, you can send your shifts as text or as a calendar image (Send calendar as image) by messaging app or email. Your shifts are sent only when you send them yourself.

Show the screen (view only)

Turn on Show this screen (view only) to show only your shift pattern, with your next shift and leave balance hidden. You can hand your phone to someone without worrying that they'll change anything. To exit, tap Exit view at the top, then Exit and return to the owner's screen.

Back up (save a copy)

Everything you enter is saved on your phone. Save a copy in case you switch phones or something goes wrong.

The Other section in Settings, with the Back up / Restore row highlighted
1“Back up”
The Back up / Restore screen, with the Save to file button highlighted
2Tap “Save to file”

Choose where to save it (on iPhone, “Save to Files”; on Android, “Downloads”, Google Drive, etc.), and a file named cyclam-backup-date.txt is created. To restore, use Choose file and restore under “2. Restore (from a copy)” on the same screen and choose that file.

If you delete the app, everything you entered is deleted too. Always save a copy before deleting it.

Roster photos are not included in the backup file (see Roster photo).

Back to contents

10. Troubleshooting

Alarms don't ring or aren't set

Cyclam doesn't appear in the widget list

Switching phones

On your old phone, create a backup file, send it to your new phone by email, cloud drive or similar, and choose it under “2. Restore (from a copy)” on your new phone. You can move between iPhone and Android too. Roster photos aren't included in the backup, so save them to Photos and add them again. Get PRO back with Bought before? Restore purchase on the purchase screen (when you use the same store account).

On your new phone, be sure to open Cyclam once. Alarms aren't set until you do. If you're asked for permissions, allow them. Auto alarms are set again at that time. Check alarms you added yourself on the Alarms tab, and add them again if they're missing.

Change how the screen looks

Change it in Settings > “Display”. Each item is folded into one row like “Name current value ›” and opens when you tap it (important days, how shifts and days off look, and cell marks are in “Advanced display settings” inside it).

My paid leave balance doesn't match

I want to start over

To clear only from a certain day onward, use Clear from a date onward. To clear everything, use Settings > “Other” > Reset all data (shifts, leave and settings are deleted; text size and theme are kept). Right after deleting, you can get it back with Undo in the bar at the top.

Can I use alarms in the web version?

No. A browser can't control your phone's alarms. Use alarms in the iPhone or Android app.

Contact

Settings > “Other” > Send feedback, or email cyclam.support@gmail.com.

Back to contents