Importing map files

You can import maps authored outside IXIASOFT CCMS Desktop and add them to the Content Store.

When you import a map, the following happens:

  • The map and its dependencies are imported into the Content Store (such as all the submaps, topics, and images it references)
  • They are assigned an initial status (such as Authoring:work)
  • They are automatically assigned to you
  • The map's filename is added to the object's metadata in the originalFileName index
  • A submap's path relative to its containing map is added to the object's metadata in the originalRelativePath index

If one of the map dependencies cannot be found (for example, a topic is missing), the import is canceled and an error message is displayed.

If the map or topic being imported references a non-DITA resource such as PDF file or video, it is imported as a resource of the type "unknown", which allows it to be searchable from the Search view. Once imported, you can edit the resource to change the type from "unknown" to something more specific as required.

Import options

You can specify the following options when importing maps:

Option Description
Import As External

When you import the document, it and its children (if any) are imported into the Content Store and assigned the Authoring:readonly status.

Update existing documents

When you import a document, the system determines if this document already exists.

If a document already exists and the Update existing documents option is selected, the existing document is updated with the contents of the imported document. If this option is not selected, a new document is created, with a new filename.

If the Use relative path along with file name to match documents to update option is also selected, the system also checks that the base path of the imported document matches the base path of the document in the Content Store. The system updates the existing document only if the paths match.

When you re-import an external document, this option is always enabled and the existing document and its children (if any) are always updated.

Default language

All documents in the Content Store must have a designated language. If the documents you are importing do not have a language attribute, the system will assign them the language you select from this list. If the document you are importing has children, this language will also be assigned to these children.

You can also set the Override unknown languages with default option. When you import documents that reference a language that’s not configured in your system, the system will replace these values with the default language specified if you select this option.

Images options If the maps you are importing reference images, you need to specify the type and format of the images.
  • Type is an informative label that is written into the image metadata. Default values are Line Art, Screen Capture, and Equation.

    If an image is labeled Line Art or Screen Capture, the system will automatically designate it as Needing Translation. Images labeled Equation are not designated as needing translation; if these images are part of a map that is sent for localization, the system will automatically promote them to the review state and will not include them in the image localization kit.

    You can set the translation designation for specific images as required once the image has been imported, and the image type may be changed once the image is in the Content Store.

  • Format may determine the output format of an image, depending on your system setup.
Labels You can assign one or more labels to a document and its children (if any). Labels are added as metadata and improve searchability.
Import options
MAP IDs: Retain root map IDs If this option is not selected, the map is assigned a new ID by the system. This will be used as both the file name and as the map root ID. The imported map’s root ID is overwritten.

If this option is selected, then the value of the imported map ID remains unchanged on import and this ID is also used as the document file name. If there is a conflict with an existing map ID, the system informs you of the conflict and cancels the import.

Topicrefs: Remove @navtitle and @type from <topicref> containing @href If this option is selected, then navtitle and type attributes are removed from <topicref> elements containing an href attribute when the map is imported.

When you are authoring DITA documents, there are several ways that you can specify topic attributes such as type and title: at the map level and at topic level. The system does not maintain map attributes automatically. If you keep these in the map, then you’ll need to update them manually if, for example, you change the title of a topic.

Images: If this option is selected and there are two (or more) images with the same filename, then the system imports just one of them (randomly). If you leave this checkbox empty, then all images are imported, they keep their duplicate titles, and the system assigns unique filenames.
Resources: If this option is selected and there are two (or more) resources with the same filename, then the system imports just one of them (randomly). If you leave this checkbox empty, then all resources are imported, keep their duplicate titles, and the system assigns filenames.
Import Base Path: Specifies the base path to use when replacing existing documents.
Important: The filename and base path of the imported object are important when you intend to replace an existing object. See Re-importing and updates to existing files for more information.