XMLPublications.saveFormat (Method)
Saves or updates an XML publication format.
Returns:
Void
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| id | XMLPublicationFormatID_0 | Required | An XML publication definition's ID. If this value is 0, CommonSpot create a new format instead of updating an existing one. |
| definitionID | XMLPublicationDefinitionID | Required | The ID of the publication definition to which the format will be bound. This value is required if CommonSpot will create a new format and Ignored when it updates an existing one. |
| name | XMLFormatName | Required | The name of an XML publication's format. |
| description | PlainText_NonNull_2000 | Required | The description of an XML publication's format. |
| xsltModule | ModulePath_EmptyString | Optional. Defaults to an empty string. | The full path name to the XSLT module. If this is an empty string, a module is not associated with this format, which means raw XML is displayed in your browser. |
| xsltModuleType | XSLTModuleType_EmptyString | Optional. Defaults to an empty string. | String containing a XSLT module's module type, which can be 'Existing', 'Explicit' or empty string if no XSLT module is specified. |
| supportSyndication | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true indicates that the publication format supports syndication. |
| syndicationType | SyndicationType_EmptyString | Optional. Defaults to an empty string. | A syndication format type (0--application/atom+xml--or 1--application/rss+xml). If this is an empty string, the format does not support syndication. |
Context:
| License Requirements | None |
| Permission Requirements | site:ManageXMLPublications |
| Deny Context | None |
| Require Context | AuthoringEnabled |
| Author Lock | (not required) |
| Transaction Logging | If transaction logging is enabled at the site level, calls to this method will be logged |
| Customization | This method may be customized at the site level |
Error Codes:
| Code | Error Message |
|---|---|
| 65004 | The XML publication output format name of '$1' is already set. |
| 65005 | The '$1' XML publication format already exists using the specified publication definition and XSL transformation. Choose another XSL Transformation or edit the '$1' XML Publication Format. |
| 65006 | The specified $1 XSLT module '$2' does not exist. |
| 65008 | You must provide a syndication type if the support syndication property is active. |
| 65014 | You cannot edit or delete information for an inactive XML publication format. |
| 65015 | You cannot change the publication definition while editing the XML publication format. |
| 65026 | Please specify the module type ('Existing' OR 'Explicit') for the specified XSLT module. |
| 65027 | Please specify the full path of the explicit XSLT Module. |
Notes:
None