ICalendar Migration Guide Zimbra I Calendar

User Manual: Pdf

Open the PDF directly: View PDF PDF.
Page Count: 8

DownloadICalendar Migration Guide Zimbra I Calendar
Open PDF In BrowserView PDF
Zimbra iCalendar Migration Guide
ZCS 8.7

April 2016

Legal Notices
Copyright © 2005-2016 Synacor, Inc. All rights reserved. This product is protected by U.S. and
international copyright and intellectual property laws. "Zimbra" is a registered trademark of Synacor,
Inc. in the United States and other jurisdictions.You may not alter or remove any trademark, copyright,
or other notice from copies of the content. All other marks and names mentioned herein may be
trademarks of their respective companies.
Synacor, Inc.
40 La Riviere Drive, Suite 300
Buffalo, New York 14202
www.synacor.com
ZCS 8.7
April 2016

Using Zimbra iCalendar Migration

The Zimbra Collaboration Server (ZCS) allows you to convert and migrate
Oracle calendars in .ics format to a Zimbra Collaboration Server. Oracle
calendars must be exported from the Oracle Calendar Server in .ics format
before they can be converted and migrated.
Migrating an exported Oracle calendar to a ZCS server is a two part process.
The first step is using the Zimbra iCalendar Migration Tool to convert .ics
Oracle calendar data into a standard .ics format. Once the file has been
converted, it can be imported.
This document discusses the Zimbra iCalendar Migration Tool, migration
planning, steps to migrate Oracle calendars to a Zimbra server, alternate
methods of importing .ics files, and Zimbra iCalendar Migration Tool log files.

About Zimbra iCalendar Migration Tool
The Zimbra iCalendar Migration Tool converts Oracle Calendar Server (OCS)
generated .ics files into standard .ics format.
The Zimbra iCalendar Migration Tool begins the conversion by identifying
patterns within RDATE series. Any patterns of DAILY, WEEKLY and
MONTHLY recurrences within RDATE series are converted to an RRULE. In
the case of recurrences that happen on a specific day of the week, a BYDAY
is also added to the RRULE. Any recurrences with limited changes in
summary, attendee list, location, date, time, or description are converted to
exceptions.
By default, all RDATE series that do not fit a pattern are converted into
standalone events with new UIDs. Alternately, the icalmig tool can be run with
an option to convert all RDATE series that do not fit a pattern to an RRULE
with a YEARLY recurrence, with exceptions are created for each associated
occurrence.
The Zimbra iCalendar Migration Tool is run using the icalmig command in the
Command Line Interface (CLI). The icalmig command can be run in standard
mode, or with additional options to further control the conversion process.
Standard mode converts a file to standard RFC format, using only default and
standard options during conversion. Syntax, description, and examples for
icalmig are given below.

Zimbra Collaboration Server

ZCS 8.6 3

Zimbra iCalendar Migration Guide

icalmig
This tool converts Oracle Calendar Server (OCS) generated calendar files to a
standard .ics format, which can then be processed by Zimbra servers. The
icalmig tool is stored in /opt/zimbra/libexec.
Syntax
icalmig -f  [options]
Description
Option

Description

-f

 Specifies the .ics file to convert.

Note: To run icalmig in standard mode, use
only this argument. Files converted in
standard mode use all default and
standard options, converting the file
to standard RFC format.

4

ZCS 8.6

-h

Displays the usage options for this command.

-v

Displays the Zimbra iCalendar Migration Tool version number.

-delrdate

{1|0} Deletes RDATEs from the master VEVENT
which has RRULE also. A value of 0 turns this
option off. A value of 1 turns this option on. This
option is on by default.

-exceptions

{1|0} Creates exceptions for RDATEs that do not
fit a pattern. A value of 0 turns this option off. A
value of 1 turns this option on. This option is on
by default.

-patternrule

{1|0} Creates an RRULE based on pattern found.
(E.g. DAILY, WEEKLY, BIWEEKLY) A value of 0
turns this option off. A value of 1 turns this option
on. This option is on by default.

-YearlyException

If this option is specified, all RDATE series that do
not fit a pattern are converted to an RRULE with a
YEARLY recurrence, with exceptions are created
for each associated occurrence.

Zimbra Collaboration Server

Using Zimbra iCalendar Migration

Option

Description

-tz

{1|0} Adds a VTIMEZONE component for
EST5EDT. All other date-time information will be
changed according to this component. A value of
0 turns this option off. A value of 1 turns this
option on. This option is off by default.

Note: At this time, this option does not
adjust the GMT timestamp. See Bug
31815 for more current information
about the status of this issue.
-nonStandardDTSTART

{1|0} Shifts the master event date to the oldest
RDATE if the master DTSTART is not the first
RDATE in the series. A value of 0 turns this
option off. A value of 1 turns this option on. This
option is off by default.

Note: All occurrences in an RDATE series
with a DSTART older than the master
event will be skipped during the
conversion if this option is off.
-logpath

 Specifies the log file path. The default path
is /opt/zimbra/log.

Example
In this example, the Zimbra iCalendar Migration Tool converts the
calendar.ics file located at home/myuser/data/. The log files for this
conversion will be stored in /tmp/logs.
icalmig -f “/home/myuser/data/calendar.ics” -logpath “/tmp/logs”.

Before Migrating
Before you begin the process of converting and migrating OCS generated
calendar files to a Zimbra server, you must export the OCS calendar data for
each user account in .ics format. The user’s calendar data can be exported
using either of the following Oracle tools.
 The uniical Utility. For more information about this tool, see the Oracle

download page, http://download.oracle.com/docs/cd/B15595_01/
collab.101/b14486/migical.htm#BJEEIDDF.
 Oracle Calendar Desktop Client. For more information about this tool,

see the Oracle Product page, http://www.oracle.com/technology/software/
products/cs/htdocs/clientsoft.html.

Zimbra Collaboration Server

ZCS 8.6

5

Zimbra iCalendar Migration Guide

Migrating an Oracle Calendar to a Zimbra Server
Once you have exported the OCS calendar data to an .ics format, you are
ready to begin converting and migrating the .ics files.
Use the following steps to migrate an OCS generated calendar file to a Zimbra
server.
1. Run the icalmig command with the .ics file to convert and any additional

options desired.
icalmig -f “/example.ics” [options]
Note: After the conversion is successfully finished, the complete path of
the output file and the log file are displayed. If this information is not
displayed, check the log files for errors.
2. If you are currently running as root, switch to the zimbra user.

su zimbra
3. Run the zmmailbox command to import the converted .ics file to the

Zimbra Server.
zmmailbox -z -m user@domain.com pru /Calendar ./example.ics.zimbra
The .ics file is now migrated to the Zimbra server.

Alternate Methods of Importing a Converted .ics File
Two alternate methods of importing a converted .ics file are REST and SOAP
calls. To import files using either of these methods, you will need the user
name and password of the account to which the .ics file is being imported.
A converted .ics file can also be imported by POSTing the content to REST
API. To POST an .ics file to a calendar using cURL, use the following
command.
curl -u user_name:password --data-binary @/tmp/new.ics
http://server/service/home/user_name/calendar?fmt=ics
To see more examples of importing using cURL, see the User Migration article
on the Zimbra Wiki.
Importing converted .ics files using SOAP is possible using any programming
language with SOAP support.
Note: Zimbra does not recommend using SOAP to import converted .ics files
unless you have previous experience programming with SOAP.

6

ZCS 8.6

Zimbra Collaboration Server

Using Zimbra iCalendar Migration

Zimbra iCalendar Migration Tool Log Files
The Zimbra iCalendar Migration Tool automatically creates a detailed log file
of each conversion. By default, this log file is saved to /opt/zimbra/log. You
can modify the path that the log file is saved to using the -logpath option when
you run the Zimbra iCalendar Migration Tool.

Contacting Zimbra Support
If you are a Network Edition customer experiencing an issue, file a support
case through the Support Portal. To provide the highest level of service,
please gather the following information before contacting support.
 Steps for reproducing the problem. Include steps for reproducing the

problem that you are experiencing.
 Log files. Attach logs generated in the Zimbra iCalendar Migration Tool

Log Files, described in “Zimbra iCalendar Migration Tool Log Files” on
page 7. These logs should only contain logging information gathered while
the problem was occurring.
 Oracle .ics file. Attach a sample Oracle .ics file exhibiting the conversion

problem.

Zimbra Collaboration Server

ZCS 8.6

7

Zimbra iCalendar Migration Guide

8

ZCS 8.6

Zimbra Collaboration Server



Source Exif Data:
File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.6
Linearized                      : No
Author                          : Synacor, Inc.
Create Date                     : 2014:07:28 16:04:45Z
Modify Date                     : 2016:04:21 14:25:55+01:00
Language                        : en
Tagged PDF                      : Yes
XMP Toolkit                     : Adobe XMP Core 5.6-c015 81.157285, 2014/12/12-00:43:15
Creator Tool                    : FrameMaker 11.0
Metadata Date                   : 2016:04:21 14:25:55+01:00
Producer                        : Acrobat Distiller 11.0 (Windows)
Format                          : application/pdf
Title                           : iCalendar Migration Guide
Creator                         : Synacor, Inc.
Document ID                     : uuid:f1649404-d5e9-4e2d-9b61-a1709bd1ea23
Instance ID                     : uuid:ea654376-cd76-4ae1-8723-360070e766bb
Page Mode                       : UseOutlines
Page Count                      : 8
Warning                         : [Minor] Ignored duplicate Info dictionary
EXIF Metadata provided by EXIF.tools

Navigation menu