496
EPICenter Software Installation and User Guide
EPICenter External Access Protocol
5
The external application sends a “dbquery” command request and arguments to the EPICenter
server.
6
The EPICenter server sends a response back to the external application.
7
Step 4 through 5 may be repeated as many times as needed.
8
The external application sends a “logout” command request to the EPICenter server.
9
The EPICenter server closes the TCP connection with the external application.
The EPICenter server accepts a maximum of 5 simultaneous external connections. The next section
describes the set of commands understood by the EPICenter server.
EPICenter Server Commands
Login Command
The external application should send the following data to login:
<command><param>login</param><param>
name
</param><param>
password
</param></command>
name
and
password
should be substituted by the external application.
If the login is successful, the server sends:
<H2>REQUEST COMPLETE, welcome to the EPICENTER server</H2>
If the login failed, the server sends:
<H2>ERROR, Invalid login, try again.</H2>
The external application should check the result code in the message to determine the success or failure
of the login. “REQUEST COMPLETE” is login successful, “ERROR” is login failed.
Dbquery Command
The external application may send the following to issue a dbquery command:
<command><param>dbquery</param><param>
sql
</param>[<param>
variable
1
</param>...]</command>
sql
is a SQL SELECT statement that may contain ? characters for variable substitution. For each ? in the
SQL statement, there must be a corresponding
<PARAM> variable </PARAM>
where the
variable
will
be placed in the location of the ? character when the server process the SELECT statement. For example:
<command><param>dbquery</param><param>
select * from Employee where name =
‘Bob’
</param></command>
<command><param>dbquery</param><param>
select * from Employee where name = ?
</param<PARAM>
Bob
</PARAM></command>
Both query command produces the same result. But the second form of the SQL query using the ?
substitution allows the external application to specify values without using any special quoting.
For example, given the following SQL query:
select * from Store where name = ‘Al’s Brewery’
Summary of Contents for EPICenter 4.1
Page 20: ...20 EPICenter Software Installation and User Guide Preface ...
Page 46: ...46 EPICenter Software Installation and User Guide EPICenter and Policy Manager Overview ...
Page 190: ...190 EPICenter Software Installation and User Guide Configuration Manager ...
Page 204: ...204 EPICenter Software Installation and User Guide Using the Interactive Telnet Application ...
Page 242: ...242 EPICenter Software Installation and User Guide Using the IP MAC Address Finder ...
Page 266: ...266 EPICenter Software Installation and User Guide Using ExtremeView ...
Page 284: ...284 EPICenter Software Installation and User Guide Real Time Statistics ...
Page 436: ...436 EPICenter Software Installation and User Guide Using the Policy Manager ...
Page 454: ...454 EPICenter Software Installation and User Guide The ACL Viewer ...
Page 468: ...468 EPICenter Software Installation and User Guide Troubleshooting ...
Page 504: ...504 EPICenter Software Installation and User Guide EPICenter External Access Protocol ...
Page 510: ...510 EPICenter Software Installation and User Guide EPICenter Database Views ...
Page 522: ...522 EPICenter Software Installation and User Guide EPICenter Backup ...
Page 526: ...526 EPICenter Software Installation and User Guide Dynamic Link Context System DLCS ...
Page 546: ......