SDKHelp

Overview

SDKHelp is provided as a value add item based on a number of user requests. SDKHelp provides MicroStation CONNECT SDK developers - a single, simple and unified view from which to Explore and Search the most commonly used MicroStation (and Microsoft) API CHM Help File resources all from one convenient help file (SDKHelp.chm).  The SDKHelp.chm file provided was created using the Microsoft HTML Workshop (Download) and creating a Help File Merge Project. Think of a merge file being very similar to MicroStation "reference files" or Autodesk "x-refs".  The parent CHM help file (SDKHelp.chm) references other dependent CHM files that are required to all be accessed within the same product documentation folder. Once all merge file links are created, topics and layouts performed, then all that remains is to create/provide a Welcome Page (similar to below) to providing some orientation for developers to best get started, resources and search tips to help ensure maximum productivity and self-help results can be achieved.

So, what do you need to do?

  1. Download SDKHelp.zip
  2. Extract under your location of the MicroStation CONNECT Edition SDK "Documentation" folder
    • e.g. C:\Program Files\Bentley\MicroStationCONNECTSDK\Documentation
      NOTE
      : If prompted to use admin permissions; Select the Continue (button)
  3. Open the MicroStation Developer Shell (Run as Admin)
  4. Type: SDKHelp

If the files are extracted to the correct locations you should see sample output like the image below and the (sdkdocs) ..\documentation\SDKHelp.chm file open to Search and Explore.

We sure hope you find this new value added feature helpful and enjoy using it!

Anonymous
  • Hi ,

    We tested scenarios with both Default and Custom install locations (e.g. D:\bentley\ms10150074\MicroStation and D:\bentley\mssdk10150076) though we did not attempt testing on remote/network mapped, or NAS drives; though those locations should be fine and not likely an issue.

    Since the SDKHelpSetup performs PowerShell, your message above is related to running unsigned scripts.  I will check into being able to provide signed scripts to prevent this when the final version ships in MSCE SDK U16.

    (For now) to permit executing unsigned PowerShell scripts like the one provided, I would suggest considering and performing these (additional steps):

    1. Get a list of your current Power Shell Execution Policies (for reference)
      1. Open PowerShell.exe and type: get-executionpolicy -list
      2. Make sure to get a copy (copy/paste or screen capture) of the listing in case you wish to revert behavior to the defaults once the setup has executed or later in the future.
    2. Set the PowerShell Execution Policies to permit running unsigned scripts (Set to "Unrestricted" temporarily or permanently)
      1. Type: set-executionpolicy -ExecutionPolicy Unrestricted -Scope CurrentUser -Force
      2. Confirm changes made and type: get-executionpolicy -list
    3. [Optional] To Revert the Execution Policies behavior (post running SDKHelpSetup)
      1. From your original settings, make sure to use the original value from Step #1 for the CurrentUser, or
      2. To reset the Execution Policy to Windows default policy (Undefined):
        1. Type: set-executionpolicy -ExecutionPolicy Undefined -Scope CurrentUser -Force

    I will investigate if I can perform these steps above (for further beta) updates, and for the MSCE SDK U16 release ensure the script is signed at worst providing a command shell prompt to accept running.

    Thank you for your feedback and please let me know if you are ok/safe in performing the above to provide a further update.
    Bob

    REFERENCE

  • I followed the instructions, and ran SDKHelpSetup.bat in the \SDK\bin directory with admin. privilege.  I got this error:

    G:\PROGRA~1\Bentley\MICROS~2\SDK\bin>SDKHelpSetup
    File G:\Program Files\Bentley\MicroStation CONNECT Edition\SDK\bin\SDKHelpSetup.ps1 cannot be loaded because running
    scripts is disabled on this system. For more information, see about_Execution_Policies at
    https:/go.microsoft.com/fwlink/?LinkID=135170.
        + CategoryInfo          : SecurityError: (:) [], ParentContainsErrorRecordException
        + FullyQualifiedErrorId : UnauthorizedAccess
    The system cannot find the file G:\PROGRA~1\Bentley\MICROS~2\SDK\Documentation\SDKHelp.chm.

    I copied SDKHelp.chm manually to the \SDK\Documentation folder but got the same error about scripts.

Related
Recommended