Zimbra Triggers

Steps to Getting the PREAUTHKEY from the Server (where ZCS 7.1.2 is installed)

1. Connect to Server using Putty.

2. Login as root user.

3. Change the user to Zimbra using

• su – zimbra
• zmprov
• prov> gdpak domain.com

- preAuthKey: Key will be displayed here.

4. The PreAuthKey value needs to be hard coded in the zimbra.class.php file.

“$this->_preAuthKey = preAuthKey “

5. Also in Line Number 41 of zimbra.class.php

protected $_server1 = 'ip-10-73-18-235.ec2.internal'; // hostname of zimbra server.

Needs to be changed and hostname of the server in which the ZCS is installed should put.

Steps for Executing the Triggers in Processmaker

1. Enter URL (Your Processmaker Instance).

2. User Id : of the Processmaker.

3. Password : of the Processmaker.

4. Select the Process to be Started.

5. Click on New Case.

6. You will get a Screen as below.

7. Select the Trigger you want to Test/Execute and press Start.

Examples

Add Folder (Trigger)

• Zimbra Server URL: Enter the ipaddress/displayName used for loging in to Zimbra Server.

• Zimbra User: Enter the UserName used for loging in to Zimbra Server.

• FolderName: Enter the Folder Name you wish to Create

• Color: Select the Color you wish to give to the folder.

OPTIONS for Parameters

Folder Name:Just the folder name if it is a parent folder

Else Parent Folder Name / Folder Name (you want to create)

Color:

0 - None

1 - Blue

2 - Cyan

3 - Green

4 - Purple

5 - Red

6 - Yellow

7 - Pink

8 - Gray

9 - Orange

• Click on Submit and in the createFolderResult variable you will get a message “Folder Created Successfully”.

• If Folder Already Exists then message displayed will be “Folder with name folderName already exists”.

• To check if the folder is actually created or not, logon to Zimbra Webserver using the credentials and Click on Briefcase Tab you can see the folder with the name and color you selected in the Trigger, on the Right Panel.

Create Contacts(Trigger)

• Zimbra Server URL: Enter the ipaddress/displayName used for loging in to Zimbra Server.
• Zimbra User: Enter the UserName used for loging in to Zimbra Server.
• First Name: Enter the First Name of the user whom you want to add in the Contacts List
• Last Name: Enter the Last Name of the user whom you want to add in the Contacts List
• Email: Enter the Email Address of the user whom you want to add in the Contacts List
• Other : Enter Other Details such as Birthday, Anniversary or any other CustomValue.

   OPTIONS for Parameters:

   Other:

     - Birthday – YYYY-MM-DD

     - Anniversary – YYYY-MM-DD

     - Custom – Normal Sentence (plain text)

• Click on Submit and in the createContactsResult variable you will get a message “Contact Created Successfully”.

• To check if the contact is actually created or not, logon to Zimbra Webserver using the credentials and Click on AddressBook Tab you can see the contact with the attributes you set in the Trigger, on the Main Content Area.

Create Appointment(Trigger)

a. Zimbra Server URL  : Enter the ipaddress/displayName used for loging in to Zimbra Server.

b. Zimbra User  : Enter the UserName used for loging in to Zimbra Server.

c. Subject : Enter the Mail Subject for the Appointment

d. Organizer Friendly Name : Enter the Organizer’s Name

e. Domain Name : Enter the Domain name in which ZCS is installed

f. Schedule: Select the Schedule of the Appointment.

g. Appointment Name : Enter the Appointment Name.

h. Is Organizer : Select whether the appointment is Organized by the organizer or no.

i.Location : Enter the location where the Appointment is scheduled.

j.Is All Day Appointment: Select if the Appointment is an all Day or Not.

k. Start Date : Select/Enter the Starting Date of the Appointment.

l.End Date: Select/Enter the Ending Date of the Appointment.

m.Time Zone: Select the Time Zone.

n.Role : Select the role of the attendee.

o.Participation Status: Select the participation status of the Attendee.

p.Attendees Friendly Name: Enter the display name of the Attendee.

q.RSVP: Select whether you want RSVP or Not.

r.Calendar User Type: Select the Calendar user Type.

s.User Email: Enter the Email Address of the Attendee.

OPTIONS for Parameters

• Organizer Friendly Name:

    User name used for loging in to Zimbra Server

• Schedule:

   F – Free

   B – Busy

   T – Busy Tentative

   U – Busy Unavailable / Out of Office

• Is Organizer:

   0 – No

   1 – Yes

• Is All Day Appointment:

   0 – No

   1 – Yes

• Start Date:

   If All Day is 1 then

     YYYYMMDD

   Else

    YYYYMMDDTHHMMSS

• End Date:

   If All Day is 1 then

    YYYYMMDD

   Else

    YYYYMMDDTHHMMSS

• TimeZone:

If All Day is 1 then

Time zone parameter should be empty/null

Else

Contitent/CityName (that is used as reference for Time Zone universally)

• Role:

CHA – Chair

REQ – Required

OPT – Optional

NON– Non-participant

• Participation Status:

NE–Needs-action

TE – Tentative

AC – Accept

DE – Declined

DG – Delegated

CO – Completed (todo)

IN – In-process (todo)

• Calendar User Type:

IND – Individual

GRO – Group

RES – Resource

ROO – Room

UNK – Unknown

• Attendees Friendly Name:

If more than one Attendee the use semi-colon to separate the display name of the attendee.

• User Email:

If more than one Attendee the use semi-colon to separate the email address of the attendee.

Note: - The Options for Role, Chair and Non Participant does not appear in the Appointment.

The Options for Calendar User Type Group and Unknown Does not Display Attendees email address in the Appointment.

t.Click on Submit and in the createAppointmentResult variable you will get a message “Appointment Created Successfully”.

To check if the appointment is actually created or not, logon to Zimbra Webserver using the credentials and Click on Calendar Tab you can see the appointment with the attributes you set in the Trigger, on the Main Content Area.

Create Task(Trigger)

a.Zimbra Server URL: Enter the ipaddress/displayName used for loging in to Zimbra Server.

b.Zimbra User : Enter the UserName used for loging in to Zimbra Server.

c.Subject : Enter the Mail Subject for the Task.

d.User Friendly Name: Enter the display name of the user

e.User Email: Enter the Email Address of the user.

f.Task Name: Enter the name of the task

g.Is All Day Task: Select if the Task is an all Day or Not.

h.Class: Select if the task class is public or private.

i.Priority: Select the priority of the task.

j.Percentage Completed: Percentage of the task Completed.

k.Status : Select the status of the Task.

l.Location: Enter Location of the Task.

m.Due Date: Select/Enter the Due Date of the Task.

OPTIONS for Parameters

Is All Day Task:

- false – No

- true – Yes

Class:

- PUB – Public

- PRI – Private

Priority:

- 1 –High

- 5 –Normal

- 10 –Low

Percentage Completed:

- 0% to 100% increment by 10

Status:

- COMP – Completed

- INPR –In Progress

- WAITING –Waiting on Some one

- DEFERRED –Deferred

Start Date:

YYYYMMDD

Due Date:

YYYYMMDD

n. Click on Submit and in the createTaskResult variable you will get a message “Task Created Successfully”.

o. To check if the contact is actually created or not, logon to Zimbra Webserver using the credentials and Click on Task Tab you can see the task with the attributes you set in the Trigger, on the Main Content Area.

Get AppointmentList(Trigger)

a. Zimbra Server URL: Enter the ipaddress/displayName used for loging in to Zimbra Server.

b. Zimbra User: Enter the UserName used for loging in to Zimbra Server.

c. Click on Submit and in the getAppointmentResult variable you will get a list of “Appointments” along with the respective Details.

Get TaskList(Trigger)

a. Zimbra Server URL: Enter the ipaddress/displayName used for loging in to Zimbra Server.

b. Zimbra User:Enter the UserName used for loging in to Zimbra Server.

c. Click on Submit and in the getTaskResult variable you will get a list of ”Tasks” along with the respective Details

Get ContactList(Trigger)

a. Zimbra Server URL: Enter the ipaddress/displayName used for loging in to Zimbra Server.

b. Zimbra User: Enter the UserName used for loging in to Zimbra Server.

c. Click on Submit and in the getContactsResult variable you will get a list of “Contacts” along with the respective Details.

Upload(Trigger)

For Upload Trigger to Work

• Install a PHP PECL extension/module

Ubuntu

Follow the instructions

• After installing the extension check if on the php.ini file was added the following line:

<source lang="php"> [PHP_HTTP] extension=php_http.so

</source>

If the line wasn't added, add at the end of the file.

• Restart apache service

CentoOS 5

• /usr/bin/pecl install intl

• Search log "checking for icu-config... /usr/bin/icu-config*".

You'll need a path of the directory which has "/bin/icu-config" later.

• Download php wget [1]

tar xvzf php-5.3.6.tar.gz

cd php-5.3.6/ext/intl/

• compile and install intl module. phpize

./configure --enable-intl --with-icu-dir=/usr
make

make test

sudo make install.

• Finally, append "extension=intl.so" into php.ini.

Parameters

a. Zimbra Server URL: Enter the ipaddress/displayName used for loging in to Zimbra Server.

b. Zimbra User: Enter the UserName used for loging in to Zimbra Server.

c. FilePath: Enter the absolute path of the file where the file is located.

d. Folder Name : Enter the FolderName to which you wish to upload.

e. Click on Submit and in the uploadResult variable you will get a message “File Uploaded Successfully”.

f. To check if the file is actually uploaded or not, logon to Zimbra Webserver using the credentials and Click on BriefCase Tab and Click on the folder you provided as folder name in the trigger, you can see the file uploaded, on the Main Content Area.