Setting up Single Sign-On

Installation Procedure

Installing the Agents

---

Installing the Online Documentation

The WebHelp format is available for the UserInterface in the form of an online documentation/context sensitive help (F1 key).

As of version 11, help is delivered only in English for major version releases. German and French versions are delivered with the first service pack.
In order to use the context-sensitive help, you should copy the English version files into the folder for French or German respectively.
This ensures that the documentation topic describing the active window, tab, or script element in the UserInterface will open when you press F1.

In this document you find the following sections to help you decide on the help format and guide you through installation and copy&paste procedures:

• WebHelp Browser Compatibility
• Documentation Formats
• Documentation Types
• Supplied Files
• Deciding on a Location for Your Documentation
• Installing the Automation Engine Guides in WebHelp Format
• Copying and Unzipping the Automation Engine Messages in WebHelp Format
• Copying and Unzipping the Automation Engine Release Notes
• Using the WebHelp format online on docs.automic.com with F1-key

WebHelp Browser Compatibility

For Automic WebHelp in HTML5 format the same browser compatibility applies as for the ECC. Please check our Automic Compatibility Checker for details.
JavaScript must be enabled in order to use the complete functional range.

Documentation Formats

Automation Engine documentation is available in the following formats:

• WebHelp: You can run the WebHelp on all platforms with an HTML browser.
• PDF: You can open the PDF guides from all platforms on which a display program (such as Adobe Reader) is installed.

You cannot use PDF files as context sensitive help in the UserInterface (F1 key).

Documentation Types

You can install each documentation type in the language(s) of your choice. In the image below, documentation in all formats, types, and languages are installed in a Windows directory.

Supplied Files

The documentation in each type, formats, and languages are provided in the directory IMAGE:DOCUMENTATION.

The Automation Engine documentation in WebHelp format is also available in compressed format as TAR files (in the directory IMAGE:DOCUMENTATION\GUIDES\WEBHELP).

Deciding on a Location for Your Documentation

Automation Engine documentation can either reside locally on the machine where each UserInterface is installed or at a shared location that can be accessed by all users.

Installing the Automation Engine Guides in WebHelp Format

To install the Automation Engine guides in WebHelp format:

1. From IMAGE:DOCUMENTATION\GUIDES\WEBHELP, navigate to the language(s) you wish to add WebHelp documentation for.

In each language's sub-directory, there is a .zip file.

2. Copy and unzip the contents of the .zip file(s) to the location(s) you want them (usually \DOCUMENTATION\WEBHELP\<language>).

In the image below, the contents of the .zip file are unzipped in the \DOCUMENTATION\WEBHELP\ENGLISH directory.



3. Edit the <docu type="format">path</docu> and <browser type="name">path</browser> parameters in the uc4config.xml configurationA set of constituent components that make up a system. This includes information on how the components are connected including the settings applied. file for each UserInterface.

Text from a sample uc4config.xml is shown below with the necessary edits shown in bold.

<configuration>
    <paths>
        <docu type="wh">C:\AUTOMIC\Documentation</docu>
       <browser type="Internet Explorer">"C:\Program Files\Internet Explorer\iexplore.exe"</browser>
        <logging count="10">..\temp\UCDJ_LOG_##.TXT</logging>
       <trace count="10" xml="0" tcp="0" ra="9">../temp/UCDJ_TRC_##.TXT</trace>
   </paths>

As of version 11, help is delivered only in English for major version releases. German and French versions are delivered with the first service pack.
In order to use the context-sensitive help, you should copy the English version files into the folder for French or German respectively.
This ensures that the documentation topic describing the active window, tab, or script element in the UserInterface will open when you press F1.

Copying the Automation Engine PDF Guides

To copy the Automation Engine release notes, go to IMAGE:DOCUMENTATION\GUIDES\PDF, and copy the directories for the PDF files for the desired language(s) to the location you want them (usually \DOCUMENTATION\PDF\<language>).

Copying and Unzipping the Automation Engine Messages in WebHelp Format

To copy and unzip the Automation Engine messages in WebHelp format:

1. From IMAGE:DOCUMENTATION\MESSAGES\WEBHELP, navigate to the language(s) you wish to add messages in WebHelp format for.

In each language's sub-directory, is a .zip file.

2. Copy and unzip the contents of the .zip file(s) to the location(s) you want them (usually \DOCUMENTATION\MESSAGES\<language>).

Copying and Unzipping the Automation Engine Release Notes

To copy and unzip the Automation Engine release notes:

1. From IMAGE:DOCUMENTATION\RELEASE NOTES, navigate to the language(s) you wish to add Release Notes for.

In each language's sub-directory, there is a PDF file and .zip file.

2. Copy the PDF and .zip file(s) to the location(s) you want them (usually \DOCUMENTATION\RELEASE NOTES\<language>).
3. Unzip the contents of the .zip file(s).

Using the WebHelp format online on docs.automic.com with F1-key

At this point this workaround for using WebHelp on our documentation site exists. In future AE versions the use of the F1-key with the documentation on the net will be implemented.

To use the online documentation in WebHelp format on docs.automic.com as context-sensitive help when pressing F1, configure the uc4config.xml as described above, but take care to make the following changes:

1. Create a help.htm file in the path configured for WebHelp (see above).
2. Paste the following script lines into this help.htm and save it:
   

   <!DOCTYPE HTML>

  <html lang="en-US">

      <head>

          <meta charset="UTF-8">

          <script type="text/javascript">

            var href = window.location.href;

            var deeplink = href.split("/");

            window.location = "http://docs.automic.com/documentation/AE/11.1/english/AE_WEBHELP/" + deeplink[deeplink.length-1];

          </script>

           <title>Page Redirection</title>

       </head>

       <body>

          If you are not redirected automatically, follow this <a href='http://docs.automic.com/documentation/AE/11.1/english/AE_WEBHELP/help.htm'>link to example</a>

       </body>

   </html>