Introduction

This document describes the installation process for Floe release 200 and above.

For installation instructions covering older versions of Floe please see the Floe Installation Guide.

System Requirements

Arch Floe is installed as an ABAP Add-On into a SAP WebAS ABAP Stack.   

Please review the Floe System Requirements before attempting the installation steps below.

1. Performing the Installation of Floe

1.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.

For installations or upgrades use Add-On Installation Tool (transaction SAINT).

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

Load the software package:

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

1.2 SGEN

At this point you should compile Floe 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.

2 Post-Installation Configuration

2.1 ZFLOE Packages

Two packages are important for the configuration of the Floe system:

2.1.1 ZFLOE_CUST

This package is used to hold and transport the business logic associated with customer e-mails.

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

2.1.2 ZFLOE_AUTHORIZATIONS

This package is used to hold the FLOE authorization object (see section 3.1).

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

2.2 Content Management

Floe uses the 'Content Management System' [CMS] or 'Content Server' to optionally store sent e-mails and their attachments.  From version 210 onwards it is also used to store files that can be attached to emails via configuration. The setup of CMS is SAP standard.

2.2.1 Content Management Table

The standard Floe 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 a physical table for that purpose.

1. Transaction SE11.
2. Select the radiobutton 'Tables' and enter table SDOKCONT1. (Those are OHs)
3. Copy this table to ZFLOE_CMSCONT1, assigning package ZFLOE_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.

Floe supports only the SAP Database CMS repository type.

2.2.2 Content Repository

In this Activity, you can define content repository. Floe only supports using the 'SAP System Database' type of repository.

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.

Floe Content Repository:

1. Transaction OAC0 (OH-A-C-Zero).
2. Change - Create
3. Content Rep. : We suggest “ZFLOE001”
4. Description: Floe: Email Content Repository
5. Document Area:  FLOE E-mail Content
6. Storage type: SAP System Database
7. Version No.: 0046
8. Contents Table: ZFLOE_CMSCONT1 (table created in step 2.2.1)
9. Save

2.2.3 Content Category

In this activity you assign the storage category to a 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.

Floe Content Category:

1. Transaction OACT (OH-A-C-T).
2. New Entries
3. Category: We suggest “ZFLOE001”
4. Description: Floe: Content Category
5. Document Area: "/Floe/"
6. Content Repo: ZFLOE001 (repository created in step 2.2.2)
7. Save

2.3 Number Range Intervals

The following number range objects are delivered with Floe and a new interval range must be setup for them:

The Floe Email ID (/FLOE/EID) number range

1. In transaction SNRO create a new number range interval for object /FLOE/EID
2. Create Interval Range '01'. E.g 01 000000001 – 9999999999
3. Save and create the internal in each system.

The Floe HTML Block (/FLOE/HID) number range

1. In transaction SNRO create a new number range interval for object /FLOE/HID
2. Create Interval Range '01'. E.g 01 000000001 – 9999999999
3. Save and create the internal in each system.

The Floe Attachment ID (/FLOE/ATID) number range (versions 210 and above only)

1. In transaction SNRO create a new number range interval for object /FLOE/ATID
2. Create Interval Range '01'. E.g 01 000000001 – 9999999999
3. Save and create the internal in each system.

2.4 Create Class for Variable Routines

Global variable logic is stored in generated variable routines which are created in class ZFLOE_VARIABLE_ROUTINES.  This class must be manually created.

1. Transaction SE24.
2. Enter Object type: ZFLOE_VARIABLE_ROUTINES
3. Press Create button
4. Select Object type 'Class' and return.
5. Add description 'Floe Variable Routines' and return (Save).
6. Assign package ZFLOE_CUST and Save.
7. Assign workbench request and return.
8. Select 'Activate' pushbutton and return through the pop-up screen.
9. Exit.

2.5 SMTP outbound settings

Ensure that SAPconnect is configured to send outbound e-mails through transaction SCOT.

Refer to standard SAP documentation if there is no SMTP node defined under the 'INT'

2.6 Setup inbound email processing

Version 210 (and later) offers inbound email/decission capture functionality. This requires inbound processing configuration.

In transaction SCOT, go to Settings->SMTP Connection->Inbound Messages->Inbound Processing and create the following entry:

• Communication Type: Internet Mail
• Recipient Address: The address to which inbound FLOE emails are to be sent.
• Document Class: *
• Exit Name: /FLOE/INBOUND_HANDLER

Next, in transaction se38 run program RSCONN06  and make sure that for Incoming E-Mails, the radio-button is set to either "Always Save" or to "MIME Message Header" and click "Execute".

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

You must also maintain the Inbound Specific System Settings (see section 4)

2.7 Setup a SAP Gateway System Aliases to FLOE OData Service

1. In transaction SM30 open View /IWFND/V_MGDEAM
2. Use the drop down in the Service Doc. Identifier to add /FLOE/APP_SERVER_SRV_0001
   1. 
3. Save and Transport.

2.8 Activate SICF Nodes

Activate the following SICF Nodes.

1. Transaction SICF.
2. Enter *FLOE* into Service Name field
3. Press Execute
4. Right-click and select Activate for all FLOE nodes
   1. /sap/opu/odata/floe/app_server_srv
   2. /sap/bc/ui5_ui5/floe/ebuilder
   3. /sap/bc/ui5_ui5/floe/ebuildercloud
   4. /sap/bc/bsp/floe/ebuilder
   5. /sap/bc/bsp/floe/ebuildercloud

2.9 Upload the default Floe email template

1. In transaction SPRO go to Cross Application Components -> General Application Functions -> Floe
2. Open activity Maintain HTML Blocks and select New Entry to add a new HTML Block "FLOE200_DEFAULT_TEMPLATE_1" with block type: Template.
   1. 
3. Save and add to transports.
4. Select the new block and open HTML Block Content
5. Add a New Entry.  HTML Block Code: FLOE200_DEFAULT_TEMPLATE_1,  Language: EN.
6. Select Edit Block Content to open the code editor and copy-paste the content of the FLOE_DEFAULT_TEMPLATE file included with the distribution.
7. Save and add to transport.

3 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.

Floe 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.

3.1 Authorization Object

Two authorization fields are delivered as part of Floe:

/FLOE/ECAT   Email Category
/FLOE/ETYP   Email Type

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

Floe is not shipped with an authorization object.  Part of the installation process involves the creation of authorization object ‘z/floe/001’.

Creating an Authorization Object

1. Transaction SU21 or menu path ‘Tools->ABAP Workbench->Development->Other tools->Authorization objects->Objects’
2. Choose the pushbutton for create authorization object.
3. Enter the following:
   • Object: ‘z/floe/001’
   • Text: ‘Floe: Email Authorization Object'
   • Class: ‘AAAB’
   • Field name: /FLOE/ECAT
   • Field name: /FLOE/ETYP
   • Field name: ACTVT
4. Select pushbutton to maintain the permitted activities. Use ZFLOE_AUTHORIZATIONS for the package.
5. Select options
   1. 01 (Create or Generate): This activity is required to send emails
   2. 03 (Display): This activity is required to display emails in the "Email History" and "Inbound Log" transactions
   3. 23 (Maintain): This activity is required to maintain emails in the "Floe Designer" application
   4. 36 (Extended Maintenance): This activity is required to maintain library blocks, to upload files to the attachment repository and to create new email types in the "Floe Designer" application.
   5. Select Save
6. Select pushbutton to create documentation, then save
7. Save the authorization object. You may get a message indicating it has already been saved, if so just cancel out of the maintenance window.
8. 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.

3.2 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’.

3.2.1 Floe Developer Role

1. Transaction code PFCG or select the menu path ‘Tools->Administration->User Maintenance->Role Administration->Roles.’
2. Enter role name ‘ZFLOE_DEVELOPER’ and choose the ‘Single Role’ pushbutton.
3. Enter the role description then Save
4. Select the Authorizations tab
5. In the ‘Information About Authorization Profile’ box, select the ‘Propose Profile Names’ pushbutton, and a profile name is generated automatically. Save.
6. Select the Change Authorization Data pushbutton.  A pop-up window is displayed.  Select the ‘Do not select templates’ pushbutton. 
7. Now select the ‘Manually’ pushbutton, and enter the authorization object ‘z/floe/001’.
8. 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.
9. Select the Manually’ pushbutton again, and enter the authorization object S_TCODE
10. Expand the Tree out and select the Change Transaction code button.
11. Enter ‘/FLOE/*’ into the ‘Form’ field as shown. This is granting authority for ALL /FLOE transactions to the ZFLOE_DEVELOPER role.
12. Generate. (Save)

Role ZFLOE_DEVELOPER is now ready to be linked to existing developer users, who will also require transactions SE24, SLG1, ST22, SE10, SE16, SE91, SO10, SM30, SM34, SPRO, SOST, SCOT

3.2.2 Floe User Role

Follow the same steps as for setting up the ZFLOE_DEVELOPER role, but in the final step, limit the role by email category, e-mail type and /or /FLOE transaction code.

For example, if stored e-mails contain sensitive information, then limit access using the e-mail type and activity '03'.

Activity 01 is required to trigger a new e-mail, so this must be added to profiles for any dialogue or background users who use transactions or programs to trigger Floe e-mails. 

3.3 Assign Authorization Groups to /FLOE/ tables for customizing access

Optionally, the delivered Floe tables can be assigned to an authorization group in transaction SE54 to control access.

However, most Floe configuration tables will only be maintained in a Development system, so in general this step will not be required.

The following tables should be maintained in the development system only:

• System settings: /FLOE/SETTINGS
• Variables: /FLOE/VARS & /FLOE/VARST
• Email Categories: /FLOE/ECAT & /FLOE/ECATT
• HTML Blocks: /FLOE/HBLOCK & /FLOE/HBLOCKT & /FLOE/HBLOCKC
• Email Types: /FLOE/ETYPE & /FLOE/ETYPET & /FLOE/ETYPET

The Safe Recipients Table should be maintainable in any non-productive system, as entries are local to that system:

• Safe Recipients: /FLOE/SAFE_REC

The Recipients List Tables should be maintainable in any system:

• Recipients Lists: /FLOE/RLIST & /FLOE/RLISTT & /FLOE/RLISTC

In order to maintain the Recipients Lists, these tables can be added to an existing Authorization Group to enable business users to maintain those tables.

3.4 OData Service Authorization

In order for users to use the Floe designer application, they must have authorization for the underlying oData service. To add this to an existing role, you can do the following:

• Add authorization object s_service to the role

• Click on the “change” button next to “Program, transaction or functi”:

• Select “TADIR Service” in the “Type” drop-down and add the following two entries: 
  R3TR    IWSG   /FLOE/APP_SERVER_SRV_0001 
  R3TR    IWSV    /FLOE/APP_SERVER_SRV               0001

More information can be found here and here.

4 Floe System Settings

The final set-up step is to set the Floe System Settings.

In the SAP IMG (transaction SPRO), navigate to the Floe customizing menu

SAP Customizing Implementation Guide -> Cross-Application Components -> General Application Functions -> Floe -> Administration -> System Settings

6 Install License Key