office integration server - tibco software

Office Integration ServerSoftware Release 10.4.0October 2020

TIBCO Nimbus®

Copyright © 1997-2020 TIBCO Software Inc. All Rights Reserved.

TIBCO Nimbus® Office Integration Server

Table of Contents

........................................................................................................................... 3Introduction

............................................................................................................... 31.1Target Audience

............................................................................................................... 31.2About the Office Integration Server

............................................................................................................... 31.3About TIBCO Nimbus

........................................................................................................................... 4

Configuring the Office Integration Server(OIS)

........................................................................................................................... 6OIS Logging

........................................................................................................................... 8Testing the OIS

........................................................................................................................... 9Running the OIS in Desktop Mode

........................................................................................................................... 11Running the OIS in Service Mode

........................................................................................................................... 12TIBCO Nimbus Support

............................................................................................................... 127.1Contact Details

........................................................................................................................... 13Legal and Third-Party Notices


Introduction

3

Target Audience

The intended audience for this Office Integration Server is:

· IT staff responsible for providing the technical infrastructure in which TIBCO Nimbus® isdeployed

· IT staff responsible for the implementation of Nimbus®

· The nominated administrators responsible for the day-to-day management of Nimbus®

About the Office Integration Server

The Office Integration Server facilitates the communication between Nimbus® and Microsoft Excel.Excel data is used to update metric links in the Web Server, and to generate Excel-based (.mht)scorecards in the Web Server.

There are two modes that the Office Integration can work in; Service Mode and Desktop Mode. TheService Mode is a Windows-based service that can be managed by the Nimbus® Service Installer tool(supplied on the CD). The Desktop Mode is a user-interface that provides a visual tool for monitoringand troubleshooting the Office Integration Service, as well as allowing the configuration settings ofthe OIS to be easily modified.

Scorecards in Mozilla Firefox

It is not possible to view MHT scorecards in the current versions of Mozilla Firefox. It is recommendedto use Google Chrome, Internet Explorer or Edge to view them. They can subsequently be saved ascomplete web pages that are compatible with Mozilla Firefox.

About TIBCO Nimbus®

Nimbus® is a business application for process documentation. By presenting an easy-to-understandvisualization of how people, processes, and systems should interact, it enables communication andsimplification of processes to improve how businesses operate.

Maps are a collection of diagrams created by authors. A map is initially created as a draft until it ispromoted to a master. Maps may also comprise a number of scenarios. Access rights can be assignedto individual users and groups, allowing or preventing access to an entire map or parts of a map.Continuous improvement of business processes is achieved through a number of collaborativefeatures. Acknowledgement requests ensure users are aware of process content that affects theirroles. Reviews ensure that content is kept up-to-date. Feedback and change requests allow users tosuggest improvements. Users can also be notified when content changes through the use ofsubscriptions.

Statement sets are a hierarchical set of regulatory and auditable statements that ensure complianceto specific business and legal requirements, such as ISO 9001, 27001, CMMi, internal companypolicies, etc. Statements can be linked to activities that are related to compliance and governance.

Configuring the Office Integration Server (OIS)

4TIBCO Nimbus® Office Integration Server


Both the Desktop Mode and Service Mode are controlled by a single configuration file, CtrlOffSvr.ini.This configuration file can be modified in both the Desktop Mode, and by manually editingCtrlOffSvr.ini in Notepad.

The configuration file, CtrlOffSvr.ini, is stored in the following location:

\TIBCO Nimbus\Action ServerThe Office Integration Server (Desktop Mode) can be run from the Start menu:

Programs>>TIBCO Nimbus>>Action Server>>Office Integration Server (DesktopMode). Then, from the File menu choose Configuration.

Desktop Mode CtrlOffSvr.ini Description

Port Port The listening port for the application. The permitted range is1024 - 65535, default is 51001. Note: The value must be thesame as the port values specified in the Nimbus® Web Serverconfiguration files.

Monitor timeout MonitorTimeout The time, in milliseconds, that the OIS should wait for aresponse from Excel. Default is 15000 milliseconds (15seconds).

Terminatetimeout

TerminateTimeout

The time, in milliseconds, that the OIS should wait for Excel toshutdown. Default is 15000 milliseconds (15 seconds).

Use interactivedesktop

InteractiveDesktop

Allows Excel warning messages to appear on the desktop ofthe user who is logged on directly to the operating system(Service mode only). Note: This option cannot be enabled inWindows Vista and Windows Server 2008.

Maximumhistory records

MaxHistoryCount The maximum number of request history records that will bestored in memory in Desktop Mode. The default is 20000 andonce this value is been reached, the oldest record will bedeleted for every new record generated.

Logging level LoggingLevel The detail of logging generated (see OIS Logging for moreinformation).

File rollover size(KB)

LogRolloverSize The maximum size permitted (kilobytes for Desktop Mode,bytes for Service Mode) for any one log file. When a log filereaches the size specified, a new log file will be created.

Maximumrollover files

LogMaxRollover The maximum number of rollover files permitted. When thisnumber is reached the oldest log file will be deleted for everynew log file that is created. If this value is set to '0' then onlya single file will be used, which is not limited by size.

Table: Descriptions of the configuration parameters in both the Desktop Mode and theCtrlOffSvr.ini file.



5

Windows Server 2008, Vista and laterFor Windows Server 2008, Windows Vista and later versions, a dual process is required to run the OISservice. The main account for the service to run under should be left as the default Local Systemaccount. Additionally, a secondary account should be specified for the worker process. Note that theworker process does not inherit any security rights from the Local System, therefore posing no securityrisks.

Worker Process Credentials (SecondaryIdentity)This account should be dedicated to the Nimbus Application, it can be restricted to domain useraccess, no specific domain permissions are required. This is defined in the OIS Desktop Mode, fromthe File menu choose Configuration). The worker process account requires the following:

· DCOM rights to launch Excel; it must also have previously run Excel and the Visual BasicEditor on the local machine.

· Log on as a service rights; this is usually granted when the account is specified in theproperties for a service. If the account has never been used on the PC as a service account, itwill need to be added by either:

· Temporarily setting the account as the account for the Office Integration Server service,so that Windows automatically grants this right.

OR

· Adding the account to the Log on as a service list using the Local Security Settingspolicy editor.

Note that on earlier versions of Windows the OIS service will run as a single process using a normaldomain user account.

Path MappingsThe path mappings to UNC path names can be configured, thereby allowing users to define an Excelspreadsheet in a mapped drive in the client, and define a UNC path in the Web Server. For example,the source path might be H:\Documents, but in the Web Server you might want to substitute this with\\server1\public\documents. Multiple mappings can be defined if needed.

In Desktop Mode click the Path Mappings tab (in the Configuration window).

Source path (SourcePathn) is the mapped drive path to be substituted by the Web Server.

Destination path (DestPathn) is the UNC path to use instead of the mapped drive path.

OIS Logging


OIS Logging

The Office Integration Service offers Log4D logging capabilities, which allows the debugging of anyissues that arise in the OIS.

Log FileThe same log file, ControlOIS.log, is used for both the Desktop and Service modes. This log file isstored in:

C:\TIBCO Nimbus\Action Server\Logs\OIS

Note: The current log file can also be viewed in the Log File tab in the Desktop Mode.

Configuring OIS LoggingThe logging configuration settings are defined in the CtrlOffSvr.ini file. This log file is stored in:

C:\TIBCO Nimbus\Action Server

Both the Desktop and Service modes share the same configuration settings file, so any changes to thelogging level will be reflected in both modes. The logging settings can be defined in either theCtrlOffSvr.ini file (through a text editor such as Notepad) or through the Desktop Mode.

Configuring OIS logging in Desktop Mode:

1. Run Office Integration Server (Desktop Mode) from the Start menu.

2. From the File menu choose Configuration.

3. In the Log file panel on the General tab, modify the following options, as required:

Logging level is the detail of logging that is generated (see table below)

File rollover size (KB) is the maximum size permitted, in kilobytes, for any one log file (whenthe current log file reaches the size specified, a new log file will be created).

Maximum rollover files is the maximum number of rollover files permitted (when thisnumber is reached, the oldest log file will be deleted for every new log file that is created). Ifthis value is set to '0' then only a single file will is used, which is not limited by size.

Logging Level

Detail of log entriesDesktop Mode CtrlOffSvr.ini

None 0 No logging.

Low 1· Date and time when the service is started· Date and time when the service is stopped

Medium 2· Date and time when the service is started· Date and time when the service is stopped· Any errors that are encountered

High 3· Date and time when the service is started· Date and time when the service is stopped· Any errors that are encountered· All handled requests


OIS Logging

7

Table: Available logging levels.

Configuring OIS logging in the configuration file:

1. Open the configuration file CtrlOffSvr.ini, which is stored in:

...\TIBCO Nimbus\Action Server\

2. In the [Options] settings, modify any of the following logging parameters:

LoggingLevel is the detail of logging that is generated (see table above)

LogRolloverSize is the maximum size permitted, in bytes, for any one log file. When a filereaches the size specified, a new log file will be created.

LogMaxRollovers is the maximum number of rollover files permitted. When this number isreached, the oldest log file will be deleted for every new log file that is created. If this valueis set to '0' then only a single file will is used, which is not limited by size.

3. Save and exit CtrlOffSvr.ini.

Testing the OIS


Testing the OIS

The Office Integration Server can be tested to ensure it is working correctly. When a self test is run,several requests are sent to the local computer on the port specified in the configuration settings.

The following tests are run:

· Metric with no macro

· Metric with macro

· Scorecard

Testing the Office Integration Server (Desktop Mode):

Note: The OIS service must not be running.


2. Click Start request processing.

3. Click Self test.

Testing the Office Integration Server (Service Mode):

Note: The OIS service must be running.


2. Click Self test.


Running the OIS in Desktop Mode

9


The Office Integration Server Desktop Mode allows administrators to visually monitor the status of theOIS and view the list of handled requests; this assists in troubleshooting any problems that arise.

The Office Integration Server (Desktop Mode) can be run from the Start menu:

Programs>>Nimbus®>Action Server

The Desktop Mode is split into three tabs:

Current Status This tab provides a summary of the number of processed requests and the number of failed requestsfor the current history record, since the application started. You can also start and stop the processingof requests.

To start processing, click Start request processing.

To stop processing, click Stop request processing.

Request HistoryThis tab displays all requests handled since the Desktop Mode started, subject to the limit set for the'Maximum history records' parameter. It does not show the requests handled by the Service Mode. Toreset the history, click Clear History.

Request records can be copied to the clipboard and then pasted into an Email if support is required.Highlight the text that you want to copy, then press Ctrl+C to copy the data to the clipboard.

Grouping Columns

Group any column by clicking and dragging the column header onto the gray space above thecolumns.

Sorting Columns

Sort the data within a column by clicking the column header.

Filtering Columns

Filter a particular column by selecting a filter value from the associated drop-down arrow on thecolumn header.

Displaying/hiding Columns

Display or hide certain columns by clicking to display the Column Selector. The Column Selectorlists the columns that are not currently being displayed. To add a column to the report, click anddrag the column from the Column Selector to the desired position on the column headers. Whenthe green arrows appear, release the mouse button to drop the column into place. To remove acolumn from the report, simply click and drag the column header into the Column Selector.

Log FileThis tab displays the current log file for the Office Integration Server.

Note: This is the same log file that is used by the OIS Service Mode.



Reload log file when a change is detected will refresh the log file whenever a change is detected.If this option is disabled then click Reload Log to refresh the view.


Running the OIS in Service Mode

11

Running the OIS in Service Mode

For more information about managing the OIS with the Nimbus® service installer, see ManagingNimbus® Services under Maintenance in the TIBCO Nimbus® Administration Guide which can bedownloaded from docs.tibco.com.

https://docs.tibco.com/products/tibco-nimbus

TIBCO Nimbus Support


Contact Details

Our specialized team are on hand to provide assistance with the Nimbus® product. TIBCO Support isan online resource where you can log cases directly, 24 hours a day, 7 days a week. You can alsoview updates on current cases and search the Nimbus® Knowledge Base.

Use the links below to access the relevant service.

Requirement Contact Details

To register for a TIBCO Support account. Request an account for TIBCO Support

To log in to TIBCO Support. support.tibco.com

If your support issue is urgent and you havenot yet registered for an account please email.

[email protected]

For further information on service levelagreements.

TIBCO Support Services

Access the TIBCO Community site. TIBCO Community

https://support.tibco.com/s/contact-support-agent

https://support.tibco.com

mailto:[email protected]

https://www.tibco.com/services/support

https://community.tibco.com/products/tibco-nimbus


Legal and Third-Party Notices

13

Legal and Third-Party Notices

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDEDOR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITEDADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLEDSOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FORANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF ALICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT,OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENTWHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH ISDUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT ORCLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE LICENSE FILE(S) OFTHE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THESAME.

This document contains confidential information that is subject to U.S. and international copyrightlaws and treaties. No part of this document may be reproduced in any form without the writtenauthorization of TIBCO Software Inc.

TIBCO, the TIBCO logo, the TIBCO O logo, and Nimbus are either registered trademarks or trademarksof TIBCO Software Inc. in the United States and/or other countries.

All other product and company names and marks mentioned in this document are the property of theirrespective owners and are mentioned for identification purposes only.

This software may be available on multiple operating systems. However, not all operating systemplatforms for a specific software version are released at the same time. See the readme file for theavailability of this software version on a specific operating system platform.

THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS ORIMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS.CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BEINCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKEIMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED INTHIS DOCUMENT AT ANY TIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUTNOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

This and other products of TIBCO Software Inc. may be covered by registered patents. Please refer toTIBCO's Virtual Patent Marking document (https://www.tibco.com/patents) for details.

Copyright © 1997-2020 TIBCO Software Inc. All Rights Reserved.

https://www.tibco.com/patents