Skip to main content

Attach workflows and publish Typefi jobs with Oxygen XML Web Author

Toni Gonzales
  • Updated

This article will explain how to edit DITA (Darwin Information Typing Architecture) XML files, attach workflows, and publish jobs from Oxygen XML Web Author for Typefi XML web authoring. 

Prerequisites

To successfully attach workflows and publish Typefi jobs with Oxygen XML Web Author, please make sure that you complete the following requirements:

  1. First, if you still need to, install and configure Oxygen XML Web Author in Typefi Server (v8.11–v8.13). Follow the steps in the help article: Install and configure Oxygen XML Web Author for Typefi. Need to update your Server? Refer to the help section, Installing, updating, and licensing.
  2. Upload and store all XML files related to your Typefi workflows in Typefi Server → Files (for example, .xml, .dita, and .ditamap files). 
  3. Then, update any workflow XML file paths for images and other .dita files to match the location on Typefi Server → Files.
  4. Verify that your Typefi administrator enabled file versioning in Admin →Filestore. Enabling versioning ensures your team can save new file versions within Oxygen XML Web Author.

Please contact us if you need assistance or have questions about these requirements.

Check out and edit a DITA XML file from Oxygen XML Web Author

When you open a DITA XML file in the XML web authoring environment, you automatically lock the file for editing, meaning other users cannot make changes or view the version you are working on until you check the file back in.

To use the check-in/out feature and save versions in Typefi Server → Files, a Typefi administrator must enable versioning in the settings located in Admin → Filestore. For more details, please see the help article, Enable file versioning in Typefi Filestore.

Open_OxygenWebAuthor.gif

To check out and edit a DITA XML file from Oxygen XML Web Author, follow these steps:

  1. Sign in to Typefi Server.
  2. Go to Files and select the checkbox next to a . dita or .ditamap file that you want to edit.
  3. Click Edit. The file is now checked out and locked for editing.
  4. Your file will now open for editing in Typefi’s XML web authoring environment for Oxygen XML Web Author.
  5. Edit your document.
  6. Then, click Save*. 

    *What happens if you forget to save in Oxygen XML Web Author? Currently, Oxygen XML Web Author does not have an autosave feature, and SyncroSoft does not have a roadmap for implementing it. If you accidentally close your browser or tab without saving your work, a dialog will confirm your intention to leave the site. Oxygen_LeaveSitedialogbox.png

  7. From the dialog, click Cancel, then select Save in the Typefi toolbar (see below). Please note if you choose to Leave without saving changes, the file will still be checked out and locked for editing. 

Oxygen_Typefi toolbar

Attach a Typefi workflow in Oxygen XML Web Author

To attach a workflow, follow these steps:

  1. Click the Workflow icon  Workflow_Icon_Fonto.png  in the toolbar.
  2. Select the appropriate workflow from the list.
    ServerAdmin_Server8.10_Webeditor_Workflow_Oxygen.png
  3. Click Close to confirm your selection. (If you need to choose a different workflow, select Detach.)

Publish a Typefi job in Oxygen XML Web Authoring

After confirming that the file is attached to the correct workflow, you can publish your Typefi job without navigating to the Files tab.

Follow these steps:

  1. Click the publish icon Publish.png located in the Typefi toolbar.
  2. In the dialog, confirm the workflow details. (To choose a different workflow, select Change.)

    If you encounter an error message in the dialog, it could mean there are issues with how the workflow is set up or that you must select a different one. If this issue continues, please reach out to your Typefi Solutions Consultant.

  3. Click Publish to run the job.publishworkflowConfirmation.png
  4. To download your published file, click ViewJobDetails.pngin the dialog to open the Jobs log in a new tab.
  5. Save your work, then click the Typefi icon to check in your file when you are ready to close the Typefi XML web authoring environment.

Check in a DITA XML file

To make sure that other authorised users can access the most recent version of your edited file, you need to save your changes and check in (unlock) your file manually by following the steps below:

  1. Click the Save icon in the Typefi toolbar. When you save, a generic comment with the date and time will be added to the current version by default.
  2. Select the Typefi icon in the toolbar.
  3. Once you select the Typefi icon, a dialog will appear and ask: Do you want to check the file back in?
    • Select YES to unlock the file for editing (check-in) and return to the Files tab.
    • Select No if you do not want to check in the file and open the Files view in a new tab.

To learn how to use the actions and features in Oxygen XML Web Author, please refer to Oxygen’s help article, Web Author Interface.

If you have any questions about attaching workflows and publishing Typefi jobs with Oxygen XML Web Author, please contact us. We're happy to help!

See Also

Related articles

Comments

0 comments

Please sign in to leave a comment.