Project Wonder

https://github.com/wocommunity/wonder
Admin
Project Wonder is the largest open source collection of reusable WebObjects frameworks,...
Tokens:1,036,871
Snippets:6,442
Trust Score:8.7
Update:8 hours ago
Show doc for...
Tokens:
Raw
### Example FrontBase JDBC URL with user and password

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/PlugIns/FrontBasePlugIn/Documentation/Readme.html

Shows a concrete URL for connecting to a local FrontBase database named MyDatabase with user admin and password secret. The user name is compulsory; if no users exist, use _SYSTEM (user=_SYSTEM) to get started.

```text
jdbc:FrontBase://localhost/MyDatabase/user=admin/upasswd=secret
```

--------------------------------

### Start H2 viewer application

Source: https://github.com/wocommunity/wonder/blob/master/Examples/ERXPartials/Readme.markdown

Launches the built-in H2 viewer to start the in-memory database and TCP server. Provide the connection URL and username 'h2user'.

```bash
java -jar H2PlugIn.framework/Resources/Java/h2-*.jar
```

--------------------------------

### Example WebObjects adaptor parameters

Source: https://github.com/wocommunity/wonder/blob/master/Utilities/Adaptors/Apache/Installation.html

Example values for the adaptor parameters. The default alias is /cgi-bin/WebObjects, and by default the adaptor contacts the local wotaskd instance.

```apache
WebObjectsDocumentRoot /Local/Library/WebServer/Documents
WebObjectsAlias /Apps/WebObjects
WebObjectsConfig webobjects://239.128.14.2:1085 10
```

--------------------------------

### Static URL configuration examples

Source: https://github.com/wocommunity/wonder/blob/master/Utilities/Adaptors/IIS/Installation.html

Example URLs for reading adaptor configuration from a static URL. Use file:/// for local files or http:// for remote XML configuration.

```plaintext
 
file:///Local/Library/WebObjects/Configuration/WebObjects.xml
http://www.company.com/private/woappconfig.xml
```

--------------------------------

### Build Wonder with Ant

Source: https://github.com/wocommunity/wonder/blob/master/BUILD.txt

Invoke ant -projecthelp for help, but normally you would run these commands to build and install frameworks, applications, and examples. Use sudo if you lack write privileges in the target directories.

```bash
ant clean frameworks; sudo ant -Duser.home=$HOME frameworks.install
```

```bash
ant applications; sudo ant -Duser.home=$HOME applications.install
```

```bash
ant examples; sudo ant -Duser.home=$HOME examples.install
```

--------------------------------

### Start OpenJMS server

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/EOF/ERChangeNotificationJMS/Documentation/GettingStartedMacOSX.txt

Starts the OpenJMS server using the JDBM configuration file.

```shell
cd $OPENJMS_HOME/bin
startjms.sh -config ../config/rmi_jms_jdbm.xml &
```

--------------------------------

### Start OpenJMS server with MySQL configuration

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/EOF/ERChangeNotificationJMS/Documentation/GettingStartedMacOSX.txt

Starts the OpenJMS server using the MySQL configuration file.

```shell
cd $OPENJMS_HOME/bin
startjms.sh -config ../config/rmi_jms_mysql.xml &
```

--------------------------------

### Multicast discovery configuration URL

Source: https://github.com/wocommunity/wonder/blob/master/Utilities/Adaptors/IIS/Installation.html

Example URL for discovering hosts using multicast. The scheme is webobjects:// followed by the multicast address and port.

```plaintext
 
webobjects://239.128.14.2:1085 
```

--------------------------------

### FrontBase JDBC URL syntax grammar

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/PlugIns/FrontBasePlugIn/Documentation/Readme.html

Defines the URL syntax for connecting to FrontBase from WebObjects 5 via EOModeler. The user name is compulsory; if no users exist, use _SYSTEM (user=_SYSTEM) to get started.

```text
jdbc:frontbase:// <host info> [<arg list>]

<host info>          ::= <regular> | <cluster list>
<arg list>           ::= <user> | <user password> | <database password> | <session> | <system> | 
                         <isolation level> | <locking discipline> | <access mode> | <prepare statement>

<regular>            ::= host_name <database info>
<cluster list>       ::= <cluster member> {/<cluster member>}

<database info>      ::= /database_name | :port

<cluster member>     ::= database_name@host_name

<user>               ::= /user=user_name
<user password>      ::= /upasswd=user_password
<database password>  ::= /dbpasswd=database_password
<session>            ::= /session=session_id
<system>             ::= /system=system_user
<isolation level>    ::= /isolation=<isolation value>
<locking discipline> ::= /locking=<locking value>
<access mode>        ::= /readOnly=<access value>
<prepare statement>  ::= /pstmt=<prepare value>

<isolation value>    ::= read_uncommitted | read_committed | repeatable_read | serializable | versioned
<locking value>      ::= pessimistic | deferred | optimistic
<access value>       ::= true | false
<prepare value>      ::= client | server
```

--------------------------------

### Installation file copy destinations for FrontBase PlugIn

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/PlugIns/FrontBasePlugIn/Documentation/Readme.html

Lists the two items to manually copy on Linux/Unix: FrontBasePlugIn.framework to NEXT_ROOT/Local/Library/Frameworks and frontbasejdbc.jar to JAVA_HOME/jre/lib/ext. No automatic installer exists for these components.

```text
FrontBasePlugIn.framework  ->  NEXT_ROOT/Local/Library/Frameworks
frontbasejdbc.jar          ->  JAVA_HOME/jre/lib/ext
```

--------------------------------

### Run movies.sql script with mysql command

Source: https://github.com/wocommunity/wonder/blob/master/Examples/Reporting/ERJasperReportsExample/Documentation/README.txt

QuickStart for MySQL: run the movies.sql script to set up the movies database. The script will not run if the movies database already exists. It creates a user named developer with password 'passw0rd' having access to the movies database only.

```bash
$ mysql < movies.sql
```

--------------------------------

### Log4j Configuration in WebObjects.properties

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Core/ERExtensions/Documentation/GettingStarted.txt

Configuration for initializing Log4j in WebObjects.properties (in home directory under 5.1). Includes appender and formatting settings, plus logger configuration for the 'er' package.

```properties
//log4j appender and formatting
log4j.rootLogger=INFO, A1
log4j.loggerFactory=er.extensions.ERXLogger$Factory
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=er.extensions.ERXPatternLayout
log4j.appender.A1.layout.ConversionPattern=%-5p %d{HH:mm:ss} (%-20c:%L) %x -%m%n

//log4j logger configuration
log4j.logger.er=INFO
```

--------------------------------

### Known hosts configuration for WebObjects adaptor

Source: https://github.com/wocommunity/wonder/blob/master/Utilities/Adaptors/NSAPI/Installation.html

Use a comma-separated list of wotaskd URLs to find applications running on known hosts. The example shows three hosts.

```plaintext
http://woserv1:1085,http://woserv2:1085,http://woserv2:1085
```

--------------------------------

### Known hosts configuration URL

Source: https://github.com/wocommunity/wonder/blob/master/Utilities/Adaptors/IIS/Installation.html

Example URL for finding applications running on known hosts. The value is a comma-separated list of host:port entries.

```plaintext
 
http://woserv1:1085,http://woserv2:1085,http://woserv2:1085
```

--------------------------------

### UI element local variable example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Example of a local variable (starting with underscore) available via 'this' in getLocator() and getDefaultValues().

```javascript
_labelMap: {
    'Name': 'user'
    , 'Email': 'em'
    , 'Phone': 'tel'
}
```

--------------------------------

### UI-Element Testcase Example (HTML Table Format)

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Shows how testcases can use UI-Element locators (e.g., ui=allPages::section(section=topics)) to make tests more readable. Boilerplate code is omitted; the example demonstrates the open, clickAndWait, and click commands with UI-Element arguments.

```html
<tr>
    <td>open</td>
    <td>/</td>
    <td></td>
</tr>
<tr>
    <td>clickAndWait</td>
    <td>ui=allPages::section(section=topics)</td>
    <td></td>
</tr>
<tr>
    <td>clickAndWait</td>
    <td>ui=topicListingPages::topic(topic=Process)</td>
    <td></td>
</tr>
<tr>
    <td>clickAndWait</td>
    <td>ui=subtopicListingPages::subtopic(subtopic=Creativity)</td>
    <td></td>
</tr>
<tr>
    <td>click</td>
    <td>ui=subtopicArticleListingPages::article(index=2)</td>
    <td></td>
</tr>
```

--------------------------------

### UI element getOffsetLocator default strategy example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Example of using the provided default offset locator strategy.

```javascript
getOffsetLocator: UIElement.defaultOffsetLocatorStrategy
```

--------------------------------

### UI element testcase example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Example of a testcase for testing getLocator() implementation.

```javascript
testcase1: {
    xhtml: '<div class="item"><h5>'
        + '<a expected-result="1" /></h5></div>'
}
```

--------------------------------

### Install adaptor with apxs

Source: https://github.com/wocommunity/wonder/blob/master/Utilities/Adaptors/Apache2/README.txt

Installs the WebObjects adaptor module into Apache2 using apxs. The -a flag activates the module and -n WebObjects names it. The example uses mod_WebObjects.la as the build product.

```bash
$(PATH_TO_APACHE2)/bin/apxs -i -a -n WebObjects 'build product'
```

```bash
/Library/Apache2/bin/apxs -i -a -n WebObjects mod_WebObjects.la
```

--------------------------------

### UI element genericLocator string example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Example of a genericLocator string to skip non-matching UI elements during recording.

```javascript
genericLocator: "//table[@class='ctrl']"
    + "/descendant::input"
```

--------------------------------

### Registry entries recognized by ISAPI adaptor

Source: https://github.com/wocommunity/wonder/blob/master/Utilities/Adaptors/IIS/Installation.html

List of registry entry names recognized by the ISAPI adaptor. Values are described in the .xml configuration example or the DTD. Setting WOUSERNAME to "public" allows anyone to see the WOAdaptorInfo page.

```plaintext
	"WOUSERNAME",
	"WOPASSWORD",
	"CONF_INTERVAL",
	"CONF_URL",
	"SEND_TIMEOUT",
	"RECV_TIMEOUT",
	"CONNECT_TIMEOUT",
	"TIMEOUT",
	"POOL_SIZE",
	"RETRIES",
	"DORMANT_INTERVAL",
	"ERROR_REDIRECT",
	"LOG_PATH",
	"SCHEDULER",
	"DOCUMENT_ROOT".
```

--------------------------------

### UI element args attribute example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Example of the args attribute, a list of argument objects that modify getLocator().

```javascript
[
    { name: 'index'
    , description: 'the index of the author, by article'
    , defaultValues: range(1, 5) }
]
```

--------------------------------

### UI element getLocator with this._idMap example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Example of a getLocator function using a local variable _idMap and quoteForXPath().

```javascript
getLocator: function(args) {
    var label = args.label;
    var id = this._idMap[label];
    return '//input[@id=' + id.quoteForXPath() + ']';
}
```

--------------------------------

### UI element locator attribute example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Example of a fixed locator string for the locator attribute.

```javascript
locator: 'submit'
```

--------------------------------

### ERXNavigationMenu NavigationMenu.plist Example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Core/ERExtensions/Documentation/Navigation.html

Complete example of a NavigationMenu.plist for configuring the ERXNavigationMenu. It defines a root menu with children (Home, Movie, Customer) and demonstrates various bindings: action, directActionName, queryBindings, displayName, childrenConditions, children as keyPath, childrenChoices, hasActivity, and conditions. Requires setting er.extensions.ERXNavigationManager.localizeDisplayKeys=true and calling ERXNavigationManager.manager().configureNavigation() after app initialization.

```plist
(
	/*
	Using the ERXNavigationMenu:
	 
	(This sample and its excelent comments come from Ramsey Gurley's
	HelloD2W sample application from WOWODC 2010)
	 
	In order to enable a navigation menu, you must/should:
	 
	1. Add to your properties file:
	er.extensions.ERXNavigationManager.localizeDisplayKeys=true
	 
	2. When your app finishes initializing, call:
	ERXNavigationManager.manager().configureNavigation();
	 
	3. Create a NavigationMenu.plist file (like this one)
	 
	4. Set the navigation context (see the navigationContext() method in MenuHeader)
	 
	5. Set the navigationState on the navigation context... more on that in a bit.
	 
	*/
	{
		/*
		This defines the root level of the menu. If you add any new level one
		menu items, you must include the name in the list of children for
		root. ERXNavigationMenu is limited to three levels of menu items.
		*/
		name = Root;
		children = (Home,Movie,Customer);
	},
	{
		/*
		The name of your navigation item is used to identify your navigation
		state as well.  So in your context, if you want the named item to
		appear selected, you need to have a navigation state that matches.
		 
		For example, let us say in your menu hierarchy you want a second 
		level item to appear selected. Your navigation state should look  
		something like "Parent.Child" where "Parent" is the name of the  
		level one menu item, and "Child" is the name of the level two menu
		item.
		*/
		name = Home; 
		/*
		The action here does not have to be a component action.
		In order of precedence, it can be:
		 
		href
		action
		pageName
		directActionName
		 
		*/
		action = "session.navController.homeAction";
		children = ("Graph","Logout");
		 
		/*
		A frequent special case is a parent element having the same  
		action as one if its children. In this case, you may omit the  
		href/action/pageName/directActionName and instead specify a
		defaultChild:
		*/
		 
		defaultChild = "Movie.SearchMovie";
		 
	},
	{
		/* an example using a direct action */
		name = Graph;
		directActionName = "graph";
		/*
		A query dictionary may be specified with the queryBindings key. In
		this case, the graphviz page requires a binding for format and it
		may only be either "pdf" or "svg"
		*/
		queryBindings = {format="pdf";};
	},
	{
		name = Movie;
		action = "session.navController.listMovieAction";
		 
		/*
		displayName takes precedence over name for display purposes.
		If no displayName is provided, name is used.  Localized keys are
		"Nav.<displayName>" and "Nav.<name>" respectively.
		*/
		displayName = "MovieKey";
		children = ("CreateMovie");
		/*
		Oddly, instead of specifying an array for childrenConditions, 
		a comma separated string of keyPaths is expected instead. All 
		children conditions must be met or no children will be shown 
		for the menu item.
		*/
		childrenConditions = "session.user.hasAdministratorAccessLevel,session.user.hasEmployeeAccessLevel";
	},
	{
		name = CreateMovie;
		action = "session.navController.createMovieAction";
	},
	{
		name = Logout;
		directActionName = "logout";
		/*
		You may specify the direct action class using the
		directActionClass binding.
		*/
		directActionClass = "ERXDirectAction";
	},
	{
		name = Customer;
		action = "session.navController.inspectTabCustomerAction";
		/*
		If children is a keyPath instead of an array, then the value for the
		keyPath is used to determine the children choices shown.  
		If the keypath evaluates to an NSArray, then the resultant array is 
		used as the children array.
		If the array evaluates to a String, then that String is used as a key
		to find the array of children in the 'childrenChoices' dictionary.
		*/
		children = "session.user.accessLevel.toString";
		childrenChoices = {
			1 = (Choice1);
			2 = (Choice2);
			3 = (RentalHistory,RentMovies);
		};
	},
	{
		name = Choice1;
		action = "session.navController.homeAction";
	},
	{
		name = Choice2;
		action = "session.navController.homeAction";
	},
	{
		name = RentalHistory;
		action = "session.navController.rentalHistoryAction";
		/*
		hasActivity evaluates the value supplied directly, so truthy
		values like 1 or true evaluate true and falsey values evaluate
		false. To specify a keyPath, you need to start the keypath with
		a '^' character.
		*/
		hasActivity = "^session.user.customer.hasOverdueRentals";
	},
	{
		name = RentMovies;
		action = "session.navController.rentMoviesAction";
		/*
		If the keyPaths for 'conditions' evaluate to false, then the menu
		item is omitted. A single array of conditions are ANDed together,
		where a nested array like ((condition1, condition2)) are ORed
		instead. The following example is ANDed, so all conditions must
		be true or RentMovies will be omitted.
		*/
		conditions = ("session.user.hasCustomerAccessLevel","session.user.customer.isAllowedToRent");
		/*
		The qualifier is only evaluated if there are conditions and the 
		conditions have been met.
		*/
	}
)
```

--------------------------------

### UI element name attribute example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Example of the name attribute for a UI element.

```javascript
name: 'article'
```

--------------------------------

### Pageset pathPrefix Attribute Example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Example value for the optional 'pathPrefix' attribute. It specifies a URL path prefix that all included pages must contain.

```javascript
pathPrefix: 'gallery/'
```

--------------------------------

### commandMatchers Array Example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Example of a `commandMatchers` array with a single matcher that matches a `type` command targeting `ui=loginPages::user\(.+` and updates the `args` object with the command's value.

```javascript
commandMatchers: [
    {
        command: 'type'
        , target: 'ui=loginPages::user\\(.+'
        , value: '.+'
        , minMatches: 1
        , maxMatches: 1
        , updateArgs:
            function(command, args) {
            args.user = command.value;
            return args;
        }
    }
]
```

--------------------------------

### UI element getLocator function example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Example of a getLocator function that returns a CSS locator based on an argument.

```javascript
getLocator: function(args) {
    return 'css=div.item:nth-child(' + args.index + ')'
        + ' > h5 > a';
}
```

--------------------------------

### Example wobuild.properties

Source: https://github.com/wocommunity/wonder/blob/master/BUILD.txt

Place this file in ~/Library on Mac OS X or in a Library folder under the user.home directory on Windows. These settings may be necessary for some functionality.

```properties
wo.woroot=/
wo.wosystemroot=/System
wo.wolocalroot=/
```

--------------------------------

### Pageset paramRegexps Attribute Example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Example value for the optional 'paramRegexps' attribute. It maps URL parameter names to regular expression strings that must match their values.

```javascript
paramRegexps: {
    dept: '^[abcd]$'
    , team: 'marketing'
}
```

--------------------------------

### Install WOStart as Windows Service with SC create

Source: https://github.com/wocommunity/wonder/blob/master/Utilities/WOStart/ReadMe.txt

Use this command to install a WebObjects application as a Windows service using the Windows 'SC' tool. The binPath must point to the WOStart-based executable and can include command line arguments like heap size and port. Ensure the JVM architecture matches the WOStart executable.

```batch
sc create WOApp1 start= auto DisplayName= "WOApp1" binPath= "<path>/WOApp1.woa/WOApp1.exe -Xmx1512m -WOPort 4444"
```

--------------------------------

### Validation Message in Validations.strings

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Core/ERExtensions/Documentation/GettingStarted.txt

Add a localized message for the validation exception code in a Validations.strings file.

```properties
somecode = "Something went wrong";
```

--------------------------------

### Throw ERXValidationException

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Core/ERExtensions/Documentation/GettingStarted.txt

Replace NSValidation.ValidationException with ERXValidationException in your model. Requires classes to descend from ERXGenericRecord and optionally subclass ERXEntityClassDescription.

```java
throw new ERXValidationException(eo, key, value, "somecode");
```

```java
throw ERXValidationFactory.defaultFactory().createException(eo, key, value, "somecode");
```

--------------------------------

### GCPie3DChart with labels

Source: https://github.com/wocommunity/wonder/blob/master/Examples/Misc/ERComponentTour/Components/GoogleChartsPage.wo/GoogleChartsPage.html

3D pie chart with title, size, data, and labels.

```html
<wo:GCPie3DChart title="wo_fu" size="400x200" data="[10, 45, 45]" labels="Chuck,Anjo,Mike"/>
```

--------------------------------

### IMComponent Transcript - example IM conversation

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/WOAdaptors/ERIMAdaptor/Documentation/README.txt

Example transcript of an instant messaging conversation between a user (Mike) and the server. It shows the server's responses: first a greeting, then repeated 'Welcome back Mike!' after the user responds. The ellipsis (...) indicates the conversation continues.

```text
Mike> Hey server!
Server> Hi Mike!
Mike> How's it going?
Server> Welcome back Mike!
Mike> Uh. OK.
Server> Welcome back Mike!
	...
```

--------------------------------

### Add SunJCE Security Provider

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Core/ERExtensions/Documentation/GettingStarted.txt

Line to add to /Library/Java/Home/lib/security/java.security for ERCrypto with JDK 1.3. Requires JCE jars in the extensions directory.

```java
security.provider.4=com.sun.crypto.provider.SunJCE
```

--------------------------------

### Manually control OpenJMS via SystemStarter

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/EOF/ERChangeNotificationJMS/Documentation/GettingStartedMacOSX.txt

Manually start, stop, or restart the OpenJMS server when the StartupItem is installed.

```shell
sudo SystemStarter start OpenJMS
sudo SystemStarter stop OpenJMS
sudo SystemStarter restart OpenJMS
```

--------------------------------

### Create MySQL database and app user with threadsdemo-01.sql

Source: https://github.com/wocommunity/wonder/blob/master/Examples/Misc/BackgroundTasks/README.txt

Run this command from the project's Resources folder to create the database and the app user (guest user with password 'password' and localhost access only). Requires MySQL and root access.

```bash
mysql -u root -p < threadsdemo-01.sql
```

--------------------------------

### GCPieChart basic

Source: https://github.com/wocommunity/wonder/blob/master/Examples/Misc/ERComponentTour/Components/GoogleChartsPage.wo/GoogleChartsPage.html

Pie chart with a single data array.

```html
<wo:GCPieChart data="[20, 35, 45]"/>
```

--------------------------------

### Import WebObjects frameworks with Maven

Source: https://github.com/wocommunity/wonder/blob/master/BUILD.txt

Run this command to import the WebObjects frameworks as jars into the local Maven repository. Required only once or after cleaning the local repository.

```bash
mvn wobootstrap:install
```

--------------------------------

### Maven release help

Source: https://github.com/wocommunity/wonder/blob/master/BUILD.txt

Run this command to see help for the Maven release script that automates steps like svn revert, svn up, version substitution, and mvn clean with relevant properties.

```bash
ant -f Build/build/maven.release.xml help
```

--------------------------------

### Command Matcher command Attribute Examples

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Examples of the `command` attribute for command matcher objects. The first matches any command starting with 'click', the second matches the exact command 'rollup'.

```javascript
command: 'click.+'
```

```javascript
command: 'rollup'
```

--------------------------------

### Build Wonder with Maven

Source: https://github.com/wocommunity/wonder/blob/master/BUILD.txt

Run this command from the Wonder root directory to build Wonder. Ensure your settings.xml is properly configured.

```bash
mvn clean install
```

--------------------------------

### Sample Map File Path (chrome://selenium-ide/...)

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

The sample UI-Element map definition file for alistapart.com, available at this path in the Selenium IDE distribution. Use it to experiment with UI-Element.

```text
chrome://selenium-ide/content/selenium/scripts/ui-map-sample.js
```

--------------------------------

### Install adaptor with apxs

Source: https://github.com/wocommunity/wonder/blob/master/Utilities/Adaptors/Apache2.2/README.txt

Install the WebObjects adaptor module into Apache 2.2 using apxs. The -i flag installs the module, -a adds a LoadModule directive, and -n WebObjects names the module. The example uses /usr/local/Apache2.2/bin/apxs with mod_WebObjects.la.

```bash
cd Apache2.2

$(PATH_TO_APACHE2)/bin/apxs -i -a -n WebObjects 'build product'

e.g.

/usr/local/Apache2.2/bin/apxs -i -a -n WebObjects mod_WebObjects.la

or just 'sudo make install'.
```

--------------------------------

### Add Init lines to magnus.conf for NSAPI adaptor

Source: https://github.com/wocommunity/wonder/blob/master/Utilities/Adaptors/NSAPI/Installation.html

Add these two lines at the end of the Init-prefixed block in magnus.conf. Replace <pathToNSAPIadaptor>, <pathToWebServer'sDocRoot>, and <woconfigurl> with your actual paths and URL. The shlib path points to the NSAPI shared library (e.g., /opt/Apple/Library/WebObjects/Adaptors/NSAPI/libWebObjects.so on Solaris or C:/Apple/Library/WebObjects/Adaptors/NSAPI/WebObjects.dll on Windows).

```plaintext
Init fn="load-modules" funcs="WebObjects_init,WebObjectsNameTrans,WebObjectsRequest" shlib=<pathToNSAPIadaptor>
Init fn="WebObjects_init" root=<pathToWebServer'sDocRoot> config=<woconfigurl>
```

--------------------------------

### Enable adaptor logging by creating logWebObjects file

Source: https://github.com/wocommunity/wonder/blob/master/Applications/JavaMonitor/Components/HelpPage.wo/HelpPage.html

Create an empty file named logWebObjects in the HTTP server's temp directory (e.g., /tmp on Solaris/MacOSX, or the directory returned by echo $TEMP on Win2k). The adaptor log is written to WebObjects.log in the same directory; adaptors do not need restarting to start or stop logging.

```bash
echo $TEMP
```

--------------------------------

### Enable direct connect with -WODirectConnectEnabled true

Source: https://github.com/wocommunity/wonder/blob/master/Applications/JavaMonitor/Components/HelpPage.wo/HelpPage.html

In deployment installations, WODirectConnectEnabled defaults to false, preventing direct connections. Start the application with this argument to allow direct connections through the adaptor.

```bash
-WODirectConnectEnabled true
```

--------------------------------

### Optional wobuild.properties settings

Source: https://github.com/wocommunity/wonder/blob/master/BUILD.txt

These additional properties may or may not be necessary for some functionality.

```properties
wo.dir.root=/
wo.dir.user.home.library.frameworks=/User/yourname/Library/Frameworks
wo.dir.local=/
wo.dir.library=/System/Library
wo.dir.user.home.library=/User/yourname/Library
wo.dir.local.library=/Library
wo.dir.library.frameworks=/System/Library/Frameworks
wo.dir.local.library.frameworks=/Library/Frameworks
wo.dir.system=/System
```

--------------------------------

### JSONRequestHandler Example: JavaScript functions using AjaxJSONClient

Source: https://github.com/wocommunity/wonder/blob/master/Examples/Ajax/AjaxExample/Components/JSONExample.wo/JSONExample.html

JavaScript functions that call services through the AjaxJSONClient web object. They demonstrate printing a string, retrieving the session ID, getting the application name, and passing a complex object to a service method. The complexObject function accesses the first person from an array and passes it to printPerson.

```javascript
function printThisString() { <webobject name = "AjaxJSONClient"/>.exampleService.printThisString('hi'); } function returnMySessionID() { var json = <webobject name = "AjaxJSONClient"/>; var sessionID = json.exampleService.returnMySessionID(); alert(sessionID); } function returnThisApplicationName() { alert(<webobject name = "AjaxJSONClient"/>.exampleService.returnThisApplicationName()); } function complexObject() { var json = <webobject name = "AjaxJSONClient"/>; var people = json.exampleService.somePeople(); var firstPerson = people.nsarray\[0\]; json.exampleService.printPerson(firstPerson); }
```

--------------------------------

### PostgreSQL create database command

Source: https://github.com/wocommunity/wonder/blob/master/Examples/ERXPartials/Readme.markdown

Creates the ERXPartials database with UTF8 encoding.

```bash
$ createdb -U postgres -E UTF8 ERXPartials
```

--------------------------------

### FrontBase database recreation with ant fb.recreate

Source: https://github.com/wocommunity/wonder/blob/master/Examples/ERXPartials/Readme.markdown

Creates the empty FrontBase database and sets ownership permissions. Output shows expected messages when the database is not running.

```bash
$ ant fb.recreate
Buildfile: /Volumes/Data/Development/GitHub/ERXPartials/wonder/Tests/ERXPartials/ERXPartialBaseModel/build.xml

init.properties:

fb.recreate:

  [exec] connect to ERXPartials user _system;  
  [exec] Cannot connect to ERXPartials@localhost  
  [exec] Database is not running  
  [exec] stop database;  
  [exec] No current session.  
  [exec] delete database ERXPartials;  
  [exec] Cannot delete database ERXPartials@localhost;  
  [exec] Reason: Database is unknown  
  [exec] create database ERXPartials;  
  [exec] connect to ERXPartials user _system;  
  [exec] Auto committing is on: SET COMMIT TRUE;  
  [exec] create user erxpartial;  
  [exec] set password test user erxpartial;  
  [exec] create schema erxpartial authorization erxpartial;  
  [exec] disconnect all;  
  [exec]  

BUILD SUCCESSFUL

Total time: 1 second
```

--------------------------------

### H2 shared in-memory database connection URL

Source: https://github.com/wocommunity/wonder/blob/master/Examples/ERXPartials/Readme.markdown

Use this URL to connect to a named in-memory H2 database in server mode. The database must be started before the application.

```text
jdbc:h2:tcp://localhost/mem:ERXPartials
```

--------------------------------

### Enable WebObjects adaptor logging

Source: https://github.com/wocommunity/wonder/blob/master/Utilities/Adaptors/Apache/Installation.html

Creates the log file that the WebObjects adaptor uses to log requests. Run as root before making requests.

```bash
touch /tmp/logWebObjects
```

--------------------------------

### Load mod_WebObjects.so in apache.conf

Source: https://github.com/wocommunity/wonder/blob/master/Utilities/Adaptors/Apache/Installation.html

Ensure the LoadModule command in apache.conf points to the correct path of the compiled mod_WebObjects.so. The example uses the Mac OS X path; adjust for other platforms.

```apache
LoadModule WebObjects_module /System/Library/WebObjects/Adaptors/Apache/mod_WebObjects.so
```

--------------------------------

### Set OPENJMS_HOME environment variable

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/EOF/ERChangeNotificationJMS/Documentation/GettingStartedMacOSX.txt

Sets the OPENJMS_HOME environment variable to the OpenJMS installation directory. Add this line to ~/.cshrc to persist it across Terminal sessions.

```shell
setenv OPENJMS_HOME /usr/local/openjms
```

--------------------------------

### Check Ant version

Source: https://github.com/wocommunity/wonder/blob/master/BUILD.txt

Run this command to confirm that Ant is properly installed and at version 1.7 or later.

```bash
ant -version
```

--------------------------------

### Set confinterval for host list or multicast re-read

Source: https://github.com/wocommunity/wonder/blob/master/Utilities/Adaptors/NSAPI/Installation.html

Add the confinterval option on the same Init line to set the re-read interval in seconds for either the host list or multicast mechanisms. This example sets it to 10 seconds.

```plaintext
Init fn="WebObjects_init" root="/opt/iplanet/servers/docs" config="http://localhost:1085" confinterval="10"
```

--------------------------------

### Configure Apache to accept DSO modules

Source: https://github.com/wocommunity/wonder/blob/master/Utilities/Adaptors/Apache/Installation.html

Run this command when building Apache to enable Dynamic Shared Object (DSO) support, which is required for the WebObjects adaptor on platforms other than Mac OS X.

```bash
./configure --enable-module=so
```

--------------------------------

### Implement IERXMigration with modelDependencies, upgrade, and downgrade

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Core/ERExtensions/Sources/er/extensions/migration/package.html

Shows a complete migration class implementing IERXMigration. modelDependencies declares required model versions, upgrade runs SQL scripts and updates, and downgrade is a placeholder that is not currently executed by Wonder.

```java
package com.mdimension.hotnew.migration; 

public class HotNewModel2 implements IERXMigration { 
   public NSArray modelDependencies() { 
     return new NSArray(new ERXModelVersion[] { new ERXModelVersion("AccountingModel", 8), new ERXModelVersion("CoreModel", 5) }); 
   } 

   public void upgrade(EOEditingContext editingContext, EOAdaptorChannel channel, EOModel model) throws Throwable { 
     ERXJDBCUtilities.executeUpdateScriptFromResourceNamed(channel, "HotNewModel2-" + ERXJDBCUtilities.databaseProductName(channel) + ".sql", null); 
     ERXJDBCUtilities.executeUpdate(channel, "update Person set name = 'Mike' where age = 28"); 
   }

   public void downgrade(EOEditingContext editingContext, EOAdaptorChannel channel, EOModel model) throws Throwable { 
     // whatever it takes to invert those 
   } 
} 
```

--------------------------------

### Simple rollup rule example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Defines a rollup rule named `do_search` that matches two consecutive commands and expands to a `type` and `clickAndWait`. The `commandMatchers` use `ui=` locators and an `updateArgs` function extracts the `term` argument. Note the second matcher matches any command starting with `click` and the expansion converts it to `clickAndWait`.

```javascript
manager.addRollupRule({
    name: 'do_search'
    , description: 'performs a search'
    , args: [
        name: 'term'
        , description: 'the search term'
    ]
    , commandMatchers: [
        {
            command: 'type'
            , target: 'ui=searchPages::search_box\\(.+'
            , updateArgs: function(command, args) {
                var uiSpecifier = new UISpecifier(command.target);
                args.term = uiSpecifier.args.term;
                return args;
            }
        }
        , {
            command: 'click.+'
            , target: 'ui=searchPages::search_go\\(.+'
        }
    ]
    , getExpandedCommands: function(args) {
        var commands = [];
        var uiSpecifier = new UISpecifier(
            'searchPages'
            , 'search_box'
            , { term: args.term });
        commands.push({
            command: 'type'
            , target: 'ui=' + uiSpecifier.toString()
        });
        commands.push({
            command: 'clickAndWait'
            , target: 'ui=searchPages::search_go()'
        });
        return commands;
    }
});
```

--------------------------------

### Ajax.Request push with onInteractive handler

Source: https://github.com/wocommunity/wonder/blob/master/Examples/Ajax/AjaxExample/Components/PushExample.wo/PushExample.html

Sends a GET request to the WebObjects URL and processes streaming data incrementally via the onInteractive callback. The code parses a length-prefixed protocol from transport.responseText, appending each chunk to the 'result' element. Comments note this is a proof of concept and that transport.responseText is never reset, which may cause memory issues.

```JavaScript
// AK: I don't have time to look up the proper API, but for a proof of concept, this should suffice // MS: this is going to run out of memory, because transport.responseText is never reset ... are we allowed to mess with transport.responseText? var pendingLength = 0; var offset = 0; new Ajax.Request('<webobjects name=url/>', { parameters: '', method: 'GET', asynchronous: true, onInteractive: function(transport) { var result = document.getElementById('result'); if (transport.responseText.length - offset > 0) { while (true) { if (pendingLength == 0) { var colonIndex = transport.responseText.indexOf(':', offset); if (colonIndex != -1) { pendingLength = parseInt(transport.responseText.substring(offset, colonIndex)); offset += ((colonIndex - offset) + 1); } else { break; } } if (pendingLength > 0 && (transport.responseText.length - offset) >= pendingLength) { var nextStr = transport.responseText.substr(offset, pendingLength); result.innerHTML += nextStr; offset += pendingLength; pendingLength = 0; if (transport.responseText.length == offset) { break; } } else { break; } } } } });
```

--------------------------------

### Rollup rule attribute examples

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Examples for the `name`, `description`, `alternateCommand`, `pre`, `post`, and `args` attributes of a rollup rule object. Each example shows the attribute name and a sample value.

```javascript
name: 'do_login'
```

```javascript
description: 'logs into the application'
```

```javascript
alternateCommand: 'clickAndWait'
```

```javascript
pre: 'the page contains login widgets'
```

```javascript
post: 'the user is logged in, or is \
directed to a login error page'
```

--------------------------------

### UI element description attribute example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Example of the description attribute for a UI element.

```javascript
description: 'front or issue page link to article'
```

--------------------------------

### Minimal addPageset() Example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Shows the minimal JSON structure for the addPageset() method. The pageset is named 'allPages' and matches all pages via the pathRegexp '.*'.

```javascript
map.addPageset({
    name: 'allPages'
    , description: 'contains elements common to all pages'
    , pathRegexp: '.*'
});
```

--------------------------------

### Multicast discovery configuration for WebObjects adaptor

Source: https://github.com/wocommunity/wonder/blob/master/Utilities/Adaptors/NSAPI/Installation.html

Use the webobjects:// scheme with a multicast address and port to discover hosts using multicast.

```plaintext
webobjects://239.128.14.2:1085
```

--------------------------------

### UI element getGenericLocator function example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Example of a getGenericLocator function returning a locator using _xpathPrefix.

```javascript
getGenericLocator: function() {
    return this._xpathPrefix + '/descendant::a';
}
```

--------------------------------

### Tail WebObjects adaptor log

Source: https://github.com/wocommunity/wonder/blob/master/Utilities/Adaptors/Apache/Installation.html

Continuously displays the WebObjects adaptor log file to verify which adaptor is handling requests.

```bash
tail -f /tmp/WebObjects.log
```

--------------------------------

### Tag and fetch tagged entities

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/BusinessLogic/ERTaggable/Sources/er/taggable/package.html

Create a Person, add tags, fetch people tagged with a specific tag, and fetch all tagged items across entities.

```java
Person mike = Person.createPerson(editingContext, "Mike Schrag");
ERTaggable<Person> taggableMike = mike.taggable();
taggableMike.addTags("mike employee important");

NSArray<Person> matchingPeople = Person.taggableEntity().fetchTaggedWith(editingContext, "employee");
	
NSDictionary<EOEntity, NSArray<? extends ERXGenericRecord>> matchingItems = ERTaggableEntity.fetchAllTaggedWith(editingContext, "mike");
		
```

--------------------------------

### H2 file-based database connection URL

Source: https://github.com/wocommunity/wonder/blob/master/Examples/ERXPartials/Readme.markdown

Use this URL for a file-based H2 database. Run the application, wait for migrations, then quit before using the viewer.

```text
jdbc:h2:file:~/ERXPartials
```

--------------------------------

### Multicast configuration format

Source: https://github.com/wocommunity/wonder/blob/master/Applications/JavaMonitor/Components/HelpPage.wo/HelpPage.html

Format for configuring the HTTP adaptor to use multicast discovery. The adaptor broadcasts a UDP request and wotaskds respond with their configuration URLs. wotaskds do not respond to multicast by default.

```text
webobjects://<multicast address>:<port> <request interval>
```

--------------------------------

### Static URL configuration for WebObjects adaptor

Source: https://github.com/wocommunity/wonder/blob/master/Utilities/Adaptors/NSAPI/Installation.html

Use a static URL to read adaptor configuration from a file or HTTP URL. The URL format depends on how you wish to retrieve adaptor configuration.

```plaintext
file:///Local/Library/WebObjects/Configuration/WebObjects.xml
http://www.company.com/private/woappconfig.xml
```

--------------------------------

### Page wrapper with ERXNavigationMenu and WOComponentContent

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Core/ERExtensions/Documentation/Navigation.html

Creates a page wrapper that includes a navigation menu and content area. The .html defines the web objects, the .wod binds the navigation to an ERXNavigationMenu with a context, and the .java provides a navigationContext method that returns the current context, handling D2WPage specially.

```html
<webobject name="Navigation"/><webobject name="Content"/>
```

```wod
Navigation: ERXNavigationMenu {context = myContext;}
Content: WOComponentContent {}
```

```java
...
public NSKeyValueCoding navigationContext() {
    NSKeyValueCoding context = (NSKeyValueCoding)session().objectForKey("navigationContext");
    
    if (context().page() instanceof D2WPage) {
        context = ((D2WPage)context().page()).d2wContext();
    }
    return context;
}

```

--------------------------------

### Argument description attribute example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Example of the 'description' attribute for a UI argument object. Provides a textual description of the argument.

```javascript
description: 'the index of the article'
```

--------------------------------

### UI element custom getOffsetLocator function example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Example of a custom getOffsetLocator function that returns null when no offset is found.

```javascript
getOffsetLocator:
    function(locatedElement, pageElement) {
    if (pageElement.parentNode == locatedElement) {
        return '/child::' + pageElement.nodeName;
    }
    return null;
}
```

--------------------------------

### Pageset name Attribute Example

Source: https://github.com/wocommunity/wonder/blob/master/Frameworks/Misc/ERSelenium/WebServerResources/selenium-core/scripts/ui-doc.html

Example value for the required 'name' attribute of a Pageset object. It should be unique within the map.

```javascript
name: 'shopPages'
```
Tokens:
Raw