events in script program

[Former Member]

what are the events sap scaript program....

[Former Member]

Hi,

if you are talking about Function modules

then first OPEN_FORM "used to open the form

WRITE_FORM "used to write the content to form

CLOSE_FORM "used to close the form which is opened.

START_FORM "used to start a form

"you can call different layout

END_FORM "used to end the form which was started

CONTROL_FORM "using this you can call control commands

<b>Reward points</b>

Regards

[Former Member]

Hi

Function Modules Used in Script:

In the Driver Program we must use all or some of the function modules that are listed below to transfer the data.

• Open_Form

• Close_Form

• Start_Form

• Write_Form

• Write_Form_Lines

• End_Form

• Control_Form

• Read_Form_elements

• Read_Form_Lines

Any driver program must contain Open_Form, Close_Form and Write_Form. Other function modules are optional.

OPEN_FORM: This function module opens layout set printing. One must call this function module before he uses any of other layout set function modules like Write_Form, Start_Form, Control_Form etc., You need specify a layout set name in the export parameters of this function module. If nothing is passed to Open_Form then one should use Start_Form function module to open layout set before starting the output. The layout set opened by Open_Form should be closed by Close_Form function module, other wise output doesn’t appear. We can use any number of Open_Form, Close_Form functions in one single program. But Close_Form must be there for every Open_Form in the program.

Some of the important export parameters we have to pass to Open_Form function module.

Form: Enter the Layout set name here, which then controls the output formatting. If nothing is specified then we must use Start_Form for opening layout set.

Language: Layout sets are Language dependent. Enter the desired language here. If the entered layout set is not in that language, then the function tries to open the Form entered in its original language. The default value is SY-LANGU.

Device: SAP Script can format a text on different device types. The device can be ‘PRINTER’ or ‘TELEX’, ‘TELEFAX’, ’ABAP’ and ‘SCREEN’.

Dialog: Use parameter DIALOG to determine whether to display a dialog box before printing, in which the user can set several spool parameters for print formatting. Possible values: SPACE displays no print parameter screen. 'X' display print parameter screen. Default value: 'X'

Options: Use parameter OPTIONS to set several options for print formatting. The parameter has the structure ITCPO. The user can change some of the defined settings on the print control screen. The default value for Options is ‘ ‘. We will discuss about ITCPO structure in detail later.

Other Export, Import and Exceptions are self-explanatory.

Close_Form: The function module closes the layout set opened using OPEN_FORM. The system executes any terminating processing steps for the last opened layout set. No Export parameters for this Function Module.

Start_Form: In-between the function modules OPEN_FORM and CLOSE_FORM, we can use different layout sets. This allows us to combine several different layout sets into one print output. However, we can combine only those layout sets that have the same page format. To switch layout sets, use the function module START_FORM. If another layout set is still open, we must close it first using END_FORM. If we specify no layout set name when calling START_FORM, the system restarts the last open layout set. If after OPEN_FORM no layout set was activated yet, the system leaves the function module with the exception UNUSED. Some of the important export parameters for this function module are

Form: The parameter contains the name of the layout set you want to use for printing. If you specify no layout set here, the system restarts the last active layout set.

Language: Layout sets are language-dependent. Enter the desired language here. If the layout set does not exist in this language, the system tries to call the layout set in its original language. If the parameter LANGUAGE is empty, the system uses the language of the last active layout set.

Startpage: Usually, SAP script starts with the page specified as start page in the layout set definition. If we want to start output with another layout set page, enter the name of the desired layout set page here. If the desired page is not defined, the system uses the start page defined in the layout set.

Program: To replace program symbols, SAP script must know which active program contains the work areas for the values to be passed. If we omit the parameter, the system searches for the field values in the program that was specified in the parameter OPTIONS (field TDPROGRAM) of OPEN_FORM. If we enter a program name, the system replaces the program symbols with the values from this program up to the next END_FORM.

Exceptions and other Export, Import parameters are self-explanatory.

Write_Form: The system outputs the layout set element specified in parameter ELEMENT into the currently opened layout set. In the parameter WINDOW we can specify the name of a window for the output. Remember that the layout set element must be defined in this window. The parameter FUNCTION specifies how to merge the text lines to be output with any existing contents in the window. In this case, there are differences between the different window types or areas. Some of the important export parameters used in Write_Form.

Element: Specify the name of the text element you want to output into the layout set window specified in the parameter WINDOW. The element must be defined in that layout set window. If you specify no element, the system uses the default element, if one is defined in the layout set.

Window: Specify the name of the window into which you want to output the layout set element specified in the parameter ELEMENT. Default value for Window is ‘MAIN’.

Function: The parameter determines how to output the text element into the respective window. The output type depends on the window type and area:

Window Type: MAIN Area: BODY

SET/APPEND: Appends to previous output.

Window Type: Main Area: Top/Bottom and

Window Type: Other than Main and all areas

SET : Delete the old element contents and prints the new elements

APPEND: Appends the new content to existing elements.

Type: The system interprets this parameter only for output to the main window. The parameter determines the area of the main window into which we want to output the element. Possible values: 'TOP' header area

'BODY' main area

'BOTTOM' footer area

Default value: 'BODY'

Write_Form_Lines: This function module outputs the text lines in table LINES into the specified layout set window. The text lines must have the SAP script ITF format. From the data in the text header, the system uses only the field TDSTYLE to apply the formatting attributes defined in the specified style for this text. If the field is empty, the system uses the identically named formatting attributes (character and paragraph formats) of the layout set.

Use parameter WINDOW to specify into which of the windows defined in the layout set we want to output the text. We can specify any window used in the layout set. The parameter FUNCTION determines how to merge the text lines to be output with any existing contents in the window. There are differences between the different window types or areas.

Header: This parameter contains the header of the text module we want to output in the current layout set. For the formatting process, the system uses only the entries in the header fields TDSTYLE and TDFORM. Structure: THEAD

WINDOW: Enter the name of the window into which we want to output the layout set element specified in parameter ELEMENT. Default value: 'MAIN'

FUNCTION: This parameter determines how to output the text element into the respective window. The output type depends on the window type and area: Window type MAIN, area BODY: 'SET' append to previous output 'APPEND' same as SET. DELETE' no effect. Window type MAIN, areas TOP and BOTTOM; all other windows: 'SET' delete old window or area contents and output the element 'APPEND' append the element to the existing elements 'DELETE' no effect Default value: 'SET'

TYPE: The system interprets this parameter only for output to the main window. The parameter determines the area of the main window into which you want to output the element. Possible values: 'TOP' header area 'BODY' main area 'BOTTOM' footer area Default value: 'BODY'

END_FORM: END_FORM ends the currently open layout set and executes the required termination processing. After calling this function module, no more layout set is active. For further output, we must start a new layout set using START_FORM. No Export parameters.

CONTROL_FORM: Use this function module to pass SAP Script Control Commands to the layout set. The Control command is passed through the export parameter ‘COMMAND’ in quotes.

READ_FORM_ELEMENTS: This function module fills a table with all text elements that appear in one layout set. If we specify no layout set name, the system includes all elements of the currently open layout set. If we specify a layout set, the system uses the information about the active version of the layout set, retrieved from the database. Here we have two export parameters, Form and Language and a table parameter Elements.

READ_FORM_LINES: Use this function module to transfer the lines of a layout set element into an internal table. If we specify no layout set name, the system transfers the text lines of the currently open layout set. If we specify a layout set, the system uses the text lines of the active version of the layout set from the database. The Export parameters are Form, Language, Window and Element. If we pass these 4 parameters the function module returns a table with the lines from layout set.

A variable in SAPscript is called a symbol. There are the following types.

• System symbol (e.g. the number of the current page)

• Standard symbol (usable in any document)

• Program symbol (value from the print program)

• Text symbol (“local variable”)

The value of a symbol is text for using within SAPscript code and is represented by the symbol-name enclosed by ampersands. On seeing the tell-tale ampersands in SAPscript code, you sometimes need to figure out the symbol type.

goto any PAGEWINDOW's Text elements in Script (SE71)

from the Menu-> INSERT-> Symbols

you find all symbols here

System symbols

System symbols in a SAPscript form are comparable to system fields like SY-UZEIT in an ABAP program, and include these. The graphical editor offers three types of system symbol.

1. General system symbols

See the table TTSXY. PAGE is the most widely used. The list given in our BC460 training manuals is out of date.

2. SAPscript system symbols

See the dictionary structure SAPSCRIPT. SAPSCRIPT-FORMPAGES is the most widely used.

3. ABAP system symbols

For the ABAP system field SY-UNAME, say, the symbol is SYST-UNAME. [SYST is the dictionary structure for ABAP system fields.]

Sample code:

• User: &SYST-UNAME&

• Page &PAGE& of &SAPSCRIPT-FORMPAGES(C3)&

Standard symbols

Standard symbols are maintained centrally (in the table TTDTG via transaction SE75) for use in any document. Menu path:

Tools

Form Printout

Administration

Settings

Some standard symbols are SAP-standard and others are custom. Curiously, table TTDTG is cross-client although SAPscript forms are not.

The value of a standard symbol has to be defined for each language used. This gives a way to make a single SAPscript form multi-lingual.

We can take advantage to an extent of the central maintenance, though there is no guarantee that the available standard symbols will used in every appropriate context.

Standard symbols complicate searching a SAPscript form, since text like ‘Charity registration 211581’ may be hiding in a standard symbol.

Text symbols

A text symbol is declared and assigned to within the SAPscript code, and so obviously applies only to the current document. The command DEFINE is used, requiring /: in the tag column, as in the following examples.

/: DEFINE &COMP_NAME& = ‘University of Warwick’

/: DEFINE &WS_RATE& = &TAX_SUMM_C&

SCRIPT COMMANDS

ADDRESS : Formatting of Address

BOTTOM, ENDBOTTOM : Define Footer text in a window

BOX, POSITION, SIZE : Boxes, Lines and Shading

CASE, ENDCASE : Case Distinction

DEFINE : Value assignment to text symbols

HEX, ENDHEX : Hexadecimal values

IF, ENDIF : Conditional text output

INCLUDE : Include other texts

NEW-PAGE : Explicit forms feed

NEW-WINDOW : Next window main

PRINT-CONTROL : Insert print control character

PROTECT...ENDPROTECT : Protect from page break

RESET : Initialize outline paragraphs

SET COUNTRY : Country-specific formating

SET DATE MASK : Formating of date fields

SET SIGN : Position of +/- sign

SET TIME MASK : Formating of time fields

STYLE : Change style

SUMMING : Summing variables

TOP : Set header text in window MAIN

<b>Reward points for useful Answers</b>

Regards

Anji