This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
dev:connections:home [2011/01/20 19:08] els |
dev:connections:home [2011/03/15 19:44] els |
||
|---|---|---|---|
| Line 46: | Line 46: | ||
| === Using Environment Variables and Shell Commands === | === Using Environment Variables and Shell Commands === | ||
| - | Omnidex allows environment variables to replace any or all of the components of a connection string. The syntax for referencing an environment variable on the remote host is {$VARIABLE}, where VARIABLE is the name of the environment variable. The syntax for referencing an environment variable on the local host is {$$VARIABLE}. The entire connection string could be replaced with environment variables using the following syntax. Note that any variable name can be used. | + | Omnidex supports environment variables and shell commands to be used in many places within the product. Omnidex also allows environment variables to replace any or all of the components of a connection string. The syntax used in connection strings is more unique that the [[appendix:reference:envvar:home|general syntax]]. This is because of the need to differentiate whether the environment variable resides on the client or the server. |
| - | Omnidex also allows shell commands to be used in place of environment variables. Shell commands can be used to allow an external process to produce the value, rather than relying on an environment variable. The syntax for referencing a shell command on the remote server is {$(command)}, where command is the shell command. The syntax for referencing a shell command on the local server is {$$(command)}. | + | The syntax for referencing an environment variable on the local host is {$VARIABLE}, where VARIABLE is the name of the environment variable. The syntax for referencing an environment variable on the remote host is {$$VARIABLE}. The entire connection string could be replaced with environment variables using the following syntax. Note that any variable name can be used. |
| - | Whether using environment variables or shell commands, the HOST, PORT and POOL parameters can only reference the local server. This is required since the connect to the remote server cannot be made without this information from the local server. | + | Omnidex also allows shell commands to be used in place of environment variables. Shell commands can be used to allow an external process to produce the value, rather than relying on an environment variable. The syntax for referencing a shell command on the local server is {$(command)}, where command is the shell command. The syntax for referencing a shell command on the remote server is {$$(command)}. Note that if the shell command contains spaces or punctuation marks, it should be enclosed in quotation marks. |
| + | |||
| + | Whether using environment variables or shell commands, the host, port and pool parameters can only reference the local server. This is required since the connect to the remote server cannot be made without this information from the local server. | ||
| ==== Examples ==== | ==== Examples ==== | ||
| Line 56: | Line 58: | ||
| == Connection to local environment file == | == Connection to local environment file == | ||
| - | This connection string connects to a environment file on the local machine. Because of the absence of bracketed network information, this connection will not require Omnidex Network Services. | + | This connection string connects to an environment file on the local machine. Because of the absence of bracketed network information, this connection will not require Omnidex Network Services. |
| c:\class\simple.xml | c:\class\simple.xml | ||
| Line 85: | Line 87: | ||
| == Connection to a remote environment with environment variables == | == Connection to a remote environment with environment variables == | ||
| - | This connection string connects to an environment file using a local environment variables for the host and port, and using a remote environment variable for the filename. | + | This connection string connects to an environment file using local environment variables for the host and port, and using a remote environment variable for the filename. |
| - | [{$$HOST}:{$$PORT}]{$ENVIRONMENT_FILENAME} | + | [{$HOST}:{$PORT}]{$$ENVIRONMENT_FILENAME} |
| == Connection to a remote environment with shell commands == | == Connection to a remote environment with shell commands == | ||
| - | This connection string connects to an environment file using a local Windows shell command for the host and port, and using a remote UNIX shell command for the filename. | + | This connection string connects to an environment file using a local Windows shell command for the host and port, and using a remote UNIX shell command for the filename. Note that quotation marks are required because the shell command contains spaces. |
| - | [{$$(host.bat)}:{$$(port.bat)}]{$(cat filename.txt)} | + | [{$(host.bat)}:{$(port.bat)}]"{$$(cat filename.txt)}" |