aquiller technical guide - arch

Aquiller Technical Guide Installation

Copyright

Arch Consulting

Aquiller Technical Guide – Installation Manual

of 31

Table of Contents

1. Introduction .................................................................................................................................... 4

2. Prerequisites for installing Aquiller ................................................................................................. 5

3. Preparation for installing Aquiller ................................................................................................... 7

4. Installing Aquiller ............................................................................................................................ 8

SAINT ........................................................................................................................................... 8

Apply Aquiller Notes .................................................................................................................... 8

SGEN ............................................................................................................................................ 8

5. Post Installation Configuration ....................................................................................................... 9

Creating Aquiller Package in Z Namespace................................................................................. 9

Linked FLM Customer Code for Aquiller ...................................................................................... 9

Namespace Configuration......................................................................................................... 10

Number Range Objects Configuration ...................................................................................... 11

Aquiller Content ID .................................................................................................................... 11

Aquiller Template ID .................................................................................................................. 12

Aquiller Letter ID ....................................................................................................................... 13

SICF Settings .............................................................................................................................. 14

6. RFC Destination Configuration ...................................................................................................... 15

Super User Connection .............................................................................................................. 15

Real User Connection ................................................................................................................ 15

7. Webservices Configuration ........................................................................................................... 18

8. Authorization Object ..................................................................................................................... 19

Overview ................................................................................................................................... 19

Authorization Object creation ................................................................................................... 20

Roles .......................................................................................................................................... 21

Creating an Aquiller Super User Role ........................................................................................ 21

9. Functional and Technical Settings ................................................................................................. 23

Linking Document Type to CMS ................................................................................................ 23

Define Correspondence Categories ........................................................................................... 23

Define Classification Data for Content ...................................................................................... 25

Define Classification Data for Template ................................................................................... 26


of 31

Maintain Customer Code .......................................................................................................... 27

Define System Specific Settings ................................................................................................. 28

Define Infotypes relevant for Aquiller ....................................................................................... 29

Upload Master Stylesheet Template ......................................................................................... 30

Load Infotype Metadata ........................................................................................................... 31


of 31

1. Introduction

This document describes the installation process for Aquiller Release 120 SP2.


of 31

2. Prerequisites for installing Aquiller

The Aquiller SAP Add-On is installed onto the WebAS ABAP using the normal SAP SAINT

transaction. The support WebAS release must be at least NW7.0* [NW2004s] or higher

which also includes NW 731 and 740.

For additional information, see the FLMConnect System Requirements page.

SAP system configuration on the host system must include an Adobe Document Services

(ADS) connection in order to render PDFs (see here for the SAP documentation on how to do

this) and also SSL in order to encrypt the traffic transmitted between the client application

and the SAP server (see here for the SAP documentation on how to do this).

Note

Forms Lifecycle Manager (FLM) 295 SP3 ABAP Add-On must be installed and configured

before installing Aquiller 120 SP2.

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

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.

The Aquiller ABAP Add-On must be installed on NW 700 SP15 or higher and have the

following SAP Notes applied. NetWeaver 70* systems include NW 731 and 740 are

supported.

The software is built at Service Pack 24 (NW2004s). Certain SAP Notes may be required to

be applied either before or after the installation which is covered in the Installation Guide.

NW 700 SP20 and below - Apply the following SAP Notes for FLMCG

WSDL

1378391

1230235

NW 740 SP06 and below - Apply the following SAP Note to resolve

SAPFAult errors 1922155

Before starting the installation, read the following SAP Notes and documentation:

Description Note

Problems w/add-on inst/upgrade to SAP NW 7.0s ABAP 822380

Known Problems with Support Packages in SAP NW 2004s AS

ABAP

822379

The following software components are required in your system:

http://help.sap.com/saphelp_nw70ehp2/helpdata/en/37/504b8cbc2848a494facfdc09a359b1/content.htm

http://help.sap.com/saphelp_nw70ehp2/helpdata/en/52/31683ab81fd846e10000000a11402f/content.htm


of 31

SAP_ABA 700

SAP_BASIS 700


of 31

3. Preparation for installing Aquiller

1. Mount the Add-On Installation Media.

2. Unpack the archive FLMCG_INST_<VER>.SAR in the subdirectory DATA using the

command:

sapcar –xvf FLMCG_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.

Note

Steps 2-4 can also be done in SAINT:

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

For Service Packs you would use the same method but via the SPAM tool instead.

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.


of 31

4. Installing Aquiller

This section describes the installation procedure for the software.

If you are updating a pre-existing installation of Aquiller be sure to first backup all your

forms by exporting all the unedrlying FLM forms in the system on a form-by-form basis (one

at a time) including business logic.

SAINT

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

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

Apply Aquiller Notes

1. Apply any relevant Aquiller Notes. These will be posted onto this wiki as they

become available, under the menu option 'Aquiller Notes'.

SGEN

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

Note

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

Check for any additional upgrade notes.


of 31

5. Post Installation Configuration

Note

FLM Customer code has to be created and SysDefault checkbox should be selected before

proceeding with the step below - Refer section Maintain Customer Code for more

information and steps to follow.

Creating Aquiller Package in Z Namespace

Create an Aquiller package in Z namespace for Z space objects eg., ZAQUILLER.

This package is used to hold objects that cannot be maintained in the /FLMCG/ 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 ZAQUILLER and select Create.

3. Short Description: Aquiller: Authorization Objects

4. Application Component: CA

5. Software Component: HOME

6. Transport Layer: Customer Specific, Default SAP.

7. Save

Linked FLM Customer Code for Aquiller

This customer code is used by Aquiller to store various global parameters within the Aquiller

system.

1. Navigate to transaction SPRO and to Aquiller in the Cross-Application Settings ->

General Application Functions -> Aquiller -> Global Settings -> Functional Settings -

> Initialize Aquiller System -> Create Linked FLM Customer Code

2. Click New Entries and define a 3 Character XXX code and enter description. Make

sure SysDefault check box is *not selected* for this customer.


of 31

Namespace Configuration

Aquiller framework generates Data dictionary objects in the namespace /FLMCG/. Therefore

this namespace must be set to ‘modifiable’.

1. Transaction SE03 [ess-ee-zero-three].

2. Choose ‘Set System Change Option’.

3. Navigate in the ‘Software Component’ Table to Aquiller(Software Component)

FLMCG(Technical Name).

4. Choose ‘Modifiable’.

5. Navigate in the ‘Namespace/Name range’ Aquiller(Software Component)

FLMCG(Technical Name).

6. Choose ‘Modifiable’.

7. Save the settings.


of 31

Number Range Objects Configuration

Aquiller uses number range objects to manage content and templates created using the

frontend flex application.

Aquiller Content ID

The Aquiller Content ID (/FLMCG/PID) number range object that manages Content is

delivered with Aquiller and a new interval range must be setup in it.

1. Transaction SNRO [es-en-ar-oh].

2. Enter number range object name (/FLMCG/PID).

3. Press Number Range button.

4. Press change Intervals.

5. Click add interval.

6. Create an Interval. - 01 100000000 – 1999999999.

1. If using multiple SAP Clients in the same systems use the Client number at the

begining of the Internal. This will help quickly identify which client is the

source of a particular form.

1. Example: 01 501000000 – 5019999999

7. Press add interval.

8. Press save.


of 31

Aquiller Template ID

The Aquiller Template ID number range object firstly has be to created and then a new

interval range inserted.


2. Enter (/FLMCG/<3 Character Aquiller Customer Code> *Not FLM Customer

Code*) in the number range object name field.

3. Press create icon.

4. Enter Short and Long Texts.

5. In Number length domain enter NUMC4.

6. Set the warning %, eg 5%.

7. Assign the object to /FLMCG/CUST package when prompted.

8. Ignore warning about buffering.

9. Press save.




13. Create a number interval - 10 1000 - 9999.


15. Press save.


of 31

Aquiller Letter ID

*Note* This step can be skipped if number range in FLM namespace has been defined

already - applies to existing FLM customers. Aquiller allocates numbers from the FLM form

id range.


2. Enter (/FLM/<3 Character linked FLM customer code for Aquiller created above

in 3.1>) in the number range object name field.

3. Press create icon.

4. Enter Short and Long Texts.

5. In Number length domain enter CHAR10.

6. Set the warning %, eg 5%.

7. Assign the object to /FLM/CUST package when prompted.

8. Ignore warning about buffering.

9. Press save.




13. Create a number interval - 01 1000000000 - 9999999999.


15. Press save.


of 31

SICF Settings

Aquiller makes use of a number of webservices and business server pages to establish the

communication channel between the user frontend and SAP backend. These Webservices and

BSPs have to be activated in SICF. Proceed as follows:

1. Transaction SICF.

2. Enter *FLMCG* into Service Name field

3. Press Execute

4. Right-click and select Activate all FLMCG nodes under default_host->sap->bc->bsp .

5. Right-click and select Activate all FLMCG nodes under default_host->sap->bc->srt-

>rfc.

6. Make sure the parent and all child nodes are active.

Note

There are certain standard BSP service nodes that must activated as a pre-requisite for using

any BSP application. Consult SAP Note 517484 for details


of 31

6. RFC Destination Configuration

Super User Connection

This connection is used for system level background processing and accessing data from

HCM system.

1. Transaction SM59.

2. Press create a new connection icon

3. Define RFC Connection name <Name>_super

4. Connection Type - 3

5. Enter description

6. Enter Target Host - (Location of HR system) followed by system number.

7. Select Logon & Security tab and fill in System user logon credentials in the Logon

section. (Make sure the system user has all relevant authorizations to perform super

user activity)

8. Press Save

Real User Connection

Note

This step should be skipped for single system installation where Aquiller and HCM are on the

same system.


of 31

This connection uses logged in user credentials to process Aquiller letters and to access data

from HCM system. In order for this to work where the HCM system is on a remote server,

the two servers must have a Trust Relationship configured. See the sap documentation for

how to configure this before you continue (note// as of EHP2, ie 702, an installation number

is also required to complete this configuration - see note 1361211 ).

1. Transaction SM59.

2. Press create a new connection icon

3. Define RFC Connection name <Name>_real

4. Connection Type - 3


6. Enter Targer Host - (Location of HR system) followed by system number.

7. Select Logon & Security tab and check Current User checkbox.

8. Press Save.

http://help.sap.com/saphelp_nw70ehp2/helpdata/en/22/042671488911d189490000e829fbbd/frameset.htm


of 31

Client No: Enter the ABAP client where your Aquiller data is stored.

Port No: See instructions above for 'Group Server' and take the port number from

the popup URL, port 8000 in the example above.

Binding Key: Click open WSDL document for selected binding and grab the part

of the URL that begins with XXXX_bindingkey as highlighted below

Service Name and Service Port: Open the WSDL file again like in the Group Server step

and look for the 'wsdl:service name'/'wsdl: port name' node near the bottom and take the

name.

HTTPS and Port: If HTTPS is Enabled go to ABAP transaction SMICM to get the

HTTPS port number:

in SMICM use the Goto menu -> services -> and read the port number from

the resulting list

Network Test URL: A connectivity test URL i.e www.google.com

"


of 31

7. Webservices Configuration

Aquiller uses a number of webservices to communicate with SAP from a variety of

application. Endpoints have to be created for the webservices shipped with Aquiller.

1. Transaction SOAMANAGER.

2. Select Business Administration Tab and click on Web Service Administration.

3. Search for '/FLMCG/AQUI_AIR_APIS'

4. Select the row and press apply selection

5. Go to Configurations tab and press Create Service and enter the following.

6. Service Name: FLMCG_AQUI_AIR_APIS

7. Description: Aquiller AIR APIS

8. Binding Name: FLMCG_AQUI_AIR_APIS

9. Press Apply Settings.

10. Check No Authentication under Authentication Settings and hit save.

Follow the same procedure as above and create a service endpoint for

'/FLMCG/AQUI_BROWSER_APIS'.

Service Name: FLMCG_AQUI_BROWSER_APIS

Description: Aquiller BROWSER APIS

Binding Name: FLMCG_AQUI_BROWSER_APIS

"


of 31

8. Authorization Object

Note

Ensure FLM authorization object is defined (Refer to Section 6 FLM Installation Guide for

details) and an appropriate role is assigned to the Aquiller user.

Overview

Aquiller authorization object is used to define roles and profiles that you wish the Aquiller

system to respect when letters are being processed. Frontend user access can be precisely

controlled using this object based on Application Type, Correspondence Category, Letter

Type, Customer code and Top Level hierarchy.

Five authorization fields are delivered as part of the Aquiller package:

1. Aquiller Application (/FLMCG/APP) (Content Builder, Letter Assembler, Letter

Writer, Letter Box)

2. Aquiller Customer Code (/FLMCG/CUS)

3. Aquiller Correspondence Category (/FLMCG/CCA)

4. Aquiller Assembly Number (/FLMCG/CTY) (4 digit code automatically assigned to

letters)

5. Aquiller Node (/FLMCG/NDE) (120sp2+ only)

The final field /FLMCG/NDE optionally allows customers to give access to only certain parts

of their classification hierarchies to users. This field combines all of the allowable TOP level

nodes from BOTH content and assemblies. If you wish to not limit this, just enter the value

'*'. For example, if your hierarchy looks like this:

UK

North

South

East

West

France

North

Central

South

Germany

West

East

You could enter France in this field to give users only access to content and assemblies

classified in that way.

http://flmconnect.com/default.asp?W48#toc_22


of 31

Authorization Object creation

Aquiller is not shipped with an authorization object. Part of the installation process involves

the creation of authorization object ‘Z/FLMCG/01’.

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:

1. Object: ‘Z/FLMCG/01’


3. Class: ‘AAAB’

4. Field name: /FLMCG/APP

5. Field name: /FLMCG/CUS

6. Field name: /FLMCG/CCA

7. Field name: /FLMCG/CTY

8. Field name: /FLMCG/NDE

4. Assign to ZAQUILLER package


of 31

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

Creating an Aquiller Super User Role

1. Transaction PFCG or select the menu path ‘Tools->Administration->User

Maintenance->Role Administration->Roles.’

2. Enter role name (for example ‘AQUI_SUPER’) and choose the ‘Single Role’

pushbutton.

3. Enter the role description then Save.

4. Go to the Authorizations Tab and in the ‘Information About Authorization Profile’

box, select the ‘Propose Profile Names’ pushbutton, and a profile name is generated

automatically. Press Save.

5. Select the Change Authorization Data pushbutton. A pop-up window is displayed.

Select the ‘Do not select templates’ pushbutton.

6. Now select the ‘Manually’ pushbutton, and enter the authorization object

‘Z/FLMCG/0001’ created above (4.2).

7. Expand the hierarchy and then enter values for each field: select the ‘*’ symbol in

order for this role to include all application types, correspondence categories, letter

types and customer codes for the super user.

8. Press Generate role and save.

9. Select User tab and assign the role to SAP user account.


of 31

Follow the above procedure to define authorization profiles for other users who require

restricted access to Aquiller application.

Depending on the users other authorizations they may also need the S_SERVICE role.


of 31

9. Functional and Technical Settings

Linking Document Type to CMS



> Initialize Aquiller System->Link Document Type to CMS.

2. Define File Type below and link them to CMS.

3. If FLM is configured in the same client then the entries may already exist.

Define Correspondence Categories

Aquiller letters can be grouped together for the purposes of user authorisation using

correspondence categories. For example, you may wish to bundle letters together by their

sensitivity as in the example below, or by business area (for example, HR Recruiting, HR

Administration) or by territory (UK, US, Germany etc). It is a freely definable choice and

you can have as many of these as you wish.

Once these have been defined, each letter assembly is configured to use a single

Correspondence Category. A series of Authorisation Profiles can be defined to allow access

to certain Correspondence Categories and hence users.

1. Navigate to transaction SPRO > Aquiller > Cross-Application Settings > General

Application Functions > Aquiller > Global Settings > Functional Settings > Maintain

Correspondence Categories

2. Click New Entries and select FLM linked Aquiller Customer Code created Linked FLM Customer Code for Aquiller

3. Define a 3 character category code 'XXX'.

4. Enter a description for the category. Save the updates


of 31

5. Repeat the above procedure to add additional categories as required.


of 31

Define Classification Data for Content

The classification is a hierarchical representation of your business, split into whatever

sections you require in order to locate pieces of classification later on when assembling

individual letters.

Classifications can be up to 6 levels deep and are completely free format; typically people use

their own geographical distribution, or their own product distribution as part of their

hierarchy.

Classifications are separated by 'releases'. Each release is a separate, independent view on the

business. Only one release can be active in the business at any one time; this chosen release

must be maintained against the Aquiller Customer master record in the Aquiller IMG.



> Maintain Classifications -> Maintain Classification Data for Content

2. Enter the release to modify - (if this a new installation then enter 1) and press execute.

3. Click on new entries and enter nodes for level 1 of the classification OR

4. Insert rows as required and enter the classification details starting from Node1.

5. Add nested nodes in the same level, select row of a node in level 1 and click on Level

2 in the cluster column. Repeat Step 3 and 4 to add nodes upto Level 6.

6. Press Save.


of 31

Define Classification Data for Template

Template classification functionally is very similar to the classification for individual pieces

of content as defined above. Letter templates can be assigned to various nodes various nodes

within the tree, and then use the tree subsequently to retrieve different letters.



> Maintain Classifications -> Maintain Classification Data for Template.

2. Enter the release to modify - (if this a new installation then enter 1) and press execute.

3. Click on new entries and enter nodes for level 1 of the classification

4. To add nested nodes in the same level, select row of a node in level 1 and click on

Level 2 in the cluster column. Repeat Step 3 and 4 to add nodes upto Level 6.

5. Follow the steps for Maintain Classification for content, Aquiller SP2 Version

6. Press Save.


of 31

Maintain Customer Code

All global settings relevant to Aquiller are maintained under the FLM Linked Aquiller

Customer Code (that is, the Aquiller Customer Code settings are an extension to a previously

created FLM Customer Code).



> Maintain Customer Code

2. Click on new entry.

3. Under Default Routing Control >Define Form Action specific for Aquiller. The FLM

Form Actions should be defined using FLM Form Action Maintenance. Further

details on configuring FLM Form Action can be found in FLM Connect under Define

form Actions.

4. Under Default Routing Control=>Define Final Letter Status specific for Aquiller. The

letter status should be defined using FLM Form Status Maintenance. Further details

on configuring FLM Form Status can be found in FLM Connect under Define form

Statuses.

5. Enter FLM linked Aquiller customer code created in the Aquiller Installation Linked FLM Customer Code for Aquiller

6. Enter Country Grouping to fetch relevant data from HCM.

7. Enter the Assembly Number Range created Number Range Objects Configuration

8. Enter Classification Release for Content created Define Classification Data for Content

9. Enter Classification Release for Template created Define Classification Data for Template.

10. Enter Aquiller Authorization Object created in Authorization Object creation

11. Press Save.


of 31

Define System Specific Settings

Certain customizing settings must vary depending on the particular SAP system that Aquiller

is running on. Most Aquiller systems will be integrated with a traditional multi-instance SAP

landscape, typically consisting of a development, quality and production instances.

Each of these SAP systems has a unique 'System ID' or SID.

In this activity, you can make settings that are particular to a certain SID - for example, the

name of the RFC destination to the backend SAP HR system, which may vary depending on

whether it is connected to the development or production Aquiller system.

By maintaining one row of data for each SID here, you can maintain, in the one system,

settings for all of the subsequent SAP systems in the landscape.


General Application Functions -> Aquiller -> Global Settings -> Technical Settings -

> System Specific Settings.

2. Click New Entries and enter SAP System ID.

3. Enter RFCDest for SuperUser created during the Super User Connection Aquiller

installation

4. Enter RFCDest for Real User created during the Real User Connect Aquiller

Note

A Real User does not need to be created for single system installation where Aquiller and

HCM are on the same system.

5. Press Save.

Follow the same procedure to enter details of QA and PROD systems.


of 31

Define Infotypes relevant for Aquiller


General Application Functions -> Aquiller -> Global Settings -> Dynamic Variables

Management->Maintain Infotypes relevant for Aquiller

2. InfoTypes, SubTypes, Minor Types and Fields are relevant for Aquiller content - in

each case you do this by navigating to the appropriate level and then ticking the

'include' box.

3. Press save once configured.


of 31

Upload Master Stylesheet Template

Use this activity to upload a master stylesheet template into the Aquiller system. Select the

template shipped as an .xdp file with the Aquiller software package from the installation CD,

and execute.

Note

Free /FLM/ classes must be available in order to store Aquiller stylesheets. To create new

stylesheet classes, navigate to transaction SPRO > Cross-Application Settings -> General

Application Functions -> Aquiller ->Global Settings->Technical Settings->Create Stylesheet

Classes->Enter required number of class to be generated and run the program.

1. Copy the Master Stylesheet template from the DOCU/RESOURCES folder on the

installation disks or right click and save-> FLM_ACL_DEMO_E_00.xdp to the

desktop.

2. Open the .xdp file using Adobe Livecycle Designer. Make the required changes to the

logo and boilerplate texts in the header and footer of the stylesheet.

3. Navigate to File->Form properties > Variables > Click CCODE Variable on the left

pane and update the 3 digit CCODE with FLM Customer Code as defined in FLM

system.

The FLM Customer with SysDefault Checked, as shown in the screenshot below

should be selected.

1. Navigate to File > Form properties > Variables > Click FTYPE Variable on the left

pane and type in 4 character Form Type <XXXX>.

2. Rename and save the Stylesheet in this format - FLM_<CCODE defined in

Step3>_<FTYPE Defined in Step4>_E_00.xdp (See example

FLM_ACL_AMEY_E_00.xdp).

3. Navigate to transaction SPRO > Cross-Application Settings > General Application

Functions > Aquiller > Stylesheet Management > Upload Stylesheet

4. Browse to the file saved in Step 2

5. Press Execute and enter description when prompted

Note

This procedure can be repeated as required for creating different Stylesheet templates by

defining a unique 4 Character Form Type - as specified in Step 4.

http://flmconnect.com/default.asp?pg=pgDownload&pgType=pgWikiAttachment&ixAttachment=13751&sFileName=FLM_ACL_DEMO_E_00.xdp


of 31

Load Infotype Metadata

In 'Master Load'' mode the system takes ALL of the HCM infotypes and rebuilds the

Aquiller configuration table which then allows the system consultants decide which of

the infotypes should be made available to Aquiller operators.

1. Navigate to transaction SPRO > Cross-Application Settings > General Application

Functions > Aquiller > Global Settings > Functional Settings > Initialize Aquiller

System>Master Load of Infotype Metadata.

2. Execute selecting Master Reset.

aquiller technical guide - arch

Documents