Define Form

Use

You define a form for a specific Internal Service Request scenario. This form is later filled out by the person entering the request.

Prerequisites

...

       1.      In Customizing under Cross-Application Components ®Internet/Intranet Services ® Internal Service Request ® Scenario Definition ®Define Scenarios, you defined a scenario.

For more information on the scenario, see Definition of a Scenario.

You define special fields for the request in Customizing for scenarios. You can use the following characteristic categories for this:

·         Characteristics with a reference to a category=data element

·         Characteristics with a reference to a category=structure

·         Uncategorized characteristics

You can evaluate characteristics on the HTML template under the name specified there.

The only exception is characteristics with reference to a structure. In this case, the structure fields can be used with their names (without the prefix of <structure name> or similar names) in the HTML template. This means that structures are continuously broken down for the request and can, therefore, be seen as a more compact definition instead of a selection of single characteristics that refer to data elements.

In all three cases, the characteristic description is available as a field label in the HTML template as well as the name and the characteristic content.

Categorized characteristics can use the field length in addition. In addition, the input/output format is executed for characteristics that refer to data elements or structure fields, in the same way as for screen fields.

Uncategorized characteristics have the implicit CHAR250 category without input/output conversion.

The following restrictions apply to the definition of the scenario characteristics:

·         Characteristic names or structure field names must be unique within a scenario.

·         Characteristic names or structure field names may not begin with ISR_

·         Characteristic names or structure field names should not be named as HTML business indicators (such as LABEL, NAME, VALUE, DIM, MAXSIZE, TYPE, EXISTS, ENABLED, or VISSIZE).

·         The characteristic names or structure field names should have a maximum length of 28 characters.

·         The data length of the characteristic or structure fields is restricted to 250 characters.

       2.      You have generated and published an ITS service.

For more information on generating an ITS service, see Generating a Service.

Process

An Internet service for an internal service request has the following components:

·        Service file with ITS parameters

·        HTML templates for the different processing modes in the request

·        File with the language-dependent resources from the HTML template.

You can process Internet services in the SAP@Web Studio, or in the Web Application Builder (access from Customizing for scenarios). However, the SAP@Web Studio has several advantages over the Web Application Builder (syntax check, more user-friendly editor, clearer management of the individual components and several Internet services at the same time, and more extensive help functions). You can also switch between tools during processing. You can use the source control in the SAP@Web Studio to check Internet services in and out of the SAP@Web Studio.

For more information on adaptation tools, see the SAP Library under:

·        Basis ® BC-ABAP Workbench ® Integration of Internet Services ® Web Application Builder

·        Basis ® SAP-Internet Applications ® SAP@Web Studio

Service Parameters

In an Internet service, you need the following parameters for an internal service request:

Parameters

Value

SCENARIO

Scenario Name

~TRANSACTION

QISR1

~WEBTRANSACTIONTYPE

EWT

~GENERATEDYNPRO

1

~STYLE

DHTML

~AUTOSCROLL

0

~LISTSCROLLING

0

~POPUPS

1

HTML Templates

You start the internal service request with transaction QISR1 in the SAP system (program SAPLQISR3). One of the following screens appears, depending on the processing mode. For each of these subscreen containers, you can define your own HTML template to generate the corresponding HTML form:

Mode

Screen

HTML Template

CREATE

110

saplqisr3_110.html

CHANGE

120

saplqisr3_120.html

DISPLAY

130

saplqisr3_130.html

All HTML templates should be assigned to Default-Theme 99. You can leave out the HTML template for processing modes that you do not require.

If you do not require any variants for the request for the different processing modes, define the HTML template for the display mode. You can enter the following HTML business statement for all other HTML templates:

`include(~theme="99", ~language="", ~name="saplqisr3_110.html")`

This statement ensures that for each HTML template, the saplqisr3_110.html HTML template for the create mode is referenced.

In the HTML template for creating, if you use the functions from the ISR HTML library (for SAP Design) or from the ISR Plain HTML Library (for Plain HTML), then the entry fields are automatically switched to Not ready for input depending on the processing mode.

Definition of an HTML Template for the ISR

The simplest HTML template contains the HTML code for displaying the request in the Web browser. You can embed the HTMLBusiness statement into the HTML template for a dynamic HTML page layout.
For more information on HTMLBusiness, see the SAP@Web Studio or theWeb Application Builder under Application Help. You can use HTMLBusiness to create HTML statements under certain circumstances for example (if ( ... ) ... else ... end;) or in loops (for ... ;). In the HTML template, the following always applies:

·        Statements included in ` (backtick) contain HTML business code

·        Statements not included in ` (backtick) contain HTML code, which is generated directly into the HTML page.

Data from the SAP system can likewise be addressed using HTMLBusiness in the HTML template. For example, the instruction BUILDING_TO has the effect that in the HTML page generated based on the template the value of the characteristic BUILDING_TO is output.

As well as the special characteristics defined in Customizing for scenarios, you can use the following general data from the internal service request in the HTML template.

Name

Description

Name in BADIs

ISR_HEADER-NOTIF_NO

Notification Number

GENERAL_DATA -NOTIF_NO

ISR_HEADER-NOTIF_TYPE    

Notification type

GENERAL_DATA-NOTIF_TYPE      

ISR_HEADER-SCENARIO       

Scenario

GENERAL_DATA-SCENARIO 

ISR_HEADER-CREATION_DATE

Creation date

GENERAL_DATA-CREATION_DATE

ISR_HEADER-CREATION_TIME

Creation time

GENERAL_DATA-CREATION_TIME

ISR_HEADER-CALC_COSTS

Calculated costs

GENERAL_DATA-CALC_COSTS

ISR_HEADER-CALC_COSTS_CURR

Currency key for CALC_COSTS

GENERAL_DATA-CALC_COSTS_CURR

ISR_HEADER-LANGUAGE     

Language

GENERAL_DATA-LANGUAGE       

ISR_HEADER-START_DATE  

Start date

GENERAL_DATA-START_DATE    

ISR_HEADER-START_TIME    

Start time

GENERAL_DATA-START_TIME     

ISR_HEADER-REQ_DATE       

Required date

GENERAL_DATA-REQ_DATE

ISR_HEADER-REQ_TIME

Required time

GENERAL_DATA-REQ_TIME  

ISR_HEADER-PRIORITY 

Priority

GENERAL_DATA-PRIORITY   

ISR_PAGE

Current page number

PAGE

ISR_HEADER-EXT_REF_NUMBER

External reference number

GENERAL_DATA-EXT_REF_NUMBER

ISR_HEADER-SHORT_TEXT

Short text

GENERAL_DATA-SHORT_TEXT

ISR_HEADER-ESTIM_COSTS 

Estimated costs

GENERAL_DATA-ESTIM_COSTS   

ISR_HEADER-ESTIM_COSTS_CURR

Currency key for ESTIM_COSTS

GENERAL_DATA-ESTIM_COSTS_CURR

ISR_MODE

Current mode (CREATE, DISPLAY, and so on)

MODE

ISR_FORM_VIEW

View

Default:
ISR_REQUEST
If processor calls the form for the message:
ISR_PROCESS

ISR_CREATED_BY-USER_ID

Created by: User name

ISR_GENERAL_DATA-CREATED_BY-USER_ID

ISR_CREATED_BY-FIRSTNAME

Created by: First name

ISR_GENERAL_DATA-CREATED_BY-FIRSTNAME

ISR_CREATED_BY-LASTNAME

Created by: Last name

ISR_GENERAL_DATA-CREATED_BY-LASTNAME

ISR_CREATED_BY-FULLNAME

Created by: Full name

ISR_GENERAL_DATA-CREATED_BY-FULLNAME

ISR_CREATED_BY-TITLE       

Created by: Title

ISR_GENERAL_DATA-CREATED_BY-TITLE  

ISR_CREATED_BY-DEPARTMENT

Created by: Department

ISR_GENERAL_DATA-CREATED_BY-DEPARTMENT

ISR_CREATED_BY-BUILDING

Created by: Building

ISR_GENERAL_DATA-CREATED_BY-BUILDING

ISR_CREATED_BY-FLOOR    

Created by: Floor

ISR_GENERAL_DATA-CREATED_BY-FLOOR       

ISR_CREATED_BY-ROOM_NO

Created by: Room number

ISR_GENERAL_DATA-CREATED_BY-ROOM_NO

ISR_CREATED_BY-E_MAIL    

Created by: eMail address

ISR_GENERAL_DATA-CREATED_BY-E_MAIL       

ISR_CREATED_BY-TEL_NUMBER

Created by: Telephone

ISR_GENERAL_DATA-CREATED_BY-TEL_NUMBER

ISR_CREATED_BY-TEL_EXTENSION

Created by: Telephone extension

ISR_GENERAL_DATA-CREATED_BY-TEL_EXTENSION

ISR_CREATED_BY-FAX_NUMBER

Created by: Fax

ISR_GENERAL_DATA-CREATED_BY-FAX_NUMBER

ISR_CREATED_BY-FAX_EXTENSION

Created by: Fax extension

ISR_GENERAL_DATA-CREATED_BY-FAX_EXTENSION

ISR_CREATED_BY-COMPANY

Created by: Company

ISR_GENERAL_DATA-CREATED_BY-COMPANY

ISR_CREATED_BY-MASTER_CCTR

Created by: Master cost center

ISR_GENERAL_DATA- CREATED_BY-MASTER_CCTR

ISR_CREATED_BY-MASTER_COAREA

Created by: Master controlling area

ISR_GENERAL_DATA- CREATED_BY-MASTER_COAREA

ISR_INITIATED_BY- …

According to applicant

ISR_GENERAL_DATA-INITIATED_BY- …

ISR_APPROVED_BY- …

According to approving manager

ISR_GENERAL_DATA-APPROVED_BY- …

ISR_PROCESSOR- …

According to processor

ISR_GENERAL_DATA-PROCESSOR- …

ISR_CONTACT_PERSON- …

According to contact person for scenario

ISR_GENERAL_DATA-CONTACT_PERSON- …

The following functions are available in the SAP General HTMLBusiness Functions Library to enable you to create the most important form elements (buttons, fields, labels etc.) quickly and easily:

·        SAPDesign

To simplify the creation of HTML templates for internal service requests further, there is a supplement to the SAP General HTML Business Functions Library for internal service requests. You include this library in HTML templates using the following statement:

`include(~service="sr_library", ~theme="99", ~language="", ~name="ISR_Template_Library.html")`

If you use this library, you can automatically use the functions of the SAP General HTML Business Functions Library.

See also:

Example: HTML Framework for HTML Templates for Internal Service Requests

Example: Specific Form Elements in HTML Templates (SAPDesign)

·        Plain HTML

To make it easier to create Plain HTML templates, you can use the following statement to include a library in your template:

`include(~service="sr_library", ~theme="99", ~language="", ~name="ISR_Template_Library_Plain_HTML.html")`

See also:

Example: Specific Form Elements in HTML Templates (Plain HTML)