PT Multimedia Version 1.0 Install

Download

Download the PT Multimedia Application from the Community Site or from the SVN Repository.

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

Site Configuration

The application is built within the ADF. The ADF must be installed in the site to run the application, 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' (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:

loadApp("ptMultimedia");

• Reset the ADF for the server and site.

Styles

The application ships with a style sheet to insure proper display of your multimedia. The styles are defined in the following style sheet located in the /pt_multimedia/style/ directory:

• ptmultimedia.css (/ADF/apps/pt_multimedia/style/ptmultimedia.css)

The recommended approach is to load this style sheet into your Base Plus One Template.

'Note:' the classes and styles defined for the Multimedia application are targeted tightly for the layout generated by the Multimedia application and should not interfere with your site styles. However, it is a good idea to give these styles sheets higher precedence in your style definitions.

Import Custom Elements

Create Custom Category

1. Go to Site Administration
2. Expand "Elements and Forms"
3. Click Elements
4. Select Manage Categories
5. "Add New Category"
6. Name the category: "PT Multimedia Elements"

Import

Import Custom Elements in this order:

1. Multimedia Category (Multimedia-Category -Custom-Element.zip)
2. Multimedia Category Gallery (Multimedia-Category –Gallery-Custom-Element.zip)
3. Multimedia (Multimedia- Custom-Element.zip)
4. Multimedia Series (Multimedia-Series -Custom-Element.zip)
5. Multimedia Series Gallery (Multimedia-Series -Gallery-Custom-Element.zip)
6. Multimedia Configuration (PT Multimedia -Configuration-Custom-Element.zip)

Import Metadata form:

1. Multimedia Display Format (MultimediaDisplayFormat -Metadata-Form.zip)
   1. Bind this form to the following Multimedia Render Handler
      1. Multimedia
      2. Multimedia Search Results

Import Custom fields:

1. Import media host select custom field (Media-Host-Select-Field-Custom-Field.zip)
2. import media type select custom field (Media-Type-Select-Field-Custom-Field-Type.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 the imported item 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/apps/ptMultimedia/customfields /".

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 Multimedia 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 "mediaCategoryGC" as the bean name. After reassigning the field type, delete the new imported field from the list of custom field types.

Site Configuration

The Multimedia App uses a custom element to store site specific configurations. The Multimedia App needs to know the upload URL, pop-up player URL, etc for the site.

If you are installing the Multimedia application, there is no need to do anything with this element at this time. This element will be configured in a later step.

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

Configuration Fields

There are six major components to the configuration:

1. UPLOAD_PATH – Directory where media is uploaded. (Example: C:/wwwroot/mysite/mediauploads/)
2. UPLOAD _FILE_TYPES – Supported multimedia files. (Example: mp3,flv,mp4)
3. MAXFILESIZE – Selection list limiting maximum upload size.
4. UPLOAD_URL – URL Path on the server to store uploaded media. (Example: /mediauploads)
5. ADD_URL - URL to the location of the media add page. (Example: /mysite/lightbox/multimedia/Media-Add.cfm)
6. UPLOADMEDIAFORM – URL to the location of the handle media upload page. (Example: / mysite /lightbox/multimedia/handle-media-upload.cfm)
7. POPUPPLAYERURL - URL to the location of the lightbox player page. (Example: /mysite /lightbox/multimedia/popUpPlayer.cfm)
8. SEARCHRESULTS - URL to the location of the “All Media” display results page. (Example: / mysite /Multimedia-Search-Results.cfm )

Subsites

It is highly recommended that a Multimedia webadmin subsite is created for Administrators and a Multimedia Lightbox subsite is created for the lightbox pages. This configuration allows subsite security to be used to allow only Administrators access to the webadmin subsite and also allows the Commonspot toolbar to be turned off for the lightbox pages.

Your site may already have a webadmin and/or lightbox subsite. The steps below will add a multimedia subsite under the webadmin subsite and will add a lightbox subsite.

Web Admin

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

Lightbox

1. Create a new subsite under the site root called lightbox.
2. Create a new subsite under lightbox called multimedia.

Lightbox Template

The Lightbox template will be used to render pages within a lightbox. The Lightbox template may already exist on your site if you have installed another ADF application. Check your sites templates before following the steps below to create the template.

Steps

1. Create a new page named Lightbox Template from the blank template.
2. Submit and activate the page.
3. Save the page as a template.
4. Submit the template for public use.

Reset the ADF

Reset the ADF for the server and site.