Publish one project component with tokens

You can use characters reserved for XPath and system variables in the publishing job Name. This lets you pull in data so you don't have to type it in every time you send the project component out for publishing. To publish a single project component with a token, you can use the Contents pane to find the components and then use the Options menu to select Publish.

You may not have permissions to publish under the following conditions:

  • A content owner or administrator can set permissions to deny access to components or folders. If your permissions to content has been blocked and you are not an administrator, you can use the Publish option in a project's Content pane, but it will fail with a warning.
  • An Inspire administrator can define at the user and role level whether the Publish action is available.
    • By default, only administrators can publish content in Inspire.
    • You can see the Publish option only if you're an administrator or have the can_publish module property.

Tips and tricks

  • Set notifications: If you have changed the defaults and want to see publishing notifications, make sure you configure them before publishing. Follow the steps in Set notification preferences for publishing.
  • Use a Publish Configuration. The same settings on the Publish Component screen can also be set by an administrator in the Publish Configuration.
    • If you select options on the Publish Component screen, your settings are used even if they are in conflict with the Publish Configuration that an admin creates.
    • If you select options on the Publish Component screen that don't conflict with the Publish Configuration that an admin creates, then both sets of options are used.
  • Publish a map with a DitaVal file: Ditaval files specify the conditions to include and exclude when you generate your map's output. DitaVal files are useful if you're using conditional attributes extensively in your documentation. If you're publishing a map, follow the steps in: Publish from a map.
  • Tokens can also be used in a publishing profile. For help using tokens in a publishing profile, follow the steps in Publish from a profile 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.

To publish one project component with tokens:

  1. Click Projects_TopMenuOpt Projects.
  2. On the Project Management tab, double-click the row of the project that contains the component you want to publish.
    You can also open the project by:
    • Select the row, right-clicking, and selecting Open.
    • Select the row, clicking Action_Menu the Options menu, and selecting Open.
  3. On the project tab, in the Content pane, to open the Content folder, click the expand arrow Expand folder.
  4. To select a component, click the name.
  5. Next to the component name, click Action_Menu the Options menu, and then select Publish.

    Result: The Publish Component screen opens.

    You only see the Add Ditaval button if you are publishing a map.

  6. On the Publish Component screen, by default, Inspire provides a Publish Name for your publishing request (job) using the project component's File Name without the GUID.

    Make sure that if you're choosing a Publishing Configuration, it does not include a Publish Name.

    • If the configuration includes a Publish Name, it overwrites any tokens previously used or entered into this field.
    • If the configuration does not include a Publish Name, you can include a token.

    To add a token, do the following:

    • To the name, add a token using the following format:
      {$variable}

    • To create multiple tokens, use the following format:

      {$variable}-{$variable}-{$variable}
    • The total number of characters used in the name cannot exceed 1000. If you include multiple tokens in the Publish Name, and the final Publish Name exceeds 1000 characters, then you see a warning.
      • The Publish Name will be truncated.
      • The tokens will still be used but with a truncated final name.
    • Important:
      • Replace variable with the name of a system variable used by Inspire.
      • If you add a variable to the publishing job Name that XPath can't find, the component is published and Inspire adds the unknown variable as text to the job Name. For example: MyMap_{$blueskies}
        • In your notifications you see a publishing job 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.
      • You can use up to 1000 characters to specify tokens. However, if the resolved tokens are more than 1000 characters, they will be truncated.
  7. Optionally, on the Publish Component screen, in Publish Configuration, select the option that contains the publish settings you want to use.

    This configuration is created by an administrator and includes settings such identifying the export process to use, validating XML, and using profiling attribute filters.

    If the Publish Configuration contains a Publish Name, it will overwrite your custom name and the tokens you just added.

    • You can clear the name used in the Publish Configuration and re-enter your custom name and tokens.
    • You can also ask your administrator to add the tokens to the Publish Configuration so it will always be available in the Publish Name.
    An administrator can choose a Publish Configuration to be shown automatically as the default. If you need to use something other than the default, you can select another option.

    The same settings on the Publish Component screen can also be set by an administrator in the Publish Configuration.

    • If you select options on the Publish Component screen, your settings are used even if they are in conflict with the Publish Configuration that an admin creates.
    • If you select options on the Publish Component screen that don't conflict with the Publish Configuration that an admin creates, then both sets of options are used.
    For some customers, Inspire provides a publishing configuration and a publishing plug-in for DOCX. If it's supported for your organization, you can select the Publish Docx option
  8. In Export Configuration (Publish), select the format you want the output to be in, for example PDF or HTML.

    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.

  9. When you're publishing a map, you can optionally select a DitaVal file that already exists in Inspire.

    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.
    1. On the Publish Component screen, click Add Ditaval.
    2. On the Add Ditaval screen, click Add.
    3. On the Select Components screen, search for or browse to the folder where the Ditaval file is saved.
    4. Select the checkbox for a DitaVal file and click Select.

      Result: On the Add Ditaval screen, the file you selected is listed.

      • If you selected multiple files, only the first file (#1) is used.
      • Make note of the file you selected.
        • Your selection is not shown on the Publish Component screen.
        • If you select the Add Ditaval button again, the screen will be blank and you will have to re-select the DitaVal file you want to use when publishing
    5. On the Add Ditaval screen, select Save.

      Result: You don't see the name of any DitaVal file you've applied on the Publish Component screen. (However, there are future plans to display the selected DitaVal on the Publish Component screen.)

      If you select the Add Ditaval button again, the screen will be blank and you will have to re-select the DitaVal file you want to use when publishing.

  10. If you've applied profiling attributes to content in the component you're publishing, you can use filters.

    1. To choose the profiling attributes you want included in the publishing job, click Add Filter.
    2. On the Filter profiling attributes tab, do any of the following:
      • Select the individual options you want to transform the content you are publishing.
      • In Saved Filters, select a defined collection of attribute filters.
    3. On the Filter profiling attributes screen, click Select.

      Result: You see the profiling attributes you select on the Publish Component dialog, listed after the Clear Filter button

  11. If you want to verify that your XML code in your component is valid according to your framework at the time of publishing, select the Validate XML option.

    By default this option is not selected.
  12. If you want to import the published deliverable back into Inspire automatically, select Create Attachment.
    1. In Target Folder, select the location where you want the publish deliverable saved.

      The file is saved as a binary. By default, it is 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.

  13. To add a snapshot to the history for this component and all referenced content, click Create snapshot.

    1. On the Create snapshot dialog, in Name, enter a descriptive title for the version in 50 characters or less.
    2. Optionally, in Comment, enter additional information differentiating this version from other snapshots in 2000 characters or less.
    3. On the Create snapshot dialog, click Create.
    Result: You see a component snapshot labeled On Demand on the History tab. Look in Component details for a list of the components that were included when you created the snapshot. Follow the steps in: View a snapshot
  14. On the Publish Component dialog, click Publish.
    Result:

    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 name. By default, when you select one component to publish, Inspire provides a Publish Name using the component's File Name without the GUID.
      • The Publish Name you use on the Publish Component screen is shown on the Publish portal in the Title column.
      • If you use a token in 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 Title 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 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 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 a 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 Publish 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 in Publish Server.
      • 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

    You can use Publish Server to see job status and histories, download files related to a job, and re-publish content from an existing job. To learn about job management, read Welcome to Publish Server.
    • Open Publish Server from a link in the following places:
    • For the following Inspire publishing formats, you download a ZIP file that includes multiple files:
      • HTML
    • For the following publishing formats, you download a single standalone file:
      • PDF
      • DocBook PDF
      • DocBook HTML
      • DOCX
    • When you use the Zoomin publishing option, you must open the notification and use the link to go to the Zoomin site.
    • For custom publishing options, you can configure the publishing deliverables.