Release Notes 2023.2.4.0

Enhancements to content authoring

Use new features in Oxygen 25.1

Oxygen is an XML editor that lets you author and develop content using structured mark-up languages such as XML, XSD, Relax NG, XSL, DTD.

What's New in Oxygen XML Web Author 25.1.0?

User Interface Improvements
Customization and Integration
Component Updates
API Updates

For more details, read:

Open multiple components for editing

After you create or import XML components, you can open them to edit the content.

You can open one component at a time, or you can open multiple components.
When you open multiple components, Inspire lets you edit or view each one it its own tab.

For more details, read: Open multiple components for editing.

Use tool tips when editing as XML

If you want to edit XML code inline with the content in your document, you can use an option to see and edit your content in this way.

In the editor, select the More... menu, and then select Edit as XML.
You can now hover your cursor over any option in the toolbar to see a tool tip.

For more details, read: Edit content as XML in the editor.

Choose how a map displays when you open it

When you're organizing topics into a map's hierarchy, you can control how your map entries are displayed using the View menu on the toolbar.

By default, you see a Display mode of Topic titles.
You can go to the toolbar and select the Display mode option to change the view.
Inspire remembers your preference and uses it the next time you open the map.

For more details, read: Work with maps in the Oxygen editor.

Insert external images

When working in the Oxygen-based editor, you can insert links to images that aren't stored in Inspire as long as there is a valid URL to the location of the image.

This displays the image in Oxygen but does not store the image in Inspire.
The image is also included when you publish the topic.

In a DITA topic, the URL to the image file is inserted as the value of the @href attribute in an <image> element. For example:

<image href="https://www.mycompany.com/media/catalog/product/enel15c.jpg"/>

For more details, read: Insert an external image.

Insert a video into a component

When working in the Oxygen-based editor, you can insert a video into a topic.

The video displays in the topic with playback controls.
You can watch the video in Oxygen to make sure it's the one you want.

You can choose how to reference a video.

Import the video so that it's stored in Inspire, and referenced internally.
Specify a URL in the Oxygen editor instead of importing the file.

You can import the following video formats to Inspire:

MP4
WebM
OGG

If your file format isn't supported, you can insert a URL link to the video instead of importing it into Inspire.

For more details, read: Work with video in Oxygen.

Enhancements to component management

Require authentication with an electronic signature

As an Inspire administrator, you can force a user to type in their user name as a form of electronic signature when they're approving a component.

Now, the user will also be required to authenticate their account by entering their Inspire password.

For more details, read:

Admin users: Require electronic signatures
Non-admin users: Approve or unapprove a component

Change a component's name and file name

You can change a component's display name and file name if necessary.

Changing the Component Name affects the name you see in the Component's browser.
Changing the File Name changes the name you see when referencing a component.
You can't change the GUID part of a File Name.
You can rename a component in both the Component's browser and in projects.

An Inspire administrator can define at the user and role level whether the Rename... action is available.

For more details, read:

Admin users: Control who can rename components
Non-admin users:Rename a component

See new ZIP file names when exporting files

Exported components now use the following format:

Export-{Component Name}-{date/time}.zip

For example, Export-Cloud_Computing-2022-12-21-03588.zip
{Component Name} is the source component you select.
The Component Name is truncated after 50 characters.

For more details, read: Export content from the components browser

Select at least one Scope when searching processing instructions

If you are an administrator or have permissions, you can find text in a component only when it's inside a tag that provides information to the processing application.

On the Selected Components panel, after you click Find and Replace, you must enter your search criteria on the Find/Replace components screen.

One of the required parameters is Scope. You must select whether you want to search the name property, value property, or both properties in an instruction.

You must select at least one option. Otherwise, you won't be able to click the Report or Replace All buttons.

For more details, read:

Search in the Components browser using the Path column

You can find words or phrases in the Components browser using a content search. You do this by entering text in the Search box.

Previously, when running a basic search, Inspire looked for your criteria in the following columns in the Components browser:

ID
Name
Type
File Name
Updated Date (Date only, not the time)
Locked Date (Date only, not the time)

Now, when running a basic search, Inspire also looks for your criteria in the Path column.

For more details, read: Run a content search for components.

Create a component and automatically save the language in a new attribute

Whenever you create a new component, you must select the language that the content is written in.

The language you select is now automatically applied to the root level element in the xml:lang attribute.

For more details, read:

See an updated screen when importing content

As an Inspire user you can import content from an external location using the import feature.

To import a folder structure from the Components browser, after you select the files you want to import, you see a second screen showing you the list of files.

This screen (Step 2 of 4) has been updated to avoid confusion.
The following text has been removed: All files will be imported in the "" folder.

For more details, read:

See a message if you enter incorrect dates when searching the Event log

If you have permissions, you can find logged events including errors, warnings, fatal events, and information messages.

When you search for logged events, you can optionally filter the event list by a date range.

If you enter a date in the From field that comes after the date in the To field, you see:

A warning message: "The From date must be before the To date."
The order and filtering of the Event log list is not changed.

You can correct the dates and try again.

For more details, read: Search for logged events

See truncated names completely in tool tips

When you select multiple components in the Components browser, they are listed in the Selected Components pane.

It may not be clear which exact components are added when:

Multiple component names start with the same words
The component names are long

If there isn't enough screen space to display the entire name of a component, you can hover your cursor over the name to see it in its entirety.

For more details, read: Select multiple components from the Components browser.

Generate new IDs when using Save as…

Inspire provides multiple ways for you to save a component as a new one.

Save as...
Save as a copy...
Save as a branch

When creating the new component, you now have the option to Generate New IDs for all elements in the source component.

By default, this option is not selected.

If you select this option, all elements are assigned a new ID even if the element didn't have one in the source component.

If you leave this option unselected, only elements that had an ID in the source component are given new ones.

For more details, read:

Validate XML when you export and publish

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

By default this option is not selected.
Previously this option was called Skip XML Validation.

For more details, read:

Enhancements to project management

Find and replace project content

If you are an administrator or have permissions, you can now search for text in one or more project components without opening them.

After you select a non-binary, unlocked file from the Content pane, you can look in the Selected Components pane for the snowflake icon.
Selecting this option opens a screen that allows you to create a report on the number of times the search text appears.
You can also update a component without opening it by using the Replace option on the Find and Replace screen.
Inspire creates a report showing you how many times the text was found and replaced.

The same find and replace functionality in the Components browser is now available for projects.

For more details, read: Find and replace project content.

See the correct Workflow Owner

Now that you can let other participants in a project create assignments and workflows, Inspire sets the Workflow owner to the user who is currently logged in and starting the workflow.

When you create a topic workflow from an assignment, On the Start Workflow (Step 1 of 4) screen:

Previously, the Workflow Owner was automatically set to be the Project owner.
Now, by default the Workflow owner is set to your user name (the logged-in user).

For more details, read: Create a workflow from an assignment.

Completing a project disables some component options

When work is done and you don't want to add any new content, participants, assignments or workflows, project owners and users with permissions can mark a project as complete.

Component options that you can no longer select when a project has a Status of Complete include the following:

Details...
Edit...
Save as...
Save as a copy...
Save as a branch...
Save as a snapshot...
Rename
Delete
Remove from project

For more details, read: Complete a project.

Prepopulate workflows with Workgroup users

Workflows are centered on content development and use Tasks, Workgroups, and Activities to organize the work.

After you assign users to Workgroups, Inspire now pre-populated those names in the following places:

Workflow templates
When a workflow is started

For example, on the Start Workflow (Step 2 of 4) screen:

For each workgroup, you don't need to assign one or more users because these names are pre-populated for you.
If you don't see any names, you must go and assign users to Workgroups. Follow the steps in Manage template workgroups.

For more details, read: Start a topic workflow.

Enhancements to translation management

Send files to PD translation as reference only

When sending files to Project Director for translation, you can attach files for reference only.

You see the Reference Only tab if you are sending reference files to Project Director.
On the Details tab, in Translation Project, you must select PD Rest.
Reference components are not locked in Inspire.
Reference files aren't returned from Project Director.
You can send the same files for translation and reference only. This is helpful when the linguist might need to refer to the original, such as a map, when making changes.

After you send a translation job, you can see the list of reference files on the Reference only tab.

For more details, read: See reference only components for a translation job.

See new ZIP file names when sending files to translation

When translation creates a zip, you now see the file name as:

Translate-{Job Name}-{date/time}.zip

For more details, read: Send components to translation.

Support for Right-to-Left target language files

When you create a new component from a template, Inspire sets an attribute to describe the language Reading property if:

The "dir" attribute doesn't exist yet
The language Reading property is "rtl" (Right-to-Left)

If this criteria is met, Inspire sets the dir attribute as follows:

<concept id="concept_guid" xml:lang="ar-Ar" dir="rtl">

Otherwise, no changes are made.

For more details, read:

See the correct languages list when switching translation projects

When you send a component to translation, you must identify how the translation work will be completed by choosing a Translation Project.

Depending on how your organization configures Inspire, you would select one of the following:

The method for sending the files (PD Rest Api, Manual, Transport, GlobalLink Connect, FTP)
The client or vendor name

Previously, if you selected Translation Project, and then wanted to switch it to another method or vendor, the language list would not be updated to the new method or vendor you selected.

Now, when you are on the Translate Component screen and you change the selection in Translation Project:

Inspire clears the language you previously selected.
When you go to Translation Target and you click Select Languages, you see the proper languages associated with the new Translation Project you just chose.

For more details, read: Send components to translation.

See the Project Director workflow in use

After you send components to translation, you can see if the job requires Inspire to communicate with GlobalLink's Project Director to manage the translation work.

When you:

Select Translations.
On the Translations Management tab, find the translation you want to view more details for.
Double click the translation job.
On the View Translation screen, select the Details tab.

You can now see the Project Director workflow used for the submission in Workflow Name.

When using PivotToEnglish, the same workflow will be used for both phases of translation- from a foreign language to English, and then from English to a different foreign language.

For more details, read: Open the View Translation screen.

See more information on the Translation Management tab

On the Translation Management tab, you can now use two new columns:

(Job) Id
Submission Id

The Job Id and SubId columns are shown by default.

Job Id and SubId columns are included when you export to a CSV
You can sort by the SubId column because it is a string
You can use advanced search to search by SubId
The SubId is included in the translation report

For more details, read: Things you can do on the Translations Management tab.

Check a Translation Status

After you send components to translation, you can verify details about the job by selecting an option called Check translation status.

For more details, read: Check the status of a translation job.

See correctly resolved conrefs when you pivot to English on partial translations

Previously, conrefs did not resolve correctly in translation files when you select PivottoEnglish on a partial translation.

Previously, if you did something similar to the following steps:

Create a German Concept that has a conref to a German note.
Start a Translation (Project = Transperfect, Language = French, Export Configuration = An Export configuration that excludes xrefs and conrefs
An English translation is created with a single file for the concept.
Export the zip, modify the xml and import it back into Inspire.
Inspire marks the English translation as Completed.
The French translation is started.
Export the zip, modify the xml and import back into Inspire.
Analyze the XML in the French folder.

The conref is erroneously linked to:

• TopicFileName_en-US_fr-FR#topic_en-US/note

It should be linked to

• TopicFileName_en-US_fr-FR#topic_en-US_fr-FR/note

Now, conrefs resolve correctly in translation files when you select PivottoEnglish on a partial translation.

For more details, read: Plan for special requirements.

Add locked review components to a translation job

When a translation coordinator is adding components to a translation job, if it’s locked for review, it can still be added to the job.

No review comments or changes are included in the component sent to the translator.

For more details, read: Translate components.

Enhancements to publishing

Use an Inspire publishing configuration and plug-in for DOCX

For some customers, Inspire provides a publishing configuration and a publishing plug-in for DOCX.

DOCX is the file format used by Microsoft Word to store documents.
If the DOCX publishing option is supported for your organization, when you publish a component, on the Publish Component screen, you can select the Publish Docx option.
If published successfully, you can download a deliverable in the DOCX file format that you can open in Microsoft Word.

For more details, read: Publish your content.

See the publishing profile name when you run scheduled publishing

Previously, when you created or updated a Publishing Profile, and selected the Scheduled publishing option, when you checked on the job in the Publish Portal, there was no name in the in the Profile column.

Previously, when you:

From the top menu, select Publishing.
On the Publishing Profiles tab, select Create.
On the Create Publishing Profile screen, in Name, enter a profile title for what you're publishing using 100 characters or less.
In Export Configuration, select a format for your published output.
To publish on a schedule, select Scheduled publishing.
1. In Time, select when you want Inspire to submit a job to the queue to publish the component(s).
2. In Day, select how often you want to repeat the process of submitting a publishing job for the component(s).
On the Create Publishing Profile screen, click Create.
In the top menu, select Publishing.
In the top right corner, select Go to the Publish Portal.

On the Jobs screen, in the Profile column, the value was empty if:

You published from a profile
You selected the Scheduled publishing option

Now, when you create or update a Publishing Profile, and select the Scheduled publishing option, when you check on the job in the Publish Portal, you see a name in the in the Profile column.

For more details, read: Schedule publishing.

Enhancements to administration

Allow users to create templates

As an Inspire administrator, you can set permissions to grant or deny users and roles access to a specific module.

Now, by default only users with administrator permissions have the option to Create Template on the Create Component screen.
If you want to allow a user without these permissions to create templates in the Components browser and in projects, you can give them permission in Module Access Management.

For more details, read: Allow users to create templates.

See more details when managing users

After an account has been assigned an Inspire license, Administrators can view the user account information and update its roles.

Now you can select the new Roles tab to manage the groups the user belongs to that has access assigned by job function.

You can see what roles the user belongs to now.
You can add this user to a new Role.
You can remove roles from the user.

Now you can select the new Modules tab to display a list of features the user has access to.

This list is read-only.
The Modules tab only shows the modules individually associated with the user and not those associated with the role.
Therefore, you will not see the list of modules associated with the roles, because one user can have multiples roles.

For more details, read: Update user accounts.

Control who can publish

As an Inspire administrator, you can define at the user and role level whether the Publish action is available.

If you add a user or role to the can_publish module property for the Content Browser module, the non-administrator user can see the Publish option.
Otherwise, only administrators can see the Publish option.

If a user is an administrator or has been added to the can_publish module property, that user can publish in the following places:

Content Browser — from the right-click menu, from the Options menu, and from the Selected components panel
Projects — from the right-click menu, from the the Options menu, and from the Selected components panel
Publishing — for a publishing Profile, from the right-click menu, and from the Options menu

The ability to publish from a snapshot is not affected by this module property.

For more details, read:

Admins: Control who can publish
Non-admins: Publish your content

See one changeset after renaming a file

When a user takes an action on a component a changeset record is created.

The action does not necessarily mean changes were made to the content.

Previously, multiple changeset records were created for one Update Action with a Process type of Rename.

When you Rename a file that is referenced by other components, a separate changeset record was created for each file that was updated to reflect the new name.

Now, only one changeset record is created that lists all impacted components for a file rename.

For more details, read: Understand changest rules.

Create a translation configuration

If you want to reuse a group of translation options repeatedly without having to re-enter or select the information for every translation job, an Administrator can create a configuration.

You can set as many options as you need in the configuration.
Only Name and Translation Project are required.
You can create a configuration without setting the target languages in Translation Target.

The values you set in the configuration are all used on the Translate Component screen, including the Filter option which opens the Filter Profiling Attributes screen.

The translation coordinator can override the settings in the translation configuration before clicking Translate.

For more details, read: Create a translation configuration.

Filter the changeset list by a new Process type

If you want to see an ongoing record of all changes made to the components in your instance of Inspire, you can go to Changesets.

To use the Changesets tab you must be an administrator.
There is no other permission or module property you can set to grant a non-admin user access to the Changesets module.

On the Changesets tab you can Filter the list by Date range, Action, and Process.

Now you can filter by a new Process type called RenameFileName.

For more details, read: Search for a change to a component.

Unlock a component with a system lock

Inspire locks a component with a red system lock to prevent other users from editing it while it's being reviewed or translated.

Previously, an Administrator could not unlock a component with a system lock.

Instead, the component had to:

Be released when the review was be completed or cancelled
Removed from the translation project
Released when the translation was be completed or cancelled

Now, an Administrator can now unlock any component with a system lock.

The admin sees a warning that any changes made while the component had the system lock will be lost.

For more details, read: Unlock components with system locks.

Successfully update large frameworks and multiple schema

Previously:

Updating large component frameworks or component schemas would time out and not complete successfully.
Updating a schema when more than one has already been updated would not complete successfully.

Now:

Updating large component frameworks or component schemas completes successfully.
Updating a schema when more than one has already been updated completes successfully.

For more details, read:

Release Notes 2023.2.4.0

Inspire Release 2023.2.4.0

Enhancements to content authoring

Enhancements to component management

Enhancements to project management

Enhancements to translation management

Enhancements to publishing

Enhancements to administration

Publish Server 2023.2.4.0

New features and fixes