imported>Jason.nicholls: 1 revision

2015-04-30T11:18:24Z

1 revision

← Older revision	Revision as of 11:18, 30 April 2015
(No difference)

imported>Jason.nicholls: 1 revision

2014-07-10T05:09:00Z

1 revision

New page

[[Category:enPortal 5.6]]
{{DISPLAYTITLE:Creating Application-Specific Channels}}

__TOC__

This section details how to create and maintain channels associated with a specific application.



 
==Application Directory Conventions==
 

'''Channel Packages''', '''Applications''', '''Channel Builders''', and '''Channels''' for an '''Application''' all have representation within the virtual directory. While Channels and Channel Builders are actual objects in the virtual
directory, the Channel Packages and Applications have home folders in the virtual directory where their
associated components are stored by convention.
 
The following conventions are used for naming and storing system components:
 
:* Channel Packages have home folders under the <tt>/channelpackages</tt> folder:
::* '''Packages''' are named <tt>company.product_pim</tt> by convention, such as <tt>edge.nvision_pim</tt>.
::* The periods in the package names translate to slashes ("/") in the folder structure, so <tt>edge.nvision_pim</tt> would map to <tt>/channelpackages/edge/nvision_pim</tt>.
::* Most PIMs have a version associated with the name as an appended letter, such as <tt>edge.nvision_pimC</tt>.
:* Applications have home folders under their respective Packages home folders.
:* The folder name is the name associated with the Application when created.
:* For Application named <tt>ServerA</tt> for the Package <tt>edge.nvision_pimC</tt>, the home folder would be <tt>/channelpackages/edge/nvision_pimC/ServerA</tt>.
:* The Application home folder holds '''Channels''' created for that '''Application''' using the '''Channel Builders'''.
:* '''Channel Builders''' are stored in the virtual directory in a hidden folder under the PIM’s root directory. This should only be accessed through the '''Manage Applications Tool'''’s popup actions menu.
:* Package specific Channels are created through the '''Manage Applications Tool''' and stored inside the appropriate Application’s home folder.

 
==Channel Packages==
 

'''Channels''' and '''Applications''' in the portal are arranged in constructs called '''Channel Packages''' (or Packages).
'''Packages''' provide a scope for '''Channel''' names and a container for '''Channels''' and '''Applications'''. For the purpose of configuring and maintaining '''Applications''' and their associated '''Channels''', it is important to know the name of the '''Package''' for the '''PIM''' of interest (fairly intuitive) and the Directory Conventions used.
:* Each PIM is associated with one Channel Package.
:* Each Channel in a Package refers to an Application from the same Package.
:* All packages should be named in lower case (convention borrowed from Java).

 
==Channel Builders==
 

'''Channel Builders''' are special channels installed by each '''PIM''' that provide easy creation of product-specific
channels. '''Channel Builders''' are provided for specialized pages within a proxied product, such as charts or
reports. The channels created by the '''Channel Builders''' have special knowledge of the content within the
channel and provide easy configuration of product-specific parameters required to customize the content.
:*A Channel Builder creates portal channels of a single channel type for a single PIM (and therefore, a single product).
:*The created channel is usually for a single content type (such as a chart).
:*The created channel is associated with exactly one Application (must be from the same PIM).
:*The created channel has parameters to configure details of the displayed content.

 
==Creating an Application-Specific Channel==
 

The following instructions show how to create and modify '''Application''' specific channels.
# Highlight the '''Application''' for which you want to create a '''Channel'''.
# A context menu appears:

# Click on the '''Channel builder''' for the type of '''Channel''' desired. '''Channel Builders''' start with ''Build''.
# The Channel Builder window appears:

# Enter the ''Name'' of the '''Channel''' to be created.
# Enter the ''Location'' where the '''Channel''' should be stored in the virtual directory. To use the standard naming convention, leave Location unchanged. The Channel will then be stored under the Application’s home folder.
# Click ''Next''. The '''Channel Editor''' window appears:

# The selected tab displays Channel-specific parameters that can be set. Set the values as appropriate for the '''Channel''' type selected.
# Click ''Next''.

# Choose which ''View'', if any, the created '''Channel''' should be placed in. Depending on this selection, you may be presented with a '''View Editor''' window to customize the view display.


# Click ''Ok''. A notification window appears to confirm that the changes have been saved.
# Click ''Ok''.

 
==Accessing Application-Specific Channels==
 

The following instructions detail how to access Application-specific channels.
# Once created, the Application-specific Channels are accessible in the virtual directory.


# Open the '''Content Manager''' and open the Application’s home folder:
# You can now right-click on the channel to edit, open, copy, or delete the application-specific channel.

Enportal/5.6/web integrations/creating channels - Revision history

imported>Jason.nicholls: 1 revision

imported>Jason.nicholls: 1 revision