Publication configuration directives

The publication_s1000d.xml publication configuration file contains a number of required and optional configuration directives.

LiveContent Central directives

The following table describes each of the directives listed in the publication_s1000d.xml file.

CategoryFieldRequired/OptionalDescription
CollectionnameRequiredThe name of the collection that the publication will register in, such as default. This value can be up to 62 characters in length and cannot contain special characters other than underscores(_).
descriptionOptionalDescription of the collection. This value can be up to 1000 characters in length and cannot contain special characters.
PublicationbookNameRequiredName of the publication, such as s1000d_bike_41. This value can be up to 62 characters in length and cannot contain special characters other than underscores(_).
nameRequiredName of the publication. This value can be up to 512 characters in length and cannot contain special characters other than underscores(_).
titleRequiredFree text title of the publication. This value can be up to 512 characters in length and cannot contain special characters except underscore.
descriptionOptionalDescription of the collection. This value can be up to 512 characters in length and cannot contain special characters.
modelRequiredModel of the publication. This value can be up to 40 characters in length and cannot contain spaces or special characters other than underscores(_).
specNumberOptionalS1000D Issue of the publication. This value can be up to 8 characters in length, consisting only of numbers and a dot, such as 4.0.
pubNumberRequiredNumber of the publication. This value can be up to 150 characters in length and cannot contain spaces or special characters other than underscore(_).
dateOptionalDate of the publication. This field defaults to the current date. Use the calendar widget to select a different date. This value is of the MM/DD/YYYY format.
changeLevelOptionalThe change level of the publication. This value can be up to 8 numbers in length.
searchTypeOptionalThe list of search categories. This value can be up to 350 characters in length. See Configuring search categories for a publication for more details.
uiLanguage OptionalLanguage code for the localization in characters. The ISO language code for the desired language, such as es for Spanish or it for Italian. This field defaults to EN. This value can be up to 8 lowercase characters in length.
languageOptionalLanguage code of the publication in characters. This field defaults to en_US. This value can be up to 8 lowercase characters in length.
settingsOptionalThe semicolon(;) delimited list of configuration items which can control UI behavior. This value can be up to 64MB in length.

Example value: settings="show_steps_checkbox=1;show_security_banners=1"

versionRequiredThe LiveContent Central publication version. This field is used to update a publication version or rollback to restore to a previous version.
customContentOptionalThis field allows the user to send additional information about the publication. This set of characters must be a well-formed XML concatenated as a single string and wrapped in the <customContent></customContent> tag. This value can be retrieved using Content service's getCustomContentOfPublication API. This value can be up to 10KB in length.
Example values:
<customContent><cMetadata name="publication-ID"><value>1</value>
</cMetadata><cMetadata name="publication-code"><value>BIKE_50</value>
</cMetadata><cMetadata name="Issuenumber"><value>03</value></cMetadata>
<cMetadata name="Inworknumber"><value>00</value></cMetadata>
<cMetadata name="Languagecode"><value>en-US</value></cMetadata>
<cMetadata name="Doc-manufacturer-number"><value>017-400</value> 
</cMetadata><cMetadata name="SAP-number"><value>1</value></cMetadata>
<cMetadata name="Contract-number"><value>47 086 151</value></cMetadata></customContent>

LiveContent S1000D Required directives

Some legacy LiveContent S1000D configuration directives are either obsolete, renamed, or not supported for the early access release of LiveContent Central. The table below lists LiveContent S1000D required directives and explains whether these directives are available in LiveContent Central

LiveContent S1000D required directivesLiveContent Central
OutputDBNameObsolete. The attribute bookName of the Publication element is used instead of OutputDBName.
XMLInputDirectoryThis is an archive attachment passed to the Publish API as a file parameter.
PubModuleThe pmcFile is a part of the source XML directory.
OutputDirectoryObsolete.
TempDirectoryObsolete.
LogFileLocationObsolete.
DTDTypeNot supported.
ParserTypeNot supported.
ExtraConfigNot supported.
WriteXMLNot supported.
DebugModeNot supported.

LiveContent S1000D Optional directives

The following table lists the LiveContent S1000D optional directives and explains whether they are supported in LiveContent Central.

LiveContent S1000D Optional directivesLiveContent Central
ExpandRefPmCan be configured with lcccollectionpub.properties to use with the command line binary (or) can be configured with the Publish tool using config.xml.
ExpandRefDmForWCNCan be configured with lcccollectionpub.properties to use with the command line binary (or) can be configured with the Publish tool using config.xml.
UseTechnameObsolete.
TitleDelimiterObsolete.
TitleOrderObsolete.
TocTitleDisplayRefer to Customizing the TOC
pdf.remove_imagesYou can find this configuration in Content service's application.yml.
EntityDefLocationRefer to Configuring ISO entities
IncludeISOEntitiesRefer to Configuring ISO entities
CIRApplicResolveCan be configured with lcccollectionpub.properties to use with the command line binary (or) can be configured with the Publish tool using config.xml.
ACTCatalogModuleNot supported.