Advanced Database Editor (ADE) usage

The Advanced Database Editor (ADE) usage is as follows:

ADE [/DALConfig:<ConfigValue>] [/DALAlias:<AliasString>] [/Row: <RowToOpen>] [/logfilename:<LogFileName>] [/debuglevel:<NewLogLevel>]

Note: All attributes are required unless indicated as optional.

• Optional: DALConfig:<ConfigValue> is the configuration value to use in initializing ADE. The <ConfigValue> value indicates which system to connect to as defined in the Data Access Layer (DAL) directory. The <ConfigValue> value consists of the following two components separated by a backslash:

  • The <System Name> component.

  • The <Sub Folder Name> component under the <System Name> directories that use Single Sign On (SSO).

    If you do not define a parameter, the system opens the Configuration Selector (as described in Open a form using Windows PowerShell for DNA).

    

  • The options available for the Select a system field are as follows:

    • es\control_room: The control_room subfolder for the test system—es—uses SSO to connect to the database.

    • es\control_room_shiftchange: This option requires user interaction to enter credentials. These credentials can not be used to open ADE from Windows PowerShell for DNA.

    • es\remote: The remote subfolder allows the user to connect remotely. This option requires user interaction to enter credentials. These credentials can not be used to open ADE from Windows PowerShell for DNA.

    • es\remote_sso: The remote_SSO subfolder connects to the site remotely using SSO.

      If you execute the command without the <Sub Folder Name> component (that is, just "ADE /DALConfig:es"), the system generates the following error:

      

      Similarly, if you execute the command using control_room_shiftchange as the <Sub Folder Name> component (that is, "ADE /DALConfig:<system name>\control_room_shiftchange"), the system generates the following error message because the subfolder requires user interaction for the entry of credentials:

      

      If the entered <System Name> does not exist in the DAL directory (for example, "ADE /DALConfig:dev\control_room"), the system generates the following error message:

      

• Optional: DALAlias:<AliasString> is the DAL alias to use. The valid values are as follows:

  • Realtime

  • CMX

  • Historical

  • XIS

  • PI

    If not specified, the default value is Realtime. The AliasString applies to one individual form. While you can open the view in ADE, an individual record may throw an exception. For example, executing either of the following commands will cause the system to generate an error message if you later open an analog record:

    ADE /DALAlias:XIS

    ADE /DALAlias:Historical

    

    Executing the following command will cause the system to generate an error message if you later open an analog record:

    ADE /DALAlias:PI

    

    Executing the following command with an invalid AliasString will cause the system to generate an error message if you later open an analog record:

    ADE /DALAlias:123

    

• Optional: Row:<RowToOpen> defines the record to open in the following format:

  <table name>.<key name>.<unique key field name>

  For example, the following command opens the 0analog record in the analog table using the name column as the unique key field:

  ADE /DALConfig:es\control_room /DALAlias:Realtime /Row:analog.0analog.name

  

  If you use an invalid record name, the system generates the following error message:

  

• Optional: logfilename:<LogFileName> defines the name of a log file to use. The default is the %DNADataRoot%\ADE\log\ADE.log file.

• Optional: debuglevel <NewLogLevel> sets the debug level for ADE. The default is set to Error. If the log file option is not used, the debug messages will appear in the %DNADataRoot%\ADE\log\ADE.log file. The available options are as follows:

  • Error: Error messages are logged, including fatal and exit messages.

  • Info: Information, warning, and error messages are logged.

  • Verbose: All messages—error, information, verbose, and warning—are logged.

  • Warning: Warning and error messages are logged.