8 Office Suite - PDF Generator Installation

Note:

Further information about how to install the Office Suite can be found in the Client Installation Guide on Windows for Agile e6.2.1.0.

One main feature of the Office Suite is the PDF generation from a MS Office file. The Office Suite supports a PDF printer to convert Office documents into PDF files.

8.1 Installation

Note:

The installation package of the Office Suite PDF Service is located in the packages directory and named officesuitepdf.zip.

The zip file is contained in the officesuitepdf.zip installation package, located in the packages folder of the installation medium.

Copy the Office Suite PDF Generator installation package (officesuitepdf.zip) from the packages folder of the installation medium into a temporary directory.

Example:
```
copy y:\packages\officesuitepdf.zip c:\temp
```
Extract the installation package.

This unpacks the Agile e6.2.1.0 Office Suite PDF Generator ZIP archive into the axalant\bin\java subdirectory of your temporary directory.

Example:
```
unzip c:\temp\officesuitepdf.zip -d c:\temp
```
Extract the Agile e6.2.1.0 Office Suite PDF Generator package into the installation directory.

Example:
```
unzip c:\temp\axalant\bin\java\officesuitepdf.zip -d"c:\Program Files (x86)\Agile e6".
```
The installation package contains the following directories:
- PDF Service Root (C:\Program Files (x86)\Agile_e6\Office-Suite-PDF)
  - axalant
    
    -bin
    
    - intel-ms-nt6.1 (FMS Client binaries)
    
    - java (Java archives)
    
    - cmd (Windows scripts directory)
    
    - ini (Configuration files)
    
    - pdf (PDF service files)
    
    - scripts (UNIX scripts)
  - ext
    
    - bin
    
    - intel-ms-nt6.1 (external binaries)
    
    - java (external Java archives)
  - tmp (Logging directory)
Adapt the installation.

You need to adapt the startup script to setup the 32bit Java Runtime and the installation path of the Office Suite PDF Service. The script is located at the …\axalant\cmd subdirectory of the installation.

The pdf.bat script contains the following basic configuration settings:
```
set JAVA_HOME=<Java8_32bit_home>
set ep_root=<ROOT DIRECTORY OF THE OFFICE SUITE PDF SERVICE>
```
Example:
```
set JAVA_HOME=C:\Program Files (x86)\Java\jre
set ep_root=C:\Program Files (x86)\Agile_e6\Office-Suite-PDF
```

Adapt the service settings.

The OfsPdf.properties file is located at the axalant/pdf subdirectory of the installation. The file sets the environment variables needed to start and stop the Office Suite PDF Service.

The following properties have to be adapted.

Note:

The other properties must not be changed.

#
# ECI connection
#
host=<PLM host>
port=<PLM port>
env=<PLM env>
scope=BATCH
#
# Client modes to define widget behaviours on client side.
# the valid values are: BATCH, TEST
#
# BATCH: no widgets will be opened on client side.
# TEST: widgets will be opened on client side virtually.
#
mode=BATCH
 
#
# Directories
# <ROOT DIRECTORY OF THE PDF SERVICE> e.g. C:/Program Files (x86)/Agile_e6/Office-Suite-PDF
# <PDF WORK DIRECTORY OF THE PDF SERVICE> e.g. C:/officesuite/PDF
#
varenv.DATAVIEW_CROO=<ROOT DIRECTORY OF THE PDF SERVICE>/axalant/bin/${e6_windows_client_ep_mach}
varenv.ep_root=<ROOT DIRECTORY OF THE PDF SERVICE>
varenv.axalant_root=<ROOT DIRECTORY OF THE PDF SERVICE>/axalant
varenv.$TMP=<PDF WORK DIRECTORY OF THE PDF SERVICE>
#
# Host names
#
varenv.CLI_HST=pdfsrv
varenv.CLI_SRV=<PLM host>
#
# machine ID
#
varenv.EP_MACH=${e6_windows_client_ep_mach}
varenv.CLI_HWS=${e6_windows_client_ep_mach}
#
# Security settings
#
Security.KeyStoreFile=file://<ROOT DIRECTORY OF THE PDF SERVICE>/init/wallet/private/batch/cwallet.sso
Security.KeyAlias=orakey
#
# PLM Client
#
client1=<PLM user>,<PLM password>,office.pdf.OfsPdf

Note:

To add a wallet, refer to the Security Guide for Agile e6.2.1.0 Chapter Wallets > Manual Creation of Wallets > Batch.

Note:

The password has to be encrypted with the batchkeytool. For more information, refer to the Security Guide for Agile e6.2.1.0 Chapter Encryption > Encrypt Passwords.

Note:

The PDF work directory has to be created and entered in the EDM Server configuration, PDF Service, and the PDF printer.

8.2 Configuration

The Office Suite needs some information to access the PDF printer and to exchange the files.

8.2.1 Printer Setup

The PDF printer has to fulfill the following prerequisites:

Generate PDF file without user interaction (pure batch printing).
Configurable PDF output folder.
Possibility to create a <PDF-Filename>.log file in the PDF output folder, after PDF file creation.

Note:

The PDF output folder is the exchange folder between the PDF printer and Agile e6.

Note:

Any folder can be used, but the configuration of the PDF printer has to match the configuration of the Agile EDM Office Suite PDF service.

8.2.1.1 Post PDF Creation Script

Prerequisite for PDF printer is the <PDF-filename>.log file creation (see above) in the PDF output folder. This file is the "Ready" file for the batch client to trigger the PDF file check in.

If your PDF printer does not create a <PDF-filename>.log file per default, there often exists the possibility to execute an application after printing. This could be used to create the <PDF-filename>.log file. It must be possible to set the filename "<PDF-filename>.log" as a parameter. The following steps describe the general setup of such a mechanism.

Create a file "createlog.bat" in the PDF output folder which looks like this:

set FILENAME=%~n1 
set FILEPATH=%~dp0% 
echo Done > "%FILEPATH%/%FILENAME%.log"

Configure your PDF printer to execute the Windows cmd shell (e.g.: C:\WINDOWS\system32\cmd.exe) with the following parameters (e.g %f is the file name parameter) :
```
/c C:\officesuite\pdf\createlog.bat %f
```

8.2.2 Setting up the PDF Printer

To setup the PDF printer

Start Agile e6.
Open menu Manager > Office Suite > PDF Printer.
Select the PDF printer from the printer list.

When you select the PDF printer, the following Office Suite configuration parameters are added to the Office Suite configuration table (System > OfficeSuite > Configuration table):

GDM_PDF_BATCH
GDM_PDF_DIRECTORY

The value of this configuration parameter has to be the same as the value for TEMP in the OfsPdf.properties file. Add "\*.pdf" at the end of it.
GDM_PRINTER
GDM_PRINTER_DRIVER
GDM_PRINT_PORT

Note:

GDM_PRINTER, GDM_PRINT_DRIVER, GDM_PRINT_PORT are set automatically.

Note:

This is a section of the OfsPdf.properties file:

host=<PLM host name>
port0=<PLM eci port>
env=<PLM environment name>
varenv.ep_root=<PDF service root>
varenv.axalant_root=<PDF service binary root>
varenv.EP_MACH=intel-ms-nt6.1
varenv.CLI_HWS=intel-ms-nt6.1
varenv.CLI_HST=<Client host name>
varenv.CLI_SRV=<PLM host name>
varenv.$TMP=<PDF file exchange folder>
client1=<Connect information>

The value for the Office Suite configuration parameter GDM_ARC_NOD has to be the same as the value for varenv.CLI_HST in the OfsPdf.properties file.
In the OfsPdf.properties file, the following has to be set:
- host (e.g. edmhost)
- port (e.g. 20001)
- env (e.g. edmref)
In the OfsPdf.properties file, the correct user has to be entered under "client1".

Link the PDF Generator to a lifecycle:

The PDF Generator has to be linked to the respective transition states for the STD-DOC lifecycle. The Office Suite provides a LogiView procedure (GdmBatch/Archiv) to add a job into the PDF job list. This LogiView procedure is a transition procedure for the usage within the lifecycle of the Office document.

The following transition settings can be used:

Field	With change management	Without change management
From	220	120
State (From)	Approved	In Approval
To	230	230
State (To)	Release	Released
System	X
For Change Management	X
Pre-Action	xedbusr_tor_rr_vr	xedbusr_chk_no_obj_ews & xedbusr_tor_rr_vr & sig_cre_sgn
Post-Action	xedbusr_tor_sa_uv & xchg_prd_unt_poa & GdmBatch/Archiv	xedbusr_tor_sa_uv & xedbusr_rst_prd(260) & GdmBatch/Archiv

Thus, when an Office Suite document reaches this state, a PDF is created automatically.

Add "GdmBatch/Archiv" to the respective states in the Lifecycle mask.

Note:
After updating the lifecycle states, the client needs to be restarted.
For every file type, for which a PDF should be created, the 'Create Archive Format' checkbox has to be selected in the File type mask (System > Office Suite > File Types).

Note:
The PDF generation can only be used for file types of the storage type Single.

8.2.3 Configure the Agile EDM Office Suite PDF Service

The Agile EDM Office Suite PDF Service does require some information about the local application, e.g. the exchange file between the PDF printer and Agile e6.

The configuration file of the Agile EDM Office Suite PDF Service has corresponding settings within the Agile e6 Office Suite configuration (System > Office Suite > Configuration).

The configuration table describes the settings of the configuration file of the Agile EDM Office PDF Service and the configuration settings of the EDM Office Suite configuration.

Office Suite configuration for the PDF service:

Variable	Value	Description
GDM_ARC_NOD	Hostname of the PDF Service machine (e.g. pdfsrv)	Host on which the PDF files are created (PDF batch client)
GDM_PDF_BATCH	RUN	Control parameter of the job 'PDF Generation'
GDM_PDF_DIRECTORY	PDF exchange directory (e.g. C:\officsuite\PDF_generation\*.pdf)	Working file of the PDF generator (including absolute path and generic file name)

8.3 Office Suite PDF Service

The Office Suite PDF Service must run as a console application.

To run the Office Suite PDF Service use the pdf.bat command script located in the …\axalant\cmd sub directory of the installation.

The script is called with

pdf.bat –c