KB Version:

Page Navigation

Related Links

Learning Levels

Most Read

Components

Digest

A component is any entity managed within the administration area of the system. Components include all elements found in the Administration area that are used to create and render assets for a site.

Components serve many purposes, from facilitating creation of content, managing and publishing content, and management of system users.   For ease of classification, components are divided into several different groups:

  • user User - One who uses the content management system.
  • group Group - One or more users with common permissions.
  • group Role - Determines the abilities and permissions of a User or Group.
  • asset factory Asset Factory - A way to create a specific type of asset or specially configured page.
  • configuration set Configuration Set - A grouping of Configurations, making them more manageable.
  • content types Content Types - Formally aggregates Configuration Sets, Metadata Sets, and Data Definitions into a single Administrative component that can be applied to pages.
  • data definition Data Definition- A form-based input field for the creation and editing of page content, as well as generation of XML data from user-provided input in said input fields.
  • metadata set Metadata Set - Provides the interface for customizing the kinds of metadata fields that can be visible and/or associated with an asset.
  • publish set Publish Set - Directs groups of publishable assets to be published on-demand or on a schedule.
  • target Target - Represents a site or subsite and specifies the format in which content should be published (XHTML, XML, etc).
  • destination Destination - Links a target to a transport, specifies encoding (UTF-8 or ASCII), and allows for publishing content on a schedule.
  • transport Transport - Stores data concerning how published content is pushed out to the final publish location.

Concept

Organizing Components

When operating in the Administration area of Cascade Server, Containers are used in place of folders.  Containers are utilized to organize and limit access to components, and they may contain more than one type of component.  They can be found in the left column of the Administration user interface.

containers 

Types of Components

  • ASSET FACTORY – An asset factory provides a way to create a specific type of asset or specially configured page, such as blocks, external links, files, folders, pages, stylesheets, and templates.  New assets created via the asset factory need not be based on any particular asset, and may be placed in any folder.  Access to asset factories is determined by user access rights.

  • CONFIGURATION SET – A configuration set is a collection of configurations that can be used to create one or more pages.  Each configuration ties a template together with optional blocks and stylesheets, which can be used to form the basis of a new page.  A configuration cannot be used to create a page unless it is part of a configuration set, and a configuration set may contain only one configuration.  Multiple configurations in one set are typically used when multiple outputs are required, such as HTML, printer-friendly, or XML.  When creating a new configuration set, you must also create one or more configurations.  It is possible to add more configurations later, but configurations may not be reused from other sets.

  • CONTENT TYPE – The addition of Content Types with the release of Cascade 5.5 provides users with a way of formally aggregating Configuration Sets, Metadata Sets, and Data Definitions into a single Administrative component that can be applied to pages.  Content Types provide an intuitive and logical way for end-users to identify the proper type to associate with a page by grouping together the necessary configurations for predefined page types with familiar names, such as Blog Posts, Press Releases, Announcements, etc.  Much in the way Cascade Server utilizes Asset Factories to create predefined recognizable assets such as pages, templates, etc., Content Types are given simple names that clearly identify their purpose to end users.  The addition of Content Types simplifies the page edit interface by consolidating previous options into one Content Type chooser.  This provides a single point of control for Administrators to modify a page's Configuration Set, Metadata Set, and/or Data Definition for selected pages without requiring a Bulk Change operation.

  • DATA DEFINITION – Data definitions consist of XML data authored by hand or by using the data definition builder (/common/data definition builder), and they describe how a certain set of data is structured.  Data definitions are used by Cascade Server to generate forms-based input fields for the creation and editing of page content, as well as to generate XML data from the input provided by users in input fields.

metadatasetwired

  • METADATA SET – A metadata set provides the interface for customizing the kinds of metadata fields that can be visible and/or associated with an asset. As metadata fields may be broken into two categories (wired and dynamic), metadata sets allow administrators to choose which wired fields can be made visible to end users and which ones will be turned off. Likewise, the interface allows for dynamic fields to be created that help to further describe an asset beyond the scope of what regular wired fields allow.

    • Metadata sets also allow for administrators to customize the wired and dynamic metadata fields so that they appear ‘inline’ in the editing interface for an asset instead of appearing in the metadata pane, thus making the fields more accessible to end users. Additionally, fields can be set to 'required' so that end users must enter acceptable values for metadata before saving the asset.
    • Metadata sets allow administrators to customize metadata options for multiple assets, and are managed in the Administration area.

  • PUBLISH SET – Publish sets allow groups of publishable assets to be published on-demand or on a schedule. Publish sets may contain files, folders, and pages.  Publish sets are controlled by container-level access rights and can be limited to certain users.  A common use of publish sets is to implement a workflow publish set trigger, which publishes content (and all related assets, as defined by the set) after it has been approved.

  • TARGET – A target is used to represent a site or subsite, and specifies the format in which content should be published (XHTML, XML, etc.).  Usually, a target will be created to represent a site, with subtargets (children of the master target) created for the different templates within that site (HTML, XML, handheld, etc.).  By defining a base folder, which contains all the content for the site, the ‘master’ target ties together the entire site, including all the subtargets and their templates.  Each subtarget ties an individual site template to the pages (and those pages’ related files) using that template.

  • DESTINATION – A destination represents a location to which a target can be published, allows for publishing content on a schedule, and specifies encoding (UTF-8 or ASCII) for the published content.
    • Destinations are useful for controlling individual sites that may need different settings, or that publish on different schedules using different locations (represented by transports).  Each destination has a transport that represents a server where the published content will reside.  Destinations have access rights restrictions that are dictated by group membership.
    • When publishing a target, Cascade Server allows the selection of the individual destinations that are associated with that target.  This is generally used when content is to be published to a development or internal server for final quality assurance before being pushed to a live site.
    • A target contains a collection of one or many destinations; these destinations define the locations where the target can publish to.  The location is defined by the transport associated with the destinations, and the transport represents a server location.  The directory that is specified in the destination will override the directory specified in the transport that the destination uses.

    • TRANSPORT – A transport moves and stores data concerning how published content is pushed out from a temporary directory to the final publish location. There are two types of transports:
      • File System – File system transports can push out content to a location on the CMS server’s hard drive or to a mapped network location. In order to set the transport to a mapped network connection, the account used by the CMS server must have the appropriate privileges to write to and create new files in the network publish location.
      • FTP/STP – FTP/STP transports push content to a remote server via the SFTP or FTP protocol. The account specified in the transport's settings must have appropriate privileges on the remote server to navigate through the folder structure, write, and create to ensure publish operations do not encounter errors.

Technical

Creating Components

User

  1. Go to the Administration area and click the Users, Groups, & Roles tab on the left navigation bar.
  2. Click Create New User.
  3. On the General tab:

    1. Username - The name the user will be known by in the system.
    2. Full Name - The full name of the user (optional).
    3. Email - The email to which messages and notifications will be sent.
    4. Authentication - Determines whether Normal (password) or Custom (single sign-on solution via a custom plugin) authentication is required for this user.
    5. Password - User passwords must be 4-16 alphanumeric characters in length.
    6. Enabled - This allows you to activate and deactivate the user without deleting the account.
    7. Groups - Select the group(s) to which the user should belong. Assigning multiple groups to each user is an easy way to customize the permissions options for each user.
    8. Default Group - Assigning a default group allows the administrator to assign this user a default folder and dashboard settings that are customized at the group level.
    9. Role - Select the desired explicit role of the user. The user's actual role is determined by the highest overall role when taking into account the user's explicit role AND the roles of the groups the user belongs to.

  4. Click Submit to save your new user.

crenewuser


Users can be viewed, edited, or deleted by clicking on the username in the Administration area and selecting the appropriate choices.


In addition, all user activity may be monitored by clicking on the username in the Administration area and selecting Workflows or User Audit Trail.

Group

  1. Go to the Administration area and click the Users, Groups, & Roles tab on the left side navigation menu.
  2. Click New Group.
  3. On the General pane:

    1. Group Name - Type in a Name for the group.
    2. Starting Page - This starting page will apply to all users set with this group as their default group.
    3. Base Folder - This base folder will apply to all users set with this group as their default group.
    4. Asset Factory Container - This Asset Factory Container will be used to populate "My Create Types" on the dashboard of all users set with this group as their default group.
    5. CSS Classes - Adding CSS classes here will limit the classes available to users set with this group as their default group.
    6. WYSIWYG Toolbar Options - Check the boxes for any types of WYSIWYG options you want to be made available to all users set with this group as their default group.
    7. Users - Select the users that should belong to the new group. Users may also be added to a group on the user level.
    8. Roles - If the role of the group is higher than that of a member user, that user's role will be promoted to that level.

  4. Click Submit to save your new group.

crnewgrp


Groups can be viewed, edited, or deleted by clicking on the group name in the Administration area and selecting the appropriate choices. In addition, all group activity may be monitored by clicking on the group name in the Administration area and selecting Workflows or User Audit Trail.


Role

  1. Go to Administration in the top navigation Menu.
  2. On the left, the first container is “Users, Groups, & Roles.”
  3. Select whether you’d like to great a new User or a new Group from the choices presented.
  4. For this example, since we’re discussing users, once you choose “New User,” you will be directed to the “Create New User” page.
  5. Enter the desired Username, Full Name, email address, select your Authentication choice (either normal or custom), define a user Password, and assign he or she to all relevant Groups. You will also be able to assign a Default Group. Finally, the last option, is to select the desired Role from the drop-down menu of choices: Contributor, Approver, Publisher, Manager, or Administrator.

selectrole


Asset Factory

  1. Administration area and select the ‘Asset Factories’ menu.
  2. Click Add Asset Factory.
  3. Select the type of asset you would like to create.
  4. In the General pane, complete:
    1. Name – Describes the asset (eg. Press Release, Newsletter, etc.).
    2. Parent Container – Determines where the asset factory should be stored in the Administration area.
    3. Base Asset – Selects the asset on which the asset factory will be based.
    4. Placement Folder – Determines default folder placement for all assets created using this asset factory.
    5. Subfolder Placement - Checking this allows assets created via this asset factory to be placed in subfolders within the placement folder.
    6. Folder Placement Position – Determines the order in which the new asset will appear in the folder. For example, a new press release may always need to be placed first in the folder in order for dynamic navigation menus to render them as most recent.
    7. Overwrite – Allows newly created assets to overwrite existing assets with the same name.
    8. Groups – Select from available groups on the left, and move to the right to enable asset factory usage.

  5. In the Workflow pane, there are three possible modes for asset factories:
    1. Folder Controlled – Pulls workflow definitions from the folder in which the asset is being created within the asset factory.
    2. As Selected Below – Selects a workflow to be used for all assets created using this asset factory.
    3. None – Uses no workflow for assets created with this asset factory.
  6. On the Plugins pane, add one or more plug-ins by selecting from the drop down menu and clicking the green + icon.  Some plug-ins will prompt you to add various parameters.
  7. Click Submit to save your new asset factory.

crassetfact


Configuration Set

  1. In the Administration area, select ‘Configuration Sets from the left navigation area.
  2. Navigate to the desired container, or create a new container to hold the new configuration set.
  3. Click New Configuration Set.
  4. In the General pane, complete the following:
    1. Name – Enter a descriptive name for your configuration set.
    2. Parent Container – This value will already be set to the current container, but it can be changed, if desired, by clicking the chooser icon.
  5. In the Configurations pane:
    1. Select a Template and give a Name to your new configuration.  Click ‘Add this new configuration’.
    2. You will then be forwarded to the configuration page, which allows you to assign blocks and stylesheets to the various template regions, assign an overall stylesheet, and determine whether this should be the Default Configuration.
    3. You may add more configurations by repeating the same steps at the bottom of the frame.
  6. Click Submit to save your new configuration set.

crconfigset

Data Definition

  1. In the Administration area, select ‘Data Definitions’ from the left navigation pane.
  2. Navigate to the container in which the new data definition will be stored, or create a new container.
  3. Click ‘New Data Definition’.
  4. Complete the following fields in the ‘General’ pane.
    1. Name – A descriptive name for your definition.
    2. Parent Container – This value will be set to the current container, but can be changed if desired by clicking on the chooser icon.
    3. XML – Enter XML content.
    4. File Upload – As an alternative to entering content in the XML field, data definition XML content may be entered here.
  5. Click ‘Submit’ to save data definition.

create data definition


Metadata Set

  1. In the Administration area, select ‘Metadata Sets from the left navigation pane.
  2. Navigate to your choice of container, or create a new container.
  3. Click 'Metadata Set'.


metadataset



  1. Under the General pane:
    Name – Name metadata sets according to the type of asset that will be used.
    Parent Container – This value will default to the current container, but can be changed by clicking the chooser icon.

  2. Under the Wired Fields pane:
    Lists the metadata fields that are standard for every asset. The Visibility column allows users to determine whether a field is shown in the metadata pane, completely hidden, or shown inline with content in the content pane. Checking the Required box will force users to enter a value for that field before allowing them to submit assets.

  3. Under the Dynamic Fields pane:
    Allows users to add custom metadata fields. Click on Add Text, Radio, or Dropdown, and enter a name for the new field.  Other options can be selected as normal.  If a Radio or Dropdown Field is created, users will be prompted to enter the appropriate Configuration for options. If more than one dynamic field is created, users may enter a listing order for each field.

  4. Click ‘Submit’ to save your new Metadata Set.

Publish Set

  1. In the Administration area, select ‘Publish Sets in the left navigation pane.
  2. Select your desired container, or create a new container to hold the new publish set.
  3. Click ‘New Publish Set’.
  4. Complete the following fields in the ‘General’ pane:

    Name – Identify the publish set.
    Parent Container – Will be set to the current container, but can be overridden by clicking the browse icon.
    Schedule - Allows the set to publish on an automatic schedule.

  5. In the ‘Files’ pane, add files which will be included in the set.
  6. In the ‘Folders’ pane, add folders which will be included in the set.
  7. In the ‘Pages’ pane, add pages which will be included in the set.
  8. Click Submit to save your new publish set.

crpubset


Target

  1. Go to the Administration area and select ‘Targets and Destinations.
  2. Click ‘New Target.
  3. Complete the following fields under the ‘General tab:

    Name – Will typically be the same as its corresponding asset folder.
    Parent Target – If this is a sub-target, select the appropriate parent from the chooser.
    Base Folder – Select the corresponding asset folder.
    Output File Extension – Typical extensions are .html, .htm, .asp, etc.
    CSS Classes – Associate specific classes with this site.
    CSS File – Associate a specific style sheet with this site.
    Type of Data – Determines output format of content.
    XML Declaration – Determines whether XML Declaration is included in published files.
    Path – Determines whether target path is included in publishing, and allows for removal of base folder path from published files.
    Uses Scheduled Publishing – Determines a schedule for automatic publishing; does not interfere with manual publishing.

  4. Click ‘Submit to save the new target.

crtarget


Destination

  1. Select ‘Administration’ from the top navigation menu.
  2. Select ‘Targets & Destinations’ in the left navigation pane.
  3. Select the target to which a destination will be added.
  4. Click ‘New Destination’.
  5. Complete the following fields in the ‘General tab:
    1. Name – How the system identifies the destination.
    2. Directory – Generally, this value is inherited from the transport. An absolute path may be entered here if content needs to be directed to a different folder than the one identified in the transport.
    3. Transport – Use browse icon to select desired transport.
    4. Target – Use browse icon to select desired target.
    5. Activation – Allows users to temporarily deactivate certain destinations without having to delete and recreate them later.
    6. Output – Cascade Server publishes content in Unicode by default; this may be overridden by selecting the ASCII checkbox.
    7. Schedule Publishing - Allows content to be automatically published on a recurring schedule. By setting up different destinations, users may set certain portions of a site to publish on different schedules.
    8. Applicable for Groups – Determines which groups may publish to the destination.  Unless a group is defined here, this destination will not show up on an asset's list of available destinations on the publish screen for that group.
  6. Click Submit to save the new destination.

crdest

When publishing content, destinations may be checked or unchecked to allow users added flexibility in regards to where to publish content on an ad hoc basis.

Transport

  1. Click on ‘Administration’ in the top navigation menu.
  2. Select ‘Transports’ in the left navigation pane.
  3. Click ‘Filesystem’ or ‘FTP and SFTP, depending on where content is to be published.
  4. Click ‘New Transport’.
  5. In the ‘Create’ pane, select the appropriate Transport Type and click ‘Submit’.
  6. Complete the following fields in the ‘General’ pane:
    1. Transport Name – Used by the system to identify the transport.
    2. Server Name – Will only appear for FTP/STP transports; enter the name of production server.
    3. Server Port – Will only appear for FTP/SFTP transports; enter the port number.
    4. Server Directory – Address where content should be published.
    5. User Name/Password – Will only appear for FTP/SFTP transports; enter information needed to access the directory.
  7. Click ‘Submit’ to save the new transport.

crtrans

Creating Containers

  1. Click on Administration on the top navigation menu.
  2. Click on the component type (from left column) where you would like the container placed.
  3. Click New Container on the left side, below the type of component you selected.
newcontainer
  1. Follow the steps to create the desired container.

Related Links