User Guide
Using the module
After taking the steps in the installation guide, please follow the instructions below in order to use the Opacus SugarCRM Activities Sync with your calendaring application/device.
Your username is your SugarCRM username Your password is your Calendar Publish Key NB: Username is case sensitive!
iPhone / iPad
- Navigate to Settings > Mail, Contacts, Calendars
- Under 'Accounts', select 'Add Account'.
- Choose 'Other'.
- Under 'CALENDARS', choose 'Add CalDAV Account'.
- In the Server field enter the following URL:
[SUGAR-URL]/sas.php/principals/[USERNAME]
or for versions > 3.0
[SUGAR-URL]/rest/v10/sas/principals/[USERNAME]
where [SUGAR-URL] is your Sugar instance URL (including http:// or https://) and [USERNAME] is your Sugar Username
- In the Username field, enter your Sugar Username (case-sensitive)
- In the Password field, enter your Calendar Publish Key. You can find your Calendar Publish Key on the Advanced panel on your Sugar User Profile page.
- In the Description field, enter a suitable name for this new Account (e.g. Activity Sync)
- Choose 'Next'
- Once the Account details have been verified, choose whether you want Calendars and/or Reminders to be synced.
- Choose 'Save'
You can now navigate to the Calendar app to see your new calendars. PLEASE NOTE: If you have a large quantity of Meetings/Tasks/Calls in Sugar, the first refresh of the calendar(s) may take some time.
Android
Connecting to a CalDAV server using Android currently requires a third-party app, OpenSync
Once installed follow the instructions below:
- Open OpenSync
- Choose to Add New Account using the plus
- Login with URL and Username
- In the Base URL field, add your Sugar URL as follows:
[SUGAR-URL]/sas.php/
or for version > 3.0
[SUGAR-URL]/rest/v10/sas/
where
[SUGAR-URL] is your Sugar instance URL (including http:// or https://)
- In the Username field, enter your Sugar Username (case-sensitive)
- In the Password field, enter your Calendar Publish Key (case-sensitive). You can find your Calendar Publish Key on the Advanced panel on your Sugar User Profile page.
- In the account settings set your preferences such as sync frequency
- Your calendar is now configured.
Thunderbird + Lightning
- Install Lightning extension (Tools > Addons > Get Addons).
- After Thunderbird restarts, select Events and Tasks > Calendar from the Main Menu.
- Right click in the left hand panel and select 'New Calendar'.
- Select 'On the Network'.
- Select 'CalDAV' and enter the location as:
[SUGAR-URL]/sas.php/calendars/[USERNAME]/default
or for version > 3.0
[SUGAR-URL]/rest/v10/sas/calendars/[USERNAME]/default
where [SUGAR-URL] is your Sugar instance URL (including http:// or https://) and [USERNAME] is your Sugar Username. 6. Give your new calendar a Name. 7. In the Username field, enter your Sugar Username (case-sensitive, for our demo this is "Demo") 8. In the Password field, enter your Calendar Publish Key (for our demo this is "opacus"). You can find your Calendar Publish Key on the Advanced panel on your Sugar User Profile page.
To add calls please follow the same process replacing "default" in step 5 with "calls".
iCal
- Start iCal
- Go to the Preferences.
- Click on 'Accounts'.
- Click the + (Add) button to add a new CalDAV account.
- Select 'CalDAV' as the Account Type.
- In the Username field, enter your Sugar Username (case-sensitive)
- In the Password field, enter your Calendar Publish Key. You can find your Calendar Publish Key on the Advanced panel on your Sugar User Profile page.
- In the Server Address field, enter your Sugar instance URL.
- Click Create. iCal will begin searching for CalDAV servers. This will fail, this is normal behaviour.
- After the search has failed, click 'Continue'.
- Enter the following into the server path:
/sas.php/principals/[USERNAME]
or for version > 3.0
/rest/v10/sas/principals/[USERNAME]
where [USERNAME] is your Sugar username. Please note that the username is case sensitive. 12. Click Create.
You can now close the Preferences Window and begin using your calendar(s).