PT Calendar Version 4.8 Upgrade - Revision history

Gcronkright at 14:50, 3 June 2025

2025-06-03T14:50:19Z

Show changes

Gcronkright at 14:45, 3 June 2025

2025-06-03T14:45:45Z

Gcronkright at 14:39, 3 June 2025

2025-06-03T14:39:51Z

Ssmith: /* Update the PT Calendar "Calendar Event Recurrence" Custom Element */

2025-03-13T19:24:47Z

‎Update the PT Calendar "Calendar Event Recurrence" Custom Element

Ssmith: /* Update the PT Calendar "Calendar Event Recurrence" Custom Element */

2025-03-13T15:46:16Z

‎Update the PT Calendar "Calendar Event Recurrence" Custom Element

Gcronkright at 22:37, 6 February 2025

2025-02-06T22:37:09Z

Gcronkright: /* Disabling the CCAPI for Custom Elements */

2025-02-05T21:07:34Z

‎Disabling the CCAPI for Custom Elements

Gcronkright at 22:13, 31 January 2025

2025-01-31T22:13:50Z

Gcronkright: /* Calendar Events Search Viewer Page */

2025-01-31T18:08:28Z

‎Calendar Events Search Viewer Page

Gcronkright at 18:05, 31 January 2025

2025-01-31T18:05:19Z

@@ Line 131: / Line 131: @@
 # Once completed, Reset the ADF.
-  Note: If no other CE nodes are listed in the <elements> node, other ADF CCAPI functions may still use the <wsVars> configuration information, so do not remove this file.
+  Note: If other CE nodes are listed in the <elements> node, other ADF CCAPI functions may still use the <wsVars> configuration information, so do not remove this file.
 == Reset the ADF ==
 [[Reset ADF|Reset the ADF]] for the server and site.

@@ Line 8: / Line 8: @@
 == Overview ==
-This guide is to upgrade the PT Calendar v4.7 from v4.8.  If you are updating from a version earlier than v4.7, please complete the v3.0 - v4.8 Upgrade Guides in order.
+This guide is to upgrade the PT Calendar v4.7 to v4.8.  If you are updating from a version earlier than v4.7, please complete the v3.0 - v4.8 Upgrade Guides in order.
   Note: There is not an upgrade path from Calendar 2 or earlier to Calendar 4.x. You can only upgrade Calendar v3.x to Calendar v4.x. From Calendar 2.x or earlier you will need to treat the Calendar App as a new install.

@@ Line 48: / Line 48: @@
 ## '/ADF/apps/pt_calendar/site-files/customcf/calAppUpdater.cfm'
 # View the PT Calendar App Update menu page by going to the URL:
-## http://{your-site}/customcf/calAppUpdater.cfm.cfm
+## http://{your-site}/customcf/calAppUpdater.cfm
 # The following updater-script will be displayed with [PREVIEW] and [RUN] options
 ## cft-props-defaults-updater-for-4.8

@@ Line 46: / Line 46: @@
 Use these steps to update the  recurStartTime, recurEndTime, recurAllDay, rangeStartDate and rangeEndDate fields to be updated to the correct custom field types:
 # Copy the following updater file to your site and place it in your 'customcf' directory:
-## '/ADF/apps/pt_social_media/site-files/customcf/calAppUpdater.cfm'
+## '/ADF/apps/pt_calendar/site-files/customcf/calAppUpdater.cfm'
 # View the PT Calendar App Update menu page by going to the URL:
 ## http://{your-site}/customcf/calAppUpdater.cfm.cfm

@@ Line 1: / Line 1: @@
 Back to [[PT_Calendar|PT Calendar]]
-  '''IMPORTANT''': v4.8 of this application requires '''ADF 2.7.0''' or greater and '''CommonSpot 11.0.0, 10.9.1 or 10.8.2''' or greater.
+  '''IMPORTANT''': v4.8 of this application requires '''ADF 2.7.0''' or greater and '''CommonSpot 11.0.0, 10.9.1 or 10.8.3''' or greater.
 <!--

@@ Line 127: / Line 127: @@
 # Find your CCAPI conduit page for the Calendar App. This page is generally called 'ccapiCalendar' built from the 'Blank Layout Template''.
 ## The ccapiCalendar.cfm page may be located in the '/webadmin/calendar/' subsite.
-# Once you find the CCAPI Conduit page that has the Calendar elements on it, disable this page.
+# Once you find the CCAPI Conduit page that has the Calendar App elements on it, disable this page.
 # In the '/_cs_apps/config/ccapi.cfm' file for the site remove the <CalendarEventDetails>, <CalendarEventDateTime>, <CalendarEventRecurrence>, <CalendarEventCategories> and <CalendarOrganizations> nodes from the <elements> section of the XML block.
 # Once completed, Reset the ADF.

@@ Line 1: / Line 1: @@
 Back to [[PT_Calendar|PT Calendar]]
-  '''IMPORTANT''': v4.8 of this application requires ADF 2.7.0 or greater and CommonSpot 11.0.0, 10.9.1 or 10.8.2 or greater.
+  '''IMPORTANT''': v4.8 of this application requires '''ADF 2.7.0''' or greater and '''CommonSpot 11.0.0, 10.9.1 or 10.8.2''' or greater.
 <!--
@@ Line 28: / Line 28: @@
 # Rename directory "/ADF/apps/pt_calendar" to "/ADF/apps/pt_calendar_v4.7".
 # Rename file "/ADF/apps/pt_calendar_v4.7/appBeanConfig.cfm" to "/ADF/apps/pt_calendar_v4.7/appBeanConfig.cfm.old".
-# Move the PT Calendar v4.8 and into the "/ADF/apps/pt_calendar/" directory.
+# Move the PT Calendar v4.8 files and folder structure into the "/ADF/apps/pt_calendar/" directory.
 # Reset the ADF

@@ Line 72: / Line 72: @@
 Your Fields should now be updated!
-== Calendar Events Search Viewer Page ==
+=== GCE Viewer Page for PT Calendar Details Search Results - Optional ===
 This feature allows the Calendar Event Details element records listed on a CommonSpot Search Results Element render handler to link to the correct event details displayed on a Calendar Event Details App view page. If the search results item links to a single event the GCE View Page will forward the Event Details view page, if multiple recurring events are matched then the GCE Viewer Page will list the matched events as a list of event date links.
-To set up a GCE Viewer Page for PT Calendar Event Details data in search results, follow these steps:
+  Important: This set-up guide assumes that you have “Full-Text Search” configured and at least one search collection setup for your site.
-If you haven’t already done so, install the ‘PT Calendar Event Details Viewer’ custom metadata form via the Site Admin Element & Forms > Metadata forms dialog:
+If you haven’t already done so, install the '''PT Calendar Event Details Viewer''' custom metadata form via the Site Admin Element & Forms > Metadata forms dialog:
-# Click on the ‘Import Metadata Form” at the bottom of the “Metadata Forms” dialog
+# Click on the '''Import Metadata Form''' at the bottom of the '''Metadata Forms''' dialog
 ## From the File Field click the “Choose File” button
-### From your local hard drive select the “PT-Calendar-Event-Details-Viewer-Metadata-Form.zip” file from where you have the pt_calendar\exported-objects app directory saved
+## From your local hard drive select the '''PT-Calendar-Event-Details-Viewer-Metadata-Form.zip''' file from where you have the pt_calendar\exported-objects app directory saved
 ## Click Next
-## Follow the remainder of the import wizard prompts to finish the Custom Metadata form installation
+## Follow the remainder of the import wizard prompts to finish the '''Custom Metadata Form''' installation
 # After the PT Calendar Event Details Viewer Metadata Form .zip archive is installed you will need to re-copy the “calendar_search_redirect_rh.cfm” file to your “/ADF/Apps/pt_calendar/renderhandlers/” folder on your server to make sure this file has the latest updates.
 Setup a Calendar Details GCE Viewer Page:
-# Create a new page in the “/calendar” subsite from the “Base Plus One” Template (or other Site specific subsite and/or soft template).
+# Create a new page in the “/calendar” subsite from the “Base Plus One” Template (or other Site specific subsite and/or soft template)
-## Standard Properties:
+## Page Standard Metadata:
 ### Name: calendar-event-details-forwarder
 ### CommonSpot Title: Calendar Event Details Select
@@ Line 98: / Line 95: @@
 ### Uncheck “Full Text and Search Element Results”
 ### Click Next
-## Set applicable “custom properties” for this new page.
+## Set applicable “custom properties” for this new page
 ### Click Save
 # On the newly created page insert the “Calendar Event Details” Global Custom Element in the main content area container
@@ Line 106: / Line 103: @@
 ## Then from the element indicator icon for the “Calendar Event Details” Global Custom Element click on the Custom icon:
 ### Use the “Linked Calendar Page” field to select the main “All Events” calendar view page you set up for viewing calendar event details you created during the main calendar app install.
-### Important: This is NOT the “Calendar Details GCE Viewer Page” you are currently editing.
+#### Important: This is NOT the “Calendar Details GCE Viewer Page” you are currently editing
 ### Click Save
 ## Publish this page.
 Configure the Calendar Event Details GCE Viewer Page:
-# From the CommonSpot Site Admin go to the Element & Forms > Elements left menu item.
+# From the CommonSpot Site Admin go to the Element & Forms > Elements left menu item
 # After the “Manage Elements” dialog opens go to the “Calendar Event Details” global custom element.
 ## From the pencil icon select the “View Page & Search Properties” menu item.

← Older revision		Revision as of 18:05, 31 January 2025
Line 71:		Line 71:

	Your Fields should now be updated!		Your Fields should now be updated!
		+
		+	== Calendar Events Search Viewer Page ==
		+
		+	This feature allows the Calendar Event Details element records listed on a CommonSpot Search Results Element render handler to link to the correct event details displayed on a Calendar Event Details App view page. If the search results item links to a single event the GCE View Page will forward the Event Details view page, if multiple recurring events are matched then the GCE Viewer Page will list the matched events as a list of event date links.
		+
		+	To set up a GCE Viewer Page for PT Calendar Event Details data in search results, follow these steps:
		+
		+	Important: This set-up guide assumes that you have “Full-Text” Search configured and at least one search collection setup for your site.
		+
		+	If you haven’t already done so, install the ‘PT Calendar Event Details Viewer’ custom metadata form via the Site Admin Element & Forms > Metadata forms dialog:
		+	# Click on the ‘Import Metadata Form” at the bottom of the “Metadata Forms” dialog
		+	## From the File Field click the “Choose File” button
		+	### From your local hard drive select the “PT-Calendar-Event-Details-Viewer-Metadata-Form.zip” file from where you have the pt_calendar\exported-objects app directory saved
		+	## Click Next
		+	## Follow the remainder of the import wizard prompts to finish the Custom Metadata form installation
		+	# After the PT Calendar Event Details Viewer Metadata Form .zip archive is installed you will need to re-copy the “calendar_search_redirect_rh.cfm” file to your “/ADF/Apps/pt_calendar/renderhandlers/” folder on your server to make sure this file has the latest updates.
		+
		+	Setup a Calendar Details GCE Viewer Page:
		+	# Create a new page in the “/calendar” subsite from the “Base Plus One” Template (or other Site specific subsite and/or soft template).
		+	## Standard Properties:
		+	### Name: calendar-event-details-forwarder
		+	### CommonSpot Title: Calendar Event Details Select
		+	### Page Title: Calendar Event Details Select
		+	### Description: A calendar event details select list or redirect page
		+	### Uncheck “Page Index”
		+	### Uncheck “Full Text and Search Element Results”
		+	### Click Next
		+	## Set applicable “custom properties” for this new page.
		+	### Click Save
		+	# On the newly created page insert the “Calendar Event Details” Global Custom Element in the main content area container
		+	## From the element indicator icon for the “Calendar Event Details” Global Custom Element click on the Render Properties option and select the option:
		+	### One Record - Base on URL (Developer Use)
		+	### Click Save
		+	## Then from the element indicator icon for the “Calendar Event Details” Global Custom Element click on the Custom icon:
		+	### Use the “Linked Calendar Page” field to select the main “All Events” calendar view page you set up for viewing calendar event details you created during the main calendar app install.
		+	### Important: This is NOT the “Calendar Details GCE Viewer Page” you are currently editing.
		+	### Click Save
		+	## Publish this page.
		+
		+	Configure the Calendar Event Details GCE Viewer Page:
		+	# From the CommonSpot Site Admin go to the Element & Forms > Elements left menu item.
		+	# After the “Manage Elements” dialog opens go to the “Calendar Event Details” global custom element.
		+	## From the pencil icon select the “View Page & Search Properties” menu item.
		+	### Set the following settings
		+	#### Element Viewing Page: {select the ‘Calendar Event Details Select’ page you just created}
		+	#### Title: Events Title
		+	#### Description: Description
		+	#### Enable full-text indexing: X - checked
		+	#### Full-Text Collection: {select the collection where calendar details data should be indexed.}
		+	### Click Save
		+	# After the “Calendar Event Details” global custom element is configured with the new GCE Viewer Page you will need to ‘Reindex” the ‘Full-Text Collection’ selected during its configuration.
		+
		+	Note: When the GCE Viewer Page is configured it can also be used for linking to calendar event details from other CS elements like a Calendar Event Details Datasheet row using the /ADF/extensions/datasheet-modules/1.0/pageID-to-link-for-global-ce-records.cfm Datasheet Module (found in ADF 2.7 or above).

	== Disabling the CCAPI for Custom Elements ==		== Disabling the CCAPI for Custom Elements ==