How to create and use Calendars and Events in CQ

Transcription

How to create and use Calendars and Events in CQ
How to create and use Calendars and Events in CQ
How to create and use Calendars and Events
in CQ
Overview / CQ / Adobe Experience Manager 5.6.1 / Administering / Introduction to Social Communities /
The Calendar and Event components provide the following functionality:
• You can create calendars, then add and modify events; events can be single occurrence or repeating.
• Calendars have a variety of views, including day, week, month, agenda.
• Your can define default settings for a calendar, or customize the appearance.
• You can filter events or use the Query builder.
• You can import or export ICS files.
• You can assign an event to a page of content, then subscribe to such pages from a calendar. This allows
you to have pages with detailed event information while still providing an overview in calendar format.
• You can subscribe to other calendars and events.
• You can create your own event forms for customized event entry.
• You can subscribe to an external calendar from the web; for example a Google calendar.
An example Calendar can be seen on the Events page of Geometrixx; for example, http://localhost:4502/
content/geometrixx/en/events.html.
CREATING A NEW CALENDAR
To add a new calendar you can add an instance of the Calendar component to your existing page (ensure
that the calendar component has been enabled in Design mode; it will appear under Calendar in the
sidekick, from here you can drag it to create an instance at the required position).
CREATING AN EVENT IN A CALENDAR
When creating an event in a calendar you specify the start and finish days; and optionally, the specific times
too.
To create an event:
1.
In the Month view click on a specific date to open the Create event dialog:
•
•
2.
In the Summary field, enter a descriptive name for the event.
Set the appropriate start and end dates with the From and To fields.
Deactivate the All day check box to add specific times if required. The drop down list provides
times at 15 minute intervals, but you can type in any time.
• If you select a period for Repeats, copies of the event will be automatically generated at the
required interval.
• Optionally, add a Description, Tags and a Link.
Click Save. The event appears on your calendar:
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 1
Created on 2014-09-05
How to create and use Calendars and Events in CQ
MODIFYING EVENTS
To modify an event:
1. In the calendar, click on the event you want to modify. The Edit event window opens.
2. Make your changes and click Save.
If you are editing an event that has been set to repeat at intervals you will be asked to confirm whether
you want to update all occurrences, or just the current instance.
DELETING EVENTS
To delete an event you also use the Edit event dialog:
1. In the calendar, click on the event you want to delete. The Edit event window opens.
2. Click Delete.
You will be asked to confirm the deletion, and in the case of a recurring event you will be asked whether
you want to delete the series or only the current instance.
NAVIGATING DATES
To navigate through the calendar month by month, click the left and right arrows above the calendar. To
move directly to today, click the Today link.
CHANGING THE CALENDAR VIEW
CQ Calendars provide views to determine how you, and the visitors to your website, see the calendars and
events presented.
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 2
Created on 2014-09-05
How to create and use Calendars and Events in CQ
The Month and Agenda views are activated and available on the calendar by default.
Clicking Month displays the month view:
If there are too many events to be shown for a single day, then this will be indicated:
Clicking Agenda displays the agenda view:
DEFINING DEFAULT SETTINGS FOR YOUR CALENDAR
You can select the timezone, date and time formats and also the day you want as the start of the week:
1.
2.
Open the calendar page.
Click Edit.
3.
In the General tab you can define formats and the day to use for start of week.
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 3
Created on 2014-09-05
How to create and use Calendars and Events in CQ
•
4.
Date format: Select from Locale dependent, 25.09.2009, 09/25/2009 or 2009-09-25
Locale dependent uses the locale/language setting of the user currently logged in (translations
include date/time format strings). This setting makes sense for intranet-based usage on author
instances only (since a login is normal there). When publishing the calendar, a fixed format setting
that is used for all website users is often used.
• Time format: Select from Locale dependent, 1 pm or 13:00.
• Start of week: Select from Locale dependent or any day of the week.
• Time Zone: Select the required time zone (according to area/location) from the drop down list; type
a substring of the required the location to select a sublist, e.g. typing Euro will limit the list to those
entries containing that string.
If left empty the locale value locale of the server will be taken (this is the locale of the server JVM).
Click OK to save.
NOTE
Changing the time zone will refresh the view of any existing events.
NOTE
The time zones listed are taken from the zoneinfo database (also known as Olson database).
Each time zone uses the standard naming of <area>/<location>; for example, Europe/London or
Atlantic/Faroe amongst many others.
Daylight saving changes are made automatically, based on information in the database.
CUSTOMIZING THE APPEARANCE OF A CALENDAR
At any time after you have created a calendar, you can customize certain aspects of the appearance:
1.
2.
Click Edit on the calendar.
Select the Appearance tab to set:
• Calendar lens height
• Show querybuilder
• Event view popup size
• Event edit dialog size
• Default lens
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 4
Created on 2014-09-05
How to create and use Calendars and Events in CQ
3.
Click OK to save.
DEFINING WHERE EVENTS ON THE CALENDAR CAN BE EDITED
To define when events on the calendar can be edited:
1.
2.
Click Edit on the calendar.
Select the Edit tab to specify:
•
3.
Allow editing:
• Permission sensitive Visitors to the publish environment can add/edit events, when logged in
with an account that has the appropriate permissions.
• Only on authoring instance Events can only be added or edited on the author environment.
• Never
See Selecting an Event Form for other settings.
Click OK to save the changes.
FILTERING EVENTS
You can filter events to see only those events containing a specific string. The filter will be enforced when
you navigate through the months.
For example, to see only those items that have the word "Staff" in them:
1.
In the Search box, type the term you want to filter with (i.e. the keyword that CQ will look for in the
calendar events).
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 5
Created on 2014-09-05
How to create and use Calendars and Events in CQ
2.
Click the magnifiying glass to apply the filter. Only events containing this term are shown, all other
calendar events are hidden.
3.
Remove the keyword in the Search box (either manually or use the x button) and click the magnifying
glass to remove the filter. All events are displayed again.
NOTE
After applying the filter the view stays on the current month. You might have to navigate to
another month/week/day to see any filtered events.
USING THE QUERY BUILDER
The Query Builder can be used (once activated for the calendar) for more detailed searches than are
possible with the filter.
For more information see the Dam Asset Share.
IMPORTING AN ICS FILE
You can import an ics file to include events from another calendar (this is a one-off action, see Importing an
External Calendar for full integration).
For example, to import an event with the following details:
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 6
Created on 2014-09-05
How to create and use Calendars and Events in CQ
1.
Click Edit on the calendar and select the Subscriptions / Import tab:
2.
Click the Upload ICS file button to open a dialog allowing you to either enter the file name, or browse
your local file system:
3.
After specifying the file, use the Upload button to initiate the action. CQ will confirm the success with a
message box.
4.
Click OK to save. The new event will be shown:
EXPORTING YOUR CALENDAR
Calendar Export Link
The Calendar Export Link component can be selected from sidekick and allows you to create a link to the
entire content of a calendar component - both the calendar's own and any subscribed content.
There are two types of link:
• ICS file download
This can be used for a one-time download; for example, when importing content into Outlook or iCal.
• Webcal link
This is recognized by most browsers and opens the default calendar application (for example, Outlook
or iCal) for subscription. Typically, the calendar application can be configured to regularly check the CQ
calendar for updates.
NOTE
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 7
Created on 2014-09-05
How to create and use Calendars and Events in CQ
A webcal link requires anonymous read rights on the calendar page, component and all events
displayed. There is no way for the calendar application to use credentials when checking the
subscription, so they will always access the link as an anonymous web user; this is default on
publish, but might require configuration if required on author.
1.
Drag the Calendar Export Link component to the page.
2.
Right-click the component instance and click Edit.
•
•
•
Link Title
Specify the text you want used for the link.
If empty the text Export Calendar is used for the link.
Link Type
You can choose from:
• Download ICS file (http://)
• Webcal subscription (webcal://)
Calendar component
Specify the path to the page holding the required calendar component; this is typically a
page path + /jcr:content/par/calendar
if the calendar lies in the paragraph system "par" on that page.
Or leave empty to use the calendar on the current page (in the same paragraph system).
There are two examples of such links on the Geometrixx page, http://localhost:4502/cf#/content/geometrixx/
en/events.feed:
•
•
Subscribe to calendar
Download Calendar as ICS
Feeds
As with all CQ pages a calendar page is available as feeds that can be subscribed to. For example, the
Geometrixx page, can be accessed as either:
• Atom feed
http://localhost:4503/content/geometrixx/en/events.feed
• RSS feed
http://localhost:4503/content/geometrixx/en/events.feed.rss.xml
For example, the Atom Feed:
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 8
Created on 2014-09-05
How to create and use Calendars and Events in CQ
CREATING A CONTENT PAGE FOR A SINGLE EVENT
As well as creating events within a calendar you can create a single event directly on a page. A calendar
can then subscribe to the page (or to the subtree holding this, and other, events). The event(s) will then be
automatically shown in the calendar.
This allows you to link pages holding detailed information about events with a calendar providing the
overview.
1.
Open the required page.
2.
3.
Select the Event component from the Calendar section of sidekick. Drag it onto the page.
You can enter the event details by opening the dialog with the Edit event button (right side of the
component instance). Details will then be shown on the page, you can also add other content related to
the event, for example:
NOTE
Double-clicking on the component area (but not on the Edit event button) opens the
Edit Component dialog for editing details about the event form and dialog - if required.
4.
From your (overview) calendar subscribe to this page (or tree, it will detect all single events on the child
pages) for the event to be shown.
For example, creating a selection of pages, each holding a single event (as above):
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 9
Created on 2014-09-05
How to create and use Calendars and Events in CQ
Will provide you with a calendar containing an overview of all single events:
Event Forms
The Edit event dialog is based on a CQ Form (cq:Form).
A standard event form is provided out-of-the-box, but if required you can copy this to create a form
customized to your own specifications.
WARNING
You should never edit the standard event form (located at /libs/collab/calendar/content/
eventform.html).
Always create your own event form before editing.
SELECTING AN EVENT FORM
To select the form to use when creating or viewing events:
1.
2.
Click Edit on the calendar.
Select the Edit or View tab as appropriate to specify:
•
Details specific to either:
• Allow editing:
(See Defining where Events on the Calendar can be edited for more details on these settings.)
• Permission sensitive
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 10
Created on 2014-09-05
How to create and use Calendars and Events in CQ
3.
• Only on authoring instance
• Never
• Event display:
• Embed view form in popup
• Embed view pattern in popup
• Link to URL in event (using pattern as fallback)
• Link to view pattern
• Event form:
• Leave blank to use the default form (eventeditor).
• Specify a form of your choice.
• Event pattern
• Specify the URL pattern. Select from the placeholders available.
Click OK to save the changes.
NOTE
Day recommends that you create event forms for a specific calendar underneath the page holding
the calendar. For example, ../mycontent/mycalendar.html would use ../mycontent/mycalendar/
myeventform.html.
CUSTOMIZING YOUR NEW EVENT FORM
Open the required form with either the Event edit form or Event view form links as appropriate:
CAUTION
To avoid the event form page being shown in any navigation use the Page tab of sidekick to
access Page Properties... and activate Hide in Navigation.
Here you can add, move or delete the Event Form components:
Event Basics
This component adds the basic fields that are always required for any event. These fields ensure that an
event contains the minimum information required for ICS export.
WARNING
Do not delete the instance of Event Basics from your form. This information is needed by every
event form.
Event ICS Link
This component provides the link for downloading a single event as ICS. By editing this component you can
add the link Title.
This component can be used on a event form (only visible on an existing event that has been saved).
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 11
Created on 2014-09-05
How to create and use Calendars and Events in CQ
Link
Although available under the Form section of sidekick (as opposed to the Event Form section), this
component is often used with events.
You can configure various parameters for an instance of this component (double-click), but you must set the
Element Name to ./url.
Event Organizer
This component allows you to input information about the person organizing the event:
NOTE
This information is not compulsory.
Event Push Workflow
This component allows the user to place the event into a "Push" Workflow:
A "Push" workflow is used when a calendar has an event that should appear in a separate calendar, but
does not have write access to that calendar.
As there is not write access to the other calendar, a workflow is used to send a request for the event
to be accepted into the other calendar. After the event is accepted any changes will be automatically
synchronized.
For example, a university might have one main calendar holding all common events, with each department
having their own individual calendars holding both department specific events and common events (by
subscribing to the main calendar). If a "common" event is created in a department calendar the workflow can
be used to request that it be accepted by the main calendar.
Double-click the component instance to configure:
• Title, to appear on the event form
• Button label, to appear on the event form; leave empty to use the default title "Start Workflow"
• Workflow Model, specify a workflow model (that has a subscription process step)
• Target Calendars, specify the target calendars
You can create workflows for processing events; an example is the Calendar Event Promotion workflow:
Event Recurrence
This component provides the fields necessary to define events that repeat at regular intervals:
The individual fields are dependent on the period selected by the author.
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 12
Created on 2014-09-05
How to create and use Calendars and Events in CQ
Subscribing to/from Other Calendars
SUBSCRIBING TO A CQ CALENDAR OR EVENT
Subscribing will automatically show the target content in the current calendar. You can subscribe to:
• another CQ calendar
• a CQ event
• a subtree; any calendars or events within the tree will be included
To configure the subscriptions:
1.
2.
3.
Click Edit on the calendar.
Select the Subscriptions / Import tab and use the Subscribed calendars/events field to specify the
target location; this can be a single page, or the root page of a subtree.
You can use the + button to add more subscriptions.
Click OK to save and activate the subscription.
SUBSCRIBING TO AN EXTERNAL CALENDAR
You can connect to the feed provided by an external calendar so that events are regularly imported into your
CQ WCM calendar. This uses the CQ Feed Importer, which polls the external calendar at regular intervals.
Calendar URLs are generally available within a calendar's settings. Check the documentation for your
calendar application for more information. You can import either a public calendar or a private calendar. If
you want to import a private calendar, you need access to the private ics URL.
To import events from another calendar:
1.
2.
3.
Open the Tools console.
Expand the Importers folder and double-click the Feed Importer.
Click Add to open the New Importer Configuration dialog to define:
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 13
Created on 2014-09-05
How to create and use Calendars and Events in CQ
•
•
•
•
4.
5.
Type
The type of feed. Select Calendar (RSS, Atom, IMAP, IMAP (over SSL), POP3 and POP3 (over
SSL) are also available if necessary).
Feed URL
The source URL for the calendar data.
Import to Path
Add the path where the imported calendar should be stored.
In the Import to Path field navigate to the calendar you created and then navigate to /jcr:content/
calendar/calendars/default. You can also paste the path into the field. For example, for a page
created in /content/calendar.html the import path is /content/calendar/jcr:content/calendar/
calendars/default.
Update Interval in Seconds
Enter a time in seconds. The minimum is 300 seconds. The first import of calendar information
happens after the time you specify (you do not see content import until after the specified time
period has elapsed). Using the OSGi interface the minimum can be reduced, but this should only
be considered for testing purposes.
Click OK. Your import configuration is stored.
Open, or refresh, your calendar page. After the specified interval, imported data appears on the
calendar.
USING AN EVENT PUSH WORKFLOW
You can customize your event form to include the Event Push Workflow field. This allows you to "push" the
event in question into another calendar by means of a workflow.
For example, a university might have one main calendar holding all common events, with each department
having their own individual calendars holding both department specific events and common events (by
subscribing to the main calendar). If a "common" event is created in a department calendar the workflow can
be used to request that it be accepted by the main calendar.
To configure your calendar for use with a workflow:
1. Create a new page and create a Calendar there.
2. Edit the calendar and subscribe to a second calendar; for example the Geometrixx page Events (/
content/geometrixx/en/events.html).
3. Edit the calendar and create a new events form. Ensure that this event form is assigned to your
calendar.
4. Edit this form and add the Event Push Workflow field.
5. Configure the Event Push Workflow field:
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 14
Created on 2014-09-05
How to create and use Calendars and Events in CQ
•
•
•
Title, assign your own title.
Button label, assign your own label.
Workflow Model, select the workflow that can be used for this event form. For example, the
Calendar Event Promotion workflow.
• Target Calendar, assign the calendar to which the event will be sent.
6. Save all changes.
To use a workflow with your calendar (for example, the default workflow):
1. Create an event in the calendar configured above.
2. After inputting the event details, select the required workflow in the Event Push Workflow field.
3. Click Start Workflow. A message will confirm that the event has been placed in the workflow for
processing..
4. Click OK to save.
The appropriate person will now be assigned the Moderation step in the workflow.
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 15
Created on 2014-09-05