Sei sulla pagina 1di 22

Modification Guide

SAP Biller Direct ® 3.0

Document Version 1.00 – May, 2004

Based on mySAP Financials ® Accounts Receivable and Payable (FI-CA)

® 3.0 Document Version 1.00 – May, 2004 Based on mySAP Financials ® Accounts Receivable and

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

Copyright

© Copyright 2004 SAP AG. All rights reserved.

No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice.

Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors.

Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation.

IBM, DB2, DB2 Universal Database, OS/2, Parallel Sysplex, MVS/ESA, AIX, S/390, AS/400, OS/390, OS/400, iSeries, pSeries, xSeries, zSeries, z/OS, AFP, Intelligent Miner, WebSphere, Netfinity, Tivoli, and Informix are trademarks or registered trademarks of IBM Corporation in the United States and/or other countries.

Oracle is a registered trademark of Oracle Corporation.

UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group.

Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc.

HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C®, World Wide Web Consortium, Massachusetts Institute of Technology.

Java is a registered trademark of Sun Microsystems, Inc.

JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape.

MaxDB is a trademark of MySQL AB, Sweden.

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

Icons in Body Text

Icon

Meaning

Caution

Caution

Example

Note

Recommendation

Syntax

Caution Example Note Recommendation Syntax Additional icons are used in SAP Library documentation to

Additional icons are used in SAP Library documentation to help you identify different types of information at a glance. For more information, see Help on Help Æ General Information Classes and Information Classes for Business Information Warehouse on the first page of any version of SAP Library.

Typographic Conventions

Type Style

Description

Example text

Words or characters quoted from the screen. These include field names, screen titles, pushbuttons labels, menu names, menu paths, and menu options.

Cross-references to other documentation.

Example text

Emphasized words or phrases in body text, graphic titles, and table titles.

EXAMPLE TEXT

Technical names of system objects. These include report names, program names, transaction codes, table names, and key concepts of a programming language when they are surrounded by body text, for example, SELECT and INCLUDE.

Example text

Output on the screen. This includes file and directory names and their paths, messages, names of variables and parameters, source text, and names of installation, upgrade and database tools.

Example text

Exact user entry. These are words or characters that you enter in the system exactly as they appear in the documentation.

<Example text>

Variable user entry. Angle brackets indicate that you replace these words and characters with appropriate entries to make entries in the system.

EXAMPLE TEXT

Keys on the keyboard, for example, F2 or ENTER.

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

Modification of SAP Biller Direct

5

Contract Accounts Receivable and Payable Enhancements

5

Filling the Tables at Event 1231

6

Adapting the Web Application

9

Showing Customer Fields

10

Adapting Interface Texts

11

Changing Texts

11

Deleting Texts

13

Creating Texts

14

Adapting the Interface Design

15

Changing the User Interface at Runtime

16

Integrating Separate Customer Functions

16

Creating the Event Handler and Java Beans

17

Inserting New Menu Options

17

Creating Your Own JavaServer Pages

18

Registering New Components

18

Registering New JavaServer Pages

18

Registering the New Event Handler

18

Registering New Resource Bundles

18

Executing Customer Enhancements

19

Adapting Web User Documentation

19

Adapting the Design of the Web User Documentation

20

Deactivating the Documentation Type

21

Deactivating Entire Web User Documentation

22

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

Modification of SAP Biller Direct

Purpose

In addition to the system settings in the back end and in the Web application, you can modify the back end and the Web application as described in the following sections to better adapt them to your requirements.

Implementation Considerations

Contract Accounts Receivable and Payable (FI-CA) is not included in mySAP ERP 2004.

SAP does not provide maintenance for modifications you implement yourself.

Contract Accounts Receivable and Payable Enhancements

Use

In addition to the system settings given, there are various other events and BAdIs that you can use to adapt the functions of SAP Biller Direct to meet your company requirements.

Prerequisites

You have made the initial system settings in FI-CA.

Features

You can use the following events for installation- and industry-specific enhancements:

Sample Function Module

Function

FKK_SAMPLE_1231

Create Web user view of bills, payments, and credits (see also example for Filling the Tables [Seite 6])

FKK_SAMPLE_1232

Determine payment method for items

FKK_SAMPLE_1233

Determine customer fields from document table

FKK_SAMPLE_1235

Insert final changes before transferring the bills and credits to the Web application

FKK_SAMPLE_1236

Carry out authorization of payment card

FKK_SAMPLE_1237

Determine business object for the Web user

FKK_SAMPLE_1238

Update statistics for payments made in the Web application

FKK_SAMPLE_1239

Add data for posting documents

FKK_SAMPLE_1240

Make additional document changes on payment

FKK_SAMPLE_1241

Evaluate results of credit card authorization

FKK_SAMPLE_1242

Trigger subsequent actions after paying

FKK_SAMPLE_1243

Change name of contract account

FKK_SAMPLE_1244

Determine additional data for initializing the application

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

FKK_SAMPLE_1245

Generate descriptions for business partner, contract account, and contract

FKK_SAMPLE_1246

Determine address for changing and displaying address

FKK_EBPP_CHANGE_ADDRESS_1260

Change an address

(event 1260)

For detailed information, see the documentation for the function modules mentioned above.

Also available for modifications are the Business Add-Ins FIS_INVOICEDETAIL (determination of detailed data for a bill) and GEN_EBPP_DEBITOR_SL (search for possible business partners). Detailed information is available in the BAdI documentation (see the Implementation Guide for Contract Accounts Receivable and Payable under Integration Æ Financial Supply Chain Management Æ Biller Direct).

Activities

As with other functions in the standard system, you choose between:

Standard function module

Industry function module

Customer function module

Program separate function modules using the sample function modules (FKK_SAMPLE_*) in the table as a template, and define these in the FI-CA Implementation Guide under Program Enhancements Æ Define Customer-Specific Function Modules. See also the documentation for the Customizing activity and sample function modules.

Filling the Tables at Event 1231

Initial Situation

A customer has two open bills and a credit. For each bill and the credit there is a document with an item:

Bill 1 for EUR 100 (identification R1)

Bill 2 for EUR 200 (identification R2)

Credit 1 for EUR 10 (identification G1)

When you call up event 1231, this results in the following content for table T_ITEMS:

Table T_ITEMS

 

OPBEL

OPUPW

OPUPK

OPUPZ

BETRW

FAEDN

STAPP

4711

000

0001

0000

100

01/01/2002

1

4712

000

0001

0000

200

01/10/2002

1

4713

000

0001

0000

-10

12/01/2001

1

Once you have run event 1231 the remaining tables have the following content:

Table T_INVOICES

 

INVID

LINCT

DOCT1

BETRW

FAEDN

STAPP

R1

1

Bill 1

100

01/01/2002

1

R2

2

Bill 2

200

01/10/2002

1

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

G1

3

Credit 1

-10

12/01/2001

1

Table T_ALLOCATION

   

OPBEL

OPUPW

OPUPK

OPUPZ

INVID

4711

000

0001

0000

R1

4712

000

0001

0000

R2

4713

000

0001

0000

G1

The remaining tables are not yet filled, as no payment has yet been made.

Payment

The customer makes two partial payments for these bills in the Web application and deducts the credit from the payment amount.

On January 5, he arranges for EUR 110 to be deducted from his account 1111 by bank collection:

Bill 1

EUR 40

Partial payment

Bill 2

EUR 80

Partial payment

Credit 1

EUR 10

Clearing

On January 15, he arranges for EUR 180 to be deducted from his account 2222 by bank collection:

Bill 1

EUR 60

Payment of remaining balance

Bill 2

EUR 120

Payment of remaining balance

Once the system has run event 1231, the contents of table T_ITEMS are as follows:

Table T_ITEMS

 

OPBEL

OPUPW

OPUPK

OPUPZ

BETRW

PAYINFO

FAEDN

STAPP

4711

000

0001

0000

100

*

01/01/2002

9

4712

000

0001

0000

200

*

01/10/2002

9

4713

000

0001

0000

-10

Bank collection

12/01/2001

9

International

Bank

Account 1111

Once you have run event 1231 the remaining tables have the following content:

 

Table T_INVOICES

 

INVID

LINCT

DOCT1

 

BETRW

FAEDN

STAPP

R1

1

Bill 1

 

100

01/01/2002

9

R2

2

Bill 2

 

200

01/10/2002

9

G1

3

Credit 1

 

-10

12/01/2001

9

Table T_ALLOCATION

 

OPBEL

OPUPW

OPUPK

OPUPZ

INVID

4711

000

0001

0000

R1

4712

000

0001

0000

R2

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

4713

000

0001

0000

G1

If the indicators FILLPAYALLO and FILLMYPAYMENTS have been filled with an X in structure E_CONTROLDATA, tables T_MYPAYMENTS and T_PAYALLOCATION do not have to be filled. This data is filled by the system. However, if you fill this data yourself, you must enter a space in the indicators. Once the system has run standard event 1231, these tables have the following content:

Table T_MYPAYMENTS

 

REFID

DOCT1

BETRW

VALUT

Z1

Bank collection International Bank , Account 1111

110

01/05/2002

Z2

Bank collection International Bank , Account 2222

180

01/15/2002

Table T_PAYALLOCATION

 

INVID

REFID

AMOUNT

ALLOCATED_INVID

ALLOCATED_AMOUNT

G1

Z1

-10

R1

10

R1

Z1

40

 

30

R1

Z2

60

 

60

R2

Z1

80

 

80

R2

Z2

120

 

120

The table T_PAYALLOCATION creates the connection between paid bills and payments made, whereby the two amount fields are used for two different views:

The amounts in the AMOUNT field are for the detail display of a payment, and show which bills a payment was applied to. You can establish from this data, for example, that from payment Z1 EUR 40 are allotted to bill R1 and EUR 80 to bill R2. In addition a credit of EUR 10 has been cleared (connection to Z1 via the field ALLOCATED_INVID). The total amount adds up to EUR 110 and is equal to the payment amount.

The amount field ALLOCATED_AMOUNT is for detail display of bills and shows which payments were applied to a bill. You can establish from this data, for example, that bill R1 was paid using EUR 30 from payment Z1 and EUR 60 from payment Z2. In addition, credit G1 was used in payment of this bill. The total amount adds up to EUR 100 and is equal to the bill amount.

The example mentioned illustrates the difference between the two amount fields. From the point of view of a payment, the credit amount reduces the payment of a bill (the credit amount is negative). From the point of view of a paid bill, the credit increases the paid part (amount of the credit is positive). The partial amounts add up to the total amount of the bill or payment for which you want to display the detail information (differing amount for the line R1 and Z1).

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

Adapting the Web Application

Use

In addition to the normal Web application configuration, you can change texts, graphics and the layout, for example, if you want to insert your company logo or ensure your company- specific terminology is being used. SAP recommends that you check the contents of the following Web user documentation:

FAQ

Are you a new user?

Glossary

SAP supplies example texts which you need to check and if necessary correct on the basis of the following criteria:

Are the statements in line with your company practice?

Do the statements correspond to the configuration of Contract Accounts Receivable and Payable?

Do the statements correspond to the configuration of the Web application?

Prerequisites

You have configured contract accounts receivable and payable.

To make any adaptations, you should be familiar with HTML, Cascading Style Sheet (CSS) and JavaServer Pages (JSP). Enter umlauts and other special characters in accordance with the HTML standard in all text files (for example Zurück is Zur&uuml;ck in HTML formatting).

Features

The following tables give you an overview of the possible adaptations you can make to the Web application. Detailed entries can be found in the following sections.

Adapting the Web Application

Area

Function

Comments

Customer fields

Insert

Only possible for totals information (table T_TOTALS, see documentation of sample function module

FKK_SAMPLE_123

5).

Interface texts

Change

 

Delete

 

Insert

 

Interface design

Colors

 

Fonts

 

Spacing

 

Graphics

 

Web user documentation

Change, delete, or insert text

Check strongly

recommended

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

 

Deactivate individual documentation type

Deactivate entire Web user documentation

Design of the Web user documentation

Colors

Fonts

 

Spacing

Graphics

Web pages

Deactivating an Entry in Application Menu

Showing Customer Fields

Use

You can display your own fields that you add to the existing structures or tables in the back end and fill in events on the Web interface.

Procedure

To display information in the Web application that is not displayed in the SAP standard delivery, you have the following two options:

Use the parameter T_TOTALS for totals information and T_INIT_DATA for any customer data for event 1235, in which you can freely define customer values.

If you want to enhance totals structures such as C_CREDITS, or bill structures such as T_INVOICES, you can fill the structures you enhanced with customer values after determining the bill for event 1235. Note that such enhancements should only be undertaken by an experienced consultant.

To display additional data in the Web application, proceed as follows:

1. Enhance the interface parameter of event 1235 by separate customer append structures. You can find out which parameter or related structures you are able to enhance from the parameter description custExtendedParameters. Enhance both the structure of the interface parameter for event 1235 and the similar structure of the interface parameter of module GEN_EBPP_GET_DATA.

2. Enter the name of the enhanced interface parameter of module GEN_EBPP_GET_DATA in parameter custExtendedParameters in XCM.

3. Fill your own customer fields in event 1235.

4. Output the data on the relevant Web page as described in the following. The technology for the data output is based on XML for parameters T_TOTALS and T_INIT_DATA, and is JavaBean based for additional attributes in other parameters.

To make the values of customer own fields visible on your Web page, proceed as follows for parameters T_TOTALS/T_INIT_DATA or for parameter T_INVOICES:

Example

1. Open the JS P file content_billListBalance_html.jsp in a suitable editor, such as a text editor or an HTML editor like Macromedia Dreamweaver or Microsoft FrontPage.

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

2. If you want to use the parameters T_TOTALS/T_INIT_DATA check whether the coding <%@ page import="com.sap.fin.webbase.DocumentBean" %> for using the Java class DocumentBean is contained in the page. If not, insert the coding in the page header with the other instructions (<%@ page import="com.sap.fin.webbase.DocumentBean" %>).

3. If you want to use parameters T_TOTALS/T_INIT_DATA, enhance the following entries directly after the tag <body> in the page header in addition:

° To enhance the parameter T_TOTALS:

<% DocumentBean totals = custData.getTotals(); pageContext.setAttribute("totals", totals); %>

° To enhance the parameter T_INIT_DATA:

<% DocumentBean addCustData = custData.getAdditionalCustomerData(); pageContext.setAttribute("addCustData", addCustData); %>

You can output the data which is to be displayed through this page coding for parameters T_TOTALS/T_INIT_DATA as follows:

1. To output the total amount (field AMOUNT) and related text (TEXT) as a table, add the following coding:

<webbase: xmlData beanId="totals" table="T_TOTALS">

<td><webbase:xmlField name="AMOUNT"/></td>

<td><webbase:xmlField name="TEXT"/></td>

</tr>

</webbase:xmlData>

2. To output separate customer fields in other parameters, for example in parameter T_INVOICE use Methode getExtendedParameter (String parameterName) on the

For example, if you have added field TAXAMOUNT to the

related object (here bill).

parameter T_INVOICE, then you can access this within the loop using all bills with <%=bill.getExtendedParameter("TAXAMOUNT");=>.

Adapting Interface Texts

Use

You can adapt all texts on the Web interface of SAP Biller Direct to meet your requirements and to comply with your company-specific terminology. How you change, delete and re-create texts is set out in the following sections.

Changing Texts

Procedure

The Web application downloads texts from various language-dependent properties files and displays these on the interface dynamically using a variable. For each subject you deal with (such as bills, complaints) there is a separate resource bundle. This means in turn that for each subject area there is a properties file for each language. When the texts are output by a "

special tag (for example, <webbase:message key="

resource="

"/>)

the Web

application determines both the related resource bundle and properties file from the logical

name in the attribute resource=“

.

You can find out which resource bundle has been

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

assigned to which logical name from the section <message-resources></message- resources> in file WEB-INF/webbase-config.xml.

Section <message-resources></message-resources>in file webbase-config.xml

<message-resources> <resource name="addressdata" path="com.sap.fin.fscmbase.resources.addressdata"/> <resource name="advicenote" path="com.sap.fin.fscmbase.resources.advicenote"/> <resource name="agency" path="com.sap.fin.fscmbase.resources.agency"/> <resource name="bankdata" path="com.sap.fin.fscmbase.resources.bankdata"/> <resource name="bills" path="com.sap.fin.fscmbase.resources.bills"/> <resource name="dispute" path="com.sap.fin.fscmbase.resources.dispute"/> <resource name="fscmdata" path="com.sap.fin.fscmbase.resources.fscmdata"/> <resource name="logon" path="com.sap.fin.fscmbase.resources.logon"/> <resource name="r3Messages"

path="com.sap.fin.fscmbase.resources.R3Messages"/>

<resource name="system" path="com.sap.fin.fscmbase.resources.system"/> <resource name="releaseDependentBills" path=" com.sap.fin.fscmbase.resources.releaseDepBillsCA464 "/> </message-resources>

To adapt a text, proceed as described in the table: You have to make the changes described there before you deploy the Web application. To do this, first unpack the file delivered and then make the changes required to the corresponding unpacked properties files. In the following example, you want to replace the text Open Bills with the text My Open Bills.

Step

Action

Example

1.

Open the corresponding JSP file in a suitable editor, for example, Macromedia Dreamweaver or Microsoft FrontPage.

JSP file:

navigation_html.jsp

2.

Using the structure of the layout, find the message tag that describes the interface text. Make a note of the name of the variable and the logical name of the resource bundle from file webbase- config.xml.

Message tag:

<webbase:message key="tab.myBills" resource="system"/>

Logical name of the resource bundle: system

3.

Determine the name of the resource bundle for the logical name from the file webbase-config.xml

<resource name="system" path="com.sap.fin.fscmbase.resources.system"/>

This results in resource bundle com.sap.fin.fscmbase.resources.system

4.

Open the language- dependent properties file and find the entry for the appropriate variable.

Files with English texts: system_en.properties

Variable: tab.myBills

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

5.

Change the text to the right of the equals sign as required, but without changing the variable itself.

Before tab.myBills=Open Bills

After tab.myBills=My Open Bills

6.

Save the file.

 

7.

Create a deploy file from the unpacked files, and deploy the application.

 

8.

Check that your changes appear on the Web interface.

 

9.

If you want to make the change for an additional language, you have to repeat the procedure in the language-dependent file for this language.

Files with German texts: system_de.properties

language. Files with German texts: system_de.properties There are texts that are used by the system several

There are texts that are used by the system several times, so your change may affect several different places. If you lengthen the text, this may lead to unwanted changes in the layout. Changes in terminology on the interface can lead to inconsistencies with terminology in the Web user documentation. For detailed information on changing the Web user documentation, see Adapting Web User Documentation [Seite 19].

Deleting Texts

Procedure

To delete a text, proceed as described in the table. The same procedure applies to the deployment as is described in the section Changing Texts [Seite 11]. In the following example you want to delete the text History to display your inquiries:

Step

Action

Example

1.

Open the corresponding JSP file in a suitable editor, for example Macromedia Dreamweaver or Microsoft FrontPage.

JSP file:

content_billList_html.jsp

2.

Using the structure of the layout, find the message tag that describes the interface text.

Message tag:

<webbase:message

key="action.getDisputesBill"

 

resource="bills"/>

3.

Remove the corresponding message tag.

Message tag:

<webbase:message

key="action.getDisputesBill"

resource="bills"/>

4.

Create a deploy file from the unpacked files, and deploy the application.

 

5.

Check that your changes appear on the Web interface.

 

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

Creating Texts

Procedure

To include a new text in the interface proceed as described in table. The same procedure applies to the deployment as is described in the section Changing Texts [Seite 11]. In the example that follows, you want to insert the text Visit our homepage.

Step

Action

Example

1.

Open the language-dependent properties file

File with English texts:

bills_en.properties

2.

Insert a new text variable that has not yet been used and assign the desired text to it.

Variable name:myHomepageText Text: Visit our homepage Complete entry: myHomepageText= Visit our Homepage

3.

Save your entries.

 

4.

Open the corresponding JSP file in a suitable editor, for example Macromedia Dreamweaver or Microsoft FrontPage.

JSP file:

content_billList_html.jsp

5.

Using the structure of the layout, find the place where the new text is to appear.

 

6.

Insert the new message tag there.

Message tag: <webbase:message key=“ myHomepageText“ resource="bills „/>

7.

Create a deploy file from the unpacked files, and deploy the application.

 

8.

Check that your changes appear on the Web interface.

 

9.

If you want to make this entry for another language, you have to repeat the procedure in the language-dependent file for this language.

File with German texts:

bills_de.properties

language. File with German texts: bills_de.properties If you are using an industry-specific component or FI-CA

If you are using an industry-specific component or FI-CA Release 4.71 you have to display other texts than those contained in the delivery at certain places in the Web application where the customer has chosen to make payment by check or bank transfer. To convert the Web application to the new texts, you have to change the assignment of the logical name releaseDepBillsCA464 for the resource bundle in the file WEB-INF/webbase-config.xml. To do this, assign the resource bundle com.sap.fin.fscmbase.resources.bills to the logical name releaseDependentBills instead of resource bundle com.sap.fin.fscmbase.resources.releaseDepBillsCA464. Before you make your change the relevant line in file WEB-INF/webbase- config.xml should have the following form:

<resource name="releaseDependentBills"

path="com.sap.fin.fscmbase.resources.releaseDepBillsCA464"/

>

Following the change the line should read as follows:

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

<resource name="releaseDependentBills"

path="com.sap.fin.fscmbase.resources.releaseDepBillsCA464"/

>

Adapting the Interface Design

Use

You can adapt the interface design of FSCM Biller Direct to meet your requirements, for example to use the logo, colors, fonts, and graphics that are characteristic of your homepage.

Procedure

The entries for the interface design are contained in the following Cascading Style Sheet files:

File

Browser Type

winie.css

Microsoft Internet Explorer

winns.css

Netscape Navigator

winno.css

Other browser types

To adapt the design, proceed as described in the table: In the example you change the background color of the application menu from blue to pink:

Step

Action

Example

1.

Open the corresponding JSP file in a suitable editor, for example Macromedia Dreamweaver or Microsoft FrontPage.

JSP file: navigation_html.jsp

2.

Find the tag containing the attribute class, which is to be changed. Note the name of the attribute.

Message tag: <td

id=“NaviTab_1“class=

“TabstripEmph“>

 

Name of the attribute class:

TabstripEmph

3.

Open the browser-dependent file. Find the entry for the corresponding name.

File: winie.css

Name of the attribute: TabstripEmph

4.

Change the corresponding style.

Before

BACKGROUND-COLOR:#b1c9e2;

After

BACKGROUND-COLOR:#FFCCCC;

5.

Save your entries.

 

6.

Check that your changes appear on the Web interface.

 
that your changes appear on the Web interface.   You can find the graphic files in

You can find the graphic files in folder img (for example, the file bg_navigation_top.jpg). There you can change the company logo or icons.

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

Changing the User Interface at Runtime

Use

With SAP Biller Direct you can change not just the appearance of each interface design, but also switch between individual Cascading Style Sheets (CSS) with the related graphics at runtime.

Procedure

All CSS and graphics are delivered in the standard system under the theme Default. If you are using your own CSS, proceed as follows:

1. Copy directory Default under directory Themes.

2. Give the copied directory another name (such as Portal).

3. Change the relevant CSS and graphics in the new directory.

4. Activate your changes as follows:

° With XCM

Under Start Æ General Settings Æ Customer Æ Technical Settings Æ default enter a value for the login-screen-theme parameter (such as Portal). In this example, Portal stands for the copied default directory where the CSS and graphics you have altered are located. If you do not specify a directory here then the entries for the Style Sheets and graphics in the standard delivery in directory Default are used.

° via call up parameters in the URL address

You can change the theme at runtime for every HTTP request. To do this add the parameter theme to the URL address. If you enter http://localhost:8080/ebpp?theme=Portal for example, then SAP Biller Direct is called up with the theme Portal .

Integrating Separate Customer Functions

Use

You would like to enhance SAP Biller Direct with your own functions.

Prerequisites

Such enhancements presuppose considerable experience in the area of Java programming.

To include your own Java code in the application, you need a Java development environment, meaning an editor, compiler and if necessary a debugger. To be able to compile your own or the example source code, you have to make all of the SAP J2EE Engine libraries accessible from directory additional-lib in addition to the libraries that belong directly to Biller Direct that are contained in directories WEB_INF/lib: ebpp.jar and webbase.jar when you set up the development environment.

Activities

The following shows you how to implement your own functions using the framework, and how you can access data from the core application.

The SAP Biller Direct delivery contains example code for customer-defined enhancements in the .ear file that you can use as template for implementing your own functions. After you have unpacked the application as set out in the implementation guide, you can find

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

folder \docs\customerExtensions Beispielsourcecode. Based on this example that you can use to display a list of all of the company codes with their relationships taken from the SAP R/3 system, the following sections demonstrate step by step how to integrate an enhancement in your installation.

Creating the Event Handler and Java Beans

Procedure

Creating the Event Handler and Java Beans Procedure You are recommended to create all customer Java

You are recommended to create all customer Java classes in a separate package. Before this is completed you should create a .jar file from the separate customer classes and add WEB_INF/lib to the application. The example classes have been implemented in example package com.company.ebpp.

To enable you to deal with a customer-defined event (such as clicking on a customer menu option), you need a customer event handler. This is done by class CustomerExtendAction.java in the example. You can find explanations on setting this up in the comments with the code for this class. This kind of event handler class checks which event is involved, and executes the requested changes to the data bean objects. In the current example, the data bean with the list of company codes is constructed on the incoming event. As several data beans are usually implemented when the actual implementation takes place, it is good practice to define a root data bean that all subordinate data beans reference. By doing this you can create data within JavaServer Pages (JSPs) with only one object reference. This is done by class CustomerExtendRootBean.java in the example. In this class the corresponding SAP R/3 Add-Ins are called up for creating the list of company codes. From the result of the call up an appropriate data bean of class CustomerExtendDataBean.java is constructed. For information on how you use the services of the framework, such as Connection Manager or Action Messages, see the comments for the source code.

For the internationalization of your developments you need one or more property files with text keys (resource bundle). Only the default property file is contained in the example (CustomerExtensions.properties). If you want to support several languages, you have to create the property files in the required languages under the corresponding file names. When you do this note the Java resource bundle specification.

Inserting New Menu Options

Use

You would like to display separate customer-defined functions in the menu of SAP Biller Direct.

Procedure

To insert your own functions in the navigation bar, you do not need to modify the corresponding JavaServer Pages but simply fill the corresponding Include files in the folder \jsp\customerExtensions. There use the IDs NaviTab_21 to NaviTab_29. The file \docs\customerExtensions contains the example code for the standard example included in the delivery.

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

Creating Your Own JavaServer Pages

Procedure

Folder \docs\customerExtensions contains the JSP content_custExtension_html.jsp. in addition to the example code. This JSP takes over the display of the data for the company codes. This means that this JSP generates the HTML page for the display. You should create your own JSPs in folder \jsp\customerExtensions so as to clearly differentiate between your own developments and the SAP standard delivery.

Registering New Components

Procedure

Once you have created the code, you have to register the new elements in the Web application. To do this, proceed as follows:

1. Call up the configuration file webbase-config.xml in directory \WEB-INF. In example folder \docs\customerExtensions you will find a file under the same name containing all of the additional code required for the example.

2. To implement the example, insert the code included between the comment tags <!-- >>>BEGIN OF INSERT --> and <!-- >>>END OF INSERT --> in the original file.

Registering New JavaServer Pages

Procedure

Insert your new JavaServer Pages between the tags <screens> and </screens>. For this enter a name for each screen and the path of the JSP relating to the root directory in the Web application.

Registering the New Event Handler

Procedure

Insert your new event handler between the tags <webactions> and </webactions>. An event handler (Web action) is made up of the following:

Specification of the event (request without extension .sap)

Class that deals with the event

Comprehensive mapping of the results on the follow-on screens or follow-on events

Registering New Resource Bundles

Procedure

You can address texts in various languages in the JSPs in tag <webbase:message "

key="

resource="

"/>.

The key contains in each case the text key from the

corresponding property file. The resource bundle itself is addressed under the name you have

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

entered in the attribute resource. To register the resource bundle in the application under the appropriate name, insert a new resource between the tags <message-resources> and </message-resources>. In addition enter the name addressed and the source path of the resource bundle.

Executing Customer Enhancements

When you are ready to execute your modifications, make sure you bear the following in mind:

modifications, make sure you bear the following in mind: So that your changes are made visible,

So that your changes are made visible, you must if necessary delete the work directory of the JavaServer Pages already compiled once you have inserted the code and JSPs. This applies particularly if you have changed includes in order to enhance customer-defined menu options.

You have to start the J2EE Engine again following changes to the code. Only by doing so do your changes become visible.

Adapting Web User Documentation

Use

You can adapt all of the texts in the Web user documentation of SAP Biller Direct in accordance with the requirements of your company.

Procedure

The Web application documentation texts that you have received together with the Web application are stored in HTML files. Each language version comprises several HTML and graphic files. If you want to make purely text changes, select one of the following files:

File

Documentation Type

Help_FAQ.htm

FAQ

Help_Function.htm

Are you a new user?

Help_Glossary.htm

Glossary

navigation_help.htm

Menu

To adapt a text, proceed as described in the table: In the example, you change a text in the FAQs:

Step

Action

Example

1.

Open the corresponding JSP file in a suitable editor, for example Macromedia

HTML file with English texts in the folder en: Help_FAQ.html

Dreamweaver or

Microsoft FrontPage.

2.

Find the text and change it without changing the HTML elements and their attributes.

See example

3.

Save the file.

 

4.

Check whether your changes appear in the documentation as desired.

 

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

5.

If you want to make the change for an additional language, you have to repeat the procedure in the HTML file for this language.

HTML file with German texts in the folder de: Help_FAQ.html

The procedure described for text changes also applies to deleting and inserting texts.

text changes also applies to deleting and inserting texts. For more information on how you can

For more information on how you can deactivate a documentation type completely, see Deactivating Documentation Type [Seite 21]. For more information on how you can deactivate the entire Web application documentation, see Deactivating the Entire Web User Documentation [Seite 22].

Example

You have replaced the text Open Bills in the menu bar of the Web interface with the text My Open Bills. You would like to reflect this change in the text of the FAQ:

Before

Can I deduct credits from the payment amount? Yes. On the screen Open Bills you can see the total of all the credits that you can deduct from the payment amount for the bills selected in the Credits field. An overview of your credits appears on the screen Credits.

After

Can I deduct credits from the payment amount? Yes. On the screen My Open Bills you can see the total of all the credits that you can deduct from the payment amount for the bills selected in the Credits field. An overview of your credits appears on the screen Credits.

Adapting the Design of the Web User Documentation

Use

You can adapt the design of the FSCM Biller Direct Web user documentation to meet your requirements, for example to use the logo, colors, fonts, and graphics that are characteristic of your homepage.

Procedure

The entries for the Web user documentation design can be found in the following Cascading Style Sheet files:

File

Browser Type

winie.css

Microsoft Internet Explorer

winns.css

Netscape Navigator

winno.css

Other browser types

To adapt the design, proceed as described in the table: In the example you change the background color of the documentation menu from blue to pink:

Step

Action

Example

1.

Open the corresponding JSP file in a suitable editor, for example Macromedia Dreamweaver or Microsoft FrontPage.

JSP file: navigation_HELP.htm

2.

Find the tag containing the attribute class, which is to be changed.

Tag:

<td id=“NaviTab_1“class=

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

 

Note the name of the attribute.

“TabstripEmph“>

Name of the attribute: TabstripEmph

3.

Open the browser-dependent file. Find the entry for the corresponding name.

File: winie.css

Name of the attribute: TabstripEmph

4.

Change the corresponding style.

Before

BACKGROUND-COLOR:#b1c9e2;

After

BACKGROUND-COLOR:#FFCCCC;

5.

Save your entries.

 

6.

Check whether your changes appear in the documentation as desired.

 
changes appear in the documentation as desired.   You can find the graphic files in same

You can find the graphic files in same folder as the HTML files (for example, the printer printer.gif). You can change the graphics there.

Deactivating the Documentation Type

Use

If you do not need a particular documentation type, you can suppress the display of this from the FSCM Biller Direct Web user documentation.

Procedure

To deactivate a documentation type, proceed as described in the documentation: In the example you suppress the display of the glossary:

Step

Action

Example

1.

Open the corresponding JSP file in a suitable editor, for example Macromedia Dreamweaver or Microsoft FrontPage.

HTML file with English texts in the folder en: navigation_help.htm

2.

 

<td> tag with entry Mini-glossary:

Find the <td> tag containing the desired navigation entry.

<td id="NaviTab_3"class= "TabstripStd"><a href= "Help_Glossary.htm" class="prtlTopNavLnk" onClick="changeStyle('3'); "

target="content">Mini-

glossary

</a></td>

3.

Remove this tag completely.

 

4.

Save your entries.

 

5.

Check that the entry for the documentation type is no longer displayed in the documentation menu.

 

6.

If you want to make the change for an additional language, you have to repeat the procedure in the HTML file for this language.

HTML file with German texts in the folder de: navigation_help.htm.

SAP Biller Direct 3.0 Modification Guide (FI-CA)

May 2004

Deactivating Entire Web User Documentation

Use

If you do not need the FSCM Biller Direct Web user documentation, you can suppress the display of it completely.

Procedure

To deactivate the Web user documentation completely, you need to remove the HTML link FAQ that the user uses to access the documentation from the interface. To do this, proceed as follows:

Step

Action

Example

1.

Open the corresponding JSP file in a suitable editor, for example Macromedia Dreamweaver or Microsoft FrontPage.

JSP file: navigation_html.jsp

2.

Find the corresponding message tag.

Message tag: <webbase:message key=‘navi.faq‘ resource=‘system‘/>

3.

Remove this tag completely.

 

4.

Save your entries.

 

5.

Check that the HTML link FAQ is no longer displayed on the Web application interface.

 

Result

The HTML link FAQ is no longer displayed on the FSCM Biller Direct Web interface. Consequently the Web user can no longer access the different documentation types.