Sybernet / Supplied PeopleSoft Reference
Release 3.00
May 21, 2005
forwards forwards

PSHRPRD.SP_HTML_FILTER

This procedure creates a form screen. Its purpose is to gather input from the user and pass that information to your procedure for processing. The advantage is that a single call to sp_html_filter will have a single look and feel for all your users. It also provides built-in functions that allows the output of your stored procedure to be sent to a printer or e-mailed to a user. Options also exist to format the output as HTML, Excel, or RTF. All you have to do is create your output in HTML and sp_html_filter will handle the rest. The disadvantage is that you are limited by a well known list of parameters that sp_html_filter recognizes. In general, this covers about 90% of all the sort of parameters you might want to request.


Syntax

Procedure SP_HTML_FILTER
(
    PROCNAME                      VARCHAR2
,   VERSION                       VARCHAR2
,   TITLE                         VARCHAR2
,   BUTTON                        VARCHAR2
,   SORT                          VARCHAR2
,   TARGET                        VARCHAR2
,   SECURITYTYPE                  VARCHAR2
,   STYLE                         VARCHAR2
,   ONLOAD                        VARCHAR2
,   APPEARANCE                    VARCHAR2
,   ATTACHMENT_NAME               VARCHAR2
,   DEPARTMENT                    VARCHAR2
,   GROUP                         VARCHAR2
,   DIVISION                      VARCHAR2
,   CONTEXTTYPE                   VARCHAR2
,   CONTENTTYPE                   VARCHAR2
,   DEVICENAME                    VARCHAR2
,   OFFLINE                       VARCHAR2
,   POSTSCRIPT                    VARCHAR2
,   COMPANY                       VARCHAR2
,   EMPLID                        VARCHAR2
,   DEPTID                        VARCHAR2
,   YEAR_ACQUIRED                 VARCHAR2
,   HRS_ADJUST_UNPROC             VARCHAR2
,   PLAN_TYPE                     VARCHAR2
,   ACCOMPLISHMENT                VARCHAR2
,   SCHOOL_CODE                   VARCHAR2
,   RUN_ID                        VARCHAR2
,   TAX_LOCATION_CD               VARCHAR2
,   PERIOD_END_DT                 VARCHAR2
,   SUB_PERIOD_END_DT             VARCHAR2
,   START_DATE                    VARCHAR2
,   STOP_DATE                     VARCHAR2
,   EFFDT                         VARCHAR2
,   BALANCE_YEAR                  VARCHAR2
,   BALANCE_QTR                   VARCHAR2
,   BALANCE_PERIOD                VARCHAR2
,   BALANCE_ID                    VARCHAR2
,   PAYGROUP                      VARCHAR2
,   GROUPNUMBER                   VARCHAR2
,   NATIONAL_ID                   VARCHAR2
,   EMPL_STATUS                   VARCHAR2
,   REG_TEMP                      VARCHAR2
,   MENUBAR                       VARCHAR2
,   SHELLSCRIPT                   VARCHAR2
,   CONFIGURATION                 VARCHAR2
,   BORDER                        VARCHAR2
,   BORDERCOLOR                   VARCHAR2
,   CELLPADDING                   VARCHAR2
,   CELLSPACING                   VARCHAR2
,   BGCOLOR                       VARCHAR2
,   WIDTH                         VARCHAR2
,   SEARCH                        VARCHAR2
,   MY_BUTTON                     VARCHAR2
)   ;

Parameters

Parameter Description
procname
 
The name of your procedure. Normally, you can pass HTTP.MYSELF.NAME to this procedure.
version
 
The version of your procedure. Normally, you can pass HTTP.MYSELF.VERSION to this procedure.
title
 
The title of your procedure. Normally, you can pass HTTP.MYSELF.TITLE to this procedure.
button
 
This is the value of BUTTON that is passed to your procedure when your procedure is invoked. Multiple buttons can be specified by separting their name or description with commas.
sort
 
This parameter determines how the list of deparments, divisions, and groups are sorted. The default is ORG which causes this list to be sorted by department number. Valid values include ORG (the default), DEPARTMENT, GROUP, and DIVISION.
target
 
This parameter determines the target window that sp_html_filter is to use. This should be NULL or unspecified when the output is sent to the same window or frame.
securitytype
 
This parameter determines the row-level (or org level security) that should be imposed when displaying a list of valid department numbers. A value of PUBLIC means this user can see all orgs. A value of PRIVATE means this user is restricted to only those orgs that they are allowed to see.
style
 
This parameter determines the default date format for date fields.
onload
 
This parameter allows you to execute JavaScript when this page is built.
appearance
 
This parameter allows you override the default appearance of this screen.
attachment_name
 
This parameter allows you to specify the name of e-mail attachments.
department
 
description
group
 
description
division
 
description
contexttype
 
description
contenttype
 
description
devicename
 
description
offline
 
description
postscript
 
description
company
 
description
emplid
 
description
deptid
 
description
year_acquired
 
description
hrs_adjust_unproc
 
description
plan_type
 
description
accomplishment
 
description
school_code
 
description
run_id
 
description
tax_location_cd
 
description
period_end_dt
 
description
sub_period_end_dt
 
description
start_date
 
description
stop_date
 
description
effdt
 
description
balance_year
 
description
balance_qtr
 
description
balance_period
 
description
balance_id
 
description
paygroup
 
description
groupnumber
 
description
national_id
 
description
empl_status
 
description
reg_temp
 
description
menubar
 
description
shellscript
 
description
configuration
 
description
border
 
description
bordercolor
 
description
cellpadding
 
description
cellspacing
 
description
bgcolor
 
description
width
 
description
search
 
description
my_button
 
description


Example

The following example illustrates how to call sp_html_filter:

to be specified



Sybernet is a trademark of SRI International.
Copyright © 1996-2006 SRI International. All Rights Reserved.
Denis D. Workman / http://Sybernet.sri.com/