https://brwiki2.brulescorp.com/brwiki2/api.php?action=feedcontributions&feedformat=atom&user=AdminBR Wiki - User contributions [en]2026-04-18T14:22:01ZUser contributionsMediaWiki 1.41.0https://brwiki2.brulescorp.com/brwiki2/index.php?title=Main_Page&diff=6542Main Page2013-07-31T14:28:13Z<p>Admin: /* Other Business Rules! Links */</p>
<hr />
<div>Welcome to the '''{{SITENAME}}'''. This wiki is dedicated to the '''[[Business Rules!]]''' programming language (a.k.a. BR) and the software developers who use it. Currently containing [[Special:Statistics|{{NUMBEROFARTICLES}}]] articles, this growing wiki is a great place to find information about the Business Rules! programming language. Our goal is to provide Business Rules! developers a convenient source of reference as well as an easy-to-use platform for documentation development. <br />
<br />
We encourage members of the [[BR Wiki:Community Portal|Business Rules! community]] to contribute their own knowledge to the Wiki. Everyone is encouraged to [[Special:Userlogin|register]] but editing is restricted to the [[BR Wiki:Administrators|editors group]]. <br />
<br />
If you come here often, you may be interested in just [[Special:Newpages|new pages]] or [[Special:Recentchanges|recent changes]]. If you'd like to keep up with what's happening on the BR! Wiki you are welcome to [http://brwiki.ads.net/index.php?title=Special:Recentchanges&feed=rss subscribe to the recent changes RSS]. <br />
<br />
== For New Users ==<br />
<br />
*[http://meta.wikimedia.org/wiki/Help:Contents Help Using the Wiki]<br />
*[[Special:Userlogin|Register]]<br />
*[[BR Tutorial]]<br />
*[http://brforum.brulescorp.com BR Forum]<br />
<br />
== Main Links ==<br />
<br />
*[[Business Rules!|Introduction]]<br />
*[[Business Rules!|BR Reference]]<br />
*[[Backward Compatibility]]<br />
*[[:Category:Utilities Third Party|Utilities Third Party]]<br />
*[http://brwiki.brulescorp.com Old Wiki]<br />
*[http://www.ads.net/brules/download.html#BRUTILITIES Old BR Utilities]<br />
*[[Export|Exporting the Wiki]]<br />
<br />
==ADS Official Links==<br />
<br />
'''Application Development Systems''', commonly called '''ADS''', is the owner and distributor of the [[Business Rules!]].<br />
<br />
The links below are all hosted and maintained by ADS.<br />
<br />
*[http://ads.net/home.html ADS Home]<br />
*[http://www.ads.net/brules/ Business Rules! Home]<br />
*[http://www.ads.net/brules/advanced/index.html Advanced Capabilities]<br />
*[http://www.ads.net/brules/dealers.html Dealers]<br />
*[http://www.ads.net/brules/download.html Download]<br />
*[ftp://ftp.ads.net/Dll_Distr/ ADS FTP Site] (See also the BR Wiki's documentation of [[ADS FTP Site]].)<br />
<br />
==Business Rules! Related Links==<br />
<br />
*[http://www.sageax.com/br.html Sage Enterprises' Business Rules! page]<br />
*[http://br32.com/ BR32.com]<br />
*[http://www.luisgomez.net/br/ Luis Gomez's BR page]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Main_Page&diff=6541Main Page2013-07-31T14:26:43Z<p>Admin: /* Helpful Links */</p>
<hr />
<div>Welcome to the '''{{SITENAME}}'''. This wiki is dedicated to the '''[[Business Rules!]]''' programming language (a.k.a. BR) and the software developers who use it. Currently containing [[Special:Statistics|{{NUMBEROFARTICLES}}]] articles, this growing wiki is a great place to find information about the Business Rules! programming language. Our goal is to provide Business Rules! developers a convenient source of reference as well as an easy-to-use platform for documentation development. <br />
<br />
We encourage members of the [[BR Wiki:Community Portal|Business Rules! community]] to contribute their own knowledge to the Wiki. Everyone is encouraged to [[Special:Userlogin|register]] but editing is restricted to the [[BR Wiki:Administrators|editors group]]. <br />
<br />
If you come here often, you may be interested in just [[Special:Newpages|new pages]] or [[Special:Recentchanges|recent changes]]. If you'd like to keep up with what's happening on the BR! Wiki you are welcome to [http://brwiki.ads.net/index.php?title=Special:Recentchanges&feed=rss subscribe to the recent changes RSS]. <br />
<br />
== For New Users ==<br />
<br />
*[http://meta.wikimedia.org/wiki/Help:Contents Help Using the Wiki]<br />
*[[Special:Userlogin|Register]]<br />
*[[BR Tutorial]]<br />
*[http://brforum.brulescorp.com BR Forum]<br />
<br />
== Main Links ==<br />
<br />
*[[Business Rules!|Introduction]]<br />
*[[Business Rules!|BR Reference]]<br />
*[[Backward Compatibility]]<br />
*[[:Category:Utilities Third Party|Utilities Third Party]]<br />
*[http://brwiki.brulescorp.com Old Wiki]<br />
*[http://www.ads.net/brules/download.html#BRUTILITIES Old BR Utilities]<br />
*[[Export|Exporting the Wiki]]<br />
<br />
==ADS Official Links==<br />
<br />
'''Application Development Systems''', commonly called '''ADS''', is the owner and distributor of the [[Business Rules!]].<br />
<br />
The links below are all hosted and maintained by ADS.<br />
<br />
*[http://ads.net/home.html ADS Home]<br />
*[http://www.ads.net/brules/ Business Rules! Home]<br />
*[http://www.ads.net/brules/advanced/index.html Advanced Capabilities]<br />
*[http://www.ads.net/brules/dealers.html Dealers]<br />
*[http://www.ads.net/brules/download.html Download]<br />
*[ftp://ftp.ads.net/Dll_Distr/ ADS FTP Site] (See also the BR Wiki's documentation of [[ADS FTP Site]].)<br />
<br />
==Other Business Rules! Links==<br />
<br />
*[http://www.sageax.com/br.html Sage Enterprises' Business Rules! page]<br />
*[http://br32.com/ BR32.com]<br />
*[http://www.luisgomez.net/br/ Luis Gomez's BR page]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Main_Page&diff=6540Main Page2013-07-31T14:24:12Z<p>Admin: /* For New Users */</p>
<hr />
<div>Welcome to the '''{{SITENAME}}'''. This wiki is dedicated to the '''[[Business Rules!]]''' programming language (a.k.a. BR) and the software developers who use it. Currently containing [[Special:Statistics|{{NUMBEROFARTICLES}}]] articles, this growing wiki is a great place to find information about the Business Rules! programming language. Our goal is to provide Business Rules! developers a convenient source of reference as well as an easy-to-use platform for documentation development. <br />
<br />
We encourage members of the [[BR Wiki:Community Portal|Business Rules! community]] to contribute their own knowledge to the Wiki. Everyone is encouraged to [[Special:Userlogin|register]] but editing is restricted to the [[BR Wiki:Administrators|editors group]]. <br />
<br />
If you come here often, you may be interested in just [[Special:Newpages|new pages]] or [[Special:Recentchanges|recent changes]]. If you'd like to keep up with what's happening on the BR! Wiki you are welcome to [http://brwiki.ads.net/index.php?title=Special:Recentchanges&feed=rss subscribe to the recent changes RSS]. <br />
<br />
== For New Users ==<br />
<br />
*[http://meta.wikimedia.org/wiki/Help:Contents Help Using the Wiki]<br />
*[[Special:Userlogin|Register]]<br />
*[[BR Tutorial]]<br />
*[http://brforum.brulescorp.com BR Forum]<br />
<br />
== Helpful Links ==<br />
<br />
*[[Business Rules!|BR Reference]]<br />
*[http://brforum.brulescorp.com BR Forum]<br />
*[http://brwiki.brulescorp.com Old Wiki]<br />
*[http://www.ads.net/brules/download.html#BRUTILITIES Old BR Utilities]<br />
*[[:Category:Utilities Third Party|Utilities Third Party]]<br />
*[[Backward Compatibility]]<br />
*[[Export|Exporting the Wiki]]<br />
*[[BR Tutorial]]<br />
<br />
==ADS Official Links==<br />
<br />
'''Application Development Systems''', commonly called '''ADS''', is the owner and distributor of the [[Business Rules!]].<br />
<br />
The links below are all hosted and maintained by ADS.<br />
<br />
*[http://ads.net/home.html ADS Home]<br />
*[http://www.ads.net/brules/ Business Rules! Home]<br />
*[http://www.ads.net/brules/advanced/index.html Advanced Capabilities]<br />
*[http://www.ads.net/brules/dealers.html Dealers]<br />
*[http://www.ads.net/brules/download.html Download]<br />
*[ftp://ftp.ads.net/Dll_Distr/ ADS FTP Site] (See also the BR Wiki's documentation of [[ADS FTP Site]].)<br />
<br />
==Other Business Rules! Links==<br />
<br />
*[http://www.sageax.com/br.html Sage Enterprises' Business Rules! page]<br />
*[http://br32.com/ BR32.com]<br />
*[http://www.luisgomez.net/br/ Luis Gomez's BR page]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Business_Rules!&diff=6539Business Rules!2013-07-31T14:07:20Z<p>Admin: minor edits re programming philosophy</p>
<hr />
<div>====General Introduction====<br />
'''Business Rules!''', also known as '''BR''' is a derivative of ANSI Basic similar to that used on IBM mid-frame computers. It is a highly readable '''cross-platform''' [[programming language]] used by procedural programmers to build applications in a top-down building block structure. <br />
<br />
In the modern world there are three general types of programming languages:<br />
* Procedural - Where program control flow is the primary focus while the code creates, processes and destroys representations of external reality.<br />
* Non-Procedural - Where various elements are defined with snippets of code attached to events which are triggered by either users or other programs.<br />
* Object Oriented - Which is a blend of the preceding types with predefined rules for creating and deleting representations of external reality, and program defined methods of accessing them. This language structure was introduced to the programming world as C++, and has become the predominate programming language model. <br />
<br />
The advent of the World Wide Web introduced the widespread acceptance of the connectionless client/server model, with [[tunneled methods]] of achieving connection persistence. This technique was implemented by the Microsoft Dot Net programming languages. Another concept implemented by both Dot Net and Java was the use of a compiled pseudo-code executable which is made portable by providing execution engines for each platform. <br />
<br />
====RESTful Characteristics====<br />
Representational State Transfer (REST) is a style of software architecture for distributed systems such as the World Wide Web and [[loosely coupled]] application frameworks. Key goals of REST include:<br />
<br />
* Scalability of component interactions<br />
* Generality of interfaces<br />
* Independent deployment of components<br />
* Intermediary components to reduce latency, enforce security and encapsulate legacy systems<br />
<br />
The strength of many programming languages lies in their ability to express immense amounts of processing control specifications in relatively few statements. This is achieved in object oriented languages by the concepts of inheritance and overloading. While these concepts work well for creating and using tool sets, where all users learn the tools as an extension of the underlying language, a pervasive problem associated with them is that in an application framework it is necessary for users of objects to be aware of processing details of the objects they inherit from. Again, this works extremely well for tool sets, and not so well where 1) large sets of programs are shared among many programmers, 2) where programs are part of a networked set of applications, and 3) where a large set of programs must be modified by someone who is not entirely familiar with them. <br />
<br />
Truly RESTful systems insulate nodes from the requirement of knowing processing details within other nodes. <br />
<br />
====BR Characteristics====<br />
Business Rules! is a procedural language that conforms to REST principles. Its unique set of rules for utilizing libraries to create program building blocks, along with its general readability, position it well for both beginning programmers and large scale projects. <br />
<br />
This language is being adopted by a growing number of young programmers due to it's ability to quickly develop procedural programs that include:<br />
<br />
* powerful string and array manipulation<br />
* [[character position oriented window, field and report specification]]<br />
* HTTP client emulation<br />
* serial communications for industrial applications<br />
* PDF printing with background forms<br />
* both flat file processing with multiple indexes and traditional database support<br />
* powerful built-in parsing functions for XML and CSV strings<br />
<br />
and have it run in a framework with:<br />
* a [[client server architecture]]<br />
* a portable pseudo-code executable format<br />
* dynamic interactive debugging<br />
* uniquely readable building block programming ( libraries )<br />
* performance profiling<br />
* an HTTP server add-on with JSON compilation and manipulation <br />
<br />
BR handles platform dependencies independently from code, so it is easy to maintain one set of programs for all supported platforms (Windows, Linux and MAC).<br />
<br />
The BR Programming Language is comprised of [[Environmental Settings]], [[Commands]], [[Variable|Variables]], [[Internal Functions|Functions]], [[Expression Logic]] and [[Program Statements]]. Programs are compiled into virtual code that is executed by a run-time executive. This supports a high degree of portability across platforms. The interactive nature of BR facilitates relatively easy debugging because you can change a program while it is running, as well as execute commands and statements from it's [[command console]].<br />
<br />
Business Rules! strong commitment to providing backward compatibility options ensures that any investment in BR programs will be protected nearly indefinitely. While some of Business Rules! syntax may seem too simplistic to someone versed in more complex object oriented programming, the language's inability to hide code enhances readability. <br />
<br />
See also: [[BR Wiki:Community Portal]]<br />
<br />
== Getting Started ==<br />
<br />
*BR [[Setup]]<br />
<br />
*[[Getting Started]]<br />
<br />
== Categories ==<br />
<br />
Most of this wiki is categorized. An individual article may belong to multiple categories. The [[Special:Uncategorizedcategories|Top Level Categories]] are a nice way to browse this wiki. In the table below are the most popular categories.<br />
<br />
*[[:Category:Commands|Commands]]<br />
*[[:Category:Variable|Variables]]<br />
*[[:Category:Arrays|Arrays]]<br />
*[[:Category:Operations|Operations]]<br />
*[[:Category:Internal Functions|Internal Functions]]<br />
*[[:Category:Field Specifications|Field Specifications]]<br />
*[[:Category:Definitions|Definitions]]<br />
*[[:Category:Statements|Statements]]<br />
*[[:Category:Control_Structures|Control Structures]]<br />
*[[:Category:File_Operations|File Operations]]<br />
*[[:Category:Sorting_and_Indexing|Sorting and Indexing]]<br />
*[[:Category:GUI|Widgets / GUI]]<br />
*[[:Category:Properties_Events_and_Methods|Properties, Events and Methods]]<br />
*[[:Category:User_Defined_Functions_and_Libraries|User Defined Functions / Libraries]]<br />
*[[:Category:Config|Configuration and Environmental Settings]]<br />
*[[:Category:Printing|Printing]]<br />
*[[:Category:HTTP|HTTP]]<br />
*[[:Category:External_Editors|External Editors]]<br />
*[[:Category:Terminology|Glossary / Terminology]]<br />
*[[:Category:Error|Error Handling]]<br />
*[[:Category:Error Codes|Error Codes]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Main_Page&diff=3511Main Page2013-06-26T23:47:14Z<p>Admin: /* Helpful Links */</p>
<hr />
<div>Welcome to the '''{{SITENAME}}'''. This wiki is dedicated to the '''[[Business Rules!]]''' programming language (a.k.a. BR) and the software developers who use it. Currently containing [[Special:Statistics|{{NUMBEROFARTICLES}}]] articles, this growing wiki is a great place to find information about the Business Rules! programming language. Our goal is to provide Business Rules! developers a convenient source of reference as well as an easy-to-use platform for documentation development. <br />
<br />
We encourage members of the [[BR Wiki:Community Portal|Business Rules! community]] to contribute their own knowledge to the Wiki. Everyone is encouraged to [[Special:Userlogin|register]] but editing is restricted to the [[BR Wiki:Administrators|editors group]]. <br />
<br />
If you come here often, you may be interested in just [[Special:Newpages|new pages]] or [[Special:Recentchanges|recent changes]]. If you'd like to keep up with what's happening on the BR! Wiki you are welcome to [http://brwiki.ads.net/index.php?title=Special:Recentchanges&feed=rss subscribe to the recent changes RSS]. <br />
<br />
== For New Users ==<br />
<br />
*[http://meta.wikimedia.org/wiki/Help:Contents Help Using the Wiki]<br />
*[[Special:Userlogin|Register]]<br />
<br />
== Helpful Links ==<br />
<br />
*[[Business Rules!|BR Reference]]<br />
*[http://brforum.brulescorp.com BR Forum]<br />
*[http://brwiki.brulescorp.com Old Wiki]<br />
*[http://www.ads.net/brules/download.html#BRUTILITIES Old BR Utilities]<br />
*[[:Category:Utilities Third Party|Utilities Third Party]]<br />
*[[Backward Compatibility]]<br />
*[[Export|Exporting the Wiki]]<br />
*[[BR Tutorial]]<br />
<br />
==ADS Official Links==<br />
<br />
'''Application Development Systems''', commonly called '''ADS''', is the owner and distributor of the [[Business Rules!]].<br />
<br />
The links below are all hosted and maintained by ADS.<br />
<br />
*[http://ads.net/home.html ADS Home]<br />
*[http://www.ads.net/brules/ Business Rules! Home]<br />
*[http://www.ads.net/brules/advanced/index.html Advanced Capabilities]<br />
*[http://www.ads.net/brules/dealers.html Dealers]<br />
*[http://www.ads.net/brules/download.html Download]<br />
*[ftp://ftp.ads.net/Dll_Distr/ ADS FTP Site] (See also the BR Wiki's documentation of [[ADS FTP Site]].)<br />
<br />
==Other Business Rules! Links==<br />
<br />
*[http://www.sageax.com/br.html Sage Enterprises' Business Rules! page]<br />
*[http://br32.com/ BR32.com]<br />
*[http://www.luisgomez.net/br/ Luis Gomez's BR page]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Main_Page&diff=3510Main Page2013-06-26T23:46:55Z<p>Admin: /* Helpful Links */</p>
<hr />
<div>Welcome to the '''{{SITENAME}}'''. This wiki is dedicated to the '''[[Business Rules!]]''' programming language (a.k.a. BR) and the software developers who use it. Currently containing [[Special:Statistics|{{NUMBEROFARTICLES}}]] articles, this growing wiki is a great place to find information about the Business Rules! programming language. Our goal is to provide Business Rules! developers a convenient source of reference as well as an easy-to-use platform for documentation development. <br />
<br />
We encourage members of the [[BR Wiki:Community Portal|Business Rules! community]] to contribute their own knowledge to the Wiki. Everyone is encouraged to [[Special:Userlogin|register]] but editing is restricted to the [[BR Wiki:Administrators|editors group]]. <br />
<br />
If you come here often, you may be interested in just [[Special:Newpages|new pages]] or [[Special:Recentchanges|recent changes]]. If you'd like to keep up with what's happening on the BR! Wiki you are welcome to [http://brwiki.ads.net/index.php?title=Special:Recentchanges&feed=rss subscribe to the recent changes RSS]. <br />
<br />
== For New Users ==<br />
<br />
*[http://meta.wikimedia.org/wiki/Help:Contents Help Using the Wiki]<br />
*[[Special:Userlogin|Register]]<br />
<br />
== Helpful Links ==<br />
<br />
*[[Business Rules!|BR Reference]]<br />
*[http://brforum.brulescorp.com BR Forum]<br />
*[http://brwiki.brulescorp.com Old Wiki]<br />
*[http://www.ads.net/brules/download.html#BRUTILITIES Old BR Utilities]<br />
*[[:Category:Utilities Third Party]]<br />
*[[Backward Compatibility]]<br />
*[[Export|Exporting the Wiki]]<br />
*[[BR Tutorial]]<br />
<br />
==ADS Official Links==<br />
<br />
'''Application Development Systems''', commonly called '''ADS''', is the owner and distributor of the [[Business Rules!]].<br />
<br />
The links below are all hosted and maintained by ADS.<br />
<br />
*[http://ads.net/home.html ADS Home]<br />
*[http://www.ads.net/brules/ Business Rules! Home]<br />
*[http://www.ads.net/brules/advanced/index.html Advanced Capabilities]<br />
*[http://www.ads.net/brules/dealers.html Dealers]<br />
*[http://www.ads.net/brules/download.html Download]<br />
*[ftp://ftp.ads.net/Dll_Distr/ ADS FTP Site] (See also the BR Wiki's documentation of [[ADS FTP Site]].)<br />
<br />
==Other Business Rules! Links==<br />
<br />
*[http://www.sageax.com/br.html Sage Enterprises' Business Rules! page]<br />
*[http://br32.com/ BR32.com]<br />
*[http://www.luisgomez.net/br/ Luis Gomez's BR page]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Third_party_utlity&diff=3509Third party utlity2013-06-26T23:46:17Z<p>Admin: Created page with "There are several third party utilities available for integration with your Business Rules! software system. Some of these have been written by companies that have never e..."</p>
<hr />
<div>There are several third party utilities available for integration with your [[Business Rules!]] software system. Some of these have been written by companies that have never even heard of BR, but most of them have been written by the BR user community.<br />
<br />
*Third Party Utilities<br />
**[[:Category:Install Builder|Install Builders]]<br />
***[[Inno]]<br />
***[[NSIS Setup]]<br />
**BR Function Libraries<br />
***[[fnSnap]]<br />
***[[Fileio library]]<br />
**Tools for extending the power of BR<br />
***[[AutoIt]]<br />
***[[BR Internet Bridge]]<br />
***[[ScreenIO]]<br />
***[[PhpIO]]<br />
**Tools for making BR programming easier<br />
***[[FreeEdit Linkage]]<br />
***[[Notepad++]]<br />
***[[MyEdit (BR Edition)]]<br />
***[[BR2BRS|WB2BRS and BR2BRS]] <br />
***[[BRS2BR|BRS2WB and BRS2WB]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Category:Utilities_Third_Party&diff=3508Category:Utilities Third Party2013-06-26T23:45:44Z<p>Admin: Created page with "{{:Third party utlity}} Category:Utilities"</p>
<hr />
<div>{{:Third party utlity}}<br />
<br />
[[Category:Utilities]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Category:3rd_Party_Utilities&diff=3507Category:3rd Party Utilities2013-06-26T23:44:09Z<p>Admin: Created page with "{{:Third party utlity}} Category:Utilities"</p>
<hr />
<div>{{:Third party utlity}}<br />
<br />
[[Category:Utilities]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=OPTION_33_mismatch_using_wbserver.dat&diff=3505OPTION 33 mismatch using wbserver.dat2013-06-19T03:17:25Z<p>Admin: 1 revision</p>
<hr />
<div>Message box with a caption of '''Error''' stating '''[[OPTION]] 33 mismatch using [[wbserver.dat]]'''<br />
<br />
[[Category:Error]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=536870914&diff=35035368709142013-06-19T03:17:25Z<p>Admin: 1 revision</p>
<hr />
<div>===Problem===<br />
Message box with a caption of '''Error''' and text reading '''Client-Server error 536870914, sending data.'''<br />
===Solution===<br />
Probably due to a massive over use of variables.<br />
<br />
One Customer experienced this during an index. The issue ended up being hardware related, bad memory card on server.<br />
<br />
<noinclude><br />
[[Category:Client Server]]<br />
[[Category:Error]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Couldn%27t_%27lock_in_progress%27&diff=3501Couldn't 'lock in progress'2013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div>'''Couldn't lock in progress'''<br />
<br />
This is a problem accessing the [[WBServer.dat]]. This lock is retried several times as other locks are. It is possible that there are a lot of people starting [[BR!]] at the same time or that something is running slowly and holding its lock longer that normal.<br />
<br />
To recover from this error you can delete the WBServer.dat file and let BR.exe rebuild it.<br />
<br />
<br />
==See Also==<br />
*[[in progress]]<br />
<br />
<noinclude><br />
[[category:Error]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=The_requested_Workstation_ID_(WSID)_is_already_in_use_by_(UserName)&diff=3499The requested Workstation ID (WSID) is already in use by (UserName)2013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div>On startup you receive a [[messagebox]] with a title of '''Error''' stating '''The requested Workstation ID (WSID) is already in use by (UserName)'''.<br />
<br />
This is probably due to the fact that (UserName) is logged into BR! with the same [[WSID]].<br />
<br />
If not, if may be due to a corrupt [[WBServer.dat]] file.<br />
<br />
There are many ways to address this issue.<br />
<br />
#Make [[WSID]] dynamic or add a +1 or +100 to the end of your WSID statement in your [[BRConfig.sys]]<br />
#Use a different WSID<br />
<br />
<noinclude><br />
[[Category:Error]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Could_not_read_license_file.&diff=3497Could not read license file.2013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div>When attempting to use [[ODBC]] you might receive an error message box containing the text '''Could not read license file.''' with a caption of '''Business Rules!'''.<br />
<br />
<noinclude><br />
[[category:Error]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Couldn%27t_open_wbserver&diff=3495Couldn't open wbserver2013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div>Received a messagebox with a title of '''Error''' stating '''Couldn't open wbserver at BR Path=(path here). OS Path=(path here) Please check if it exists and current user has write permission.'''<br />
<br />
See also:<br />
*[[WBServer.dat]]<br />
<br />
<noinclude><br />
[[Category:Error]]<br />
[[Category:Client Server]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Couldn%27t_find_BRLISTENER.exe_in_the_specified_(or_SYSTEM)_directory&diff=3493Couldn't find BRLISTENER.exe in the specified (or SYSTEM) directory2013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div>===Problem===<br />
When attempting to launch [[install.exe]] you receive a [[messagebox]] with a title of [[BR Service Opening]] stating '''Couldn't find BRLISTENER.exe in the specified (or SYSTEM) directory'''.<br />
===Solution===<br />
Place [[BRlistener.exe]] in your [[C:\Windows\System32]] folder.<br />
<br />
<br />
<noinclude><br />
[[Category:Client Server]]<br />
[[Category:Error]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=10054&diff=3491100542013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div>[[Client Server]] connection is broken.<br />
<br />
==Problem==<br />
Receive a [[messagebox]] with a title of '''Error''' and a body stating '''Client-Server error 10054 receiving data.'''<br />
<br />
==Resolution==<br />
Check the BRConfig.log (You must turn logging on).<br />
Review the "Launch Line" (Something like this).<br />
Security process has started with command c:\...\BRServer.exe -c:\...\WBConfig.sys, startdir c:\...\, logfile c:\...\brconfig.log, loglevel 10, stderr file NULL, socket handle 120, anonymous NULL<br />
There will most likely be another line after it explaining the reason for the problem.<br />
<br />
*Error 10038 is Socket operation on nonsocket -- This means the server was unable to connect to the workstation.<br />
**Remember that while Port 8555 is typically used to initiate the inbound connection to BRListener, Ports 1024-65535 will be used to connect by to BRClient.<br />
<br />
*Most Windows Sockets 2 functions do not return the specific cause of an error when the function returns. For information, see the Handling Winsock Errors topic.<br />
**http://msdn.microsoft.com/en-us/library/windows/desktop/ms740668%28v=vs.85%29.aspx<br />
<br />
*Perhaps this is caused by a bad path in [[BRListener.conf]]<br />
<br />
*Mapped Network drives WILL NOT work as the BRServer session does not have mappings.<br />
<br />
*UNC names will work properly, but significantly affect performance.<br />
<br />
==Troubleshooting Tips==<br />
<br />
Host: Make sure the server name is correct, in particular, you may have moved to a new server or IP address<br />
<br />
Label: This is case sensitive, and remember "Spaces" and perhaps other special characters require "" (Quotes)<br />
<br />
<br />
<br />
<noinclude><br />
[[Category:Error]]<br />
[[Category:Client Server]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=10013&diff=3489100132013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div>"accept failed errno '''10013'''" reported in the [[client server]] log file.<br />
<br />
<noinclude><br />
[[Category:Error]]<br />
[[Category:Client Server]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=BR_StartService_failed&diff=3487BR StartService failed2013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div>A messagebox with a title of '''BR StartService failed''' and a message stating '''The service did not respond to the start or control request in a timely fashion.''' is displayed whey you launch [[install.exe]]<br />
<br />
<noinclude><br />
[[Category:Error]]<br />
[[Category:Client Server]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=BRServer_cannot_be_started_directly.&diff=3485BRServer cannot be started directly.2013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div>Receive a messagebox with a caption of '''BusinessRules!''' and a message which states '''BRServer cannot be started directly. To run BR in client-server mode, install and start BRListener.exe'''<br />
<br />
You need to run [[Install.exe]] (server side) to start the service, which will use BRListerner.exe. BRListerner.exe should be located in the [[C:\Windows]] folder.<br />
<br />
See also:<br />
*[[BRListener.exe]]<br />
*[[Client Server]]<br />
*[[BRServer.exe]]<br />
<br />
<br />
<br />
<noinclude><br />
[[Category:Client Server]]<br />
[[Category:Error]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Socket_error&diff=3483Socket error2013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div>==Problem==<br />
When attempting to launch a [[Client Server]] version of [[Business Rules!]] you may receive a [[messagebox]] stating '''Connection failed''' with a caption which reads '''Socket error'''. This is probably due to a bad configuration or lack of connectivity.<br />
<br />
==Solution==<br />
Probably the Server side isn't started. Go to the server and properly launch [[install.exe]].<br />
<br />
<br />
<noinclude><br />
[[Category:Error]]<br />
[[Category:Client Server]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Network_error_processing_authentication&diff=3481Network error processing authentication2013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div>Receive a messagebox with a title of '''Error''' stating '''Network error processing authentication''' when trying to connect in [[Client Server]] [[BR!]]?<br />
<br />
Check the error logs and see if it is logging why.<br />
<br />
This may be due to an improperly configured [[BRListener.conf]].<br />
<br />
<noinclude><br />
[[Category:Error]]<br />
[[Category:Client Server]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=ODBC_registration_problem&diff=3479ODBC registration problem2013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div>When attempting to use [[ODBC]] you receive a message box stating "ODBC registration problem" and "There was a problem registering this computer to use ODBC" with an OK button.<br />
<br />
This is generally due to a lack of ODBC licenses. Contact [[BRC]] to upgrade your [[brserial.dat]].<br />
<br />
<noinclude><br />
[[Category:Error]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Executable_version&diff=3477Executable version2013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div><br />
Upon launch of [[Business Rules!]] you may receive a [[messagebox]] stating '''executable version ### does not match license version ###''' where ### are version numbers omitting periods.<br />
<br />
i.e. "executable version 420 does not match license version 490"<br />
<br />
[[brserial.dat]] needs to be more current<br />
<br />
<br />
[[Category:Error]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Couldn%27t_get_lock_offset&diff=3475Couldn't get lock offset2013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div>When launching [[Business Rules!]] a '''Couldn't get lock offset.''' messagebox with a caption of '''Error''' is displayed.<br />
<br />
<br />
A solution is to exit all copies of [[Business Rules!]] on the workstation and then re-enter.<br />
<br />
This is probably due to an issue related to [[wbserver.dat]].<br />
<br />
<noinclude><br />
[[category:Error]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Wrong_version_of_wbserver.dat&diff=3473Wrong version of wbserver.dat2013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div>When launching [[Business Rules!]] a "Wrong version of wbserver.dat" messagebox with a caption of "Error" is displayed.<br />
<br />
See also [[WBServer.dat]]<br />
<br />
<noinclude><br />
[[Category:Error]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Debugging_Errors&diff=3471Debugging Errors2013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div>'''Debugging Errors''' we're released with [[4.18a]]<br />
<br />
Initially they only contained:<br />
*[[0420]]<br />
*[[0422]]<br />
*[[0424]]<br />
*[[0426]]<br />
*[[0428]]<br />
*[[0430]]<br />
*[[0432]]<br />
<br />
<noinclude><br />
[[Category:Error]]<br />
[[Category:Debug]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Category:Error_Conditions&diff=3469Category:Error Conditions2013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div>Error Conditions are listed below.</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Assertion_Failed&diff=3467Assertion Failed2013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div>{{Error<br />
|Assertion Failed<br />
|Assertion Failed<br />
|'''Assertion failures''' and '''GPF'''s are usually caused by a corrupt [[br.exe]] or insufficient rights to something (often C:\windows\br.ini)<br />
# BR does NOT have FULL permissions, to create the necessary files. <br />
#*[[BRServer.dat]]<br />
#*br.ini <br />
|#The [[BRServer.dat]] is created in the location that is pointed to in the [[BRConfig.sys]], the [[BR.ini]] is created in the windows/system32 directory.<br />
<br />
<br />
BR.ini used to only get created when you did a save font size position, if you don't do that it never gets created. BRServer.dat gets created every time you load [[BR.EXE|BR!]]. In some versions of wb the previous [[WBServer.dat]] did not get deleted, and the new file never got made, and you would get the error too manyWBServer.dat found<br />
<br />
}}<br />
<br />
<br />
<br />
Error Message: Assertion Failed: t.sessionID, file wbs\Startup.c <br />
<br />
When attempting to run WB from a workstation on a network where the user had all the necessary network rights to the network WB directories but did not have rights to the WinNT directory on the local workstation which is where the WB.ini file resides.<br />
<br />
<br />
[[Category:Error]]<br />
[[Category:BR Manual Chapter 20]]<br />
[[Category:Needs Help]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Category:Error_Codes&diff=3465Category:Error Codes2013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div>{{:Error Codes}}<br />
<br />
[[Category:Error]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Operating_System_Error&diff=3463Operating System Error2013-06-19T03:17:24Z<p>Admin: 1 revision</p>
<hr />
<div>'''Operating System Errors''' may vary from OS to OS. In older versions of Business Rules! errors in the 4200 series were all Operating System Errors. The error number was calculated internally by BR by adding 4200 to the OS Error Number. Sometimes the resulting error code exceeded 4299 which conflicted with Unix / Linux error codes. Therefore in 4.16 this method was been replaced by generating BR errors [[4300]] and [[4320]], in combination with [[SysErr$]] and [[SysErr]].<br />
<br />
But most importantly, '''check the value of the variables SysErr and SysErr$ for a description of the error'''.<br />
<br />
For more information about Microsoft DOS and Windows OS Error Numbers see: <br />
<br />
*[http://msdn.microsoft.com/en-us/library/ms681381(VS.85).aspx MSDN - System Error Codes]<br />
*[http://support.tabs3.com/main/R10307.htm another nice OS Error Chart]<br />
<br />
<br />
Operating System Error <br />
72 - Print or disk redirection is paused. <br />
267 - The directory name is invalid.<br />
<br />
<br />
<br />
<noinclude><br />
[[Category:Error]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=BrMyAdmin&diff=3461BrMyAdmin2013-06-19T03:08:26Z<p>Admin: 1 revision</p>
<hr />
<div>'''BrMyAdmin''' documentation coming soon!<br />
<br />
<br />
<noinclude><br />
[[Category:Utilities Third Party]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=AuditBR&diff=3459AuditBR2013-06-19T03:08:26Z<p>Admin: 1 revision</p>
<hr />
<div>'''Audit BR''' is a powerful new [[library]] from [[Sage AX]], created as a part of Sage AX's continuous mission to empower the BR developer with the latest in modern programming tools and techniques.<br />
<br />
Audit BR is a library that can be used to accomplish two simple functions, opening a powerful door for debugging your BR programs.<br />
<br />
Audit BR builds upon FileIO, enabling this powerful technology to work with your existing BR software right out of the box.<br />
<br />
More information about Audit BR is available at http://www.sageax.com/index.php?option=com_content&view=article&id=67 .<br />
<br />
= Description of Functions =<br />
<br />
== fnBeginAudit ==<br />
<br />
fnBeginAudit(BackupFolder$)<br />
<br />
BackupFolder$ - the name of a folder to backup the Audit Information to. If it does not exist, it is created.<br />
<br />
The fnBeginAudit function makes a backup of your BR data files, essentially creating a restore point that can be compared at any time to your current data files, generating a report indicating clearly everything that has changed in the data files. To use it, simply call fnBeginAudit and give it the name of a folder to back the data up to. This folder should be a new folder, and it should not be used for any other purpose then for your BR datafile Audits.<br />
<br />
== fnCompare ==<br />
<br />
fnCompare(BackupFolder$;Logfile$,Printer,DontClose)<br />
<br />
BackupFolder$ - the name of a folder containing a backup of your datafiles. Use fnBeginAudit to create and to update this folder.<br />
Logfile$ - The name of a logfile to report any changes to. The logfile is built on each time, so its a good idea to keep a logfile. If you run the audit routine regularly then you can use the logfile to determine not only what data has changed, but exactly when the change occured. If this field is blank or is not given, then the logfile is not created.<br />
Printer - this is a boolean flag indicating weather a report should be generated and sent to print preview or not. This report is color coded to make it easier to identify which elements of the data file have changed. When the program is being used and checked by a user or programmer, the printout is the easiest way to quickly make sense of the differences found in your data files.<br />
DontClose - use this optional boolean flag to force the fnCompare function to leave file #255 (the printer) open. Use this parameter if you want to keep from displaying the report in order to print more information on it before closing it yourself manually to generate the print job later.<br />
<br />
= Typical Usage =<br />
<br />
To use this library, you may run audit.br directly, or simply call these functions from your existing code. You can script the call to happen automatically, or you can place it on the user interface.<br />
<br />
== Example Usage 1 - User/Programmer Manual Trigger ==<br />
<br />
In one of my programs, I simply added an option on the menu to run an "Audit Report". This menu option first calls fnCompare, then it calls fnBeginAudit right afterwords to create a restore point for the next comparison. I can run the menu option any time to see what has changed sinse the last time it was run.<br />
<br />
Any time I need to test a program change that modifies one or more data files in my system, I run the Audit Routine, then I run my new code, then I run the Audit Routine again. The Audit routine quickly generates a list of exactly which elements in the data file have changed and I'm able to debug and double check my code in a fraction of the time it took to do it before. And more effecient debugging means fewer mistakes.<br />
<br />
== Example Usage 2 - Automatic Trigger (Interval) ==<br />
<br />
You might also want to make the Audit routine run automatically on a regular interval by a background process to build a running logfile showing all changes made to your system and the time that those changes were made.<br />
<br />
You can use Windows Task Scheduler to trigger the running of a program on a preset time interval.<br />
<br />
== Example Usage 3 - Automatic Trigger (Event Driven) ==<br />
<br />
It may be necessary to monitor what changes are made by each employee in the system. If you don't have a lot of employees using the system at the same time, one easy way to implement such a change may be to run the Audit routine each time a program is exited. Just prior to running the report, print a line to the logfile yourself saying what program just ran and who ran it. This would enable to you monitor the logfile to see exactly which user is responsible for a given change made to your system.<br />
<br />
= Notes =<br />
<br />
== Requires BR 4.1 or Above ==<br />
<br />
Because the Audit Report makes extensive use of NWP features, Audit BR requires BR 4.1 or above to run. Please note that your programs don't have to use BR 4.1. You can always just fire up a copy of BR 4.1 in order to run Audit and continue to use an earlier version of BR for the rest of your programs if you desire.<br />
<br />
== Workstack Requirements ==<br />
<br />
Audit BR requires FileIO, and FileIO requires a high Workstack value. If you recieve error 9001, try increasing the Workstack value specified in your brconfig.sys file. You can check your current workstack value at any time by using Status Stacks. The maximum value for Workstack under BR 4.1 and lower is 65535.<br />
<br />
== Files using Linux Style ("/") Paths ==<br />
<br />
Audit BR is not compatable with using the "/" in your file layouts to describe the path for your data files. If you specify the filename for your data files (the first line of the file layout) using "/" linux style notation, please update your layouts and specify the path and filename for your data files using the "\" style Windows notation.<br />
<br />
[[Category:Utilities_Third_Party]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Color.exe&diff=3457Color.exe2013-06-19T03:08:26Z<p>Admin: 1 revision</p>
<hr />
<div>The '''Color.exe''' program came from [[Western Canadian Software]] at the Fall 2007 [[BRGroup Conference]].<br />
<br />
<br />
[[Category:Utilities Third Party]]<br />
[[Category:Files]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Programming_in_Jungles&diff=3455Programming in Jungles2013-06-19T03:08:26Z<p>Admin: 1 revision</p>
<hr />
<div>Sometimes we're blazing a trail through unexplored territories we may write some [[Business Rules!]] programs along the way. Well out there in the jungle there is no internet. So if we want something from the web, we'd better pack it to go first. The easiest way to take this wiki with you is to make your own wiki on a stick (a.k.a. Thumb drive or USB drive) and export data from this wiki to it. It's much simpler it sounds, thanks to some innovative work from [http://www.chsoftware.net/en/useware/mowes/mowes.htm CHSoftware].<br />
<br />
==DIY==<br />
Want to create a personal web host on a stick? Here's [[:Category:How To|how to]] do it:<br />
<br />
#Install a [http://www.mediawiki.org/wiki/Manual:Wiki_on_a_stick Wiki on a Stick] to your thumb drive.<br />
:*The required packages (for our ends) are:<br />
::#MediaWiki<br />
::#PHP5<br />
::#Apache Server<br />
::#MySQL<br />
:*Test and verify that you can access your ''wiki on a stick''<br />
#[[Special:Export|Export]] the desired [[Special:Uncategorizedcategories|Top level categories]] or [[Special:categories|any category]] or [[Special:Allpages|any single pages]] that you want from this wiki. [[:Category:Templates|Templates]] are critical.<br />
:*(Improvement in this step is planned, special categories will be made for the convenience of exporting)<br />
:*Export sizes are limited, so you can't export EVERYTHING at once, but you can get quite a lot.<br />
#Login to your new wiki with the user name ''Admin'' and the password ''password''.<br />
#Go to '''special pages''' and then '''Import''' (generally towards the end of the page).<br />
#Choose the file that you previously exported (in step 2)<br />
<br />
That's it. Now when you are ready to launch your portable wiki on a stick, all you have to do is double click on '''mowes.exe''' in the root of your USB drive.<br />
<br />
===Run from a Batch File===<br />
If you'd like create an appropriately-named [[batch]] file to launch '''mowes.exe''' instead:<br />
<br />
BRWiki.cmd (for example) might contain:<br />
mowes.exe<br />
<br />
===AutoRun===<br />
You may like your wiki to automatically pop up when you insert your thumb drive into a computer. To do that you'll need to make an [[AutoRun.inf]] file and place it in the root directory of your thumb drive. The AutoRun.inf file is just a regular text file and should contain the following:<br />
<br />
[AutoRun.inf]<br />
Open=mowes.exe<br />
<br />
It may contain more, but that's the bare minimum.<br />
<br />
===Location===<br />
Perhaps you don't want your wiki on a stick to be stored in the root of your flash drive. Or maybe you don't want it on a flash drive at all. Have it your way! You can put your wiki anywhere you want- even at the end of a ridiculously long path in My Documents on your hard drive. Or perhaps you want it on your flash drive, but in a folder of it's own, separate from all of your other files and folders. It will be fine there too. Just make sure to alter any Autorun or Batch files that call the wiki. That's all you have to do!<br />
<br />
==FAQ==<br />
'''Q.''' What should I export from the BR Wiki?<br />
<br />
'''A.''' <br />
Always get:<br />
*the [[:Category:Templates|Templates category]]<br />
Additionally:<br />
*Category '''Error Codes'''<br />
*Category '''Widgets'''<br />
*Category '''BR Manual'''<br />
*[[Special:Allpages]] contains a list of all the pages, go there and copy anything you want right into [[Special:Export]]<br />
<br />
'''Note:''' You can't take everything in one export because it will exceed the maximum import size on your local wiki.<br />
<br />
<br />
<br />
'''Q.''' Can I edit my wiki on a stick?<br />
<br />
'''A.''' Yes, you can, but be aware that all changes you make to your wiki on a stick will be lost forever just as soon as you import additional data from the BR Wiki. When programming in a jungle, you should log the desired changes, and when you are back to civilization (internet accessible) make those changes to the BR Wiki.<br />
<br />
<br />
<br />
'''Q.''' Page not found<br />
<br />
'''A.''' If you get a Page not found error in your browser than it's probably because the IP address hasn't populated and cached everywhere yet... Simply, wait a few seconds and press F5/Refreash.<br />
<br />
<br />
[[Category:Utilities Third Party]]<br />
[[Category:How To]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Lexi&diff=3453Lexi2013-06-19T03:08:26Z<p>Admin: 1 revision</p>
<hr />
<div>'''Lexi''', the '''BR! Lexical Preprocessor''' is a system for integrating [[BR]] with your favorite [[third party editor]]. Initially Lexi only supported only [[MyEdit]], but it is also being used successfully with [[Notepad++]] and is very likely to work with any text editor that supports customizable user tools.<br />
<br />
If you use Lexi, you can edit your [[BR Programs]] [[#No Line Numbers|Without Line Numbers]]. This frees you up to copy and paste code, rearrange code, and add and edit code without having to worry about or manually change any line numbers. Lexi adds and changes and manages your [[line numbers]] for you automatically, when you "compile" your programs into .BR files.<br />
<br />
But Lexi also does a lot more. By preprocessing your [[source code|code]] before it is passed on to BR, Lexi gives you, the programmer, access to many useful features not normally found in BR.<br />
<br />
Lexi also gives you access to the [[#SELECT CASE|SELECT CASE]] statement and the [[#DEFINE]] statement, common in other languages.<br />
<br />
<br />
==Installation==<br />
===MyEdit (BR Edition)===<br />
Lexi can be used to automatically convert between BRS and BR files from within MyEdit. This can make your Editing life much easier. Lexi works with ALL versions of BR. However it requires a version of MyEdit dated [[October 20]], [[2006]] or later.<br />
<br />
The latest version of Lexi can be found at [http://www.sageax.com/downloads/Lexi.zip]<br />
<br />
<br />
====Instructions====<br />
<br />
To install Lexi, follow the following steps.<br />
<br />
=====Automatic Installation=====<br />
<br />
*The Automatic Installation process requires a version of MyEdit dated [[March 5]], [[2010]] or later.<br />
<br />
#) Unzip Lexi.zip into "C:\Lexi". You must use this directory in order for the automatic installation to work.<br />
#) Copy your personal [[brserial.dat]] file into this directory (C:\Lexi).<br />
#) Launch MyEdit.<br />
#) Select Import User Tools. Select the "Lexi.mut" file that came in Lexi.zip.<br />
<br />
That's all there is to it.<br />
<br />
=====Manual Installation=====<br />
<br />
#) Unzip Lexi.zip into its own directory.<br />
#) Copy your personal BRSerial.dat file into this directory.<br />
#) Launch MyEdit.<br />
#) Go to the Tools Menu, and then select "Configure User Tools".<br />
#) Select "Add"<br />
#) Enter the following information (Replace C:\Lexi\ with the appropriate folder), and Click OK to add the "Compile" tool.<br />
<br />
Menu Item Name: Compile BR Program<br />
Application/Command: C:\Lexi\ConvStoO.cmd<br />
Working Folder: C:\Lexi\<br />
Command Line Parameters: %%np_name %%npne_name "%%name" "%%folder"<br />
<br />
<br />
There are six other Tools you can add to the MyEdit user tools menu that give you additional abilities for working with BR Source code. To add additional tools, repeat steps 5 and 6 above substituting information from the "Available Functions" table below.<br />
<br />
That's all there is to it. Now, if you load a .BR file in MyEdit, you can select the "Extract Source" tool.<br />
The file will be converted to a .BRS file and the new one will be loaded in MyEdit. If you<br />
load a .BRS file, you can select the "Compile" tool, and the file will automatically be<br />
"compiled" into a .BR file for you. Then simply load BR and test your new program.<br />
<br />
This works with all versions of BR.<br />
<br />
====Available Functions====<br />
<br />
{| border=0<br />
!Menu Item<br />
!Application<br />
!Parameters<br />
|-<br />
|Compile BR Program<br />
|ConvStoO.cmd<br />
|%%np_name %%npne_name "%%name" "%%folder"<br />
|-<br />
|Extract Source Code<br />
|ConvOtoS.cmd<br />
|%%np_name %%npne_name "%%name" "%%folder"<br />
|-<br />
|Debug BR Program*<br />
|DebugBR.cmd<br />
|%%np_name %%npne_name "%%name" "%%folder"<br />
|-<br />
|Extract Source Code and Strip Line Numbers<br />
|ConvOSNL.cmd<br />
|%%np_name %%npne_name "%%name" "%%folder"<br />
|-<br />
|Add Line Numbers<br />
|AddLN.cmd<br />
|%%np_name %%npne_name "%%name" "%%folder"<br />
|-<br />
|Strip Line Numbers<br />
|StripLN.cmd<br />
|%%np_name %%npne_name "%%name" "%%folder"<br />
|-<br />
|Run BR Program<br />
|RunBR.cmd<br />
|%%np_name %%npne_name "%%name" "%%folder"<br />
|-<br />
|}<br />
<br />
* Debug BR Program requires that you have a copy of [[brnative.exe]] in the appropriate version sitting in your application folder. This may not be possible in all situations. Use Compile BR Program in situations where you cannot use Debug BR Program.<br />
<br />
===Notepad++===<br />
Users such as [[User:Bowman]] are currently using Lexi from within [[Notepad++]]. However he has not yet been kind enough to share his setup process. If you implement Lexi into your Notepad++ installation please add some instructions here. If you can't figure it out I'd suggest contacting [[User:Bowman]] for assistance.<br />
<br />
====Instructions====<br />
These instructions assume Lexi <br />
<br />
=====Automatic Installation=====<br />
Probably the easiest way to install Lexi tools into Notepad++ is to add the following lines to your shortcuts.xml file.<br />
<br />
<nowiki><br />
<Command name="BR!s - Compile" Ctrl="yes" Alt="yes" Shift="yes" Key="73">C:\Lexi\ConvStoO.cmd &quot;$(FULL_CURRENT_PATH)&quot;</Command><br />
</nowiki><br />
<br />
<nowiki><br />
<Command name="BR!s - Stip line numbers" Ctrl="yes" Alt="yes" Shift="yes" Key="73">C:\Lexi\StripLN.cmd &quot;$(FULL_CURRENT_PATH)&quot;</Command><br />
</nowiki><br />
<br />
<nowiki><br />
<Command name="BR!s - Add line numbers" Ctrl="yes" Alt="yes" Shift="yes" Key="73">C:\Lexi\AddLN.cmd &quot;$(FULL_CURRENT_PATH)&quot;</Command><br />
</nowiki><br />
<br />
=====Manual Installation=====<br />
<br />
Add three user controls by choosing Run>Run... (enter the first line) and click Save, then select the remaining two lines. Do these steps for each of the Lexi utilities listed here.<br />
<br />
BRS - Line numbers - Remove<br />
C:\Lexi\StripLN.cmd "$(FULL_CURRENT_PATH)"<br />
Alt+8<br />
<br />
BRS - Line numbers - Add<br />
C:\Lexi\AddLN.cmd "$(FULL_CURRENT_PATH)"<br />
Alt+Shift+8<br />
<br />
BR!s - Compile<br />
C:\Lexi\ConvStoO.cmd "$(FULL_CURRENT_PATH)"<br />
<br />
====Available Functions====<br />
{| border=0<br />
!Menu Item<br />
!The Program To Run<br />
|-<br />
|BRS - Compile<br />
|C:\Lexi\ConvStoO.cmd "$(FULL_CURRENT_PATH)"<br />
|-<br />
|BRS - Line numbers - Add<br />
|C:\Lexi\AddLN.cmd "$(FULL_CURRENT_PATH)"<br />
|-<br />
|BRS - Line numbers - Remove<br />
|C:\Lexi\StripLN.cmd "$(FULL_CURRENT_PATH)"<br />
|-<br />
|}<br />
<br />
<br />
Potentially other functions could be made available but have not yet been enhanced to work with the single full path parameter. The enhanced batch files (listed above) could serve as an example of how this is done - If you're feeling spunky.<br />
<br />
* These installation instructions assumes the enhancement of 1 parameter passing (as opposed to 4) was included in your distribution.<br />
<br />
===All Third Party Editors===<br />
<br />
====Tips====<br />
*Inside the \Lexi\ folder you will find a copy of BR renamed to brnative.exe. It works better if this brnative.exe is the same version of BR that you are using in your programs. So copy your BR to this folder and replace brnative.exe with it.<br />
*If you are having some trouble "Extracting Source" and you installed MyEdit to a custom location you will need to modify the file ConvOtoS.cmd to point to the proper location of MyEdit.exe. Load it in a text editor and you'll see what I mean.<br />
*There is an additional tool called DebugBR.cmd. This only works if there is a working BR file called brnative.exe in the same folder as your program files. You add it to the list the same way as you did the other tools above.<br />
<br />
== Function Reference ==<br />
<br />
Lexi gives you access to a number of different abilities from other programs, designed to make your source code editing life easier. When you send a source file to BR using Lexi, Lexi preprocesses your source code, adding line numbers, and interpreting other "precompiler directives"<br />
<br />
=== No Line Numbers ===<br />
<br />
Working with No [[Line Numbers]] is easy, when you have Lexi to help.<br />
<br />
You load your files using MyEdit, and you work with them as Source Code files. If you are editing a file in MyEdit that has line numbers in it, you can save the document and select the "Strip Line Numbers" user tool. This will launch BR, use it to strip out the line numbers, and reload your program in MyEdit. You make the changes you want while the line numbers are gone, and when you choose the "Compile" user tool or the "Add Line Numbers" user tool, the line numbers are added back to your program. If you choose the "Compile" tool, the line numbers are added, and your source code file is saved as a .BR file.<br />
<br />
43900 ! #Autonumber# 43900,10<br />
43910 DoesLayoutExist: ! Return true if layout exists in the layouts folder<br />
43920 def library FnDoesLayoutExist(layout$;LayoutPath$*255)<br />
43930 let Fnsettings(Layoutpath$) !:<br />
fnDoesLayoutExist = exists(LayoutPath$&Filename$)<br />
43940 fnend<br />
<br />
The above code gets turned into the following code when line numbers are stripped. When they are added back in, it gets turned back into the code above again.<br />
<br />
! #Autonumber# 43900,10<br />
DoesLayoutExist: ! Return true if layout exists in the layouts folder<br />
def library FnDoesLayoutExist(layout$;LayoutPath$*255)<br />
let Fnsettings(Layoutpath$) !:<br />
fnDoesLayoutExist = exists(LayoutPath$&Filename$)<br />
fnend<br />
<br />
=== AutoNumber ===<br />
<br />
The #AutoNumber# precompiler directive directs the Line Number Add routine to use certian line numbers in your code.<br />
<br />
Without the #AutoNumber# precompiler directive, Lexi adds line numbers starting with line number 00001 and counting by 1s.<br />
<br />
! This Example Is Quite Simple:<br />
let Fnupdatefiledropdown ! We Run This No Matter What Happens. It Builds The Combo Box Dropdown List<br />
!<br />
if Trim$(_Post$(1))="" then ! If The User Did Not Select A File Layout From The List Then<br />
let Fnreadlayoutfolder ! Display The File Layout List In A Table<br />
else<br />
let Fnreadfileio(Trim$(_Post$(1))) ! But If They Did Select A File, Then Show It<br />
end if<br />
stop<br />
<br />
becomes<br />
<br />
00001 ! This Example Is Quite Simple:<br />
00002 let Fnupdatefiledropdown ! We Run This No Matter What Happens. It Builds The Combo Box Dropdown List<br />
00003 !<br />
00004 if Trim$(_Post$(1))="" then ! If The User Did Not Select A File Layout From The List Then<br />
00005 let Fnreadlayoutfolder ! Display The File Layout List In A Table<br />
00006 else<br />
00007 let Fnreadfileio(Trim$(_Post$(1))) ! But If They Did Select A File, Then Show It<br />
00008 end if<br />
00009 stop<br />
<br />
The idea is that you maintain your programs in source files, and so it doesn't matter what your line numbers are.<br />
<br />
However, most BR Vendors do not maintain their programs as source files. They maintain them as .BR or .WB files, and the line numbers are important.<br />
<br />
To use the #AutoNumber# precompiler directive, all you have to do is place simple comments in your code that say:<br />
<br />
! #AutoNumber# LineNum,Increment<br />
<br />
Then, when Lexi is adding line numbers, and it finds one of these lines, Lexi tries to set the line number of the current line to the line number you specified. Thereafter, until it reaches the next #AutoNumber# statement, it counts by the Increment you gave it.<br />
<br />
In this way, its easy to give your functions each their own line number space, and still retain the ability to edit without having to worry about line numbers.<br />
<br />
With the #AutoNumber# statement,<br />
<br />
! #Autonumber# 16000,10<br />
DefineModes: ! Define the input spec modes<br />
def fnDefineInputModes<br />
dim InputAttributesMode<br />
dim InputFieldlistMode<br />
dim InputEditorMode<br />
dim InputEditorMoveMode<br />
dim InputDebugMode<br />
<br />
let InputAttributesMode=1<br />
let InputFieldlistMode=2<br />
let InputEditorMode=3<br />
let InputEditorMoveMode=4<br />
let InputDebugMode=5<br />
fnend<br />
<br />
becomes<br />
<br />
16000 ! #Autonumber# 16000,10<br />
16010 DefineModes: ! Define the input spec modes<br />
16020 def fnDefineInputModes<br />
16030 dim InputAttributesMode<br />
16040 dim InputFieldlistMode<br />
16050 dim InputEditorMode<br />
16060 dim InputEditorMoveMode<br />
16070 dim InputDebugMode<br />
16080 !<br />
16090 let InputAttributesMode=1<br />
16100 let InputFieldlistMode=2<br />
16110 let InputEditorMode=3<br />
16120 let InputEditorMoveMode=4<br />
16130 let InputDebugMode=5<br />
16140 fnend<br />
<br />
For this reason, when you are removing line numbers from your programs, it is sometimes a good idea to populate them with #AutoNumber# comments first, to preserve your original line number structure as much as possible.<br />
<br />
If the line numbers program detects that your #AutoNumber# comments are not in numerical order, or if there is not enough numbers between them to accomodate all your lines, it will generate an error and stop processing your program. At that time you should type clear, and then system to return to your editor, and fix the #AutoNumber# statements there. After you fix the problem, Save your source code again, and compile.<br />
<br />
=== DEFINE ===<br />
<br />
The #DEFINE# Precompiler Directive will tell The Line Number generation system that you have made a constant.<br />
<br />
<br />
!. "#Define# <nowiki>[[ScreenControls]]</nowiki> = "mat ControlName$, mat FieldName$, mat Description$, mat VPosition, mat HPosition, mat FieldType$"<br />
<br />
The above example will set up a precompiler Constant called <nowiki>[[ScreenControls]]</nowiki>. Now, everywhere in your program that you use the text <nowiki>[[ScreenControls]]</nowiki> will be replaced by "mat ControlName$, mat FieldName$, mat Description$, mat VPosition, mat HPosition, mat FieldType$".<br />
<br />
The "." will force BR to not change the capitalization of your comments.<br />
<br />
! #AutoNumber# 14000,10<br />
EditScreen: ! Main Screen Designer<br />
def fnEditScreen(fScreenIO, fScreenFld, ScreenName$, mat ScreenIO$, mat ScreenIO,<nowiki>[[ScreenControls]]</nowiki>)<br />
<br />
This function definition changes to contain the full list of arrays that are responsible for Screen Control information in the ScreenIO library, each time the program is compiled.<br />
<br />
When the source code is pulled back out and the line numbers are stripped, the substitute statements revert back to their original values.<br />
<br />
=== SELECT CASE ===<br />
<br />
We have implemented SELECT CASE as a precompiler directive. This means, when editing your programs with no line numbers, you can write SELECT CASE (SWITCH in C/C++) statements using the following syntax, and it will automatically be turned into IF THEN ELSEIF statements when it gets to BR.<br />
<br />
! #Autonumber# 16000,10<br />
PreformInput: ! Preform main input operation<br />
def fnPreformInput(&Mode,Control,mat ScreenIO$,mat ScreenIO;___,Window)<br />
#SELECT# Mode #CASE# InputAttributesMode<br />
let Window=fnGetAttributesWindow<br />
let fnGetAttributeSpec(mat InputSpec$,mat InputData$,mat InputSubs)<br />
rinput #Window, fields mat InputSpec$ : mat InputData$<br />
<br />
#CASE# InputFieldlistMode<br />
let Window=fnGetFieldsWindow<br />
let fnGetFieldsSpec(InputSpec$)<br />
rinput #Window, fields InputSpec$ : InputData<br />
<br />
#CASE# InputDebugMode<br />
let Window=fnGetDebugWindow<br />
let fnGetFieldsSpec(InputSpec$)<br />
rinput #Window, fields InputSpec$ : InputData<br />
<br />
#End Select#<br />
fnend<br />
<br />
Gets translated into this:<br />
<br />
16000 ! #Autonumber# 16000,10<br />
16010 PreformInput: ! Preform main input operation<br />
16020 def fnPreformInput(&Mode,Control,mat ScreenIO$,mat ScreenIO;___,Window)<br />
16030 IF Mode = InputAttributesMode THEN ! #SELECT# Mode #CASE# InputAttributesMode<br />
16040 let Window=fnGetAttributesWindow<br />
16050 let fnGetAttributeSpec(mat InputSpec$,mat InputData$,mat InputSubs)<br />
16060 rinput #Window, fields mat InputSpec$ : mat InputData$<br />
16070 !<br />
16080 ELSE IF Mode = InputFieldlistMode THEN ! #CASE# InputFieldlistMode<br />
16090 let Window=fnGetFieldsWindow<br />
16100 let fnGetFieldsSpec(InputSpec$)<br />
16110 rinput #Window, fields InputSpec$ : InputData<br />
16120 !<br />
16130 ELSE IF Mode = InputDebugMode THEN ! #CASE# InputDebugMode<br />
16140 let Window=fnGetDebugWindow<br />
16150 let fnGetFieldsSpec(InputSpec$)<br />
16160 rinput #Window, fields InputSpec$ : InputData<br />
16170 !<br />
16180 END IF ! #End Select#<br />
16190 fnend<br />
<br />
You may notice the comments that appear at the end of your IF THEN statements. The comments are created automatically by the "Add Line Numbers" routine when it translates the SELECT CASE statement into IF THEN ELSEIF statements. The purpose of the comments is so that the "Strip Line Numbers" routine can change them back into a SELECT CASE statement so that your code appears correct on the editor/line-number-free side.<br />
<br />
=== Spacing ===<br />
<br />
As you can see from the above examples, any blank spaces you insert into your programs are turned automatically into blank comment lines. This is to preserve the spacing and look and feel of your program on the editor/line-number-free side.<br />
<br />
== Considerations ==<br />
<br />
=== L##### labels ===<br />
Because Lexi strips the line numbers before you edit your document, it would easily cause a problem if you had any hard coded line number references, because your line numbers change all the time and those references aren't automatically updated. Therefore, before it strips line numbers from any BR program, Lexi loads the program in BR and executes the [[RENUM]] LABELS_ONLY command. This command replaces all your hard coded goto references with labels that are L##### where ##### is the line number.<br />
<br />
That way you are free to edit your document without worrying about the line numbers, and later, when you add in new line numbers, your program still works.<br />
<br />
If you have accidentally placed L##### labels in your code and you need them removed, contact [[mailto:gabriel.bakker@gmail.com Gabriel]]. He has written a program to remove them.<br />
<br />
The L##### labels do not harm your code - it will work exactly as before. However, I understand sometimes it can be confusing if something like this happens to your code and there is a tool to change them back.<br />
<br />
<br />
One other note about L##### labels: If the "Add Line Numbers" routine detects any of these labels in your code, it will use them as clues as to what your original line numbers were, and it will match the new line numbers as closely as possible to the old one. This is done for your comfort as you edit your programs, just in case you still edit them in BR and use the line numbers. I wanted your programs to remain as unchanged by the linkage as possible.<br />
<br />
=== Save Source Code ===<br />
It is of vital importance that you save your source code before executing any of the user tools. If you fail to save your source code before using a user tool, the tool will operate on the old version of the file that it finds on the disk, and when the conversion is complete and the new file is reloaded in MyEdit, all your changes will be lost. You can't undo it because MyEdit thinks you have loaded a whole new file.<br />
<br />
Please be careful when using this.<br />
<br />
=== PROC NOECHO ===<br />
For anyone who has used Lexi in the past, it used to scroll through the contents of your program as it was adding or removing line numbers, due to the process of converting your source file into a compiled BR program. Depending on the size of the program and the speed of your system, this process may have taken a long time.<br />
<br />
The latest version of Lexi has been updated with PROC NOECHO to disable this printout and greatly improve the speed of compiling your programs. As a result of PROC NOECHO, if there are any compile time errors in your code, you will not be able to see the line that caused the problem, until you press F2. Just remember, if you run into a problem compiling your screen, press F2 to see the offending line.<br />
<br />
<br />
==Disclaimer==<br />
<br />
[[User:Gabriel|Gabriel Bakker]] and [[Sage AX]] are not responsible for anything that happens to your BR programs or data as a result of using this or any other tool we create.<br />
<br />
<br />
[[Category:Utilities_Third_Party]]<br />
[[Category:How To]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=ScreenIO_Library&diff=3451ScreenIO Library2013-06-19T03:08:25Z<p>Admin: 1 revision</p>
<hr />
<div>The '''ScreenIO Library''' is a Rapid Application Design tool that enables Sage AX to create complete custom programs for a fraction of the cost of traditional development. For example, a fully functional File Maintenance program can now be created for $300. A zoom function or any other "single screen" program can be created for $150.<br />
<br />
These "screen functions" integrate directly with your existing database and can be implemented as a standard BR library anywhere in your existing software. Some of our customers have placed them on tabs in already existing "tabbed windows" (or new tabbed windows). Some of our customers used them to quickly spruce up the look and feel of programs designed and written for older versions of BR, with modern new gui controls.<br />
<br />
Just about any business application can be designed faster, cheaper, and easier using ScreenIO, than ever before. You can even build entire application suites out of "Screen Functions". Sage recently wrote our entire internal accounting system using "screen function" technology, in just a couple of weeks.<br />
<br />
The ScreenIO Library is a sister library to the [[FileIO Library]]. The ScreenIO library builds upon and requires the FileIO library in order to run. <br />
<br />
The ScreenIO Library is a third party developer tool created and marketed by Sage AX to the BR programmer.<br />
<br />
== Bookmarks ==<br />
<br />
Before we get any farther, if you're here for help with ScreenIO, here's a short list of common reference links:<br />
<br />
[[#ScreenIO Runtime Engine Library Functions|ScreenIO's fnFm Parameter List]]<br><br />
[[#ScreenIO Events|Custom Function - Events]]<br><br />
[[#Writing Screen Helper Functions|Custom Function - Parameters]]<br><br />
[[#Keyboard Reference (Undo/Redo, Copy/Cut/Paste and more)|Keyboard Reference]]<br><br />
[[#Working with the ScreenIO Loading Icon|Animations]]<br><br />
[[#ExitMode|ExitMode]]<br><br />
<br />
== Using ScreenIO Screens ==<br />
<br />
This section of the documentation deals with all of the ways to make use of your screens created with the ScreenIO system.<br />
<br />
=== Screen Functions ===<br />
<br />
==== What is a Screen Function? ====<br />
<br />
A Screen Function is a complete self contained program, that can be chained to, procced to, run as a regular program, or even run as a library from right in the middle of your existing program.<br />
<br />
Screens are Modular and Reusable. That means you can create a screen for selecting a customer from a listview on the screen. This "Listview Screen" can also have buttons that chain to other screens, such as an Add/Edit Screen.<br />
<br />
Now you have a complete FM program in two screens, for maintaining the customer file. But wait, what if you need a "Customer Selection" listview in your other programs? No problem, the same "Screen Function" program that was run before as your Customer FM, can also be run as a library function, as your Customer Selection screen.<br />
<br />
So a Screen Function is more than a program. Its a program and a library, a gui, a complete software generation system, and an easy way to write beautiful software in BR that can be implemented again and again in your programs.<br />
<br />
A Screen Function is a totally modular object. Its easy to add a screen to an existing program, or to another screen. By combining multiple screens you can create truly amazing effects.<br />
<br />
By Combining four screens together, we can even write File Maintenance programs that work on two data files simultaneously, with a parent/child relationship!<br />
<br />
==== How does it work? ====<br />
<br />
Using our powerful ScreenIO Programming System, we create the Screen and save it in an internal data file that keeps track of what data needs to be displayed where on the screen, where it needs to be saved on the disk, and what we want to do with it. We can even embed function calls and business logic directly in the screens. When we "compile" the screens, a screen helper library is created with all the custom function code that needs to run from your screen. This helper library also serves as the program you can use to run your screens.<br />
<br />
By keeping the screen layout in data files, it becomes easy to modify and easy to maintain. By making the screens run as library functions, they become easy to implement anywhere in your existing programs. All you have to do is create the library linkage and call the program with the following two lines of BR code:<br />
<br />
LIBRARY "screenio" : fnfm$<br />
let Result$=fnfm$("scrnname")<br />
<br />
Result$ can be queried to see what the user did in the screen. A listview selection screen will return the record selected. An Add/Edit screen will directly write the results to the data file for you, and return the key to this new record in Result$. If the user cancels, Result$ will be empty.<br />
<br />
==== What can a Screen Function Do? ====<br />
<br />
A Screen Function can do many things. A Screen Function right now generally fits into three categories:<br />
<br />
1. A Listview Screen Function<br />
2. An Add/Edit Screen Function<br />
3. A Menu/Simple Screen Function<br />
<br />
<br />
===== Listview Screen Function =====<br />
<br />
A Listview Screen Function is a Screen Function that is tied to a data file (through fileIO) and has no editable text controls on it, and has a Listview on it somewhere.<br />
<br />
A Listview Screen Function is now the very easiest way to implement 2D Controls in your BR programs. A ListView Screen Function displays all or some of the records in a data file and allows the user to select one. In your Listview screen, you may also have a link to the add/edit screen for the same data file, creating a basic File Maintenance program. You can use your Listview Screen anywhere that you would like the user to select a record from the ListView Screen's Target File. If it is tied to an Add/Edit screen, you may also use it as the File Maintenance program for that screen. You can use the same screen in multiple ways.<br />
<br />
===== Add/Edit Screen Function =====<br />
<br />
An Add/Edit Screen Function is a screen function that is tied to a data file (through fileIO) and has editable text controls on it, and no Listivew control on it anywhere. An Add/Edit screen can be passed a key, which will cause it to act as an Edit Screen Function, telling ScreenIO to edit the record who's key was passed in. If the Add/Edit screen is not passed in a key, it will act as an Add Screen Function, telling ScreenIO to Add a new record to the data file.<br />
<br />
An Add/Edit Screen Function is the easiest way to create any sort of user interface asking for specific data from a customer.<br />
<br />
<br />
===== A Menu/Simple Screen Function =====<br />
<br />
A Menu/Simple Screen Function is a screen function that is not tied to any data file. This sort of screen is very limited in functionality. The primary purpose of using such a screen is to create a menu of buttons that call other screens or other programs or library functions or parts of your code.<br />
<br />
A Menu/Simple screen function cannot change any data on disk because it is not tied to a data file. It is also not possible to get a lot of information back from the user in a Simple Screen Function, because instead of returning a key to a record in a data file that was edited (like an Add/Edit screen function would), a Menu/Simple screen is limited to returning a 255 byte string for its return value.<br />
<br />
==== Limitations ====<br />
<br />
===== No combination Listview/Add/Edit screens =====<br />
<br />
It is not possible to make a screen that contains both a Listview, and Add/Edit capabilities in the same screen. When the user changes selection on a Listview, this changes the current record that the screen is using. If they were attempting to change a record on a combination ListView/Add/Edit screen, their changes would get lost each time the Listview selection changes. For that reason, if you wish to have both a Listview and some record selection going on at the same time, you will need to have two screens and tie them to each other.<br />
<br />
It is much better to stick to a single purpose for each Screen Function.<br />
<br />
<br />
==== Future ====<br />
<br />
The following features are not currently available in screens, but will be soon:<br />
<br />
===== Grids =====<br />
<br />
Grids are not currently supported in ScreenIO. However, you can do just about anything using a 2 screen Listview and Add/Edit Screen Combination (a simple FM) that you can do with a grid. In future releases of ScreenIO, we will add support for Grids<br />
Directly.<br />
<br />
===== Floating Child Windows =====<br />
<br />
ScreenIO runs perfectly fine in both BR 4.1 and BR 4.2. However, it does't currently support advanced BR 4.2 features such as floating child windows. This will be coming soon, however.<br />
<br />
=== Implementation Guide ===<br />
<br />
Implementing your new Screen Functions in your existing programs is simple, modular, and flexible. The same screen can be used in multiple places in your program suite. Any changes or bug fixes to your Screen Function change it everywhere that it is used, thanks to the power of Libraries.<br />
<br />
If you order a screen function from Sage AX, we will send you information explaining how to implement it. If you want to read about all the various ways to implement a screen, read on. If you are unsure what one of the options means, don't worry about it. If you buy a screen from Sage AX, we'll tell you which options apply to your screen.<br />
<br />
==== Installing your new screen ====<br />
<br />
When you order a screen, Sage will send you the following files:<br />
<br />
data\screenio.dat - Screen Header Data file containing your new screen and all your old screens<br />
data\screenio.key - Screen Header Key file<br />
data\screenfld.dat - Screen Fields Data file containing all the fields for your screens<br />
data\screenfld.key - Screen Fields Key file<br />
data\screenfld.ky2 - Screen Fields Key file<br />
<br />
screenio.br - Free ScreenIO Runtime Library required to run your screens<br />
screenio\scrnname.br - Screen helper library (compiled in a br program)<br />
screenio\scrnname.brs - Screen helper library (BR Source File, included for your convenience only.)<br />
<br />
"scrnname" is replaced by the name of your new screen.<br />
<br />
To begin using your new screens, simply copy the files into the main folder of your BR programs.<br />
<br />
==== Running your new screen ====<br />
<br />
You can now run your new screen by simply typing:<br />
<br />
LOAD scrnname<br />
RUN<br />
<br />
<br />
==== Calling your screen from your existing programs ====<br />
<br />
However, to really get the most mileage out of your screen functions, you should implement them as library calls. This will enable you to interpret the result of the users action in the screen and act accordingly.<br />
<br />
To implement your new screens as library calls from within your existing programs, all you need to do is add a library statement to the ScreenIO runtime library, and call your screens.<br />
<br />
01000 LIBRARY "screenio" : fnfm<br />
01200 let fnfm("scrnname")<br />
<br />
When your program gets to line 1200, your screen is loaded and displayed, and the user is able to do anything your screen is set up for them to do. When they are done, control returns to your program at the line after 1200.<br />
<br />
<br />
==== Returning Information from your screen ====<br />
<br />
The ScreenIO Runtime Library can return limited information about the execution of each screen. This return string is limited to 255 characters, and is generally used to return the key of the record edited/added/selected from the listview. If a Cancel option is available in your screen, and the user cancels, then the return will be blank.<br />
<br />
ScreenIO Returns the key of the record, by default. If you just draw a screen, and tie some fields from the file to it, writing no custom code at all, the key of the edited record will be the return value.<br />
<br />
However, by placing custom code in your screen, it is possible to override the default return value for your Screen Function with any kind of data you want.<br />
<br />
In general, if you want to use your screen to query the user for information that does not get saved in your system, then you create a screen and tie it to a temporary data file. In your calling program, you call the screen, and if the user did not cancel, you use that key to read the results from the temporary data file and interpret them, deleting the information from the file when you're done.<br />
<br />
However, if the amount of information you wanted to return was less then 255 bytes, it would be possible to override the return value for the screen to just return all that information in a string of data that could be interpreted by your calling program.<br />
<br />
=== Advanced Screen Implementation ===<br />
<br />
==== ScreenIO Runtime Engine Library Functions ====<br />
<br />
There are a few other useful functions in the ScreenIO Runtime Engine Library. They are all used to display and pass control to your screen, your screen but with a few different options:<br />
<br />
*fnfm("scrnname"; key$, row, col, ParentKey$, ParentWindow, DisplayOnly,Dontredolistview,Recordval,Mat Passeddata$,Usemyf,Mat Myf$,Mat Myf,Path$,Selecting) - Displays and passes control to your screen. FnFm returns true if a record was selected/edited and false if the record was not edited. If the return value for the screen is numeric, then fnfm would return the numeric return value of the screen. If the return value is a string, calling fnfm will discard the string return value and return only 1 if the user didn't cancel, or 0 if they did.<br />
<br />
*fnfm$("scrnname"; key$, row, col, ParentKey$, ParentWindow, DisplayOnly,Dontredolistview,Recordval,Mat Passeddata$,Usemyf,Mat Myf$,Mat Myf,Path$,Selecting) - Displays and passes control to your screen. FnFm$ returns the key of the record selected/edited, or blank if the user cancelled out of the screen. It is possible to override the return value in the screen by adding custom code to your screen. If the return value for a screen is numeric, then fnfm$ returns "str$()" of the numeric return value of the screen. Use "val()" to turn it back into a number if you need.<br />
<br />
*fnDisplayScreen("scrnname"; key$, row, col, ParentKey$, ParentWindow,Recordval) - Deprecated, use fnfm instead, with the Display Only parameter. (This displays a screen, but does not pass control to it. This sort of functionality is very useful for advanced implementation of your screens in your programs. Oftentimes it is desirable, especially with a listview screen, to display a listview of items on the screen but not edit it yet. In that situation, you would want to continue in your main program, and wait until the user clicked on your listview Screen Function, at which point you would then call fnfm or fnfm$ for the same screen, allowing the user to use the listview later. The return value for fnDisplayScreen is the window number of the new Screen Function Window opened. When you are done displaying the Listview Screen Function and want to erase it, simply close the window number that fnDisplayScreen returned.)<br />
<br />
''Within ScreenIO you may call screen functions from any existing screen function by placing the internal syntax for calling a screen directly in the click event for any button or any other event in your screen. This would be in the form [SCRNNAME(Row,Col)]Key$="blah" : ParentKey$="blahblah". Row, Col, Key$, and ParentKey$ Are optional. You can also specify Record=, Selecting=, DisplayOnly=, and Path$=.<br />
<br />
The simplest (and most common) form is just to say [SCRNNAME]''<br />
<br />
==== ScreenIO Runtime Engine Library Function Parameters ====<br />
<br />
The ScreenIO Functions listed above all accept the following parameters:<br />
<br />
*Scrnname$ - This is the name of the screen you are trying to call. This is the only required parameter. If you are using fnCallScreen$, it is also possible to substitute the internal screenio syntax for calling screens here, which is [SCRNNAME(Row,Col)].<br />
<br />
*Key$ - This is the key of the current record you are editing. ScreenIO interprets this variable when it is loading and displaying your screen. If it is blank, it does not read the screen, and instead performs the screen's initialize event, the custom code (if there is any) for initializing a new record into the data file. However, if a key IS given, then instead it reads that record from the data file, performs the input, and saves the data.<br><br>'''''Note:''' A Key should never be passed into a Listview screen''<br />
<br />
*Row, Col - These scalar parameters represent the physical location to place the top left corner of your screen. If no Row or Col is specified, then the screen opens in the middle of your BR window, resizing Window 0 if necessary to display your entire screen. If you DO give a Row and Col value, then it is your responsibility to make sure the Screen Function fits in the BR window - otherwise you will get the BR Internal Error for invalid Row and Col specification when you try to run the screen.<br />
<br />
*ParentKey$ - This is an extra value you can pass into your screen function. It is ignored by the ScreenIO Runtime Engine Library, but it may be used by your custom functions. Most often it is used by the filter event of a listview, to limit the records in the Listview. (If a Listview has no filter event defined, then by default every record of the data file is displayed).<br />
<br />
*ParentWindow - This optional parameter is used in conjunction with Row and Col to specify the parent window for the Screen Function. If no Parent Window is given, then window 0 is assumed to be the parent, and the new Screen Function opens on top of whatever other windows may have been on your screen before. If a Parent Window is given, then that Parent Window is used for the Row and Col position of your screen. <br />
<br />
*DisplayOnly - This optional Boolean Flag tells the ScreenIO Runtime Engine Library to display the screen and then exit without passing control to the screen. This parameter makes FnFm, FnFm$, and fnCallScreen$ work the same way that fnDisplayScreen works above. In the case of FnFM, the return value becomes the window number of the newly opened Screen Function. In the case of FnFM$ and FnCallScreen$, the return value becomes the "str$()" value of the window number of the newly opened Screen Function - use "val()" to get the actual Window Number as a numeric value.<br />
<br />
*DontRedoListview - This optional boolean parameter is used when running a screen from within another screen, for example in one of your custom functions. If the calling screen has a listview on it, the Listview will automatically be repopulated when you return. If you're calling a screen that doesn't change the contents of the listview then its better not to repopulate the listview, in order to make your screens run as quickly as possible. Use this boolean flag to instruct ScreenIO not to redraw the listview you're returning '''''to'''''. If you're implementing a screen that Sage AX made for you, we will have already set this for you.<br><br>'''''Example:''' If you're in a listview screen and its calling an add/edit screen, this parameter is used on the call to the '''add/edit screen''' but it applies to the '''listview screen.'''''<br />
<br />
*RecordVal - If you are editing a record in an Add/Edit Screen By Record instead of by Key, specify the Record here, and leave "Key$" blank.<br />
<br />
*Mat PassedData$ - Mat PassedData$ is an array you can use for passing Custom Information into your screens. Any of the functions inside the screen will have access to Mat PassedData$. If you're implementing a screen from Sage AX, we will tell you if there is any custom data you need to pass in.<br />
<br />
*UseMyF - If you set this boolean parameter to True then you can pass in your own mat F$ and mat F arrays. Instead of reading the record from the disk, ScreenIO will use the record in the arrays you're passing in. Use this for an Add/Edit screen when you don't want ScreenIO to read or write the record on disk.<br />
<br />
*Mat MyF$ - This is the corresponding string array containing information from a record you want to edit with a screenio screen. Use with the UseMyF parameter above.<br />
<br />
*Mat MyF - This is the corresponding numeric array containing information from a record you want to edit with a screenio screen. Use with the UseMyF parameter above.<br />
<br />
*Path$ - This is the FileIO Path$ Parameter that specifies a Data Path to be prepended to the path specified in your file layouts, in order to accommodate situations where the same data file with the same layout occurs in multiple paths.<br />
<br />
*Selecting - This is a flag you can use to signal to your screens when you're running them as to the intentions of your users. You can use it to define different "modes" for the current screen. The parameter is not used by ScreenIO at all, but simply passed onto your functions, similar to the way ParentKey$ works.<br />
<br />
=== How does it work Internally ===<br />
<br />
==== Program Flow ====<br />
<br />
When you call your new screen, no matter how it is called, the screen layout is loaded from the screenio data files (ScreenIO.DAT and ScreenFld.DAT). Then, if a file layout is given, the file is opened, and if there is a key given, then the key is read and the read event is triggered. If a key is not given, then the initialize event is triggered.<br />
<br />
After that ScreenIO maps the fields in the data file onto the fields on your screen and displays them, allowing the user to interact with the screen as they wish. The screen remains in control until "[[#ExitMode|ExitMode]]" is triggered, either from one of the events, or by pressing the ESC key to trigger an [[#ExitMode|ExitMode]] of Cancel (by default), or the ENTER key to trigger an [[#ExitMode|ExitMode]] of Select (by Default).<br />
<br />
Once a Screen Function Event has been triggered that sets [[#ExitMode|ExitMode]] to one of the various valid exit modes, the screen is exited, and depending on [[#ExitMode|ExitMode]], the return value is calculated and the data is saved or added, or dropped, or ignored, and the return value is set. The Prewrite Event and the Exit event is triggered here.<br />
<br />
==== Philosophy ====<br />
<br />
ScreenIO is a modular event driven system for BR. The ScreenIO Design and Runtime Libraries do for BR what Visual Basic did for the Microsoft world of programming. However, its easier to create and use ScreenIO screens then it is to write VB programs, because BR is simpler then VB in many of its internal working details, and because ScreenIO screens have the ability to write to your data files without having a stitch of custom code.<br />
<br />
ScreenIO was designed to eliminate the BR headache of working with 2D object-style controls in the non-object oriented world of BR programming.<br />
<br />
ScreenIO cannot make every program in the world. I would be very impressed if I saw someone make a video game in ScreenIO. It is limited to interfaces that BR can produce, and that means that you can only input from one screen at a time (because BR's input statement is Modal). It can only make BR style listviews and grids, and your interfaces work using rows and columns, instead of twips or pixels like other languages.<br />
<br />
Instead, ScreenIO's focus is on remaining as simple as possible, while still allowing the flexibility to accomplish 90% of the business programming purposes. It can't make absolutely everything - if it could, it would become unruly and difficult to use. By limiting the scope, however, we are able to create 90% of business programs, much faster and easier then ANY other method of programming on the market.<br />
<br />
==== Modular ====<br />
<br />
Because ScreenIO is Modular, it is extremely easy to implement your screens in any of your existing programs using the chain statement, or more commonly, a library function call. Your screens can be called from each other, even recursively should you so desire.<br />
<br />
<br />
==== Event Driven ====<br />
<br />
Because ScreenIO is Event Driven, it is easy to call any of your existing business logic code from one of our screens.<br />
<br />
Each ScreenIO Screen Function has several events, that can be used to extend the functionality of your screen, provide custom validation, provide custom filtering on a Listivew, extend functionality by linking to additional screens, and control and override the return values of your Screen Functions.<br />
<br />
Your Screen Functions have the following events that can each be overridden with custom code, a library call, an execute command, or a link to another screen.<br />
<br />
<br />
===== Screen Events =====<br />
<br />
*Enter Event: This event is triggered when your screen is first displayed.<br />
<br />
*Initialize Event: This event is triggered any time you call your screen without giving it a key$ (as long as there is a data file). The initialize event is used to initialize the values for newly added records in one of your data files, in an Add/Edit Screen.<br />
<br />
*Read Event: This event is triggered when your screen reads the initial record, and in a Listview screen, any time the Listview selection is changed. It is primarily used for unpacking the data and placing it on a screen.<br />
<br />
*Write Event: This event is triggered when the user selects the "Save" option in your screen, just before actually saving the data to the disk. In the Write event, you can cancel the users exiting of the screen, or change the exit mode to any other exit mode you like. You can also make any last minute changes to the data before it is saved to the disk.<br />
<br />
*Mainloop Event: This event is triggered every time the main Rinput Fields statement is passed. You can use this event to update information on the screen, implement special keys, or implement windows menu's in your screenio screens.<br />
<br />
*Wait Event: This event works in conjunction with the timeout setting you specify for your screen. This timeout value specifies the number of seconds before triggering a WAIT event. If you specify a WAIT event here, your event will be triggered if the keyboard is idle for that many seconds. If you do not write a WAIT event, the default ScreenIO Wait event is triggered.<br />
<br />
*Record Locked: This event is triggered whenever a record is locked in a screenio screen. If you do not specify your own locked record event, the default ScreenIO Locked Record Event is triggered.<br />
<br />
*Exit Event: This event is triggered last, when the screen is being closed.<br />
<br />
===== Individual Control Events =====<br />
<br />
Each of the controls on your screen has its own event, which get triggered in various ways depending on the control.<br />
<br />
*Filter Event - In a Listview Control, the listviews event is the filter function that gets called to determine if the currently selected record should be added to the listview or not. Your filter function receives MAT F$ and MAT F for the screen, and if it returns true, (anything other then 0 or blank) then the record is included in the listview. If your filter function returns an HTML color code, then that HTML color is used to color that specific row of the listview. If there is no filter function, the listview displays every record in the data file.<br />
**Listviews<br />
<br />
*Validation - In a data Control, the data Control's event is the validation function that gets called to determine if the data is acceptable or not. If there is no Validation Function, then the data gets saved according to internal rules: All text data gets saved regardless of what it is, and numeric data is saved only if the user entered valid numeric data. The validation function receives the value the user is trying to save, and it can modify that data, and return true or false, to force the data to be saved or not. (However, you never can force saving string data in a numeric field, that will always be discarded by the ScreenIO Runtime Engine).<br />
**CheckBoxes<br />
**SearchBoxes<br />
**Radio Buttons<br />
<br />
*Click Events - Non-Data Controls have a "Click" event. This event is triggered whenever the user clicks on the control.<br />
**Buttons<br />
**Pictures<br />
**Captions<br />
<br />
===== Purpose of Events =====<br />
<br />
By overriding various events with custom code, we can make your screen functions behave any way you want them to.<br />
<br />
=== Screens with two data files ===<br />
<br />
ScreenIO Screen Functions are limited to one data file each. This means that each ScreenIO Screen function can only directly and automatically modify the MAIN data file for the screen. However, it is possible to modify additional related data files through the custom code added to the various screen events.<br />
<br />
It is possible to use ScreenIO to modify data sets of two data files with a parent/child relationship, by using four screens and tying them together, and setting special code in various events.<br />
<br />
<br />
==== Example ====<br />
<br />
If you had a set of invoice files, with one invoice header file and another invoice detail file containing the line items of various invoices, and you wanted to maintain those files with ScreenIO, you would create four screens.<br />
<br />
The first screen would be a listview screen tied to the invoice header that would list all the invoices on record. (You could also set up a filter function limiting this display to invoices for a certain customer (passed in using ParentKey$) if you desired.) This screen would have buttons linking to the Add/Edit screen for invoice headers (the second screen described below).<br />
<br />
The second screen would be the Edit screen for the listview header. This screen would link (using Display Only) to the third screen (below) in its Enter Event. It would also have a button linking to the third screen (below) without the Display Only option, so that the user can click on this button and jump to the Listview displaying line items for the invoice.<br />
<br />
The third screen would be a listview for the invoice detail lines. This screen would have to have a filter function to limit its display to only lines on the currently selected invoice (which would be passed in using ParentKey$). You would link to this screen using "DisplayOnly" in the second screens "Enter Event", so that when they are editing the invoice header records, they will also be able to view the line items on the listview. You would also have placed a button on Screen 2 linking to Screen 3 without Display Only (described above). The third screen, just like the first screen above, would have buttons linking to the Add/Edit screen for Invoice Detail items.<br />
<br />
The fourth screen would be a simple Add/Edit screen for the detail line items. In the initialize event for this screen, you would want to initialize the value in the detail file that ties it to the header file. In our example of invoices, we would initialize an invoice line item by specifying which invoice it appears on.<br />
<br />
<br />
This process allows you to quickly and easily create a set of four Screen Functions that preform complete FM operations on two linked data files with a parent/child relationship.<br />
<br />
<br />
=== The ScreenIO Animated Loading Icon ===<br />
ScreenIO comes with an Animated Loading Icon that automatically appears whenever a listview takes a long time to load. This tells the user that something is happening, so they know its not just hung.<br />
<br />
You don't have to do anything to your screens to use the loading animation. It automatically happens whenever a listview takes more then a couple seconds to load.<br />
<br />
==== Changing the Loading Icon ====<br />
See [[#Working_with_the_ScreenIO_Loading_Icon|Working with the ScreenIO Loading Icon]] for more information.<br />
<br />
=== Save Money with Screen Functions ===<br />
<br />
==== Lower Development Costs ====<br />
<br />
A "Screen Function", depending on the complexity, represents about 4 - 8 hrs of traditional development time. Sage AX is selling all custom screens at a base price of $150. Custom processing code is occationally necessary to achieve particularly powerful effects, and it is available at a small additional charge. Most screen functions require little or no custom code, but more complex functionality is available. You can do just about anything with a screen.<br />
<br />
Because the screens are contained in Data files, they are easy to modify and easy to maintain.<br />
<br />
Because ScreenIO does the bulk of the work for you, the cost for custom processing code in your screens is lower then you might think.<br />
<br />
<br />
==== Lower Maintenance Costs ====<br />
<br />
The ScreenIO Runtime Library required to run your screens is free.<br />
<br />
The ScreenIO Design engine used to create your screens is available for sale, for a one time unlimited-lisence fee. It will pay for itself after about 30 screens.<br />
<br />
You don't need any special editor to edit the custom code that's already in your screen. That can be done by simply loading the screen helper library and modifying the code, the same way you would modify any BR program. However, if you make those sorts of changes yourself, you should send us a copy of your changes so that they can be included in any future modifications we make to that screen for you.<br />
<br />
Because ScreenIO uses FileIO to access all your data files, you never need to update your screens for file layout changes. This happens automatically because of the magic of the [[FileIO Library]]. The only thing you have to do is update your File Layouts.<br />
<br />
==== Estimated Price for your Screen Project ====<br />
<br />
Please contact Sage AX (gabriel.bakker@gmail.com) with your project details to recieve a free price quote.<br />
<br />
Visit http://www.sageax.com/products/screenio-library/ for more details.<br />
<br />
== Making ScreenIO Screens ==<br />
<br />
It is also possible to purchase a ScreenIO Designer License, that entitles you to a full copy of the ScreenIO Designer, which you can use to make your own ScreenIO Screens. This part of the documentation deals with using the ScreenIO Screen Designer.<br />
<br />
=== The ScreenIO Designer (Overview and Reference) ===<br />
[[image:Designer_-_Add_Edit_Screen_-_Field_Selection_Mode.jpg|thumb|800px]]<br />
<br />
The ScreenIO Designer is modeled after other modern visual program designers. However, it is written entirely in BR, and as such has a few limitations. We have done our best to work past the limitations of traditional BR programming by employing a clever combination of tricks and advanced BR syntax.<br />
<br />
At the top of the screen is the traditional Windows Menu. The left column of the Screen is made up of the Toolbar, which contains the Window Attributes, the Field List, and the ToolBox. At the bottom of the screen is the Debug window. The remaining space is the Editor window, where you can view and modify your screen in a graphical programming environment.<br />
==== Windows X ====<br />
Clicking on the Windows X from the ScreenIO Designer will close the ScreenIO Designer and exit BR.<br />
<br />
Clicking on the Windows X when running your screen will Cancel and Exit out of all screens that you may currently be in recursively until you reach the calling program. It is up to your calling program to then close whatever it was doing and exit.<br />
<br />
If there is no calling program, then clicking on the Windows X when running a ScreenIO screen will close the program and exit BR.<br />
==== ScreenIO Windows Menu ====<br />
===== File =====<br />
File Options<br />
====== New ======<br />
Create a new screen.<br />
====== Load ======<br />
Load a previously saved screen.<br />
====== Save and Compile ======<br />
Save and Compile your screen.<br />
====== Compile ======<br />
Compile your screen only. Use this if you've changed some code but you haven't changed the screen itself.<br />
====== Export Screen ======<br />
Export your screen to a ScreenIO File (*.sio) for transferring it between different ScreenIO implementations.<br />
<br />
This will not save the custom screen functions. It is necessary to transfer any required custom screen functions by hand from the functions\ subfolder in your source ScreenIO implementation.<br />
====== Import Screen ======<br />
Import a screen from a ScreenIO File (*.sio).<br />
====== Purge ScreenFlds File ======<br />
Because of the way ScreenIO Stores the screen information, the screenflds file tends to grow and grow. Run this menu option to purge all deleted records from this file and free up all the unnessicary space.<br />
====== Recompile All Screens ======<br />
This menu option automatically recompiles all your ScreenIO Autogenerated Helper Libraries. This is useful if you made a change to a Custom Screen Function that is in use by more then one screen, and you want to apply the change everywhere in your implementation at once.<br />
====== Quit ======<br />
Exit the ScreenIO System to a BR Prompt.<br />
<br />
If you want to exit BR entirely from just one click, click on the windows "X".<br />
===== Options =====<br />
Performance Options<br />
====== Click to Move ======<br />
Default: On<br />
<br />
This setting enables/disables the grid of blue dots that allows you to quickly move your controls around the screen by just clicking on the destination. On some computers, or some network settings, the click-to-move dots can slow down performance noticably. If this happens, disable the dots by using this menu setting, and move the controls around using the keyboard instead of the click to move dots. (Use the Arrow Keys).<br />
<br />
The Click to Move dots are particularly slow when you are modifying large 2D controls such as ListViews.<br />
<br />
====== Preview Listviews ======<br />
Default: On<br />
<br />
ScreenIO attempts to provide the developer with a WYSIWYG environment. To that end, it renders your screen as much as it possibly can at design time.<br />
<br />
If you make a Listview Screen for a Data File that has records in it, the ScreenIO Designer will do the best it can to populate that listview even while you are designing the listview.<br />
<br />
Previewing the listviews can be very slow for large data files. If you wish to increase performance, turn the "Preview Listviews" setting off.<br />
====== Real Time Filters ======<br />
Default: Off<br />
<br />
If your ScreenIO listview has a custom filter function assigned to it, you can enable the use of the filter function during the WYSIWYG Preview Listview rendering.<br />
<br />
Depending on the resources of your computer, this setting can have a serious impact on performance.<br />
<br />
If the Preview Listviews setting is turned off, then the Real Time Filters setting has no effect.<br />
<br />
===== Add Control =====<br />
The add control menu gives you keyboard access for adding any control you want to your screen. <br />
<br />
====== Add Field ======<br />
This places the cursor in the Fields Listview where you can select fields from your data file and with the arrows and add them to your screen by pressing "Enter".<br />
<br />
====== Add Exit Buttons ======<br />
This automatically adds Exit buttons to your screen. If its a listview screen, then it adds "Select" and "Cancel" buttons. If its an Add/Edit screen, then it gives you "Save" and "Cancel" buttons. These buttons are added to the bottom right corner of your screen, lining up with your rightmost controls. <br />
<br />
====== Add Textbox ======<br />
Adds a Textbox. This is the same as clicking the button in your Toolbox.<br />
<br />
<br />
<br />
====== Add Caption ======<br />
Adds a Caption. This is the same as clicking the button in your Toolbox.<br />
====== Add Checkbox ======<br />
Adds a Checkbox or a Radio Button. This is the same as clicking the button in your Toolbox.<br />
====== Add Listview ======<br />
Adds a Listview to your screen. This is the same as clicking the button in your Toolbox.<br />
====== Add Searchbox ======<br />
Adds a SearchBox to your screen. This is the same as clicking the button in your Toolbox.<br />
====== Add Button ======<br />
Adds a Button. This is the same as clicking the button in your Toolbox.<br />
====== Add Picture ======<br />
Adds a Picture. This is the same as clicking the button in your Toolbox.<br />
====== Skip A Space ======<br />
Skips a space for the automatic placement of controls. This is the same as clicking the button in your Toolbox.<br />
<br />
===== Screen =====<br />
Screen Options<br />
====== Adjust Screen Size ======<br />
Automatically resizes your screen to just large enough to fit all your controls on it.<br />
====== Move Controls ======<br />
This puts ScreenIO into Control Movement Mode<br />
====== Visit Checklist ======<br />
This puts the curser in the Debug listview. You can do the same thing by clicking on the Debug Listview.<br />
====== Set FG Color ======<br />
This brings up the color selector, allowing you to select the Foreground Color for your screen. This is the same as clicking on the button in the Window Attributes panel.<br />
====== Set BG Color ======<br />
This brings up the color selector, allowing you to select the Background Color for your screen. This is the same as clicking on the button in the Window Attributes panel.<br />
====== Select File Layout ======<br />
This brings up the file selection dialog. This is the same as clicking on the button in the Window Attributes panel.<br />
====== Set Events ======<br />
This menu option does the same thing that clicking on the "Set Events" button (under Window Attributes) does: It opens a window where you can specify your Screen level Event Handler Custom Screen Functions.<br />
====== Set Tab Order ======<br />
This menu option allows you to set the tab order by clicking on all of your screen controls in the order that you want the tab order to go. This function is also availble from the "Set Tab Order" button in the Window Attributes corner of the ScreenIO Designer.<br />
====== Configure Debug ======<br />
This option allows you to specify any special instructions to use when testing the screen via the Test Screen menu option below.<br />
====== Test Screen ======<br />
This option fires up a second copy of BR to test your screen. All screenIO screens can be exited by clicking on the Windows X. Your screen runs in a completely separate instance of BR, so you don't have to worry about the test of the screen screwing up whats going on in your editor.<br />
<br />
Its important to remember to save your screen before testing it. Otherwise, you will see the previous version of the screen when you test it.<br />
<br />
ScreenIO will attempt to use the same BR executable and brconfig.sys file that you loaded screenio with, so make sure its the one you want to use for your application.<br />
<br />
===== Help =====<br />
Help Menu<br />
====== Documentation ======<br />
This menu option links to this wiki document.<br />
====== About ======<br />
Opens the ScreenIO About screen.<br />
<br />
==== ScreenIO Designer Modes ====<br />
The ScreenIO Designer has several different modes that it operates in. For the most part this is designed to be seamless to the programmer but it may help to understand whats going on behind the scenes.<br />
<br />
BR has a major interface limitation, in that only one child window is able to be input from at a given time. The ScreenIO designer attempts to hide this problem by using different modes. The modes are as follows:<br />
<br />
let Inputattributesmode=1<br />
let Inputfieldlistmode=2<br />
let Inputeditormode=3<br />
let Inputeditormovemode=4<br />
let Inputdebugmode=5<br />
let Quitmode=6<br />
let Selectcolormode=7<br />
let Selectfilelaymode=8<br />
let Inputlistviewmode=9<br />
let Selecteventsmode=10<br />
let Settabordermode=11<br />
let Configuredebugmode=12<br />
<br />
Input Attributes Mode is when the cursor is in the upper left corner of the screen, inputting the attributes for the whole screen. If you're in a different mode and you click on the Window Attributes, then the mode is changed to Window Attributes mode.<br />
Input FieldsList Mode is when the cursor is in the fields listview, and you're selecting fields to add to the screen.<br />
Input Editor Mode is when the cursor is in the attributes for a single field.<br />
Input Editor Move Mode is when the cursor is in the mode where you move controls, the mode with the blue dots.<br />
Input Debug Mode is when the Todo List debug at the bottom of the screen is active.<br />
Quit Mode is used to tell the designer to exit.<br />
Select Color Mode is the current mode whenever you're selecting a color for something.<br />
Select FileLay Mode is used to select the file layout for your screen.<br />
Input Listview Mode is the mode for entering the information for listview columns.<br />
Select Events mode is the mode you're in when you're selecting screen level events.<br />
Set Tab Order Mode is the mode for setting the tab order.<br />
Configure Debug Mode is the mode for configuring the debug window.<br />
<br />
You can generally tell what mode you're in because that part of the screen will light up yellow.<br />
==== Toolbar ====<br />
The Toolbar Window is along the left side of the screen. It is made up of the Window Attributes window, the Fields List, and the Toolbox.<br />
===== Window Attributes =====<br />
The Window Attributes window contains information about all Screen level Attributes.<br />
====== Window Name ======<br />
This is the unique 8 digit Window Name. It is used as the unique key in the ScreenIO data file. It is the name you use to load your screen from code, and the name you use when you load your screen from the ScreenIO Designer File->Load menu.<br />
====== Caption ======<br />
This is the Caption in the Windows Title Bar when you run your application. If the Window you are creating has a border specified, then this is also the caption that appears in the border of that Child Window<br />
====== Rows ======<br />
The number of Rows your window takes up. You can change this any time, and your screen will adjust on the fly. This makes it easy to design your screens and then adjust the size of them when you already know what they will look like.<br />
<br />
If you make your screen too small and not all the controls fit on it, the ones that are outside the border of the window will not be rendered, and a Debug Message will appear in the Debug Window. Simply make your screen large enough for all the controls to appear and move the offending controls away from the edge, and then resize your screen again to the size you want it to be.<br />
====== Cols ======<br />
The number of Columns your window takes up. See Rows (above) for more information.<br />
====== Attributes ======<br />
This Attributes Screen is used when opening your window. You can place any valid BR Window Attribute statement here. For example, to make your screen have a border around it, type "BORDER=S" in the Attributes setting for the window.<br />
====== Picture ======<br />
Type the path and filename of a picture file, and it will be used as the background image for your Screen.<br />
====== Read Key ======<br />
Specify the key to use when reading the file. The default is the first key specified in the layout for Add/Edit screens, and Sequential Read for Listview Screens.<br />
====== Return Key ======<br />
Specify the key to use when calculating the return value. The default is the first key specified in the layout.<br />
====== Input Attr ======<br />
Specify the Input Attr spec to use in the main Rinput Fields statement. This controls the appearance of the currently active field.<br />
====== Wait Time ======<br />
Specify the time to wait in seconds of keyboard inactivity before triggering a WAIT event. If you have no WAIT event specified, then ScreenIO will trigger the default ScreenIO WAIT event.<br />
====== FG Color ======<br />
This is the default Foreground Color when adding new controls to the screen.<br />
====== BG Color ======<br />
This is the background color for the screen.<br />
====== File Layout ======<br />
Click this button to select the file layout that your screen applies to.<br />
====== Set Form Events ======<br />
This button is a shortcut to the Windows Menu: Screen->Set Form Events. It opens a window where you can view and configure the ScreenIO Custom Helper Functions that get triggered for each of your Form (Screen) level Events.<br />
====== Set Tab Order ======<br />
This button is a shortcut to the Windows Menu: Screen->Set Tab Order. It allows you to change the tab order of your screen by clicking on your screen controls in the order that you would like the tab order to become.<br />
===== Field List =====<br />
This listview shows all the fields in the currently selected File Layout.<br />
<br />
Because of a limitation in BR, only one child window can be active at any given time. You can tell if you are in "Input Fields List Mode" because the background for the Listview will turn Yellow. When you are in "Input Fields List Mode," you can navigate the listview with the mouse or arrow keys. Pressing Enter or Double Clicking on an item will add it to your new screen.<br />
===== Toolbox =====<br />
The toolbox contains buttons for adding each of the different control types supported by ScreenIO.<br />
====== Add Field ======<br />
This button adds the currently selected field from the Fields List to your new screen. This is the same as double clicking on a listview item or pressing enter while in Input Fields List Mode (while the Fields List is yellow). If you are not currently selecting a field from the Fields Listview, then clicking on this button does nothing.<br />
<br />
The currently selected field is added as a Textbox that is automatically tied back to your data file. To the left of this new textbox is a caption containing the description from the File Layout for this field. Both can be customized to your hearts content, and positioned any place you want on the screen.<br />
====== Add TextBox ======<br />
This button adds an empty Textbox Control to your new screen. This textbox control can then be configured and tied to a field from the data file, or left as a Screen field that can be accessed and modified by your custom ScreenIO Helper Functions.<br />
====== MultiLine Textbox ======<br />
BR Supports Multi-Line Textboxes via a little-known programming trick that dates back to the days before graphical controls. It is possible to use this technique to make multiline textboxes in BR, and ScreenIO makes the process easy for you. The only down side to BR multi-line text boxes is that you can only make a multiline text box that goes all the way to both the left and right side of the window.<br />
<br />
To make a MultiLine textbox in ScreenIO, simply add a regular textbox to the screen and then press the PgDn key while in movement mode. It will stretch horizontally to fill the screen, and grow to become a multiline textbox.<br />
====== Add Caption ======<br />
This button adds an empty Caption Control to your new screen. This caption can be configured and the Text to display can be specified. Or, you can tie it to a field in the data file, or leave it as a Screen field that can be accessed and modified by your Custom ScreenIO Helper Functions<br />
====== Add CheckBox ======<br />
This button adds an empty Checkbox Control to your new screen. This Checkbox can be configured and its caption can be specified. It can also be tied to a data file, or left as a Screen field that you can access and modify.<br />
<br />
You can tie your checkbox to a field in your data file by specifying a TrueValue and a FalseValue in addition to a FieldName for a field from the file. If the checkbox is checked, the truevalue you specify will be saved in the file. If its not, the falsevalue will be saved in the file.<br />
<br />
====== Add Radio Button ======<br />
To add a Radio Button, start by adding a Checkbox to your screen. Then convert the Check box into a Radio Button using the following procedure.<br />
<br />
You can turn your checkboxes into radio buttons very easily. Simply add a group number (1,2,3,etc) in the attribute field and your checkbox will be converted to a radio button as ScreenIO builds the screen.<br />
<br />
You oftentimes will want to tie a group of Radio Buttons to a single field in the data file. In that event, specify the same field name for every radio button, and specify the True Value that you want associated with each Radio button in the group. For falsehood values for all the controls in the group, specify a value of "~ignore~". This will instruct ScreenIO to ignore the falsevalue, saving the truevalue from the currently selected radio button.<br />
<br />
====== Add Listview ======<br />
This button adds an empty listview to your new screen. This Listview can then be configured and modified. If you enter "Edit Listview Columns" mode, then you can add or remove columns from the listview. If you are currently in Edit Listview Columns mode, then you can click on the Fields List to automatically add listview columns from your datafile directly.<br />
====== Add Search Box ======<br />
This button adds a Search Box and ties it automatically to a listview if one is found. You can also tie the Search Box to a Listview later from its control attributes window.<br />
====== Add Button ======<br />
This button adds a Button to your new screen. You can specify a Click Event Handler, some custom BR code that gets triggered whenever the button is clicked on.<br />
====== Add Picture ======<br />
This button adds a Picture object to your new screen. Pictures, like buttons, also have a click event.<br />
====== Skip a Space ======<br />
This instructs ScreenIO to skip a row for the automatic placement of Screen Controls.<br />
<br />
==== Editor ====<br />
The Editor Window contains your new screen.<br />
<br />
From the Editor Window you can move your Screen Controls around, and also edit each of their attributes and event functions.<br />
==== Debug ====<br />
The Debug window lists potential warnings and errors discovered by our Screen validation routine.<br />
<br />
Messages in Blue are Warnings. They point to things that our ScreenIO Validation routine believes don't really make sense, even though they aren't really going to cause an error.<br />
<br />
Messages in Red are Errors. If those problems are not corrected, your screen will not function properly.<br />
<br />
If you double click on a message, the ScreenIO validation routines will do their best to take you to the location of the error so you can find it and fix it more easily.<br />
<br />
=== Using the ScreenIO Designer ===<br />
Now that we have gone over the various elements that make up the ScreenIO Design Library, lets take a closer look at the process of making a Screen.<br />
<br />
==== Create a New Screen ====<br />
The first thing that every screen needs is a Screen Name.<br />
<br />
Fire up the ScreenIO Designer. You will notice a few messages in the Debug window, right off the bat. One of these is an error message, that says "Window Name cannot be blank." (The message may appear white on a blue background instead of Red on a White background. This is because of the current row selection bar, which is White on Blue.)<br />
<br />
The Window Name is the primary unique key for the ScreenIO Screens file, and every screen needs one. You use the Screen Name when invoking your screen, and when loading it from the File->Load menu.<br />
<br />
Enter a name for your new screen.<br />
<br />
The next step is to Select the File Layout for your screen.<br />
<br />
One of the nicest features of ScreenIO enabling truly Rapid Application Development, is ScreenIO's ability to automatically modify data files that have been defined within the [[FileIO Library]] system.<br />
<br />
In order to use ScreenIO to create screens that dynamically interact with your data files, it is first necessary to define your data files with FileIO style file layouts. If you have not done so, do so now. For more information on the [[FileIO Library]], visit the [[FileIO Library]]s page on this wiki.<br />
<br />
Click the button to the right of the text "File Layout:". Select the file layout for the file you plan to interact with using this screen.<br />
<br />
[[image:Designer_-_Add_Edit_Screen_-_Field_Selection_Mode.jpg|thumb|800px]]<br />
==== Add Fields to your new Screen ====<br />
As soon as you select your file layout, the Field List listview should populate with all of the fields in the selected data file. At this point, you can add these fields to your Screen, by selecting them from the Field List listview and pressing the "Add Field" button (or pressing "Enter" from the Field List listview).<br />
<br />
The fields you add will appear in the top left corner of your screen. You can go ahead and add all the fields you want in a row. They will all go on top of each other, and the Debug Window will change to reflect that many of your controls cannot be drawn because they are on top of each other.<br />
<br />
If you'd like to create a Listview Screen instead, you can do that by adding a Blank Listview control to your screen. Then, follow the instructions below to position your listview where you want it. When your listview is in the position and size you'd like it, press Enter twice, to go to "Edit Listview Columns Mode". Click the "Delete Column" button once to delete the Empty Listview Column that appears by default, and then click on the Field List to Jump to the Field List listview. From the field list, you can then add columns directly from your data file to your listview, by selecting them and pressing Enter.<br />
<br />
[[image:ScreenIO_Designer_-_Movement_Mode.jpg|thumb|800px]]<br />
==== Position the fields on your new Screen ====<br />
When you have finished adding your fields, click on one of your controls in the Editor window. A grid of small blue dots should appear, and your selected control will appear in Yellow, indicating that you are in Movement Mode.<br />
<br />
While you are in Movement Mode, ScreenIO will group your captions with your textboxes for any controls that were added together. If you move the textbox control, the caption associated with it will move automatically. This is regardless of weather or not the caption is part of a control group.<br />
<br />
This piece of magic is accomplished via the [[#Caption Field|Caption Field]] poperty.<br />
<br />
===== Keyboard Control Movement =====<br />
In Movement Mode, you can position your control using the Arrow Keys. The Backspace Key makes your control narrower, while the Space Key makes your control Wider. PgUp and PgDn make your 2D control Taller or Shorter. Enter toggles between Movement Mode, and Control Attributes Mode. For more information, see the chapter on [[#Screen_Control_Movement_Mode|Screen Control Movement Mode Keyboard Reference]].<br />
<br />
===== Click to Move Control Movement =====<br />
While BR does not support true Drag and Drop, you can approximate the functionality of Drag and Drop in BR. This is what the ScreenIO Click to Move feature is all about.<br />
<br />
While you are positioning your controls around the screen, the currently selected control is highlited in Yellow, and the BR Print Statement for the control is displayed in the text of the control.<br />
<br />
If you click on one of the blue dots, your control will jump to that location. You can use this feature to quickly place your controls on the screen.<br />
<br />
First, click on the control that you want to move. It will highlite in Yellow. Then click on the blue dot where you want to move it to. It will move there. If there is a control group selected, then all the controls in the selected group will be moved relative to how the main control moved.<br />
<br />
When you move your controls around, select the Text Box field and move that first. The Caption field will automatically move with you, following the Text Box around the screen. This may be confusing at first, but this feature is designed to save you time in the long run.<br />
<br />
Move all of your new controls around until your screen looks nice. You can also resize your screen at any time by changing the values in the Window Attributes window.<br />
<br />
''However, the Click to Move feature can significantly slow down the ScreenIO Designer on computers with limited resources. If you prefer to turn it off, you can do so from the Options menu.''<br />
<br />
[[image:ScreenIO_Designer_-_Control_Attributes_Window.jpg|thumb|800px]]<br />
<br />
==== Control Attributes Window ====<br />
<br />
When you have your screen looking the way you want it, it is time to begin modifying the attributes of your individual controls. Click on the control that you want to view the attributes for to select it. It will highlight in Yellow. Click it a second time (or press the Enter key) and a little window will open up showing all the attributes for the given control.<br />
<br />
The control attributes window shows all the customizable attributes for each of your screen objects. Each object type has its own set of attributes and events.<br />
<br />
[[image:ScreenIO_Designer_-_Control_Attributes_Window_-_Closeup.jpg]]<br />
<br />
Here is a list of all the available Control Attributes and what they do:<br />
===== Control Name =====<br />
This is the name for the control. Your controls do not require a name. However, if your control is not tied to a field, but you give it a name, then ScreenIO automatically reserves a place for that control in Mat S$. You can modify the value of that control within your Custom Screen Functions by using its control name.<br />
<br />
You can also use the control name to identify controls from within your event functions. If the control is called MyControl, then you can access its Background Color by looking at BgColor$(ctl_MyControl).<br />
<br />
===== Field =====<br />
This is the field the control is tied to in your data file. When the user enters the screen, the record is read (or added) and the information from this field is displayed in the control. When the user finishes modifying the code and presses the Save button, the information is automatically saved back into the data file for you. Validation is provided for in the Validation Function (explained below).<br />
===== Caption =====<br />
This is the caption for your Caption Fields, Check Boxes, and Buttons. This is the Tool Tip Text for your Buttons (not implemented yet).<br />
===== Caption Field =====<br />
This is the Control Name of the field that is tied to this field for movement purposes.<br />
<br />
Any time you use the Movement Mode to move a control around, if it has a Caption Field specified, then the control referenced in the caption field is moved automatically for you. This helps keep the caption next to the text box it applies to.<br />
<br />
===== Spec Width =====<br />
This is the Internal Width of the data allowed in the control. This is not to be confused with the physical display width of the control. You modify the Display Width of a control by pressing "Space" or "BackSpace" when you are in Movement Mode and the control is selected. The Spec Width specifies how wide the data in the control can be.<br />
===== Sort Column =====<br />
The Sort Column attribute applies to ListViews only, and specifies which column the listview is sorted on when the program is first loaded. If you are using a search box with your listview, then it is highly reccomended that you specify a Sort Column along with it. Otherwise, your Search Box will not be usable until the user manually sorts the Listview by clicking on the column headings.<br />
<br />
If you want your listview to sort in Descending Order, then specify a negative number. If you want it to sort in ascending order then specify a positive number here.<br />
<br />
For example, if you want it to sort in Descending Order on the Second Column, then specify a Sort Column of -2.<br />
===== Multiselect =====<br />
This check box indicates weather you want to allow multi-selection in your listview or not. If you do enable multiselection, then use mat SelectedKeys$ or mat SelectedRecords in your custom functions to see which records the user has selected from your data file.<br />
===== Truth Value =====<br />
The Truth Value attribute applies to Checkboxes only, and is used to translate a checked/unchecked value into the true and false values for your data files.<br />
<br />
Everybody uses something slightly different in their data files to represent True and False. Some people use "Y" or "N". Some people use "T" and "F". Some people use 1 and 0 to represent True and False in their data files. The Truth Value specifies the value that represents True in the data file for this Check Box.<br />
===== Falsehood Value =====<br />
The Falsehood Value attribute applies to Checkboxes only, and is used to translate a checked/unchecked value into the true and false values for your data files.<br />
<br />
Everybody uses something slightly different in their data files to represent True and False. Some people use "Y" or "N". Some people use "T" and "F". Some people use 1 and 0 to represent True and False in their data files. The Falsehood Value specifies the value that represents False in the data file for this Check Box.<br />
<br />
====== ~Ignore~ (Radio Buttons) ======<br />
If you are using Radio Buttons, you'll often want to tie several buttons to a single data file. To do this, you will specify the value that you want each option to write to the disk using the Truth Value, and for the false value you want to specify "~ignore~". This will tell ScreenIO to ignore the false value, and when the user selected a new radio button, the truth value for the radio button they selected will be used as opposed to the false value for the radio button that they unselected.<br />
<br />
===== Function =====<br />
The Function attribute specifies the Click event for your Button or Picture control. Press the Edit button to select from your existing Custom Screen Functions, or create a new one. See the Custom Screen Function section of this document (below) for more information about Custom Screen Functions.<br />
<br />
The Click Event selects the BR Code that gets triggered whenever the user Clicks on this picture or button.<br />
===== Validation =====<br />
The Validation attribute identifies the Custom Screen function that gets triggered whenever the data in the control is changed. You can use this event to ensure that only valid data gets saved in the database. If your validation event returns false (0) or a null string then the data the user entered is thrown out, and the previous value is replaced in the control.<br />
===== Filter =====<br />
The Filter Function applies to a Listview only, and is one of the most versatile functions in the ScreenIO System.<br />
<br />
Your filter function gets triggered for Each Row in the data file, before it is added to the listview. You can use the Filter event to include/exclude certian records from the listview. You can also modify the data displayed in the listview before it goes to the screen.<br />
===== Conversion =====<br />
The conversion field specifies to ScreenIO how to treat numeric data. You can specify any valid BR field spec, or FMT, PIC or DATE here. You may also specify your own conversion function to be used when unpacking the data from the disk.<br />
<br />
If you use DATE then it will convert the value from a julian date into the date format you specify, and when its writing it back to the disk, it will convert it back to the julian date value before saving it to the disk.<br />
===== Picture File =====<br />
This specifies the path and filename of the picture file to use for the picture control. All the image types supported by BR are supported here.<br />
===== Foreground Color (Header FG Color) =====<br />
This is the foreground color of the control. If you intend to use Attribute Substitute statements to color your controls, then you need to leave the Foreground Color and Background Colors blank, as these values will override the colors specified in your Attribute Substitute Statements.<br />
===== Background Color (Header BG Color) =====<br />
This is the background color of the control. If you intend to use Attribute Substitute statements to color your controls, then you need to leave the Foreground Color and Background Colors blank, as these values will override the colors specified in your Attribute Substitute Statements.<br />
===== Justification Spec =====<br />
This attribute specifies the BR Justifcation Attribute to use for this screen object. The default "C" is Left Justify. You can specify:<br />
<br />
*C - Left Justify<br />
*CC - Center Justify<br />
*CR - Right Justify<br />
*CU - Force Uppercase<br />
*CL - Force Lowercase<br />
===== Set Listview =====<br />
The Set Listview attribute applies to Search Boxes only, and specifies the Listview that the Search Box is tied to. When the user types something in the Search Box, the Listview will automatically jump to the record they are typing, based on which column the listview is sorted on.<br />
<br />
If you have a Search Box, but no Sort column is specified in your listview, then an Error message is displayed in your Debug Window.<br />
<br />
When you click the "Set Listview" button, the search box is automatically tied to the listview on the screen. (At this time ScreenIO does not support more then one listview on a logical screen at a given time.) The Spec Width for the Search Box is automatically updated to match the largest column in the listview.<br />
<br />
If you added your listview before you added your search box, then the Search Box is already tied to your Listview by default. When your search box is tied to a listview, you will see the internal name of the listview (usually "LV1") in the "Set Listview" button.<br />
===== Attributes =====<br />
The Attributes control attribute specifies the Control and Display Attributes to use when displaying the control. (Say that five times fast...)<br />
<br />
You can specify any valid BR attribute, including Attribute Substitution Statements from your brconfig.sys. This enables the use of BR style themes in your ScreenIO screens.<br />
<br />
===== Tooltip Text =====<br />
Here you can specify the help text, if any, to be associated with the given control. You can specify your own helplevel if you know how to do so. If you do not specify your own help level, ScreenIO defaults to the most unused help level available in the version of BR you're running. This is level 1 for 4.1 and level 0 for 4.2 or higher, indicating to display the help text as tooltip text whenever the mouse is over the control.<br />
<br />
===== User Data =====<br />
This is a field you can use for any purpose you like. You can view and modify this field in your screen functions.<br />
<br />
===== Protected =====<br />
This indicates if a field is protected or not. If its protected, then it is kept automatically out of the input fields statement, keeping the user from modifying it. We do it manually because there are certian times when it doesn't work properly using the standard BR Protected attribute. However if you wish to use the Standard BR Protected Attribute, you can always specify a "P" in the Attributes field. This value, and all of these values, can be changed at runtime from any of your custom functions.<br />
<br />
===== Invisible =====<br />
This indicates if a field is invisible or not. If it is invisible, then it is kept off the screen entirely. This is different from BR's invisible attribute, which hides the data behind a mask of "*"s. If you wish to use the standard BR invisible attribute, you can specify an "I" in your Attributes field. This value, and all of these values, can be changed at runtime from any of your custom functions.<br />
<br />
==== Save and Test Screen ====<br />
Once you have finished adjusting the positions, appearance, and behavior of your screen controls, it is time to save your screen. Select "Save" from the File dropdown menu and your new screen is written to the disk, and its Autogenerated Screen Helper library is compiled for you.<br />
<br />
You may now select "Test Screen" from the Screen menu, to test your new screen in a seperate BR process.<br />
<br />
==== Conclusion ====<br />
Your new Add/Edit screen contains everything necessary to Add and Edit records in the selected data file, and you didn't have to write any custom code at all.<br />
<br />
However, most screens you write will most likely utilize custom code to achieve a nicer effect. You can use your Custom Screen Functions to do just about anything with your ScreenIO Screen. For more details about Custom Screen Functions, see the Custom Screen Function section in this document (below).<br />
<br />
=== ScreenIO Custom Screen Functions ===<br />
You can already see that the ScreenIO system is the fastest way to develop functioning software in the BR world. Simple Listview and FM screens can already be quite powerful, without writing a stitch of custom code. Because of the object oriented database foundation afforded to us by FileIO, we can achieve some pretty amazing results in just a few minutes of graphic design with a WYSIWYG editor.<br />
<br />
However, I'm sure you can already think of hundreds of situations where the default ScreenIO behavior is insufficient to achieve the results expected of custom code.<br />
<br />
Its with ScreenIO Events and Custom Screen Functions, that the power of the ScreenIO Rapid Application Development system really begins to unfold.<br />
<br />
You can write custom events to initialize your new record, unpack a record after reading it, validate a record before saving it, and open an close your screens. You can also place code in the events for your individual controls. You can add custom code to your listview's Filter Event, or the Click events for your Buttons and Pictures, and you can have your custom code perform Validation.<br />
<br />
Your Custom Screen Functions can modify any value in the ScreenIO System, including the Control Attributes for your individual controls. All your screen's controls can be referred to by their FileIO syntax in the mat F$ and mat F arrays that are read from your data file. Simply read or change the data in the file record (mat f$ and mat f) and it will be reflected in real time on the screen.<br />
<br />
If you place controls on your screen and don't tie them to a field, but give them a control name instead, then they are placed in a special array called mat S$ and you can access and modify their data values there, by control name.<br />
<br />
By writing solid clean code, you can even reuse your Custom Screen functions, making future screen development faster even for complex powerful screens.<br />
<br />
<br />
==== ScreenIO Events ====<br />
The screenIO system has several Events that can trigger your custom code. You will write different sorts of functions for each type of event.<br />
<br />
===== Form (Screen) Level Events =====<br />
ScreenIO supports eight Screen level events. These are major events triggered by the state of the screen as a whole.<br />
====== Enter Event ======<br />
The Enter Event is triggered when your screen first loads. You can use it to initialize Screen Global Variables, Open additional data files, Initialize values on the screen, and even load other screens that you want to appear to the user as being a part of this screen.<br />
====== Initialize Event ======<br />
The Initialize Event is triggered from an Add/Edit screen when you are adding a new record to the data file. This happens any time you call FnFM without specifying the key to edit. (See Using Screens above). Use the Initialize Event to initialize the data in a new record that you are adding.<br />
<br />
It is often useful to have your Initialize Event Function call your Read Event Function.<br />
====== Read Event ======<br />
The Read Event is triggered upon a successful read of the data file. This happens in an Add/Edit screen any time you are loading a record to modify it.<br />
<br />
You most often use this event to Unpack the data from the data file for Screen Display purposes. This is why you sometimes want it to happen on Initialization of new records as well as the reading of existing records.<br />
<br />
On a listview screen, the Read Event behaves totally differently. On a listview screen, you never give a key when you call the screen, so the Read event never gets triggered when the screen is loading. Instead, on a listview screen, the Read Event is triggered any time the user changes which row is currently selected in your listview. You can use this to update reference information on the screen from the new record in the data file.<br />
====== Mainloop Event ======<br />
The mainloop event is an event thats triggered every time the main RINPUT FIELDS statement is executed when running your screenio screen. This means, every time anything happens, the mainloop event happens first. You can use the mainloop event to test for fkey 98 (the windows dropdown menu) and add dropdown menu support to your screenio screen.<br />
<br />
You can also place the "X" attribute in various fields to trigger the Mainloop Event to fire whenever the user moves the cursor out of these fields, in order to update the screen in some way.<br />
<br />
Another way to use the mainloop event is to use the config keyboard command to remap any key on the keyboard to an fkey value, and test for that fkey value, tying your own custom action to any key on the keyboard.<br />
<br />
See Example [[#Mainloop_Function|Mainloop Function]].<br />
====== Wait Event ======<br />
The WAIT event is triggered any time your screen has a WAIT value specified in the Window Attributes panel. This event determines the action you would like ScreenIO to take when the keyboard has been idle for some time.<br />
<br />
Your WAIT event return value determines the action screenio takes after the main processing of your WAIT event. If your WAIT event function returns True, then ScreenIO clears the WAIT condition and continues executing the screen until another event is triggered. If your WAIT event function returns False, then the ScreenIO screen is closed with an [[#ExitMode|ExitMode]] of Cancel, and the screen is backed out of.<br />
<br />
If you do not specify a WAIT event function, then the default ScreenIO WAIT event code fires, and ScreenIO informs the user that their keyboard has been idle for some time, and requests that they please press a key sometime in the next 30 seconds or else they will be logged out of the current screen. If they press a key in the alotted time, they are taken back to the RINPUT FIELDS statement and allowed to continue using the screen. If not, the screen closes and logs them out, freeing up the record so someone else can use it.<br />
<br />
====== Locked Record Event ======<br />
The Locked Record event is triggered any time ScreenIO attempts to read a record that has been locked by another user. Your Locked Record event should tell ScreenIO what to do when a record locking error occurs in your screen.<br />
<br />
If your Locked Record event returns True, then the read is attempted again. If it returns false, then the read is cancelled and the screen is exited.<br />
<br />
If you do not specify a Locked Record event function, then the default ScreenIO Locked Record event code fires. The user is informed of a file sharing violation and the user name of the person who has the record locked. They are given the option to Retry or Cancel the operation. If they select Retry, the read is attempted again. if they select false, then the read is cancelled and the screen is exited.<br />
====== Write Event ======<br />
The Write Event happens just before your screen exits, when Save has been selected. You can use the Write event to perform last minute validation. From the Write Event, you can correct any validation problems, discard the invalid data, or cancel the [[#ExitMode|ExitMode]], forcing ScreenIO to continue to process and forcing the user to fix the error before continuing.<br />
<br />
====== Exit Event ======<br />
The Exit Event happens when the screen exits. If you had to open reference data files in your screens "Enter" event, then the "Exit" event is a good place to close those same data files.<br />
===== Control Specific Events =====<br />
In addition to the Form Level events, ScreenIO provides one custom event per control. The meaning of this event is different depending on the control type. Some controls don't have any event at all.<br />
====== Click Event ======<br />
The Click Event is the simplest event to code for. It is triggered whenever someone clicks on a Button or a Picture. In this event, you can place any code that you want to be called when they click on the button.<br />
<br />
See Example [[#Click_Event_Function|Click Event Function]].<br />
====== Validate Event ======<br />
The Validate Event is triggered whenever the data in the element changes. You can use this event to discard or accept the data, display a msgbox to the user, and position the curser. If your validation routine returns non-zero and non-blank, then the value the user typed is accepted and saved. If your validation routine returns null or 0 then the value the user typed in is ignored and the previous value is retained. You can also modify the value directly by modifying the optional parameter "FieldText$" in your function.<br />
<br />
See Example [[#Validate_Field_Function|Validate Field Function]].<br />
====== Filter Event ======<br />
The Filter function is the most versatile function. This function can be used to unpack the record data so it can be properly displayed in the listview. It can also mark records for inclusion or exclusion in the listview, and if it specifies a color, then that color is used to conditionally color the records of the data file while displaying them in the listview.<br />
<br />
Your filter function must return true (non-zero) or something (non-empty string) for all records which are to be included in the listview. Any time your Filter Function returns False (or a null string), the record is ignored.<br />
<br />
See Example [[#Listview_Filter_Function|Listview Filter Function]].<br />
====== Conversion Function ======<br />
The Conversion Function Event is more powerful then many of the other events. It can also contain a function or a reference to a library, but in addition to those values it may contain any valid BR PIC or FMT or DATE statement that can be applied with the "CNVRT$" function.<br />
<br />
Also, if you're using BR 4.2, the Conversion function may be used with Listview Columns to natively support numeric listview columns.<br />
<br />
If the conversion value is DATE then ScreenIO will automatically use it to convert what the user typed in back into a natural DATE value.<br />
<br />
You may also use the validation function to preform validation on the field. However, if you are using DATE, then remember to leave the accpted value in the DATE format so that ScreenIO can convert it back to the julian DAYS format that you will be saving on disk.<br />
<br />
If the conversion value is PIC or FMT then ScreenIO will not attempt to convert it back, but it will still use "val" to change numeric fields back into numeric fields.<br />
<br />
If the conversion value is a custom function, then your custom function will need to modify "FieldText$" to the appropriate value for Converting from Disk to Screen. If you then need to convert it back, you may do so through the fields Validation function.<br />
<br />
==== Valid Custom Function Types ====<br />
Your Custom Function can specify several different types of Event Handler. The Edit button is provided to help you manage and reuse your Custom Functions. <br />
<br />
If you wish to enter any of the other types of Event Handlers, simply type them into the Event Textbox.<br />
<br />
===== Link to another screen =====<br />
To link to another screen, simply specify the Screen Name in Square Brackets:<br />
<br />
Function: [CUSTEDIT]<br />
<br />
or (specify a position)<br />
<br />
Function: [CUSTEDIT(2,4)]<br />
<br />
or (pass in other values)<br />
<br />
Function: [CUSTEDIT]key$=CurrentKey$<br />
<br />
You can specify the row and column position to place the new screen using the shorthand notation specified above, placing the row and column in parenthesis inside the square brackets, after the screen name.<br />
<br />
You can pass values into the screen you are about to call by specifying them after the name of the screen as in the example above.<br />
<br />
You can pass Key$ and ParentKey$, Displayonly, ParentWindow, Dontredolistview, and Record.<br />
<br />
====== CurrentKey$ ======<br />
<br />
CurrentKey$ always matches the Currently Selected Key from this current screen. If the current screen is a listview, then CurrentKey$ will always match the currently selected row of the listview. This can be used anywhere in your custom functions that you want to know the key for the currently selected or currently edited record.<br />
<br />
By saying "Key$=CurrentKey$" in the above example, we are telling the CUSTEDIT screen to use the currently selected listview item as the key for Editing.<br />
<br />
====== ThisParentKey$ ======<br />
<br />
ThisParentKey$ always matches the parentkey passed into the screen. In most of your custom functions you can just use "ParentKey$" to get this value. However, when calling another screen automatically, if you want to pass the current ParentKey$ into the screen you're calling, you'll need to use ThisParentKey$.<br />
<br />
If you say "ParentKey$=ThisParentKey$" then you're telling screenio to use the ParentKey$ from this screen to set the ParentKey$ in the new child screen. This is useful when you need to pass your ParentKey$ or part of it into a child screen as the parentkey for that child screen.<br />
<br />
===== Chain statement =====<br />
If the first character of your function is a %, then the rest of your function is interpreted to be a chain statement.<br />
<br />
%menu.br<br />
<br />
This example will chain to the BR program called "menu.br".<br />
===== Any single BR command =====<br />
For most events, anything else you type is interpreted as a regular BR statement and executed with the execute command.<br />
<br />
The only exception to this is the Conversion Function. If you type anything else in the Conversion Function, then it will be interpreted as a BR Field Spec to be used with the CNVRT$ function. <br />
<br />
You can launch a web page or a system command here, or you can modify the status of the current screen. You might have a Save button with a click event that says:<br />
<br />
let ExitMode=SaveAndQuit<br />
<br />
[[#ExitMode|ExitMode]] is the ScreenIO variable that determines when we are done processing your screen. If you set ExitMode to the constant "SaveAndQuit" then your screen will exit and save the data on its way out.<br />
<br />
===== Any valid BR Field Spec (Conversion Function Only) =====<br />
If you type anything in the Conversion Function thats not a library call or a custom function reference, then it will be interpreted as a BR Field Spec to be used with the CNVRT$ function. Any valid field spec, including FMT and PIC and DATE are acceptable here.<br />
<br />
ScreenIO will use this value to convert the data as best it can both onto the screen and back onto the disk. If you are using Julian Date values on the disk, you'll probably want to specify a "DATE(" conversion function to automatically have those displayed and edited as readable dates. You can also use this for numeric formatting, and listview sorting if you put it in a listview column.<br />
<br />
Listview numeric column sorting is only available in BR 4.2. BR 4.1 and earlier will sort the numeric fields alphabetically which does not always produce the desired results.<br />
<br />
===== Link to a Custom Screen Function =====<br />
To link to a Custom Screen Function, use the Edit Button. Your selected Custom Screen Function will be placed within Curly Braces {}.<br />
<br />
{AddNewCustomer}<br />
<br />
More details about Custom Screen Functions follow.<br />
<br />
====== Entering / Selecting your custom handler ======<br />
To select the Custom Screen Function for a given ScreenIO Event, simply go to the correct place and click the "Edit" button. This button brings up the ScreenIO Select Custom Screen Function dialog.<br />
<br />
At the top left you'll see a list of all your available Custom Screen Functions. At the bottom left is a search box, that can be used to hunt quickly through the list of Custom Screen Functions, as well as to specify the name for new Custom Screen Functions that you might create. At the right of the dialog is a multi-line text box displaying the first part of the source code for the currently selected Custom Screen Function.<br />
<br />
You can select any Custom Function from the list and click the "Ok" button to accept it.<br />
<br />
===== Link to a Library Function =====<br />
You may also link directly to a library function from any of your Screen Events. To do this, type a "#" followed by the library name and the function, separated by a ":"<br />
<br />
#libname:fnFunctionName(parm1,parm2$,parm3)<br />
<br />
Example: Assume your library is called "run.br" and your function is called fnRun(screenname$).<br />
<br />
#run:fnRun('customer')<br />
<br />
Example 2: Assume your library is called "thing.dll" and your function is called fnDoSomething(thing$,otherthing$)<br />
<br />
#thing.dll:fnDoSomething(thing$,'constant')<br />
<br />
Note: Notice the use of single quotes when passing string constants into your library functions. This is necessary at this time because of the way ScreenIO compiles your custom helper libraries.<br />
<br />
==== Writing Screen Helper Functions ====<br />
<br />
To create a new Custom Screen Function, enter a name into the search box at the bottom left and click the "Add New" button. ScreenIO automatically creates a new .brs file containing a blank custom screen function, and opens it in your Windows Default Editor for .BRS files. If you don't have a default editor specified yet, then select MyEDIT or some other editor capable of working with .BRS files.<br />
<br />
You will notice that your new blank Custom Screen Function doesn't have any line numbers in it. This is important. When ScreenIO compiles all your individual Custom Screen Functions into one Autogenerated Screen Helper Library for each Screen, it has to add the line numbers itself, to make sure that none of them conflict with each other. Therefore, when you write Custom Screen Functions, it is important to remember not to use line numbers in your code.<br />
<br />
===== Custom Screen Function Parameters =====<br />
<br />
ScreenIO Provides several parameters automatically that you can use in your Screen Functions. If you wish to make use of a parameter, all you have to do is add it as a required parameter in your Custom Function Definition statement. ScreenIO actually checks your custom function statements to see which variables they are expecting and provides them with all the variables they ask for, as long as they are on this list:<br />
<br />
*'''Function$''' - The Function we are Calling<br />
*'''Mat F$''' - The Strings for the FileIO Record Object<br />
*'''Mat F''' - The Numbers for the FileIO Record Object<br />
*'''Mat S$''' - Your Screen Record Object<br />
*'''Mat Form$''' - Your FileIO Forms Array<br />
*'''''All your Screen Information'''''<br />
**'''Mat Screenio$''' - Your Screen Header information (Strings)<br />
**'''Mat Screenio''' - Your Screen Lines information (Numbers)<br />
**'''mat ControlName$''' - Array of the control names for all the controls on your screen.<br />
**'''mat FieldName$''' - Array of the Field Names for the associated fields of all the controls on your screen.<br />
**'''mat Description$''' - Array of the Descriptions or Caption Fields for all the controls on your screen.<br />
**'''mat VPosition''' - Array of the Verticle Position for all the controls on your screen.<br />
**'''mat HPosition''' - Array of the Horizontal Position for all the controls on your screen.<br />
**'''mat FieldType$''' - Array of the Field Types for all the controls on your screen.<br />
**'''mat SpecWidth''' - Array of the Spec Widths for all the controls on your screen.<br />
**'''mat Width''' - Array of the Widths for all the controls on your screen.<br />
**'''mat Height''' - Array of the Heights for all the controls on your screen.<br />
**'''mat TrueValue$''' - Array of the Truth Values for all the controls on your screen.<br />
**'''mat FalseValue$''' - Array of the Falsehood Values for all the controls on your screen.<br />
**'''mat Function$''' - Array of the Function triggers for all the controls on your screen.<br />
**'''mat Picture$''' - Array of the Picture Files for all the controls on your screen.<br />
**'''mat Parent$''' - Array of the Parent Attribute for all the controls on your screen.<br />
**'''mat FGColor$''' - Array of the Foreground Colors for all the controls on your screen.<br />
**'''mat BGColor$''' - Array of the Background Colors for all the controls on your screen.<br />
**'''mat Justify$''' - Array of the Justification Specs for all the controls on your screen.<br />
**'''mat Attr$''' - Array of the Additional Attribute Specs for all the controls on your screen.<br />
**'''mat Protected''' - Array of boolean flag indicating weather or not each of your controls are protected.<br />
**'''mat Invisible''' - Array of boolean flag indicating weather or not each of your controls are invisible.<br />
**'''mat Tooltip$''' - Array of the tooltip help text for all the controls on your screen.<br />
**'''mat ConvrtIn$''' - Array of the conversion values for all the controls on your screen.<br />
**'''mat ConvrtOut$''' - Not currently used.<br />
**'''mat MultiSelect''' - Array of values indicating weather or not your Listviews have Multiselect Enabled.<br />
**'''mat Userdata$''' - Array of data passed into your screen that can be used for any reason<br />
*'''mat Subscripts$''' - This array contains your FileIO Subscripts and your ScreenIO Subscripts and the sio_ subscripts for all your controls that are not tied to a field and are instead living inside your mat S$ array.<br />
*'''Key$''' - This is the Key that we called the screen with<br />
*'''[[#ExitMode|ExitMode]]''' - Set [[#ExitMode|ExitMode]] to non-zero to cause your screen to exit.<br />
*'''RepopulateListviews''' - Set this value to True in your function to cause ScreenIO to redraw the listviews when its done processing your custom function code.<br />
*'''Prefix$''' - Prefix for your FileIO Data File<br />
*'''Currentkey$''' - Currently selected key from your data file<br />
*'''rec(datafile)''' - this is obvious, but if you need to know the current record in the primary data file you can use the BR system function REC to discover it.<br />
*'''mat SelectedKeys$''' - If you have a listview with multiselect enabled, use this array to access the keys of all selected records. If Multiselect is not enabled, then this array will have only one element and it will be equivlent to CurrentKey$ above. Therefore you can use Mat SelectedKeys$ to write functions that work for both multi-select listviews and single selection listviews.<br />
*'''mat SelectedRecords''' - If you have a listview with multiselect enabled, use this array to access the record numbers of all selected records. If Multiselect is not enabled, then this array will have only one element and it will be equivlent to rec(Datafile) above. Therefore you can use Mat SelectedRecords to write functions that work for both multi-select listviews and single selection listviews.<br />
*'''mat Save_F$''' - this is an automatic copy of Mat F$ that is made upon entering the screen and can be used to determine weather or not the user has changed anything sense reading or adding the record.<br />
*'''mat Save_F''' - this is an automatic copy of Mat F that is made upon entering the screen and can be used to determine weather or not the user has changed anything sense reading or adding the record.<br />
*'''mat Save_S$''' - this is an automatic copy of mat S$ that is made upon entering the screen and can be used to determine weather or not the user has changed anything sense reading or adding the record.<br />
*'''mat PassedData$''' - this array can be used for any purpose you desire. It represents an array of data you can pass into your screen with the call to fnfm. You can query it and use it in your custom functions in whatever way you desire.<br />
*'''Parentkey$''' - The Parent Key that may have been passed into your screen when it was called. This is a value that you can pass into your screens that has no purpose except to be used in your screen functions. You can use it to filter your listview to show only records for the current Customer or whatver ParentKey makes sense to you.<br />
*'''LockUser$''' - This value is only available in the Record Locked event. It will tell you the user name of the user who has the record locked.<br />
*'''Datafile''' - This is the file number of the data file<br />
*'''Window''' - This is the window number of the screenio screen<br />
*'''FileIO Subscripts''' - All your fileio subscripts are set for you so you may use your file just as if you'd opened it yourself.<br />
*'''ScreenIO Subscripts''' - Any of your screen controls that belong in MAT S$ have a screen subscript that you can use to access them.<br />
*'''ScreenIO Control Subscripts''' - Every Control on your screen with a control name has a subscript that can be used to access its properties in the Screen Control Arrays above. For example, if you have a text box named "Customer" and you want to make it invisible in one of your custom helper functions, then give the command: "let Invisible(ctl_customer)=1"<br />
*'''CurrentRow''' - this variable contains and controls the currently selected listview element. You can use it to determine which listview item is currently selected, and if you change this value it will change the current row in the listview. You can use this value to control the cursor on a listview screen.<br />
*'''Currentfield''' - This is the CurFld Value of the field which the cursor is in. If you change it, it will move the cursor around.<br />
*'''Currentfield$''' - This is Control Name of the Control for the field which the cursor is in. You can move the cursor by setting CurrentField$ to the ControlName$ of the field you want to move it to. This is case insensitive. If you change both CurrentField$ and CurrentField, the CurrentField$ change takes precedence.<br />
*'''''Only Available in Validate and Conversion Functions''''' - these next parameters are only available in Validate and Conversion functions. Most of them are read only (any changes to them will be ignored) and they should be used to make your custom Validation and Conversion functions reusable:<br />
**'''Fieldtext$''' - This is the text in the field being validated/converted.<br />
**'''Fieldindex (read only)''' - This is the CurFld value of the field being validated/converted. You could use this to put the cursor in the bad field by saying ''"CurrentField=FieldIndex"''.<br />
**'''ControlIndex (read only)''' - This is the index (matches ctl_controlname) of the Control for the field being validated/converted. You can use this anywhere that you can use ctl_controlname, for example to access the Attributes arrays of the control. For example, you can make the control invisible by saying ''"Invisible(ControlIndex)=1"''.<br />
<br />
===== Accessing Control Properties from within your Helper Functions =====<br />
If you wish to access any of your controls' attributes from a custom helper function, you first have to define the control by giving it a ControlName in the Control Attributes Window. Then, all you have to do is reference the array of the attribute you're looking for, with the control name for a subscript, prefixed by "ctl_". For example, to make the customer control invisible, simply type:<br />
<br />
let Invisible(ctl_customer)=1<br />
<br />
===== #Include Statement =====<br />
Sometimes it is necessary to reference one of your custom helper functions from another one. But when you do, you need a way to ensure that its always included in any screens that call the first custom helper function. The way to do that is with the #Include statement. You use this statement in a comment, so that BR will ignore it. Simply say:<br />
<br />
! #Include {functionname}<br />
<br />
in a comment somewhere in your program and the specified custom helper function will be included. The "{}"s are mandatory and are part of the syntax for specifying a Custom Helper Function anywhere in ScreenIO.<br />
<br />
===== Examples =====<br />
<br />
====== Validate Field Function ======<br />
<br />
NOTE: ScreenIO has this functionality built in now, so you shouldn't need to validate your dates this way. Its only included here as an example for how a validate function works.<br />
<br />
For more information on the proper way to work with dates in ScreenIO, see the [[#Conversion_Function|Conversion Function]] section.<br />
<br />
! function\validatedate.brs<br />
!<br />
! Created on 01/12/2009<br />
!<br />
! This function would be placed in every field in the SageLive system that accepts a date.<br />
! <br />
!<br />
def fnvalidatedate(&fieldtext$;___,DateValue) <br />
let DateValue=days(fieldtext$,"mm/dd/ccyy") conv BadDateEntered<br />
<br />
let fieldtext$=date$(DateValue,"m/d/ccyy")<br />
let fnvalidatedate=1 ! Date Save Successful <br />
<br />
BadDateEntered: ! a bad date was entered. Return False so that ScreenIO Places the old value back.<br />
fnend<br />
<br />
====== Listview Filter Function ======<br />
<br />
! function\filtertasks.brs<br />
! Created on 04/17/2009<br />
!<br />
! fnFilterTasks - This Function Filters the Tasks List to show only<br />
! tasks for the Current Employee that are not completed or cancelled. <br />
! It also colors the tasks, and sets the task_status Listview Column.<br />
!<br />
! This function is the filter event for the Todo List listview in the SageLive System<br />
!<br />
dim CurrentEmployee$<br />
<br />
def fnFilterTasks$(mat f$,mat f,ParentKey$,prefix$,mat Subscripts$,mat S$)<br />
<br />
if CurrentEmployee$="" then<br />
library "timelib" : fnCurrentEmployee$<br />
let CurrentEmployee$=fnCurrentEmployee$<br />
end if<br />
if uprc$(ParentKey$(1:7))="SHOWALL" then<br />
if f$(todo_employee)=CurrentEmployee$ then<br />
let fnFilterTasks$="/#00FF00:#000000"<br />
else<br />
let fnFilterTasks$="/#0000FF:#000000"<br />
end if<br />
else if f$(todo_employee)=CurrentEmployee$ and f(todo_cancel)=0 and f(todo_complete)=0 then<br />
let fnFilterTasks$="/#33CC66:#000000"<br />
if sio_taskstatus then let s$(sio_taskstatus)="X" ! Open<br />
else if f$(todo_employee)=CurrentEmployee$ and f(todo_cancel)=0 and f(todo_complete)=days(date$) then<br />
let fnFilterTasks$="/#6699FF:#000000"<br />
if sio_taskstatus then let s$(sio_taskstatus)="Y" ! Completed<br />
else if f$(todo_employee)=CurrentEmployee$ and f(todo_cancel)=days(date$) and f(todo_complete)=0 then<br />
let fnFilterTasks$="/#AA0000:#000000"<br />
if sio_taskstatus then let s$(sio_taskstatus)="Z" ! Cancelled<br />
end if<br />
fnend<br />
<br />
====== Click Event Function ======<br />
<br />
! function\quickinvoiceacustomer.brs<br />
! Created on 03/30/2009<br />
!<br />
! fnQuickInvoiceACustomer - This Function automatically creates an invoice<br />
! for a customer.<br />
!<br />
! This function is placed in the Click Event for the "Invoice Customer" button on the<br />
! Customer Listview Screen in the SageLive system.<br />
!<br />
! It operates on the currently selected item in the listview by using the<br />
! value of CurrentKey$<br />
! <br />
! Most of the actual processing takes place in various libraries that are part<br />
! of the SageLive system.<br />
<br />
dim Invoice$(1)*255,Invoice(1)<br />
<br />
def fnQuickInvoiceACustomer(CurrentKey$,DataFile,mat Form$)<br />
library "invclib" : fnBuildInvoiceHeader,fnAddCustomerToInvoice,fnImportCustomer, fnPrintInvoiceByData<br />
<br />
let Invoice=fnOpen("invoice",mat Invoice$,mat Invoice,mat Form$)<br />
<br />
let fnBuildInvoiceHeader(Invoice,mat Invoice$,mat Invoice)<br />
let fnAddCustomerToInvoice(CurrentKey$,mat Invoice$,mat Invoice,DataFile,mat form$)<br />
let fnImportCustomer(CurrentKey$,Invoice$(ih_id))<br />
let fnPrintInvoiceByData(mat Invoice$,mat Invoice,1)<br />
<br />
write #Invoice, using form$(Invoice) : mat Invoice$, mat Invoice<br />
let fnCloseFile(Invoice,"invoice")<br />
<br />
let fnfm('INVCEDIT',Invoice$(ih_id))<br />
fnend<br />
<br />
The first function called, fnBuildInvoiceHeader, populates the Invoice Header information with the current date and the next available invoice number, etc.<br />
<br />
The next two functions, fnAddCustomerToInvoice and fnImportCustomer add the customer to the invoice, automatically searching the database for any billable work that has been completed, and adding it to the invoice. They also mark the timelog records as "Billed", and mark the invoice number in the timelog record showing which invoice each timelog entry ended up on. At the same time, they populate the Invoice Header record with important information such as Billing Address, Shipping Information, Payment Terms, etc.<br />
<br />
The next function, fnPrintInvoiceByData generates the invoice as a PDF file. It automatically detects if we're running BR 4.2 or 4.1. If we're running BR 4.1, then it generates the PDF file using the CutePDF Printer Driver and a short AutoIt Script. If its BR 4.2, then it uses the built in PDF generation ability. The optional parameter 1 at the end specifies to generate the PDF file. The same function could be used to print the invoice on a standard printer using Print Preview and the windows Printer selection dialog.<br />
<br />
After that we write the new invoice to the database, and the file is closed.<br />
<br />
Finally, the Edit Invoice screen is called, and the new invoice is displayed to be reviewed and emailed to the customer.<br />
<br />
When the user is finished looking at the invoice, we return to what we were doing in the customer screen.<br />
<br />
====== Mainloop Function ======<br />
<br />
Now lets take a look at how to use the Mainloop Function to respond to various keys.<br />
<br />
! function\tabsmainloop.brs<br />
! Created on 02/21/2010<br />
!<br />
! fnTabsMainloop - This Function This Function updates the Current Potential<br />
! elements of the Screen (if they exist)<br />
!<br />
! This function appears in many of the SageLive screens, to enable the Windows Dropdown Menu.<br />
! it also does a few other things for some of the screens it sits in.<br />
!<br />
! #Include {executetask}<br />
! #Include {tabwindowsmenu}<br />
<br />
def fnTabsMainloop<br />
if fkey=98 then let fnProcessWindowsMenu ! Fkey 98 is Windows Menu Click<br />
if fkey=0 or fkey=201 then let fnSelect ! Fkey 0 is Enter and Fkey 201 is Double Click<br />
<br />
if sio_current_potential or sio_current_week_now or sio_current_week_poten then let fnUpdateCurrentPotential<br />
fnend<br />
<br />
def fnSelect<br />
if lwrc$(screenio$(si_screencode))="tabwork" then<br />
let fnfm("projedit",CurrentKey$)<br />
else if lwrc$(screenio$(si_screencode))="tabtodo" then<br />
if todo_function and len(trim$(f$(todo_function))) then<br />
let fnExecuteTask<br />
else<br />
let fnfm("taskedit",CurrentKey$)<br />
end if<br />
else if lwrc$(screenio$(si_screencode))="tabincome" then<br />
let fnfm("invcedit",CurrentKey$)<br />
else if lwrc$(screenio$(si_screencode))="tabexpense" then<br />
let fnfm("expnedit",CurrentKey$)<br />
else if lwrc$(screenio$(si_screencode))="tabcustomer" then<br />
let fnfm("custedit",CurrentKey$)<br />
end if<br />
if fkey<>93 then let fkey(-1) ! Reset Fkey after whatever they've done except Windows X<br />
let Function=-1<br />
let ExitMode=0 ! Don't exit after procesing Enter Key<br />
fnend<br />
<br />
The fnTabsMainLoop function is used here to check for various special function keys that we want to do something special for, as well as to do any processing that we wish to run as often as possible.<br />
<br />
The first thing it does is test for and respond to a Windows Dropdown Menu click (fkey 98). If a selection is made from the Windows Dropdown Menu, the SageLive Windows Menu handler is called. This Windows Menu Handler function resides in another Custom Function which we include using the #Include screenio command. This command is used any time one of your custom functions depends on another custom function.<br />
<br />
<br />
After that we check for the Enter Key (fkey 0) or a Double Click (fkey 201). The default action in ScreenIO for the enter key, is to select the current item from the list and return it to the calling code, exiting the screen. But for many of the listveiws in the SageLive system, we wanted to do something different. In many cases we wanted to view or edit the item selected, and in one case, the SageLive Todo List, we wanted to do something really special.<br />
<br />
We're testing for fkey 201 because I also want double clicking on a listview item to preform our special "Selection" routine.<br />
<br />
Because this function is used in many different screens, and they each display different information and require a different action, I chose to place the code that handles the event inside another function, fnSelect.<br />
<br />
FnSelect tests the value of the ScreenCode in mat ScreenIO$ to see which screen we're in, and handles the click accordingly. For example, if we're on the Customer screen, then double clicking launches the Customer Edit screen, displaying the current customer record. If we're on the Expense Screen, then we want to launch the Expense Edit screen to view or edit the Expense Record.<br />
<br />
<br />
The SageLive Todo List contains one special feature. Todo List Items can have code in them, a function that gets executed automatically to help with the task. For example, the automatic task that comes up each month to remind me to enter the electric bill has code in it that helps me enter the electric bill as an expense into the system.<br />
<br />
When I run that task, SageLive automatically launches my electric bills website for me, right at the login prompt. Then it waits with an autoit script for me to print the latest bill from their webpage. I select "Print Bill" from the electric companies website, and the bill is snatched right from the print stream and uploaded into SageLive. I read and enter the amount on the bill, and the rest is done for me.<br />
<br />
Here you see where we call the ExecuteTask function responsible for that piece of magic, whenever an item is selected on the SageLive Todo List. If the Task we selected has code in it, then we run the code, executing the task. If it does not have code in it, then we simply launch the Task View screen where the text in the Todo List item can be read in a multi-line text box.<br />
<br />
<br />
At the end of the fnSelect Routine is code to reset the fkey value and to cancel the default action for the Enter key (which is to select and quit). Fkey 93 is the Windows X, and in ScreenIO it means to exit every screen that we're in (prompting to save any changes) and if your original calling program that launched the first screen responds to it properly, close BR. So we want to leave fkey 93 alone but cancel any other fkey values that might have come back from the screen we jumped into.<br />
<br />
<br />
After handling the special keys, our fnTabsMainLoop function handles the fnUpdateCurrentPotential. Some of the screens in the SageLive system have a little place where they show the Current Employee's Current Potential Earnings. This function is called from lots of screens and only a few of those have the Current Potential Display, so the first thing we do is test to see if the screen we're currently in has the Current Potential fields on it. <br />
<br />
The Current Potential Fields is a calculated approximation of how much money the Current Employee has earned so far today, and how much money they can potentially earn if they continue to work until 6pm.<br />
<br />
It was intended to be a motivational tool, but its mentioned here as an example of a situation where you might want to update some data on the screen as often as possible. Because the Current Earnings are always going up whenever the employee is currently logged in on a project, and the Potential Earnings are always going down whenever the employee is not logged in on a project, we want to try to update it as often as we can.<br />
<br />
The mainloop is called every single time ScreenIO gets control and the RINPUT FIELDS statement ends. The Screens with Current Potential fields are all listview screens with the X attribute specified for the listview, making it so that any time the user scrolls around the list, presses the fkey, clicks on any button or does just about anything at all, the Current Potential is updated. You can even use this in combination with the Wait Time value to force a regular update of the screen.<br />
<br />
===== ScreenIO Built In functions =====<br />
ScreenIO has a built in function for use in your events.<br />
====== FnFindSubscript ======<br />
FnFindSubscript(mat Subscripts$,Prefix$,String$)<br />
This function searches through the array mat Subscripts$ looking for the subscript that matches the given Prefix$ and Subname$. It returns the index of this subscript.<br />
<br />
Use this function to programmatically interrogate mat Subscripts$ from your Custom Functions in order to help make them more reusable.<br />
<br />
===== Mat S$ =====<br />
Lets go over a couple of ScreenIO Concepts one more time.<br />
<br />
Most of the controls on the screen are tied directly to a field in the data file. In your Custom Validation Functions, you can refer to that data by its FileIO Name.<br />
<br />
let msgbox("Customer Name is "&f$(cu_Name))<br />
<br />
The value in your mat F$ and mat F is the same as the value on the screen. It is the value of the disk record in memory. When the record is saved, mat F$ and mat F are rewritten back to the data file.<br />
<br />
However, any of your controls that are NOT tied to a data file, (but still have a control name) get placed in another array: Mat S$<br />
<br />
A Control is tied to the data file if it has a value for its FieldName. Mat S$ contains the data for all the controls that have no value for "FieldName" but do have a value for "ControlName".<br />
<br />
You can access them the data in Mat S$ by giving the screenIO subscript for the control, which is sio_ControlName where ControlName is the actual name of your control.<br />
<br />
read #CustomerFile, using form$(CustomerFile), key=f$(ih_customer) : mat Customer$, mat Customer<br />
let S$(sio_CustomerName)=Customer$(cu_FirstName)&" "&Customer$(cu_LastName)<br />
<br />
You can use this feature to have additional input fields that the end user is able to interact with that don't necessarily correspond directly with a field in the data file. Your Custom Functions can react to the mat S$ fields and they can also update the Mat S$ fields.<br />
<br />
You can use a Mat S$ field to set the picture file for a picture control, to something that is calculated in a Custom Function at runtime.<br />
<br />
===== ExitMode =====<br />
<br />
One common thing you might do in a custom function, or directly in one of your controls Function properties is set ExitMode. ExitMode is a variable you can change with your custom functions. It governs when your screen is finished executing.<br />
<br />
ExitMode can have the following values:<br />
<br />
*ExitMode=0 .... When ExitMode is 0 the screen keeps running. You can cancel an ExitMode by setting it back to 0.<br />
*ExitMode=SaveAndQuit .... When ExitMode is SaveAndQuit then the screen stops running and the data is saved and the key of the new record is returned. Use this on an Add/Edit Screen.<br />
*ExitMode=SelectAndQuit .... When ExitMode is SelectAndQuit then the screen stops running and the key of the currently selected listview item is returned. Use this on a Listview Screen.<br />
*ExitMode=QuitOnly .... When ExitMode is QuitOnly the screen stops running and the users data is not saved, and nothing is returned.<br />
*ExitMode=QuitOther .... QuitOther works the same as SelectAndQuit. You can use it if you need to implement your own custom Exit logic.<br />
*ExitMode=AskSaveAndQuit .... AskSaveAndQuit will check to see if the user has changed anything. If they have, it will ask the user if they'd like to Save or just Quit, and behave accordingly. If the user hasn't changed anything, it will just quit.<br />
<br />
To set ExitMode in one of your functions, simply assign it a value from the list above.<br />
<br />
====== ScreenIO ExitMode Constants ======<br />
SaveAndQuit, SelectAndQuit and all the other values above are ScreenIO ExitMode Constants. The ScreenIO ExitMode Constants are set for you in your custom helper library in order to help facilitate the readability of your ScreenIO Code. The values are set with code such as the following, and even inside ScreenIO they're tested for by name.<br />
<br />
let Quitonly=1<br />
let Saveandquit=2<br />
let Selectandquit=3<br />
let Quitother=4<br />
let Asksaveandquit=5<br />
<br />
=== Working with the ScreenIO Loading Icon ===<br />
<br />
ScreenIO comes with an Animated Loading Icon that automatically appears whenever a listview takes a long time to load. This tells the user that something is happening, so they know its not just hung.<br />
<br />
You don't have to do anything to your screens to use the loading animation. It automatically happens whenever a listview takes more then a couple seconds to load.<br />
<br />
==== Changing the Loading Icon ====<br />
<br />
ScreenIO comes with two different animtated loading icons: A Modern Clock and a Grandfather Clock.<br />
<br />
If you look in the "clocks" folder that came with ScreenIO, you'll see three folders: "clock", "grandfather clock" and "kitchen clock". ScreenIO ignores all the other folders, and only looks inside the "clock" folder.<br />
<br />
To change which clock you want to use, simply delete the contents of the "clock" folder and replace them with the contents of the one of the other folders, the one containing the clock of your choice.<br />
<br />
==== Making your own clock animations ====<br />
<br />
Its very simple to make your own clock animations. All you have to do is place a bunch of image files in a folder, depicting the different steps of the animation. They can be either jpg's or gif's. You can have as many files as you want, and they can be any resolution you want, but keep in mind that large animations may run slow in network or internet environments. If you intend to run your software over a network share, or over Client Server, you may wish to stick to reasonably sized files. You can get plenty of detail for a loading animation out of a 2k image file.<br />
<br />
Gif files are particularly nice to work with because they support transparency, so your loading clock doesn't have to be square.<br />
<br />
ScreenIO reads all the images in the clocks\clock folder and sorts them alphabetically, then plays them in a loop. The timing and size and color of the animation window is controlled via the clock.ini settings file.<br />
<br />
===== The clock.ini settings file =====<br />
<br />
In your clock folders, you'll see a clock.ini settings file. Its a very short csv file containing five fields in order. All of the fields are optional. The Clock.ini file itself is optional, in fact. If the file is not found, or any of the values are missing, then default values are used.<br />
<br />
The five parameters, and their default values are as follows:<br />
<br />
#) Animation Speed (.5) - This is the Animation Speed, in seconds of delay. The default value will update the animation every half second. Use a lower value for a smoother animation, but be careful, if you use too low of a value you can slow down the processing of the listview. This number should be specific to the animation you're using. If your frames are very different from each other you'll want a high value like .5 or .6. If the frames are only changed slightly from each other, and you have a lot of them, then you might want the animation to play faster, like .1 or .2. An animation speed of 0 will force it to update as often as possible, which is one frame each time another chunk of data is sent to the listview.<br />
#) Rows (5) - The size of the animation window in Rows.<br />
#) Cols (10) - The size of the animation window in Columns.<br />
#) Color$ (inherited) - The BR color for the animation window. If present, this parameter is what goes in the "N=" part of the open statement. The default of none causes BR to use the default or inherited colors for the animation window.<br />
#) Border$ (no border) - The BR border string for the animation window. This can be used to add or color a BR border.<br />
<br />
==== Submitting your clock animations ====<br />
<br />
If you've made a nice clock, and you'd like to submit it to be included in future releases of ScreenIO, please zip the entire clocks folder and email it to me at gabriel.bakker@gmail.com. I welcome and encourage your submissions, and I look forward to seeing the beautiful loading clocks that you come up with.<br />
<br />
<br />
=== Keyboard Reference (Undo/Redo, Copy/Cut/Paste and more) ===<br />
When using ScreenIO, there are several ways to control the designer with the keyboard. Almost any function can be accessed from the Windows Dropdown Menu, which you can get to from the keyboard by using the Alt key in combination with the underlined letters in the Menu, and with the arrow keys.<br />
<br />
You can also use following keyboard shortcuts any time in the ScreenIO Designer.<br />
<br />
Ctrl-V .. Paste Controls<br />
Ctrl-X .. Cut Controls<br />
Ctrl-C .. Copy Controls<br />
Alt-Z ... Undo<br />
Alt-R ... Redo<br />
<br />
You can use standard keys for Copy, Cut, and Paste in screenio. Copy and Cut act on the current controls and copy them to the clipboard. They are copied to the clipboard in plain text, so its possible to paste them in notepad and then later select them and copy and paste them back into another ScreenIO screen. You can use the clipboard the same way you would expect to use it in any windows program.<br />
<br />
Alt-Z and Alt-R Undo and Redo the last operations. You can use them any time in ScreenIO. The only reason its not the standard Ctrl-Z and Ctrl-R is because BR reacts better to Alt-Z and Alt-R.<br />
<br />
==== Screen Control Movement Mode ====<br />
The following controls work in Control Movement Mode Only<br />
<br />
Lf ...... Move the control left<br />
Rt ...... Move the control to the right<br />
Up ...... Move the control up<br />
Dn ...... Move the control down<br />
Space ... Make the control Wider<br />
BkSp .... Make the control narrower<br />
PgDn .... Make the control taller<br />
PgUp .... Make the control shorter<br />
Enter ... Cycle through the Control Attributes and Movement Mode<br />
Del ..... Delete the selected control from the screen<br />
Ctrl-S .. Toggle Selection for current control<br />
Ctrl-T .. Select All Textboxes<br />
Esc ..... Unselect all or exit the current control<br />
Ctrl-E .. Make all Left Edges of selected controls match the current control<br />
Ctrl-R .. Make all Right Edges of Selected Controls match the current control<br />
Ctrl-W .. Make all Widths of selected controls match the current control<br />
<br />
===== Selecting Multiple Controls =====<br />
<br />
You can use CTRL-S to toggle the selection of the current control, turning it Green, building a group of selected controls. Once you have a bunch of controls selected you can change their attributes or position as a group, instead of having to work with them one at a time.<br />
<br />
To select a group of controls, simply click on the controls you want to select one at a time, and press CTRL-S between each click to select them.<br />
<br />
The easiest way to learn about control grouping is to try it out. Save your screen and experiment with selecting several controls to see what happens.<br />
<br />
The current control will always appear in yellow, and all the controls in the currently selected group will appear in green.<br />
<br />
If you move any control, the other selected controls will move with you. You can retain the selection outside of control movement mode but you must be in control movement mode in order to change the selection. Outside of control movement mode the only effects that are shared with the group Copy and Cut, and changing properties. If you change any control properties while there is a selected control group, then a message box will appear asking if you would like to copy the changes to all selected controls in the group.<br />
<br />
''You can also move controls around the screen with the mouse. For more information on Mouse Movement, see the chapter on [[#Click_to_Move_Control_Movement|Mouse Movement]].''<br />
<br />
==Update Process==<br />
<br />
If you used an older version of ScreenIO and updated it to a newer version and you recieved a message from ScreenIO saying that it needs to recompile your helper libraries and update your folder structure, thats because we have recently moved all your ScreenIO Helper Libraries into their own subdirectory, in order to keep from cluttering up your main installation directory as much as possible.<br />
<br />
If you do not get this message when updating, don't worry about it. Chances are you were already running with a newer version of ScreenIO. But if you do get this message, then here is a little more information about what it is and what it means.<br />
<br />
Your ScreenIO Helper Libraries have been moved into a new folder called 'screenio\'. If you referenced any of these files in your existing code, you may need to update those references. We have generated this brconfig file of substitution statements to aid in this process. To use it simply add 'include screenio\screenio.sys' to your brconfig.sys file.<br />
<br />
WARNING: If any of the following substitution statements conflict with one of your file names you will not be able to use them. Carefully inspect these files to ensure they do not conflict with the names of any of your data files. If they do, you will not be able to use the substitution statements because they will affect your data files as well as your program name references. You will have to remove those lines from this file before using this file, and manually fix all the references in your existing code to any programs who's names conflict with your data files.<br />
<br />
If you have any questions about this process, contact Gabriel Bakker at gabriel.bakker@gmail.com.<br />
<br />
== Future Changes ==<br />
A partial list of future changes for ScreenIO has been added here. If any of you have a feature in mind that you'd like to see and its not already listed here, feel free to add it. I will remove the features from the list as they are implemented in ScreenIO.<br />
<br />
=== New Future Change Requests ===<br />
All currently requested features have been implemented. If you have a feature in mind you'd like to see, feel free to post it here, and also please notify gabriel.bakker@gmail.com. When I have finished implementing the feature, i'll remove it from the list that you make here.<br />
<br />
*Add your Feature<br />
*Requests Here<br />
<br />
=== Completed Future Change Requests ===<br />
<br />
The following list of change requests has been completed.<br />
<br />
*Additional Parameters in fnfm for Interacting with Screens, that get passed both in and out of your new screen.<br />
*Non-Data Screens - the ability to call fnfm with your own mat F$ and mat F and have it work with your passed in data instead of automatically reading and writing from your data file.<br />
*True Numeric Fields in Listviews supported with BR 4.2<br />
*Numeric Fields on regular Text Box Controls<br />
*Mainloop event to support custom keys<br />
*Error Handling Improvement<br />
*Animated "Loading Icon" for populating Large Listviews<br />
*Group Movement/Alignment of controls<br />
*Copy and Paste of Controls from one screen to another screen<br />
*Group Copy and Paste of Controls<br />
*ScreenIO Helper Libraries in a special folder<br />
*ScreenIO itself in a special folder<br />
*Add the "-d" option to the ScreenIO Screenfld file to keep it from growing huge after some time<br />
*Additional Field level Properties in Screenflds for Programmers to use for things<br />
*Support for TIMEOUT and WAIT in BR - Perhaps these should be events as well<br />
*Advanced Filtering of a Listview - using the proper index to make it run faster<br />
<br />
[[Category:Utilities_Third_Party]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=FileIO_Library&diff=3449FileIO Library2013-06-19T03:08:24Z<p>Admin: 1 revision</p>
<hr />
<div>At the April 2006 [[BRGroup Conference]], [[User:Gabriel|Gabriel]] spoke to many of us about a new revolution in BR '''FileIO''' management. This topic generated so much interest that he was asked to present it again at the Fall Conference. There were also many suggestions for improvements to the library.<br />
<br />
The FileIO Library began as a project to find a way to reduce the headache associated with making changes to your data files. In my experiences working for [[BRC]], I had to make a change to the commun file, a data file that stores information about communication with EDI VANs. I added some new fields, and removed a couple of old fields, and then I began searching through the BRC program suite to find and modify each program that referenced this data file in order to update it with the proper new form statement. This task quickly became daunting as I noticed that out of BRC’s program suite of over 600 programs, more then 1/3rd of them referenced the commun file. With 223 programs to modify, the task was given up as hopeless and tabled indefinitely.<br />
<br />
I am happy to announce that we have solved this problem. When I have to make a change to a data file layout for my customers today, I can complete the task in under 1 minute, and none, not one single one of my programs needs to be changed in order to still work with the new file layout. In fact, I don’t even have to update my customer’s data files, as the FileIO library takes care of this for me as well.<br />
<br />
The trick is to define your file layouts in an ASCII text file layout file that I will tell you about in a minute. The FileIO Library will actually parse through your file layouts, and it will instruct your programs how to read the data file, so that you don’t have to. It will also automatically detect when you make changes to the file layout, and it will update your customer’s data files on the fly to make sure they have the latest version. Finally, it even contains a DataCrawler that you can use to examine the contents of any of your BR data files in a raw format.<br />
<br />
[[FileIO 2]] Improves upon FileIO in many ways. For information on FileIO 2, see the [[FileIO 2]] page.<br />
<br />
For more information about the FileIO Library visit the [http://www.sageax.com/products/fileio-library/ Sage AX Website]<br />
<br />
To download the latest copy of FileIO, click [http://www.sageax.com/downloads/FileIO.zip here.]<br />
<br />
== The Method ==<br />
I have created a file IO library that parses a formatted text file layout and uses this information to structure the opening and initializing of the reading of a file “object”. The word object here is used to refer to all the data in a given record in one of your files. This library is easy to use, and provided you follow some simple standards, it will simplify your lives immensely.<br />
<br />
=== File Object Arrays ===<br />
<br />
First, in your program you must create two matrices to store the file information. If we are dealing with the Color File these would be MAT COLOR$ and MAT COLOR. One will store all the string information about a color, and the other will store all the numeric data. Our working example will involve two files: a Color File and a Color Category File. You should dimension these to:<br />
<br />
01030 DIM color$(1)*255,color(1)<br />
01040 DIM colorcat$(1)*255,colorcat(1)<br />
<br />
=== Forms Array ===<br />
<br />
You will also need a variable to store the form statement associated with reading the files. This form statement will be dynamically generated whenever a new file is opened. It will say: <br />
<br />
01020 DIM form$(1)*255<br />
<br />
=== Library Linkage ===<br />
<br />
You will also need the library call:<br />
<br />
02020 library "fileio.br": fnopenfile, fnreaddescription$<br />
<br />
=== fnOpen Function ===<br />
<br />
Now, a simple function placed into all your files will simplify one aspect of this. Because BR libraries do not share variables with the programs they are called from, we will need to execute a simple proc file whenever we open a file to set the names of all our variables after we return. Create an FnOpen that calls the library version and runs the proc file when we are done. Notice the $$$ at the end of the procfile name. This will tell the procfile to self-destruct after execution. Since this procfile is used simply to return variable information back from the library to the main program, we don’t need it sitting around collecting dust.<br />
<br />
99010 OPEN: ! ***** Function To Call Library Openfile And Generate Subs<br />
99020 def Fnopen(Filename$*255, Mat F$, Mat F, Mat Form$; Inputonly, Keynum, Dont_Sort_Subs, Path$*255, Mat Descr$, Mat Field_Widths)<br />
99030 dim _FileIOSubs$(1)*800<br />
99040 let Fnopen=Fnopenfile(Filename$, Mat F$, Mat F, Mat Form$, Inputonly, Keynum, Dont_Sort_Subs, Path$, Mat Descr$, Mat Field_Widths, Mat _FileIOSubs$)<br />
99050 for Index=1 to udim(mat _FileIOSubs$) : execute (_FileIOSubs$(Index)) : next Index<br />
99060 fnend<br />
<br />
=== Using FileIO in Your Programs ===<br />
<br />
Now you are ready to process files. You simply open the file by saying:<br />
<br />
04020 let colorfile=fnopen("color",mat color$,mat color,mat form$)<br />
04030 let colorcatfile=fnopen("colorcat",mat colorcat$,mat colorcat,mat form$,1)<br />
<br />
These statements tell the File Library to look in the filelay folder to find the file layout for the Color File, and read it to find out what the Color File looks like. Then Open the Color File, and set MAT COLOR$ and MAT COLOR to the correct size to hold an entire color record. Finally, it will define several variables that we can use as pointers in these arrays to read the data we want to see, and it will place the file handle into a variable called colorfile.<br />
<br />
The second line above will do the same thing to the routing file, except the 1 parameter tells the function to open readonly. Because of the extra function we inserted into our program earlier, the subscripts array will be executed, creating the subscripts in memory, and the pointers (subscripts) will be set in the returned program. So, if I had a file layout such as the following:<br />
<br />
color.dat, CO_, 1<br />
color.key, CODE<br />
recl=127<br />
===================================================<br />
CODE$, Color Code, C 6<br />
NAME$, English Name for Color, V 30<br />
CATEGORY$, General Category of Color, C 6<br />
HTML$, HTML Code for the Color, C 6<br />
<br />
Then the functions would do the same thing as the following individual lines of code (assuming the next available file handle was 5):<br />
<br />
DIM FORM$(5)*255<br />
DIM COLOR$(9)*255, COLOR(1)<br />
OPEN #5: “Name=color.dat, kfname=color.key”,internal,outin,keyed<br />
LET FORM$(5)=”form C 6,V 30,V 6,C 6”<br />
LET FORM$(5)=CFORM$(FORM$(5))<br />
LET COLORFILE=5<br />
CO_CODE=1<br />
CO_NAME=2<br />
CO_CATEGORY=3<br />
CO_HTML=4<br />
<br />
Now we can read the file:<br />
<br />
30120 read #colorfile, using form$(colorfile) : mat color$, mat color eof Ignore<br />
<br />
<br />
and use the data:<br />
<br />
30180 LET ColorCode$=color$(co_Code) !:<br />
LET ColorName$=color$(co_Name)<br />
<br />
<br />
<br />
The data is used by referencing the file array, with the subscript name, so the color’s description becomes color$(co_Name).<br />
<br />
In the old days, if we wanted to change the file layout of our file, all of the programs that used that file would have to be changed one at a time to use the new file layout. Also, if the order of the fields changed, then all the programs would have to also be changed to use the new fields.<br />
<br />
But now, using this function, we can change the file layout all we want. If we later want to insert a field into the file layout before color name, I won’t have to look at this program again; this program will just work fine, because the library tells it which fields to use.<br />
<br />
Also, the code is easier to read and maintain.<br />
<br />
=== Example ===<br />
The whole thing looks like this:<br />
<br />
01025 ! Dimension the Arrays<br />
01030 DIM color$(1)*255,color(1)<br />
01040 DIM colorcat$(1)*255,colorcat(1)<br />
01050 DIM form$(1)*255<br />
02000 !<br />
02020 library "fileio.br": fnopenfile, fnreaddescription$<br />
04020 let colorfile=fnopen("color",mat color$,mat color,mat form$) ! Open the file<br />
05000 ! <br />
30120 read #colorfile, using form$(colorfile) : mat color$, mat color eof Ignore ! Read the file<br />
30180 LET ColorCode$=color$(co_Code) !:<br />
LET ColorName$=color$(co_Name) ! Use the data by referincing it in the file arrays<br />
80000 !<br />
90000 ! Every program using fileio needs the following code<br />
99010 OPEN: ! ***** Function To Call Library Openfile And Generate Subs<br />
99020 def Fnopen(Filename$*255, Mat F$, Mat F, Mat Form$; Inputonly, Keynum, Dont_Sort_Subs, Path$*255, Mat Descr$, Mat Field_Widths)<br />
99030 dim _FileIOSubs$(1)*800<br />
99040 let Fnopen=Fnopenfile(Filename$, Mat F$, Mat F, Mat Form$, Inputonly, Keynum, Dont_Sort_Subs, Path$, Mat Descr$, Mat Field_Widths, Mat _FileIOSubs$)<br />
99050 for Index=1 to udim(mat _FileIOSubs$) : execute (_FileIOSubs$(Index)) : next Index<br />
99060 fnend<br />
<br />
== File Layouts ==<br />
Now let me demonstrate the anatomy of a properly formatted file layout. These should be placed in a subdirectory called filelay.<br />
<br />
price.dat, PR_, 1<br />
price.key, FARM<br />
price.ky2, ITEM<br />
price.ky3, FARM/ITEM/GRADE<br />
recl=127<br />
===================================================<br />
FARM$, Farm Code (or blank), C 4<br />
ITEM$, Item Code, C 4<br />
GRADE$, Quality, C 4<br />
X, Empty, X 37<br />
PRICE, Default Price, BH 3.2<br />
COST, Default Cost, BH 3.2<br />
XOPRICE, Default Christmas Price, BH 3.2<br />
XOCOST, Default Christmas Cost, BH 3.2<br />
MOPRICE, Default Mothers D Price, BH 3.2<br />
MOCOST, Default Mothers D Cost, BH 3.2<br />
VOPRICE, Default Valentine Price, BH 3.2<br />
VOCOST, Default Valentine Cost, BH 3.2<br />
DESCRIPTION$, Description of Price Rule, C 30<br />
<br />
The first line contains the name of the Farm File, a unique prefix to add to all your subscript index pointers, and the file version number. The subscript value is to ensure that the program knows the difference between the Farm File’s Farm Code, and the Route File’s Route Code. (One will be RT_CODE and the other is FM_CODE). These are separated by a comma. Spacing does not matter, so adjust your spacing so that it looks nice.<br />
<br />
The Version number is used to determine when the data has changed, and an update needs to be made to your data file. Your file layouts should all start at version 0, and each time you want to make a change, you may increment this value by 1.<br />
<br />
If you look in the filelay folder, you will notice several files ending with a number. For example, you may see a color, a color.0, and a color.1 file. If you run the function and it can not find your data file (usually because this is a new file and it hasn’t been created yet), the function library will automatically create your file, based on the information you give in the first part of the file layout. Also, whenever you make changes to your file layout, the function library will automatically update the data files on disk for you. It does this by renaming the old file, creating a new one with the new version number, and then copying the data from the old one to the new one a record at a time.<br />
<br />
Any time it creates a file, or updates the file on disk, it creates a backup of the file layout. The first time you run a program that tries to read your new data file, it will create the data file for you and make a backup, and if the number in your file layout is 0, then it will create, for example, a filelay\price.0 file, a backup of your file layout that the library uses to figure out what has changed the next time you try to update the file.<br />
<br />
If you wish to make any changes to this data file, first you increment the version number, (in this case make the 0 into a 1). Then change the file layout all you want. You may rearrange fields, add new fields, add or remove keys, or change the record length.<br />
<br />
Each time you try to open a file with the library, it reads the file version number of the file on disk (using the BR version() function), and then it compares it to the version number in your file layout. If your file layout has a higher version number then your existing data file, then the library opens the backup of the file layout for the version of the data file that exists on disk. It makes a backup copy of the existing data file, and creates a new file with the proper version number. Then it reads your records one at a time, and copies all the data from the old file into the new file one field at a time. If a field is dropped from the file layout, that data gets lost. If fields are rearranged, the data is copied and saved in the new file in the new positions. If a new field is added, it starts out blank (or 0).<br />
<br />
The only step necessary for having your data files updated is to increment the version number every time you make a change to the file layout. You may make any changes you like to the file layouts, but do not change the names of your existing subscripts. If you change the subscript name, not only will all the programs that reference that subscript be broken, but additionally, the routine will not understand that you are changing the name. It will think you are dropping the old field and adding a new field and any data stored in this location will be lost when the file is updated.<br />
<br />
price.dat, PR_, 1<br />
<br />
The second line contains the name of the first key, and a definition telling what the key is based on. These are separated by a comma. The key definition is made up of each of the subscript names in this file that form the keyfields for the file. When the library is called to open a file, if the file does not exist, or if it needs to be updated, a new one will be created. The function will read these subscript names that form your key definitions, and it will calculate the proper kps and kln values. Then the create routine will use this information to create the new keys.<br />
<br />
You notice the file can have as many keys as you want. The function will keep parsing key file names until it reaches the RECL= parameter. Remember it opens any OutIn files with all keys so that any changes you may make to the data stored on disk will be properly reflected in all the key files.<br />
<br />
Also, notice the third key is based on three different fields. These are separated by a “/”. It is important that you use a “/” to separate your keys when you are building a key out of more then one field, because the function uses this “/” to help it make the proper BR syntax for defining complex keyfields.<br />
<br />
The RECL= Parameter is also read and used whenever a new file is created or an old one is updated. It is also used to tell the function when to stop looking for key file names, and start looking for the rest of the data.<br />
<br />
price.key, ITEM<br />
price.ky2, FARM<br />
price.ky3, ITEM/FARM/GRADE<br />
recl=127<br />
<br />
The next line in the file is skipped by the parsing routine, and its purpose is to make the file layouts more readable to a programmer.<br />
<br />
===================================================<br />
<br />
Following file layouts, we will discuss data elements. There are three parameters on each line, and you make one line for each field in your file. The first parameter is the subscript index prefix code that you will use in your program to refer to this data element. Place a $ at the end of the subscript name for all string elements. Don’t place anything at the end of the subscript name for numeric elements.<br />
<br />
The spaces are ignored, so you may include as many spaces as you wish to make the layout look good. However the file layout is designed to handle a maximum of 255 characters on each line, and a maximum of 80 characters for the Description names. Do not use tabs, however. For some reason, tabs confuse BR. The second parameter is the description. This description is for the benefit of the programmer, so when the programmer is reading the file layouts, (s)he can tell which field does what.<br />
<br />
The description is also used by the built in DataCrawler, a program that reads any of your data files and displays the entire contents in raw form in a listview. The Descriptions become the headings for each column in the listview. Imagine this as something that you would show to a programmer, or a highly technical user who needed to investigate a data error of some kind.<br />
<br />
The third parameter is the form statement, which is pretty straightforward. Any items with a form statement of type “X” will be ignored, except that the length will still be used to calculate the position on disk of all remaining fields in the record. The library will take X fields into consideration when building the form statement, but not at any other time.<br />
<br />
FARM$, Farm Code (or blank), C 4<br />
ITEM$, Item Code, C 4<br />
GRADE$, Quality, C 4<br />
DUMMY, Empty, X 37<br />
PRICE, Default Price, BH 3.2<br />
COST, Default Cost, BH 3.2<br />
XOPRICE, Default Christmas Price, BH 3.2<br />
XOCOST, Default Christmas Cost, BH 3.2<br />
MOPRICE, Default Mothers D Price, BH 3.2<br />
MOCOST, Default Mothers D Cost, BH 3.2<br />
VOPRICE, Default Valentine Price, BH 3.2<br />
VOCOST, Default Valentine Cost, BH 3.2<br />
DESCRIPTION$, Description of Price Rule, C 30<br />
<br />
And that’s all there is to it.<br />
<br />
== The Library (Function Reference) ==<br />
The library includes a number of useful functions. I hope you find these to be as useful for you as I have found them to be for me.<br />
<br />
=== fnSettings (Global Settings Code) ===<br />
<br />
The newest version of the FileIO library supports some features that require you to specify Global Settings values. These are done by modifying the contents of the fnSettings routine at the beginning of the fileIO library.<br />
<br />
01010 SETTINGS: ! ***** Set Global Defaults For The Library Here<br />
01020 def Fnsettings(&Defaultfilelayoutpath$;&Promptonfilecreate,&Createlogfile,&EnforceDupkeys,&StartFileNumber)<br />
01030 let EnforceDupkeys=1 ! Enforce that key number 1 is unique key<br />
01040 let Defaultfilelayoutpath$="filelay\" ! Path To Your File Layouts<br />
01050 let Promptonfilecreate=1 ! Ask User Before Creating New Files<br />
01060 let Createlogfile=0 ! Create the logfile<br />
01070 let StartFileNumber=1 ! File IO will use file numbers above this number<br />
01080 let CheckIndex=0 ! Automatically Update Indexes <br />
01080 fnend<br />
<br />
==== EnforceDupkeys ====<br />
<br />
Turn on the EnforceDupkeys option to force that the first key listed in your file layouts is a unique key. FileIO will generate the standard BR error for Dupkeys when attempting to create indexes if it is not unique.<br />
<br />
==== DefaultFileLayoutPath ====<br />
<br />
Use the DefaultFileLayoutPath option to specify the path from your programs to your file layout folder. The default is "filelay\". Use this setting if you want to place your file layouts in another folder from the default.<br />
<br />
==== PromptOnFileCreate ====<br />
<br />
Use the PromptOnFileCreate setting to cause FileIO to put up a message box whenever its attempting to create a new file. This happens during the automatic update procedure, as well as during any attempt to access a file that does not exist. This setting should be turned off in your live system, and only turned on for development purposes. If you use the message box to cancel creating of the new file, then the file is not created, and fileIO or your application will most likely give an error when you attempt to actually access the new file.<br />
<br />
It can be useful during development to make sure that you don't accidentally create the wrong files, due to an incorrectly specified path or a typeo in the filename in the layout file. However, in a live system, these things have already been tested, and you generally want the default behavior, because you don't want your users to have the ability to cancel the normal operation of FileIO.<br />
<br />
==== CreateLogFile ====<br />
<br />
Use this option to specify weather or not to use the FileIO log file. If it is turned on, a log file called FileIO.log in the current directory is created with entries listing all attempts to open a file, automatically update one, or automatically update your indexes.<br />
<br />
==== StartFileNumber ====<br />
<br />
Use this option to set the starting file number that the fnGetFileNumber and the fnOpen functions use to search for available file numbers. This is so that if you have certian reserved file numbers in your code, you can make sure that FileIO will not use those reserved file numbers, causing a conflict with your already existing programs. The default is 1, which is fine if your software does not have any reserved file numbers.<br />
<br />
==== CheckIndex ====<br />
<br />
This function is used for Partial FileIO Implementations. If all your software uses FileIO then all of your indexes are kept automatically up to date by the FileIO library and BR's internal file processing systems. However, if some of programs do not use FileIO, and you use the FileIO library to add a new index file that those other programs do not know about, then its possible for the additional index file to become out of date when the master file is updated by your other programs.<br />
<br />
Use this setting to cause FileIO to check the DateTime stamp on all your index files when opening a new file, and automatically update any indexes that may have potentially gotten out of date from other programs.<br />
<br />
This option slows down the processing of the fnOpen function, particularly when running under client server over the internet. If you know that every program in your application suite uses FileIO, and that any programs that do not use FileIO still properly update all the indexes that your data file uses, then you can safely leave this setting turned off, and take advantage of a significant speed increase when opening a lot of files using the fileIO system.<br />
<br />
=== fnOpenFile ===<br />
The primary function opens a file, and it’s used like so:<br />
<br />
FNOPENFILE(FILENAME$,MAT F$,MAT F,MAT FORM$;INPUTONLY,KEYNUM,DONT_SORT_SUBS,<br />
PATH$,MAT DESCR$,MAT FIELDWIDTHS,SUPRESS_PROMPT)<br />
<br />
FILENAME$ - The filename of the file layout for the file you’re reading.<br />
MAT F$ - The array that will be used to hold the string data for the file.<br />
MAT F – The array that will hold the numeric data for the file.<br />
MAT FORM$ - An array of form statements.<br />
INPUTONLY – 1 means open for input only. 0 means open for OutIn and open every<br />
key file associated with the given data file (this is because all key files<br />
need to be open for the keys to be updated on an output) (defaults to 0).<br />
KEYNUM – This tells the function of which key to return the file handle (defaults to 1).<br />
DONT_SORT_SUBS – The function by default will sort the string and numeric subs in order<br />
to allow for reading the data into an array, and this parameter would turn this<br />
functionality off. However, if you are trying to read your data without reading<br />
it into an array, you are missing the point. You should leave this option turned<br />
off (0). This is a totally unsupported feature, and should always be set to 0, if<br />
it is specified at all.<br />
PATH$ - The path to your data files. This optional parameter can be passed in by the<br />
calling function. It is appended to the beginning of the paths given in the file<br />
layout files. It is useful when your data files can be in different locations<br />
depending on the state of your program.<br />
MAT DESCR$ - This optional parameter provides a way to read the description for<br />
each field from the original file layout. If the parameter is not provided, no<br />
description data will be returned. <br />
MAT FIELDWIDTHS – This optional parameter will return an array of the calculated<br />
display field widths. This number will always be at least long enough to contain<br />
the data for this field.<br />
SUPRESS_PROMPT - This optional parameter can be used to supress the prompt normally<br />
given when fileIO creates a file. It can have three values. A value of 0, the default,<br />
uses the setting stored in your FileIO fnSettings routine to determine weather or not<br />
to prompt on Creation of a new file. A nonzero value always supresses the prompt. A<br />
value of 1 indicates never to create a file if the file doesn't exist. A value of 2<br />
automatically creates the file if the file doesn't exist.<br />
<br />
* When using fnOpenFile, you really want to call your local function FnOpen, which in turn calls fnOpenFile for you.<br />
<br />
Example:<br />
<br />
Let FFILE=FNOPENFILE(“FARM”,MAT FARM$,MAT FARM,MAT FORM$,0,2)<br />
Let RFILE=FNOPENFILE(“ROUTE”,MAT ROUTE$,MAT ROUTE,MAT FORM$,1,3)<br />
Let CFILE=FNOPENFILE(“CUSTOMER”,MAT CUSTOMER$,MAT CUSTOMER,MAT FORM$)<br />
<br />
assuming:<br />
farm.dat has 3 keys: farm.ky1, farm.ky2, farm.ky3<br />
route.dat has 4 keys: route.ky1 … route.ky4<br />
customer.dat has 2 keys: customer.ky1, customer.ky2<br />
<br />
This will perform the following opens and set the following variables:<br />
<br />
OPEN #1: “Name=Farm.Dat, kfname=farm.ky2”,internal,outin,keyed<br />
OPEN #2: “Name=Farm.Dat, kfname=farm.ky1”,internal,outin,keyed<br />
OPEN #3: “Name=Farm.Dat, kfname=farm.ky3”,internal,outin,keyed<br />
OPEN #4: “Name=Route.Dat, kfname=route.ky3”,internal,input,keyed<br />
OPEN #5: “Name=Customer.Dat,kfname=customer.ky1”,internal,outin,keyed<br />
OPEN #6: “Name=Customer.Dat,kfname=customer.ky2”,internal,outin,keyed<br />
LET FFILE=1<br />
LET RFILE=4<br />
LET CFILE=5<br />
<br />
This will also resize the arrays, set the form statement, and create all the subscripts to make reading and writing clear and simple, as in the above example. The KEYNUM parameter is where you list the key file you would like to use for input and output. The extra keys are opened as a courtesy to you to ensure that all keys get updated properly when the file is changed.<br />
<br />
Example:<br />
DIM FORM$(1),PRICE$(1)*255,PRICE(1),<br />
DIM DESCRIPTION$(1)*255,FIELDWIDTHS(1)<br />
<br />
Let PRICEFILE=FNOPENFILE(“PRICE”,MAT PRICE$,MAT PRICE,MAT FORM$,0,2,0,MAT DESCRIPTION$)<br />
<br />
Assuming the Price File layout (filelay\price) contains:<br />
<br />
price.dat, PR_, 1<br />
price.key, FARM<br />
price.ky2, ITEM<br />
price.ky3, FARM/ITEM/GRADE<br />
recl=127<br />
===================================================<br />
FARM$, Farm Code (or blank), C 4<br />
ITEM$, Item Code, C 4<br />
GRADE$, Quality, C 4<br />
DUMMY, Empty, X 37<br />
PRICE, Default Price, BH 3.2<br />
COST, Default Cost, BH 3.2<br />
XOPRICE, Default Christmas Price, BH 3.2<br />
XOCOST, Default Christmas Cost, BH 3.2<br />
MOPRICE, Default Mothers D Price, BH 3.2<br />
MOCOST, Default Mothers D Cost, BH 3.2<br />
VOPRICE, Default Valentine Price, BH 3.2<br />
VOCOST, Default Valentine Cost, BH 3.2<br />
DESCRIPTION$, Description of Price Rule, C 30<br />
<br />
This will perform the following opens and set the following variables:<br />
<br />
OPEN #1: “Name=Price.Dat, kfname=Price.ky2”,internal,outin,keyed<br />
OPEN #2: “Name=Price.Dat, kfname=Price.ky1”,internal,outin,keyed<br />
OPEN #3: “Name=Price.Dat, kfname=Price.ky3”,internal,outin,keyed<br />
let PRICEFILE=1<br />
let PR_FARM=1<br />
let PR_ITEM=2<br />
let PR_GRADE=3<br />
let PR_DESCR=4<br />
let PR_PRICE=1<br />
let PR_COST=2<br />
let PR_XOPRICE=3<br />
let PR_XOCOST=4<br />
let PR_MOPRICE=5<br />
let PR_MOCOST=6<br />
let PR_VOPRICE=7<br />
let PR_VOCOST=8<br />
MAT FORM$(1)<br />
MAT PRICE$(4)<br />
MAT PRICE(8)<br />
MAT DESCRIPTION$(12)<br />
MAT FIELDWIDTHS(12)<br />
let FORM$(1)=CFORM$(”form C 4,C 4,C 4,POS 74,C 30,POS 50,BH 3.2,BH 3.2,BH 3.2,BH 3.2,BH 3.2,BH 3.2,BH 3.2,BH 3.2”)<br />
let Description$(1)= “Farm Code (or blank)”<br />
let Description$(2) = “Item Code”<br />
let Description$(3) = “Quality”<br />
let Description$(4) = “Description of Price Rule”<br />
let Description$(5) = “Default Price”<br />
let Description$(6) = “Default Cost”<br />
let Description$(7) = “Default Christmas Price”<br />
let Description$(8) = “Default Christmas Cost”<br />
let Description$(9) = “Default Mothers D Price”<br />
let Description$(10) = “Default Mothers D Cost”<br />
let Description$(11) = “Default Valentine Price”<br />
let Description$(12) = “Default Valentine Cost”<br />
let FieldWidths(1) = 4<br />
let FieldWidths(2) = 4<br />
let FieldWidths(3) = 4<br />
let FieldWidths(4) = 30<br />
let FieldWidths(5) = 8<br />
let FieldWidths(6) = 8<br />
let FieldWidths(7) = 8<br />
let FieldWidths(8) = 8<br />
let FieldWidths(9) = 8<br />
let FieldWidths(10) = 8<br />
let FieldWidths(11) = 8<br />
let FieldWidths(12) = 8<br />
<br />
<br />
There are a few things I’d like to point out about the example above. First, you will notice that the form statement jumps around to put all the strings first, and then the numbers last. This is why it has a “POS 74, C 30,POS 50”. Then notice that the subscripts for the string variables are 1 .. 4, and the subscripts for the numbers are 1 .. 8. Finally, the order of the Description and FieldWidth fields also match the sorted positioning of the Form Statement.<br />
<br />
The reason that we sort our form statements is so that BR will allow us to read the file into arrays by saying:<br />
<br />
Read #pricefile, using form$(pricefile) : mat price$, mat price<br />
<br />
Without resorting, the above statement would give a conversion error as BR attempted to put the PR_PRICE field inside mat price$(4). However, because we have reordered the form statement, we are able to read them safely into two arrays, and then we will be able to use the values without caring what position they are in the file, by simply saying PRICE$(PR_DESCRIPTION) when we want the description, and PRICE(PR_PRICE) when we want the pr_Price field.<br />
<br />
Another thing you may notice about the above example is that it gives the calculated display length for the numeric fields as 8, when on the disk (and in the file layout) they are listed as BH 3.2. The reason for this is the program looks at the BH 3, and figures that a number that takes up 3 bytes on disk has a potential maximum size of 256**3 or 16,777,216, and therefore will need up to 8 characters of screen display space to view. <br />
<br />
Finally, note that any field with a form statement of X is ignored by the library, except that the blank space is used when building the FORM statement.<br />
<br />
FnOpenFile and FnOpen have been improved to pass the subscripts back in an array instead of a proc file, which is much faster, and also not as prone to causing file sharing errors.<br />
<br />
=== fnCloseFile ===<br />
This function will close the specified filenumber and all keys that were opened with the file. You should use it only for files that were opened using the library for OutIn. The purpose of this function is to facilitate the closing of the extra keys that are opened when you open a file for OutIn with the library. You must give the function the name of the file layout. It uses this information to determine how many keys were opened, and how many it must therefore close. Then it basically starts at the file number you gave it, and closes the next X files that were opened with the same file name as this, where X is the number of keys associated with this file.<br />
<br />
The syntax is:<br />
<br />
FNCLOSEFILE(filenumber,filelay$;path$)<br />
<br />
FileNumber – The filenumber of the file you are trying to close.<br />
FileLay$ - The name of the file layout for this file. This is used to determine<br />
how many keys the file would have been opened with and therefore how many we<br />
now need to close.<br />
Path$ - Optional Alternate Path. Use to close files that were opened using the open file's optional alternate path parameter.<br />
<br />
=== fnMakeSubProc ===<br />
The standard FNOpenFile routine opens a file and sets several values, and also passes back the subscripts to the calling program. The fnMakeSubProc$ routine passes back the subs without actually opening the file. This is useful when a file record is passed as arrays into a library function in another program, or when you chained to another program and you need to know how to reach the data in the arrays without actually reopening the file.<br />
<br />
FNMakeSubProc(filelay$;mat Subscripts$) - Returns Just the Subscripts of the given file.<br />
<br />
FileLay$ - The name of the file layout from which to read the subscripts.<br />
mat Subscripts$ - If you give this optional array, fnMakeSubProc passes the<br />
subscripts back in this array rather then in the subs.$$$ file. This is<br />
much faster and helps avoid sharing conflicts.<br />
<br />
When this routine returns, you can set the subscripts in your program by executing every element of the Subscripts$ array in a for/next loop.<br />
<br />
If you did not pass in a subscripts array, then the old subs.$$$ file is created for backwards compatability. If you proc that file, the proper subscripts will be set.<br />
<br />
=== fnReadLayoutArrays ===<br />
This function reads the fields in a file layout into arrays. You call it like the following<br />
<br />
fnReadLayoutArrays(filelay$,&prefix$;mat SSubs$, mat NSubs$, mat SSpec$, mat NSpec$,<br />
mat SDescription$, mat NDescription$,Mat Spos,Mat Npos,)<br />
<br />
filelay$ - the name of the layout to read<br />
prefix$ - the return value for the prefix for the file<br />
mat SSubs$ - the return value for all the string subscripts in the layout<br />
mat NSubs$ - the return value for the numeric subscripts in the layout<br />
mat SSpec$ - the return value for the string fields specs<br />
mat NSpec$ - the return value for the numeric fields specs<br />
mat SDescription$ - the return value for the Descriptions of the String Specs<br />
mat NDescription$ - the return value for the Descriptions of the Numeric Specs<br />
mat SPos - the return value for the starting positions of the String Specs<br />
mat NPos - the return value for the starting positions of the Numeric Specs<br />
<br />
This function call would read the fields from the layout in filelay$, and it would return the prefix to prefix$. The Subs would be returned in mat SSubs$ and mat NSubs$. The Spec statements are returned in mat SSpec$ and mat NSpec$ and the Descriptions are returned in mat SDescription$ and mat NDescription$. The start positions on disk of each element are returned in mat SPos and mat NPos. All the arrays are optional. If you don’t pass them the information they supposed to record is simply not returned. <br />
<br />
=== fnReadLayoutHeader ===<br />
This function reads the header for a given file layout.<br />
<br />
FnReadLayoutHeader(Layoutname$*255;&Filename$,Mat Keys$,Mat KeyDescription$)<br />
<br />
LayoutName$ - Name of the layout to read<br />
Filename$ - The file name read from the layout<br />
Mat Keys$ - Array to be populated with the list of keys for the file<br />
Mat KeyDescription$ - Key Description String returned from the file<br />
<br />
=== fnReadEntireLayout ===<br />
This function reads the entire layout by calling fnReadLayoutHeader and fnReadLayoutArrays.<br />
<br />
FnReadEntireLayout(Layoutname$*255;&Filename$,&Prefix$,Mat Keys$,Mat KeyDescription$,<br />
Mat Ssubs$,Mat Nsubs$,Mat Sspec$,Mat Nspec$,Mat Sdescription$,Mat Ndescription$,<br />
Mat Spos,Mat Npos)<br />
<br />
LayoutName$ - Name of the layout to read<br />
Filename$ - The file name read from the layout<br />
prefix$ - the return value for the prefix for the file<br />
Mat Keys$ - Array to be populated with the list of keys for the file<br />
Mat KeyDescription$ - Key Description String returned from the file<br />
mat SSubs$ - the return value for all the string subscripts in the layout<br />
mat NSubs$ - the return value for the numeric subscripts in the layout<br />
mat SSpec$ - the return value for the string fields specs<br />
mat NSpec$ - the return value for the numeric fields specs<br />
mat SDescription$ - the return value for the Descriptions of the String Specs<br />
mat NDescription$ - the return value for the Descriptions of the Numeric Specs<br />
mat SPos - the return value for the starting positions of the String Specs<br />
mat NPos - the return value for the starting positions of the Numeric Specs <br />
<br />
=== fnReadSubs ===<br />
This function reads the subscripts from a layout into Subs arrays.<br />
<br />
fnReadSubs(Filename$,mat SSubs$,mat NSubs$,&Prefix$)<br />
<br />
=== fnReadKeyFiles ===<br />
This function reads the list of key files from the layout.<br />
<br />
fnReadKeyFiles(Layout$,mat Keys$)<br />
<br />
=== fnReadDescription$ ===<br />
In the example program I used above, I am reading the Color File to get details about each color. The color file contains a colorcat code field, but I want to display the colorcat description. The colorcat file contains a few details about a color category, and it is indexed based on colorcat code:<br />
<br />
route.dat, RT_<br />
route.key, CODE<br />
recl=512<br />
===================================================<br />
CODE, Routing Code, C 6<br />
NAME, Routing Name Description, C 30<br />
MOFT, T/A/C (truck/air/courier), C 1<br />
SHIPPINGDAY, Day of Week for Shipping, C 7<br />
<br />
Now, as you know, in the above example, we have already opened the ColorCat File, and we have opened and read a Color record.<br />
<br />
04020 let colorfile=fnopen("color",mat color$,mat color,mat form$)<br />
04030 let colorcatfile=fnopen("colorcat",mat colorcat$,mat colorcat,mat form$,1)<br />
<br />
<br />
30120 read #colorfile, using form$(colorfile) : mat color$, mat color eof Ignore<br />
30180 LET ccode$=color$(CO_CODE) !:<br />
LET Name$=color$(CO_NAME)<br />
<br />
Now all that’s left to do is to take the Color File’s ColorCat code and use it to look up the ColorCat File’s description.<br />
<br />
30190 LET ColorCat$ = fnReadDescription$(ColorCatFile, CC_NAME, Color$(CO_CATEGORY),<br />
mat ColorCat$, mat ColorCat, mat form$)<br />
<br />
Lets take a look at how this function works:<br />
FNREADDESCRIPTION$(Fl,Subscript,key$,mat F$,mat F,mat fm$)<br />
<br />
FL – File Handle for file to use (Route File).<br />
SUBSCRIPT – Index of field in record to use (should be taken from file layout)<br />
(RT_NAME, which should equal 2 after opening routefile (unless we change the<br />
file layout later)).<br />
KEY$ - Item that should match a key in this file somewhere (in this case it is<br />
the route code from the farm record).<br />
MAT F$ & MAT F - Work Variables to hold a file record from the file we are reading<br />
– they have to be dimensioned properly, which is why we use our colorcat$ and our<br />
colorcat for these parameters.<br />
MAT FM$ - This will need to be our array of form statements, so the function can<br />
read the file properly.<br />
<br />
=== fnReadUnopenedDescription$ ===<br />
This function accomplishes the same thing as fnReadDescription except that it opens the data file for you. It is slower then FnReadDescription$, but it is easier to use.<br />
<br />
FnReadUnopenedDescription$(Layout$,key$*255;Field)<br />
<br />
Layout$ - the layout of the file we are reading<br />
key$ - the key of the record to be read<br />
Field - the element of the data file to return. If not given, this defaults to 2,<br />
so sometimes it is a good idea to design your data files so that string field<br />
number two is a descriptive field, like Name or Description.<br />
<br />
=== fnReadNumber ===<br />
FnReadNumber does the same thing that ReadDescription does except it reads a numeric field instead of a description.<br />
<br />
Lets take a look at how this function works:<br />
FNREADNUMBER(Fl,subscript,key$,mat F$,mat F,mat fm$)<br />
<br />
FL – File Handle for file to use (Route File).<br />
SUBSCRIPT – Index of field in record to use (should be taken from file layout)<br />
(RT_NAME, which should equal 2 after opening routefile (unless we change the<br />
file layout later)).<br />
KEY$ - Item that should match a key in this file somewhere (in this case it is<br />
the route code from the farm record).<br />
MAT F$ & MAT F - Work Variables to hold a file record from the file we are reading<br />
– they have to be dimensioned properly, which is why we use our colorcat$ and our<br />
colorcat for these parameters.<br />
MAT FM$ - This will need to be our array of form statements, so the function can<br />
read the file properly.<br />
<br />
=== fnReadUnopenedNumber ===<br />
This function accomplishes the same thing as fnReadNumber except that it opens the data file for you. It is slower then FnReadNumber, but it is easier to use.<br />
<br />
FnReadUnopenedNumber(Layout$,key$*255;Field)<br />
<br />
Layout$ - the layout of the file we are reading<br />
key$ - the key of the record to be read<br />
Field - the element of the data file to return. If not given, this defaults to 2,<br />
so sometimes it is a good idea to design your data files so that string field<br />
number two is a descriptive field, like Name or Description.<br />
<br />
=== fnReadRelativeDescription$ ===<br />
This function is the same as fnReadDescription$ but for Relative Files.<br />
<br />
FnReadRelativeDescription$(FileNumber,SubscriptToRead,RecordNumber,mat F$,mat F,mat form$)<br />
<br />
=== fnReadRelUnopenedDescription$ ===<br />
This is the same as ReadUnopenedDescription$ but for Relative Files.<br />
<br />
fnReadRelUnopenedDescription(LayoutName$,RecordNumber;Field)<br />
<br />
=== fnReadRelativeNumber ===<br />
This is the same as fnReadNumber but for Relative Files.<br />
<br />
fnReadRelativeNumber(FileNumber,SubscriptToRead,RecordNumber,mat F$,mat f,mat Form$)<br />
<br />
=== fnReadRelUnopenedNumber ===<br />
This is the same as fnReadUnopenedNumber but for Relative Files.<br />
<br />
fnReadRelUnopenedNumber(LayoutName$,RecordNumber;Field)<br />
<br />
=== fnGetFileNumber ===<br />
FnGetFileNumber is a simple function to find a valid unused file handle. If you use this function in all of your programs, they will become much more portable, as you will never have to worry about your file handles fighting with each other. The function will return 0 if no free file number was found (but with 999 of them available now, I have never seen it happen).<br />
<br />
FNGETFILENUMBER(;X,Count)<br />
<br />
X – This optional parameter will specify where to start looking.<br />
Count - This optional parameter will specify how many file numbers to find in<br />
a row. If count is 3, then fnGetFileNumber will return the first filenumber in<br />
the first gap of three unused file numbers that it finds.<br />
<br />
=== fnUniqueKey ===<br />
This function tests to see if a given key is unique to the specified file. This function is very useful for situations where you need to ensure that the user-entered key is unique.<br />
<br />
FnUniqueKey(Fl,key$*255)<br />
<br />
FL – The file number of the opened file.<br />
Key$ - This is the key to test. If this key is the key for a preexisting record in<br />
the file, the function will return false. If this key can not be found in the file,<br />
the function will return true.<br />
<br />
=== fnReadAllKeys ===<br />
This function will read through a file, returning the specified element(s) from each record into (a) dynamically dimensioned array(s). For example, I could tell it to give me the Inventory Code for every inventory item in my database in one array, while placing the Inventory Description (name) for each item into the corresponding position in another array.<br />
<br />
FnReadAllKeys(Fl,mat f$,mat f,mat fm$,sub1,mat out1$;sub2,mat out2$)<br />
<br />
FL – The file handle for the already opened file in question.<br />
MAT F$ - Work array with a size that corresponds to the number of string elements<br />
in the record (this is calculated automatically in the Open statement, if you used<br />
this library to open the file).<br />
MAT F – Work array with a size that corresponds to the number of numeric elements in<br />
the record (this is calculated automatically in the Open statement, if you used this<br />
library to open the file).<br />
MAT fm$ - Array of Forms statement. FM$(FL) must be the form statement for this file<br />
(this is calculated automatically in the Open statement, if you used this library<br />
to open the file).<br />
Sub1 – Subscript of the element to return in the first array<br />
MAT out1$ - Array in which to return the data. This array will be resized to match<br />
the number of records in the file.<br />
Sub2 – Subscript of the element to return in the second array. This is optional.<br />
If it is specified, you must give MAT out2$, or BR will return an error.<br />
MAT out2$ - Array in which to return the second (optional) parameter. This array<br />
will be resized to match the number of records in the file. This parameter MUST<br />
be provided when Sub2 is given (non-zero). This parameter will not be used if Sub2<br />
is not given or is given as 0.<br />
<br />
<br />
If I wanted to implement the above example, I would say:<br />
<br />
FnReadAllKeys(InventFile,mat Invent$,mat Invent,mat Form$,IN_Code,mat InvtList$,IN_Name,mat InvtNames$)<br />
<br />
<br />
<br />
=== fnReadMatchingKeys ===<br />
<br />
This function will read through a file, returning the specified element(s) from each record where the key matches the specified key into (a) dynamically dimensioned array(s). This function is the same as the above function except this one will filter the results, returning only those records where the key matches the specified key.<br />
<br />
<br />
FnReadMatchingKeys(Fl,mat f$,mat f,mat fm$,key$,keysub,sub1,mat out1$;sub2,mat out2$)<br />
<br />
FL – The file handle for the already opened file in question.<br />
MAT F$ - Work array with a size that corresponds to the number of string elements in<br />
the record (this is calculated automatically in the Open statement, if you used this<br />
library to open the file).<br />
MAT F – Work array with a size that corresponds to the number of numeric elements in the<br />
record (this is calculated automatically in the Open statement, if you used this library<br />
to open the file).<br />
MAT fm$ - Array of Forms statement. FM$(FL) must be the form statement for this file<br />
(this is calculated automatically in the Open statement, if you used this library to open<br />
the file).<br />
Key$ - Only records where the key field matches key$ will be returned.<br />
Keysub – This tells the function which element is the key element for this particular file number.<br />
Sub1 – Subscript of the element to return in the first array.<br />
MAT out1$ - Array in which to return the data. This array will be resized to match the number<br />
of records in the file.<br />
Sub2 – Subscript of the element to return in the second array. This is optional. If it is<br />
specified, you must give MAT out2$, or BR will return an error.<br />
MAT out2$ - Array in which to return the second (optional) parameter. This array will be<br />
resized to match the number of records in the file. This parameter MUST be provided when<br />
Sub2 is given (non-zero). This parameter will not be used if Sub2 is not given or is given as 0.<br />
<br />
<br />
=== fnReadAllNewKeys ===<br />
<br />
This function will read through a file, returning the specified element(s) from each record that isn’t already there into (a) dynamically dimensioned array(s). This function is the same as the above function, except this one will filter the results returning only those records that don’t already exist in the array (eliminating duplicates).<br />
<br />
<br />
FnReadAllNewKeys(Fl,mat f$,mat f,mat fm$,sub1,mat out1$; dont_reset,sub2,mat out2$)<br />
<br />
FL – The file handle for the already opened file in question.<br />
MAT F$ - Work array with a size that corresponds to the number of string elements in the<br />
record (this is calculated automatically in the Open statement, if you used this library<br />
to open the file).<br />
MAT F – Work array with a size that corresponds to the number of numeric elements in the<br />
record (this is calculated automatically in the Open statement, if you used this library<br />
to open the file).<br />
MAT fm$ - Array of Forms statement. FM$(FL) must be the form statement for this file (this<br />
is calculated automatically in the Open statement, if you used this library to open the file).<br />
Sub1 – Subscript of the element to return in the first array.<br />
MAT out1$ - Array in which to return the data. This array will be resized to match the number of<br />
records in the file.<br />
Dont_reset – By default the array will clear the contents of the arrays that are passed in. This<br />
Boolean flag will instruct the function to not empty the passed in arrays.<br />
Sub2 – Subscript of the element to return in the second array. This is optional. If it is specified,<br />
you must give MAT out2$, or BR will return an error.<br />
MAT out2$ - Array in which to return the second (optional) parameter. This array will be resized to<br />
match the number of records in the file. This parameter MUST be provided when Sub2 is given<br />
(non-zero). This parameter will not be used if Sub2 is not given or is given as 0.<br />
<br />
<br />
=== FnReadFilterKeys ===<br />
<br />
This function by Mikhail Zheleznov is a modification of the above functions. Like its predecessors, it reads an entire file, populating the specified arrays with data from all or some of the records in the file. The given subscripts specify which fields to return from each record. The key given specifies search criteria for the records. The filter specifies filtering criteria that can be preformed on the data before it is returned. <br />
<br />
FnReadFilterKeys(Fl,Mat F$,Mat F,Mat Fm$,Key$,Keyfld,Sub1,Mat Out1$;Filter$,Filter_Sub,<br />
Readlarger,Sub2,Mat Out2$, Sub3, Mat Out3$, Sub4,Mat Out4$)<br />
<br />
FL – The file handle for the already opened file in question.<br />
MAT F$ - Work array with a size that corresponds to the number of string elements in the<br />
record (this is calculated automatically in the Open statement, if you used this library<br />
to open the file).<br />
MAT F – Work array with a size that corresponds to the number of numeric elements in the<br />
record (this is calculated automatically in the Open statement, if you used this library<br />
to open the file).<br />
MAT fm$ - Array of Forms statement. FM$(FL) must be the form statement for this file (this<br />
is calculated automatically in the Open statement, if you used this library to open the file).<br />
Key$ - The key to search for in the read statements<br />
Keyfld – the subscript of the key field in the data file. This must match the key field<br />
specified in the data file otherwise the function won’t work.<br />
Sub1 – Subscript of the element to return in the first array.<br />
MAT out1$ - Array in which to return the data. This array will be resized to match the<br />
number of records in the file.<br />
Filter$ – This optional parameter identifies matches to search for in the records. It<br />
works in conjunction with Filter_Sub<br />
Filter_Sub – This parameter specifies which field to look for in the records for matches<br />
to Filter$. Only records which have Filter$ in the specified field will be returned.<br />
Sub2 – Subscript of the element to return in the second array. This is optional. If it<br />
is specified, you must give MAT out2$, or BR will return an error.<br />
MAT out2$ - Array in which to return the second (optional) field. This array will be<br />
resized to match the number of records in the file. This parameter MUST be provided<br />
when Sub2 is given (non-zero). This parameter will not be used if Sub2 is not given<br />
or is given as 0.<br />
Sub3 – Subscript of the element to return in the third array. This is optional. If it<br />
is specified, you must give MAT out3$, or BR will return an error.<br />
MAT out3$ - Array in which to return the third (optional) field. This array will be<br />
resized to match the number of records in the file. This parameter MUST be provided<br />
when Sub3 is given (non-zero). This parameter will not be used if Sub3 is not given<br />
or is given as 0.<br />
Sub4 – Subscript of the element to return in the fourth array. This is optional. If it<br />
is specified, you must give MAT out4$, or BR will return an error.<br />
MAT out4$ - Array in which to return the fourth (optional) field. This array will be<br />
resized to match the number of records in the file. This parameter MUST be provided<br />
when Sub4 is given (non-zero). This parameter will not be used if Sub4 is not given<br />
or is given as 0.<br />
<br />
This function was written by Mikhail Zheleznov for the fileIO library.<br />
<br />
=== fnMakeUniqueKey$ ===<br />
This function generates a unique key for a given file. This is useful if you do not care what the key is, but it needs to be unique. I use this function in situations where the user never needs to know what the given key is. <br />
<br />
This function reads the key length for the given file. Then it returns a string that is the right length, which is generated by counting in binary until a key is found that does not appear in the file. The first key found for a 4 byte key field would be chr$(0)&chr$(0)&chr$(0)&chr$(0). If that key was already in use in the file, the function would return chr$(0)&chr$(0)&chr$(0)&chr$(1). If that one was also in use, it would then try chr$(0)&chr$(0)&chr$(0)&chr$(2), and so on until it found one that wasn’t in use.<br />
<br />
FnMakeUniqueKey$(fl)<br />
<br />
FL – This is the file number of the opened file for the desired key.<br />
<br />
=== fnLog & fnErrLog ===<br />
These next two functions are functions to aid in logging. When you call either of these two functions, you give them a string that you wish to log. They will open a textfile called FileIO.log and add a line to the end of it containing some user information such as login_name and session$, and the string that you specified. FnErrLog does the same thing as fnLog except it also logs the Error Number and the Line.<br />
<br />
The syntax is:<br />
<br />
FnLog(string$)<br />
FnErrLog(String$)<br />
<br />
=== fnNotInFile ===<br />
This function will determine if a non-key element in a line is unique. It works almost exactly like fnUniqueKey specified above, except that it allows you to enter the subscript value of the element you are checking for uniqueness. You can use this to look for uniqueness in any field, not just in the key field. Additionally, the search engine used by this function looks for a partial match, and will only return true if the given string is not found anywhere in the specified element for the given file.<br />
<br />
FnNotInFile(string$*100,filename$,sub)<br />
<br />
String$ - Value to check for uniqueness in this file.<br />
Filename$ - This is the name of the file layout of the file you want to check. This file<br />
does not have to be open in order for you to search it, because the function will open<br />
it for you.<br />
Sub – This is the subscript value of the element you are checking.<br />
<br />
<br />
=== fnReadLayouts ===<br />
This function reads the file layout folder and returns all the applicable layouts in the passed in array.<br />
<br />
FnReadLayouts(mat Dirlist$)<br />
<br />
Mat Dirlist$ - After running the function, mat Dirlist$ will contain a list of all the<br />
file layouts that FileIO can find.<br />
<br />
=== fnDoesLayoutExist ===<br />
This function returns true if the given file layout exists. It returns false if the layout does not exist.<br />
<br />
FnDoesLayoutExist(layout$)<br />
<br />
Layout$ - Layout to look for<br />
<br />
=== fnKey$ ===<br />
This function formats the key for the given file number.<br />
<br />
FnKey$(FileNumber, Key$)<br />
<br />
FileNumber - the file number we are formatting the key for<br />
Key$ - the key we are trying to format.<br />
<br />
=== fnBuildKey$ ===<br />
This function will return they key for a given record in a data file. It actually reads the file layout and builds the key to match the layout.<br />
<br />
FnBuildKey$(Layout$, Mat F$, Mat F; Keynum)<br />
<br />
Layout$ - the name of the data file to build the key for.<br />
Mat F$ - the string array of the file object<br />
Mat F - the numeric array of the file object<br />
KeyNum - This optional parameter specifies which of the key files in<br />
the given layout the key should be built for.<br />
<br />
=== fnReadRecordWhere$ ===<br />
This function returns the record where the given element matches the given value. It does not depend on any key files, and it can be used to locate a record based on any element. However, it loops through the entire data file to do this and it could be a bit slow for large data files. This function opens the file for you, so the file does not have to be already opened.<br />
<br />
FnReadRecordWhere$(Layout$,SearchSub,SearchKey$*255,ReturnSub)<br />
<br />
Layout$ - the layout of the file we are searching<br />
SearchSub - Subscript of the element to look in<br />
SearchKey$ - The value we are looking for<br />
ReturnSub - Subscript of the element to return<br />
<br />
=== fnUpdateFile ===<br />
This function checks and Updates a data file if it needs to be updated, by opening and then closing the data file.<br />
<br />
fnUpdateFile(FileLayout$)<br />
<br />
FileLayout$ - The name of the file to update<br />
<br />
=== fnDisplayLength ===<br />
This function calculates the display length of a field based on its form spec.<br />
<br />
fnDisplayLength(Spec$)<br />
<br />
Spec - the Form Spec to return the display length of.<br />
<br />
=== fnLength ===<br />
This function calculates the length on disk of a field based on its form spec.<br />
<br />
fnLength(Spec$)<br />
<br />
Spec - the Form Spec to return the display length of.<br />
<br />
=== fnDataCrawler ===<br />
This function launches the Data Crawler as a function, so you can make your own programs link to it. Special thanks to Mikhail Zheleznov for turning the DataCrawler into a library function.<br />
<br />
fnDataCrawler(Layout$;SRow$,SCol$,Rows$,Cols$)<br />
<br />
=== fnDataEdit ===<br />
This function launches the DataGrid as a function, so you can make your own programs link to it. Special thanks to Mikhail Zheleznov for turning the DataGrid into a library function.<br />
<br />
fnDataEdit(Layout$;SRow$,SCol$,Rows$,Cols$)<br />
<br />
== FileIO Add-on Packages ==<br />
<br />
Many FileIO Add-on packages are currently in the works.<br />
<br />
=== ScreenIO Library ===<br />
<br />
The [[ScreenIO Library]] is a sister library to the FileIO library. The ScreenIO library requires the FileIO library in order to run.<br />
<br />
The ScreenIO library is a complete Rapid Application Design tool that enables you to implement custom screen functions anywhere in your exiting programs.<br />
<br />
If you call the ScreenIO Library as a function library, you call a function called fnFM and tell it which screen you wish to use. The ScreenIO library loads your user interface, loads your data files, and preforms all the file maintenance operations you have designed into your screens.<br />
<br />
You can find out the latest information about the ScreenIO library in the ScreenIO page.<br />
<br />
== What’s New ==<br />
=== Spring 2009 ===<br />
==== New Functions ====<br />
The FileIO Library has been updated in Spring 2009 to provide several new functions:<br />
<br />
fnReadRecordWhere<br />
fnKey$<br />
fnBuildKey$<br />
fnReadUnopenedDescription$<br />
fnUpdateFile<br />
fnDisplayLength<br />
fnLength<br />
fnReadLayoutHeader<br />
fnReadEntireLayout<br />
<br />
==== Speed Increases ====<br />
Thanks to the BR Profiler, we have increased the speed of FileIO fnOpen function by ten times when running over a LAN and by 100 times when running over the internet using Client Server.<br />
<br />
In order to get the new Speed Upgrades, you will need to make sure that you use the latest copy of the [[#fnOpen_Function|fnOpen]] function in each one of your programs that use FileIO.<br />
<br />
==== Network FileIO ====<br />
This version of FileIO has been optimized to work better in network situations.<br />
<br />
==== FnSettings ====<br />
There are more configuration options in the [[#fnSettings_.28Global_Settings_Code.29|fnSettings]] routine.<br />
<br />
==== Automatic Update Speed Fix ====<br />
The automatic update proceedure has been made to run more then 100 times faster then before according to our benchmarking tests.<br />
<br />
=== Fall 2008 ===<br />
==== DataCrawler Grid ====<br />
<br />
By popular request we added a read/write version to the data crawler. This version works exactly the same as the datacrawler did before but it displays all the contents of your data files in a grid instead of a listview. <br />
<br />
When you run the fileIO library as a program, it launches a tool known as the [[#DataCrawler|DataCrawler]]. The DataCrawler shows a listview displaying all your layout files in it. If you select one, it builds another listview with all the data in your selected data file.<br />
<br />
If you are looking at the first list of all your file layouts, and you press F5, a grid will be build displaying all the data in your data files. You can change any of the records you like, and when you're done, your changes will be saved to the data file. Additionally, you can Add or Delete records using the buttons at the bottom. Any changes you make are not written to the disk until you click the "Save" button. If you press ESC (Cancel) the grid is closed and all changes you made sinse the last save are lost.<br />
<br />
This tool is for programmers only. Do not give your end users access to the DataCrawler.<br />
<br />
Use the DataCrawler at your own risk. Gabriel Bakker and Sage AX are not responsible for any harm that comes to your data files through the use of this or any other tools we offer.<br />
<br />
The DataCrawler is not designed to be used to maintain your data files. It can be used carefully to correct small things in your data files.<br />
<br />
==== Support for Nonstandard Paths ====<br />
<br />
Many BR Vendors keep different versions of the same data files in different locations. For example, sometimes a BR vendor will use a different Data folder to represent data for different Warehouses, or Customers. In cases like this it is necessary for your programs to specify the path to your data files. They may do so by specifying the optional "PATH" parameter to your data files. See the section [[#fnOpenFile]] for more information.<br />
<br />
<br />
==== Support for Nonstandard Layout Files Path ====<br />
<br />
Old versions of the fileIO library required you to place all your file layouts in a subfolder of your program directory called "filelay". We have now changed the Fileio library to allow you to place your file layouts any place you want. The only requirement is that they are all together in one folder by themselves.<br />
<br />
If you use a nonstandard path in the fileIO library, it is necessary to make a change to the [[#fnSettings_.28Global_Settings_Code.29|fnSettings]] code in your copy of fileio.br.<br />
<br />
==== Prompt on Create ====<br />
<br />
The FileIO library automatically creates any data files that it can't find. This was done to make it easier to deploy your finished programs - if you had any empty data files you could omit them from the packages and they would be created when they were needed, on the fly.<br />
<br />
The current version of the FileIO library contains the same ability. However, it prompts you before creating any data files. This helps to avoid bugs that happen from incorrectly specifying the path to your data files.<br />
<br />
However, if you do intend for your data files to be autocreated, then you probably don't want your end users to modify them. Therefore, you can use the PromptOnCreate setting in the [[#fnSettings_.28Global_Settings_Code.29|fnSettings]] code to specify. If this value is set to true, then the fileIO library will prompt you whenever it attempts to Autocreate a data file. If it is set to false, then the fileIO library will create the data files without prompting you, like it always did before.<br />
<br />
==== fnSettings ====<br />
<br />
The newest version of the FileIO library supports some features that require you to specify Global Settings values. These are done by modifying the contents of the [[#fnSettings_.28Global_Settings_Code.29|fnSettings]] routine at the beginning of the fileIO library.<br />
<br />
=== Fall 2006 ===<br />
Many improvements have been made in the FileIO library over the summer. This section is intended to acquaint you with the highlights of those changes. Most of these improvements were built from ideas generated during the discussion at the April conference.<br />
<br />
==== Intermixed String and Numeric Specs ====<br />
The File Library has been expanded to allow the reading of data files that contain mixed string and numeric specs. This is to aid those of you who are planning on implementing the FileIO Library on existing data files which may not be organized with strings first and numbers second.<br />
<br />
The central idea of the FileIO Library is based upon the reading of your data files into a String and Numeric array. This will enable you to refer to the fields in your file by using a named subscript, saying F$(FM_NAME) to refer, for example, to the farm file’s name field. The advantage to this is that when you change the file layout, all your existing programs will not have to be modified, because they will only be looking at F$(FM_NAME). If the name field changes from the third string field to the fourth, the value of FM_NAME will also change, and you won’t have to worry about updating your data files.<br />
<br />
However, in order to support the reading of a data file with intermixed string and numeric specs, the generated form statement will actually calculate the position of any fields that are not in order, so that the file read statement will still return all string fields first (into your string array) and the numeric fields second (into your numeric array). You do not need to worry about this; the library does it for you. All you have to do is read your file and use the data values.<br />
<br />
The only thing that is required is making sure that all your string subscript names end with a “$”. This will tell the library that they are strings. Thank you, George, for this suggestion.<br />
<br />
==== Versioning / Automatic Updates ====<br />
The file layouts have been expanded to contain a version number. This version number will be used to determine when a file needs to be updated. The version number is the third parameter in the file layout.<br />
<br />
Any time you wish to change your file layouts, simply increment this version number. Each time the library attempts to open a data file, the file’s version is checked and compared with the version in the file layout. If the file layout has been changed (if the version in the file layout is greater then the version in the file) then the file will be updated to the latest version. Depending on the file size this may take a couple of moments. A simple progress bar will be displayed on screen while this is happening. The progress bar will be displayed in its own window, so it should not affect anything your programs may have had on screen.<br />
<br />
The library uses the following procedure for updating a file. First, the file is copied to a backup file (prefixed by the letter ‘o’ for old). So color.dat would become ocolor.dat, and color.key would become ocolor.key. Then the new file is created and marked with the proper version number. (color.dat, color.key). The old file is opened in read-only mode, and the new file is opened for OutIn. The update routine actually reads through the old file layout, and one record at a time creates a new record, using the new file layout, with the same data, saving it to the new data file.<br />
<br />
When it is done upgrading, the progress bar window is closed, and the file is reopened in the fashion you described in your call to fnOpen, and flow returns to your program as though nothing unusual has happened.<br />
<br />
If an error occurs during processing, the routine will do what it can to roll your data files back to the previous version, but please make frequent backups of your data files anyway, just to be safe.<br />
<br />
==== Error Checking – If there is a mistake in the file layout ====<br />
The routine attempts to discover the cause of the error in the case that one is encountered due to a missing file, a file sharing violation, or an invalid or corrupt file layout. If this should happen, the program is paused, and a text message is printed out explaining the most likely source for the error, including what part of the file layout, if any, may have caused the error.<br />
<br />
You may then examine the printed text, and the contents of the BR system variables ERR and LINE to determine the problem. If you type “GO”, the next line will be execute “system”, ending your program.<br />
<br />
If the file was in the middle of an upgrade when the error happened, it will be automatically rolled back to the previous version, so that when you fix the problem and try to run your program again, the file will again attempt to update from the beginning, and you won’t have to worry about corrupted data.<br />
<br />
However, please backup your data before upgrading your data files anyway, just to be safe.<br />
<br />
==== Implementation of Keys / Creation of New Data Files ====<br />
The library has been expanded to automatically create all new data files, and to automatically update any existing files. This means that in the file layout header, two new fields that were previously ignored are no longer ignored. The RECL value that you specify in your file layout will be used, along with the description/definition of your keys file. When you open a new file (or update an existing one), the library will calculate the proper kps and kln by evaluating the key description. This key description must match up with subscript values from the data elements in your file, and more then one may be specified, but they must be separated with slashes (/). If I wanted my Farm File to be keyed based on CODE and NAME, the proper key description would be:<br />
<br />
farm.key, CODE/NAME<br />
<br />
The library will then look up the position and length on disk of the CODE and NAME fields and put them together to create the proper keys during an update or creation of a new file. <br />
<br />
==== DataCrawler ====<br />
Perhaps the most exciting new addition to the library is the addition of a programming tool I like to call a DataCrawler. If you run the FileIO Library directly as a program, instead of using it as a library, it will function as a DataCrawler. The DataCrawler requires a New Gui version of BR, as it requires a ListView to be able to properly and easily display the data in your files.<br />
<br />
If you run it in an older version of BR you will get a message, telling you to run it in a newer copy. If you run it in a New Gui version of BR with CONFIG GUI OFF, then GUI will be turned temporarily on for the use of the DataCrawler and then turned off again when you are finished. If you run it in a New Gui version of BR with GUI ON, it will just run normally.<br />
<br />
When you run the DataCrawler, first you will see a ListView displaying every file layout it can find in the filelay folder. If you select a file, the DataCrawler will open a large ListView with as many columns as there are fields in the file. The Column Headings will come from the element descriptions in your data files, and the column widths will come from the displayed width of the fields. There will be a row for every record in your data file, and you can resize the column widths, and scroll around the data file to view the raw data of your BR data files on disk.<br />
<br />
If you are dealing with a particularly enormous data file (50,000+ records) it can take a moment to populate the ListView with the data in your data file. You may hit ESC to stop loading if you like, and view only the already loaded records.<br />
<br />
If you would like to look up a particular record (based only upon the primary key for the data file), you may press F4. This will give you a window which asks you to input the key or partial key. When you press enter, the file will be reloaded, starting at the key you specified and continuing on to the end of the file, or until you press ESC. The records you are looking for should appear at the top of the ListView.<br />
<br />
To reset the ListView and look at the contents of the entire file again, simply press F4, and enter a blank (“”) key.<br />
<br />
Finally, as with any ListView, you may resort your data by clicking on any of the column headings. Then you can use the slider bar at the right to scroll down to the record you desire.<br />
<br />
This is a programming tool and is not designed to be used by an end user. This tool will open your file in read-only mode. It will not allow you to modify the data; I leave that as an exercise for the reader. However, it will update any datafiles you view to the latest version (if they need to be updated) when it opens them, just as any other program that uses the library will do.<br />
<br />
== Appendix (Examples)==<br />
<br />
=== Example.br ===<br />
00010 ! example.br - This program is an example of for the data reading simplification<br />
00020 ! Copyright April 2006 by Gabriel Bakker<br />
00030 ! Distributed open source as a Christmas gift to brag members<br />
00040 !<br />
00100 execute "config gui off"<br />
01020 DIM form$(1)*255<br />
01030 DIM color$(1)*255,color(1)<br />
01040 DIM colorcat$(1)*255,colorcat(1)<br />
02020 library "fileio": fnopenfile, fnreaddescription$<br />
04000 !<br />
04010 Openfiles: ! Open your files here<br />
04020 let colorfile=fnopen("color",mat color$,mat color,mat form$)<br />
04030 let colorcatfile=fnopen("colorcat",mat colorcat$,mat colorcat,mat form$,1)<br />
06000 ! gosub WriteFiles ! If you want to test this line, make sure to drop flag from 4030<br />
07000 !<br />
07010 MainBit: ! This'un here's tha Main Bit<br />
07030 RESTORE #ColorFile:<br />
07100 ReadNextcolor: ! Read next record<br />
07120 read #ColorFile, using form$(ColorFile) : mat Color$, mat Color eof EndReadColor<br />
07180 PRINT Color$(co_name)&" ("&Color$(co_html)&") is a member of the '";<br />
07190 PRINT trim$(fnReadDescription$(ColorcatFile,cc_Name,Color$(co_category),mat Colorcat$,mat Colorcat,mat form$))&"' category."<br />
07290 goto ReadNextColor<br />
07300 EndReadcolor: ! Finished with Color File<br />
08000 STOP<br />
25000 !<br />
25010 WriteFiles: ! Uncalled routine to demonstrate writing files<br />
25105 let color$(co_code)="GD" !:<br />
let color$(co_Name)="Gold" !:<br />
let color$(co_Category)="YL" !:<br />
let color$(co_html)="FFD700"<br />
25110 write #colorfile, using form$(colorfile): mat color$, mat color<br />
25115 let color$(co_code)="LV" !:<br />
let color$(co_Name)="Lavender" !:<br />
let color$(co_Category)="BL" !:<br />
let color$(co_html)="E6E6FA"<br />
25120 write #colorfile, using form$(colorfile): mat color$, mat color<br />
25125 let color$(co_Code)="OR" !:<br />
let color$(co_Name)="Orange" !:<br />
let color$(co_Category)="YL" !:<br />
let color$(co_html)="FFA500"<br />
25130 write #colorfile, using form$(colorfile): mat color$, mat color<br />
25205 let colorcat$(cc_Code)="YL" !:<br />
let colorcat$(cc_Name)="Yellows" !:<br />
let colorcat$(cc_html)="FFFF00"<br />
25210 write #colorcatfile, using form$(colorcatfile): mat colorcat$,mat colorcat<br />
25215 let colorcat$(cc_Code)="BL" !:<br />
let colorcat$(cc_Name)="Blues" !:<br />
let colorcat$(cc_html)="0000FF"<br />
25220 write #colorcatfile, using form$(colorcatfile): mat colorcat$,mat colorcat<br />
25300 return<br />
40000 !<br />
40010 Open: ! ***** Function to call library openfile and proc subs<br />
40020 def fnOpen(FILENAME$, MAT F$, MAT F, MAT FORM$;INPUTONLY,KEYNUM,___,INDEX)<br />
40025 dim _FileIOSubs$(1)*50<br />
40030 let fnopen=fnopenfile(FILENAME$, MAT F$, MAT F, MAT FORM$,INPUTONLY,KEYNUM,MAT _FileIOSubs$)<br />
40040 for Index=1 to udim(mat _FileIOSubs$) : execute (_FileIOSubs$(Index)) : next Index<br />
40090 fnend<br />
50000 !<br />
60000 Ignore: Continue<br />
<br />
Color File Layout<br />
color.dat, CO_, 1<br />
color.key, CODE<br />
recl=127<br />
===================================================<br />
CODE$, Color Code, C 6<br />
NAME$, English Name for Color, V 30<br />
CATEGORY$, General Category of Color, C 6<br />
HTML$, HTML Code for the Color, C 6<br />
<br />
ColorCat File Layout<br />
colorcat.dat, CC_, 0<br />
colorcat.key, CODE<br />
recl=127<br />
===================================================<br />
CODE$, Category Code, C 6<br />
NAME$, English Name for Color, V 30<br />
HTML$, HTML Code for the Color, C 6<br />
<br />
Example Layout showing multiple keys (price)<br />
price.dat, PR_, 0<br />
price.key, FARM<br />
price.ky2, ITEM<br />
price.ky3, FARM/ITEM/GRADE<br />
recl=127<br />
===================================================<br />
FARM$, Farm Code (or blank), C 4<br />
ITEM$, Item Code, C 4<br />
GRADE$, Quality, C 4<br />
X, Empty, X 37<br />
PRICE, Default Price, BH 3.2<br />
COST, Default Cost, BH 3.2<br />
XOPRICE, Default Christmas Price, BH 3.2<br />
XOCOST, Default Christmas Cost, BH 3.2<br />
MOPRICE, Default Mothers D Price, BH 3.2<br />
MOCOST, Default Mothers D Cost, BH 3.2<br />
VOPRICE, Default Valentine Price, BH 3.2<br />
VOCOST, Default Valentine Cost, BH 3.2<br />
<br />
[[Category:Utilities_Third_Party]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=BR_Web_Scripting_Bridge&diff=3447BR Web Scripting Bridge2013-06-19T03:08:24Z<p>Admin: 1 revision</p>
<hr />
<div>The '''BR Web Scripting Bridge''' is a [[PHP]] class that has the ability to run BR! programs and display the resulting output on a website. Using the BR Web Scripting Bridge, it is easy to create web interfaces to your BR data, and you don't have to know a thing about PHP. Simply drop the BR Web Scripting Bridge and a copy of BR on your web server and start writing your code in BR.<br />
<br />
See also:<br />
*[[HTTP]]<br />
*[http://brwebscriptingb.sourceforge.net/ SourceForge Project].<br />
<br />
<br />
=== The Method ===<br />
<br />
When a page is requested from your web server, your BR code is executed with a bit of PHP script.<br />
<br />
To use the BR Web Scripting Bridge, you simply write BR programs that print to standard out. This output is then returned to the web browser.<br />
<br />
We created a reusable PHP file that will call a BR program of the same name. Then you copy the included PHP template file and rename it to match your program name. The php file tells the web server to run your BR program and display the resulting output.<br />
<br />
Input to your programs is provided in the form of a set of predefined variables. These variables contain all data that is sent when a form is submitted by the users web browser.<br />
<br />
Using these methods, virtually any web application or http service can be built entirely in BR. Your pages can utilize any of the technologies currently seen in web pages such as Flash, JavaScript, and AJAX.<br />
<br />
=== Requirements ===<br />
<br />
*[http://brwebscriptingb.sourceforge.net/ BR Web Scripting Bridge]<br />
*[http://www.apache.org/ Apache Web Server]<br />
*[http://www.php.net/ PHP]<br />
<br />
=== Examples ===<br />
Here are some examples of the BR Web Scripting Bridge in action:<br />
<br />
*[[#Example 1|Example 1]]: http://www.sageax.com/bridgedemo/adapter.php?BR_SOURCE=src/webcrawl.brs<br />
*[[#Example 2|Example 2]]: http://www.sageax.com/bridgedemo/adapter.php?BR_SOURCE=src/csscrawl.brs<br />
*[[#Example 3|Example 3]]: http://www.sageax.com/bridgedemo/adapter.php?BR_SOURCE=src/itemlist.brs<br />
*[[#Example 4|Example 4]]: http://www.sageax.com/bridgedemo/adapter.php?BR_SOURCE=src/select.brs<br />
<br />
Each of the above examples are simple web applications created and controlled by a single BR program.<br />
<br />
Each Example consists of a simple three line php file, the BR Web Scripting Bridge, and a single BR program. The .php file is a completely generic .php file. The only thing it does is to find and launch the .br file of the same name. All you have to do is rename it so the name matches the name of your br program.<br />
<br />
We named our first example webcrawl, and created a br program called webcrawl to run the example web page.<br />
The second example is called itemlist, and it and all the others are identical to webcrawl.<br />
<br />
<?PHP<br />
include('class.brphp.php');<br />
$br = new brphp();<br />
$br->RunBrCodeBehind($_SERVER['PHP_SELF']);<br />
?><br />
<br />
The generic php code above simply launches the br code below and displays the output in your browser.<br />
<br />
====Example 1====<br />
<br />
http://www.sageax.com/bridgedemo/webcrawl.php<br />
<br />
The above website is created from a simple BR program shown below. This example program uses the [[FileIO Library]] (not shown) to read data out of my data files in my suite of sample programs and sample data. You choose the data file to view from the drop down. When you press the "View File" button, the php server calls BR and returns the results of the file you chose.<br />
<br />
<pre><br />
<br />
01000 ! WebCrawl - Copyright August 2008 By Gabriel Bakker #Autonumber# 1000,10<br />
01010 !<br />
01020 ! Created August 4th, 2008<br />
01030 !<br />
01040 ! This Program Dynamically Generates Html From Your Br Internal Data Files.<br />
01050 !<br />
01060 ! This Program Requires Fileio To Function And Only Works With Br Internal<br />
01070 ! Data Files That Are Described In A Fileio Compatable File Layout Format.<br />
01080 !<br />
01090 ! This Program Was Designed To Be Called From A Php Web Site, As An Example<br />
01100 ! Of The New Ability To Expose Your Br Data To The Web Using These Tools.<br />
01110 ! This Program Is An Example Of A Br "CodeBehind" For Php. It Is A Complete<br />
01120 ! Br Powered Web Site<br />
01130 !<br />
01170 !<br />
01180 !<br />
01190 ! With The BR Web Scripting Bridge Your Program Runs In Response To The User<br />
01200 ! Clicking On A Php Web Object Such As A Button. The Button Tells The Php<br />
01210 ! To Reload With The Newly Entered Data, And The Php Server Calls Your Br<br />
01220 ! Program. Mat _Post$ Contains All The Data The User May Have Entered In<br />
01230 ! Your Web Site.<br />
01240 !<br />
01250 ! You Interpret Mat Post$ And Decide What Needs To Be Done.<br />
01260 !<br />
01270 ! This Example Is Quite Simple:<br />
01280 !<br />
01300 !<br />
01310 if Trim$(_Post$(1))="" then ! If The User Did Not Select A File Layout From The List Then<br />
01320 let Fnreadlayoutfolder ! Display The File Layout List In A Table<br />
01330 else<br />
01340 let Fnreadfileio(Trim$(_Post$(1))) ! But If They Did Select A File, Then Show It<br />
01350 end if<br />
01360 !<br />
01370 stop<br />
01380 !<br />
01390 !<br />
01400 !<br />
10000 ! #Autonumber# 10000,10<br />
10010 READFILEIO: ! ***** Generate Html From Br Internal Data Files<br />
10020 def Fnreadfileio(Layoutname$*80;Keynum,Path$*255,_Inputfile,_Index)<br />
10030 !<br />
10040 dim F$(1)*255, F(1)<br />
10050 dim Forms$(1)*255<br />
10060 dim Descr$(1)*255, Widths(1)<br />
10070 !<br />
10080 library "fileio" : Fnopenfile, Fngetfilenumber,Fnreadlayouts<br />
10090 dim Directorylist$(1)*255<br />
10100 !<br />
10110 let Fnreadlayouts(Mat Directorylist$)<br />
10120 !<br />
10130 let _Inputfile=Fnopen(Layoutname$,Mat F$,Mat F,Mat Forms$,1,Keynum,0,Path$,Mat Descr$)<br />
10140 if Udim(Mat Directorylist$) then<br />
10150 !<br />
10170 print '<html xmlns="http://www.w3.org/1999/xhtml">'<br />
10180 print '<head>'<br />
10190 print '<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />'<br />
10200 print '</head>'<br />
10210 print '<body>'<br />
10220 print ' <form id="FileData" name="FileData" method="post" action="">'<br />
10230 print ' <label>'<br />
10240 print ' <p><div align="center">File Layout:'<br />
10250 print ' <select name="FileLayout">'<br />
10260 print ' <option value="">All...</option>'<br />
10270 for _Index=1 to Udim(Mat Directorylist$)<br />
10280 print ' <option value="'<br />
&Trim$(Directorylist$(_Index))&'">'&Trim$(Directorylist$(_Index))&'</option>'<br />
10290 next _Index<br />
10300 print ' </select>'<br />
10310 print ' <p><input type="submit" name="Submit" value="View File" />'<br />
10320 print ' </div>'<br />
10330 print ' </label>'<br />
10340 print ' </form>'<br />
10350 !<br />
10360 end if<br />
10370 !<br />
10380 !<br />
10390 if _Inputfile then<br />
10400 !<br />
10410 print '<title>HTML View for '&Layoutname$&' file.</title>'<br />
10420 print '<p align="center"><b>HTML View for '&Layoutname$&' file.</b></p>'<br />
10430 print ''<br />
10440 print '<table align="center" border="1">'<br />
10450 !<br />
10460 print ' <tr>'<br />
10470 for _Index=1 to Udim(Mat Descr$)<br />
10480 print ' <th scope="col">'&Descr$(_Index)&'</th>'<br />
10490 next _Index<br />
10500 print ' </tr>'<br />
10510 !<br />
10520 do<br />
10530 read #_Inputfile, using Forms$(_Inputfile): Mat F$, Mat F eof IGNORE<br />
10540 if File(_Inputfile)=0 then ! Read Successful<br />
10550 print ' <tr>'<br />
10560 for _Index=1 to Udim(Mat F$)<br />
10570 print ' <td>'&F$(_Index)&'</td>'<br />
10580 next _Index<br />
10590 for _Index=1 to Udim(Mat F)<br />
10600 print ' <td>'&Str$(F(_Index))&'</td>'<br />
10610 next _Index<br />
10620 print ' </tr>'<br />
10630 end if<br />
10640 loop While File(_Inputfile)=0<br />
10650 !<br />
10660 print '</table>'<br />
10670 print '</body>'<br />
10680 print '</html>'<br />
10690 !<br />
10700 close #_Inputfile:<br />
10710 end if<br />
10720 fnend<br />
10730 !<br />
11000 ! #Autonumber# 11000,10<br />
11010 READLAYOUTFOLDER: ! Generate A Table Listing The Names Of All Your File Layouts<br />
11020 def Fnreadlayoutfolder(;_Index)<br />
11030 !<br />
11040 library "fileio" : Fnreadlayouts, Fngetfilenumber<br />
11050 dim Directorylist$(1)*255<br />
11060 !<br />
11070 let Fnreadlayouts(Mat Directorylist$)<br />
11080 !<br />
11090 if Udim(Mat Directorylist$) then<br />
11100 !<br />
11120 print '<html xmlns="http://www.w3.org/1999/xhtml">'<br />
11130 print '<head>'<br />
11140 print '<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />'<br />
11150 print '</head>'<br />
11160 print '<body>'<br />
11170 print ' <form id="FileData" name="FileData" method="post" action="">'<br />
11180 print ' <label>'<br />
11190 print ' <p><div align="center">File Layout:'<br />
11200 print ' <select name="FileLayout">'<br />
11210 print ' <option value="">All...</option>'<br />
11220 for _Index=1 to Udim(Mat Directorylist$)<br />
11230 print ' <option value="'&<br />
Trim$(Directorylist$(_Index))&'">'&Trim$(Directorylist$(_Index))&'</option>'<br />
11240 next _Index<br />
11250 print ' </select>'<br />
11260 print ' <p><input type="submit" name="Submit" value="View File" />'<br />
11270 print ' </div>'<br />
11280 print ' </label>'<br />
11290 print ' </form>'<br />
11300 print ' <p align="center"><b>Layout Files</b></p>'<br />
11310 print ''<br />
11320 print ' <table align="center" border="1">'<br />
11330 !<br />
11340 print ' <tr>'<br />
11350 print ' <th scope="col">Layout</th>'<br />
11360 print ' </tr>'<br />
11370 !<br />
11380 for _Index=1 to Udim(Mat Directorylist$)<br />
11390 print ' <tr>'<br />
11400 print ' <td><div align="center">'&Directorylist$(_Index)&'</div></td>'<br />
11410 print ' </tr>'<br />
11420 next _Index<br />
11430 !<br />
11440 print ' </table>'<br />
11450 print '</body>'<br />
11460 print '</html>'<br />
11470 !<br />
11480 end if<br />
11490 fnend<br />
11500 !<br />
99000 ! #Autonumber# 99000,10<br />
99010 OPEN: ! ***** Function To Call Library Openfile And Proc Subs<br />
99020 def Fnopen(Filename$, Mat F$, Mat F, Mat Form$; Inputonly, Keynum, Dont_Sort_Subs, <br />
Path$*255, Mat Descr$, Mat Field_Widths)<br />
99030 let Fnopen=Fnopenfile(Filename$, Mat F$, Mat F, Mat Form$, Inputonly, Keynum, <br />
Dont_Sort_Subs, Path$, Mat Descr$, Mat Field_Widths)<br />
99040 execute ("*proc subs.$$$")<br />
99050 fnend<br />
99060 !<br />
99980 ! #Autonumber# 99980,10<br />
99990 IGNORE: continue<br />
<br />
</pre><br />
<br />
====Example 2====<br />
<br />
http://www.sageax.com/bridgedemo/csscrawl.php<br />
<br />
Our first example was simple and exciting but the web page didn't look very nice. For our next example, we're going to take the same program, and apply a Cascading Style Sheet to make it look a little bit nicer.<br />
<br />
Cascading Style Sheets, or CSS files, are replaceable templates that affect the overall look, or style, of a web page. When you design a web site, if you put all your style settings in a CSS file, you can change them all later by simply replacing the CSS file, without having to modify the site itself.<br />
<br />
Additionally, you can find many CSS files online that you can just drop into your applications.<br />
<br />
For this example, we'll be taking a CSS file called style.css that contains a bunch of nice styles for tables. We'll be using it to spruce up the appearance of the tables from the example before.<br />
<br />
To use CSS, all we have to do is modify the header to include the style sheet, and modify the tables to use it.<br />
<br />
<pre><br />
<br />
10160 print '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" <br />
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'<br />
10170 print '<html xmlns="http://www.w3.org/1999/xhtml">'<br />
10180 print '<head>'<br />
10190 print ' <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />'<br />
10200 print ' <link href="style.css" rel="stylesheet" type="text/css">'<br />
10210 print '</head>'<br />
<br />
</pre><br />
<br />
In line 10160, we declare the file as an xhtml file as opposed to a regular html file. In line 10200, we include the style sheet.<br />
<br />
<pre><br />
<br />
10450 print '<table id="hor-minimalist-b" align="center">'<br />
10470 print ' <thead>'<br />
10480 print ' <tr>'<br />
10490 for _Index=1 to Udim(Mat Descr$)<br />
10500 print ' <th scope="col">'&Descr$(_Index)&'</th>'<br />
10510 next _Index<br />
10520 print ' </tr>'<br />
10530 print ' </thead>'<br />
<br />
</pre><br />
<br />
Line 10450 tells the table to use the CSS style "hor-minimalist-b" from the included file.<br />
<br />
Notice the <thead> and </thead> tags above. We also need to specify a <thead> and a <tbody>, so that the style knows what to apply to each part of the table.<br />
<br />
<pre><br />
<br />
10550 print ' <tbody>'<br />
10610 print ' <td>'&F$(_Index)&'</td>'<br />
10640 print ' <td>'&Str$(F(_Index))&'</td>'<br />
10700 print ' </tbody>'<br />
10710 print '</table>'<br />
10720 print '</body>'<br />
10730 print '</html>'<br />
<br />
</pre><br />
<br />
We draw the body of the table just like before, adding the <tbody> and </tbody> tags.<br />
<br />
Here is the full example. The code is almost identical to Example 1 but looks a lot nicer when you run it.<br />
<br />
<pre><br />
<br />
01000 ! CssCrawl - Copyright August 2008 By Gabriel Bakker #Autonumber# 1000,10<br />
01010 !<br />
01020 ! Created August 4th, 2008<br />
01030 !<br />
01040 ! This Program Dynamically Generates Html From Your Br Internal Data Files.<br />
01050 !<br />
01060 ! This Program Requires Fileio To Function And Only Works With Br Internal<br />
01070 ! Data Files That Are Described In A Fileio Compatable File Layout Format.<br />
01080 !<br />
01090 ! This Program Was Designed To Be Called From A Php Web Site, As An Example<br />
01100 ! Of The New Ability To Expose Your Br Data To The Web Using These Tools.<br />
01110 ! This Program Is An Example Of A Br "CodeBehind" For Php. It Is A Complete<br />
01120 ! Br Powered Web Site<br />
01130 !<br />
01140 ! This Library Is Intended To Be Implemented With The Br Phprun System And<br />
01150 ! The Fileio Library.<br />
01160 !<br />
01170 !<br />
01180 !<br />
01190 ! With Br Php, Your Program Runs In Response To The User Clicking On<br />
01200 ! A Php Web Object Such As A Button. The Button Tells The Php To Reload<br />
01210 ! With The Newly Entered Data, And The Php Server Calls Your Br Program.<br />
01220 ! Mat _Post$ Contains All The Data The User May Have Entered In Your Web<br />
01230 ! Site.<br />
01240 !<br />
01250 ! You Interpret Mat Post$ And Decide What Needs To Be Done.<br />
01260 !<br />
01270 ! This Example Is Quite Simple:<br />
01280 !<br />
01290 !<br />
01300 if Trim$(_Post$(1))="" then ! If The User Did Not Select A File Layout From The List Then<br />
01310 let Fnreadlayoutfolder ! Display The File Layout List In A Table<br />
01320 else<br />
01330 let Fnreadfileio(Trim$(_Post$(1))) ! But If They Did Select A File, Then Show It<br />
01340 end if<br />
01350 !<br />
01360 stop<br />
01370 !<br />
01380 !<br />
01390 !<br />
10000 ! #Autonumber# 10000,10<br />
10010 READFILEIO: ! ***** Generate Html From Br Internal Data Files<br />
10020 def Fnreadfileio(Layoutname$*80;Keynum,Path$*255,_Inputfile,_Index)<br />
10030 !<br />
10040 dim F$(1)*255, F(1)<br />
10050 dim Forms$(1)*255<br />
10060 dim Descr$(1)*255, Widths(1)<br />
10070 !<br />
10080 library "fileio" : Fnopenfile, Fngetfilenumber,Fnreadlayouts<br />
10090 dim Directorylist$(1)*255<br />
10100 !<br />
10110 let Fnreadlayouts(Mat Directorylist$)<br />
10120 !<br />
10130 let _Inputfile=Fnopen(Layoutname$,Mat F$,Mat F,Mat Forms$,1,Keynum,0,Path$,Mat Descr$)<br />
10140 if Udim(Mat Directorylist$) then<br />
10150 !<br />
10160 print '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" <br />
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'<br />
10170 print '<html xmlns="http://www.w3.org/1999/xhtml">'<br />
10180 print '<head>'<br />
10190 print ' <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />'<br />
10200 print ' <link href="style.css" rel="stylesheet" type="text/css">'<br />
10210 print '</head>'<br />
10220 print '<body>'<br />
10230 print ' <form id="FileData" name="FileData" method="post" action="">'<br />
10240 print ' <label>'<br />
10250 print ' <p><div align="center">File Layout:'<br />
10260 print ' <select name="FileLayout">'<br />
10270 print ' <option value="">All...</option>'<br />
10280 for _Index=1 to Udim(Mat Directorylist$)<br />
10290 print ' <option value="'&<br />
Trim$(Directorylist$(_Index))&'">'&Trim$(Directorylist$(_Index))&'</option>'<br />
10300 next _Index<br />
10310 print ' </select>'<br />
10320 print ' <p><input type="submit" name="Submit" value="View File" />'<br />
10330 print ' </div>'<br />
10340 print ' </label>'<br />
10350 print ' </form>'<br />
10360 !<br />
10370 end if<br />
10380 !<br />
10390 !<br />
10400 if _Inputfile then<br />
10410 !<br />
10420 print '<title>HTML View for '&Layoutname$&' file.</title>'<br />
10430 print '<p align="center"><b>HTML View for '&Layoutname$&' file.</b></p>'<br />
10440 print ''<br />
10450 print '<table id="hor-minimalist-b" align="center">'<br />
10460 !<br />
10470 print ' <thead>'<br />
10480 print ' <tr>'<br />
10490 for _Index=1 to Udim(Mat Descr$)<br />
10500 print ' <th scope="col">'&Descr$(_Index)&'</th>'<br />
10510 next _Index<br />
10520 print ' </tr>'<br />
10530 print ' </thead>'<br />
10540 !<br />
10550 print ' <tbody>'<br />
10560 do<br />
10570 read #_Inputfile, using Forms$(_Inputfile): Mat F$, Mat F eof IGNORE<br />
10580 if File(_Inputfile)=0 then ! Read Successful<br />
10590 print ' <tr>'<br />
10600 for _Index=1 to Udim(Mat F$)<br />
10610 print ' <td>'&F$(_Index)&'</td>'<br />
10620 next _Index<br />
10630 for _Index=1 to Udim(Mat F)<br />
10640 print ' <td>'&Str$(F(_Index))&'</td>'<br />
10650 next _Index<br />
10660 print ' </tr>'<br />
10670 end if<br />
10680 loop While File(_Inputfile)=0<br />
10690 !<br />
10700 print ' </tbody>'<br />
10710 print '</table>'<br />
10720 print '</body>'<br />
10730 print '</html>'<br />
10740 !<br />
10750 close #_Inputfile:<br />
10760 end if<br />
10770 fnend<br />
10780 !<br />
11000 ! #Autonumber# 11000,10<br />
11010 READLAYOUTFOLDER: ! Generate A Table Listing The Names Of All Your File Layouts<br />
11020 def Fnreadlayoutfolder(;_Index)<br />
11030 !<br />
11040 library "fileio" : Fnreadlayouts, Fngetfilenumber<br />
11050 dim Directorylist$(1)*255<br />
11060 !<br />
11070 let Fnreadlayouts(Mat Directorylist$)<br />
11080 !<br />
11090 if Udim(Mat Directorylist$) then<br />
11100 !<br />
11110 print '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" <br />
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'<br />
11120 print '<html xmlns="http://www.w3.org/1999/xhtml">'<br />
11130 print '<head>'<br />
11140 print ' <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />'<br />
11150 print ' <link href="style.css" rel="stylesheet" type="text/css">'<br />
11160 print '</head>'<br />
11170 print '<body>'<br />
11180 print ' <form id="FileData" name="FileData" method="post" action="">'<br />
11190 print ' <label>'<br />
11200 print ' <p><div align="center">File Layout:'<br />
11210 print ' <select name="FileLayout">'<br />
11220 print ' <option value="">All...</option>'<br />
11230 for _Index=1 to Udim(Mat Directorylist$)<br />
11240 print ' <option value="'&<br />
Trim$(Directorylist$(_Index))&'">'&Trim$(Directorylist$(_Index))&'</option>'<br />
11250 next _Index<br />
11260 print ' </select>'<br />
11270 print ' <p><input type="submit" name="Submit" value="View File" />'<br />
11280 print ' </div>'<br />
11290 print ' </label>'<br />
11300 print ' </form>'<br />
11310 print ' <p align="center"><b>Layout Files</b></p>'<br />
11320 print ''<br />
11330 print ' <table id="hor-minimalist-b" align="center">'<br />
11340 !<br />
11350 print ' <thead>'<br />
11360 print ' <tr>'<br />
11370 print ' <th scope="col">Layout</th>'<br />
11380 print ' </tr>'<br />
11390 print ' </thead>'<br />
11400 !<br />
11410 print ' <tbody>'<br />
11420 for _Index=1 to Udim(Mat Directorylist$)<br />
11430 print ' <tr>'<br />
11440 print ' <td><div align="center">'&Directorylist$(_Index)&'</div></td>'<br />
11450 print ' </tr>'<br />
11460 next _Index<br />
11470 !<br />
11480 print ' </tbody>'<br />
11490 print ' </table>'<br />
11500 print '</body>'<br />
11510 print '</html>'<br />
11520 !<br />
11530 end if<br />
11540 fnend<br />
11550 !<br />
99000 ! #Autonumber# 99000,10<br />
99010 OPEN: ! ***** Function To Call Library Openfile And Proc Subs<br />
99020 def Fnopen(Filename$, Mat F$, Mat F, Mat Form$; Inputonly, Keynum, Dont_Sort_Subs,<br />
Path$*255, Mat Descr$, Mat Field_Widths)<br />
99030 let Fnopen=Fnopenfile(Filename$, Mat F$, Mat F, Mat Form$, Inputonly, Keynum, <br />
Dont_Sort_Subs, Path$, Mat Descr$, Mat Field_Widths)<br />
99040 execute ("*proc subs.$$$")<br />
99050 fnend<br />
99060 !<br />
99980 ! #Autonumber# 99980,10<br />
99990 IGNORE: continue<br />
<br />
</pre><br />
<br />
====Example 3====<br />
<br />
http://www.sageax.com/bridgedemo/itemlist.php<br />
<br />
Example 3 demonstrates how to dynamically ask the user for information from your BR program.<br />
<br />
This simple BR program reads a list of groceries from the items file and generates a web form where a grocer could order items directly over the internet. The grocer enters quantities in the quantities field for any items he wishes to purchase and presses the "Ok" button when done. The page is submitted again to our program, this time with the MAT _POST$ array populated with all the data the grocer entered into the form. The program processes the data, adding up the quantities and prints out a "Congratulations, your order was successful!" page.<br />
<br />
If this were a real life program, you would simply save the new order back into your BR data files.<br />
<br />
<pre><br />
<br />
10000 ! Itemlist - Copyright August 2008 By Sage Ax #Autonumber# 10000,10<br />
10010 !<br />
10020 ! Created August 20th, 2008<br />
10030 !<br />
10040 ! This Program Dynamically Generates Html From Your Br Internal Data Files.<br />
10050 !<br />
10060 ! This Program Requires Fileio To Function And Only Works With Br Internal<br />
10070 ! Data Files That Are Described In A Fileio Compatable File Layout Format.<br />
10080 !<br />
10090 ! This Program Was Designed To Be Called From A Php Web Site, As An Example<br />
10100 ! Of The New Ability To Expose Your Br Data To The Web Using These Tools.<br />
10110 ! This Program Is An Example Of A Br "CodeBehind" For Php. It Is A Complete<br />
10120 ! Br Powered Web Site<br />
10130 !<br />
10140 ! This Library Is Intended To Be Implemented With The Br Phprun System And<br />
10150 ! The Fileio Library.<br />
10160 !<br />
10170 !<br />
10180 !<br />
10190 ! With Br Php, Your Program Runs In Response To The User Clicking On<br />
10200 ! A Php Web Object Such As A Button. The Button Tells The Php To Reload<br />
10210 ! With The Newly Entered Data, And The Php Server Calls Your Br Program.<br />
10220 ! Mat _Post$ Contains All The Data The User May Have Entered In Your Web<br />
10230 ! Site.<br />
10240 !<br />
10250 ! You Interpret Mat Post$ And Decide What Needs To Be Done.<br />
10260 !<br />
10270 ! This Example Is Quite Simple:<br />
10280 !<br />
10290 !<br />
10300 !<br />
10310 dim Subs(4)<br />
10320 dim Subn(3)<br />
10330 dim Item$(1)*255, Item(1)<br />
10340 dim Forms$(1)*255<br />
10350 dim Descr$(1)*255, Widths(1)<br />
10360 !<br />
10370 if udim(_post$)>10 then goto DisplayResults<br />
10380 !<br />
10390 library "fileio" : Fnopenfile, Fngetfilenumber<br />
10400 !<br />
10410 let _Inputfile=Fnopen("opditem",Mat Item$,Mat Item,Mat Forms$,1,0,0,"",Mat Descr$)<br />
10420 !<br />
10430 let Subs(1)=It_Item<br />
10440 let Subs(2)=It_Desc<br />
10450 let Subs(3)=It_Um<br />
10460 let Subs(4)=It_Size<br />
10470 let Subn(1)=It_Cost<br />
10480 let Subn(2)=It_Price<br />
10490 let Subn(3)=It_Retail<br />
10500 !<br />
10510 if _Inputfile then<br />
10520 !<br />
10540 print '<html xmlns="http://www.w3.org/1999/xhtml">'<br />
10550 print '<head>'<br />
10560 print '<title>Sample Order Entry</title>'<br />
10570 print '<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />'<br />
10580 print '</head>'<br />
10590 print '<body>'<br />
10600 print '<p align="center"><b>Sample Order Entry</b></p>'<br />
10610 print '<br><br>'<br />
10620 print '<form id="FileData" name="FileData" method="post" action="">'<br />
10630 print '<table align="center" border="1">'<br />
10640 print ' <tr>'<br />
10650 print ' <th scope="col">Qty Ordered</th>'<br />
10660 for _Index=1 to Udim(Mat Subs) ! Print String Captions<br />
10670 print ' <th scope="col">'&Descr$(Subs(_Index))&'</th>'<br />
10680 next _Index<br />
10690 for _Index=1 to Udim(Mat Subn) ! Print Numeric Captions<br />
10700 print ' <th scope="col">'&Descr$(Subn(_Index)+Udim(Mat Item$))&'</th>'<br />
10710 next _Index<br />
10720 print ' </tr>'<br />
10730 !<br />
10740 do<br />
10750 read #_Inputfile, using Forms$(_Inputfile): Mat Item$, Mat Item eof IGNORE<br />
10760 !<br />
10770 if File(_Inputfile)=0 then ! Read Successful<br />
10780 print ' <tr>'<br />
10790 print ' <td><label>'<br />
10800 print ' Qty: <input type="text" name="Qty'&<br />
Item$(It_Item)&'" id="Qty'&Item$(It_Item)&'" />'<br />
10810 print ' </label></td>'<br />
10820 for _Index=1 to Udim(Mat Subs)<br />
10830 print ' <td>'&Item$(Subs(_Index))&'</td>'<br />
10840 next _Index<br />
10850 for _Index=1 to Udim(Mat Subn)<br />
10860 print ' <td>'&Str$(Item(Subn(_Index)))&'</td>'<br />
10870 next _Index<br />
10880 print ' </tr>'<br />
10890 end if<br />
10900 loop While File(_Inputfile)=0<br />
10910 !<br />
10920 print '</table>'<br />
10930 !<br />
10940 print '<p align="center"><label>Submit Order: <input type="submit" name="button" <br />
id="cow" value="Ok" /></label></p>'<br />
10950 !<br />
10960 print '</form>'<br />
10970 print '</body>'<br />
10980 print '</html>'<br />
10990 !<br />
11000 close #_Inputfile:<br />
11010 end if<br />
11020 !<br />
11030 Goto EndProgram<br />
11040 !<br />
11050 DisplayResults: ! Display results<br />
11060 !<br />
11070 For Index=1 to udim(mat _post$)<br />
11080 if Index<>p_button then<br />
11090 TotalQty+=val(_post$(Index)) conv Ignore<br />
11100 end if<br />
11110 next Index<br />
11120 !<br />
11130 print '...........' ! Extra spaces in case of parsing differences<br />
11140 print '<html xmlns="http://www.w3.org/1999/xhtml">'<br />
11150 print '<head>'<br />
11160 print '<title>Order Submitted!</title>'<br />
11170 print '<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />'<br />
11180 print '</head>'<br />
11190 print '<body>'<br />
11200 print '<b><p align="center">Congratulations!!!</p>'<br />
11210 print '<br><br>'<br />
11220 print '<p align="center">Your order for '&str$(TotalQty)&' items has been recieved.'<br />
11230 print '</body>'<br />
11240 print '</html>'<br />
11250 !<br />
11260 EndProgram: ! End program<br />
11270 stop<br />
11280 !<br />
11290 !<br />
99000 ! #Autonumber# 99000,10<br />
99010 OPEN: ! ***** Function To Call Library Openfile And Proc Subs<br />
99020 def Fnopen(Filename$, Mat F$, Mat F, Mat Form$; Inputonly, Keynum, Dont_Sort_Subs, <br />
Path$*255, Mat Descr$, Mat Field_Widths)<br />
99030 let Fnopen=Fnopenfile(Filename$, Mat F$, Mat F, Mat Form$, Inputonly, Keynum, <br />
Dont_Sort_Subs, Path$, Mat Descr$, Mat Field_Widths)<br />
99040 execute ("*proc subs.$$$")<br />
99050 fnend<br />
99060 !<br />
99980 ! #Autonumber# 99980,10<br />
99990 IGNORE: continue<br />
<br />
</pre><br />
<br />
====Example 4====<br />
<br />
http://www.sageax.com/bridgedemo/select.php<br />
<br />
Our next example demonstrates both data entry and multi-program applications.<br />
<br />
This example is in three parts, each controlled by a separate BR program.<br />
<br />
The first br program and php file are called "select". This BR program simply displays the contents of the colorcat file and ask's a user to select a record from it using radio buttons.<br />
<br />
The second BR program and php file are called "edit". This BR program presents the contents of the record the user selected, allowing the user to edit them in a web form.<br />
<br />
The third BR program and PHP file are called "save". This BR program saves the changes the user made and prints a confirmation message.<br />
<br />
select.brs:<br />
<pre><br />
<br />
10000 ! Select - Copyright August 2008 By Sage Ax #Autonumber# 10000,10<br />
10010 !<br />
10020 ! Created August 21st, 2008<br />
10030 !<br />
10040 ! This Program Dynamically Generates Html From Your Br Internal Data Files.<br />
10050 !<br />
10060 ! This Program Requires Fileio To Function And Only Works With Br Internal<br />
10070 ! Data Files That Are Described In A Fileio Compatable File Layout Format.<br />
10080 !<br />
10090 ! This Program Was Designed To Be Called From A Php Web Site, As An Example<br />
10100 ! Of The New Ability To Expose Your Br Data To The Web Using These Tools.<br />
10110 ! This Program Is An Example Of A Br "CodeBehind" For Php. It Is A Complete<br />
10120 ! Br Powered Web Site<br />
10130 !<br />
10140 ! This Library Is Intended To Be Implemented With The Br Phprun System And<br />
10150 ! The Fileio Library.<br />
10160 !<br />
10170 !<br />
10180 !<br />
10190 ! This Program Is The First Part In A Three Part Demonstration Showing How<br />
10200 ! You Can Use A Seperate Program For Each "Step" In The Process.<br />
10210 !<br />
10220 ! In This Stage In The Process, The User Is Presented With A Selection Screen<br />
10230 ! On Which They Can Select A Colorcat Record To Edit. We'll also show the<br />
10240 ! Entire Contents Of The Colorcat File On The Screen For Review.<br />
10250 !<br />
10260 !<br />
10270 dim Colorcat$(1)*255, Colorcat(1)<br />
10280 dim Forms$(1)*255<br />
10290 dim Descr$(1)*255, Widths(1)<br />
10300 !<br />
10310 library "fileio" : Fnopenfile, Fngetfilenumber<br />
10320 !<br />
10330 let _Inputfile=Fnopen("colorcat",Mat Colorcat$,Mat Colorcat,Mat Forms$,1,0,0,"",Mat Descr$)<br />
10340 !<br />
10360 print '<html xmlns="http://www.w3.org/1999/xhtml">'<br />
10370 print '<head>'<br />
10380 print '<title>Select a record</title>'<br />
10390 print '<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />'<br />
10400 print '</head>'<br />
10410 print '<body>'<br />
10420 print '<br>'<br />
10430 print '<br>'<br />
10440 print '<form id="Colorcat" name="colorcat" method="post" action="edit.php">'<br />
10450 !<br />
10460 print ' <p align="center">Select a record and press Edit.<br>'<br />
10470 print ' <input type="submit" name="button" value="Edit" />'<br />
10480 print ' </p>'<br />
10490 !<br />
10500 print '<table align="center" border="1">'<br />
10510 print ' <tr>'<br />
10520 print ' <th scope="col">Select</th>'<br />
10530 for _Index=1 to Udim(Mat Descr$) ! Print String Captions<br />
10540 print ' <th scope="col">'&Descr$(_Index)&'</th>'<br />
10550 next _Index<br />
10560 print ' </tr>'<br />
10570 !<br />
10580 do<br />
10590 read #_Inputfile, using Forms$(_Inputfile): Mat Colorcat$, Mat Colorcat eof IGNORE<br />
10600 if File(_Inputfile)=0 then ! Read Successful<br />
10610 print ' <tr bgcolor="'&Colorcat$(Cc_Html)&'">'<br />
10620 print '<td> <input name="key" type="radio" value="'&Colorcat$(Cc_Code)&'" /></td>'<br />
10630 for _Index=1 to Udim(Mat Colorcat$)<br />
10640 print ' <td>'&Colorcat$(_Index)&'</td>'<br />
10650 next _Index<br />
10660 print ' </tr>'<br />
10670 end if<br />
10680 loop While File(_Inputfile)=0<br />
10690 !<br />
10700 print '</table>'<br />
10710 !<br />
10720 print '</form>'<br />
10730 print '</body>'<br />
10740 print '</html>'<br />
10750 !<br />
10760 close #_Inputfile:<br />
10770 !<br />
10780 stop<br />
10790 !<br />
10800 !<br />
99000 ! #Autonumber# 99000,10<br />
99010 OPEN: ! ***** Function To Call Library Openfile And Proc Subs<br />
99020 def Fnopen(Filename$, Mat F$, Mat F, Mat Form$; Inputonly, Keynum, Dont_Sort_Subs,<br />
Path$*255, Mat Descr$, Mat Field_Widths)<br />
99030 let Fnopen=Fnopenfile(Filename$, Mat F$, Mat F, Mat Form$, Inputonly, Keynum, <br />
Dont_Sort_Subs, Path$, Mat Descr$, Mat Field_Widths)<br />
99040 execute ("*proc subs.$$$")<br />
99050 fnend<br />
99060 !<br />
99980 ! #Autonumber# 99980,10<br />
99990 IGNORE: continue<br />
<br />
</pre><br />
<br />
<br />
edit.brs:<br />
<br />
<pre><br />
<br />
10000 ! Edit - Copyright August 2008 By Sage Ax #Autonumber# 10000,10<br />
10010 !<br />
10020 ! Created August 21st, 2008<br />
10030 !<br />
10040 !<br />
10050 ! This Program Is The Second Part In A Three Part Demonstration Showing How<br />
10060 ! You Can Use A Seperate Program For Each "Step" In The Process.<br />
10070 !<br />
10080 ! In This Stage In The Process, The User Is Presented With The Data For<br />
10090 ! A Colorcat Record So That They Can Change It And Save It.<br />
10100 !<br />
10110 !<br />
10120 dim Colorcat$(1)*255, Colorcat(1)<br />
10130 dim Forms$(1)*255<br />
10140 dim Descr$(1)*255, Widths(1)<br />
10150 !<br />
10160 library "fileio" : Fnopenfile, Fngetfilenumber<br />
10170 !<br />
10180 if P_Key then<br />
10190 let _Inputfile=Fnopen("colorcat",Mat Colorcat$,Mat Colorcat,Mat Forms$,1,0,0,"",<br />
Mat Descr$)<br />
10200 if _Inputfile then<br />
10210 read #_Inputfile, using Forms$(_Inputfile), key=_Post$(P_Key) : Mat Colorcat$, <br />
Mat Colorcat nokey IGNORE<br />
10220 close #_Inputfile:<br />
10230 end if<br />
10240 end if<br />
10250 !<br />
10260 !<br />
10270 if Cc_Code=0 Or Trim$(Colorcat$(Cc_Code))="" then ! If Record Not Found<br />
10280 !<br />
10290 print '............'<br />
10300 print '<html xmlns="http://www.w3.org/1999/xhtml">'<br />
10310 print '<head>'<br />
10320 print '<title>Error</title>'<br />
10330 print '<meta http-equiv="REFRESH" content="4;url=select.php"/>'<br />
10340 print '</head>'<br />
10350 print '<body>'<br />
10360 print '<br>'<br />
10370 if P_Key=0 then<br />
10380 print '<p align="center">Please select a record and <A HREF="select.php"><br />
try again</a>.</p>'<br />
10390 else<br />
10400 print '<p align="center">The record could not be found. Please <A HREF="select.php"><br />
try again</a>.</p>'<br />
10410 end if<br />
10420 print '</body>'<br />
10430 print '</html>'<br />
10440 !<br />
10450 stop<br />
10460 !<br />
10470 end if<br />
10480 !<br />
10490 print '<html xmlns="http://www.w3.org/1999/xhtml">'<br />
10500 print '<head>'<br />
10510 print '<title>Edit the record</title>'<br />
10520 print '<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />'<br />
10530 print '</head>'<br />
10540 print '<body>'<br />
10550 print '<br>'<br />
10560 print '<br>'<br />
10570 print '<form id="Colorcat" name="colorcat" method="post" action="save.php">'<br />
10580 print ' <p align="center">Edit the data and press Save.<br><br>'<br />
10590 print ' Key: '&Colorcat$(Cc_Code)&'<input type="hidden" name="key" value="'&<br />
Colorcat$(Cc_Code)&'"/>'<br />
10600 print ' Description: <input type="text" name="Description" value="'&Colorcat$(Cc_Name)<br />
&'" />'<br />
10610 print ' Color: <input type="text" name="Color" value="'&Colorcat$(Cc_Html)&'" /><br>'<br />
10620 print ' <br><input type="submit" name="button" value="Save" />'<br />
10630 print ' </p>'<br />
10640 print '</form>'<br />
10650 print '</body>'<br />
10660 print '</html>'<br />
10670 !<br />
10680 stop<br />
10690 !<br />
10700 !<br />
99000 ! #Autonumber# 99000,10<br />
99010 OPEN: ! ***** Function To Call Library Openfile And Proc Subs<br />
99020 def Fnopen(Filename$, Mat F$, Mat F, Mat Form$; Inputonly, Keynum, Dont_Sort_Subs, <br />
Path$*255, Mat Descr$, Mat Field_Widths)<br />
99030 let Fnopen=Fnopenfile(Filename$, Mat F$, Mat F, Mat Form$, Inputonly, Keynum, <br />
Dont_Sort_Subs, Path$, Mat Descr$, Mat Field_Widths)<br />
99040 execute ("*proc subs.$$$")<br />
99050 fnend<br />
99060 !<br />
99980 ! #Autonumber# 99980,10<br />
99990 IGNORE: continue<br />
<br />
</pre><br />
<br />
<br />
save.br:<br />
<br />
<pre><br />
<br />
10000 ! Save - Copyright August 2008 By Sage Ax #Autonumber# 10000,10<br />
10010 !<br />
10020 ! Created August 21st, 2008<br />
10030 !<br />
10040 !<br />
10050 ! This Program Is The Second Part In A Three Part Demonstration Showing How<br />
10060 ! You Can Use A Seperate Program For Each "Step" In The Process.<br />
10070 !<br />
10080 ! In This Stage In The Process, The data is saved and a confirmation is printed.<br />
10100 !<br />
10110 !<br />
10120 dim Colorcat$(1)*255, Colorcat(1)<br />
10130 dim Forms$(1)*255<br />
10150 !<br />
10160 library "fileio" : Fnopenfile, Fngetfilenumber<br />
10170 print Mat _Post$<br />
10180 !<br />
10190 if P_Key then<br />
10200 let _Inputfile=Fnopen("colorcat",Mat Colorcat$,Mat Colorcat,Mat Forms$)<br />
10210 if _Inputfile then<br />
10220 read #_Inputfile, using Forms$(_Inputfile), key=_Post$(P_Key) : Mat Colorcat$, <br />
Mat Colorcat nokey IGNORE<br />
10230 let Colorcat$(cc_code)=_post$(p_key)<br />
10240 let Colorcat$(cc_name)=_post$(p_description)<br />
10250 let Colorcat$(cc_html)=_post$(p_color)<br />
10260 rewrite #_Inputfile, using forms$(_Inputfile) : mat colorcat$, mat colorcat<br />
10270 let found=1<br />
10280 end if<br />
10290 end if<br />
10300 !<br />
10310 if not found then ! If Record Not Found<br />
10320 !<br />
10330 print '............'<br />
10340 print '<html xmlns="http://www.w3.org/1999/xhtml">'<br />
10350 print '<head>'<br />
10360 print '<title>Error</title>'<br />
10370 print '<meta http-equiv="REFRESH" content="4;url=select.php">'<br />
10380 print '</head>'<br />
10390 print '<body>'<br />
10400 print '<br>'<br />
10410 print '<p align="center">The record could not be found. Please <A HREF="select.php"><br />
try again</a>.</p>'<br />
10420 print '</body>'<br />
10430 print '</html>'<br />
10440 !<br />
10450 stop<br />
10460 !<br />
10470 end if<br />
10480 !<br />
10485 PRINT "########[BEGINHTML]########................."<br />
10490 print '<html xmlns="http://www.w3.org/1999/xhtml">'<br />
10500 print '<head>'<br />
10510 print '<title>Success</title>'<br />
10520 print '<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />'<br />
10530 print '</head>'<br />
10540 print '<body>'<br />
10550 print '<br>'<br />
10560 print '<br>'<br />
10570 print '<form id="Colorcat" name="colorcat" method="post" action="select.php">'<br />
10580 print ' <p align="center">Your record has been saved!<br><br>'<br />
10590 print ' <input type="submit" name="button" value="Show Me" />'<br />
10600 print ' </p>'<br />
10610 print '</form>'<br />
10620 print '</body>'<br />
10630 print '</html>'<br />
10640 !<br />
10650 stop<br />
10660 !<br />
10670 !<br />
99000 ! #Autonumber# 99000,10<br />
99010 OPEN: ! ***** Function To Call Library Openfile And Proc Subs<br />
99020 def Fnopen(Filename$, Mat F$, Mat F, Mat Form$; Inputonly, Keynum, Dont_Sort_Subs, <br />
Path$*255, Mat Descr$, Mat Field_Widths)<br />
99030 let Fnopen=Fnopenfile(Filename$, Mat F$, Mat F, Mat Form$, Inputonly, Keynum, <br />
Dont_Sort_Subs, Path$, Mat Descr$, Mat Field_Widths)<br />
99040 execute ("*proc subs.$$$")<br />
99050 fnend<br />
99060 !<br />
99980 ! #Autonumber# 99980,10<br />
99990 IGNORE: continue<br />
<br />
</pre><br />
<br />
=== User Guide ===<br />
<br />
This page will be updated with the documentation as soon as it is released.<br />
<br />
<noinclude><br />
[[Category:Third Party Utilities]]<br />
[[Category:Open Source]]<br />
[[Category:HTTP]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=BRS2BR&diff=3445BRS2BR2013-06-19T03:08:23Z<p>Admin: 1 revision</p>
<hr />
<div>Purpose: A utility to enable the windows explorer right click menu to convert a .BRS or .WBS file to the .BR or .WB format.<br />
<br />
Language: Batch<br />
<br />
License: Open Source<br />
<br />
[[Category:Utilities_Third_Party]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=BR2BRS&diff=3443BR2BRS2013-06-19T03:08:23Z<p>Admin: 1 revision</p>
<hr />
<div>'''BR2BRS''' is a utility to enable the windows explorer right click menu to convert a .WB or .BR file to the [[.BRS format]]. <br />
<br />
Language: [[Batch]]<br />
<br />
License: [[Open Source]]<br />
<br />
available BR2BRS.zip from [ftp://ftp.brulescorp.com/Brg_pub/Zip/ ftp://ftp.brulescorp.com/Brg_pub/Zip/].<br />
<br />
<br />
[[Category:Utilities_Third_Party]]<br />
[[Category:ftp.brulescorp.com]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=PhpIO&diff=3441PhpIO2013-06-19T03:08:23Z<p>Admin: 1 revision</p>
<hr />
<div>The '''PhpIO''' Library requires both the ScreenIO library to function. It uses the [[BR Internet Bridge]] created by Chris Shields to run the screens you designed using the [[ScreenIO Library]] on a web server. The PhpIO library puts your ScreenIO programs on the web.<br />
<br />
== User Guide ==<br />
<br />
The User Guide for the PhpIO library will be published here when it is available.<br />
<br />
<br />
<br />
[[Category:Utilities_Third_Party]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Photo_Sorter&diff=3439Photo Sorter2013-06-19T03:08:23Z<p>Admin: 1 revision</p>
<hr />
<div>:Project Leader: [[User:Gabriel|Gabriel Bakker]]<br />
:Language: [[Business Rules!]]<br />
:License: ???<br />
<br />
*The installation files are contained in [ftp://dsg.ftpaccess.cc/Sage/Photo/Photosorter.zip Photosort.zip].<br />
*The Instruction Manual is [ftp://dsg.ftpaccess.cc/Sage/Photo/Photosorter.pdf available here].<br />
<br />
<br />
===Installation===<br />
*Extract the contents of the zip file to any folder you like.<br />
*Copy in your brserial.dat file.<br />
*Launch the included copy of BR [[4.17]].<br />
*Type '''Run PhotoSrt'''<br />
<br />
===Origin===<br />
When I take photos with my digital camera, I tend to take hundred of pictures, expecting only a few to come out right. I usually take five or six photographs of each subject just to make sure I get the one that worked well.<br />
<br />
I was sorting through some pictures a few months ago. I would use Windows Picture and Fax viewer to view them, and when I knew which ones came out well and which ones didn't, I would use Windows Explorer to move them into different folders ("Good", "Bad"). The process would take hours, and was extremely annoying, having to switch back and forth the whole time between two (or three with video) different programs. I decided there had to be a better way. That day the Photo Sorter was born.<br />
<br />
===Description===<br />
The Photo Sorter is a free utility, written entirely in BR, to help sort pictures. You quickly run through and categorize your photo's, and then with the push of a button they are placed in the folders you marked. The interface is designed to be as fast and efficient as possible.<br />
<br />
The Photo Sorter saves what you have done after every keystroke, so if anything happens, power outage, program failure, or anything else, you don't have to redo any of your work. The next time you load the photo sorter it will pick up just where you left off. <br />
<br />
The Photo Sorter even handles Videos!<br />
<br />
Please send any comments, compliments or complaints to [mailto:gabriel.bakker@gmail.com?Subject=PhotoSorter_Feedback Gabriel Bakker]!<br />
<br />
<br />
[[Category:Freeware]]<br />
[[Category:Open Source]]<br />
[[Category:Utilities Third Party]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=FnSnap&diff=3437FnSnap2013-06-19T03:08:23Z<p>Admin: 1 revision</p>
<hr />
<div>:Project Leader: [[:User:Gtisdale|George Tisdale]].<br />
:Language: [[Business Rules!]]<br />
:License: ???<br />
<br />
<br />
You can find the latest copy of '''fnSnap.dll''' in fnsnap.zip available at [ftp://ftp.brulescorp.com/Brg_pub/Zip/]<br />
<br />
See also [[:Category:FnSnap]]<br />
<br />
*[[Library Functions|Library Functions]]<br />
*[[fnSnap: File|File]]<br />
:*File Management<br />
::*FNBLDSORT - build a sort control file and execute the sort<br />
::*FNFIL - create a file number that will increment by 1 each time a batch is created<br />
::*FNFILENAME$*80 - Provide a file name<br />
::*FNFILEOK - Check version number<br />
::*FNFILESIZE - count number of records in a file<br />
::*FNGETFILE$ - Return the name and path of an existing file<br />
::*FNGETFILENAME$*80 - Create a file name from a seed<br />
::*FNINDEX - Build an Index file and check for duplicates<br />
::*FNNEXTFIL$ - returns the file name of the next sequential file in a given location<br />
::*FNPUTFILE$ - Return the name and path of an file to be created, replaced or appended<br />
::*FNSIZE - Set or correct a file size<br />
::*FNUPDATE_VERSION - Change a file version and reconfigure layout<br />
:*Data management<br />
::*FNSEQ - Return the next sequence for a key field<br />
::*FNTYPE - Move the contents of one text file into another open file<br />
:*Form statements<br />
::*FNCFORM$ - Create a Condensed Compiled Form Statement<br />
::*FNCF$ - Process a field specification string for use in FNCFORM$<br />
*[[fnSnap: Screen Processing|Screen Processing]]<br />
:*Buttons, messages and dialogs<br />
::*FNBUTTON - Add button on the button bar<br />
::*FNCHECK - in connection with a radio dot or check box returns a 1 if checked<br />
::*FNCHECK$ - places or strips ^ from an element<br />
::*FNCLRBUTTON - removes a button from the button bar<br />
::*FNDIALOG$*40 - Display dialog box and return selected text<br />
::*FNDLG - Display a dialog box from data in a file<br />
::*FNHELP - open a tip box associated with a screen using a text file<br />
::*FNHELPTIP - uses David Blankenship utility to display a help record<br />
::*FNOK - Pop-up "OK" question<br />
::* FNOPTIONS - creates a radio dot selection pop up<br />
::* FNOPTIONS$ - creates a check box selection pop up<br />
::* FNPFKEYLINE - Creates a hot field string of function key options<br />
::* FNPFKEY - Prints a function key message<br />
::* FNRADIOCHK$ - display a radio/checkbox with a set of options<br />
::* FNRADNUM - Return the option selected in a radio dot list<br />
::* FNTIMEOUT - Display timeout message<br />
::* FNWINBUTTONS - print one or more buttons on a screen in a designated window<br />
:*String Manipulation<br />
::*FNDECRYPT$ - Decrypt FNENCRYPT$<br />
::*FNENCRYPT$ - Simple encryption<br />
::*FNFKEY - Converts an FKEY value greater than 1000<br />
::*FNNUM$ - Convert number to string<br />
::*FNPHONE$ - Convert number to (###) ###-####<br />
::*FNPROPER$*60 - Convert to Proper Case<br />
:*Other<br />
::*FNAUTO - 1 if last field exit was automatic<br />
::*FNCLKBUF - Clear keyboard buffer<br />
::*FNERRTRAP - Trapped Error Processing<br />
::*FNINIT - Initialize variables in FNSNAP Library<br />
::*FNPRINTSCREEN - stuff the keyboard to generate a print screen<br />
::*FNZERO - set to number if zero<br />
:*Screen input and display<br />
::*FNMOD - returns the column number of a cell in a grid<br />
::*FNPARSERES - returns screen resolution and BR window size for a session<br />
::*FNPROGRESS - Progress bar<br />
::*FNSCREEN - 24 x 80 screen display for screen painter<br />
::*FNTEXTBOX - creates a text box with word wrap<br />
::*FNWINSCRN - paints a screen in a window<br />
::*FNWINROWCOL - in GUI mode returns rows and columns of a window<br />
::*FNWINSIZE - in GUI mode creates arrays holding all window sizes<br />
<br />
*[[fnSnap: Window Maintenance|Window Maintenance]]<br />
:*List and Grid<br />
::*FNLISTSPEC$*50 - Create a window for a list/grid box<br />
:*Child windows<br />
::*FNWINHEAD - Print the top bar to a window<br />
::*FNWINDEV - Query FNSNAP for last window opened<br />
*[[fnSnap: Printing and PCL|Printing and PCL]]<br />
:*Font Management<br />
::*FNFONT$*30 - Create a PCL font string<br />
::*FNLOADFONT$*50 - Loads a PCL font to printer<br />
:*Reprinting Reports<br />
::*FNCLEANLOG - part of FNREPRINT used to remove out of date reports<br />
::*FNOPEN - create a log file for saved reports<br />
::*FNMENUACCESS - used in connection with FNREPRINT to determine user permission to reprint a report<br />
::*FNPRINT - prints a saved report opened using FNOPEN<br />
::*FNREPRINT - displays a list of available saved reports and prints selected report<br />
:*PCL and NWP formatting<br />
::*Bar Codes and addresses<br />
:::*FNPOSTNET - prints a postal bar code from a zip code<br />
:::*FNCODE3OF9<br />
:::*FNCODEUPC<br />
<br />
::*Forms and formatting<br />
::*NWP Printing<br />
:::*FNPRINTNWP - positions a string and aligns it right, center or decimal on a specified position<br />
:*RTF Printing<br />
::*FNRTFSTART - opens a source file to produce an RTF file using RTFLIB.dll<br />
::*FNRTFEND - turns a source file built with FNRTFSTART into a finished document<br />
:*FNREFERENCE - Prints a page reference on bottom right corner in PCL<br />
:*FNPRINT_FILE - Prints a text file on Grey bar Paper<br />
:*FNPRINTERS - Creates a printed list of printers and a printers.sys file<br />
<br />
*[[fnSnap: Date and Time|Date and Time]]<br />
:*Date formatting<br />
::*FNCCYYMMDD_TO_DAYS - converts CYMD to DAYS<br />
::*FNDATEFWD<br />
::*FNDATEREV - converts MMDDYY to YYMMDD<br />
::*FNDATE$ - Creates a formatted date from DAYS input<br />
::*FNDAYS_TO_MMDDCCYY - Converts DAYS to MDCY<br />
::*FNDAYS_TO_MMDDYY - Converts DAYS to MMDDYY<br />
::*FNMDY2YMD - converts YYMMDD to MMDDYY with century option<br />
::*FNMMDDCCYY_TO_DAYS - converts MDCY to DAYS<br />
::*FNMMDDYY_TO_DAYS - Converts MDY to DAYS<br />
::*FNTIMMILREG - 12 hour time from 24 hour time<br />
::*FNYMD2MDY - converts MMDDYY to YYMMDD with century option<br />
::*FNYYMMDD_TO_DAYS - convert YMD to DAYS<br />
:*Relative and special dates<br />
::*FNBUSINESSDAY - returns the next business day after or including a specified date<br />
::*FNDAYOFYEAR - ordinal number of days from beginning of calendar year<br />
::*FNNEXTMONTH - similar date in the following month<br />
::*FNPRIOR BUSINESSDAY - returns the first business day prior to a given date including the given date<br />
::*FNWEEKDAY$ - Returns the day of the week<br />
::*FNWEEKOFMONTH - number of time a specified day of week has occur ed in the month specified<br />
::*FNWEEKOFYEAR - number of times a specified day of week has occurred in a year up to a specified date<br />
<br />
*[[fnSnap: Array Functions|Array Functions]]<br />
:*Sorting arrays<br />
::*FNSORTARRAY - sort an array with header and footer<br />
::*FNSRTARY - sort an array with header and footer based on itself<br />
::*FNSRTNARY -Sort a numeric array based on another array<br />
:*Array arithmetic<br />
::*FNCOLSUM - sums the elements of an array for a specified column<br />
::*FNROWSUM - sums the elements of an array for a specified row<br />
:*Searching arrays<br />
::*FNCHRMAT$ - convert a numeric array to character<br />
::*FNLISTSRCH - searches a character array based on a search string<br />
::*FNLISTSRCHN - searches a numeric array based on a search string<br />
::*FNSELECTION - selection process using two arrays<br />
::*FNSRCHCRIT$*50 - search criteria for a list box<br />
:*Other<br />
::*FNDELROW - removes a specified row from an array and redimensions the array<br />
::*FNDELROW$ - removes a specified row from an array and redimensions the array<br />
::*FNADDROW - inserts a cell in the middle of a numeric array at a specified row<br />
::*FNADDROW - inserts a cell in the middle of a character array at a specified row<br />
::*FNPARMAT - split an array into sub-arrays<br />
<br />
*[[fnSnap: Miscellaneous Functions|Miscellaneous Functions]]<br />
:*Email<br />
::*FNEMAIL - creates an email file for email monitor<br />
::*FNEMAILFILE - inserts a text file into an email for email monitor<br />
:*Formatting<br />
::*FNLEADZERO$ - obsolete replace with CNVRT$("PIC(###)",x)<br />
::*FNCHECKAMOUNT$ - returns English words for a dollar amount<br />
:*Progress<br />
::*FNPROG - displays a progress bar for a process<br />
::*FNPROGRESS - displays a progress bar for a process<br />
:*Other<br />
::*FNCLKBUF - clears the keyboard buffer of extra key strokes<br />
::*FNCURDRV$ - returns the current drive and directory<br />
::*FNMSEXE$ - return the installed location of a Microsoft compliant program installation<br />
::*FNX$ - returns X if true BLANK if false<br />
<br />
*[[fnSnap: FNSNAP Obsolete functions|Obsolete functions]]<br />
:*Window and screen processing<br />
::*FNMGCLR - clears a message form the fnpick message line<br />
::*FNSAVPART - legacy function to save a portion of the screen - obsolete in 4.17<br />
::*FNRELPART - legacy function to clear a portion of the screen obsolete in 4.17<br />
::*FNWIN - legacy function to open a window in numeric order<br />
::*FNCLSWIN - legacy function to close a window opened by FNWIN<br />
::*FNPM - legacy message box on the main window<br />
:*Point and pick<br />
::*FNKEYSEL - direct file look up function requires a fixed position font<br />
::*FNPICK_EX - A point and shoot legacy using a single matrix requires a fixed position font<br />
::*FNPICK - A point and shoot legacy using a single matrix requires a fixed position font<br />
::*FNKEYSEL_EX - a legacy direct file access point and shoot requires a fixed sized font<br />
::*FNPOPUP - legacy code for a pop-up choice box<br />
:*Supporting functions<br />
::*Data transfer between program and library<br />
::*FNWINDEV - returns the number of the currentlyactive FNSNAP window using the old system<br />
::*FNLEADZERO$<br />
::*FNGETK$ - \fs20<br />
::*FNSETALL - set all elements of an array<br />
::*FNSETSEL - set all elements of an array<br />
::*FNPRTPICKBAR - a function to position a colored pick bar in FNPICK<br />
::*FNZLPAD$ - pads a number with zeros and converts to string<br />
::*FNINIT - initializes the variable required by the original FNSNAP functions<br />
::*FNNOKEY - chekc to see if CMDKEY or FKEY were pressed<br />
<br />
<br />
<br />
FnSnap is also discussed in [[Library Facility]].<br />
<br />
<br />
[[Category:FnSnap]]<br />
[[Category:Utilities]]<br />
[[Category:Utilities Third Party]]<br />
[[Category:ftp.ads.net]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=CURL&diff=3435CURL2013-06-19T03:08:23Z<p>Admin: 1 revision</p>
<hr />
<div>{{Messagebox|Please note that [[Business Rules!]] [[4.20]] provides native [[HTTP]] support.}}<br />
<br />
<br />
'''cURL''' is a command line tool for transferring files with URL syntax, supporting FTP, FTPS, [[HTTP]], HTTPS, SCP, SFTP, TFTP, TELNET, DICT, LDAP, LDAPS and FILE. cURL supports SSL certificates, HTTP POST, HTTP PUT, FTP uploading, HTTP form based upload, proxies, cookies, user+password authentication (Basic, Digest, NTLM, Negotiate, kerberos...), file transfer resume, proxy tunneling and a busload of other useful tricks.<br />
<br />
Curl is free and open software that compiles and runs under a wide variety of operating systems. Curl exists thanks to efforts from many contributors. <br />
See [http://curl.haxx.se/ cURL Home Page]<br />
<br />
See also: [[Wikipedia:Web scraping]]<br />
<br />
The basic idea is you call cURL using a system call and you give it a URL and a file name to save the page under. Curl goes to the URL you enter, just as if you entered it in Internet explorer, and it saves the resulting page as an html file.<br />
<br />
In this example we wanted to write a function to perform a reverse phone number look-up. I can't send you the whole source code because it is proprietary, but I don't think a little excerpt will hurt. We call Curl and we give it a URL at whitepages.com. We figured out that if you go to the URL: [http://www.whitepages.com/15055/search/ReversePhone?phone=8172745220] it will display an html page showing who the phone number 817 274 5220 <br />
belongs to (which happens to be Nizza Pizza).<br />
<br />
<br />
00100 REV_LOOK: ! Reverse Lookup By Phone Number<br />
00120 def library Fnrev_Look(Number$,Mat Result$)<br />
00140 let Fnrev_Look=1 ! Assume Success !:<br />
mat Web_Page$(0)<br />
00150 if Exists("address.html") then execute "*free address.html"<br />
00160 execute 'sy -M curl http://www.whitepages.com/15055/search/ReversePhone?phone=' & Number$ & ' -A "Mozilla/4.0" -o address.html -s'<br />
00200 if Fnread_Page("address.html",Mat Web_Page$) then<br />
00270 let Response_Type=Fnget_Type(Mat Web_Page$)<br />
00272 if Response_Type then ! If Respose Type Found !:<br />
let Fnrev_Look=Fnparse_Page(Response_Type, Mat Web_Page$, Mat Result$) ! Parse It !:<br />
else !:<br />
let Fnrev_Look=0 ! Failed To Get Parse Response Type<br />
00280 else<br />
00285 let Fnrev_Look=0 ! Failed To Read Page, Check Internet<br />
00290 end if<br />
00340 _END_REV_LOOK: fnend<br />
<br />
This function takes the phone number to look up, and it builds the URL and passes it to curl in line 160. Line 160 tells Curl to preform the look-up and save the resulting page as address.html in the current directory.<br />
<br />
After that, on line 200, we call a function that reads the results into a matrix. After that we call various functions to parse through the matrix looking for the Address information.<br />
<br />
During our investigation of the web site we discovered that whitepages.com returns several different web pages depending on if there are 0 result(s), 1 result(s) or many result(s) found. Our parser functions look at the format of the address.html file that curl saved, to determine which type it is. Then, based on that information, it parses the results and builds an address array called Mat Result$ that it returns to the caller.<br />
<br />
If you call this function using 817 274 5220, you end up with a mat results$ similar to:<br />
<br />
*Results$(1)="Nizza Pizza & Pasta"<br />
*Results$(2)="1430 S Cooper St"<br />
*Results$(3)="Arlington"<br />
*Results$(4)="TX"<br />
*Results$(5)="76013"<br />
<br />
<br />
<noinclude><br />
[[Category:Needs Help]]<br />
[[Category:Utilities Third Party]]<br />
[[Category:Open Source]]<br />
[[Category:Freeware]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=GotoMeeting&diff=3433GotoMeeting2013-06-19T03:08:23Z<p>Admin: 1 revision</p>
<hr />
<div><br />
*[http://www.gotoassist.com/ goto assist.com]<br />
*[https://www2.gotomeeting.com/en_US/entry/entry.tmpl goto meeting.com]<br />
<br />
[[Category:Utilities Third Party]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=MyEdit_(BR_Edition)&diff=3431MyEdit (BR Edition)2013-06-19T03:08:23Z<p>Admin: 1 revision</p>
<hr />
<div>'''MyEdit - BR Edition''' ('''MyEditBR''') is the first third-party [[editor]] to be specifically written to support the [[Business Rules!]] language.<br />
<br />
It is the most popular editor for Business Rules! [[4.18]]+ editing<br />
<br />
With it's high level of integration with BR! and the built-in capabilities MyEditBR will become a valued tool for all BR! developers. MyEditBR is based on SynEdit[http://synedit.sourceforge.net/].<br />
<br />
==Extrenal Link(s)==<br />
*[http://www.mills-enterprise.ca/ Mills Enterprise Website]<br />
*[http://support.mills-enterprise.ca/ Mills Enterprise - Support Forums]<br />
<br />
==Support==<br />
MyEditBR is the product of [[Mills Enterprise]] with the support of [[Western Canadian Software]]. <br />
<br />
The support is handled by [[Ryan J. Mills]] and he can typically be reached on the BR Forums, the Mills Enterprise Website or via his private email address.<br />
<br />
There are two versions of MyEditBR: '''Free''' and '''Supported'''.<br />
<br />
While MyEditBR is free to download and use, the free version has certain features and capabilities turned off. You will still be able to use MyEditBR for your average day to day BR! programming responsibilities.<br />
<br />
The supported version of MyEditBR gives the user a license to more advanced features found in the program.<br />
<br />
Please note that there is only one program. The supported features are turned on with a valid support license. It is easier to describe the differences as if they were from two separate programs.<br />
<br />
Here is a list of current features showing the differences between the two versions:<br />
<br />
* '''Number of open files'''<br>- Free version is limited to 5 open files at any one time.<br>- Supported version is unlimited.<br />
* '''Color and Language Support'''<br>- Free version doesn't support importing/exporting color and language customizations from within the editor.<br>- Supported version has built-in importing/exporting capabilities.<br />
* '''Automated Bug Reporting'''<br>- Free version doesn't provide this.<br>- Supported version will offer to submit bug report directly to Mills Enterprise via the web.<br />
* '''Advanced Editor Options'''<br>- Free version doesn't provide this.<br>- Supported version can show modified line statuses and supports editing in either editor while in Split View mode.<br />
* '''BR Support'''<br>- Free version doesn't provide this.<br>- Supported version integrates directly with BR to provide direct editing of .WB/.BR files and compiling back to .BR/.WB files. As well as providing on the fly native BR syntax checking while editing (appears as additional HWEs)<br />
* '''Advanced Debugging Features'''<br>- Free version has the standard debugger support<br>- Supported version provides advanced capabilities like Conditional Breakpoints.<br />
* '''Program Support'''<br>- Free version doesn't provide this.<br>- Supported version provides additional features such as Checking for Updates.<br />
<br />
This list is not complete and will be updated as completed features get added to the program.<br />
<br />
The licensing terms have not been finalized to date as such all copies of MyEditBR available from the ADS FTP site and directly from Mills Enterprise (Ryan Mills) have a temporary license provided that will expire after a given date.<br />
<br />
To see the details of the currently installed license, open the Help|About program menu item. (Doing so on a Remote Desktop Connection is very very slow and may take a long time for the about dialog to fade away)<br />
<br />
==Installation==<br />
*To move the keyboard shortcut assignments from one installation to another copy the [Program Installation Directory]\MyEditBR.actbindings file.<br />
<br />
*To move your color setup for any or all languages use the Help>Export and Help>Import options.<br />
<br />
*To implement the BR Wiki as context sensitive help, see the [[Lookup project]].<br />
<br />
==Portable Installation==<br />
<br />
/forceportable is the command line option needed to make MyEditBR behave properly on a USB install.<br />
<br />
You need the following setup (Manually configured):<br />
<br />
# Make a folder on your USB key.<br />
# Copy all files and folders where you have MyEditBR installed on your main machine to the folder created in Step 1. (This will typically be "c:\program files\mills enterprise\myeditbr".)<br />
# Copy all files and folders from your MyEditBR data directory into the folder created in Step 1. (This data folder will be found in one of two different places depending on the operating system you have. WinXP: "c:\documents and settings\(your username)\Application Data\Mills Enterprise\MyEditBR") (Please replace (your username) with the appropriate value. Smile)<br />
<br />
You need to edit your brconfig.sys file and add the command line option /forceportable) it to the EDITOR option there as well as point it to your new USB install of MyEditBR.<br />
<br />
Once that is done, you should be good to go.<br />
<br />
==Features==<br />
* '''Hints Warnings and Errors (HWE)'''<br />
**Built in checking for the most commonly encountered problems when moving from the standard BR editor to MyEditBR.<br />
* '''Syntax Highlighting'''<br />
**Color coded syntax highlighting provides easy visual ques to program code.<br />
* '''Code Completion'''<br />
**Providing quick shortcuts to long function names as well as showing the parameters of current function<br />
* '''Refactoring'''<br />
**The latest versions of the application support [[refactoring]] of [[variables]], [[labels]] and [[named forms]].<br />
* '''Line Renumbering'''<br />
**As powerful as BR but with additional capabilities.<br />
* '''BR Debugger''' (requires BR! [[4.18]]+)<br />
**Visual Debugger, Watches, Breakpoints, Conditional Breakpoints (Supported version only), Hover over tool tip variable evaluation and more.<br />
* '''Re-mappable Keyboard Shortcuts'''<br />
**Don't like a given keyboard short cut, then change it!<br />
* '''Highly Customizable'''<br />
**Persistent configuration changes between runs of the application. Includes window and tool window size and position storage and configuration persistence.<br />
* '''Full Multi-Monitor Support'''<br />
**If you work on a laptop with an additional monitor at work but not at home, MyEditBR will always start up on the correct monitor.<br />
* '''Live Development'''<br />
**New features can be added/considered on request<br />
* '''Alt+Mouse Scrolling Changes Font Size'''<br />
**This is also implemented as keyboard shortcuts (Ctrl+Shift+< and Ctrl+Shift+>)<br />
<br />
==Settings Files==<br />
To copy settings between multiple installations you may need to copy one or more of the following files.<br />
<br />
*MyEditBR.actbindings - Primarily Menu / Tool bar shortcuts (action bindings)<br />
*MyEditBR.ardetails - Auto-Recovery details in case of a crash during editing<br />
*MyEditBR.broptions - BR specific options (HWE for example)<br />
*MyEditBR.desktop - Screen docking layout (Includes dockable tool windows)<br />
*MyEditBR.exclusions - BR HWE Global Exclusions<br />
*MyEditBR.fileextensions - Additional file extension handling (.cfg -> text file)<br />
*MyEditBR.filesmru - MRU file list<br />
*MyEditBR.genops - Editor General options (spell checker, AutoNewFileType, etc)<br />
*MyEditBR.highlighters - Additional custom highlighters (??)<br />
*MyEditBR.options - SynEdit specific options<br />
*MyEditBR.pagesetup - SynEdit print page setup options (??)<br />
*MyEditBR.searchhistory - Search/Replace history<br />
*MyEditBR.sessionmru - MRU session file list<br />
*MyEditBR.usertools - User Tools<br />
*MyEditBR.visparm - Editor Visual parameters (Editor State and Position, Tool bar states, positions and customizations)<br />
<br />
<br />
==See Also==<br />
*Errors [[1154]] and [[1156]]<br />
<br />
<noinclude><br />
[[Category:Utilities Third Party]]<br />
[[Category:Supports Regular Expression]]<br />
[[Category:Purchasable]]<br />
</noinclude></div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=Category:Install_Builder&diff=3429Category:Install Builder2013-06-19T03:08:23Z<p>Admin: 1 revision</p>
<hr />
<div>Pages in this category discuss software that can be used to build installers.<br />
<br />
[[Category: Utilities Third Party]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=AutoIt&diff=3427AutoIt2013-06-19T03:08:23Z<p>Admin: 1 revision</p>
<hr />
<div>[[image:autoit_scripter_blue_userbar.png|center]]<br />
<br />
<br />
'''AutoIt''' is a 'growing' [[scripting language]]. It started as an add-on tool to automate basic tasks in GUI's of other programs.<br />
These tasks (like sending a keystroke or clicking a button) are still the core components of an AutoIt script. However with the recent [[GUI]] additions, you can now incorporate your own graphical interface using native AutoIt script commands.<br />
The new COM (Object) functionality fills the gap with WSH[http://en.wikipedia.org/wiki/Windows_Scripting_Host] languages, such as VBScript/JScript. Under certain conditions you can now even use WSH-like scripts on otherwise unsupported operating systems (like Windows 9x/Me/NT).<br />
<br />
With this combination of GUI Automation, GUI Interfaces and COM support, AutoIt offers you a powerful scripting tool that is able to compete with fully-fledged scripting languages like WSH or KiXStart[http://www.kixtart.org/]).<br />
<br />
AutoIt has been designed to work on Windows 95, 98, ME, NT 4, 2000, XP, 2003 and Windows Vista. With no annoying runtime libraries required!<br />
<br />
*[http://www.autoitscript.com/ Official Web Site]<br />
*[http://www.autoitscript.com/autoit3/docs/ Documentation]<br />
*[http://www.autoitscript.com/wiki/Main_Page AutoIt Wiki]<br />
[[Category:Utilities Third Party]]<br />
[[Category:Freeware]]<br />
[[Category: Install Builder]]<br />
[[Category:Programming Language]]<br />
[[Category:Scripting Language]]</div>Adminhttps://brwiki2.brulescorp.com/brwiki2/index.php?title=EditPad_Pro&diff=3425EditPad Pro2013-06-19T03:08:23Z<p>Admin: 1 revision</p>
<hr />
<div>'''EditPad Pro''' is a powerful and versatile text editor or word processor. <br />
<br />
==External Links==<br />
<br />
*[http://www.editpadpro.com/ EditPad Pro Official Home]<br />
<br />
<noinclude><br />
[[Category:Utilities Third Party]]<br />
[[Category:Supports Regular Expression]]<br />
[[Category:Purchasable]]<br />
</noinclude></div>Admin