User Manual. Summary. Author: SYMTRAX. Compleo Gateway User Manual 1

Transcription

1 User Manual Summary This manual will give an insight into some of the major functionalities of the product and the best practices to use while working with Compleo Gateway. Author: SYMTRAX Compleo Gateway User Manual 1

2 Table of Contents 1 Introduction Getting started with Compleo Gateway Configuring Compleo Gateway Supervisor Compleo Gateway Interface Configurations Processes The Log viewer Gateway Services Status Manage PC File Formats Preferences Advanced Settings Configuration Settings Machine Settings Find/Find Next Open Folder Process Files Again Overview - Supervision and Scheduled Tasks Programming the Scheduler Removing a Schedule Supervision i5 System SAP R/ BC-XOM Connector SAP Print Service PC Folder Supervision Mailboxes XML Stream connection XPS Printer Compleo Gateway User Manual 2

3 2.4.9 Scheduling Task for Query Designer templates Schedule Tasks Scenario Manager Overview of the concept of Scenarios Scenario Conditions Additional Actions Managing Actions Error Management Editing Scenario Scheduling a Scenario Activating & Deactivating a Scenario Deleting Scenario Other options Compleo Gateway- Interactive Compleo Gateway Service Definition Logs Created by Gateway SAP Configuration for BC-XOM Connector Setup of a new RFC destination: Declaration on an RFC server Create a new ROMS (Real Output Management System) Create a new LOMS (Logical Output Management System) Create an Output device Changing the call back time Processing SAP spools using BC-XOM Connector (Without installing any package on the server) Print a report immediately ISERIES 400 Defined Security Examples iseries Compleo Gateway User Manual 3

4 Contact us Index Table of Figures Compleo Gateway User Manual 4

5 1 Introduction Compleo Gateway is a software that serves as a bridge between your devices (i5 system outqueues, SAP R/3 printers, BC-XOM Connector, POP3 mailbox, XPS printers, scheduled queries) and your hosting service provider. Each new file that arrives in a supervised repository is checked by the Compleo Gateway and sent to the hosting service provider. These files will then be processed and distributed as per the business needs. This is the program which works as a background task on the machine where the Compleo Gateway is installed. When it is started, the Compleo Gateway button is displayed in the system tray of your PC. It constantly monitors the supervised repositories configured on the Compleo Gateway, checking to see if the documents that arrive meet the conditions set-up in the Configurations. The documents will get processed, if the conditions are satisfied. Figure 1: Compleo Gateway Architecture Compleo Gateway ensures data integrity and data security by encrypting the data that is being transferred. Also, the data compression feature of Compleo Gateway makes data transfer quick and hassle-free. Compleo Gateway is Interactive as well as configurable as a Service. 2 Getting started with Compleo Gateway 2.1 CONFIGURING COMPLEO GATEWAY SUPERVISOR Compleo Gateway allows you to send the input documents to process them and generate the output. To send the input documents you need to configure the Compleo Gateway Supervisor settings under the Preferences dialog box. Compleo Gateway User Manual 5

6 Go to Preferences. This displays the Preferences dialog box. Click Compleo Gateway Supervisor tab. Figure 2: Compleo Gateway Supervisor Settings Compleo Gateway User Manual 6

7 Enter the following details: Customer ID: Enter the customer ID, used to connect to the Gateway Supervisor. Customer Name: Enter the customer name. Compleo Gateway Supervisor Address: Enter the address of the Compleo Gateway Supervisor. Folder for the output files: Select a local folder where you want to save the processed output files. Advanced settings: Click this button to configure the advanced encryption settings. For more details, refer to the Advanced Settings section. Once the above settings are done the Compleo Gateway can send the input documents to the Compleo Gateway Supervisor. 2.2 COMPLEO GATEWAY INTERFACE Compleo Gateway interface consists of the following tabs: CONFIGURATIONS To open the Compleo Gateway, go to Start All Programs Symtrax Compleo Suite Compleo Gateway. This tab allows you to manage configurations for Compleo Gateway. You can choose the connectors and define task settings for the configuration. In this configuration, you can create and view the supervised repositories. For the supervised repositories, you can define scenarios. Figure 3: Configurations Interface Compleo Gateway User Manual 7

8 The main window is presented as follows: (1) Top of this interface displays a ribbon with the following groups: General: You can perform following tasks from this tab: Save: Save the settings for Configurations. Configuration Settings: Click this button to manage the connectors and task settings. Device Supervision: You can perform following tasks from this tab: Activate: Allows you to Activate the supervision of the selected target repository (Outqueue, Printer, PC Folder, Mailbox, Scheduled Query). Pause: You can pause the supervision of the selected target repository (Outqueue, Printer, PC Folder, Mailbox, Scheduled Query). Schedule: Clicking this icon redirects you to the Scheduling window. Scenario Management: You can perform following tasks from this tab: : Clicking this command button will redirect you to Scenario Manager where you can create a new scenario for the selected i5 System Outqueue / SAP R/3 Printer / BC- XOM Connector Printer / SAP Print Service Virtual Printer/ PC Folder/ XPS Printer/Query Scheduled Tasks. : Clicking this command button will redirect you to Scheduling window where you can schedule a new activity / task for selected scenario for the selected i5 System Outqueue/ SAP R/3 Printer / BC- XOM Connector Printer/ SAP Print Service Virtual Printer/ PC Folder/ XPS Printer/Query Scheduled Task. Compleo Gateway User Manual 8

9 : Clicking this command button will move the selected scenario on the upside available position in the List View Pane for the i5 System Outqueues / SAP R/3 Printers/ BC- XOM Connector Printer / SAP Print Service Virtual Printer / PC Folders/XPS Printer/Query Scheduled Tasks. : Clicking this command button will move the selected scenario on the downside available position in the List View Pane for the i5 System Outqueues / SAP R/3 Printers /BC- XOM Connector Printer/ SAP Print Service Virtual Printer/PC Folders/ XPS Printer/Query Scheduled Tasks. : Clicking this command button will delete the action(s) / condition(s) for the selected i5 System Outqueue /SAP R/3 Printer/ BC- XOM Connector Printer / SAP Print Service Virtual Printer/ PC Folder/XPS Printer/Query Scheduled Task. You can select multiple scenarios. : Clicking this command button will Cut the action(s)/condition(s) for the selected i5 System Outqueue / SAP R/3 Printer/ BC- XOM Connector Printer / SAP Print Service Virtual Printer/ PC Folder/XPS Printer/Query Scheduled Task. You can select multiple scenarios. : Clicking this command button will Copy the selected Scenario action(s) / condition(s) to the clipboard for Paste process to be carried out on the selected i5 System Outqueue / SAP R/3 Printer / BC- XOM Connector Printer / SAP Print Service Virtual Printer/ PC Folder /XPS Printer/Query Scheduled Task. You can select and copy multiple scenarios. : Clicking this command button will paste the copied or cut action(s) / condition(s) for the selected i5 System Outqueue / SAP R/3 Printer/ BC- XOM Connector Printer / SAP Print Service Virtual Printer/ PC Folder/XPS Printer/Query Scheduled Task. You can select multiple scenarios. : Clicking this command button will redirect you to Find dialog box where you can enter the text you want to search. : Clicking this command button will navigate to the next instance of a search result. : Clicking this command button will reset the history of the scenario action such as Last process date, Processes, Successes, Failures and comments defined for the selected scenario. : Clicking this command button will reset the statistics for all the scenario actions. Compleo Gateway User Manual 9

10 Import/Export: You can perform the following tasks from this tab: Import Configuration: loads the saved configuration file in Compleo Gateway. Thus the active repositories and scenario settings of the configuration file will be reflected in Compleo Gateway. Export Configuration: allows saving the current configuration as a.ccf file at the desired location. You can use this saved file to Import the saved configuration when required. Outqueue Supervision: This group appears under the Configurations tab. It appears only when you select an iseries Outqueue. You can perform the following tasks from this tab: Refresh List: Clicking on this command button will refresh the output stream of outqueue and the available outqueues will be displayed in List View Pane. Supervise Outqueue: This command button is enabled only when you select Supervisable Outqueue from the List View Pane of the i5 System connection. On clicking this button, you will be redirected to the Supervised Outqueue settings window, where you can create a new Supervised Outqueue. Delete Supervision: This command button is enabled only when you select Supervised Outqueue from the List View Pane of the i5 System connection. Click this command button will delete the supervision and delete all the scenarios and scheduled tasks for the Supervised i5 System Outqueue. Reset Supervision: Resets the supervision parameters of Outqueue and set the supervision in its original form. Free Supervisable Outqueue: This option is active only when you select a Non- Supervisable Outqueue from the List View Pane of the i5 System connection. It will remove any existing supervision and make the outqueue available for the Supervision. (2) The left hand side of the window displays the Tree view of your system. The distinguish category objects are displayed with different icons. (3) The right hand side List View Pane will show the specific display: Compleo Gateway User Manual 10

11 For i5 Series Systems: The list of available outqueues for supervision under the selected i5 Series system connection. The list of Schedule Task and associated Path. The list of scenarios associated with the selected supervised Outqueue. For SAP R/3 Systems: The list of available Supervision and associated Printer Name under the selected SAP R/3 connection. The list of Schedule Task and associated Path. The list of scenarios associated with the selected supervised Printer. For BC-XOM Connector: The list of available SAP Systems connected through BC-XOM Connector. The list of available SAP Printers. The list of scenarios associated with the Printer. For SAP Print Service: The list of available SAP Printers. The list of scenarios associated with the Printer. For PC Folders: The list of available Supervision and associated Folder Path of the selected PC. The list of Schedule Task, Recurse status and associated Path. The list of scenarios associated with the selected task of PC folder. For Mailboxes: The list of available Mailbox connections. The list of Schedule Task and associated path. The list of scenarios associated with the Mailbox. For XML Stream Connector: The list of available dataq for Supervision under the selected XML Stream connection. The list of scenarios associated with the selected DataQ. For Symtrax XPS Printer: The list of available XPS printer for Supervision under the selected XPS Printer connection. The list of scenarios associated with the selected XPS printer. For Scheduled Query task: The list of available scheduled task for Supervision under the selected scheduled queries. Compleo Gateway User Manual 11

12 The list of scenarios associated with the selected scheduled task. Note: By right clicking on any object in any of the window pane, a contextual menu is displayed. This context menu will change depending on where you have clicked and will give you access to all the commands and functions available for that object PROCESSES Processes interface gives you an overview of the files with various statuses Waiting, Sending, Sent, Processing, Processed, Error and Warning. It allows you to view detailed information for the files in error or warning state. You can also see the Compleo Gateway usage reports. Figure 4: Processes Interface (1) All Supervised Locations: This pane displays the list of Supervised Repositories (i5 Systems Outqueues, SAP R/3 Printers, BC-XOM Output devices, SAP Print Service Virtual Printers, PC Folders, Mailboxes, DataQ, Scheduled Queries and Symtrax XPS Printer). Active Supervisions, at the present time, is denoted by and followed by the name of the Supervised Repository (i5 Systems Outqueue/SAP R/3 Printer/ BC- XOM Output device/ PC Folder/ SAP Print Service Virtual Printers/ PC Folders/ Mailboxes/DataQ/DataQ/ Scheduled Queries and Symtrax XPS Printer). In-active Supervision, at the present time, is denoted by and followed by the name of Supervised Repository (i5 Systems Outqueue / SAP R/3 Printer/ BCXOM Printer/ SAP Print Service Printer/ PC Folder/ Mailbox/Symtrax XPS Printer). Pause Supervision, at the present time, is denoted by and followed by the name of Supervised Repository (i5 Systems Outqueue / SAP R/3 Printer/ BCXOM Printer/ SAP Print Service Printer/ PC Folder/ Mailbox/Symtrax XPS Printer). Compleo Gateway User Manual 12

13 (2) Document Status: This pane displays the list of documents in various stages - Waiting, Sending, Sent, Processing, Error, Warning and Processed. The documents in different states are identified by the following icons: : This indicates that the document is waiting to be sent. : This indicates that the document is currently being sent. : This indicates that the document is sent and is waiting to be processed. : This indicates that the document is currently being processed. : This indicates that the document has processed successfully. : This indicates that the document processing has failed and it is in the error state. : This indicates that the document processing has generated some error and needs to be checked. (3) Document processing status: This pane displays the error or warning details that have occurred while processing the document. (4) Gateway Processes Ribbon: This ribbon consists of the following groups: Information: You can perform the following tasks from this group: It displays the Compleo Gateway details. User Account: Displays the user account running the service (if Compleo Gateway is a service)/currently logged in (if Compleo Gateway is interactive). If Compleo Gateway is a service you can change the user account from the Machine Settings window. Note: If Gateway is interactive you cannot change the user account. Machine Settings: Click this button to configure the Compleo Gateway machine settings. It also displays whether the data transfer is encrypted or not. Compleo Gateway User Manual 13

14 Gateway activity: You can perform the following tasks from this group: Start: This button starts the Gateway. Stop: This button stops the Gateway. Restart: This button stops and then starts the Gateway. Note: If the Compleo Gateway is running as a Service, then these options will Start, Stop and Restart Compleo Gateway Service respectively. : This button will notify Compleo Gateway to update its configuration, if required. The current Processes tab will be updated accordingly. Monitoring: You can perform the following tasks from this group: Past processes Displayed: Select the relevant options to display the processes details according to the selected status. The available options are: All: This option will display the list of all the documents processed. Error: This option will display only those documents which were processed with error. Success: This option will display the details of those documents which were processed successfully. Delete: If the selected document is not yet sent to the Gateway Supervisor, then this command kills the sending process. Windows Event Viewer: Opens Windows Event Viewer. This window allows you to browse and manage the event logs. (5) Status Bar: It shows the last updated details, count of the documents in waiting, sending, sent and processing statuses. Last Updated: Displays the date and time the console was last updated. Documents Waiting: Displays the number of documents in the queue waiting to be sent. Documents Sending: Displays the number of documents currently being sent. Compleo Gateway User Manual 14

15 Documents Sent: Displays the number of documents already sent. Documents Processing: Displays the number of documents/tasks being processed by the Gateway Supervisor. Service Status: Displays the current status of the selected service THE LOG VIEWER This allows the user to monitor the error or warning messages that are automatically saved when the different scenarios are run. These may be error messages informing the user that a scenario has failed or warning messages informing the user of any problems or failure to run a scenario. The execution of specific tasks may be followed and the cause of any failures given GATEWAY SERVICES STATUS Figure 5: Processes Tab Log Viewer The Gateway Service Status appears in the status bar of the Processes tab. It displays the current status of the Gateway service. To view the Services status: Go to Processes tab. In the Status Bar, click of the services:. This displays a pop-up with the current status Figure 6: Service Status In the Service Status pop-up: : Indicates that the service is currently running. : Indicates that the service is currently stopped (not running). Compleo Gateway User Manual 15

16 2.2.5 MANAGE PC FILE FORMATS You can manage PC file formats for Compleo Gateway. To view Manage File Formats dialog box: On the Processes tab, in the Information group, click Settings dialog box.. This displays the Machine Click Manage PC File Formats button. Figure 7: Machine Settings Manage PC file formats This displays the Manage File Formats dialog box: Figure 8: Manage File formats Gives the option to view and manage the extensions used for every file handled by Compleo Gateway (ASCII, EBCDIC, CSV, CTS, PDF, XML, XPS ), and the options associated with each extension. Compleo Gateway User Manual 16

17 Any other file extension can be listed by specifying its extension and format, in the Manage File Formats option dialog box. You can Add, Edit, and Remove file extension by using relevant command control given on the top right corner of this window tab. Add: Click button to add new file extension; the New File Extension dialog box will appear where you have to enter the file format and extension that will be associated with the type of file format you entered. Edit: Click button to edit file extension. Remove: To remove the existing file extension type, click button PREFERENCES To view Preferences dialog box: Click and select the Preferences option. Interface: Figure 9: Preferences - Interface Select Interface Language: Allows you to change the language of the interface. Choose any of the desired language from the drop down list (English, French, German, Spanish or Japanese). Note: The selected language interface will appear on restarting Compleo Gateway. Automatically run Compleo Gateway Interface when I log on to Windows: If you select this check box, when you log on to Windows next time, the Compleo Gateway Interface will start automatically. If unchecked, you will have to manually start the Compleo Gateway. Compleo Gateway User Manual 17

18 Open main window when Compleo Gateway Interface starts: If you select this check box, the main application window will open. If unchecked, the Compleo Gateway Interface will run as a background process. Exit the application on closing main window: If you select this check box, the application will be closed on closing the main window. By default, when this option is not selected, then the window is closed, the application still keeps running in the background and can be seen in the Processes list of the Task Manager window (on the right of the task bar). Compleo Gateway Supervisor: Figure 10: Preferences Compleo Gateway Supervisor Customer ID: Enter the customer ID, used to connect to the Gateway Supervisor. Customer Name: Enter the customer name. Compleo Gateway Supervisor Address: Enter the address of the Compleo Gateway Supervisor. Folder for the output files: Select a local folder where you want to save the processed output files. Advanced settings: Click this button to configure the advanced encryption settings ADVANCED SETTINGS The Advanced Settings allows you to configure and select the data encryption method. You can also choose to compress the data while sending. It ensures data integrity and data security by encrypting the data that is being transferred. Also, the data compression feature of Compleo Gateway makes data transfer quick and hassle-free. Compleo Gateway User Manual 18

19 To view the Advanced Settings dialog box: Click and select the Preferences option. In the Compleo Gateway Supervisor tab, click Advanced Settings: Figure 11: Preferences Advanced Settings This displays the Advanced Settings dialog box: Figure 12: Advanced Settings In this dialog box you can define how much data will be encrypted and compressed while sending to Gateway Supervisor. Compleo Gateway User Manual 19

20 Encrypt data transfer: Select this check box to enable data encryption, while sending files to the Gateway Supervisor. Select encryption method: Select from the drop down, the encryption method to be used while sending files. Get encryption key: Click this button to automatically generate the encryption key. Cloud Encryption Key: Displays the generated encryption key. Compress data transfer: Select this check box to reduce the file size while sending it CONFIGURATION SETTINGS The Configuration Settings allow you to choose the connectors. You can even manage the task settings. To view the Configuration Settings dialog box: On the Configurations tab, in the General group, click. Connectors: In this tab, choose the connectors you want to work with. Figure 13: Configuration Settings - Connectors Display the following connector: Select the check boxes to display the connectors in tree view of the Administrator. Compleo Gateway User Manual 20

21 i5 (iseries/ AS/400) servers) SAP BC-XOM SAP virtual printer Mailboxes SAP Active Connector My Computer XML Stream Connector Symtrax XPS Printers Scheduled tasks for Query Designer Templates Important: When you select the Symtrax XPS printers check box, you will be directed to install the XPS printer. Tasks: Processes tab Figure 14: Configuration Settings - Tasks Keep a trace of the past events during days: Enter the maximum number of days for which you want to save the history of events. Do not show more than _ waiting documents: Enter the maximum number of waiting documents to appear in the Processes tab. Do not show more than_ processed documents: Enter the maximum number of processed documents to appear in the Processes tab. Compleo Gateway User Manual 21

22 2.2.9 MACHINE SETTINGS The Machine Settings allow you to manage the activity settings. You can define here the interactive or service mode of Compleo Gateway. To view the Machine Settings dialog box: On the Processes tab, in the Information group, click. Figure 15: Machine Settings - Activity Run the Gateway server interactively: Select this option to run Gateway in the interactive mode. Start automatically when the application starts: Select this check box to automatically run Gateway on opening interface, when Gateway is in the interactive mode Run the Gateway server as a service: Select this option to run Gateway in the service mode. Run the service with this profile: Select this option to run the Gateway using the current profile. You can also edit the current profile. Start automatically when Windows starts: Select this check box to automatically run Gateway on starting Windows, when Gateway is in the Service mode. Manage PC File Formats: Click this button to manage the file formats that can be read by Compleo Gateway. Compleo Gateway User Manual 22

23 FIND/FIND NEXT Find/Find Next is located under the Configurations tab, in the Scenario Management group. This option allows searching for every occurrence of the text listed below in an outqueue/printer/pc folder: Title of the Scenario and its comment Text of condition(s) Parameters of Actions like folder name, Path, or file name To find the next occurrence of the text in the list, click OPEN FOLDER Open Folder option is located under the Processes tab, in the File group. This option allows you to open the folder on your local machine where the selected document is saved. To locate the local machine folder: Method 1: Go to the Processes tab and select a document that you wish to locate on your local machine. In the File group, click. Figure 16: Open Folder Compleo Gateway User Manual 23

24 Method 2: Right-click on a document and select Open Folder option. This opens the folder where the selected document is saved PROCESS FILES AGAIN Process Again is located under the Processes tab in the File group. This option allows you to resend document(s) to the Gateway Supervisor in order to process it again. To resend the document(s): Method 1: Go to the Processes tab and select the document(s) that you wish process again. In the File group, click. Method 2: Figure 17: Process Again Right-click on a document and select Process Again option. Compleo Gateway User Manual 24

25 This will resend the selected document(s) to the Gateway Supervisor for processing it again. Figure 18: Documents sent to it process again Note: You can reprocess the documents, only when they are in the Processed or Error state. 2.3 OVERVIEW - SUPERVISION AND SCHEDULED TASKS Compleo Gateway allows you to set supervision on repositories. You can create scenarios for supervision. These scenarios allow you to define various conditions and the process to be applied on the files satisfying those conditions. Once the scenario is set, Gateway will constantly monitor these repositories. As soon as a file arrives in any of these repositories, it is checked for the conditions specified in the scenarios and if the file satisfies those conditions, then the Gateway will apply the process specified in the scenario. You can also automate the task of supervision by scheduling them. You can choose to schedule the task on daily, weekly, monthly, or yearly basis. To schedule a task, select an active repository. On the Configurations tab, in the Device Supervision group, click. You can also schedule an active repository by right clicking on the active supervised repository and then selecting Schedule option. You can create multiple schedules for the same task by checking the Show multiple Schedules check box and then clicking New button to add multiple schedules for the same task PROGRAMMING THE SCHEDULER Right-click on the required file repository (i5 System outqueue/sap Active Connector printer/ BC-XOM output device/ SAP Print Service virtual printer/ PC Folder/ Mailboxes/ Supervised DataQ /XPS Printer) to display the context menu. Compleo Gateway User Manual 25

26 Figure 19: Right-click context menu Select Schedule option, to display Scheduling dialog box. Figure 20: Scheduling dialog box Select Check this box to activate scheduling checkbox to activate scheduling. Using the Scenario scheduling dialog box, you can program the following: Event time: Defines the time range during which the Schedule will be active. This range can cover two days if the start time is not 00h00 and not higher or equal to the end value i.e. 14h00 to 13h00 will cover two days whereas 00h00 to 12h00 will only cover one day. Recurrence pattern: Defines when the Schedule is to be active. The Recurrence of the schedule can be as often as desired (every day, weekly, monthly or annually): Daily: Allows you to configure the schedule to run daily. Further, you can continue the schedule in effect by selecting the option every... day (s) and entering the appropriate range of consecutive days in the text box next to Every. Valid value is any number from 1 to 999. Compleo Gateway User Manual 26

27 Figure 21: Recurrence Pattern Daily Note: If you set schedule to continue to next day, then you get the message box of "only one valid day (everyday)". This means that the options Every Week Day is not in effect/available for schedule settings. Weekly: Allows you to configure the schedule on a weekly basis. Here you have an option of selecting the day(s) of week you want to set the schedule to run. By default, Mon (Monday) will be selected. You can select multiple days by checking the appropriate check boxes next to the day of week. Compleo Gateway User Manual 27

28 Figure 22: Recurrence Pattern Weekly Monthly: Allows you to configure the schedule on monthly basis. You have an option of setting the schedule on a particular day (numeric / date e.g. 1, 2,..., 31) of the month or you can select the particular day of every month. For setting a schedule on a particular day of every month you have to select the appropriate combination of the options from both the drop down lists given here, on which you want the schedule to be in effect. Figure 23: Recurrence Pattern Monthly Annually: Allows you to configure the schedule on annual / yearly basis. You have an option of setting the schedule on a particular date of every month in a year or you can select the particular day of every month in a year. For setting a schedule on a particular Compleo Gateway User Manual 28

29 day of every month in a year you have to select the appropriate combination of the options from all three the drop down lists given here, on which you want the schedule to be in effect. Duration: Figure 24: Recurrence Pattern Annually Allows you to set the range of days during which this Schedule is valid. If you select only a Start date and do not give an End date then schedule range will be an endless loop. Graphical Notations: The graphical notation in color blocks for Schedule settings are: Selected Zone: The schedule will be active during the selected period. Non Selected Zone: No schedule will be active during the periods in this color. Current selection: Period range currently selected for viewing/editing range settings. Partial Selection: This color shows that the schedule will only be active for a part of the time period selected by you for the active day. Figure 25: Selecting Scheduling Activity Compleo Gateway User Manual 29

30 The time range is displayed in the lower bar when you select the box. It lets you further specify the schedule (in terms of minutes), where Active is range and is Inactive range. For Example: Figure 26: Active/Inactive Schedules In the above example the schedule will be inactive from 16:10 to 16:20. Deleting Recurrence Range: You can delete all the Schedule Recurrence Range in only one step. To do this, click button shown in the upper part of this dialog box. Selecting Entire Recurrence Range: You can select entire range of Schedule Recurrence in one step. To do this, simply click button shown in the upper part of this dialog box REMOVING A SCHEDULE To remove schedule from the folder do one of the following: Right-click the Scheduled i5 Series System Outqueue/ Scheduled SAP R/3 Printer/Scheduled BC-XOM Output Device/ Scheduled SAP Print Service virtual printer/ Scheduled PC Folder/ Scheduled Mailbox and select the Schedule... from the context menu. You will be redirected to the Scheduling option dialog box. Then in the Scheduling option dialog box, un-check the box to deactivate the scheduling. Select the Scheduled i5 Series System Outqueue/ Scheduled SAP R/3 Printer/ Scheduled BC-XOM Output Device/ Scheduled SAP Print Service virtual printer/ Scheduled PC Folder/ Scheduled Mailbox/ Scheduled XPS printer. On the Configurations tab, in the Device Supervision group, click. You will get a warning message box, click YES and all schedules will be removed from the selected folder. Figure 27: Compleo Gateway Compleo Gateway User Manual 30

31 2.4 SUPERVISION I5 SYSTEM In order to validate an OutQ by Compleo Gateway, the OutQ must be associated with a DataQ. Once the association is made, a SuperQ is obtained. When a spool file located in a supervised OutQ moves to ready status, a token is generated in the SuperQ. The iseries 400 supervision program examines the SuperQ when a token reaches it. It then sends it back to the computer where Compleo Gateway analyzes it. If it corresponds to the conditions specified in one of the scenarios that were created, the scenario applies the various tasks assigned to the spool file Configuring iseries system To configure a connection to an i5 Systems server, right-click i5 Connection and select New Then i5 Connection Settings dialog box will be displayed. Figure 28: i5 Connection Settings-Connection Connection: This tab allows you to configure a connection of an i5 Series System server. Compleo Gateway User Manual 31

32 Server: Name: Enter the Connection Name in the space provided, as you want it to appear in the Configuration tab. Connection Type: Select the connection type from the drop down list. Connection IP Address: Enter the IP address of the server you want to connect to. Full Code Page: Select this checkbox and then select the code page used on the iseries. This code page will convert both single and double byte characters. Code Page: Enter the page code number to be used to interpret/display files. This will determine the way in which special characters are displayed in different languages. DBCS Code Page: Select the appropriate DBCS Code Page option from the drop down list. Note: This option is used to correctly view/interpret the spool files that contain uni-code characters. Transaction Program: Click on the button to activate the setting text boxes for transaction program. Configure the following settings: Library: Select the root library for the transaction program to be connected on remote server. Name: Name of the library for the transaction program to be connected on remote server. Authentication Methods: Enter the following authentication details to logon to i5 Series System: User: Enter the user name in the space provided. Password: Enter the password in the space provided. System Information: Displays the details of the i5 Series System you have connected to. Click Check Connection button to verify the connection details. Click OK Editing an iseries System settings To edit the connection for i5 System, right-click i5 System connection in the tree view and select Edit i5 Connection from the context menu. Figure 29: Edit System settings Compleo Gateway User Manual 32

33 The i5 Server Configuration window appears. Edit the required details. Click OK Removing connection properties To remove the connection for i5 System, right-click i5 System connection in the tree-view and select Remove i5 Connection from the context menu. Figure 30: Remove connection A confirmation message will appear. Click OK to remove the connection I5 Outqueue Supervision On the left, the iseries 400 system configured to work with Compleo Gateway is displayed. Click on the name of the AS /400 to display the output queues to be supervised. On the right, the list of output queues on the system is displayed. The status of an output queue may be one of the following: Supervised Outqueue: This is the outqueue accessed through the i5 Systems connection for performing the tasks and put under the supervision using Gateway. Supervisable Outqueue: This is the outqueue accessed through the i5 Systems connection and available for setting the Supervision by Gateway. This is the default status. Non-Supervisable Outqueue: Is the outqueue which is currently not supervisable by the Gateway. Note: When an output queue is unavailable it is usually because it is being used by an application other than Compleo Gateway. To make it available, the association with the current application has to be deleted on the iseries 400 itself (please ask your system administrator to do this). List View of Supervised Outqueue displays the details about Supervised, Supervisable and Non-supervisable Outqueue listed by selected i5series connection. The list view shows the columns for: Name: Name of the Outqueue on the selected i5 System connection. Library: Name of the Library corresponding to the Outqueues. Status: Shows the supervision status of the Outqueues. DataQueue: Shows the name of the dataqueue associated with the outqueue. Token: Shows the number of tokens in the dataqueue waiting to be processed. Size: Shows the size of the dataqueue (in bytes). Compleo Gateway User Manual 33

34 Created on: The date on which supervision was created on your machine. Comments: Remark or a note placed for supervision. A comment is an optional component and it can kept blank too. Figure 31: List view of Supervised Outqueue on i5 Series Server Supervised Outqueue: General Figure 32: Supervised Outqueue General Outqueue: Displays name of the supervised outqueue. Comments: Enter a description of the supervision which can act as an easy reference later on. Logged Event Types: This gives direction to the Gateway on what kind of events should be saved by the Gateway in the log. Error: Check this box if you want the errors to be logged. Warning: Check this box if you want the warning to be logged. Information: Check this box if you want detailed verbose information to be logged. Compleo Gateway User Manual 34

35 Supervised Outqueue: Reconnection Figure 33: Supervised Outqueue Reconnection This Reconnection tab gives you the advanced option of configuring the amount of time that administrator should wait before retrying to connect to the server after the connection is lost. Time before first attempt: The value in this box defines the amount of time (in minutes) that administrator should wait, after the connection is lost, before it retries to establish the connection. Time before second attempt: The value in this box defines the amount of time (in minutes) that administrator should wait, after the connection is lost, before it retries to establish the connection for the second time. Time before third attempt: The value in this box defines the amount of time (in minutes) that administrator should wait, after the connection is lost, before it retries to establish the connection for the third time. Time between subsequent attempts: The value in this box defines the amount of time (in minutes) between subsequent retries after the third attempt fails. Note: If you enter 0 in these tabs, the Gateway will not try to reconnect to the server after the connection is lost. Compleo Gateway User Manual 35

36 Supervised Outqueue: Event Forwarding Figure 34: Supervised Outqueue Event Forwarding This tab gives you the option of sending the Events you have selected, to an address or to a group of addresses in a distribution list. This is a very useful feature which allows you to monitor the administrator activities from any location just by browsing through the Events that you receive by . You can once again, select the type of Event logs that you want forwarded to the selected address/distribution list. Select the Forward events by SMTP mail check box. Click Edit Parameters to enter the required details in the SMTP Send Message Settings window. Figure 35: SMTP Send Message Settings Note: This window will allow you to add only the server and recipient details. The other details are automatically added by Compleo Gateway. Compleo Gateway User Manual 36

37 Once you have entered the details, the following parameters are displayed in the Event Forwarding tab: Server: Displays the server address/name to use for sending the SMTP mail. From: Displays the sender s address in this field. To: Displays the recipient address. Cc: Displays the recipient address for Copy Circulated/Carbon Copy. Bcc: Displays the recipient address for Blind Copy Circulated / Blind Carbon Copy. Types of Event Forwarding: Error: Select this check box if you want the errors events to be forwarded. Warning: Select this check box if you want the warning events to be forwarded. Information: Select this check box if you want detailed verbose information events to be forwarded Activate Supervision - i5 Systems To activate supervision on i5 Systems, carry out any of the following methods: Method One: Select a supervised outqueue. On the Configurations tab, in the Device Supervision group, click. Method Two: Another way to activate the supervision on i5series Outqueue is right-click on the Supervised Outqueue you want to activate supervision. A context menu will pop-up. Click Activate command on the context menu to activate the Supervised Outqueue. Compleo Gateway User Manual 37

38 Note: (1) The supervision status of the i5 Series Outqueue is displayed by distinguishing icon image. (2) An Outqueue can only be in the Active mode, if at least one Active Scenario is associated with it Pause Supervision - i5 Systems Outqueue This is the default status of an i5 Series Outqueue when you setup the supervision. The Gateway module will not scan an i5 System Outqueue in this state. You can Pause the supervision on i5 System Outqueue by following any of the methods: Method One: Select the desired Active i5 System Outqueue. On the Configurations tab, in the Device Supervision group, click Outqueue. to pause the supervision set on the active i5 Series Method Two: You can pause the supervision on an Active i5 System Outqueue by right clicking on the supervised outqueue in the tree-view and selecting the Pause command from the context menu Editing Supervision - i5 Systems Outqueue Method One: Click on the i5 Systems connection, you will get all the list of available outqueue in the right hand side List View Pane. Right-click on the Supervised i5 System Outqueue, you will get a context menu. Select the Edit Outqueue Supervision... menu command from context menu and you will be redirected to the Supervised Outqueue window, where you can edit parameters for Supervision. Compleo Gateway User Manual 38

39 Method Two: You will get a context menu on right clicking the Supervised i5 System Outqueue available in the tree-view. Select the command Edit Outqueue Supervision... from the context menu, on selection you will be redirect you to the Supervised Outqueue window, where you can edit parameters for Supervised i5 System Outqueue Supervision Removing Supervision - i5 Systems Method One: Click the available i5 Systems connection and you will get the list of available outqueue in the right hand side List View Pane. On right clicking the desired Supervised i5 System Outqueue, you get a context menu. Select the Remove OutQ Supervision from the menu command. This will result into removal of supervision on the selected i5 System Outqueue. You can select only one outqueue at a time. Method Two: Right click on the Supervised Outqueue and a context menu pops-up. Select the command Remove OutQ Supervision to remove the supervision on the selected Outqueue. Note: Delete Supervision menu command on the context menu will be enabled only if you right-click on Supervised Outqueue SAP R/ Configuring SAP R/3 Server To configure a connection to a SAP R/3 server, right-click New SAP R/3 Connection and select Compleo Gateway User Manual 39

40 Then SAP R/3 Connection Settings dialog box will be displayed. Figure 36: SAP R/3 Connection Settings-Connection Connection: This tab allows you to configure a connection of a SAP R/3 Systems server. System: Description Enter the connection description in the space provided as you want it appear in Tree view. Application Server Enter the SAPR/3 server IP address to which you want to connect. System ID Gateway Host Gateway Service Enter the system ID. Enter the gateway host name/ip address. Enter the gateway Service. Logon: Client User Name Enter the client number/id. Enter the user name to log in the SAP R/3 server. Compleo Gateway User Manual 40

41 Password Language Enter the password in the space provided to authenticate the user mentioned in user name box. Enter the code for interface language, for example EN for English language Editing a SAP R/3 connection settings To edit the connection for SAP R/3 Active connector, right-click SAP R/3 Connection in the tree view and select Edit System Settings from the context menu. Figure 37: Edit connection properties The SAP R/3 connection settings window appears. Edit the required details. Click OK Removing connection properties To remove the connection for SAP R/3 Active connector, right click SAP R/3 Connection in the tree-view and select Remove Connection from the context menu. A confirmation message will appear. Click OK to remove the connection SAP Active Supervision List view of Supervised Printers displays the detail list of all available printers in the selected SAP R/3 Connection. Supervision Name: Is the name you give to the supervision set on SAP R/3 Printer. Printer Name: Is the name of SAP R/3 Printer in the selected SAP R/3 Connection. Figure 38: List view of Supervised SAP R/3 Printer. Compleo Gateway User Manual 41

42 Supervised Printer: General Figure 39: Supervised Printer - General Supervision Title: Enter an appropriate title for the task you want to supervise. (This field is mandatory). Supervised Printer: Select a printer on which you want to supervise the printer. You can select a printer from the drop down list. Supervision Frequency: Allows you to set the time interval between the retrieval of files from the supervised printer. The frequency interval is in HH:MM:SS format. All new events will then be detected and new files will be processed by the scenarios. For example, if you set this interval as 00:00:10, then the Gateway will retrieve the spool files from the supervised printer after every 10 seconds. Note: The minimum scan frequency is 01 seconds and the maximum is 23:59:59 hours. Do not process a spool before ensuring that its number of pages hasn t grown between two printer scans: Select this check box to ensure that the complete file is spooled before it is sent for printing. Logged Event Types: This gives direction to the Gateway on what kind of events should be saved by the Gateway in the log. Error: Select this check box if you want the errors events to be forwarded. Warning: Select this check box if you want the warning events to be forwarded. Information: Select this check box if you want detailed verbose information events to be forwarded. Compleo Gateway User Manual 42

43 Supervised Printer: Reconnection Figure 40: Supervised Printer Reconnection This connection tab gives you the advanced option of configuring the amount of time that administrator should wait before retrying to connect to the server after the connection is lost. Time before first attempt: The value in this box defines the amount of time (in minutes) that administrator should wait, after the connection is lost, before it retries to establish the connection. Time before second attempt: The value in this box defines the amount of time (in minutes) that administrator should wait, after the connection is lost, before it retries to establish the connection for the second time. Time before third attempt: The value in this box defines the amount of time (in minutes) that administrator should wait, after the connection is lost, before it retries to establish the connection for the third time. Time between subsequent attempts: The value in this box defines the amount of time (in minutes) between subsequent retries after the third attempt fails. Note: If you enter 0 in these tabs, the Gateway will not try to reconnect to the server after the connection is lost. Compleo Gateway User Manual 43

44 Supervised Printer: Event Forwarding Figure 41: Supervised Printer Event Forwarding This tab gives you the option of sending the Events you have selected, to an address or to a group of addresses in a distribution list. This is a very useful feature which allows you to monitor the administrator activities from any location just by browsing through the Events that you receive by . You can once again, select the type of Event logs that you want forwarded to the selected address/distribution list. Select the Forward events by SMTP mail check box. Click Edit Parameters to enter the required details in the SMTP Send Message Settings window. Figure 42: SMTP Send Message Settings Note: This window will allow you to add only the server and recipient details. The other details are automatically added by Compleo Gateway. Compleo Gateway User Manual 44

45 Once you have entered the details, the following parameters are displayed in the Event Forwarding tab: Server: Displays the server address/name to use for sending the SMTP mail. From: Displays the sender s address in this field. To: Displays the recipient address. Cc: Displays the recipient address for Copy Circulated/Carbon Copy. Bcc: Displays the recipient address for Blind Copy Circulated / Blind Carbon Copy. Types of Event Forwarding: Error: Select this check box if you want the errors events to be forwarded. Warning: Select this check box if you want the warning events to be forwarded. Information: Select this check box if you want detailed verbose information events to be forwarded Activate Supervision - SAP R/3 printer To Activate Supervision on SAP R/3, carry out any of the following methods: Method One: Select a supervised SAP R/3 Printer. On the Configurations tab, in the Device Supervision group, click. Method Two: Another way to activate the supervision on SAP R/3 Printer is, click Supervised Printer you want to activate supervision. A context menu will pop-up. Click Activate command on the context menu to activate the Supervised Printer. Important: A Printer can only be in the Active mode if at least one Active Scenario is associated with it. Compleo Gateway User Manual 45

46 Pause Supervision - SAP R/3 Active printer This is the default status of a SAP R/3 Printer when you setup the supervision. The Gateway module will not scan a SAP R/3 Printer in this state. You can Pause the supervision on Active SAP R/3 Printer by following any of the methods: Method One: Select the desired Active SAP R/3 Printer. On the Configurations tab, in the Device Supervision group, click to pause the supervision set on the active SAP R/3 Printer. Method Two: You can pause the supervision on an Active SAP R/3 Printer by right clicking on the supervised printer in the tree-view and selecting the Pause command from the context menu Editing Supervision - SAP R/3 printer Method One: Click available SAP R/3 Connection and you will get the list of all available Supervised SAP R/3 Printer in the List View Pane. On right clicking the desired SAP R/3 Printer for editing supervision, you get a context menu. Select the Edit Printer Supervision from the menu command, and you will be redirected to the Supervised Printer window, where you can edit parameters for Supervision. Method Two: You will get a context menu on right clicking the Supervised SAP R/3 Printer available in the tree-view. Select the command Edit Printer Supervision... from the context menu, and you will be redirected to the Supervised Printer window, where you can edit parameters for supervised SAP R/3 Printer Supervision. Compleo Gateway User Manual 46

47 Removing Supervision - SAP R/3 Method One: Figure 43: Editing Supervision - SAP R/3 Click the available SAP R/3 Connection and you will get the list of all available Supervised SAP R/3 Printer in the List View pane. On right clicking the desired SAP R/3 Printer for removing supervision, you get a context menu. Select the Remove Printer Supervision from the menu command, which will remove the supervision set on the SAP R/3 Printer. Method Two: Right click on the SAP R/3 Printer and a context menu pops-up. Select the command Remove Printer Supervision to remove the supervision on the selected SAP R/3 Printer BC-XOM CONNECTOR BC-XOM is a protocol provided by SAP which facilitates communication with External Output Management Systems. The callbacks ensure bi-directional communication. SAP directly sends the output requests to Compleo Gateway for processing and Compleo Gateway updates SAP with the status of the processes Configuring SAP System Right-click on BC-XOM connector New SAP System. The SAP System dialog box appears: Compleo Gateway User Manual 47

48 Figure 44: Configuring SAP System settings Enter the login details to configure SAP System. Description ROMS Enter the connection description in the space provided as you want it appear in the tree view. Enter the ROMS name as defined in SAP system SAP Host Machine Enter SAP server name/ip you want to connect. Gateway Service Program ID Enter the gateway service name. Enter the ProgramID as defined for selected RFC connection on the SAP side. Compleo Gateway User Manual 48

49 System Number Client User Name Password Language Enter the System number Enter the Client details Enter the user name to connect to the SAP system. Enter the password to authenticate the above mentioned user name. Enter the code for interface language, for example EN for English language Edit SAP System Settings 1. Right-click SAP System, and select Edit SAP System option from context menu. This displays the SAP System dialog box: Figure 45: Edit SAP System Settings Compleo Gateway User Manual 49

50 2. Edit the required fields and click OK Remove SAP system Right-click SAP System and select Remove SAP System option from context menu. Figure 46: Remove SAP System Compleo Gateway User Manual 50

51 A confirmation dialog box is displayed. Click Yes to remove the SAP system Refresh device list Figure 47: Confirmation dialog box This option refreshes the list of output device configured with an external output management system. It adds the printers created in the SAP system to the list and removes the output devices that have been deleted. 1. Right-click on the SAP System to display the context menu. Figure 48: Output device type Note: The Host Spool Access Method of an output device (in SAP) configured with BC- XOM Connector should be E: External output management system. 2. Select Refresh Device List, to view the available list of printer. List of printer before refresh List of printer after refresh Compleo Gateway User Manual 51

52 Notes: The device list will be available only if the BC-XOM connector is active and the Gateway service is running. The greyed out device list indicates that these device does not exist for the defined SAP System. This happens when the configuration for the SAP System is changed or the output device is deleted from the SAP System Activate printer supervision- BC-XOM Connector To Activate Supervision on the BC-XOM Connector, use any of the following methods: Method One: Select a BC-XOM Printer. On the Configurations tab, in the Device Supervision group, click. Method Two: Another way to activate supervision on BC-XOM Connector is right-click on the Printer Name you want to activate supervision. A context menu will pop-up. Click Activate/Pause command in the context menu to activate the Supervised Printer. Figure 49: Right-click context menu Important: A printer can only be in the Active mode if at least one Active Scenario is associated with it Pause Supervision BC-XOM Connector This is the default status of the BC-XOM Connector when you setup the supervision. The Gateway module will not scan a BC-XOM Connector in this state. You can Pause the supervision on the Active BC-XOM Connector by using any of the following methods: Compleo Gateway User Manual 52

53 Method One: Select the desired Active BC-XOM Connector. On the Configurations tab, in the Device Supervision group, click to pause the supervision set on the active Printer Name. Method Two: You can pause the supervision on an Active BC-XOM Connector by right-clicking on the supervised printer in the tree-view and selecting the Activate/Pause command from the context menu. Figure 50: Right-click context menu Editing Supervision BC-XOM connector You will get a context menu on right clicking the BC-XOM Device available in the treeview. Select the Edit supervision command from the context menu, which will redirect you to the Supervised BC-XOM Device dialog box, where you can edit parameters for BC-XOM Device Supervision Write an XMI Log You can manually add XMI logs for SAP Systems in Gateway. To write an XMI log 1. Right-click on the SAP System to display the context menu. Figure 51: Right-click context menu Compleo Gateway User Manual 53

54 2. Select XMI Log Write Manual Entry. This displays the Write XMI Log dialog box. Figure 52: Write XMI dialog box 3. Provide the following information, to add an XMI log: User Name: Enter the user name. Object: Enter an object/subject of the log. Message ID: Enter an id number. Message Text: Enter text related to the log. 4. Click Write. All the logs are registered in XMI logs dialog box once they are processed Read OMS logs You can view the OMS logs that you have manually entered using this option. 1. Right-click on the SAP System to display the context menu. Figure 53: Right-click context menu 2. Select XMI Logs Read OMS Logs. This displays the XMI Logs dialog box. Compleo Gateway User Manual 54

55 An example for adding XMI logs Figure 54: XMI logs dialog box In this example, we will add a new SAP System London to the BC-XOM Connector. Note: For more information on adding a SAP system, refer to section Adding a SAP System. We will now add the below details in the Write XMI Log dialog box: USER ADMIN MESSAGE ID 2.11 OBJECT PO - for DOCTEAM only MESSAGE Connection Settings amended These details are displayed in SAP on saving the logs in Gateway. The transaction RZ 15 displays the XMI Log Management: Display in SAP. Double-click on the entry to view the full entry SAP PRINT SERVICE Figure 55: XMI Log Management: Display You can supervise a printer in a SAP Print system. The Gateway will process all the files directed to the printer, if the conditions in the scenarios are satisfied New SAP Print Connection To configure a connection to a SAP Print service, right-click on New Printer Connection... and select Compleo Gateway User Manual 55

56 Then the SAP Virtual printer Settings dialog box will be displayed. General: Figure 56: SAP Virtual Printer Connection Settings Printer Name: Enter the Printer Name in the text box. The Printer Name should be exactly same as in the SAP system. Send acknowledgement to SAP after full process only: When you select this check box an acknowledgement will be sent to SAP only after scenarios are processed completely. If this option is unchecked an acknowledgement will be sent to SAP as soon as the spool files are received by the Gateway. Files with error status: Pause printer after successive errors: Select this check box to automatically deactivate the printer and switch it to the "Pause" status, when the scenario fails on X successive files. Pause printer after total errors: Select this check box to automatically deactivate the printer and switch it to the Pause status, when the scenario fails on X files. Remove files older than X days: If this option is checked, then the files that failed will be automatically deleted every X days. Consider that you had created a scenario to copy files in a particular folder to which you do not have access. In that case the scenario fails and files will appear in Files in Error dialog box. If you have specified the printer to be paused after three successive errors, then the printer will be paused and you need to reactivate the printer. Suppose there are five files waiting to be processed and first three files encounter an error, in that case the printer will be paused only after processing all five files. After these files are processed, the printer will be paused and not visible in Supervised locations in Processes, however in Configurations Compleo Gateway User Manual 56

57 it will be displayed as active. You need to reactivate the printer by pausing it first and then activating it. To view the files with error, right-click on the printer and select Show Errors from the context menu. The Files in Error for Printer dialog box will be displayed. Figure 57: Files in Error This dialog box provides options to execute three actions on the file(s) that were not processed because of an error. Delete: This option will delete the selected files. Process: This option will send the selected files for processing. Export to Interactive Folder: This option will export the file to interactive folder. Compleo Gateway User Manual 57

58 Activate Supervision SAP Print Service To Activate Supervision on SAP Print Service, carry out any of the following methods: Method One: Select a SAP virtual printer. On the Configurations tab, in the Device Supervision group, click. Method Two: Another way to activate the supervision on SAP Virtual Printer is, right-click on the SAP Virtual Printer you want active supervision. Context menu will pop-up. Click Activate command on the context menu to activate the supervision of the SAP Virtual Printer. Important: A Virtual SAP Printer can only be in the Active mode if at least one Active Scenario is associated with it Pause Supervision SAP Print Service This is the default status of a SAP Virtual Printer when you setup the supervision. The Gateway module will not scan a SAP Virtual Printer in this state. You can Pause the supervision on SAP Virtual Printer by following any of the methods: Method One: Select the desired active SAP Virtual Printer. On the Configurations tab, in the Device Supervision group, click to pause the supervision set on an active Printer. Compleo Gateway User Manual 58

59 Method Two: You can pause the supervision on an SAP Virtual Printer by right clicking on the SAP Virtual Printer in the tree-view and selecting the Pause command from the context menu Editing Supervision SAP Print Service Method One: Click the available SAP Print Service and you will get the list of all available Supervised SAP Print Service in the List View Pane. On right clicking the desired SAP Print Service for editing supervision, you get a context menu. Select the Edit Connection Properties from the menu command, which will edit the supervision parameters of the SAP Print Service. Method two: You will get a context menu on right clicking the SAP Virtual Printer available in the treeview. Select the Edit Properties command from the context menu, which will redirect you to the SAP Virtual Printer window, where you can edit parameters for SAP Virtual Printer Supervision. Compleo Gateway User Manual 59

60 Removing Supervision - SAP Print Service Method One: Click the available SAP Print Service and you will get the list of all available SAP virtual Printers in the List View Pane. On right clicking the desired SAP virtual printer for removing supervision, you get a context menu. Select the Remove connection from the menu command, which will remove the supervision set on the SAP virtual printer. Method Two: Right click on the SAP virtual printer and a context menu pops-up. Select the command Remove Connection to remove the supervision on the selected SAP virtual Printer PC FOLDER SUPERVISION The List View of PC Folder displays the details about: Supervision Name: The name of supervision set for the PC Folder. Folder Path: Shows the Path of Supervised PC Folder that is located on your PC or on a shared location. Include subfolders: Shows a Boolean value whether the subfolders are included for supervision or not. Figure 58: List view of Supervised PC Folder Compleo Gateway User Manual 60

61 Creating a New Supervised Folder This option allows you to supervise a local PC folder on your machine. To add a supervised folder: Right-click PC Folders connector in the tree view and select the New Supervised Folder option. You will be redirected to the Supervised Folder dialog box, where can set the supervised folder after few settings on different tabs provided in the dialog box. Figure 59: Supervised Folder Once a folder is supervised, a Gateway configuration is associated with it. The Gateway configuration contains all the parameters for the Supervised Folder (supervision name, options, scenarios ) When a new file arrives in a supervised folder, it is checked by Gateway and this check is only carried out at certain times depending on the frequency and conditions set. If the file matches the conditions specified, it will be processed according to the parameters that have been set. It can therefore be automatically sent by , printed, deleted, archived etc. Compleo Gateway User Manual 61

62 Supervised PC Folder: General Figure 60: Supervised Folder General Supervision Title: Enter an appropriate title for the task you want to supervise. (This field is mandatory.) Supervised Folder: Enter the path of the folder you want to supervise or click Browse button to select the folder. To include the sub-folders, check the Supervise subfolders check box. Supervision Frequency: Allows you to set the time interval between successive supervisions. The frequency interval is in HH:MM:SS format. For example, if you set this interval as 00:00:10, then the Gateway will check the supervised folder after every 10 seconds for any new files. NOTE: The minimum scan frequency is 01 seconds and the maximum is 23:59:59 hours Logged Event Types: This gives direction to the Gateway on what kind of events should be saved by the Gateway in the log. Error: Check this box if you want the errors to be logged. Warning: Check this box if you want the warning to be logged. Information: Check this box if you want detailed verbose information to be logged. Compleo Gateway User Manual 62

63 Supervised PC Folder: Reconnection Figure 61: Supervised Folder Reconnection This Reconnection tab gives you the advanced option of configuring the amount of time that administrator should wait before retrying to connect to the folder after the connection is lost. Time before first attempt: The value in this box defines the amount of time (in minutes) that administrator should wait, after the connection is lost, before it retries to establish the connection. Time before second attempt: The value in this box defines the amount of time (in minutes) that administrator should wait, after the connection is lost, before it retries to establish the connection for the second time. Time before third attempt: The value in this box defines the amount of time (in minutes) that administrator should wait, after the connection is lost, before it retries to establish the connection for the third time. Time between subsequent attempts: The value in this box defines the amount of time (in minutes) between subsequent retries after the third attempt fails. Note: If you enter 0 in these tabs, the Gateway will not try to reconnect to the folder after the connection is lost. Compleo Gateway User Manual 63

64 Supervised PC Folder: Event Forwarding Figure 62: Supervised Folder Event Forwarding This tab gives you the option of sending the Events you have selected, to an address or to a group of addresses in a distribution list. This is a very useful feature which allows you to monitor the administrator activities from any location just by browsing through the Events that you receive by . You can once again, select the type of Event logs that you want forwarded to the selected address / distribution list(s). Select the Forward events by SMTP mail check box. Click Edit Parameters to enter the required details in the SMTP Send Message Settings window. Figure 63: SMTP Send Message Settings Compleo Gateway User Manual 64

65 Note: This window will allow you to add only the server and recipient details. The other details are automatically added by Compleo Gateway. Once you have entered the details, the following parameters are displayed in the Event Forwarding tab: Server: Displays the server address/name to use for sending the SMTP mail. From: Displays the sender s address in this field. To: Displays the recipient address. Cc: Displays the recipient address for Copy Circulated/Carbon Copy. Bcc: Displays the recipient address for Blind Copy Circulated / Blind Carbon Copy. Types of Event Forwarding: Error: Select this check box if you want the errors events to be forwarded. Warning: Select this check box if you want the warning events to be forwarded. Information: Select this check box if you want detailed verbose information events to be forwarded Activate Supervision - PC Folder To Activate Supervision on PC Folder, carry out any of the following methods: Method One: Select a supervised PC folder. On the Configurations tab, in the Device Supervision group, click. Method Two: Another way to activate the supervision on PC Folder is, right-click on the Supervised PC Folder you want active supervision. Context menu will pop-up. Click on the Activate command on the context menu to activate the supervision of the Supervised PC Folder. Important: A PC Folder can only be in the Active mode if at least one Active Scenario is associated with it. Compleo Gateway User Manual 65

66 Pause Supervision - PC Folder This is the default status of a PC Folder when you setup the supervision. The Gateway module will not scan a PC Folder in this state. You can Pause the supervision on Active PC Folder by following any of the methods: Method One: Select the desired Active PC Folder. On the Configurations tab, in the Device Supervision group, click to pause the supervision set on the active PC Folder. Method Two: You can pause the supervision on a PC Folder by right clicking on the supervised PC Folder in the tree-view and selecting the Pause command from the context menu Editing Supervision - PC Folder Method One: Click on the PC Folders, you will get all the list of available supervision folders in the right hand side List View Pane. Right-click on the Supervised PC folder, you will get a context menu. Select the Edit Folder Supervision... menu command from context menu and you will be redirected to the Supervised Folder window, where you can edit parameters for Supervised PC Folder Supervision. Compleo Gateway User Manual 66

67 Method Two: You will get a context menu on right clicking the Supervised PC Folder available in the tree-view. Select the command Edit Folder Supervision... menu command from the context menu, which will be redirect you to the Supervised Folder window, where you can edit parameters for Supervised PC Folder Supervision Removing Supervision - PC Folder Method One: Click PC icon in tree-view and you will get the list of all available Supervised PC Folder in the List View Pane. On right clicking the desired PC Folder for removing supervision, you get a context menu. Select the Remove Folder Supervision from the menu command, which will remove the supervision set on the PC Folder. Method Two: Right-click on the PC folder and context menu pop-ups. Select the command Remove Folder Supervision to remove the supervision on the selected PC Folder MAILBOXES You can now supervise your mailbox with Compleo Gateway. You can configure your POP mail server settings with Gateway. Gateway will monitor all the incoming mails and will process all the attachments in the mails according to the conditions specified in the scenarios. Note: Once an is processed, it will be marked as read and will not be processed again. When you start supervision on your mail box and if it contains mails that are marked as read but not processed, then Gateway will process all the mails that are not processed. The List View of Mailbox displays the details about: Compleo Gateway User Manual 67

68 Mailbox Name: The name of supervision set for the Mailbox. Address: Displays the Address that is set for the supervision New Mailbox Connection To configure a connection to a Mailbox, right-click and select New Supervised Mailbox... Then the Supervised Mailbox dialog box will be displayed. Figure 64: Supervised Mailbox Enter the following details in the three different tabs provided in the dialog box: Supervised Mailbox: General Supervision Title: Enter an appropriate title for the task you want to supervise. Server Address: Enter the server address of the POP mail to be supervised. Port Number: Enter the appropriate Port Number. By default, the Port Number for POP3 services is 110. Secure Connection: Check this option, if your server is using a secure connection. Note: The port number for POP3 with secure connection is 995. User ID: Enter the Account address to be supervised. Compleo Gateway User Manual 68

69 Password: Enter the password of the account provided. Leave mail on server: Checking this option will leave a copy of mail on the server after processing the mails, else the mails will be deleted after processing. By default, this option is not checked. Process the attached files: Select this check box to process only the files attached to an . Process the text of the body: Select this check box to process only the text of the . Note: This option will not process the digital signature or image available in the message header. Supervision Frequency: Allows you to set the time interval between the retrieval of files from the supervised printer. The frequency interval is in HH:MM:SS format. For example, if you set this interval as 00:00:10, then the Gateway will retrieve the spool files from the supervised printer after every 10 seconds. NOTE: The minimum scan frequency is 01 seconds and the maximum is 23:59:59 hours. Logged Event Types: This gives direction to the Gateway on what kind of events should be saved by the Gateway in the log. Error: Check this box if you want the errors to be logged. Warning: Check this box if you want the warning to be logged. Information: Check this box if you want detailed verbose information to be logged. Supervised Mailbox: Reconnection Figure 65: Supervised Mailbox Reconnection This connection tab gives you the advanced option of configuring the amount of time that administrator should wait before retrying to connect to the server after the connection is lost. Compleo Gateway User Manual 69

70 Time before first attempt: The value in this box defines the amount of time (in minutes) that administrator should wait, after the connection is lost, before it retries to establish the connection. Time before second attempt: The value in this box defines the amount of time (in minutes) that administrator should wait, after the connection is lost, before it retries to establish the connection for the second time. Time before third attempt: The value in this box defines the amount of time (in minutes) that administrator should wait, after the connection is lost, before it retries to establish the connection for the third time. Time between subsequent attempts: The value in this box defines the amount of time (in minutes) between subsequent retries after the third attempt fails. Note: If you enter 0, the Gateway will not try to reconnect to the server after the connection is lost. Supervised Mailbox: Event Forwarding Figure 66: Supervised Mailbox Event Forwarding This tab gives you the option of sending the events you have selected, to an address or to a group of addresses in a distribution list. This is a very useful feature which allows you to monitor the administrator activities from any location just by browsing through the Events that you receive by . You can once again, select the type of Event logs that you want forwarded to the selected address/distribution list(s). Compleo Gateway User Manual 70

71 Select the Forward events by SMTP mail check box. Click Edit Parameters to enter the required details in the SMTP Send Message Settings window. Figure 67: SMTP Send Message Settings Note: This window will allow you to add only the server and recipient details. The other details are automatically added by Compleo Gateway. Once you have entered the details, the following parameters are displayed in the Event Forwarding tab: Server: Displays the server address/name to use for sending the SMTP mail. From: Displays the sender s address in this field. To: Displays the recipient address. Cc: Displays the recipient address for Copy Circulated/Carbon Copy. Bcc: Displays the recipient address for Blind Copy Circulated / Blind Carbon Copy Types of Event Forwarding: Error: Select this check box if you want the errors events to be forwarded. Warning: Select this check box if you want the warning events to be forwarded. Information: Select this check box if you want detailed verbose information events to be forwarded. Compleo Gateway User Manual 71

72 Activate Supervision - Mailboxes To Activate Supervision on Mailboxes, carry out any of the following methods: Method One: Select a supervised mailbox. On the Configurations tab, in the Device Supervision group, click. Method Two: Another way to activate the supervision on Mailboxes is, right-click on the Supervised Mailboxes you want active supervision. Context menus will pop-up. Click Activate command on the context menu to activate the supervision of the Supervised Mailboxes. Important: A Mailbox can only be in the Active mode if at least one Active Scenario is associated with it Pause Supervision - Mailboxes This is the default status of Mailboxes when you setup the supervision. The Gateway module will not scan Mailboxes in this state. You can Pause the supervision on Mailbox by following any of the methods: Method One: Select the desired Active Mailbox. On the Configurations tab, in the Device Supervision group, click to pause the supervision set on the Mailbox. Compleo Gateway User Manual 72

73 Method Two: You can pause the supervision on a Mailbox by right clicking on the supervised Mailbox in the tree-view and selecting the Pause command from the context menu Editing Supervision Mailboxes Method One: Click on the Mailbox, you will get all the list of available supervision mailbox in the right hand side List View Pane. Right-click on the Supervised Mailbox Name, you will get a context menu. Select the Edit Mailbox Supervision... menu command from context menu and you will be redirected to the Supervised Mailbox window, where you can edit parameters for Supervised Mailbox Supervision. Method Two: You will get a context menu on right clicking the Supervised Mailbox available in the tree-view. Select the command Edit Mailbox Supervision... menu command from the context menu, which will be redirect you to the Supervised Mailbox window, where you can edit parameters for Supervised Mailbox Supervision. Compleo Gateway User Manual 73

74 Removing Supervision Mailboxes Method One: Click Mailbox in tree-view and you will get the list of all available Supervised Mailbox in the List View Pane. On right clicking the desired Mailbox for removing supervision, you get a context menu. Select the Remove Mailbox Supervision from the menu command, which will remove the supervision set on the Mailbox. Method Two: Right-click on the mailbox connection and a context menu pops-up. Select the command Remove Mailbox Supervision to remove the supervision on the selected Mailbox XML STREAM CONNECTION Configuring XML Stream connector You can configure a connection to an XML Stream Connection. The Gateway will supervise the available dataq, if the conditions in the scenarios are satisfied. Right-click Connection and select New XML Stream Connector Server Figure 68: XML Stream Connector Server Connection Then XML Stream Connector Server Settings dialog box will be displayed. Compleo Gateway User Manual 74

75 Figure 69: XML Stream Connector Connection Settings Connection: Name: Enter the Connection Name in the space provided, as you want it to appear in the Administrator Tree view. Address: Enter the IP address of the Iseries you want to connect to. Connection Type: Select the connection type from the drop down list. Code Page: Enter the page code number to be used to interpret/display files. This will determine the way in which special characters are displayed in different languages. Authentication: Enter the following authentication details to logon to the server. User: Enter the user name in the space provided. Password: Enter the password in the space provided. Click Test Connection button to verify the connection details Editing XML stream connection settings To edit the connection for DataQ, right-click XML stream Connection in the tree view and select Edit System Settings from the context menu. Figure 70: Edit System settings The XML Stream connection window appears. Edit the required details. Compleo Gateway User Manual 75

76 Click OK Removing connection properties To remove the connection for DataQ System, right-click DataQ connection in the tree-view and select Remove Connection from the context menu. Figure 71: Remove connection A confirmation message will appear. Click OK to remove the connection DataQ Supervision On the left, the XML Stream connection configured to work with Compleo Gateway is displayed. Click on the name of the DataQ to display the DataQ to be supervised. On the right, the list of output DataQ on the system is displayed. List View of Supervised DataQ displays the following details. Name: Name of the DataQ on the selected XML Stream connection. Library: Name of the Library corresponding to the DataQ. Linked Users: Shows the number of linked users of the supervised DataQ. Linked Devices: Shows the number of the device linked with the DataQ. Description: Shows the description which is added during the supervision of DataQ. Figure 72: List view of Supervised DataQ Compleo Gateway User Manual 76

77 Supervised DataQ: General Figure 73: Supervised DataQ General Name: Enter the name of the DataQ. Normally, it's the name of the workstation (This field is mandatory). Alias: Alias name of the DataQ (if any). This name will appear as the job name on the iseries. Description: Enter the description that will help you recognize your DataQ. Valuate DQACK with previous processing status: Select this check box to retrieve return code of the previous process. This code will indicate the status of the process i.e., Success or Failure. Logged Event Types: This gives direction to the Gateway on what kind of events should be saved by the Gateway in the log. Error: Select this check box if you want the errors to be logged. Warning: Select this check box if you want the warning to be logged. Information: Select this check box if you want detailed verbose information to be logged. Compleo Gateway User Manual 77

78 Supervised DataQ: Reconnection Figure 74: Supervised DataQ Reconnection This connection tab gives you the advanced option of configuring the amount of time that administrator should wait before retrying to connect to the server after the connection is lost. Time before first attempt: The value in this box defines the amount of time (in minutes) that administrator should wait, after the connection is lost, before it retries to establish the connection. Time before second attempt: The value in this box defines the amount of time (in minutes) that administrator should wait, after the connection is lost, before it retries to establish the connection for the second time. Time before third attempt: The value in this box defines the amount of time (in minutes) that administrator should wait, after the connection is lost, before it retries to establish the connection for the third time. Time between subsequent attempts: The value in this box defines the amount of time (in minutes) between subsequent retries after the third attempt fails. Note: If you enter 0 in these tabs, the Gateway will not try to reconnect to the server after the connection is lost. Compleo Gateway User Manual 78

79 Supervised DataQ: Event Forwarding Figure 75: Supervised DataQ Event Forwarding This tab gives you the option of sending the Events you have selected, to an address or to a group of addresses in a distribution list. This is a very useful feature which allows you to monitor the administrator activities from any location just by browsing through the Events that you receive by . You can once again, select the type of Event logs that you want forwarded to the selected address/distribution list. Select the Forward events by SMTP mail check box. Click Edit Parameters to enter the required details in the SMTP Send Message Settings window. Figure 76: SMTP Send Message Settings Note: This window will allow you to add only the server and recipient details. The other details are automatically added by Compleo Gateway. Compleo Gateway User Manual 79

80 Once you have entered the details, the following parameters are displayed in the Event Forwarding tab: Server: Displays the server address/name to use for sending the SMTP mail. From: Displays the sender s address in this field. To: Displays the recipient address. Cc: Displays the recipient address for Copy Circulated/Carbon Copy. Bcc: Displays the recipient address for Blind Copy Circulated / Blind Carbon Copy Types of Event Forwarding: Error: Select this check box if you want the errors events to be forwarded. Warning: Select this check box if you want the warning events to be forwarded. Information: Select this check box if you want detailed verbose information events to be forwarded Manage Links Right-click the XML stream connection and select the Manage Links option from the context menu. The Link Manager allows the user to create a link between the DataQ and terminal emulations or the user. This window is divided into three parts: Figure 77: Link Manager The left hand side displays the list of existing DataQ's. Compleo Gateway User Manual 80

81 The upper right side displays the list of terminals, DataQ to which the terminal is linked and its description. The lower right side displays the list of users, linked DataQ and Description Buffer Manager Right-click the XML stream connection and select the Buffer Manager option from the context menu. This window displays a list of existing buffers that is found on the iseries. The window is divided into two parts: Figure 78: Buffer Manager The left hand side displays list of buffers in the alphabetic order, with the description. The right hand side displays list of data in the alphabetic order, followed by their size. You can add, edit or delete the buffer and its data Activate Supervision - DataQ To Activate Supervision on DataQ Systems, carry out any of the following methods: Method One: Select a supervised outqueue. On the Configurations tab, in the Device Supervision group, click. Compleo Gateway User Manual 81

82 Method Two: Another way to activate the supervision on DataQ is, right-click on the Supervised DataQ you want to activate supervision. A context menu will pop-up. Click Activate command on the context menu to activate the Supervised DataQ. Note: A DataQ can only be in the Active mode, if at least one Active Scenario is associated with it Pause Supervision - DataQ This is the default status of a DataQ when you setup the supervision. The Gateway module will not scan a DataQ in this state. You can pause the supervision on DataQ by following any of the methods: Method One: Select the desired Active DataQ, On the Configurations tab, in the Device Supervision group, click to pause the supervision set on the active DataQ. Method Two: You can pause the supervision on an Active DataQ by right clicking on the supervised outqueue in the tree-view and selecting the Pause command from the context menu. Compleo Gateway User Manual 82

83 Editing Supervision - DataQ Method One: Click on the DataQ connection, you will get all the list of available outqueue in the right hand side List View Pane. Right-click on the Supervised DataQ, you will get a context menu. Select the Edit DataQ... menu command from context menu and you will be redirected to the Supervised DataQ window, where you can edit parameters for Supervision. Method Two: You will get a context menu on right clicking the Supervised DataQ available in the tree-view. Select the command Edit DataQ Supervision from the context menu, on selection you will be redirect you to the Supervised DataQ window, where you can edit parameters for DataQ Supervision XPS PRINTER You can supervise an XPS printer with Compleo Gateway. It allows printing the document from any software directly to Compleo Gateway (it will come in XPS format). Gateway will monitor all the files printed using this printer and process these files according to the conditions specified in the scenarios. Note: Once a file is printed using the XPS printer, the document will be converted into an XPS file format New Supervised XPS Printer To configure a XPS Printer, right-click and select New XPS Printer... Then the Supervised XPS Printer dialog box will be displayed. Compleo Gateway User Manual 83

84 Figure 79: Supervised XPS Printer Enter the following details in the three different tabs provided in the dialog box: Printer Name: Enter the Printer Name in the text box. Share this printer: Select this option if you want to share the printer with anyone on the same network. Supervision Frequency: Allows you to set the time interval between the retrieval of files from the supervised printer. The frequency interval is in HH:MM:SS format. For example, if you set this interval as 00:00:10, then the Gateway will retrieve the spool files from the supervised printer after every 10 seconds. NOTE: The minimum scan frequency is 01 seconds and the maximum is 23:59:59 hours Logged Event Types: This gives direction to the Gateway on what kind of events should be saved by the Gateway in the log. Error: Check this box if you want the errors to be logged. Warning: Check this box if you want the warning to be logged. Information: Check this box if you want detailed verbose information to be logged. Compleo Gateway User Manual 84

85 Supervised XPS Printer: Event Forwarding Figure 80: Supervised XPS Printer Event Forwarding This tab gives you the option of sending the Events you have selected, to an address or to a group of addresses in a distribution list. This is a very useful feature which allows you to monitor the Gateway activities from any location just by browsing through the Events that you receive by . You can once again, select the type of Event logs that you want forwarded to the selected address/distribution list(s). Select the Forward events by SMTP mail check box. Click Edit Parameters to enter the required details in the SMTP Send Message Settings window. Figure 81: SMTP Send Message Settings Compleo Gateway User Manual 85

86 Note: This window will allow you to add only the server and recipient details. The other details are automatically added by Compleo Gateway. Once you have entered the details, the following parameters are displayed in the Event Forwarding tab: Server: Displays the server address/name to use for sending the SMTP mail. From: Displays the sender s address in this field. To: Displays the recipient address. Cc: Displays the recipient address for Copy Circulated/Carbon Copy. Bcc: Displays the recipient address for Blind Copy Circulated / Blind Carbon Copy Types of Event Forwarding: This gives direction to the Gateway on what kind of events should be saved by the Gateway in the log. Error: Select this check box if you want the errors events to be forwarded. Warning: Select this check box if you want the warning events to be forwarded. Information: Select this check box if you want detailed verbose information events to be forwarded Activate Supervision XPS Printer To Activate Supervision on XPS Printer, use any of the following methods: Method One: Select a supervised XPS Printer. On the Configurations tab, in the Device Supervision group, click. Method Two: Right click the XPS printer you want to activate supervision. A context menu will pop-up. Click Activate on the context menu to activate the XPS printer. Compleo Gateway User Manual 86

87 Important: A XPS Printer can only be in the Active mode, if at least one Active Scenario is associated with it Pause Supervision XPS Printer This is the default status of XPS Printer when you setup the supervision. The Gateway module will not scan XPS Printer in this state. You can pause the supervision on XPS Printer by using any of the following methods: Method One: Select the desired Active XPS Printer. On the Configurations tab, in the Device Supervision group, click to pause the supervision set on the active XPS Printer. Method Two: You can pause the supervision on a XPS Printer by right clicking on the supervised XPS in the tree-view and selecting the Pause command from the context menu Editing Supervision XPS Printer Method One: Click on the XPS Printer connection, you will get all the list of available XPS Printer in the right hand side List View Pane. Right-click on the Supervised XPS Printer, you will get a context menu. Select the Edit Printer Properties menu command from context menu and you will be redirected to the XPS Printer window, where you can edit parameters for Supervision. Compleo Gateway User Manual 87

88 Method Two: You will get a context menu on right clicking the Supervised XPS Printer available in the tree-view. Select the command Edit Printer Properties from the context menu, on selection you will be redirect you to the Supervised XPS Printer window, where you can edit parameters for XPS Printer Supervision Removing Supervision XPS Printer Method One: Click XPS Printer in tree-view and you will get the list of all available Supervised XPS Printer in the List View Pane. On right clicking the desired XPS Printer for removing supervision, you get a context menu. Select the Remove Printer from the menu command, which will remove the supervision set on the XPS Printer. Method Two: Right-click on the XPS Printer and a context menu pops-up. Select the command Remove Printer to remove the supervision on the selected XPS Printer. Compleo Gateway User Manual 88

89 2.4.9 SCHEDULING TASK FOR QUERY DESIGNER TEMPLATES The List View of Scheduled task displays the details about: Scheduled Task name: The name of supervision set for the query task. Figure 82: List view of Supervised Query task Creating a New Query Scheduled task Right-click on the Scheduled Queries in the tree view and select New Query Scheduled task. You will be redirected to the Query Scheduled task dialog box, where you can set the supervised folder after few settings on three different tabs - General, and Event Forwarding provided in the dialog box. With Query Scheduled Tasks, you can setup to execute a CDT. This CDT will query the database to generate an input file. The template will be applied to the input file and output file will be generated as required. Query Scheduled task: General Figure 83: Supervised Folder General Supervision Title: Enter an appropriate title for the task you want to schedule (This field is mandatory). Compleo Gateway User Manual 89

90 Query Text: Displays the query built using the query wizard. Query Wizard: Click this button to define a query by connecting to a database. Triggers: The settings here define the conditions on which the Scheduled Task is supposed to start. To define triggers, click on the button. On clicking button to set triggers, you will be redirected to the new scheduled task window, where you have to select few parameters to set schedule for supervision. You can also edit or delete a scheduled task condition using the or buttons in the Triggers toolbar. For more details about the new scheduled task window, refer to the Scheduled Task chapter explained below. Logged Event Types: This gives direction to the Gateway on what kind of events should be saved by the Gateway in the log. Error: Check this box if you want the errors to be logged. Warning: Check this box if you want the warning to be logged. Information: Check this box if you want detailed verbose information to be logged. Query Scheduled task: Event Forwarding Figure 84: Scheduled Query task Event Forwarding This tab gives you the option of sending the Events you have selected, to an address or to a group of addresses in a distribution list. This is a very useful feature which allows you to monitor the administrator activities from any location just by browsing through the Events that you receive by . Compleo Gateway User Manual 90

91 You can once again, select the type of Event logs that you want forwarded to the selected address / distribution list(s). Select the Forward events by SMTP mail check box. Click Edit Parameters to enter the required details in the SMTP Send Message Settings window. Figure 85: SMTP Send Message Settings Note: This window will allow you to add only the server and recipient details. The other details are automatically added by Compleo Gateway. Once you have entered the details, the following parameters are displayed in the Event Forwarding tab: Server: Displays the server address/name to use for sending the SMTP mail. From: Displays the sender s address in this field. To: Displays the recipient address. Cc: Displays the recipient address for Copy Circulated/Carbon Copy. Bcc: Displays the recipient address for Blind Copy Circulated / Blind Carbon Copy Types of Event Forwarding: Error: Select this check box if you want the errors events to be forwarded. Warning: Select this check box if you want the warning events to be forwarded. Information: Select this check box if you want detailed verbose information events to be forwarded. Compleo Gateway User Manual 91

92 Editing Scheduled Query task Method One: Click on the Scheduled query task, you will get all the list of available tasks in the right hand side List View Pane. Right-click on the query task, you will get a context menu. Select the Edit Scheduled task... menu command from context menu and you will be redirected to the Query Scheduled Task window, where you can edit parameters for query scheduled task. Method Two: You will get a context menu on right clicking the Scheduled task available in the tree-view. Select the command Edit Scheduled Task... menu command from the context menu, which will be redirect you to the Query Scheduled Task window, where you can edit parameters for Supervised Query task Removing Supervision - Query scheduled task Method One: Click Scheduled Queries in tree-view and you will get the list of all available Scheduled task name in the List View Pane. On right clicking the desired query task for removing scheduled task, you get a context menu. Select the Remove Scheduled Task from the menu command, which will remove the scheduled task. Method Two: Right-click on the query task and context menu pop-ups. Select the command Remove scheduled task to remove the scheduled task. Compleo Gateway User Manual 92

93 SCHEDULE TASKS Overview With Scheduled Tasks, you can setup to process certain files of any repository at any time, irrespective of these files are old or new, using the conditions you define. With Scheduled Tasks, you can also: Schedule task to run daily, weekly, monthly, or at certain times (e.g. system startup). Change the schedule for a task. Stop a scheduled task. Customize how a task will run at a scheduled time. You can add scheduled tasks for i5 Series System, SAP Active Connector and PC Folders Creating a Scheduled Task Right-click i5 Series/SAP R/3 Printer/PC Folder Schedule Tasks in the tree view and click New i5 Series/SAP R/3/PC Schedule Task The Scheduled Task dialog box will be displayed. Figure 86: SAP R/3 Scheduled Task Compleo Gateway User Manual 93

94 General: Supervision Title: Enter an appropriate title for the task you want to schedule (This field is mandatory.) Supervised Outqueue: Select an Outqueue on which you want to schedule the task. You can select an outqueue from the drop down list or simply select All Outqueues of the server. Triggers: The settings here define the conditions on which the Scheduled Task is supposed to start. To define triggers, click on the button. This displays the New Scheduled Task dialog box: Schedule Figure 87: New Scheduled Task dialog box Select the following options to run the task on a scheduled day and time. Scheduled Task: Select from the drop down list the occurrence of the scheduled task. You can schedule a task for: You can specify the schedule by entering a Start time. This defines the time when the schedule task is to start running. Daily: This would let you schedule the task to run daily on the schedule specified by you. Compleo Gateway User Manual 94

95 Weekly: This would let you schedule the task on a weekly basis. You have the option of selecting the days you want to schedule the task to be run. By default, Mon (Monday) will be selected. You can select multiple days by checking the appropriate check boxes. You also have the option to select Every x weeks(s) if you want the task to be run at regular intervals. For e.g if you want the task to be run bi-weekly, then you can enter 2 in this box and the task will be run once every 14 days. Monthly: Allows you to select the month(s) you want to run the task, in advance. You have the option of running the task on a particular day of the month or select the days on which you want the task to be run by selecting the appropriate value from the drop down list. To select the months, select the check boxes for the relevant months. By default, all the months are selected. Advanced: You can also set advanced scheduling options: Start Date: Allows you to select the date on which the schedule is to be started. You can set end date for scheduled task by checking the box for End Date and selecting the end of the schedule. Repeat Task: Checking this box will allow you to access further, more advanced, options for Scheduling task. You can select the frequency of repetition of this schedule task by entering the appropriate value in Every box and selecting the duration either as minutes or hours from the drop down list. You can also select to Repeat task after Every set time duration by entering/selecting the time value. You can choose to run the task up to a particular hour during the day, by selecting options mentioned in Until header: o o You can choose the exact time till which you want to run the Repeat Task by clicking on the Time radio button and entering the appropriate value in the text box next to it. If you do not want to choose a particular time, but want to run the task for a predefined duration, then select the Duration radio button and enter the number of hour(s) and minute(s) you want the task to run for. If you check the "If the task is still running, stop it at this time" check box, the scheduled task will stop as soon as the defined duration is over, even if the task being carried out is not complete. The tasks will be stopped at the specified condition. If you do not check this option, the scheduled task will stop at the given time but, if it is in the middle of processing the task, it will allow it to finish and will not stop it abruptly. You can also edit or delete a scheduled task condition using the or buttons in the Triggers toolbar. Logged Event Types: This gives direction to the Gateway on what kind of events should be saved by the Gateway in the log. Compleo Gateway User Manual 95

96 Error: Check this box if you want the errors to be logged. Warning: Check this box if you want the warning to be logged. Information: Check this box if you want detailed verbose information to be logged. Event Forwarding This tab gives you the option of sending the Events you have selected, to an address or to a group of addresses in a distribution list. This is a very useful feature which allows you to monitor the administrator activities from any location just by browsing through the Events that you receive by . You can once again, select the type of Event logs that you want forwarded to the selected address / distribution list(s). Select the Forward events by SMTP mail check box. Click Edit Parameters to enter the required details in the SMTP Send Message Settings window. Once you have entered the details, the following parameters are displayed in this window: Server: Displays the server address / name to use for sending the SMTP mail. From: Displays the sender s address in this field. To: Displays the recipient address. Cc: Displays the recipient address for Copy Circulated / Carbon Copy. Bcc: Displays the recipient address for Blind Copy Circulated / Blind Carbon Copy. Select the Types of Event Forwarding: Error: Check this box if you want the errors events to be forwarded. Warning: Check this box if you want the warning events to be forwarded. Information: Check this box if you want detailed verbose information events to be forwarded Editing Scheduled Tasks You can edit the schedule task for the i5 Series/SAP R/3/PC Folder by making necessary changes in parameters available in this window. General: Supervision Title: Enter an appropriate title for the task you want to schedule (This field is mandatory.) Supervised Outqueue: Select an Outqueue on which you want to schedule the task. You can select an outqueue from the drop down list or simply select All Outqueues of the server. Triggers: The settings here define the conditions on which the Scheduled Task is supposed to start. To define triggers, click button. Compleo Gateway User Manual 96

97 On clicking button to set triggers, you will be redirected to the new scheduled task window, where you have to select few parameters to set schedule for supervision. Logged Event Types: This gives direction to the Gateway on what kind of events should be saved by the Gateway in the log. Error: Check this box if you want the errors to be logged. Warning: Check this box if you want the warning to be logged. Information: Check this box if you want detailed verbose information to be logged. Event Forwarding: This tab gives you the option of sending the Events you have selected, to an address or to a group of addresses in a distribution list. This is a very useful feature which allows you to monitor the administrator activities from any location just by browsing through the Events that you receive by . You can once again, select the type of Event logs that you want forwarded to the selected address/distribution list(s). Select the Forward events by SMTP mail check box. Click Edit Parameters to enter the required details in the SMTP Send Message Settings window. Figure 88: SMTP Send Message Settings Note: This window will allow you to add only the server and recipient details. The other details are automatically added by Compleo Gateway. Once you have entered the details, the following parameters are displayed in the Event Forwarding tab: Server: Displays the server address/name to use for sending the SMTP mail. From: Displays the sender s address in this field. Compleo Gateway User Manual 97

98 To: Displays the recipient address. Cc: Displays the recipient address for Copy Circulated/Carbon Copy. Bcc: Displays the recipient address for Blind Copy Circulated / Blind Carbon Copy Types of Event Forwarding: Error: Select this check box if you want the errors events to be forwarded. Warning: Select this check box if you want the warning events to be forwarded. Information: Select this check box if you want detailed verbose information events to be forwarded Removing a Scheduled Task Right-click on the available in the repository s tree-view(i5 System outqueue/sap Active Connector printer/ BC-XOM output device/ SAP Print Service virtual printer/ PC Folder/ Mailboxes/XPS) and you a get a context menu. Select the Remove Scheduled Task from the context menu to remove the selected scheduled task. 2.5 SCENARIO MANAGER OVERVIEW OF THE CONCEPT OF SCENARIOS A scenario is a group of Conditions/Tasks/Process that are checked and carried out by the Gateway module when a new file arrives in the supervised repositories or when a scheduled task is launched. You can add, edit, or delete an action from the scenario. Each supervised repository has its own scenarios associated with it. A title and a comment. A Schedule for programming active periods (optional). A list of Conditions which must be met for the Scenario to be executed. A Process to apply on Compleo Gateway Supervisor A list of Actions to be performed on the input and the output documents (optional) The Scenario Manager dialog box will be displayed as shown below: Compleo Gateway User Manual 98

99 Figure 89: Scenario Manager Title: Enter the title of your Scenario. This is the name given to the scenario that would appear in the administrator. Comment: Enter a description to explain in detail about the function of the scenario. This is optional but it is a good idea to add some relevant comments about the scenario for future reference. Conditions to check for: The criteria that must match before sending the files to the Gateway Supervisor for processing. A condition is created with reference to the file properties. Process of Compleo Gateway Supervisor to apply: Select the name of the process that should be applied to process the files in this scenario. The processes in this dropdown list are the ones defined on the Gateway Supervisor. Compleo Gateway User Manual 99

100 Show/Hide additional actions... Click this button to view/hide the more actions to be performed on the input/output documents locally. Action to carry out on the input document, once saved locally or uploaded: Select an option if you wish to retain, delete or modify the input file properties after it is sent to the Gateway Supervisor. Keep it as it is: Select this option to retain the input document as it is. Delete it: Select this option to delete the input document after it is sent. Modify its properties: Select this option to modify the attributes of the input document. Click on the Settings button to select the file attributes to be modified. Action to carry out on the output documents returned by the Compleo Gateway Supervisor: List of action(s) to be performed on the output documents received from the Gateway Supervisor. You can manage the actions and errors Adding a Scenario To Add a Scenario, carry out any of the following methods: Method One: 1. Go to the Configurations tab. 2. Select the supervised repository in the Tree-view. 3. Click button in the Scenario Management group. 4. In the Scenario Manager window which appears, complete the following as required: Title (required) Comment (optional) List of conditions (optional) Process to be applied (required) Actions to carry out on input and output documents (optional) Method Two: You can also add new scenario by selecting the command from the context menu display on right clicking the supervised repository from the Tree-view Propagate Scenarios This option allows you to maintain an identical set of scenarios in a list of outqueues. To propagate scenarios: 1. Right-click on the outqueue from which you want to replace the new scenario with the existing one and select Propagate scenario. Compleo Gateway User Manual 100

101 Figure 90: Right-click context menu 2. In the Propagate Scenario dialog box, select the outqueues in which you want to copy the scenario. Figure 91: Propagating scenario Note: Clicking the Reset button, removes the current selection of outqueues and restores previously selected outqueues for propagations. 3. Click OK. This adds the scenarios to the selected outqueue. Figure 92: Scenarios propagated Note: Select the Select all checkbox to copy the scenarios in all outqueues. Compleo Gateway User Manual 101

102 2.5.2 SCENARIO CONDITIONS These are the conditions (with reference to the File Properties) to be tested before applying the process selected in the Scenario. Scenario Conditions test the following File Properties (specific to repositories): i5 Series Spool File Properties Spool Name Job Name User Name Form Type User data Spool state Total pages Spool text File number Copies Page Width Creation date System Template Folder SAP R/3 Printer Properties Spool number Spool Name Number of pages Status Client User Name Number of copies Recipient Department Document type Spool text Creation date BC-XOM Printer Properties Spool no. Spool Title Spool User Output Device Output User Spool Format Recipient Number of Copies Department Priority Job Name Spool Name Spool Text System Template Folder Compleo Gateway User Manual 102

103 SAP Virtual Printer Properties Spool Name Spool Number Host Job name Client User name Number of pages File Text Creation date PC File Properties File name File Extension File size File text File type File attributes File Format Creation date Name without extension Mailbox Properties File name File size File type File format Name without extension File extension File text File attributes Creation date Mail sender Mail subject Mail body XML Stream Connector Device name User Name Scenario Name Script Path XPS Printer Properties File Name File Size File Type File Format Compleo Gateway User Manual 103

104 Name without extension File extension File Text File attributes Creation date XPS category XPS Content Status XPS Content Type XPS Created XPS Creator XPS Description XPS Identifier XPS Keywords XPS Language XPS Last Modified By XPS Last Printed XPS Modified XPS Revision XPS Subject XPS Title XPS Version Condition settings, that common for all types of repositories: Order of Conditions: The conditions are evaluated in the order in which they appears in list; i.e. from top to bottom. Important: If the Action cannot be carried out (for example the spooled file was deleted by the preceding Action), the scenario is classed as 'failure and an error message is generated and then the order progression down the list of Actions to carry out is stopped. Adding a Condition: To Add the Condition(s), do the following: Conditions to check for: Click button in the toolbar. This displays the Condition dialog box. Compleo Gateway User Manual 104

105 Figure 93: Scenario Manager - Conditions In the Condition dialog box, enter the following details: 1. Select the property of the file you wish to test. 2. Condition: The condition type can differ depending on the attribute being tested e.g. text, number of pages or spool file contents, etc. Condition to be checked is based on: Numeric Value Comparison Text Verification Text to Search File Attributes Date Comparison Figure 94: Scenario Condition Added Compleo Gateway User Manual 105

106 Modifying a Condition: To modify the settings of an existing Condition, do the following: Select the condition you wish to modify from the list. Click button in the toolbar. Deleting a Condition: Figure 95: Scenario Conditions - Modify To delete an existing Condition, do the following: Select the condition you wish to delete it from the list. Click button in the tool bar. Figure 96: Scenario Conditions Delete Compleo Gateway User Manual 106

107 Scenario Conditions Types Condition based on Numeric Values Comparison: In this dialog box to test the Condition, you can configure the parameters to test the properties based on Numeric Values Comparison. The Property is examined with the help of Test operator with reference to Value1 and Value2. Note: Value2 can only be set if you select Test Operator- " is between" Value1 and Value2 are user defined values and are required to be entered by you. From the drop down list for the Test parameter, select the operator: ==: The condition is verified with this selected operator and is satisfied only if the Property are equal to the Value1. <>: The condition is verified with this selected operator and is satisfied only if the Property is not equal to the Value1. <: The condition is verified with this selected operator and is satisfied only if the Property is less than the Value1. <=: The condition is verified with this selected operator and is satisfied only if the Property is less than or equal to the Value1. >=: The condition is verified with this selected operator and is satisfied only if the Property is greater/more than or equal to the Value1. >: The condition is verified with this selected operator and is satisfied only if the Property is greater/more than the Value1 Is between: The condition is verified with this selected operator and is satisfied only if the Property is in between the range of Value1 and Value2. Figure 97: Condition based on Numeric Values Comparison Properties which are examined on this type of Test are: Copies Number of Pages File Number Page Width File Size Spool Number Number of Copies Total Pages Compleo Gateway User Manual 107

108 Condition based on Text Verification In this dialog box to test the Condition, you can configure the parameters to test the properties based on Text verification. The Property is examined with the help of Test operator with reference to the Value. This Value is a user defined text value and is required to be entered by you. From the drop down list for the Test parameter, select the operator: ==: The condition is verified with this selected operator where the file is scanned for the value and the condition is satisfied only if the Property is equal to the Value. contains: To verify the test with this selected operator, the file is scanned for the value and the condition is satisfied only if the Property contains the text that is given in the Value. does not contain: The condition is verified with this selected operator where the file is scanned for the value and the condition is satisfied only if the Property does not contain the text that is given in the Value. begins with: The condition is verified with this selected operator where the file is scanned for the value and the condition is satisfied only if the Property begins with the text that is given in the Value. Figure 98: Condition based on Text Verification Properties which are examined on this type of Test are: Document Type Request Division File Extension Request Owner File Format Request receiver File Name Request Title File Type Spool Name Form Type Status Job Name User Data Name without extension User Name Request Client System Template Folder Device name Scenario Name Compleo Gateway User Manual 108

109 Script path Template Condition based on Text to Search In this dialog box to test the Condition, you can configure the parameters to test the property based on text to search. The Property is evaluated with the help of Test operator with reference to the Value. This Value is a user defined text value and is required to be entered by you. From the drop down list for the Test parameter, select the operator: contains: To verify the test with this selected operator, the file is scanned for the value and the condition is satisfied only if the Property contains the text that is given in the Value. does not contain: The condition is verified with this selected operator where the file is scanned for the value and the condition is satisfied only if the Property does not contain the text that is given in the Value. Note: If Search only on page option is not checked, the text is searched in all pages of the document. It is recommended that do not use this kind of condition frequently and/or without checking the Search only on page option, because it can take a lot of time to verify the condition. Properties which are examined on this type of Test are: Spool text (for i5 spool files) File text (for PC files/compleo Archivor files) Spool text (for R/3 spool files) Condition based on Date Comparison Figure 99: Condition based on Text to Search In this dialog box to test the Condition, you can configure the parameters to test the property based on Date Comparison in terms of number of days. The Property is examining with the help of Test operator with reference to the Value for X; where X is the user defined numeric value and is required to be entered by you. From the drop down list for the Test parameter, select the operator: is less than X days old: The condition is satisfied only if the Property is less than X days old than that of the date on which condition will be tested. is more than X days old: The condition is satisfied only if the Property is more than X days old than that of the date on which condition will be tested. Properties which are examined on this type of Test are: Compleo Gateway User Manual 109

110 Creation Date: Condition based on File Attributes: Figure 100: Condition based on Date Comparison In this dialog box to test the Condition, you can configure the parameters to test the File Attributes property, by selecting appropriate check box (es). The condition on the File Attributes is satisfied only when each of the three attributes of the file to be tested is in the same state as the one specified in the specific check boxes. Read Only: The condition is verified with file attribute property as a test operator and is successful only: If you check this box to select Read-Only state and the file to be tested on the Condition is having this attribute set On. If you un-check this box to un-select Read-Only state and the file to be tested is having this attribute set Off. If you put the check box as an un-determinate state for Read-Only and the file to be tested is having this attribute either set On or Off. Hidden: The condition is verified with this selected file attribute property as a test operator and is successful only: If you check this box to select Hidden state and the file to be tested on the Condition is having this attribute set On. If you un-check this box to un-select Hidden state and the file to be tested is having this attribute set Off. If you put the check box as an un-determinate state for Hidden and the file to be tested is having this attribute either set On or Off. Archive: The condition is verified with this selected file attribute property as a test operator and is successful only: If you check this box to select Archive state and the file to be tested on the Condition is having this attribute set On. If you un-check this box to un-select Archive state and the file to be tested is having this attribute set Off. If you put the check box as an un-determinate state for Archive and the file to be tested is having this attribute either set On or Off. Compleo Gateway User Manual 110

111 Note: By default, the check boxes for File Attributes will appear with an un-determinate state, which means don't care. If you leave it unchanged then that property to test the condition will be overlooked by the Gateway. The test must succeed on all the three attributes for the condition to be satisfied. Important: File Attribute is the information that indicates whether a file is read-only, hidden, ready for archiving (backing up), compressed, or encrypted, and whether the file contents should be indexed for fast file searching. Graphical notations of check box for selecting attribute are: : Selected state of the attribute. : Don't care the original state of the file attribute. : Un-selected state of the attribute. Property which is examined with this type of Test is: File Attributes Figure 101: Condition based on File Attributes Scenario Conditions Groups Group Separators Overview: Details about Groups of Conditions: By default all the conditions have to be met simultaneously for the Scenario to run. However, it is possible to define Groups of Conditions by inserting two or more Conditions. between Two or more Conditions separated by an effectively create two groups of Conditions which are tested separately. In the same group, all the Conditions must be met simultaneously Adding a Group Separator: To add a separator in between the existing Conditions, do the following: 1. Select the condition after which you wish to insert the separator. 2. Click button in the toolbar. Compleo Gateway User Manual 111

112 Deleting a Group Separator: To delete an existing Condition Group Separator, do the following: 1. Select the Group Separator from the list you wish to delete. 2. Click button in the tool bar ADDITIONAL ACTIONS These are the actions to be applied on the input documents (sent to the Gateway Supervisor) and the output documents (processed documents received from Gateway Supervisor). To view the additional actions: Go to the Scenario Manager dialog box, click. Figure 102: Scenario Manager Show additional actions Compleo Gateway User Manual 112

113 The Additional actions panel is displayed: Actions specific to Input documents: Figure 103: Additional Actions panel These actions will be applied on the input documents after it is saved locally or it is uploaded on the Gateway Supervisor server. The following are the available options: Figure 104: Additional actions specific to input documents Keep it as it is: Retains the input document as it is locally. Delete it: Deletes the input document after it is sent. Modify its properties: Allows you to modify the attributes of the input document. Click on the Settings button to select the file attributes to be modified. Actions specific to Output documents, returned by Compleo Gateway Supervisor: These actions will be applied on the output documents after it is received from the Gateway Supervisor. The following are the available options: Compleo Gateway User Manual 113

114 Figure 105: Additional actions specific to output documents Process With...: The final document will be saved and/or opened according to the commands sent. Copy/Move File: The output document received from the Gateway Supervisor will be copied or moved to the selected destination folder. SMTP Mail Driver*: Sends the output file by to a defined address/ distribution list. Microsoft Fax: Sends the final document by fax using the Microsoft fax driver. Upload to SAP: Allows you to upload the final document to the SAP server. SAP Function Call: Allows you to extract the value of the SAP function. FTP Driver: Publishes the final document on the FTP site. Compleo SharePoint Driver: Allows you to upload the file to Compleo SharePoint. Call a Web Service: Allows you to send an xml file to a web service. Zip File: Adds the file to a zip file MANAGING ACTIONS Additional actions are applied to the input and the output documents as defined in the Scenario Manager dialog box Adding Additional Actions For input documents: In the Scenario Manager dialog box, carry out the following: Click Show additional actions button. For Action to carry out on the input documents, once saved locally or uploaded, select any of the following options: Compleo Gateway User Manual 114

115 Keep it as it is: Select this option to retain the input document as it is. By default this option is selected. Delete it: Select this option to delete the input document after it is sent. Modify its properties: Select this option to modify the attributes of the input document. Click on the Settings button to select the file attributes to be modified. For output documents: In the Scenario Manager dialog box, carry out the following: Click Show additional actions button. Under Action to carry out on the output documents returned by Compleo Gateway Supervisor section. Click button in the toolbar. This displays the Actions dialog box. Double click on the available commands. OR Select the command and click. The window specific to that command will be displayed allowing users to enter the parameters. After you make the settings the selected actions will be displayed under Actions to carry out Modifying an Action for output documents: To modify the settings of an existing Action, carry out the following: 1. Select the Action to modify from the list. 2. Click button in the toolbar or double-click on the Action to modify. Compleo Gateway User Manual 115

116 The window specific to that command will be displayed allowing the users to make the modifications Deleting an Action for output documents: To delete the Action, do the following: 1. Select the Action to delete from the list. 2. Click button on the toolbar Moving an Action for output documents: To Move the Action, do the following: 1. Select the Action in the list to Move. 2. Click button in the toolbar to Move the Action up the list. 3. Click button in the toolbar to Move the Action down the list. Compleo Gateway User Manual 116

117 2.5.5 ERROR MANAGEMENT The Error Management option allows you to specify the number of retries if an action fails to process. You can also specify the wait time between each retry. To configure the error management settings: 1. Select a supervised repository and add a scenario action. 2. In the Scenario Manager dialog box, under Actions to carry out on the output documents returned by Compleo Gateway Supervisor section, select an action from the list and click from the toolbar. The Error management window appears. Figure 106: Error Management dialog box 3. Enter the number of times you want to re-try the action if the process fails. 4. Enter the waiting period (in seconds) between each attempt of executing the action. 5. Select the checkbox if you want the selected process to run only if the previous action fails. Notes: The above option is enabled only if you have added more than one action. If anyone action fails, Compleo Gateway will not execute the consecutive actions, unless this check box is selected. Compleo Gateway User Manual 117

118 2.5.6 EDITING SCENARIO Method One: Double-click on the desired scenario to be edited from the list of available scenarios for i5 Series Spool Files / SAP R3 Printer / PC Folder/Mailbox/SAP Print Service/Supervised DataQ/XPS Printer/Scheduled Query Task and you will be redirected to the Scenario Manager window where you can edit the appropriate parameters for scenario. Method Two: You can access the Scenario Manager window for editing the scenario set for i5 Series Spool Files / SAP R/3 Printer / PC Folder/Mailbox/SAP Print Service/ Supervised DataQ/ XPS Printer/Scheduled Query task by right clicking the desired supervised object. A context menu pop-ups and you have to select the Edit... command from the context menu and you will be redirected to Scenario settings window, where you can edit the appropriate parameters for scenario SCHEDULING A SCENARIO See Programming the Scheduler ACTIVATING & DEACTIVATING A SCENARIO You get the options for Activate/Deactivate scenario on right clicking the scenario from the list view of the selected repository. In the context menu, click Activate to activate deactivate scenario or click Deactivate to deactivate an active scenario. Compleo Gateway User Manual 118

119 2.5.9 DELETING SCENARIO To delete the scenario, follow one of the methods given below. Note: You can delete the Scenario from active and inactive repositories. Method One: Select the (Scenario) / (Scheduled Scenario) available in the List View. On the Configurations tab, in the Scenario Management group, click. OR Press Delete button on your keyboard to delete the selected Scenario / Scheduled Scenario. Method Two: You will get a context menu on right clicking a Scenario) / (Scheduled Scenario) available in the List View. Select the Delete menu command of context menu or press Del button on your keyboard to delete the selected Scenario / Scheduled Scenario. Method Three: (To Delete All Scenarios): You will get a context menu on right clicking the i5 System Outqueue / SAP R/3 Printer / Scheduled Task / PC Folder/Mailbox/SAP Print Service/ Supervised DataQ/XPS Printer/Scheduled Query task available in the Tree-view. Select the command Delete All Scenarios from the context menu, which will delete all the scenarios set for the corresponding i5 System Outqueue / Printer / Scheduled Task / PC Folder/Mailbox/SAP Print Service/ XPS Printer/Scheduled Query task you right clicked on. Compleo Gateway User Manual 119

120 OTHER OPTIONS Cut: You can cut the scenario by right clicking on the scenario to cut and selecting Cut command from the context menu or use shortcut keys CTRL + X from the keyboard. Copy: You can copy the scenario by right clicking on the scenario to copy and selecting copy command from the context menu or use shortcut keys CTRL + C from the keyboard. Paste: You can paste the scenario that is copied, by using shortcut keys CTRL + V from the keyboard. Delete: You can delete the scenario by right clicking on the scenario to delete and selecting Delete command from the context menu or use shortcut keys Del key from the keyboard. 2.6 COMPLEO GATEWAY- INTERACTIVE When Gateway is interactive, Gateway runs in the current session. It runs with the current user account, and if for some reason a process opens a window, the window will pop up. Gateway will be able to access user s Network Drives or other locations accessible only when this user is logged in. On the other hand, Gateway will run and the files will be processed generating the desired output only if the Gateway application is open. You can set Gateway to run automatically when the application starts. Configuring Gateway in the Interactive Mode: 1. Go to the Processes tab, in the Information group, click in the toolbar. This displays the Machine Settings dialog box. Figure 107: Machine Settings - Activity Compleo Gateway User Manual 120

121 2. Select Run the Gateway server interactively option. If your service is running you will get a restart prompt, click OK. 3. In the Machine Settings dialog box, click OK. The mode you chose is displayed under the Processes tab Information group. Figure 108: Gateway - Interactive Mode Note: If the Gateway is in Interactive session, the files will be supervised only when the Gateway application is open. 2.7 COMPLEO GATEWAY SERVICE DEFINITION A service is an application type that runs in the background and is similar to UNIX daemon applications. Service applications typically provide features such as client/server applications, Web servers, database servers, and other server-based applications to users, both locally and across the network. You can use Services to: Start, stop, pause, resume, or disable services on remote and local computers. You must have the appropriate permissions to start, stop, pause, restart, and disable services. Compleo Gateway User Manual 121

122 Manage services on local computers. Set up recovery actions to take place if a service fails, for example, restarting the service automatically or restarting the computer. Enable or disable services for a particular hardware profile. View the status and description of each service. Note: After the installation of Compleo Gateway is complete, the Startup Type for the service is set to Automatic, with the log-on account of Creator Owner (The log-on account from which the Compleo Gateway was installed). It is recommended to use the Startup Type as Manual using a log-on account with appropriate rights to utilize the capability of Compleo Gateway to the maximum extent. You can configure Service directly from the Console by following a few simple steps: 1. Go to the Processes tab, in the Information group, click in the toolbar. This displays the Machine Settings dialog box. 2. Select Run the Gateway server as a service option. 3. If Gateway in interactive mode is running, the Gateway restart prompt will appear, click OK for the Service session to become active. Compleo Gateway User Manual 122

123 The mode you chose is displayed under the Processes tab Information group. Configuring Supervisor Service Figure 109: Gateway is a Service On opening Compleo Gateway in Service Mode, if the service is not started, then you get an option of starting the service. If you click on YES the service starts automatically. You can also set Gateway service to run automatically when windows start through console Machine Settings window. 2.8 LOGS CREATED BY GATEWAY The Log Viewer allows the user to monitor the messages that are automatically saved when the different Gateway operations are carried out. Start right-click on My Computer Manage. Now select Event Viewer from System Tools Compleo Suite. Applications and Services Logs OR In Compleo Gateway, on the Processes tab, in the Monitoring group, click. Compleo Gateway User Manual 123

124 On doing these steps, the following window will be displayed: Figure 110: Computer Management Event Viewer Types of messages that are displayed: Error: Signals a problem which will stop the current scenario and maybe the whole application. Information: Signals changes in status of the different parts of Compleo Gateway (the message describes an action that has been performed). Warning: Signals a task error that has not affected any current scenarios. Example: Double-click on the message to find out more information. showing the entire message is displayed. A dialog box Figure 111: Event Properties The Event Properties window shows the details such as the Date, Type and Description of the event. Note: If you need to contact the Technical Support team following an error message, please make a note of the message description and Source. How to...clear the log Computer Management Console has its own default process to clear the log of events. Compleo Gateway User Manual 124

125 How to... Refresh the list of messages If new messages have been added to the log and not yet displayed, select the command Refresh from the Action menu. You can also use F5 function key or right-click and select Refresh from the context menu that pops up. 2.9 SAP CONFIGURATION FOR BC-XOM CONNECTOR Important: The Gateway service should have access to the folder \\Sapserver\SAP\InstanceName\DVEBMGS00\data under the name BCXOM_Data. So the shared folder would appear as \\Sapserver\BCXOM_Data for the BC-XOM connector to be able to communicate with your SAP systems. First you need configure BC-XOM connection on the SAP system and then configure the SAP System in Compleo Gateway. Perform the following steps on SAP system to setup a BCXOM connection, using an external RFC server: SETUP OF A NEW RFC DESTINATION: DECLARATION ON AN RFC SERVER In SAP system, enter transaction SM59. The Configuration of RFC Connections window appears. Click button and fill the RFC destination parameters as shown: Figure 112: Configuring RFC destination Compleo Gateway User Manual 125

126 Activation Type: Chose Registered Server Program Program ID: The Program ID is like a password, so it can be user specific. This parameter is used to uniquely identify the RFC server on the SAP Gateway. Thus two different SAP systems with identical program IDs, can connect to the same Gateway. To connect a SAP system to multiple Gateways each RFC server definition should have unique Program ID. SAP Recommendation to define Program ID: MACHINENAME.OPERATION (e.g. COMPLEOHOST.BCXOM_SERVER) Start Type of External Program: Chose Default Gateway value. CPI-C Timeout: Chose Default Gateway Value. Gateway Host: Enter the name of the SAP system that will host your Gateway. Gateway Service: Enter the name of the Gateway service that you want to use to communicate with Compleo. Gateway: This parameter is a communication junction for the SAP system and Compleo RFC server. Compleo registers itself on the SAP Gateway to receive the SAP request. In the RFC Server definition, enter this SAP gateway. When multiple SAP systems are connected to a given Gateway, every system must share the same Gateway Host and service, for the requests to reach Compleo. Tips: Generally, all SAP systems have the sapgw00 gateway installed by default. But the SAP Administrator can install a new SAP Gateway to use with BC-XOM, especially when high loads are expected. Click MDMP & Unicode tab. Select Unicode option. This option is available only in unicode compatible SAP systems. Click button to save the settings. Go back to the previous screen, the new RFC destination will appear in the TCP/IP connections list. Compleo Gateway User Manual 126

127 Figure 113: Viewing RFC destination CREATE A NEW ROMS (REAL OUTPUT MANAGEMENT SYSTEM) 1. Enter transaction code SPAD. The Spool Administrator: Initial screen appears. Figure 114: Spool Administrator: Initial screen Compleo Gateway User Manual 127

128 2. Click Extended Admin and go to the tab Output Management systems. 3. Then click Display button of Real Output Management Systems. The Spool Admin.: List of Real Output Management Systems appears. Click. 4. The list of Real Output Management Systems is displayed here. In the extended toolbar, click to create ROMS. Compleo Gateway User Manual 128

129 5. Enter the details in the OMS Description as shown. Enter the OMS Configuration. The OMS configuration should be exactly the same as Real OMS. Note: The Initialization Instance should be same as the RFC Destination defined while created the RFC connection as shown above. State of the options under OMS Attributes and SAP Configuration Tasking Command Line RFC Server Job Status Query Deletable Polling Callback Device Status Compleo Gateway User Manual 129

130 Query Queue Callback Output Type Fax 6. Click Save and the OMS will be added in the list of real output management systems CREATE A NEW LOMS (LOGICAL OUTPUT MANAGEMENT SYSTEM) 1. Enter transaction SPAD Extended Administrator Output Management Systems tab Logical Output Management Systems. 2. The List of Logical Output Management Systems window appears. Click to display extended toolbar. Click. Logical OMS: Enter the LOMS name. Recommendation to define LOMS name: 1. Use the entire 6 characters allowed to define an LOMS name. 2. Avoid defining two names where one might contain another. For example, define LOMS1 and LOMS2 instead of LOMS and LOMS1. Compleo Gateway User Manual 130

131 SAP configuration: Select the option as shown above: ROMS Choose the correct ROMS. Tasking target Enter the RFC Description, one that we created above. Target Callback for The system is automatically displayed by SAP Tasking Data by File This option is compulsory as suggested by SAP. Note: Data direct is not supported and will give an RFC communication error. Devices Queue query This option will enable to use the External jobs button to see the device status and the list of waiting spools. This needs to be. Callback Select Callback checkbox. On selecting this check box Target for callback appears. In Target for callback enter the spool server name. This needs to be Jobs Query This option allows users to see the status of a spool waiting in Compleo. This needs to be Compleo Gateway User Manual 131

132 Can be deleted This option allows users to delete any output request that has not been yet treated by Compleo. The user can then select the output request and click the delete button to delete it from the Supervisor list. This needs to be This option sends a pop-up when a successful or error message is send by Compleo for an output request. This is recommended to be. Status query It is recommended to use the given LOMS for printing by individual users. This will help them monitor the result of their actions. Note: When printing in batches it is preferable to disable this option. OMS Configuration 1. Select extended configuration button on the toolbar to display the details of OMS configuration. 2. Click OMS configuration tab. Compleo Gateway User Manual 132

133 Retain the default settings. OMS Callback Cache Print Requests: Send Period This is a callback period for jobs and should be decided depending on the load on the LOMS. Note: The smaller the value the faster is the callback and more CPU usage on the Compleo Server. It should not be less than 2 seconds for optimal usage. Generally a batch printing might use something like 2 to 5 seconds and user related LOMS might use 10 seconds. OMS Device This option updates the status of a device in case of change or pause in a scenario etc. OMS Configuration: This value has to be a HOSTNAME of your SAP system which will communicate with Compleo. If incorrect, Compleo will not accept the spools even if other actions seem to work fine. Click Save. The CMP_L LOMS will appear in the List of LOMS CREATE AN OUTPUT DEVICE Using the above created LOMS you can create multiple Output devices as per your requirement. 1. Enter Transaction SPAD Output Device Display. 2. This will show the list of output device available in spool administration. Click this will expand and will display other options of the toolbar. 3. Click create new printer. The Spool Administration: Create Output Device screen will be displayed. Compleo Gateway User Manual 133

134 Figure 115: Create Printer 4. Enter the printer name and its short name in Output Device and Short name text box respectively. In this case, use Compleo BC-XOM as printer name and CBX as short name. 5. Select appropriate device type from the Device Type drop-down list. Select SAPGOF: Generic output format ASCII if you want to export in excel or change the content. Select Standard printer. 6. Click Access Method tab. Figure 116: Access Method 7. Select E: External output management system in Host Spool Access Method from the drop-down list. Compleo Gateway User Manual 134

135 8. Enter host printer name in the Host Printer text box. Note: Host printer name should be exactly same as the Output Device or Short name. In this case it is Compleo BC-XOM. 9. In Logical OMS select already created Logical OMS name from the drop down menu. 10. Save the settings by clicking. Note: You do not need to install any other package on your SAP system to run the BC- XOM connector CHANGING THE CALL BACK TIME You can change the call back time taken on the SAP system, when a file is processed by Compleo. To change the settings: 1. In the SAP Interface, enter transaction code SPAD and press ENTER. This displays the Spool Administration: Initial Screen. Figure 117: Spool Administration: Initial Screen 2. Select Full Administration and click the Output Management Systems tab. 3. Click button, besides Logical Output Management Systems. Figure 118: Output Management Systems tab 4. In the Spool Admin: List of Logical Output Management Systems screen, doubleclick on the required LOMS. Compleo Gateway User Manual 135

136 This displays the Spool Administration: Logical Output Management System (Display) screen. Figure 119: LOMS 5. In the OMS configuration tab, click and then click. 6. Edit the Send Period from 20 sec (default) to 5 seconds and then click. Figure 120: Changing Callback time Compleo Gateway User Manual 136

137 2.10 PROCESSING SAP SPOOLS USING BC-XOM CONNECTOR (WITHOUT INSTALLING ANY PACKAGE ON THE SERVER) PRINT A REPORT IMMEDIATELY Figure 121: Selecting a printer To print a report, select the report: 1. Click the printer button. 2. Print List window appears. Click 3. Type Compleo BC-XOM in the Output Device box. 4. Select the printer to Print as Compleo BC-XOM. To print the spool immediately: 1. Select print out immediately from the drop down menu of Time of print. 2. Click. Compleo Gateway User Manual 137

138 Figure 122: Spool Request immediately Immediately the spools satisfying Wise Printing condition will be processed by the Gateway and also reflected in Console as displayed in figure below. Figure 123: Files in Processes 2.11 ISERIES 400 DEFINED SECURITY The Compleo products may in no way override OS/400 defined security. Compleo provides additional iseries 400 security through its own module, found on the iseries 400. To access this function, enter the following command: CALL CPSUITE4/WRKCPSAUT Using this screen, you may limit all Compleo users to certain functions: Compleo Gateway User Manual 138

139 Symtrax recommends that you limit the profile *PUBLIC (this is the profile used by all users who have the profile Current User specified in Compleo) and add additional profiles for users who have higher use rights (such as administrators, for example). The following security options are enabled or disabled according to whether there is a Y (for yes) or an N (for no) indicated. Exp: The user may connect to the iseries 400 and use the Explorer module. Adm: The user may connect to the iseries 400 and use the Administrator module. Sup: The user may activate the Gateway module. Usr: The user may display all spool files of all users even if they do not belong to the user. OutQ: The user may display the entire output queue list in Compleo. DSP: The user may display spool files. CHG: The user may change the spool file attributes. DLT: The user may delete spool files. STS: The user may change the spool file status (i.e. *HLD or *RLS). SND: The user may send spool files. PRT: The user may display the print status of spool files. IMP: The user may use the Compleo Explorer Wizard. BUP: The user may back up spool files on the PC. SPC: The user may use the search functions in Compleo. Compleo Gateway User Manual 139

140 2.12 EXAMPLES ISERIES In this example, we will see how to: 1. Supervise an outqueue 2. Apply a process to send the spool files to the Gateway Supervisor 3. Add an additional action, which will be applied on the output documents, received from Gateway Supervisor Configuring the Outqueue 1. In the Configurations tab, select an outqueue to be supervised in the tree view. 2. In the Scenario Management group, click to set the scenario. The Scenario Manager dialog box will be displayed. 3. In Title text field, enter Invoices. Figure 124: iseries example 4. In the Process of Compleo Gateway Supervisor to apply drop down list, select the Sales Invoices process. Adding additional actions on the output documents: We want to the output document, received from the Gateway Supervisor directly to our customer. For this, we add an additional action to send an as shown: Compleo Gateway User Manual 140

141 1. In the Scenario Manager dialog box, click. The additional actions section appears as shown: Figure 125: Additional Actions 2. Under Actions to carry out on the output documents returned by Compleo Gateway Supervisor section, click. This displays the Actions dialog box: 3. Select the SMTP Mail Driver option and click on Settings. This displays the SMTP Send Message Settings dialog box: Compleo Gateway User Manual 141

142 4. Enter the required details: Compleo Gateway User Manual 142

143 5. Click OK. The action will be added in the Scenario Manager window as shown: In the tree view of the Configurations, activate the selected supervised outqueue. 6. In the Device Supervision group, click. 7. Click to save the changes made in the Configurations tab. Now, when the spool files are released, it will be sent to the Gateway Supervisor. The processed documents will be received and ed to the respective customer as shown: Compleo Gateway User Manual 143