Release 3.00
Sep 24, 2005
|
Sybernet / Supplied Procedures Reference
Release 3.00 Sep 24, 2005 |
|
The Sybernet Stored Procedure Register allows you register your stored procedures. Registered procedures appear on the Sybernet menu screen. Database security (do you have execute permission?) determines whether or not this application is displayed on the menu.
You can create any number of sub-menus with this application. Sybernet calls these Parents. Parents are stored procedures that are given execute permission, just like any other application. The only difference between them and regular applications is they don't do anything. That is, they are never actually executed so you can get away with a one or two line script for these.
To edit a procedure select its name from the list of Registered Procedures. To register a procedure or subprogram for the first time select its name from the list of Procedures or Packages. You can also register a synonym if it points to a stored procedure.
This section determines the name of your application and where it is located on the menu.
| Name | Description |
|---|---|
Group Name |
Group Name indicates what group this procedure belongs to. To create a new group name register it as a parent. |
Short Description |
The short description is used as the hyper-text link (and is required). This is the application name that is displayed on the menu screen. |
Image Name |
Image name allows parent procedures to be identified with an image. This is a URL to that image. |
Group Type |
Group Type identifies the type of procedure you are registering:
|
Visibility |
Visibility determines who can see this application on the menu screen. While database security is always in affect, this option determines who can see this application from the menu screen. |
Domain |
Domain is a user-defined value so it is not important to the Sybernet Register. We use this field to define a set of procedures for lite testing. |
Splash Screen |
Splash Screen allows your application to invoke a splash screen at the same time your application is launched. Your splash screen must be a fully qualified procedure name. |
Developer |
Developer defines the employee name that developed this application. |
Custodian |
Custodian defines the employee name responsible for maintaining this application. This is normally the same as the developer. This field can also be used to define the unit tester or the backup programmer for this application. |
Customer |
Customer defines the employee name responsible for testing this application. |
The section defines the run time options for your application or how Sybernet is suppose to invoke this stored procedure. Most of the time you will just use the default values for everything.
| Name | Description |
|---|---|
Meta Refresh |
Meta Refresh allows Adult procedures to refresh themselves automatically. |
Format |
Format determines the output format. The default is NULL which means this value is determined by the Sybernet configuration file. This should be SUPPRESSED if your application is creating HTML. |
Filter |
Filter should be NULL to send the output of your stored procedure to your browser. When Filter is CGI, the results are back to the database. |
Content Type |
Content Type allows you to override the Content-Type value in the HTTP header. The default is text/html. To send your results to Excel, for example, you would specify application/excel. |
Disposition |
Disposition allows you to specify this application's disposition as inline or as an attachment. In conjunction with Content-Type you can
specify that an application opens immediately as an attachment. The default is null which is the same thing as inline. The following example
illustrates how to specify an attachment and its filename:
attachment;filename='vehicles.xls' |
Parameters |
Parameters allow you to pass static parameters to your stored procedure. You might use this option to register the same procedure more than once with different options. Parameters is a comma separated list of name=value pairs. |
Window options apply only to those procedures whose Group Type is Orphan. Orphans run in their own window and these options control what that window looks like.
| Name | Description |
|---|---|
Window Name |
Window Name is the name of this window. |
Width |
Width is the width of this window in pixels. |
Height |
Height is the width of this window in pixels. |
Scrollbars |
This option determines if scrollbars are allowed. |
Toolbar |
This option determines if a toolbar is allowed. |
Resizable |
This option determines if the window is resizable. |
Location |
This option determines if a location is allowed. |
Directories |
This option determines if directories are allowed. |
Status |
This option determines if the status line is displayed. |
Menubar |
This option determines if the standard menubar is displayed. |
| Name | Description |
|---|---|
Long Description |
Long Description is the description that appears on the menu next to the application name. Like Short Description, this field may contain HTML. |
| Name | Description |
|---|---|
Register |
Register allows you to register a new application. You can register the same procedure more than once as long as they are registered in different folders (parents). |
Change |
Change allows you to change the current registration information. |
Delete |
Delete allows you to unregister your application. Note that you cannot delete a procedure that has been dropped. Nor can you delete a parent if it has children. |
Next |
This button allows you to scroll to the next registered application. |
Back |
This button allows you to scroll to the prior registered application. |
First |
This button allows you to scroll to the first registered application. |
Last |
This button allows you to scroll to the last registered application. |
Report |
Report creates a report of all procedures for this schema. To run the report make sure that a registered procedure has been loaded. To restrict the report to a particular folder, select the appropriate Group Name. |
Find |
Find allows you to search for a particular application. |