The following table describes all the XML tags used in the XML configuration file:
XML Tag Pair |
Description |
---|---|
<?xml version="1.0" encoding="UTF-8"?> | Do not modify this line, it contains information about the level and type of the xml format. |
<configuration xmlns="http://tempuri.org/config.xsd" version="1.0"> | Do not modify this line as it contains information about the level and type of the xml format. |
<startupSystem name="Sample"></startupSystem> | Identifies the <system> that should be started when the WinForm Container is run. If this line is omitted, then the first <system> block that is encountered is run. The name entered here must match the name given in one of the <system> blocks in the configuration file. Change it to be the same as the system name of the system you want to start up with. This is to allow for SWITCH.TO, where multiple systems are in the one config file. |
<system name="Sample"> | Is the start of the block of data for the named system. In this case, MySystem. This 'name' is displayed on the title bar of the WinForm Container, and should be a user friendly name. The actual name of the runtime system is identified in a different line. Change this to the name of your system. |
<componentName>SAMPLE </componentName> | This is the deployed COM+ system name of the generated runtime. The simplest way to find this is to open the 'component services' management console on the machine that the runtime was generated to, then Component Services/Computers/My Computer/COM+ Applications. Find your generated system .The name of your COM+ application is what you should enter here. Note: This name is case sensitive and must correspond to the case of the actual name of the folder. |
<runtimeServer>localhost</runtimeServer> | Identifies the machine name that the runtime system was deployed to. This can also be the IP address of the server. |
<downloadServerURI>file://C:\MySystem\ Sample\SampleDeploy\Release\Sample\ Interfaces\WinForms\ Bin</downloadServerURI> | The name of the computer the client should look to for updated or missing files. Language numbers are added automatically and do not need to be included as part of this entry. This can be left blank, but you need to manually copy the form control files to each end user computer. This might be an http: reference, or a file: reference. For example http://myWebServer/myAppFiles/ |
<localDownloadDirectory>.\ </localDownloadDirectory> | Identifies the directory on the local computer where the WinForm Container expects to find the individual forms, images and external list boxes. This is also the location that forms is downloaded to. This will normally be the current directory. |
<defaultImageType>.jpg</defaultImageType> | Identifies the file extension to use if an image name does not include one. .This is generally the .jpg or .gif, .jpg is best for photo type images, but .gif are better for graphic type images. |
<defaultImageSubDirectory>images\ </defaultImageSubDirectory> | The sub-directory under the 'localDownloadDirectory' in which to place the images. |
<defaultListType>.xml</defaultListType> | Controls the file extension to use when downloading 'external' list files. External list files are list data files that are not created by the sendlist.static or sendlist.dynamic command, but are created by hand. |
<defaultListSubDirectory> images\</defaultListSubDirectory> | The sub-directory under the 'localDownloadDirectory' in which to place external lists. |
<disableConsole>true</disableConsole> | Prevents a user for accessing the console dialog, and issuing colon commands. This option must be set to false if you want the end user to be able to run reports, or interact with reports. If this item is set to true, the Command Console, Select Commands and Run Reports menu items are disabled. |
<GIWCompatibleBehaviour>true </GIWCompatibleBehaviour> | Alters the behavior of the WinForm Client to be more like that of a Graphical Interface Workbench client. This alters the way push button groups are handled, from a Windows standard way (no data sent unless a button in that group is pressed) to a GIW way (data is sent for every button group, unless a button in a different button group is pressed). |
<enableKanji>true</enableKanji | Enables the correct handling of Kanji data in a Segment that has NationalString Nodal property under the National Support category set to MultiByte. In particular, it ensures that Kanji data sent to the Winform clients via the SendListDynamic and SendListStatic commands are properly encoded and displayed in list boxes. |
<enableLogging>true</enableLogging> | Controls logging. This is a diagnostic log, and should only be enabled when you are trying to track down a particular problem. |
<windowState>Normal</windowState> | Specifies the initial state of the Winform window upon the Winform Container being started. Valid values are Normal, Maximized, and Minimized. |
<clientSize>800,600</clientSize> | Specifies the initial size of the Winform window upon the Winform Container being started. |
<useComputerNameForStation>false </useComputerNameForStation> | Determines whether to use the local computer name as the station name for the Winform client session. By default, the Winform user’s Windows user ID is used as the station name. |
<stationName> | Specifies the station name to use. If specified, this value overrides the default station name and/or the <useComputerNameForStation> setting above if True. |
<logFile>.\client.log</logFile> | Identifies the location of the WinForm Container log file if the enableLogging tag is true in the config.xml file. The log file also contains masked data for attributes that have the EnableMaskDefinition property set to true and for attributes that have the ControlType property set to PasswordField. |
<ispecs> | Do not modify. This tag identifies an <ispecs> block. It surrounds a list of the ispecs shown in the 'Open Form' dialog. If the <ispecs> block is empty, the select forms menu item is disabled in the WinForm client. |
<ispec name="Menu" description= "The description for the Menu class"> | Each <ispec> item identifies an ispec and description that appears in the list of forms in the WinForm Container. Add additional ispecs as required. |
</ispec> | Note: The individual closing tag for each ispec might be omitted if each <ispec tag is terminated with the closing character of />. |
</ispecs> | Do not modify, as this tag identifies an <ispecs> block. It surrounds a list of the ispecs shown in the 'Open Form' dialog. If the <ispecs> block is empty, the select forms menu item is disabled in the WinForm client. |
<reports> | Do not modify. This tag identifies a <reports> block. This block encompasses a list of reports the user is shown in the Report dialog. If the <reports> block is empty, the run reports menu item is disabled in the WinForm client. |
<report name="report1" description="The description for the report1 report"> | Each <report> item identifies a report and description that appears in the run reports dialog. Add additional reports as required. |
</report> | Note: The individual closing tag for each report might be omitted if each <report tag is terminated with the closing character of />. |
<report name="report2" description="The description for the report2 report"> | Each <report> item identifies a report and description that appears in the run reports dialog. Add additional reports as required. |
</report> | Note: The individual closing tag for each report might be omitted if each <report tag is terminated with the closing character of />. |
</reports> | Do not modify. This tag identifies a <reports> block. This block encompasses a list of reports the user is shown in the Report dialog. If the <reports> block is empty, the run reports menu item is disabled in the WinForm client. |
<commands> | Do not modify. This tag identifies a <commands> block. If the <commands> block is empty, the System Commands menu item is disabled in the WinForm client. |
<command name="who" description="list of who is on the system"> | Each <command> item identifies a colon command, and a description that appears in the System Command dialog. Add additional commands as required. |
</command> | Note: The individual closing tag for each command might be omitted if each <command tag is terminated with the closing character of />. |
</commands> | Do not modify. This tag identifies a <commands> block. If the <commands> block is empty, the System Commands menu item is disabled in the WinForm client. |
<languages> | Do not modify. This tag identifies a <languages> block. If this block is empty, the Change Language menu item is disabled. This block is only required if your end users need to change between languages. |
<language name="English" ID=”1033” / > | The languages must reflect the languages that you have defined in your AB Suite system. The name and ID should match the names and IDs of the languages you have defined in your runtime system. Add additional languages as required. |
</language> | Note: The individual closing tag for each language might be omitted if each <language tag is terminated with the closing character of />. |
</languages> | Do not modify. This tag identifies a <languages> block. If this block is empty, the Change Language menu item will be disabled. This block is only required if your end users need to change between languages. |
</system> | Defines the end of this particular system. If you switch between more than one systems using the SWITCH.TO command in you runtime logic, you must define a <system> block for each system that might be switched into. |
</configuration> | Identifies the end of the configuration block. |