Difference between revisions of "PT Profile v2 Install"

From ADF Docs
Jump to: navigation, search
(Import Elements)
(Site Configuration)
Line 50: Line 50:
  
 
== Site Configuration ==
 
== Site Configuration ==
 +
The Profile Application uses an XML file to manage the site specific configurations.  The Profile Application needs to know what the profile element name, unique field, roles, subsite ids, and template ids for the site.
  
 +
The fields for the Profile Configuration custom element are defined below.
  
=== Configuration Fields ===
+
=== Steps ===
 +
To allow each site to have its own configuration for the Profile:
 +
* Locate the ''/_cs_apps'' directory in your site.  If a ''/_cs_apps/config/'' directory does not exists, then create the directory.
 +
* Place a file in this directory called "ptProfile.xml".  This file can be found in the ''/pt_profile/site-files/_cs_apps/config/ptProfile.xml''.
 +
* Verify the tag field data with the descriptions of the tags below.
 +
* We will come back to this configuration file later to populate the data.
  
 +
=== XML Tags ===
 +
The following are the tags of the Profile XML Config file:
 +
# '''CE_NAME''' - The profile custom element name within the site.
 +
# '''CE_ID_FIELD''' - The field ID within the profile custom element that stores the username.
 +
# '''ROLES''' - structure identifies the roles available to the profile element for the site.  Each role sub tag is the name of the role throughout the site.
 +
## '''SUBSITE_ID''' - Specifies the subsite ID that profile pages for the role will be created in.
 +
## '''TEMPLATE_ID''' - Specifies the template ID that profile pages for the role will be created with.
 +
# '''ADD_URL''' - Site relative URL for the Profile Add page.
 +
# '''DELETE_URL''' - Site relative URL for the Profile Delete page.
 +
# '''DASHBOARD_URL''' - Site relative URL for the Profile Dashboard page.
 +
# '''LB_WIDTH''' - Width for the profile edit form lightbox.
 +
# '''LB_HEIGHT''' - Height for the profile edit form lightbox.
 +
# '''JQUERY_UI_THEME''' - JQuery UI Theme to use throughout the application.
  
 
== Subsites ==
 
== Subsites ==

Revision as of 15:48, 23 October 2011

Extract Photo Gallery Application

Download the Profile Application from the Community Site Project or from the SVN Repository.

Extract the zip files into the following directory: /ADF/apps/pt_profile/

ADF Configuration

The Profile Application is built within the ADF. The ADF must be installed in the site to run the Profile Application, follow the ADF Installation instructions.

  • Open the sites 'ADF.cfc' ( See Site Configuration (ADF.cfc) for more details) file (/_cs_apps/ADF.cfc) 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:
loadApp("ptProfile");

Import Elements

The Profile App has several Custom Components defined within CommonSpot. These components are available in the Profiles's "exported-objects" folder located at the root of the Profile application directory (e.g. /ADF/apps/pt_profile/exported-objects/)

Optional: You may want to create a new category within the CommonSpot Element Gallery for 'PT Profile 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:

  1. Profile (Profile-Custom-Element.zip)
  2. Profile Gallery (Profile-Gallery-Custom-Element.zip)

Import Metadata form:

  1. Profiles (profiles-Metadata-Form.zip)

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 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. After reassigning the field type, delete the new imported field from the list of custom field types.

Security Settings

During the import, field permissions may have been cleared or assigned to an unknown group. The following custom element and metadata form fields should have explicit security settings:

  • Profile Custom Element
    • User ID - Field has Read/Edit permissions to the Site Administrators group. Read permissions for Anonymous and Authenticated Users groups.
  • Profiles Metadata Form (the metadata form will need to be unlocked to change the field security settings)
    • Type - Field has Read permissions to the Site Administrators group.
    • User ID - Field has Read permissions to the Site Administrators group.
    • UniqueID - Field has Read permissions to the Site Administrators group.

For additional details on field security, view the Profile Element and Profiles Metadata Form wiki pages.

Site Configuration

The Profile Application uses an XML file to manage the site specific configurations. The Profile Application needs to know what the profile element name, unique field, roles, subsite ids, and template ids for the site.

The fields for the Profile Configuration custom element are defined below.

Steps

To allow each site to have its own configuration for the Profile:

  • Locate the /_cs_apps directory in your site. If a /_cs_apps/config/ directory does not exists, then create the directory.
  • Place a file in this directory called "ptProfile.xml". This file can be found in the /pt_profile/site-files/_cs_apps/config/ptProfile.xml.
  • Verify the tag field data with the descriptions of the tags below.
  • We will come back to this configuration file later to populate the data.

XML Tags

The following are the tags of the Profile XML Config file:

  1. CE_NAME - The profile custom element name within the site.
  2. CE_ID_FIELD - The field ID within the profile custom element that stores the username.
  3. ROLES - structure identifies the roles available to the profile element for the site. Each role sub tag is the name of the role throughout the site.
    1. SUBSITE_ID - Specifies the subsite ID that profile pages for the role will be created in.
    2. TEMPLATE_ID - Specifies the template ID that profile pages for the role will be created with.
  4. ADD_URL - Site relative URL for the Profile Add page.
  5. DELETE_URL - Site relative URL for the Profile Delete page.
  6. DASHBOARD_URL - Site relative URL for the Profile Dashboard page.
  7. LB_WIDTH - Width for the profile edit form lightbox.
  8. LB_HEIGHT - Height for the profile edit form lightbox.
  9. JQUERY_UI_THEME - JQuery UI Theme to use throughout the application.

Subsites

Web Admin

  1. Create a new subsite under the site root called webadmin.
  2. Create a new subsite under /webadmin/ called profiles.
  3. Configure the /webadmin/profiles/ subsite Content Security to give 'No Rights' to 'Anonymous Users' and 'Authenticated Users'.
  4. Configure the /webadmin/profiles/ subsite Content Security to give permissions to the group of administrators who will manage the Photos.
  5. Create a new subsite under /webadmin/profiles/ called forms.

CCAPI

Setup

  1. Create a new page called 'ccapi' under the root subsite and from the base plus one template. When creating the page, disable the standard metadata 'Include In' fields for 'Page Indexes' and 'Full Text and Search Element Results'. This page may already exist within your site, if it does, then continue to the next steps.


Configuration

Photo Upload

Photo Display

Update Photo Gallery Site Config

Photo Admin Manager

Photo Admin Datasheet

Photo Category Admin Datasheet

Photo Size Admin Datasheet

Reset the ADF

Reset the ADF for the server and site.