Varo (FLM) Installation Guide

Table of Contents
  1. 1 Introduction
    1. 1.1 Prerequisites for installing FLM
    2. 1.2  Java Prerequisites
    3. 1.3  Preparation for installing FLM
  2. 2 Performing the Installation of FLM
    1. 2.1 SAINT
    2. 2.2 Apply FLM Notes
    3. 2.3 SGEN (Optional)
  3. 3 Post Installation Configuration
    1. 3.1  Adobe ReaderRights Credential
    2. 3.2  Namespace /FLM/ and Software Component FLM
    3. 3.3  ZFLM Packages
      1. 3.3.1  ZFLM_FORM_CLASSES
      2. 3.3.2  ZFLM_AUTHORIZATIONS
    4. 3.4 Content Management Physical Tables
    5. 3.5 Number Range /FLM/TID
    6. 3.6 Number Range /FLM/EXCEL
    7. 3.7 SICF Settings
    8. 3.8 Define Content Repositories
    9. 3.9 Define and Assign Content Categories
    10. 3.10 Web Service Configuration
  4. 4 Digital Security
  5. 5 User Management
  6. 6 Setting Up Authorization Checks for FLM Forms
    1. 6.1 Overview
    2. 6.2 Authorization Fields
    3. 6.3 Authorization Object
    4. 6.4 Roles
      1. 6.4.1  Creating an FLM Admin Role
      2. 6.4.2  Creating Form User Roles
    5. 6.5 User Master Roles
    6. 6.6 Offline user
    7. 6.7 FLM Developer User Role and Authorizations
    8. 6.8 FLM Read Only Role
  7. 7 Deploying the FLM Portal
    1. 7.1  Multi-UI Portal
    2. 7.2  FLM Form Manager (UI5 Portal) Features
  8. 8 Customer Initialization tasks
    1. 8.1  Creating a new customer code
      1. 8.1.1  Customer Details
      2. 8.1.2  ADS Settings & Trace
      3. 8.1.3  Authorizations
      4. 8.1.4  FLM Portal Settings
      5. 8.1.5  Offline Settings
      6. 8.1.6 Customer Code Parameters
    2. 8.2 Define Form Categories
    3. 8.3 Define Form Statuses
    4. 8.4 Define Form Actions
    5. 8.5 System Specific Settings
    6. 8.6 Number Range /FLM/<Customer Code>
    7. 8.7 Message Class /FLM/<Customer_Code>
    8. 8.8 Link Document Types
    9. 8.9  Create Form Classes
    10. 8.10 Upload Master Templates
    11. 8.11 Copy Standard FLM Javascript snippet library to local client.
    12. 8.12 Create JXXX Javascript Class
    13. 8.13 Test Form
    14. 8.14 Upload TS01 Packages (optional)
    15. 8.15 FLM Maintenance and Monitoring.
  9. 9 Setting Up Offline (Email) Handling in FLM
    1. 9.1 Setting up Inbound Email (Offline) Processing:
  10. 10 Setting up QAS and PRD.
  11. 11 Uninstallation of Varo (FLM).

1 Introduction

This document describes the installation process for Forms Lifecycle Manager release 300.

We estimate that the installation of FLM on a customer site takes around one day.  

1.1 Prerequisites for installing FLM

Please review the System Requirements before installing.

  • User performing the post installation activities will need an abap developer role and developer key.
  • For PDF scenarios ADS must be configured. See the ADS Configuration Tips for additional information.
  • Current versions of kernel, tp and R3trans

Make sure that your system contains the current versions of kernel, tp and R3trans.

  • Current SPAM / SAINT Update

Make sure that you have imported the most recent SPAM / SAINT Update into your system. Compare the short text of the last SPAM / SAINT Update you imported with that of the SPAM / SAINT Update in the SAP Service Marketplace. If the version of the SPAM / SAINT Update in the SAP Service Marketplace is more recent, import it.

1.2  Java Prerequisites

For interactive-form scenarios that use PDFs you will also need ADS which is a Java component that is delivered with and resides on the NW WebAS Java Stack.

1.3  Preparation for installing FLM

Support Packs are not cumulative so all ABAP ADD-ON .SAR files received with the FLM distribution must be applied.

1.    Mount the Add-On Installation Media.
2.    Unpack the archive FLM_INST_<VER>.SAR in the subdirectory DATA using the command:

sapcar –xvf FLM_INST_<VER>.SAR

3.    From the resulting EPS/IN directory, copy the QA1*.PAT file into your development system EPS inbox directory:

//sapmnt/trans/EPS/in

4.    Ensure that the permissions of the file are set for read/write access for the SAP O/S users.

Quick note: Steps 2-4 can also be done in SAINT:

     SAINT -> Installation Package -> Load Packages -> From Front End

          For Service Packs you would use SPAM.

For more information about this, see the online documentation for Add-On Installation Tool. To do this, choose the help function in the application toolbar and navigate to Online Documentation Loading Installation Packages.

 

2 Performing the Installation of FLM

This section describes the installation procedure for the software.

If you are updating a preexisting installation of FLM be sure to first backup all your forms by exporting all the forms in the system on a form-by-form basis (one at a time) including business logic.

2.1 SAINT

Log on to your SAP system as client 000 and as a user that has SAP_ALL authorization. Do not use the user SAP* or DDIC.

  1.    Upload and apply the following Add-On upgrades with transaction SAINT.
    1. The Varo (FLM) Add-On FLM_INST_300.SAR
    2. The Varo Form Manager (FLMUI5) Add-On FLMUI5_INST_300.SAR
      1. This component is optional but recommended see System Requirements for more details.
  2.     Optional: Run SGEN on FLM after the upgrade has been applied.
  3.     Apply all relevant Varo (FLM) Notes and Transport.

For more information see the online documentation for Add-On Installation Tool. To do this, choose the help function on the toolbar.

2.2 Apply FLM Notes

  1. Apply any relevant FLM Notes.

2.3 SGEN (Optional)

At this point you should compile FLM using the SGEN transaction.

  1. Transaction SGEN.
  2. Select the first option: Generate All Objects of Selected .... - Continue
  3. Select for Parallel Generation:  Leave default. - Continue
  4. Start Job Directly.
  5. Generation speed depends on your system but should take under 10 minutes.

 

You can stop here if you are updating an existing installation of FLM.

Check the Upgrade Guide for FLM and SAP for more details.


3 Post Installation Configuration


If you have already setup a DEV system and are installing the QAS and PRD systems skip to Section: 10 Setting up QAS and PRD.

Installation should be done on the Client that will be using FLM so the objects created below transport properly to QA and Customer Systems.  We suggest creating a new transport when prompted named “FLM <VER> Installation <CLNT>”.

3.1  Adobe ReaderRights Credential

In order for ADS to be able to render PDF forms which are interactive, it is required to install into each Java stack an ‘Adobe Credential for ReaderRights’.  This is a piece of Adobe intellectual property delivered via the SAP OSS system in the form a small file.  It is installed into the WebAS java stack and then configured using the ‘Visual Administrator’.  Only one Credential is required per customer.

The process is described in SAP Note 736902.

3.2  Namespace /FLM/ and Software Component FLM

During the process of forms creation the FLM framework generates Data dictionary objects in the namespace /FLM/.  Therefore this namespace must be set to ‘modifiable’.  Process:

  1. Transaction SE03 [ess-ee-zero-three].
  2. Choose ‘Set System Change Option’.
  3. Navigate in the ‘Software Component’ Table to FLM.
  4. Choose ‘Modifiable’.
  5. Navigate in the ‘Namespace/Name range’ Table to /FLM/.
  6. Choose ‘Modifiable’.
  7. Save the settings.

3.3  ZFLM Packages

Two packages are important for the maintenance of the FLM system.

3.3.1  ZFLM_FORM_CLASSES

This package is used to hold and transport the business logic associated with customer forms and is delivered empty.  Certain aspects of form business logic has to be generated by the FLM framework in the Z namespace, and hence an Z package can only be used to hold these objects.

After the initial installation, this package should be repaired in transaction SE21 to change the transport layer to the customer’s standard transport layer, such that objects in this package can be successfully migrated through the customer landscape.

  1. Transaction SE21.
  2. Package will be ZFLM_FORM_CLASSES and select Create.
  3. Short Description: FLM: Form Type Classes and Business Logic
  4. Application Component: CA
  5. Software Component: HOME
  6. Transport Layer: Customer Specific, Default SAP.
  7. Save

Note: As of 295 SP3 the /FLM/CUST package is no longer used to hold form type classes. Existing classes will not be affected and do not need to be migrated to the Z namespace.

3.3.2  ZFLM_AUTHORIZATIONS

This package is used to hold objects that cannot be maintained in the /FLM/ namespace, eg authorization objects, such that they can be migrated through the customer’s landscape.  The package is created in transaction SE21.

  1. Transaction SE21.
  2. Package will be ZFLM_AUTHORIZATIONS and select Create.
  3. Short Description: FLM: Authorization Objects
  4. Application Component: CA
  5. Software Component: HOME
  6. Transport Layer: Customer Specific, Default SAP.
  7. Save

3.4 Content Management Physical Tables

FLM uses the 'Content Management System' [CMS] or 'Content Server' to store form and form templates.  The setup of CMS is SAP standard and described fully in the IMG documentation accordingly. 

The standard FLM installation scenario makes use of SAP DDIC physical tables as the final repository for CMS data, and under those circumstances it is necessary to create physical table for that purpose. We will create two tables, one for the form templates and one for to hold the form data. 

Template Table:

  1. Transaction SE11.
  2. Select the radiobutton 'Tables' and enter table SDOKCONT1. (Those are OHs)
  3. Copy this table to /FLM/SDOKCONT1t, assigning package /FLM/CUST and workbench request as required.
  4. Activate this table.

Data Table:

  1. Transaction SE11.
  2. Select the radiobutton 'Tables' and enter table SDOKCONT1. (Those are OHs)
  3. Copy this table to /FLM/SDOKCONT1d, assigning package /FLM/CUST and workbench request as required.
  4. Activate this table.

Form Archiving was introduced at FLM 295 SP2 and requires a separate table.

Archive Table:

  1. Transaction SE11.
  2. Select the radiobutton 'Tables' and enter table SDOKCONT1. (Those are OHs)
  3. Copy this table to /FLM/SDOKCONT1a, assigning package /FLM/CUST and workbench request as required.
  4. Activate this table.

Ensure that the technical settings of the table match the expected size of the table, and adjust accordingly.

FLM supports only the SAP Database CMS repository type.

3.5 Number Range /FLM/TID

The FLM Transport ID (/FLM/TID) Number Range Object is delivered with FLM and a new interval range must be setup in it.

  1. Transaction SNRO [es-en-ar-oh].
  2. Enter number range object name (/FLM/TID).
  3. Press Number Range button.
  4. Press change Intervals.
  5. Create an Interval. E.g 01 100000000 – 1999999999 - 1000000000
  6. Press save.

3.6 Number Range /FLM/EXCEL

The FLM Transport ID (/FLM/EXCEL) Number Range Object is delivered with FLM and a new interval range must be setup in it.

  1. Transaction SNRO [es-en-ar-oh].
  2. Enter number range object name (/FLM/EXCEL).
  3. Press Number Range button.
  4. Press change Intervals.
  5. Create an Interval. E.g 01 600000000 – 6999999999 - 6000000000
  6. Press save.

3.7 SICF Settings

FLM makes use of a business server pages transaction in order to allow FLM form URLs to be sent as part of the reminder functionality in form routing.  The BSP application must be activated in transaction SICF.  Proceed as follows:

  1. Transaction SICF.
  2. Enter *FLM* into Service Name field
  3. Press Execute
  4. Right-click and select Activate all FLM (and FLMUI5 if available).
  5. Choose to Activate this node and all child nodes

Please note that there are certain standard BSP service nodes that must activated as a pre-requisite for using any BSP application; please consult SAP Note 517484 - Inactive services in the Internet Communication Framework for details.

The following BSP services must also be activated:

  1. Review SAP Note 517484 - section "Using Business Server Pages (BSP)"
  2. Activate: /sap/public/myssocntl
  3. Activate: /sap/public/bc/bsp (BSP Design2008)
    1. For NW 700 / 701 review SAP Note 1671470 - BSP: Design2008 for release 7.00 and 7.01
    2. If the user base is using browers versions older than IE11 then Design2003 should be set as the theme to be used in the Device Characteristics table. See the FLM Multi-UI Portal documentation for additional detail.

3.8 Define Content Repositories

In this Activity, you can define content repositories to which contents can be moved.

In Knowledge Warehouse three different types of content repositories can be used, FLM only supports using the SAP System Database and we will highlight the steps for its configuration.

You can find further information on content repositories in the SAP Knowledge Warehouse Installation Guide and in the SAP Library under Basis - Basis Services - SAP Knowledge Provider - Content Management Service - Concepts.

Setup the Content Repository to use the SAP System Database:

Template Content Repository:

  1. Transaction OAC0 (OH-A-C-Zero).
  2. Change - Create
  3. Content Rep. : We suggest “ZFLM0001”
  4. Description: FLM: Template Content Repository
  5. Document Area:  We suggest /FLM/ or Forms Lifecycle Manager
  6. Storage type: SAP System Database
  7. Version No.: 0046
  8. Contents Table: /FLM/SDOKCONT1t
  9. Save

Data Content Repository:

  1. Transaction OAC0 (OH-A-C-Zero).
  2. Change - Create
  3. Content Rep. : We suggest “ZFLM0002”
  4. Description: FLM: Data Content Repository
  5. Document Area:  We suggest /FLM/ or Forms Lifecycle Manager
  6. Storage type: SAP System Database
  7. Version No.: 0046
  8. Contents Table: /FLM/SDOKCONT1d
  9. Save

Form Archiving was introduced at FLM 295 SP2 and requires a separate content repository.

Archive Content Repository:

  1. Transaction OAC0 (OH-A-C-Zero).
  2. Change - Create
  3. Content Rep. : We suggest “ZFLM0003”
  4. Description: FLM: Archive Content Repository
  5. Document Area:  We suggest /FLM/ or Forms Lifecycle Manager
  6. Storage type: SAP System Database
  7. Version No.: 0046
  8. Contents Table: /FLM/SDOKCONT1a
  9. Save

If you encounter problems with entering data at this step please see SAP NOTE: 1163925

3.9 Define and Assign Content Categories

In this activity you assign the storage categories of documents managed in the Knowledge Warehouse to content repositories (in the Knowledge Provider these are also called content categories).

Follow the steps below to create a new storage category and assign it to the content repository.

Template Content Repository:

  1. Transaction OACT (OH-A-C-T).
  2. New Entries
  3. Category: We suggest “ZFLM0001”
  4. Description: FLM: Template Content Categories
  5. Document Area: /FLM/
  6. Content Repo: This is the repository created in the previous step, ZFLM0001
  7. Save

Data Content Repository:

  1. Transaction OACT (OH-A-C-T).
  2. New Entries
  3. Category: We suggest “ZFLM0002”
  4. Description: FLM: Data Content Categories
  5. Document Area: /FLM/
  6. Content Repo: This is the repository created in the previous step, ZFLM0002
  7. Save

Form Archiving was introduced at FLM 295 SP2 and requires a separate content category.

Archive Content Repository:

  1. Transaction OACT (OH-A-C-T).
  2. New Entries
  3. Category: We suggest “ZFLM0003”
  4. Description: FLM: Archive Content Categories
  5. Document Area: /FLM/
  6. Content Repo: This is the repository created in the previous step, ZFLM0003
  7. Save

3.10 Web Service Configuration

Some form processes may use web services to retrieve data from various SAP systems in the SAP landscape.  If these features will be used the webservice configuration must be performed if it hasn't been completed previously.

Details on the web seervices configuration can be found here: Note 1043195 - Configuration of the Web service runtime

Arch also provides a quick setup guide: Web Service Configuration

 

4 Digital Security


// This section is typically not required as part of the initial configuration and can be skipped.

For FLM to support digital signatures, this must be configured after installation in the Maintain Security Settings for Customer activity in the IMG:
 
You can create the credentials for a certification (server-side digital signature) as they will appear to the user using the ‘new entries’ function. The ‘permissions’ selection allows you to configure what is allowed to be changed on the form without damaging the integrity of its digital certification.
 

5 User Management


In SAP, each user’s authorization can be defined with reference to a composite role, single roles, and profiles. The object to be checked is an ‘authorization object’, and is made up of authorization fields that the system will need to use in the check.

FLM is delivered with authorization checking code and the authorization fields, but the set-up of the users, roles, profiles and objects will be different in each implementation.

The installation guide suggests the creation of the following roles, one of which will be need to be assigned to a user accessing FLM

ZFLM_ADMIN
ZFLM_DEVELOPER
ZFLM_USER
ZFLM_PORTAL
ZFLM_READONLY
 

6 Setting Up Authorization Checks for FLM Forms


FLM relies entirely on the user master record as defined in the ABAP stack.  The UME of the java stack must have the ABAP stack set as it's data source in order to take advantage of this standard installation configuration.

Firstly, in order to control which users have access to which form categories and form types, an authorization object must be created in the customer system and transported through the system landscape.  Typically this would be in the customer namespace, we recommend for example, z/flm/0001.

Find our more in FLM Authorizations and Security.

6.1 Overview

In SAP, each user’s authorization can be defined with reference to a composite role, single roles, and profiles. The object to be checked is an ‘authorization object’, and is made up of authorization fields that the system will need to use in the check.

 FLM is delivered with authorization checking code and the authorization fields, but the set-up of the users, roles, profiles and objects will be different in each implementation.

6.2 Authorization Fields

Three authorization fields are delivered as part of FLM:

/FLM/CUST   Customer
/FLM/FTYPE   Form type
/FLM/FCAT    Form category

These three authorization fields, along with the standard field ACTVT, must be included in the authorization object.

6.3 Authorization Object

FLM is not shipped with an authorization object.  Part of the installation process involves the creation of authorization object ‘z/flm/0001’.

Creating an Authorization Object

  • Transaction SU21 or menu path ‘Tools->ABAP Workbench->Development->Other tools->Authorization objects->Objects’
  • Choose the pushbutton for create authorization object.
  • Enter the following:
    • Object: ‘z/flm/0001’
    • Text: ‘FLM: Form Authorization Object'
    • Class: ‘AAAB’
    •  Field name: /FLM/CUST
    • Field name: /FLM/FCAT
    • Field name: /FLM/FTYPE
    • Field name: ACTVT

 

  • Select pushbutton to maintain the permitted activities. Use ZFLM_AUTHORIZATIONS for the package.
  • Select options ‘01’, ‘02’, ‘03’, ‘10’, '24', '25' and '70'. Save,
  • Select pushbutton to create documentation, then save
  • Save the authorization object. You may get a message indicating it has already been saved, if so just cancel out of the maintenance window.
  • Finally we need to regenerate the SAP_ALL profile in order to include the new object.  Use the pushbutton ‘Re-generate SAP_ALL’ on the top of the front screen for transaction RSU21_NEW.

6.4 Roles

There are various ways of linking the authorization object to user ids using roles and profiles.  In this section we describe one method, using a ‘single role’ and a ‘generated profile’.

6.4.1  Creating an FLM Admin Role

We need one role for FLM administration

  • Or transaction code PFCG or select the menu path ‘Tools->Administration->User Maintenance->Role Administration->Roles.’
  • Enter role name ‘ZFLM_ADMIN’ and choose the ‘Single Role’ pushbutton.
  • Enter the role description then Save

 

  • Select the Authorizations tab

 

  • In the ‘Information About Authorisation Profile’ box, select the ‘Propose Profile Names’ pushbutton, and a profile name is generated automatically. Save.

 

  • Select the Change Authorization Data pushbutton.  A pop-up window is displayed.  Select the ‘Do not select templates’ pushbutton. 
  • Now select the ‘Manually’ pushbutton, and enter the authorization object ‘z/flm/0001’.

 

  • Expand the hierarchy and then enter values for each field: select the ‘*’ symbol in order for this role to include all form types, categories and activities.

 

  • Select the Manually’ pushbutton again, and enter the authorization object S_TCODE

 

  • Expand the Tree out and select the Change Transaction code button.

 

  • Enter ‘/FLM/*’ into the ‘Form’ field as shown. This is granting authority for ALL /FLM transactions to the ZFLM_ADMIN role.

 

  • Generate. (Save)
  • Role ZFLM_ADMIN is now ready to be linked to user records.

6.4.2  Creating Form User Roles

Follow the same steps as for setting up the ZFLM_ADMIN role, but in the final step, limit the role by form category, form type and /or /FLM transaction code.

For example:If the user only submits forms but cannot change submitted forms, then select activity 01 but not 02 for authorization object z/flm/0001.

If the user can display forms in the Dashboard (transaction code /FLM/FORM_DASHBOARD), but not post forms in FPE (transaction /FLM/FPE) or trigger form routing escalations (transaction /FLM/WF) for example ,select only the relevant transaction code(s) in place of the /FLM/* assigned to the admin role against authorization object S_TCODE

If users will be access web services users will also need S_SERVICE role for the servce being called.

For more details see the FLM Authorization and Security Guide.

6.5 User Master Roles

Once the roles and profiles have been created, it is necessary to link the roles to the user master records as normal. This can be achieved on a user-by-user basis, or by adding the FLM roles to existing composite roles. Users are maintained in transaction SU01. The role is added as shown in the ‘Roles’ tab.

 

When the role is added to the user, the profile appears in the ‘Profiles’ tab.

 

6.6 Offline user

The FLM system requires one SAP user as the so-called ‘Offline User’.  The FLM framework uses this user for processing offline forms [ie form sent to user not via the FLM Portal], since at this time no SAP dialog user is available for authorization checking.

It is recommended a ZFLM_OFFLINE rolle be created and it be given the authorization object z/flm/0001 with open authorizations to the whole FLM system as follows:

  • /FLM/CUST                       *
  • /FLM/FCAT                       *
  • /FLM/FTYPE                     *
  • ACTVT                              * 

This user master record is entered into the FLM configuration under the ‘Set Customer Code’ IMG activity against the ‘Offline User’ field. = user name attributed to offline email user activity.

Create technical (Service) user ZFLMOFFLINE and assign the ZFLM_OFFLINE role to it.
 

6.7 FLM Developer User Role and Authorizations

  • Create ZFLM_DEVELOPER role and add the authorisation z/flm/0001 Object with  ‘*’ as before.
  • Also add the authorisation object S_TCODE with the following transactions
    • /FLM/*
    • OAC0
    • OACT
    • SE10
    • SE16
    • SE24
    • SE91
    • SO10
    • SFP
    • SM30
    • SM34
    • SPRO
    • SOST
    • SCOT
    • SLG1
    • ST22

 

  • Add authorisation objects S_CTS_ADMI  and S_TRANSPRT to enable the role to create and administer transport requests.
  • Add authorisation object S_GUI.
  • Add role ZFLM_DEVELOPER to the developer user, along with a normal ABAP developer role such as SAP_BC_DWB_ABAPDEVELOPER

6.8 FLM Read Only Role

The ZFLM_READONLY role can be created for giving remote access to the FLM System.

See FLM Authorizations and Security for more details.

 

7 Deploying the FLM Portal

 

The FLM Portal component is required for on-line (via a web browser) interactive-form.

There are two main Portals that can be used.

Note: The Customer Code in Section 8 below must be completed before the portals will function correctly.

7.1  Multi-UI Portal

The first is the FLM Multi-UI Portal. 

  • The first time the MUI Portal is accessed it may time out and take several attempts as the BSP libraries may need to compile.

The Multi-UI Portal URL: http://<server>:<abap port (8000)>/sap/bc/bsp/flm/dispatcher/default.htm

The Multi-UI Portal Setup:

  • The MUI Portal BSP configuration was covered in Section 3.6 of this guide.
  • If you do not have SSL configured on your systems add an entry for Windows Desktop in the Device Character table.
    • SPRO -> IMG -> Cross-Application Components -> General Applications Functions -> Forms Lifecycle Manager -> Initialize Customer Code -> Advanced Settings -> Maintain Device Characteristics

7.2  FLM Form Manager (UI5 Portal) Features

The second is the FLM Form Manager Portal which is based on the SAP UI5 framework and provides a richer user experience.

  • The FLM Form Manager is now the recommended portal for on-line (web) scenarios.

The Form Manager is deployed as a seperate ABAP Add-On and only requires activating the FLMUI5 SICF nodes otherwise it is configured with the same features as the Multi-UI Portal above.

 

8 Customer Initialization tasks

8.1  Creating a new customer code

Each implementation of FLM is defined by at 3-digit customer code. You will need to use this activity to setup a default customer code by clicking on ‘new entries’ at the top of the window and defining a new 3-letter customer code. Also enter a text description.

SPRO -> Cross-Application Componets -> General Application Functions -> Forms Lifecycle Manager -> Initialize Customer Code -> Set Customer Code

On the main screen is a list of setup customer codes. The tick box shows which customer code is currently set as default.

You can create a new customer code by clicking ‘new entries’ at the top of the screen. This must be a unique 3-letter code approved by Arch.

For the initial configuration only the following fields are required:

  • FLM Customer Code
  • Default Customer - Checked
  • Auth Object: most likely z/flm/0001 as recommended by this guide.
  • File Type: PDF Format
  • Recommended: Default Sender Addr: <SID>@<SERVER>
  • Recommended: Offline User - most likely FLM_OFFLINE as recommended by this guide.

Please Note: If you are deploying FLM to multiple clients on the same system the Customer Code in each Client must be unque otherwise you won't be able to transport between clients and cross-client tables may not function as expected.

 

8.1.1  Customer Details

FLM Customer Code:

Enter the 3-letter code you want to define your new FLM implementation, and text that describes the customer code.

Default Customer:

Checking the ‘default’ box will set it as the default customer, to which forms will be assigned unless you otherwise specify. Each FLM system can have multiple FLM Customer Codes maintained. However, only one FLM Customer Code can be 'default' in each system ( or client ). Only the default customer can be actively processing forms at runtime - other FLM Customer Codes are for development purposes only.

Master Language:

The master language defines which language the form data schema must initially be defined in.   All other languages at the same version will then share the same data schema, which cannot be altered.

The master language also determines the template used for the ABAP user-exits, and also the language of various drop-downs in the system.

Once the language is set and a form defined, this should not be changed.

Solution Manager Active:

Check this box if SAP Solution Manager is active in your landscape. This sole effect of this to stop the FLM Form Wizard from generating its own transports.

In this case you must use Solution Manager to generate the transports, and then pick these up manually in the Form Transport Wizard run.

If you wish the Form Transport Wizard to pick up the correct transports automatically, the request headers (workbench and customizing) must be given the Attribute 'SAPCOMPONENT' with the value 'FLM:Cust = XXX , Form = YYYY', where XXX is your 3-letter FLM customer code and YYYY is your 4-letter FLM Form Type Code.

Factory Calendar:

Entering a factory calendar will assign that calendar to the customer code. For example you may wish to use a working-day calendar for escalation and reminder time lapses. Default FC is 01 or Country Code (GB for Britian).

8.1.2  ADS Settings & Trace

Metadata On:

Metadata is off by default. If you are running NW700 SP15 or better you can turn this on to see meta data in your PDFs.

ADS Trace Level:

Sets the ADS trace level.  0 = no trace, 4 = highest level of trace.

At level 4 a successfully rendered pdf will also have several extra attachments corresponding to the trace file from ADS, the form template, the form data schema etc.

At all lower levels the trace information is stored in the defaultTrace file on the java stack and can be viewed from the Log viewer here:

\\usr\sap\<SID>\<Instance>\J2EE\cluster\server<n>\log\defaultTrace.trc

Activate the HDS Trace

This flag controls the HTML Document Services (HDS) trace function; set the flag if you wish the system to record trace information whilst rendering HTML forms.  This can be very useful for debugging form issues.   The system only records the trace of the most recently rendered HTML form.

8.1.3  Authorizations

Authorizaton Object:

This is the authorization object created in Section 6, most likely z/flm/0001.

An authorization object combines up to 10 authorization fields, which are checked using the AND connective.

Authorizations are checked against objects in the system. Authorization objects enable complex checks (linked to several conditions) of an authorization. For the authorization check to be successful, the user must pass the check for each field contained in the object.

Standard Usergroup Functionality Activated:

This switch enables you to use standard SAP usergroups for group access to forms.

Usergroups are maintained and assigned to users in transaction SUGR.

If this scenario is enabled then forms are routed to either individual users or to single usergroups.  If forms are assigned to individual users then they are still only available to that one user in the FLM Inbox.  If they are assigned to usergroups then anyone in that usergroup can process those forms.

You must also switch on 'Group Access to Forms' for every form type if you wish to use this scenario, as it is a global setting.  You can do this under the FLM IMG activity 'Form Types Configuration'.

If you have also maintained a remote system for your FLM user management under the FLM IMG activity 'System specific settings', then the user groups are read from the remote system and not the local one.

8.1.4  FLM Portal Settings

No Logo Section:

If this flag is set, there will be no logo section displayed in the FLM Portal.  This removes the logo, the title 'Forms Lifecycle Manager' and the name of the logged in user.

No Logout Button:

If this flag is set, there will be no logout button on the FLM Portal. This is to support scenarios where forms utilize the UWL exclusively.

8.1.5  Offline Settings

EncryptKey:

The encryption key is used to scramble URLs being sent out by FLM such that the form parameters are not human-readable.  The key must comply with the following rules:

  • choose only letters in the range G to Z
  • you must fill all 16 positions
  • you cannot choose the same letter twice.

File Type:

The return file type defines how the form is returned to FLM in the offline scenario.   You have two choices, either as the full PDF format (which includes attachments, annotations etc) or as just an XML data blob.  The XML data version is much smaller than the PDF format, but only includes the pure form data.

You can set the return file type globally on the FLM customer master record, or you can set it individually at the form type level.  If the format is set in both places, the form-specific value prevails.

The recommended setting is to choose the full PDF format to be sent; you would choose XML really only if bandwidth was severely limited or where infrastructure was unreliable, as the file size in this case is considerably smaller.

Default Sender Addr:

Any outbound email from FLM must be supplied with a return address in order for replies to be automatically generated.

You maintain this address either globally on the FLM Customer master record, or on a per-system basis, in the System-Specific Settings table.

It is recommended to use the latter method (from FLM 295 onwards) as this method allows you to differentiate between DEV, QA and PRD systems.

Offline User:

Whenever a form is sent offline to an e-mail recipient then FLM assigns this 'Offline User' as the 'Form Owner' as we no longer have a real SAP named user for the form owner..

FLM also uses this field when running certain programs in order to pass the built-in FLM authorization checks.

The user maintained here should generally not be a dialog user and should be given sufficient FLM authorisations to process all forms.

Rej Title Text:

Text Object for Body of e-mail Rejection

When an off-line e-mail is received back into the FLM system it may have certain fields validated before it is received fully into the system. If the form fails validation, an e-mail may also be sent back to the sender to explain why it could not be received.

This field holds the name of the text object that is used to store the title of that e-mail.

Reg Body Text:

Text Object for Body of e-mail Rejection

When an off-line e-mail is received back into the FLM system it may have certain fields validated before it is received fully into the system. If the form fails validation, an e-mail may also be sent back to the sender to explain why it could not be received.

This field holds the name of the text object that is used to store the body of that e-mail.

Portal Exit Text

This is the text object that contains the HTML that will be used to format the exit page after a form submission from an external URL launch.  If no text object is specified here, a default object is used. For further documentation and an example, please see the F1 help on the field itself.

8.1.6 Customer Code Parameters

// If the Customer is only maintaining one Customer Code than this step can be skipped.

The FLM framework needs to know for every FLM user which 3-digit FLM Customer Code that user should be associated with.  This is achieved in the user master record, by adding the parameter /FLM/CCODE to the user master record in the ‘Parameters’ tab, as shown below:

 

Any user that does not have this parameter maintained will take the default customer code set up in the FLM system; hence any FLM customer only maintaining one customer code is not required to maintain this parameter.

8.2 Define Form Categories

In this activity you define the set of available Form Categories in your system.  A Form Category is a logical grouping of Form Types that is used as a part of the user authorisation concept in FLM. You must define your form categories before you can begin creating logical forms via the FLM Form Wizard, as each form must be assigned to a 2-character category.

The groupings shown in the demo below are examples of typical form categories: ‘Purchasing’ ‘Human Resources’ and ‘Accounting’.

To create a new form category, go to ‘New Entries’ and define a two-character form category code with an associated description for each form category required. Form Category codes are only applicable for the customer code within which they were set up.

8.3 Define Form Statuses

This section displays all the available statuses that can be assigned to each form. A separate status is available according to customer code, description and category.

Form statuses refer to the stage of the workflow, or routing, that the form is in at any one time.

An initial status defines a form at the first stage of a routing, i.e. initial.

An intermediate status defines a form in the middle stages of a routing, e.g. approved, rejected, submitted, or approved

A final status defines the form at the end of a routing, e.g. End Of Routing

All statuses displays all available statuses        

You can create a new form status tag by going to the ‘new entries’ menu and entering new criteria for customer code, status code, description, and category. Once this new status has been created in this activity, it will then become available to select in the routing configuration table (see 1.3.2)

8.4 Define Form Actions

Form Actions list the options available to select the next position in the form routing, e.g. submit, approve, post etc. You can enter a new action by going to ‘new entries’ and entering a customer code, action code and description for each new action. Actions Y and Z are reserved and cannot be reassigned. All other letters of the alphabet are available to assign to different stages of a workflow as you wish. The stage names themselves are only suggestions and are completely customisable.

8.5 System Specific Settings

The System Specific Settings are not required for the initial configuration but it is advised that an entry be created for each system in the SAP landscape.

Certain parameters, such as hostnames, vary naturally between the different systems in the SAP landscape (development, quality, production). This configuration table provides a system-specific way to set those parameters. This avoids having to open up downstream system in order to make changes to configuration tables locally.

Begin by adding entries into this table, one for each System ID in your FLM landscape. Against each entry you can then make certain settings, detailed below, which can then be read locally against the local system ID by FLM (and customer code) to provide this necessary information.

  1. Select FLM Settings
  2. New Entry
  3. Enter the SID  of the system.
  4. Save
  5. Repeat for each system in the Landscape DEV->QAS->PRD etc...

8.6 Number Range /FLM/<Customer Code>

Each FLM customer is allocated a 3-digit customer code, for example ABC.  The customer must create a number range object in this case called /FLM/ABC.  Process:

  1. Transaction SNRO [es-en-ar-oh].
  2. Enter number range object name.
  3. Press create icon.
  4. Enter Short and Long Texts.
  5. In Number length domain enter CHAR10.
  6. Set the warning %, eg 5%.
  7. Press save.
  8. Ignore warning about buffering.
  9. Create a number interval. (e.g. 01 1000000000 – 199999999 – 100000000)
    1. Note: if FLM is being used on more than one SAP Client on the same Instance the interval should be <CLIENT>0000000 - <CLIENT>9999999 (e.g. 8110000000 - 8119999999).
  10. To create the number interval go to SNRO again
  11. Enter the name of the object you just created and click on “Number ranges”

8.7 Message Class /FLM/<Customer_Code>

The customer message class is used to store work instructions for your forms.  For example, message 001 could be ‘Please resubmit your form’.  The process for creating your message class is as follows:

  1. Transaction SE91.
  2. Enter message class /FLM/<Customer_Code>.
  3. Press create icon.
  4. Enter short text.
  5. Press save.
  6. Assign to package /FLM/CUST.
  7. Create a transport/assign to an existing transport.

8.8 Link Document Types

In this activity, you link your document types to the content categories as defined in the CMS in the previous step. You should create these entries:

File Type Description Category
XDP PDF Form Templates ZFLM0001
HTML HTML Form Templates ZFLM0001
XML Form Data ZFLM0002
ATT Attachments ZFLM0002
TXT Texts ZFLM0002
ANN Annotations ZFLM0002
SWF Flex Forms ZFLM0002
AR1 Archive - Form Data ZFLM0003
AR2 Archive - Attachements ZFLM0003
AR3 Archive - Annotations ZFLM0003

SPRO -> Cross-Application Componets -> General Application Functions -> Forms Lifecycle Manager -> Initialize Customer Code -> Initialize FLM System -> Link Data Types

The content repository was created during the installation phase 3.7 and can be found in transaction OAC0 (OH-A-C-Zero). We suggested the name be something like ZFLM0001 (templates) and ZFLM0002 (data)  but it could be anything. If in doubt contact the administrator who did the installation. 

From FLM 295sp2 onwards you should also link data types AR1, AR2 and AR3 for the forms archive system (these should always be linked to separate content repositories and content categories and physical tables from the main FLM tables).

8.9  Create Form Classes

Each FLM customer code and form stores its business logic in a series of form classes.  You must generate these classes (suggested initial number = 50) as part of the installation process.

When prompted for a development class [or package] choose ZFLM_FORM_CLASSES, as this will then allow you to transport these classes through the landscape.

Prior to FLM 295 SP2 you must manually activate the classes after the run.  Use transaction SE80 to do this, choose 'Inactive Objects' from the dropdown then shift-select from the list.

You can run this report subsequently if you run out of classes to add more space, and each time you have to transport the classes through the landscape.

8.10 Upload Master Templates

Use this activity to upload a master template into the FLM system. This can then be accessed by the form wizard to be used as a base template for a new form.

FLM bases all new forms on an existing master template (XDP or HTML), and so for each new customer code initialization these templates must be uploaded into the system.

For Interactive PDF Scenarios upload the XDP master template:

  1. If Interactive PDF Forms are not going to be developed then this template is not required.
  2. Navigate to transaction SPRO and Navigate to FLM in the Cross-Application Settings -> General Application Functions -> Forms Lifecycle Manager -> Initialize Customer Code -> Initialize FLM System -> Upload Master Template
  3. Upload file XDP Master FLM Template from the installation media folder.
  4. Press Execute and follow the on-screen instructions

For HTML based forms upload the HTML Master Structure:

  1. If HTML forms are not going to be developed then this template is not required.
  2. The distribution folder will contain a HTML Master Structure folder containing all the MIME objects that provide a framework of all the most common functions needed for developing HTML forms.
  3. To Upload the HTML Master Template.
    1. Navigate to transaction SPRO and Navigate to FLM in the Cross-Application Settings -> General Application Functions -> Forms Lifecycle Manager -> Interactive Forms -> Setup Forms -> Manage Form Resources
    2. In Manage Form Resources navigate to the Form Templates -> HTML Folder
    3. Right click on HTML and Upload
    4. Upload the FLM_FLM_XXXX_XX_XX.HTML file from the Templates -> HTML folder.
  4. To Upload the MIME objects into their corresponding folders.
    1.  Follow the steps above uploading the MIME objects from the HTML Master Structure folders to their corresponding folders in Manage Form Resesources.
      1. For example the images in the Images folder should be uploaded into the Images folder in the Manage Form Resources activity.

            TIP: There may be a Transports folder with transports that includes all the MIME objects.

 

8.11 Copy Standard FLM Javascript snippet library to local client.

FLM delivers a set of useful javascript functions into client 000. This report copies those entries into the local client.

SPRO -> Cross-Application Componets -> General Application Functions -> Forms Lifecycle Manager -> Initialize Customer Code -> Initialize FLM System -> One-Time Execution Programs -> Copy Standard FLM javascript library to local client.

8.12 Create JXXX Javascript Class

The JXXX class holds Javascript variables and is added to the /FLM/FTYPE_CLASS table. 

  1. OpenIMG activity SPRO ... Forms Lifecycle Manager -> Forms Optimization -> Javascript Management -> Define Dynamic Variables and create a Test entry.
  2. Select "Routine" to ensure the new class is generated properly.
  3. After saving, Delete the entry.

8.13 Test Form

At this phase you must setup a new test form to complete the customer code configuration and ensure the customer code is configured properly. Please see the Functional Test Sequence for more detail.

The first time a form is rendered on a EHP1/2 system you may get an error for form class: ZFLM_000n  this is due to the classes being exported from NW700 and Imported into 701. To fix this open the class in SE24 and Utitlities -> Clean Up -> Method Includes and then again Utilities -> Regenerate Sections.

You will have to do this for TS01 and DOC1 as well.

8.14 Upload TS01 Packages (optional)

After you have tested the system is running properly upload the TS01 form packages.  TS01 is a example time sheet form and the AUTODOC contains the template required for the auto documentation feature.

SPRO -> Cross-Application Componets -> General Application Functions -> Forms Lifecycle Manager -> Tools ->Form Transport Wizard

Follow the Timesheet (TS01) Demo Configuration for more details.

8.15 FLM Maintenance and Monitoring.

Please review the FLM Administrators Guide additional information regarding routine background jobs and monitoring.
 

9 Setting Up Offline (Email) Handling in FLM

FLM processing relies on e-mails in the following scenarios:

  • On-line forms: outbound notification e-mails
  • On-line forms: outbound reminder e-mails
  • Off-line forms: outbound e-mail with PDF attachment
  • Off-line forms: inbound e-mail with attachment processing
  • SAP Output: e-mail with PDF attachment

FLM utilizes the standard SAP email handling for outbound and inbound emails.

To test if the SMTP configuration is working follow the Offline Functional Test Sequence

9.1 Setting up Inbound Email (Offline) Processing:

Use the menu path Settings->Inbound processing.

Insert the Recipient Address for the address to which offline forms are to be returned. This is likely the Default Sender Addr in the FLM Cusotmer Code or the Sender Email defined FLM System Specific Settings. The Recipient Address will also likely need a rule on the corporate email network that forwards it to the SAP system via a Send Connector or other method.

Choose the exit ‘/FLM/EMAIL_HANDLER’ to process all inbound e-mails.

 

For more information on how to configure and test the SAP SMTP configuration please see: SAP SMTP (Offline) Configuration

 

10 Setting up QAS and PRD.

When you are ready to install FLM on your QAS and PRD systems please do the following:

  1. Ensure prerequisites have been met from Section 1.
  2. Install FLM .SAR files in SAINT Client 000 as described in Section 2.
  3. Import installation transports created for Section 3-8 .
  4. Create intervals in transaction SNRO for /FLM/TID and /FLM/<Customer_Code> in the correct client.
    1. Note: if FLM is being used on more than one SAP Client on the same Instance the interval should be <CLIENT>0000000 - <CLIENT>9999999 (e.g. 8110000000 - 8119999999).
  5. FLM Portal (Section 7)
    • Activate BSP settings for MUI Portal
    • or Install FLM WDPJ Portal .SCA file with JSPM and setup Java Connectors - with the Model Jco using SSO if available.
  6. If you are using an offline (email) scenario ensure that email is configured properly. (Section 9)
  7. If you are using web services that connect to SAP systems in your landscape be sure webservices are configured. (Section 3.9)
  8. Review the FLM Administrators Guide regarding routine background jobs and monitoring.

See the relevant sections above for more details.

11 Uninstallation of Varo (FLM).

 
As of Varo (FLM) version 300 un-installation of the FLM and FLMUI5 ABAP add-ons is supported using the standard SAINT methods.
 

Please see the following SAP Note for additional details: 2011192 - Uninstallation of ABAP add-ons

Before un-installation remove all objects under package /FLM/CUST.

Once the add-ons have been removed via the un-installation features in SAINT review the following Z packages for any objects created during the installation steps in the guide above that may need to be deleted from the system.

  • Package ZFLM_FORM_CLASSES
  • Package ZFLM_AUTHORIZATIONS