Difference between revisions of "Profiles Overview"

From ADF Docs
Jump to: navigation, search
(→‎About Profile App)
 
(63 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
==Documentation ERRORS==
 
−
* If you change the Role in the ptProfile.xml file - you need to change the setRolePermission() function in profileRoles.cfc to have the correct permissions for the new role
 
−
* The profile links (in the top right of the Profile Page) don't work because <DASHBOARD_URL> is not defined in the config struct
 
−
 
 
== About Profile App ==
 
== About Profile App ==
 
The Profile application is built in the [[Overview|Application Development Framework (ADF)]].
 
The Profile application is built in the [[Overview|Application Development Framework (ADF)]].
−
* License Agreement
+
 
 +
== Overview ==
 +
The profile application provides the functionality to allow users to manage and share their information throughout the site.  A profile page provides the user with a unique page URL that can be shared.  The users can manage their profile pages and edit their information through a profile dashboard page.  Users profile information can be connected and synchronized to an external data source.  Profiles can be configured to allow multiple roles and profile pages in multiple subsites and derived from multiple templates.
  
 
== Requirements ==
 
== Requirements ==
−
ADF Library components that are required for the Profile:
+
The ADF must be configured correctly for your site. The [[Site Configuration (ADF.cfc)]] wiki page has instructions for configuration.
−
* CEData_1_0
 
−
* CSData_1_0
 
−
* Scripts_1_0
 
−
* CCAPI
 
  
−
ADF must be configured correctly for your site. [[Site Configuration|Site Configuration]] has instructions for configuration.
+
== Download ==
 +
Download the Profile Application from the [http://community.paperthin.com/projects/pt_profile/index.cfm Community Site Project] or from the SVN Repository.
  
 
== Contents ==
 
== Contents ==
−
The Profile contains the following:
+
The Profile application contains the following:
 
* Custom Coding - various components and scripts.
 
* Custom Coding - various components and scripts.
 
* CommonSpot Components:
 
* CommonSpot Components:
Line 23: Line 18:
 
** [[Profiles_Metadata_Form|Profiles]] - Metadata Form
 
** [[Profiles_Metadata_Form|Profiles]] - Metadata Form
  
−
Note: Elements may contain 1 or more: Render Handlers or Custom Field Types. It does NOT use Display Templates.
+
'Note:' Elements may contain one or more: Render Handlers or Custom Field Types. They do NOT use Display Templates.
  
 
== Pre-installation Considerations ==
 
== Pre-installation Considerations ==
−
[[Application Development Framework (ADF)|Overview]] must be setup and configured on the server for the site that will be implementing the Profile application.  For detailed instructions follow the [[Application Development Framework (ADF)|Application Development Framework (ADF)]] wiki page for Site Configurations.
+
[[Overview|Application Development Framework (ADF)]] must be setup and configured on the server for the site that will be implementing the Profile application.  For detailed instructions, see the [[Overview|Application Development Framework (ADF)]] wiki page for Site Configurations.
 +
 
 +
This installation guide assumes that you have no Custom Elements/Metadata Forms with the names above.  Before the install, remove any Custom Elements/Metadata Forms with the names listed in the "Contents" section above.  (If you do not remove existing elements with these names, you may have difficulties during the installation.)
 +
 
 +
<!--
 +
== CommonSpot Requirements ==
 +
 
 +
If running on '''CommonSpot 6.2.0''', install the following patches:
 +
* [http://www.paperthin.com/support/knowledgebase/articles/ccapi-metadata.cfm 6.2.0.13]
 +
* [http://www.paperthin.com/support/knowledgebase/articles/ccapi-page-audience.cfm 6.2.0.46]
 +
 
 +
If running on '''CommonSpot 6.1''', install the following patches:
 +
* [http://www.paperthin.com/support/knowledgebase/articles/api-textblock-and-subsite-creation-issues.cfm 6.1.0.49b]
 +
* [http://www.paperthin.com/support/knowledgebase/articles/ccapi-default-filetype.cfm 6.1.0.61]
 +
-->
 +
 
 +
== Installation Guides ==
 +
 
 +
'''Current Release Version:'''
 +
* v3.5:
 +
** [[PT_Profile_v3.5_Release_Notes|Version 3.5 Release Notes]]
 +
** [[PT_Profile_v3.5_Install|Version 3.5 Install Guide]]
 +
** [[PT_Profile_v3.5_Upgrade|Version 3.5 Upgrade Guide]]
 +
<!-- '''IMPORTANT''': The above versions of this application require '''ADF 2.5''' or greater and '''CommonSpot 10.5.2 or 10.6.1''' or greater. -->
 +
 
 +
'''Previous Versions:'''
 +
* v3.4:
 +
** [[PT_Profile_v3.4_Release_Notes|Version 3.4 Release Notes]]
 +
** [[PT_Profile_v3.4_Install|Version 3.4 Install Guide]]
 +
** [[PT_Profile_v3.4_Upgrade|Version 3.4 Upgrade Guide]]
 +
'''IMPORTANT''': The above versions of this application require '''ADF 2.5''' or greater and '''CommonSpot 10.5.2 or 10.6.1''' or greater.
 +
 
 +
* v3.3:
 +
** [[PT_Profile_v3.3_Release_Notes|Version 3.3 Release Notes]]
 +
** [[PT_Profile_v3.3_Install|Version 3.3 Install Guide]]
 +
** [[PT_Profile_v3.3_Upgrade|Version 3.3 Upgrade Guide]]
  
−
This installation guide assumes that you have no Custom Elements/Metadata Forms with the names above. Before the install, be sure to remove any Custom Elements/Metadata Forms with the names contained in the "Contents" section above. If you do not remove existing elements with these names you may have difficulties during the installation.
+
* v3.2:
 +
** [[PT_Profile_v3.2_Release_Notes|Version 3.2 Release Notes]]
 +
** [[PT_Profile_v3.2_Install|Version 3.2 Install Guide]]
 +
** [[PT_Profile_v3.2_Upgrade|Version 3.2 Upgrade Guide]]
  
−
== Installation/Setup ==
+
* v3.1:
−
Each of the following steps should be completed fully and in the order presented.
+
** [[PT_Profile_v3.1_Release_Notes|Version 3.1 Release Notes]]
 +
** [[PT_Profile_v3.1_Install|Version 3.1 Install Guide]]
 +
** [[PT_Profile_v3.1_Upgrade|Version 3.1 Upgrade Guide]]
  
−
* [[ADF Configuration|ADF Configuration]]
+
* v3.0:
−
* [[Extract Profile Application|Extract Profile Application]]
+
** [[PT_Profile_Release_Notes_v3|Release Notes]]
−
* [[Styles|Styles]]
+
** [[PT_Profile_Install_v3|Install Guide]]
−
* [[Import CommonSpot Components|Import CommonSpot Components]]
+
** [[PT_Profile_Upgrade_v3|Upgrade Guide]]
−
* [[Site Configuration|Site Configuration]]
+
 
−
* [[CCAPI Setup|CCAPI Setup]]
+
* v2.1:
−
* [[Build CommonSpot Templates/Pages|Build CommonSpot Templates/Pages]]
+
** [[PT_Profile_Version_2.1_Release_Notes|Release Notes]]
 +
** [[PT_Profile_Version_2.1_Install|Install Guide]]
 +
** [[PT_Profile_Version_2.1_Upgrade|Upgrade Guide]]
 +
 
 +
* v2.0:
 +
** [[PT_Profile_Version_2.0_Install|Version 2.0 Install Guide]]
 +
** [[PT_Profile_Version_2.0_Upgrade|Version 2.0 Upgrade Guide]]
 +
 
 +
* v1.0
 +
** [[PT_Profile_Version_1.0_Install|Install Guide]]
 +
 
 +
<!--
 +
Current Development Builds v3.1:
 +
* [[PT_Profile_Release_Notes_v3.1|Release Notes]]
 +
* [[PT_Profile_Install_v3.1|Install Guide]]
 +
* [[PT_Profile_Upgrade_v3.1|Upgrade Guide]]
 +
-->
 +
 
 +
== Getting Started ==
 +
The installation has been completed and you are ready to start creating profiles.
 +
 
 +
# Navigate to the Profile Dashboard page and click the "Click Here, to create a profile" link.
 +
# In the profile form userid field, enter the CommonSpot username that you logged into the site.  Completed the rest of the form with your bio information.  Submit the form once complete.
 +
# This will create your profile and after the Profile Dashboard page refreshes you'll see your profile info with link to edit and a link to view your profile page.
  
 
== Features ==
 
== Features ==
−
The profile application will provide the following list of features:
+
The profile application provides the following features:
  
−
* [[Lightbox|Lightbox]]
+
* [[PT_Profile_Roles|Profile Roles]]
−
* [[Profile Roles|Profile Roles]]
+
* [[PT_Profile_Multiple_Subsites|Multiple Subsites]]
−
* [[Multiple Profile Pages|Multiple Profile Pages]]
+
* [[PT_Profile_Multiple_Templates|Multiple Templates]]
−
* [[Multiple Page Templates|Multiple Page Templates]]
+
* [[PT Profile Gallery|Gallery]]
−
* [[Profile Select|Profile Select]]
+
* [[PT_Profile_Extended_Elements|Extended Profile Elements]]
−
* [[Extended Profile Elements|Extended Profile Elements]]
+
* [[PT_Profile_Authorized_Admins|Authorized Administrators]]
−
* [[Authorized Administrators|Authorized Administrators]]
+
* [[PT_Profile_Auto Create|Auto Create]]
−
* [[Auto Create|Auto Create]]
+
* [[PT_Profile_Bulk Creation/Update|Bulk Creation/Update]]
−
* [[Bulk Creation/Update|Bulk Creation/Update]]
+
* [[PT_Profile_Hooks to Photo Gallery App|Hooks to Photo Gallery App]]
−
* [[Hooks to Photo Gallery App|Hooks to Photo Gallery App]]
+
* [[PT_Profile_Schedule_Bulk_Update|Nightly Scheduled Job Import/Update]]
  
−
== Guides ==
+
== Known Issues/Bugs ==
−
* [[How_to_add_profile_role|How to add a new profile role]]
+
Found a bug, view the [[Known_PT_Profile_Issues|Known Issues/Bugs]] wiki page.  Your issue not on the list?  Then post it so the issue can be addressed.
  
−
== Known Issues/Bugs ==
+
[[Category:Project]][[Category:Profile]]
−
Found a bug, view the [[Known_Issues_Bugs|Known Issues/Bugs]] wiki page.  Your issue not on the list?  Then post it so the issue can be addressed.
 

Latest revision as of 23:26, 17 February 2022

About Profile App

The Profile application is built in the Application Development Framework (ADF).

Overview

The profile application provides the functionality to allow users to manage and share their information throughout the site. A profile page provides the user with a unique page URL that can be shared. The users can manage their profile pages and edit their information through a profile dashboard page. Users profile information can be connected and synchronized to an external data source. Profiles can be configured to allow multiple roles and profile pages in multiple subsites and derived from multiple templates.

Requirements

The ADF must be configured correctly for your site. The Site Configuration (ADF.cfc) wiki page has instructions for configuration.

Download

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

Contents

The Profile application contains the following:

  • Custom Coding - various components and scripts.
  • CommonSpot Components:

'Note:' Elements may contain one or more: Render Handlers or Custom Field Types. They do NOT use Display Templates.

Pre-installation Considerations

Application Development Framework (ADF) must be setup and configured on the server for the site that will be implementing the Profile application. For detailed instructions, see the Application Development Framework (ADF) wiki page for Site Configurations.

This installation guide assumes that you have no Custom Elements/Metadata Forms with the names above. Before the install, remove any Custom Elements/Metadata Forms with the names listed in the "Contents" section above. (If you do not remove existing elements with these names, you may have difficulties during the installation.)


Installation Guides

Current Release Version:

Previous Versions: 

IMPORTANT: The above versions of this application require ADF 2.5 or greater and CommonSpot 10.5.2 or 10.6.1 or greater.


Getting Started

The installation has been completed and you are ready to start creating profiles.

  1. Navigate to the Profile Dashboard page and click the "Click Here, to create a profile" link.
  2. In the profile form userid field, enter the CommonSpot username that you logged into the site. Completed the rest of the form with your bio information. Submit the form once complete.
  3. This will create your profile and after the Profile Dashboard page refreshes you'll see your profile info with link to edit and a link to view your profile page.

Features

The profile application provides the following features:

Known Issues/Bugs

Found a bug, view the Known Issues/Bugs wiki page. Your issue not on the list? Then post it so the issue can be addressed.

Retrieved from "http://community.paperthin.com/adf-docs/index.php?title=Profiles_Overview&oldid=7911"