Ingeniux.CMS Namespace

Represents a task to be completed when a transition is executed. An action is associated with a transition through the AddAction(EnumActionType, String) method.

There are actions for common operations in the content tree, such as checking in a page and marking a page for publish. If the built-in actions are not adequate, developers can create custom workflow actions. Custom workflow actions assemblies must be put in App_Data/xml/custom/plugins/CustomWorkflowActions directory. The actual Action class must implement the ICustomWorkflowAction interface. The custom action uses its full class name as the value of the ProgID attribute and calls the Execute method to perform the action.

The actions associated with a transition are executed in the order in which they are added to the transition. If an action fails to execute, the transition will not complete. The workflow remains in the WorkState it was in before the transition executed.

Represents an asset in the Assets Tree within a particular Site.

It can be retrieved via Asset method from the Site object.

Used to access admin level content and actions on an asset. Cannot be accessed directly. A retrieved asset needs to be recast as IAssetAdminContentDirect.

Represents a folder in the Assets Tree within a particular Site

It can be retrieved via AssetFolder method from the Site object.

Represents one CategoryNode in the Taxonomy tree.

Categories are used to tag Page objects, creating another way to organize and index Page objects.

The Taxonomy system is hierarchical. Each CategoryNode may have parent and children nodes.

Represents a Synonym entry for a CategoryNode.

Synonym is another name of the CategoryNode that is specific to a Locale.

1. Has multiple versions

2. Can be checked out and checked in

3. Contains content including elements and attributes

4. Can be added and advanced in workflow

5. Always created from a Schema

6. Part of a tree structure

1. Has multiple versions

2. Can be checked out and checked in

3. Contains content including elements and attributes

4. Can be added and advanced in workflow

5. Always created from a Schema

6. Part of a tree structure

Represents a mobile device-web browser combination with unique UserAgent string. A device entry with this UserAgent string can be uniquely identified by Ingeniux CMS' mobile device detection system.

Represents an entry in the exports of a NavigationElement.

Exports are additional attributes appended to an expanded Link or Navigation XML element, adding more information to the Link or Navigation entry.

This interface is used for SchemaFields on Schemas and for GlobalExports. It is not for LocalExports on Navigation elements for Pages.

Represents the Global Variable entry. As the name indicates, global variables are placeholders that hold specific values They can be used in any part of an element value or attribute. The purpose of this object is to allow static information that is repeated across multiple pages or fields to be editable in only one place.

Global variables always have a global value, which applies to all publishing targets. They may also contain override values for specific publishing targets. During publish, these override values are used for the publishing targets to which the global variables belong.

Global variables are defined in the CMS and undergo value replacement in the DSS.

Represents a Group element on a page.

A Group element contains child elements of any type, except another group element.

Represents an object that holds a set of string values, unique by their locale.

All the string value have the same meaning, but expressed differently depending on its language.

Examples

Represents the lingual relationship mapping for specific version of the master page. This object is an entry in LingualPageMap.

Localization of web pages starts with the source language page (master page). In the beginning, the source language content is finalized and checked in, but there is no translation of this page in the target language. This will be the first entry in lingual map of this master page. It has a version for source page, but doesn't have a version for target page yet. As translation finishes, this lingual version map is finalized. It contains the target language page (clone page) version number. At this point, this version map is closed and kept in history of the master page's translations.

Represents the information of a step/task entry in a background task to be monitored. This step has a collection of substeps.

Substeps need not have a particular order. List steps can advance from one step to any other step.

Represents the types of XPower elements that produce a collection of Navigation elements during runtime or publishing expansion. A Navigation element queries each page it covers and produces a Page element with a set of attributes that summarizes the page's content.

The highly organized and highly flexible Navigation elements are a central part of the Ingeniux CMS.

The amount of information to summarize from page content is decided by the combination of global exports and local exports. Local exports override global exports with same name. Therefore, all Navigation element types can have local exports.

Represents a node in the content tree within a particular Site. It can be retrieved via Page method from the Site object.

Pages are the building blocks of a CMS Site. Each Page object represents a structured piece of content that represents either a URL on the runtime site or a content block to be included in other pages.

Defines the criteria for creating a new Page, including Schema, location, and limitations on Groups and Users.

Page creation rules provide a controlled way to create pages; their main purpose is to enforce restrictions on page creation for nonadministrative users.

Because they provide ways to limit page creation locations, they can also be a used as shortcuts for creating pages quickly.

In addition, page creation rules can add newly created pages directly into workflows.

Publishing Targets, Publishing Profiles, Structured Url Maps, Runtime Redirects, Replication System, Publishing Tasks and Replication Tasks.

It also provides ways to manage InSite Search configuration of CMS published content.

Represents a collection of Publishing Targets. Publishing profiles serve two purposes:

Represents a field in schema. It corresponds to an element or attribute in a page.

A schema contains a flat list of multiple fields.

Represents the manager object that provides the means to query and manage Pages and Page Versions.

It is the most important manager, due to fact it manages the central pieces of CMS, the Pages.

Each Site Branding entry corresponding to a presentation style collection. Site Branding at run time is determined by locating its search string on the request URL. If the search string is found on the request URL, site branding is applied.

In other words, site brandings allow for presentation style switching based on request URL, include host name, base URL, and query strings.

Represents the Manager object that provides functionalities to manage translations of Schemas, Page Creation Rules, Workflow Defintions and States, into various languages for display on the user interfaces of Ingeniux CMS client.

The translated Schemas will replace the original field label and help text on Edit Form of a Page.

The translated Page Creation Rules will override the Page Creation Rule selection dialog's rule names.

The translated Workflow Definitions and Work States will change the labels of Workflow advancement dialogs.

Represents the information of a step/task entry in a background task to be monitored. Steps are the building blocks of the Task Monitor, which is used to monitor the progress of a task.

Steps are normally constructed with full information during construction of a Task Monitor. Its property values cannot be changed.

Represents a path between two Work States. When a Workflow advances from one workstate to another, it goes through a transition.

Transitions allow for ownership change of a page in workflow. Transitions can also can execute built-in or custom Actions.

Transitions are defined in Workflow Definitions and carried out in Workflow Instances.

User agent branding is used to define cobranding at the client level. Each user agent branding entry corresponds to a presentation style collection. User agent branding at run time is determined by locating its search string on the requested, browser-specific user agent string. If the search string is found on the requested user agent, then this user agent branding is applied.

Creating user agent brandings allows presentation style switching based on browser type. This is mainly used for mobile-device detection.