Apparo Fast Edit installation & configuration fileApparo Gateway (Apache Webserver) and Apparo Application Server (Apache Tomcat) Apparo Repository . 6 / 37 1.7 Overview installation

1 / 37

Installation Guide

Apparo Fast Edit

MS Windows / SAP BusinessObjects

Version 3.0.7

2 / 37

1 Prior to Installation _____________________________________________________ 3

1.1 Hardware requirements __________________________________________________ 3

1.2 Supported operating systems ______________________________________________ 3

1.3 Supported SAP BusinessObjects versions ____________________________________ 3

1.4 Supported security systems _______________________________________________ 3

1.5 Supported virtual environments ___________________________________________ 3

1.6 Architecture ____________________________________________________________ 4

2. Preparation ________________________________________________________ 7

2.1 Creation of an database user for the Apparo Repository ________________________ 8

2.2 Defining the Launch Pad folder for the Apparo Designer entry ___________________ 9

2.3 Shared Secret _________________________________________________________ 10

3 Installation _________________________________________________________ 13

3.1 License agreement _____________________________________________________ 14

3.2 Selection of the architecture _____________________________________________ 15

3.3 Defining the target file directory __________________________________________ 16

3.4 Carrying out the installation ______________________________________________ 17

3.5 Installation finish_______________________________________________________ 17

4 Configuration _______________________________________________________ 18

4.1 Architecture ___________________________________________________________ 21

4.2 Application Server ______________________________________________________ 21

4.3 SAP BusinessObjects ____________________________________________________ 22

4.4 File system paths _______________________________________________________ 22

4.5 22

4.6 Web security system ____________________________________________________ 24

4.7 eMail security system ___________________________________________________ 24

4.8 Repository ____________________________________________________________ 25

4.9 License key ___________________________________________________________ 26

5 Creating the Apparo Designer entry in SAP BusinessObjects Portal ____________ 27

6 Installation clients ____________________________________________________ 30

7 Using Sybase ASE / IQ / Anywhere as data source __________________________ 33

7.1 Usage of the right Sybase IQ driver ________________________________________ 33

8 Unattended configuration ______________________________________________ 34

Importing definitions _________________________________________________________ 34

Exporting definitions _________________________________________________________ 35

9 Using MSSQL 2005 and Windows Authentication __________________________ 36

10 Support ___________________________________________________________ 37

3 / 37

1 Prior to Installation Installing Apparo Fast Edit can be done in 30 minutes if you prepare your environment. Please be aware of the following points before starting installation: 1.1 Hardware requirements

File system about 500 MB

Main Memory about 1000 MB 1.2 Supported operating systems

Windows 2008/2012 (64 Bit) 1.3 Supported SAP BusinessObjects versions

SAP BusinessObjects Enterprise 4.0 / 4.1 / 4.2

1.4 Supported security systems

All security systems that are currently in use for SAP BusinessObjects

1.5 Supported virtual environments

VMware ESX, ESXi

VMware Player

Apparo Fast Edit must be installed using a local Windows administrator account.

SAP BusinessObjects must be already installed and running.

4 / 37

1.6 Architecture The following architecture is possible

Single Instance The already installed SAP BusinessObjects-environment is completely installed on one host and Apparo Fast Edit shall be installed on the same host. Single Instance can be used for the test and development environments. This document describes the installation of a single instance architecture.

Multi Instance The already installed SAP BusinessObjects-environment is installed on several hosts or Apparo Fast Edit shall be installed on a different host. Multi Instance is suitable for higher performance and availability. If you want to install a multi instance architecture, then this document is NOT suitable. Please refer the installation cluster document.

5 / 37

You can find a more detailed architecture document within the setup file. Single-Instance architecture:

Client Client Client

Apparo Gateway (Apache Webserver) and Apparo Application Server (Apache Tomcat)

Apparo Repository

6 / 37

1.7 Overview installation steps

Preparation Optional: Creation of a database user for the Apparo repository Defining the SAP BusinessObjects folder for the Apparo Designer entry

Installation Starting setup file for installation

Configuration of the Apparo Gateway and the Apparo Application Server The Apparo Gateway is the interface between the users web-browser and the Apparo Application Server Using Apparo Configuration Manager to configure the installation

Creating the Apparo Designer link in SAP BusinessObjects Portal Creating the start entry of Apparo Designer

Installing clients

7 / 37

2. Preparation

Preparation Optional: Creation of an database user for the Apparo Repository Defining the SAP BusinessObjects folder for the Apparo Designer entry

Installation Starting setup file for installation of the files



Installing clients

8 / 37

2.1 Creation of an database user for the Apparo Repository Apparo Fast Edit requires a database repository. In this repository all of your definitions are stored. Following databases are supported:

Oracle 10g-12c

IBM DB2 9-10.5

MS SQL Server 2005-2014

Internal database (for test and development systems)

This database user must be defined before starting the Apparo Fast Edit setup, except you want to use the internal database. You can find a detail description in the document “Installation – creating database user“.

Essential grants:

The database user must be able to create database tables

A Login with this user must be possible

9 / 37

2.2 Defining the Launch Pad folder for the Apparo Designer entry Create a new folder in BI Launch Pad in that you can define later the Apparo designer entry:

10 / 37

2.3 Shared Secret Open the „Central Management Console“ of SAP BusinessObjects:

11 / 37

Choose „Enterprise“:

d Enable „Trusted Authentication is enabled“:

12 / 37

Press button „New Shared Secret“

Press button „Update“.

Press button „Download Shared Secret“

Open the downloaded file in a text editor

Copy the shared secret

13 / 37

3 Installation

Preparation

Optional: Creation of an database user for the Apparo Repository

Defining the SAP BusinessObjects portal folder for the Apparo Designer entry




Installing clients

14 / 37

Start the Installation by executing the file for a Windows 64 bit environment: FastEdit3.x.x.x_yyy_win64_tomcat_sapbo.exe

Confirm the beginning of the installation by clicking „Next“. 3.1 License agreement

Read and confirm the license agreement by clicking „I Agree“.

15 / 37

3.2 Selection of the architecture

Please select ‘Single Instance’

16 / 37

3.3 Defining the target file directory

The default file directory is: C:\Program Files\Apparo Please define the path and choose „Next“.

17 / 37

3.4 Carrying out the installation Finally the installation of Apparo Fast Edit with the selected architecture will start. After that this installation must be configured with the Apparo Configuration Manager.

3.5 Installation finish

Now it’s time to configure the installation with the Apparo Configuration Manager. Click „Finish" for completing the installation and to start the configuration.

18 / 37

4 Configuration

Preparation


Defining the SAP BusinessObjects folder for the Apparo Designer entry




Installing clients

19 / 37

With the Apparo Configuration Manager you are able to configure the already installed Apparo Fast Edit. The settings are grouped into chapters (left side). For each setting you can read a helpful description text in the yellow box.

The settings are grouped into several chapters (left side). All settings are described in the bottom of the window. After you have been done, you can check the settings with the ‘Test Configuration’ button. Now you are ready to start it with the ‘Start Fast Edit’ button.

20 / 37

To do list:

Define all settings

Press the „Test Configuration“ button for testing all settings.

Press the „Start Fast Edit“ button for starting the application server

You can see the log file of the application server with pressing „Show Log“ If the application server is running then you can see in the log: 2015-11-09 02:37:41,831 INFO com ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + Apparo Fast Edit 3.0.x (Build nnn) was successfully started at 11.09.2015 02:37:41 + ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

The configuration of Apparo Fast Edit is stored in file configuration.xml in file directory [APPARO_HOME]\FastEdit\cm . If you plan a parallel/cluster system then it’s sometimes comfortable to copy this file into the target system. If you open the Apparo Configuration Manager then you will see the same configuration settings like of your source system and it’s possible to change it comfortable. Test of an Apparo application server: http://<applicationserver:<Communication port>/apparo/pages/apptest.xhtml Example: http://server1:9800/apparo/pages/apptest.xhtml With this URL you can test if the Apparo application server is running fine or has problems.

http://server1:9800/apparo/pages/apptest.xhtml

21 / 37

4.1 Architecture In this section of the Configuration Managers you can find the selected Apparo Fast Edit architecture. This architecture was defined at installation time and is not changeable now.

4.2 Application Server Settings for the application server, for example main memory.

22 / 37

4.3 SAP BusinessObjects Settings for the already installed SAP BusinessObjects environment:

4.4 File system paths File directories for the server side scripts and user defined Java classes for testing:

4.5

It is important that the Windows system user or the user that is running the Windows Service of Apparo Fast Edit has write and read access to these file directories.

23 / 37

24 / 37

4.6 Web security system The SAP BusinessObjects group/role that is necessary to have full access in Apparo Designer. If no security group is defined then everybody can do everything with Apparo Designer.

4.7 eMail security system The Excel import using eMail feature need an own security system because it is not part of the SAP BusinessObjects security.

25 / 37

4.8 Repository The database connection to the Apparo repository: For testing the internal database is possible.

26 / 37

4.9 License key In this section you can add & change the license key. This key is necessary to run Apparo Fast Edit.

27 / 37

5 Creating the Apparo Designer entry in SAP BusinessObjects Portal

Preparation


Defining the SAP BusinessObjects Connection folder for the Apparo Designer entry




Installing clients

28 / 37

With the Apparo Designer you can create new business cases, new database connection and so on. The Apparo Designer can be started with selecting an entry in SAP BusinessObjects portal. Open Windows Start button, select Apparo chapter, select entry “Designer link” Now a text file is opening:

Copy the complete generated URL entry. Login into SAP BusinessObjects portal using one of the user names which has design rights for Apparo Fast Edit (default: everybody can open the Apparo Designers) Go to your folder in that that the Apparo Designer entry must be stored to (the same folder like defined in Apparo Configuration Manager): Create a new link entry in SAP BusinessObjects portal and paste the complete URL into the URL setting:

29 / 37

Now try to start the Apparo Designer – just select the “Apparo Designer” entry. The following window should open:

If you get the message “You have insufficient privileges” then you must add the current user into the security group that is necessary to be able to open the Apparo Designer.

30 / 37

6 Installation clients

Preparation

Optional: Creation of an database user for the Apparo repository

Defining the SAP BusinessObjects portal folder for the Apparo Designer entry




Installing clients

31 / 37

Now it is necessary to install the clients.

Please read now the document “Configuration Guide” for defining/importing clients.

32 / 37

The installation & configuration is now

successfully completed.

Take the document “First Steps / Training guide” for the fundamental usage and then the movies for the first steps. You can find all documentations in Start (left corner) / All Programs / Apparo / Documentation

33 / 37

7 Using Sybase ASE / IQ / Anywhere as data source If you want to use Sybase ASE / IQ / Anywhere as data source, you must configure the master database for the usage of the Sybase ASE / IQ / Anywhere JDBC driver. You will find the original Sybase ASE / IQ / Anywhere files in: [APPARO_HOME]\etc\Sybase_JDBC\jConnect-7_0\sp Depending on the used database version you have to run the matching script in the master database:

sql_server.sql - installs stored procedures on Adaptive Server earlier than version 12.0.

sql_server12.sql - installs stored procedures on Adaptive Server 12.0.x.

sql_server12.5.sql - installs stored procedures on Adaptive Server 12.5.x.

sql_server15.0.sql - installs stored procedures on Adaptive Server 15.0.x through 15.5.x.

sql_server15.7.sql - installs stored procedures on Adaptive Server 15.7 or later.

sql_asa.sql - installs stored procedures on SQL Anywhere 9.x.

sql_asa10.sql - installs stored procedures on SQL Anywhere 10.x.

sql_asa11.sql - installs stored procedures on SQL Anywhere 11.x.

sql_asa12.sql - installs stored procedures on SQL Anywhere 12.x. 7.1 Usage of the right Sybase IQ driver You can select the right driver in the file in cm\input\afe.properties with these entries: # Sybase JDBC driver - version 6 or version 7 can be used. # Jconnect 6: For Sybase IQ version less or equals than 15.2 jdbc.sybase.driver=com.sybase.jdbc3.jdbc.SybDriver # Sybase JDBC driver Jconnect 7: For Sybase IQ version 15.4 and higher #jdbc.sybase.driver=com.sybase.jdbc4.jdbc.SybDriver Depending on the driver you have to use, it has to be activated. Uncomment the driver for your version and put a ‚#‘ in front of the driver you don’t have to use. Finally restart AFE in the Configuration Manager by pressing the ‚Start Fast Edit‘ button.

34 / 37

8 Unattended configuration You can export and import clients (including languages, folder, Business Cases, connections, and DB-messages), Business Cases, folder and connections using scripts. Importing definitions

Important: At this time the Apparo Fast Edit application must already run.

The import program is stored in the file directory “import”: [APPARO_HOME]\FastEdit\import Use script afe-import.bat (If you start the script without arguments then you see the possible arguments) -afeUrl <URL> The Apparo Fast Edit URL address that will export the data.

Example: http://localhost:9800/apparo If you don't use this argument then the export is using the application server of this installation and its installation port.

-clientId <CLIENT_ID> ID of a client that Business Cases, language definitions, database messages or connection definitions will be imported into.

-f <FILE> The file that contains the client, Business Case, language definition, database messages or connection definitions. -h Displays this help text -importSecurity <true|false> Business cases and folders may contain a list of user groups defining who can access them. If this option is set to false, such

security information will not be imported. -overwriteBc <true|false> If true then Business Cases from the import file will overwrite already existing Business Cases if their Business Case ID are the same. If false, Business Cases with such conflicting identifiers will be skipped. -overwriteClient <true|false> If true then clients from the import file will overwrite already

existing clients with the same identifiers including client content like Business Cases. If false then clients with such conflicting identifiers will be skipped.

-overwriteConnection <true|false> If true then database and email connections from the import file will overwrite already existing connections with the same names. If false then connections with such conflicting names will be skipped. All import activities are logged server side in file directory logs, file afeimport.log Sample: afe-import.bat –f \etc\definition.xml

35 / 37

Exporting definitions The export program is stored in the file directory “export”: [APPARO_HOME]\FastEdit\export Use script afe-export.bat If you start the script without arguments then you can see the possible arguments: -afeUrl <URL> The Apparo Fast Edit URL address that will export the data. Example: http://localhost:18000/KFE. If you don't use this argument then the export is using the application server of this installation and its installation port. -bcid <BUSINESS_CASE_ID> ID of a Business Case you want to export. -clientId <CLIENT_ID> ID of a client you either want to export or an ID of a client the target object (Business Case, folder or connection) belongs to. -dbc <CONN_NAME> Name of a database connection you want to export. -emailc <CONN_NAME> Name of an email connection you want to export. -f <FILEPATH> Filename & path where to write the exported XML. -folderPath <PATH> Path of a folder you want to export. It should start with a slash character '/' which should also be used as a path separator. -h Displays this help text All export activities are logged server side in file directory logs, file afeexport.log Sample: fafe-export.bat –f \etc\definition.xml -clientId DemoClient

36 / 37

9 Using MSSQL 2005 and Windows Authentication Unfortunately the required drivers for MSSQL 2008+ are not compatible to those which are required to use the Windows authentication feature for MSSQL 2005. If you want to use this feature with your MSSQL 2005 database server you have to apply the following changes:

Please open the folder: [Apparo-Home]\FastEdit\tomcat\webapps\KFE\WEB-INF\lib Rename the files: sqljdbc4.jar.sql2005 to sqljdbc4.jar sqljdbc4-4.2.6420.100.jar to sqljdbc4-4.2.6420.100.jar.sql2008 After that, please restart Apparo Fast Edit. Now you can use MSSQL 2005 connections & windows authentication.

37 / 37

10 Support If you need support please write an email to: [email protected]

mailto:[email protected]

Documents

Apparo Fast Edit installation & configuration fileApparo Gateway (Apache Webserver) and Apparo Application Server (Apache Tomcat) Apparo Repository . 6 / 37 1.7 Overview installation