Reading Sample Sap Press Sap Interactive Forms by Adobe
Reading Sample Sap Press Sap Interactive Forms by Adobe
Index
The Author
Timo Ortiz
www.sap-press.com/5494
Chapter 3
Installing and Configuring Adobe 3
Document Services
In this chapter, we show you how to set up Adobe Document Services
and prepare it for forms output. Furthermore, you’ll get an overview of
the scenario-dependent configuration of the runtime components as
well as optional setting options.
To work with SAP Interactive Forms by Adobe, you need Adobe Document Services
(ADS) in addition to Adobe LiveCycle Designer. These are integrated into SAP Net-
Weaver Application Server Java (SAP NetWeaver AS Java). You also need SAP NetWeaver
Application Server ABAP (SAP NetWeaver AS ABAP) to run other scenarios described in
this book. It’s assumed in the following that the ABAP and Java application servers are
already installed, namely in the versions SAP NetWeaver AS ABAP 7.54 (SAP_BASIS 754)
or higher and SAP NetWeaver AS Java 7.54 or higher.
The installation and configuration of ADS usually isn’t performed by form developers,
but by the Basis team. This chapter shows the special features to be considered for the
installation and operation of ADS as well as the necessary configuration.
67
3 Installing and Configuring Adobe Document Services 3.2 Basic Configuration
You start the automatic configuration in SAP NetWeaver Administrator using the fol-
lowing steps:
1. Select the Configuration tab and then the Scenarios tab below it (see Figure 3.1).
3
Figure 3.2 Configuring Adobe Document Services with the Configuration Wizard
68 69
3 Installing and Configuring Adobe Document Services 3.2 Basic Configuration
4. You’re now in the user administration of the Java system (see Figure 3.3). First check 8. Switch to the Assigned Roles tab (see Figure 3.5). Enter “SAP_ADSCALLER” as the role
whether the user ADSUser already exists by entering “ADSUser” in the input field in on the left of the screen, and click the Go button.
Figure 3.3 and clicking the Go button. If the user doesn’t exist, create it using the fol-
lowing steps. If the user already exists, you can check the settings analogously.
3
9. Highlight this role in the table, and click Add to assign it to the ADSUser user. Save the
user settings.
Figure 3.3 Identity Management (User Administration)
To access ADS, the role SAP_ADSCALLER is linked to various applications. You can check
these links in SAP NetWeaver Administrator in Identity Management with these steps:
5. Click the Create User button.
1. Select Role in the Search Criteria field, and enter “SAP_ADSCALLER” in the input field
6. In the next screen, set the password and other technical settings (see Figure 3.4). You
to the right. Click the Go button (see Figure 3.6).
must remember the password because you’ll need it later during the web service
configuration.
7. Enter any name in the Last Name field, as this is a mandatory field. In the Security-
Policy selection field, select the Technical User option. Figure 3.6 Linking the Role
70 71
3 Installing and Configuring Adobe Document Services 3.2 Basic Configuration
The first steps to configure ADS are now complete. You can close SAP NetWeaver Admi-
nistrator via the Logout button.
2. Next to Search Type, select the Provider System radio button, and click the Search
button.
3. From the displayed list of available web services (see Figure 3.8), select AdobeDocu-
mentServicesVi, and confirm with Next.
Figure 3.9 Adobe Document Services Testing Method
4. Under Operation, you’ll see the rpData method for testing ADS. Select rpData, and
click Next (see Figure 3.9).
72 73
3 Installing and Configuring Adobe Document Services 3.3 Scenario-Dependent Configuration
5. In the following step, you can still set call parameters for the execution of the successfully. Without any data, you’ll see an error message (com.adobe.ProcessingEx-
method. However, this isn’t necessary for our test. Click on the Next button. ception: Required stream: “PDFDocument” not found in request OR its length is zero)
6. A window for entering the user parameters will appear (see Figure 3.10). Enter the in the Result area, as expected. However, this indicates that the web service call was suc-
cessful—after all, it came from ADS.
3
user “ADSUSER” and the password you chose in the previous section.
R
Print Program ISR Scenario Web Service ISR Scenario
Web Dynpro
(Chapter 6) ABAP Proxy Java
R
R R
R
Forms Runtime
ABAP PDF R R R
Form RFC
Object Web Service
Storage Destination
(Chapter 9)
Adobe
Document
Services
R Destination R
Spool ICF Scenario
Service
Both ABAP print programs and applications in Web Dynpro ABAP use the ABAP PDF
object at runtime, which requires a configured remote function call (RFC) connection
to communicate with ADS (the RFC destination). Form scenarios that run on the Java
application server, such as applications in Web Dynpro Java, access the ADS web service
through a proxy (the web service proxy).
There is an additional return channel for the ABAP form runtime: the Internet Commu-
Figure 3.11 Result of the Web Service Test
nication Framework (ICF) service. To access this interface, a destination must be config-
ured for ADS. This return channel is used for reloading form templates because these
You don’t specify any further data in this test and thus can’t simulate correct process-
ing by ADS. You only want to check whether the communication could be established
74 75
3 Installing and Configuring Adobe Document Services 3.3 Scenario-Dependent Configuration
are cached by ADS and read only when needed. In addition, application data and docu- 3. Switch to the Logon & Security tab, and activate the Basic Authentication radio but-
ments generated by ADS are transferred via this communication path during mass ton. In the User field, enter “ADSUser” and the password you’ve chosen (see Figure
printing; that is, the web service call itself only contains the control data in these sce- 3.14). To finish the configuration, click the Save button.
narios.
3
You can then check the RFC connection using program FP_PDF_TEST_00. The connec-
tion test offered in Transaction SM59 doesn’t work because it doesn’t support SOAP.
Therefore, call Transaction SE38. If you don’t have authorization to do this, you can use
Transaction SA38 to execute it if necessary. Execute program FP_PDF_TEST_00 there,
specifying the RFC connection you’ve configured (ADS in our example). If successful, the
internal version number of ADS is returned.
76 77
3 Installing and Configuring Adobe Document Services 3.3 Scenario-Dependent Configuration
form template caching by ADS because the call contains only a reference to the tem- After the profile has been regenerated, you can create the service user:
plate used. In addition, a time stamp is used to decide whether an update of the local 1. Call Transaction SU01 (User Maintenance). Enter the name “ADS_AGENT”, and click
cache is necessary or whether the already-cached template can be used. Furthermore, the Create button.
the separate connection circumvents limitations of SOAP because this protocol wasn’t
3
2. On the Address tab, fill in the Last Name field; it’s recommended to repeat the user
designed for the exchange of very large amounts of data. In this section, we’ll discuss
name here.
how to set up the HTTP connection, including creating a service user, activating and
testing the relevant ICF services, and creating and testing the destination on the Java 3. Switch to the Logon Data tab, and select Service as the user type there. In addition,
application server. set a password.
4. Switch to the Roles tab, and assign the SAP_BC_FPADS_ICF role to the user. Finally, click
Create Service User for HTTP Communication the Save button (see Figure 3.16).
You must create a service user through which the communication between ADS and
the ABAP application server takes place. This user is assigned the role SAP_BC_FPADS_ICF.
First, you need to generate the profile associated with this role, if this hasn’t already
been done in your system, with the following steps:
1. Call Transaction PFCG (Role Maintenance) to display the role.
2. Switch to the Authorizations tab, and click the Display Authorization Data button
in the Edit Authorization Data and Generate Profiles area (see Figure 3.15).
3. You’ll now see all the permissions assigned to this role and can generate a current
profile using the Generate button.
Figure 3.16 Maintain User
Test the Service User and the Internet Communication Framework Services
You can test the ICF services that are used to access the ABAP form store, among other
things, using a web browser. You must first determine the PC name and the HTTP port
of the ABAP application server. To do this, call Transaction SICF, click the Run button,
and then select Port Information from the Goto menu. A table is displayed in a dialog
Figure 3.15 Display Authorization Data in Role Maintenance
box. In the Protocol column, find the HTTP entry, and note or copy the corresponding
entries in the Hostname and Service columns.
78 79
3 Installing and Configuring Adobe Document Services 3.3 Scenario-Dependent Configuration
80 81
3 Installing and Configuring Adobe Document Services 3.3 Scenario-Dependent Configuration
6. Make another entry in the System ID field, and specify the client in which you’ve
configured the ADS_AGENT user in the Client field. Click on the Previous button.
7. In the Authentication field, select Basic (User ID and Password), as shown in Figure
3
3.21.
8. In the User Name field, enter “ADS_AGENT” and the corresponding password, and
click the Finish button.
Destination Test
The connection test from SAP NetWeaver Administrator generally generates an error
message for this connection because only the PC name and HTTP port are stored in the
URL. The path information to the respective service is only appended at runtime. To be
able to carry out a test nevertheless, it’s advisable to temporarily extend the stored
URL. To do this, append the path /sap/bc/fp/form/layout/FP_TEST_03_TABLE.XDP to
the URL, and click Ping Destination without saving the changes first. If this test could be
executed successfully, the message appears: Successfully connected to HTTP destina-
tion FP_ICF_DATA_<SID> with response code 200. Content type text/html. . . . Then,
click the Cancel button because you’ve attached the path only for a test. This test simu-
lated reading the FP_TEST_03_TABLE form from the ABAP form store.
In addition, you can test this configuration from the ABAP application server as fol-
Figure 3.20 Connection Settings
lows:
1. Call test program FP_CHECK_DESTINATION_SERVICE in Transaction SE38 or Trans-
action SA38.
82 83
3 Installing and Configuring Adobe Document Services 3.3 Scenario-Dependent Configuration
2. There, enter the name of the configured RFC connection (“ADS”), and select the With
Destination Service checkbox.
3. Click Run, and ADS will be called and generate a PDF form. Here the return channel
3
you configured before will be used. If successful, you’ll get a short informational
message (i.e., . . . bytes transferred).
Figure 3.22 SOA Tab Figure 3.24 Entering Credentials for the Web Service Proxy
84 85
3 Installing and Configuring Adobe Document Services 3.3 Scenario-Dependent Configuration
8. Click the Finish button to complete the configuration and save the changes. Then To create interactive forms with usage rights, you must configure the ReaderRights cre-
click the Back button to return to the SAP NetWeaver Administrator initial screen. dential. Usage rights are used to enable advanced functionality in Adobe Acrobat
Reader. You configure the key within SAP NetWeaver Administrator. In addition to the
To test the web service proxy, select Operations • Systems • Start & Stop • Java Applica- 3
private keys (credentials) for ADS, you can also manage certificates and certificate revo-
tions, and start the tc~wd~pdfobject application. This configuration also allows the Web
cation lists (CRLs) there.
Dynpro Java runtime to access ADS.
First, open SAP NetWeaver Administrator to configure the ReaderRights credential as
follows:
3.3.4 Configuring the ReaderRights Credential
1. Select the Configuration tab, and then click Infrastructure (see Figure 3.26). There,
To create interactive forms, you need a ReaderRights credential, which is a right to use click the Adobe Document Services link.
SAP Interactive Forms by Adobe. To obtain a ReaderRights credential for production
use, see SAP Note 736902. You can also download a ReaderRights credential valid for a
limited time from the SAP download page for developer and trial versions of the SAP
software at http://s-prs.co/v224207. To configure the credential, follow these steps:
1. Go to the website just mentioned, and then search for the keyword “credentials”.
You may need to log in to this page with your S-User. A list of available credentials
for SAP Interactive Forms by Adobe is displayed (see Figure 3.25).
2. Click the link in the Name column for the credential that is relevant to you.
3. Confirm the license agreements, and start the download via the Submit button.
4. In the following step, you can check again if the correct S-User is specified. Then click
on Click here to start your trial!
The download consists of a ZIP archive file (.zip) that contains a password-protected pri-
vate key (credential). The format of the credential file conforms to the Public Key Cryp- Figure 3.26 Configuration Tab
tography Standards (PKCS#12) specification. The file ends in .p12 or .pfx. In addition to
the key, there is a text file (.txt) in the ZIP archive that stores the associated password.
86 87
3 Installing and Configuring Adobe Document Services 3.3 Scenario-Dependent Configuration
2. Next, you’ll see the Document Security tab. Here you manage credentials, certifi-
cates, and revoked certificates, or you can monitor the license status. The applica-
tion also allows you to get started managing job profiles (see Figure 3.27). Select
Credentials in the Show field, and click the Manage P12 Files button.
3
3. Use the following popup window to load the credential into your system by clicking
the Add New File button (see Figure 3.28).
4. In the dialog that opens, use the Browse button to select the PFX file, and then click
Upload. Close the dialog from Figure 3.28 via the Close button. Figure 3.29 Selecting the ReaderRights Credential
8. Under Password and Confirm Password, enter the password you received as part of
the credential (text file in the ZIP file).
9. Close the dialog via the Save button.
Your ADS web services are now configured, and you can use the ReaderRights creden-
tial. Note the validity expiration (Expiry) if this is a test credential (see Figure 3.30).
5. Now you can configure the credential by clicking the Add New Object button from
Figure 3.27.
6. The dialog shown in Figure 3.29 opens. Select the ReaderRights option, and set the
type in the Type field to P12.
7. In the P12 File dropdown, select your credential.
88 89
3 Installing and Configuring Adobe Document Services 3.4 Parallelization Configuration
To complete the configuration, you must restart the Document Service Trust Manager small- or medium-sized forms, provided the print program outputs these forms in one
service on the Java application server; otherwise, the changes won’t take effect. To do print job (see Chapter 6, Section 6.7.1). This is a system-wide setting. Alternatively, ABAP
this, select the Operations tab in SAP NetWeaver Administrator. Under it, select the Sys- print programs can control form bundling via a parameter.
tems area and then the Start & Stop link. Then select Java Services, enter “adobe” under
3
You can use the Caching column to specify whether the ADS form template should be
Service Component Name, and press (Enter). In the list that appears, you can now cached in the destination cache. This improves performance because the ADS web ser-
select the service and restart it. vices don’t have to request the template from the ABAP server each time a form is gen-
You can check the correct installation of the ReaderRights credential using program erated. The system automatically recognizes changes to the form template. In this case,
FP_TEST_03. Call this test program in Transaction SE38, and select the option X (Inter- the updated template is requested and then stored in the destination cache. Note that
active Form with Additional Usage Rights) for the parameter Form - Interactive. If you caching is turned on by default, so you must set it to false if you want to turn it off.
then display the print preview of the form, Adobe Acrobat Reader DC reports that it’s a To save your changes, click the Save button. For the other columns in table FPCONNECT,
fillable form. it’s recommended to use default values.
The Compl.Bund column enables system-wide control of form bundling. To switch this
on, select the value true. This significantly reduces the runtime of print jobs with many
Figure 3.32 Transaction SOAMANAGER: Service Administration Tab
90 91
3 Installing and Configuring Adobe Document Services 3.4 Parallelization Configuration
In the following dialog, set Consumer Proxy in the Search criteria area, and enter “FP*”
as the search expression. Click the Search button to display the search results at the
bottom of the screen (see Figure 3.33).
3
2. In step 1, you can freely assign a name in the Logical Port Name field, for example,
“ADS”. Also enter a Description, and check the Logical Port is Default checkbox (see
Figure 3.35). Then click the Next button.
This section will dive further into configuring web services, including testing the con-
nection between web services and using RFCs to connect to ADS.
3. In step 2, leave the WSDL Access Settings at Via HTTP Access (see Figure 3.36). In the
3.4.1 Configure Web Services
WSDL Location section, specify “http://<server>:<port>/FpPrintRequestService/
We’ll first configure the CO_FP_PRINT_REQUEST web service, which is responsible for the FpPrintRequest?wsdl&mode=ws_policy” in the URL for WSDL access field. Here, you
actual parallelization, with the following steps: must replace <server> and <port> with the parameters of your Java stack. You can
1. Select the CO_FP_PRINT_REQUEST entry from Figure 3.33, shown earlier. The logical also find these parameters in the RFC destination to ADS (Section 3.3.1). Continue
ports configuration appears (see Figure 3.34). Click the Create button, and select with Next.
WSDL-Based Configuration from the drop-down list. 4. This takes you to step 3, Binding Selection (see Figure 3.37). Click the Next button
again here.
92 93
3 Installing and Configuring Adobe Document Services 3.4 Parallelization Configuration
6. In step 5, HTTPSettings, finish the configuration using the Done button (see Figure
3.39).
You’re returned to the logical port Configurations view, where you can see the ADS log-
ical port you just created (see Figure 3.40).
Now that you’ve configured the web service for parallelization, let’s turn to the second
web service from Figure 3.33, shown earlier. The FpQueueAdminService service is needed
to monitor and manage the jobs. Select the CO_FP_QUEUE_ADMIN entry in the SOA
Manager and perform the same steps for this web service as described in the previous
section. It’s important that you give the logical port the same name, in our case, “ADS”
Figure 3.37 Binding Selection for the WSDL Document
again.
5. In step 4, you make the security settings (see Figure 3.38). In our case, the sapsp:HTTP- The crucial difference is in the URL for WSDL Access input field in the WSDL Location
Basic authentication method is used by default, where securing via user and pass- section. The URL for access is for the monitoring service http://<server>:<port>/
word is sufficient. Enter the User Name for ADS (“ADSUser”) and the set password, FpQueueAdminService/FpQueueAdmin?wsdl&mode=ws_policy. Maintain the security
and click the Next button. settings as shown earlier in Figure 3.38, and save your entries. You’ll return to the Web
Service Configuration dialog. There you can now see the two logical ports for paral-
lelization and monitoring.
94 95
3 Installing and Configuring Adobe Document Services 3.4 Parallelization Configuration
3.4.3 Assigning the Logical Port to the Remote Function Call Connection ADS
The connection to ADS is made in the ABAP program via an RFC connection, which usu-
ally has the name ADS. If you choose a different name, you must specify it explicitly in
each application program. To use parallelization, you must define a mapping between
this RFC connection and the logical ports created. You define this mapping in table
FPCONNECT, via which you also make the settings for bundling (Section 3.3.5).
Figure 3.39 HTTP Logical Port Settings
Call this up via the table maintenance in Transaction SM30, click on Maintain, and con-
firm the information regarding client independence with (Enter). Select the connec-
tion entry ADS in the table, and scroll to the right until you see the Logical Port field.
Enter here the name of the logical port you selected in Section 3.4.1 (see Figure 3.42).
Parallelization is basically possible with and without bundling the forms. However, by
bundling, you also reduce the number of calls to ADS, as in the case of sequential pro-
cessing.
96 97
3 Installing and Configuring Adobe Document Services 3.5 Optional Configuration
3.5.1 Licensing
An additional license is required to create custom interactive forms (see SAP Note
750784). ADS has a component that monitors license-required usage and allows you to
change the license status. To view the corresponding usage data as well as make
changes to the status, start SAP NetWeaver Administrator and the Adobe Document
Services app, as described in the ReaderRights Credentials configuration (Section 3.3.4).
You’ll return to the screen shown earlier in Figure 3.27, and click on the Licensing tab
there.
Figure 3.43 Licensing Tab
In Figure 3.43 you can see the number of forms processed on this system, divided into
the following three categories:
3.5.2 Document Security: Credentials, Trusted Anchors, and
쐍 Number of SAP forms
Certificate Revocation Lists
This number indicates how many forms delivered by SAP (not modified or only min-
imally modified) have been processed. No additional license is required for these ADS can also be used to generate and verify digital signatures. Here, a distinction must
forms. first be made between certification and signature:
As soon as customer forms requiring a license have been processed, the status (License Private keys (credentials), trusted certificates (trusted anchors), and CRLs are required
Fulfillment) changes from green to red. If you’ve purchased a license, you can configure to use digital signatures, as discussed in the following sections.
this in the system by clicking the Set System Status button and checking the appropri-
ate box (This system is licensed to use SAP Interactive Forms by Adobe) in the dialog Credentials
that appears. This will change the status from red to green again. In addition to display- The PDF object (ABAP and Java) provides various methods both for certification and for
ing the license status in the administration interface, ADS writes a log entry if a license applying signatures. Among other things, these objects allow the key to be specified by
is required but the status hasn’t been configured. means of a configured alias. However, if these optional parameters aren’t supplied, ADS
The Customer Forms table at the bottom of the user interface (UI) displays all customer uses the following default values:
forms that require a license, as well as additional information such as the SAP system 쐍 DocumentCertification as alias for certification
ID and client from which ADS was called, and the name of the form and calling applica-
쐍 ServerSignature as alias for the digital signature
tion.
98 99
3 Installing and Configuring Adobe Document Services 3.5 Optional Configuration
The procedure for installing and configuring these and other keys is identical to that
for the ReaderRights credential (Section 3.3.4). Only the correct spelling of the alias and
the entry of a valid password must be observed. As already indicated in the description
of the ReaderRights credential, the Document Services Trust Manager service must also
3
be restarted for additional keys.
Under Credentials, all registered keys are displayed in a table. ADS checks their expira-
tion dates daily and writes log entries as soon as the current date approaches or
exceeds the expiration date. Consequently, there is no need for the system administra-
tor to regularly check the expiration dates of the keys via this UI; instead, monitoring
the logs is sufficient.
In the Configure Sequence Check area, settings can be made regarding the log entries.
For example, the time of the daily executed verification process can be adjusted. It’s
also possible to specify how many days before a key expires that warnings should be
written to the log file. Figure 3.44 Managing Trusted Anchors
4. By clicking the Save button you finish the registration of the public key. Afterwards,
Trusted Anchors
it will appear in the Trusted Anchors table.
ADS enables you to verify signatures in PDF forms. This requires the configuration of
5. Then restart the Document Services Trust Manager service. Proceed in the same way
trusted certificates, which are either the public key of a private key used for the signa-
as described for the ReaderRights credential (Section 3.3.4). After that, the list of
ture or the public key of the issuing authority—a root certificate. These public keys are
trusted certificates is active in your system.
managed via the Trusted Anchors field.
You define a list of trusted certificates in your system as follows:
List of Revoked Certificates (Certificate Revocation Lists)
1. In the Adobe Document Services screen, on the Document Security tab (refer to With the help of revoked certificate lists, keys that were originally classified as trusted
Figure 3.27), select Trusted Anchors instead of Credentials in the Show dropdown. can be subsequently marked as invalid. You also manage these lists on the Document
You can use the Manage CER Files button to load the .cer file for the trusted anchors Security tab, but select Revoked Certificate List to specify revoked certificates. Analo-
into the system in the same way as for the ReaderRights credential. gous to the ReaderRights credential and trusted anchors, you must load the CRL into
2. After that, you can select this file using the Add New Object button. the system via the Manage CRL Files button. Use the Add New Object button to access
3. Use the indicators next to Trusted For to determine what the certificate should be the selection of available CRLs (see Figure 3.45).
used for (see Figure 3.44):
– Signatures and as a Trusted Entry Point
Use this option to control whether the certificate should be used to validate signa-
tures.
– Certified Documents
If the public key is to be used to verify certified PDF forms, this flag must be
enabled.
– Embedded High Privilege JavaScript
Interactive forms may contain JavaScript instructions. Use this flag to specify
whether such PDF forms are also trusted if they are certified. You can select this
option only if you’ve also enabled the Certified Documents flag.
Figure 3.45 List of Revoked Certificates
100 101
3 Installing and Configuring Adobe Document Services 3.5 Optional Configuration
In addition, fill in the URL field. This is a unique identifier contained in keys (crldp field) generates PDF documents and print forms and has a default value of “4”. If you send
that can be retracted via this list. Typically, the list of revoked certificates can also be many parallel requests to ADS and have a PC with multiple processors, you can increase
retrieved via this URL. this value to achieve optimum utilization of resources.
3
To complete the registration, click the Save button. The list now appears in the List of You can’t make the setting via SAP NetWeaver Administrator. Instead, start the Config
Revoked Certificates table. After configuring revoked certificate lists, the Document Tool on the operating system level under the path /usr/sap/<SID>/J<instance>/j2ee/
Services Trust Manager service must be restarted. configtool/configtool.bat (or sh), and follow these steps:
1. Open the tree structure under services. You’ll find the com.adobe~XMLFormService
Secure Sockets Layer Connection Configuration service there (see Figure 3.46).
To work with certifications and signatures, the ADS web service must be accessed via a
Secure Sockets Layer (SSL) connection. Detailed instructions for performing the neces-
sary configuration steps can also be found in the SAP Help Portal. There, navigate to the
Adobe Document Services Configuration Guide (http://s-prs.co/v224282). Choose Con-
figuration of Communication Security • Configuration of the Web Service SSL Connec-
tion for a description of the SSL configuration.
Destination Cache
As mentioned in Section 3.3.2, the ADS web services have a local cache where, among
other things, form templates are stored. To modify the size of this cache, call up Adobe Figure 3.46 Config Tool: PoolMax Setting
Document Services again in SAP NetWeaver Administrator under Configuration • Infra-
structure. Select the Caches tab. The current size of the cache is displayed there in 2. In the PoolMax setting for this entry on the right, you can set the number of pro-
megabytes. The default value is 4 MB. cesses.
You can change the value via the Configure Destination Cache button. If you’re using 3. To change an entry, click New. Then specify the parameter name and the new value,
very large form templates or forms in many different languages, we recommend and confirm with OK.
increasing this value so that the cache can be used optimally. The other two buttons, 4. Select the menu path File • Apply Changes.
Reset Destination Cache and Reset PDF Cache, can be useful if you ever need to reset 5. Restart the cluster, for example, via SAP Management Console.
the cache. This should normally not be necessary. In the event of an error, for example,
if a form change doesn’t appear in the finished document, you can clear the buffer
manually here. 3.5.4 Number of Parallel Print Jobs
When parallelizing print jobs, the individual requests are distributed to parallel pro-
Adjust PoolMax Value for Parallel Processing cesses. You can configure the number of jobs to be started simultaneously in SAP Net-
There is a PoolMax property for each XML Form Module service. This property specifies Weaver Administrator under Configuration • Infrastructure. Then follow these steps:
how many documents can be processed in parallel. The XML Form Module service
102 103
3 Installing and Configuring Adobe Document Services 3.6 Operating Adobe Document Services
1. Select the Application Modules link. The following types are supported:
2. Select the sap.com~tc~fp~parallelization~ejb.jar module (see Figure 3.47). To find 쐍 OpenType (.otf)
the module faster, specify “*fp*” as the filter. 쐍 TrueType (.ttf) 3
3. In the Details EJB Module area, select the Enterprise JavaBean FpXfaRequestProces- 쐍 PostScript Type 1 (.pfb, .pfm)
sorBean, and click the Edit button.
Before the newly installed fonts can be used, two components of ADS must be
4. Select the Properties of the Resource Adapter tab at the bottom right. Change the
restarted. To do this, call up SAP NetWeaver Administrator, and select Operations • Sys-
maxPoolSize value to the number of jobs to be processed simultaneously by the par-
tems • Start & Stop • Java Services. Start the Document Services Font Manager service.
allelization framework.
Then select the Java Applications tab, and click on the Adobe Document Services appli-
5. Save the settings.
cation.
104 105
3 Installing and Configuring Adobe Document Services 3.6 Operating Adobe Document Services
3. In the Weight column, select the All value, and then click the Copy to Subtree and
Save Configuration buttons.
This results in all subcomponents of ADS writing the maximum number of traces. 3
Traces can be helpful in troubleshooting and are often required by support. To return
to the default setting, click the Default Configuration button.
You can view log and trace files using the Log Viewer in SAP NetWeaver Administrator:
1. Select the Error Analysis tab, and then select Logs and Traces. Click the Log Viewer
link.
2. Depending on the default settings in your system, the default trace is displayed
next. If this isn’t the case, select View • Open View • System Logs and Traces. Filter
the results by entering “com.adobe” in the Location column.
Figure 3.48 Performance Tracing Error When Calling ADS from the ABAP Possible Cause
Application Server
Using the Log Configurator available in SAP NetWeaver Administrator, you can config-
A dialog box specifying the login data ADSUser is either locked (refer to Section
ure which components should write how many logs or traces. To obtain precise pro-
appears. 3.2.1), or an incorrect password has been
cessing information from ADS, proceed as follows: entered in the RFC connection data (Section
1. Select the Error Analysis tab, and then Logs and Traces. Then click the Log Configura- 3.3.1).
tion link. The message HTTP receive failed with excep- An incorrect PC name or HTTP port was
2. In the Display field, select Trace Locations, and navigate to the ROOT LOCATION • com • tion communication_failure appears (possi- entered in the RFC connection data (refer to
adobe node (see Figure 3.49). bly as part of a longer error message). Section 3.3.1).
The message HTTP send returned with status An incorrect path was specified in the RFC
code is displayed (possibly as part of a longer connection data (refer to Section 3.3.1).
error message).
The error message contains com.adobe.Pro- The ADS_AGENT user is locked or doesn’t have
cessingException: Problem accessing data the required permissions. The ICF services
from Destination.... haven’t been activated. An incorrect PC name
or HTTP port has been entered in the destina-
tion, or the specified password is incorrect
(refer to Section 3.3.2).
Table 3.1 Typical Error Messages When Calling Adobe Document Services and Possible
Causes
106 107
3 Installing and Configuring Adobe Document Services 3.7 Hub Concept
ABAP or Java. Most applications (and indeed all those discussed in this book) are devel-
Error When Calling ADS from Java Possible Cause
Application Server oped in ABAP. Therefore, the installation of the Java stack is always an additional appli-
cation server. This additional effort makes it possible to connect several ABAP systems
The message com.sap.tc.webdynpro-pdf- ADSUser is locked (refer to Section 3.2.1), or
to ADS. In addition to the sizing, which must be considered separately, the question of
3
object.core.PDFObjectRuntime-Exception: incorrect information has been entered in
release dependency between the two stacks basically arises.
Service call exception is displayed (possibly the web service proxy (password, PC name,
as part of a longer error message). HTTP port, or path). The Java PDF object SAP positions ADS web services as a hub, which means that they are interoperable with
wasn’t restarted after configuration changes other systems as a standalone system (as part of SAP NetWeaver AS Java). They also
were made (refer to Section 3.3.3). have their own patch cycle, for example, compared to an ERP system that calls ADS.
Typically, the stack trace containing the Version reconciliation is performed via SAP Solution Manager to ensure that there are
aforementioned exception includes addi- no version problems. However, new functions of ADS that are only available in later
tional information from which you can
releases can’t be supported, of course. For all application programs, you must therefore
deduce the cause of the error.
bear in mind that you can’t automatically assume that all ADS functions exist. For this
General Errors When Calling ADS Possible Cause purpose, SAP provides an availability query every ABAP program should call before
The message User ADSUser doesn’t have The ADSUser isn’t linked to the ADSCaller using a new function via the form runtime environment (see Chapter 6) or the ABAP
access to method rpData is displayed (possi- role (refer to Figure 3.6). PDF object (see Chapter 9). Only if the availability query is successful may a function be
bly as part of a longer error message). used.
The message com.adobe.ProcessingExcep- The ReaderRights credential hasn’t been con- This could be done automatically in the background, but it’s not possible to decide in
tion: Could not retrieve a password for cre- figured or has been configured under an general whether the desired feature is necessary for the application scenario or only
dential: ReaderRights appears (possibly as incorrect alias (refer to Section 3.3.4). optional. In the first case, either an error message would be issued or a workaround
part of a longer error message). would have to be programmed; in the latter case, the function would simply be dis-
The message com.adobe.ProcessingExcep- The ReaderRights credential has expired pensed with. Therefore, the decision must be made in the respective application pro-
tion: Not allowed by credential error while (refer to Section 3.3.4). gram. If the release of your ADS is always greater than or equal to the ABAP release, you
applying usage rights to PDF is displayed can do without this query.
(possibly as part of a longer error message).
The availability query is implemented using ABAP class CL_FP_FEATURE_TEST, which pro-
The error message contains com.adobe.Pro- The Document Services Trust Manager ser- vides static method IS_AVAILABLE. The return is a Boolean value that provides informa-
cessingException: Credential login error vice wasn’t restarted after changes were tion about whether the requested feature can be used. The feature itself is passed to the
while applying usage rights to PDF. made to the configuration (refer to Section IS_AVAILABLE method. The possible values depend on the release of the ABAP stack and
3.3.4).
are listed as attributes of class CP_FP_FEATURE_TEST. Table 3.2 shows the values from the
Table 3.1 Typical Error Messages When Calling Adobe Document Services and Possible SAP NetWeaver AS ABAP 7.5 release. You probably won’t use any of these features
Causes (Cont.) directly in your programs. Rather, they are functions that are queried internally, for
example, in Web Dynpro ABAP.
If you can’t find a description of your problem in Table 3.1, SAP Note 944221 provides a
Feature Description
procedure on how to locate the problem using test reports.
GC_JOB_PROFILES Job profiles
108 109
3 Installing and Configuring Adobe Document Services 3.8 Summary
The feature test itself accesses a cached version number of ADS and performs a remote
Feature Description
call only in exceptional cases. Therefore, the query isn’t performance critical.
GC_HIGHLIGHT_FIELDS_ON_ERROR Highlight fields in case of error
3
GC_ASSEMBLE_STITCH Merge into one PDF document, even for very large Further Information on the Hub Concept
PDFs
The ADS hub concept is also described in the “ADS Hub – Central Installation of Adobe
GC_NO_DROP_DOWN_TO_ZCI Don’t send dropdown lists to ZCI Document Service” blog post in the SAP Community at http://s-prs.co/v224283.
GC_LAYOUT_MIRRORING Template mirroring In this chapter, we’ve shown you how to configure the ABAP and Java systems to run
ADS. This is necessary to try out the examples in this book. Furthermore, you’ve gained
GC_RENDER_PDFA1 PDF/A-1
an overview of the individual components of ADS and how they interact. You’ve gained
GC_EXT_PRN_OPTIONS Additional printing options knowledge about important aspects of the operation of ADS and can independently
locate and correct typical configuration errors.
GC_PDFA_EXT PDF/A-1b, 2b, 3b, Converter, ZUGFeRD
In the next chapter, we’ll discuss the structure, interface, and context of a form.
GC_CAB CAB output
You may be interested in the PDF/A-1 (GC_RENDER_PDFA1) and job profiles (GC_JOB_PRO-
FILES) features. We explain job profiles in Chapter 6, Section 6.1.3. However, because
they have also been supported by the ADS hub concept since the first version (Release
7.0, SP13), you can dispense with the query. For more information about PDF/A-1, a for-
mat which can be used for archiving PDFs, see Chapter 6, Section 6.5.1.
The basic invocation of the feature test is shown in Listing 3.1.
110 111
Contents
Introduction ............................................................................................................................................ 17
1.1 PDF, PDF-Based Print Forms, and Interactive PDF Forms .................................... 23
1.1.1 PDF File Format ....................................................................................................... 23
1.1.2 PDF-Based Print Forms ......................................................................................... 24
1.1.3 Interactive PDF Forms ........................................................................................... 28
1.1.4 PDF Form Accessibility .......................................................................................... 29
1.2 Adobe Acrobat Reader and Adobe Acrobat Pro ....................................................... 29
1.2.1 Adobe Acrobat Reader and Adobe Acrobat Pro Comparison ................... 30
1.2.2 Choosing the Correct Adobe Acrobat Reader Version ............................... 32
1.2.3 Useful Settings in Adobe Acrobat Reader ...................................................... 32
1.3 Examples of PDF-Based Print Forms and Interactive PDF Forms ..................... 33
1.3.1 Print Output Example ........................................................................................... 33
1.3.2 Creating an Interactive PDF Form ..................................................................... 36
1.4 Using Interactive Forms in Business Processes ........................................................ 39
1.4.1 Online Scenarios ..................................................................................................... 39
1.4.2 Offline Scenarios ..................................................................................................... 40
1.4.3 Combining Online and Offline Scenarios ....................................................... 41
1.4.4 When Are Online and Offline Scenarios Used? ............................................ 41
1.4.5 Notes on Using Interactive Forms .................................................................... 43
1.5 Software Components and Architecture .................................................................... 44
1.5.1 Adobe LiveCycle Designer .................................................................................... 45
1.5.2 Adobe Document Services ................................................................................... 49
1.5.3 Interaction between the Components ............................................................ 54
1.6 Form Templates in SAP S/4HANA .................................................................................. 57
1.6.1 Master and Content Form Templates ............................................................. 57
1.6.2 Data Connection for Form Templates ............................................................. 59
1.7 Summary ................................................................................................................................... 59
7
Contents Contents
2.1 Installing Adobe LiveCycle Designer ............................................................................. 61 4.1 Form Structure ........................................................................................................................ 113
2.2 Install Adobe Acrobat Reader DC ................................................................................... 64 4.2 Form Interface ......................................................................................................................... 114
2.3 Summary ................................................................................................................................... 65 4.2.1 Creating the Interface ........................................................................................... 114
4.2.2 ABAP Dictionary-Based Interface ...................................................................... 116
4.2.3 XML Schema-Based Interface ............................................................................. 125
4.2.4 Smart Forms-Compatible Interface ................................................................. 127
3 Installing and Configuring Adobe Document 4.2.5 Documentation of a Form Interface ................................................................ 128
Services 67 4.3 Context of a Form .................................................................................................................. 129
4.3.1 Creating a Form ...................................................................................................... 130
3.1 Automatic Configuration ................................................................................................... 67 4.3.2 Form Structure ........................................................................................................ 132
3.2 Basic Configuration .............................................................................................................. 69 4.3.3 Structures .................................................................................................................. 135
3.2.1 Creating a Technical User .................................................................................... 69 4.3.4 Data Nodes ............................................................................................................... 137
3.2.2 Web Service Test ..................................................................................................... 72 4.3.5 Text Nodes ................................................................................................................ 139
4.3.6 Graphic Nodes ......................................................................................................... 144
3.3 Scenario-Dependent Configuration .............................................................................. 75
4.3.7 Address Node ........................................................................................................... 147
3.3.1 Setting Up the RFC Destination ......................................................................... 76
4.3.8 Alternatives .............................................................................................................. 150
3.3.2 Setting Up the Destination and Internet Communication
4.3.9 Tables or Loops ........................................................................................................ 152
Framework Service ................................................................................................. 77
4.3.10 Single Record Node ................................................................................................ 156
3.3.3 Configuring the Web Service Proxy .................................................................. 84
4.3.11 Conditions ................................................................................................................. 159
3.3.4 Configuring the ReaderRights Credential ...................................................... 86
4.3.12 Folder .......................................................................................................................... 160
3.3.5 Additional Settings for the Remote Function Call Connection ............... 90
4.4 Documentation of a Form ................................................................................................. 161
3.4 Parallelization Configuration ........................................................................................... 91
3.4.1 Configure Web Services ....................................................................................... 92 4.5 Summary ................................................................................................................................... 161
3.4.2 Testing the Connection between Two Web Services ................................. 97
3.4.3 Assigning the Logical Port to the Remote Function Call
Connection ADS ...................................................................................................... 97
5 Creating Form Templates 163
3.5 Optional Configuration ....................................................................................................... 98
3.5.1 Licensing .................................................................................................................... 98 5.1 Adobe LiveCycle Designer Structure ............................................................................. 163
3.5.2 Document Security: Credentials, Trusted Anchors, and 5.1.1 Menu and Toolbar .................................................................................................. 164
Certificate Revocation Lists ................................................................................. 99
5.1.2 Script Editor .............................................................................................................. 165
3.5.3 Service Characteristics .......................................................................................... 102
5.1.3 Hierarchy and Data View ..................................................................................... 165
3.5.4 Number of Parallel Print Jobs ............................................................................. 103
5.1.4 Object Library Palette and Object Palette ...................................................... 167
3.5.5 Fonts ........................................................................................................................... 104
5.1.5 Layout Editor ............................................................................................................ 169
3.5.6 Providing XDC Files for Print Output ............................................................... 105
5.2 Basics of Form Template Creation ................................................................................. 170
3.6 Operating Adobe Document Services .......................................................................... 105
5.2.1 First Steps .................................................................................................................. 170
3.6.1 Performance Monitoring and Log Configuration ........................................ 105
5.2.2 Using Text Fields ..................................................................................................... 174
3.6.2 Error Analysis ........................................................................................................... 107
5.2.3 Using the Preview PDF .......................................................................................... 180
3.7 Hub Concept ............................................................................................................................ 108 5.2.4 Formatting Texts .................................................................................................... 181
3.8 Summary ................................................................................................................................... 111
8 9
Contents Contents
5.3 Data Bindings for Form Fields .......................................................................................... 182 6.4 Additional Printing Options .............................................................................................. 237
5.3.1 Determination of the Data Binding ................................................................. 183 6.4.1 Setting Print Options in the Print Dialog Box ............................................... 238
5.3.2 Using Preview Data ................................................................................................ 184 6.4.2 Setting Print Options via Print Tickets ............................................................. 239
5.4 Structuring Form Templates by Subforms ................................................................. 186 6.5 Special Output Scenarios ................................................................................................... 242
5.4.1 Adding a Subform .................................................................................................. 187 6.5.1 Archiving ................................................................................................................... 243
5.4.2 Extending the Form Template ........................................................................... 189 6.5.2 Returning the PDF Documents .......................................................................... 246
5.5 Using Master Pages and Rich Text Fields .................................................................... 196 6.6 Error Analysis ........................................................................................................................... 251
5.5.1 Customizing the Master Page ............................................................................ 196 6.6.1 Trace and PDF Document with Additional Information ........................... 251
5.5.2 Rich Text Fields ........................................................................................................ 197 6.6.2 Internet Communication Framework Recorder ........................................... 255
5.5.3 Form Template Activation ................................................................................... 200 6.7 Performance Optimization through Bundling ......................................................... 259
5.6 Reusing Form Objects .......................................................................................................... 200 6.7.1 Bundling Forms ....................................................................................................... 260
5.6.1 Creating Your Own Libraries ............................................................................... 200 6.7.2 Activating Bundling ............................................................................................... 261
5.6.2 Adding Form Objects ............................................................................................. 202 6.7.3 Disabling Bundling ................................................................................................. 261
5.6.3 Using Form Objects ............................................................................................... 203 6.7.4 Bundling Example .................................................................................................. 262
5.7 Implicit Data Binding ........................................................................................................... 203 6.7.5 Bundling a PDF Return .......................................................................................... 266
5.7.1 Creating Form Copies ............................................................................................ 203 6.8 Parallelization of Print Jobs .............................................................................................. 267
5.7.2 Determining the Implicit Data Binding .......................................................... 205 6.8.1 Activating Parallelization in the Print Program ............................................ 268
5.8 Tips for Working with Adobe LiveCycle Designer ................................................... 208 6.8.2 Monitoring Print Jobs ............................................................................................ 269
6.8.3 Cleaning Up Obsolete Print Jobs ....................................................................... 272
5.8.1 Adapting the Working Environment ............................................................... 208
6.8.4 Tracing with the SOA Manager ......................................................................... 272
5.8.2 Spell Check and Hyphenation ............................................................................ 211
5.8.3 Settings for Form Fields and Data Bindings .................................................. 213 6.9 XPF Data Streams .................................................................................................................. 276
5.8.4 Target Version of Adobe Acrobat Reader for a Form Template .............. 213 6.10 Summary ................................................................................................................................... 278
5.8.5 Keyboard Shortcuts ............................................................................................... 214
5.9 Summary ................................................................................................................................... 215
6 Form Output 217 7.1 Advanced Techniques for Print Forms .......................................................................... 279
7.1.1 Preparations ............................................................................................................. 279
6.1 Print Program .......................................................................................................................... 217 7.1.2 Fields in Body Text ................................................................................................. 280
6.1.1 Data Selection ......................................................................................................... 218 7.1.3 Using Tables ............................................................................................................. 282
6.1.2 Determining the Generated Function Module ............................................. 221 7.1.4 Page Breaks ............................................................................................................... 286
6.1.3 Opening the Print Job ........................................................................................... 222 7.1.5 Subform Set .............................................................................................................. 290
6.1.4 Calling the Generated Function Module ........................................................ 225 7.1.6 Using Patterns for Display Formatting ........................................................... 293
6.1.5 Finishing the Print Job .......................................................................................... 227 7.1.7 Conditional Page Breaks ...................................................................................... 297
6.1.6 Executing the Run Print Program ...................................................................... 228 7.1.8 Form Output in Duplex Printing ........................................................................ 298
7.1.9 Finished Form Template Output ....................................................................... 300
6.2 Spool System ........................................................................................................................... 232
7.2 Interactive PDF Forms .......................................................................................................... 301
6.3 Device Types for Output ..................................................................................................... 234
7.2.1 Preparations ............................................................................................................. 302
7.2.2 From PDF-Based Print Forms to Interactive PDF Forms ............................. 307
10 11
Contents Contents
7.2.3 Form Fields of Interactive PDF Forms .............................................................. 317 9 ABAP PDF Object 389
7.2.4 Dynamic Properties ............................................................................................... 327
7.3 Using Script Programs ......................................................................................................... 330 9.1 Instantiating the PDF object ............................................................................................. 390
7.3.1 First Script Program ............................................................................................... 330
9.2 Creating a PDF Document .................................................................................................. 392
7.3.2 Tips for Debugging Script Programs ................................................................ 334
9.2.1 Obtaining a Form .................................................................................................... 393
7.3.3 Calculations by Script Programs ........................................................................ 335
9.2.2 Creating an Interactive PDF Document .......................................................... 397
7.3.4 Input Validation by Script Programs ................................................................ 336
9.2.3 Rights of Use ............................................................................................................ 401
7.3.5 Controlling Input Readiness and Visibility of Form Fields ........................ 338
7.3.6 Creating Simple Script Programs with the Action Builder ....................... 339 9.3 Processing an Interactive PDF Document ................................................................... 403
7.3.7 Determining the Receiving Address for an Email Message 9.3.1 Filling Out an Interactive PDF Document ....................................................... 404
at Runtime ................................................................................................................ 342 9.3.2 Extracting Data ....................................................................................................... 407
7.3.8 Querying Reader Version Information ............................................................ 343 9.3.3 Validating a Digital Signature ............................................................................ 410
7.3.9 Access to Data Nodes and Form Fields ............................................................ 345 9.4 PDF Document Certification ............................................................................................. 412
7.3.10 Dynamic Tables ....................................................................................................... 347 9.4.1 Manually Requested Certification .................................................................... 413
7.4 Using Barcodes ....................................................................................................................... 350 9.4.2 Validating a Certification ..................................................................................... 414
9.4.3 Automated Certification ...................................................................................... 416
7.5 Using Label Printers .............................................................................................................. 352
9.5 Further Methods of the PDF Object ............................................................................... 421
7.6 Tips for Improving Performance ..................................................................................... 353
9.6 Summary ................................................................................................................................... 421
7.7 Introduction to Accessible PDF Forms .......................................................................... 354
10.1 Using Web Service Definition Language Data Connections .............................. 424
8 ABAP Offline Infrastructure 361 10.1.1 Creating a Web Service Based on a Business Application
Programming Interface ........................................................................................ 424
8.1 Example Scenario: Address Update in the Flight Booking Model ................... 361 10.1.2 Configuring Runtime Release in SOA Manager ........................................... 427
10.1.3 Creating the Form Template .............................................................................. 432
8.2 Configuring the Email Inbound ....................................................................................... 363
10.1.4 Testing the Form Template ................................................................................. 437
8.3 Using the ABAP Offline Infrastructure ......................................................................... 364
10.2 Using the Simple Object Access Protocol Object in JavaScript ......................... 441
8.3.1 Creating the Offline Handler .............................................................................. 364
10.2.1 Creating a Web Service Based on a Function Module ................................ 441
8.3.2 Interface and Context ........................................................................................... 366
10.2.2 Creating the Form Template .............................................................................. 446
8.3.3 Creating the Form Template .............................................................................. 368
10.2.3 Implementing the Web Service Calls ............................................................... 446
8.3.4 Generating and Sending the Form ................................................................... 373
10.2.4 Testing the Form Template ................................................................................. 451
8.3.5 Processing Received Forms ................................................................................. 378
10.3 Tips for Using Web Services .............................................................................................. 452
8.4 Testing the Offline Scenario ............................................................................................. 383
10.4 Summary ................................................................................................................................... 453
8.5 Summary ................................................................................................................................... 387
12 13
Contents Contents
11 Form Templates in SAP S/4HANA 455 12.2.2 Downloading a Form Template for Translation in Adobe
LiveCycle Designer .................................................................................................. 524
12.2.3 Translating Text and Other Form Fields in Adobe LiveCycle
11.1 Adobe LiveCycle Designer for SAP as a Standalone Application ...................... 455
Designer ..................................................................................................................... 527
11.2 Fragment-Based and Standalone Form Templates ................................................ 457 12.2.4 Testing the Translations ...................................................................................... 530
11.3 Downloading Form Templates and Uploading Them to the Design 12.2.5 Uploading the Form Template ........................................................................... 532
Environment ............................................................................................................................ 460 12.2.6 Locales ........................................................................................................................ 534
11.3.1 Downloading Form Templates in the Maintain Form 12.3 Dealing with Problems in Translations ........................................................................ 537
Templates App ........................................................................................................ 460
12.4 Customizing Solutions for Translation Maintenance ........................................... 538
11.3.2 Opening a Form Template in Adobe LiveCycle Designer .......................... 463
12.5 Origin of a Translation ........................................................................................................ 541
11.4 Editing Form Templates in Adobe LiveCycle Designer .......................................... 464
11.4.1 Editing Standalone Form Templates ............................................................... 464 12.6 Summary ................................................................................................................................... 544
11.4.2 Editing Master Form Template Editing ........................................................... 466
11.4.3 Fragments ................................................................................................................. 467
11.4.4 Fragment Integration ............................................................................................ 469
13 Setting Up SAP Gateway Services 545
11.4.5 Master Pages ............................................................................................................ 471
11.4.6 Editing Content Form Templates ...................................................................... 480
13.1 Data Supply for Form Templates in SAP S/4HANA ................................................ 545
11.4.7 Converting a Fragment-Based Form Template to a Standalone
Form Template ........................................................................................................ 487 13.2 SAP Gateway ........................................................................................................................... 546
13.2.1 SAP Gateway Service Builder .............................................................................. 547
11.5 Uploading Form Templates in the Maintain Form Templates App ................. 488
13.2.2 Determining the Relevant SAP Gateway Service ......................................... 548
11.5.1 Upload a New Custom Form Template ........................................................... 488
13.2.3 Determining the Project for the SAP Gateway Service .............................. 550
11.5.2 Customization of Existing Custom Templates ............................................. 492
13.2.4 Activating and Managing SAP Gateway Services ........................................ 552
11.6 Transport Connection .......................................................................................................... 495 13.2.5 SAP Gateway Service Entity Types .................................................................... 559
11.6.1 Register Transport Form Templates ................................................................. 495 13.2.6 Extending SAP Gateway Services ...................................................................... 561
11.6.2 Filter in the Register Extensions for Transport App .................................... 500
13.3 Custom Fields and Logic App ............................................................................................ 562
11.6.3 Configure Software Packages ............................................................................ 503
13.3.1 Overview .................................................................................................................... 562
11.7 Summary ................................................................................................................................... 506 13.3.2 Custom Fields .......................................................................................................... 563
13.3.3 Custom Logic ............................................................................................................ 569
13.3.4 Extending the Data Source ................................................................................. 579
12 Translating Form Templates 507 13.3.5 Activating Custom Fields ..................................................................................... 585
13.3.6 Transport Connection via the Register Extensions for
Transport App .......................................................................................................... 586
12.1 Translating Classic Form Templates .............................................................................. 507
12.1.1 Manual Translation of a Form ............................................................................ 508 13.4 Summary ................................................................................................................................... 587
12.1.2 Output of a Translated Form .............................................................................. 512
12.1.3 Form Layout Mirroring .......................................................................................... 514
12.1.4 Disable Automatic Mirroring of the Form Layout ....................................... 516
14 Configure Output Control in SAP S/4HANA 589
12.1.5 Translation Editor ................................................................................................... 517
12.2 Translating SAP S/4HANA Form Templates .............................................................. 518 14.1 Basic Settings .......................................................................................................................... 589
12.2.1 Translation within the Maintain Form Templates App ............................. 519 14.1.1 Enable HTTP Services for Business Rules Framework Plus ....................... 590
14.1.2 Activation of Transaction OPD ........................................................................... 593
14 15
Contents
14.8 Define Determination Rules for Master Form Template ..................................... 642
14.11 Customizing and Data Maintenance in the Productive Systems ..................... 655
Appendices 667
16
Index
711
Index Index
Barcode (Cont.) Certification (Cont.) Corporate design ................................................... 457 Data structure ........................................ 54, 167, 208
library ................................................................... 350 manually requested ......................................... 413 Corporate identity ............................... 58, 449, 457 XML-based .......................................................... 167
paper form .......................................................... 351 PDF document ..................................................... 99 Country ..................................................................... 253 Data transmission ................................................ 259
Base64 .............................................................. 223, 257 verify ...................................................................... 414 Credential ............................................................ 31, 99 Data type .................................................................. 121
Baseline shift .......................................................... 182 Change document ................................................. 617 configure ................................................................ 88 CUKY ..................................................................... 123
Binary format ......................................................... 144 Change mode .......................................................... 210 Currency ......................................................... 124, 295 CURR ..................................................................... 123
Binding ...................................................................... 182 Channel ........................................................... 619, 634 field ........................................................................ 123 define custom .................................................... 121
expression .................... 183, 184, 192, 194, 196, Character formats ................................................. 141 Custom Fields and Logic app .......... 59, 562, 569 QUAN ........................................................... 123, 148
203, 286 Check parameters ................................................. 225 Custom logic ........................................................... 569 UNIT ...................................................................... 123
Body text .................................................................. 280 Checkbox .................................................................. 323 test ......................................................................... 576 Data view ................................................. 45, 165, 546
BUMODE .................................................................. 261 appearance ......................................................... 323 Customer Datamax label printer ................................. 26, 352
Bundling ................................................................... 259 style ........................................................................ 323 forms ........................................................................ 98 Datamax Programming Language (DPL) .... 235
activate ................................................................ 261 Class includes ................................................................ 585 Date field ............................................... 218, 294, 314
disable .................................................................. 261 CL_FP ..................................................................... 390 Customizing Date format ............................................................ 244
example ............................................................... 262 CL_FP_FEATURE_TEST ......................... 109, 245 translation .......................................................... 539 Decimal field ................................................. 313, 336
PDF return ........................................................... 266 CL_FP_INBOUND_HANDLER ............ 363, 379 Decimal place ................................................ 123, 295
Business add-in (BAdI) ........................................ 244 CL_FP_PDF_OBJECT ........................................ 390 D Decision table ........................................................ 620
description .......................................................... 570 CL_FP_WB_HELPER ......................................... 396 edit ......................................................................... 628
Business Address Services (BAS) ..................... 147 Class Builder ............................................................ 613 Data Design view .................................................... 169, 184
Business Application Programming Click event ...................................................... 330, 447 capture .................................................................... 24 Destination ................................................................ 81
Interface (BAPI) ....................................... 409, 424 Client .......................................................................... 142 connection ............................................................. 59 cache .............................................................. 91, 102
Business Communication Service ................. 363 Client dependency .................................................. 92 extraction ............................................................ 407 test ............................................................................ 83
Business context ......................................... 563, 570 Collection ................................................................. 326 format ................................................................... 221 Development environment ................................ 54
Business process ...................................................... 39 create ..................................................................... 369 global .......................................................... 118, 120 Development time .................................................. 54
Business rule ................................................. 618, 621 editor ..................................................................... 369 input ......................................................................... 56 Device type .................................................... 234, 235
define .................................................................... 630 list ........................................................................... 369 integrity .................................................................. 39 Dictionary structure ........................................... 382
output parameter determination ............. 621 Color gradient ............................................... 173, 354 ouput ........................................................................ 24 Digital signature ......... 37, 99, 362, 382, 390, 410
Business Rule Framework plus (BRFplus) ... 589 Color printing ......................................................... 237 preview ................................................................. 530 validate ................................................................ 410
administrator .................................................... 594 Comments ................................................................. 30 row ......................................................................... 284 Dispatch time ........................................................ 632
repository ............................................................ 602 Communication Type ......................................... 363 Data binding ........................................ 182, 312, 353 Display formatting ..................................... 293, 296
workbench .......................................................... 597 Communications user ........................................ 430 establish ............................................................... 183 Display patterns .................................................... 297
Button .............................................................. 319, 332 Comparison operators ........................................ 151 evaluation ........................................................... 207 docReady event ..................................................... 330
add ......................................................................... 371 Condition ........................................................ 159, 297 explicit ........................................................ 203, 353 DOCRIGHTS ............................................................ 402
alternative ................................................. 148, 151 implicit .................................... 203, 205, 353, 354 Document
C ConfigPort_Document ......................................... 84 relative .................................................................. 353 properties ............................................................ 355
Configure Software Packages app ................... 503 subform ...................................................... 192, 213 return .................................................................... 246
CAB label printer ...................................................... 26 Connection table ....................................................................... 285 signature ............................................................. 324
Cache ............................................................ 78, 91, 102 default ................................................................... 391 Data Browser ........................................................... 386 Document security ................................................. 99
Calendar window .................................................. 314 SSL ........................................................................... 411 Data connection Document Services ................................................. 53
Call pattern .............................................................. 225 Console XML schema-based ......................................... 167 font manager ............................................. 75, 104
Callback class .......................................................... 613 enable .................................................................... 335 Data element transition ..................................... 541 Document Services Trust Manager ........ 90, 100
naming ................................................................. 614 Consumer proxy ...................................................... 92 Data model ........................................... 130, 537, 547 Documentation
Caption ...................................................................... 175 Content area ..................... 196, 426, 469, 474, 475 Data node ................................................................. 137 form interface ................................................... 128
dynamic ............................................................... 329 Content form template ... 57, 457, 473, 480, 525 access .................................................................... 345 Domain translation ............................................. 541
Central technical configuration (CTC) ............. 67 Content repository ..................................... 604, 607 Data patterns .......................................................... 297 Double-sided printing ........................................ 237
Certificate Content type ........................................................... 287 Data retrieval .......................................................... 217 Draft forms ................................................................ 98
revoked ................................................................. 101 Context menu Data selection ............................................... 218, 223 Dropdown list
signature ............................................................. 324 create table ......................................................... 154 Data source dynamic filling .................................................. 328
trusted ..................................................................... 99 Control level ............................................................ 155 extend ................................................................... 579 list entries ........................................................... 328
Certificate revocation list (CRL) ........ 87, 99, 101 Control type .................................................. 319, 371 functions .............................................................. 579 Duplex printing .......................... 27, 296, 298, 299
Certification Conversion routine .................................... 155, 158 Data stream ............................................................. 263 Dynamic properties ................................... 303, 327
automated .......................................................... 416 Core data service (CDS) view ............................. 582 XFP ......................................................................... 276 activate ................................................................ 327
712 713
Index Index
714 715
Index Index
716 717
Index Index
718 719
Index Index
Program (Cont.) Root certificate ....................................................... 100 SAPscript .......................................... 17, 27, 276, 648 Software components ................................. 44, 595
FP_CLEANUP_PARALLEL_PROCESSI ........ 272 Root node ................................................................. 133 forms ..................................................................... 651 SOMU_FORM_MASTER_A4 .................... 466, 467
FP_GENERATE_FUNCTION_ Row include text ............................................... 139, 141 SOMU_FORM_MASTER_LETTER ................... 466
MODULE ............................................... 224, 232 delete ..................................................................... 349 style ....................................................................... 143 Special characters ................................................. 141
FP_MONITOR_PARALLEL_ Rule ID ....................................................................... 643 SAPterm .................................................................... 542 Spell check ............................................................... 211
PROCESSING ........................................ 269, 272 Runtime ...................................................................... 55 Scanner ........................................................................ 26 Spool administration .......................................... 234
FP_PDF_TEST_00 ............................................... 77 artifacts ................................................................ 548 Schema ...................................................................... 401 Spool request ................... 224, 228, 229, 231, 232
FP_PDF_TEST_01 .............................................. 393 environment ............................................... 55, 155 Screen reader ................................................ 352, 354 display .................................................................. 232
FP_PDF_TEST_03 ............................................. 408 property ................................................................ 436 Script editor ......................................... 165, 332, 371 output .................................................................. 232
FP_PDF_TEST_20 ............................................. 421 Script objects .......................................................... 165 part list ................................................................. 266
FP_TEST_03 ................................................... 33, 90 S Script program .......................... 165, 297, 330, 354 type ........................................................................ 232
FP_TEST_IA_01 .................................................... 36 basics ..................................................................... 330 Spool system ................................................. 231, 232
RSPO0021 ............................................................ 239 Sales Document app ............................................ 618 calculation .......................................................... 335 Standalone form template ............................... 458
RSPO0022 ............................................................ 235 SAP Business Process Management ................ 52 create .................................................................... 332 create .................................................................... 487
SAPBC_DATA_GENERATOR ............................ 33 SAP Business Suite .................................................. 18 debug .................................................................... 334 Standard print tickets ......................................... 242
Proposal pool .......................................................... 512 SAP Business Workflow ........................................ 52 default language .............................................. 332 Stapling function .................................................. 237
Purchasing documents ...................................... 611 SAP Community .................................................... 357 input validation ................................................ 336 Statement pattern ................................................ 148
SAP Fiori ............................................................ 57, 519 preperation ......................................................... 331 Status information .............................................. 323
Q SAP Fiori launchpad ................................... 460, 519 syntax check ....................................................... 333 Storage category ................................................... 606
SAP Gateway ........................ 59, 459, 490, 545, 546 web service call ....................................... 423, 435 Storage mode ......................................................... 243
Quantity fields ....................................................... 123 activate ................................................................. 552 Scripting language ................................................... 46 Storage system ...................................................... 604
Quick info ................................................................ 564 add service ........................................................... 556 Scripting Object Model (SOM) Storage type ............................................................ 623
customize project ............................................. 550 expressions ........................................................ 346 Structure
R deactivate ............................................................ 554 Sections ..................................................................... 293 SFPDOCPARAMS .............................................. 243
define package ................................................... 556 Secure sockets layer (SSL) ........................ 102, 411 Style ........................................................................... 141
Radix alignment .................................................... 295 determine determine service ....................... 548 Selection section ................................................... 293 Subform ............................................................ 45, 186
Range ......................................................................... 631 entity type ........................................................... 559 Sending process ........................................... 361, 373 add ......................................................................... 187
Raw data interfaces (RDI) ................................... 276 extend ................................................................... 561 Service definition ........................................ 428, 444 content ........................................................ 279, 284
ReaderRights credential ................................ 86, 87 redefine ................................................................. 561 Service implementation .................................... 548 data binding ............................................. 192, 193
installation ............................................................ 90 register .................................................................. 555 Service maintenance ........................................... 548 default bnding .................................................. 353
Read-only ....................................................... 311, 356 SAP Gateway Service Builder ................... 59, 546, Service user ................................................................ 78 edit ......................................................................... 280
Recipient ............................................... 607, 619, 633 547, 550 SET_USAGERIGHTS .............................................. 412 expand ................................................................. 189
Rectangle .................................................................. 173 SAP GUI ....................................................................... 33 SFPOUTPUTPARAMS ........................................... 223 flow direction .................................................... 193
Reference ............................................... 119, 397, 404 SAP Help Portal ...................................................... 102 Short text ................................................................. 508 form fragment .................................................. 485
Reference field ....................................................... 124 SAP Interactive Forms by Adobe ....................... 23 translation .......................................................... 509 nesting depth ........................................... 280, 353
Register Extensions for Transport SAP NetWeaver ......................................................... 38 Side protection ...................................................... 141 repetition ............................................................ 196
app ............................................................... 495, 586 SAP NetWeaver Administration ........................ 81 Signature .................................................... 30, 99, 324 show/hide ........................................................... 338
Remote function call (RFC) SAP NetWeaver Administrator .......................... 87 field .............................................................. 369, 404 Subform set ............................................................ 290
destination ................................. 75, 76, 603, 631 SAP NetWeaver Application Server tool ......................................................................... 390 normal ................................................................. 290
Remote function call (RFC) connection ... 76, 97 ABAP ................................................................. 33, 61 validate ................................................................ 406 selection .............................................................. 290
settings .................................................................... 90 SAP NetWeaver Application Server SIGNRIGHTS ............................................................ 402 Syntax check .......................................................... 333
Report for Java .................................................................... 49 Simple Object Access Protocol (SOAP) Syntax error ............................................................ 333
FDT_TRANS_MASS_CHECK ......................... 663 SAP NetWeaver Developer Studio .................... 49 framework ............................................................. 75 System email address ......................................... 362
FP_TEST_MIRRORING_SERVICE ................ 515 SAP ONE Support Launchpad ............................. 61 header ................................................................... 449 System event .......................................................... 330
Request parameters ............................................. 423 SAP Printing Guide ............................................... 235 object ........................................ 423, 425, 441, 446 System field ............................................................ 134
Resource distribution ......................................... 267 SAP S/4HANA Simplex printing ...................................................... 27 System preparation ................................................ 61
Response parameters .......................................... 423 form template .................................................... 458 Single record node ............................................... 156 System requirement
Rich text field ......................................................... 197 form translation ............................................... 518 Smart forms ................. 17, 27, 114, 127, 276, 651 bundling .............................................................. 260
Rich Text Reference ............................................. 358 output control ................................................... 589 compatible interface ....................................... 127 System status ................................................ 595, 646
Role simplification list .............................................. 642 style ....................................................................... 143
maintenance ......................................................... 78 transportation ................................................... 495 text modules ...................................................... 139
sap_bc_fdt_administrator ........................... 594 SAP_ADSCALLER ..................................................... 71 SOA Manager ......................................... 91, 272, 427
720 721
Index Index
722 723
Index
724
First-hand knowledge.
Timo Ortiz