When a translated topic does not import

When a translated topic fails to import, there are some troubleshooting steps you can take to find and resolve the problem.

Sometimes, a translated topic fails to import into CCMS Web. When this happens, it can be difficult to troubleshoot. A topic is virtual until the translation is imported, which means that if the topic fails to import, there is no actual object in the CCMS to review and correct.

Trying to troubleshoot outside of the CCMS can also be difficult because you probably do not have a local environment that includes the CCMS's DTDs and other required configuration.

While this process will be improved in future releases of CCMS Web, in the meantime, there is a workaround.

  1. Open the topic locally and comment out everything after the <title> element. Leave the closing root element tag.

    For example:

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE concept PUBLIC "-//DOCIXIA//DTD DITA Composite//EN" "DocixiaDitabase.dtd">
    <concept id="kbe1742572751667" xml:lang="en-us">
    	<title>When a translated topic does not import</title>
    	<!--<conbody>
    		<p>Sometimes, a translated topic fails to import into CCMS Web. When this happens, it can be
    			difficult to troubleshoot. A topic is virtual until the translation is imported, which
    			means that if the topic fails to import, there is no actual object in the CCMS to review
    			and correct.</p>
    		<p>Trying to troubleshoot outside of the CCMS can also be difficult because you probably do
    			not have a local environment that includes the CCMS's DTDs and other required
    			configuration.</p>
    		<p>While this process will be improved in future releases of CCMS Web, in the meantime,
    			there is a workaround.</p>
    		<ol id="ol_mqs_d4c_t2c">
    			<li>Open the topic locally and comment out everything after the
    					<xmlelement>title</xmlelement> element. Leave the closing root element tag.</li>
    		</ol>
    	</conbody>-->
    </concept>

    If the problem is within the DITA structure, commenting out everything but the <title> should ensure the structural problem is eliminated.

  2. Import the topic.

    If this import still fails, the problem is likely not the DITA structure. It could be an invalid language code, an invalid filename, or some other problem.

  3. After the topic is imported, check it out and edit it within the CCMS.

    Follow your usual troubleshooting process. For example, uncomment content element by element, checking the topic back in each time. When the check in fails, you know you have found the offending element and you can make the necessary correction.

  4. If appropriate, notify your LSP of the error so they can ensure it does not continue to occur in the content they return to you.