Documentation Center

PublicationOutput 2.5 Create

Creates a new publication, version and/or publication output in the Content Manager repository.


Parameters

NameTypeDirectionDescription
psAuthContextStringInOutDeprecated proprietary authentication context only used by .ASMX web services based on internal username/password authentication. Claims based security standards drive all the WCF .SVC web services, making this parameter redundant.
plFolderRefLongInIdentifier of the folder.
psLogicalIdStringInOutThe logical identifier of the object.
  • If no identifier is specified, a new GUID is generated.
  • When an identifier is supplied, the identifier must comply with the element name limitations .
psVersionStringInOutThe version of the object. When no exact version is given, the version number will be returned.
psOutputFormatStringInThe name of the output format (e.g. Manual, Online Documentation, Booklet, Compiled Help,...).
psLngCombinationStringInThe ordered list of languages separated by the '+' character indicating the languages used in the content of the object.
psXMLMetadataStringInMetadata XML structure with the metadata that will be set on the current object.

Requirements are:
  • The user has write access to the folder of the Publication.
  • The mandatory field requirements for each created level have to be met. So the function parameters and especially the content of parameter psXMLMetaData need to specify all mandatory metadata for the object that is created.
  • The OutputFormat and Language Combination cannot already exist under the Publication version.
Some how-to scenarios.
  • How to create a logical level only?

    • The parameters psVersion, psOutputFormat and psLngCombination have to be empty,
    • The parameter psXMLMetadata may not contain any version-level nor language-level fields.
  • How to create a version level only?
    • The parameters psOutputFormat and psLngCombination have to be empty,
    • The parameter psXMLMetadata may not contain any language-level fields.
  • How to create a language level?
    • Fill in all parameters.
Note that:
  • The folder id can be set to empty ('') when the logical object is already present in the repository. When the object is already present and a folder id is provided, then the provided identifier has to match the identifier of the folder that contains the object.
  • All logical identifiers within Content Manager are in uppercase.
  • The ownership for an object in the repository is inherited from the folder that contains the object.