• KB Home |
• Need Help?

Learning Levels

• Digest
• Concept
• Technical

Announcements

Asset Factory assetType

Facebook Connector Changes

A new connector super-type has been added that acts as the parent type for the new Facebook Connector and for the existing Twitter Connector.  It's called a "statusUpdateConnector" and is declared as the following:

<complexType name="statusUpdateConnector"> <complexContent> <extension base="impl:connector"> <sequence> <!-- The destination Priority: destinationId > destinationPath One is REQUIRED --> <element maxOccurs="1" minOccurs="0" name="destinationId" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="destinationPath" type="xsd:string"/> </sequence> </extension> </complexContent> </complexType>

Another new connector complex type has been added to represent Facebook Connectors.

<complexType name="facebookConnector"> <complexContent> <extension base="impl:statusUpdateConnector"/> </complexContent> </complexType>

A "facebookconnector" entry has likewise been added to the "entityTypeString" enumeration.

<enumeration value="facebookconnector"/>

Destination Web URLs

A new field has been added to the "destination" complex type called "webUrl" which is equivalent to the field now available in the UI.

<!-- The base URL which should be used for linking to a given configuration during publishing, when this destination is explicity chosen for a configuration on the content type. --> <element maxOccurs="1" minOccurs="0" name="webUrl" nillable="true" type="xsd:string"/>

Addition of Created By/Created On Fields

The created by and created on fields for Home Area Assets can now be accessed via web services. Their element declarations are found below.

<!-- When this asset was created NOT REQUIRED --> <element maxOccurs="1" minOccurs="0" name="createdDate" nillable="true" type="xsd:dateTime"/> <!-- Who created this asset NOT REQUIRED --> <element maxOccurs="1" minOccurs="0" name="createdBy" nillable="true" type="xsd:string"/>

Simpler editing of read assets

When reading an asset, Cascade returns both ids and paths (or names for assets that do not have paths) of both the read asset and any referenced assets. Prior to 6.8, a user had to manually null out one of these two values in addition to their other modifications before submitting the page for edit. As of Cascade 6.8, all asset relationship elements which include id and path elements can now contain both values when submitted for edit. If both fields are present, the id will be used in favor of the path to locate the asset or any referenced asset.

<complexType name="identifier"> <sequence> <!-- When editing and selected asset is recycled, it is recommended to preserve this relationship by providing selected asset's id in case if the selected asset gets restored from the recycle bin. One is REQUIRED --> <element maxOccurs="1" minOccurs="0" name="id" type="xsd:string"/> <!-- Path works only for non-recycled assets --> <element maxOccurs="1" minOccurs="0" name="path" type="impl:path"/> <element maxOccurs="1" minOccurs="1" name="type" type="impl:entityTypeString"/> <!-- NOT REQUIRED: For reading purposes only. Ignored when editing, copying etc. --> <element maxOccurs="1" minOccurs="0" name="recycled" type="xsd:boolean"/> </sequence> </complexType>

Java Example

Here's Java code to update the Page's title prior to 6.8:

ReadResult result = client.read(auth, new Identifier(id, null, EntityTypeString.page, null)); Asset asset = result.getAsset(); Page fetchedPage = asset.getPage(); fetchedPage.setTitle("new title"); // had to use either the WebServicesUtil or manually NULL individual properties of the Page before submitting WebservicesUtils.nullPageValues(fetchedPage); OperationResult er = client.edit(auth, asset);

Here's the same operation in 6.8:

ReadResult result = client.read(auth, new Identifier(id, null, EntityTypeString.page, null)); Asset asset = result.getAsset(); Page fetchedPage = asset.getPage(); fetchedPage.setTitle("new title"); // simply change the page and submit for edit OperationResult er = client.edit(auth, asset);

Google Analytics Connector

In Cascade 6.8, a new type of Connector has been introduced: Google Analytics Connector.

<complexType name="googleAnalyticsConnector"> <complexContent> <extension base="impl:connector"/> </complexContent> </complexType>

Creation and editing of that Connector is identical to the other ones with a small difference:  connectorContentTypeLinks are not requred. This is because Google Analytics Connector does not use Connector Content Type Links. However, when creating or editing a Twitter Connector or a WordPress Connector, they still need to be provided.

<!-- A list of connector parameters REQUIRED for TwitterConnector and WordPressConnector --> <element maxOccurs="1" minOccurs="0" name="connectorContentTypeLinks" type="impl:connector-content-type-link-list"/>

Asset scheduled publishing - new properties

Sites, Publish Sets, Destinations and Targets have updated scheduled publishing properties. The type of scheduled publishing (every day, each selected day of a week, every n hours, Cron expression) is dependent on which one of the following fields is not null:

• publishIntervalHours - for every n hours publish, provide the amount of hours for the interval
• publishDaysOfWeek - uses the complexType daysOfWeek. Provide one or more values from the enumeration daysOfWeek indicating which days the asset should be published.
• cronExpression - for Cron expression publish, provide the cron expression in a string form, timeToPublish field is ignored in this case

<!-- The base time this set will be published. For example if one wanted this set to publish at 0100, 0500, 0900, 1300, 1700, 2100, I would enter one of those times here and set the "publishInterval" to 4, and the "publishIntervalUnits" to "hours" NOT REQUIRED default: 00:00 (midnight), if cronExpression provided or usesScheduledPublishing is false, ignored --> <element maxOccurs="1" minOccurs="0" name="timeToPublish" type="xsd:time"/> <!-- Depending on which of the following 3 values is provided, that is the type of scheduled publish that is going to be used. One is REQUIRED if usesScheduledPublishing is true, else NOT REQUIRED and ignored--> <choice> <!-- Every how many hours the asset should be published. Can be between 1 and 23 --> <element maxOccurs="1" minOccurs="0" name="publishIntervalHours" type="xsd:nonNegativeInteger"/> <!-- Which days of the which the job should publish on - select all days to have a daily publish --> <element maxOccurs="1" minOccurs="0" name="publishDaysOfWeek" type="impl:daysOfWeek"/> <!-- Applicable only if publishInterval Units is "cron" - only a valid Cron Expression will be accepted --> <element maxOccurs="1" minOccurs="0" name="cronExpression" type="xsd:string"/> </choice>

<!-- A wrapper type wrapping a list of identifiers of publishable assets (files, folders, or pages) --> <complexType name="daysOfWeek"> <sequence> <element maxOccurs="unbounded" minOccurs="0" name="dayOfWeek" type="impl:dayOfWeek"/> </sequence> </complexType>

<simpleType name="dayOfWeek"> <restriction base="xsd:string"> <enumeration value="Monday"/> <enumeration value="Tuesday"/> <enumeration value="Wednesday"/> <enumeration value="Thursday"/> <enumeration value="Friday"/> <enumeration value="Saturday"/> <enumeration value="Sunday"/> </restriction> </simpleType>

Content Type Page Configuration-Destinations

As of 6.8, Content Types in Sites can have Destinations assigned for each Configuration coming from the Content Type's Configuration Set. These can be assigned through web services using contentTypePageConfigurations element.

<!-- The array of contentTypePageConfigurations NOT REQUIRED - if not specified, the default publish mode "all-destinations" is used for each pageConfiguration - ignored in Global area --> <element maxOccurs="1" minOccurs="0" name="contentTypePageConfigurations" nillable="true" type="impl:contentTypePageConfigurations"/>

Each contentTypePageConfigurations element contains a list of contentTypePageConfiguration elements.

<complexType name="contentTypePageConfigurations"> <sequence> <element maxOccurs="unbounded" minOccurs="0" name="contentTypePageConfiguration" nillable="true" type="impl:contentTypePageConfiguration"/> </sequence> </complexType>

Each contentTypePageConfiguration element should correspond to each Configuration Set's Configuration and is referenced by pageConfigurationId and pageConfigurationName elements. Only one of these elements is necessary. If the contentTypePageConfiguration element is not provided for a particular Configuration, Cascade Server will assign the default value to it - "All Destinations".

<complexType name="contentTypePageConfiguration"> <sequence> <!-- The page configuration Priority: pageConfigurationId > pageConfigurationName One is REQUIRED --> <element maxOccurs="1" minOccurs="0" name="pageConfigurationId" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="pageConfigurationName" type="xsd:string"/> <!-- REQUIRED --> <element maxOccurs="1" minOccurs="1" name="publishMode" type="impl:contentTypePageConfigurationPublishMode"/> <!-- REQUIRED if "publishMode" is "selected-destinations", else NOT REQUIRED and ignored --> <element maxOccurs="1" minOccurs="0" name="destinations" nillable="true" type="impl:contentTypePageConfigurationDestinations"/> </sequence> </complexType>

Also, contentTypePageConfiguration elements contain a required publishMode simple type. The available publish modes correspond to the ones provided in the user interface:

• all-destinations - "All Destinations" option
• selected-destinations - "Selected Destinations" option
• do-not-publish - "Do not publish" option

<simpleType name="contentTypePageConfigurationPublishMode"> <restriction base="xsd:string"> <enumeration value="all-destinations"/> <enumeration value="selected-destinations"/> <enumeration value="do-not-publish"/> </restriction> </simpleType>

If the publishMode is selected-destinations, a list of destination identifiers is required.

<complexType name="contentTypePageConfigurationDestinations"> <sequence> <element maxOccurs="unbounded" minOccurs="0" name="destination" type="impl:identifier"/> </sequence> </complexType>

Workflow Configuration End Date

Workflow end dates can now be set when issuing create, edit, copy, move, or delete requests with a workflow configuration.  Below is the new element that has been added to the workflow-configuration complex type.

<!-- Optional due date for the workflow. If not specified, will default to 7 days from today --> <element maxOccurs="1" minOccurs="0" name="endDate" type="xsd:dateTime"/>

Workflow Start Date and End Date

The Workflow object returned through "readWorkflowInformation" operation now contains two additional properties: startDate and endDate. Below are the new elements that have been added to the workflow complex type.

<!-- The date when the workflow was initialized --> <element maxOccurs="1" minOccurs="0" name="startDate" nillable="true" type="xsd:dateTime"/> <!-- The due date of the workflow --> <element maxOccurs="1" minOccurs="0" name="endDate" nillable="true" type="xsd:dateTime"/>

Database Transports

Workflow Step Configuration

Applicable Groups for Workflow Definitions, Asset Factories, Asset Factory Containers, and Destinations

As of 6.7.3, the "applicableGroups" property is not required and non-nillable for Workflow Definitions, Asset Factories, Asset Factory Containers, and Destinations and should contain a semicolon delimited list of group names.

<!-- semicolon-delimited list of string group names for which this asset is available for use NOT REQUIRED leave out to assign no groups --> <element maxOccurs="1" minOccurs="0" name="applicableGroups" type="xsd:string"/>

Previously, "applicable groups" assigned were being read as a comma-separated list of group names. However, they were being stored as semicolon-separated so if you attempted to edit using commas it would actually clear out the "applicable groups" property when the asset was viewed in the application.

New Sub-types for Transports

The entityTypeString simple type has been updated so that it contains more specific Transport types, which is consistent with other asset types that have sub-types (e.g. Blocks can be block_INDEX, block_XML, etc.).  The new entityTypeStrings are displayed below.

<enumeration value="transport_fs"/> <enumeration value="transport_ftp"/> <enumeration value="transport_db"/>

Recycle Bin

With the addition of the Recycle Bin, it was necessary to add new elements in various places where recycle entities are being referenced.  These new elements will indicate whether or not an assignment made on an asset is referring to a recycled asset.  This element was added mainly so that users can tell when a relationship refers to a recycled entity.  Setting these elements to true will NOT recycle an asset that has not been recycled yet.  These elements are ignored when creating/editing assets.

Here are a few examples:

Template's Format

<!-- NOT REQUIRED: For reading purposes only. Ignored when editing, copying etc. --> <element maxOccurs="1" minOccurs="0" name="formatRecycled" nillable="true" type="xsd:boolean"/>

Group's Starting Page

<!-- NOT REQUIRED: For reading purposes only. Ignored when editing, copying etc. --> <element maxOccurs="1" minOccurs="0" name="groupStartingPageRecycled" type="xsd:boolean"/>

Page Region's Block

<!-- NOT REQUIRED: For reading purposes only. Ignored when editing, copying etc. --> <element maxOccurs="1" minOccurs="0" name="blockRecycled" type="xsd:boolean"/>

Purge Interval

The Recycle Bin comes equipped with a automatic purge feature which will remove items from the Recycle Bin (and from the system completely) after a specified amount of time.  This configuration property is applicable for each Site and has therefore been added to the 'site' complex type so that it can be modified via web services.

<!-- REQUIRED The recycle bin expiration time --> <element maxOccurs="1" minOccurs="1" name="recycleBinExpiration" type="impl:recycleBinExpiration"/>

Values which are valid for this property are displayed below.  The unit of measure is 'days'.

<simpleType name="recycleBinExpiration"> <restriction base="xsd:string"> <enumeration value="1"/> <enumeration value="15"/> <enumeration value="30"/> <enumeration value="never"/> </restriction> </simpleType> 

XHTML/Data Definition Blocks

In 6.7, XHTML Blocks have been upgraded to XHTML/Data Definition Blocks and therefore required some changes in the WSDL.  First, you will notice that the name of the complex type for these Blocks has been changed to "xhtmlDataDefinitionBlock" from "xhtmlBlock".  This complex type also now contains a new element, "structuredData", which is used to specify a Data Definition and the structured data itself (exactly like Page editing).  Either the "xhtml" element or the "structuredData" element should be filled out, but not both.

<complexType name="xhtmlDataDefinitionBlock"> <complexContent> <extension base="impl:block"> <choice> <!-- A choice between structured data and xhtml content --> <choice> <element maxOccurs="1" minOccurs="1" name="structuredData" type="impl:structured-data"/> <element maxOccurs="1" minOccurs="1" name="xhtml" type="xsd:string"/> </choice> </choice> </extension> </complexContent> </complexType>

Here is the new entity type string declaration for XHTML/Data Definition Blocks:

<enumeration value="block_XHTML_DATADEFINITION"/>

In addition to the changes mentioned above, the term "structured data definition" has been replaced by "data definition" across the board (not just in the WSDL but also in the Cascade UI).  Elements referring to Data Definition no longer contain the prefix "structured".  Below are a few examples.

Entity type strings for Data Definition and Data Definition Container

<enumeration value="datadefinition"/> <enumeration value="datadefinitioncontainer"/>

The "dataDefinition" and "dataDefinitionContainer" complex types, formerly known as "structuredDataDefinition" and "structuredDataDefinitionContainer".

<complexType name="dataDefinition"> <complexContent> <extension base="impl:containered-asset"> <sequence> <!-- The XML content of this data definition REQUIRED --> <element maxOccurs="1" minOccurs="1" name="xml" type="xsd:string"/> </sequence> </extension> </complexContent> </complexType> <complexType name="dataDefinitionContainer"> <complexContent> <extension base="impl:containered-asset"> <sequence> <!-- the array of children --> <element maxOccurs="1" minOccurs="0" name="children" nillable="true" type="impl:container-children"/> </sequence> </extension> </complexContent> </complexType>

Move Operation

Moving/renaming assets is now its own operation within the Cascade UI.  This change has also been made in the Web Services layer.  There now exists a "move" operation that must be used in order to move or rename an asset.  The elements of the move operation are vary similar to a copy operation.  Relevant complex types are displayed below.

The "move" operation and parameters:

<!-- Used to move/rename an asset --> <element name="move"> <complexType> <sequence> <element maxOccurs="1" minOccurs="1" name="authentication" nillable="false" type="impl:authentication"/> <!-- REQUIRED: identifier of the asset being moved --> <element maxOccurs="1" minOccurs="1" name="identifier" nillable="false" type="impl:identifier"/> <!-- REQUIRED: parameters specifying a new name and/or container for the asset --> <element maxOccurs="1" minOccurs="1" name="moveParameters" nillable="false" type="impl:moveParameters"/> <!-- NOT REQUIRED: workflow configuration to be used when moving --> <element maxOccurs="1" minOccurs="0" name="workflowConfiguration" nillable="false" type="impl:workflow-configuration"/> </sequence> </complexType> </element> <!-- Parameters used when moving an asset --> <complexType name="moveParameters"> <sequence> <!-- NOT REQUIRED: the container into which the asset will be moved if left empty, asset will remain in its current container --> <element maxOccurs="1" minOccurs="0" name="destinationContainerIdentifier" type="impl:identifier"/> <element maxOccurs="1" minOccurs="1" name="doWorkflow" nillable="false" type="xsd:boolean"/> <!-- NOT REQUIRED: name to give the asset if left empty asset's name will not be changed --> <element maxOccurs="1" minOccurs="0" name="newName" type="xsd:string"/> </sequence> </complexType>

New Audit Types

A few new audit types have been added that correspond to new features mentioned above.  These audits types are:

<enumeration value="recycle"/> <enumeration value="restore"/> <enumeration value="move"/>

Ability Updates

A number of abilities have been added and updated as a part of 6.7.  They are listed below and separated into Global and Site abilities.

Global Abilities

<!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="editDataDefinition" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="recycleBinViewRestoreUserAssets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="recycleBinDeleteAssets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="recycleBinViewRestoreAllAssets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="moveRenameAssets" type="xsd:boolean"/>

Site Abilities

<!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="editDataDefinition" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="recycleBinViewRestoreUserAssets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="recycleBinDeleteAssets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="recycleBinViewRestoreAllAssets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="moveRenameAssets" type="xsd:boolean"/>

Additional Changes

A few miscellaneous items have been updated to maintain parity between properties available for editing in the Cascade UI and via Web Services.

The first is the default Site property on the "user" complex type.  As in the Ui, this is used to specify a Site into which a User is placed upon logging into Cascade.

<!-- Default Site for the user, defaultSiteId takes precedence if both fields are set NOT REQUIRED --> <element maxOccurs="1" minOccurs="0" name="defaultSiteId" nillable="true" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="defaultSiteName" nillable="true" type="xsd:string"/>

The remaining fields are contained in the "file" complex type.  They are "rewriteLinks" and "maintainAbsoluteLinks" which dictate how links are managed inside File assets.

<element maxOccurs="1" minOccurs="0" name="rewriteLinks" type="xsd:boolean"/> <element maxOccurs="1" minOccurs="0" name="maintainAbsoluteLinks" type="xsd:boolean"/>

Connectors

Available in 6.4 is the ability to manipulate Connectors and their containers via web services.  Three new values have been added to the entityTypeString simple type to use when reading a Connector or a Connector's container.  Three new elements have also been added to the asset complex type which enables creation and editing of Connectors and Connector Containers.

<simpleType name="entityTypeString"> <restriction base="xsd:string"> ... <enumeration value="connectorcontainer"/> <enumeration value="twitterconnector"/> <enumeration value="wordpressconnector"/> ... </restriction> </simpleType> <complexType name="asset"> <sequence> ... <element maxOccurs="1" minOccurs="1" name="connectorContainer" nillable="true" type="impl:connectorContainer"/> <element maxOccurs="1" minOccurs="1" name="twitterConnector" nillable="true" type="impl:twitterConnector"/> <element maxOccurs="1" minOccurs="1" name="wordPressConnector" nillable="true" type="impl:wordPressConnector"/> ... </sequence> </complexType>

Creating and editing Connectors is accomplished by using a number of new complex types.  The three main complex types are displayed below.  Notice there is a connector complex type which is extended by the wordpressConnector and twitterConnector complex types.

<complexType name="connector"> <complexContent> <extension base="impl:containered-asset"> <sequence> <!-- First authentication token for the external application the connector connects to (usually a username or email address) NOT REQUIRED --> <element maxOccurs="1" minOccurs="0" name="auth1" nillable="true" type="xsd:string"/> <!-- Second authentication token for the external application the connector connects to (usually a password) Write only - hidden when read NOT REQUIRED --> <element maxOccurs="1" minOccurs="0" name="auth2" nillable="true" type="xsd:string"/> <!-- URL of the external application the connector connects to NOT REQUIRED --> <element maxOccurs="1" minOccurs="0" name="url" nillable="true" type="xsd:string"/> <!-- Determines whether or not the connector has been verified Read only - editing a connector always unverifies it NOT REQUIRED --> <element maxOccurs="1" minOccurs="0" name="verified" type="xsd:boolean"/> <!-- The date this conenctor was verified Read only - editing a connector always clears the verification date NOT REQUIRED --> <element maxOccurs="1" minOccurs="0" name="verifiedDate" nillable="true" type="xsd:dateTime"/> <!-- A list of connector parameters NOT REQUIRED --> <element maxOccurs="1" minOccurs="0" name="connectorParameters" type="impl:connector-parameter-list"/> <!-- A list of connector parameters REQUIRED --> <element maxOccurs="1" minOccurs="1" name="connectorContentTypeLinks" type="impl:connector-content-type-link-list"/> </sequence> </extension> </complexContent> </complexType> <complexType name="wordPressConnector"> <complexContent> <extension base="impl:connector"/> </complexContent> </complexType> <complexType name="twitterConnector"> <complexContent> <extension base="impl:connector"> <sequence> <!-- The destination REQUIRED --> <choice> <element maxOccurs="1" minOccurs="1" name="destinationId" type="xsd:string"/> <element maxOccurs="1" minOccurs="1" name="destinationPath" type="xsd:string"/> </choice> </sequence> </extension> </complexContent> </complexType>

Each Connector must have at least one Content Type assignment.  Content Type assignments are declared by using the connectorContentTypeLinks element available on the connector complex type.  The connectorContentTypeLinks element is of type connector-content-type-link-list which is another complex type which can contain any number of connector-content-type-link's.  Each connector-content-type-link represents a single Content Type assignment for a particular Connector.

<complexType name="connector-content-type-link-list"> <sequence> <element maxOccurs="unbounded" minOccurs="0" name="connectorContentTypeLink" nillable="true" type="impl:connector-content-type-link"/> </sequence> </complexType> <complexType name="connector-content-type-link"> <sequence> <!-- The content type REQUIRED --> <choice> <element maxOccurs="1" minOccurs="1" name="contentTypeId" type="xsd:string"/> <element maxOccurs="1" minOccurs="1" name="contentTypePath" type="xsd:string"/> </choice> <!-- The page configuration NOT REQUIRED --> <choice> <element maxOccurs="1" minOccurs="0" name="pageConfigurationId" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="pageConfigurationName" type="xsd:string"/> </choice> </sequence> </complexType>

For some Connectors, Connector Content Type assignments have additional parameters specific for each Content Type assignment which can be manipulated using the connectorContentTypeLinkParams element available on each assignment.  Each parameter simply has a name and a value.

<complexType name="connector-content-type-link-param"> <sequence> <!-- Name of the parameter REQUIRED --> <element maxOccurs="1" minOccurs="1" name="name" nillable="true" type="xsd:string"/> <!-- Value of the parameter REQUIRED --> <element maxOccurs="1" minOccurs="1" name="value" nillable="true" type="xsd:string"/> </sequence> </complexType>

Connectors can also have additional parameters that are not specific to a particular Content Type link.  These parameters are supplied via the connectorParameters element available in the connector complex type.  The connectorParameters element is of type connector-parameter-list and contains any number of connector-parameter objects.

<complexType name="connector-parameter-list"> <sequence> <element maxOccurs="unbounded" minOccurs="0" name="connectorParameter" nillable="true" type="impl:connector-parameter"/> </sequence> </complexType> <complexType name="connector-parameter"> <sequence> <!-- Name of the parameter REQUIRED --> <element maxOccurs="1" minOccurs="1" name="name" nillable="true" type="xsd:string"/> <!-- Value of the parameter REQUIRED --> <element maxOccurs="1" minOccurs="1" name="value" nillable="true" type="xsd:string"/> </sequence> </complexType>

Manipulating Connector Containers is accomplished using the connectorContainer complex type which behaves the same as most other system area container types.  The main difference is that all Connector Containers must belong to a Site.

<complexType name="connectorContainer"> <complexContent> <extension base="impl:containered-asset"> <sequence> <!-- the array of children --> <element maxOccurs="1" minOccurs="0" name="children" nillable="true" type="impl:container-children"/> </sequence> </extension> </complexContent> </complexType>

The root Connector container id for a particular Site can be acquired by reading the Site and accessing the rootConnectorContainerId element now available on the site complex type. 

<element maxOccurs="1" minOccurs="0" name="rootConnectorContainerId" nillable="true" type="xsd:string"/>

Abilities

Access to the Connectors area within a Site can be granted via web services using a new Site level ability which has been added to the WSDL.  It has been added to the site-abilities complex type and is shown below.

<!-- NOT REQUIRED - default false --><element maxOccurs="1" minOccurs="0" name="accessConnectors" type="xsd:boolean"/>

A new global ability has been added to Cascade which governs a user's access to Broadcast Messaging.  This ability can now be enabled via web services using the element below which has been added to the global-abilities complex type.

<!-- NOT REQUIRED - default false --><element maxOccurs="1" minOccurs="0" name="broadcastMessages" type="xsd:boolean"/>

Specifying Cross-Site Relationships

Now available in Cascade 6.2 is the ability to populate cross-site asset relationships via Web Services.  For example, the Metadata Set field present on many Home Area assets can now be specified by path using the cross-site relationship format displayed below.  Note that populating these relationships by id does not require a special format.

<metadataSetPath>SiteName:/path/to/asset</metadataSetPath>

This cross-site relationship format is also used in the Cascade UI when selecting assets using asset choosers.  Notice that this format is different from the format used when creating links between assets in the home area via content areas; this helps to distinguish the difference between a content link and an asset relationship.

To reference assets residing in the Global Area, simply use "Global" as the site name; to reference an asset contained in the same site as the asset being edited/created, simply omit the site name and ':' and only supply the path to the asset.

Site Destination Containers

Because Sites do not employ Targets, it was necessary to create a new type of container in 6.0 called a Site Destination Container.  The web services API has been updated in Cascade 6.0.3 to allow users to manipulate these new containers.  Below is the siteDestinationContainer complex type declaration.

<complexType name="siteDestinationContainer"> <complexContent> <extension base="impl:containered-asset"> <sequence> <!-- the array of children --> <element maxOccurs="1" minOccurs="0" name="children" nillable="true" type="impl:container-children"/> </sequence> </extension> </complexContent> </complexType>

As a result of there being two types of containers for Destinations, the parentTargetId and parentTargetPath elements of the destination complex type have been renamed to parentContainerId and parentContainerPath, respectively.

<!-- For defining the parent target relationship REQUIRED When inside a Site, this field must refer to a SiteDestinationContainer. When not in a Site, this field must refer to a Target --><choice> <element maxOccurs="1" minOccurs="1" name="parentContainerId" type="xsd:string"/> <element maxOccurs="1" minOccurs="1" name="parentContainerPath" type="xsd:string"/> </choice>

Sites

A number of new fields have been added to sites in 6.0.1 and are listed below.  These fields correspond to relationships that are now available in the UI.

<!-- Define the site asset factory container relationship here This asset factory container will determine which asset factories show on that user's dashboard under the "My New Content Wizards" section in the site. NOT REQUIRED default: none --> <choice> <element maxOccurs="1" minOccurs="0" name="siteAssetFactoryContainerId" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="siteAssetFactoryContainerPath" type="xsd:string"/> </choice> <!-- Define the site starting page relationship here This starting page will override the global starting page set in the system preferences NOT REQUIRED default: none --> <choice> <element maxOccurs="1" minOccurs="0" name="siteStartingPageId" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="siteStartingPagePath" type="xsd:string"/> </choice>

Asset Factories

Asset factory plugins can now be preserved when editing an Asset Factory via web services.  A new field has been added to the assetFactory complex type, called plugins, which will contain any Asset Factory plugins that have been assigned to the Asset Factory via the Cascade GUI.  Along with this field are a number of supporting complex types that represent dependent plugin properties.

<!-- An array of asset factory plugins assigned to the asset factory NOT REQUIRED default: empty --><element maxOccurs="1" minOccurs="0" name="plugins" type="impl:asset-factory-plugins"/>

<!-- complex type wrapping a list of asset factory plugins --> <complexType name="asset-factory-plugins"> <sequence> <element maxOccurs="unbounded" minOccurs="0" name="plugin" type="impl:asset-factory-plugin"/> </sequence> </complexType> <complexType name="asset-factory-plugin"> <sequence> <!-- Name of the asset factory plugin - this is the exact class, like "com.cms.assetfactory.DisplayToSystemNamePlugin" REQUIRED --> <element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="parameters" type="impl:asset-factory-plugin-parameters"/> </sequence> </complexType> <!-- complex type wrapping a list of asset factory plugin parameters --> <complexType name="asset-factory-plugin-parameters"> <sequence> <element maxOccurs="unbounded" minOccurs="0" name="parameter" type="impl:asset-factory-plugin-parameter"/> </sequence> </complexType> <complexType name="asset-factory-plugin-parameter"> <sequence> <!-- Parameter name (not label), for example "assetfactory.plugin.filelimit.param.name.size" REQUIRED --> <element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/> <!-- Parameter value NOT REQUIRED default: empty string --> <element maxOccurs="1" minOccurs="0" name="value" type="xsd:string"/> </sequence> </complexType>

Sites

With the addition of Sites, the web services API has been augmented to allow for the manipulation of assets that live either inside a Site or in the Global Area.  The path element in an asset identifier has been converted into a complex type that must contain a string representing the path of the asset as well as either the site id or site name of the Site to which the asset belongs.  If both the site id and site name fields are left empty, then the asset is assumed to exist in the Global Area.

<element maxOccurs="1" name="path" type="impl:path"/>

<complexType name="path"> <sequence> <element maxOccurs="1" name="path" type="xsd:string"/> <choice> <element maxOccurs="1" name="siteId" nillable="true" type="xsd:string"/> <element maxOccurs="1" name="siteName" nillable="true" type="xsd:string"/> </choice> </sequence> </complexType>

When editing or creating an asset via web services, it is possible to specify the site to which the asset should belong by populating the site id or site name.  A siteId and siteName element have been added to the folder-contained-asset complex type as well as the containered-asset to allow for this.

<!-- The site in which the asset is located NOT REQUIRED --><choice> <element maxOccurs="1" minOccurs="0" name="siteId" nillable="true" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="siteName" nillable="true" type="xsd:string"/> </choice>

Site assets themselves can also be manipulated via web services.  A site complex type has been added and is displayed below along with two supporting complex types: role-assignments and role-assignment.  The two supporting complex types allow for the assigning of Roles and Users to a particular Site similar to how they would be assigned through the UI.

<complexType name="site"> <complexContent> <extension base="impl:named-asset"> <sequence> <!-- The site url REQUIRED--> <element maxOccurs="1" minOccurs="1" name="url" type="xsd:string"/> <!-- The default metadata set for the site REQUIRED --> <choice> <element maxOccurs="1" minOccurs="0" name="defaultMetadataSetId" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="defaultMetadataSetPath" type="xsd:string"/> </choice> <!-- File containing css for the site NOT REQUIRED --> <choice> <element maxOccurs="1" minOccurs="0" name="cssFileId" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="cssFilePath" type="xsd:string"/> </choice> <element maxOccurs="1" minOccurs="0" name="cssClasses" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="roleAssignments" type="impl:role-assignments"/> <!-- Whether or not to publish this target on a schedule NOT REQUIRED default: false --> <element maxOccurs="1" minOccurs="0" name="usesScheduledPublishing" type="xsd:boolean"/> <!-- The base time this target will be published. For example if one wanted this target to publish at 0100, 0500, 0900, 1300, 1700, 2100, I would enter one of those times here and set the "publishInterval" to 4, and the "publishIntervalUnits" to "hours" NOT REQUIRED default: 00:00 (midnight) --> <element maxOccurs="1" minOccurs="0" name="timeToPublish" type="xsd:time"/> <!-- The interval at which this target will be published NOT REQUIRED default: 1 --> <element maxOccurs="1" minOccurs="0" name="publishInterval" type="xsd:nonNegativeInteger"/> <!-- The time unit for publishInterval NOT REQUIRED default: "hours" --> <element maxOccurs="1" minOccurs="0" name="publishIntervalUnits" type="impl:timeUnits"/> <!-- The root folder id and containers idds - used only when reading a site. Unused in other cases NOT REQUIRED ignored --> <element maxOccurs="1" minOccurs="0" name="rootFolderId" nillable="true" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="rootAssetFactoryContainerId" nillable="true" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="rootPageConfigurationSetContainerId" nillable="true" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="rootContentTypeContainerId" nillable="true" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="rootStructuredDataDefinitionContainerId" nillable="true" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="rootMetadataSetContainerId" nillable="true" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="rootPublishSetContainerId" nillable="true" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="rootSiteDestinationContainerId" nillable="true" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="rootTransportContainerId" nillable="true" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="rootWorkflowDefinitionContainerId" nillable="true" type="xsd:string"/> </sequence> </extension> </complexContent> </complexType> <complexType name="role-assignments"> <sequence> <element maxOccurs="unbounded" minOccurs="0" name="roleAssignment" type="impl:role-assignment"/> </sequence> </complexType> <complexType name="role-assignment"> <sequence> <choice> <element maxOccurs="1" minOccurs="0" name="roleId" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="roleName" type="xsd:string"/> </choice> <!-- comma delimited list of usernames --> <element maxOccurs="1" minOccurs="0" name="users" type="xsd:string"/> <!-- comma delimited list of group names --> <element maxOccurs="1" minOccurs="0" name="groups" type="xsd:string"/> </sequence> </complexType>

Roles

Role manipulation has also been added to the web services API in Cascade 6.0.  Below is the role complex type which is used to create and edit Roles.  Each Role requires a role type.  Notice the simpleType role-types which declares the two valid values for the roleType element: site or global. 

Site Roles can only be assigned to Sites; while Global Roles are only assigned to Users and Groups.

<!-- A role --> <complexType name="role"> <complexContent> <extension base="impl:named-asset"> <sequence> <!-- The type of the role NOT REQUIRED --> <element maxOccurs="1" minOccurs="1" name="roleType" type="impl:role-types"/> <!-- The global or site abilities for the role - use correct one depending on the type of the role REQUIRED --> <choice> <element maxOccurs="1" minOccurs="1" name="globalAbilities" type="impl:global-abilities"/> <element maxOccurs="1" minOccurs="1" name="siteAbilities" type="impl:site-abilities"/> </choice> </sequence> </extension> </complexContent> </complexType> <!-- The types of roles. --> <simpleType name="role-types"> <restriction base="xsd:string"> <enumeration value="site"/> <enumeration value="global"/> </restriction> </simpleType>

The Abilities available to a particular Role will differ depending on the type of Role.  The two sets of abilities overlap but have been split into two distinct complex types: global-abilities and site-abilities.  Notice that the role" complex type requires either a set of global abilities or a set of site abilities.

<!-- global role abilities --> <complexType name="global-abilities"> <sequence> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="globalAdmin" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="bypassAllPermissionsChecks" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessSiteManagement" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="createSites" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="uploadImagesFromWysiwyg" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="multiSelectCopy" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="multiSelectPublish" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="multiSelectMove" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="multiSelectDelete" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="editPageLevelConfigurations" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="editPageContentType" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="publishReadableHomeAssets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="publishWritableHomeAssets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="viewPublishQueue" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="reorderPublishQueue" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="cancelPublishJobs" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="editAccessRights" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="viewVersions" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="activateDeleteVersions" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessAudits" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="bypassWorkflow" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="assignApproveWorkflowSteps" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="deleteWorkflows" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="breakLocks" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="assignWorkflowsToFolders" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="bypassAssetFactoryGroupsNewMenu" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="bypassDestinationGroupsWhenPublishing" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="bypassWorkflowDefintionGroupsForFolders" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="alwaysAllowedToToggleDataChecks" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessAdminArea" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessAssetFactories" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessConfigurationSets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessDataDefinitions" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessMetadataSets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessPublishSets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessTargetsDestinations" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessTransports" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessWorkflowDefinitions" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessContentTypes" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessAllSites" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="viewSystemInfoAndLogs" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="forceLogout" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="diagnosticTests" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessSecurityArea" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="publishReadableAdminAreaAssets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="publishWritableAdminAreaAssets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="newSiteWizard" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="integrateFolder" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="importZipArchive" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="optimizeDatabase" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="syncLdap" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="bulkChange" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="configureLogging" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="searchingIndexing" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessConfiguration" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="editSystemPreferences" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="siteMigration" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="viewUsersInMemberGroups" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="viewAllUsers" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="createUsers" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="deleteUsersInMemberGroups" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="deleteAllUsers" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="viewMemberGroups" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="viewAllGroups" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="createGroups" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="deleteMemberGroups" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessRoles" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="createRoles" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="deleteAnyGroup" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="editAnyUser" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="editUsersInMemberGroups" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="editAnyGroup" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="editMemberGroups" type="xsd:boolean"/> </sequence> </complexType> <!-- site role abilities --> <complexType name="site-abilities"> <sequence> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="bypassAllPermissionsChecks" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="uploadImagesFromWysiwyg" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="multiSelectCopy" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="multiSelectPublish" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="multiSelectMove" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="multiSelectDelete" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="editPageLevelConfigurations" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="editPageContentType" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="publishReadableHomeAssets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="publishWritableHomeAssets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="editAccessRights" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="viewVersions" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="activateDeleteVersions" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessAudits" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="bypassWorkflow" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="assignApproveWorkflowSteps" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="deleteWorkflows" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="breakLocks" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="assignWorkflowsToFolders" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="bypassAssetFactoryGroupsNewMenu" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="bypassDestinationGroupsWhenPublishing" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="bypassWorkflowDefintionGroupsForFolders" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessAdminArea" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessAssetFactories" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessConfigurationSets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessDataDefinitions" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessMetadataSets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessPublishSets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessDestinations" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessTransports" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessWorkflowDefinitions" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="accessContentTypes" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="publishReadableAdminAreaAssets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="publishWritableAdminAreaAssets" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="integrateFolder" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="importZipArchive" type="xsd:boolean"/> <!-- NOT REQUIRED - default false --> <element maxOccurs="1" minOccurs="0" name="bulkChange" type="xsd:boolean"/> </sequence> </complexType>

Page Configurations

A number of new fields have been added to the pageConfiguration complex type in order to support the manipulation of Configuration Sets that reside in a Site.  These fields are displayed below.  When editing a global Configuration Set, these new fields will be ignored because they do not apply.  When editing a Configuration Set that lives in a Site, these fields will be used.

<!-- The output file extension, for example ".html" Only required when in a site --> <element maxOccurs="1" minOccurs="0" name="outputExtension" nillable="true" type="xsd:string"/> <!-- The content type this target serializes its output as Only required when in a site --> <element maxOccurs="1" minOccurs="0" name="serializationType" nillable="true" type="impl:serialization-type"/> <!-- When the serializationType is "XML", should Cascade include the XML declaration in published files? NOT REQUIRED default: false --> <element maxOccurs="1" minOccurs="0" name="includeXMLDeclaration" nillable="true" type="xsd:boolean"/> <!-- Is this configuration publishable? --> <element maxOccurs="1" minOccurs="0" name="publishable" nillable="true" type="xsd:boolean"/>

Templates

To allow for Templates to be created or edited in a Site, the target element of the template complex type is no longer required.

<!-- For defining the target relationship NOT REQUIRED when template is inside of site REQUIRED when template is in global area --><choice> <element maxOccurs="1" minOccurs="0" name="targetId" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="targetPath" type="xsd:string"/> </choice>

Index Block Updates

• The complex type indexBlock has a new optional field, indexBlockType, that refers to a simple type index-block-type.  This field can be set to either folder or content-type. The default value is folder:

<element maxOccurs="1" minOccurs="0" name="indexBlockType" type="impl:index-block-type"/>

<simpleType name="index-block-type"> <restriction base="xsd:string"> <enumeration value="folder"/> <enumeration value="content-type"/> </restriction> </simpleType>

• The complex type indexBlock now also has two additional fields allowing the User to provide either a Content Type id or Content Type path:

<choice> <element maxOccurs="1" minOccurs="1" name="indexedFolderId" type="xsd:string"/> <element maxOccurs="1" minOccurs="1" name="indexedFolderPath" type="xsd:string"/> <element maxOccurs="1" minOccurs="1" name="indexedContentTypeId" type="xsd:string"/> <element maxOccurs="1" minOccurs="1" name="indexedContentTypePath" type="xsd:string"/> </choice>

• The name of the simple type index-block-sort-order that is being used by sortMethod in the complex type indexBlock has been renamed to index-block-sort-method

<element maxOccurs="1" minOccurs="0" name="sortMethod" type="impl:index-block-sort-method"/>

<simpleType name="index-block-sort-method"> <restriction base="xsd:string"> <enumeration value="folder-order"/> <enumeration value="alphabetical"/> <enumeration value="last-modified-date"/> <enumeration value="created-date"/> </restriction> </simpleType>

• The complex type indexBlock has a new optional field sortOrder that refers to a simple type index-block-sort-order that can be either ascending or descending. The default value is ascending:

<element maxOccurs="1" minOccurs="0" name="sortOrder" type="impl:index-block-sort-order"/>

<simpleType name="index-block-sort-order"> <restriction base="xsd:string"> <enumeration value="ascending"/> <enumeration value="descending"/> </restriction> </simpleType>

XSLT and Script Format Updates

• The complex type stylesheet has been renamed to xsltFormat.
• A new complex type scriptFormat with the following schema has been added:

<complexType name="scriptFormat"> <complexContent> <extension base="impl:folder-contained-asset"> <sequence> <element maxOccurs="1" minOccurs="1" name="script" type="xsd:string"/> </sequence> </extension> </complexContent> </complexType>

• The stylesheetId and stylesheetPath fields of the template, pageConfiguration, and pageRegion complex types have been renamed to formatId and formatPath, respectively.
• The complex type asset has had two fields, xsltFormat and scriptFormat, added and the stylesheet field has been removed.

<element maxOccurs="1" minOccurs="1" name="xsltFormat" nillable="true" type="impl:xsltFormat"/> <element maxOccurs="1" minOccurs="1" name="scriptFormat" nillable="true" type="impl:scriptFormat"/>

• The stylesheet field has been removed from the asset and asset-read complex types.

Transport and Transport Container Updates

• A new complex type has been added, transportContainer, which allows Transport Containers to be manipulated via web services.

<complexType name="transportContainer"> <complexContent> <extension base="impl:containered-asset"> <sequence> <!-- the array of children --> <element maxOccurs="1" minOccurs="0" name="children" nillable="true" type="impl:container-children"/> </sequence> </extension> </complexContent> </complexType>

• The ftpTransport and fileSystemTransport complex types have been modified so that they extend the containered-asset complex type.  This allows for Transports to be created/edited with a specified container.

• 4 new values have been added to the entityTypeString simple type: format_XSLT, format_SCRIPT, format, and transportcontainer.  The value stylesheet has been removed.

© 2001-2012 Hannon Hill Corporation

Site Index | HH Internet | KB Feedback

Contact Us: Online Form | +1.678.904.6900