OMG

OMG_PipeManager Installation Guide

Version 1.1

Installation Guide

2

www.ibs.net

Contents Introduction .................................................................................................................................................. 3

Installation .................................................................................................................................................... 4

Verify whether the LPD service is running ...................................................................................................... 4

Install the OMG_PipeManager application ..................................................................................................... 9

Verify whether the Installation was successful ............................................................................................. 15

Verify whether the service can be stopped and restarted ............................................................................. 16

Create a LiveCycle Instance ......................................................................................................................... 17

Create a Windows printer queue .................................................................................................................. 19

Create a transaction log (Optional) ............................................................................................................... 22

Troubleshooting......................................................................................................................................... 23

Verify the configuration of the spool directory of the printer ......................................................................... 23

Uninstall the application ........................................................................................................................... 25

Add Additional LiveCycle Instances ........................................................................................................ 26

Create a LiveCycle instance ...................................................................................................................... 26

Restart the PipeManager service .............................................................................................................. 28

Installation Guide

3

www.ibs.net

Introduction The earlier installations of Adobe Central Output Server had the central print processor along with the pipe manager to process spool jobs and send the data file to the Central collector directory.

However, LiveCycle does not have a similar in-built mechanism to receive a data file in the watched folder directory.

To overcome this problem, a windows console application must be installed on the machine running Livecycle server. This application is called OMG_ PipeManager.

Installation Guide

4

www.ibs.net

Installation The following section describes the steps you must follow to install and verify the OMG_PipeManager application. You must follow these steps in the order in which they are listed or you may encounter problems:

1. Verify LPD service

2. Running the Setup file

3. Create a Livecycle Instance

4. Verify the installation

5. Add additional Livecycle Instances

Verify whether the LPD service is running

The LPD service enables client computers to print to the server using TCP/IP and the Line printer remote protocol.

Follow these steps to verify if the LPD service is up and running:

1. Go to Start > Control panel > Administrative tools > Services.

Check whether the LPD service is listed and started.

If the LPD service is up and running, proceed to Running the Setup File

If the LPD service is not listed, follow these steps to list LPD service under Services.

Windows 2008

1. Go to Start > Administrative tools > Server manager.

2. Select Features summary > Add feature > Select LPR Port monitor. Click Next.

Installation Guide

5

www.ibs.net

3. Click Install.

4. Select Close.

5. From Server manager, select Roles > Click Add Roles.

Installation Guide

6

www.ibs.net

6. Click Next.

7. Select Print and Document Services. Click Next and click Next again.

8. Select LPD service. Click Next.

Installation Guide

7

www.ibs.net

9. Click Install.

10. After the installation, select Close.

11. Restart the system.

Windows XP/Vista/7

1. Go to Start > Control Panel > Programs and Features > Turn Windows Features On or Off.

2. Select LPD service and LPR Monitor under Print and Document services.

3. Restart the machine.

Installation Guide

8

www.ibs.net

Before the Installation

If the OMG_PipeManager application service is already installed, you must uninstall all the components of the application before running the new Setup file.

Follow the steps below:

1. Uninstall OMG_PipeManager service

2. Install the OMG_PipeManager application

If you are installing the OMG_PipeManager application for the first time, proceed with the following steps to install the application:

Installation Guide

9

www.ibs.net

Install the OMG_PipeManager application

The Setup.exe file will help you to:

1. Copy all the necessary application files

2. Install the Windows resource kit as a part of installation.

The rktools utility enables you to run the OMG_PipeManager application as a windows service.

3. Map the service added to point to the executable.

Follow these steps to install the OMG_PipeManager application:

1. Download the setup file from the following link:

https://drive.google.com/a/ibs.net/folderview?id=0BzssSstxHVIFR3M3TDF5amI0dUE&usp=sharing

2. Copy the Setup.bat file to a local drive on the machine on which you have installed LiveCycle

ES4.

3. Run the Setup file by double clicking it. The Setup file extracts the required .dll files and .exe files

to the folder that you specify. The OMG_PipeManager utility will be installed in this folder.

4. Run the OMG_PipeManager.exe by double-clicking it. You access the Welcome page. Click

Next.

4. You access the Select Destination Location page. By default, all the files and directories are

extracted to C:\ProgramFiles\OMG_PipeManager. If you would like to change the default path, click the Browse button or type the full path name of the directory where you would like to extract the related files of the application. Click Next.

Installation Guide

10

www.ibs.net

5. You access the Select Start Menu folder page. Click Browse to change the default folder. Click Next.

6. You access the Select Additional Tasks page. Click Next.

Installation Guide

11

www.ibs.net

7. You access the Ready to Install page. Click Install.

8. It might take a while, be patient.

Installation Guide

12

www.ibs.net

9. Continue to install Windows Resource kit utility. You access the Welcome page of the installation wizard. Click Next.

10. You access the End-user License Agreement page. Read the license agreement carefully and if you agree to the terms, select I Agree and then click Next.

Installation Guide

13

www.ibs.net

11. You access the User Information page. The fields on this page are optional. Click Next.

12. You access the Destination Directory page. If you want to change the path where the application will be installed, click Browse and enter the new location. Click Install Now after you have specified the location.

Installation Guide

14

www.ibs.net

13. Wait for the installation to complete.

14. Click Finish to complete the installation of OMG_Pipe Manager.

Installation Guide

15

www.ibs.net

Verify whether the Installation was successful

To do so, follow these steps:

1. Verify whether the newly created OMG_PipeManager service is added under Windows services. To do so, Click Start > Control Panel > Administrative Tools > Services.

2. Navigate to the Installation directory (By default, this path is C:\Program Files\OMG_PipeManager) and make sure that the following files have been created and are present in the directory:

Note: If you use Windows 2008, the default path is : C:\Program Files( x86)\OMG_PipeManager

Config_pipe.exe: User interactive executable to create Livecycle Instance. User can provide:

The Name of the Livecycle Instance to create

Specify the Watched Folder path

ListOfinstances.txt: This file maintains information about Livecycle Instance added to the

machine

Watched_Folder_Path: Local folder path that serves as a place holder to contain XML data.

Name of the Instance: Generic name to identify the instance & Printer Queue

Log_Configure.txt: The configuration file to control the log of spool files transferred from IBS

Enterprise to Livecycle server by OMG_Pipe Manager Service.

OMG_PipeManager_Log.txt: The log file that contains the transaction spool files transferred

from IBS Enterprise to the Livecycle server by the OMG_PipeManager service.

Installation Guide

16

www.ibs.net

Verify whether the service can be stopped and restarted

1. Verify if the OMG_PIPEMANAGER service can be stopped:

1. Go to Start > Control Panel > Administrative Tools > Services.

2. Select the service OMG_PIPEMANAGER.

3. Click Stop.

2. Verify if the OMG_PIPEMANAGER service has started:

1. Go to Start > Control Panel > AdministrativeTools > Services.

2. Select the service OMG_PIPEMANAGER and check the Status column to see if it has

started.

3. Verify if the OMG_PIPEMANAGER service can be restarted:



3. Click Restart.

Important Note: It is strongly recommended to not to use this option. Pause it instead.

Installation Guide

17

www.ibs.net

Create a LiveCycle instance

The following section describes the steps you must follow to create a LiveCycle instance.

1. Navigate to the Installation Directory containing the required .dll and .exe files.

1. By default, this path is C:\Program Files\OMG_PIPEMANAGER

2. If using Windows 2008, the default path is : C:\Program Files( x86)\OMG_PIPEMANAGER

2. Open Config_Pipe.exe to create a new Livecycle Instance and follow the steps

1. Enter a unique name to identify the Livecycle Instance.

2. By default, the name of the instance is set to Instance1.

3. Specify the Watched Folder directory path to place the XML files to process.

4. Make sure that you select the path for the Watched Folder until the Input folder as shown in

the following figure:

5. Click Browse to specify a different path & click Finish.

6. Add a printer with a printer queue with the same Instance name

7. Follow the steps described in Creating a Windows Printer Queue.

Installation Guide

18

www.ibs.net

8. Click Ok.

9. Click OK to complete the wizard.

10. Verify if Instance Name is updated in ListOfInstances file.

1. Navigate to Installation directory. By Default, it is C:\Program Files\OMG_PipeManager

2. Using Notepad, open the ListOfInstances file and verify its contents.

3. The contents of the file should be updated as follows:

Name of the Instance: Name of the Livecycle Instance mentioned earlier.

Watched_Folder_Path: This is the directory in which the XML files will be placed for Livecycle to process. It is recommended that you do not change this path.

4. Restart the OMG_PipeManager service

Follow the steps described in Restarting the Pipe Manager Service.

Installation Guide

19

www.ibs.net

Create a Windows printer queue

Follow the steps listed below to create a windows printer queue:

1. Click Start > Devices and printers. Double-click the Add Printer icon.

2. You access the What Type of printer do you want to install? page. Select Add a Local printer.

3. In the Choose a printer port page, select Create a new port and then select Local Port from the drop-down list. Click Next.

Installation Guide

20

www.ibs.net

4. Add a new local port with the name \\.\pipe\instance1, where instance1 is the name of the instance you entered while creating a new LiveCycle instance as mentioned in the previous section. Click OK.

5. You access the Install the printer driver page. Under Printers, select Generic/Text Only and click Next.

6. Click Next.

7. Enter the printer name in the Printer Name field. Name it the same as the Instance name. For example, if the instance name is Instance1, the Printer Name should also be set to Instance1. Click Next.

Installation Guide

21

www.ibs.net

8. You access the Printer Sharing page. Make the printer shared and provide a share name. It must be the same as the LC Instance Name. For example, if the instance name is Instance1, the shared name is Instance1.

9. You can specify a location and comments for the printer. Click Next.

10. You should see the Youve successfully added Printer page. If you dont, go back to step 1 and try again. Click Finish

Installation Guide

22

www.ibs.net

Create a transaction log (Optional)

You can enable a pipe instance to create a log of files transferred for a particular instance.

The file containing the transaction details is OMG_PipeManager_Log.txt.

The log information includes following details:

Time of transfer

Instance name

Name of the file being moved

Status of the file in the printer queue

Follow the steps to enable the instance to create a transaction log:

1. In the OMG_PipeManager Installation directory, open the Log_Configure.txt file using Notepad.

2. Set the parameter Do you want to capture the transactions for this instance to Y

3. Restart the OMG_PipeManager service. Follow the steps described in Restarting the Pipe Manager Service.

Note: The default value for the parameter is N. Changing the value to Y will create an entry for each

file transferred against the instance by the OMG_PipeManager service in the

OMG_PipeManager_log.txt

The maximum size limit for this file is 500MB. If the file exceeds this limit, the file is refreshed.

Installation Guide

23

www.ibs.net

Troubleshooting Sometimes, you may run into a scenario where the files received in the printer queue may not get moved by the OMG_Pipe Manager Service.

Follow these steps to verify if the necessary components have been set to the correct value:

Verify the configuration of the spool directory of the printer

1. Click Start, type Run in the search box and then type Regedit. Click Ok.

2. You access the Registry editor. Expand to the following key:

HKEY_LOCAL_MACHINE > SYSTEM > CURRENTCONTROLSET > CONTROL > PRINT > PRINTERS

Select the printer that you added in the previous section. For example, Instance1.

3. Double click the Spool directory key to verify if spool directory path is configured.

Installation Guide

24

www.ibs.net

4. Note that Spool Directory string is appended with the name of the Instance. Edit the value if not set.

For example, if the value under the Spool Directory string is

C:\Windows\System32\Spool\Printers\Instance1

Then, a directory called Instance1 will be created under the directory path. Click Ok.

5. Restart the Print Spooler service & OMG_Pipe Manager service

To restart the print spooler & OMG_Pipe Manager Service, navigate to the Service manager window.

Click Start > Control Panel > Administrative Tools > Services. Select the respective service, right

click and select restart.

Installation Guide

25

www.ibs.net

Uninstall the application Follow the steps below to uninstall the OMG_PipeManager application from your system:

1. Goto Start > Control Panel> Programs & Features > Select OMG_PipeManager program > Right click > Select Uninstall.

2. Click Yes.

3. Click Ok. You have now uninstalled OMG_PipeManager from your system.

4. Restart the System.

Installation Guide

26

www.ibs.net

Add Additional LiveCycle Instances After the initial installation, if you want to add additional LiveCycle instances then you must configure the printer queue for each of these instances:

Follow these steps to add additional LiveCycle instances:

Create a LiveCycle instance

1. Navigate to the Installation Directory containing the required .dll and .exe files.

1. By default, this path is C:\Program Files\OMG_PipeManager.

2. If you use Windows 2008, the default path is: C:\Program Files( x86)\OMG_

OMG_PipeManager.

2. Open Config_Pipe.exe to create a new LiveCycle Instance and follow the steps

1. Enter a unique name to identify the LiveCycle Instance.

2. By default, the name of the instance is set to Instance1.

3. Specify the Watched Folder directory path to place the XML files to process.

4. Make sure that you select the path for the Watched Folder until the Input folder as shown in

the following figure:

5. Click Browse to specify a different path & click Finish.

6. Add a printer with a printer queue with the same Instance name

7. Follow the steps described in Creating a Windows Printer Queue.

Installation Guide

27

www.ibs.net

8. Click Ok.

9. Click OK to complete the wizard.

10. Verify if Instance Name is updated in ListOfInstances file.

Navigate to Installation directory. By Default, it is C:\Program Files\OMG_PipeManager

Using Notepad, open the ListOfInstances file and verify its contents.

The contents of the file should be updated as follows:

Name of the Instance: Name of the LiveCycle Instance mentioned earlier.

Watched_Folder_Path: This is the directory in which the XML files will be placed for

LiveCycle to process. It is recommended that you do not change this path.

11. Restart the OMG_PipeManager service

Follow the steps described in Restarting the Pipe Manager Service.

Installation Guide

28

www.ibs.net

Restart the Pipe Manager service



3. Click Restart.

Important: You must restart the OMG_Pipe manager service after adding a LiveCycle Instance for the

changes to take effect. You must do this every time you add an instance.

Documents

OMG