OHSU Navigation Install v1.0 - Revision history

Gcronkright: /* Site Configuration */

2016-05-06T21:54:35Z

‎Site Configuration

Mcarroll: /* CCAPI Configuration */

2012-09-05T20:30:46Z

‎CCAPI Configuration

Mcarroll: /* Reset the ADF */

2012-09-05T18:43:16Z

‎Reset the ADF

Mcarroll: /* Navigation Configuration */

2012-09-05T18:42:49Z

‎Navigation Configuration

Mcarroll: /* Management Page */

2012-09-05T18:42:36Z

‎Management Page

Mcarroll: /* Configuration Page */

2012-09-05T18:41:59Z

‎Configuration Page

Mcarroll: /* CCAPI Configuration */

2012-09-05T18:41:27Z

‎CCAPI Configuration

Mcarroll: /* Import Custom Elements */

2012-09-05T18:38:51Z

‎Import Custom Elements

Mcarroll: Created page with '== Download == Download the OHSU Navigation Application from the [http://community.paperthin.com/projects/ohsu_navigation/ Community Site] or from the SVN Repository. Extract …'

2012-09-05T18:35:53Z

Created page with '== Download == Download the OHSU Navigation Application from the [http://community.paperthin.com/projects/ohsu_navigation/ Community Site] or from the SVN Repository. Extract …'

New page

== Download ==
Download the OHSU Navigation Application from the [http://community.paperthin.com/projects/ohsu_navigation/ Community Site] or from the SVN Repository.

Extract the zip files into the following directory:
'''/ADF/apps/ohsu_nav/'''

== Site Configuration ==
The OHSU Navigation Application is built within the ADF. The ADF must be installed in the site to run the OHSU Nav, follow the ADF [[Installation]] instructions.

* Make sure the ADF is setup and running on the site. If the ADF is not setup, then follow the instructions for ADF [[Installation]].
* Open the sites 'ADF.cfc' ([[Site Configuration (ADF.cfc)|See Site Configuration (ADF.cfc) for more info]]) file (located in your site's /_cs_apps/ directory) in a text editor. Locate the ''Load the ADF Application into application space'' comment in the file. Add (or uncomment) the following command under the comment section:
<source lang="java">
loadApp("ohsuNav");
</source>
* [[Reset ADF|Reset the ADF]] for the server and site.

== Import Custom Elements ==
The OHSU Navigation Application has a couple Custom Components defined within CommonSpot. The components have been exported and are available in the OHSU Navigation's "exported-objects" folder located at the root of the OHSU Nav application directory (e.g. /ADF/apps/ohsu_nav/exported-objects/)

Optional: You may want to create a new category within the CommonSpot Element Gallery for 'OHSU Navigation Elements'.

To import these objects, you will need to be an administrator for your site. If you are not a site administrator, consult your Server administrator for more information

=== Import ===

Import Custom Elements in this order:

# Photo (Photo-Custom-Element.zip)
# Photo Category (Photo-Category-Custom-Element.zip)
# Photo Size (Photo-Size-Custom-Element.zip)
# Photo Gallery (Photo-Gallery-Custom-Element.zip)
# PTPhotoGallery Configuration (PTPhotoGallery-Configuration-Custom-Element.zip)

Import Metadata form:

# PhotoSizeRender (PhotoSizeRender-Metadata-Form.zip)
## Bind this form to the following Photo Gallery Render Handler
### Cycle
### Cycle Thumb Nav
### Grid

=== Verify Imports ===

The imported components' render handlers and custom field types must be verified. During the import process, the render handler and custom field types paths may have been changed to reflect the current site's path.

Review and update these paths to reference the ADF path. In most cases, this will just require to be unlocked and a change in the path from the site name to 'ADF'. Check the paths for the [[PT_Photo_Gallery_Overview#Contents|custom field types that were imported]] with the custom elements by unlocking them and fixing the explicit paths to point to "/ADF/extensions/".

If the custom elements that are imported contain custom field types that are already in the site, the naming convention for the custom field type will be unique. To resolve this, unlock the field types and elements, and reassign the element field type to the pre-existing field type.

Example: The Photo Category custom element contains two uses of the General Chooser field type, if the General Chooser field type is already installed on the site then the import process will attempt to import another General Chooser but with a new name such as "General Chooser_import_1250003208472." To resolve this issue, open the custom element and assign the field type (General Chooser_import_1250003208472) to the field type with the simple name General Chooser. Note that when you assign the existing general chooser you will need to click on the "properties" tab and enter "photoSizeGC" as the bean name. After reassigning the field type, delete the new imported field from the list of custom field types.

== Subsites ==
It is '''highly recommended''' that a Navigation webadmin subsite is created for Administrators. This configuration allows subsite security to be used to allow only Administrators access to the webadmin subsite. A ''forms'' subsite is also created to store the pages for the administrator forms.

Your site may already have a ''webadmin'' subsite. The steps below will add a ''navigation'' subsite under the ''webadmin'' subsite.

=== Web Admin ===
# Create a new subsite under the site root called ''webadmin''.
# Create a new subsite under ''webadmin'' called ''navigation''.
# Configure the ''/webadmin/navigation/'' subsite Content Security to give 'No Rights' to 'Anonymous Users' and 'Authenticated Users'.
# Configure the ''/webadmin/navigation/'' subsite Content Security to give permissions to the group of administrators who will manage the Photos.

== CCAPI Configuration ==

== Configuration Page ==

== Reset the ADF ==
[[Reset ADF|Reset the ADF]] for the server and site.

[[Category:Photo Gallery]]

@@ Line 48: / Line 48: @@
 First, follow the steps to set up the [[CCAPI Config|CCAPI Config]] file for the site.  Once that configuration is complete, follow the steps below to set up the CCAPI config for the Photo Gallery application.  Make sure to update the ''wsVars'' section with the correct URLs and username/password.
-# Create a new page called 'ccapiNav'. Recommend creating this page in the ''/webadmin/navigation/'' subsite.
+# Create a new page called 'ccapiNav'. Recommend creating this page in the root subsite.
 # Add the 'Nav Element' element to the page.
 # Select the 'Photo' element indicator and go to 'more...'.  Select 'Name' from the menu.

← Older revision		Revision as of 18:43, 5 September 2012
Line 122:		Line 122:

	[[Category: OHSU Navigation]]		[[Category: OHSU Navigation]]
		+
		+	== Navigation Custom Field Type ==
		+	* Create a Metadata form called Navigation (or use an existing metadata form)
		+	* Add a Field called "Navigation" using the "Navigation" field type
		+	* Bind the Metadata field to your Base Template

	== Reset the ADF ==		== Reset the ADF ==

@@ Line 94: / Line 94: @@
 * Publish page
-== Navigation Configuration ==
+== Navigation Element Configuration ==
 === Option 1: Add directly to Base Template ===

@@ Line 93: / Line 93: @@
 * Add edit/delete action columns
 * Publish page
 == Reset the ADF ==

← Older revision		Revision as of 18:41, 5 September 2012
Line 44:		Line 44:

	== CCAPI Configuration ==		== CCAPI Configuration ==
		+	The Photo Gallery Application uses the [[CCAPI\|ADF CCAPI]] to populate profile records and create profile pages. The CCAPI needs to be configured for the site and photo gallery application.
		+
		+	First, follow the steps to set up the [[CCAPI Config\|CCAPI Config]] file for the site. Once that configuration is complete, follow the steps below to set up the CCAPI config for the Photo Gallery application. Make sure to update the ''wsVars'' section with the correct URLs and username/password.
		+
		+	# Create a new page called 'ccapiNav'. Recommend creating this page in the ''/webadmin/navigation/'' subsite.
		+	# Add the 'Nav Element' element to the page.
		+	# Select the 'Photo' element indicator and go to 'more...'. Select 'Name' from the menu.
		+	# In the Element Name field, enter the text 'navElement'.
		+	# Publish this page and view in read mode.
		+	# Edit the 'ccapi.xml' file for the site and add the following xml block into the <elements> section:
		+	<source lang="xml">
		+	<navigation>
		+	<pageID>#####</pageID>
		+	<subsiteID>##</subsiteID>
		+	<elementType>custom</elementType>
		+	<controlName>navElement</controlName>
		+	</navigation>
		+	</source>
		+
		+	To populate the <pageID> and <subsiteID> tags, view the source code for the 'ccapiPhoto' page that was just created.
		+
		+	Identify the following line in the source code and enter this numeric value into the <subsiteID> tag:
		+	<source lang="java">
		+	var jsSubSiteID = ##;
		+	</source>
		+
		+	Identify the following line in the source code and enter this numeric value into the <pageID> tag:
		+	<source lang="java">
		+	var jsPageID = ####;
		+	</source>
		+
		+	[[Reset ADF\|Reset the ADF]] for the server and site.

−
	== Configuration Page ==		== Configuration Page ==

@@ Line 10: / Line 10: @@
 * Make sure the ADF is setup and running on the site. If the ADF is not setup, then follow the instructions for ADF [[Installation]].
 * Open the sites 'ADF.cfc' ([[Site Configuration (ADF.cfc)|See Site Configuration (ADF.cfc) for more info]]) file (located in your site's /_cs_apps/ directory) in a text editor. Locate the ''Load the ADF Application into application space'' comment in the file. Add (or uncomment) the following command under the comment section:
-<source lang="java">
-loadApp("ohsuNav");
+ loadApp("ohsuNav");
-</source>
 * [[Reset ADF|Reset the ADF]] for the server and site.

@@ Line 77: / Line 77: @@
 [[Reset ADF|Reset the ADF]] for the server and site.
-== Configuration Page ==
+== Management Page ==
 == Reset the ADF ==

@@ Line 24: / Line 24: @@
 === Import ===
-Import Custom Elements in this order:
+Import Custom Element:
-# Photo (Photo-Custom-Element.zip)
+# Nav Element (Nav-Element-Custom-Element.zip)
-Import Metadata form:
+Import the Custom Field Type:
-# PhotoSizeRender (PhotoSizeRender-Metadata-Form.zip)
+# Navigation (Navigation-Custom-Field-Type.zip)
 == Subsites ==