Difference between revisions of "PT Profile Roles"

From ADF Docs
Jump to: navigation, search
(Configuration Points)
(Customizations)
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
== Overview ==
 
== Overview ==
Profile roles are set up through the [[PT_Profile_Site_Configuration|Site Configuration]] and [[ProfileRoles_Component|ProfileRoles Component]].  These roles establish permissions for the profile and determines which subsites and/or templates the profile page will be derived from.  This configuration allows the same profile information to be used for multiple displays throughout the site.
+
Profile roles are set up through the [[PT_Profile_Site_Configuration|Site Configuration]] and [[PT_Profile_Roles_Component|ProfileRoles Component]].  These roles establish permissions for the profile and determines which subsites and/or templates the profile page will be derived from.  This configuration allows the same profile information to be used for multiple displays throughout the site.
  
 
Profile roles will differ depending on the purpose of the application.  For example, if the profiles were implemented in an educational institution, roles could be 'student', 'faculty', and 'staff;' if implemented for healthcare, the roles could be 'doctor', 'surgeon', 'nurse', and 'staff.'
 
Profile roles will differ depending on the purpose of the application.  For example, if the profiles were implemented in an educational institution, roles could be 'student', 'faculty', and 'staff;' if implemented for healthcare, the roles could be 'doctor', 'surgeon', 'nurse', and 'staff.'
  
 
== Customizations ==
 
== Customizations ==
* /SiteName/_cs_apps/config/ptProfile.xml
+
Customizing the profile roles is a valuable piece to the profile applicationFollowing the instructions below to add a new role:
** [[How_to_add_profile_role | Add a new profile role]]
 
** See the [[PT_Profile_Site Configuration|Site Configuration]] for details on updates for additional roles.
 
* [[ProfileRoles_Component|ProfileRoles Component]]
 
* [optional] /ADF/apps/pt_profile/customcf/profile_manager.cfm
 
** Profile Manager script iterates over the profile roles to display what the logged in user has permissions to access/viewTo make a new role render, this needs to be updated manually.
 
 
 
 
 
  
 +
# Update the [[PT_Profile Site_Configuration|Site Configuration]] with the new role.  Add a new tag under the <ROLES> tag with the name of the role.  Next, you'll add the SUBSITE_ID and TEMPLATE_ID tags.
 +
## Populate SUBSITE_ID by creating a new subsite for the profile pages and update the ID in the configuration file.  See the [[PT_Profile Subsites|Subsites]] wiki page for additional details.
 +
## Populate TEMPLATE_ID by creating a new template for the profile pages and update the ID in the configuration file.  See the [[PT_Profile_Template|Profile Template]] wiki page for additional details. (Note: This step is optional - you can also use one template for all profile roles.)
 +
# Depending on the complexity of your roles and how many sites are implementing the profile app, you can either update the [[PT_Profile_Roles_Component|ProfileRoles Component]] with the new roles.
 +
## Copy the [[PT_Profile_Roles_Component|ProfileRoles Component]] component from the ADF apps directory to your local site components directory ''/MySite/_cs_apps/pt_profile/components/profileRoles.cfc''.
 +
## In the ''setRolePermission'' function, add a new case statement for the role name.  Add your logic to set the roles permmission.
 +
# /ADF/apps/pt_profile/datasheet-modules/datasheet-action-edit-delete-view.cfm
 +
## The datasheet action column will render a view button for the profile page.  This needs to be setup based on the profile role.  Update the top of the script to set the profile role to use as the view button.
  
 
[[Category:Profile]]
 
[[Category:Profile]]
 
[[Category:Customization]]
 
[[Category:Customization]]

Latest revision as of 19:56, 23 April 2010

Overview

Profile roles are set up through the Site Configuration and ProfileRoles Component. These roles establish permissions for the profile and determines which subsites and/or templates the profile page will be derived from. This configuration allows the same profile information to be used for multiple displays throughout the site.

Profile roles will differ depending on the purpose of the application. For example, if the profiles were implemented in an educational institution, roles could be 'student', 'faculty', and 'staff;' if implemented for healthcare, the roles could be 'doctor', 'surgeon', 'nurse', and 'staff.'

Customizations

Customizing the profile roles is a valuable piece to the profile application. Following the instructions below to add a new role:

  1. Update the Site Configuration with the new role. Add a new tag under the <ROLES> tag with the name of the role. Next, you'll add the SUBSITE_ID and TEMPLATE_ID tags.
    1. Populate SUBSITE_ID by creating a new subsite for the profile pages and update the ID in the configuration file. See the Subsites wiki page for additional details.
    2. Populate TEMPLATE_ID by creating a new template for the profile pages and update the ID in the configuration file. See the Profile Template wiki page for additional details. (Note: This step is optional - you can also use one template for all profile roles.)
  2. Depending on the complexity of your roles and how many sites are implementing the profile app, you can either update the ProfileRoles Component with the new roles.
    1. Copy the ProfileRoles Component component from the ADF apps directory to your local site components directory /MySite/_cs_apps/pt_profile/components/profileRoles.cfc.
    2. In the setRolePermission function, add a new case statement for the role name. Add your logic to set the roles permmission.
  3. /ADF/apps/pt_profile/datasheet-modules/datasheet-action-edit-delete-view.cfm
    1. The datasheet action column will render a view button for the profile page. This needs to be setup based on the profile role. Update the top of the script to set the profile role to use as the view button.