Publish one component with a token

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 component out for publishing. To publish a single component with a token, you can use the Components pane to find the components and then use the Options menu to select Publish.

Tips and tricks

  • If you don't see the Publish option, contact your administrator. An Inspire administrator can define whether the Publish action is available at the user and role level.
  • 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 component with a token:

  1. Click Components_TopMenuOpt Components.
  2. In the Folders pane, locate the one component that you want to publish.

    Tokens can only be used when publishing one component, or from a publishing profile. This is because the Publish Name field is hidden when you select more than one component to publish.

  3. In the Components pane, right-click the component and then select Publish.
  4. On the Publish Component screen, by default, Inspire provides a Publish Name for your publishing request (job) using the 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}
    • 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.
  5. Optionally, on the Publish Component screen, in Publish Configuration, select 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
  6. 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.

  7. 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, select the options you want to publish, and then click Select.
      You'll see the profiling attributes you select on the Publish Component dialog, listed after the Clear Filter button.
  8. 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.
  9. 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 and 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.

  10. 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.
    You'll 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.

  11. 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. This name is used to track the job.
        • 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 Work with 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:
      • In your notification after you submit a publishing job or Open and manage messages on the Notifications tab
      • On the Publishing tab by clicking Go to Publish Server
    • 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.