Application Note. This document contains information on the following:

Size: px

Start display at page:

Download "Application Note. This document contains information on the following:"

Louisa Sharp
5 years ago
Views:

1 Document Number: IX_APP00115 File Name: InteractX Under the Hood.doc Date: January 27, 2003 Product: InteractX Designer Application Note Associated Project: Related Documents: KEYWORDS While precautions have been taken in the preparation of this note, CTC and the author assume no responsibility for errors or omissions. Neither is any liability assumed for damages resulting from the use of the information contained herein. This document contains information on the following: File Structure Applications Folder System Folder Materials - How to modify an existing material Brand.xml RTLanguage_enu.cfg - How to create a RTLanguage translation file for another language Licensing Folder Styles Folder How to share styles Toolbin Folder How to share drawers How to share parts Path Settings MSI s Page: 1

$In this example, InteractX was installed to the default directory C:\Program Files\InteractX. Double click on the Applications folder.$

2 File Structure Applications Folder Using Windows Explorer, browse to the location of your InteractX install. In this example, InteractX was installed to the default directory C:\Program Files\InteractX. Double click on the Applications folder. The Applications folder contains your InteractX applications. Double click on one of the applications to explore what is inside! Page: 2

An InteractX application is made up of the following files: File Extension File Description File Type.adm User Administration File Custom binary.amm.

3 An InteractX application is made up of the following files: File Extension File Description File Type.adm User Administration File Custom binary.amm.grp Alarm File contains information on alarm definitions and logging setup Radio Groups File stores the radio button groups.xml.xml.ody Application File.xml.opd Communications File Custom text.opf Communications File Custom binary.tag Tag File.xml.pnl Panel File Custom binary.vba VBA File contains VBA scripts (this file is optional and only exists if a user has a VBA script associated with the application) Custom binary Page: 3

$System Folder Using Windows Explorer, browse to the location of your InteractX install. In this example, InteractX was installed to the default directory C:\Program Files\InteractX.$

4 System Folder Using Windows Explorer, browse to the location of your InteractX install. In this example, InteractX was installed to the default directory C:\Program Files\InteractX. Double click on the System folder. Materials The System folder contains all of the materials available in InteractX, each as.png files. How to modify an existing material You can modify an existing material by editing the material s.png file in the System folder. The.png file must have the same name as the existing material. Page: 4

5 Brand.xml This file contains the branding information. You can brand the product with your company information. Here is a list of brandable objects. InteractX Designer name, company, copyright, and icons InteractX about box content InteractX Runtime name, copyright, and icons Install name and company information To modify the content of this file, open the file using any XML-compatible software package, such as NotePad or an.xml editor try or In this example, we will modify various parts of the branding file. To begin, we will edit the HMIDev application. Page: 5

newnamecorp.com</COMPANYURL> This will replace the web link shown in the Help menu when running InteractX outside of MachineShop. <BIGICON/> This needs to be edited to read: <BIGICON>nameoficon.

6 <BRANDING> <BRAND APPLICATION="HMIDev"> NOTE: this item must remain HIMDev <NAME>New Name Designer</NAME> This will replace the name of the designer shown in the title bar when running InteractX outside of MachineShop. <COMPANY>New Name Corporation</COMPANY> This will replace the name of the designer shown in the Help menu when running InteractX outside of MachineShop. <COMPANYURL> This will replace the web link shown in the Help menu when running InteractX outside of MachineShop. <BIGICON/> This needs to be edited to read: <BIGICON>nameoficon.ico</BIGICON> This will replace all instances of the 32x32 icon used in InteractX. <SMALLICON/> This needs to be edited to read: <SMALLICON>nameoficon.ico</SMALLICON> This will replace all instances of the 16x16 icon used in InteractX. The location of the.ico file needs to be where InteractX is installed, in this example C:\Program Files\InteractX Page: 6

7 <COPYRIGHT>Copyright (c) 2002 New Name Corporation</COPYRIGHT> <ABOUTBOX> The about box text can be customized to contain any text information. The about box will scroll, so there is no limit on the amout of text you can enter. There are a few simple formatting rules: (br) is a line break, (build) will insert the version number stored in the install. <TEXT>New Name Designer (br) Version (build)(br)(br) Copyright (c) 2002(br) New Name Corporation (br)(br) 1234 New Address (br) New City, New State 12345(br)(br)Telephone: (br)(br) @newnamecorp.com(br)(br)world Wide Web: is just an example of extra text(br)this is just an example of extra text(br)</text> <BIGICON/> This needs to be edited to read: <BIGICON>nameoficon.ico</BIGICON> This will replace the instances of the InteractX icon used in the about box. Just as before, the location of the.ico file needs to be where InteractX is installed, in this example C:\Program Files\InteractX </ABOUTBOX> Page: 7

8 <LICENSING> This controls where on the splash screen and in the header of the Licensing Manager the text goes, what font its using, and its size. <MAJORTEXTPOS X="50" Y="40"/> Major = main text, X and Y are the coordinated where the upper left pixel of the first character is positioned. <MAJORFONT HEIGHT="14" WIDTH="0" FACENAME="Arial" WEIGHT="700"/> <MINORTEXTPOS X="10" Y="95"/> Minor = copyright text, X and Y are the coordinated where the upper left pixel of the first character is positioned. <MINORFONT HEIGHT="12" WIDTH="0" FACENAME="Arial" WEIGHT="700"/> <SPLASH/> no longer used <DOAUTH>0</DOAUTH> no longer used <AUTHMINUTES>15</AUTHMINUTES> no longer used <RUNTIMEOUTMINUTES>60</RUNTIMEOUTMINUTES> no longer used </LICENSING> </BRAND> Next, we will edit the HMIRun application. Page: 8

9 <BRAND APPLICATION="HMIRun"> NOTE: this item must remain HIMDev <NAME>New Name Runtime</NAME> <BIGICON/> This needs to be edited to read: <BIGICON>nameoficon.ico</BIGICON> This will replace all instances of the 32x32 icon used in InteractX. <SMALLICON/> This needs to be edited to read: SMALLICON>nameoficon.ico</SMALLICON> This will replace all instances of the 16x16 icon used in InteractX. The location of the.ico file needs to be where InteractX is installed, in this example C:\Program Files\InteractX <COPYRIGHT>Copyright (c) 2002 New Name Corporation</COPYRIGHT> <LICENSING> This controls where on the splash screen and in the header of the Licensing Manager text goes, what font its using, and its size. <MAJORTEXTPOS X="20" Y="380"/> Major = main text, X and Y are the coordinated where the upper left pixel of the first character is positioned. <MAJORFONT HEIGHT="14" WIDTH="0" FACENAME="Arial" WEIGHT="700"/> <MINORTEXTPOS X="10" Y="30"/> Minor = copyright text, X and Y are the coordinated where the upper left pixel of the first character is positioned. <MINORFONT HEIGHT="12" WIDTH="0" FACENAME="Arial" WEIGHT="700"/> <SPLASH/> no longer used <DOAUTH>0</DOAUTH> no longer used <AUTHMINUTES>15</AUTHMINUTES> no longer used Page: 9

10 <RUNTIMEOUTMINUTES>60</RUNTIMEOUTMINUTES> no longer used </LICENSING> </BRAND> Finally, we will edit the application install. <BRAND APPLICATION="INSTALL"> <NAME>New Name</NAME> <COMPANY>New Name Coporation</COMPANY> </BRAND> Page: 10

11 RTLanguage_enu.cfg This file is the English version of a file containing translation information for some runtime objects, including the Popup Tools, User Admin strings, Alarming strings, logging strings, and miscellaneous errors. The file is a tab-delimited Unicode XML file. How to create a RTLanguage translation file for another language To translate the content of this file, open the file using any XML-compatible software package, such as NotePad or an.xml editor try or You can modify the different objects in the file and then save a copy of the.cfg file, renaming it with the proper Unicode abbreviation for the language. Page: 11

12 Here is a list of the different translatable objects in the file: Object Keyboard Description Every key on the popup Keyboard is assigned a number. You can modify what the keys display. For example, with key 1 you could change Esc to a Japanese character. Selection List Keypad Logon Display User Admin User Admin tool Alarming Logging For the popup Selection List, you can modify the up and down arrows. You can also translate Accept and Cancel and assign different hot keys to both. For the popup Keypad, you can modify the Cancel, Back, and Enter buttons as well as assign different hot keys to them. You can also modify the text on the object itself (Minimum and Maximum) and the decimal point. For the popup Logon Display, you can modify the Accept and Cancel buttons as well as assign different hot keys to both. You can also translate other strings associated with the object. You can translate a number of strings associated with logging on, logging off, and entering passwords. You can translate the left-column headings for this tool such as User Name and PW Expiration. In addition you can translate a number of error strings. You can translate the headers that appear on the Alarm Viewer such as Acknowledged and Time Off. In addition you can translate a number of error strings. You can translate specifiers such as Log Start Time and Log End Time. In addition you can translate a number of error strings. Here is a list of the supported languages and their Unicode abbreviations: Unicode Abbreviation Language Code Number ENU English (U.S.) 1033 SQI Albanian 1052 AFK Afrikaans 1078 ARA Arabic (Saudi Arabia) 1025 Page: 12

13 EUQ Basque 1069 BEL Belarusian 1059 BGR Bulgarian 1026 CAT Catalan 1027 CHT Chinese (Taiwan) 1028 CHS Chinese (PRC) 2052 ZHH Chinese (Hong Kong SAR, PRC) 3076 HRV Croatian 1050 CSY Czech 1029 DAN Danish 1030 NLD Dutch (Netherlands) 1043 NLB Dutch (Belgium) 2067 ENG English (United Kingdom) 2057 ENA English (Australian) 3081 ENC English (Canadian) 4105 ENZ English (New Zealand) 5129 ENI English (Ireland) 6153 ENS English (South Africa) 7177 ENJ English (Jamaica) 8201 ENB English (Caribbean) 9225 ENL English (Belize) ETI Estonian 1061 FIN Finnish 1035 Page: 13

14 FRA French (Standard) 1036 FRB French (Belgian) 2060 FRC French (Canadian) 3084 FRS French (Switzerland) 4108 FRL French (Luxembourg) 5132 DEU German (Standard) 1031 DES German (Switzerland) 2055 DEA German (Austria) 3079 DEL German (Luxembourg) 4103 DEC German (Liechtenstein) 5127 ELL Greek 1032 HEB Hebrew 1037 HUN Hungarian 1038 ISL Icelandic 1039 IND Indonesian 1057 ITA Italian (Standard) 1040 ITS Italian (Switzerland) 2064 JPN Japanese 1041 KOR Korean 1042 LVI Latvian 1062 LTH Lithuanian 1063 NOR Norwegian (Bokmal) 1044 NON Norwegian (Nynorsk) 2068 Page: 14

15 PLK Polish 1045 PTB Portuguese (Brazil) 1046 PTG Portuguese (Portugal) 2070 ROM Romanian 1048 RUS Russian 1049 SRB Serbian (Cyrillic) 3098 SKY Slovak 1051 SLV Slovenian 1060 ESP Spanish (Spain, Traditional Sort) 1034 ESM Spanish (Mexican) 2058 ESN Spanish (Spain, Modern Sort) 3082 SVE Swedish 1053 THA Thai 1054 TRK Turkish 1055 UKR Ukranian 1058 UZB Uzbek (Latin) 1091 VIT Vietnamese 1066 Page: 15

16 In this example, we will translate the popup English (ENU) Keypad to French (FRA). Open the RTLanguage_enu.cfg file in an xml editor, in this example we will use TextPad. Assign French words and hot keys to the translatable keypad objects. Save a copy of the file, renaming it RTLanguage_fra.cfg. Note: Be sure to save the.cfg file with UTF-8 encoding. You can have a separate CFG file for each language, and you can use the CFG for any application you create. When you change languages in runtime, InteractX will search for the corresponding.cfg file. If a.cfg file does not exist for the language, English RTLanguage_enu.cfg will be used as the default. Note: In the cases of some languages, such as Chinese and Japanese, the popup Keyboard provided with Designer may be insufficient because it is based on the English language. You can still translate RTLanguage_enu.cfg to a double-byte language, but you should use the CFG file with a third party popup keyboard that supports the keys for double-byte characters. Page: 16

Licensing Folder Double click on the Licensing folder. The Licensing folder contains folders named Html and Images. Double click on the HTML folder.

17 Licensing Folder Double click on the Licensing folder. The Licensing folder contains folders named Html and Images. Double click on the HTML folder. The HTML folder contains two files used for licensing. Index.htm is the file which links into CTC s internal systems to generate product enable codes. Page2.htm is the license agreement. A user can replace these with what they would like as long as the names are consistent. Double click on the Images folder. The images folder contains the splash and header bitmaps used in the Licensing Manger. A user can replace these with what they would like as long as the names are consistent. Note: the code will not scale the bitmaps. If a bitmap is too large, part of it will draw behind the License Manger. Page: 17

Styles Folder Double click on the Styles folder. The Styles folder contains the different styles available in InteractX, each style in.xml format.

18 Styles Folder Double click on the Styles folder. The Styles folder contains the different styles available in InteractX, each style in.xml format. How to share styles You can easily share your newly created styles with other users by giving them a copy of the.xml file for that style. For example, in InteractX, I created a new style named Example. To share this style with another person, simply copy the Example.xml file and they will place the copy in their Styles folder. Page: 18

19 Toolbin Folder Double click on the Toolbin folder. The Toolbin folder contains the different drawers available in the toolbin. How to share drawers You can easily share your toolbin drawers with other users by giving them a copy of the drawer folder. For example, in InteractX, I created a new drawer named New Drawer. To share this drawer with another person, simply copy the drawer folder and they will place the copy in their Toolbin folder. The copied drawer will automatically default to the last drawer in the toolbin. To edit the order of drawers a user can enter InteractX and rearrange the order of the toolbin drawers and then exit InteractX to save the changes. Another option is to edit the Toolbin.xml file. The order of the drawers is contained in the Toolbin.xml file. A user can edit the.xml file using any XMLcompatible software package, such as NotePad or an.xml editor try or Double click on a drawer folder. The Drawer folder contains the different parts available in the drawer. Page: 19

20 How to share parts You can easily share your parts within a toolbin drawer with other users by giving them a copy of the part folder. For example, in InteractX, in the drawer named New Drawer, there are three parts Exit, Next, and Previous. To share any of these parts with another person, simply copy the part folder and they will place the copy in one of their Toolbin folders. The copied part will automatically default to the last part in the drawer. To edit the order of parts within a drawer a user can enter InteractX and rearrange the order of the parts within the toolbin drawers and then exit InteractX to save the changes. Another option is to edit the drawer.xml file. The order of the parts within a drawer is contained in the drawer.xml file. A user can edit the.xml file using any XML-compatible software package, such as NotePad or an.xml editor try or Page: 20

21 Path Settings When creating a new MachineShop project, the defaut path for project location is C:\Program Files\MachineShop Suite\Projects. The default location for an application created within a MachineShop Project is C:\Program Files\MachineShop Suite\Projects\NameofProject\NameofDevice\InteractX. A user can create multiple Project storage locations by simply creating a new Projects folder in any desired location. When creating a new MachineShop project, the New Project dialog will prompt the user to define a project location. The user can then browse to the desired project folder. When creating a new InteractX application when running InteractX Designer (not within MachineShop), the default application location is C:\Program Files\InteractX\Applications. A user can create multiple Application storage locations by simply creating a new Applications folder in any desired location. When creating a new InteractX application, the New Application dialog will prompt the user to define a application location. The user can then browse to the desired application folder. Page: 21

MSIs MSIs are the Microsoft Installer files which install different components of the MachineShopSuite, including MachineShop, InteractX Designer, InteractX Runtime, and the Deployment Server.

22 MSIs MSIs are the Microsoft Installer files which install different components of the MachineShopSuite, including MachineShop, InteractX Designer, InteractX Runtime, and the Deployment Server. The MSIs are located on the release CD in a folder named MSI. A use can double click on any of the.msi files to install a component. File InteractX.msi InteractXDeployment.msi File Description Installs InteractX Designer and Runtime Installs InteractX Deployment Server InteractXDST.msi InteractXRuntime.msi MachineShop Suite.msi Installs PowerStationDST, PowerStationPST, and all the files needed to run InteractX within Global MachineShop Installs InteractX Runtime Installs MachineShop Suite, InteractX Designer and Runtime InstMsiA.exe For Win98 machines, upgrades Microsoft Installer to version 2.0 InstMsiW.exe For WinNT and 2000 machines, upgrades Microsoft Installer to version 2.0 Page: 22

Xapity Current Activity Administration Guide.

Xapity Current Activity Administration Guide www.xapity.com Document Version 1.0 October 2016 This document contains information that may change without notice. While every effort has been made to ensure