Publish a component from a profile

• Optionally, you can change the Publish Name to a different set of characters.
  • Use 1000 characters or less
  • You must use underscores (_) instead of spaces.
• Select a Publish Configuration to populate the Publish Name.
  • If the configuration includes a Publish Name, it overwrites anything previously used or entered into this field.
  • If the configuration does not include a Publish Name, you can leave the default of the component's File Name or enter a new name.

• If you leave Publish Name empty, Inspire uses the component's File Name without the GUID.

• To add a token to the Publish Name when publishing a component, follow the steps in Publish a component with tokens.

• Examples of ways you can use a token in the job's Publish Name field:

  • To add the name of the MyMap component, use {$componentname}

    Example Publish Name = MyMap

  • To add the topic title of the MyMap component, use {$title}

    Example Publish Name = UserManual

  • To add the file name of the MyMap component, use {$filename}

    Example Publish Name = MyMap_ceb80930-0712-48d2-92a5-9c2ee7d2ff7d.xml

  • To add the current date and time to the job name for MyMap, use {$datetime}

    Example Publish Name = MyMap2024-04-30-111017

  • To add the name of the user who created the publishing job for MyMap, use{$username}

    Example Publish Name = MyMapjanedoe@mycompany.org

  • To add the code for the language used in the component MyMap, use {$langcode}

    Example Publish Name = MyMapen-US

  • To add the name of the language used in the component MyMap, use {$langname}

    Example Publish Name = MyMapEnglish

  • If you need a system variable that isn't in the list of examples, contact your Inspire support representative.

Your configuration choice is used to create the output, even if it is in conflict with the Export Configuration (Publish) set in the Publish Configuration by an administrator.

Ditaval files specify the conditions to include and exclude when you generate your output. They ensure that conditions are always applied consistently to generated output. DitaVal files are useful if you're using conditional attributes extensively in your documentation.

Although you can select more than one DitaVal file, only the first file is used.

• Any other files listed after the first one are ignored.
• There are future plans for supporting multiple DitaVal files.

In the top-right corner, you see a message that Inspire is preparing your publishing job.

After Inspire successfully submits the job, you receive a notification that you can review on the Notifications tab, in Slack if it's configured for notifications, and in email.

When you complete a task that triggers a notification, such as publishing content, the Slack and email body contain:

• The notification with ten or less Issues, Errors, and Warnings.
• A link at the bottom of the message [See Full Version].
• You can click the [See Full Version] link to expand a section under the link with the full details.

• Finding your publishing request. By default, Inspire uses the Publish Name as it appears in the publishing profile.
  • The Publish Name is shown on the Publish portal in the Profile column.
  • If you use a token in the job's Publish Name, and Inspire can resolve it, the token appears in the following places with the token replaced by actual data:
    • On the Publish portal in the Profile column.
    • In the deliverable name using the following default format: Publish-{ComponentName}{token}-YYYY-MM-DD-HHHHMM. However, an administrator can configure Inspire to omit the timestamp from the published file name.
  • If you use a token in the job's Publish Name, and Inspire can resolve it, the token appears in the following notifications, if you have them turned on:
    • In-app publishing notifications for queued, submitted, and completed.
    • Slack publishing notifications for queued, submitted, and completed.
    • Email publishing notifications for queued, submitted, and completed.

  • If you add a variable to the job's Publish Name that XPath can't find, Inspire adds the unknown variable as text to all names and notifications except for the deliverable name.

    • For example, if you use a non-system variable:

      MyMap_{$blueskies}

      • In your notifications you see Publish Name of MyMap_{$blueskies}.
      • The name of the published deliverable will not include the unknown variable as text. Deliverables are named using the following default format: Publish-{ComponentName}-YYYY-MM-DD-HHHHMM. However, an administrator can configure Inspire to omit the timestamp from the published file name.

  • Keep the following naming issues in mind:

    • The job Name is not the same as the deliverable (published content) name.
      • You can create whatever Publish Name you want.
      • Deliverables are named by Inspire using the following default format: Publish-{ComponentName}-YYYY-MM-DD-HHHHMM. However, an administrator can configure Inspire to omit the timestamp from the published file name.
• Finding your deliverables.
  • You can download your deliverable from publishing notifications or on the Publish portal.
  • You can also find the deliverable in Inspire if you selected the Create Attachment option when you were configuring settings on the Publish Component screen. You can find a copy of the published deliverable in the Target Folder you selected.

  

  After the publishing job completes successfully:

  • A copy of the published deliverable is imported back into Inspire automatically as a binary file.

    

  • A relationship between the component you published and the deliverable that was imported is created.
    • In the Component's Browser, the component you published now has a black paperclip before its name. This indicates it references another component as an attachment.
    • In the Component's Browser, the published deliverable has a green paperclip before its name. This indicates it is referenced by an another component as an attachment.
    • For more information on attachment relationships, read See component attachments.

Tips and tricks