Download as pdf or txt
Download as pdf or txt
You are on page 1of 62

Translated from German to English - www.onlinedoctranslator.

com

FIS/edc Life Cycle Manager Technical Manual

FIS/edc Life Cycle Manager Technical Manual


Release 2021.69.0

FIS information systems Röthleiner Weg 1 Phone: +49 97 23 / 91 88-0 info@fis-gmbh.de

and Consulting Ltd D-97506 Grafenrheinfeld Fax: +49 97 23 / 91 88-100 www.fis-gmbh.de


FIS/edc Life Cycle Manager Technical Manual

Disclaimer

The information contained in this document is subject to change without prior notice. This
document is made available without any guarantee on the part of FIS regarding the
correctness, completeness and use of the information and data contained therein.

It is for informational purposes only. FIS assumes no liability for errors in or for the
completeness of the document, in particular not for the information, graphics, links or other
information and content contained therein. FIS shall not be liable for any damages, express
or implied, that may result from the use of the document, including but not limited to
merchantability, fitness for a particular purpose, and non-infringement of applicable law,
unless damages are caused by were caused intentionally or through gross negligence on the
part of FIS. This includes in particular direct, special, indirect damage as well as incidental and
consequential damage.

03/17/2021 - Page 2 of 62
FIS/edc Life Cycle Manager Technical Manual

contents

1. Overview of Life Cycle Managers ..................................... ........................................ 6

2. installation ................................................ .................................................. ...................... 7

2.1. Requirements ................................................. .................................................. ................. 7


2.1.1. servers ................................................ .................................................. ....................... 7
2.1.2. Database ................................................. .................................................. ........................ 7
2.1.3. client ................................................ .................................................. ................................. 8th
2.1.3.1. website ................................................ .................................................. ................................... 8th
2.1.3.2. FIS/edc® for SAP ............................................ .................................................. ................. 8th
2.2. Set up ................................................. .................................................. ................................. 8th
2.2.1. Installation process ..................................................... .................................................. ......... 9
2.2.2. Rework ................................................ .................................................. ................. 16
2.2.3. HTTPS activation ................................................ .................................................. ......... 17
2.2.3.1. https settings on the backend .................................................. ...................................... 17
2.2.3.2. https settings on the frontend .................................................. ...................................... 18
2.2.3.3. https settings for the web front end ................................................ .......................... 19

3. administration ................................................ .................................................. ............. 21

3.1. back end ................................................ .................................................. ....................... 21


3.1.1. Log files ................................................ .................................................. ..................... 21
3.1.2. Configuration Application ..................................................... ................................................ 22
3.2. Front end ................................................ .................................................. ....................... 23
3.2.1. Reports ................................................ .................................................. .......................... 25
3.2.2. administration ................................................ .................................................. ................ 36
3.2.2.1. Process management ..................................................... .................................................. ........ 37
3.2.2.2. Module management ................................................ .................................................. ............ 41
3.2.2.3. Process overview management ..................................................... ........................................ 44
3.2.2.4. Report management ..................................................... .................................................. ........ 45
3.2.2.5. Settings ................................................. .................................................. .................. 48
3.2.2.6. Export of definitions ..................................................... .................................................. ... 48
3.2.2.7. Importing definitions ..................................................... .................................................. ... 49
3.2.3. Test tool ................................................ .................................................. ................. 51
3.3. Web service interface ..................................................... ................................................. 55
0

03/17/2021 - Page 3 of 62
FIS/edc Life Cycle Manager Technical Manual

3.3.1. Interactions with the document ..................................................... ...................................... 55


3.3.1.1. Create document ................................................ .................................................. ......... 56
3.3.1.2. Filing a comment on the document ................................................. .................................... 56
3.3.1.3. Update document data ..................................................... ....................................... 56
3.3.1.4. Finalize document ................................................ .................................................. .. 56
3.3.1.5. Creating module data ........................................ .................................................. ....... 56
3.3.1.6. Append module data ........................................ .................................................. ... 56
3.3.1.7. Update module data ..................................................... ................................................ 56
3.3.2. Description of the interfaces ..................................................... ...................................... 56
3.3.2.1. DocumentDataWcfService ................................................ ............................................ 57
3.3.2.2. ModuleDataWcfService ................................................ .................................................. .. 58
3.3.3. Parameters ................................................ .................................................. ...................... 59
3.3.3.1. DocumentDataDto ................................................ .................................................. ........ 59
3.3.3.2. CommentDataDto ................................................ .................................................. ......... 60
3.3.3.3. PC Query ................................................ .................................................. ....................... 61
3.3.3.4. ModuleDataDto ................................................ .................................................. ............... 62

03/17/2021 - Page 4 of 62
FIS/edc Life Cycle Manager Technical Manual

foreword

The reader

This manual is primarily intended for the administrators of the FIS/edc(R) monitors and the FIS/
fci(R) software.

requirements

This documentation was created on the basis of Microsoft Windows Server operating systems and
Microsoft Internet Information Services.

Registered trademarks

FIS/fci® is a registered trademark of FIS GmbH


SAP R/3 and ABAP are registered trademarks of SAP AG, Walldorf.

All other product and brand names are registered or unregistered trademarks of their
respective owners.

A notice:
After the introduction of FIS/edc or FIS/fci, the settings described in this documentation should
only be changed after consultation with the FIS GmbH project team, as some parameters are
required for a proper process flow.

Editor:

FIS Information Systems and Consulting GmbH

Röthleiner Weg 1
D-97506 Grafenrheinfeld

Phone: + 49 (9723) 9188-0


Fax: + 49 (9723) 9188-700
Email: info@fis-gmbh.de

Web: http://www.fis-gmbh.de

03/17/2021 - Page 5 of 62
FIS/edc Life Cycle Manager Technical Manual

1. Life Cycle Manager overview


The FIS/edc Life Cycle Manager is an application for monitoring processes that have a
document as a common basis.

Figure 1: Life Cycle Manager process overview

Figure 1 shows the flow of a typical application scenario with the FIS/edc Life Cycle
Manager.
The focus here is on the Life Cycle Manager Service. This is designed as a WCF service and
has an open interface that supports both the integration of FIS Smart Products and the
connection of third-party applications.
All other services and applications that are part of a process are mapped as modules and
can transmit status data to the Life Cycle Manager Service via the interface or query
status data.

It is also possible to define your own processes and modules that are not supplied by FIS.

The FIS/edc Life Cycle Manager consists of a backend and an administration interface.
Both are installed with the setup.

03/17/2021 - Page 6 of 62
FIS/edc Life Cycle Manager Technical Manual

2.Installation
The installation of the FIS/edc Life Cycle Manager is described below in individual steps.
The requirements for operating the backend and frontend should also be shown.

2.1. requirements

The following requirements apply to the operation of the respective modules.

2.1.1. server

The FIS/edc Life Cycle Manager should be installed on a Microsoft Windows Server
operating system.

The following operating systems are supported:

· Microsoft Windows Server 2012 R2, 2016 or newer (recommended with GUI).
· Microsoft Windows 10.

Furthermore, the Microsoft .NET Framework Version 4.6.2 is required. It is recommended to make
this available before installation on the target server. Furthermore, several services are installed
and started.

The web services run under the Microsoft Internet Information Server (IIIS). This must be
installed on the server in version 7 or higher.
Microsoft IIS Express is not sufficient.

At least 2 GB of RAM should be available for operation. Depending on the number of


documents, significantly more may be required.

2.1.2. Database

A database is required to operate the FIS/edc Life Cycle Manager. This must be made
available prior to installation.

The following database management systems are supported:

· Microsoft SQL Server 2012, 2014, 2016, 2017 and 2019

Furthermore, the FIS/edc Life Cycle Manager requires its own database user, which must
also be created and known.

In order to be able to establish communication with the respective database, special drivers
are required depending on the database, which are available on the application server

03/17/2021 - Page 7 of 62
FIS/edc Life Cycle Manager Technical Manual

have to be asked. These are not part of the setup and may have to be installed by the
administrator.

If a Microsoft SQL Server 2008 or 2008R2 is used, the required drivers are already
installed with the .NET Framework 4.6.2 (during the installation). If a newer version of
Microsoft SQL Server is used, it is absolutely necessary to install the appropriate database
driver on the application server.

2.1.3. clients

The FIS/edc Life Cycle Manager has a web client included in the delivery version. There is
also the option of connecting FIS/edc® for SAP as a front end.

2.1.3.1. Web

In order to be able to use the web frontend without any problems, the following conditions should be met.

Recommended browsers:

· Microsoft Edge and newer


· Mozilla Firefox or newer
· Google Chrome

Furthermore, the frontend uses JavaScript technologies, which must also be supported by the
browser or their use must be permitted.

2.1.3.2. FIS/edc® for SAP

FIS/edc® for SAP is offered and sold as an independent product by FIS


Informationssysteme und Consulting GmbH. If FIS/edc® is used for SAP, it is possible to
connect it to the FIS/edc Life Cycle Manager. Further information on the procedure can be
found in the FIS/edc® for SAP manual.

It is also necessary to check whether the SAP basis version (Netweaver) supports "Nested XSD
schema files". This is absolutely necessary for a smooth connection to FIS/edc®. According to the
current state of knowledge, this is supported from SAP Netweaver 7.01 EHP5.

2.2. Set up

The actual installation is carried out using a setup application that is delivered and
installed by the FIS consultants.
After completing the actual setup, a dialog appears asking you to configure the
connection to the respective database and create the database schema.

03/17/2021 - Page 8 of 62
FIS/edc Life Cycle Manager Technical Manual

2.2.1. installation process

The FIS/edc Life Cycle Manager is installed via a Windows setup.

If the .NET Framework Version 4.6.2 is not available and cannot be installed automatically
with the installation, please install it manually, it can be obtained free of charge from the
Microsoft server and then start the Life Cycle Manager installation again. Furthermore,
the Microsoft Internet Information Server 7 (IIS) or higher must be installed in order to be
able to carry out the setup.

Start the setup with administration rights.

Then confirm the start of the actual setup with "Next".

Figure 2: Life Cycle Manager Setup - Home Screen

Now select the components to be installed and start the installation process.

03/17/2021 - Page 9 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 3: Life Cycle Manager Setup - Component Selection

If desired, change the installation path.

03/17/2021 - Page 10 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 4: Life Cycle Manager Setup - specifying the installation path

The installation process has started.


If unexpected problems should occur during the installation, these errors are
displayed here in the window or the whole process is also logged in the log files. The
log file can be found in the same directory as the installation package.

03/17/2021 - Page 11 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 5: Life Cycle Manager Setup - Progress

If the installation process has gone through without any problems, the setup can be completed with
'Finish'.

03/17/2021 - Page 12 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 6: Life Cycle Manager Setup - Exit

After the actual installation of the Life Cycle Manager is complete, you will now be
prompted to configure the application. The database configuration is carried out by
selecting the database server used and the associated dialect. Furthermore, the
connection string must be entered depending on the selected database. Please ask your
database administrator about this.

Danger: It is absolutely necessary that the necessary client drivers are available, see also
section:Database .

Once the database configuration is complete, please confirm it with "Save Config".

03/17/2021 - Page 13 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 7: Life Cycle Manager configurator

Reinstallation:

If no previous version of the Life Cycle Manager was installed, a new installation can be
carried out without any problems. All necessary tables are created in the previously
selected database and settings are made.

Danger: If there is already data in the database, it will be completely deleted. To keep the
existing data please use the'upgrade'Function.

Please note that under 'DB schema options' the option'create'is clicked. You can
then start the configuration with the 'Database Schema' button.

03/17/2021 - Page 14 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 8: Life Cycle Manager configurator - create database scheme

updated:

If an earlier version of the Life Cycle Manager is already installed, an update must be
carried out. All tables on the previously selected database are adjusted.

Please note that under 'DB schema options' the option'update'is clicked. You can
then start the configuration with the 'Database Schema' button.

03/17/2021 - Page 15 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 9: Life Cycle Manager Configurator - update database schema

Danger: the database configured in the connection string must already exist!

If the services could be started successfully, the installation is complete.

2.2.2. rework

If the installation was successfully completed, small rework must be carried out.

Figure 10: Life Cycle Manager backend service

The backend service must be started manually. However, this should be possible without any problems once
the database has been configured and the schemas have been created. Please start the service now.

03/17/2021 - Page 16 of 62
FIS/edc Life Cycle Manager Technical Manual

If you are having trouble configuring or starting the services, see the Administration
section atbackend Further information.

2.2.3. HTTPS activation

By default, the LCM is addressed via http. This means that after the installation, the LCM web service
runs under http -> port 8001 and the LCM web front end under http -> 8002. In order to make it https-
enabled, the following steps must be taken
be performed.

Note: Operating the LCM via https requires a sha256 server certificate, which must
be stored in the server's local certificate store

2.2.3.1. https settings on the backend

1. Open the fileProcessControlService.ProcessControlWindowsService.exe.configin an


editor
(By default, this is underC:\Program Files (x86)\FIS\LCM\service\to find)
2nd sub<AppSettings>must be the value forsslOnbe set to true
<add key="sslOn" value="true"/>
3. sub <System.ServiceModel> <services> <services> <host> <baseAddresses>must all
base addressAttributes on https and the FQDN hostname are changed
<system.serviceModel>
<services>
<service behaviorConfiguration="ProcessControlService.WcfServiceBehavior"
name="ProcessControlService.Domain.Services.DocumentDataService">
<endpoint address="" binding="basicHttpBinding"
bindingConfiguration="ProcessControlService_BasicHttpEndpointBinding"
bindingNamespace="http://fis/DocumentDataServices"
contract="ProcessControlService.Common.ServiceContract.IDocumentDataService"/> <endpoint address="mex" <!--
binding="mexHttpBinding" contract="IMetadataExchange"/>-->
<host>
<baseAddresses>
<add baseAddress=" https://<hostname>.fis-
gmbh.de:8001/DocumentDataWcfService.svc "/> <!-- when sslOn is true webservice is running
under https, then change url to https://... -->
</baseAddresses>
</host>
</ service>
........

4. Under<bindings> <basicHttpBinding> must the knot<security>be commented out.


It should look like this.

<security mode="Transport">
<transport clientCredentialType="None"
</transport>
</security>

5. Save the file and start the FIS LifeCycleManager service. Now the
LCM web service should run under port 8001 only via https

03/17/2021 - Page 17 of 62
FIS/edc Life Cycle Manager Technical Manual

6. Now the certificate has to be bound to port 8001


To do this, the Powershell (Admin) must be opened and the following commands must be issued.

dir cert:\localmachine\my

7. A list of the certificates found should then be displayed

Directories: Microsoft.PowerShell.Security\Certificate::localmachine\my Thumbprint


Subject
---------- -------
89C38E9AD6455F9A8782DD29CE089074C57311ED CN=*.lovelydomain.com

8. The thumbprint for the desired certificate must be noted.


9. Then write the following lines individually in Powershell. The
thumbprint noted above must be in the $certHash line

$guid = [guid]::NewGuid()
$certHash = "89C38E9AD6455F9A8782DD29CE089074C57311ED" $ip =
"0.0.0.0" # This means all IP addresses $port = "8001" # the default HTTPS
port
"http add sslcert ipport=$($ip):$port certhash=$certHash appid={$guid}" | net

10.If the certificate was successfully linked, you can tell by the message that is returned
after the last line.

2.2.3.2. https settings on the frontend

1. Open the fileweb.configin an editor


(By default, this is underC:\inetpub\wwwroot\LifeCycleManager\to find)
2nd sub <system.serviceModel> <bindings> <basicHttpBinding> <binding
name="ProcessControlService_BasicHttpEndpointBinding"> <security must be the complete knot
mode="TransportCredentialOnly"> commented and the node <security
mode="transportation">be commented out.

<!--<security mode="TransportCredentialOnly">
<transport clientCredentialType="Basic" proxyCredentialType="Basic" realm="LCM" /> </security>-->

<security mode="Transport"> </


security>

3. Under the knot<system.serviceModel> <client> <endpoint> must have the attributesaddresson


https and the FQDN hostname can be changed
<client>
<!-- when sslOn is true webservice is running under https, then change url to https://...
-->
<endpoint name="BasicHttpBinding_IDocumentDataService"
address=" https://<hostname>.fis-gmbh.de:8001/DocumentDataWcfService.svc "
binding="basicHttpBinding" bindingConfiguration="ProcessControlService_BasicHttpEndpointBinding"
contract="ProcessControlService.Common.ServiceContract.IDocumentDataService"
behaviorConfiguration="defaultBehavior">

<identity>
<dns value="localhost"/> </
identity>

03/17/2021 - Page 18 of 62
FIS/edc Life Cycle Manager Technical Manual

</endpoint>
.....
4. After restarting the LifeCycleManager page via the IIS Management Tool, the LCM web front end
only runs on the https LCM web service

2.2.3.3. https settings for the web frontend

In order to run the LCM web front end under https, you have to adjust the binding of the LCM
website in the IIS Management Tool
1. Open Bindings of LifeCycleManager

Figure 11: Life Cycle Manager Setup - Open Binding for IIS
2. Change http binding to port 8003 and save

Figure 12: Life Cycle Manager Setup - adjust old http binding

03/17/2021 - Page 19 of 62
FIS/edc Life Cycle Manager Technical Manual

3. Create a new https binding on port 8002 and select a certificate

Figure 13: Life Cycle Manager Setup - Add https binding


4. Only now can the old http binding be deleted, which was changed under point 2
5. Start LifeCycleManager web frontend via IIS Management

03/17/2021 - Page 20 of 62
FIS/edc Life Cycle Manager Technical Manual

3. Administration
Once the installation and basic configuration of the application is complete, the
process(es) to be used must be imported or created. The required steps are described
below.

If unexpected problems occur during installation and configuration, you will find possible
solutions on the following pages.

3.1. backend

The "FIS/edc LifeCycleManager Service (ProcessControlWindowsService)" represents the


actual Life Cycle Manager, the web service (WCF) is hosted here. All existing WCF services
listen on port 8001 by default.

3.1.1. log files

The backend service writes its own log file, which serves as the main data source for
monitoring the service functionality.

The log file can be found in the "service\log" folder of the installation. In the standard case this is:

C:\Program Files (x86)\FIS\LCM\service\log

· ProcessControlWindowsService.log => Log file for "FIS/edc LifeCycleManager Service


(ProcessControlWindowsService)"

[2013-11-12 09:13:43] [6] [INFO] Start ing service... [2013-11-12


09:13:43] [6] [INFO] Init ialize Spring framework... [ 2013-11-12
09:13:44] [6] [INFO] Spring initialized.
[2013-11-12 09:13:44] [6] [INFO] Opening Host [0]
[2013-11-12 09:13:45] [6] [INFO] Address: ht tp://ruebalap:8001/DocumentDataWcfService.svc
[2013-11-12 09:13:45] [6] [INFO] Host opened!
[2013-11-12 09:13:45] [6] [INFO] Opening Host [1]
[2013-11-12 09:13:45] [6] [INFO] Address: ht tp://fis39.fis-gmbh.de:8001/ModulDataWcfService.svc
[2013-11-12 09:13:45] [6] [INFO] Host opened!
[2013-11-12 09:13:45] [6] [INFO] Opening Host [2]
[2013-11-12 09:13:45] [6] [INFO] Address: ht tp://fis39.fis-gmbh.de:8001/ModulDefinit ionWcfService.svc
[2013-11-12 09:13:45 ] [6] [INFO] Host opened!
[2013-11-12 09:13:45] [6] [INFO] Opening Host [3]
[2013-11-12 09:13:45] [6] [INFO] Address: ht tp://fis39.fis-gmbh.de:8001/ProcessViewFieldService.svc
[2013-11-12 09:13:45] [6] [INFO] Host opened!
[2013-11-12 09:13:45] [6] [INFO] Opening Host [4]
[2013-11-12 09:13:45] [6] [INFO] Address: ht tp://fis39.fis-gmbh.de:8001/ExtendedDocumentDataService.svc
[2013-11-12 09:13:45] [6] [INFO] Host opened!
[2013-11-12 09:13:45] [6] [INFO] T rying to connect with URI ht tp://lcm: edc@fis39.fisgmbh.de
:8001/ExtendedDocumentDataService.svc
[2013-11-12 09:13:47] [4] [INFO] ConfigurationFileName = C:\Program Files (x86)\FIS\LCM_2014\service\nhibernate.cfg.xml
[2013-11-12 09:13 :48] [4] [INFO] ConfigurationFileName = C:\Program Files (x86)\FIS\LCM_2014\service\nhibernate.cfg.xml
[2013-11-12 09:13:50] [4] [DEBUG] select TOP (@p0) ping0_.ID as ID7_, ping0_.Message as Message7_ from Ping ping0_;@p0 = 1
[Type: Int32 (0)]
[2013-11-12 09:13:50] [6] [INFO] DocumentDataService working: True

03/17/2021 - Page 21 of 62
FIS/edc Life Cycle Manager Technical Manual

[2013-11-12 09:13:50] [4] [DEBUG] select TOP (@p0) ping0_.ID as ID7_, ping0_.Message as Message7_ from Ping ping0_;@p0 = 1
[Type: Int32 (0) ]
[2013-11-12 09:13:50] [6] [INFO] ModuleDataService working: True
[2013-11-12 09:13:50] [4] [DEBUG] select TOP (@p0) ping0_.ID as ID7_, ping0_.Message as Message7_ from Ping ping0_;@p0 = 1
[Type: Int32 (0) ]
[2013-11-12 09:13:50] [6] [INFO] ModuleDefinitionService working: True
[2013-11-12 09:13:50] [4] [DEBUG] select TOP (@p0) ping0_.ID as ID7_, ping0_.Message as Message7_ from Ping ping0_;@p0 = 1
[Type: Int32 (0) ]
[2013-11-12 09:13:50] [6] [INFO] ProcessViewFieldService working: True
[2013-11-12 09:13:50] [4] [DEBUG] select TOP (@p0) ping0_.ID as ID7_, ping0_.Message as Message7_ from Ping ping0_;@p0 = 1
[Type: Int32 (0) ]
[2013-11-12 09:13:50] [6] [INFO] ExtendedDocumentDataService working: T rue
[2013-11-12 09:13:50] [6] [INFO] Service started!

If you start successfully, your log file should contain similar entries. The entries are particularly
important here.

ODocumentDataService working: True O


ModuleDataService working: True O
ModuleDefinitionService working: True O
ProcessViewFieldService working; True O
ExtendedDocumentDataService working: True O
Service started!

Furthermore, all SQL queries to the database are written to the log file by default

"service\nhibernate.cfg.xml" the entry "<property name="show_sql">true</property>" is


set to "false" and then the service is restarted. Furthermore, all error messages are
logged here.

3.1.2. configuration application

With the FIS/edc Life Cycle Manager - Configurator, it is possible to adjust the database
settings afterwards.

The application can be started from the "service\installer" folder.

03/17/2021 - Page 22 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 14: Life Cycle Manager configurator

The figure shows the application interface. The interesting setting after the installation
is primarily the "Connections String", here the desired database parameters can be set.
Once this is done, save the settings back to the file with "Save Config".

Furthermore, different paths to the configuration files are displayed, here you have the
option of editing settings directly as required. It is also possible, if the standard ports and
the service address are not to be used, to use them via the "baseAddresses" in the
configuration file
"ProcessControlService.ProcessControlWindowsService.exe.config".

3.2. front end

The FIS/edc Life Cycle Manager frontend is used to manage the Life Cycle Manager service
and is available as standard via port 8002 via HTTP with a web browser.

03/17/2021 - Page 23 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 15: Life Cycle Manager Frontend - start page

The frontend is divided into three main categories, which are described in more detail
below. The "About Application" menu item is shown in this figure, the primary purpose
here is to view the version of the installed frontend version and the status of the currently
logged-in user.

Figure 16: Life Cycle Manager Frontend - About the application

03/17/2021 - Page 24 of 62
FIS/edc Life Cycle Manager Technical Manual

3.2.1. reports

The status of the individual documents and the values of the associated attributes can be
displayed using the report functionality.

Figure 17: Life Cycle Manager Frontend - Reports

The functionality of the report function is explained below.

"Process Selection"
In order to display the reports, one must first select a process or a process
category for which the report is to be displayed.

Figure 18: Life Cycle Manager Frontend - Process/Process Category Selection for Reports

"Multiple selection of processes"


After it has been selected that a report for a process (not a process category) is to be
carried out, you can add additional processes to the report evaluation.

03/17/2021 - Page 25 of 62
FIS/edc Life Cycle Manager Technical Manual

It should be noted that the processes correspond to the same category. Evaluations of
different process categories are not supported. The multiple selection of the process
wins over the single process selection. Either the multiple selection (via checkboxes) or
the single selection (via dropdown) is evaluated.

Figure 19: Life Cycle Manager Frontend - multiple selection of processes

"Saved Reports"
For each process (not a process category), ready-made reports can be called up or new
reports can be created and saved.

Figure 20: Life Cycle Manager Frontend - Overview of saved reports

"Search Criteria Selection"


After selecting the process, the search criteria section appears. This section is used to
limit the number of records by specifying the filter conditions.
The filter fields are divided into 3 groups: "Document Data", "Module Data" and "Other".

03/17/2021 - Page 26 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 21: Life Cycle Manager Frontend - available


search criteria

"document data"
These fields relate to the document (receipt) fields and are always the same for each
process.
These fields are as follows. "Document ID", "Barcode", "Tiff", "User ID", "Batch", "Date
Created" and "Date Modified".

"module data"
Different modules can store different information in the LCM. This information can differ
depending on the module and can be defined in the LCM frontend (administration) for
each module as "module fields". This information can be searched in the LCM database
and the relevant fields are found in the search criteria under the "Data Module" group.

These fields may change depending on the process selected. It depends on which modules
are assigned to which process.

"Other"
This group includes all other fields. There are currently two status fields here:
"DocumentCompleteStatus" and "RequiredFieldStatus".

a)Figure 22: Life Cycle Manager Frontend - Other search criteria

03/17/2021 - Page 27 of 62
FIS/edc Life Cycle Manager Technical Manual

"DocumentCompleteStatus" allows the user to determine whether the documents on the


report should be shown as finished, unfinished or all (in this case – no filter).
"RequiredFieldStatus" is a bit more complicated. This status can have 3 values: "Missing",
"Complete", "All". "Missing" means that each of the documents found should have at least one
empty mandatory "ModuleField". Which module field is mandatory must be defined in the
LCM administration. Correspondingly, "Complete" means that each of the found documents
must not have empty mandatory "ModuleFields".

"Query Operator"
This list contains the query operators that are relevant to the selected filter field.

Figure 23: Life Cycle


Manager Frontend - Operators
for characters

Date operators:

Figure 24: Life Cycle


Manager Frontend - Operators
for date

Available / Not Available Operators:


For fields in the module data area, there are exclusively the operators "Available" and "Not
available".
This operator can be used to check whether a module has already been run through (Available)
or has not yet been run through (Not available). No comparison value is required for these two
operands. Since the backend checks whether the selected module is available. This allows reports
to be created which, for example, already archived documents (Available) or not yet archived
documents (Not available) to display.

03/17/2021 - Page 28 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 25: Life Cycle Manager


Frontend - Operators for module
traverse / not traverse

With each change of the filter field, the operator list is updated and populated with relevant
operators. As an example for a text field, the following query operators are available: "
Contains", "Begins with" etc., which are irrelevant for a date field. The following query
operators are available for a date field: "date from", "date to", "date between".

range operator:
For fields (no date fields) in the document data and module data areas, there is the operand "
in between".the operand"in between" can evaluate both numbers and text.

Example: barcodefrom'Test0001'until'Test0099' returns all barcodes from 'Test0001' to


'Test0002', etc. up to barcode 'Test0099'

Multiselection operator:
For fields (no date fields) in the document data and module data areas, there is the
operand "In".the operand"In" can evaluate both numbers and text.
It can be done with the operator "In"Several values of a data field can be selected at the same
time. For each value, a separate selection criterion with the operator "In" to be attached.

Example: ACCAREA_INVOICE_READERIn'0001', ACCAREA_INVOICE_READERIn'0201' and


ACCAREA_INVOICE_READERIn'001' returns all documents as a result set that either

the BUKRS = '0001'orBUKRS = '0201'orBUKRS = '001' included.

Figure 26: Life Cycle Manager Frontend - In Operator

Note: The operator "same" links the fields withandnot withor.

"Value Fields"
The third field is used to specify the actual value for the selected filter field.

03/17/2021 - Page 29 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 27: Life Cycle Manager Frontend - value field

This field appears dynamically and depends on the selected filter field and query
operator.
For text filter fields, the value field is a text field with a mandatory field condition (value cannot be
blank).
For date filter fields, the value field is also a text field with two conditions: mandatory field and
date format (yyyy-MM-dd hh:mm:ss).
For the query operator "Date between" there are two text fields for entering the date
range.

No value field is required for the operators beginning with 'since ...'.
If no value field is entered, autom. the current timestamp is used as a criterion.

Figure 28: Life Cycle Manager frontend - date/time selection

For status fields in the "Other" query field group, the values are selected from a
selection list.

Figure 29: Life Cycle Manager Frontend - input help for other search criteria

03/17/2021 - Page 30 of 62
FIS/edc Life Cycle Manager Technical Manual

The "Add" button is used to add the specified search criterion.

The inserted search criteria are displayed in a table. A search criterion can be removed by
clicking on the "Delete" button.
By clicking on the value, the user can easily edit the value.

Figure 30: Life Cycle Manager Frontend - Subsequent editing of the value field

All search criteria can also be deleted at once via 'Reset selection'.

Figure 31: Life Cycle Manager Frontend - reset search criteria

Important: Technically, the inserted search criteria are stored in a session object. This
means that they can be reset if the user has been inactive for a long time.

With a click on the "Search" button, the query is executed and the results are displayed on
the report page.

"report page"
The documents found are displayed in a result table.
The search criteria used are displayed on the left above the results table, as well as the number of data
records per page.
On the right above the results table there is a search and an export function, both
functions access the data in the results table.
The search function can search across all columns/pages of the results table.
The export function can both copy the data to the clipboard and export it to CSV and PDF
formats. It is also possible to prepare the data for printing.

By clicking on the table header, the user can sort the records, both in ascending and
descending order.

03/17/2021 - Page 31 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 32: Life Cycle Manager Frontend - search results

Clicking the "Details" button redirects the user to the Details page.

"details"
This page contains information about document data and other data added by various
modules (module data).

In the event of an error, the 'last module run through' is visible.

For each module, the module data is sorted in ascending order by date (creation date or
modification date).

03/17/2021 - Page 32 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 33: Life Cycle Manager front end - detailed view

image display

As of FCI Version 5.0, the invoice image can be displayed in the detail view.

03/17/2021 - Page 33 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 34: Life Cycle Manager Frontend - image view

"Create and save a new report"

In order to add another saved report, the process in which the report is to be displayed
must first be selected.
If the process is selected, a name and a short description must be entered.

The 'Deletable by user' flag has the function of allowing the user to delete the report from
the report page.

03/17/2021 - Page 34 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 35: Life Cycle Manager Frontend - Save report

Once the header information for the report has been saved, the selection criteria can be
stored.
The selection criterion must be saved with the 'Add' button before the report can be
saved.

03/17/2021 - Page 35 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 36: Life Cycle Manager Frontend - Selecting the selection criteria

If a date field is used as a selection criterion and 'since .....' as the operator at the same time, the value
field must be empty, otherwise the report will be loaded with the stored date when it is called up on
the report page.
If the value field is empty, the current date is always used as the starting date when the report is
loaded.

3.2.2. administration

The administration area is used to manage the processes and modules; the individual
menu items are discussed below.

The FIS/edc Life Cycle Manager is hereinafter referred to as LCM.

03/17/2021 - Page 36 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 37: Life Cycle Manager Administration -


administration menu

3.2.2.1. process management

This section describes how to create and manage the processes. To do this, please click on
the menu item "Process management".

Figure 38: Life Cycle Manager Administration - Process overview

Clicking on the process name redirects the user to the process details page.

The "Create new process" link is used to define a new process.

"Create new process"


A process is described with two properties: name and description. To define a new
process you have to enter this information and confirm with the "Save" button. The
following conditions apply to both fields. The "Name" field is required and both fields can
have a maximum of 50 characters.

03/17/2021 - Page 37 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 39: Life Cycle Manager Administration - Create a new process

"Process Details"
By clicking on the process name, the process details open. The process properties are
listed on the left. The "Edit" and "Delete" links allow you to edit or delete a process.
The process editing page has a very similar look and functionality to the new process
creation page.
To delete the process you have to confirm this operation.
A process can only be successfully deleted if there is still no document data for this
process in the LCM database.

Figure 40: Life Cycle Manager Administration - Process Details

03/17/2021 - Page 38 of 62
FIS/edc Life Cycle Manager Technical Manual

"Assigned Modules"
On the right is the list of modules assigned to the process.

Figure 41: Life Cycle Manager Administration - Modules assigned to the process

You can edit this list by clicking on the "Assign Modules" link.

"Assign Modules"
The "Available Modules" list contains the modules that are not assigned to the current
process.

Figure 42: Life Cycle Manager Administration - Assign new module

With a click on the "Add to“ Switch, you can assign a selected module to the current
process.

The "Assigned Modules" list contains the modules that have been assigned to the current process.
In addition, you can set up the order and mandatory fields for each module.

03/17/2021 - Page 39 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 43: Life Cycle Manager Administration - Module Order

The module order affects the order of the modules on the report detail page (See: LCM Web
Application). The value of the order for each module must have a number > 1 and cannot be
empty.

The module mandatory fields work together with "RequiredFieldStatus" filter field (see: LCM web
application). These module fields are marked with red if the value is empty.
With the "Extinguish“ button you can delete the module from the list. After this operation,
this module will disappear from the "Assigned Modules" list and will appear on the "Available
Modules" list.

The key "Save on computer“ is used to save the order and mandatory fields in the
database.
The modules on the "Assign modules" list are sorted in ascending order according to the assigned
order.

03/17/2021 - Page 40 of 62
FIS/edc Life Cycle Manager Technical Manual

3.2.2.2. module management

This section describes how to create and manage the modules. To do this, please click on the
menu item "Module management".

"module management"
This page contains the list of the defined modules of the LCM database.

Figure 44: Life Cycle Manager Administration - module overview

By clicking on the name of the module, the user is redirected to the module details page.

"Create new module" link is used to define a new module.

"Create new module"


A module is described with two properties: name and description. To define a new
module you have to enter this information and confirm with the "Save" button. The
following conditions apply to both fields. The "Name" field is required and both can have
a maximum of 50 characters.

03/17/2021 - Page 41 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 45: Life Cycle Manager Administration - create a new module

"module details"
The module properties are listed on the left. "Edit" and "Delete" links redirect the user
to the page for editing or deleting a module.

The module edit page has a very similar look and functionality to the new module
creation page.
To delete the module you have to confirm this operation. A module can only be
successfully deleted if its module fields are not already used in the module data of the
LCM database.

On the right side is the list of module fields belonging to the selected module.

03/17/2021 - Page 42 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 46: Life Cycle Manager Administration - Module Details

"Create a new module field"


Used to define a new module array for the current module.
Clicking on the module field name redirects the user to the module field details page.

Figure 47: Life Cycle Manager Administration - create a new module field

"module field details" edit and delete work in the same way as the modules.

03/17/2021 - Page 43 of 62
FIS/edc Life Cycle Manager Technical Manual

3.2.2.3. Process overview management

This section describes how to create and manage the visible fields in the process overview. To
do this, please click on the menu item "Process overview management".

"Process Overview Management"

This page contains an overview of the created processes to which the module fields to be
monitored can be added.

Figure 48: Life Cycle Manager Administration - Process Overview Management

"Add module field"


In order to add another module field to the process overview, the process to be used
must first be selected.
Then you can select the desired module field from a list of the module fields belonging to
the process.
A sorting index is needed because it determines the display order.

03/17/2021 - Page 44 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 49: Life Cycle Manager Administration - add module field to the process overview

3.2.2.4. report management

This section describes how to create and manage the saved reports. To do this, please
click on the menu item "Report Management".

"Report Management"

This page contains an overview of the reports that have already been delivered. You can
create and save more ready-made reports for your users.
Reports that have already been saved can be displayed, edited and deleted here.

Figure 50: Life Cycle Manager Administration - Report Management

"Create new report"

03/17/2021 - Page 45 of 62
FIS/edc Life Cycle Manager Technical Manual

To add another report, the process in which the report is to be displayed must first be
selected.
If the process is selected, a name and a short description must be stored.

The 'Deletable by user' flag has the function of allowing the user to delete the report from
the report page.

Figure 51: Life Cycle Manager Administration - Create a new predefined report

Once the header information for the report has been saved, the selection criteria can be
stored.
The selection criterion must be saved with the 'Add' button before the report can be
saved.

03/17/2021 - Page 46 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 52: Life Cycle Manager Administration - select search criteria for predefined report

If a date field is used as a selection criterion and 'since .....' as the operator at the same time, the value
field must be empty, otherwise the report will be loaded with the stored date when it is called up on
the report page.
If the value field is empty, the current date is always used as the starting date when the report is
loaded.

Example:

Field operant value result


Creation Date since 2 weeks <empty> all documents
created in the last 2
weeks are displayed

Creation Date since 2 weeks 02/20/2014 all documents the 2


weeks before
Created 02/20/2014
would become
displayed.

03/17/2021 - Page 47 of 62
FIS/edc Life Cycle Manager Technical Manual

3.2.2.5. settings

The settings show the addresses (baseAddresses) of the service endpoints of the FIS/edc Life Cycle
Manager service.

Figure 53: Life Cycle Manager Administration - set web service addresses

In order to be able to connect an application, make sure to replace "localhost" with the
name of the server if this is not used on the LCM application server.

3.2.2.6. Export definitions

When you click on "Export of definitions" you will see a list of the processes to be exported. The
runtime data is not taken into account during the export, only the process structure. This can be
useful if the structure is to be transferred to another instance of the LCM, eg when the server is
relocated or upgraded.

Selection of the process to be exported.

Figure 54: Life Cycle Manager Administration - selection of the process to be exported
Storage of the process as XML structure.

03/17/2021 - Page 48 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 55: Life Cycle Manager Administration - saving the XML structure

3.2.2.7. Import definitions

In order to load predefined processes and structures into the LCM, it is possible to import
an XML definition file.

First, the desired file should be selected using the "Browse" button, then the
selection is confirmed with "Ok".

Figure 56: Life Cycle Manager Administration - import process definition

Then, as shown in the figure, the desired structures (modules) can be selected for import.
A selection must always be made here; the complete file content is selected via the
"Select all" link. With the "Import selected elements" button, these are imported into the
database.

If you want or need to change the process name, please use the field
provided.

03/17/2021 - Page 49 of 62
FIS/edc Life Cycle Manager Technical Manual

03/17/2021 - Page 50 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 57: Life Cycle Manager Administration - selection of the import scope

3.2.3. test tool

The test tool is used to manually create documents in the FIS/edc Life Cycle Manager and
to set up test scenarios.

03/17/2021 - Page 51 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 58: Life Cycle Manager Test Tool - Menu

"Document Data - Create New"


Here you can add a new document to the LCM database. Adding a new document without
process information is not allowed. You can either select the process from the selection
list or enter a name manually. In the latter case, a new process will be automatically
created (under the entered name) and all existing modules will be assigned to this new
process. If both fields are entered, the selected process from the list will be preferred.

03/17/2021 - Page 52 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 59: Life Cycle Manager test tool - create a new document

After the successful creation of the document data, two new pieces of information are made
available: "Creation date" and "Document ID". In addition, two new links appear: "Create
Other" and "Add Module Data".

· "Document Data - Edit"


· "mark as finished"
· "Extinguish"

For these three operations, one must first load the document (by entering document ID
and clicking "Load" button). If the document has been loaded successfully, you can edit
the properties accordingly, mark the document as finished or delete the document.

03/17/2021 - Page 53 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 60: Life Cycle Manager test tool - edit document

"Add data module"


To add the module data, one must first load the document (similar to document
editing). The document properties are on the left. On the right side you can add the
module data for the loaded document and the selected module field.

03/17/2021 - Page 54 of 62
FIS/edc Life Cycle Manager Technical Manual

Figure 61: Life Cycle Manager test tool - add module data to the document

It is possible to add module data multiple times for the same document and module field. In such a
case, these data are stored one below the other in the same data word in the database.

3.3. Web service interface

The FIS/edc Life Cycle Manager offers an interface based on Http web services for third-
party systems, with which the FIS/edc Life Cycle Manager data can be manipulated.

3.3.1. Interactions with the document

Here you will find the most important methods that can be used in a FIS/edc Life Cycle Manager
process.
For more methods, please see theDescription of the interfaces on.

03/17/2021 - Page 55 of 62
FIS/edc Life Cycle Manager Technical Manual

3.3.1.1. Create document

Adds a new document.

http://localhost:8001/DocumentDataWcfService.svc/InsertDocumentData

3.3.1.2. File a comment on the document

Adds a comment to the document

http://localhost:8001/DocumentDataWcfService.svc/AddDocumentComment

3.3.1.3. Update document data

Updates document data

http://localhost:8001/DocumentDataWcfService.svc/UpdateDocumentData

3.3.1.4. complete the document

Marks a document as finished

http://localhost:8001/DocumentDataWcfService.svc/MarkAsComplete

3.3.1.5. Create module data

Adds new module data

http://localhost:8001/ModulDataWcfService.svc/InsertModulData

3.3.1.6. Append module data

Adds data to already existing module data (value).

http://localhost:8001/ModulDataWcfService.svc/AppendModulData

3.3.1.7. Update module data

Updates module data (value), no appending.

http://localhost:8001/ModulDataWcfService.svc/UpdateModulData

3.3.2. Description of the interfaces

Here you will find the complete description of the Http web services of the FIS/edc Life Cycle
Manager, which can be used by third-party systems.

03/17/2021 - Page 56 of 62
FIS/edc Life Cycle Manager Technical Manual

3.3.2.1. DocumentDataWcfService

This web service represents all operations that are possible on document data.

method description parameter

AddDocumentDataCom Adds a comment to the document CommentDataDto


ment

DeleteDocumentData Deletes a document Integer (DocumentId)

FindAll Selects all created documents

GetByID Selects a document based on the Integer (DocumentId)


document ID

GetByQuery Selects all documents that match PCQuery


the query criteria

InsertDocumentData Adds a new document DocumentDataDto

MarkAsComplete Marks a document as finished Integer (DocumentId)

03/17/2021 - Page 57 of 62
FIS/edc Life Cycle Manager Technical Manual

UpdateDocumentData Updates document data DocumentDataDto

3.3.2.2. ModuleDataWcfService

This web service represents all operations that are possible on module data.

method description parameter

AppendModuleData Adds data to already existing ModuleDataDto


module data (value).

FindAllModuldata Selects all created module data

GetModulDataById Selects all module data based on Integer (ModuleDataId)


the document ID

GetModulDataByQuery Selects all module data that PCQuery


match the query criteria

03/17/2021 - Page 58 of 62
FIS/edc Life Cycle Manager Technical Manual

InsertModuleData Adds new module data ModuleDataDto

UpdateModuleData Updates module data (value), no ModuleDataDto


appending.

3.3.3. parameter

Here you will find the complete description of the interface parameters of the FIS/edc Life Cycle
Manager

3.3.3.1. DocumentDataDto

CommentDataDto
ModuleDataDto

03/17/2021 - Page 59 of 62
FIS/edc Life Cycle Manager Technical Manual

3.3.3.2. CommentDataDto

03/17/2021 - Page 60 of 62
FIS/edc Life Cycle Manager Technical Manual

3.3.3.3. PCQuery

03/17/2021 - Page 61 of 62
FIS/edc Life Cycle Manager Technical Manual

3.3.3.4. ModuleDataDto

03/17/2021 - Page 62 of 62

You might also like