Generating a publication

Complete these steps to generate a publication using the LiveContent Central Publish tool.

Before you begin

  • The following LiveContent Central services must be installed and running: Publish service, Discovery service, Distribution service, Content service and Deployer service.
  • The user must have sufficient read-write permissions to create and modify configuration, data, and status log files in their respective directories.

Procedure

  1. Launch the LiveContent Central Publish tool.
    1. In Windows File Explorer, navigate to folder containing the LiveContentPublishUI.exe executable (by default[LCC_home]\publish-service\PublishUI).
    2. Launch the executable using Run as Administrator.
    The Publish tool launches as a windows application.
  2. In the landing page, you will find the default passwords populated into the Publish service ID password and Distribution service ID password fields. They are required to publish and distribute any publication. If you have modified the passwords (clientSecret in the application.yml file), you will need to enter the new passwords when you launch the Publish tool.
  3. From the LiveContent Central Publish home screen, select Publications.
    The Publication List displays a list of the available publications.
  4. Select Add.
    The Publication Configuration Builder appears. The tool publishes to the LiveContent Central Publish service implementation.
  5. Make entries to the following fields.
    FieldDescription
    IDRequired.

    ID of the publication. This value must be unique, can be up to 40 characters in length, and cannot contain special characters.

    NameRequired.

    Name of the publication.

    This value can be up to 256 characters in length and cannot contain special characters.

    Module FileRequired.

    The publication module (prefix PMC) for the publication in the folder named user-publication/source_xml.

    Browse to the publication module file.

    Windows allows up to 260 for the file path, which cannot contain special characters.

    TitleRequired.

    Free text title of the publication.

    This value can be up to 256 characters in length and cannot contain special characters.

    IssueRequired.

    S1000D 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.

    DateRequired.

    Date of the publication. This field defaults to the current date. Use the calendar widget to select a different date.

    NumberRequired.

    Number of the publication.

    This value can be up to 40 characters in length and cannot contain spaces or special characters.

    DescriptionRequired.

    Description of the publication.

    This value can be up to 256 characters in length and cannot contain special characters.

    ModelRequired.

    Model of the publication.

    This value can be up to 40 characters in length and cannot contain spaces or special characters.

    LanguageOptional.

    Language code of the publication in lowercase characters. This field defaults to en.

    This value can be up to 40 lowercase characters in length.

    Change LevelRequired.

    The change level of the publication.

    This value can be up to 8 numbers in length.

    Custom ContentOptional.

    This 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. This value can be retrieved using Content service's getCustomContentOfPublication API. This value can be up to 10KB in length.

    Example values:
    <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>
    Overwrite previously published dataOptional.

    Option to overwrite publication data.

    Select this option to overwrite any previously published data during republishing. This checkbox is unselected by default.

  6. Select Next.
    The tool displays a summary of the values you entered.
  7. Select Publish to launch the publish process using these values, or Cancel to return to the Publication Configuration Builder to make changes.
    The Status window displays information about the progress of the process.
  8. Select Finish.
    The Publication List appears, including the new publication in the list.

    When the process completes, the status of the publication in the Publication List changes to Complete, which appears as a link with an icon indicating success or failure. Select this link to view the process log.

Results

The LiveContent Central Publish tool does the following.
  • Updates the PublicationsData.xml file in the [LCC_home]publish-service/PublishUI/publishData directory.
  • Creates a DML file for the publication if applicability is configured to do so.
  • Updates the publication_PUBLICATION-ID.txt status log file in the locationToStoreData/publishData/logs directory, or creates it if does not exist.
  • Saves the value of Custom Content at[LCC_home]/publish-service/PublishUI/publishData/customContent/customContent-PUBLICATION-ID.txt, if it exists.