PT Calendar Version 4.8 Install - Revision history

Gcronkright at 15:15, 3 June 2025

2025-06-03T15:15:49Z

Gcronkright at 15:11, 3 June 2025

2025-06-03T15:11:08Z

Show changes

Gcronkright at 22:36, 6 February 2025

2025-02-06T22:36:50Z

Gcronkright: /* CCAPI Configuration */

2025-02-05T20:42:38Z

‎CCAPI Configuration

Gcronkright: PT Calendar Version 4.8 Install

2025-01-31T22:11:03Z

PT Calendar Version 4.8 Install

Gcronkright: /* GCE Viewer Page for PT Calendar Details Search Results - Optional */

2025-01-31T18:09:35Z

‎GCE Viewer Page for PT Calendar Details Search Results - Optional

Gcronkright: /* CCAPI Configuration */

2025-01-31T17:52:05Z

‎CCAPI Configuration

Gcronkright: /* CCAPI Configuration */

2025-01-31T17:51:39Z

‎CCAPI Configuration

Gcronkright: /* Import Custom Elements */

2025-01-31T17:35:56Z

‎Import Custom Elements

Gcronkright: /* Import Custom Elements */

2025-01-31T17:35:21Z

‎Import Custom Elements

@@ Line 503: / Line 503: @@
 #Enter the following text into the Explicit Module path:
 #* /ADF/apps/pt_calendar/customcf/manage_events_filtering_tools.cfm
-#Add another Custom Script element to main content container of the page.
+#Add another Custom Script element to the main content container of the page.
 #From the Custom Script element interface, click the "Edit" icon.
 #Enter the following text into the Explicit Module path:
@@ Line 515: / Line 515: @@
 ## Description: View to manage events
 ## Datasheet Source: Form Result/Custom Element Sheet
-# From the Datasheet Source dialog choose the "Calendar Event Details" custom element and click "Next".
+# From the Datasheet Source dialog, choose the "Calendar Event Details" custom element and click "Next".
 # From the Datasheet Columns Dialog select the columns '''UniqueID''', '''Title''', '''EventDateTimeIDList''', '''EventRecurrenceID''', '''Category''', '''Organization''', '''EventApproved''' and '''ApprovalUserID''' from the Available Columns list and move them to the Selected Columns list and then click "Finish".
 # You will be brought to the Datasheet View page; click "Close" to return to your page.
@@ Line 526: / Line 526: @@
 ## Click Finish or Save
 # You will see the datasheet element on this page now. Click the Datasheet element interface icon again and this time choose "Edit Columns".
-#Within the Datasheet View Column Properties dialog choose the '''UniqueID''' column and click "edit":
+#Within the Datasheet View Column Properties dialog, choose the '''UniqueID''' column and click "edit":
 ##In the Render Handler field, select the 'Change' button. Enter the following value into the Explicit Module text box:
 ##*/ADF/apps/pt_calendar/datasheet-modules/event-edit-delete-copy.cfm
@@ Line 532: / Line 532: @@
 ##In the Header field, switch the text to 'Edit/Delete/Copy'
 ##Click Finish or Save
-#Now within the Datasheet View Column Properties dialog choose the '''EventDateTimeIDList''' column and click "edit":
+#Now, within the Datasheet View Column Properties dialog, choose the '''EventDateTimeIDList''' column and click "edit":
 ##In the Render Handler field, select the 'Change' button. Enter the following value into the Explicit Module text box:
 ##*/ADF/apps/pt_calendar/datasheet-modules/convert-id-list-to-date-time-blocks.cfm
@@ Line 538: / Line 538: @@
 ##In the Header field, switch the text to 'Event Dates/Times'
 ##Click Finish or Save
-#Now within the Datasheet View Column Properties dialog choose the '''EventRecurrenceID''' column and click "edit":
+#Now, within the Datasheet View Column Properties dialog, choose the '''EventRecurrenceID''' column and click "edit":
 ##In the Render Handler field, select the 'Change' button. Enter the following value into the Explicit Module text box:
 ##*/ADF/apps/pt_calendar/datasheet-modules/convert-id-list-to-recurrence-properties.cfm
@@ Line 544: / Line 544: @@
 ##In the Header field, switch the text to 'Recurrence Properties'
 ##Click Finish or Save
-#Now within the Datasheet View Column Properties dialog choose the '''Category''' column and click "edit":
+#Now, within the Datasheet View Column Properties dialog, choose the '''Category''' column and click "edit":
 ##In the Render Handler field, select the 'Change' button. Enter the following value into the Explicit Module text box:
 ##*/ADF/apps/pt_calendar/datasheet-modules/convert-id-list-to-cat-names-with-icons.cfm
@@ Line 550: / Line 550: @@
 ##In the Header field, switch the text to 'Categories'
 ##Click Finish or Save
-#Now within the Datasheet View Column Properties dialog choose the '''Organization''' column and click "edit":
+#Now, within the Datasheet View Column Properties dialog, choose the '''Organization''' column and click "edit":
 ##In the Render Handler field, select the 'Change' button. Enter the following value into the Explicit Module text box:
 ##*/ADF/apps/pt_calendar/datasheet-modules/convert-id-list-to-org-names.cfm
@@ Line 556: / Line 556: @@
 ##In the Header field, switch the text to 'Organizations'
 ##Click Finish or Save
-#Now within the Datasheet View Column Properties dialog choose the '''EventApproved''' column and click "edit":
+#Now, within the Datasheet View Column Properties dialog, choose the '''EventApproved''' column and click "edit":
 ##In the Render Handler field, select the 'Change' button. Enter the following value into the Explicit Module text box:
 ##*/ADF/apps/pt_calendar/datasheet-modules/convert-approval-status.cfm
@@ Line 562: / Line 562: @@
 ##In the Header field, switch the text to 'Approval Status'
 ##Click Finish or Save
-#Now within the Datasheet View Column Properties dialog choose the '''AppovalUserID''' column and click "edit":
+#Now, within the Datasheet View Column Properties dialog, choose the '''AppovalUserID''' column and click "edit":
 ##In the Render Handler field, select the 'Change' button. Enter the following value into the Explicit Module text box:
 ##*/ADF/extensions/datasheet-modules/1.0/userID-to-name.cfm
@@ Line 598: / Line 598: @@
 ====Manage Events Filtering Parameters (Optional)====
-The optional Filtering Tools custom script parameters can be used to create a Calendar Events management page that only displays Events from a specific Organization and/or Category and also limits what filtering options are available.
+The optional Filtering Tools custom script parameters can be used to create a Calendar Events management page that only displays Events from a specific Organization and/or Category, and also limits what filtering options are available.
 * "OrganizationName" - Add a valid Organization Name to only show events for a specific organization
@@ Line 651: / Line 651: @@
 ## Description: View to manage All Page Mappings View
 ## Datasheet Source: Form Result/Custom Element Sheet
-# From the Datasheet Source dialog choose the "Calendar Page Mapping" custom element and click "Next".
+# From the Datasheet Source dialog, choose the "Calendar Page Mapping" custom element and click "Next".
-# From the Datasheet View Columns Dialog select the columns '''MapID''', '''Subsite''', '''OrgID''', '''MonthlyGridPage''', '''MonthlyListPage''', '''WeeklyGridPage''', '''WeeklyListPage''', '''DailyPage''' and '''DetailsPage''' from the Available Columns list and move them to the Selected Columns list and then click "Finish".
+# From the Datasheet View Columns Dialog select the columns '''MapID''', '''Subsite''', '''OrgID''', '''MonthlyGridPage''', '''MonthlyListPage''', '''WeeklyGridPage''', '''WeeklyListPage''', '''DailyPage''', and '''DetailsPage''' from the Available Columns list and move them to the Selected Columns list and then click "Finish".
 # You will be brought to the Datasheet View page; click "Close" to return to your page.
 # You will see the datasheet element on this page now. Click the Datasheet element interface icon again and this time choose "Edit Columns".
@@ Line 661: / Line 661: @@
 ##In the Header field, switch the text to 'Edit/Delete'
 ##Click Finish or Save
-#Now within the Datasheet View Column Properties dialog choose the '''Subsite''' column and click "edit":
+#Now, within the Datasheet View Column Properties dialog, choose the '''Subsite''' column and click "edit":
 ##In the Render Handler field, select the 'Change' button. Enter the following value into the Explicit Module text box:
 ##*/ADF/apps/pt_calendar/datasheet-modules/manage-convert-subsiteid-subsiteurl.cfm
 ## Click Finish or Save
-#Now within the Datasheet View Column Properties dialog choose the '''OrgID''' column and click "edit":
+#Now, within the Datasheet View Column Properties dialo,g choose the '''OrgID''' column and click "edit":
 ##In the Render Handler field, select the 'Change' button. Enter the following value into the Explicit Module text box:
 ##*/ADF/apps/pt_calendar/datasheet-modules/convert-id-list-to-org-names.cfm
@@ Line 671: / Line 671: @@
 ## In the Header field, switch the text to 'Organizations'
 ##Click Finish or Save
-#Now within the Datasheet View Column Properties dialog choose the '''MonthlyGridPage''' column and click "edit":
+#No,w within the Datasheet View Column Properties dialo,g choose the '''MonthlyGridPage''' column and click "edit":
 ##In the Render Handler field, select the 'Change' button. Enter the following value into the Explicit Module text box:
 ##*/ADF/extensions/datasheet-modules/1.0/pageID-to-link.cfm
@@ Line 750: / Line 750: @@
 # 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:
+Set up 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)
 ## Page Standard Metadata:
@@ Line 774: / Line 774: @@
 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.
+# 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.
+## 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}

@@ 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 274: / Line 274: @@
 === CCAPI Configuration ===
-  IMPORTANT: The CCAPI CCAPI configuration for custom elements is no longer needed for ADF 2.7 and CommonSpot 11.0 or greater. Skip to the next section.
+  IMPORTANT: The CCAPI configuration is no longer required for CommonSpot 11 and ADF 2.7 or greater. Please skip to the next section.
-With the release of CommonSpot 11 and ADF 2.7, this app now uses the new ceRecordAPI to save data to Custom Elements. Using the CCAPI with CommonSpot 11.0 is still available but using the ceRecordAPI instead is highly recommended.
+With the release of CommonSpot 11.0 and ADF 2.7, this app now uses the ADF's ceRecordAPI wrapper functions for the CommonSpot Custom Data API to add or update Custom Elements data.
-  If you are using this app with CommonSpot 10.9.1 or 10.8.3, please continue with the following CCAPI Configuration steps:
+  Note: If you are using this app with CommonSpot 10.9.1 or 10.8.3 or below, please continue with the following CCAPI Configuration steps:
 The Calendar Application uses the [[CCAPI_Library_Component|ADF CCAPI]] to populate and modify the calendar app element records. The CCAPI needs to be configured to handle this calendar functionality.

@@ 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 743: / Line 743: @@
 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 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
+## 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.
+# 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)
-##Page Standard Metadata:
+## Page Standard Metadata:
-###Name: calendar-event-details-forwarder
+### Name: calendar-event-details-forwarder
-###CommonSpot Title: Calendar Event Details Select
+### CommonSpot Title: Calendar Event Details Select
-###Page Title: Calendar Event Details Select
+### Page Title: Calendar Event Details Select
-###Description: A calendar event details select list or redirect page
+### Description: A calendar event details select list or redirect page
-###Uncheck “Page Index”
+### Uncheck “Page Index”
-###Uncheck “Full Text and Search Element Results”
+### Uncheck “Full Text and Search Element Results”
-###Click Next
+### Click Next
-##Set applicable “custom properties” for this new page
+## Set applicable “custom properties” for this new page
-###Click Save
+### Click Save
-#On the newly created page insert the “Calendar Event Details” Global Custom Element in the main content area container
+# 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:
+## 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)
+### One Record - Base on URL (Developer Use)
-###Click Save
+### Click Save
-##Then from the element indicator icon for the “Calendar Event Details” Global Custom Element click on the Custom icon:
+## 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.
+### 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
+### Click Save
-##Publish this page.
+## 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.
+# 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.
+## From the pencil icon select the “View Page & Search Properties” menu item.
-###Set the following settings
+### Set the following settings
-####Element Viewing Page: {select the ‘Calendar Event Details Select’ page you just created}
+#### Element Viewing Page: {select the ‘Calendar Event Details Select’ page you just created}
-####Title: Events Title
+#### Title: Events Title
-####Description: Description
+#### Description: Description
-####Enable full-text indexing: X - checked
+#### Enable full-text indexing: X - checked
-####Full-Text Collection: {select the collection where calendar details data should be indexed.}
+#### Full-Text Collection: {select the collection where calendar details data should be indexed.}
-###Click Save
+### 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.
+# 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).

@@ Line 51: / Line 51: @@
 #[[Calendar Organizations]] (Calendar-Organizations-Custom-Element.zip)
 #[[Calendar Event Recurrence]] (Calendar-Event-Recurrence-Custom-Element.zip)*
-## *If importing this CE in to CS 10.9.x or below, use the .zip archive in the 'pt_calendar/exported-objects/cs10.9 and below/' direcotry.
+## *If importing this CE in to CS 10.9.x or below, use the .zip archive in the 'pt_calendar/exported-objects/cs10.9 and below/' directory.
 #[[Calendar Event Details]] (Calendar-Event-Details-Custom-Element.zip)
 #[[Calendar Event DateTime]] (Calendar-Event-DateTime-Custom-Element.zip)