Automic Workload Automation

  • Private Community
Back to discussions
Expand all | Collapse all

Calling the online context help with F1

Legacy User

Legacy UserDec 21, 2016 12:02 PM

You're welcome :)

  • 1.  Calling the online context help with F1

    Posted Jul 08, 2016 08:33 AM
    Here are the steps to set up your User Interface (fat client) so it calls the online documentation when pressing F1.

    1 - Create a help.htm file with the content below:
     <!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.2/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.2/english/AE_WEBHELP/help.htm'>link to example</a>
           </body>
       </html>

    2 - Put it in its target folder
    The path has to end with "\guides\webhelp\english" - e.g. C:\Automic\Documentation\V11\guides\webhelp\english

    re2jua6dnk19.jpg

    3 - Adjust uc4config.xml 
    Set docu type="wh" and set the path without "\guides\webhelp\english" - e.g.
    <docu type="wh">C:\Automic\Documentation\V11</docu>

    That's it ! You will need to restart the GUI for the change to take effect.


  • 2.  Calling the online context help with F1

    Posted Dec 21, 2016 12:01 PM
    Antoine_Sauteron
    Thanks, this was the step i was missing.
    Working now...

    Thanks again...


  • 3.  Calling the online context help with F1

    Posted Dec 21, 2016 12:02 PM
    You're welcome :)


  • 4.  Calling the online context help with F1

    Posted Dec 22, 2016 09:41 AM
    This should be the default way that the User Interface is configured when it is downloaded from Automic.  :)


  • 5.  Calling the online context help with F1

    Posted Feb 03, 2017 08:18 AM
    Has anyone gotten F1 help working with the v12 documentation? The documentation has been completely reorganized in v12, and the structure is quite different. Moreover, the Java UI-specific parts of the documentation were completely removed. (If one wants JUI-specific info, one must go back to the v11 documentation.)

    I am not sure what URL base to use, nor which HTML file in the v12 documentation supports the the cshid anchors that point to the context-sensitive, topic-specific deep links. The main help.htm file appears to have been moved to this location (for v12.0.1):
    https://docs.automic.com/documentation/WEBHELP/English/all/components/DOCU/12.0.1/AWA%20Guides/help.htm
    Unfortunately, none of the cshid anchors I tried actually works with this file. No matter where I trigger the F1 help in the Java UI, it just takes me straight to the Release Highlights page.

    Of course, the Java UI was deprecated in v12, so perhaps no one bothered to make sure the F1 help still worked. Can someone from Automic confirm this? Is F1 help broken in the v12 JUI?

    It's too bad there is no equivalent context-sensitive help function in the AWI (yet). Let's hope this capability is added soon.


  • 6.  Calling the online context help with F1

    Posted Feb 03, 2017 09:14 AM
    Hi Michael,

    I could not get it to work either in v12. More specifically pressing F1 does redirect to the online documentation, but will always land on the "Release Highlights" page no matter which object or window the context help is called from. As you mentioned this most likely occurs because of the structure change.

    However I'm not too confident this should work in the near future, for the 2 reasons below:
    • the Java GUI is no longer the official client for the Automation Engine in version 12.
    • the context help has not been implemented in AWI, and is not on the product roadmap so far.

    Kind regards,
    Antoine


  • 7.  Calling the online context help with F1

    Posted Mar 22, 2017 08:23 AM
    I would like to give you an update for V11.2: Unlike it is said it also works for the german help in the meantime.

    I only put the help.htm also in the German webhelp directory and changed the both occurrences of the URL from
    http://docs.automic.com/documentation/AE/11.2/english/AE_WEBHELP/help.htm
    to
    http://docs.automic.com/documentation/AE/11.2/german/AE_WEBHELP/help.htm
    Best regards,
    Tim



  • 8.  Calling the online context help with F1

    Posted Mar 22, 2017 09:15 AM
    Antoine Sauteron wrote:
    I could not get it to work either in v12. More specifically pressing F1 does redirect to the online documentation, but will always land on the "Release Highlights" page no matter which object or window the context help is called from. As you mentioned this most likely occurs because of the structure change.

    However I'm not too confident this should work in the near future, for the 2 reasons below:
    • the Java GUI is no longer the official client for the Automation Engine in version 12.
    • the context help has not been implemented in AWI, and is not on the product roadmap so far.
    It is unfortunate that the v12 documentation main page (help.htm) was not updated to be able to be able to gracefully handle the cshid anchors that have worked in all recent versions of the documentation, and that the Java User Interface still uses when opening help pages.

    I understand that it would take some effort to make it work, considering that so many documentation pages have been moved, reorganized, and renamed. I also assume no one even thought of it until I pointed it out.  :D

    I would like to emphasize though that currently, with version 12, there is no context-sensitive help in either the Java User Interface or the Automic Web Interface. If Automic decides not to fix the documentation so that links from the JUI still work, I can understand this. However, this makes it all the more important that Automic prioritize getting context-sensitive help working in the AWI.  It’s not very nice that a useful feature has been broken in the old interface before an equivalent capability is available in the new interface. 


  • 9.  Calling the online context help with F1

    Posted Mar 22, 2017 10:59 AM
    • the context help has not been implemented in AWI, and is not on the product roadmap so far.
    Isn't that called a regression ?

    The context help is a great feature for those who are using a bit or a lot the script commands because you cannot remember all parameters, syntax, etc ... from all commands. Same for those who are not familiar with some attributes or parameters of an object definition.

    Maybe the product manager should work more with the product itself on a daily basis to see how useful is this feature for the customers.


  • 10.  Calling the online context help with F1

    Posted Mar 22, 2017 04:47 PM

    Maybe the product manager should work more with the product itself on a daily basis to see how useful is this feature for the customers.
    <provocative> Did they within the last 3 years at all?


  • 11.  Calling the online context help with F1

    Posted Mar 23, 2017 05:22 AM
    Hi all,

    Thanks for your input.

    Tim_Quakulinsky : thanks for letting us know! I will edit my post to fix it.

    AlainMoisy : did you know that the context help is available for script in version 12 ? Start typing and hit Ctrl+Space and it will display :

    4m3t6qna9r3a.png

    As you already know v12 introduces many changes, and it will probably take some more time before we close the gap between the Java GUI's features and the AWI's features. However please rest assured we are definitely willing to get there.

    As always your (constructive) feedback is very important to us! Please feel free to submit enhancement requests (I know you already are :) ). The "voting" feature is a great way of letting our Product Management team know what matters the most to our customers.

    Best regards,
    Antoine


  • 12.  Calling the online context help with F1

    Posted Mar 23, 2017 06:11 AM

    In a comment on the discussion Java UI features that are missing from the Automic Web Interface, Robert_Schausberger_8294 indicated that v12.1 will include improvements to the AWI’s help functions:

    [W]e are working on improving the help experience along V12.1 of AWI. In  parallel the docu team is working to provide new best-practise/use-case  based documentation as well.

    I hope this the promised improvements include better context-sensitive help, but it is difficult to tell from this statement.

     

    Taking Antoine_Sauteron’s suggestion above, I have opened a new enhancement request on ideas.automic.com:

    Context-sensitive help 



  • 13.  Calling the online context help with F1

    Posted Apr 10, 2017 06:32 AM
    @ Antoine Sauteron

     That's not exactly what I would call a context help, just a "    Show parameter info" as it was called in the Settings in the java GUI.

    The context help is to link the help page to the item you have selected or the help on the item you are working with like the help on the Attibute tab of an object if you are with this tab as the active display in your interface.

    Changing everything may be interesting on the long term but a smooth transition with keeping some of the useful features would be the best. And old stuff is not always bad stuff  ;)


  • 14.  Calling the online context help with F1

    Posted May 24, 2017 10:04 AM
    In my opinion the feature of context sensitive online documentation is a key feature for all users work with automation engine.
    It might be reasons to change online doc, but don't forget not everyone can make an update to the first released new version. Changing usability while lifetime of a softwareproduct is not useful.
    The compatibility should be ensure.

    Andrzej Golaszewski


  • 15.  Calling the online context help with F1

    Posted Jun 01, 2017 03:17 AM
    Just a little note on online documentation (facing case actually on a site) :

    How do you manage it when you have a company policy that prohibits access to internet and/or external sites ?


  • 16.  Calling the online context help with F1

    Posted Jun 01, 2017 03:24 AM
    Alain Moisy wrote:
    Just a little note on online documentation (facing case actually on a site) :
    How do you manage it when you have a company policy that prohibits access to internet and/or external sites ?
    Download the documentation and host it locally.


  • 17.  Calling the online context help with F1

    Posted Nov 21, 2017 05:58 PM
    While I've gotten the regular context sensitive help to work, Is there a way to reference or merge multiple sets because each RA will have its own set of webhelp.


  • 18.  Calling the online context help with F1

    Posted Nov 22, 2017 03:20 AM
    Richard Beck wrote:
    While I've gotten the regular context sensitive help to work, Is there a way to reference or merge multiple sets because each RA will have its own set of webhelp.
    To the best of my knowledge there is no way to do this. The context-sensitive help system in the JUI (and AWI) is built based on the assumption that all help files are located under a unified hierarchy; the RA solution documentation is entirely separate. My advice would be just to bookmark the RA solution docs that you use most often. Or submit an idea to ideas.automic.com.


  • 19.  Calling the online context help with F1

    Posted Nov 22, 2017 04:12 AM
    Hi Richard,

    Like Michael said the RA docs are separated for several reasons. Here are a few:
    • Each RA solution has its own versioning.
    • RA agents are not developed / delivered at the same pace as the Automation Engine. They are "autonomous" components.
    • RA solutions can be used with AE (Automation Engine) or AM (Applications Manager), which are 2 completely different software.

    Besides, this trick to redirect to the online documentation will no longer be used in the near future, because AWI is now the dedicated GUI for AWA and ARA. Therefore if the context help was to be implemented for these RA agents it would be delivered with the AWI.

    It's a good point though, maybe an enhancement suggestion (ideas.automic.com) would be the best way to proceed.

    Best regards,
    Antoine


  • 20.  Calling the online context help with F1

    Posted Nov 22, 2017 04:48 AM

    The AWI configuration settings let one specify the main URL for the AWA documentation. E.g. the helpUrl.english setting specifies the URL for the English language AWA documentation. There should be a way to specify, for each AWI plug-in, the URL for documentation files relevant to that plug-in.

     

    I submitted the idea:

    Context-sensitive help for AWI plug-ins 

    If you like the idea, pleas vote for it.



  • 21.  Calling the online context help with F1

    Posted Nov 22, 2017 10:25 AM
    I did a little investigation and figured out how the help link redirections work.
    1. When you select Open Help in the AWI, the AWI opens a new browser window with a URL that depends on the part of the AWI that is currently active/visible.
      • The base of the URL is the one specified in configuration.properties, e.g. in thehelpUrl.englishsetting.
      • The second part of the URL always begins with#CSHID=(CSHID is probably an abbreviation for context-sensitive help ID).
      • The part after the equals sign is what varies depending on where you are in the AWI.
    2. A bit of JavaScript loaded by help.htm (in MadCapAll.js, I think) interprets the CSHID value and redirects to the appropriate documentation page.
    I tried loading the help while various RA agents and jobs were displayed in the AWI. Here is what I saw: 
    AE objectAWI sheet
    		CSHID
    Informatica agentInformatica
    		pa_view_InformaticaAgent
    Informatica jobInformatica
    		pa_view_JOBS_CIT
    FTP agentFTP
    		pa_view_sheet_ra_agent_template
    FTP job Job settings
    		pa_view_RAJobObjectSheetSettingsView
    Web services REST agentWeb Service
    		pa_view_sheet_ra_webservice_rest
    Web services REST jobRequest
    		pa_view_sheet_ra_webservice_rest_job_request

    I guess pa is short for Process Assembly, but it also appears in CSHIDs for sheets in the Administration perspective.

    None of these CSHIDs is currently handled; all of these links take one straight to the main AWA documentation page, even though specific documentation for these RA solutions does exist. Still this is a sign that Automic has begun to lay the groundwork for better context-sensitive help in the future. And in fact, my enhancement request would be completely unnecessary if the main AWA help file were able to handle redirects for all CSHIDs.


  • 22.  Calling the online context help with F1

    Posted Dec 11, 2017 05:08 PM
    Hi All, 

    Context-sensitive help is now available in 12.1 AWI, Per the release notes:

    Automic Web Interface:

    • Every page and sub page provides direct access to the topic in the product documentation that deals with it.
    • Direct access to the Automic Scripting Guide from within the Script Editor. Simply hover your mouse over the script element for which you need help and select Search in help. The topic that describes that particular element opens up.
    This is explained in greater detail at the following link:

    https://docs.automic.com/documentation/webhelp/english/AWA/12.1/DOCU/12.1/AWA%20Guides/help.htm#_Common/GettingStarted/GS_OnlineHelp.htm

    It's not "press F1", but the help does bring up the appropriate object when you:

    Expand the dropdown list on the upper right corner of the screen and select Online Help to open the Online Help to the topic that describes the object, task, perspective, etc. that is currently opened and in focus.

    This dropdown list is where your User, System, and Client are showing while logged into the AWI. 


  • 23.  Calling the online context help with F1

    Posted Dec 11, 2017 05:18 PM
    Spencer_Cockrell_39 wrote:
    It's not "press F1", but the help does bring up the appropriate object when you:
    This is a step in the right direction. Thanks!

    The following still needs to be added back to bring the AWI up to the level of usability that the JUI has provided for many years:
    • F1 should work, or there should be a user-configurable hotkey.
    • When a scripting tab (e.g., theProcesstab of a job) is in the foreground and the user activates the help function, the documentation page that is loaded should be thespecific page for the particular script elementwhere the mouse cursor is located (or the selected script element if one is highlighted). The currentSearch in Help function is nice, but it is not the same thing.


  • 24.  Calling the online context help with F1

    Posted Dec 11, 2017 08:01 PM
    Michael_Lowry 

    The script search is slightly different, based on what I could find - you'll need to right-click on the element after hovering over with your mouse and select, "Search in Help." It's not yet to the level that you describe (taking you to the precise page), but it should bring up the list of elements such as in the following example:

    Your search for "get_uc_system_name" returned 6 result(s).



  • 25.  Calling the online context help with F1

    Posted Dec 12, 2017 04:34 AM
    Spencer Cockrell said:
    Michael_Lowry 

    The script search is slightly different, based on what I could find - you'll need to right-click on the element after hovering over with your mouse and select, "Search in Help." It's not yet to the level that you describe (taking you to the precise page)
    Got it. I have updated my comment above to clarify the difference between searching for a term and going straight to the correct documentation page.