Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: 'Shortcuts' text updated

...

  • The Editor can be opened most easily through a double-click on a shortcut to the sos.xml.editor.exe binary.
  • Clicking File -> Open will open a tab for a new configuration.

The configuration of a JADE YADE file transfer operation is used in this article as a 'vehicle' for describing the use of the XML Editor. Other uses are available or in development, such as the configuration of the JobScheduler Monitoring Interface.

...

...

The Configurations element in the JADE YADE Reference schema shown in the screenshot above is the root XML element and therefore automatically specified when a new configuration is opened, along with its mandatory child elements.

...

The structure of the configuration is described in more detail in the JADE YADE User Manual - Configuring and Running File Transfers article and its child articles.

...

  • the XML format that will become the new standard for JADE YADE with release 1.11,
  • the settings.ini format that will that will remain standard until release 1.11 (when the JADE YADE Xml2Ini Converter plugin is active).

Note that the JADE YADE Xml2Ini Converter plugin used to generate the settings.ini file can be deactivated (and configured) as described in the Plugins section of this article below.

More information about the change of formats can be found in the JADE YADE User Manual - Configuration Formats & Tools article.

The following code boxes can be opened to show the simple configuration described above in XML and in settings.ini formats:

Code Block
titleSimple file transfer configuration in XML format
collapsetrue
<?xml version="1.0" encoding="utf-8"?>
<Configurations xsi:noNamespaceSchemaLocation="http://www.sos-berlin.com/schema/jadeyade/JADEYADE_configuration_v1.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fragments>
    <ProtocolFragments>
      <FTPFragment name="ftp_demo_sos-berlin">
        <BasicConnection>
          <Hostname><![CDATA[test.sos-berlin.com]]></Hostname>
        </BasicConnection>
        <BasicAuthentication>
          <Account><![CDATA[demo]]></Account>
          <Password><![CDATA[demo]]></Password>
        </BasicAuthentication>
      </FTPFragment>
    </ProtocolFragments>
  </Fragments>
  <Profiles>
    <Profile profile_id="ftp_server_2_local">
      <Operation>
        <Copy>
          <CopySource>
            <CopySourceFragmentRef>
              <FTPFragmentRef ref="ftp_demo_sos-berlin" />
            </CopySourceFragmentRef>
            <SourceFileOptions>
              <Selection>
                <FileSpecSelection>
                  <FileSpec><![CDATA[.*]]></FileSpec>
                  <Directory><![CDATA[./]]></Directory>
                </FileSpecSelection>
              </Selection>
            </SourceFileOptions>
          </CopySource>
          <CopyTarget>
            <CopyTargetFragmentRef>
              <LocalTarget />
            </CopyTargetFragmentRef>
            <Directory><![CDATA[${USERPROFILE}\jade_demo\a]]></Directory>
          </CopyTarget>
        </Copy>
      </Operation>
    </Profile>
  </Profiles>
</Configurations>

...

Code Block
titleRunning the file transfer XML configuration on Windows format (JADE 1.11 and newer))
jade.cmd -settings="%USERPROFILE%\jade_demo\sos-berlin_demo_2_local.xml" -profile="ftp_server_2_local"
Code Block
titleRunning the file transfer settings.ini configuration on Windows format (JADE 1.10 and earlier)
jade.cmd -settings="%USERPROFILE%\jade_demo\sos-berlin_demo_2_local.ini" -profile="ftp_server_2_local"

...

More information including example calls for Unix systems can be found in the JADE YADE User Manual - Configuring and Running File Transfers article.

Plugins

JADE Xml2Ini Converter

YADE Xml2Ini Converter

Jira
serverSOS JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId6dc67751-9d67-34cd-985b-194a8cdc9602
keyJS-1416

By default the XML Editor comes with an activated JADE YADE Xml2Ini Converter plugin that is used to convert the Editor's native XML format to the settings.ini format required for JADE YADE up to versions 1.10.

The menu for configuring this plugin can be opened using either the JADE YADE Xml2Ini Converter button shown in the screenshot below or by opening the Plugins entry in the main menu.

...

  • XSD Schema:allows an alternative schema to be used for the conversion to that specified in the current XML Editor tab.
  • Autosave output file: automatically saves the converted file under the same folder and file name as the 'original' XML file but with the extension .ini.
  • Show notification on autosave: causes a a small notification window to be shown at the taskbar when a file is saved and an autosave setting causes the Converter Plugin to be executed.
  • Convert: is used to convert the XML document shown in the current XML Editor tab to a compatible .ini format.
  • Open INI file: opens the converted file in the default editor for .ini format.

Keyboard Shortcuts

Jira
serverSOS JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId6dc67751-9d67-34cd-985b-194a8cdc9602
keyJS-1501

The XML Editor supports shortcuts that allow the Editor to be used without a pointing device (mouse).

The following shortcuts are available:

  • tab level - shortcuts work when the focus is in the left or in the right panel:
    • CTRL S: Save
    • CTRL V: Validate XML
    • CTRL X: Show XML
  • context level of a selected element - shortcuts work when the focus is in the left panel:
    • CTRL +: Expand
    • CTRL -: Collapse
    • CTRL A: Add Child - opens the Add Child context menu

References

Change Management References

Jira
serverSOS JIRA
columnstype,key,issuelinks,fixversions,status,priority,summary,updated
maximumIssues20
jqlQuerylabels in (xml-editor)
serverId6dc67751-9d67-34cd-985b-194a8cdc9602